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:
| Command | Description |
|---|---|
racli add |
Adds an object to the Recovery Appliance. |
racli add acfs |
Specifies that the Automatic Storage Management Cluster (ACFS) should be added to the Recovery Appliance schema. |
racli add cloud_storage |
Adds a cloud storage object to the Recovery Appliance. |
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 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 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 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 cloud_storage |
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 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 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 disable |
Disables an object from operations performed by the Recovery Appliance. |
racli disable cloud_storage |
Disables a cloud storage object from operations performed by the Recovery Appliance. |
racli disable keystore |
Disables the keystore. |
racli disable nfs |
Disables the specified Network File System (NFS). |
racli enable |
Enables an object for operations performed by the Recovery Appliance. |
racli enable cloud_storage |
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 export |
Used for exporting data. |
racli export appliance |
Creates an export bundle for the Recovery Appliance. |
racli help |
Refer to the HELP section above. |
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 cloud_storage |
Lists details about the cloud storage known to 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 patch |
The action to patch a specified object. |
racli patch appliance |
Patch the Recovery Appliance Software. |
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 cloud_storage |
Removes the specified cloud storage from the Recovery Appliance. |
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 vpc_user |
Removes the specified user account from the Recovery Appliance metadata schema. |
racli start |
The action to start a specified service (object). |
racli start nfs |
Start NFS services of the Recovery Appliance. |
racli status |
Check status of objects associated with the Recovery Appliance. |
racli status appliance |
Returns a summary of the status of the appliance. |
racli status cloud_storage |
Returns the status of cloud storage. |
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 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 stop |
The action to stop a specified service (object). |
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 storage_location |
Update RA pool data file with the most current number of storage cells. |
racli update support_tools |
Updates the TFA 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. |
racli version |
Provides version information for software running on the Recovery Appliance. |
Syntax
racli add acfs --name=myAcfsName --disk_group=myDGName --volume_name=myVolumeName --mount_point=myPath --size=SIZE
Syntax
racli add cloud_storage --opc_id=OPC_USER_ID --opc_url='https://OPC_STORAGE_LOCATION' --container_name='STORAGE_CONTAINER_NAME' --proxy_host=PROXY_NAME --proxy_port=PROXYPORTNUM --storage_class=[Tiering | Standard] --streams=NUM_STREAMS
Options
--opc_idThe Oracle Private Cloud (OPC) user identification included with the credentials associated with the cloud archive service.
--opc_urlThe OPC storage location included with the credentials associated with the cloud archive service.
--container_nameName for new container within the OPC storage location that will house the copy-to-cloud backups. This container name will also serve as the sbt_library name in the sbt_job_template creation.
--proxy_hostThe name of the proxy host.
--proxy_portThe port number for the proxy.
--storage_classThe type or class of storage to be designated to the newly created container. Standard uses the Object Storage only; Tiering uses the Archive Storage. For archive to cloud support 'Tiering' class should be used.
--streamsThe number of streams to use. If not specfied, two (2) streams are created by default.
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 named "tango" to the Recovery Appliance schema.
racli add cloud_storage --opc_id=user@oracle.com --opc_url='https://storage.oraclecorp.com' --container_name='tango' --proxy_host='myHost' --proxy_port=8080 --storage_class=Tiering
When prompted, enter the password for user@oracle.com.
Syntax
racli add credential --user_name=OS_USER_ID --alias=ALIAS_ID --wallet_path=PATH_TO_WALLET
Options
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:
Syntax
racli add credential_wallet --wallet_path=PATH_TO_WALLET
Details
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:
Syntax
racli add keystore --type=[HSM|SW] --wrl=PATH_TO_WALLET
Options
Details
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
Syntax
racli add nfs --nfs_server=myServerName --nfs_export=myExportPath --name=myNfsMountName --mount_options='NFS_OPTIONS'
Syntax
racli add storage_cells --cells=cell1,cell2,...celln
Details
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 --cell=cellhost1,cellhost2
Syntax
racli add storage_disks --cell=cell1,cell2,...celln --priority=high
Options
Details
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 --cell=cellhost1,cellhost2
Syntax
racli add vpc_user --user_name=myVpcUserName
Details
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.
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:
Options
Syntax
racli alter cloud_storage --opc_id=OPC_USER_ID --opc_url='https://OPC_STORAGE_LOCATION' --container_name='STORAGE_CONTAINER_NAME' --storage_class=Tiering
Options
--opc_idThe OPC User ID included with the credentials associated with the cloud archive service.
--opc_urlThe OPC Storage Location included with the credentials associated with the cloud archive service.
--container_nameName for new container within the OPC Storage Location that will house the archive to cloud backups. This container_name will also serve as the sbt_library name in the sbt_job_template creation.
--storage_classThe type or class of storage to be designated to the newly created container. For archive to cloud support 'Tiering' class should be used.
Details
This is equivalent to the sbt_library used for copy-to-tape. This sbt_library is specific to copy-to-cloud.
Syntax
racli alter credential_wallet --wallet_path=PATH_TO_WALLET
Details
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:
Syntax
racli alter keystore { --initalize_key | --restart_db | --password | --rekey }
Options
--rekeyGenerates new TDE master encryption key (rekey) for the protected database.
--passwordSpecifies a new password for the keystore.
--initialize_keyGenerates the initial TDE master key for the keystore.
--restart_dbRestarts the database stack after changes to the keystore to ensure they are honored at service restart.
Examples
The following example restarts the database stack following a keystore change.
racli alter keystore --restart_db
Syntax
racli alter passphrase
Options
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.
Syntax
racli alter rasys_user { --init | --password }
Options
Details
Examples
The following example changes the password for the ravpc1 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.
Syntax
racli alter vpc_user --user_name=myVpcUserName
Options
Details
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:
Options
Details
Object remains known to the Recovery Appliance for a quick enable later.
Syntax
racli disable cloud_storage { --container_name=CONTAINER_NAME | --all }
Options
Examples
The following example disables all of the known cloud storage objects.
racli disable cloud_storage --all
Syntax
racli enable cloud_storage { --container_name=STORAGE_CONTAINER_NAME | --all }
Options
Examples
The following example enables cloud storage objects associated with the container named Lima.
racli enable cloud_storage --container_name=lima
Syntax
racli enable keystore
Options
Details
This is the OKV endpoint keystore, also known as the OKV shared wallet.
Syntax
racli export appliance
Options
Syntax
racli install appliance --step={ STEP_NUMBER | ALL } [--import=IMPORT_BUNDLE_PATH]
Options
--importSpecifies the location of the RA export bundle to use for the installation.
--stepIndicate which step number of install appliance to run. Value range is 1-7 or "all" for all steps.
Step Numbers:
Validates and configures the hardware and platform.
Configures the operating system, including setting up file system properties, and users and groups.
Configures the oracle operating system user.
Creates the database file system (DBFS) mounts, configures TNS aliases, and sets up the required wallets for communication.
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.
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.
Starts all Recovery Appliance services installed in the previous steps.
Details
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
Syntax
racli install okv_endpoint
Options
Details
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]
Syntax
racli list cloud_storage { --container_name=STORAGE_CONTAINER_NAME | --all } [--long]
Options
Examples
The following example lists all known cloud_storage objects.
racli list cloud_storage --all
Syntax
racli list okv_endpoint [--all] [--long]
Options
Examples
The following example lists all of the OKV end points with extended details.
racli list okv_endpoint --all --long
Syntax
racli patch appliance --step=STEP_NUMBER [--ignore_incidents]
Options
--stepIndicate which step number of upgrade appliance to run. Value range is 1-2.
Step Numbers:
Runs the prechecks prior to upgrade. No downtime required. Does not change the software.
Performs the Patch. A full outage is required and is followed by a postcheck.
--ignore_incidentsIgnore active incidents (not recommended).
Options
Details
Removed objects become unknown to the Recovery Appliance and cannot be quickly enabled later.
Syntax
racli remove cloud_storage --container_name=STORAGE_CONTAINER_NAME [--force]
Options
Examples
This example removes the cloud_storage object associated with the storage container name gorilla regardless of container contents.
racli remove cloud_storage --container_name=gorilla --force
Syntax
racli remove keystore
Options
Syntax
racli remove vpc_user --user_name=myVPCUserName
Details
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
Syntax
racli status appliance
Options
Syntax
racli status disk_group
Options
Details
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.
Syntax
racli status keystore
Options
Syntax
racli status nfs --name=myMountName
Options
Syntax
racli status okv_endpoint
Options
Syntax
racli uninstall appliance --step={ STEP_NUMBER | ALL }
Options
Details
--stepIndicate which step number of uninstall appliance to run. Value range is 1-7 or "all" for all steps.
Step Numbers:
Unconfigures the hardware and platform.
Unconfigures the operating system, including setting up file system properties, and users and groups.
Unconfigures the Oracle operating system user.
Removes file system mounts, unconfigures TNS aliases, and invalidates wallets for communication.
If a tape backup system is detected, unconfigures the resources used for tape backup.
Unconfigures backup of the Recovery Appliance catalog database and removes credentials for performing the backups.
Stops all Recovery Appliance services installed.
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
Syntax
racli uninstall okv_endpoint [--force]
Options
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
Syntax
racli update storage_location --cells=cell1,cell2,...celln
Options
Syntax
racli update support_tools
Options
Syntax
racli upgrade appliance --step=STEP_NUMBER [--ignore_incidents]
Options
--stepIndicate which step number of upgrade appliance to run. Value range is 1-4.
Step Numbers:
Runs the prechecks prior to upgrade. No downtime required. Does not change the software.
Stages the new software stack. No downtime required. Does not change the software.
Performs the upgrade using the staged items. A full outage is required; it is followed by a postcheck and cleanup of the old files.
Migrate DBFS to ACFS. All files residing on DBFS will be migrated to new ACFS.
--ignore_incidentsIgnore active incidents (not recommended).
Syntax
racli version
Options
Details
The versioning information provided includes:
The ra_automation rpm currently installed on the Recovery Appliance.
The database version currenly installed on the Recovery Appliance.
The specific transaction associated with the version running on the Recovery Appliance.
The base software version installed and running on the Recovery Appliance.