config backup

Configure Sharded Database (SDB) Backup

Syntax

config backup -rccatalog rc_connstr 
              [-target (PRIMARY|STANDBY)] 
              [(-destination (ALL|CATALOG| <shard_list>):<deviceconfig>:<channelconfig>)+]
              [-frequency #level0_days|[#level0_days]:[#level1-days]]
              [-incremental (DIFFERENTIAL|CUMULATIVE)]
              [-retention #recovery_window_days]
              [-cdb sc_cdb_connstr] [-catpwd password]
              [-shard shard_list] [-async]
              [-encryption encryption][-REMOVE]

Options

Table 2-19 GDSCTL config backup Options

Option	Description
`-rccatalog rc_connstr`	A connection string to the recovery catalog database.
`-target (PRIMARY\|STANDBY)`	For shards in Data Guard configurations, database backup can be done at the primary or the standby. The default is the standby. The value for this option is either `PRIMARY` or `STANDBY`.
`-destination {ALL\|CATALOG\| shard_list:deviceconfig:channelconfig}`	Definition of device types and channels for target databases. It consists of three components: `shard-list`, `deviceconfig` and `channelconfig`. shard-list: specifies a comma separated list of shard identifiers. They can be shard space, shard group or shard names. deviceconfig: configures a device type for the prefixed target databases. It must be a valid device type configuration statement for RMAN. channelconfig: configures a channel for the prefixed target databases. It must be a valid channel configuration statement for RMAN.
`-starttime ALL\|CATALOG\|shard_list:hh:mm`	Backup start time for individual shards and the sharded database (SDB) catalog database. It must be a local time in a day in the time zone where the target database is located and specified in 24-hour format. The smallest unit for the time is minute. For example, `CATALOG:22:30` specifies that the scheduled backup for the SDB catalog database should be started at 10:30 PM. The default backup start time for a target database is the midnight (00:00). Internally the start time is converted into a UTC time before it’s passed to DBMS Scheduler to be set as the job start time
`-frequency #level0_days\|#level0_days:#level1_days`	Backup repeat intervals for incremental level 0 and level 1 backups in days. The first number is the interval for incremental level 0 backups and the second is that for level 1 backups. If a single number is specified without a following comma, it defines the interval for level 0 backups. If a comma appears in the parameter, then the number to its left is the backup interval for level 0 backups and that to its right is the interval for level 1 backups, but both numbers are optional in this case. The default intervals for level 0 and level 1 backups are respectively 7 and 1 day.
`-incremental DIFFERENTIAL\|CUMULATIVE`	Incremental level 1 backup type to either `DIFFERENTIAL` or `CUMULATIVE`. The default is `DIFFERENTIAL`.
`-retention #recovery_window_days`	A recovery window for backup files. It must be a positive integer and specified in days. The default is 30 days.
`-cdb sc_cdb_connstr`	Required if the SDB catalog database is a PDB. It specifies a connect string for the container database of the SDB catalog database.
`-catpwd password`	Password for user GSMCATUSER. Prompted if not specified. This password only needs to be specified once for this command in an entire GDSCTL session.
`-shard shard_list`	shard_list specifies a comma separated list of shard identifiers. They can be shard space, shard group or shard names. If the same name is used for a shard space, shard group or shard, shard space takes the highest precedence followed by shard group and then shard. There are two special words for this option: `ALL` and `CATALOG`. `ALL` represents the SDB catalog database and all the shards in the SDB while `CATALOG` represents only the SDB catalog database. The default is `all shards`.
`-async`	When specified, all tasks to configure the backup for the shards will run in background. By default, the task will run in foreground. The task for the SDB catalog database will always run in foreground regardless of this flag setting.
`-encryption`	Encryption protocol for Advanced Network Option (ANO) used between GSM, GDSCTL and databases. OFF means that ANO is disabled. ( AES256 \| AES192 \| OFF).
`-remov`	If specified, it removes the backup configuration from the specified shards. Other provided options for the command are ignored.

Examples

The following example configures a backup channel of DISK type for the SDB catalog database, two parallel channels of DISK type for each of the shards (shard spaces dbs1 and dbs2 are used in the shard list), the backup retention window to 14 days, the level 0 and level 1 incremental backup repeat intervals to 7 and 1 day and the backup start time to 12:00 AM, leaving the incremental backup type to the default DIFFERENTIAL and the backup target type to the default STANDBY.

GDSCTL> config backup -rccatalog rcadmin/rman@inst6 -destination 
"CATALOG::configure channel device type disk format '/tmp/rman/backups/%d_%U'" -destination "dbs1,dbs2:configure device type disk parallelism 2:configure 
channel 1 device type disk format '/tmp/rman/backups/1/%U';configure channel 2 
device type disk format '/tmp/rman/backups/2/%U'" -starttime ALL:00:00 -
retention 14 -frequency 7:1 -catpwd gsm -cdb gsm_admin/gsm@instroot1;

When CONFIG BACKUP is not provided with any parameters, it shows the current backup configuration.

GDSCTL> config backup
Recovery catalog database user: rcadmin
Recovery catalog database connect descriptor: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=den02qxr)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=cdb6_pdb1.regress.rdbms.dev.example.com)))
Catalog database root container user: gsm_admin
Catalog database root container connect descriptor: (DESCRIPTION=(ADDRESS=(PROTOCOL=tcp)(HOST=den02qxr)(PORT=1521))(CONNECT_DATA=(SERVICE_NAME=v1908.regress.rdbms.dev.example.com)))
Backup retention policy in days: 14
Level 0 incremental backup repeat interval in minutes: 10080
Level 1 incremental backup repeat interval in minutes: 1440
Level 1 incremental backup type : DIFFERENTIAL
Backup target type: STANDBY
Backup destinations:
catalog::channel device type disk format '/tmp/rman/backups/%d_%u'
dbs1,dbs2:device type disk parallelism 2:channel 1 device type disk format '/tmp/rman/backups/1/%u';channel 2 device type disk format '/tmp/rman/backups/2/%u'
catalog::configure channel device type disk format '/tmp/rman/backups/%d_%u'
dbs1,dbs2:configure device type disk parallelism 2:configure channel 1 device type disk format '/tmp/rman/backups/1/%u';configure channel 2 device type disk format '/tmp/rman/backups/2/%u'
Backup start times:
all:00:00

Parent topic: Global Data Services Control Utility (GDSCTL) Command Reference