Purpose
The list_agents command lists the Data Mover agents connected to the Data Mover daemon. The list_agents RESTful API uses the following URL and method:
Item | Description |
---|---|
URL | /datamover/agents |
Method | GET |
Request Parameters
The list_agents RESTful API does not require specific request parameters.
Response Parameters
If the command executes without error, the API returns the status code 200, along with an array of JSON objects describing the agents.
- agentName
- Description: Name that identifies the agent.
- agentHostName
- Description: Name of the host running the agent.
- agentVersion
- Description: Data Mover version for the agent.
- maxConcurrentTasks
- Description: Maximum number of concurrent tasks the agent can run.
- currentTaskCount
- Descriptions: Number of tasks the agent is currently running.
- major
- Description: Number corresponding to the major version.
- minor
- Description: Number corresponding to the minor version.
- maintenance
- Description: Maintenance release number.
- efix
- Description: efix release number.
Response Examples
[ { "agentName" : "AgentBond", "agentHostName" : "dm-agent7", "agentVersion" : { "major" : "16", "minor" : "00", "maintenance" : "00", "efix" : "00" }, "maxConcurrentTasks" : 5, "currentTaskCount" : 0 }, { "agentName" : "AgentKay", "agentHostName" : "dm-agent4", "agentVersion" : { "major" : "16", "minor" : "00", "maintenance" : "00", "efix" : "00" }, "maxConcurrentTasks" : 5, "currentTaskCount" : 0 } ]
This example shows an error message.
{ "message": "Unable to communicate with DM Daemon. Make sure the broker url and port are correct." }