Configuring and Using Diagnostic Tools › How to Clean Up Data with the CA SOI Toolbox › Create a CA SOI Toolbox Configuration File

Create a CA SOI Toolbox Configuration File

For CA SOI instances that do not run entirely in one local location, create a CA SOI toolbox configuration file. This configuration file allows you to run commands, using the -x option. The -x option allows you to provide all the credentials of a complex CA SOI instance which is not run in one location locally. To allow the running of commands using the -x option for a complex CA SOI instance, create a CA SOI toolbox configuration file.

Follow these steps:

1. Open the toolbox with a command prompt.
2. Run the -x command from the toolbox.

   The toolbox creates an empty configuration file.

   Important! Before the toolbox creates the empty configuration file, an ERROR: bad content - File not found message appears. Disregard this message.

3. Open the empty configuration file soitoolbox.cfg in a text editor.

   The empty configuration file, which is a template, opens displaying instructions with placeholders.

4. Specify all the information for your CA SOI instance in the configuration file placeholders.

   Note: The file contains instructions about the information that you specify.

5. Save the configuration file with the changes you made.

   Your CA SOI instance now has a toolbox configuration file which you can use to run toolbox commands by using the -x option.

Note: Include the -x option before any call or command instead of specifying specific credentials when using the CA SOI toolbox. For example, you would run the following command to get a list of all the connectors in CA SOI instance after you set up the configuration file:

soitoolbox -x --getAvailableConnectors

Important! If you use the -x option, do not use the -m option to specify a machine. If you use both options in a command, an error occurs.