Hitachi

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


7.2.2 IM management node

This section describes json objects for IM management node information.

Organization of this subsection

(1) IM management node tree object

Description

An object that contains the information of an IM management node tree

Format
{
  "meta":{
    "format":"file-type",
    "timestamp":"file-created-time"
    "componentName":"component-name",
    "hostName":"host-name",
    "version":"1"
  },
  "simtData":[
    {"sid":"IM-management-node-tree-SID"},...
  ]
}
Members

The following table describes the members of this object.

Table 7‒20: Members of the IM management node tree object

No.

Member

Data type

Description

1

meta

array

An array that stores file information

2

format

string

The file format. This is always set to conf.

This attribute cannot be omitted.

3

timestamp

string

Returns the date and time when the file was created, as a UTC date time value in the ISO 8601 format. This attribute cannot be omitted. The time is based on the time of the JP1/IM - Manager server.

4

compornentName

string

Specifies the name of the component from which IM management node information is retrieved.

5

hostName

string

Specifies the name of the host from which IM management node information is retrieved.

6

version

string

The version of the file. Always set this to 1.

7

simtData

array

An array that stores the SIDs of IM management nodes.

You can specify the SID of the IM management node for target, the label to be displayed for label, and the image file to be displayed as the node icon on the Related node tab for iconName, which together constitute the value of the tree SID.

For details about the names of image files, see 2.3.1 (7) Icons for related nodes in the manual JP1/Integrated Management 2 - Manager GUI Reference.

8

sid

string

Specifies the tree SID of the IM management node.

Output example
{
  "meta":{
    "format":"conf"
    "timestamp":"2018-11-11T00:00:00Z"
     "componentName":"/HITACHI/JP1/IMDD"
     "hostName":"host1"
  },
  "simtData":[
    {"sid":"_ROOT_AllSystems","value":{"target":[],"iconName":"ROOT.png","label":"All Systems"}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1","value":{"target":[],"label":"system1",...}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1","value":{"target":[],"label":"sub-system1",...}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1","value":{"target":[],"label":"host1",...}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_job","value":{"target":[],"label":"Job",...}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_job/_SUBCATEGORY_JP1%2FAJS3%20-%20Manager/_OBJECT_AJSROOT1/_OBJECT_jobgroup","value":{"target":[],"label":"jobgroup",...}},
    {"sid":"_ROOT_AllSystems/_SYSTEM_System1/_SYSTEM_SubSystem1/_HOST_host1/_CATEGORY_job/_SUBCATEGORY_JP1%2FAJS3%20-%20Manager/_OBJECT_AJSROOT1/_OBJECT_jobgroup/_OBJECT_jobnet1","value":{"target":[],"label":"jobnet1",...}}
  ]
}

(2) IM management node object

Description

An object that contains IM management node information

Format
{
  "meta":{
    "format":"file-type",
    "timestamp":"file-created-time"
    "componentName":"component-name",
    "hostName":"host-name",
    "version":"1"
  },
  "simtData":[
    {"sid":"IM-management-node-SID"},...
  ]
}
Members

The following table describes the members of this object.

Table 7‒21: Members of the IM management node object

No.

Member

Data type

Description

1

meta

array

An array that stores file information

2

format

string

The file format. This is always set to conf.

This attribute cannot be omitted.

3

timestamp

string

Returns the date and time when the file was created, as a UTC date time value in the ISO 8601 format. This attribute cannot be omitted. The time is based on the time of the JP1/IM - Manager server.

4

compornentName

string

Specifies the name of the component from which IM management node information is retrieved.

It accepts alphanumeric characters and a forward slash (/).

5

hostName

string

  • For the IM management node object file

    Specifies the name of the host from which IM management node information is retrieved.

  • For the IM management node object master file

    Always set this to master.

6

version

string

The version of the file. Always set this to 1.

7

simtData

array

An array that stores the SIDs of IM management nodes.

8

sid

string

Specifies the SID of the IM management node.

Output example
{
  "meta":{
    "format":"conf"
    "timestamp":"2018-11-11T00:00:00Z"
    "componentName":"/HITACHI/JP1/AJS3/CONFINFO"
    "hostName":"host1"
  },
"simtData":[
    {"sid":"_JP1AJS-M_host1/_HOST_host1","value":{...}},
    {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv","value":{...}},
    {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup","value":{...}},
    {"sid":"_JP1AJS-M_host1/_HOST_host1/_JP1SCHE_schedulerserv/_JP1JOBG_jobgroup/_JP1ROOTJOBNET_jobnet1","value":{...}},
    {"sid":"_JP1AJS-M_host1/_JP1AJS-A_AGT10/_HOST_host10","value":{...}},
    {"sid":"_JP1PFM-M_host2/_HOST_host2","value":{...}},
    {"sid":"_JP1PFM-M_host2/_JP1PFM-A_servid/_HOST_host20","value":{...}}
  ]
}

(3) IM management node link master object

Description

An object that contains the information of an IM management node link master.

Format
{
    "meta":{
      "format":"file-type",
      "timestamp":"file-created-time"
      "componentName":"component-name",
      "hostName":"host-name",
      "version":"1"
    },
    "links": [
        {
        "from": "preceding-node-SID",
        "to": "succeeding-node-SID",
        "type": "type-of-the-target"
        }, ...
    ]
}
Members

The following table describes the members of this object.

Table 7‒22: Members of the IM management node link master object

No.

Member

Data type

Description

1

meta

array

An array that stores file information

2

format

string

The file format. This is always set to conf.

This attribute cannot be omitted.

3

timestamp

string

Returns the date and time when the file was created, as a UTC date time value in the ISO 8601 format. This attribute cannot be omitted. The time is based on the time of the JP1/IM - Manager server.

4

compornentName

string

Always set this to master.

5

hostName

string

Always set this to master.

6

version

string

The version of the file. Always set this to 1.

7

links

array

An array for the response object. The order of the array is irrelevant.

8

from

string

The preceding node. It specifies the SID of the preceding node. This attribute cannot be omitted.

Example: When a root jobnet is specified:

_JP1AJS-M_JP1/AJS3-manager-host-name/_HOST_JP1/AJS3-manager-host-name/_JP1SCHE_scheduler-service-name/_JP1JOBG_job-group-name/_JP1ROOTJOBNET_node-name

9

to

string

The succeeding node. It specifies the SID of the succeeding node. This attribute cannot be omitted.

Example: When a root jobnet is specified:

_JP1AJS-M_JP1/AJS3-manager-host-name/_HOST_JP1/AJS3-manager-host-name/_JP1SCHE_scheduler-service-name/_JP1JOBG_job-group-name/_JP1ROOTJOBNET_node-name

10

type

string

Specify the type of the link information that you want to retrieve, among the link information types applied to the system.

type describes a grouping of relations that have the same meaning. On the Related node tab in the Integrated Operation Viewer window, you can filter relations to display only those belonging to a specific type.

For relations within a JP1/IM product or between a JP1/IM product and another product, the following types are used. In addition to these types, the use of user-specified types is also allowed.

  • rootJobnetExecutionOrder: relation of the execution order of root jobnets

  • managerAgent: Relation between the manager and agent of a JP1 product

  • rootJobnetAgent: Relation between a root jobnet and an AJS agent

  • sameNode: Relation between nodes with the same name

  • L2Connection: Relation between layer-2 connection lines managed by JP1/NNMi

  • Infrastructure: Relation between infrastructure resources managed by JP1/OA

  • monitoringConfiguration: Relation between a product and a monitoring target in a monitoring product configuration

Output example
{
 "meta":{
    "format":"conf"
    "timestamp":"2018-11-11T00:00:00Z"
        "componentName":"AJS"
        "hostName":"host1"
  },
    "links": [
        {
        "from": "preceding-node-SID",
        "to": "succeeding-node-SID",
        "type": "type-of-the-target"
        }, ...
    ],
}