Use the tacmd setAgentConnection command to edit connection properties and environment variables of agents running on the target node. Target agents with updated connection settings or environment variables are restarted following the update. Specify the configuration data through the parameter pair SECTION.NAME=VALUE. Using the Bulk Deploy option, the agents specified in the bundle group are configured on the managed systems specified in the deployment group.Use the no execute option to determine which configuration properties are used to configure which managed systems. When using this command to set or modify an environment variable, ensure that the value you assign to the variable is correct. An incorrect value assignment might impact the agent behavior and possibly prevent the agent from starting.
When specifying configuration properties, specify the individual property keywords and avoid using a URL syntax.
[{IP.PIPE|IP.SPIPE}://[HOSTNAME][:PORT]While specifying a URL syntax is allowed, you might not set the additional parameters which are required for the configuration specification. When any of the protocol properties are changed for an agent, those same protocol properties should be changed for all the other agents on that target machine. If the connection information for all the agents is not the same, then you might encounter problems with managing or collecting metrics from the agents. Additionally, the parameters that are passed to the configuration utility are not validated for compatibility or effectiveness when applied. Therefore it is important to thoroughly understand the changes that are intended and the parameter values that you specify for the command.
Configuring a single monitoring agent:
tacmd setAgentConnection
{-t|--type} TYPE
{-n|--node} MANAGED-OS
[{-p|--property} NAME=VALUE ... ]
[{-e|--environment} NAME=VALUE ... ]
[{-a|--allagents} ]
[{-f|--force} ]
Bulk monitoring agent connection properties update:
tacmd setAgentConnection
{-g|--deploygroup DEPLOY_GROUP_NAME}
{-b|--bundlegroup BUNDLE_GROUP_NAME}
[{-e|--environment} NAME=VALUE ... ]
[{-a|--allagents} ]
[{-x|--noexecute}]
[{-f|--force} ]
where:
Specifies one or more agent connection properties to be updated for the agent. The connection properties are specified with NAME=VALUE pairs, where NAME specifies the name of the connection property and VALUE specifies the property value. If more than one connection property is specified, each NAME=VALUE pair should be separated by a space. Valid properties for a monitoring agent include ENCRYPT, KEY, IP_PIPE, IP_SPIPE, PROTOCOL, PROTOCOL1, PROTOCOL2, PROTOCOL3, PORT, SERVER, SNA_NETNAME, SNA_LOGMODE, SNA_LUNAME, SNA_TPNAME, BACKUP, BSERVER, BPROTOCOL, BPROTOCOL1, BPROTOCOL2, BPROTOCOL3, BSNA_NETNAME, BSNA_LOGMODE, BSNA_LUNAME, BSNA_TPNAME, FOLDER, BPORT, and BIND_TO_NIC.
The following table describes the parameter keywords most frequently used to change an agent's connection parameters and identifies the additional parameters to specify when changing parameters.
| Parameter keyword | Expected value | Also specify these additional parameter keywords... |
|---|---|---|
| 1 KEY | The encryption key to encrypt your local passwords and IDs. The value must be exactly 32 characters. If it is short it will be padded with "9"'s. If it is long it will be truncated. | |
| 2 PROTOCOL1 | Highest precedent protocol for TEMS communication. (IP.PIPE,IP.SPIPE) | 7, one of 5 or 6 |
| 3 PROTOCOL2 | Second highest precedent protocol for TEMS communication. (IP.PIPE,IP.SPIPE) | 7, one of 5 or 6 |
| 4 PROTOCOL3 | Third highest procedent protocol for TEMS communication. (IP.PIPE,IP.SPIPE) | 7, one of 5 or 6 |
| 5 IP_PIPE_PORT | Port number used by IP.PIPE protocol to connect to Primary TEMS | 7, one of 2, 3 or 4 |
| 6 IP_SPIPE_PORT | Port number used by IP.SPIPE protocol to connect to Primary TEMS | 7, one of 2, 3 or 4 |
| 7 SERVER | Hostname or IPv4 address of the Primary TEMS to connect to. | 2, one of 5 or 6 |
| 8 BACKUP | Does a secondary TEMS connection exist or are you adding one? (Y or N) | 9, 10, one of 13 or 14 |
| 9 BSERVER | Hostname or IPv4 address of the Secondary TEMS to connect to | 8, 10, one of 13 or 14 |
| 10 BPROTOCOL1 | Highest precedent protocol for Secondary TEMS communication. (IP.PIPE,IP.SPIPE) | 8, 9, one of 13 or 14 |
| 11 BPROTOCOL2 | Second highest precedent protocol for Secondary TEMS communication. (IP.PIPE,IP.SPIPE) | 8, 9, one of 13 or 14 |
| 12 BPROTOCOL3 | Third highest procedent protocol for Secondary TEMS communication. (IP.PIPE,IP.SPIPE) | 8, 9, one of 13 or 14 |
| 13 BIP_PIPE_PORT | Port number used by IP.PIPE protocol to connect to Secondary TEMS | 8, 9, one of 10, 11 or 12 |
| 14 BIP_SPIPE_PORT | Port number used by IP.SPIPE protocol to connect to Secondary TEMS | 8, 9, one of 10, 11 or 12 |
| 15 BIND_TO_NIC | IPv4 address for dual network host adapter cards |
In the following example, the agent will connect to newTEMS as its server when it is restarted after the configuration. In addition, the CTIRA_HOSTNAME and CTIRA_HEARBEAT environment variables will be updated. When you run the tacmd listSystems command after the tacmd setAgentCommand command completes, the results indicate the agent connected to newTEMS with CTIRA_HOSTNAME of aix526 and the original entry with an inactive (N) status. You can delete the inactive entry using the tacmd cleanms command. If there are other agents installed on the node, use the -a|--allagents option to connect them to the new server (newTEMS).
tacmd setagentconnection -t ux -n amsaix75:KUX -p SERVER=newTEMS
-e CTIRA_HOSTNAME=aix526 CTIRA_HEARTBEAT=9In the following example, you assign a backup server (BSERVER=YYYYYYY) with IP.PIPE protocol for agent on node XXXXXX.
tacmd setagentconnection -t nt -n <Primary:XXXXXX:NT>
-p BACKUP=Y BSERVER=YYYYYYYY BPROTOCOL=IP.PIPEChanging the protocol setting for the Primary TEMS from IP.PIPE to IP.SPIPE
tacmd setagentconnection -n Primary:endpoint:NT -a -p SERVER=PrimaryTEMS
PROTOCOL1=IP.SPIPE IP_SPIPE_PORT=3600Changing or adding a Backup TEMS for all the Agents
tacmd setagentconnection -n Primary:endpoint:NT -a -p BSERVER=SecondaryTEMS
BPROTOCOL1=IP.PIPE BIP_PIPE_PORT=1918 BACKUP=YSwapping the Primary TEMS with the Backup TEMS
tacmd setagentconnection -n endpoint:UX -a -p SERVER=BackupRTEMS
PROTOCOL1=IP.PIPE IP_PIPE_PORT=1918 BSERVER=PrimaryRTEMS
BPROTOCOL1=IP.PIPE BIP_PIPE_PORT=1918 BACKUP=YRemoving a Backup TEMS
tacmd setagentconnection -n endpoint:UX -a -p SERVER=PrimaryRTEMS PROTOCOL1=IP.PIPE
IP_PIPE_PORT=1918 BACKUP=NSee Table 1.
Return to Table 1.