C ORDS Legacy Commands and New ORDS CLI Commands

Table C-1 ORDS Legacy and New CLI Commands

Legacy Command New CLI Command Description

java -jar ords.war configdir

 ords --config /path/to/config <command> Example of using config option:

ords --config /path/to/config install <OPTIONS>
ords --config /path/to/config uninstall <OPTIONS>

Specifies the ORDS configuration folder that contains configuration files.

New CLI Command:If the configuration folder is not specified, your current working directory is your configuration folder. The command does not store the configuration location. You must provide the configuration location or use the default configuration location.

Legacy configuration directory:

The configuration location is stored in ords.war file. When the user executes the ords command, (example: install, setup) and the configuration location exists in ords.war file, then it does not prompt for the configuration location.

Refer to Setting Up the Configuration Folder Structure for more information.
java -jar ords.war install advanced 
/ords install
ords --config /path/to/config install
ords --config /path/to/config install --interactive
ords --config /path/to/config install -i

Install ORDS in interactive mode.

Legacy install advanced:

Prompts for the configuration information only if the ORDS configuration does not exist.

Prompts if you want to run in a standalone mode.

  

java -jar ords.war install --silent

java -jar ords.war install simple

java -jar ords.war

 ords --config /path/to/config install <OPTIONS>

Install ORDS in a non-interactive mode. No prompting for new install CLI command if the user provides install options and not specifying the -i or --interactive option.

Legacy install simple or no command :(java -jar ords.war)

Prompts for the configuration information only if the ORDS configuration does not exist.

If the configuration file does not exist and if the default parameter file does not contain any configuration values, then it prompts.
java -jar ords.war schema ords --config /path/to/config install Install or upgrade ORDS only. The configuration file is not updated.

New CLI Command: Enter a number to select the type of installation [1] Install or upgrade ORDS in the database only [2] Create or update a database pool and install/upgrade ORDS in the database [3] Create or update a database pool only Choose [1]: Option 1 is equivalent.

java -jar ords.war uninstall advanced

java -jar ords.war uninstall

ords uninstall

ords --config /path/to/config uninstall

ords --config /path/to/config uninstall --interactive

ords --config /path/to/config uninstall -i

Uninstalls ORDS in interactive mode.

java -jar ords.war uninstall --silent

java -jar ords.war uninstall simple

 ords --config /path/to/config uninstall <OPTIONS> Uninstall ORDS in non-interactive mode. If you provide uninstall options and not specify the -i or --interactive option, then you are not prompted for new uninstall CLI command.
java -jar ords.war set-property <KEY> <VALUE> ords --config /path/to/config config set <KEY> <VALUE> Updates the setting in the configuration file.

See Updating the Configuration Settings for a list of options.

java -jar ords.war standalone ords --config /path/to/config serve Launch ORDS in standalone mode.
java -jar ords.war user <USERNAME> ROLES ords --config /path/to/config config user add <NAME> <ROLE> Create the user and its roles to provide permission to the ORDS REST Services.
java -jar ords.war validate 
ords install repair 
ords --config /path/to/conf install repair 
ords --config /path/to/conf install repair --interactive
ords --config /path/to/conf install repair -i
Repair ORDS in interactive mode.  
java -jar ords.war validate --silent ords --config /path/to/conf install repair <OPTIONS>

Repair ORDS in non-interactive mode. There is no prompting for install repair CLI command if user provides install options afer omitting the -i or --interactive option.