Oracle DBMS_RA_SBT
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 utility for tape (SBT)
AUTHID DEFINER
Constants
Name Data Type Value
 General
RRA_MSG_UNSUPPORTED PLS_INTEGER 9999
RRA_MSG_PROBE PLS_INTEGER 1
RRA_MSG_HEARTBEAT PLS_INTEGER 2
RRA_MSG_BREAK_REPPAIR PLS_INTEGER 3
RRA_MSG_REQUEST_BACKUP PLS_INTEGER 4
RRA_MSG_LAST_MSGCODE PLS_INTEGER RRA_MSG_REQUEST_BACKUP
Data Types CREATE OR REPLACE TYPE rai_number_2t IS TABLE OF rai_two_numbers_type;
Dependencies
ARCH_GROUP_TASK DBMS_RCVMAN SBT_CATALOG
BCF DBMS_SYS_ERROR SBT_JOB_TEMPLATE
BDF DBMS_XMLGEN SBT_LIB_DESC
BP DF SBT_TASK
BRL INITREP_ALT SBT_TASK_HISTORY
BS KBRSI_ICD SBT_TEMPLATE_DB
BSF NODE SBT_TEMPLATE_DF
CKP ODB SERVER
CONFIG OFFR SF_BACKUP
DB PROT TASK
DBINC RAA_VERSIONS TENANT
DBMS_BACKUP_RESTORE RAI_ACTIVE_INSTANCES TIMER_TASK
DBMS_LOB RAI_SCHEMA USER_TAB_COLUMNS
DBMS_NETWORK_ACL_ADMIN RA_REPLICATION_CONFIG V_$PARAMETER
DBMS_RA RCFILE V_$RMAN_ENCRYPTION_ALGORITHMS
DBMS_RA_INT REP_PAIR _RSX_RSI_RMTRA_HANDSHAKE_
DBMS_RA_MISC REP_SERVER _RSX_RSI_RMTRA_REQBU_BU_RESP_
DBMS_RA_SCHEDULER RRA_REQUEST_BACKUP _RSX_RSI_RMTRA_REQBU_PDBINFO_
DBMS_RA_STORAGE SBT_ATTR_SET _RSX_RSI_RMTRA_REQBU_BU_
Documented No
First Available Not known
Security Model Owned by SYS with no privileges granted
Source {ORACLE_HOME}/rdbms/admin/recover.bsq

Compilation requires sys.kbrsi_icd is installed and execute is granted to the RMAN catalog owner.
Subprograms
 
ADD_REPOSITORY
Undocumented dbms_ra_sbt.add_repository(
catalog_user_name IN VARCHAR2,
new_server_key    IN NUMBER,
am_server_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)
RETURN NUMBER;
TBD
 
BASELINETIMEZONE
Undocumented dbms_ra_sbt.baselineTimezone(
p_db_key              IN         NUMBER,
p_baseline_time       OUT NOCOPY DATE,
p_baseline_untscn     OUT NOCOPY NUMBER,
p_recovery_window_sbt OUT NOCOPY DATE);
TBD
 
BUILD_REP_ATR_NAME
Undocumented dbms_ra_sbt.build_rep_atr_name(
rep_srv_name IN VARCHAR2,
server_key   IN NUMBER DEFAULT NULL)
RETURN VARCHAR2;
TBD
 
BUILD_REP_LIB_NAME
Undocumented dbms_ra_sbt.build_rep_lib_name(
rep_srv_name IN VARCHAR2,
server_key   IN NUMBER DEFAULT NULL)
RETURN VARCHAR2;
TBD
 
BUILD_REP_TPL_NAME
Undocumented dbms_ra_sbt.build_rep_tpl_name(
rep_srv_name     IN VARCHAR2,
db_key           IN NUMBER,
p_rep_server_key IN NUMBER)
RETURN VARCHAR2;
TBD
 
CHECK_DO_PENDING_REP_SETUP
Undocumented dbms_ra_sbt.check_do_pending_rep_setup(p_db_key IN VARCHAR2) RETURN BOOLEAN;
TBD
 
COPY_ONE_BACKUPPIECE
Undocumented dbms_ra_sbt.copy_one_backuppiece(
p_bpkey            IN NUMBER,
p_format           IN VARCHAR2,
p_deletesource     IN VARCHAR2,
p_template_key     IN NUMBER   DEFAULT NULL,
p_compression_algo IN VARCHAR2 DEFAULT NULL,
p_encryption_algo  IN VARCHAR2 DEFAULT NULL);
TBD
 
COPY_SBT
Undocumented dbms_ra_sbt.copy_sbt(p_task_rec IN TIMESTAMP);
exec dbms_ra_sbt.copy_sbt(SYSTIMESTAMP-1);
 
CREATE_SBT_JOB_TEMPLATE_INT
Undocumented

Overload 1
dbms_ra_sbt.create_sbt_job_template_int(
template_name      IN VARCHAR2,
prot_name          IN VARCHAR2,
attr_name          IN VARCHAR2,
backup_type        IN VARCHAR2,
full_template_name IN VARCHAR2                 DEFAULT NULL,
from_tag           IN VARCHAR2                 DEFAULT NULL,
priority           IN NUMBER                   DEFAULT 100,    -- SBT_PRIORITY_MEDIUM
copies             IN NUMBER                   DEFAULT 1,
window             IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
p_compression_algo IN VARCHAR2                 DEFAULT NULL,
p_encryption_algo  IN VARCHAR2                 DEFAULT NULL,
do_commit          IN BOOLEAN                  DEFAULT TRUE);
TBD
Overload 2 dbms_ra_sbt.create_sbt_job_template_int(
template_name      IN VARCHAR2,
db_unique_name     IN VARCHAR2,
attr_name          IN VARCHAR2,
backup_type        IN VARCHAR2,
full_template_name IN VARCHAR2                 DEFAULT NULL,
from_tag           IN VARCHAR2                 DEFAULT NULL,
priority           IN NUMBER                   DEFAULT 100,   -- SBT_PRIORITY_MEDIUM
copies             IN NUMBER                   DEFAULT 1,
window             IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL,
p_compression_algo IN VARCHAR2                 DEFAULT NULL,
p_encryption_algo  IN VARCHAR2                 DEFAULT NULL,
do_commit          IN BOOLEAN                  DEFAULT TRUE,
p_tkey             IN NUMBER                   DEFAULT 0);    -- DEFAULT_TENANT
TBD
 
DELETE_ONE_BACKUPPIECE
Undocumented dbms_ra_sbt.delete_one_backuppiece(p_bpkey IN NUMBER);
TBD
 
DELETE_REPOSITORY
Undocumented dbms_ra_sbt.delete_repository(
catalog_user_name IN VARCHAR2,
wallet_alias      IN VARCHAR2,
wallet_path       IN VARCHAR2);
TBD
 
FULL_RESYNC_DONE
Undocumented dbms_ra_sbt.full_resync_done(p_db_key IN NUMBER);
-- example from recover.bsq

CREATE OR REPLACE PROCEDURE dbms_rai_full_resync_done IS
BEGIN
  dbms_ra_sbt.full_resync_done(p_db_key => dbms_rcvman.getDbKey);
END;
/
 
GRANT_NETWORK_ACL_ACE
Undocumented dbms_ra_sbt.grant_network_acl_ace(
catalog_user_name IN VARCHAR2,
wallet_alias      IN VARCHAR2,
wallet_path       IN VARCHAR2);
TBD
 
GROUP_ARCH_SBT_BACKUP
Undocumented dbms_ra_sbt.group_arch_sbt_backup(
p_task_rec IN TIMESTAMP,
p_attr_key IN NUMBER);
TBD
 
INVALIDATEBASELEVELBCKS
Undocumented dbms_ra_sbt.inValidateBaseLevelBcks(
p_db_key       IN NUMBER,
p_currinc      IN NUMBER,
p_template_key IN NUMBER,
p_baseline_scn IN OUT NUMBER);
TBD
 
IS_VALID_JOB_COMPRESSION_ALGO
Undocumented dbms_ra_sbt.is_valid_job_compression_algo(p_compression_algo IN VARCHAR2)
RETURN BOOLEAN;
TBD
 
IS_VALID_JOB_ENCRYPTION_ALGO
Undocumented dbms_ra_sbt.is_valid_job_encryption_algo(p_encryption_algo IN VARCHAR2) RETURN BOOLEAN;
TBD
 
LOAD_ENC_ALG
Undocumented dbms_ra_sbt.load_enc_alg;
exec dbms_ra_sbt.load_enc_alg;
 
LOGMISSINGDFBCKSERROR
Undocumented dbms_ra_sbt.logMissingDfBcksError(
p_db_key       IN NUMBER,
p_currinc      IN NUMBER,
p_template_key IN NUMBER,
p_lib_key      IN NUMBER);
TBD
 
PROCESSALLPIECESCHEDULED
Undocumented dbms_ra_sbt.ProcessAllPieceScheduled(
p_bs_key       IN NUMBER,
p_template_key IN NUMBER,
p_db_key       IN NUMBER,
p_df_file_no   IN NUMBER,
p_df_ckpscn    IN NUMBER,
p_df_crescn    IN NUMBER,
p_df_pc        IN NUMBER,
p_raise_error  IN BOOLEAN);
TBD
 
PURGE_OBSOLETE_SBT
Undocumented dbms_ra_sbt.purge_obsolete_sbt(
p_dbkey   IN NUMBER,
p_libkey  IN NUMBER,
p_sbt_ret IN DSINTERVAL_UNCONSTRAINED);
TBD
 
QUEUEARCHIVEDLOGBCKS
Undocumented dbms_ra_sbt.queueArchivedLogBcks(
p_db_key            IN NUMBER,
p_from_tag          IN VARCHAR2,
p_template_key      IN NUMBER,
p_full_template_key IN NUMBER,
p_baseline_scn      IN NUMBER,
p_lib_key           IN NUMBER,
p_attr_key          IN NUMBER,
p_copies            IN NUMBER,
p_delete_source     IN VARCHAR2,
p_format            IN VARCHAR2,
p_init_cf_bs_key    IN NUMBER,
p_last_bp_key       IN NUMBER,
p_server_key        IN NUMBER,
p_compression_algo  IN VARCHAR2,
p_encryption_algo   IN VARCHAR2,
p_autobackup_prefix IN VARCHAR2,
p_tag               IN VARCHAR2);
TBD
 
QUEUEBASELEVELBCKS
Undocumented dbms_ra_sbt.queueBaseLevelBcks(
p_db_key            IN     NUMBER,
p_dbid                 OUT NUMBER,
p_currinc           IN OUT NUMBER,
p_db_slkey          IN OUT NUMBER,
p_from_tag          IN     VARCHAR2,
p_template_key      IN     NUMBER,
p_baseline_scn      IN OUT NUMBER,
p_lib_key           IN     NUMBER,
p_attr_key          IN     NUMBER,
p_copies            IN     NUMBER,
p_delete_source     IN     VARCHAR2,
p_format            IN     VARCHAR2,
p_last_bp_key       IN     NUMBER,
p_max_bp_key        IN     NUMBER,
p_server_key        IN     NUMBER,
p_compression_algo  IN     VARCHAR2,
p_encryption_algo   IN     VARCHAR2,
p_autobackup_prefix IN     VARCHAR2,
p_tag               IN     VARCHAR2);
TBD
 
QUEUEINCREMENTALBCKS
Undocumented dbms_ra_sbt.queueIncrementalBcks(
p_db_key            IN NUMBER,
p_from_tag          IN VARCHAR2,
p_template_key      IN NUMBER,
p_full_template_key IN NUMBER,
p_baseline_scn      IN NUMBER,
p_lib_key           IN NUMBER,
p_attr_key          IN NUMBER,
p_copies            IN NUMBER,
p_delete_source     IN VARCHAR2,
p_format            IN VARCHAR2,
p_init_cf_bs_key    IN NUMBER,
p_last_bp_key       IN NUMBER,
p_server_key        IN NUMBER,
p_compression_algo  IN VARCHAR2,
p_encryption_algo   IN VARCHAR2,
p_autobackup_prefix IN VARCHAR2,
p_tag               IN VARCHAR2);
TBD
 
QUEUEKEEPANDNVFULLBCKS
Undocumented dbms_ra_sbt.queueKeepAndNvFullBcks(
p_db_key        IN NUMBER,
p_from_tag      IN VARCHAR2,
p_template_key  IN NUMBER,
p_baseline_scn  IN NUMBER,
p_lib_key       IN NUMBER,
p_attr_key      IN NUMBER,
p_copies        IN NUMBER,
p_delete_source IN VARCHAR2,
p_format        IN VARCHAR2,
p_last_bp_key   IN NUMBER,
p_server_key    IN NUMBER,
p_keep_bck      IN NUMBER,
p_nvfull_bck    IN NUMBER);
TBD
 
QUEUEMISSINGDFBCKS
Undocumented dbms_ra_sbt.queueMissingDFBcks(
p_db_key            IN NUMBER,
p_from_tag          IN VARCHAR2,
p_template_key      IN NUMBER,
p_baseline_scn      IN NUMBER,
p_lib_key           IN NUMBER,
p_attr_key          IN NUMBER,
p_copies            IN NUMBER,
p_delete_source     IN VARCHAR2,
p_format            IN VARCHAR2,
p_last_bp_key       IN NUMBER,
p_server_key        IN NUMBER,
p_compression_algo  IN VARCHAR2,
p_encryption_algo   IN VARCHAR2,
p_autobackup_prefix IN VARCHAR2,
p_tag               IN VARCHAR2);
TBD
 
RECONCILE_DB
Undocumented dbms_ra_sbt.reconcile_db (p_where IN VARCHAR2,
p_db_key          IN  NUMBER,
p_server_key      IN  NUMBER  DEFAULT NULL,
p_only_active     IN  BOOLEAN DEFAULT TRUE,
p_force_reconcile IN  BOOLEAN DEFAULT FALSE,
rec_cnt           OUT NUMBER,
p_force_fixed     IN  BOOLEAN DEFAULT FALSE)
RETURN BOOLEAN;
TBD
 
RELEASE_BLOCKED_SBT_TASKS
Undocumented dbms_ra_sbt.release_blocked_sbt_tasks(
p_db_key         IN NUMBER,
p_rep_server_key IN NUMBER);
TBD
 
REMOTERA_DELETEREPSERVER
Undocumented dbms_ra_sbt.RemoteRa_DeleteRepServer(p_rep_server_name IN VARCHAR2);
TBD
 
REMOTERA_EXEC_DS
Undocumented dbms_ra_sbt.remoteRA_exec_DS(
input_xml_filename IN VARCHAR2,
p_user_id          IN NUMBER,
p_username         IN VARCHAR2);
TBD
 
REMOTERA_PROBE
Undocumented dbms_ra_sbt.RemoteRa_Probe(
p_rep_server_name  IN  VARCHAR2,
p_new_rep_pair_key OUT NUMBER)
RETURN BOOLEAN;
TBD
 
REMOTERA_REQUESTBACKUP
Undocumented dbms_ra_sbt.RemoteRA_RequestBackup(p_group# IN NUMBER DEFAULT NULL) RETURN BOOLEAN;
TBD
 
REPCLRMISSINGDFBCKSERROR
Undocumented dbms_ra_sbt.repClrMissingDfBcksError(
p_db_key       IN NUMBER,
p_bs_key       IN NUMBER,
p_piece_no     IN NUMBER,
p_template_key IN NUMBER);
TBD
 
REPLICATE_EXISTING_BACKUPS
Undocumented dbms_ra_sbt.replicate_existing_backups(
p_template_name IN TIMESTAMP,
p_db_key        IN NUMBER DEFAULT NULL,
p_server_key    IN NUMBER DEFAULT NULL);
TBD
 
REPLICATE_EXISTING_BACKUPS_ALT
Undocumented dbms_ra_sbt.replicate_existing_backups_alt(
p_db_key             IN NUMBER,
p_server_key         IN NUMBER,
p_override_read_only IN BOOLEAN DEFAULT FALSE);
TBD
 
REPLICATE_ONE_BP
Undocumented dbms_ra_sbt.replicate_one_bp (p_db_key IN NUMBER,
p_bp_key             IN  NUMBER,
p_server_key         IN  NUMBER  DEFAULT NULL,
p_override_read_only IN  BOOLEAN DEFAULT FALSE,
p_allow_rerep        IN  BOOLEAN DEFAULT FALSE,
p_cnt_new_tasks      OUT NUMBER);
TBD
 
REQMODE_BU_RECEIVED
Undocumented dbms_ra_sbt.reqmode_bu_received(
p_bp_key IN NUMBER,
p_ct_key IN NUMBER)
TBD
 
REQMODE_CALCULATE_MISSING
Undocumented dbms_ra_sbt.reqmode_calculate_missing(
p_db_key       IN NUMBER  DEFAULT NULL,
p_rep_pair_key IN NUMBER  DEFAULT NULL,
p_group#       IN NUMBER  DEFAULT NULL,
p_from_api     IN BOOLEAN DEFAULT FALSE);
TBD
 
REQMODE_CALC_ONE_DB
Undocumented dbms_ra_sbt.reqmode_calc_one_db(
p_db_key     IN NUMBER,
p_server_key IN NUMBER,
p_group#     IN NUMBER  DEFAULT NULL,
p_from_api   IN BOOLEAN DEFAULT FALSE);
TBD
 
REQMODE_CLEANUP
Undocumented dbms_ra_sbt.reqmode_cleanup(
p_db_key       IN NUMBER,
p_rep_pair_key IN NUMBER);
TBD
 
REQMODE_GETBURESP
Undocumented dbms_ra_sbt.reqmode_getBuResp RETURN rai_number_2t;
TBD
 
REQMODE_QUEUE_PIECE
Undocumented dbms_ra_sbt.reqmode_queue_piece(
p_bp_key IN NUMBER,
p_group# IN NUMBER DEFAULT NULL);
TBD
 
REQMODE_STARTUP
Undocumented dbms_ra_sbt.reqmode_startup;
exec dbms_ra_sbt.reqmode_startup;
 
RESTORE_SBT
Undocumented dbms_ra_sbt.restore_sbt(p_task_rec IN TIMESTAMP);
exec dbms_ra_sbt.restore_sbt(SYSTIMESTAMP-1);
 
REVOKE_NETWORK_ACL_ACE
Undocumented dbms_ra_sbt.revoke_network_acl_ace(
catalog_user_name IN VARCHAR2,
wallet_alias      IN VARCHAR2,
wallet_path       IN VARCHAR2);
TBD
 
SBT_DEFAULT_DRIVES
Undocumented dbms_ra_sbt.sbt_default_drives RETURN NUMBER;
SELECT dbms_ra_sbt.sbt_default_drives
FROM dual;
 
SBT_JOB_BACKUP_TYPE_TO_NUM
Undocumented dbms_ra_sbt.sbt_job_backup_type_to_num(backup_type IN VARCHAR2) RETURN NUMBER;
TBD
 
SETTRACING
Undocumented dbms_ra_sbt.setTracing(p_trc_on IN NUMBER);
TBD
 
SET_NEXT_RECONCILE_TIME
Undocumented dbms_ra_sbt.set_next_reconcile_time (
p_db_key            IN NUMBER,
p_set_for_nextcheck IN BOOLEAN DEFAULT FALSE);
TBD
 
STATBPSBT
Undocumented dbms_ra_sbt.statBpSbt(
db_key  IN         NUMBER,
handle  IN         VARCHAR2,
mhandle OUT NOCOPY sys.kbrsi_icd.names$_t,
single  OUT        BINARY_INTEGER,
recall  IN         BINARY_INTEGER,
remote  OUT        BINARY_INTEGER)
RETURN BINARY_INTEGER;
TBD

Related Topics
Built-in Functions
Built-in Packages
Database Security
DBMS_BACKUP_RESTORE
DBMS_RA
DBMS_RA_DUMP
DBMS_RA_INT
DBMS_RA_MISC
DBMS_RA_POOL
DBMS_RA_SCHEDULER
DBMS_RA_STORAGE
KBRSI_ICD
RMAN
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-2022 Daniel A. Morgan All Rights Reserved
  DBSecWorx