Registry Services commands

With the Registry Services commands, you can run various tasks, such as installation and uninstallation of the Registry Services database, through the command-line interface (CLI).

The CLI operations are entered through a command line where you define the required values for the parameters. Specific information for each CLI run is defined in a properties file.

URL parameters and properties
The Registry Services URL parameters that you pass when you run a CLI command must match the Registry Services root URL.
If you define the public URL in Registry Services configuration, all URL parameters must match that value. Otherwise, all URLs must be consistent within the request.
When you run a CLI command, such as deleteProvider and remapUrl, the parameters values that you pass must match the appserver.host, appserver.port, and appserver.clientauthentication properties values.
For example, if you set the following properties as shown:
appserver.host=hostname
appserver.port=9086
appserver.clientauthentication=BASIC
The -providerUrl parameter must start with http://hostname:9086/.
If you set the following properties as shown:
appserver.host=hostname
appserver.port=9449
appserver.clientauthentication=CLIENT-CERT
The -providerUrl parameter must start by https://hostname:9449/
The CLI connects to the server with the root URL given by appserver.host, appserver.port, and appserver.clientauthentication properties values. Therefore, the -providerUrl parameter that you pass in the request to delete Registration Records must match the root URL. Registry Services finds nothing to delete if the -providerUrl parameter does not match the root URL.
If you must use the HTTPS form of the Registry Services URLs, set the public URL configuration value for Registry Services to match that root URL. All URLs in the CLIs must reference that value.

The Registry Services application uses the Registry_Home\etc\CLI.properties file as the default source of properties. However, you can specify any other path to the properties file for the CLI execution. In this case, you must set the -properties parameter from the command-line interface with the path to the properties file.

You set the CLI properties not only for Registry Services installation, but also for any other CLI command operation. See the CLI properties subsections for the list of required properties.

Required properties
The Registry Services CLIs that communicate with the WebSphere® Application Server rely on two properties to connect to Registry Services.
These properties are required in the properties file for you to run the CLIs when either authentication mechanism is set to Registry Services , Basic or Client-Cert:
  • appserver.user
  • appserver.password
Security-related properties
All CLIs support the setting of security-related properties that are passed in the CLI.properties file, but only the CLIs that communicate with the WebSphere Application Server also support the -keyStore, -keyStorePassword, -keyStoreType, -trustStore, -trustStorePassword, -trustStoreType CLI parameters.
Passing the properties in the file is considered safer than passing them as CLI parameters. The file can be secured in your file system and cannot be probed by other system users by dumping the list of running processes.
However, command-line parameters override their respective properties in the CLI.properties file.
The SSL properties are
  • javax.net.ssl.keyStore
  • javax.net.ssl.keyStorePassword
  • javax.net.ssl.trustStore
  • javax.net.ssl.trustStorePassword
  • javax.net.ssl.keyStoreType
  • javax.net.ssl.trustStoreType

For the list of CLIs that communicate with either DB2® database or WebSphere Application Server, see Command-line interface.

Attention: The install and uninstall CLI commands must be used for manual installation and uninstallation only. For example, after you configure your Jazz™ for Service Management environment for FIPS, you might want to disable non-SSL ports for IBM® DB2. You can then use the uninstall and install commands to manually reinstall the Registry Services application. By default, you must use Installation Manager to install and uninstall Registry Services.
Parent topic: Jazz for Service Management CLI references