5.8.1 IM management node related information generation

Description

Obtain the product-managed configuration from JP1/AJS3, JP1/PFM, JP1/IM and JP1/Base, and use the following file to generate configuration management tree File:

System node definition file (imdd_systemnode.conf)
Category name definition file for IM management nodes (imdd_category_name.conf)
Target host definition file for configuration collection (imdd_target_host.conf)
Host name definition file (imdd_host_name.conf)

The storage directory of files created by this API 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

If the generation is successful, the JP1 event "3F80" is issued, and if the generation fails, the "3F81" is issued.

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/create httpVersion

Request message body

None

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

None

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`	You do not have execute permission.
`404`	`Not Found`	No resource.
`406`	`Not Acceptable`	Accept header or Accept-Language header is invalid.
`408`	`Request Timeout`	The request timed out.
`415`	`Unsupported media type`	Content-Type header specification is invalid.
`500`	`Internal Server Error`	The server operation error occurred.
`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.
6	Execute of this API does not have enough data.
9	The path of the storage directory is too long.
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	Invalid information was received from the plug-in.
18	Information from the plug-in is invalid.
20	Failed to create IM management node file.
21	Failed to create IM management node link file.
22	Failed to create IM managed node tree data.
23	Failed to create IM management node tree file.
26	The user used for authentication has insufficient permissions.
255	The system error.

Examples

The following is a sample API that generates a configuration management tree file:

Request:

POST /im/api/v1/nodes/create HTTP/1.1
Authorization: Bearer anAxYWRtaW46TUdGa01tTTJNMlV3TURFNFh6STNYekE0T2pJME9qTXpYMTlmWDE5ZlgxOWZYMTlmWDE5ZlgycHdNV0ZrYldsdUlDQWdJQ0FnSUNBZ0lDQWdJQ0FnSUNBZ0lDQWdJQ0Fn
Accept-Language: ja
Content-Type: application/json
Accept: application/json

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