Hitachi

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


List of definition files

The following table lists the JP1/Integrated Management definition files.

Organization of this page

List of definition files

Table 2‒1: List of definition files

Product name

Definition file name

Description

JP1/Base

Configuration definition file

Defines the system hierarchy that is to be managed by JP1/IM. For details about the configuration definition file (jbs_route.conf), see the JP1/Base User's Guide.

Environment variable file#3

Defines environment variables to be used when commands are executed at managed hosts in JP1/IM. For details about the environment variable file, see the JP1/Base User's Guide.

Host group definition file

Defines a group of managed hosts in JP1/IM. For details about the host group definition file, see the JP1/Base User's Guide.

JP1/IM - Manager

JP1/IM - Manager

Common definition settings file (changing the attribute of JP1 events)

Changes the attribute of JP1 events.

Operation log definition file (imm_operationlog.conf)

Defines whether to output operation log data, the output destination, log file size, and number of files.

Intelligent Integrated Management Base

Intelligent Integrated Management Base definition file (imdd.properties)

Defines system settings for the Intelligent Integrated Management Base.

System node definition file (imdd_systemnode.conf)#3

Contains settings to define the hierarchical structure of the system to represent the structure in a sunburst or tree chart, and settings to group collected data into defined hosts.

Category name definition file for IM management nodes (imdd_category_name.conf)#3

Defines IM management node category names for management groups to be displayed in a sunburst or tree chart.

Target host definition file for configuration collection (imdd_target_host.conf)#3

Defines the hosts from which to collect information regarding monitoring objects of each linked product.

Host name definition file (imdd_host_name.conf)#3

Defines mapping between aliases and real host names.

IM management node link definition file (imdd_nodeLink_def.conf)#3

Defines relationships between IM management nodes.

Suggestion definition file (imdd_suggestion.conf)#3

Defines criteria for suggesting response actions and what the actions do, which are used by the suggestion function.

Suggestion definition file (user-created) (imdd_suggestion_any-file-name.conf)#3,#4

Single sign-on mapping definition file (imdd_sso_mapping.properties)#3

Defines the mapping between the name of the JP1 user used in the Intelligent Integrated Management Base and the name of the user registered in the OpenID provider.

Auto response action definition file (autoactconf.json) #3

A file that restores execution conditions in Automatic Response Action and Automatic Response Action definition, which is executed contents are recorded.

Response action state monitoring definition file (responseactionnotice.conf)

A file that defines setup for monitoring execute status for automated Response Action.

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

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

Definition file properties file (imdd_file_properties.json)

This File defines file name, file path, and the operation for importing the definition file when acquiring or updating the definition file.

Central Console

Event-source-host mapping definition file (user_hostmap.conf)#3

Defines mapping on the event source host.

Automated action environment definition file (action.conf.update)

Defines an execution environment for automated actions.

Automated action definition file (actdef.conf)

Defines conditions for executing an automated action and the command to be executed as the action.

Automated action definition file (actdef.conf) (for conversion)

Defines (for conversion) conditions for executing an automated action and the command to be executed as the action.

Automatic action notification definition file (actnotice.conf)

Defines the automated action status notification function.

Extended startup process definition file (jp1co_service.conf)

Defines process information for the functions that constitute JP1/IM - Manager.

IM parameter definition file (jp1co_param_V7.conf)

Defines whether a JP1 event is to be issued when JP1/IM - Manager processes fail or when JP1/IM - Manager processes are recovered automatically from abnormal termination.

System profile (.system)

Defines environment information for the basic operation of the event console.

User profile (defaultUser | profile_user-name)

Defines environment information for how the Event Console window is displayed.

Communication environment definition file (console.conf.update)

Defines communication processing (timeout period) among JP1/IM - Manager, the viewer, and the jcochstat command.

Health check definition file (jcohc.conf)#3

Defines whether the health check function is to be enabled.

Event guide information file (jco_guide.txt)#3,#4

Defines event guide information for JP1 events that occur in the system and create problems.

Event guide information sample file (sample_jco_guide_ja.txt, sample_jco_guide_en.txt)#3

Sample files that defines event guide information for JP1 events that occur in the system and create problems.

Status event definition file (processupdate.conf)

Defines whether a JP1 event is to be issued when the action status changes.

Correlation event generation system profile (egs_system.conf)#3

Defines the start and stop operations for the Event Generation Service.

Correlation event generation definition file#3,#4

Defines the JP1 event conditions that result in generation of correlation events and the correlation events that are generated when the JP1 event conditions are satisfied.

Correlation event generation environment definition file#3,#4

Defines the size and number of correlation event generation history files.

Definition file for manually registering incidents (incident.conf)

A definition file for linkage with JP1/Service Support. The file defines JP1/Service Support for linkage with JP1/IM - View.

Configuration file for incident inheritance information(incident_info.conf)

A configuration file for linkage with JP1/Service Support. The file defines JP1 events' attributes and character strings to be inherited by incidents.

Severity changing definition file (jcochsev.conf)#3

Defines conditions for changing the severity of JP1events and the new severity level.

Command button definition file (cmdbtn.conf)#3

Defines command buttons to be displayed in the Execute Command window.

File that defines which items are displayed for event conditions (attr_list.conf)

Specifies the conversion rules for the automated action and command execution event inheritance function.

Configuration file for converting information (event_info_replace.conf)

Specifies the conversion rules for the automated action event inheriting function.

Item file

Specifies the JP1 event attributes that are to be output during output of event reports.

Environment definition file for event report output (evtreport.conf)

Defines the execution environment of the event report output function.

Filter file

Defines filter conditions to be applied during output of event reports.

System color definition file (systemColor.conf)#3

Defines the color settings used for an event list.

Definition file for extended event attributes#3,#4

Defines extended attributes of JP1 events.

Definition file for extended event attributes (extended file)#3,#4

Defines the settings for displaying program-specific extended attributes of JP1 events as item names on the screen and in the output of event reports.

Definition file for object types

Defines the object types of the extended attributes of JP1 events.

Common-exclusion-conditions extended definition file#3,#4

Defines the event conditions or the applicable period of the extended-mode common exclusion-conditions.

Common-exclusion-conditions display item definition file (common_exclude_filter_attr_list.conf)#3

Specifies the items to be displayed in the Attribute name display area in the Common Exclusion-Conditions Settings (Extended) window.

Common-exclusion-conditions auto-input definition file (common_exclude_filter_auto_list.conf)#3

Defines JP1 event attributes that are set automatically when the Common Exclusion-Conditions Settings (Extended) window opens.

Display item definition file for the repeated event condition (event_storm_attr_list.conf)#3

Specifies the items to be displayed in the Attribute name display area in the Repeated Event Condition Settings window.

Auto-input definition file for the repeated event condition (event_storm_auto_list.conf)#3

Defines the attribute of a JP1 event that is set automatically when the Repeated Event Condition Settings window opens.

Display item definition file for the severity change definition (chsev_attr_list.conf)#3

A definition file that specifies the items to display in the Attribute name display area of the Severity Change Definition Settings window.

Auto-input definition file for the severity change definition (chsev_auto_list.conf)#3

Defines the JP1 event attribute that is set automatically when the Severity Change Definition Settings window opens.

Definition file for opening monitor windows#3,#4

Defines settings for opening monitor windows.

Email environment definition file (jimmail.conf)

A definition file that sets information necessary to send an email by using JP1/IM - Manager.

Display message change definition file (jcochmsg.conf)#3

Defines the JP1 event conditions and new messages when changing the display of messages using the event display message change function.

Display item definition file for a display message change definition (chmsg_attr_list.conf)#3

Specifies the items to be displayed in the Attribute name display area of the Display Message Change Definition Settings window.

Automatic input definition file for a display message change definition (chmsg_auto_list.conf)#3

Specifies the conditions to be automatically set when the Display Message Change Definition Settings window opens.

Environment definition file for events after the display message is changed (chmsgevent.conf)

Defines the behavior of the function for issuing an event when a display message is changed.

Central Scope

Host information file (jcs_hosts)

Defines the host information that is managed by JP1/IM - Manager (Central Scope).

Guide information file (jcs_guide.txt)#1

Defines guide information about the JP1 events that trigger a change in monitoring object status.

Settings file for the maximum number of status change events (evhist_warn_event_xxx.conf)#2

Defines whether a JP1 event is to be issued when the number of status change events for a monitoring object exceeds a maximum value.

Settings file for the completed-action linkage function (action_complete_xxx.conf)#2

Defines whether the completed-action linkage function is to be enabled.

Definition file for automatic delete mode of status change event

Defines whether the function that automatically deletes the status change events when a JP1 event's status becomes Processed is to be enabled.

Definition file for monitoring object initialization mode

Defines whether the function that initializes monitoring objects when a specific JP1 event is received is to be enabled.

Automatic backup and recovery settings file for the monitoring object database (auto_dbbackup_xxx.conf)#2

Defines whether the function that protects the monitoring object database from corruption caused by OS shutdown or cluster system switching during monitoring tree update processing is to be enabled.

Definition file for on memory mode of status change condition

Specifies whether the memory-resident status change condition function is to be enabled.

System profile of Central Scope (jcs_sysprofile_xxx.def)#1

Common definition information for Central Scope viewer.

When you log in to Central Scope, this file is sent to Central Scope viewer.

IM Configuration Management

Operation definition file for IM Configuration Management - View (jcfview.conf)

Specifies the operation of IM Configuration Management - View.

Apply-IM-configuration-method definition file (jp1cf_applyconfig.conf)

Defines how to apply the system hierarchy.

Host input information file (host_input_data.csv)

An export file for host input information related to managed hosts of IM Configuration Management.

Collected host information file (host_collect_data.csv)

An export file for collected host information related to managed hosts of IM Configuration Management.

Profile management environment definition file (jp1cf_profile_manager.conf)

Defines information about the execution environment for the profile management function.

Remote log trap environment definition file (jp1cf_remote_logtrap.conf)

Defines the execution environment for the remote-monitoring log file trap function and the remote-monitoring event log trap function.

Remote-monitoring log file-trap action definition file

Defines actions for the remote monitoring log trap function.

Remote-monitoring event log trap action-definition file

Defines actions for the remote monitoring event log trapping function.

IM database

Setup information file (jimdbsetupinfo.conf)

Specifies setup information, such as the size of the IM database and the directory for storing data for the IM database, when the integrated monitoring database and IM Configuration Management database are set up.

Cluster setup information file (jimdbclustersetupinfo.conf)

A file that describes the directory to store the size or data of the IM database for a logical host when the integrated monitoring database and IM Configuration Management database are set up in a cluster environment.

Intelligent Integrated Management Database

Intelligent Integrated Management Database setup information file (jimgndbsetupinfo.conf)

File that describes the items required when setting up Intelligent Integrated Management Database.

Cluster environment Intelligent Integrated Management Database setup information file (jimgndbclustersetupinfo.conf)

A File that describes the items required when setting up a clustered Intelligent Integrated Management Database environment.

Intelligent Integrated Management Database configuration file (postgresql.conf)

File that describes the parameter definition for Intelligent Integrated Management Database (PostgreSQL).

Product plug-ins of JP1/IM - Agent

Node exporter metric definition file (metrics_node_exporter.conf)#3

This File defines metric of Node exporter to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

Process exporter metric definition file (metrics_process_exporter.conf)#3

This file defines Process exporter metric information shown in the Trends tab of the Integrated Operation Viewer window.

Node exporter (Service monitoring) metric definition file (metrics_node_exporter_service.conf)#3

This file defines metric information of Node exporter (Service monitoring) displayed on the [Trend] tab of [Integrated Operation Viewer] window.

Windows exporter metric definition file (metrics_windows_exporter.conf)#3

This File defines metric of Windows exporter to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

Windows exporter (process monitoring) metric definition file (metrics_windows_exporter_process.conf)#3

This file defines Windows exporter (process monitoring) metric information shown in the Trends tab of the Integrated Operation Viewer window.

Windows exporter (Service monitoring) metric definition file (metrics_windows_exporter_service.conf)#3

This file defines metric information of Windows exporter (Service monitoring) displayed on the [Trend] tab of [Integrated Operation Viewer] window.

Node exporter for AIX metric definition file (metrics_node_exporter_aix.conf)#3

This file defines metric information of Node exporter for AIX displayed on the [Trend] tab of [Integrated Operation Viewer] window.

Blackbox exporter metric definition file (metrics_blackbox_exporter.conf)#3

This File defines metric of Blackbox exporter to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

Yet another cloudwatch exporter metric definition file (metrics_ya_cloudwatch_exporter.conf)#3

This File defines metric of Yet another cloudwatch exporter to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

Promitor metric definition file (metrics_promitor.conf)#3

This file defines Promitor metric information shown in the Trends tab of the Integrated Operation Viewer window.

Script exporter metric definition file (metrics_script_exporter.conf)#3

This file defines Script exporter metric information shown in the Trends tab of the Integrated Operation Viewer window.

Fluentd metric definition file (metrics_fluentd.conf)#3

This File defines metric of Fluentd to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

OracleDB exporter metric definition file (metrics_oracledb_exporter.conf)#3

This file defines metric information of OracleDB exporter displayed on the [Trend] tab of [Integrated Operation Viewer] window.

OracleDB exporter default collection metric definition file (default-metrics.toml)

A file that defines the metrics that the OracleDB exporter retrieves.

Container monitoring metric definition file (metrics_kubernetes.conf)#3

This file defines the container monitoring metric information shown in the Trends tab of the Integrated Operation Viewer window.

Any Prometheus trend name metric definition file (metrics_any-Prometheus-trend-name.conf)#3,#4

This File defines metric to be displayed on the [Trend] tabbed page of Integrated Operation Viewer window.

User-specific metric definition file (metrics_any-Prometheus-trend-name.conf)#3,#4

A File that defines your own metric properties to be displayed on the [Trends] tabbed page of Integrated Operation Viewer window.

User-specific metric definition file (Promitor) (metrics_any-Prometheus-trend-name.conf)#3,#4

This file defines the user specific metric information which displayed in the Trend tab of Integration Operation Viewer window.

User-specific metric definition file (container monitoring) (metrics_any-Prometheus-trend-name.conf)#3,#4

This file defines the user specific metric information which displayed in the Trend tab of Integration Operation Viewer window.

AWS definition file (aws_settings.conf)#3

Configuration file for AWS and Yet another cloudwatch exporter.

JP1/IM - Agent (JP1/IM agent management base)

imbase common configuration file (jpc_imbasecommon.json)

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

imbase configuration file (jpc_imbase.json)

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

imbaseproxy configuration file (jpc_imbaseproxy.json)

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

JP1/IM - View

Communication environment definition file (view.conf.update)

Defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Console).

Communication environment definition file (tree_view.conf.update)

Defines timeout periods for communication between JP1/IM - View and JP1/IM - Manager (Central Scope).

Non-encryption communication host configuration file (nosslhost.conf)

Configures hosts that use non-encrypted communication.

IM-View settings file (tuning.conf)

Defines the operation of JP1/IM - View, such as the number of connected-host log entries in the Login window and the operation when the Event Console window is displayed.

Web page call definition file (hitachi_jp1_product-name.html)

Used for calling another product's Web page from the Tool Launcher window.

Start program definition file (!JP1_CS_APP0.conf)

Defines the start path for a program that is added to the toolbar in the Monitoring Tree window.

Toolbar definition file (!JP1_CS_FTOOL0.conf)

Defines the order of programs that are added to the toolbar in the Monitoring Tree window.

Icon operation definition file (!JP1_CS_FTREE0.conf)

Defines the operation of icons that are added to the toolbar in the Monitoring Tree window.

Configuration file for monitoring tree

Defines the configuration of the monitoring tree that is displayed in the Monitoring Tree window.

Definition file for executing applications

Defines the IDs and paths of applications that are executed by the viewer.

Definition file for the Tool Launcher window

Defines the tree that is to be displayed in the Tool Launcher window.

System profile of the Central Scope viewer (system.conf)

Central Scope Viewer common definition information.

Defines the Monitoring Tree (Editing) window and the Visual Monitoring (Editing) window.

Performance report display definition file (performance.conf)

Defines the function for displaying the performance report of the host that issued the event. This file defines the URL of the connection-target instance of JP1/PFM - Web Console.

JP1/IM - Agent

Alertmanager configuration file (jpc_alertmanager.yml)#3

A configuration file that defines the operation of Alertmanager.

Prometheus configuration file (jpc_prometheus_server.yml)#3

A configuration file that defines the operation of Prometheus server.

Alert configuration file (jpc_alerting_rules.yml)#3

A File that defines the alert-evaluation rules that Prometheus server will Execute.

Node exporter discovery configuration file (jpc_file_sd_config_node.yml)#3

A File that Setup Node exporter that Prometheus server will scrape.

Process exporter discovery configuration file (jpc_file_sd_config_process.yml)#3

This file configures the Process exporter to be scraped by the Prometheus server.

Windows exporter discovery configuration file (jpc_file_sd_config_windows.yml)#3

A File that Setup Windows exporter that Prometheus server will scrape.

Node exporter for AIX discovery configuration file (jpc_file_sd_config_node_aix.yml)#3

Files that set Node exporter for AIX that Prometheus server will scrape.

Blackbox exporter (HTTP/HTTPS monitoring) discovery configuration file (jpc_file_sd_config_blackbox_http.yml)#3,#5

A File that Setup Blackbox exporter that Prometheus server will scrape for HTTP/HTTPS monitoring.

Blackbox exporter (HTTP/HTTPS monitoring) discovery configuration file (user-created) (file_sd_config_blackbox_module-name-start-with-http.yml)#3,#5

Blackbox exporter (ICMP monitoring) discovery configuration file (jpc_file_sd_config_blackbox_icmp.yml)#3

A File that Setup Blackbox exporter that Prometheus server will scrape for ICMP monitoring.

Blackbox exporter (ICMP monitoring) discovery configuration file (user-created) (file_sd_config_blackbox_module-name-start-with-icmp.yml)#3,#5

Yet another cloudwatch exporter discovery configuration file (jpc_file_sd_config_cloudwatch.yml)#3,#5

A File that Setup Yet another cloudwatch exporter that Prometheus server will scrape.

Promitor discovery configuration file (jpc_file_sd_config_promitor.yml)#3

This file configures the Promitor to be scraped by the Prometheus server.

OracleDB exporter discovery configuration file (jpc_file_sd_config_oracledb.yml)#3

Files that set OracleDB exporter that Prometheus server will scrape.

Script exporter discovery configuration file (jpc_file_sd_config_script.yml)#3

This file configures the Script exporter to be scraped by the Prometheus server.

User-specific discovery configuration file (user_file_sd_config_any-name.yml)#3,#5

A File that Setup Prometheus server to scrape. Exporter that you have prepared can also be subject to scrape.

Service definition file (jpc_program-name_service.xml)

A WinSW definition File for make programs Windows-service in a Windows environment.

Unit definition file (jpc_program-name.service)

A definition File for add programs to systemctl Add in a Linux.

Windows exporter configuration file (jpc_windows_exporter.yml)#3

A configuration file that defines the operation of Windows exporter.

Process exporter configuration file (jpc_process_exporter.yml)#3

The configuration file that determines the behavior of Process exporter.

Blackbox exporter configuration file (jpc_blackbox_exporter.yml)#3

A configuration file that defines the operation of Blackbox exporter.

Yet another cloudwatch exporter configuration file (jpc_ya_cloudwatch_exporter.yml)#3

A configuration file that defines the operation of Yet another cloudwatch exporter.

Promitor Scraper configuration file (metrics-declaration.yaml)#3

The configuration file that defines the metrics to be acquired by the Promitor Scraper.

Promitor Scraper runtime configuration file (runtime.yaml)#3

The configuration file that defines Promitor Scraper authentication information, ports used for scraping, and other information.

Promitor Resource Discovery configuration file (resource-discovery-declaration.yaml)#3

The configuration file that defines the resource group to be acquired by Promitor Resource Discovery.

Promitor Resource Discovery runtime configuration file (runtime.yaml)#3

The configuration file that defines Promitor Resource Discovery authentication information, ports used for scraping, and other information.

Script exporter configuration file (jpc_script_exporter.yml)#3

The configuration file that determines the behavior of Script exporter.

Sample file of Script exporter configuration file for SAP system monitoring (jpc_script_exporter_sap.yml)

This is a sample file of a configuration file that defines the operation of the Script Exporter for SAP system monitoring.

Log monitoring common definition file (jpc_fluentd_common.conf)#3

A File for defining Common behavior in fluentd, such as HTTP POST request function and log output function.

Log monitoring target definition file (jpc_fluentd_common_list.conf)#3

A File that specifies what to monitor for logging. Specifies File of monitoring definition file, which is text-formatted log file, or Windows event-monitoring definition file. The logging monitoring of the specified definition File is set to Enable.

Monitoring text-formatted log file definition file (fluentd_@@trapname@@_tail.conf.template)#3,#5

A Definition File for monitoring text-formatted log File.

Windows event log monitoring definition file (fluentd_@@trapname@@_wevt.conf.template)#3,#5

A Definition File for monitoring Windows event logs.

Sample file of system log information monitoring definition file for SAP system (fluentd_sap_syslog_tail.conf)

Sample file of the definition file for monitoring system log information of SAP system.

Sample file of CCMS alert information monitoring definition file for SAP system (fluentd_sap_alertlog_tail.conf)

Sample file of the definition file used to monitor CCMS alerting for SAP system.

Environment parameters file for jr3slget command (jr3slget.ini)

This file is used to set the output destination file name of the system log information of SAP system.

Sample file of environment parameters file for jr3slget command (jr3slget.ini.sample)

This file is used to set the output destination file name of the system log information of SAP system.

Environment parameters file for jr3alget command (jr3alget.ini)

This file is used to set the output-destination filename of CCMS alert information of SAP system.

Sample file of environment parameters file for jr3alget command (jr3alget.ini.sample)

This is a sample file of a file that sets the output destination file name of the CCMS alert information of the SAP system.

Log metrics definition file (fluentd_any-name_logmetrics.conf)#3#5

The Fluentd metric definition file used to read logs output by the application being monitored and convert them into log metrics.

Property label definition file (property_labels.conf)

The definition file used to convert IM management node property values into separate values.

imagent common configuration file (jpc_imagentcommon.json)

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

imagent configuration file (jpc_imagent.json)

A configuration file defines imagent operation of JP1/IM agent control base.

imagentproxy configuration file (jpc_imagentproxy.json)

A configuration file defines imagentproxy operation of JP1/IM agent control base.

imagentaction configuration file (jpc_imagentaction.json)

A configuration file defines imagentaction operation of JP1/IM agent control base.

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

A File that defines a user-created File that can be updated and delete with JP1/IM - Manager supplied REST API.

Definition file property file (jpc_file_properties.json)

A File describes File name, File path, and File import operations for the definition File that are to be manipulated by the acquisition or update functions of the definition File.

Environment variable file (any file name)#3,#5

A File that defines an environment-variable for Execute commands on JP1/IM managed hosts.

#1: The file name of the guide information file used in the system profile of Central Scope, and UNIX version of JP1/IM - Manager depend on the language used by the JP1/IM - Manager. The xxx part of the guide information file is explained later in the section describing details of each file.

#2: There are two settings files for the maximum number of status change events, two settings files for the completed-action linkage function, and two automatic backup and recovery settings files for the monitoring object database. Either on or off is set in xxx.

#3: A definition File that you can update using integrated operation viewer (for downloading and uploading a definition File) or REST API (for acquiring and updating a definition File). The following File can also be updated:

  • File for Blackbox exporter

    CA certificate File, client certificate File, client certificate key File, Password File

#4: Definition File that can be specified in User-created definition file list definition file (imdd_user_deffile_list.json).

#5: Definition File that can be specified in User-created definition file list definition file (jpc_user_deffile_list.json). You can also specify the following File:

  • File for Blackbox exporter

    CA certificate File, client certificate File, client certificate key File, Password File