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.

Request

PUT https://{hostname}:{port}
    /cli/agentCLI/rename?{parameters}
Accept: {contentType}
Table 1. Request parameters
Parameter Type Required Description
agent string true Name or ID of the agent to rename
name string true The new name for the agent
Table 2. Header parameters
Parameter Type Required Description
Accept
  • application/json
  • application/yaml
true

Example

curl -k -u jsmith:passwd 
   
  "https://deployserver.example.com:8443/cli/agentCLI/rename?
  agent=MyAgent&name=NewAgentName" -X PUT

Related CLI command: forceRenameAgent.