Hitachi

JP1 Version 12 JP1/SNMP System Observer Description, Operator's Guide and Reference


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]

(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.

  • The resource category name must begin with USER. Also, the resource category name must not exceed 32 bytes, including USER.

  • The resource category name is not case sensitive#. USER at the top of the name, however, must be written in uppercase.

#: 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:

(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 single-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.

  • Normal < Warning < Critical: 1

  • Critical < Warning < Normal: 2

When coding a resource definition, note the following:

(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:

(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

  • Enter the MIB object ID when replacing the key name with another MIB object name having a suffix that matches the suffix of an MIB object specified in subrsc_mib_oid.

  • Enter the numbers that will be compared with the objects comprising the suffix of the MIB object ID and MIB object (number-1;number-2) and the number that will replace (number-3), separated by semicolons (;).

  • For the MIB object ID, enter the MIB object ID for acquiring the MIB value, which will be replaced with the MIB object suffix entered in subrsc_mib_oid.

  • For number-1, enter the ordinal number of the object which form the suffix of the MIB object specified in MIB object ID, that will be compared with the suffix of the MIB object entered in subrsc_mib_oid. A number from 1 to 32 can be specified for number-1. You can specify multiple numbers. When specifying multiple numbers, write the numbers in ascending order, and delimit each number with a comma (,) or delimit the first and last numbers with a comma (,).

  • For number-2, enter the ordinal number of the object which forms the suffix of the MIB object described in subrsc_mib_oid, that will be compared with the suffix of the MIB object described in MIB object ID. A number from 1 to 32 can be specified for number-2. You can specify multiple numbers. When specifying multiple numbers, write the numbers in ascending order, and delimit each number with a comma (,) or delimit the first and last numbers with a comma (,).

  • For number-3, enter the ordinal number of the object which forms the suffix of the MIB object specified in subrsc_mib_oid, that will be replaced with the MIB value of the MIB object specified in MIB object ID. A number from 1 to 32 can be specified for number-3. You can specify multiple numbers. When specifying numbers, write the numbers in ascending order, and delimit each number with a comma (,) or delimit the first and last numbers with a comma (,).

  • Always start an MIB object ID with a period (.).

instance_mib_type

  • Enter the type of MIB object entered in instance_mib_oid. Specify Counter, Gauge, Integer, or String. Note that data is handled in the same way either when Counter is specified or when Gauge is specified. For the data handling according to the object type, see Table 2-8 Types of collectable MIB objects in 2.3.1 User resources that can be defined.

  • If the MIB object data type specified in instance_mib_oid is Counter64 of SNMP version 2, specify 2 as the SNMP version for the corresponding resource category in the SNMP configuration file. For the SNMP configuration file, see 6.3.6 SNMP definition file (ssosnmp.conf).

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.

  • The MIB object ID must start with a period (.).

  • Specify the MIB object ID of a node object (MIB object ID that does not include instances).

  • Obtain the MIB values of all instances as the MIB object using table format.

subrsc_mib_type

  • Specify Counter, Gauge, Integer, or String for the type of the MIB object specified in subrsc_mib_oid. For the data handling according to the object type, see Table 2-8 Types of collectable MIB objects in 2.3.1 User resources that can be defined.

  • If the MIB object data type specified in subrsc_mib_oid is Counter64 of SNMP version 2, specify 2 as the SNMP version for the corresponding resource category in the SNMP configuration file. For the SNMP configuration file, see 6.3.6 SNMP definition file (ssosnmp.conf).

  • If Counter is specified in subrsc_mib_type, the resource value is calculated from the increase of the value of the subresource MIB object from the previous value. Therefore, the resource value is not calculated right after collection starts (at the first collection). For this reason, for such a resource, collected data saving and resource status change event issuance start when the collection interval time elapses (at the second collection) after collection starts.

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 single-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.

  • When you specify a MIB expression#3, #4, use infix notation or postfix notation. If you use postfix notation, insert one or more spaces between a value and a value, between an operator and an operator, or between a value and an operator.

  • It is possible to include the collection interval in the MIB expression. In this case, specify SamplingTime variable. The actual collection interval (seconds) will be entered automatically in SamplingTime. #5

  • Specify a value within 8,191 bytes from the top of the line.

#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]

(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 Linux 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.