15 RACLI Overview
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_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 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 ApplianceUsage: racli add tag --tag=myTagName --level=myLevelOptions:Name of the new tag to be added. |
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 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 cloud_user
|
Modifies information about a cloud user. |
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 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 configure
|
Configure an object from operations performed by the Recovery Appliance. |
racli configure archive_group
|
Configures archive log grouping. |
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 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 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 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 grid_home
|
Lists details about grid_home. |
racli list host
|
Lists details about all hosts available 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 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 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. |
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_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 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 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 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 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 aide
|
Updates the Advanced Intrusion Detection Environment (AIDE). |
racli update parameter
|
Update init parameters in 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 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. |
racli version
|
Provides version information for software running on the Recovery Appliance. |
racli add
Options
Details
Adds an object to the Recovery Appliance.
racli add acfs
Syntax
racli add acfs --name=myAcfsName --disk_group=myDGName --volume_name=myVolumeName --mount_point=myPath --size=SIZE
Options
Details
Specifies that the Automatic Storage Management Cluster (ACFS) should be added to the Recovery Appliance schema.
racli add cloud_key
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
Syntax
racli add cloud_location --cloud_user=CLOUD_USER_NAME --host=HOST_URL --bucket=OCI_BUCKET_NAME [--enable_archive=TRUE] [--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]
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.
-
--enable_archive
-
Enables archival of backup data after the time interval specified by the
--archive_after_backup
parameter. If not specified, by default the cloud archival functionality will be disabled, which is equivalent to a cloud bucket that is just cold storage.If cloud location is enabled for archival, use "
racli disable cloud_location
" and "racli enable cloud_location
" later as pause/resume functionality. -
--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.
-
--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".
Details
Adds a cloud storage object to the Recovery Appliance. 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
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
Syntax
racli add credential --user_name=OS_USER_ID --alias=ALIAS_ID --wallet_path=PATH_TO_WALLET
Options
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
Syntax
racli add credential_wallet --wallet_path=PATH_TO_WALLET
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 host
Syntax
racli add host --host_name=HOSTNAME --ip=IPADDRESS --domain_name=DOMAINNAME
Options
Details
Adds a host to those available on the Recovery Appliance.
racli add keystore
Syntax
racli add keystore --type=[HSM|SW] --wrl=PATH_TO_WALLET
Options
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
Syntax
racli add nfs --nfs_server=myServerName --nfs_export=myExportPath --name=myNfsMountName --mount_options='NFS_OPTIONS'
Options
Details
Specifies that the Network File System (NFS) should be added to the Recovery Appliance schema.
racli add rasys_wallet
Syntax
racli add rasys_wallet
Options
Details
Creates the rasys user wallet.
racli add storage_cells
Syntax
racli add storage_cells --cells=cell1,cell2,...celln
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
Syntax
racli add storage_disks --cells=cell1,cell2,...celln --priority=high
Options
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
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 RA version information from each node:
racli add tag --tag=new_tag --level=196608
racli add vpc_user
Syntax
racli add vpc_user --user_name=myVpcUserName
Details
Creates a new Virtual Private Catalog (VPC) user account in the Recovery Appliance schema.
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
Options
Details
Modifies the properties on objects supported in the Recovery Appliance schema.
racli alter 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
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 cloud_user
Syntax
racli alter cloud_user --cloud_user=CLOUD_USER_NAME --key_name=CLOUD_KEY_NAME --user_ocid=UOCID --tenancy_ocid=TOCID --compartment_ocid=COCID
Options
-
--user_name
-
The name user wants 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
Modifies information about a cloud user.
racli alter credential_wallet
Syntax
racli alter credential_wallet --wallet_path=PATH_TO_WALLET
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 keystore
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 parameter
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.
Details
Modifies the specified parameter whether it should be included or ignored as a check.
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
Syntax
racli alter rasys_user { --init | --password }
Options
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
Syntax
racli alter vpc_user --user_name=myVpcUserName
Details
Modifies an existing Recovery Appliance user account and changes its password.
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 configure
Options
Details
Configure an object from operations performed by the Recovery Appliance.
racli configure archive_group
Syntax
racli configure archive_group
Options
racli disable
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
Syntax
racli disable aide
Options
Details
Disables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.
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
Syntax
racli disable check { --check_name=CHECK_NAME }
Details
Disables a specific check object from check run operations performed on the Recovery Appliance.
racli disable cloud_location
Syntax
racli disable cloud_location [ --location_name=CLOUD_LOCATION_NAME ]
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
Syntax
racli disable keystore
Options
Details
Disables the keystore.
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 aide
Syntax
racli enable aide
Options
Details
Enables the Advanced Intrusion Detection Environment (AIDE) on the Recovery Appliance.
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 cloud_location
Syntax
racli enable cloud_location [ --location_name=CLOUD_LOCATION_NAME ]
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
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 export appliance
Syntax
racli export appliance
Options
Details
Creates an export bundle for the Recovery Appliance.
racli install appliance
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:
-
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
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
andinstall.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
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
Options
Details
Lists information about objects given in the Recovery Appliance schema.
racli list check
Syntax
racli list check { --status=STATUS | --all } {--verbose}
Options
Details
List checks available on the Recovery Appliance.
racli list cloud_key
Syntax
racli list cloud_key { --key_name=KEY_NAME | --all } [--long] [--fingerprint]
Options
Details
List details in short (default) or long format about a specified cloud key or all cloud keys.
racli list cloud_location
Syntax
racli list cloud_location { --location_name=CLOUD_LOCATION_NAME | --all } [--long]
Options
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
Syntax
racli list cloud_user { --user_name=USER_NAME | --all } [--long]
Options
Details
List details about the specified cloud user, or all cloud users.
racli list compute_nodes
Syntax
racli list compute_nodes
Options
Details
Lists the names of the compute nodes available on the Recovery Appliance.
racli list grid_home
Syntax
racli list grid_home { --active | --inactive | --removed | --all }
Options
Details
Lists details about grid_home.
racli list host
Syntax
racli list host
Options
Details
Lists details about all hosts available to the Recovery Appliance.
racli list okv_endpoint
Syntax
racli list okv_endpoint [--all] [--long]
Options
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
Syntax
racli list oracle_home { --active | --inactive | --removed | --all }
Options
Details
Lists details about oracle_home.
racli list parameter
Syntax
racli list parameter --type=db [--invalid | --valid | --all] [--long]
Options
Details
Lists the names and value of the init parameters for the Recovery Appliance.
racli list storage_cells
Syntax
racli list storage_cells
Options
Details
Lists names of storage cells available to the Recovery Appliance.
racli patch
Options
Details
The action to patch a specified object.
racli patch appliance
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:
-
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_incidents
-
Ignore active incidents (not recommended).
Details
Patch the Recovery Appliance Software.
racli remove
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
Syntax
racli remove acfs --mount_name=myName
Details
Removes the specified Automatic Storage Management Cluster (ACFS) mount from the Recovery Appliance schema.
racli remove cloud_location
Syntax
racli remove cloud_location --location_name=LOCATION_NAME [--force]
Options
Details
Removes the specified cloud storage from the Recovery Appliance, unless the cloud archive job template is tied to the library.
racli remove keystore
Syntax
racli remove keystore
Options
Details
Removes the specified keystore from the Recovery Appliance schema.
racli remove osb_pieces
Syntax
racli remove osb_pieces
Options
Details
Removes all pieces that are no longer in the ZDLRA catalog from the OSB catalog.
racli remove vpc_user
Syntax
racli remove vpc_user --user_name=myVPCUserName
Details
Removes the specified user account from the Recovery Appliance metadata schema.
-
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
Options
Details
Performs an action for an object to the Recovery Appliance.
racli run check
Syntax
racli run check { --check_name=CHECK_NAME | --group_name=GROUP_NAME | --all };
Options
Details
Runs the enabled checks for the Recovery Appliance.
racli run diagnostics
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.
Details
Runs and collects the required diagnostics on the Recovery Appliance.
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 start
Options
Details
The action to start a specified service (object).
racli status
Options
Details
Check status of objects associated with the Recovery Appliance.
racli status aide
Syntax
racli status aide
Options
Details
Returns the status of the Advanced Intrusion Detection Environment (AIDE).
racli status appliance
Syntax
racli status appliance
Options
Details
Returns a summary of the status of the appliance.
racli status cloud_location
Syntax
racli status cloud_location [ --location_name=CLOUD_LOCATION_NAME ] [--long]
Options
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 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
Syntax
racli status keystore
Options
Details
Returns the status of the keystore in use by the Recovery Appliance.
racli status nfs
Syntax
racli status nfs --name=myMountName
Options
Details
Returns the status of the Network File Service (NFS).
racli status okv_endpoint
Syntax
racli status okv_endpoint
Options
Details
Returns the status of the OKV_ENDPOINTs associated with the Recovery Appliance.
racli stop
Options
Details
The action to stop a specified service (object).
racli uninstall
Options
Details
Backs out a portion of the installation.
racli uninstall appliance
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:
-
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.
-
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
Syntax
racli uninstall okv_endpoint [--force]
Options
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
Options
Details
Update a component of the Recovery Appliance.
racli update aide
Syntax
racli update aide
Options
Details
Updates the Advanced Intrusion Detection Environment (AIDE).
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 storage_location
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
Syntax
racli update support_tools {--ahf_file=<AHF_FILE_NAME>} {--exachk_file=<EXACHK_FILE_NAME>}
Options
Details
Updates the TFA and Exachk versions using the staged binaries zip files.
racli upgrade
Options
Details
The action to upgrade a specified object to the next version.
racli upgrade appliance
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:
-
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.
-
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
Syntax
racli version
Options
- 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.
Details
Provides version information for software running on the Recovery Appliance.
The versioning information provided includes: