IBM Tivoli Monitoring, Version 6.3

tacmd configureSystem

Description

Use the tacmd configureSystem command to edit configuration options of an existing managed system. By default, the managed system monitoring agent is restarted so the new configuration parameters can take effect. 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. Note that you can use this command with the -e|--environment option to specify environment variables for an OS agent. However, in the case of an OS agent, you cannot use the -p (properties) option to update the OS agent connection properties. To configure OS agent connection properties, use the tacmd setAgentConnection command.

Specify the configuration data through the parameter pair SECTION.NAME=VALUE. If an optional parameter is specified with an equal sign but without a value, the specified parameter is removed from the agent configuration. By using the bulk deployment option, the agents specified in the bundle group are configured on the managed systems specified in the deployment group.

The environment option is supported for both individual configuration and group configuration where there are environment variables that need to be changed or defined at the target node for the agent to work properly. Only those environment variables should be set or updated that are incorrect or not set and are required for the agent. You can query deployment workspaces if you are using the Tivoli Enterprise Portal or run the tacmd getDeployStatus command to determine the result for the tacmd configureSystem command.

The -x|--noexecute option is intended to allow you to determine which configuration properties are used to configure which managed systems.

If you specify the -n|--noagentrestart option instead of the default, the managed system monitoring agent is reconfigured, but the agent is not restarted after the configuration.

Note: You cannot use this command to configure a non-default Universal Agent instance that you created manually. Use the itmcmd config command with the -o option instead to configure a non-default Universal Agent instance.

Note: Use the tacmd describeSystemType command to view available configuration properties.

Note: Remote Deployment is not supported in environments with a z/OS Tivoli Enterprise Monitoring Server. This restriction includes this command.

CLI syntax

Configuring a single IBM® Tivoli® Monitoring agent:

tacmd configureSystem
                    {-m|--system} SYSTEM
                    {-p|--property|--properties} SECTION.NAME=VALUE ...
                    [{-e|--environment} NAME=VALUE ...]
                    [{-n|--noagentrestart}]
                    [{-f|--force}]

Configuring a single System Service Monitors agent:

tacmd configureSystem
                    {-h|--host} HOST[:PORT]
                    [{-c|--configfile|--configfiles} CONFIG_LIST]
                    [{-l|--filelist} FILE_LIST]
                    [{-p|--property|--properties}] SECTION.NAME=VALUE ...
                    [{-r|--reboot}]
                    [{-f|--force}]

Note: At least one of -p, -c, or -l must be specified.

Configuring bulk IBM Tivoli Monitoring or System Service Monitors agents:

tacmd configureSystem
                    {-g|--deploygroup DEPLOY_GROUP_NAME}
                    {-b|--bundlegroup BUNDLE_GROUP_NAME}
                    [{-e|--environment} NAME=VALUE ...]
                    [{-x|--noexecute}]
                    [-n|--noagentrestart]
                    [{-f|--force}]

Standard input option:

tacmd configureSystem
{-stdin|--stdin}

where:

-m|--system

Identifies the agent (managed system) for which to update the configuration.

-h|--host

Identifies the location of the host of the System Service Monitors agent.

-c|--configfile|--configfiles

List of one or more configuration files (separated by spaces) that are executed on the System Service Monitors agent. Configuration files must be located in the depot under depot/SSMCONFIG.

-l|--filelist

List of one or more files (separated by spaces) that are transferred to the System Service Monitors agent, but not installed as configuration files. Configuration files must be located in the depot under depot/SSMCONFIG.

-e|--environment

Specifies one or more NAME=VALUE pairs that identify environment variables to update, where NAME specifies the name of the environment variable, and VALUE specifies the value to be assigned. If more than one environment variable is specified, each NAME=VALUE pair should be separated by a space. For example:

 -e CTIRA_HOSTNAME=aixnode CTIRA_HEARTBEAT=8

Refer to the "Agent configuration and environment variables" appendix of the IBM Tivoli Monitoring: Installation and Setup Guide for a list of supported variables.

Note: If you update the environment variable CTIRA_HOSTNAME, you should use the tacmd cleanMS command to delete the entries for offline managed systems from the Tivoli Enterprise Monitoring Server before running other remote deploy commands to the target system. Use the tacmd listSystems command to display the list of managed systems.

-p|--property|--properties

Specifies one or more SECTION. NAME=VALUE pairs that identify configuration properties to update, where SECTION specifies the configuration section containing the configuration property, NAME specifies the name of the configuration property, and VALUE specifies the property value. Specify the instance name of the system to be configured by using the INSTANCE property for a system that can have multiple instances. If more than one property is specified, each NAME=VALUE pair should be separated by a space.

-r|--reboot

Forces a restart of the System Service Monitors agent.

-g|--deploygroup

Specifies the name of the deployment group to which the agents in the bundle group are configured.

-b|--bundlegroup

Specifies the name of the bundle group containing the agents which are configured to the managed systems in the deployment group.

-x|--noexecute

Causes the command to display the configuration properties used to configure specific managed systems.

-n|--noagentrestart

Specifies that when configuration completes, the agent is not rebooted.

-f|--force

Allows execution of the command without prompting for confirmation.

-stdin|--stdin

Indicates that all command-line parameters are processed from standard input (in the same command-line format) instead of being parsed from the command-line arguments.

CLI example

This command reconfigures the universal agent on stone with the file_unix.mdl MDL file.

   tacmd configureSystem -m stone:UA -p UA.CONFIG="file_unix.mdl"

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

tacmd configureSystem -g UnixGroup -b ULBundle

Note: Before executing the above command, create groups UnixGroup and ULBundle by using the createGroup command and add members to it by using the addGroupMember command as follows:

tacmd createGroup -g UnixGroup -d "unix deploy group" -t DEPLOY 
-p KDY.SERVER=IP.PIPE:\\s108o001.tivlab.raleigh.ibm.com:1918 
KDYRXA.TIMEOUT=300 KDYRXA. CONNECT_TIMEOUT =100 KDYRXA. RXAPORT =4230

tacmd createGroup -g ULBundle -d "unix log Bundle group" -t BUNDLE

tacmd addGroupMember -g UnixGroup -t DEPLOY -m f50pa2d.tivlab.raleigh.ibm.com 
-p KDYRXA.installDir=/data/aut/s108o001 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/s108o001 KDYRXA.RXAUSERNAME=root 
KDYRXA.RXAPASSWORD=**** KDYRXA.RXAPROTOCOL =ssh KDYRXA. RXAPORT=22

tacmd addGroupMember -g ULBundle –m linuxULBundle -t BUNDLE -y UL 
–v 062100000 –i li6263

This additional example includes the -e option to specify an environment variable setting for CTIRA_HEARTBEAT.

tacmd configureSystem -m stone:UX -e CTIRA_HOSTNAME=stoneUNIX CTIRA_HEARTBEAT=9

Return values

See Table 1.

Related commands

tacmd addSystem

Return to Table 1.

Feedback