Hitachi

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


[Figure]imagent common configuration file (jpc_imagentcommon.json)

Organization of this page

Format

{
  "JP1_BIND_ADDR": Binding method,
  "COM_LISTEN_ALL_ADDR": Whether more than one IP address is listening for services,
  "COM_MAX_LISTEN_NUM": how many IP addresses that the service is listening on,
  "JP1_CLIENT_BIND_ADDR": Binding method,
  "http": {
    "max_content_length": Max Request Body Size,
    "client_timeout": Client Timeout
  },
  "immgr": {
    "host": "Manager Host name",
    "proxy_url": "HTTP proxy server URL",
    "proxy_user": "HTTP Proxy Server authentication User name",
    "tls_config": {
      "ca_file": "CA Certificate File Path",
      "insecure_skip_verify": Server certificate validation skip,
      "min_version": "Smallest TLS Protocol Version"
    },
    "imbase": {
      "port": Connecting port of JP1/IM agent management base (imbase)
    },
    "imbaseproxy": {
      "port": Connecting port of  JP1/IM agent management base (imbaseproxy)
    }
  },
  "//immgr_add": {
    "secondary": {
      "host": "Manager Hostname",
      "proxy_url": "HTTP proxy server URL",
      "proxy_user": "HTTP Proxy Server authentication User name",
      "tls_config": {
        "ca_file": "CA Certificate File Path",
        "insecure_skip_verify": Server certificate validation skip,
        "min_version": "Smallest TLS Protocol Version"
      },
      "imbase": {
        "port": Connecting port of JP1/IM agent management base (imbase)
      },
      "imbaseproxy": {
        "port": Connecting port of  JP1/IM agent management base (imbaseproxy)
      }
    }
  }
}

File

jpc_imagentcommon.json

jpc_imagentcommon.json.model (model file)

Storage directory

■Integrated agent host

In Windows:

  • For a physical host

    Agent-path\conf\

  • For a logical host

    shared-folder\jp1ima\conf\

In Linux:

  • For a physical host

    /opt/jp1ima/conf/

  • For a logical host

    shared-directory/jp1ima/conf/

Description

This configuration file defines Common operation of JP1/IM agent control base.

Character code

UTF-8 (without BOM)

Line feed code

In Windows: CR+LF

In Linux: LF

When the definitions are applied

Reflected when imagent service, imagentaction service, and imagentproxy service are restarted.

Information that is specified

Member name

Optional

Format

Value to Setup

JP1_BIND_ADDR

Yes

string

Server Binding Methods

You can specify one of the following:

  • ANY: Do not bind (accepts all IP address)

  • IP: Binding to a IP address Retrieved by Host name Name Resolution

    It can be accepted for more than one IP address by specifying COM_LISTEN_ALL_ADDR and COM_MAX_LISTEN_NUM.

If this operand is omitted or if an unspecified character string Value is specified, ANY is assumed.

COM_LISTEN_ALL_ADDR

Yes

number

Whether the service is listening on more than one IP address

  • 0:Bind with the highest-priority IP address

  • 1:Binding with more than one IP address

If this operand is omitted, or if a numeric value that cannot be specified is specified, 0 is assumed.

COM_MAX_LISTEN_NUM

Yes

number

How many IP addresses on which the service is listening

If you specify 1 for COM_LISTEN_ALL_ADDR, specify the number of IP address that the service listens on, ranging from 1 to 16.

When this option is omitted or a value that cannot be specified is assumed to be 4.

JP1_CLIENT_BIND_ADDR

Yes

string

Source IP address Binding Method When Sending Requests

You can specify one of the following:

  • ANY: Bind with IP address that OS automatically allocates

  • IP: Binding with IP address Retrieved from Host name Name Resolution

If this operand is omitted or if an unspecified character string Value is specified, ANY is assumed.

If you want to use a particular IP address as the source IP address, for example, in a multi LAN connection environment, set the binding method to IP so that the host name resolves to a particular IP address.

http

Yes

object

See the explanation of http in imbase configuration file (jpc_imbase.json).

immgr

Not possible

object

Connect to JP1/IM Manager Host Setup

host

Not possible

string

Manager Host name

proxy_url

Yes

string

HTTP Proxy Server URL

Use the following form.

http://host-name-or-IPv4-address:port-number(1024 to 65535)

If this operand is omitted or if a character string Value that cannot be specified is specified, HTTP proxy server is not used.

proxy_user

Yes

string

User name uses for HTTP authentication for HTTP proxies

You can specify ASCII characters that do not contain control codes (except the Spacetab) and ":".

Character types are not checked.

If this option is omitted or if an unspecified character string Value is specified, authentication is not sent to HTTP proxy server.

tls_config

Yes

object

TLS Client Setup

If this option is omitted, communication with imbase or imbaseproxy is not encrypted.

The defaule value of member name is "//tls_config", treated as omitted.

In order to enable TLS server setup, change it to "tls_config".

ca_file

Yes

string

CA certificate File of authentication authority that issued Server certificate for imbase or imbaseproxy

Specifies CA certificate that is used to validate Server certificate.

Specify the full path of the file under the following directory:

■In a non-cluster configuration

  • For Windows

    Agent-path\conf\user\cert\

  • For Linux

    /opt/jp1ima/conf/user/cert/

■In a cluster configuration

  • For Windows

    shared-folder\jp1ima\conf\user\cert\

  • For Linux

    shared-directory/jp1ima/conf/user/cert/

For details, see the description of the files and directories that users can browse and edit on JP1/IM - Agent of the Integration Manager host agent on Appendix A.4 JP1/IM - Agent in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

insecure_skip_verify

Yes

boolean

If you do not want to validate Server certificate for imbase or imbaseproxy, specify true if you want to validate it false.

By default, false is assumed.

min_version

Yes

string

See the explanation of the min_version in imbase configuration file (jpc_imbase.json).

imbase

Not possible

object

Setup of the destination imbase

port

Not possible

number

JP1/IM agent management base (imbase) listen port

Specify within the range of 5001 to 65535.

If this operand is omitted or if a numeric value that cannot be specified is specified, 20724 is assumed.

imbaseproxy

Not possible

object

Setup of the destination imbaseproxy

port

Not possible

number

JP1/IM agent management base (imbaseproxy) listen port

Specify within the range of 5001 to 65535.

If this operand is omitted or if a numeric value that cannot be specified is specified, 20725 is assumed.

immgr_add

Yes

object

Setting Up Connectivity to JP1/IM Manager Hosts

Use this membership instead of immgr when you invoke imagent, imagentproxy, imagentaction with-imagid optional specification.

secondary

--

--

Use this membership when you specify secondary with-imagid option of imagent, imagentproxy, imagentaction.

host

Not possible

string

See the explanation of the same membership in immgr.

proxy_url

Yes

string

proxy_user

Yes

string

tls_config

Yes

object

ca_file

Yes

string

insecure_skip_verify

Yes

boolean

min_version

Yes

string

imbase

Not possible

object

port

Not possible

number

imbaseproxy

Not possible

object

port

Not possible

number

Notes
  • If this File is not accessible, imagentproxy will be stopped abnormally.

  • If JSON format is invalid or does not match the type specified, the service is stopped abnormally.