Intelligent Integrated Management Base definition file (imdd.properties)

Organization of this page

Format
Files
Storage directory
Description
When the definitions are applied
Information that is specified
Notes
Example definition

Format

server.port=port-number
jp1.imdd.proxy.server[n].host=host-name-of-proxy-server[n]
jp1.imdd.proxy.server[n].port=port-number-of-proxy-server[n]
jp1.imdd.proxy.server[n].user=authentication-user-ID-of-proxy-server[n]
jp1.imdd.proxy.target[n].host=target-host[n]-of-REST-API-that-uses-proxy-server
jp1.imdd.proxy.target[n].serverHost=target-host-name[n]-of-destination-proxy-server
jp1.imdd.gui.settings.contentViews.<custom UI Id>.title=title-displayed-on-custom-UI-tab
jp1.imdd.gui.settings.contentViews.<custom UI Id>.url=path-to-html-file-displayed-in-user-defined-window-display-area
jp1.imdd.gui.settings.contentViews.<custom UI Id>.sid=tree-SID-of-IM-management-node-on-which-user-defined-windows-are-displayed
jp1.imdd.gui.settings.contentViews.<custom UI Id>.target=SID-of-IM-management-node-on-which-user-defined-windows-are-displayed
jp1.im.db.DEFAULT.portNo=port-number-used-by-IM-database
jp1.im.db.DEFAULT.logicalHostNum=number-used-by-IM-database-for-logical-host-to-identify-logical-host
jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=whether-to-show/hide-impact-unknown-icon
jp1.imdd.event.stormCompatible=Compatible-setting-of-the-repeated-event-viewing-suppression-function
jp1.imdd.gui.settings.eventSearchCount=number-of-searches-in-event-acquisition
jp1.imdd.authBasic=whether-to-enable/disable-Basic-authentication
jp1.imdd.jp1LoginForm=true|false
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-name=alias-name-of-the-client
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-id=client-ID-configured-in-the-OpenID-provider
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-authentication-method=basic|post
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.authorization-grant-type=authorization_code
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.redirect-uri=URI-of-the-redirection-URL
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.scope=scope-used-for-the-client
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.authorization-uri=URI-of-the-authorization-URL
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.token-uri=URI-of-the-URL-from-which-the-token-is-obtained
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.user-info-uri=URI-of-the-user-information-URL
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.userNameAttribute=attribute-name
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.jwk-set-uri=URI-of-the-JSON-Web-Key-(JWK)-Set-URL
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.issuer-uri=Issuer-Identifier-of-the-OpenID-provider
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.logout-uri=logout-URI-of-the-OpenID-provider
jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.introspect-uri=token-information-acquisition-URI-of-the-OpenID-provider
jp1.imdd.simt.updateMode=reconfigure|change

To Page Top

Files

imdd.properties

imdd.properties.model (model file for the Intelligent Integrated Management Base definition file)

To Page Top

Storage directory

In Windows

For a physical host:: Manager-path\conf\imdd\
For a logical host:: shared-folder\jp1imm\conf\imdd\

In UNIX

For a physical host:: /etc/opt/jp1imm/conf/imdd/
For a logical host:: shared-folder/jp1imm/conf/imdd/

To Page Top

Description

This file defines system settings for the Intelligent Integrated Management Base.

To Page Top

When the definitions are applied

The specified definitions take effect when JP1/IM - Manager starts.

To Page Top

Information that is specified

The following rules apply to the Intelligent Integrated Management Base definition file:

If # (0x23) is specified at the beginning of a line, the line is treated as a comment line.
Property names are case sensitive.
The definition file must be saved in UTF-8 without BOM (byte order mark).
If an invalid property is found, the system ignores the line to continue.
We cannot guarantee the behavior when a property is set to an unacceptable value.

server.port=port-number

Specifies a port number on which the Intelligent Integrated Management Base will receive HTTP connections.

The specified port number must be unique across the system and across the host that is created during the setup.

Acceptable values are from 5001 to 65535. The default value is 20703.

jp1.imdd.proxy.server[n].host=host-name-of-proxy-server[n]

Specifies the host name of proxy server [n].

The specified host name of the proxy server must be able to be resolved. If an invalid host name is specified, product plug-ins fail to execute APIs.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.server[n].port=port-number-of-proxy-server[n]

Specifies the port number of proxy server [n].

Possible values are 1 to 65535. If the specified value is beyond the range of the possible values, the KAJY52016-W message is output and the proxy server [n] setting is disabled.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.server[n].user=authentication-user-ID-of-proxy-server[n]

Specifies the user ID of the authentication user for proxy server [n].

If you use proxy server authentication, you must specify this option and configure authentication information for the proxy server. For details about the authentication information settings for the proxy server, see jddsetproxyuser in Chapter 1. Commands.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

If you do not use proxy server authentication, you can omit this option.

jp1.imdd.proxy.target[n].host=target-host[n]-of-REST-API-that-uses-proxy-server

Specifies the host for target [n] that is a target of REST API which uses the proxy server. The host name of target [n] must have the host section in the URL of the REST API.

For example, if the REST API has the http://hitachi.co.jp/api/v1/restApi value, specify hitacih.co.jp.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.proxy.target[n].serverHost=target-host-name[n]-of-destination-proxy-server

Specifies the host name of proxy server [n] working as the destination.

If the specified value is not configured for proxy server [n] or is invalid, the KAJY52018-W message is output and the settings for target host [n] are disabled.

Use ASCII characters to specify it.

If you specify this property multiple times, use serial numbers starting from 0 for [n].

jp1.imdd.gui.settings.contentViews.<custom UI Id>.title=title-displayed-on-custom-UI-tab

Specifies the title displayed on the custom UI tab when the custom UI display function is used.

The title must be a string with 255 or fewer characters that contains neither control nor machine-dependent characters.

If you use multi-byte characters, convert them into Unicode format (which is expressed as \udddd). In this case, the number of characters is counted as the number of them converted into Unicode.

You must specify this option for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.url=path-to-html-file-displayed-in-user-defined-window-display-area

Specifies the path to the html file displayed in User-defined window display area in relative path format to public when the custom UI display function is used. The html file is located in the following location:

In Windows: Manager-path\public\customUI\
In UNIX: /opt/jp1imm/public/customUI/

Specify the path to the html file as a string with 255 or fewer characters that contains neither control nor machine-dependent characters. Use a forward slash (/) as a delimiter.

If you use multi-byte characters, convert them into Unicode format (which is expressed as \udddd). In this case, the number of characters is counted as the number of them converted into Unicode. You do not have to enclose a space character ( ) with double quotation marks (").

You must specify this option for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.sid=tree-SID-of-IM-management-node-on-which-user-defined-windows-are-displayed

Specifies the tree SID of the IM management node on which user-defined windows are displayed when the custom UI display function is used.

The tree SID of the IM management node you specify must have 1,048,576 or less characters. The characters allowed conform to the specifications of the tree SID specified.

You can use regular expressions when specifying the tree SID of an IM management node. The regular expressions work if they match perfectly. The condition will be true if the specified regular expression matches perfectly with the whole string of the tree SID of the IM management node after comparing the expression with the string. When regular expressions are used, it may take time for searching if .*, which matches any string, is used many times. If you want to use .*, do so only when it is really necessary.

Note that the system does not check whether the specified tree SID exists.

You must specify either sid or target for every <custom UI Id>.

jp1.imdd.gui.settings.contentViews.<custom UI Id>.target=SID-of-IM-management-node-on-which-user-defined-windows-are-displayed

Specifies the tree SID of the IM management node on which user-defined windows are displayed when the custom UI display function is used.

The tree SID of the IM management node you specify must have 1,048,576 or less characters. The characters allowed conform to the specifications of the tree SID specified. You can use regular expressions when specifying the SID of an IM management node. The regular expressions work if they match perfectly. The condition will be true if the specified regular expression matches perfectly with the whole string of the SID of the IM management node after comparing the expression with the string. When regular expressions are used, it may take time for searching if .*, which matches any string, is used many times. If you want to use .*, do so only when it is really necessary.

Note that the system does not check whether the specified tree SID exists.

You must specify either sid or target for every <custom UI Id>.

jp1.im.db.DEFAULT.portNo=port-number-used-by-IM-database

Specifies the port number used by the IM database.

For a physical host, use the value specified for the IMDBPORT option in the setup information file that is used during setup of the integrated monitoring database. If the IMDBPORT option is set to its default, you do not have to specify the jp1.im.db.DEFAULT.portNo value.

For details about the setup information file, see Setup information file (jimdbsetupinfo.conf).

For a logical host, use the value specified for the IMDBPORT option in the cluster setup information file that is used during setup of the integrated monitoring database.

For details about the cluster setup information file, see Cluster setup information file (jimdbclustersetupinfo.conf).

jp1.im.db.DEFAULT.logicalHostNum=number-used-by-IM-database-for-logical-host-to-identify-logical-host

Specifies the number used by the IM database for a logical host to identify the host.

Specify the value used for the LOGICALHOSTNUMBER option in the cluster setup information file that is used during setup of the integrated monitoring database.

If a logical host is specified for jp1.im.db.DEFAULT.portNo, specify this option.

For details about the cluster setup information file, see Cluster setup information file (jimdbclustersetupinfo.conf).

jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=whether-to-show/hide-impact-unknown-icon

Specifies whether to show an icon indicating that it is unknown whether there is any impact on following root jobnets ( [Figure] icon) in the Job flow tab and the Linked unit dialog box.

Specify either true or false. Use true if you want to show the icon, or false if not. The default value is true.

jp1.imdd.event.stormCompatible=Compatible-setting-of-the-repeated-event-viewing-suppression-function

In version 12-00, repeated-event display is not suppressed even if the -storm option of the jcoimdef command is set to ON. Therefore, if you upgraded from version 12-00, to use the repeated event viewing suppression function, the compatible setting of the Repeated event viewing suppression function must be disabled (false).

If you new install a version 12-10 or later, the compatible setting of the repeated event viewing suppression Function is setting to Disabled (false) beforehand.

Specify either true or false.

If you set it to true, display of repeated events is not suppressed just like in 12-00. If you set it to false, display of repeated events is suppressed.

The default value is true.

The repeated-event display suppression function is enabled when suppression of repeated event monitoring in the -storm option of the jcoimdef command is set to ON and the jp1.imdd.event.stormCompatible option is set to false.

The repeated-event display suppression function is disabled when suppression of repeated event monitoring in the -storm option of the jcoimdef command is set to OFF, regardless of the jp1.imdd.event.stormCompatible option.

jp1.imdd.gui.settings.eventSearchCount=number-of-searches-in-event-acquisition

Specifies the number of searches during event acquisition that is performed by the integrated operation viewer to show the event list.

In event acquisition, the system searches for events mapped with the selected IM management node. Depending on the pages to be displayed, the search start position, search direction, and 100 events to be searched for are determined. If 100 events cannot be obtained due to an event receiver filter, the search is repeated for the next 100 events.

You specify the upper limit for the number of these repeated event searches. If the number of searches reaches the specified value, the search operation is interrupted and the events obtained before the interruption are displayed in the event list.

Possible values are 0 to 120000 (times). The number of times is unlimited if you specify 0 for it. The default is 10. If a value beyond the possible values is specified, the default value is assumed for operation.

jp1.imdd.authBasic=whether-to-enable/disable-Basic-authentication

In any REST API of the Intelligent Integrated Management Base, you can use an authentication method with login information added to the REST API (Basic authentication). This option specifies whether to enable the Basic authentication.

Specify either true or false.

The Basic authentication is enabled if the option is set to true.

The default is false.

For details about the REST API, see 5. API.

jp1.imdd.jp1LoginForm=true|false

Specifies whether the login form for JP1/Base authentication is displayed as the login window of the Intelligent Integrated Management Base.

When no OpenID provider is defined, the option assumes true for operation if it is set to false.

Furthermore, if it is set to false and only one OpenID provider is defined, the authentication URL of the OpenID provider is called directly without the use of the authentication window of the Intelligent Integrated Management Base.

Specify either true or false.

The JP1/Base authentication login form is enabled if the option is set to true.

The default is true.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-name=alias-name-of-the-client

Specifies the alias name of the Intelligent Integrated Management Base client registered in the OpenID provider.

The alias name of the client is used as the name of the button on the login window of the Intelligent Integrated Management Base.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-id=client-ID-configured-in-the-OpenID-provider

Specifies the ID of the Intelligent Integrated Management Base client registered in the OpenID provider.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.client-authentication-method=basic|post

Specifies the authentication method used on the server that authorizes the Intelligent Integrated Management Base client registered in the OpenID provider.

Specify either basic or post.

The default is basic.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.authorization-grant-type=authorization_code

Specifies the type of authorization granted to the Intelligent Integrated Management Base client registered in the OpenID provider.

Specify authorization_code.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.redirect-uri=URI-of-the-redirection-URL

Specifies the URI of the redirection URL registered in the OpenID provider in the following format:

<Intelligent-Integrated-Management-Base-login-URI>/oauth2/code/<OpenID-provider>

Example:

https://IMHOST:20703/login/oauth2/code/okta

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>. The permitted characters are a URL-formatted string. If the characters are specified in any other format, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

The authentication request is stored in the WWW browser and in the session of the Intelligent Integrated Management Base. Cookie data is managed on a domain basis. Therefore, make sure that the Intelligent Integrated Management server host name for the Intelligent Integrated Management Base login URI matches that for the URI of the redirection URL, and make sure that during authentication processing, the cookies are not removed or overwritten.

Also, if the Intelligent Integrated Management server host name for the Intelligent Integrated Management Base login URI and that for the URI of the redirection URL do not match, the KAJY52028-E message is output as a return value to the integrated operation viewer or REST API upon login by OpenID authentication.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.scope=scope-used-for-the-client

Specifies the scope used for the Intelligent Integrated Management Base client registered in the OpenID provider. To specify multiple scopes, separate them with a comma (,).

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

The permitted characters are ASCII characters (0x21, 0x23 to 0x5B, and 0x5D to 0x7E). If any characters that are not permitted are specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.authorization-uri=URI-of-the-authorization-URL

Specifies the URI of the authorization URL.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.token-uri=URI-of-the-URL-from-which-the-token-is-obtained

Specifies the URI of the URL from which the token is obtained.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.user-info-uri=URI-of-the-user-information-URL

Specifies the URI of the user information URL.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.userNameAttribute=attribute-name

Specifies the name of the attribute used to access the name of the user based on the user information response.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.jwk-set-uri=URI-of-the-JSON-Web-Key-(JWK)-Set-URL

Specifies the URI of the JSON Web Key (JWK) Set URL.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.issuer-uri=Issuer-Identifier-of-the-OpenID-provider

Specifies the Issuer Identifier of the OpenID provider.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.logout-uri=logout-URI-of-the-OpenID-provider

Specifies the logout URL of the OpenID provider.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.oidc.<key-name-of-the-OpenID-provider>.introspect-uri=token-information-acquisition-URI-of-the-OpenID-provider

Specifies the token information acquisition URL of the OpenID provider.

Specify a unique name with which the OpenID provider can be identified for <key-name-of-the-OpenID-provider>.

If a value that is not in the URL format is specified, the KAJY52019-W message is output to disable the OpenID provider settings and the startup of the JP1/IM2-Manager service continues.

jp1.imdd.simt.updateMode=reconfigure|change

Specifies the default method for application when the jddupdatetree command is executed.

Specify either reconfigure or change.

If you specify reconfigure, the application is performed in the new and rebuilding mode, which is the same as version 12-10 or earlier. If you specify change, the application is performed in the configuration change mode.

The default value is change.

If this option is not defined, it assumes reconfigure. If an invalid value is specified, the option uses the default value, change.

To Page Top

Notes

When the Intelligent Integrated Management Base service starts, if this definition file does not exist or an attempt to read the file fails, the following behavior occurs.

For a physical host:: The KAJY00015-W message is output to the integrated trace log, the default value is tentatively set for the property, and the service starts.
For a logical host:: The KAJY00021-E message is output to the integrated trace log, and the Intelligent Integrated Management Base service ends.

To Page Top

Example definition

server.port=20703
jp1.imdd.proxy.server[0].host=ProxyServer
jp1.imdd.proxy.server[0].port=443
jp1.imdd.proxy.server[0].user=UserID
jp1.imdd.proxy.target[0].host=HostA
jp1.imdd.proxy.target[0].serverHost=ProxyServer
 
jp1.imdd.gui.settings.contentViews.sample.title=\u30ab\u30b9\u30bf\u30e0UI1
jp1.imdd.gui.settings.contentViews.sample.url=./customUI/sample/index.html
jp1.imdd.gui.settings.contentViews.sample.target=^(?=.*MYHOST).*$
 
jp1.imdd.gui.settings.contentViews.sample2.title=\u30ab\u30b9\u30bf\u30e0UI2
jp1.imdd.gui.settings.contentViews.sample2.url=./customUI/sample2/index.html
jp1.imdd.gui.settings.contentViews.sample2.sid=_ROOT_AllSystems
 
jp1.im.db.DEFAULT.portNo=20700
jp1.im.db.DEFAULT.logicalHostNum=[1-9]
 
jp1.imdd.gui.settings.linkedUnit.impact.unKnownDisplay=true
jp1.imdd.event.stormCompatible=false
 
jp1.imdd.gui.settings.eventSearchCount=10
 
jp1.imdd.authBasic=false
 
jp1.imdd.jp1LoginForm=true
jp1.imdd.oidc.keycloak.client-name=KEYCLOAK LOGIN
jp1.imdd.oidc.keycloak.client-id=jddmain
jp1.imdd.oidc.keycloak.client-authentication-method=basic
jp1.imdd.oidc.keycloak.authorization-grant-type=authorization_code
jp1.imdd.oidc.keycloak.redirect-uri=https://IMhost:20703/login/oauth2/code/keycloak
jp1.imdd.oidc.keycloak.scope=openid,profile,email,address,offline_access
jp1.imdd.oidc.keycloak.authorization-uri=https://OPhost:8080/auth/realms/jddmain/protocol/openid-connect/auth
jp1.imdd.oidc.keycloak.token-uri=https://OPhost:8080/auth/realms/jddmain/protocol/openid-connect/token
jp1.imdd.oidc.keycloak.user-info-uri=https://OPhost:8080/auth//realms/jddmain/protocol/openid-connect/userinfo
jp1.imdd.oidc.keycloak.userNameAttribute=sub
jp1.imdd.oidc.keycloak.jwk-set-uri=https://OPhost:8080/auth/realms/jddmain/protocol/openid-connect/certs
jp1.imdd.oidc.keycloak.issuer-uri=https://OPhost:8080/auth/realms/jddmain
jp1.imdd.oidc.keycloak.logout-uri=https://OPhost:8080/auth/realms/jddmain/protocol/openid-connect/logout
jp1.imdd.oidc.keycloak.introspect-uri=https://OPhost:8080/auth/realms/jddmain/protocol/openid-connect/token/introspect
jp1.imdd.simt.updateMode=change

To Page Top