CmsConfig addlog command

Edit online

Use the CmsConfig addlog command to manually add the location of client log files to an existing node definition in the client-configuration.xml configuration file. Use this command only if the client log files are stored in a non-default location on the client system.

Requirement: If the node definition does not exist, you must first issue the CmsConfig addnode command to create the node definition.

Syntax

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

logPath

The fully qualified path of the log files. This parameter is required.

Example (Linux client): /opt/backup_tools/tivoli/tsm/baclient/dsmerror.log

Example (Windows client): C:\backup tools\Tivoli\TSM\baclient\dsmerror.log

language

The language locale of the log file. This parameter is optional. However, if you specify this parameter, you must also specify the dateFormat, timeFormat, and encoding parameters. You must specify the locale for the following languages.

Language	Locale
Brazilian Portuguese	`pt_BR`
Chinese, Simplified	`zh_CN`
Chinese, Traditional	`zh_TW`
Czech	`cs_CZ`
English	`en_US`
French	`fr_FR`
German	`de_DE`
Hungarian	`hu_HU`
Italian	`it_IT`
Japanese	`ja_JP`
Korean	`ko_KR`
Polish	`pl_PL`
Russian	`ru_RU`
Spanish	`es_ES`

dateFormat

The date format of the time stamp entries in the client log file. This parameter is optional. However, if you specify this parameter, you must also specify the language, timeFormat, and encoding parameters.

The following table shows the date formats for the languages.

Tip: Instead of using one of the date formats that are listed in the table, you can specify a date format by using the backup-archive client dateformat option.

Language	Date format
Chinese, Simplified	`yyyy-MM-dd`
Chinese, Traditional	`yyyy/MM/dd`
Czech	`dd.MM.yyyy`
English	`MM/dd/yyyy`
French	`dd/MM/yyyy`
German	`dd.MM.yyyy`
Hungarian	`yyyy.MM.dd`
Italian	`dd/MM/yyyy`
Japanese	`yyyy-MM-dd`
Korean	`yyyy/MM/dd`
Polish	`yyyy-MM-dd`
Portuguese, Brazilian	`dd/MM/yyyy`
Russian	`dd.MM.yyyy`
Spanish	`dd.MM.yyyy`

timeFormat

The time format of the time stamp entries in the client log file. This parameter is optional. However, if you specify this parameter, you must also specify the language, dateFormat, and encoding parameters.

The following table shows examples of default time formats that you can specify and client operating systems.

Tip: Instead of using one of the time formats that are listed in the table, you can specify a time format by using the backup-archive client timeformat option.

Language	Time format for Linux client systems	Time format for Windows client systems
Chinese, Simplified	`HH:mm:ss`	`HH:mm:ss`
Chinese, Traditional	`HH:mm:ss`	`ahh:mm:ss`
Czech	`HH:mm:ss`	`HH:mm:ss`
English	`HH:mm:ss`	`HH:mm:ss`
French	`HH:mm:ss`	`HH:mm:ss`
German	`HH:mm:ss`	`HH:mm:ss`
Hungarian	`HH.mm.ss`	`HH:mm:ss`
Italian	`HH:mm:ss`	`HH:mm:ss`
Japanese	`HH:mm:ss`	`HH:mm:ss`
Korean	`HH:mm:ss`	`HH:mm:ss`
Polish	`HH:mm:ss`	`HH:mm:ss`
Portuguese, Brazilian	`HH:mm:ss`	`HH:mm:ss`
Russian	`HH:mm:ss`	`HH:mm:ss`
Spanish	`HH:mm:ss`	`HH:mm:ss`

encoding

The character encoding of the entries in the client log files. This parameter is optional. However, if you specify this parameter, you must also specify the language, dateFormat, and timeFormat parameters.

For Linux client systems, the typical character encoding is UTF-8. For Windows client systems, the default encoding values are shown in the following table. If your client system is customized differently, use the encoding parameter to specify a value other than the default.

Language	Encoding
Chinese, Simplified	`CP936`
Chinese, Traditional	`CP950`
Czech	`Windows-1250`
English	`Windows-1252`
French	`Windows-1252`
German	`Windows-1252`
Hungarian	`Windows-1250`
Italian	`Windows-1252`
Japanese	`CP932`
Korean	`CP949`
Polish	`Windows-1250`
Portuguese, Brazilian	`Windows-1252`
Russian	`Windows-1251`
Spanish	`Windows-1252`

Example for a Linux client system

Add the client log file location to the existing definition for client node SUSAN in the client-configuration.xml file. The path for the client log file is /usr/work/logs/dsmerror.log. Add the language specification, time format, and date format for the French locale.

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

Command:

./CmsConfig.sh addlog SUSAN /usr/work/logs/dsmerror.log fr_FR yyyy/MM/dd HH:MM:ss UTF-8

Output:

Adding log.

Finished adding log.

Example for a Windows client system

Add the client log file location to the existing definition for client node SUSAN in the client-configuration.xml. The path for the client log file is c:\work\logs\dsmerror.log. Add the language specification, time format, and date format for the French locale.

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

Command:

cmsconfig addlog SUSAN c:\work\logs\dsmerror.log fr_FR yyyy/MM/dd HH:MM:ss UTF-8

Output:

Adding log.

Finished adding log.