Fleet Configure Backup
post
https://EM_HOST:EM_CONSOLE_HTTPS_PORT/em/api/databases/actions/bulkConfigureBackup
Configures multiple databases to backup to the specified destination media. This API requires the ZDLRA Management Pack to be enabled on the Recovery Appliance if the selected destination is a Recovery Appliance.
Request
Header Parameters
-
ORCL-EM-DBTARGET-AUTHORIZATION(required):
Database credentials used to connect to the databases.
-
ORCL-EM-HOSTTARGET-AUTHORIZATION(required):
Host credentials that are operating system credentials used to perform database backup and recovery operations.
-
ORCL-EM-OCITARGET-AUTHORIZATION(required):
Oracle Cloud Infrastructure credentials.
-
ORCL-EM-RTUTARGET-AUTHORIZATION:
Named credentials for Redo Transport User password.
-
ORCL-EM-TDEWALLETTARGET-AUTHORIZATION:
Named credentials for password protected TDE wallet.
-
ORCL-EM-WALLETTARGET-AUTHORIZATION:
Named credentials for password protected Backup wallet.
-
ORCL_EM_PROXYTARGET_AUTHORIZATION:
Named credentials for Proxy Target Authorization.
Supported Media Types
- application/json
Root Schema : schema
Type:
object
Bulk Config Backup Details.
Show Source
-
backupConfiguration: object
Discriminator: destinationMediaType
Discriminator:
{ "propertyName":"destinationMediaType", "mapping":{ "OCI":"#/components/schemas/ConfigBackupDetailsOCI", "RA":"#/components/schemas/BulkConfigBackupDetailsRA" } }
Contains details of the backup configuration. -
ociMediaSettings: array
ociMediaSettings
Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.
-
recoveryApplianceMediaSettings: array
recoveryApplianceMediaSettings
Details of Recovery Appliances to which the databases will be configured to send backups.
-
schedule:
Discriminator: type
Discriminator:
{ "propertyName":"type", "mapping":{ "immediately":"#/components/schemas/ScheduleImmediately", "later":"#/components/schemas/ScheduleLater", "repeating":"#/components/schemas/ScheduleRepeating" } }
Specifies schedule of the deployment procedure. -
targetList: array
targetList
Contains details of database targets that will be configured to send backups.
Nested Schema : Discriminator: destinationMediaType
Type:
object
Discriminator: destinationMediaType
Discriminator Values
Contains details of the backup configuration.
Match One Schema
Show Source
-
OCI -
object
ConfigBackupDetailsOCI
Configure Backup Details for Oracle Cloud Infrastructure.
-
RA -
object
BulkConfigBackupDetailsRA
Bulk Configure Backup Details for Recovery Appliance.
Nested Schema : ociMediaSettings
Type:
array
Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.
Show Source
Nested Schema : recoveryApplianceMediaSettings
Type:
array
Details of Recovery Appliances to which the databases will be configured to send backups.
Show Source
Nested Schema : Discriminator: type
Type:
object
Discriminator: type
Discriminator Values
Specifies schedule of the deployment procedure.
Match One Schema
Show Source
-
immediately -
object
ScheduleImmediately
Schedule immediately.
-
later -
object
ScheduleLater
Schedule later.
-
object
Discriminator: repeatFrequency
Discriminator:
{ "propertyName":"repeatFrequency", "mapping":{ "WEEKLY":"#/components/schemas/ScheduleWeekly", "MONTHLY":"#/components/schemas/ScheduleMonthly", "YEARLY":"#/components/schemas/ScheduleYearly", "INTERVAL":"#/components/schemas/ScheduleInterval" } }
Repeating schedule.
Nested Schema : targetList
Type:
array
Contains details of database targets that will be configured to send backups.
Show Source
Nested Schema : ConfigBackupDetailsOCI
Type:
object
Configure Backup Details for Oracle Cloud Infrastructure.
Show Source
-
advanced: object
advanced
Advanced parameters.
-
destinationMediaType(required): string
Destination media type.Example:
OCI
Nested Schema : BulkConfigBackupDetailsRA
Type:
object
Bulk Configure Backup Details for Recovery Appliance.
Show Source
-
advanced: object
advanced
Advanced parameters.
-
backupConfig: string
Allowed Values:
[ "NO_DG", "ALL_DG", "CUSTOM_DG", "GOLD", "GOLD_WITH_REP" ]
Backup configuration.Example:ALL_DG
-
backupModuleParameters: object
backupModuleParameters
Backup module related parameters.
-
destinationMediaType(required): string
Destination media type.Example:
RA
-
isBRContinuity: boolean
Specifies if the database has to be configured with Backup and Recovery Continuity.Example:
false
-
isDatabaseRestartPermitted: boolean
Specifies if it is permitted to restart the database if required by the configuration procedure.Example:
false
-
isForceRestartDB: boolean
Specifies if the database has to be restarted for sure during the configuration procedure.Example:
false
-
isShipRedo: boolean
Specifies if redo logs need to be shipped.Example:
true
-
isSkipControlfileAutobackup: boolean
Specifies if control file backup should be skipped.Example:
true
-
isUpdateSnapshotControlfileLoc: boolean
Specifies if snapshot control file should be updated.Example:
false
-
protocol: string
Allowed Values:
[ "TCP", "TCPS" ]
Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.Example:TCP
-
walletParameters: object
walletParameters
Wallet related parameters.
Nested Schema : advanced
Type:
object
Advanced parameters.
Show Source
-
forceSerialExecution: boolean
Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.Example:
true
-
installerArgs: array
installerArgs
Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.
-
parallelism: number
Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.Example:
1
-
proxyHost: string
Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host.
-
proxyPort: integer
Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host.
-
skipConfiguredDbs: boolean
Specifies if databases that are already configured to backup to the specified destination media should be skipped.Example:
true
Nested Schema : installerArgs
Type:
array
Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.
Show Source
-
Array of:
string
Example:
-proxyHost abc
Example:
[
"-proxyHost abc",
"-proxyPort 80"
]
Nested Schema : advanced
Type:
object
Advanced parameters.
Show Source
-
parallelism: number
Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.Example:
1
Nested Schema : backupModuleParameters
Type:
object
Backup module related parameters.
Show Source
-
isDownloadBackupModule: boolean
Specifies if the latest backup module has to be downloaded into the Software Library.Example:
false
-
isForceInstallBackupModule: boolean
Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.Example:
false
-
moduleLocation: string
Cutom location of the backup module. Default is $ORACLE_HOME/lib.Example:
$ORACLE_HOME/lib
Nested Schema : walletParameters
Type:
object
Wallet related parameters.
Show Source
-
isSetWalletRoot: boolean
Specifies if the WALLET_ROOT database initialization parameter has be set.Example:
false
-
isUpdateCRSEnv: boolean
Specifies if the required environment variables (ORACLE_HOME, ORACLE_BASE, DB_UNIQUE_NAME, ORACLE_UNQNAME) should be updated in Cluster Ready Services (CRS) via the SRVCTL command.Example:
false
-
isUpdateSQLNet: boolean
Specifies if the SQLNET.WALLET_LOCATION has to be updated.Example:
false
-
walletLocation: string
Wallet location.Example:
$ORACLE_HOME/dbs/wallet
Nested Schema : items
Type:
Show Source
object
-
compartmentOCID: string
Container OCID.Example:
ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq
-
isOCIBucketImmutable: boolean
Specifies if the bucket specified is an immutable bucket.Example:
true
-
ociBucket: string
Bucket.Example:
Backup1
-
ociEndPoint: string
API EndPoint.Example:
https://objectstorage.us-ashburn-1.oraclecloud.com
-
settingsId: number
Index.Example:
1
-
tempMetadataOCIBucket: string
Temporary metadata bucket that will be used to store objects that needs to be updated or deleted during backup if the ociBucket specified is an immutable bucket.Example:
tempBucket1
Nested Schema : items
Type:
Show Source
object
-
overrideConnDesc: string
Override connect descriptor.Example:
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
-
protocol: string
Allowed Values:
[ "TCP", "TCPS" ]
Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.Example:TCP
-
raTargetName: string
Recovery Appliance target name.Example:
RA19000
-
raTargetType: string
Recovery Appliance target type.Example:
oracle_dblra
-
settingsId: number
Recovery Appliance media settings index. [1-16] are the allowed indexes.Example:
1
-
vpcUserName: string
Virtual private catalog user name.Example:
bkpUser1
Nested Schema : ScheduleImmediately
Type:
object
Schedule immediately.
Show Source
-
type(required): string
Type of schedule.Example:
immediately
Nested Schema : ScheduleLater
Type:
object
Schedule later.
Show Source
-
startTime:
date-time
Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.Example:2021/08/30 23:00
-
timeZone: string
Java Timezone.Example:
America/New_York
-
type(required): string
Type of schedule.Example:
later
Nested Schema : Discriminator: repeatFrequency
Type:
object
Discriminator: repeatFrequency
Discriminator Values
Repeating schedule.
Match All
Repeating schedule.
Show Source
-
object
ScheduleRepeatingBase
Repeating schedule.
Match One Schema
Show Source
-
WEEKLY -
object
ScheduleWeekly
Repeat value for repeat frequency - weekly.
-
MONTHLY -
object
ScheduleMonthly
Repeat value for repeat frequency - monthly.
-
YEARLY -
object
ScheduleYearly
Repeat value for repeat frequency - yearly.
-
INTERVAL -
object
ScheduleInterval
Repeat value for repeat frequency - interval.
Nested Schema : ScheduleRepeatingBase
Type:
object
Repeating schedule.
Show Source
-
endtime:
date-time
Date when job expires. Specified as a string in the format yyyy/MM/dd HH:mm. If not specified, repeat would be on forever.Example:2021/08/30 23:00
-
repeatFrequency(required): string
Allowed Values:
[ "WEEKLY", "MONTHLY", "YEARLY", "INTERVAL" ]
Repetitive frequency type. -
startTime(required):
date-time
Date when the deployment procedure is scheduled to start. Specified as a string in the format yyyy/MM/dd HH:mm.Example:2021/08/30 23:00
-
timeZone: string
Java Timezone.Example:
America/New_York
-
type(required): string
Type of schedule.Example:
repeating
Nested Schema : ScheduleWeekly
Type:
object
Repeat value for repeat frequency - weekly.
Show Source
-
days(required): array
days
Days of the week.
Nested Schema : ScheduleMonthly
Type:
object
Repeat value for repeat frequency - monthly.
Show Source
-
days(required): array
days
Repeat value for monthly.
Nested Schema : ScheduleYearly
Type:
object
Repeat value for repeat frequency - yearly.
Show Source
-
months(required): array
months
Repeat value for yearly.
Nested Schema : ScheduleInterval
Type:
object
Repeat value for repeat frequency - interval.
Show Source
-
repeatEvery(required): string
Repeat every N value - m(minutes), h(hours), d(days), w(week).Example:
10m, 3h, 5d, 2w
Nested Schema : days
Type:
array
Days of the week.
Show Source
-
Array of:
integer
Allowed Values:
[ "1", "2", "3", "4", "5", "6", "7" ]
Days of the week, Sunday is 1, Monday is 2 etc.
Example:
1,4
Nested Schema : days
Type:
array
Repeat value for monthly.
Show Source
-
Array of:
integer
Day number, int -1, 1..5 representing which day number. -1 represents LAST day.
Example:
1,30,31
Nested Schema : months
Type:
array
Repeat value for yearly.
Show Source
-
Array of:
integer
Month number, int 1, 2, 3.. representing months Januaray, February, March etc.
Example:
1,3
Nested Schema : items
Type:
Show Source
object
-
alternateOverrideConnDesc: string
Alternate override connect descriptor.Example:
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
-
alternateRecoveryApplianceSettingsId: number
Alternate Recovery Appliance media settings index.Example:
2
-
databaseCredentials: string
Database credentials used to connect to the database.Example:
NAMED:NC_DB1:SYSMAN
-
hostCredentials: string
Host credentials that are operating system credentials used to perform database backup and recovery operations.Example:
NAMED:NC_VMUSER:SYSMAN
-
isForceInstallBackupModule: boolean
Specifies if the latest backup module has to be pushed from the Software Library and installed in the database Oracle home or backup module location if specified.Example:
false
-
ociMediaSettingsId: string
Oracle Cloud Infrastructure media settings index.Example:
1
-
overallOverrideConnDesc: string
Backup and Recovery Continuity override connect descriptor.Example:
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
-
overrideConnDesc: string
Override connect descriptor.Example:
(DESCRIPTION=(ADDRESS_LIST=(ADDRESS=(PROTOCOL=TCP)(HOST=example01-vip.us.oracle.com)(PORT=1521))(ADDRESS=(PROTOCOL=TCP)(HOST=example02-vip.us.oracle.com)(PORT=1521)))(CONNECT_DATA=(SERVICE_NAME=exapl)))
-
parallelism: number
Number of SBT channels to set in database RMAN settings for the backup.Example:
1
-
protocol: string
Allowed Values:
[ "TCP", "TCPS" ]
Protocol that will be used to configure databases to send backups to Recovery Appliance. Default is TCPS, if the Recovery Appliance is configured in either the TLS only mode or DUAL mode. If not, TCP.Example:TCP
-
raCommonVpcUserName: string
Common virtual private catalog user name.Example:
bkpUser1
-
recoveryApplianceSettingsId: number
Recovery Appliance media settings index.Example:
1
-
targetName: string
Database target name.Example:
DB19000
-
targetType: string
Database target type.Example:
oracle_database
Examples
Back to Top
Response
Supported Media Types
- application/json
202 Response
Execution details of the deployment procedure submitted.
Headers
-
Content-Location:
Execution details of the deployment procedure submitted.
Root Schema : BulkConfigureBackupDatabase
Type:
object
Status of operation submitted.
Show Source
-
executionId(required): string
Deployment procedure execution ID.Example:
DE8676BE8CD73086E053DE0D4B64D288
-
location: string
URI to verify the status of the deployment procedure submitted.Example:
/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288
-
procedureId(required): string
Deployment procedure submission ID.Example:
DE8676BE8CD73086E053DE0D4B64D288
-
submissionBy(required): string
User that submitted the deployment procedure.Example:
SYSMAN
-
submissionName(required): string
Name of the deployment procedure submitted.Example:
BACKUP_RA_CONFIG_121222220321
400 Response
Bad Request. The payload is null or missing some parameters
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
401 Response
Unauthorized. The user does not have permissions to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
403 Response
Forbidden. The user is forbidden to perform the requested operation
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
404 Response
Not Found. The requested REST API URL is not found.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
500 Response
Internal Server Error. Exception in execution of REST API.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported
503 Response
Service Unavailable. The server is unable to process the request.
Root Schema : ErrorResponse
Type:
object
Response sent back in the case of an error.
Show Source
-
code: string
Status code of the error.Example:
IllegalArgument
-
message: string
A descriptive error message.Example:
argument given is not supported