Configuring and Using Diagnostic Tools › CA SOI Toolbox Utility › Configuration Options

Configuration Options

This section describes the different commands for the CA SOI toolbox that you can use to configure a CA SOI instance. In all commands, include the necessary options to establish a valid connection with the SA Store database. If you do not, the utility prompts you for the necessary information.

-m, --machine

Specifies the system to connect to which runs the SA Store database.

Default: localhost

-n, --mUsername

Specifies the name of the user who has access to the database system.

Note: This command is not valid and has no effect when using the localhost system.

Default: Administrator

-w, --mPassword

Specifies the password of the Windows users in plain text.

Note: This command is not valid and has no effect when using the localhost system.

-d, --dbName

Specifies the name of the CA SOI database.

Default: SAMStore

--dbArchiveName

Allows you to specify a new name for the archive database.

-u, --dbUsername

Specifies the user with privileges to access the CA SOI database.

Default: sa

-p, --dbPassword

Specifies the password for the database user in plain text.

Note: If the password is not specified, the utility requests it during runtime.

--credentials

Specifies the location of the file containing the user names and passwords for all systems that run CA SOI components. This command is required when you operate a distributed CA SOI instance.

-x

Creates a configuration file template if the file does not exist.

Note: This command is the equivalent of --credentials=soitoolbox.cfg.

-q, --quiet

Specifies that the user is not asked to confirm the running of a destructive operation.

-t, --timeout

Specifies the generic timeout in seconds.

Default: 30

-b, --dbConnectionTimeout

Specifies the timeout in seconds for the initial wait time for the opening of the database connection.

Default: 30

-c, --connector

Specifies the connectors to be used in action commands.

Default: *

Note: * in this case means all connectors in a CA SOI instance. The following examples show how the * symbol can be used:

--connector=CA:09998_soimachine.ca.com, CA:00005_soimachine.ca.com
--connector=CA:09998_*
--connector=CA:*_soimachine.ca.com
--connector=*

-s, --beSmart

Activates a special method for stopping connectors. In beSmart mode, the utility only stops components (services and connectors) which affect or can be affected by an action command.

Note: This option requires that you include --credentials.