IBM Tivoli Monitoring, Version 6.2.2 Fix Pack 2

tacmd addSystem

Description

Use the tacmd addSystem command to deploy a monitoring agent to a computer in your IBM Tivoli Monitoring environment. The tacmd addSystem command deploys an agent and other required components if they are not already installed on the node. This command is also available for non-agent bundles.

Note:
When this command is issued against a managed node that already has the specified agent deployed to it, a message is issued informing you to specify that the "-p" options are required, such as _UNIX_STARTUP_.Username.

By using the bulk deploy option, the agents specified in the bundle group are deployed on the managed systems specified in the deploy group.

Any computer to which you want to deploy an agent must already have an OS agent installed. You can either install the OS agent by using the installation wizard or with the tacmd createNode command.

Note:
You cannot use this command to add a non-default Universal Agent instance that you created manually. You must use the itmcmd config command with the -o option to create additional Universal Agent instances.

CLI syntax

Single IBM Tivoli Monitoring agent deployment:

tacmd addSystem
                      {-t|--type}  TYPE
                      {-n|--node} MANAGED-OS
                      {-p|--property} SECTION.NAME=VALUE...

Bulk IBM Tivoli Monitoring or System Service Monitors agent deployment:

tacmd addSystem
                      {-g|--deploygroup DEPLOY_GROUP_NAME}
                      {-b|--bundlegroup BUNDLE_GROUP_NAME}
                      [{-x|--noexecute}]

where:

-t|--type
Specifies the type (product code) of agent to add to the monitoring system. See the IBM Tivoli Monitoring Installation and Setup Guide for a listing of agent product codes.
-n|--node
Identifies the node, or the directory on the monitoring system where the OS agent is installed, to which you want to add the agent. A node is identified by the managed operating system that it contains. The name of a node includes the computer where the OS agent is installed and the product code for the OS agent. For example, stone.ibm.com:LZ is the name of the node on computer stone.ibm.com, which has a Linux® OS agent installed.
-p|--property
Specifies section.name=value pairs that identify agent configuration properties and their values, where section specifies the name of the section containing the key value pair, name specifies the name of the configuration property, and value specifies the property value. You can specify the instance name of the system to be configured via the instance property for a system that can have multiple instances.

See the agent user's guide for the agent that you are configuring for a list of available configuration properties.

In addition to the agent-specific configuration properties, you can also configure the Run-as settings, specifying the user ID under which an agent runs. Use the following options:

_UNIX_STARTUP_.Username=user
On UNIX®, the For the INLINE_Cusername under which to run the agent. Note that you can only use this option if the OS agent running on the UNIX computer is started as the root user (or another user with privileges to super user). You cannot change the Run-as setting if your OS agent runs as a non-root user.

If you have already configured the Run-as user (for example, through the Manage Tivoli Enterprise Monitoring Services utility), this value defaults to what you have already set. If you have not configured the Run-as user previously, the default user is the user that is running the OS agent on the computer.

_WIN32_STARTUP_.Username=user
On Windows®, the For the INLINE_Cusername under which to run the agent.

If you have already configured the Run-as user (for example, through the Manage Tivoli Enterprise Monitoring Services utility), this value defaults to what you have already set. If you have not configured the Run-as user previously, the default user is LocalSystem (InteractWithDesktop=0).

_WIN32_STARTUP_.Password=pwd
The password for the Run-as user that you specified with _WIN32_STARTUP_Username.
_WIN32_STARTUP_.LocalSystem={0|1}
Indicates whether you want to use the LocalSystem user to start the agent. Specify 1 if you want to use the LocalSystem user. Specify 0 if you do not want to use the LocalSystem user.

You must also specify the _WIN32_STARTUP_.InteractWithDesktop={0|1} option.

_WIN32_STARTUP_.InteractWithDesktop={0|1}
Indicates whether the LocalSystem can interact with the computer desktop. Use 1 to specify that it can and 0 to specify that it cannot.
-g|--deploygroup
Specifies the name of the deployment group to which the agents in the bundle group will be deployed.
-b|--bundlegroup
Specifies the name of the bundle group containing the agents that will be deployed to the managed systems in the deployment group.
-x|--noexecute
Causes the command to display which bundles will be deployed to which managed systems.

CLI example

This command deploys universal agent (type UA) to the monitoring system named HDCHASDSTC0213 with the file.mdl MDL file.

tacmd addsystem -t UM -n Primary:HDCHASDSTC0213:NT -p UA.CONFIG="file.mdl"

Each agent bundle has its own unique configuration properties that you need to provide in the tacmd addSystem command (by using the -p option). You can view the configuration parameters by running the tacmd describeSystemType command. The following example shows the configuration options that are available to use with the tacmd addSystem command for the Universal Agent (product code um) to be installed on a remote Windows system (platform WINNT):

tacmd describeSystemType -t um -p WINNT

The MDL file is made available in the %CANDLEHOME%/cms/depot/UACONFIG directory and $CANDLEHOME\tables\tems\depot\UACONFIG in the case of a UNIX system.

This command deploys universal agent (type UA) to the monitoring system named HDCHASDSTC0213 with the script.mdl file.

tacmd addsystem -t UM -n Primary:HDCHASDSTC0213:NT -p UA.SCRIPT="script.mdl"

The mdl file is made available in the %CANDLEHOME%/cms/depot/UASCRIPT directory and $CANDLEHOME\tables\tems\depot\UASCRIPT directory in the case of a UNIX system.

The following is an example for the bulk deployment option. The agents specified in the bundle group are deployed to the host systems specified in the deployment group:

tacmd addsystem -g UnixGroup -b ULBundle
Note:
Before executing the preceding command, create groups UnixGroup and ULBundle by using the createGroup command and add members on it by using the addGroupMember command as follows: 
tacmd createGroup -g UnixGroup -d "unix deploy group" -t DEPLOY 

-p KDY.SERVER=IP.PIPE:\\r111o001.tivlab.raleigh.ibm.com:1918  

KDYRXA.TIMEOUT=300 KDYRXA.CONNECT_TIMEOUT=100 KDYRXA. 

RXAPROTOCOL=smb KDYRXA.RXAPORT=4230
tacmd addGroupMember -g UnixGroup -t DEPLOY 

-m f50pa2d.tivlab.raleigh.ibm.com 
-p KDYRXA.installDir=/data/aut/r111o001 KDYRXA.RXAUSERNAME=root 

KDYRXA.RXAPASSWORD=**** KDYRXA.RXAPROTOCOL =ssh KDYRXA. 

RXAPORT =22
tacmd addGroupMember -g UnixGroup -t DEPLOY 

-m amssol19.tivlab.raleigh.ibm.com 

-p KDYRXA.installDir=/data/aut/r111o001 KDYRXA.RXAUSERNAME =root KDYRXA. 

RXAPASSWORD =Agnt2tst KDYRXA. RXAPROTOCOL =ssh KDYRXA. 

RXAPORT =22
tacmd createGroup -g ULBundle -d "UL bundle" -t BUNDLE
tacmd addGroupMember -g ULBundle -m linuxULBundle -t BUNDLE -y UL 

-v 06210000 -i li6263

Return values

See Table 6.

Related commands

tacmd createNode

tacmd describeSystemType (to view configuration properties for an installed agent)

cinfo (to return the list of product codes installed on the computer)

Return to Table 1.

[ Top of Page | Previous Page | Next Page ]