6.3.14 User resource definition file
The user resource definition file contains definitions of user-specific resources. You can define resources in a resource category in the user resource definition file.
- Organization of this subsection
(1) Format
The following shows the format of the user resource definition file.
![[Figure]](GRAPHICS/SS060210.GIF)
(2) Details of resource category definition
The next table lists the items that constitute a resource category definition.
|
Key name |
Value |
|---|---|
|
rsc_category <<USER>> ((alphanumeric characters and hyphen (-) of 32 or fewer bytes)) |
Specify a resource category name.
|
#: When a category name is displayed by a command or in a window, the category name is case sensitive.
When coding a resource category definition, note the following:
-
Write this field at the top of the user resource definition file.
-
In a user resource definition file, you can write this field only once.
-
When omitting this field, omit the whole field, including the key name.
(3) Details of resource definition
The next table lists the items that constitute a resource definition. You must write fields in the definition file in the order in which they are listed the following table.
|
Key name |
Value |
|---|---|
|
rsc_id ((10000 to 19999)) |
Specify a resource ID. |
|
rsc_label_j <<English resource name>> ((The resource group label name and resource label name can have 32 or fewer bytes each.)) |
Specify this item when you specify a Japanese resource name. Specify a semicolon-separated pair consisting of a resource group label name and a resource label name. Omit this item when you use an English resource name. You can use not only multi-byte characters but also 1-byte alphanumeric characters and symbols. You cannot use one-byte katakana characters. The label names cannot include tabs, commas (,), colons (:), and/or semicolons (;). |
|
rsc_label_e ((The resource group label name and resource label name can have 32 or fewer bytes each.)) |
Specify a semicolon-separated pair consisting of a resource group label name and a resource label name. For an English label name, you can use the ASCII characters other than tab character, space character, comma (,), colon (:), semicolon (;), forward slash (/), and escape character (\). |
|
rsc_units <<unit not displayed>> |
Specify a resource unit. Usable characters are alphanumeric characters of up to 32 bytes, percent sign (%), underbar (_), and hyphen (-). |
|
rsc_threshold_MODE <<1>> ((1 or 2)) |
Specify a threshold display mode.
|
When coding a resource definition, note the following:
-
After the resource category definition, write as many resource definitions as the number of resources.
-
When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
-
If one definition file contains two or more definitions with the same resource IDs, only the first resource definition will be regarded as valid and the other resource definitions will be ignored.
-
The values specified for key names rsc_label_j and rsc_label_e must be unique within the file.
-
For a summary resource (a resource that includes a subresource whose data consists of string-type MIB values), the definitions of rsc_units and rsc_threshold_MODE are ignored.
(4) Details of subresource definition
The definition for subresources consists of one instance MIB object definition (optional), one or more subresource MIB object definitions, and one or more subresource definitions:
[instance-MIB-object-definition] subresource-MIB-object-definition : subresource-definition :
When coding a subresource definition, note the following:
-
After the resource definition, write as many subresource definitions as the number of subresources.
(a) Definitions for the instance MIB object
The following table shows the content of definitions for the instance MIB object. You must write fields in the definition file in the order in which they are listed in the following table.
|
Key name |
Value |
|---|---|
|
instance_mib_oid |
|
|
instance_mib_type |
|
When coding definitions related to instance MIB objects, note the following:
-
When omitting the instance MIB object definition, omit the whole definition, including the key name.
(b) Definitions for the subresource MIB object
The next table lists the items that constitute a subresource MIB object definition. You must write fields in the definition file in the order in which they are listed in the following table.
|
Key name |
Value |
|---|---|
|
subrsc_mib_oid |
Specify a MIB object ID.
|
|
subrsc_mib_type |
|
When coding definitions related to subresource MIB objects, note the following:
-
After the instance MIB object definition, write as many subresource MIB object definitions as the number of MIB objects to be acquired.
-
When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
-
If one definition file contains two or more resource definitions that have the same value assigned to the key name subrsc_mib_oid, only the first resource definition will be regarded as valid and the other resource definitions will be ignored.
-
When specifying two or more subresource definitions in one resource definition, you must specify MIB object IDs with the same suffix for the key name subrsc_mib_oid contained in the subresource MIB object definitions.
-
You can define up to 26 subresource MIB objects. If you define 27 or more subresource MIB objects, the first eight definitions will be regarded as valid and the 27th and subsequent definitions will be ignored.
(c) Definitions for the subresource definition
The next table lists the items that constitute a subresource definition. You must write fields in the definition file in the order in which they are listed in the following table.
|
Key name |
Value |
|---|---|
|
subrsc_label_j <<English subresource name>> ((up to 32 bytes)) |
Specify a Japanese subresource name. You can use not only multi-byte characters but also 1-byte alphanumeric characters and symbols. You cannot use one-byte katakana characters. The Japanese subresource name cannot include tabs, spaces, commas (,), colons (:), and/or semicolons (;). |
|
subrsc_label_e ((up to 32 bytes)) |
Specify an English subresource name. For an English subresource name, you can use ASCII characters other than the tab character, space character, comma (,), colon (:), semicolon (;), forward slash (/), and escape character (\). |
|
subrsc_mib_data (({ a - z}, operator-symbol { + , - , * , / }#1 ,integer, parentheses {( )}#2, SamplingTime)) |
Specify which of the MIB values specified in subrsc_mib_oid is to be used as data with reserved keywords (a to z) and operator symbols. The reserved keywords are assigned in the order specified in subrsc_mib_oid. If, however, the subresource includes an MIB whose object type is String, you must write reserved keywords alone. Therefore, you cannot write operator symbols.
|
#1 The usable operation method is only addition, subtraction, multiplication and division operation in a user resource.
#2 Parentheses can be used only when infix notation is used.
#3 The MIB expression referred to here is a combination of values and operators represented in the infix notation or postfix notation. The following MIB expression that is represented in the infix notation,
((a-b)/(a-b + c))*100
is represented in the postfix notation as follows:
a b - a b - c + / 100*
#4 The number of variables and constants that can be used in 1 MIB expression is 128 or less.
#5 The MIB expression by infix notation (a-b)/SamplingTime which uses SamplingTime, will become a b - SamplingTim / in the postfix notation.
When coding a subresource MIB object definition, note the following:
-
After the subresource MIB object definition, write as many subresource definitions as the number of subresources.
-
When you omit an optional definition item, you can only omit the value; you must write the key name and an equal sign (=).
-
If one definition file contains two or more resource definitions that have the same value assigned to the key name subrsc_label_j or subrsc_label_e, only the first resource definition will be regarded as valid and the other resource definitions will be ignored.
-
You can define up to 32 subresources.
-
If a resource includes at least a subresource whose data consists of string-type MIB values, the resource is treated as a summary resource (a resource that does not allow collection (regular query) but allows only a single query).
(5) Example
The following is an example of a user resource definition file.
![[Figure]](GRAPHICS/SS075000.GIF)
(6) Notes
(a) Storage directory for user resource definition files
Do not store any other files than the user resource configuration file under the storage directory ($SSO_CONF/rsc on UNIX or $SSO_CONF\sso\rsc on Windows) for the user resource configuration file. If a file (user resource definition file or other work file) other than the user resource configuration file is stored under the user resource configuration file storage directory, the ssocolmng daemon process might unduly tax the CPU or consume memory.
(b) Procedure to change user resource definitions
For how to add, change, and delete a user resource definition, see 2.3.2 User resource definition.
(c) Handling of division by zero during resource value calculation
When the value of a resource is calculated during resource reference or collection, the result of division by 0 is always treated as 0.
(d) Subresource ID
Subresource IDs are automatically assigned to the subresources of a user resource.
Sequential numbers beginning with 1 are assigned as subresource IDs to the subresources of a resource in the order of the subresource definitions in the resource definition.
- Example
-
When a subresource is defined by the fifth definition among the definitions for a resource, subresource ID 5 is assigned to the subresource.