Hitachi

JP1 Version 13 JP1/Integrated Management 3 - Manager Command, Definition File and API Reference


7.2.5 Integrated agent administration

Organization of this subsection

(1) Integrated agent Info object

Description

A json object representing integrated agent info.

Format
{
  "agentid": agent ID,
  "agenthost": integrated agent host name,
  "os": OS name,
  "installpath": Installation path,
  "imversion": version of integrated agent,
  "managerhost" Manager Host name,
  "registeredtime" registration date and time,
  "addons": [
    {
      "addonName": Function name,
      "enabled ": Status
    }, ...
  ]
}
Members

Members are listed in the following table.

Table 7‒26: Members of integrated agent info object

No.

Member

Data type

Description

1

agentid

string

Specifies ID of integrated agent.

2

agenthost

string

Specifies Host name of integrated agent.

3

os

string

Specifies OS of the host for integrated agent.

(Ex: windows, linux)

4

installpath

string

Specifies Installation path of JP1/IM - Agent installed on integrated agent host.

5

imversion

string

Specifies Version (VVRRSS) of JP1/IM - Agent as a six-digit number.

6

managerhost

string

Specifies Host name of integrated agent manager.

7

registeredtime

string

Specifies UTC time in ISO 8601 format as the registration date and time of integrated agent data.

The registration date and time will be updated when JP1/IM - Agent is started after the following operations are performed:

  • Installation of JP1/IM - Agent

  • Version upgrade install of JP1/IM - Agent

  • Delete JP1/IM - Agent on the JP1/IM agent list screen of the Integrated Operation Viewer

8

addons

object[]

Specifies an array of add-on information objects.

9

addonName

string

Specify the add-on name.

10

enabled

boolean

Specify whether to Enable the add-on function.

  • True: Enabled

  • False: Disabled

Output example
{
  "agentid": "RENEMzNENDg5RkQyNEM2OT",
  "agenthost": "agenthostA",
  "os": "windows",
  "installpath": "C\\Program Files\\Hitachi\\jp1ima",
  "imversion": "130000",
  "managerhost": "managerhostA",
  "registeredtime": "2020-03-01T00:00:00Z",
  "addons": [
    {
      "addonName": "Windows metric collector(Windows exporter)",
      "enables": true
    }, ...
  ]
}