Purpose
The list_agents command lists the Data Mover agents connected to the Data Mover daemon.
Parameters
- agent_names
- [Optional] Lists the connectivity of the agents that are specified. When specifying the agents, use commas to separate the agents. Do not use spaces.
- frequency
- [Optional] Frequency for updating the status of the Data Mover agent in seconds.
- broker.url
- [Optional] You may enter a broker URL to overwrite the default value specified in the commandline.properties file in order to connect to a different ActiveMQ server (and therefore a different daemon) at runtime.
- broker.port
- [Optional] You may enter a broker port to overwrite the default value specified in the commandline.properties file in order to connect to a different ActiveMQ server (and therefore a different daemon) at runtime.
Usage Notes
If the agent_names parameter is not specified, the list_agents command lists all connected agents. If agent_names is used, only the connectivity of agents that are specified are listed.
XML File Example
For the list_agents command, type datamove list_agents -f parameters.xml.
The following example shows a parameters file for the list_agents command.
<?xml version="1.0" encoding="UTF-8" standalone="yes" ?> <dmListAgents xmlns="http://schemas.teradata.com/dataMover/v2009" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://schemas.teradata.com/unity/datamover.xsd" <agent_names>AgentA</agent_names> </dmListAgents>