5.18.2 Delete integrated agent info

Description

This API is used to delete the specified integrated agent.

You can Delete a integrated agent for which JP1 user who Login has read/write access.

Execution permissions

JP1_Console_Admin

API version

Format

Request line

POST /im/api/v1/agents/delete httpVersion

Request message body

{
  "agents": [
    {
      "agenthost": integrated agent host name,
      "managerhost": manager host name
    }, ...
  ]
}

Response message body

If successful, there is no response.

If the warning ends, the following response is returned.

{
    "errhostlist":[
        {
            "agenthost": integrated-agent-hostname,
            "managerhost": manager-hostname
        }, ...
    ]
    "messageList":[
        {
            "messageId": Message ID,
            "message": Message
        }, ...
    ]
}

Parameters

Here are the parameters that you specify for message body:

Parameter name	Data type	Optional	Description
`agents`	object[]	No	Specifies the Unified Agent to delete. You can specify up to 200 integrated agents. An empty array cannot be specified.
`agenthost`	string	No	Specify host name of integrated agent, from 1 to 255.
`managerhost`	string	No	Specifies the manager host name from 1 to 255 bytes.

Parameter name

Data type

Optional

Description

agents

object[]

Specifies the Unified Agent to delete. You can specify up to 200 integrated agents.

An empty array cannot be specified.

agenthost

string

Specify host name of integrated agent, from 1 to 255.

managerhost

string

Specifies the manager host name from 1 to 255 bytes.

Response

Parameter name		Data type	Optional	Description
`errhostlist`		object[]	Yes	The array is populated with the Unified Agents that failed to be deleted. If there are no failed hosts, it is omitted.
	`agenthost`	string	No	Hostname of the integrated agent is set.
	`managerhost`	string	No	Manager hostname is set.
`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.

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	KAJY68201-E	API request is invalid. The process is turned stopped when one incorrect request is found.
200	KAJY68213-W	Integrated agent host name specified in the request or the configuration managed by the manager host name does not exist in JP1/IM - Manager Logged in as does not have read/manipulate permissions for integrated agent specified in the request The information of the integration agent or the host specified in the request is not in the unified agent host management DB.
403	KAJY01000-E	The permission of the user used for authentication is insufficient.
500	KAJY68501-E	Unable to connect to integrated agent host admin DB for the specified integrated agent manager.
200	KAJY68500-W	Unable to connect to the Unified Agent Host Management DB for the specified subordinate manager.
200	KAJY68204-W	Cannot connect to Intelligent Integrated Management Base of the manager for the specified integrated agent.
200	KAJY68210-W	Intelligent Integrated Management Base operation encountered an error.

Return values

None

Examples

Request:

POST http://hostname:20703/im/api/v1/agents/delete
{
    "agents": [
      {
        "agenthost":"hostA",
        "managerhost":"hostB"
      }
    ]
}

Response:

< HTTP/1.1 200 OK
< Content-Type: application/json

To Page Top