5.8.2 IM management node related information reflection

Description

The following file obtained by the IM Management Node Related Information Generation API and the IM Management Node Link Definition File are used to create the configuration management tree.:

IM management node tree file
IM management node data files
IM management node link file

If the new/rebuild mode is specified as the import method, all JP1 events stored in the integrated management database are acquired and evaluated, and the status of each IM management node is evaluated.

When the configuration change mode is specified for the import method, no JP1 events are acquired from the integrated monitoring DB and IM management node status information and event information related to IM management node that are already retained are inherited for use.

The directory where files created by the IM Management Node Related Information Generation API are stored is as follows.

In Windows:

For a physical host:

Manager-path\tmp\imdd\imnode\data
For a logical host:

shared-folder\JP1IMM\tmp\imdd\imnode\data

In Linux:

For a physical host:

/var/opt/jp1imm/tmp/imdd/imnode/data
For a logical host:

shared-directory/jp1imm/tmp/imdd/imnode/data

In addition, JP1 event "3F82" is issued if reflection is successful, and "3F83" is issued if reflection fails.

Execution permissions

Following permissions are required:

JP1 resource group: *
JP1 permission level: JP1_Console_Admin

API version

Format

Request line

POST /application/component/apiVersion/nodes/update httpVersion

Request message body

{
  "mode": import-method
}

Response message body

For normal termination, there is no response.

For termination with warning, the following response is returned.

{
  "returnCode": return-code,
  "messageList":[
    {
      "messageId": message-ID,
      "message": message
    },
    ...
  ]
}

Parameters

Here are the parameters that you specify for message body of the request:

Parameter name	Data type	Optional	Description
`mode`	`string`	Yes	Specify the import method. `reconfigure` Reflect in the new/rebuild mode. `change` Reflect in the configuration change mode. By default, it follows setting value of `jp1.imdd.simt.updateMode` property of Intelligent Integrated Management Base definition file (imdd.properties).

Parameter name

Data type

Optional

Description

mode

string

Yes

Specify the import method.

reconfigure

Reflect in the new/rebuild mode.
change

Reflect in the configuration change mode.

By default, it follows setting value of jp1.imdd.simt.updateMode property of Intelligent Integrated Management Base definition file (imdd.properties).

Status codes

The following table describes the status codes that are returned as a response to the request:

Status code	Message	Description
`200`	`OK`	Success.
`400`	`Bad Request`	The request header is invalid.
`403`	`Forbidden`	There is no execution permission.
`404`	`Not Found`	The resource could not be found.
`406`	`Not Acceptable`	An invalid Accept or Accept-Language header is specified.
`408`	`Request Timeout`	The request timed out.
`415`	`Unsupported media type`	An invalid Content-Type header is specified.
`500`	`Internal Server Error`	An error occurred with the server processing.
`503`	`Service Unavailable`	Service is not available. The service is temporarily unavailable due to overload or maintenance. It is returned when a temporary error occurs (when it is expected to improve over time).

Return values

Return values	Description
2	Exclusive locking is in progress.
3	Invalid argument.
6	Execute of this API does not have enough data.
9	The storage directory path is too long.
10	JP1/IM - Manager database service is not running.
13	A required file does not exist.
14	A required file could not be read.
15	A required file has an invalid format.
16	A required file has an invalid description.
17	Failed to get event information.
19	Invalid information was received from the plug-in.
22	Failed to replace master file.
26	The user used for authentication has insufficient permissions.
27	There are suggestion definitions that do not map to any IM management node.
28	Failed to create proposal related master file.
29	Suggestion-related master file replacement failed.
255	The system error.

Examples

Here is a sample API that recreates configuration management tree, retrieves and evaluates all of JP1 events stored in the integrated administration DB, and reflects the status of the configuration objects in the tree that you created.

Request:

POST /im/api/v1/nodes/update HTTP/1.1
Authorization: Bearer anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn
Accept-Language: ja
Content-Type: application/json
Accept: application/json
 
{
  "mode":"reconfigure"
}

Response:

HTTP/1.1 200 OK
Cache-Control: no-store, no-cache, max-age=0
Pragma: no-cache
Expires: Thu, 01 Jan 1970 00:00:00 GMT
Content-Type: application/json

To Page Top