agentCLI resource

Resources for creating, editing, and deleting agents.

Get status of agents
Returns a JSONObject with count of agents to status. Expected format: { "ONLINE":4, "UPGRADE_RECOMMENDED":1 } Requires Settings Tab permission.
Add a tag to an agent
Add an agent to a team
Delete a tag from an agent
Delete an agent
Agents should be shut down before deletion.
Get information about all agents
Get information about an agent
This command returns a JSON representation of an agent.
Get the value of a property on an agent
List all tags on an agent
Remove a property from an agent
Remove an agent from a team
Rename an agent
Rename an agent. Use this command if running the agent configuration script in the agent bin directory is not convenient. Only the administrator can run this method.
Restart an agent
Return high watermarks for agent usage
Set a property on a agent
Shut down an agent
Test the connection from an agent to the server
The agent's JMS and HTTP connections to the server will be tested.
Upgrade an agent
The agent will be upgraded to the agent version corresponding with the UrbanCode Deploy server version.

Related concepts:

Related tasks:

Related reference: