IBM Tivoli Monitoring, Version 6.2.2 Fix Pack 2

IBM® Tivoli® Monitoring OS Agents

For the createNode command options (-o | --option | --options), you can specify one or more of the following configuration options to customize the operation of the createNode command. The values are to be specified in key=value format. Some valid options are: VERSION, AUTOCLEAN, AGENT, JLOG_APPENDING, JLOG_SET_FILE_DIR, JLOG_SET_FILE_NAME, JLOG_SET_MAX_FILES, JLOG_SET_MAX_FILE_SIZE, ENV_env_variable_name.

Table 2. Options for the createNode command
Option name Description
KEYFILE The full path to a Secure Shell private key file that, when specified, is used to authenticate with the specified remote computer (which must already have been configured to accept the private key). Use KEYFILE when the Secure Shell protocol is, or might be, in use, and you want to use non-login based authentication.
PASSPHRASE Use this option in conjunction with the KEYFILE option to enable the specification of the passphrase (if any) that was used to encrypt the private key file. If you use the actual passphrase in this command, that passphrase is visible in the process table for the current computer, where anyone can access it. If access to the computer is restricted to only trusted personnel, this is not an issue. However, if you need to provide the passphrase but do not want to publish the passphrase, instead of using the passphrase as the option value, specify the path to a secured local file that contains the passphrase.
TIMEOUT A positive integer that indicates the maximum amount of time, in seconds, to wait for the current node creation to complete. If the node creation exceeds this time limit, then the node creation operation ends, and an error message is displayed. The default value is 1800 seconds (30 minutes).
Note:
In the event that a timeout is triggered, the node creation on the remote host might continue and complete successfully. However, if the timeout is exceeded, createNode does not wait for results to be returned from the remote host and reports a failure.
CONNECT_TIMEOUT A positive integer that indicates the maximum amount of time, in seconds, to wait for a successful connection through each communications protocol being used to connect to the specified remote computer. The default value is 60 seconds.
TEMP=temp_dir Defines a temporary directory to use during the deployment of the agent. By default, the tacmd createNode command uses the /tmp directory on UNIX® systems and %TEMP% on Windows® systems. Use the TEMP=temp_dir option if your /tmp directory does not have enough space to accommodate the temporary files needed for agent deployment.

This option is not available for SSM agents.

For the createNode, createGroup, addGroupMember, and editGroupMember properties (--p | --property | --properties), you can specify the following properties:

Table 3. Valid properties for all operating systems unless specified
Property name in key format defined for createNode command Property name in SECTION.KEY format defined for createGroup, addGroupMember, and editGroupMember commands Description
ENCRYPT KDY.ENCRYPT A Boolean flag that indicates whether or not to use SSL encryption for node communication with the monitoring server. By default, encryption is enabled for all communications. Accepted values are NO and YES.
KEY KDY.KEY The text to be used to encrypt the SSL communications. This value must match the same value that was specified for the monitoring server encryption.
IP.PIPE KDY.IP_PIPE Specifiy the KDC_PARTITION Name for the IP.PIPE protocol.
IP.SPIPE KDY.IP_SPIPE Specifiy the KDC_PARTITION Name for the IP.SPIPE protocol.
IP.PIPE.PORT KDY.IP_PIPE_PORT This is for the IP_PIPE port.
IP.SPIPE.PORT KDY.IP_SPIPE_PORT This is for IP_SPIPE port.
PROTOCOL KDY.PROTOCOL Specifies the primary communications protocol used between the node and the monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
Note:
If both PROTOCOL or PROTOCOL1 and SERVER protocol information are specified, the SERVER protocol is used as the primary communications protocol and PROTOCOL or PROTOCOL1 information is ignored.
PROTOCOL1 KDY.PROTOCOL1 Specifies the primary communications protocol used between the node and the monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
Note:
If both PROTOCOL or PROTOCOL1 and SERVER protocol information are specified, the SERVER protocol is used as the primary communications protocol and PROTOCOL or PROTOCOL1 information is ignored.
PROTOCOL2 KDY.PROTOCOL2 Specifies a secondary communications protocol to use between the node and the monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
PROTOCOL3 KDY.PROTOCOL3 Specifies a third communications protocol to use between the node and the monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
PORT KDY.PORT This is for the TCPIP Port.
SERVER KDY.SERVER Enables you to specify a specific monitoring server. The default value is the monitoring server from which you are running the command. This property accepts an optional URL-style format, which enables you to specify the primary communication protocol and port number: 
[{IP.UDP|IP.PIPE|IP.SPIPE

|SNA}://]

[HOSTNAME]

[:PORT]
Note:
If both PROTOCOL or PROTOCOL1 and SERVER protocol information are specified, the SERVER protocol is used as the primary communications protocol and PROTOCOL or PROTOCOL1 information is ignored.
SNA_NETNAME KDY.SNA_NETNAME The Systems Network Architecture primary network name.
SNA_LOGMODE KDY.SNA_LOGMODE The Systems Network Architecture one to eight character log mode name.
SNA_LUNAME KDY.SNA_LUNAME The Systems Network Architecture primary logical unit name.
SNA_TPNAME KDY.SNA_TPNAME The Systems Network Architecture transaction program specification. Accepted values are: SNASOCKETS (default), KDCLLBD, KDTMSNAP.QAUTOMON.
BACKUP KDY.BACKUP A Boolean flag used to indicate whether or not to use a secondary (back up) monitoring server for this node. By default, no backup is specified. Accepted values are NO and YES.
BSERVER KDY.BSERVER Specifies a backup monitoring server.
Note:
If both BPROTOCOL or BPROTOCOL1 and BSERVER protocol information are specified, the BSERVER protocol is used as the primary communications protocol and BPROTOCOL or BPROTOCOL1 information is ignored.
BPROTOCOL KDY.BPROTOCOL Specifies the primary communications protocol used between the node and the secondary monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
Note:
If both BPROTOCOL or BPROTOCOL1 and BSERVER protocol information are specified, the BSERVER protocol is used as the primary communications protocol and BPROTOCOL or BPROTOCOL1 information is ignored.
BPROTOCOL1 KDY.BPROTOCOL1 Specifies the primary communications protocol used between the node and the secondary monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
Note:
If both BPROTOCOL or BPROTOCOL1 and BSERVER protocol information are specified, the BSERVER protocol is used as the primary communications protocol and BPROTOCOL or BPROTOCOL1 information is ignored.
BPROTOCOL2 KDY.BPROTOCOL2 Specifies a secondary communications protocol to use between the node and the secondary monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
BPROTOCOL3 KDY.BPROTOCOL3 Specifies a secondary communications protocol to use between the node and the secondary monitoring server. Accepted values are: IP.UDP, IP.PIPE, IP.SPIPE, SNA.
BPORT KDY.BPORT This is for the TCPIP Port for backup server.
BIP.PIPE.PORT KDY.BIP_PIPE_PORT This is for the IP.PIPE port number for the backup server.
BIP.SPIPE.PORT KDY.BIP_SPIPE_PORT This is for the IP.SPIPE port number of the backup server.
BSNA_NETNAME KDY.BSNA_NETNAME The Systems Network Architecture primary network name for the secondary monitoring server.
BSNA_LOGMODE KDY.BSNA_LOGMODE The Systems Network Architecture one to eight character log mode name for the secondary monitoring server.
BSNA_LUNAME KDY.BSNA_LUNAME The Systems Network Architecture primary logical unit name for the secondary monitoring server.
BSNA_TPNAME KDY.BSNA_TPNAME The Systems Network Architecture transaction program specification for the secondary monitoring server. Accepted values are: SNASOCKETS (default), KDCLLBD, KDTMSNAP.QAUTOMON.
FOLDER KDY.FOLDER For Windows systems only. The name of the folder under which to place the node components. This is the folder name that is displayed in the Start menu.
createNode -d|--dir|--directory command-line option KDYRXA.INSTALLDIR This is the same as the -d|--dir|--directory option for createNode - Specifies the location on the specified host where the agent is installed. This location must be specified as a directory in absolute path format.
BIND.TO.NIC KDY.BIND_TO_NIC For Linux® and UNIX systems only, indicates a specific IP address for the node to bind to on multi-homed computers.

For the createGroup, addGroupMember, and editGroupMember commands properties (-p | --property | --properties), the following properties must be specified in SECTION.KEY=value format:

Table 4. Valid properties for the OS agents
Property name in SECTION.KEY format defined for createGroup, addGroupMember, and editGroupMember commands Description
KDYRXA.KEYFILE The full path to a Secure Shell private key file that, when specified, is used to authenticate with the specified remote computer (which must already have been configured to accept the private key). Use KEYFILE when the Secure Shell protocol is, or might be, in use, and you want to use non-login based authentication.
KDYRXA.PASSPHRASE Use this option in conjunction with the KEYFILE option to enable the specification of the passphrase (if any) that was used to encrypt the private key file. If you use the actual passphrase in this command, that passphrase is visible in the process table for the current computer, where anyone can access it. If access to the computer is restricted to only trusted personnel, this is not an issue. However, if you need to provide the passphrase but do not want to publish the passphrase, instead of using the passphrase as the option value, specify the path to a secured local file that contains the passphrase.
KDYRXA.TIMEOUT A positive integer that indicates the maximum amount of time, in seconds, to wait for the current node creation to complete. If the node creation exceeds this time limit, then the node creation operation ends, and an error message is displayed. The default value is 1800 seconds (30 minutes).
Note:
In the event that a timeout is triggered, the node creation on the remote host might continue and complete successfully. However, if the timeout is exceeded, the command does not wait for results to be returned from the remote host and reports a failure.
KDYRXA.CONNECT_
TIMEOUT		 A positive integer that indicates the maximum amount of time, in seconds, to wait for a successful connection through each communications protocol being used to connect to the specified remote computer. The default value is 60 seconds.
KDYRXA.TEMP Defines a temporary directory to use during the deployment of the agent. Use the TEMP option if your /tmp directory does not have enough space to accommodate the temporary files needed for agent deployment.
KDYRXA.VERSION Corresponds to the value that is displayed in the Version field that is displayed by the viewDepot command.
KDYRXA.AUTOCLEAN Determines if the deployment bundle is deleted from the local computer (the target host of the deployment) after installation. The defaults value is YES.
KDYRXA.JLOG_
APPENDING		 Specifies whether entries should be appended to an existing file, or if a new log file should be created. The default value is "false".
KDYRXA.JLOG_
SET_FILE_DIR		 Specifies the directory where log files will be written on the server. The value defaults to %CANDLE_HOME%\logs on Windows computers, and $CANDLEHOME/logs on Unix and Linux computers.
KDYRXA.JLOG_
SET_FILE_NAME		 Specifies the name of the log file on the server. The default value is trace_cn.log.
KDYRXA.JLOG_
SET_MAX_FILES		 Specifies the maximum number of log files to use. The default value is 3.
KDYRXA.JLOG_
SET_MAX_FILE_
SIZE		 Specifies the maximum size for each log file. The default value is 10,024 kilobytes (10 megabytes).
KDYRXA.ENV_
env_variable_name		 Allows the user to set an environment variable on the remote (target) environment during execution.

For information on RXA connection properties, see RXA connection properties.

[ Top of Page | Previous Page | Next Page ]