Hitachi

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


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

Organization of this page

Format

#IM GNDATABASE SERVICE - Port Number
IMGNDBPORT=port-number-for-intelligent-integrated-management-database
#TREND DATA MANEGEMENT SERVICE - Port Number
TDMSPORT=trend-data-management-service-port-number
#IM GNDATABASE SERVICE - Data Storage Directory 
IMGNDBDIR=data-storage-directory-for-intelligent-integrated-management-database
#IM GNDATABASE SERVICE - Data Base Binary 
IMGNDBENVDIR=directory-where-intelligent-integrated-management-database-is-installed
#IM GNDATABASE SERVICE - Retention
RETENTION=retention-period-of-time-series-data-in-trend-data-management-DB
#IM GNDATABASE SERVICE - Username
USERNAME=user-name-of-OS-used-to-start-intelligent-integrated-management-database
# TREND DATA DATABASE - MAX DISK SIZE [GB]
TDDBDISKMAX=max-disk-requirements-of-trend-data-management-database
# TREND DATA DATABASE - CUT-OFF TERM [Days]
TDDBCUTOFFTERM=truncation-duration-when-trend-data-is-deleted

File

jimgndbsetupinfo.conf#

jimgndbsetupinfo.conf.model (model file)

#: The installer creates it from a duplicate of the model file by deleting extension ".model".

Storage directory

In Windows

Manager-path\conf\imgndb\setup\

In UNIX

/etc/opt/jp1imm/conf/imgndb/setup/

Description

A file that describes the definitions that are required during the setup of the Intelligent Integrated Management database.

Character code

ASCII (You cannot specify multi byte characters.)

When the definitions are applied

At setup time (when the jimgndbsetup command is executed), the contents of this file are read and the environment of the intelligent integrated management database is built with the values specified for each item.

Information that is specified

IMGNDBPORT=port-number-for-intelligent-integrated-management-database

Specifies port number used by the Intelligent Integrated Management database.

The port number specified must be unique for each host that Setup creates.

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

If you want to change the setting during operation, change this value and run the jimgndbsetup command. The extension of the command restarts the service and takes effect.

TDMSPORT=trend-data-management-service-port-number

Specifies the port number used by the Trend Data Management Service.

The port number that you specify must be unique for each system and host that Setup creates.

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

If you want to change the setting during operation, change this value and run the jimgndbsetup command. The extension of the command restarts the service and takes effect.

IMGNDBDIR=data-storage-directory-for-intelligent-integrated-management-database

Specifies the absolute path of the directory in which the data of the Intelligent Integrated Management database is stored.

  • In Windows

    Specify a character string of up to 100 single-byte alphanumeric characters, including "_" (underscore), "\", "(", ")", and "." (period), and single-byte spaces.

  • In Linux

    Specify a character string of up to 100 single-byte alphanumeric characters, including "_" (underscore), "/" (slash), and "." (period).

During setup, create an imgndb directory directly under the specified directory and build a trend data management DB. If the trend data management DB has already been built, it cannot be changed from the specified contents at the time of construction.

The defaults are following:

In Windows: Manager-path\database

In Linux: /var/opt/jp1imm/database

If omitted, the default value is assumed.

IMGNDBENVDIR=directory-where-intelligent-integrated-management-database-is-installed

Specifies the absolute path of the directory where the Intelligent Integrated Management Database to be installed.

  • In Windows

    Specify a character string of up to 200 single-byte alphanumeric characters, including "_" (underscore), "\", "(", ")", and "." (period), and single-byte spaces.

  • In Linux

    Specify a character string of up to 200 single-byte alphanumeric characters, including "_" (underscore), "/" (slash), and "." (period).

During setup, imgndbbin directory is created directly under the specified directory, and the Intelligent Integrated Management Database is expanded. If you have already built an Intelligent Integrated Management Database, you cannot change it from the specification at the time of construction.

The defaults are following:

In Windows: Manager-path\dbms

In Linux: /var/opt/jp1imm/dbms

If omitted, the default value is assumed.

RETENTION=retention-period-of-time-series-data-in-trend-data-management-DB

Specify the retention period (unit: days) of the data stored in the trend data management DB.

The range is 1 to 1096.

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

If you want to change the setting during operation, change this value and run the jimgndbsetup command. The extension of the command restarts the service and takes effect.

USERNAME=user-name-of-OS-used-to-start-intelligent-integrated-management-database

Specifies OS username from which the Intelligent Integrated Management Database is to be started in Linux (users who actually exist and are available for Login by users other than root). If specified in Windows configuration, it is ignored.

There is no default value. This specification is not optional.

If you want to change the setting during operation, change this value and run the jimgndbsetup command. The extension of the command restarts the service and takes effect.

TDDBDISKMAX=max-disk-requirements-of-trend-data-management-database

Specifies the upper limit (in gigabytes) of the disk space required for Trend data Management Database. Automatic Delete occurs when Trend data Management Database disk requirements exceed 90% of this Value. If 0 is specified, the upper limit is not Setup.

The range is 0 or 10 to 131,072.

The default is 150. If the specification is omitted, the default Value is assumed.

If you want to change Setup during operation, change this Value and Execute jimgndbsetup command. Restart the service with the extension of the command. It will be reflected.

Notes:

When using monitoring Trend data Management Database Disk Requirements feature, we recommend that you specify a Value that exceeds the 10-day data size of the trend data stored in Trend data Management Database.

TDDBCUTOFFTERM=truncation-duration-when-trend-data-is-deleted

Specifies the duration (in days) of the trend data to delete when trend data management database disk requirements reach 90% of the size specified for TDDBDISKMAX. If TDDBDISKMAX is 0, this field is ignored.

The range is 1 to 31.

The default is 7. If the specification is omitted, the default Value is assumed.

If you want to change setup during operation, change this value and Execute jimgndbsetup command. Restart the service with the extension of the command. It will be reflected.

Example definition

#IM GNDATABASE SERVICE - Port Number
IMGNDBPORT=20705
#TREND DATA MANEGEMENT SERVICE - Port Number
TDMSPORT=20706
#IM GNDATABASE SERVICE - Data Storage Directory 
IMGNDBDIR=C:\Program Files (x86)\Hitachi\JP1IMM\database
#IM GNDATABASE SERVICE - Data Base Binary 
IMGNDBENVDIR=C:\Program Files (x86)\Hitachi\JP1IMM\dbms
# IM GNDATABASE SERVICE - Retention
RETENTION=32
# TREND DATA DATABASE - MAX DISK SIZE [GB]
TDDBDISKMAX=764
# TREND DATA DATABASE - CUT-OFF TERM [Days]
TDDBCUTOFFTERM=7
#IM GNDATABASE SERVICE - Port Number
IMGNDBPORT=20705
#TREND DATA MANEGEMENT SERVICE - Port Number
TDMSPORT=20706
#IM GNDATABASE SERVICE - Data Storage Directory 
IMGNDBDIR=/var/opt/jp1imm/database
#IM GNDATABASE SERVICE - Data Base Binary 
IMGNDBENVDIR=/var/opt/jp1imm/dbms
# IM GNDATABASE SERVICE - Retention
RETENTION=32
# IM GNDATABASE SERVICE - Username
USERNAME=USER01
# TREND DATA DATABASE - MAX DISK SIZE [GB]
TDDBDISKMAX=764
# TREND DATA DATABASE - CUT-OFF TERM [Days]
TDDBCUTOFFTERM=7