Update application command

You can use the update command-line interface (CLI) to update the Registry Services application. This update process includes updating the application ear file that you deployed on the application server and modifying the authentication model.

The operation that you run through the update CLI command does not update any data source settings or user mapping configuration.

The update CLI command modifies the new version of the ear archive according to the current installation properties and deploys this ear on the server.

During this process, the CLI uses the old ear archive to check whether the user modified the cleansingRules.xml file currently deployed.

This CLI compares the current and the original cleansing rules files to determine whether there is any change. If there is any, the update CLI command issues a warning message and keeps all the changes that are made by the user.

Then, it generates a new ear file and updates the Registry Services application on the server.

Command syntax

The update CLI syntax varies according to the environment in which it is run:

frs.bat update -type container [-properties properties_file]
./frs.sh update -type container [-properties properties_file]

Parameters

Table 1 lists the parameters that are used with the update CLI and provides their description.

Table 1. Parameters used in the update CLI
Parameter	Value	Description
-type	`container`	This value defines that the update command must update the Registry Services application by deploying a new ear file.
[-properties]	`properties_file`	This value defines that the .properties file must act as the source of the updating properties. This parameter is optional. If you do not specify this parameter, the default `REGISTRY_HOME`\etc\CLI.properties file is used as the source of updating properties. This update operation requires these properties to be set in the CLI.properties file: `app.name` `appserver.host` `appserver.user` `appserver.password` `appserver.clientauthentication` `appserver.was.targets` `appserver.port` The application name that is defined in the `app.name` property must be deployed in the application server that is defined in the `appserver.host` and `appserver.port` properties.

When you update the Registry Services application with FIPS mode enabled, pass these SSL parameters to specify the certificate to be used for creating a SOAP connection to the WebSphere® Application Server:

Table 2. SSL parameters used in the update CLI (FIPS mode enabled)
Parameter	Value	Description
-keyStore	`file_name`	This value defines the name of the keystore file that contains a certificate for a user that is mapped to a Registry Services role. There can be multiple certificates. This parameter is required for certificate authentication purposes. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.keyStore` property in the CLI.properties file.
-keyStorePassword	`password`	This value defines the password for the certificate that is specified in the -keyStore parameter. This parameter is required for certificate authentication purposes. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.keyStorePassword` property in the CLI.properties file.
-trustStore	`file_name`	This value defines the name of the truststore file that contains the certificate of the server to which Registry Services connects to for processing this CLI. There can be multiple certificates to multiple servers. This parameter is required for certificate authentication purposes. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.trustStore` property in the CLI.properties file.
-trustStorePassword	`password`	This value defines the password for the certificate that is specified in the -trustStore parameter. This parameter is required for certificate authentication purposes. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.trustStorePassword` property in the CLI.properties file.
[-keyStoreType]	`type_name`	This value defines the keystore type. The default value for this optional parameter is the `keystore.type` specified in the java.security file of the JDK in use. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.keyStoreType` property in the CLI.properties file.
[-trustStoreType]	`type_name`	This value defines the truststore type. The default value for this optional parameter is the `truststore.type` specified in the java.security file of the JDK in use. If you do not specify this parameter, Registry Services reads it from the `javax.net.ssl.trustStoreType` property in the CLI.properties file.

Sample

frs.bat update -type container -properties C:/etc/container.properties
./frs.sh update -type container

Return codes

The update command prints a return code when it finishes running so you can have details about the result achieved. Table 3 provides the return codes that you can get by the end of the update run and their respective descriptions.

Table 3. Return codes of the update command run
Return code	Description
0	The update command ran the operation successfully.
1	The update command failed to run because of a missing -type parameter.
2	The update command failed to run because of a properties file not found.
3	The update command failed to run because of an invalid -type parameter that is specified in the command line.
4	The update command failed to run because of an update error.
99	The update command failed to run because the `readonly` operation mode is active.

This command is used for the installation maintenance only. Do not use it unless strictly directed by the support team.