Oracle DBMS_RA
Version 21c

General Information
Library Note Morgan's Library Page Header
Which has the higher priority in your organization: Deploying a new database or securing the ones you already have? Looking for a website, and resources, dedicated solely to securing Oracle databases? Check out DBSecWorx.
Purpose Recovery Appliance (Recovery Appliance) Backup and Recovery support utilities.
AUTHID DEFINER
Constants
Name Data Type Value
 General
BA_STORAGE_DISK NUMBER 1
BA_STORAGE_HTTP NUMBER 2
BA_STORAGE_NFS_ORACLE NUMBER 3
ONEMEG NUMBER 1024*1024
FOURMEG NUMBER 4
MIN_CG_FILE_SIZE NUMBER 40
MIN_CG_FILE_SIZE_NUMSTR VARCHAR2(3) '40M'
 SBT Priority
SBT_PRIORITY_LOW CONSTANT NUMBER 1000
SBT_PRIORITY_MEDIUM NUMBER 100
SBT_PRIORITY_HIGH NUMBER 10
SBT_PRIORITY_CRITICAL NUMBER 1
 Encryption
ENC_OFF VARCHAR2(3) 'OFF'
ENC_AES128 VARCHAR2(6) 'AES128'
ENC_AES192 VARCHAR2(6) 'AES192'
ENC_AES256 VARCHAR2(6) 'AES256'
 Reserve backup Type
RESERVE_BACKUP_TYPE NUMBER 32
 Lock API
LOCKAPI_CREATE NUMBER 1
LOCKAPI_READ NUMBER 2
LOCKAPI_MODIFY NUMBER 3
LOCKAPI_DELETE NUMBER 4
Dependencies
CONFIG DBMS_RCVCAT REP_SERVER
DB KBRSI_ICD SESSIONS
DBMS_RA_DUMP NODE SL
DBMS_RA_MISC ODB TASKS
DBMS_RA_SBT PROD TENANT
DBMS_RA_SCHEDULER RAI_SQ UNREG_DATABASE
DBMS_RA_STORAGE    
Documented Yes
First Available Not known
Security Model Owned by RMAN catalog owner with no privileges granted
Source {ORACLE_HOME}/rdbms/admin/recover.bsq

This package is not installed by default by either OUI or DBCA.
Subprograms
 
ABORT
Calls ABORT_RECOVERY_APPLIANCE dbms_ra.abort;
exec dbms_ra.abort;
 
ABORT_RECOVERY_APPLIANCE
Undocumented dbms_ra.abort_recovery_appliance;
exec dbms_ra.abort_recovery_appliance;
 
ABORT_SBT_TASK
Calls DBMS_SCHEDULER.STOP_JOB with the FORCE parameter dbms_ra.abort_sbt_task(abort_sbt_task(task_id IN NUMBER)
TBD
 
ADD_DB
adds the specified database to the Recovery Appliance, and assigns a protection policy to the database. Enables a non-protected database to attain the status of a protected database. dbms_ra.add_db(
db_unique_name         IN VARCHAR2,
protection_policy_name IN VARCHAR2,
reserved_space         IN VARCHAR2,
tenant_identifier      IN NUMBER   DEFAULT 0,
tenant_prefix          IN VARCHAR2 DEFAULT NULL)
TBD
 
ADD_REPLICATION_SERVER
Adds the specified replication server configuration to the specified protection policy. After the operation succeeds, the Recovery Appliance replicates backups of databases protected by this policy to the downstream Recovery Appliance. dbms_ra.add_replication_server(
replication_server_name  IN VARCHAR2,
protection_policy_name   IN VARCHAR2,
skip_initial_replication IN BOOLEAN DEFAULT FALSE,
read_only                IN BOOLEAN DEFAULT FALSE,
request_only             IN BOOLEAN DEFAULT FALSE);
TBD
 
CLEAR_RESTRICT_SBT_INSTANCE
Undocumented dbms_ra.clear_restrict_sbt_instance(
lib_name      IN VARCHAR2,
instance_name IN VARCHAR2);
TBD
 
CONFIG
Updates a value in the config table. dbms_ra.config(
p_name  IN VARCHAR2,
p_value IN VARCHAR2);
TBD
 
COPY_BACKUP
Copies one or more backup pieces from the Recovery Appliance to a user-specified SBT destination. dbms_ra.copy_backup(
tag                   IN VARCHAR2,
format                IN VARCHAR2,
template_name         IN VARCHAR2,
compression_algorithm IN VARCHAR2 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2 DEFAULT NULL);
TBD
 
COPY_BACKUP_PIECE
Copies a single backup piece from the Recovery Appliance to a user-specified SBT destination dbms_ra.copy_backup_piece(
bp_key IN NUMBER,
format IN VARCHAR2,
template_name IN VARCHAR2,
compression_algorithm IN VARCHAR2 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2 DEFAULT NULL)
TBD
 
CREATE_POLLING_POLICY
Creates a backup polling policy dbms_ra.create_polling_policy(
polling_policy_name IN VARCHAR2,
polling_location    IN VARCHAR2,
polling_frequency   IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
delete_input        IN BOOLEAN                  DEFAULT FALSE)
TBD
 
CREATE_PROTECTION_POLICY
Creates a protection policy dbms_ra.create_protection_policy(
protection_policy_name    IN VARCHAR2,
description               IN VARCHAR2                 DEFAULT NULL,
storage_location_name     IN VARCHAR2,
polling_policy_name       IN VARCHAR2                 DEFAULT NULL,
recovery_window_goal      IN DSINTERVAL_UNCONSTRAINED,
max_retention_window      IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
recovery_window_sbt       IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
unprotected_window        IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
guaranteed_copy           IN VARCHAR2                 DEFAULT 'NO',
allow_backup_deletion     IN VARCHAR2                 DEFAULT 'YES',
store_and_forward         IN VARCHAR2                 DEFAULT 'NO',
log_compression_algorithm IN VARCHAR2                 DEFAULT 'BASIC');
TBD
 
CREATE_REPLICATION_SERVER
Defines a configuration for a downstream Recovery Appliance that forms part of a Recovery Appliance replication scheme dbms_ra.create_replication_server(
replication_server_name IN VARCHAR2,
sbt_so_name             IN VARCHAR2,
sbt_parms               IN VARCHAR2 DEFAULT NULL,
max_streams             IN NUMBER   DEFAULT NULL,
catalog_user_name       IN VARCHAR2,
wallet_alias            IN VARCHAR2,
wallet_path             IN VARCHAR2,
proxy_url               IN VARCHAR2 DEFAULT NULL,
proxy_port              IN NUMBER   DEFAULT NULL,
http_timeout            IN NUMBER   DEFAULT NULL);
TBD
 
CREATE_SBT_ATTRIBUTE_SET
Creates an SBT attribute set that SBT jobs can use dbms_ra.create_sbt_attribute_set(
lib_name           IN VARCHAR2,
attribute_set_name IN VARCHAR2,
streams            IN NUMBER   DEFAULT NULL,
poolid             IN NUMBER   DEFAULT NULL,
parms              IN VARCHAR2 DEFAULT NULL,
send               IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_SBT_JOB_TEMPLATE
Creates a new SBT backup job. The job describes how the Recovery Appliance chooses backups for copying to tape. This overload applies to backups of all databases assigned to a specific protection policy.

Overload 1
dbms_ra.create_sbt_job_template(
template_name          IN VARCHAR2,
protection_policy_name IN VARCHAR2,
attribute_set_name     IN VARCHAR2,
backup_type            IN VARCHAR2,
full_template_name     IN VARCHAR2                 DEFAULT NULL,
from_tag               IN VARCHAR2                 DEFAULT NULL,
priority               IN NUMBER                   DEFAULT SBT_PRIORITY_MEDIUM,
copies                 IN NUMBER                   DEFAULT 1,
window                 IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
compression_algorithm  IN VARCHAR2                 DEFAULT NULL,
encryption_algorithm   IN VARCHAR2                 DEFAULT NULL);
TBD
Creates a new SBT backup job. The job describes how the Recovery Appliance chooses backups for copying to tape. This overloaded procedure applies to backups for a single protected database only.

Overload 2
dbms_ra.create_sbt_job_template(
template_name         IN VARCHAR2,
db_unique_name        IN VARCHAR2,
attribute_set_name    IN VARCHAR2,
backup_type           IN VARCHAR2,
full_template_name    IN VARCHAR2                 DEFAULT NULL,
from_tag              IN VARCHAR2                 DEFAULT NULL,
priority              IN NUMBER                   DEFAULT SBT_PRIORITY_MEDIUM,
copies                IN NUMBER                   DEFAULT 1,
window                IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
compression_algorithm IN VARCHAR2                 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2                 DEFAULT NULL,
tenant_identifier     IN NUMBER                   DEFAULT 0,
tenant_prefix         IN VARCHAR2                 DEFAULT NULL);
TBD
 
CREATE_SBT_LIBRARY
Creates metadata describing an installed media management software library dbms_ra.create_sbt_library(
lib_name       IN VARCHAR2,
drives         IN NUMBER,
restore_drives IN NUMBER   DEFAULT 0,
parms          IN VARCHAR2 DEFAULT NULL,
send           IN VARCHAR2 DEFAULT NULL);
TBD
 
CREATE_STORAGE_LOCATION
Defines a Recovery Appliance storage location, which is an object that describes storage to be used by the Recovery Appliance dbms_ra.create_storage_location(
storage_location_name  IN VARCHAR2,
storage_location_dests IN VARCHAR2);
exec dbms_ra.create_storage_location('UWPRDSTORE', '+DG1(10T),+DG2,+DG3(10T)');
 
DELETE_DB
Removes the specified protected database from the Recovery Appliance deleting all metadata and backups associated with this database, both from disk and SBT. dbms_ra.delete_db(
db_unique_name    IN VARCHAR2,
wait              IN BOOLEAN  DEFAULT TRUE,
tenant_identifier IN NUMBER   DEFAULT 0,
tenant_prefix     IN VARCHAR2 DEFAULT NULL)
TBD
 
DELETE_POLLING_POLICY
Deletes the specified backup polling policy dbms_ra.delete_polling_policy(polling_policy_name IN VARCHAR2);
TBD
 
DELETE_PROTECTION_POLICY
Deletes the specified backup protection policy dbms_ra.delete_protection_policy(protection_policy_name IN VARCHAR2);
TBC
 
DELETE_REPLICATION_SERVER
Deletes a replication server configuration and all metadata relating to the downstream Recovery Appliance dbms_ra.delete_replication_server(
replication_server_name IN VARCHAR2,
force                   IN BOOLEAN DEFAULT FALSE);
TBD
 
DELETE_SBT_ATTRIBUTE_SET
Deletes the specified SBT attribute set dbms_ra.delete_sbt_attribute_set(attribute_set_name IN VARCHAR2);
TBD
 
DELETE_SBT_JOB_TEMPLATE
Deletes the specified SBT job template dbms_ra.delete_sbt_job_template(template_name IN VARCHAR2);
TBD
 
DELETE_SBT_LIBRARY
Deletes the metadata describing the specified SBT library dbms_ra.delete_sbt_library(lib_name IN VARCHAR2);
TBD
 
DELETE_STORAGE_LOCATION
Deletes the specified Recovery Appliance storage location dbms_ra.storage_location_name IN VARCHAR2);
exec dbms_ra.storage_location('UWPRDSTORE');
 
DUMP
Undocumented dbms_ra.dump(
do_dpdump IN BOOLEAN DEFAULT FALSE,
blocks    IN BOOLEAN DEFAULT FALSE,
chunks    IN BOOLEAN DEFAULT FALSE,
db_key    IN NUMBER  DEFAULT NULL,
df_key    IN NUMBER  DEFAULT NULL)
TBD
 
ESTIMATE_SPACE
Estimates space requirements for the identified database based on the target window dbms_ra.estimate_space(
db_unique_name    IN VARCHAR2,
target_window     IN DSINTERVAL_UNCONSTRAINED,
tenant_identifier IN NUMBER   DEFAULT 0,
tenant_prefix     IN VARCHAR2 DEFAULT NULL)
RETURN NUMBER;
TBD
 
GRANT_DB_ACCESS
Grants privileges to the specified recovery Appliance user account to enable back up, restore, and access recovery catalog metadata for the specified protected database dbms_ra.grant_db_access(
username          IN VARCHAR2,
db_unique_name    IN VARCHAR2,
tenant_identifier IN NUMBER   DEFAULT 0,
tenant_prefix     IN VARCHAR2 DEFAULT NULL);
TBD
 
KEY_REKEY
Undocumented

Overload 1
dbms_ra.key_rekey;
exec dbms_ra.key_rekey;
Overload 2 dbms_ra.key_rekey(db_unique_name IN VARCHAR2);
exec dbms_ra.key_rekey('ORABASEXXI');
Overload 3 dbms_ra.key_rekey(protection_policy_name IN VARCHAR2);
TBD
 
MIGRATE_TAPE_BACKUP
Makes pre-migration tape backups accessible to the Recovery Appliance through the specified SBT library dbms_ra.migrate_tape_backup(
db_unique_name    IN VARCHAR2,
sbt_lib_name      IN VARCHAR2,
tenant_identifier IN NUMBER   DEFAULT 0,
tenant_prefix     IN VARCHAR2 DEFAULT NULL);
TBD
 
MOVE_BACKUP
Moves one or more long-term archival backup pieces from the Recovery Appliance to a user-specified SBT destination dbms_ra.move_backup(
tag                   IN VARCHAR2,
format                IN VARCHAR2,
template_name         IN VARCHAR2,
compression_algorithm IN VARCHAR2 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2 DEFAULT NULL);
TBD
 
MOVE_BACKUP_PIECE
Moves a single long-term archival backup piece from the Recovery Appliance to a user-specified SBT destination dbms_ra.move_backup_piece(
bp_key                IN NUMBER,
format                IN VARCHAR2,
template_name         IN VARCHAR2,
compression_algorithm IN VARCHAR2 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2 DEFAULT NULL);
TBD
 
PAUSE_REPLICATION_SERVER
Pauses replication to the specified downstream Recovery Appliance dbms_ra.pause_replication_server(replication_server_name IN VARCHAR2);
TBD
 
PAUSE_SBT_LIBRARY
Pauses the specified SBT library while allowing in-progress copies of backup pieces to complete dbms_ra.pause_sbt_library(lib_name IN VARCHAR2);
TBD
 
POPULATE_BACKUP_PIECE
Pushes the specified backup piece into the delta store dbms_ra.populate_backup_piece(backup_piece_key IN NUMBER);
TBD
 
QUEUE_SBT_BACKUP_TASK
Queues the backup pieces selected by the specified SBT job template for copying to tape dbms_ra.queue_sbt-backup_task(
template_name     IN VARCHAR2,
format            IN VARCHAR2 DEFAULT NULL,
autobackup_prefix IN VARCHAR2 DEFAULT NULL,
tag               IN VARCHAR2 DEFAULT NULL);
TBD
 
REMOVE_REPLICATION_SERVER
Removes the specified replication server configuration from the specified protection policy dbms_ra.remove_replication_server(
replication_server_name IN VARCHAR2,
protection_policy_name  IN VARCHAR2);
TBD
 
RENAME_DB
Changes the name of the specified protected database in the Recovery Appliance metadata

It does not rename the database itself.
dbms_ra.rename_db(
db_unique_name_old IN VARCHAR2,
db_unique_name_new IN VARCHAR2,
tenant_identifier  IN NUMBER   DEFAULT 0,
tenant_prefix      IN VARCHAR2 DEFAULT NULL);
TBD
 
RESET_ERROR
Modifies the specified error log entry to have the status RESET but does raise an OEM alert dbms_ra.reset_error(
incident#  IN NUMBER                   DEFAULT NULL,
error_code IN NUMBER                   DEFAULT NULL,
error_text IN VARCHAR2                 DEFAULT NULL,
task_id    IN NUMBER                   DEFAULT NULL,
component  IN VARCHAR2                 DEFAULT NULL,
low_time   IN TIMESTAMP WITH TIME ZONE DEFAULT NULL,
high_time  IN TIMESTAMP WITH TIME ZONE DEFAULT NULL);
TBD
 
RESUME_REPLICATION_SERVER
Resumes replication of a paused Replication Server dbms_ra.resume_replication_server(replication_server_name IN VARCHAR2);
TBD
 
RESUME_SBT_LIBRARY
Resumes a paused SBT library dbms_ra.resume_sbt_library(lib_name IN ARCHAR2);
TBD
 
REVOKE_DB_ACCESS
Revokes privileges on one protected database from the specified Recovery Appliance user account dbms_ra.revoke_db_access(
username          IN VARCHAR2,
db_unique_name    IN VARCHAR2,
tenant_identifier IN NUMBER   DEFAULT 0,
tenant_prefix     IN VARCHAR2 DEFAULT NULL);
TBD
 
SET_RESTRICT_SBT_INSTANCE
Undocumented dbms_ra.set_restrict_sbt_instance(
lib_name      IN VARCHAR2,
instance_name IN VARCHAR2);
TBD
 
SET_SYSTEM_DESCRIPTION
Undocumented dbms_ra.set_system_description(sys_desc IN VARCHAR2);
TBD
 
SHUTDOWN
Calls SHUTDOWN_RECOVERY_APPLIANCE dbms_ra.shutdown;
exec dbms_ra.shutdown;
 
SHUTDOWN_RECOVERY_APPLIANCE
ZDLRA Shutdown dbms_ra.shutdown_recovery_appliance;
exec dbms_ra.shutdown_recovery_appliance;
 
STARTUP
Calls STARTUP_RECOVERY_APPLIANCE dbms_ra.startup;
exec dbms_ra.startup;
 
STARTUP_RECOVERY_APPLIANCE
ZDLRA Startup dbms_ra.startup_recovery_appliance;
exec dbms_ra.startup_recovery_appliance;
 
UPDATE_DB
Changes the attributes that are assigned to the specified protected database dbms_ra.update_db(
db_unique_name           IN VARCHAR2,
protection_policy_name   IN VARCHAR2 DEFAULT NULL,
reserved_space           IN VARCHAR2 DEFAULT NULL,
db_timezone              IN VARCHAR2 DEFAULT NULL,
incarnations             IN VARCHAR2 DEFAULT 'CURRENT',
skip_initial_replication IN BOOLEAN  DEFAULT FALSE,
tenant_identifier        IN NUMBER   DEFAULT 0,
tenant_prefix            IN VARCHAR2 DEFAULT NULL);
TBD
 
UPDATE_POLLING_POLICY
Modifies the parameters for an existing backup polling policy dbms_ra.update_polling_policy(
polling_policy_name IN VARCHAR2,
polling_location    IN VARCHAR2                 DEFAULT NULL,
polling_frequency   IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
delete_input        IN BOOLEAN                  DEFAULT NULL);
TBD
 
UPDATE_PROTECTION_POLICY
Modifies the parameters for an existing backup protection policy dbms_ra.update_protection_policy(
protection_policy_name    IN VARCHAR2,
description               IN VARCHAR2                 DEFAULT NULL,
storage_location_name     IN VARCHAR2                 DEFAULT NULL,
polling_policy_name       IN VARCHAR2,
recovery_window_goal      IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
max_retention_window      IN DSINTERVAL_UNCONSTRAINED,
recovery_window_sbt       IN DSINTERVAL_UNCONSTRAINED,
unprotected_window        IN DSINTERVAL_UNCONSTRAINED,
guaranteed_copy           IN VARCHAR2                 DEFAULT NULL,
allow_backup_deletion     IN VARCHAR2                 DEFAULT NULL,
store_and_forward         IN VARCHAR2                 DEFAULT NULL,
log_compression_algorithm IN VARCHAR2                 DEFAULT NULL);
TBD
 
UPDATE_REPLICATION_SERVER
Changes the settings for a replication server configuration dbms_ra.update_replication_server(
replication_server_name IN VARCHAR2,
sbt_so_name             IN VARCHAR2 DEFAULT NULL,
sbt_parms               IN VARCHAR2 DEFAULT NULL,
max_streams             IN NUMBER,
catalog_user_name       IN VARCHAR2 DEFAULT NULL,
wallet_alias            IN VARCHAR2 DEFAULT NULL,
wallet_path             IN VARCHAR2,
proxy_url               IN VARCHAR2,
proxy_port              IN NUMBER,
http_timeout            IN NUMBER   DEFAULT NULL);
TBD
 
UPDATE_SBT_ATTRIBUTE_SET
Updates the parameters for the specified SBT attribute set dbms_ra.update_sbt_attribute_set(
attribute_set_name IN VARCHAR2,
streams            IN NUMBER,
poolid             IN NUMBER DEFAULT NULL,
parms              IN VARCHAR2,
send               IN VARCHAR2);
TBD
 
UPDATE_SBT_JOB_TEMPLATE
Updates the parameters for the specified SBT job dbms_ra.update_sbt-job_template(
template_name         IN VARCHAR2,
attribute_set_name    IN VARCHAR2 DEFAULT NULL,
backup_type           IN VARCHAR2 DEFAULT NULL,
from_tag              IN VARCHAR2,
priority              IN NUMBER   DEFAULT NULL,
copies                IN NUMBER   DEFAULT NULL,
window                IN DSINTERVAL_UNCONSTRAINED,
compression_algorithm IN VARCHAR2 DEFAULT NULL,
encryption_algorithm  IN VARCHAR2 DEFAULT NULL);
TBD
 
UPDATE_SBT_LIBRARY
Modifies the parameters for the specified SBT library dbms_ra.update_sbt_library(
lib_name       IN VARCHAR2,
drives         IN NUMBER DEFAULT NULL,
restore_drives IN NUMBER DEFAULT NULL,
parms          IN VARCHAR2,
send           IN VARCHAR2);
TBD
 
UPDATE_STORAGE_LOCATION
Increases, but cannot decrease, space allocation for the specified storage location dbms_ra.update_storage_location(
storage_location_name  IN VARCHAR2,
storage_location_dests IN VARCHAR2 DEFAULT NULL);
exec dbms_ra.update_storage_location('UWPRDSTORE', '+DG1(25T),+DG2,+DG3(50T)');

Related Topics
Built-in Functions
Built-in Packages
Database Security
DBMS_RA_DUMP
DBMS_RA_INT
DBMS_RA_MISC
DBMS_RA_POOL
DBMS_RA_SBT
DBMS_RA_SCHEDULER
DBMS_RA_STORAGE
KBRSI_ICD
What's New In 19c
What's New In 20c-21c

Morgan's Library Page Footer
This site is maintained by Dan Morgan. Last Updated: This site is protected by copyright and trademark laws under U.S. and International law. © 1998-2021 Daniel A. Morgan All Rights Reserved
  DBSecWorx