Hitachi

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


[Figure]imbase configuration file (jpc_imbase.json)

Organization of this page

Format

{
  "port": Listen port,
  "file_operation_timeout": Timeout for File manipulation,
  "log": {
    "message": {
      "num": Logging sectors,
      "size": Max. file size
    },
    "internal": {
      "level": "Logging Level",
      "num": Logging sectors,
      "size": Max. file size
    },
    "access": {
      "num": Logging sectors,
      "size": Max. file size
    }
  },
  "action": {
    "startup_action_check_timeout": Timeout period to transition actions that remain in progress when the Unified Agent Management Platform is started to the terminal state
  },
  "//jp1base_forward_send": {
    "port": "jp1imevt"
  },
  "polling_monitoring_interval": Monitoring interval for Polling Monitoring function,
  "agent_polling_interval": Connection interval for JP1/IM agent control base

File

jpc_imbase.json

jpc_imbase.json.model (model file)

Storage directory

■Integrated manager host

In Windows:

Manager-path\conf\imdd\imagent\

In Linux:

/etc/opt/jp1imm/conf/imdd/imagent/

Description

This configuration file defines the operation of imbase process in JP1/IM agent management base.

Character code

UTF-8 (without BOM)

Line feed code

In Windows: CR+LF

In Linux: LF

When the definitions are applied

This information is reflected in imbase operation when imbase service is restarted.

Information that is specified

Member name

Optional

Format

Value to Setup

port

Yes

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.

file_operation_timeout

Yes

number

If this time passes, File operator should abort the process

Specify within the range of 1 to 60 (minutes). The default is 3.

If omitted, or if an unspecified numeric value is specified, the default Value is assumed.

log

Yes

object

Logging Setup

If it is omitted, the default Value is applied to the sub-items.

message

Yes

object

Public log

See (a) Public log in 12.2.1(6) Log of JP1/IM - Agent (JP1/IM agent management base) in the JP1/Integrated Management 3 - Manager Administration Guide.

If it is omitted, the default Value is applied to the sub-items.

num

Yes

number

Number of File sectors

Specify within the range 2 to 99.

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

size

Yes

number

Maximum file size

Specify within 1 to 100 (in MB).

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

internal

Yes

object

Internal log

Logs that do not need to be referenced.

If it is omitted, the default Value is applied to the sub-items.

level

Yes

string

Log-level#

Specify one of the following:

  • trace: debug logging and functional tracing

  • debug: info logging and debug logging

  • info: warn logging and informational logging

  • warn: error logging and Warning logging

  • error: Error Logging

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

num

Yes

number

Number of File sectors

Specify within the range 2 to 99.

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

size

Yes

number

Maximum file size

Specify within 1 to 100 (in MB).

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

access

Yes

object

Access log

Logs that do not need to be referenced.

If it is omitted, the default Value is applied to the sub-items.

num

Yes

number

Number of File sectors

Specify within the range 2 to 99.

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

size

Yes

number

Maximum file size

Specify within 1 to 100 (in MB).

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

action

Yes

object

Configuring the Unified Agent Action Execution Feature

If omitted, the default value is applied to the subitem.

startup_action_check_timeout

Yes

number

When the timeout period specified for this member elapses after starting the Unified Agent Management Platform, if the operation of the action cannot be confirmed for the action that remains running when the Unified Agent Management Platform is started, the action is moved to the end state.

Specify in the range of 120 to 3600 (unit: seconds). The default is 120.

If omitted or a numeric value that cannot be specified is specified, a default value is assumed.

jp1base_forward_send

Yes

object

Configuring event-forwarding relay function for JP1/Base

The default is a comment line, and the setting is invalid.

To enable the setting, remove "//" which represents the comment line.

If omitted or commented lines are specified, event-forwarding relay function is disabled.

port

Yes

string

Forwarding destination JP1/Base event-forwarding port

Specify within the range of 5001 to 65535.

Specify the port number or service name in double quotation marks ("").

If only a numeric value is specified, it is treated as a port number.

If a value containing a character other than a digit is specified, it is treated as a service name and the port number of the corresponding service name is obtained from services file.

Defaults to "jp1imevt". If omitted, the default value is assumed.

polling_monitoring_interval

Yes

number

Specify in the range of 60 to 7200 (unit: seconds).

The default is 60.

If omitted or an invalid value is specified, the default value is assumed.

For the specified value, refer to the following estimation formula:

"Value of agent_polling_interval * n"

Please specify n as 2 or more.

If the calculated result is less than 60 seconds, specify it to 60 seconds.

agent_polling_interval

Yes

number

Specify in the range of 10 to 3600 (unit: seconds).

The default is 10.

If omitted or an invalid value is specified, the default value is assumed.

For the specified value, refer to the following estimation formula:

"0.1 seconds * Number of JP1/IM - Agent monitored"

If the calculated result is less than 10 seconds, specify it to 10 seconds.

If you specify a longer value, the time until the JP1/IM agent control base connects may become longer.

Notes
  • If this File is not accessible under Physical host, the default Value is applied when all items are omitted.

  • If this File cannot be accessed under Logical host, imbase and imbaseproxy will be stopped abnormally.

  • If JSON format is invalid or the type Does not match the type specified, imbase and imbaseproxy is stopped abnormally.

#:

The following shows the types of logs to be output depending on the log level.

Output log

Log level

trace

debug

info

warn

error

Function trace

Y

--

--

--

--

Debug information

Y

Y

--

--

--

Information

Y

Y

Y

--

--

Warning

Y

Y

Y

Y

--

Error

Y

Y

Y

Y

Y

Items that cannot be classified by the output Message of the deployment library, etc.

Y

Y

Y

Y

Y

Legend

Y: Output, --: Do not output