CmsConfig discover command

You can use the CmsConfig discover command to automatically discover options files and log files, and add them to the client configuration file, client-configuration.xml. In this way, you can help to ensure that the client management service can access the client log files and make them available for diagnosis in the Operations Center.

Typically, the client management service installer runs the CmsConfig discover command automatically. However, you must run this command manually if you changed the backup-archive client, such as added a client, or changed the server configuration or location of log files.

For the client management service to create a log definition in the client-configuration.xml file, the IBM Spectrum Protect™ server address, server port, and client node name must be obtained. If the node name is not defined in the client options file (typically, dsm.sys on Linux client systems and dsm.opt on Windows client systems), the host name of the client system is used.

To update the client configuration file, the client management service must access one or more log files, such as dsmerror.log and dsmsched.log. For best results, run the CmsConfig discover command in the same directory and by using the same environment variables as you would for the backup-archive client command, dsmc. In this way, you can improve the chances of finding the correct log files.

If the client options file is in a custom location or it does not have a typical options file name, you can also specify the path for the client options file to narrow the scope of the discovery.

Syntax


>>-CmsConfig discover--+------------+--------------------------><
                       '-configPath-'

Parameters

configPath: The path of the client options file (typically dsm.opt). Specify the configuration path when the client options file is not in a default location or it does not have the default name. The client management service loads the client options file and discovers the client nodes and logs from there. This parameter is optional.
On a Linux client system, the client management service always loads the client user-options file (dsm.opt) first, and then looks for the client system-options file (typically dsm.sys). The value of the configPath parameter, however, is always the client user-options file.

Examples for a Linux client system

Discover the client log files and automatically add the log definitions to the client-configuration.xml file.
Issue the following command from the /opt/tivoli/tsm/cms/bin directory.
Command:

./CmsConfig.sh discover

Output:
```
Discovering client configuration and logs.

server.example.com:1500 SUSAN
    /opt/tivoli/tsm/client/ba/bin/dsmerror.log

Finished discovering client configuration and logs.
```

Discover the configuration files and log files that are specified in the /opt/tivoli/tsm/client/ba/bin/daily.opt file and automatically add the log definitions to the client-configuration.xml file.

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

Command:

./CmsConfig.sh discover /opt/tivoli/tsm/client/ba/bin/daily.opt

Output:

Discovering client configuration and logs

server.example.com:1500 NO_SSL SUSAN
Capabilities: [LOG_QUERY]
    Opt Path: /opt/tivoli/tsm/client/ba/bin/dsm.sys

    Log File:  /opt/tivoli/tsm/client/ba/bin/dsmerror.log
        en_US MM/dd/yyyy HH:mm:ss Windows-1252

    Log File: /opt/tivoli/tsm/client/ba/bin/dsmsched.log
        en_US MM/dd/yyyy HH:mm:ss Windows-1252

Finished discovering client configuration and logs.

Examples for a Windows client system

Discover the client log files and automatically add the log definitions to the client-configuration.xml file.
Issue the following command from the C:\Program Files\Tivoli\TSM\cms\bin directory.
Command:

cmsconfig discover

Output:
```
Discovering client configuration and logs.

server.example.com:1500 SUSAN
    C:\Program Files\Tivoli\TSM\baclient\dsmerror.log

Finished discovering client configuration and logs.
```

Discover the configuration files and log files that are specified in the c:\program files\tivoli\tsm\baclient\daily.opt file and automatically add the log definitions to the client-configuration.xml file.

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

Command:

cmsconfig discover "c:\program files\tivoli\tsm\baclient\daily.opt"

Output:

Discovering client configuration and logs

server.example.com:1500 NO_SSL SUSAN
Capabilities: [LOG_QUERY]
    Opt Path: C:\Program Files\Tivoli\TSM\baclient\dsm.opt

    Log File: C:\Program Files\Tivoli\TSM\baclient\dsmerror.log
        en_US MM/dd/yyyy HH:mm:ss Windows-1252

    Log File: C:\Program Files\Tivoli\TSM\baclient\dsmsched.log
        en_US MM/dd/yyyy HH:mm:ss Windows-1252

Finished discovering client configuration and logs.