1. Installation and Configuration Guide
  2. Non-Interactive ORDS CLI Commands Examples

A Non-Interactive ORDS CLI Commands Examples

This section provides some examples for non-interactive install/upgrade, and uninstall.

The following are examples for non-interactive install/upgrade, and uninstall.

The password file must contain the password(s) in the correct order to match the order of the user(s), option(s) that are specified on the command-line.

The following examples can be used for a PDB, CDB. Ensure that the --db-servicename option contains the correct value for the servicename for the CDB, PDB.

If the --log-folder <FOLDER> option is specified and the log folder does not exist, then the folder is created.

A.1 Non-Interactive Install/Upgrade

This section explains how to create a proxied APEX_PUBLIC_USER.

If APEX is installed and the APEX_PUBLIC_USER exists in the database, then the APEX_PUBLIC_USER is automatically configured to be a proxied user.

cat password.txt

<password for admin-user>

<password for proxy-user>

ords --config /path/to/test/config install --db-pool pdb1 --admin-user SYS --proxy-user --db-hostname localhost --db-port 1521 --db-servicename orcl --feature-sdw true --log-folder /path/to/logs --password-stdin < password.txt

Parent topic: Non-Interactive ORDS CLI Commands Examples

A.2 Non-Interactive Install/Upgrade (create a proxied PLSQL Gateway User)

This section explains how to create a proxied PLSQL Gateway User.

Specify a PL/SQL gateway user and --gateway-mode proxied.

ords --config /path/to/test/config install --db-pool pdb2 --admin-user SYS --proxy-user --db-hostname localhost --db-port 1521 --db-servicename pdb2 --feature-sdw true --gateway-user EXAMPLE_USER1 --gateway-mode proxied --log-folder /path/to/logs --password-stdin < password.txt

Parent topic: Non-Interactive ORDS CLI Commands Examples

A.3 Non-Interactive Install/Upgrade (specify PLSQL Gateway User and not using RESTful Services)

This section explains how to specify PLSQL Gateway User not using RESTful Services.

Specify a PL/SQL gateway user and --gateway-mode direct. The direct mode indicates that you are only using the PL/SQL GATEWAY and not RESTful Services. The gateway user password is required for direct mode.

cat gatewaypwd.txt

<password for admin-user>

<password for proxy-user>

<password for gateway-user>

ords --config /path/to/test/config install --db-pool pdb3 --admin-user SYS --proxy-user --db-hostname localhost --db-port 1521 --db-servicename pdb3 --gateway-user EXAMPLE_USER2 --gateway-mode direct --log-folder /path/to/logs --password-stdin < gatewaypwd.txt

Parent topic: Non-Interactive ORDS CLI Commands Examples

A.4 Non-Interactive Install/Upgrade (disable a configured PLSQL Gateway)

This section explains how to disable a configured PLSQL Gateway.

Disables the proxied PL/SQL gateway user.

ords --config /path/to/test/config install --db-pool pdb2 --admin-user SYS --proxy-user --db-hostname localhost --db-port 1521 --db-servicename pdb2 --feature-sdw true --gateway-mode disabled --log-folder /path/to/logs --password-stdin < password.txt

Parent topic: Non-Interactive ORDS CLI Commands Examples

A.5 Non-Interactive Uninstall ORDS

This section explains how to uninstall ORDS in the database.

To uninstall ORDS, execute the following commands:

cat adminpwd.txt
<password for admin-user>

ords --config /path/to/test/config uninstall --admin-user SYS --db-hostname localhost --db-port 1521 
--db-servicename orcl --log-folder /path/to/logs < adminpwd.txt

Parent topic: Non-Interactive ORDS CLI Commands Examples

A.6 config CLI Examples

This section provides config CLI examples.

Non-Interactive Update Wallet

If you want to change the password in the wallet, then specify the following:

ords --config /path/to/test/config config secret --password-stdin db.password < userpwd.txt

If you want to view the password in the wallet, then specify the following:

ords --config /path/to/test/config config get --secret db.password

Where:

userpwd.txt contains the password.

Note:

If you are changing the wallet for a specific pool, then you must provide the --db-pool option. The preceding example updates the default pool.

Parent topic: Non-Interactive ORDS CLI Commands Examples