Hitachi

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


imagent configuration file (jpc_imagent.json)

Organization of this page

Format

{
  "port": Listen port,
  "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": {
    "auto_action_concurrency": "Whether Response Action(auto) can execute simultaneously",
    "max_concurrent_response_actions": max number of actions execute simultaneously 1,
    "max_concurrent_file_operation_actions": max number of actions execute simultaneously 2,
    "auto_action_execution_result_limit": the limit of action result of command execution 1,
    "manual_action_execution_result_limit": the limit of action result of command execution 2,
    "username": "user name",
    "domainname": "domain name",
    "shell": "shell command"
    "service_startup_wait_time": Service startup wait time
  },
  "//jp1base_forward_receive": {
    "port": 20733
  }
}

File

jpc_imagent.json

jpc_imagent.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 operation of imagent 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

Reflects when imagent service and imagentaction service restarts.

Information that is specified

Member name

Optional

Format

Value to Setup

port

Yes

number

The port for accepting access to JP1/IM agent control base (imagent)

Specify within the range of 5001 to 65535.

The default is 20726.

log

Yes

object

Logging Setup

See (a) Public log in 12.2.2(7) JP1/IM agent control base log in the JP1/Integrated Management 3 - Manager Administration Guide.

For details about setup items, see the description of log in the imbase configuration file (jpc_imbase.json).

action

Yes

object

Setup of integrated agent Action Execute function

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

auto_action_concurrency

Yes

string

Specifies whether to simultaneous execution of Action from auto Response Action of JP1/IM - Manager (defaults: no).

You can specify one of the following:

  • yes: Concurrent Execute is enabled.

  • no: Concurrent Fail

If this member is omitted, the default Value is assumed.

For details, see 3.15.7(3)(a) Auto response Action in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

max_concurrent_response_actions

Yes

number

Specifies the max action concurrent execute count for action that was execute from auto responseAction or manual responseAction of JP1/IM - Manager, between 1 and 48 (default:10).

If this member is omitted, the default Value is assumed.

Error if the sum of the max_concurrent_response_actions and max_concurrent_file_operation_actions exceeds 48.

For details, see 3.15.7(3)(e) Maximum concurrent actions in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

max_concurrent_file_operation_actions

Yes

number

Define JP1/IM - Manager Specifies the maximum concurrent execute of action that was execute from the definition file manipulation function, from 2 and 48 (default: 5).

If this member is omitted, the default value is assumed.

Error if the sum of the max_concurrent_deal_actions and max_concurrent_file_operation_actions exceeds 48.

For details, see 3.15.7(3)(e) Maximum concurrent actions in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

auto_action_execution_result_limit

Yes

number

Specifies the upper limit of the lines of the command execute result (standard output or standard error output of the command) for commands execute from auto responseAction in JP1/IM - Manager, ranging from 0 to 196,600 lines (default: 1000 lines).

If this member is omitted, the default Value is assumed.

For details, see 3.15.7(1)(e) Command execution function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

manual_action_execution_result_limit

Yes

number

Specify the upper limit of the lines of command execute results (standard output or standard error output of commands) for commands execute from manual responseAction in JP1/IM - Manager in lines 0 to 196,600 (default: 1000 lines).

If this member is omitted, the default Value is assumed.

For details, see 3.15.7(1)(e) Command execution function in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

username

Yes

string

The user that executes command; used for Action Execution

Specify up to 20 bytes.

If this option is omitted, works as "jp1imaction".

You cannot specify a user name with multibyte characters.

Specify the user that can log on and has a home directory.

For Windows, there are the following precautions:

  • The token of user is necessary to be able to be retrieved by Windows LogonUser function.

  • The password is necessary to be registered using the jimasecret command.

domainname

Yes

string

The domain to which the user specified at username belongs

It is available only in Windows.

Specify up to 255 bytes.

If this option is omitted, works as ".".

You cannot specify a domain name with multibyte characters.

When the user specified in username is local user, set ".".

shell

Yes

string

The shell to execute command; used for Action Execution

For Action Execution, the command specified with -c option is executed to the shell specified in this option.

If this option is omitted, works in "/bin/sh".

service_startup_wait_time

Yes

number

Wait time for service startup in definition file update process.

Specify the waiting time to confirm that the definition file reflection process has been performed correctly in the range of 5 to 120 (seconds).

If omitted, it operates at 15 (seconds).

jp1base_forward_receive

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

number

Listen port listening for JP1/Base event-forwarding

Specify within the range of 5001 to 65535.

Specify the port number. Do not enclose it in double quotation marks ("").

You cannot specify a service name.

The default is 20733. If omitted, the default value is assumed.

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.