Hitachi

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


5.19.3 Delete lower manager info

Description

Delete base manager or relay manager under Integrated manager.

Execution permissions

Following permissions are required:

  • JP1 resource group: *

  • JP1 permission level: JP1_Console_Admin

API version

v1

Format
Request line
POST /application/component/apiVersion/subManagers/deleteInfo httpVersion
Request header

Follow the request header in 5.2.3 Request format.

Request message body

Message body of the request can be sent in JSON formats.

{
    "subManagers":[
        hostname, ...
    ]
}
Response message body

If successful, there is no response.

If the warning ends, the following response is returned.

{
    "errhostlist":[
        hostname, ...
    ],
    "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

subManagers

string[]

No

Specifies an array of host name for lower manager. Specify host name within the range of 1 to 255.

An empty array cannot be specified.

Status codes

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

Status code

Message

Description

200

--

API operation was successful.

400

KAJY68013-E

API request is invalid.

The process is turned stopped when one bad request is found.

403

KAJY01000-E

The permission of the user used for authentication is insufficient.

500

KAJY68501-E

Unable to connect to Integration agent host management DB for Integration Manager.

200

KAJY68500-W

Cannot connect to integrated agent host administration DB of lower manager. If you are unable to connect to integrated agent administration DB of more than one administration manager, host name contains a concatenation of the administration managers host name with ",".

200

KAJY68204-W

Cannot connect to Intelligent Integrated Management Base on lower manager. If you are unable to connect to Intelligent Integrated Management Base of more than one manager, host name will contain a concatenation of the respective manager host name with ",".

200

KAJY68016-W

Lower manager data does not exist.

200

KAJY68018-W

Delete of lower manager data has failed.

Return values

Parameter name

Data type

Optional

Description

errhostlist

string[]

Yes

Sets an array of host names of subordinate managers that failed to delete. If there are no failed hosts, it is omitted.

messageList

object

Yes

The array of message objects is populated. If the message does not exist, it is omitted.

messageId

string

No

The message ID is set.

message

string

No

The body of the message is set. The language used depends on what is specified in the Accept-Language property of the HTTP request header.

Examples
Request:
POST http://immhost01:20703/im/api/v1/subManagers/deleteInfo
{
    "subManagers":["hostA"]
}

Manager host name: immhost01

Response:
< HTTP/1.1 200 OK
< Content-Type: application/json
{
    "errhostlist":[
      "hostA"
    ],
    "messageList":[
        {
            "messageId":"KAJY68500-W",
            "message": "The Intelligent Integrated Management Base DB cannot be connected to.(JP1/IM-Manager hostname : hostA)"
        }
    ]
}