Registry Services CLIs at a glance

Body

Co-authored with Leonardo Faccio Demo

Reviewed by Maristela Salvatore

Did you know that Registry Services provides a command-line interface (CLI)? These CLIs support configuration, installation, updates, among other tasks.

Each CLI operation may have different required parameters. You can also define specific information for each CLI in a properties file.

You can list the available Registry Services CLIs, and respective parameters, by running:

frs.[bat|sh] [-properties property_file_name.properties]

or

frs.[bat|sh] help [-properties property_file_name.properties]

See below a brief explanation and the complete list of available Registry Services CLIs:

Installation CLIs:.

• install - installs Registry Services database and application server.

• uninstall - uninstalls Registry Services database and application server.

• update – updates the database and application server, for example, restores default cleansing rules and Resource Shape definitions in the database, updates database schema name in the database and application server, updates data source settings in the application server, and so on.

• rollback - rolls back Registry Services database schema from one version to another.

Note that there are some CLIs, such as install, uninstall, update CLIs, that should not be used unless strictly directed by the support team. By default, you must use IBM Installation Manager to perform these operations.

Configuration CLIs:

• config – manages configuration items, in other words, adds, deletes and lists configuration items; this CLI also executes other configuration tasks.

• manageNamespacePrefixes - creates, deletes, and lists new namespace prefix definitions.

Resource Shapes CLIs:

• createResourceShapes – creates custom Resource Shape definitions. Note that the custom Resource Shape should not conflict with any existing Resource Shape, in other words, it cannot describe the same rdf:type of any existing Resource Shape in the Registry Services database.

• deleteResourceShapes - deletes custom Resource Shape definitions. Note that the custom Resource Shape should not conflict with any existing Resource Shape, in other words, it cannot describe the same rdf:type of any existing Resource Shape in the Registry Services database.

• updateResourceShape – updates custom Resource Shape definitions. Note that the custom Resource Shape should not conflict with any existing Resource Shape, in other words, it cannot describe the same rdf:type of any existing Resource Shape in the Registry Services database.

For more information related to Resource Shapes, see the link below:

/support/pages/node/1275688

Cleansing Rules CLIs:

• updateCleansingRules - replaces the default cleansing rules by custom cleansing rules in Registry Services application.

• exportCleansingRules - lists all cleansing rules of a specific type in Registry Services database.

Monitoring CLIs:

• showVersion – retrieves the current version of any .jar and the currently installed runtime application.

• stats – collects the execution time of Registry Services calls to analyze and improve performance.

• healthCheck - monitors the configuration state and the availability health of Registry Services.

• resourceAnalytics – generates a statistics report of Registration and Resource Records.

Reconciliation CLIs:

• recomputeReconciledState - recomputes the reconciliation state of Registry Services Resource Records. This operation can take a long time. In case you want to stop the recompute process, you can use -stop option of this CLI.

• reconciliationStatus – lists how many Registration Records in Registry Services have pending reconciliation operations.

Service Provider Resource Management CLIs:

• deleteProvider – deletes all resources associated with a particular Service Provider and the Service Provider itself.

• remapUrl – updates URLs stored in the database when a Service Provider record is rehosted or there is a URL change.

You can see more information related to Registry Services command-line interface on Jazz for Service Management Information Center page:

http://pic.dhe.ibm.com/infocenter/tivihelp/v3r1/index.jsp?topic=%2Fcom.ibm.psc.doc_1.1.0.2%2Frs_original%2Fcli%2Frs_c_cli_operations.html