Hitachi

JP1 Version 12 JP1/Integrated Management 2 - Manager Command, Definition File and API Reference


7.1.1 Configuration information SID

A configuration information SID represents system configuration information.

There are different classes to configuration information SIDs, some of which are specific to each product while others are used commonly across products. The following table describes the reserved words for the class names used by the individual configuration information SIDs.

Table 7‒1: Reserved words for the class names of configuration information SIDs

No.

Applicable product

Class name#1

Description

Name to be specified#2

1

Common

_HOST_

Indicates a host.

The name of the host

2

JP1/AJS3

_JP1AJS-M_

Indicates JP1/AJS3 - Manager.

The name of the host running JP1/AJS3 - Manager

3

_JP1AJS-A_

Indicates JP1/AJS3 - Agent.

The name of the host running JP1/AJS3 - Agent

4

_JP1AJSMGR_

Indicates JP1/AJS3 - Manager.

None

5

_JP1AJSAGT_

Indicates JP1/AJS3 - Agent.

None

6

_JP1AJSSCHE_

Indicates the scheduler service of JP1/AJS3.

None

7

_JP1ROOTJOBNET_

Indicates a root jobnet.

The name of the root jobnet

8

_JP1ROOTJOBNETDUMMY_

Indicates that the preceding node or succeeding node is unknown in link information of a jobnet.

UNKNOWN

9

JP1/AJS3

JP1/IM

_JP1SCHE_

Indicates a scheduler service.

The name of the scheduler service

10

_JP1JOBG_

Indicates a job group.

The name of the job group

11

JP1/PFM

_JP1PFM-M_

Indicates JP1/PFM - Manager.

The name of the host running JP1/PFM - Manager

12

_JP1PFM-A_

Indicates the service ID of JP1/PFM - Agent or JP1/PFM - RM.

Service ID

13

_JP1PFM-AHOST_

Indicates the name of the host on which JP1/PFM - Agent or JP1/PFM - RM runs, or the name of a managed host of JP1/PFM - RM.

The name of the host on which JP1/PFM - Agent or JP1/PFM - RM runs, or the name of a managed host of JP1/PFM - RM

14

_JP1PFMMGR_

Indicates JP1/PFM - Manager.

None

15

_JP1PFMBASE_

Indicates JP1/PFM-Base.

None

16

_JP1AGENTSERVICE_

Indicates the service of JP1/PFM - Agent or JP1/PFM - RM.

None

17

JP1/IM

JP1/Base

_JP1IM_

Indicates that the host is the JP1/IM integrated manager.

The name of the host running the JP1/IM integrated manager

18

_JP1IMBASEMGR_

Indicates that the host is an IM base or relay manager.

The name of the host running the IM base or relay manager

19

_JP1IMRM_

Indicates that the host is a remotely monitored host.

The name of the remotely monitored host

20

_JP1IMMGR_

Indicates JP1/IM - Manager.

None

21

_JP1BASE_

Indicates that the host runs JP1/Base.

The name of the host running JP1/Base

22

_JP1BASEAGT_

Indicates JP1/Base.

None

23

_JP1BASETRAP_

Indicates a log file trap or event log trap.

None

24

JP1/IM

_ROOT_

Indicates the root name of the system.

The root name of the system

25

_SYSTEM_

Indicates a system.

The name of the system

26

_CATEGORY_

Indicates a category.

The name of the category

27

_SUBCATEGORY_

Indicates a subcategory.

The name of the subcategory

28

_OBJECT_

Indicates a management object

The name of the management object

29

JP1/NNMi

_JP1NNMI-M_

Indicates JP1/NNMi.

The name of the host running JP1/NNMi.

30

_JP1NNMI-A_

Indicates a node detected by JP1/NNMi.

The name of the node detected by JP1/NNMi

31

_JP1NNMiMGR_

Indicates JP1/NNMi.

None

32

_NNMINODE_

Indicates a node detected by JP1/NNMi.

None

33

JP1/OA

JP1/NNMi

JP1/SSO

_NETWORKDEVICE_

Indicates a network device.

Host name, IP switch name, or FC switch name

34

JP1/OA

_JP1OA

Indicates JP1/OA.

The name of the host running JP1/OA.

35

_JP1OA-A

Indicates a monitoring target of JP1/OA.

The name of the monitoring target of JP1/OA

36

_JP1OAMGR_

Indicates JP1/OA.

None

37

_CONSUMER_

Indicates a monitoring target (consumer).

The name of the consumer

38

_CONTAINERCLUSTER_

Indicates a monitoring target (container cluster).

The name of the container environment cluster

39

_CONTAINERNODE_

Indicates a monitoring target (container node).

The name of the container environment node

40

_SERVERCLUSTER_

Indicates a monitoring target (cluster).

The name of the cluster

41

_HYPERVISOR_

Indicates a monitoring target (hypervisor).

The name of the hypervisor

42

_VM_

Indicates a monitoring target (virtual machine).

The name of the virtual machine

43

_STORAGE_

Indicates a monitoring target (storage system).

The name of the storage system

44

_STORAGEVOLUME_

Indicates a monitoring target (volume).

The name of the volume

45

JP1/SSO

_JP1SSO-M_

Indicates that the SID is related to an SSO manager.

The name of the host running JP1/SSO

46

_JP1SSO-A_

Indicates that the SID is related to an SSO agent.

The name of the SSO agent host

47

_JP1SSOMGR_

Indicates an SSO manager.

None

48

_JP1SSOAGT_

Indicates an SSO agent.

None

#1

Each class name is 1 to 255 characters long.

#2

Each name must be 0 to 255 characters long, with the exception of the name specified for the object root node class, which must be 1 to 255 characters long.

The configuration information SID has, in addition to the value corresponding to the applicable class, additional information assigned to it in the form of a value specified for value. The following figure shows what the additional information looks like.

Figure 7‒2: Example of additional information specified in a configuration information SID

[Figure]

The following table describes the additional information items specified in the configuration information SID.

Table 7‒2: Additional information specified in the configuration information SID

No.

Applicable product

Variable name

Description

1

Common

component

The component name. It is the component value of the __configurationGet method.

This information is specified in all configuration information SIDs.

2

jp1ResourceGroup

Specify a JP1 resource group name from 1 to 64 characters. The permitted characters are half-width alphanumeric characters and the following half-width symbols:

!#$%&'()*-.@\^_`{}~

This variable can be omitted.

3

category

Specify a category from 1 to 255 characters. The permitted characters are half-width alphanumeric characters. For the acceptable values, see Table 4-2 Category IDs that the category variable can accept.

This variable can be omitted.

4

subCategory

Specify the abbreviated name of a product from 1 to 255 characters. The permitted characters are characters other than control characters. For JP1 products, this information is represented by a string starting with JP1/. This variable can be omitted.

5

visible

Specify whether to show the component in the Operating status area.

  • true: Show

  • false: Do not show

Specify true.

6

label

Specify the display name of a component that is shown in the tree from 1 to 255 characters. The permitted characters are characters other than control characters. For JP1 products, this information is represented by a string starting with JP1/. This variable can be omitted.

7

methods

A list of plug-in functions that can work with the component through the plug-in.

This information allows the function to be executed regardless of which product the plug-in belongs to. In order for this to work, it is important that you do not register a product-specific function. Make sure that the name of the function you register starts with an underscore (_).

The information for the client to identify whether the plug-in function can work with the node. Considering the scalability of the user plug-in, use return immediately without a plug-in that corresponds to a node causing an error if a method that is not found in methods is invoked.

8

property

Specify property information in object format.

The number of elements you can specify ranges from 0 to 100. Property names can accept characters from 1 to 64 characters, other than control characters. Property values can accept characters from 1 to 255 characters, other than control characters. This variable can be omitted.

Example:

"property":{"DataModelVersion":"yyy",...}

9

JP1/AJS

jobExecAgentList

Execution agent name information

10

JP1/PFM

productId

Product ID of JP1/PFM - Agent or JP1/PFM - RM

11

dataModelVersion

Data model version of JP1/PFM - Agent or JP1/PFM - RM

12

wcHostName

Host name of JP1/PFM - Web Console

13

portNumber

Port number of JP1/PFM - Web Console

14

protocol

https communication setting