Hitachi

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


Summary of amendments

The following table lists changes in this manual (3021-3-L06(E)) and product changes related to this manual.

Changes

Location

Added the following commands:

  • jddupdateaction

  • jimgndbbackup

  • jimgndbrestore

  • jimgndbsetup

  • jimgndbunsetup

  • jimgndbstop

  • jimgndbstatus

  • promtool

  • jimasecret

  • jimasetup

  • jpc_service

  • jpc_service_autostart

  • jpc_service_start

  • jpc_service_stop

1. Format of command explanations, 1. Lists of commands, 1. jddupdateaction, 1. jimgndbbackup, 1. jimgndbrestore, 1. jimgndbsetup, 1. jimgndbunsetup, 1. jimgndbstop, 1. jimgndbstatus, 1. promtool, 1. jimasecret, 1. jimasetup, 1. jpc_service, 1. jpc_service_autostart, 1. jpc_service_start, 1. jpc_service_stop

With the following commands, the monitored OS added English UTF-8 to the character code of Linux:

  • jcfallogdef

  • jcfallogstart

1. jcfallogdef, 1. jcfallogstart

Added notes to the following commands:

  • jcfallogdef

  • jcfallogreload

  • jcfallogstart

  • jcfallogstat

  • jcfallogstop

  • jcfexport

  • jcfimport

  • jddcreatetree

  • jcfvirtualchstat

  • jcoegschange

  • jcshostsexport

  • jcshostsimport

  • jimdbupdate

1. jcfallogdef, 1. jcfallogreload, 1. jcfallogstart, 1. jcfallogstat, 1. jcfallogstop, 1. jcfexport, 1. jcfimport, 1. jddcreatetree, 1. jcfvirtualchstat, 1. jcoegschange, 1. jcshostsexport, 1. jcshostsimport, 1. jimdbupdate

Added explanations and notes about the Intelligent Integrated Management Database to the following commands:

  • jddupdatetree

  • jco_killall.cluster (UNIX only)

  • jco_start (UNIX only)

  • jco_start.cluster (UNIX only)

  • jco_stop (UNIX only)

  • jco_stop.cluster (UNIX only)

  • jim_log.bat (Windows only)

  • jim_log.sh (UNIX only)

  • jimdbbackup

  • jimdbrecovery

1. jddupdatetree, 1. jco_killall.cluster (for UNIX only), 1. jco_start (for UNIX only), 1. jco_start.cluster (for UNIX only), 1. jco_stop (for UNIX only), 1. jco_stop.cluster (for UNIX only), 1. jim_log.bat (for Windows only), 1. jim_log.sh (for UNIX only), 1. jimdbbackup, 1. jimdbrecovery

The description of the range of dates and times that can be specified has been changed for the argument "-s output-start-date" of the jcoevtreport command.

1. jcoevtreport

Regarding the argument "-o retry-count:retry-interval" of jcoimdef command, the description of the value that can be specified for the number of retries was changed.

Also, the return values of the jcoimdef command were added.

1. jcoimdef

Descriptions on IM Exporter, which is built into JP1/IM - Agent, were added. Support for extended monitoring targets in cloud environments and container environments was added by using the IM Exporter add-on programs.

1. jimasecret, 2. Definition Files, 10.

Added the following definition files:

  • Suggestion definition file (user-created)

  • Auto response action definition file

  • Response action state monitoring definition file

  • User-created definition file list definition file

  • Definition files property file

  • Sample file of the event guide information file

  • Intelligent Integrated Management Database setup information file

  • Cluster environment Intelligent Integrated Management Database setup information file

  • Intelligent Integrated Management Database configuration file

  • Metric definition file for each Exporter

  • AWS definition file

  • imbase common configurration file

  • imbase configuration file

  • imbaseproxy configuration file

  • Alertmanager configuration file

  • Prometheus configuration file

  • Alert configuration file

  • Discovery configuration file for each Exporter

  • Service definition file

  • Unit definition file

  • Configuration files for each Exporter

  • Log monitoring common definition file

  • Log monitoring target definition file

  • Text-formatted log file monitoring definition file

  • Windows event-log monitoring definition file

  • imagent common configuration file

  • imagent configuration file

  • imagentproxy configuration file

  • imagentaction configuration file

  • Definition file property file

  • Environment variable file

  • IM Exporter Definition Files

2. Suggestion definition file (imdd_suggestion.conf), 2. Auto response action definition file (autoactconf.json), 2. Response action state monitoring definition file (responseactionnotice.conf), 2. User-created definition file list definition file (imdd_user_deffile_list.json), 2. Definition file properties file (imdd_file_properties.json), 2. Event guide information file (jco_guide.txt), 2. Intelligent Integrated Management Database setup information file (jimgndbsetupinfo.conf), 2. Cluster environment Intelligent Integrated Management Database setup information file (jimgndbclustersetupinfo.conf), 2. Intelligent Integrated Management Database configuration file (postgresql.conf), 2. Node exporter metric definition file (metrics_node_exporter.conf), 2. Windows exporter metric definition file (metrics_windows_exporter.conf), 2. Blackbox exporter metric definition file (metrics_blackbox_exporter.conf), 2. Yet another cloudwatch exporter metric definition file (metrics_ya_cloudwatch_exporter.conf), 2. Fluentd metric definition file (metrics_fluentd.conf), 2. Any Prometheus trend name metric definition file (metrics_any-Prometheus-trend-name.conf), 2. User-specific metric definition file (metrics_any-Prometheus-trend-name.conf), 2. AWS definition file (aws_settings.conf), 2. imbase common configuration file (jpc_imbasecommon.json), 2. imbase configuration file (jpc_imbase.json), 2. imbaseproxy configuration file (jpc_imbaseproxy.json), 2. Alertmanager configuration file (jpc_alertmanager.yml), 2. Prometheus configuration file (jpc_prometheus_server.yml), 2. Alert configuration file (jpc_alerting_rules.yml), 2. Node exporter discovery conffiguration file (jpc_file_sd_config_node.yml), 2. Windows exporter discovery configuration file (jpc_file_sd_config_windows.yml), 2. Blackbox exporter (HTTP/HTTPS monitoring) discovery configuration file (jpc_file_sd_config_blackbox_http.yml), 2. Blackbox exporter (ICMP monitoring) discovery configuration file (jpc_file_sd_config_blackbox_icmp.yml), 2. Yet another cloudwatch exporter discovery configuration file (jpc_file_sd_config_cloudwatch.yml), 2. User-specific discovery configuration file (file_sd_config_any-name.yml), 2. Service definition file (jpc_program-name_service.xml), 2. Unit definition file (jpc_program-name.service), 2. Windows exporter confiuration file (jpc_windows_exporter.yml), 2. Blackbox exporter configuration file (jpc_blackbox_exporter.yml), 2. Yet another cloudwatch exporter configuration file (jpc_ya_cloudwatch_exporter.yml), 2. Log monitoring common definition file (jpc_fluentd_common.conf), 2. Log monitoring target definition file (jpc_fluentd_common_list.conf), 2. Monitoring text-formatted log file definition file (fluentd_@@trapname@@_tail.conf.template), 2. Windows event log monitoring definition file (fluentd_@@trapname@@_wevt.conf.template), 2. imagent common configuration file (jpc_imagentcommon.json), 2. imagent configuration file (jpc_imagent.json), 2. imagentproxy configuration file (jpc_imagentproxy.json), 2. imagentaction configuration file (jpc_imagentaction.json), 2. User-created definition file list definition file (jpc_user_deffile_list.json), 2. Definition file property file (jpc_file_properties.json), 2. Environment variable file (any-file-name), 2. About definition of common placeholders for descriptive items in yml file, 10.

Added descriptions of definition files that can be updated using the integrated operation viewer or REST API.

2. List of definition files

Changed the description of the numerical values stored in the attribute name "E.START_TIME" (start time) and attribute name "E.END_TIME" (end time) of the argument "attribute-name":"attribute-value".

2. Suggestion definition file (imdd_suggestion.conf)

Added clarification for auto responseAction and manual responseAction.

2. Configuration file for converting information (event_info_replace.conf)

Changed the period that can be specified for the argument "date start-date-end date".

2. Common-exclusion-conditions extended definition file

Changed the range of numeric values that can be converted in a variable that converts the number of seconds elapsed since 1970/01/01 to a string.

2. Display message change definition file (jcochmsg.conf)

Changed the description of arguments statement in the definition file for the Tool Launcher window.

2. Definition file for the Tool Launcher window

The range of numerical values that can be output has been changed for JP1 event attributes defined in the item file.

2. Item file

The following JP1 events were added to the JP1 events output by JP1/IM - Manager:

  • JP1 event for response action

  • Events related to the generation or propagation of IM Management Node Related Information

In addition, JP1 events issued by JP1/IM - Agent were added.

3.2.1, 3.2.2, 3.2.3

The following methods were added to the method implemented by the user-created Plug-ins:

  • __configurationGetAdapterless

  • __transformEvent

  • __simtLoad

4.4.4, 4.4.4(2), 4.4.4(5), 4.4.4(8)

Added or changed the following description to __configurationGet method:

  • Added a description of the target host definition file for configuration collection

  • Changed the remarks of component member

  • Added "Managing Trend Data by IM management node" to the affected functions

4.4.4(1)

The following methods have been added to the common methods that can be used with each method of the user-created Plug-ins:

  • jp1TrendDataService.getTrendData

  • jp1TrendDataService.getLabelList

4.5, 4.5.17, 4.5.18

The following JP1/IM - Manager APIs has been added:

  • Initial secret issue

  • IM Client secret delete

  • IM Client secret issue

  • IM Client list acquisition

  • JP1 Event converter

  • Generation of IM management node related information

  • Reflection of IM management node related information

  • Write Trend Data

  • Get distribution (File download)

  • Obtain execution result of Response Action

  • Manual execution of Response Action

  • Convert event-takeover info

  • Get definition file list

  • Get definition file

  • Delete definition file

  • Updated definition file

  • Retrieve integrated agent info

  • Delete integrated agent info

  • Retrieve Secret List

  • Add, update, delete the secrets

  • Retrieve lower manager info list

  • Add lower manager info

  • Delete lower manager info

In addition, the following JP1/IM - Agent APIs has been added:

  • Reload Prometheus server

  • Prometheus server health check

  • Alertmanager health check

  • Get silence list of Alertmanager

  • Silence creation of Alertmanager

  • Silence Revocation of Alertmanager

  • Get silence of Alertmanager

  • Reload Blackbox exporter

  • API for scrape of Exporter used by JP1/IM - Agent

5.1, 5.4.3, 5.4.4, 5.4.5, 5.4.6, 5.6.5, 5.8.1, 5.8.2, 5.11.3, 5.15, 5.16, 5.17, 5.18, 5.19, 5.20, 5.21, 5.22, 5.23

The following explanations have been added or changed regarding the common API specifications:

  • Changed the description of the request format item "component".

  • Changed the range of numbers that can be specified for the date and time notation "YYYY".

  • Added Basic authentication with client secret information to REST API authentication method.

  • Changed the description of authentication method for Basic authentication using login information added to REST API.

5.2.3, 5.2.7, 5.2.8, 5.2.8(2), 5.2.8(4)

Changed the description of event attribute values registered in the event registration function of Event generation API.

5.6.4

Added jp1im_TrendData_labels to variable name related to the additional information specified in the configuration information SID.

7.1.1

The following objects were added to the json objects:

  • Trend data

  • Label Set List

  • Auto Response Action Definition

  • Integrated agent Info

7.2, 7.2.3, 7.2.4, 7.2.5

Added descriptions of the cloud service log linkage tools that registers various log data generated in Amazon Web Services and Azure as JP1 events.

11.

Linkage with JP1/Integrated Management - Rule Operation is no longer supported.

--

The following OSs are now supported:

  • Windows 11

  • Windows Server 2022

  • Linux 9

  • Oracle Linux 9

--

The following OSs are no longer supported:

  • Windows Server 2012

  • Linux 6 (x64)

  • Oracle Linux 6 (x64)

  • CentOS 7

  • CentOS 6 (x64)

--

In addition to the above changes, minor editorial corrections were made.