Service Registry 3.1 Administration Guide

Admin Tool Command-line Options

The Admin Tool recognizes the command-line options that are listed in Synopsis and described in Options.

Synopsis

[-alias alias] [-command commands] [-debug] [-help] [-keypass keypass] [-localdir localdir] [-locale locale] [-registry url] [-root locator [-create]] [-sqlselect SQL-statement] [-verbose]

Options

-alias

The alias to use when accessing the user’s certificate in the keystore. Specify the alias that you used when you registered as a user. This option is required if you will use the Admin Tool to publish data to the Registry.

-command

The Admin Tool command sequence to run instead of getting commands from the interactive shell. Use a semicolon (;) to separate multiple commands. You do not have to include a quit command in commands. If you need to use a semicolon that is not a command separator, precede the semicolon by a backslash:


\;

The shell in which you run the Admin Tool might require you to escape the backslash with a second backslash:


\\;

If any command contains spaces, enclose the entire command sequence in single or double quotes so that the tool will treat the sequence as one command-line parameter instead of several. If your shell also interprets a semicolon as separating shell commands, you always have to put sequences of multiple Admin Tool commands in quotation marks.

-create

If necessary, create the RegistryPackage specified by the -root option as well as any parent RegistryPackage objects as needed. This option is valid only if the user who is running the Admin Tool is authorized to create objects.

-debug

Outputs extra information that is useful when debugging.

-help

Provides a list of these options.

-keypass

The password to use when accessing a user’s certificate in the keystore. Specify the password that you used when you registered as a user. This option is required if you will use the Admin Tool to publish data to the Registry.

-localdir

The base directory in the local file system for commands that relate to files in the local file system.

-locale

The locale (for example, en or fr) to use for selecting the resource bundle to use for error and status messages. The default is determined by the Java Virtual Machine (JVM).

-registry

The URL of the ebXML registry to which to connect. The default is http://localhost:6480/soar/registry/soap.

-root

The locator (for example, /registry/userData) of the RegistryPackage to use as the base for those commands that treat the repository as a tree of RegistryPackage objects that each contain other RegistryObject and RegistryPackage objects. The default is the RegistryPackage that is defined for all users’ data: /registry/userData.

-sqlselect

Execute SQL-statement to select registry objects. The statement should be a complete SQL statement that starts with select. The SQL statement must be enclosed in quotation marks, but it does not have to be terminated by a semicolon. If you specify this option and then use the select command with no argument, the command will execute SQL-statement until you use the select command with an argument other than SQL-statement.

-v | -verbose

Specifies the verbose output of status messages.


Note –

The output of the -help option lists two options that are not supported in this release: -class and -property.