15 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 administration user who can manage and configure 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 migration_server	Adds a migration server to the Recovery Appliance.
racli add nfs	Specifies that the Network File System (NFS) should be added to the Recovery Appliance schema.
racli add protected_db	Adds a protected Database to the Recovery Appliance.
racli add rasys_wallet	Creates the rasys user wallet.
racli add remote_syslog	Creates a configuration file to export log files to a remote server.
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 adr_parameter	Changes Automatic Diagnostic Repository (ADR) parameters (LOG_FILE_SIZE and LOG_FILE_NUM).
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 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 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 export	Configures an NFS path for the Recovery Appliance bundle to export to.
racli create	Creates an object in the Recovery Appliance.
racli create certificate	Creates a certificate used for HTTPS operations.
racli delete	Deletes an object from the Recovery Appliance.
racli delete protection_policy	Deletes a protection policy from the Recovery Appliance.
racli delete replication_server	Deletes a replication server.
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 archived_log_grouping	Disables archived log grouping 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 rpc	Disables remote procedure call (RPC) on all compute nodes.
racli disable ssh	Disables external ssh access to the system for 'root' and 'oracle' users.
racli disable sys_remote_access	Disables remote 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 archived_log_grouping	Enables archived log grouping 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 rpc	Enables remote procedure call (RPC) on all compute nodes.
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 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 env	Lists env parameters based on type.
racli list export	Lists all the Recovery Appliance export bundles.
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 migration_server	List migration server.
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 protected_db	List protected databases.
racli list remote_syslog	List Sys Log configuration files.
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 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 remote_syslog	Removes from the Recovery Appliance schema the ability to send the system log files to a remote location.
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 archived_log_grouping	Returns if archived log grouping is enabled or disabled, if enabled it returns the group log count.
racli status cloud_location	Lists the status of a cloud storage object for operations performed by the Recovery Appliance.
racli status compliance	Lists the status (either PASS or FAIL) of all compliance-ready checks.
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_keys	TBD.
racli update ssh_known_hosts	Maintains a system-wide configuration file /etc/ssh/ssh_known_hosts with host keys for all nodes in the Recovery Appliance cluster.
racli update storage_location	Update Recovery Appliance 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 version	Returns the ZDLRA software release version in use..