Stop a multi-session agent

You can use the waitToFinish parameter to specify, in milliseconds, how long the stop process must wait before stopping an agent, if the agent is currently serving a request. waitToFinish stops new requests to the agent and waits for the current request to complete. If the current request does not complete in the specified time, a STOP message is sent to the agent.

You can also use the waitAfterStop parameter to specify an additional wait time, in milliseconds. waitAfterStop checks if the agent has indeed stopped. If the agent has not stopped, then a KILL message is sent to the agent at the end of the specified time. In either case, if the agent finishes processing its current request before waitToFinish expires, the agent will immediately shut down.

Note: Both waitToFinish and waitAfterStop are optional parameters. If you do not specify these, the agent will be stopped immediately, irrespective of whether the agent is currently idle or serving a request.

HTTP Operation

DELETE

URI

//host_name:port/oemanager/applications/App_name/agents/agentID?
waitToFinish=time-in-milliseconds&waitAfterStop=time-in-milliseconds

Media type

application/vnd.progress+json

Response codes

200 Success
403 Access Denied
500 Unexpected Server Error

Command-line example

curl -X DELETE -v http://localhost:16680/oemanager/applications/oepas1/agents/AG-sCIVXeFSQYmcb7RcHo10Zw?waitToFinish=
60000 -u tomcat:tomcat -H "Content-Type: application/vnd.progress+json"

Request body example

Response body example

{
"result": {
"agentID": "AG-sCIVXeFSQYmcb7RcHo10Zw"
},
"versionStr": "v11.7.3 ( 2018-02-12 )",
"versionNo": 1,
"outcome":"SUCCESS",
"errmsg":"",
"operation": "STOP AGENT ",
}