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

Organization of this page

Format

Format of definition File

{
  "filelist":[
    {
      "filename": "File Name",
      "filepath": "File's absolute path",
      "filecategoryID": "File Category ID",
      "filecategoryName": "File Category-name",
      "updateaction": "Manipulation for Defining Import"
    }, ...
  ]
}

Model File format

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

To Page Top

File

jpc_user_deffile_list.json

jpc_user_deffile_list.json.model (model file)

To Page Top

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/

To Page Top

Description

user-created definition Files that can be updated and deleted with JP1/IM - Manager supplied REST API.

To Page Top

Character code

UTF-8 (without BOM)

To Page Top

Line feed code

In Windows: CR+LF

In Linux: LF

To Page Top

When the definitions are applied

The definition is read when the update function, delete function, or list acquisition function of the definition File is activated.

To Page Top

Information that is specified

Member name	Optional	Value to Setup
filename	Not possible	Indicates File.
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 filepath does not contain "jp1ima`\`conf`\`user", it is considered an invalid File pass. If File with the name specified in filename does not exist in the specified Filepath It is regarded as an invalid definition. If this Setup option is omitted, the directory where JP1/IM - Agent is to be installed is assumed to be `Agent-path/conf/user` (for a logical environment, replace "`Agent-path`" with "`Shared-directory/jp1ima`).
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	For Windows, describe the action (command-line) to execute when the definition file is updated at the file destination directory that is the relative path from one layer upper from installed directory. For Linux, describe the action (command-line) to execute when the definition file is updated at the relative path from `/opt/`. For detail, see ■Description of updateaction.

■Description of updateaction

You can list the commands that is executed after updating File. The maximum length of a command line that can be written is 4096 bytes.

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

The following types of commands can be Executed:

Hosts that Execute Commands Are Windows

Execute 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 be Executed)

Hosts that Execute Commands Are Linux

Linux Commands
Shell scripts

Note that you cannot Execute the following commands:

Commands that require interaction
Command 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 mechanisms and DDE (for Windows)
Commands that shutdown OS, such as shutdown and halt

■Definition File that can be specified for the user-created definition file list definition file

Definition File that can be specified	What to Execute if File is updated		Displayed category on GUI
Definition File that can be specified	Command Execute	Command line	Displayed category on GUI
Blackbox exporter Monitored (User-Defined) Discovery configuration file (file_sd_config_blackbox_ any name.yml)	Reload of Prometheus server	■In Windows For a physical host `cmd.exe /c` `Agent-path\addon_management\prometheus\addon_jpc_service_reload.bat` For a logical host `cmd.exe /c` `Agent-path\addon_management\prometheus\addon_jpc_service_reload.bat -h` `Logical-host` ■In Linux For a physical host `/bin/sh -c /opt/jp1ima/addon_management/prometheus/addon_jpc_service_reload` For a logical host `/Bin/sh -c /opt/jp1ima/addon_management/prometheus/addon_jpc_service_reload -h` `Logical-host`	jp1_imexporter
User-specific discovery configuration file (user_file_sd_config_ any name.yml)	Reload of Prometheus server		jp1_imexporter
Monitoring Fluentd's text-formatted log file definition file (fluentd_trap-name_tail.conf) ^#	Restart of Fluentd service	■In Windows For a physical host `cmd.exe /c` `Agent-path\addon_management\fluentd\addon_jpc_service_reload.bat` For a logical host `cmd.exe /c` `Agent-path\addon_management\fluentd\addon_jpc_service_reload.bat -h` `Logical-host` ■In Linux For a physical host `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload` For a logical host `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload -h` `logical-host`	jp1_imfluenntd
Monitoring Fluentd's Windows event-log definition file (fluentd_trap-name_wevt.conf) ^#	Restart of Fluentd service		jp1_imfluenntd
CA Certificate File (for Blackbox exporter) ^#	Reload of Blackbox exporter	Same as Process exporter configuration file (jpc_blackbox_exporter.yml).	jp1_certificate
Client Certificate File (for Blackbox exporter) ^#
Client Certificate Key File (for Blackbox exporter) ^#
Password File (for Blackbox exporter)^#
Environment variable file (any File name) ^#	Not required (Environment variable file is referenced when the command Execution starts)	--	--
Log metrics definition file (fluentd_`any-name`_logmetrics.conf)	Restart of Fluentd service	■In Windows For a physical host `cmd.exe /c` `Agent-path\addon_management\fluentd\addon_jpc_service_reload.bat` For a logical host `cmd.exe /c` `Agent-path\addon_management\fluentd\addon_jpc_service_reload.bat -h` `Logical-host` ■In Linux For a physical host `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload` For a logical host `/bin/sh -c /opt/jp1ima/addon_management/fluentd/addon_jpc_service_reload -h` `logical-host`	jp1_imfluentd

Legend:: --: Not applicable
#: It can also be specified if File is Add or Deleted.

To Page Top