Tivoli Monitoring, Version 6.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.

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.

Any computer to which you want to deploy an agent must already have an OS agent installed. You can either install the OS agent 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 parameter to create additional Universal Agent instances.

CLI syntax

tacmd addSystem {-t|--type} pc
                   {-n|--node} managed-os
                   {-p|--property} section.name=value ...

where:

-t|--type pc
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 managed-os
Identifies the node, the directory on monitoring system where the OS agent is installed, to which you want to add the agent. 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 section.name=value...
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.

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 parameters:

_UNIX_STARTUP_.Username=user
On UNIX®, the user name 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 su). 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 user name 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} parameter.

_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.

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 (using the -p option). You can view the configuration parameters by running the tacmd describeSystemType command. The following example displays 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(R) 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.

Return values

See Table 2.

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)




Feedback

[ Top of Page | Previous Page | Next Page | Contents | Index ]