1. Owner's Guide
  2. Recovery Appliance Command Line Interface Reference
  3. RACLI Overview

16 RACLI Overview

This topic provides a summary of all the RACLI commands.

NAME

RACLI - Recovery Appliance Command Line Interface

DESCRIPTION

The RACLI is a simplified and controlled environment for users to manage their Recovery Appliance via the command line.

SYNOPSIS

racli <COMMAND> <OBJECT>

HELP

Displays information about racli commands and their objects.

Usage: racli help [<COMMAND> [<OBJECT>]]

Options:

racli help

General usage information for the racli help command.

racli help <COMMAND>

Detailed information specific to the COMMAND requested.

racli help <COMMAND> <OBJECT>

Specific detailed information on the COMMAND and OBJECT relationship.

Command Description
racli add Adds an object to the Recovery Appliance.
racli add admin_user Adds a specified ADMIN_USER system user to the RACLI admin group.
racli add certificate Adds https certification on the Recovery Appliance.
racli add cloud_key Generates the public and private key files required for OCI access.
racli add cloud_location Adds a cloud storage object to the Recovery Appliance.
racli add cloud_user Adds a cloud user to the Recovery Appliance schema.
racli add credential Adds a user credential to the wallet of the Recovery Appliance.
racli add credential_wallet Adds a wallet object to the Recovery Appliance.
racli add db_user Adds a database user.
racli add host Adds a host to those available on the Recovery Appliance.
racli add keystore Adds a keystore to the Recovery Appliance.
racli add nfs Specifies that the Network File System (NFS) should be added to the Recovery Appliance schema.
racli add rasys_wallet Creates the rasys user wallet.
racli add storage_cells Prepares new Recovery Applicance storage cells for storage location expansion.
racli add storage_disks Adds disks with the newly added storage cells to the ASM disk groups for storage location expansion.
racli add tag Specifies the diagnostic TAG to add to all nodes of the Recovery Appliance.
racli add vpc_user Creates a new Virtual Private Catalog (VPC) user account in the Recovery Appliance schema.
racli alter Modifies the properties on objects supported in the Recovery Appliance schema.
racli alter admin_user Changes password for a admin_user system user.
racli alter check Modifies a check on the Recovery Appliance.
racli alter cloud_key Modifies the information associated with a cloud key.
racli alter cloud_location Modifies the properties of cloud storage supported on the Recovery Appliance.
racli alter credential_wallet Changes the password on a wallet object in the Recovery Appliance.
racli alter db_user Changes password for a database user.
racli alter keystore Creates a TDE master key for the Recovery Appliance, generates new keys, or changes the password for the keystore on the Recovery Appliance.
racli alter listener .
racli alter network Modifies the Recovery Appliance protocol with TLS enabled|only|disabled.
racli alter parameter Modifies the specified parameter whether it should be included or ignored as a check.
racli alter passphrase Modifies password used to access the Recovery Appliance.
racli alter rasys_user Modifies the Recovery Appliance rasys user account password and management of the password.
racli alter vpc_user Modifies an existing Recovery Appliance user account and changes its password.
racli approve Approves the object in the Recovery Appliance schema.
racli approve request Approves a given request identifier and gives that vote to the quorum.
racli configure Configure an object from operations performed by the Recovery Appliance.
racli configure archive_group Configures archive log grouping.
racli create Create an object from operations performed by the Recovery Appliance.
racli create certificate Creates a certificate used for HTTPS operations.
racli deny Denies the object in the Recovery Appliance schema.
racli deny request Denies a given request identifier and gives that vote to the quorum.
racli disable Disables an object from operations performed by the Recovery Appliance.
racli disable aide Disables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.
racli disable check Disables a specific check object from check run operations performed on the Recovery Appliance.
racli disable cloud_location Disables a cloud storage object for operations performed by the Recovery Appliance.
racli disable keystore Disables the keystore.
racli disable nfs Disables the specified Network File System (NFS).
racli disable rasys_user Disables access to the rasys user.
racli disable root_access Disables sudo to root access for user.
racli disable ssh Disables external ssh access to the system for 'root' and 'oracle' users.
racli disable sys_remote_access Disables access to the sys database root user.
racli enable Enables an object for operations performed by the Recovery Appliance.
racli enable acfs Enables the specified Automatic Storage Management Cluster (ACFS).
racli enable aide Enables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.
racli enable check Enables a check on the Recovery Appliance.
racli enable cloud_location Enables a cloud storage object for operations performed by the Recovery Appliance.
racli enable keystore Opens the keystore so that it can be used.
racli enable nfs Enables the specified Network File System (NFS).
racli enable rasys_user Enables access to the rasys user.
racli enable root_access Enables access to the root user.
racli enable ssh Enables external ssh access for 'root' and 'oracle' users.
racli enable sys_remote_access Enables access to the sys database root user.
racli export Used for exporting data.
racli export appliance Creates an export bundle for the Recovery Appliance.
racli install Installs software.
racli install appliance Installs software to the Recovery Appliance software.
racli install okv_endpoint Installs the software required for Oracle Key Vault (OKV) end points on the Recovery Appliance.
racli list Lists information about objects given in the Recovery Appliance schema.
racli list admin_user List admin_user system users who can execute racli commands.
racli list certificate Lists details of all HTTPS certificate on the Recovery Appliance.
racli list check List checks available on the Recovery Appliance.
racli list cloud_key List details in short (default) or long format about a specified cloud key or all cloud keys.
racli list cloud_location Lists details about the cloud storage known to the Recovery Appliance.
racli list cloud_user List details about the specified cloud user, or all cloud users.
racli list compute_nodes Lists the names of the compute nodes available on the Recovery Appliance.
racli list db_user List details about the specified database user, or all database users.
racli list grid_home Lists details about grid_home.
racli list host Lists details about all hosts available to the Recovery Appliance.
racli list ip_addr Lists details about all IP addresses available to the Recovery Appliance.
racli list listener Lists details of an individual or all listeners on the Recovery Appliance.
racli list nfs Lists details about one or more Network File System mounts.
racli list okv_endpoint Lists details about the OKV end points known to the Recovery Appliance.
racli list oracle_home Lists details about oracle_home.
racli list parameter Lists the names and value of the init parameters for the Recovery Appliance.
racli list san Lists subject alternate name (SAN).
racli list scan Lists details of scan on the Recovery Appliance.
racli list scan_listener Lists details of scan_listener on the Recovery Appliance.
racli list storage_cells Lists names of storage cells available to the Recovery Appliance.
racli list tag List diagnostic tags available on the Recovery Appliance.
racli patch The action to patch a specified object.
racli patch appliance Patch the Recovery Appliance Software (DEPRECATED).
racli remove Removes objects from the Recovery Appliance schema.
racli remove acfs Removes the specified Automatic Storage Management Cluster (ACFS) mount from the Recovery Appliance schema.
racli remove admin_user Removes a admin_user system user from the system passwd database.
racli remove certificate Removes the specified HTTPS certificate.
racli remove cloud_key Removes the specified cloud key, but only if no cloud users are associated with the key.
racli remove cloud_location Removes the specified cloud storage from the Recovery Appliance, unless the cloud archive job template is tied to the library.
racli remove cloud_user Removes a cloud user.
racli remove db_user Removes a database user.
racli remove grid_home Removes the specified grid home.
racli remove host Removes the specified host.
racli remove keystore Removes the specified keystore from the Recovery Appliance schema.
racli remove nfs Removes the specified Network File System (NFS) mount from the Recovery Appliance schema.
racli remove oracle_home Removes the specified oracle home.
racli remove osb_pieces Removes all pieces that are no longer in the ZDLRA catalog from the OSB catalog.
racli remove tag Removes the specified diagnostic TAG from all nodes of the Recovery Appliance.
racli remove vpc_user Removes the specified user account from the Recovery Appliance metadata schema.
racli run Performs an action for an object to the Recovery Appliance.
racli run check Runs the enabled checks for the Recovery Appliance.
racli run diagnostics Runs and collects the required diagnostics on the Recovery Appliance.
racli run preinstall Execute preinstallation tasks.
racli start The action to start a specified service (object).
racli start appliance Starts all services on the Recovery Appliance.
racli start nfs Start NFS services of the Recovery Appliance.
racli status Check status of objects associated with the Recovery Appliance.
racli status aide Returns the status of the Advanced Intrusion Detection Environment (AIDE).
racli status appliance Returns a summary of the status of the appliance.
racli status cloud_location Lists the status of a cloud storage object for operations performed by the Recovery Appliance.
racli status disk_group Verifies that the rebalance operation completed after storage cells or storage disks are added to the ASM disk group.
racli status keystore Returns the status of the keystore in use by the Recovery Appliance.
racli status listener Returns the status of an individual listener or all listeners on the Recovery Appliance.
racli status nfs Returns the status of the Network File Service (NFS).
racli status okv_endpoint Returns the status of the OKV_ENDPOINTs associated with the Recovery Appliance.
racli status request Shows status of all scan on the Recovery Appliance.
racli status scan Shows status of all scan on the Recovery Appliance.
racli status scan_listener Shows status of all scan_listeners on the Recovery Appliance.
racli stop The action to stop a specified service (object).
racli stop appliance Stops all services on the Recovery Appliance.
racli stop nfs Stop NFS services of the Recovery Appliance.
racli uninstall Backs out a portion of the installation.
racli uninstall appliance Backout a step during install.
racli uninstall okv_endpoint Uninstalls the specified OKV end point.
racli update Update a component of the Recovery Appliance.
racli update aide Updates the Advanced Intrusion Detection Environment (AIDE).
racli update appliance Updates the ZDLRA.
racli update parameter Update init parameters in the Recovery Appliance.
racli update ssh_known_hosts Maintains a system-wide configuration file /etc/ssh/ssh_known_hosts from LsNodes() and GetCells().
racli update storage_location Update RA pool data file with the most current number of storage cells.
racli update support_tools Updates the AHF and Exachk versions using the staged binaries zip files.
racli upgrade The action to upgrade a specified object to the next version.
racli upgrade appliance Upgrade the Recovery Appliance Software Versions (DEPRECATED).
racli version Returns the ZDLRA software release version in use.

racli add

Adds an object to the Recovery Appliance.

Options

Details

Adds an object to the Recovery Appliance.

racli add admin_user

Adds a specified ADMIN_USER system user to the RACLI admin group.

Syntax

racli add admin_user --user_name=USER_NAME [--user_uid=USER_ID --user_gid=GROUP_ID]

Options

--user_name

System user name to add to RACLI admin group.

--user_uid

Set the user identifier for the newly created admin user. Value must be >= 1003.

--user_gid

Set the initial login group identifier for the newly created admin user. A group number must refer to an already existing group. Value must be >= 1003.

Details

This system user can execute RACLI commands. User is created if not already in the passwd database. This command prompts you to enter a user password.

racli add certificate

Adds https certification on the Recovery Appliance.

Syntax

racli add certificate { [--signed_cert=VALUE --trusted_cert=VALUE] | [--self_signed] }

Options

--self_signed

Specifies that the Recovery Appliance should generate the certificates itself. This mode is for testing.

--signed_cert

Specifies the full path of Recovery Appliance certificate to be added.

--trusted_cert

Specifies the full path of root certificate to be added.

Details

When the current certificate is about to expire or has expired, use this command to upload a new valid certificate to the Recovery Appliance wallet with the --signed_cert and --trusted_cert arguments.

racli add cloud_key

Generates the public and private key files required for OCI access.

Syntax

racli add cloud_key --key_name=KEY_NAME [--fingerprint=PUBFINGERPRINT --pvt_key_path=PVTKEYFILE]

Options

--key_name

The name of the cloud_key object to create.

--fingerprint

Specifies the name of the fingerprint for the public key that is paired with the specified private key. The fingerprint is used to authenticate the request.

--pvt_key_path

The name of a private key used to sign BMC API requests. The key file must be in PEM format.

Details

Generates the public and private key files required for OCI access. It also associates fingerprint and pre-existing private key files.

The first syntax form generates the public and private keys required for OCI access. The user takes the generated public key to get fingerprint from OCI console.

racli add cloud_key --key_name=KEY_NAME

The second syntax form associates fingerprint and private key files that already exist.

racli add cloud_key --key_name=KEY_NAME --fingerprint=PUBFINGERPRINT --pvt_key_path=PVTKEYFILE

racli add cloud_location

Adds a cloud storage object to the Recovery Appliance.

Syntax

racli add cloud_location --cloud_user=CLOUD_USER_NAME --host=HOST_URL --bucket=OCI_BUCKET_NAME [--enable_archive | --disable_archive] [--archive_after_backup=NUMBER:{DAYS|YEARS} --streams=NUMBER --proxy_host=HTTP_SERVER --proxy_port=HTTP_PORT --proxy_id=HTTP_USER --proxy_pass=HTTP_PASS --import_all_trustcert=X509_CERT_PATH --retain_after_restore=NUMBER:HOURS] [-guaranteed={yes|no}] [--immutable --temp_metadata_bucket=METADATA_BUCKET_NAME]

Options

--archive_after_backup

The number in days or years for period of time before backups are moved to archive state. It takes the form "--archive_after_backup=NUMBER:DAYS" or "--archive_after_backup=NUMBER:YEARS", where NUMBER is a positive integer. If not specified, the default is 2 days.

--bucket

The name of the bucket where the backup will go. Note that the install tool will create the specified bucket if it does not exist.

--cloud_user

Previously configured cloud_user object with all authentication requirements.

--disable_archive

Disables archival of backup data.

--enable_archive

Enables archival of backup data after the time interval specified by the --archive_after_backup parameter. If not specified, by default the archival will be disabled.

--host

Host name for the Oracle Bare Metal Cloud account.

--import_all_trustcert

Import all X509 certificates from Java truststore.

--streams

The number of streams to be associated with this specific cloud_location. Directly translates to the number of sbt_attrib sets created.

--proxy_host

HTTP proxy server. Used for OCI-C support.

--proxy_id

HTTP proxy server username. Used for OCI and stored as part of the alias_http_proxy in location wallet.

--proxy_pass

HTTP proxy server password. Stored as part of the alias_http_proxy in location wallet.

--proxy_port

HTTP proxy server port. Used for OCI-C support.

--retain_after_restore

Specifies the number of hours to retain information after a restore.

It takes the form "--retain_after_restore=NUMBER:HOURS". It has a maximum value of "240:HOURS".

--guaranteed

If --guaranteed=yes, this cloud location will require a copy of a backup piece before it can be deleted. For virtual backups, only one of the Level 0 or Level 1 copies of a backup piece are required.

--immutable

This makes the bucket being added immutable. Must be used with the --temp_metdata_bucket option.

--temp_metadata_bucket

Used for immutable buckets.

Specifies the metadata bucket name for immutable cloud location setup. The metadata bucket must be a mutable bucket (i.e. non immutable) and must exist. It can be created using the OCI console. Each metadata bucket must be unique. You cannot use the same metadata bucket for different immutable buckets.

Details

This is equivalent to the sbt_library used for copy-to-tape but is specific to copy-to-cloud. The user's cloud credentials are required.

Examples

This example adds a new cloud storage object to the Recovery Appliance schema.

racli add cloud_location --cloud_user=samu ---host=https://cloud_uri/oci -bucket=sam_backup

racli add cloud_user

Adds a cloud user to the Recovery Appliance schema.

Syntax

racli add cloud_user --user_name=CLOUD_USER_NAME --key_name=CLOUD_KEY_NAME --user_ocid=UOCID --tenancy_ocid=TOCID [--compartment_ocid=COCID]

Options

--user_name

The name to be associated with this particular cloud user.

--key_name

The specific cloud key to be associated with this cloud user.

--tenancy_ocid

The tenancy OCID for the Oracle Bare Metal Cloud account.

--user_ocid

The user OCID for the Oracle Bare Metal Cloud account.

--compartment_ocid

The compartment OCID within the tenancy of the Oracle Bare Metal Cloud Account.

Details

Adds a cloud user to the Recovery Appliance schema.

racli add credential

Adds a user credential to the wallet of the Recovery Appliance.

Syntax

racli add credential --user_name=OS_USER_ID --alias=ALIAS_ID --wallet_path=PATH_TO_WALLET

Options

--user_name

The OS user name associated with the credential to be added.

--alias

The alias you want to associate to the OS username that corresponds to the credential to be added.

--wallet_path

The path to the wallet where you want to store the credential.

Details

Adds a user credential to the wallet of the Recovery Appliance.

Examples

This example adds a credetinal for OS user charlie with an alias of sierra into the designated wallet.

racli add credential --wallet_path=/raacfs/raadmin/cloud/test --user_name=charlie --alias=sierra

When prompted, enter the password for the OS user for which the credential is to be added.

Enter Password [charlie]:  
Confirm Password [charlie]:

When prompted, enter the password for the wallet the credential is to be added.

Enter Wallet Password: 
Confirm Wallet Password:

racli add credential_wallet

Adds a wallet object to the Recovery Appliance.

Syntax

racli add credential_wallet --wallet_path=PATH_TO_WALLET

Options

--wallet_path

Path the credential wallet will reside.

Details

Adds a wallet object to the Recovery Appliance. You are prompted to enter new passwords for the keystore and then the wallet. The credentials to access the Recovery Appliance encryption keystore are saved in this wallet.

If no wallet path is specified, the default path is used /raacfs/raadmin/ra_wallet/.

Examples

This example adds a credential wallet in the defualt path.

racli add credential_wallet

When prompted, enter the password for the new credential wallet.

Enter Wallet Password: 
Confirm Wallet Password:

racli add db_user

Adds a database administration user who can manage and configure the Recovery Appliance.

The db_user user type admin replaces the usage of rasys for configuration and day-to-day Recovery Appliance management operations. This account can issue certain SQLPlus commands within its assigned privileges.

Note:

The db_user user type admin has limits of privileges, and cannot be used as sysdba in SQLPlus.

Syntax

racli add db_user --user_name=USER_NAME --user_type=admin|monitor|vpc

Options

--user_name

User name for the database user.

--user_type

Can be admin, monitor, or vpc. Admin user can manage and configure the Recovery Appliance. Monitor user has read-only access to Enterprise Manager. VPC user is the virtual private catalog user.

--insecure

This option can only be used with the VPC user_type.

VPC users created with this option will have the DEFAULT profile and will not have password rollover support.

racli add host

Adds a host to those available on the Recovery Appliance.

Syntax

racli add host --host_name=HOSTNAME --ip=IPADDRESS --domain_name=DOMAINNAME

Options

--host_name

Specifies the name of the host to be added.

--ip

Specifies the IP address for the host being added.

--domain_name

Specifies the domain name for the host being added.

racli add keystore

Adds a keystore to the Recovery Appliance.

Syntax

racli add keystore --type=[HSM|SW] [--restart_db]

Options

--type

Specifies the type of keystore to be created. If not specified, default is HSM.

--restart_db

Restarts the database stack after changes to the keystore to ensure they are honored at service restart.

Details

Adds a keystore to the Recovery Appliance. The keystore contains one or more TDE master keys for each Recovery Appliance client database, plus the Recovery Appliance's TDE master key. The per-client TDE master keys are used to encrypt backup pieces that are copied to the cloud.

ATTENTION: The Recovery Appliance database is restarted to activate the keystore; plan for a short outage.

Examples

This example adds a keystore of type HSM to the Recovery Appliance.

racli add keystore --type=hsm

racli add nfs

Specifies that the Network File System (NFS) should be added to the Recovery Appliance schema.

Syntax

racli add nfs --nfs_server=myServerName --nfs_export=myExportPath --name=myNfsMountName --mount_options='NFS_OPTIONS'

Options

--name

Name to be given to the NFS mount object.

--nfs_server

Server name where the myExportPath resides.

--nfs_export

Path on the myServerName intending to mount.

--mount_options

NFS mounting options. For example: 'rw,tcp,vers=3,timeo=600,actimeo=0'

Details

Specifies that the Network File System (NFS) should be added to the Recovery Appliance schema.

racli add rasys_wallet

Creates the rasys user wallet.

Syntax

racli add rasys_wallet

Options

Details

Creates the rasys user wallet.

racli add storage_cells

Prepares new Recovery Applicance storage cells for storage location expansion.

Syntax

racli add storage_cells --cells=cell1,cell2,...celln

Options

--cells

The comma-separated list of storage cell names to prepare.

Details

Prepares new Recovery Applicance storage cells for storage location expansion.

  • The new storage cells must be the same Exadata image version as the existing storage cells.

  • The new storage cells must not have any associated databases. To verify if this is the case, run:

    cellcli -e list database

Examples

This example adds the storage cells named cellhost1 and cellhost2 to the Recovery Appliance.

racli add storage_cells --cells=cell1,cell,...celln2

racli add storage_disks

Adds disks with the newly added storage cells to the ASM disk groups for storage location expansion.

Syntax

racli add storage_disks --cells=cell1,cell2,...celln --priority=high

Options

--cell

The comma-separated list of names of the newly added storage cells for the new disk groups.

--priority

Indicates the priority level for the rebalance. The default is low. Low = 4. High = 32.

This command should only be ran after rebalance is complete.

Details

Adds disks with the newly added storage cells to the ASM disk groups for storage location expansion.

You must have previously run racli add storage_cells to prepare the cells before adding the storage cells to the existing disk groups.

Run this command only if prompted to do so while running the racli add storage_cells command.

You can execute this command while the system is running, but the operation can take longer to complete and can negatively impact performance. Avoid running other I/O intensive tasks such as patching or maintenance during this time.

Examples

The following example adds storage cells named cellhost1 and cellhost2 to the storage disks.

racli add storage_disks --cells=cell1,cell2,...celln

racli add tag

Specifies the diagnostic TAG to add to all nodes of the Recovery Appliance.

Syntax

racli add tag --tag=myTagName --level=myLevel

Options

--tag

Name of the new tag to be added.

--level

The level of the ANDed diagnostics to include in the tag, available levels are:

level 1 System activity report.

level 2 RA dump txt file.

level 4 RA dump datapump.

level 8 ORDERING_WAIT analysis.

level 16 Corruption.

level 32 Gather racli logs from each node.

level 64 Get RA version information from each node.

level 128 Get store and config files from each node.

level 256 Get root and oracle history from each node.

level 512 Get network information from each node.

level 1024 Run obtool gathering useful information.

level 2048 Get osb logs from each node.

level 4096 Get /usr/etc/ob/xcr from each node.

level 8192 Get backup/admin/state from each node.

level 16384 Get all nodes ASM and ZDLRA alert.logs.

The levels can be ANDed together to create a collection.

Details

Specifies the diagnostic TAG to add to all nodes of the Recovery Appliance

Examples

This example adds a new TAG to collect racli logs and Recovery Appliance version information from each node:

racli add tag --tag=new_tag --level=196608

racli add vpc_user

Creates a new Virtual Private Catalog (VPC) user account in the Recovery Appliance schema.

Syntax

racli add vpc_user --user_name=myVpcUserName (deprecated)

Options

user_name

The name of the Recovery Appliance catalog user account to add.

Details

(deprecated) This command is deprecated. Please use racli add db_user --user_name=myVpcUserName --type=vpc to add a vpc user.

Each Recovery Appliance user account is the owner of the virtual private catalog.

  • The password is not provided on the command line for security reasons. When prompted, enter a password for the Recovery Appliance user account. The password must contain eight or more characters. Strong password authentication is used, so simple passwords are not allowed.

  • The Recovery Appliance user account being added must not already exist in the metadata database.

  • The password on the DEFAULT database profile will expire. To avoid the password expiring, change the profile associated with the VPC user.

Because strong password authentication is used, simple passwords can result in ORA-280003 or ORA-20006 errors.

When a vpc_user is created, the account is locked. The DEFAULT database profile has the following limits.

  • Failed attemps is set to 10.

  • Password life time is 180 days.

  • Password lock time is 1 day.

  • Password grace time is 7 days.

Examples

This example adds the user name ravpc1 to the Recovery Appliance schema.

racli add vpc_user --user_name=ravpc1

When prompted, enter the password for ravpc1. 

ravpc1 New Password:

racli alter

Modifies the properties on objects supported in the Recovery Appliance schema.

Options

Details

Modifies the properties on objects supported in the Recovery Appliance schema.

racli alter admin_user

Changes password for a admin_user system user.

Syntax

racli alter admin_user --user_name=USER_NAME

Options

--user_name

System user name to alter.

Details

Prompts to enter a user password.

racli alter check

Modifies a check on the Recovery Appliance.

Syntax

racli alter check { --check_name=CHECK_NAME };

Options

--check_name

Indicates the name of the check to be modified from the Recovery Appliance.

Details

Modifies a check on the Recovery Appliance.

racli alter cloud_key

Modifies the information associated with a cloud key.

Syntax

racli alter cloud_key --key_name=KEY_NAME [--fingerprint=PUBFINGERPRINT --pvt_key_path=PVTKEYFILE]

Options

--key_name

The name of the cloud key object.

--fingerprint

Specifies the name of the fingerprint for the public key that is paired with the specified private key. The fingerprint is used to authenticate the request.

--pvt_key_path

The name of a private key used to sign requests. The key file must be in PEM format.

Details

Modifies the information associated with a cloud key.

A cloud key has to have a fingerprint associated with it in order to later be associated with a user.

racli alter cloud_location

Modifies the properties of cloud storage supported on the Recovery Appliance.

Syntax

racli alter cloud_location --location_name=CLOUD_LOCATION_NAME [--archive_after_backup=NUMBER:{DAYS|YEARS}] [--streams=NUMBER] [--proxy_host=HTTP_SERVER] [--proxy_id=HTTP_USER] [--proxy_pass=HTTP_PASS] [--proxy_port=HTTP_PORT] [--retain_after_restore=NUMBER:HOURS]

Options

--archive_after_backup

The number in days or years for period of time before backups are moved to archive state. It takes the form "--archive_after_backup=NUMBER:DAYS" or "--archive_after_backup=NUMBER:YEARS", where NUMBER is a positive integer. If not specified, the default is 2 days.

--location_name

The name of the cloud location where the backup will go. The cloud location correlates to OCI object store bucket. Note that the install tool will create the specified bucket if it does not exist.

--proxy_host

HTTP proxy host.

--proxy_id

HTTP proxy server username. Used for OCI and stored as part of the alias_http_proxy in location wallet.

--proxy_pass

HTTP proxy server password. Stored as part of the alias_http_proxy in location wallet.

--proxy_port

HTTP proxy server port. Used for OCI-C support.

--streams

The number of streams to be associated with this specific cloud_location. Directly translates to the number of sbt_attrib sets created.

Integer that specifies number of streams to associate with this specific cloud_location.

--retain_after_restore

Specifies the number of hours to retain information after a restore. It takes the form "--retain_after_restore=NUMBER:HOURS". It has a maximum value of "240:HOURS".

Details

Modifies the properties of cloud storage supported on the Recovery Appliance. This is equivalent to the sbt_library used for copy-to-tape. This sbt_library is specific to archive-to-cloud.

racli alter credential_wallet

Changes the password on a wallet object in the Recovery Appliance.

Syntax

racli alter credential_wallet --wallet_path=PATH_TO_WALLET

Options

--wallet_path

Path the credential wallet will reside.

Details

Changes the password on a wallet object in the Recovery Appliance.

If no wallet_path is specified the default path is used /raacfs/raadmin/ra_wallet/.

Examples

This example alters a credential wallet in the defualt path

racli add credential_wallet

When prompted, enter the password for the new credential wallet.

Enter Wallet Password:
Re Enter Password:

racli alter db_user

Changes password for a database user.

Syntax

racli alter db_user --user_name=USER_NAME --user_type=admin|monitor|vpc

Options

--user_name

database vault admin user name to alter.

--user_type

The type of the database user to alter. User types are admin, monitor, or vpc.

--enable_stig

This option can only be used with the vpc user type.

Changes the vpc user to the RA_STIG profile that has password rollover support.

--expire_pw_rollover

End the password rollover period for this database user immediately. The database user will not be able to login with the old password anymore.

This option will not prompt the user for a new password.

Details

Prompts to enter a user password.

racli alter keystore

Creates a TDE master key for the Recovery Appliance, generates new keys, or changes the password for the keystore on the Recovery Appliance.

Syntax

racli alter keystore { --initalize_key | --restart_db | --password | --rekey }

Options

--rekey

Generates new TDE master encryption key (rekey) for the Recovery Appliance. Keys for protected databases are created using dmbs_ra.key_rekey.

--password

Specifies a new password for the keystore.

--initialize_key

Generates the initial TDE master key for the keystore.

--restart_db

Restarts the database stack after changes to the keystore to ensure they are honored at service restart.

Details

Creates a TDE master key for the Recovery Appliance, generates new keys, or changes the password for the keystore on the Recovery Appliance.

Examples

The following example restarts the database stack following a keystore change.

racli alter keystore --restart_db

racli alter network

Modifies the Recovery Appliance protocol with TLS enabled|only|disabled.

Syntax

racli alter network --network_type=VALUE [--silent]

Options

Details

--service

Indicate the service being modified on the system. Valid value is "ra_server". Cannot be used of --network_type or its arguments.

--network_type

Indicate network type on the system. Cannot be used of --service or its arguments.

--encrypt

Specifies TLS encryption status on the system: "only" means HTTPS encryption; "enable" means dual HTTPS and HTTP; and "disable" means HTTP.

--http_port

Specifies HTTP port number to use. Default port is 8001.

--https_port

Specifies HTTPS port number to use. Default port is 8002.

--tcp_port

Specifies the TCP port number to use. Default port is 1521.

--tcps_port

Specifies TCPS port number to use. Default port is 2484

--rep_tcps_port

Specifies the replication TCPS port number to use. Default port is 2485.

--rep_tcp_port

Specifies the replication TCP port number to use. Default port is 1522.

--silent

When present

Refer to the command line syntax regarding which options can be used at the same time.

The optional parameters --network_type and --service cannot be used together, and they cannot each other's optional parameters.

When configuring HTTPS (encrypt=[enable!only]), optional parameters for changing the default ports for HTTP, TCP, and replication TCP are ignored. Similarly, when disabling HTTPS (encrypt=disable), optional parameters for changing ports for HTTPS, TCPS, and replication TCPS are ignored.

Examples

The following example configures TLS on system for dual mode HTTPS and HTP. It changes the TCPS port number and leaves the other ports set to their default values.

racli alter network --service=ra_server --encrypt=enable --tcps_port=2848

racli alter parameter

Modifies the specified parameter whether it should be included or ignored as a check.

Syntax

racli alter parameter --type=db --parameter_name=NAME --ignore_check={ false | true } [--force]

Options

--type

The type of the init parameter to be checked. Presently only "db" is supported.

--parameter_name

The name of the init parameter to be checked.

--ignore_check

Specifies whether to ignore a parameter (true) or to include the parameter (false) in a check of the database.

--force

Certain parameters are deemed important for database checks and are managed in an exclusion list to always be checked. The --force option bypasses the exclusion list so that the parameter can be ignored.

racli alter passphrase

.

Syntax

racli alter passphrase

Options

Modifies password used to access the Recovery Appliance.

Details:

  • The password specified for the Recovery Appliance user account must contain eight or more characters. Strong password authentication is used, so simple passwords are not allowed.

Details

Modifies password used to access the Recovery Appliance.

  • The password specified for the Recovery Appliance user account must contain eight or more characters. Strong password authentication is used, so simple passwords are not allowed.

racli alter rasys_user

Modifies the Recovery Appliance rasys user account password and management of the password.

Syntax

racli alter rasys_user { --init | --password }

Options

--init

Establishes management of the rasys user. This will be run for you during patch or upgrade in most cases.

In the event the rasys wallet goes away, this can be used to re establish rasys password management.

--password

Set a new rasys user password

Details

Modifies the Recovery Appliance rasys user account password and management of the password.

Examples

The following example changes the password for the rasys user account.

racli alter rasys_user --password

When prompted as shown, enter the new password.

Enter rasys Password:
Confirm new rasys Password:

The password specified for the Recovery Appliance user account must contain eight or more characters. Strong password authentication is used, so simple passwords are not allowed.

racli alter vpc_user

Modifies an existing Recovery Appliance user account and changes its password.

Syntax

racli alter vpc_user --user_name=myVpcUserName (deprecated)

Options

Details

(deprecated) This command is deprecated. Please use racli alter db_user --user_name=myVpcUserName --type=vpc to alter a vpc user.

--user_name

The Virtual Private Catalog user account for the Recovery Appliance

The user_name specified in the command must be an existing Recovery Appliance user account.

The password specified for the Recovery Appliance user account must contain eight or more characters. Strong password authentication is used.

Examples

The following example changes the password for the ravpc1 user account.

racli alter vpc_user --user_name=ravpc1

When prompted as shown, enter the new password.

ravpc1 New Password:

racli approve

Approves the object in the Recovery Appliance schema.

Options

racli approve request

Approves a given request identifier and gives that vote to the quorum.

Syntax

racli approve request --request_id=VALUE

Options

--request_id

Specifies the request identifier to be approved.

racli configure

Configure an object from operations performed by the Recovery Appliance.

Options

racli configure archived_log_grouping

.

Options

racli create

Create an object from operations performed by the Recovery Appliance.

Options

racli create certificate

Creates a certificate used for HTTPS operations.

Syntax

racli create certificate [--signed_cert_valid=VALUE] [--trusted_cert_valid=VALUE] --country=VALUE --state=VALUE --location=VALUE --organization=VALUE --organization_unit=VALUE --email_address=VALUE [--signed_cert_only | --trusted_cert_only]

Options

--signed_cert_valid

Specifies the number of days that the signed certificate remains valid. The default is 365 days (1 year).

Note: --signed_cert_valid cannot be larger than --trusted_cert_valid.

--trusted_cert_valid

Specifies the number of days that the trust certificate remains valid. The default is 3650 days (10 years).

--country

Specifies the country of origin for the certificate.

--state

Specifies the state of origin for the certificate.

--location

Specifies the location of origin for the certificate.

--organization

Specifies the organization responsible for the certificate.

--organization_unit

Specifies the unit within the organization responsible for the certificate.

--email_address

Specifies the email address for the owner of the certificate.

--signed_cert_only

Enables operation involving only validation of signed certificates, not of trusted certificates.

--trusted_cert_only

Enables operation involving only validation of trusted certificates, not of signed certificates.

racli deny

Denies the object in the Recovery Appliance schema.

Options

racli deny request

Denies a given request identifier and gives that vote to the quorum.

Syntax

racli deny request --request_id=VALUE

Options

--request_id

Specifies the request identifier to be denied.

racli disable

Disables an object from operations performed by the Recovery Appliance.

Options

Details

Disables an object from operations performed by the Recovery Appliance. Object remains known to the Recovery Appliance for a quick enable later.

racli disable aide

Disables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.

Syntax

racli disable aide

Options

Details

AIDE is an Exadata utility that creates a database of files on the system and tracks changes. AIDE ensures file integrity and detects system intrusions. AIDE needs to be disabled during system installation and upgrades, and then afterward enabled again.

racli disable check

Disables a specific check object from check run operations performed on the Recovery Appliance.

Syntax

racli disable check { --check_name=CHECK_NAME }

Options

--check_name

Specifies the name of the check to be disabled.

racli disable cloud_location

Disables a cloud storage object for operations performed by the Recovery Appliance.

Syntax

racli disable cloud_location [ --location_name=CLOUD_LOCATION_NAME ]

Options

--location_name

Specifies the cloud location name to be disabled.

Details

Disables a cloud storage object for operations performed by the Recovery Appliance. The enable action defaults to all for cloud_location unless specified. This translates to 'pause' for sbt_library in a ready state.

racli disable keystore

Disables the keystore.

Syntax

racli disable keystore

Options

Details

Disables the keystore.

racli disable nfs

.

Syntax

racli disable nfs --name=myMountName

Options

Disables the specified Network File System (NFS).

Details

--name

Name of the NFS mount object.

racli disable rasys_user

Disables access to the rasys user.

Syntax

racli disable rasys_user [--request_id=req_id]

Options

If compliance mode is enabled, a quorum is needed to disable access.

If compliance mode is not enabled, quorum is not needed.

--request_id

The request id for the rasys disable request.

racli disable ssh

Disables external ssh access for the root and oracle users.

Syntax

racli disable ssh

racli disable root_access

Disables sudo to root access for user.

Syntax

racli disable root_access [--request_id=req_id]

Options

If compliance mode is enabled, a quorum is needed to disable access.

If compliance mode is not enabled, quorum is not needed.

--request_id

The request id for the disable request.

Details

This command disables root access for root, oracle, and raadmin.

This command is local_only. This can be run on the local node, but cannot be run on other nodes.

racli disable sys_remote_access

Disables access to the sys database root user.

Syntax

racli disable sys_remote_access [--request_id=req_id]

Options

If compliance mode is enabled, a quorum is needed to disable access.

If compliance mode is not enabled, quorum is not needed.

After this command is run, the Recovery Appliance needs to be restarted to complete the disable operation.

--request_id

The request identifier for the sys remote access disable request.

racli enable

.

Options

Enables an object for operations performed by the Recovery Appliance.

Details

Enables an object for operations performed by the Recovery Appliance.

racli enable acfs

Enables the specified Automatic Storage Management Cluster (ACFS).

Syntax

racli enable acfs --name=myMountName

Options

--name

Name of the ACFS mount object.

Details

Enables the specified Automatic Storage Management Cluster (ACFS).

racli enable aide

Enables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.

Syntax

racli enable aide

Options

Details

AIDE is an Exadata utility that creates a database of files on the system and tracks changes. AIDE ensures file integrity and detects system intrusions. AIDE needs to be disabled during system installation and upgrades, and then afterward enabled again.

racli enable check

Enables a check on the Recovery Appliance.

Syntax

racli enable check { --check_name=CHECK_NAME };

Options

--check_name

Indicates the name of the check to be enabled on the Recovery Appliance.

Details

Enables a check on the Recovery Appliance.

racli enable cloud_location

Enables a cloud storage object for operations performed by the Recovery Appliance.

Syntax

racli enable cloud_location [ --location_name=CLOUD_LOCATION_NAME ]

Options

--location_name

Specifies the cloud location name to be enabled.

Details

Enables a cloud storage object for operations performed by the Recovery Appliance. The enable action defaults to all for cloud_location unless specified. This translates to 'resume' for sbt_library in a paused state.

racli enable keystore

Opens the keystore so that it can be used.

Syntax

racli enable keystore

Options

Details

Opens the keystore so that it can be used. This is the OKV endpoint keystore, also known as the OKV shared wallet.

racli enable nfs

Enables the specified Network File System (NFS).

Syntax

racli enable nfs --name=myMountName

Options

--name

Name of the NFS mount object.

Details

Enables the specified Network File System (NFS).

racli enable rasys_user

Enables access to the rasys user.

Syntax

racli enable rasys_user [--request_id=req_id] [--expire=HOURS]

Options

If compliance mode is enabled, a quorum is needed to gain access.

If compliance mode is not enabled, quorum is not needed.

--expire

Time in hours for how long rasys remains enabled. Default is 3 hours.

--request_id

The request id for the access request.

This command will prompt for a new rasys password when request is approved and quorum is reached.

racli enable root_access

Enables access to the root user.

Syntax

racli enable root_access [--request_id=req_id]

Options

If compliance mode is enabled, a quorum is needed to disable access.

If compliance mode is not enabled, quorum is not needed.

--request_id

The request id for the disable request.

Details

This command is local_only. This can be run on the local node, but cannot be run on other nodes.

racli enable ssh

Enables external ssh access for the root and oracle users.

Syntax

racli enable ssh

racli enable sys_remote_access

Enables remote access to the sys database root user.

Syntax

racli enable sys_remote_access [--request_id=req_id]

Options

If compliance mode is enabled, a quorum is needed to disable access.

If compliance mode is not enabled, quorum is not needed.

--request_id

The request id for the sys remote access enable request.

racli export

Used for exporting data.

Options

Details

Used for exporting data.

racli export appliance

Creates an export bundle for the Recovery Appliance.

Syntax

racli export appliance

Options

Details

Creates an export bundle for the Recovery Appliance.

racli install

Installs software.

Options

Details

Installs software.

racli install appliance

Installs software to the Recovery Appliance software.

Syntax

racli install appliance --step={ STEP_NUMBER | ALL } [--import=IMPORT_BUNDLE_PATH]

Options

--import

Specifies the location of the RA export bundle to use for the installation.

--step

Indicate which step number of install appliance to run. Value range is 1-7 or "all" for all steps.

Step Numbers:

  1. Validates and configures the hardware and platform.

  2. Configures the operating system, including setting up file system properties, and users and groups.

  3. Configures the oracle operating system user.

  4. Creates the database file system (DBFS) mounts, configures TNS aliases, and sets up the required wallets for communication.

  5. If a tape backup system is detected, validates and configures the appliance using details that were specified on the Tape Library Connectivity Page in the Oracle Exadata Deployment Assistant.

  6. Configures backup of the Recovery Appliance catalog database and creates credentials for performing the backups. The catalog is backed up to a Recovery Appliance disk on an automated schedule.

  7. Prompts for the raadmin password. Starts all Recovery Appliance services installed in the previous steps. Removes remote root and oracle access during this step.

Details

Installs software to the Recovery Appliance software.

Before you run racli install appliance:

  • Ensure that all current installation patches are stated in the /u01/ra_install/linux-x64/WorkDir directory.

  • Ensure that the ra_preinstall.pl and install.sh scripts were run and successfully completed.

If a step fails, contact Oracle Support Services.

Examples

The following example runs only step 2 of the software installation.

racli install appliance --step=2

The following example runs all of the steps necessary to install the software based on the system and configuration settings.

racli install appliance

racli install okv_endpoint

Installs the software required for Oracle Key Vault (OKV) end points on the Recovery Appliance.

Syntax

racli install okv_endpoint

Options

Details

Installs the software required for Oracle Key Vault (OKV) end points on the Recovery Appliance. This is run after the a keystore has been activiated and is only run once. It adds all OKV endpoints associated with the Recovery Appliance; it applies to all nodes.

Examples

This example installs the okv_endpoints associated with each compute node of the Recovery Appliance.

racli install okv_endpoint

Enter New Keystore Password:
Confirm New Keystore Password:
Enter RA Wallet Password:
Wed December 23 20:14:40 2018:   Start: Install OKV End Point [compute_node1]
Wed December 23 20:14:43 2018:   End: Install OKV End Point [compute_node1]
Wed December 23 20:14:43 2018:   Start: Install OKV End Point [compute_node2]
Wed December 23 20:14:45 2018:   End: Install OKV End Point [compute_node2]

racli list

Lists information about objects given in the Recovery Appliance schema.

Options

Details

Lists information about objects given in the Recovery Appliance schema.

racli list admin_user

List admin_user system users who can execute racli commands.

Syntax

racli list admin_user

Options

Details

User has to be a member of RACLI admin group, which is raadmin by default.

racli list certificate

Lists details of all HTTPS certificate on the Recovery Appliance.

Syntax

racli list certificate

Options

Details

Use this command to obtain certificate serial numbers needed for "racli remove certificate" operations.

racli list check

List checks available on the Recovery Appliance.

Syntax

racli list check { --status=STATUS | --all } {--verbose}

Options

--status

List checks by STATUS. Valid STATUS are enabled | disabled.

--all

List names of all checks.

--verbose

List details of specified checks.

Details

List checks available on the Recovery Appliance.

racli list cloud_key

List details in short (default) or long format about a specified cloud key or all cloud keys.

Syntax

racli list cloud_key { --key_name=KEY_NAME | --all } [--long] [--fingerprint]

Options

--key_name

Specifies a key name associated with the cloud storage to list details.

--fingerprint

Displays the fingerprint associated with the cloud key.

--all

Lists details about all cloud keys known to the Recovery Appliance.

--long

Lists extended details about one or all cloud keys.

Details

List details in short (default) or long format about a specified cloud key or all cloud keys.

racli list cloud_location

Lists details about the cloud storage known to the Recovery Appliance.

Syntax

racli list cloud_location { --location_name=CLOUD_LOCATION_NAME | --all } [--long]

Options

--location_name

Specifies a cloud location name to list details.

--all

Lists details about all cloud storage known to the Recovery Appliance.

--long

Lists extended details about one or all containers.

Details

Lists details about the cloud storage known to the Recovery Appliance.

Examples

The following example lists all known cloud_location objects.

racli list cloud_location --all

racli list cloud_user

List details about the specified cloud user, or all cloud users.

Syntax

racli list cloud_user { --user_name=USER_NAME | --all } [--long]

Options

--user_name

The name user wants associated with this particular cloud user.

--all

Lists details about all cloud users known to the Recovery Appliance.

--long

Lists extended details about one or all cloud users.

Details

List details about the specified cloud user, or all cloud users.

racli list compute_nodes

Lists the names of the compute nodes available on the Recovery Appliance.

Syntax

racli list compute_nodes

Options

Details

Lists the names of the compute nodes available on the Recovery Appliance.

racli list db_user

List details about the specified database user, or all database users.

Syntax

racli list db_user { --user_name=USER_NAME | --all } [--long --user_type=admin|monitor|vpc]

Options

--user_name

Lists details about the user with the specified user_name.

--all

Lists all database users known to the Recovery Appliance.

--long

Lists extended details about one or all database users.

--user_type

Filters the user results to list only the user(s) with the specified user_type.

racli list grid_home

Lists details about grid_home.

Syntax

racli list grid_home { --active | --inactive | --removed | --all }

Options

--active

List details about active grid_home.

--inactive

List details about all inactive grid_home.

--removed

List details about removed grid_home.

--all

List details about all grid_home.

racli list host

Lists details about all hosts available to the Recovery Appliance.

Syntax

racli list host

Options

racli list ip_addr

Lists details about all IP addresses available to the Recovery Appliance.

Syntax

racli list ip_addr

Options

racli list listener

.

Options

racli list nfs

Lists details about one or more Network File System mounts.

Syntax

racli list nfs { --mount_name=myName | --all }

Options

--mount_name

Name of NFS mount to be listed.

--all

Specifies that all NFS mounts should be listed.

racli list okv_endpoint

Lists details about the OKV end points known to the Recovery Appliance.

Syntax

racli list okv_endpoint [--all] [--long]

Options

--all

Lists all of the okv_endpoint(s) known to the Recovery Appliance.

--long

Lists extended details about the OKV end points known to the Recovery Appliance.

Details

Lists details about the OKV end points known to the Recovery Appliance.

Examples

The following example lists all of the OKV end points with extended details.

racli list okv_endpoint --all --long

racli list oracle_home

Lists details about oracle_home.

Syntax

racli list oracle_home { --active | --inactive | --removed | --all }

Options

--active

List details about active oracle_home.

--inactive

List details about all inactive oracle_home.

--removed

List details about removed oracle_home.

--all

List details about all oracle_home.

racli list parameter

Lists the names and value of the init parameters for the Recovery Appliance.

Syntax

racli list parameter --type=db [--invalid | --valid | --all] [--long]

Options

--type

The type of the init parameter to be listed.

--invalid

Show only invalid init parameter names.

--valid

Show only valid init parameter names.

--all

Show all init parameter names.

--long

Show init parameter value as well as names.

Details

Lists the names and value of the init parameters for the Recovery Appliance.

racli list san

Lists subject alternate name (SAN).

Syntax

racli list san

Options

racli list scan

Lists details of scan on the Recovery Appliance.

Syntax

racli list scan

Options

racli list scan_listener

Lists details of scan_listener on the Recovery Appliance.

Syntax

racli list scan_listener

Options

racli list storage_cells

Lists names of storage cells available to the Recovery Appliance.

Syntax

racli list storage_cells

Options

Details

Lists names of storage cells available to the Recovery Appliance.

racli list tag

List diagnostic tags available on the Recovery Appliance.

Syntax

racli list tag { --tag=<TAG_NAME> | --all }

Options

--tag
     List diagnostics performed under the specific tag.
--all
     List diagnostics performed by all tags.

Details

List diagnostic tags available on the Recovery Appliance.

racli patch

(DEPRECATED) The action to patch a specified object.

Use racli update instead.

Options

Details

The action to patch a specified object.

racli patch appliance

(DEPRECATED) Patch the Recovery Appliance Software. Use racli update appliance instead.

Syntax

racli patch appliance --step=STEP_NUMBER [--ignore_incidents]

Options

--step

Indicate which step number of upgrade appliance to run. Value range is 1-2.

Step Numbers:

  1. Runs the prechecks prior to upgrade. No downtime required. Does not change the software.

  2. Performs the Patch. A full outage is required and is followed by a postcheck.

--ignore_incidents

Ignore active incidents (not recommended).

Details

Patch the Recovery Appliance Software.

racli remove

Removes objects from the Recovery Appliance schema.

Options

Details

Removes objects from the Recovery Appliance schema. Removed objects become unknown to the Recovery Appliance and cannot be quickly enabled later.

racli remove acfs

Removes the specified Automatic Storage Management Cluster (ACFS) mount from the Recovery Appliance schema.

Syntax

racli remove acfs --mount_name=myName

Options

--mount_name

Name of ACFS mount to be removed.

Details

Removes the specified Automatic Storage Management Cluster (ACFS) mount from the Recovery Appliance schema.

racli remove admin_user

Removes a admin_user system user from the system passwd database.

Syntax

racli remove admin_user --user_name=USER_NAME

Options

--user_name

System user name to remove.

Details

User has to be a member of RACLI admin group, which is raadmin by default.

racli remove certificate

Removes the specified HTTPS certificate.

Syntax

racli remove certificate --serial_number=SERIALNUMBER

Options

--serial_nuber

Specifies the serial number of the HTTPS certificate to be removed.

Details

However, the certificate is not removed if TLS is enabled and the specified certificate is the last one in its signed_cert or trusted_cert type.

racli remove cloud_key

.

Syntax

racli remove cloud_key --key_name=KEY_NAME

Options

Removes the specified cloud key, but only if no cloud users are associated with the key.

Details

--key_name

The name of the public and private key to remove.

racli remove cloud_location

Removes the specified cloud storage from the Recovery Appliance, unless the cloud archive job template is tied to the library.

Syntax

racli remove cloud_location --location_name=LOCATION_NAME [--force]

Options

--location_name

Specifies the name of the cloud location to be removed.

--force

If a cloud storage job template is tied to the library, this option forces its removal anyway.

Details

Removes the specified cloud storage from the Recovery Appliance, unless the cloud archive job template is tied to the library.

racli remove cloud_user

Removes a cloud user.

Options

--user_name

The cloud user object name associated with this particular user.

Details

Removes a cloud user. A cloud user associated with a cloud location cannot be removed.

racli remove db_user

Removes a database user.

Syntax

racli remove db_user --user_name=USER_NAME --user_type=admin|monitor|vpc

Options

--user_name

Database user to remove.

--user_type

Type of the database user to be removed.

racli remove grid_home

Removes the specified grid home.

Syntax

racli remove grid_home --grid_home=inactiveGridHome

Options

--grid_home

Path of grid_home to be removed.

racli remove host

Removes the specified host.

Syntax

racli remove host --host_name=HOSTNAME

Options

--host_name

Indicates the name of the host to be removed.

racli remove keystore

Removes the specified keystore from the Recovery Appliance schema.

Syntax

racli remove keystore [--restart_db]

Options

--restart_db

Restarts the database stack after changes to the keystore to ensure they are honored at service restart.

Details

Removes the specified keystore from the Recovery Appliance schema.

racli remove nfs

Removes the specified Network File System (NFS) mount from the Recovery Appliance schema.

Syntax

racli remove nfs --mount_name=myName

Options

--mount_name

Name of NFS mount to be removed.

Details

Removes the specified Network File System (NFS) mount from the Recovery Appliance schema.

racli remove oracle_home

Removes the specified oracle home.

Syntax

racli remove oracle_home --oracle_home=inactiveOracleHome

Options

--oracle_home

Path of oracle_home to be removed.

racli remove osb_pieces

Removes all pieces that are no longer in the ZDLRA catalog from the OSB catalog.

Syntax

racli remove osb_pieces

Options

racli remove tag

Removes the specified diagnostic TAG from all nodes of the Recovery Appliance.

Syntax

racli remove tag --tag=TagName

Options

--tag

Name of the diagnostic tag to be removed.

Details

Removes the specified diagnostic TAG from all nodes of the Recovery Appliance.

racli remove vpc_user

Removes the specified user account from the Recovery Appliance metadata schema.

Syntax

racli remove vpc_user --user_name=myVPCUserName (deprecated)

Options

--user_name

The Virtual Private Catalog user for the Recovery Appliance.

Details

(deprecated) This command is deprecated. Please use racli remove db_user --user_name=myVpcUserName --type=vpc to remove a vpc user.

  • The specified user account must exist in the Recovery Appliance schema.

  • The specified user account must not be associated with a protected database.

Examples

The following example removes the user account ravpc1 from the metadata repository.

racli remove vpc_user --user_name=ravpc1

racli run

Performs an action for an object to the Recovery Appliance.

Options

Details

Performs an action for an object to the Recovery Appliance.

racli run check

Runs the enabled checks for the Recovery Appliance.

Syntax

racli run check { --check_name=CHECK_NAME | --group_name=GROUP_NAME | --all };

Options

--all

Indicates that all checks are run.

--check_name

Indicates the name of the check to be run.

--group_name

Indicates the name of the check group to be run.

Details

Runs the enabled checks for the Recovery Appliance.

racli run diagnostics

Runs and collects the required diagnostics on the Recovery Appliance.

Syntax

racli run diagnostics { --tag=TAG | --level=LEVEL | --path };

Options

--tag

Specifies the name of the tag of diagnostics to be collected, where default tags are:

        sar = 'system activity report'
   txt_dump = 'RA dump txt file'
    dp_dump = 'RA dump datapump'
   ord_wait = 'ORDERING_WAIT analysis'
 corruption = 'corruption'
 racli_logs = 'gather racli logs from each node'
 ra_version = 'get RA version information from each node'
    str_cfg = 'get store and config files from each node'
    history = 'get root and oracle history from each node'
    network = 'get network information from each node'
 obtooldiag = 'run obtool gathering useful information'
    osblogs = 'get osb logs from each node'
     osbxcr = 'get /usr/etc/ob/xcr from each node'
   osbstate = 'get backup/admin/state from each node'
     alerts = 'get ASM and RDBMS alert.logs from each node'
        awr = 'generate awr dump for last 7 days'

And collection tags:

ra_low:  [1] Generates a System Activity Report on the Recovery Appliance
  [2] Gets the version information from each node of the Recovery Appliance
ra_med:  [1] Generates a System Activity Report on the Recovery Appliance
  [2] Performs a text format dump of the Recovery Appliance
  [3] Gets the version information from each node of the Recovery Appliance
ra_high:  [1] Generates a System Activity Report on the Recovery Appliance
  [2] Performs a datapump dump of the Recovery Appliance
  [3] Gets the version information from each node of the Recovery Appliance
osb_low:  [1] Gets OSB information through obtool on the Recovery Appliance
  [2] Gathers OSB logs from all nodes of the Recovery Appliance
osb_med:  [1] Gets OSB information through obtool on the Recovery Appliance
  [2] Gathers OSB logs from all nodes of the Recovery Appliance
  [3] Gathers OSB xcr files from all nodes of the Recovery Appliance

osb_high:  [1] Gets OSB information through obtool on the Recovery Appliance
  [2] Gathers OSB logs from all nodes of the Recovery Appliance
  [3] Gathers OSB xcr files from all nodes of the Recovery Appliance
  [4] Gathers OSB state files from the current node of the Recovery Appliance
--level

Alternatively, if a tag doesn't exist the level can be specified directly, where:

 level     1 - system activity report
 level     2 - RA dump txt file
 level     4 - RA dump datapump
 level     8 - ORDERING_WAIT analysis
 level    16 - corruption
 level    32 - gather racli logs from each node
 level    64 - get RA version information from each node
 level   128 - get store and config files from each node
 level   256 - get root and oracle history from each node
 level   512 - get network information from each node
 level  1024 - run obtool gathering useful information
 level  2048 - get osb logs from each node
 level  4096 - get /usr/etc/ob/xcr from each node
 level  8192 - get backup/admin/state from each node
 level 16384 - get all nodes ASM and ZDLRA alert.logs
 level 32768 - generate awr dump for last 7 days

The levels are additive, so to gather a system activity report and RA dump txt file you would use --level=3

--path

Specfies the location on the Recovery Appliance where the diagnostic bundle will be created, default being radump.

Examples

The following example collects racli logs from all nodes and creates a bundle in default location /radump

racli run diagnostics --tag=racli_logs

The following example using the level directly, runs and bundles system activity report and alert.logs and creates a bundle in path /tmp.

racli run diagnostics --level=16385 --path=/tmp

racli run preinstall

Execute preinstallation tasks.

Syntax

racli run preinstall [--zdlra_release_file=<FILE>] [--rollback]
[--raadmin_uid=<UID>] [--raadmin_gid=<GID>] [--rasec_uid=<UID>]
[--sec_gid=<GID>] [--rasys_uid=<UID>] [--rasys_gid=<GID>]

Options

--rollback

Perform rollback of the preinstall command.

--rollback

Perform rollback of the preinstall command.

--raadmin_uid=<UID>

The new 'raadmin' user id. Value must be >= 1003 and not equal to 1101 or 1102.

--raadmin_gid=<GID>

The new 'raadmin' group id. Value must be >= 1003 and not equal to 1101 or 1102.

--rasec_uid=<UID>

The new 'rasec' user id. Value must be >= 1003 and not equal to 1101 or 1102.

--sec_gid=<GID>

The new 'sec' group id. Value must be >= 1003 and not equal to 1101 or 1102.

--rasys_uid=<UID>

The new 'rasys' user id. Value must be >= 1003 and not equal to 1101 or 1102.

--rasys_gid=<GID>

The new 'rasys' group id. Value must be >= 1003 and not equal to 1101 or 1102.

--zdlra_release_file=<FILE>

Specifies ZDLRA release file to use.

racli start

The action to start a specified service (object).

Options

Details

The action to start a specified service (object).

racli start appliance

Starts all services on the Recovery Appliance.

Options

racli start nfs

Start NFS services of the Recovery Appliance.

Syntax

racli start nfs --name=myMountName

Options

--name

Name of the NFS mount to start.

Details

Start NFS services of the Recovery Appliance.

racli start ssh_agent

.

Options

racli status

Check status of objects associated with the Recovery Appliance.

Options

Details

Check status of objects associated with the Recovery Appliance.

racli status aide

Returns the status of the Advanced Intrusion Detection Environment (AIDE).

Syntax

racli status aide

Options

racli status appliance

Returns a summary of the status of the appliance.

Syntax

racli status appliance

Options

Details

Returns a summary of the status of the appliance.

racli status cloud_location

Lists the status of a cloud storage object for operations performed by the Recovery Appliance.

Syntax

racli status cloud_location [ --location_name=CLOUD_LOCATION_NAME ] [--long]

Options

--location_name

Specifies the name of the cloud location for status.

--long

Lists extended details about cloud storage known to the Recovery Appliance.

Details

Lists the status of a cloud storage object for operations performed by the Recovery Appliance. This action defaults to all for cloud_location unless specified.

racli status compliance

Lists the status (either PASS or FAIL) of all compliance-ready checks.

Syntax

racli status compliance  [--long]

Options

--long

Lists extended details of each compliance-ready check: for the Recovery Appliance.

racli status disk_group

Verifies that the rebalance operation completed after storage cells or storage disks are added to the ASM disk group.

Syntax

racli status disk_group

Options

Details

Verifies that the rebalance operation completed after storage cells or storage disks are added to the ASM disk group.

Run this command before running the racli update storage_location command to ensure that the ASM rebalance completed.

All rebalance must complete before Griddisks and Storage Spaces are added to a Recovery Appliance.

racli status keystore

Returns the status of the keystore in use by the Recovery Appliance.

Syntax

racli status keystore

Options

Details

Returns the status of the keystore in use by the Recovery Appliance.

racli status listener

Returns the status of an individual listener or all listeners on the Recovery Appliance.

Syntax

racli status listener [--listener_name | --all]

Options

Details

--all

Specifies that the status of all listeners should be returns. This is the default operation if no arguments are provided.

--listener_name

Specifies the name of the listener to get status information about.

racli status nfs

Returns the status of the Network File Service (NFS).

Syntax

racli status nfs --name=myMountName

Options

Details

Returns the status of the Network File Service (NFS).

racli status okv_endpoint

Returns the status of the OKV_ENDPOINTs associated with the Recovery Appliance.

Syntax

racli status okv_endpoint

Options

Details

Returns the status of the OKV_ENDPOINTs associated with the Recovery Appliance.

racli status request

Shows status of all scan on the Recovery Appliance.

Syntax

racli status request [--request_id=VALUE]

Options

--request_id

Specifies the request identifier for the status report.

racli status scan

Shows status of all scan on the Recovery Appliance.

Syntax

racli status scan

Options

racli status scan_listener

Shows status of all scan_listeners on the Recovery Appliance.

Syntax

racli status scan_listener

Options

racli stop

The action to stop a specified service (object).

Options

Details

The action to stop a specified service (object).

racli stop appliance

Stops all services on the Recovery Appliance.

Options

racli stop nfs

Stop NFS services of the Recovery Appliance.

Syntax

racli stop nfs --name=myMountName

Options

--name

Name of the ACFS mount to start.

Details

Stop NFS services of the Recovery Appliance.

racli uninstall

Backs out a portion of the installation.

Options

Details

Backs out a portion of the installation.

racli uninstall appliance

Backout a step during install.

Syntax

racli uninstall appliance --step={ STEP_NUMBER | ALL }

Options

--step

Indicate which step number of uninstall appliance to run. Value range is 1-7 or "all" for all steps.

Step Numbers:

  1. Unconfigures the hardware and platform.

  2. Unconfigures the operating system, including setting up file system properties, and users and groups.

  3. Unconfigures the Oracle operating system user.

  4. Removes file system mounts, unconfigures TNS aliases, and invalidates wallets for communication.

  5. If a tape backup system is detected, unconfigures the resources used for tape backup.

  6. Unconfigures backup of the Recovery Appliance catalog database and removes credentials for performing the backups.

  7. Stops all Recovery Appliance services installed.

Details

Backout a step during install.

Generally used if you found an error and have to redo a step after correcting. You must run the uninstallation in the reverse numerical order.

Note:

If a failed installation step is the reason that you plan to run the uninstall command, it is highly recommended that you contact Oracle Support Services.

Examples

The following example undoes only step 3 of the installation procedure.

racli uninstall appliance --step=3

The following undoes all of the steps of the installation procedure in reverse sequence.

racli uninstall appliance

racli uninstall okv_endpoint

Uninstalls the specified OKV end point.

Syntax

racli uninstall okv_endpoint [--force]

Options

--force

When specified, forces the uninstallation of the OKV end point.

Otherwise, a check is done for active storage locations utilizing the OKV end point. If any are in use, a warning is issued and uninstall fails.

Details

Uninstalls the specified OKV end point.

Examples

This example forces uninstallation of the OKV end points associated with the Recovery Appliance.

racli uninstall okv_endpoint --force

Thu August 17 06:03:55 2018: Start: Remove OKV End Point
Thu August 17 06:03:55 2018: 
  WARNING:
    Found active cloud locations.
    Removing the OKV endpoint will mean this Recovery Appliance can't recover 
      backups at cloud locations without an endpoint configured. Thu August 17 06:03:55 2018:   Start: Remove OKV End Point [node1]
Thu August 17 06:03:55 2018:   End: Remove OKV End Point [node1]
Thu August 17 06:03:55 2018:   Start: Remove OKV End Point [node2]
Thu August 17 06:03:55 2018:   End: Remove OKV End Point [node2]
Thu August 17 06:03:55 2018:   End: Remove OKV End Point

racli update

Update a component of the Recovery Appliance.

Options

Details

Update a component of the Recovery Appliance.

racli update aide

Updates the Advanced Intrusion Detection Environment (AIDE).

Syntax

racli update aide

Options

Details

AIDE is an Exadata utility that creates a database of files on the system and tracks changes. AIDE ensures file integrity and detects system intrusions.

racli update appliance

Updates the ZDLRA.

Syntax

racli update appliance [--ignore_incidents]

Options

--ignore_incidents

Ignore active incidents (not recommended).

Details

This command replaces "racli patch appliance" and "racli upgrade appliance" and determines whether the update should be a patch or an upgrade. It performs all the prechecks. If the prechecks pass, it proceeds with the patch or upgrade steps. If the update fails in the middle and after the identified error is corrected, this command can be rerun and it will continue with the step that failed.

racli update parameter

Update init parameters in the Recovery Appliance.

Syntax

racli update parameter --type=db [--restart_db]

Options

--type

The type of init parameter to be updated. Presently only "db" is supported.

Details

Update init parameters in the Recovery Appliance.

racli update ssh_known_hosts

Maintains a system-wide configuration file /etc/ssh/ssh_known_hosts with host keys from all of the nodes in the Recovery Appliance cluster.

Syntax

racli update ssh_known_hosts

Details

This command can help resolve installation issues that arise from SSH KEY inconsistencies.

racli update storage_location

Update RA pool data file with the most current number of storage cells.

Syntax

racli update storage_location --cells=cell1,cell2,...celln

Options

Details

Update RA pool data file with the most current number of storage cells.

racli update support_tools

Updates the AHF and Exachk versions using the staged binaries zip files.

Syntax

racli update support_tools {--ahf_file=<AHF_FILE_NAME>} {--exachk_file=<EXACHK_FILE_NAME>}

Options

--ahf_file

Updates AHF version the the provided AHF version.

--exachk_file

Updates Exachk version the the provided Exachk version.

Details

Updates the TFA and Exachk versions using the staged binaries zip files.

racli upgrade

(DEPRECATED) The action to upgrade a specified object to the next version.

Options

Details

The action to upgrade a specified object to the next version.

racli upgrade appliance

(DEPRECATED) Upgrade the Recovery Appliance Software Versions. Use racli update appliance instead.

Syntax

racli upgrade appliance --step=STEP_NUMBER [--ignore_incidents]

Options

--step

Indicate which step number of upgrade appliance to run. Value range is 1-5.

Step Numbers:

  1. Runs the prechecks prior to upgrade. No downtime required. Does not change the software.

  2. Stages the new software stack. No downtime required. Does not change the software.

  3. Performs the upgrade using the staged items. A full outage is required; it is followed by a postcheck and cleanup of the old files.

  4. Migrate DBFS to ACFS. All files residing on DBFS will be migrated to new ACFS.

  5. Upgrade OSB from 12.1.x.x.x to 12.2.0.1.0..

--ignore_incidents

Ignore active incidents (not recommended).

Details

Upgrade the Recovery Appliance Software Versions.

racli version

Provides version information for software running on the Recovery Appliance.

Syntax

racli version [--history] [--cache] [--all_nodes] [--json]

Options

--history

Displays all active and previous versions.

--cache

Retrieve version values from existing cache file.

--all_nodes

Retrieve version values from all nodes in cluster.

--json

Display data in JSON format.

Details

Provides version information for software running on the Recovery Appliance.

The version information provided includes:

exadata image

The exadata image currently installed on the Recovery Appliance. A blank line is expected when there is no history data to report.

rarpm version

The ra_automation rpm currently installed on the Recovery Appliance.

rdbms version

The database version currenly installed on the Recovery Appliance.

transaction

The specific transaction associated with the version running on the Recovery Appliance.

zdlra version

The base software version installed and running on the Recovery Appliance.