Hitachi

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


Host name definition file (imdd_host_name.conf)

Organization of this page

Format

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "sourceHostName":["host-name-1-in-configuration-information","host-name-2-in-configuration-information"],
      "hostName":"host-name-in-tree",
      "label":"display-name-on-screen"
    },
    ...
  ]
}

Files

imdd_host_name.conf

imdd_host_name.conf.model (model file for the host name definition file)

Storage directory

In Windows
For a physical host:

Manager-path\conf\imdd\

For a logical host:

shared-folder\jp1imm\conf\imdd\

In UNIX
For a physical host:

/etc/opt/jp1imm/conf/imdd/

For a logical host:

shared-directory/jp1imm/conf/imdd/

Description

A structure of IM management nodes can include products that can have aliases for host names. In such a case, this file is used for mapping between aliases and real host names. If aliases are mapped to their real host name, the real host name is used as a host name in a tree chart. This allows the tree chart to group aliases into the same host even when different management tools use different aliases.

You also use this definition file when you change the host name displayed in the integrated operation viewer.

When the definitions are applied

The settings in the host name definition file are applied to the Intelligent Integrated Management Base when the jddcreatetree and jddupdatetree commands are completed successfully.

For details about the jddcreatetree and jddupdatetree commands, see jddcreatetree and jddupdatetree in Chapter 1. Commands.

Information that is specified

The host name definition file must be saved in UTF-8 without BOM (byte order mark). If you specify a backslash (\) as part of a character string, immediately before \, specify \ as an escape character.

"version":"1"

Specifies the version of the target host name definition file for configuration collection. Set this to 1.

"hostNameDef"

Either sourceHostName or label must be specified. Specifying hostName is required.

"sourceHostName":["host-name-1-in-configuration-information","host-name-2-in-configuration-information"]

List the host names that you want to represent a particular host. You can specify up to 10 host names. Each host name can be up to 255 characters in length.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

"hostName":"host-name-in-tree"

Specify a host name in the tree data. The host name can be up to 255 characters in length.

Acceptable characters are alphanumeric characters and the following symbols: exclamation mark (!), dollar sign ($), left parenthesis ((), right parenthesis ()), asterisk (*), plus sign (+), comma (,), hyphen (-), period (.), forward slash (/), colon (:), left angle bracket (<), equal sign (=), left square bracket ([), backslash (\), right square bracket (]), caret (^), left curly bracket ({), vertical bar (|), and right curly bracket (}).

"label":"display-name-on-screen"

Specify a label name to be displayed on the screen. Specify it as a string no more than 255 characters, without any control and machine-dependent characters.

Host names displayed on the screen

Host names displayed on the screen are determined by the priorities as shown in the table below.

Priority

Matched with the value of hostName?

Is label specified?

Is label specified for the value value of the host configuration information SID?

Host name displayed on the screen

High

Match

Yes

--

The value of label

Match

No

--

The value of hostName

Unmatch

--

Yes

The value of label specified for the value value of the host configuration information SID

Low

Unmatch

--

No

The host name specified for the configuration information SID (XXXXX in _HOST_XXXXX)

Legend: --: Not applicable

You can see the configuration information SID and its value value in the Integrated Operation Viewer window or by using the REST API provided by JP1/IM2 - Manager. For details about SID, see 7.1 SID, and for details about the REST API, see 5. API.

Example definition

Example 1: Display hostX as Host X on the screen

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "hostName":"hostX",
      "label":"Host X"
    }
  ]
}

Example 2: Display hostX as Host X on the screen when hosts defined as alias hostA and alias hostB are represented as hostX

{
  "meta":{
    "version":"1"
  },
  "hostNameDef":[
    {
      "sourceHostName":["hostA","hostB"], 
      "hostName":"hostX",
      "label":"Host X"
    }
  ]
}