2.3.2 User resource definition
Define the names of user resources, MIB objects to be collected, and calculation formulas using the user resource definition file or the Creating User resource definition window. For details on the user resource definition file, see 6.3.14 User resource definition file. Up to 10,000 user resources can be defined. Up to 32 subresources can be defined per resource. However, if there are multiple user resource configuration files, a maximum of 10,000 user resources in total can be defined in all the user resource configuration files.
After you create the user resource definition file, execute the user resource definition command (ssocolconf). When the ssocolconf command is executed, the user resource definition file is loaded into JP1/Cm2/SSO to create a user resource setup file. To set user resources on JP1/Cm2/SSO running on remote hosts or to browse collected data, distribute the user resource setup file to each host. Store the user resource definition file in the following directory:
In Linux: $SSO_CONF/rsc/user*# In Windows: $SSO_CONF\sso\rsc\user*#
- #
-
The string user* indicates a user resource configuration file name that begins with user and has 32 or fewer bytes. Alphanumeric characters and hyphens (-) can be used. A user resource configuration file name is a character string where the category name set in the resource definition file has been converted to lowercase.
The procedures for creating, deleting, and changing user resource definitions are described below.
- Organization of this subsection
(1) Adding a definition
To create a new user resource configuration file, or to re-create a user resource configuration file by adding definitions on a per-resource basis, use the following procedure:
(a) When using user resource definition files
-
Create a new or edit an existing user resource definition file.
We do not recommend that you create the user resource definition file under the SSO installation directory. In particular, do not create the file under the $SSO_CONF/rsc (in Linux) or $SSO_CONF\sso\rsc (in Windows) directory, which contains the user resource configuration file. If that directory contains a file other than the user resource configuration file (for example, a user resource definition file or a work file), the ssocolmng daemon process might unduly monopolize the CPU or consume memory.
-
If the Resource Configuration window or the Resource Data Reference window is open, close it.
-
Create or re-create a new user resource configuration file by using the ssocolconf command.
-
Restart the ssocollectd, ssocolmng, and ssorptd daemon processes.
(b) When using the Creating User resource definition window
-
Open the SSO console, and then open the Creating User resource definition window.
-
Enter the appropriate values for the user resource definition fields in the Creating User resource definition window.
The fields to be defined are the same as for the user resource definition file. For details, see 6.3.14 User resource definition file.
Click the Temporary Save button to retain the content that was defined until the web browser is closed.
Click the Download button to download the content that was configured in the Creating User resource definition window as a user resource definition file. You can edit the downloaded user resource definition file, and then add the definition as described in 2.3.2 (1) (a) When using user resource definition files.
-
Click the Create button in the Creating User resource definition window.
A user resource configuration file is generated.
-
Restart the ssocollectd, ssocolmng, and ssorptd daemon processes.
(2) Deleting a definition
If a definition is deleted, the existing collection data of the relevant user resources can no longer be referenced by using the ssoextractlog command or the Resource Data Reference window. If necessary, use the ssoextractlog command to extract that definition in text format, and then save the extracted data in a file.
To delete a user resource definition:
-
Stop the collection of all target user resources by using the ssocolstop command or the Resource Configuration window.
-
If necessary, use the ssoextractlog command (with the -text and -savefile options specified) to extract the existing collection data of the target user resources in text format.
-
Delete all the collection data of the target resource by using the ssodbdel command or the Resource Data Reference window.
-
Delete all the collection condition definitions of the target user resource by using the ssocolset command or the Resource Configuration window.
-
If the Resource Configuration window or the Resource Data Reference window is open, close it.
-
If you want to delete only some resources, re-create the user resource configuration file by using the ssocolconf command. If you delete a user resource configuration file, you must also delete the corresponding user resource configuration file.
-
Restart the ssocollectd, ssocolmng, and ssorptd daemon processes.
- Important
-
User resource definitions cannot be deleted in the Creating User resource definition window.
(3) Changing a definition
The procedure to change a user resource definition differs depending on the condition. The following shows the procedure for each condition.
- Condition 1: When performing either of the following operations within the resource definitions of the same English resource name (rsc_label_e key value):
-
-
Changing a resource ID (rsc_id key value).
-
Deleting some definitions related to existing subresources (subrsc_label_j, subrsc_label_e, and subrsc_mib_data keys).
Before changing user resource definitions, you must delete all the existing collection data of those user resources as well as the resource configuration. If necessary, use the ssoextractlog command to extract the existing collection data in text format and save it as a file.
Execute the same procedure as that described in (2) Deleting a definition.
-
- Condition 2: When changing the English resource name (rsc_label_e key value) within resource definitions that have the same resource ID (rsc_id key value):
-
Note that after changing user resource definitions, you cannot view the existing collection data of those user resources in the Resource Data Reference window.
If necessary, use the ssoextractlog command to extract the existing collection data in binary format or text format and save it as a file.
The procedure for changing user resource definitions is as follows:
-
Stop the collection of all target user resources by using the ssocolstop command or the Resource Configuration window.
-
If necessary, use the ssoextractlog command to extract the existing collection data of the target user resources and save it as a file.
-
To save the collection data in binary format
Execute the ssoextractlog command with the -bin and -savefile options specified.
You cannot view the data from the Resource Data Reference window, but you can view the data by using the ssoextractlog command with the -text and -logfile options specified.
-
To save the collection data in text format
Execute the ssoextractlog command with the -text and -savefile options specified.
-
-
Delete all the collection data of the target user resources by using the ssodbdel command or the Resource Data Reference window.
-
Delete all the collection conditions definitions of the target resources by using the ssocolset command or the Resource Configuration window.
-
If the Resource Configuration window or the Resource Data Reference window is open, close it.
-
Use the ssocolconf command to re-create the user resource configuration file.
-
Restart the ssocollectd, ssocolmng, and ssorptd daemon processes.
- Condition 3: When neither of the above conditions applies:
-
Execute the same procedure as that described in (1) Adding a definition.
- Important
-
User resource definitions cannot be modified in the Creating User resource definition window.