Description
Use the tacmd createNode command
to deploy an IBM® Tivoli® Monitoring node or a System Service
Monitors agent to a host. This command also creates a node,
the directory into which not only the OS agent is installed, but where
any non-OS agents are deployed. A create node request is sent to the
deployment controller on the hub Tivoli Enterprise
Monitoring Server, and a global transaction ID is immediately returned
to the user. You can then use the Deployment Status workspace on the Tivoli Enterprise Portal, or
execute the getDeployStatus CLI, to view the status of the
queued operation. 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. You must log in by using
the tacmd login command before running the tacmd createNode command.
The
node is created on the local computer if no host is specified.
Note: - On UNIX computers, you
must run the tacmd createNode command as a root user.
- Use tacmd createNode to deploy an OS agent when there are
no OS agents already on the target computer. Attempting to deploy
multiple OS agents on the same computer can cause unpredictable results.
- Only Secure Shellversion 2 communication protocol is supported,
Secure Shell version 1 is not supported.
- Properties provided when using the tacmd creatnode command
for a bulk deployment override the properties given inside the group
and group members. For more information about the order of precedence,
see the Properties precedence table in the Bulk agent deployment subsection
in the IBM Tivoli Monitoring Installation and Setup Guide.
- Remote Deployment is not supported in environments with a z/OS
Tivoli Enterprise Monitoring Server. This restriction includes this
command.
CLI syntax
Execution for a single IBM Tivoli Monitoring
or System Service Monitors agent:
tacmd createNode
{-h|--host} [ {smb|ssh|rexec|rsh}:// ] HOST [ :PORT ]
{-u|--username} USERNAME
{-w|--password} PASSWORD
[ {-o|--option|--options} NAME=VALUE ... ]
[ {-d|--dir|--directory} DIRECTORYPATH ]
[ {-p|--property|--properties} NAME=VALUE ... ]
[ {-t|--type}ITM|SSM]
[ {-e|--environment}NAME=VALUE ...]
[ {-k|--securegroup} ITMGROUP]
[ {-f|--force} ]
Bulk execution
for IBM Tivoli Monitoring or System Service Monitors
agents:
tacmd createNode
{-g|--deploygroup DEPLOY_GROUP_NAME}
{-b|--bundlegroup BUNDLE_GROUP_NAME}
{-u|--username} USERNAME
{-w|--password} PASSWORD
[ {-s|--serverlist} SERVER_LIST ]
[ {-o|--option|--options} NAME=VALUE ... ]
[ {-d|--dir|--directory} DIRECTORYPATH ]
[ {-t|--type}ITM|SSM]
[ {-e|--environment}NAME=VALUE ...]
[ {-k|--securegroup} ITMGROUP]
[ {-f|--force} ]
where:
- -h|--host
- Identifies the host on which to create a node. Optionally, a specific
connection protocol and a port can be specified.
- -g|--deploygroup
- The name of the deployment group to which the agents in the bundle
group will be deployed.
- -b|--bundlegroup
- The name of the bundle group containing the agents which is deployed
to the managed systems in the deployment group.
- -s|--serverlist
- One or more server names, separated by space, from which the bulk
createNode operations should be issued from.
- u|--username
- A valid user log in ID on the specified host. The software prompts
you for the username if you do not specify one.
Note: On UNIX computers, you must run the tacmd
createNode command as a root user. When using this command to
deploy a Monitoring Agent for Windows,
you must specify a user that has Administrator privileges on the remote
computer. Local user accounts must be specified.
- -w|--password
- The password for the specified user ID. The software prompts you
for the password if you do not specify one.
- -o|--option|--options
- One or more configuration parameters that can be used to customize
the operation of this command. The valid options are: TIMEOUT, CONNECT_TIMEOUT,
TEMP, VERSION, AUTOCLEAN, KEYFILE, PASSPHRASE, AGENT, JLOG_APPENDING,
JLOG_SET_FILE_DIR, JLOG_SET_FILE_NAME, JLOG_SET_MAX_FILES, JLOG_SET_MAX_FILE_SIZE,
COLLECTALL, EXECPREREQCHECK, IGNOREPREREQCHECK, or ENV_env_variable_name.
The values are to be specified in KEY=VALUE format. If more than
one option is specified, each KEY=VALUE pair should be separated by
a space.
See Configuration options and properties for information
on these options.
- -d|--dir|--directory
- Specifies the location on the specified host where the agent is
installed. This location must be specified as a directory in absolute
path format.
- -p|--property|--properties
- Specifies one or more configuration properties that identify configuration
properties of the new system and their values. Values can differ per
system.
- The valid properties for an IBM Tivoli Monitoring agent
are: 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, or BIND_TO_NIC.
See Configuration options and properties for information on these
properties.
- The valid properties for an SSM agent are : SVCUSERNAME, SVCPASSWORD,
SNMPPORT, SNMPCOMMUNITY, COEXIST, OVERWRITE, SERVER_GUI,MS_SNMP_OVERRIDE,
DISABLE_SNMPV1, DISABLE_SNMPV2, V3AUTHPROTOCOL, V3AUTHPASSWORD, V3PRIVPROTOCOL,
CORE_ONLY, V3PRIVPASSWORD, MANUAL_SERVICE, SERVER, BSERVER, CLUSTER_INST,
CLUSTER_GROUP, CORE_CONFIG_DISK, AGENTLOG ,BYPASS_RECONFIG, AGENTLOGSIZE,
SNMPTRAPVER, CONFIGDIR, or INST_CONSOLE. The values are to be specified
in KEY=VALUE format. If more than one property is specified, each
NAME=VALUE pair should be separated by a space.
- -t|--type
- The type of agent to deploy to the unmanaged host. The valid values
are ITM and SSM. Default is ITM.
- -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.
- -k|--securegroup
- Specifies the ITMGROUP.
- -f|--force
- Executes the create node query without user confirmation.
CLI example
This example installs the OS
agent in the
/opt/IBM/ITM directory on
stone.ibm.com.
The installation is performed as
root.
tacmd createNode -h stone.ibm.com -d /opt/IBM/ITM -u root
This
example installs the OS agent in the
/opt/IBM/ITM directory
on
stone.ibm.com and includes the -e option to specify an environment
variable setting for CTIRA_HEARTBEAT. The installation is performed
as
root.
tacmd createnode -h stone.ibm.com -u root -d /opt/IBM/ITM -e CTIRA_HEARTBEAT=3
This
example installs the OS agent on the Windows system
stone.ibm.com.
The installation is performed as the user Administrator.
tacmd createNode -h stone2.ibm.com -u Administrator
The
following is an example for the bulk deployment option, where the
Monitoring Agent for UNIX OS
is deployed to the host systems specified in the deployment group:
tacmd createnode -g UnixGroup
Note: Before
executing the above command, create a deployment group UnixGroup 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://topaz.raleigh.ibm.com:1918
KDYRXA.TIMEOUT=300 KDYRXA.CONNECT_TIMEOUT=100 KDY.port=4230
tacmd addGroupMember -g UnixGroup -t DEPLOY -m jade.raleigh.ibm.com
-p KDYRXA.installDir=/home/root/ITMOSAgent KDYRXA.RXAUSERNAME=root
KDYRXA.RXAPASSWORD=***** KDYRXA.RXAPROTOCOL=ssh KDYRXA.RXAPORT=22
tacmd addGroupMember -g UnixGroup -t DEPLOY -m sapphire.raleigh.ibm.com
-p KDYRXA.installDir=/home/root/ITMOSAgent1 KDYRXA.RXAUSERNAME=achan
KDYRXA.RXAPASSWORD=***** KDYRXA.RXAPROTOCOL=ssh KDYRXA.RXAPORT =22
This
example includes the -e option to specify an environment variable
setting for CTIRA_MAX_RECONNECT_TRIES, CTIRA_HEARTBEAT, and KHD_HISTRETENTION.
tacmd createnode --deploygroup deploy_ux --environment
CTIRA_MAX_RECONNECT_TRIES=10 CTIRA_HEARTBEAT=4 KHD_HISTRETENTION=48
This
example includes the -e option to specify an environment variable
setting for CTIRA_HEARTBEAT.
tacmd createNode -h stone.ibm.com -d /opt/IBM/ITM -u root -e CTIRA_HOSTNAME=stone
UNIX CTIRA_HEARTBEAT=9
See the following example
for deploying an SSM agent:
tacmd createNode -h smb://ruby.raleigh.ibm.com -t SSM -u root –w ****
-d c:\SSMAgent\ssm