5.18.2 Delete integrated agent info

Description

This API is used to delete the specified integrated agent. Deletes Prometheus of the specified integrated agent host and the trend data that Fluentd has stored in Trend data Management Database. Restarts trend data management service automatically after the trend data is deleted. It also deletes integrated agent host that deleted the trend data.

You can Delete a integrated agent for which JP1 user who Login has read/write access. When trend data is deleted, all trend data saved by integrated agent, user-defined Prometheus, and Fluentd of the host that is specified as the target of trend data deletion is deleted if IM management node of the user's own Fluentd host has read/write access privileges.

After deletion, the deleted information is not reflected in JP1/IM - Manager (Intelligent Integrated Management Base) tree information. To import the information, generate and import the tree information from integrated operation viewer, or execute jddcreatetree command and jddupdatetree command (specify the configuration change mode (-c option)).

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-host-name,
            "managerhost": manager-host-name
        }, ...
    ]
    "errdeletelist":[
        {
            "Agenthost": integrated-agent-host-name,
            "managerhost": manager-host-name,
        },...
    ],
    "errrestartlist":[
        {
            "Agenthost": integrated-agent-host-name,
            "managerhost": manager-host-name,
        },...
    ],
    "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
`agents`	object[]	No	Specify the integrated agent to delete. You can specify up to 200 integrated agents. An empty array cannot be specified.
`agenthost`	string	No	Specify the host name of integrated agent, from 1 to 255.
`managerhost`	string	No	Specify the manager host name from 1 to 255 bytes.

Parameter name

Data type

Optional

Description

agents

object[]

Specify the integrated agent to delete. You can specify up to 200 integrated agents.

An empty array cannot be specified.

agenthost

string

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

managerhost

string

Specify 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. Includes hosts that have failed to delete trend data `errdeletelist`.
	`agenthost`	string	No	Hostname of the integrated agent is set.
	`managerhost`	string	No	Manager hostname is set.
`errdeletelist`		object[]	Yes	Sets an array of integrated agent for which trend data could not be deleted. Omitted if there are no failed hosts.
	`agenthost`	string	No	Sets the hostname of integrated agent for which trend data could not be deleted.
	`managerhost`	string	No	Sets the manager host name for which trend data could not be deleted.
`errrestartlist`		object[]	Yes	Sets the array of integrated agent that successfully deleted trend data and failed to restart trend data management service. Omitted if no host failed to reboot.
	`agenthost`	string	No	Sets the hostname of integrated agent on which trend data was deleted successfully and trend data management service failed to reboot.
	`managerhost`	string	No	Configures a manager hostname that successfully deletes trend data and fails to restart trend data management service.
`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.
200	KAJY62012-W	Failed to remove trend data in Trend data Management Database on the specified manager host.
200	KAJY62013-W	Failed to restart trend data management service on the specified manager host.
200	KAJY62014-W	Unable to connect to integrated agent Administration DB of the manager host specified in Delete trend data operation.
200	KAJY62015-W	Because Delete trend data or integrated agent info deletion was performed consecutively, trend data deletion was performed consecutively for Trend data Management Database on the same host.
200	KAJY62011-W	The logged-in user does not have integrated agent, user-defined Prometheus, or user-defined Fluentd host browse and manipulate permissions specified in the request. The specified manager host is lower manager and has not been added to lower manager in the [lower manager List] window. The specified agent host does not exist in the configuration managed by the Integration Manager.
200	KAJY68214-W	Failed to remove event-forwarding relay source information.
500	KAJY00007-E	A system error occurred (out of disk, out of memory, etc.).

Return values

None

Notes

See Notes on Deleting Trend Data in 2.7.2(3)(h) Deleting Trend Data Manually (Delete from Managed Object) in the JP1/Integrated Management 3 - Manager Overview and System Design Guide.

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