13 DBMS_RA Package Reference
This chapter provides details on the DBMS_RA
PL/SQL package. You use DBMS_RA
subprograms to perform all Recovery Appliance administration functions.
One DBMS_RA
procedure may execute at a given time. With the exception of ABORT_RECOVERY_APPLIANCE
, attempts to run multiple DBMS_RA
procedure in different sessions at the same time fail with an appropriate message.
The following table summarizes the available DBMS_RA
subprograms.
Table 13-1 DBMS_RS Package Subprograms
Subprogram | Description |
---|---|
ABORT
|
Synonymous with |
ABORT_RECOVERY_APPLIANCE
|
This procedure shuts down the Recovery Appliance without waiting for in-progress operations to complete. |
ADD_DB
|
This procedure adds the specified database to the Recovery Appliance, and assigns a protection policy to the database. This procedure enables a non-protected database to attain the status of a protected database. |
ADD_REPLICATION_SERVER
|
This procedure 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. |
CONFIG
|
This procedure updates a value in the |
COPY_BACKUP
|
This procedure copies one or more backup pieces from the Recovery Appliance to a
user-specified disk or SBT destination.
The Recovery Appliance copies all backup pieces matching the specified tag to the
location specified with the |
COPY_BACKUP_PIECE
|
This procedure copies a single backup piece from the Recovery Appliance to a user-specified disk or SBT destination. |
CREATE_POLLING_POLICY
|
This procedure creates a backup polling policy. |
CREATE_PROTECTION_POLICY
|
This procedure creates a protection policy. |
CREATE_REPLICATION_SERVER
|
This procedure defines a configuration for a downstream Recovery Appliance that forms part of a Recovery Appliance replication scheme. |
CREATE_SBT_ATTRIBUTE_SET
|
This procedure creates an SBT attribute set that SBT jobs can use. |
CREATE_SBT_JOB_TEMPLATE
|
This procedure creates an SBT job that describes how the Recovery Appliance chooses backups for copying to tape. This form of this overloaded procedure applies to backups for all protected databases assigned to the specified protection policy. |
CREATE_SBT_JOB_TEMPLATE
|
This procedure creates a new SBT backup job. The job describes how the Recovery Appliance chooses backups for copying to tape/cloud. This form of this overloaded procedure applies to backups for a single protected database only, whereas the previous form applies to backups of all databases assigned to a specific protection policy. With the exception of this difference, this procedure and its parameters are identical to the alternative form of this procedure. |
CREATE_SBT_LIBRARY
|
This procedure creates metadata describing an installed media management software library. The Recovery Appliance uses the specified library to copy backups from internal storage either to tape or to other tertiary storage supported by this media manager. |
CREATE_STORAGE_LOCATION
|
This procedure creates Recovery Appliance storage location, which is an object that describes storage to be used by the Recovery Appliance. Recovery Appliance stores all backups in named storage locations. |
DELETE_DB
|
This procedure removes the specified protected database from the Recovery Appliance. The Recovery Appliance deletes all metadata and backups associated with this database, both from disk and SBT. Backups on tape are not affected. Regarding replicated and cloud pieces: the meta data is deleted from the Recovery Appliance doing the delete, but the data is not deleted from the downstream or cloud storage. |
DELETE_POLLING_POLICY
|
This procedure deletes the specified backup polling policy. |
DELETE_PROTECTION_POLICY
|
This procedure deletes the specified protection policy. |
DELETE_REPLICATION_SERVER
|
This procedure deletes a replication server configuration. The Recovery Appliance removes all metadata relating to the downstream Recovery Appliance. |
DELETE_SBT_ATTRIBUTE_SET
|
This procedure deletes the specified SBT attribute set. |
DELETE_SBT_JOB_TEMPLATE
|
This procedure deletes the specified SBT job template. |
DELETE_SBT_LIBRARY
|
This procedure deletes the metadata describing the specified SBT library. |
DELETE_STORAGE_LOCATION
|
This procedure deletes the specified Recovery Appliance storage location. |
ESTIMATE_SPACE
|
This procedure estimates the amount of storage in GB required for recovery of a given database and a desired recovery window. |
GRANT_DB_ACCESS
|
This procedure grants the necessary privileges to the specified recovery Appliance user account to enable this account to back up, restore, and access recovery catalog metadata for the specified protected database. |
KEY_REKEY
|
This procedure rekeys encryption keys for all databases with existing encryption keys. |
KEY_REKEY
|
This procedure rekeys encryption keys for the specified database with an existing encryption key. |
KEY_REKEY
|
This procedure rekeys encryption keys for all databases with existing encryption keys in the specified protection_policy |
MIGRATE_TAPE_BACKUP
|
This procedure makes pre-migration tape backups
accessible to the Recovery Appliance through the specified SBT
library. You must first import metadata about the tape backups
into the Recovery Appliance catalog using the RMAN
|
MOVE_BACKUP
|
This procedure moves one or more long-term archival backup pieces from the Recovery Appliance to a user-specified disk or SBT destination. |
MOVE_BACKUP_PIECE
|
This procedure moves a single long-term archival backup piece from the Recovery Appliance to a user-specified disk or SBT destination. |
PAUSE_REPLICATION_SERVER
|
This procedure pauses replication to the specified downstream Recovery Appliance. |
PAUSE_SBT_LIBRARY
|
This procedure pauses the specified SBT library. The Recovery Appliance allows in-progress
copies of backup pieces to complete. However, if backup pieces were
queued for copy through this SBT library but not yet copied, then the Recovery Appliance
holds them until you resume the SBT library. No new SBT jobs that run
against this library can execute until you resume the library ( |
POPULATE_BACKUP_PIECE
|
This procedure pushes the specified backup piece into the delta store. |
QUEUE_SBT_BACKUP_TASK
|
This procedure queues the backup pieces selected by the specified SBT job template for copying to tape. Typically, a scheduling utility such as Oracle Scheduler calls this procedure. |
REMOVE_REPLICATION_SERVER
|
This procedure removes the specified replication server configuration from the specified protection policy. After the operation succeeds, the Recovery Appliance no longer replicates backups of databases protected by this policy to the downstream Recovery Appliance. |
RENAME_DB
|
This procedure changes the name of the specified protected database in the Recovery Appliance metadata. |
RESET_ERROR
|
This procedure modifies the specified set of incident log entries to have
the status |
RESUME_REPLICATION_SERVER
|
This procedure resumes replication to the specified downstream Recovery Appliance, after a
previous call to |
RESUME_SBT_LIBRARY
|
This procedure resumes a paused SBT library. |
REVOKE_DB_ACCESS
|
This procedure revokes privileges on one protected database from the specified Recovery Appliance user account. |
SET_SYSTEM_DESCRIPTION
|
This procedure sets a descriptive name for users to apply to their Recovery Appliance. The name provided here will be seen in the RA_SERVER view. |
SHUTDOWN
|
Synonymous with |
SHUTDOWN_RECOVERY_APPLIANCE
|
This procedure performs a clean shutdown of the Recovery Appliance. |
STARTUP
|
Synonymous with |
STARTUP_RECOVERY_APPLIANCE
|
This procedure starts the Recovery Appliance after it has been shut down or terminated. |
UPDATE_DB
|
This procedure changes the attributes that are assigned to the specified protected database. |
UPDATE_POLLING_POLICY
|
This procedure modifies the parameters for an existing backup polling policy. |
UPDATE_PROTECTION_POLICY
|
This procedure modifies the parameters for an existing protection policy. |
UPDATE_REPLICATION_SERVER
|
This procedure changes the settings for a replication server configuration. |
UPDATE_SBT_ATTRIBUTE_SET
|
This procedure updates the parameters for the specified SBT attribute set. |
UPDATE_SBT_JOB_TEMPLATE
|
This procedure updates the parameters for the specified SBT job. |
UPDATE_SBT_LIBRARY
|
This procedure modifies the parameters for the specified SBT library. |
UPDATE_STORAGE_LOCATION
|
This procedure allocates additional space for the specified storage location. You cannot reduce the amount of space used by a storage location. |
ABORT_RECOVERY_APPLIANCE
This procedure shuts down the Recovery Appliance without waiting for in-progress operations to complete.
When you use this procedure, the Recovery Appliance terminates backup, restore, and background
operations (such as validations, data moves, and copy-to-tape jobs)
that have started but not completed.
When the Recovery Appliance restarts, it automatically resumes or restarts
backup operations. You must
manually restart any terminated backup and restore operations. To perform a
clean shutdown, use
.
SHUTDOWN_RECOVERY_APPLIANCE
Syntax
PROCEDURE abort_recovery_appliance;
ADD_DB
This procedure adds the specified database to the Recovery Appliance, and assigns a protection policy to the database. This procedure enables a non-protected database to attain the status of a protected database.
Enrolling a database with the Recovery Appliance involves:
adding the protected database with ADD_DB
.
granting access to this database to a Recovery Appliance user account
(
).
GRANT_DB_ACCESS
registering this database in the virtual private catalog
(RMAN REGISTER DATABASE
command).
The protected database must be enrolled before Recovery Appliance can process backup and restore operations.
You cannot use this procedure to add additional databases in a physical standby configuration. Such databases will be automatically recognized as they perform recovery catalog resynchronizations.
Syntax
PROCEDURE add_db ( db_unique_name IN VARCHAR2, protection_policy_name IN VARCHAR2, reserved_space IN VARCHAR2);
Parameters
Table 13-2 ADD_DB Parameters
Parameter | Description |
---|---|
|
The |
|
The name of the protection policy to assign to the database. The protection policy must exist. |
|
The amount of disk space that is guaranteed to be available for the protected database. The format of this value is a character string that must contain
a number consisting only of the characters
If no unit is specified, then Recovery Appliance interprets the value as a number of bytes. |
ADD_REPLICATION_SERVER
This procedure 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.
Syntax
PROCEDURE 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);
Parameters
Table 13-3 ADD_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the replication server configuration to associate with the protection policy. |
|
The name of the protection policy to associate with the replication server configuration. |
|
If set to |
|
The setting that controls replication behavior to a downstream Recovery Appliance. If If |
|
When adding a replication server to a protection polity with If |
CONFIG
This procedure updates a value in the config
table.
Do not perform parameter changes unless so instructed by Oracle Support for ZDLRA.
Syntax
PROCEDURE config( p_name VARCHAR2, p_value VARCHAR2);
Parameters
Table 13-4 CONFIG Parameters
Parameter | Description |
---|---|
|
The parameter to update. Possible parameters are:
The frequency with which the Recovery Appliance runs the metadata consistency check in the background. The default frequency is 3 days.
The frequency with which the Recovery Appliance performs crosschecks of the recovery catalog to reflect actions in tape libraries or downstream Recovery Appliances. The default frequency is 1 day.
The frequency with which the Recovery Appliance performs background re-ordering of blocks in the delta store to reduce disk reads required for restore operations. The default frequency is 7 days.
The frequency with which the Recovery Appliance performs background validation of backup pieces. The default frequency is 7 days.
The percent threshold at which the Recovery Appliance posts warnings for incomplete
background operations.
For example, if
The message size that the Recovery Appliance uses for transferring backups between itself and protected databases. It is also used for replication. The default is 128 MB. All protected databases use this value to determine the unit size in which to send or read backups. For example, if a protected database backup is 1 TB, then the SBT library sends the backup data
to the Recovery Appliance in units of |
|
The new value for the parameter. |
COPY_BACKUP
This procedure copies one or more backup pieces from the Recovery Appliance to a SBT destination. The Recovery Appliance copies all backup pieces matching the specified tag to the location specified with the format
and template_name
parameters.
Syntax
PROCEDURE copy_backup ( tag IN VARCHAR2, format IN VARCHAR2, template_name IN VARCHAR2, compression_algorithm IN VARCHAR2 DEFAULT NULL, encryption_algorithm IN VARCHAR2 DEFAULT NULL);
Parameters
Table 13-5 COPY_BACKUP Parameters
Parameter | Description |
---|---|
|
The tag of the backups to copy. The Recovery Appliance copies all backups matching this tag. |
|
The naming format of the backup pieces to create.
This parameter follows the same rules as the RMAN If not specified, default format is |
|
The name of the SBT job library template. The Recovery Appliance copies the backup piece to tape (or cloud), using the media pool referenced in the SBT template name as the copy destination. |
|
Specifies the compression algorithm.
If
|
|
Specifies the encryption algorithm If Valid value are 'AES128', 'AES192', 'AES256', 'OFF' or the constant equivalents ENC_OFF, ENC_AES128, ENC_AES192, ENC_AES256. |
COPY_BACKUP_PIECE
This procedure copies a single backup piece from the Recovery Appliance to a SBT destination.
Syntax
PROCEDURE 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);
Parameters
Table 13-6 COPY_BACKUP_PIECE Parameters
Parameter | Description |
---|---|
|
The unique key of the backup piece to copy. Obtain this key
from the |
|
The naming format of the backup piece to create.
This parameter follows the same rules as the RMAN If not specified, default format is |
|
The name of the SBT job library template. The Recovery Appliance copies the backup piece to tape, using the media pool referenced in the SBT template name as the copy destination. |
|
Specifies the compression algorithm.
If
|
|
Specifies the encryption algorithm If Valid value are 'AES128', 'AES192', 'AES256', 'OFF' or the constant equivalents ENC_OFF, ENC_AES128, ENC_AES192, ENC_AES256 |
CREATE_POLLING_POLICY
This procedure creates a backup polling policy.
A backup polling policy specifies a directory where a protected database places incoming backups or archived redo log files. The policy also specifies the frequency with which the Recovery Appliance looks for backups in the polling location.
When the Recovery Appliance discovers a file through polling, the Recovery Appliance examines the file, and then uses its contents to associate it with a protected database that is registered with the Recovery Appliance. If the Recovery Appliance cannot associate the file with any registered protected database, then the Recovery Appliance logs a warning message and ceases to process the file.
Syntax
PROCEDURE 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);
Parameters
Table 13-7 CREATE_POLLING_POLICY Parameters
Parameter | Description |
---|---|
|
The user-assigned name of the polling policy. |
|
The directory that the Recovery Appliance periodically examines for new backups. Do not specify this directory name in multiple polling policies. |
|
The frequency with which the Recovery Appliance examines the specified directory for new backups. System load may cause backup polling to occur less frequently. Specify the window as any valid |
|
The setting that controls deletion behavior. If |
CREATE_PROTECTION_POLICY
This procedure creates a protection policy.
Syntax
PROCEDURE 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');
Parameters
Table 13-8 CREATE_PROTECTION_POLICY Parameters
Parameter | Description |
---|---|
|
The user-assigned name of the protection policy. |
|
An optional description of the usage for the policy. |
|
The name of the storage location. The Recovery Appliance uses this location for actively received incoming backups, and for newly created backup files for all databases sharing this protection policy. |
|
The name of the backup polling policy. The polling policy specifies the rules for how the Recovery Appliance polls for backups of protected databases that use this protection policy. If null, then no backup polling occurs for databases that use this protection policy. |
|
The recovery window goal for databases that use this protection policy. For each protected database, the Recovery Appliance attempts to ensure that the oldest backup on disk can support a point-in-time recovery to any time within the specified interval, counting backward from the current time. Specify the goal as any valid |
|
The maximum length of time that the Recovery Appliance must retain backups for databases that use this protection policy. Recovery Appliance only holds backups longer than the specified period when they are required to preserve the recovery window goal for a database. If null, then the Recovery Appliance does not purge backups unless caused by explicit user actions or space pressures within a storage location. |
|
The recovery window for SBT backups of databases that use this protection policy. For each protected database, the Recovery Appliance keeps backups long enough on tape to guarantee that a recovery is possible to any time within the specified interval, counting backward from the current time. If this parameter is not null, then you must also create an
SBT job for this protection policy, and then schedule it using a
scheduling facility such as Oracle Scheduler.
See If this parameter is null, the purge backup automatically is never run and backups are kept beyond their expiration date. Specify the window as any valid |
|
The maximum amount of data loss that is tolerable
for databases using this protection policy.
When a protected database exceeds the specified amount of data loss,
the Recovery Appliance posts a warning to Specify the window as any valid |
|
The setting of the guaranteed copy feature. Specifying
Specifying If set to |
|
Setting this to
|
|
The setting for the Backup and Redo Failover feature. This setting is used only in a protection policy defined on the alternate Recovery Appliance where the protected databases associated with this policy will redirect backups and redo in the event of an outage on the primary Recovery Appliance.
Refer to "Managing Temporary Outages with a Backup and Redo Failover Strategy" for more information. |
|
The setting for the archivelog compression feature. This setting is used to adjust the compression level of NZDL/polled archivelog backups.
Advanced Compression Option (ACO) license is not required on the protected database for use of LOW, MEDIUM, and HIGH log compression settings. For more details on log compression usage, see ZDLRA: Changes in the Protection Policy Compression Algorithms (Doc ID 2654539.1). |
CREATE_REPLICATION_SERVER
This procedure defines a configuration for a downstream Recovery Appliance that forms part of a Recovery Appliance replication scheme.
This procedure creates metadata for the downstream
Recovery Appliance, but does not replicate any backups.
Use the
procedure to
link the downstream Recovery Appliance to one or more protection policies, so
that the Recovery Appliance sends backups for protected databases assigned to these policies
to the downstream Recovery Appliance.
ADD_REPLICATION_SERVER
Syntax
PROCEDURE 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);
Parameters
Table 13-9 CREATE_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The user-assigned name of the downstream Recovery Appliance. This value is converted to upper-case before storing. |
|
The name and path to the Recovery Appliance Backup Module. The module is an Oracle-supplied media library that simulates an SBT device. The Recovery Appliance uses this library to communicate with the downstream Recovery Appliance. |
|
The name and path of a client configuration file in the form
The following shows the sample contents of a client configuration file:
|
|
The maximum number of simultaneous replication tasks. If null, which is the recommended setting, then the upstream Recovery Appliance determines the number of streams to use for replication based on the number of its nodes. |
|
Ignored. Automatically populated with the Recovery Appliance Catalog Owner. |
|
The alias that identifies the credential within the wallet that the upstream Recovery Appliances uses to authenticate with the downstream Recovery Appliance. |
|
The path to the local Oracle wallet (excluding the wallet file name).
Path must start with |
|
The URL of any required proxy server, in the format host. |
|
The port number of the proxy server. |
|
The HTTP timeout interval, in seconds. Usually you leave this parameter set to null, to accept the system default HTTP timeout, unless directed to set it to a different value by Oracle Support. |
CREATE_SBT_ATTRIBUTE_SET
This procedure creates an SBT attribute set that SBT jobs can use.
An SBT attribute set provides a grouping of attributes that control the execution of an SBT job. These attributes enable you to specify settings for the media management library, including destination media pool or media family. You can define multiple SBT attribute sets. Multiple jobs can reference a single attribute set.
Syntax
PROCEDURE 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);
Parameters
Table 13-10 CREATE_SBT_ATTRIBUTE_SET Parameters
Parameter | Description |
---|---|
|
The name of the SBT library to associate with the attribute set. |
|
User-assigned name of the attribute set. Attribute set names must be unique. |
|
The maximum number of concurrent streams that the Recovery Appliance
uses for automated backups. The number of concurrent
streams never exceeds the limits set by the |
|
The media pool number to use as the destination for backup copies.
This parameter accepts a value in the same format as the |
|
The media management library-specific parameter string for the backup
copy operation. The string has the same format as the |
|
The string that the Recovery Appliance uses to send additional
media management library-specific parameters for
the backup copy operation. The string has the same format as the
|
CREATE_SBT_JOB_TEMPLATE
This procedure creates an SBT job that describes how the Recovery Appliance chooses backups for copying to tape/cloud. This form of this overloaded procedure applies to backups for all protected databases assigned to the specified protection policy.
After you create an SBT backup job, you must schedule it with a
scheduling facility such as Oracle Scheduler.
See
.
QUEUE_SBT_BACKUP_TASK
Syntax
PROCEDURE 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);
Parameters
Table 13-11 CREATE_SBT_JOB_TEMPLATE Parameters
Parameter | Description |
---|---|
|
The user-assigned name of this SBT job template. |
|
The name of the protection policy to which this SBT job applies. Backups for all protected databases assigned to this protection policy are eligible for copying. |
|
The name of the SBT attribute set to use for this SBT job. |
|
The types of backups that this SBT job chooses for copying to tape. The string must be a comma-separated list of the following types:
|
|
The full name of this SBT job template. This applies only to |
|
The tag name. If specified, then the Recovery Appliance only considers backups using this tag for copying to tape. Refer to "Oracle Database Backup and Recovery Reference" for the correct format of the TAG string. |
|
The priority of this job for tape resource usage. Lower priority values
take precedence over higher values.
The default priority is |
|
The number of distinct copies of each backup that this SBT job
creates. Valid values range from |
|
The window of time in which this job can copy backups to tape. Copy tasks that are not able to start within the specified window must wait until the next scheduled job execution. |
|
Specifies the compression algorithm.
If
|
|
Encryption algorithm to use for tape jobs. Valid value are 'AES128', 'AES192', 'AES256', 'OFF', or the constant equivalents ENC_OFF, ENC_AES128, ENC_AES192, ENC_AES256 |
CREATE_SBT_JOB_TEMPLATE
This procedure creates a new SBT backup job. The job describes how the Recovery Appliance chooses backups for copying to tape/cloud. This form of this overloaded procedure applies to backups for a single protected database only, whereas the previous form applies to backups of all databases assigned to a specific protection policy. With the exception of this difference, this procedure and its parameters are identical to the alternative form of this procedure.
Syntax
PROCEDURE 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);
Parameters
Table 13-12 CREATE_SBT_JOB_TEMPLATE Parameters
Parameter | Description |
---|---|
|
The |
CREATE_SBT_LIBRARY
This procedure creates metadata describing an installed media management software library. The Recovery Appliance uses the specified library to copy backups from internal storage either to tape or to other tertiary storage supported by this media manager.
Syntax
PROCEDURE 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);
Parameters
Table 13-13 CREATE_SBT_LIBRARY Parameters
Parameter | Description |
---|---|
|
The user-specified name that the Recovery Appliance uses to refer to this SBT library. |
|
The maximum number of tape drives that this SBT library can access. The Recovery Appliance never uses more than the specified number of concurrent streams when accessing this library. |
|
The number of tape drives that the Recovery Appliance reserves for restore operations. If specified, then the Recovery Appliance uses a maximum of
If not specified, then the Recovery Appliance can use all available drives for backups, which means that a restore operation might have to wait for a drive to become free. |
|
The library-specific parameter string that the Recovery Appliance uses to access
this SBT library. This string has the same format as the |
|
The parameter string that the Recovery Appliance uses
to send additional library-specific parameters to this
SBT library. This string has the same format as the |
CREATE_STORAGE_LOCATION
This procedure creates Recovery Appliance storage location, which is an object that describes storage to be used by the Recovery Appliance. Recovery Appliance stores all backups in named storage locations.
The Recovery Appliance allocates storage locations from the Oracle ASM disk groups that reside in the Recovery Appliance.
The newly created storage location does not store any files until you use a protection policy to associate the location with a protected database.
Syntax
PROCEDURE create_storage_location ( storage_location_name IN VARCHAR2, storage_location_dests IN VARCHAR2);
Parameters
Table 13-14 CREATE_STORAGE_LOCATION Parameters
Parameter | Description |
---|---|
|
The user-assigned name of this storage location. |
|
A comma-delimited list of Oracle ASM disk groups from which space is to be allocated for this storage location. The disk groups must exist. The specified disk groups must have the same allocation unit size. This parameter accepts a string in the following format: storage_location_spec Each storage_location_spec has the following format: storage_location_name storage_location_name is the name of an Oracle ASM disk group. Optionally, you can follow the disk group name with the amount of space to be allocated from this disk group for this storage location. If no size is specified, then the Recovery Appliance allocates all of the free space in the disk group to this storage location. |
DELETE_DB
This procedure removes the specified protected database from the Recovery Appliance. The Recovery Appliance deletes all metadata and backups associated with this database, both from disk and SBT. Backups on tape are not affected. Regarding replicated and cloud pieces: the meta data is deleted from the Recovery Appliance doing the delete, but the data is not deleted from the downstream or cloud storage.
If the Recovery Appliance cannot delete the SBT backups owned by this database because of
errors, then the DELETE_DB
operation fails.
If SBT errors occur, then
the specified database is not completely removed from the Recovery Appliance.
The Recovery Appliance logs errors that occur during
the DELETE_DB
procedure in the RA_INCIDENT_LOG
view.
If the wait
parameter is specified as TRUE
, then the Recovery Appliance
also raises these errors in the session in which DELETE_DB
is called.
If you diagnose the SBT errors and fix the problem, then you can run
DELETE_DB
again.
Syntax
PROCEDURE delete_db ( db_unique_name IN VARCHAR2, wait IN BOOLEAN DEFAULT TRUE);
Parameters
Table 13-15 DELETE_DB Parameters
Parameter | Description |
---|---|
|
The |
|
The wait behavior of the procedure. If |
DELETE_POLLING_POLICY
This procedure deletes the specified backup polling policy.
Syntax
PROCEDURE delete_polling_policy ( polling_policy_name IN VARCHAR2);
Parameters
Table 13-16 DELETE_POLLING_POLICY Parameters
Parameter | Description |
---|---|
|
The name of the backup polling policy to delete. |
DELETE_PROTECTION_POLICY
This procedure deletes the specified protection policy.
The specified policy must not be associated with any database.
Syntax
PROCEDURE delete_protection_policy ( protection_policy_name IN VARCHAR2);
Parameters
Table 13-17 DELETE_PROTECTION_POLICY Parameters
Parameter | Description |
---|---|
|
The name of the protection policy to delete. |
DELETE_REPLICATION_SERVER
This procedure deletes a replication server configuration. The Recovery Appliance removes all metadata relating to the downstream Recovery Appliance.
Syntax
PROCEDURE delete_replication_server ( replication_server_name IN VARCHAR2, force IN BOOLEAN DEFAULT FALSE);
Parameters
Table 13-18 DELETE_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the replication server configuration to delete. |
|
The deletion behavior when a protection policy is associated with the configuration.
If |
DELETE_SBT_ATTRIBUTE_SET
This procedure deletes the specified SBT attribute set.
Syntax
PROCEDURE delete_sbt_attribute_set( attribute_set_name IN VARCHAR2);
Parameters
Table 13-19 DELETE_SBT_ATTRIBUTE_SET Parameters
Parameter | Description |
---|---|
|
The name of the SBT attribute set to delete. |
DELETE_SBT_JOB_TEMPLATE
This procedure deletes the specified SBT job template.
Syntax
PROCEDURE delete_sbt_job_template ( template_name IN VARCHAR2);
Parameters
Table 13-20 DELETE_SBT_JOB_TEMPLATE Parameters
Parameter | Description |
---|---|
|
The name of the SBT job to delete. The Recovery Appliance removes tasks belonging to this job from the task queue but does not terminate any executing task. |
DELETE_SBT_LIBRARY
This procedure deletes the metadata describing the specified SBT library.
The Recovery Appliance only removes the SBT library object, and does not uninstall the media management software.
This procedure deletes any SBT jobs and attributes created for this SBT library.
Syntax
PROCEDURE delete_sbt_library ( lib_name IN VARCHAR2);
Parameters
Table 13-21 DELETE_SBT_LIBRARY Parameters
Parameter | Description |
---|---|
|
The name of the SBT library to delete. |
DELETE_STORAGE_LOCATION
This procedure deletes the specified Recovery Appliance storage location.
The specified storage location must be empty and must not be associated with any protection policy. No storage movement may be in progress for this storage location. If any storage movement is in progress, or if any files exist in this storage location, then this procedure fails with an error.
Syntax
PROCEDURE delete_storage_location ( storage_location_name IN VARCHAR2);
Parameters
Table 13-22 DELETE_STORAGE_LOCATION Parameters
Parameter | Description |
---|---|
|
The name of the Recovery Appliance storage location to delete. |
ESTIMATE_SPACE
This procedure estimates the amount of storage in GB required for recovery of a given database and a desired recovery window.
Syntax
FUNCTION estimate_space ( db_unique_name IN VARCHAR2, target_window IN DSINTERVAL_UNCONSTRAINED) RETURN NUMBER;
Parameters
Table 13-23 ESTIMATE_SPACE Parameters
Parameter | Description |
---|---|
|
The name of the database needing the storage estimate. |
|
The desired recovery window for the database.
Specify the goal as any valid |
GRANT_DB_ACCESS
This procedure grants the necessary privileges to the specified recovery Appliance user account to enable this account to back up, restore, and access recovery catalog metadata for the specified protected database.
Syntax
PROCEDURE grant_db_access ( username IN VARCHAR2, db_unique_name IN VARCHAR2);
Parameters
Table 13-24 GRANT_DB_ACCESS Parameters
Parameter | Description |
---|---|
|
The name of the Recovery Appliance user account. |
|
The protected database for which the privilege is being granted. |
KEY_REKEY
This procedure rekeys encryption keys for all databases with existing encryption keys.
Syntax
PROCEDURE key_rekey;
KEY_REKEY
This procedure rekeys encryption keys for the specified database with an existing encryption key.
Syntax
PROCEDURE key_rekey ( db_unique_name IN VARCHAR2);
Parameters
Table 13-25 KEY_REKEY Parameters
Parameter | Description |
---|---|
|
The |
KEY_REKEY
This procedure rekeys encryption keys for all databases with existing encryption keys in the specified protection_policy
Syntax
PROCEDURE key_rekey ( protection_policy_name IN VARCHAR2);
Parameters
Table 13-26 KEY_REKEY Parameters
Parameter | Description |
---|---|
|
Generate new encryption keys for databases that are part of this protection policy. |
MIGRATE_TAPE_BACKUP
This procedure makes pre-migration tape backups
accessible to the Recovery Appliance through the specified SBT
library. You must first import metadata about the tape backups
into the Recovery Appliance catalog using the RMAN
IMPORT CATALOG
command.
This procedure performs the metadata adjustments required to access pre-existing tape backups, but does not physically move backups. The pre-existing backups must already be accessible by the specified SBT library.
Syntax
PROCEDURE migrate_tape_backup( db_unique_name IN VARCHAR2, sbt_lib_name IN VARCHAR2);
Parameters
Table 13-27 MIGRATE_TAPE_BACKUP Parameters
Parameter | Description |
---|---|
|
The comma-delimited list of protected databases whose backups
are to be migrated. You must already have registered each |
|
The SBT library that the Recovery Appliance uses to access existing tape backups
for the specified protected database. See |
MOVE_BACKUP
This procedure moves one or more long-term archival backup pieces from the Recovery Appliance to an SBT destination.
The Recovery Appliance copies all backup pieces matching the specified tag to the
location specified with the format
and template_name
parameters.
After the Recovery Appliance copies each backup piece successfully, the Recovery Appliance
deletes the backup piece from its original location.
Syntax
PROCEDURE move_backup ( tag IN VARCHAR2, format IN VARCHAR2, template_name IN VARCHAR2, compression_algorithm IN VARCHAR2 DEFAULT NULL, encryption_algorithm IN VARCHAR2 DEFAULT NULL);
Parameters
Table 13-28 MOVE_BACKUP Parameters
Parameter | Description |
---|---|
|
The tag of backups to copy. The Recovery Appliance removes all backups matching this tag. |
|
The naming format of the backup pieces to create.
This parameter follows the same rules as the RMAN If not specified, default format is |
|
The name of the SBT job library template. The Recovery Appliance copies the backup piece to tape (or cloud), using the media pool referenced in the SBT template name as the copy destination. |
|
Specifies the compression algorithm If
|
|
Specifies the encryption algorithm If Valid value are 'AES128', 'AES192', 'AES256', 'OFF' or the constant equivalents ENC_OFF, ENC_AES128, ENC_AES192, ENC_AES256 |
MOVE_BACKUP_PIECE
This procedure moves a single long-term archival backup piece from the Recovery Appliance to an SBT destination.
The Recovery Appliance copies the specified backup piece to the
location specified with the format
and template_name
parameters.
After the Recovery Appliance copies the backup piece successfully, the Recovery Appliance
deletes the backup piece from its original location.
Syntax
PROCEDURE 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);
Parameters
Table 13-29 MOVE_BACKUP_PIECE Parameters
Parameter | Description |
---|---|
|
The unique key of the backup piece to move. Obtain this key
from the |
|
The naming format of the backup pieces to create.
This parameter follows the same rules as the RMAN If not specified, default format is |
|
The name of the SBT job library template. The Recovery Appliance copies the backup piece to tape, using the media pool referenced in the SBT template name as the copy destination. |
|
Specifies the compression algorithm.
If
|
|
Specifies the encryption algorithm If Valid value are 'AES128', 'AES192', 'AES256', 'OFF' or the constant equivalents ENC_OFF, ENC_AES128, ENC_AES192, ENC_AES256 |
PAUSE_REPLICATION_SERVER
This procedure pauses replication to the specified downstream Recovery Appliance.
The Recovery Appliance permits in-progress replication of backup pieces to complete.
If the Recovery Appliance queued backup pieces for replication through this
replication server configuration but did not replicate them, then the Recovery Appliance
holds the backup pieces until you call
.
No replication tasks that
run against this Recovery Appliance can execute until you resume
replication to the downstream Recovery Appliance.
RESUME_REPLICATION_SERVER
Syntax
PROCEDURE pause_replication_server ( replication_server_name IN VARCHAR2);
Parameters
Table 13-30 PAUSE_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the downstream Recovery Appliance. |
PAUSE_SBT_LIBRARY
This procedure pauses the specified SBT library. The Recovery Appliance allows in-progress
copies of backup pieces to complete. However, if backup pieces were
queued for copy through this SBT library but not yet copied, then the Recovery Appliance
holds them until you resume the SBT library. No new SBT jobs that run
against this library can execute until you resume the library (
).
RESUME_SBT_LIBRARY
Query the RA_SBT_LIBRARY
view for a list of existing SBT libraries.
Syntax
PROCEDURE pause_sbt_library( lib_name IN VARCHAR2);
Parameters
Table 13-31 PAUSE_SBT_LIBRARY Parameters
Parameter | Description |
---|---|
|
Name of the SBT library to pause. |
POPULATE_BACKUP_PIECE
This procedure pushes the specified backup piece into the delta store.
Use this procedure to initially populate the delta store or to
correct corruption in the delta store. The delta store is backup
data that supports an incremental-forever backup solution.
Only incremental backups (not KEEP
backups) can become
part of the delta store.
Syntax
PROCEDURE populate_backup_piece( backup_piece_key IN NUMBER);
Parameters
Table 13-32 POPULATE_BACKUP_PIECE Parameters
Parameter | Description |
---|---|
|
Either the backup piece key provided by the Recovery Appliance when it detected a corruption,
or the backup piece to insert into the delta store. If
the key represents a virtual backup piece, then the Recovery Appliance
searches for a backup piece to resolve corruption in the delta store.
If the key does not represent a virtual backup, then the Recovery Appliance inserts this
backup piece into the delta store. This backup must be an incremental
backup that is not a |
QUEUE_SBT_BACKUP_TASK
This procedure queues the backup pieces selected by the specified SBT job template for copying to tape. Typically, a scheduling utility such as Oracle Scheduler calls this procedure.
Syntax
PROCEDURE queue_sbt_backup_task( template_name IN VARCHAR2, format IN VARCHAR2 DEFAULT NULL, autobackup_prefix IN VARCHAR2 DEFAULT NULL, tag IN VARCHAR2 DEFAULT NULL);
Parameters
Table 13-33 QUEUE_SBT_BACKUP_TASK Parameters
Parameter | Description |
---|---|
|
The name of the SBT job template that specifies the backup pieces to copy to tape. |
|
The naming format of the backup pieces to create. This parameter follows the same rules as the RMAN If not specified, default format is |
|
The original autobackup names will be prefixed with this autobackup_prefix. |
|
User specified tag for backups to be copied
See |
REMOVE_REPLICATION_SERVER
This procedure removes the specified replication server configuration from the specified protection policy. After the operation succeeds, the Recovery Appliance no longer replicates backups of databases protected by this policy to the downstream Recovery Appliance.
Syntax
PROCEDURE remove_replication_server ( replication_server_name IN VARCHAR2, protection_policy_name IN VARCHAR2);
Parameters
Table 13-34 REMOVE_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the replication server configuration to remove. |
|
The name of the protection policy from which the specified replication server configuration is to be removed. |
RENAME_DB
This procedure changes the name of the specified protected database in the Recovery Appliance metadata.
Use this procedure when the DB_UNIQUE_NAME
for a protected
database changes, so that the Recovery Appliance metadata reflects the
correct name.
Syntax
PROCEDURE rename_db ( db_unique_name_old IN VARCHAR2, db_unique_name_new IN VARCHAR2);
Parameters
Table 13-35 RENAME_DB Parameters
Parameter | Description |
---|---|
|
The |
|
The new |
RESET_ERROR
This procedure modifies the specified set of incident log entries to have
the status RESET
.
It takes multiple optional input parameters to allow bulk resetting of
errors. When two or more input parameters are specified in a single
RESET_ERROR call, only records that match all the
input parameters specified together are RESET.
Errors marked in this fashion do not cause Oracle Enterprise Manager
to raise alerts. If the Recovery Appliance determines that the
problem is still occurring, then errors that have been reset change to
ACTIVE
status.
The primary use of this API is to reset the error status for nonrecurring
errors, such as transient media failures.
Syntax
PROCEDURE reset_error( incident# NUMBER DEFAULT NULL, error_code NUMBER DEFAULT NULL, error_text VARCHAR2 DEFAULT NULL, task_id NUMBER DEFAULT NULL, component VARCHAR2 DEFAULT NULL, low_time TIMESTAMP WITH TIME ZONE DEFAULT NULL, high_time TIMESTAMP WITH TIME ZONE DEFAULT NULL);
Parameters
Table 13-36 RESET_ERROR Parameters
Parameter | Description |
---|---|
|
The unique identifier of the incident log entry to reset. |
|
The error code of the incident log entry to reset. |
|
The text of the error message that completely or partially matches the incident log entry to reset. |
|
The identifier for the task of the incident log entry to reset. |
|
The component of the incident log entry to reset. |
|
|
|
The low and high time with respect to last_seen column of the incident log entry to reset. If only one of them or neither of them are provided then the default values are used. The default value for low_time is the year 2000. The default value for high_time is systimestamp. Obtain the identifiers from the |
RESUME_REPLICATION_SERVER
This procedure resumes replication to the specified downstream Recovery Appliance, after a
previous call to
.
PAUSE_REPLICATION_SERVER
Syntax
PROCEDURE resume_replication_server ( replication_server_name IN VARCHAR2);
Parameters
Table 13-37 RESUME_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the downstream Recovery Appliance. |
RESUME_SBT_LIBRARY
This procedure resumes a paused SBT library.
Query the RA_SBT_LIBRARY
to determine which SBT libraries
are paused (see
).
PAUSE_SBT_LIBRARY
Syntax
PROCEDURE resume_sbt_library( lib_name IN VARCHAR2);
Parameters
Table 13-38 RESUME_SBT_LIBRARY Parameters
Parameter | Description |
---|---|
|
Name of the SBT library to resume. |
REVOKE_DB_ACCESS
This procedure revokes privileges on one protected database from the specified Recovery Appliance user account.
Syntax
PROCEDURE revoke_db_access ( username IN VARCHAR2, db_unique_name IN VARCHAR2);
Parameters
Table 13-39 REVOKE_DB_ACCESS Parameters
Parameter | Description |
---|---|
|
The name of the user account from which to revoke the privilege. |
|
The protected database for which the privilege is being revoked. |
SET_SYSTEM_DESCRIPTION
This procedure sets a descriptive name for users to apply to their Recovery Appliance. The name provided here will be seen in the RA_SERVER view.
Syntax
PROCEDURE set_system_description( sys_desc VARCHAR2);
Parameters
Table 13-40 SET_SYSTEM_DESCRIPTION Parameters
Parameter | Description |
---|---|
|
A descriptive name for this Recovery Applicance. |
SHUTDOWN_RECOVERY_APPLIANCE
This procedure performs a clean shutdown of the Recovery Appliance.
This procedure permits in-progress operations to complete before shutting down.
The shutdown can take some time.
If an immediate shutdown is required,
then use
.
ABORT_RECOVERY_APPLIANCE
Syntax
PROCEDURE shutdown_recovery_appliance;
STARTUP_RECOVERY_APPLIANCE
This procedure starts the Recovery Appliance after it has been shut down or terminated.
The Recovery Appliance can process backup and restore requests only when it is started.
If the Recovery Appliance was started with
, and if
any instance of the Recovery Appliance metadata database
is restarted, then a database startup trigger automatically restarts the
Recovery Appliance. The only exception is when the metadata database
is restarted with the STARTUP_RECOVERY_APPLIANCE
RESETLOGS
option,
which requires you to run the startup_recovery_appliance
procedure
to repair corrupt metadata.
Syntax
PROCEDURE startup_recovery_appliance;
UPDATE_DB
This procedure changes the attributes that are assigned to the specified protected database.
Syntax
PROCEDURE 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');
Parameters
Table 13-41 UPDATE_DB Parameters
Parameter | Description |
---|---|
|
The |
|
The name of the protection policy to assign to the database. The protection policy must exist. The new protection policy controls new storage operations. If the old and new protection policies specify different storage locations, the Recovery Appliance starts a background task to move data from the old storage location to the new location. Recovery Appliance only moves backups that are not obsolete. If a move between storage locations is required, then the
If the Recovery Appliance must perform higher priority work, then the Recovery Appliance may not start the move for several hours. |
|
See |
|
The time zone where this database is located. By default, protected databases are assigned to the same time zone as the Recovery Appliance. If the protected database is in a different time zone, then use this procedure to assign the database to the correct time zone. |
|
Comma-delimited list of keys for all previous database incarnations to
update. By default, this procedure updates the current incarnation. If this list
contains the current incarnation key, then the procedure updates the row corresponding to
the current incarnation in the |
UPDATE_POLLING_POLICY
This procedure modifies the parameters for an existing backup polling policy.
Parameters that are NULL retain their existing values.
Syntax
PROCEDURE 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);
Parameters
Table 13-42 UPDATE_POLLING_POLICY Parameters
Parameter | Description |
---|---|
|
The name of the backup polling policy to update. |
|
|
|
|
|
UPDATE_PROTECTION_POLICY
This procedure modifies the parameters for an existing protection policy.
If a parameter is NULL, its value remains unchanged, except as noted below.
Syntax
PROCEDURE 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 DEFAULT dbms_ra_misc.varchar2null('p1'), recovery_window_goal IN DSINTERVAL_UNCONSTRAINED DEFAULT NULL, max_retention_window IN DSINTERVAL_UNCONSTRAINED DEFAULT dbms_ra_misc.intervalnull('p3'), recovery_window_sbt IN DSINTERVAL_UNCONSTRAINED DEFAULT dbms_ra_misc.intervalnull('p2'), unprotected_window IN DSINTERVAL_UNCONSTRAINED DEFAULT dbms_ra_misc.intervalnull('p4'), 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);
Parameters
Table 13-43 UPDATE_PROTECTION_POLICY Parameters
Parameter | Description |
---|---|
|
The name of the protection policy to update. |
|
|
|
If you change the storage location for this protection policy, then the Recovery Appliance starts background jobs to move data from the old storage location to the new storage location. |
|
If you do not specify this parameter, then the policy retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
|
|
If this parameter is not specified, its old value is retained. If specified, including being specified as NULL, the new value is set. |
|
If you do not specify this parameter, then the policy retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
If you do not specify this parameter, then the policy retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
|
|
|
|
|
|
UPDATE_REPLICATION_SERVER
This procedure changes the settings for a replication server configuration.
Note the following restrictions for changing replication server parameters:
The configuration does not retain the sbt_parms
string from
the original
call.
If you change any parameter other than CREATE_REPLICATION_SERVER
max_streams
, then you must pass in
this value.
Changing any setting other than max_streams
requires
replication to be paused, which you can achieve by
calling
.
PAUSE_REPLICATION_SERVER
Parameters other than sbt_parms
whose values are null
remain unchanged, except as noted in the following parameter descriptions.
Syntax
PROCEDURE 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 DEFAULT dbms_ra_misc.number2null('p4'), catalog_user_name IN VARCHAR2 DEFAULT NULL, wallet_alias IN VARCHAR2 DEFAULT NULL, wallet_path IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p1'), proxy_url IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p2'), proxy_port IN NUMBER DEFAULT dbms_ra_misc.number2null('p3'), http_timeout IN NUMBER DEFAULT NULL);
Parameters
Table 13-44 UPDATE_REPLICATION_SERVER Parameters
Parameter | Description |
---|---|
|
The name of the replication server configuration to update. This value is converted to upper-case before storing. |
|
|
|
|
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
|
|
|
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value.
If you specify a value (including null), then the Recovery Appliance sets the new value.
Path must start with |
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
UPDATE_SBT_ATTRIBUTE_SET
This procedure updates the parameters for the specified SBT attribute set.
If a parameter is null, then its value remains unchanged, except as noted in the following parameter descriptions.
Syntax
PROCEDURE update_sbt_attribute_set( attribute_set_name IN VARCHAR2, streams IN NUMBER DEFAULT dbms_ra_misc.number2null('p1'), poolid IN NUMBER DEFAULT NULL, parms IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p2'), send IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p3'));
Parameters
Table 13-45 UPDATE_SBT_ATTRIBUTE_SET Parameters
Parameter | Description |
---|---|
|
The name of the SBT attribute set to update. |
|
If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
|
|
If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
UPDATE_SBT_JOB_TEMPLATE
This procedure updates the parameters for the specified SBT job.
If a parameter is null, then its value remains unchanged, except as noted in the following parameter descriptions.
Syntax
PROCEDURE 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 DEFAULT dbms_ra_misc.varchar2null('p1'), priority IN NUMBER DEFAULT NULL, copies IN NUMBER DEFAULT NULL, window IN DSINTERVAL_UNCONSTRAINED DEFAULT dbms_ra_misc.intervalnull('p2'), compression_algorithm IN VARCHAR2 DEFAULT NULL, encryption_algorithm IN VARCHAR2 DEFAULT NULL);
Parameters
Table 13-46 UPDATE_SBT_JOB_TEMPLATE Parameters
Parameter | Description |
---|---|
|
The name of the SBT job template to update. |
|
|
|
|
|
If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
|
|
|
|
If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
If a value is specified, it becomes the new setting. Specify If you do not specify this parameter or if you specify |
|
UPDATE_SBT_LIBRARY
This procedure modifies the parameters for the specified SBT library.
If a parameter is null, then its value remains unchanged, except as
noted in the parms
and send
descriptions.
Syntax
PROCEDURE update_sbt_library ( lib_name IN VARCHAR2, drives IN NUMBER DEFAULT NULL, restore_drives IN NUMBER DEFAULT NULL, parms IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p1'), send IN VARCHAR2 DEFAULT dbms_ra_misc.varchar2null('p2'));
Parameters
Table 13-47 UPDATE_SBT_LIBRARY Parameters
Parameter | Description |
---|---|
|
The name of the SBT library whose parameters are to be modified. |
|
See |
|
See |
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
|
See If you do not specify this parameter, then the Recovery Appliance retains the existing value. If you specify a value (including null), then the Recovery Appliance sets the new value. |
UPDATE_STORAGE_LOCATION
This procedure allocates additional space for the specified storage location. You cannot reduce the amount of space used by a storage location.
Syntax
PROCEDURE update_storage_location ( storage_location_name IN VARCHAR2, storage_location_dests IN VARCHAR2 DEFAULT NULL);
Parameters
Table 13-48 UPDATE_STORAGE_LOCATION Parameters
Parameter | Description |
---|---|
|
The name of the storage location to update. |
|
This parameter accepts a string in the same format as the corresponding
parameter to For each disk group specified in the Any new disk groups that you add to this storage location must have the same allocation unit size as the disk groups already allocated to this storage location. All existing disk groups that were previously added to this storage location remain allocated to this location, even if you do not explicitly specify them while running this procedure. In addition to processing any change to storage destinations, this procedure reexamines any disk groups specified without an explicit size when the storage location was previously created or updated. If additional free space is available in any of the reexamined disk groups, then the Recovery Appliance allocates this space to the storage location. |