User-created definition file list definition file (imdd_user_deffile_list.json)

Format

• Format of the definition file

{
  "filelist":[
    {
      "filename": "filename",
      "filepath": "full-path-of-file",
      "filecategoryID": "category-ID-of-file",
      "filecategoryName": "category-name-of-file",
      "updateaction": "manipulation-for-definition-import"
    }, ...
  ]
}

• Format of the model file

{
  "filelist":[
    {
      "filename": "",
      "filepath": "",
      "filecategoryID": "",
      "filecategoryName": "",
      "updateaction": ""
    }
  ]
}

To Page Top

Files

imdd_user_deffile_list.json

imdd_user_deffile_list.json.model (model file)

To Page Top

Storage directory

In Windows

For a physical host:

Manager-path\conf\imdd\fileoperation\

For a logical host:

shared-folder\jp1imm\conf\imdd\fileoperation\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/fileoperation/

For a logical host:

shared-directory/jp1imm/conf/imdd/fileoperation/

To Page Top

Description

A file that defines a user-created file that can be updated or delete with the functions provided by JP1/IM - Manager.

To Page Top

When the definitions are applied

Reflected when definition file list acquisition API is executed.

To Page Top

Character code

UTF-8 (If file has a BOM, load it ignoring BOM)

To Page Top

Information that is specified

Item name	Optional	Description
filename	No	Indicates file name.
filepath	Yes	Destination of file is written in absolute path. If file path (absolute path including file name) exceeds 200 characters, it becomes error. If file with the name specified in filename does not exist in the specified file path, it is regarded as an invalid definition. If this setup field is omitted, "manager-path\conf\imdd\user" is assumed. (For logical environments, replace "manager-path" with "shared-folder\jp1imm".)
filecategoryID	Yes	Describes the category ID to be specified when grouping more than one file. A file with the same category ID is considered to belong to the same category. Allowed characters are alphanumeric characters, "-" (hyphen), and "_" (underscore). Up to 32 characters can be specified. Category ID starting with "jp1_" cannot be specified.
filecategoryName	Yes	Specifies the category name for category ID. Specify a character other than a control character. Up to 32 characters can be specified. If no filecategoryID is specified, this setup field is ignored. If a filecategoryID is specified and this setup field is not specified, filecategoryID's value is setup.
updateaction	Yes	Describes the action (command-line) that should be executed if file is updated. For detail, see ■Description of updateaction.

■Description of updateaction

You can list the commands that Execute after updating file. The maximum length of a command line that can be written is 4,096 bytes.

If execute destination is a 64-bit Windows and you specify commands that are located in the %WINDIR%\System32 folders or lower, be aware of WOW64 redirection function.

The following types of commands can execute:

Hosts that execute commands are Windows

• Execution format file (.com, .exe)

• Batch file (.bat)

• The scripting file of JP1/Script (.spt) (but the association must be setup so that .spt file can execute)

Hosts that execute commands are Linux

• Linux commands

• Shell scripts

Note that you cannot execute the following commands:

• Commands that require interaction

• Commands to display the screen

• Commands with escape sequences or control codes

• Commands that do not terminate, such as daemons

• Commands that require interaction with the desktop, such as Windows Message functions and DDE (in Windows)

• Commands that shutdown OS, such as shutdown or halt

■About files that can be specified for user-created definition file list definition file

File that can be described in user-created definition file list definition file is shown below.

• User-created suggestion definition file (imdd_suggestion_any-file-name.conf)

• Correlated Event Publishing Definition File

• Correlated event publishing environment-definition File

• Definition file for extended event attributes

• Definition file for extended event attributes (extended file)

• Common exclusion conditions Extended Definition File

• Definition file for opening monitor windows

• User-specific metric definition file (metrics_any-Prometheus-trend-name.conf)

When jco_spmd_reload command is specified in updateaction for update of definition file of JP1/IM3 - Manager in logical host environment, -h option is not needed.

■About user-created definition file, which output destination is as you want

For the definition file that you create, if files can specify any location as the storage destination, when using the definition file manipulation function, the definition file is stored must be in as follows:

In Windows

For a physical host:

Manager-path\conf\imdd\user\

For a logical host:

shared-folder\jp1imm\conf\imdd\user\

In UNIX

For a physical host:

/etc/opt/jp1imm/conf/imdd/user/

For a logical host:

shared-directory/jp1imm/conf/imdd/user/

To Page Top

Example definition

{
  "filelist":[
    {
      "filename": "file_def.conf",
      "filepath": "C:\\Program Files (x86)\\Hitachi\\JP1IMM\\conf\\imdd\\user",
      "filecategoryID": "user_def",
      "filecategoryName": "user_def",
      "updateaction": "JP1Cons\\bin\\jco_spmd_reload.exe"
    }
  ]
}

To Page Top