AIX operating systemsLinux operating systemsWindows operating systems

CmsConfig addnode command

Use the CmsConfig addnode command to manually add a client node definition to the client-configuration.xml configuration file. The node definition contains information that is required by the client management service to communicate with the IBM Spectrum Protect™ server.

Use this command only if the client options file or client log files are stored in a non-default location on the client system.

Syntax

Read syntax diagramSkip visual syntax diagram
>>-CmsConfig addnode-------------------------------------------->

>--nodeName--serverIP--serverPort--serverProtocol--optPath-----><

Parameters

nodeName
The client node name that is associated with the log files. For most client systems, only one node name is registered to the IBM Spectrum Protect server. However, on systems with multiple users, such as Linux client systems, there can be more than one client node name. This parameter is required.
serverIP
The TCP/IP address of the IBM Spectrum Protect server that the client management service authenticates to. This parameter is required.

You can specify a 1 - 64 character TCP/IP address for the server. The server address can be a TCP/IP domain name or a numeric IP address. The numeric IP address can be either a TCP/IP v4 or TCP/IP v6 address. You can use IPv6 addresses only if the commmethod V6Tcpip option is specified for the client system.

Examples:
  • server.example.com
  • 192.0.2.0
  • 2001:0DB8:0:0:0:0:0:0
serverPort
The TCP/IP port number that is used to communicate with the IBM Spectrum Protect server. You can specify a value in the range 1 - 32767. This parameter is required.

Example: 1500

serverProtocol
The protocol that is used for communication between the client management service and the IBM Spectrum Protect server. This parameter is required.
You can specify one of the following values.
Value Meaning
NO_SSL The SSL security protocol is not used.
SSL The SSL security protocol is used.
FIPS The TLS 1.2 protocol is used in Federal Information Processing Standard (FIPS) mode.
Tip: Alternatively, you can enter TLS_1.2 to specify that the TLS 1.2 protocol is used in FIPS mode.
optPath
The fully qualified path of the client options file. This parameter is required.

Example (Linux client): /opt/backup_tools/tivoli/tsm/baclient/dsm.sys

Example (Windows client): C:\backup tools\Tivoli\TSM\baclient\dsm.opt

Example for a Linux client system

Add the node definition for client node SUSAN to the client-configuration.xml file. The IBM Spectrum Protect server that the node communicates with is server.example.com on server port 1500. The SSL security protocol is not used. The path for the client system options file is /opt/tivoli/tsm/client/ba/bin/custom_opt.sys.

Issue the following command from the /opt/tivoli/tsm/cms/bin directory.

Command:
./CmsConfig.sh addnode SUSAN server.example.com 1500 NO_SSL /opt/tivoli/tsm/client/ba/bin/custom_opt.sys
Output:
Adding node.

Finished adding client configuration.

Example for a Windows client system

Add the node definition for client node SUSAN to the client-configuration.xml file. The IBM Spectrum Protect server that the node communicates with is server.example.com on server port 1500. The SSL security protocol is not used. The path for the client options file is c:\program files\tivoli\tsm\baclient\custom.opt.

Issue the following command. from the C:\Program Files\Tivoli\TSM\cms\bin directory.

Command:
cmsconfig addnode SUSAN server.example.com 1500 NO_SSL "c:\program files\tivoli\tsm\baclient\custom.opt"
Output:
Adding node.

Finished adding client configuration.