list_agents | Commands | Teradata Data Mover - 17.10 - list_agents - Teradata Data Mover

Teradata® Data Mover User Guide

Product
Teradata Data Mover
Release Number
17.10
Release Date
June 2021
Content Type
User Guide
Publication ID
B035-4101-061K
Language
English (United States)

Purpose

The list_agents command lists the Data Mover agents connected to the Data Mover daemon.

Parameters

See Parameter Order.

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.
Example: AgentA,AgentB
dm.rest.endpoint
[Optional] Enter a Data Mover REST server URL to overwrite the default value specified in the commandline.properties file in order to connect to a different REST server (and therefore a different daemon) at runtime.
https://dm-server1:1443/datamover
frequency
[Optional] Frequency for updating the status of the Data Mover agent in seconds.
Example: 5
If this parameter is specified, the status of the Data Mover agent is updated every frequency seconds. To stop the status updates, press the system INTR character (UNIX) or Ctrl+C (Windows). If the frequency parameter is not specified, the status is displayed only once and is not updated.

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>