REST API for Oracle Enterprise Manager

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. If the selected destination is an Oracle Zero Data Loss Recovery Appliance, then you must enable the ZDLRA Management Pack on the Recovery Appliance to use this API.

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.

{
    "type":"object",
    "description":"Bulk Config Backup Details.",
    "properties":{
        "recoveryApplianceMediaSettings":{
            "type":"array",
            "description":"Details of Recovery Appliances to which the databases will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "settingsId":{
                        "type":"number",
                        "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
                        "example":1
                    },
                    "raTargetName":{
                        "type":"string",
                        "description":"Recovery Appliance target name.",
                        "example":"RA19000"
                    },
                    "raTargetType":{
                        "type":"string",
                        "description":"Recovery Appliance target type.",
                        "example":"oracle_dblra"
                    },
                    "protocol":{
                        "type":"string",
                        "description":"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.",
                        "enum":[
                            "TCP",
                            "TCPS"
                        ],
                        "example":"TCP"
                    },
                    "vpcUserName":{
                        "type":"string",
                        "description":"Virtual private catalog user name.",
                        "example":"bkpUser1"
                    },
                    "overrideConnDesc":{
                        "type":"string",
                        "description":"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)))"
                    }
                }
            }
        },
        "ociMediaSettings":{
            "type":"array",
            "description":"Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "settingsId":{
                        "type":"number",
                        "description":"Index.",
                        "example":1
                    },
                    "ociEndPoint":{
                        "type":"string",
                        "description":"API EndPoint.",
                        "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
                    },
                    "ociBucket":{
                        "type":"string",
                        "description":"Bucket.",
                        "example":"Backup1"
                    },
                    "tempMetadataOCIBucket":{
                        "type":"string",
                        "description":"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"
                    },
                    "isOCIBucketImmutable":{
                        "type":"boolean",
                        "description":"Specifies if the bucket specified is an immutable bucket.",
                        "example":true
                    },
                    "compartmentOCID":{
                        "type":"string",
                        "description":"Container OCID.",
                        "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
                    }
                }
            }
        },
        "targetList":{
            "type":"array",
            "description":"Contains details of database targets that will be configured to send backups.",
            "items":{
                "type":"object",
                "properties":{
                    "targetName":{
                        "type":"string",
                        "description":"Database target name.",
                        "example":"DB19000"
                    },
                    "targetType":{
                        "type":"string",
                        "description":"Database target type.",
                        "example":"oracle_database"
                    },
                    "databaseCredentials":{
                        "type":"string",
                        "description":"Database credentials used to connect to the database.",
                        "example":"NAMED:NC_DB1:SYSMAN"
                    },
                    "hostCredentials":{
                        "type":"string",
                        "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
                        "example":"NAMED:NC_VMUSER:SYSMAN"
                    },
                    "parallelism":{
                        "type":"number",
                        "description":"Number of SBT channels to set in database RMAN settings for the backup.",
                        "example":1
                    },
                    "protocol":{
                        "type":"string",
                        "description":"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.",
                        "enum":[
                            "TCP",
                            "TCPS"
                        ],
                        "example":"TCP"
                    },
                    "isForceInstallBackupModule":{
                        "type":"boolean",
                        "description":"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
                    },
                    "recoveryApplianceSettingsId":{
                        "type":"number",
                        "description":"Recovery Appliance media settings index.",
                        "example":1
                    },
                    "alternateRecoveryApplianceSettingsId":{
                        "type":"number",
                        "description":"Alternate Recovery Appliance media settings index.",
                        "example":2
                    },
                    "raCommonVpcUserName":{
                        "type":"string",
                        "description":"Common virtual private catalog user name.",
                        "example":"bkpUser1"
                    },
                    "overrideConnDesc":{
                        "type":"string",
                        "description":"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)))"
                    },
                    "alternateOverrideConnDesc":{
                        "type":"string",
                        "description":"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)))"
                    },
                    "overallOverrideConnDesc":{
                        "type":"string",
                        "description":"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)))"
                    },
                    "ociMediaSettingsId":{
                        "type":"string",
                        "description":"Oracle Cloud Infrastructure media settings index.",
                        "example":1
                    }
                }
            }
        },
        "backupConfiguration":{
            "type":"object",
            "description":"Contains details of the backup configuration.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
                },
                {
                    "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
                }
            ],
            "discriminator":{
                "propertyName":"destinationMediaType",
                "mapping":{
                    "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
                    "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
                }
            }
        },
        "schedule":{
            "description":"Specifies schedule of the deployment procedure.",
            "oneOf":[
                {
                    "$ref":"#/components/schemas/ScheduleImmediately"
                },
                {
                    "$ref":"#/components/schemas/ScheduleLater"
                },
                {
                    "$ref":"#/components/schemas/ScheduleRepeating"
                }
            ],
            "discriminator":{
                "propertyName":"type",
                "mapping":{
                    "immediately":"#/components/schemas/ScheduleImmediately",
                    "later":"#/components/schemas/ScheduleLater",
                    "repeating":"#/components/schemas/ScheduleRepeating"
                }
            }
        }
    }
}

Nested Schema : Discriminator: destinationMediaType

Type: object

Discriminator: destinationMediaType

Discriminator Values

{
    "type":"object",
    "description":"Contains details of the backup configuration.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
            "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    }
}

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.

{
    "type":"object",
    "description":"Contains details of the backup configuration.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ConfigBackupDetailsOCI"
        },
        {
            "$ref":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    ],
    "discriminator":{
        "propertyName":"destinationMediaType",
        "mapping":{
            "OCI":"#/components/schemas/ConfigBackupDetailsOCI",
            "RA":"#/components/schemas/BulkConfigBackupDetailsRA"
        }
    }
}

Nested Schema : ociMediaSettings

Type: array

Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Details of Oracle Cloud Infrastructure settings to which the databases will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "settingsId":{
                "type":"number",
                "description":"Index.",
                "example":1
            },
            "ociEndPoint":{
                "type":"string",
                "description":"API EndPoint.",
                "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
            },
            "ociBucket":{
                "type":"string",
                "description":"Bucket.",
                "example":"Backup1"
            },
            "tempMetadataOCIBucket":{
                "type":"string",
                "description":"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"
            },
            "isOCIBucketImmutable":{
                "type":"boolean",
                "description":"Specifies if the bucket specified is an immutable bucket.",
                "example":true
            },
            "compartmentOCID":{
                "type":"string",
                "description":"Container OCID.",
                "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
            }
        }
    }
}

Nested Schema : recoveryApplianceMediaSettings

Type: array

Details of Recovery Appliances to which the databases will be configured to send backups.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Details of Recovery Appliances to which the databases will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "settingsId":{
                "type":"number",
                "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
                "example":1
            },
            "raTargetName":{
                "type":"string",
                "description":"Recovery Appliance target name.",
                "example":"RA19000"
            },
            "raTargetType":{
                "type":"string",
                "description":"Recovery Appliance target type.",
                "example":"oracle_dblra"
            },
            "protocol":{
                "type":"string",
                "description":"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.",
                "enum":[
                    "TCP",
                    "TCPS"
                ],
                "example":"TCP"
            },
            "vpcUserName":{
                "type":"string",
                "description":"Virtual private catalog user name.",
                "example":"bkpUser1"
            },
            "overrideConnDesc":{
                "type":"string",
                "description":"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)))"
            }
        }
    }
}

Nested Schema : Discriminator: type

Type: object

Discriminator: type

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

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.

{
    "description":"Specifies schedule of the deployment procedure.",
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleImmediately"
        },
        {
            "$ref":"#/components/schemas/ScheduleLater"
        },
        {
            "$ref":"#/components/schemas/ScheduleRepeating"
        }
    ],
    "discriminator":{
        "propertyName":"type",
        "mapping":{
            "immediately":"#/components/schemas/ScheduleImmediately",
            "later":"#/components/schemas/ScheduleLater",
            "repeating":"#/components/schemas/ScheduleRepeating"
        }
    }
}

Nested Schema : targetList

Type: array

Contains details of database targets that will be configured to send backups.

Show Source

Array of: object items

{
    "type":"array",
    "description":"Contains details of database targets that will be configured to send backups.",
    "items":{
        "type":"object",
        "properties":{
            "targetName":{
                "type":"string",
                "description":"Database target name.",
                "example":"DB19000"
            },
            "targetType":{
                "type":"string",
                "description":"Database target type.",
                "example":"oracle_database"
            },
            "databaseCredentials":{
                "type":"string",
                "description":"Database credentials used to connect to the database.",
                "example":"NAMED:NC_DB1:SYSMAN"
            },
            "hostCredentials":{
                "type":"string",
                "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
                "example":"NAMED:NC_VMUSER:SYSMAN"
            },
            "parallelism":{
                "type":"number",
                "description":"Number of SBT channels to set in database RMAN settings for the backup.",
                "example":1
            },
            "protocol":{
                "type":"string",
                "description":"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.",
                "enum":[
                    "TCP",
                    "TCPS"
                ],
                "example":"TCP"
            },
            "isForceInstallBackupModule":{
                "type":"boolean",
                "description":"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
            },
            "recoveryApplianceSettingsId":{
                "type":"number",
                "description":"Recovery Appliance media settings index.",
                "example":1
            },
            "alternateRecoveryApplianceSettingsId":{
                "type":"number",
                "description":"Alternate Recovery Appliance media settings index.",
                "example":2
            },
            "raCommonVpcUserName":{
                "type":"string",
                "description":"Common virtual private catalog user name.",
                "example":"bkpUser1"
            },
            "overrideConnDesc":{
                "type":"string",
                "description":"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)))"
            },
            "alternateOverrideConnDesc":{
                "type":"string",
                "description":"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)))"
            },
            "overallOverrideConnDesc":{
                "type":"string",
                "description":"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)))"
            },
            "ociMediaSettingsId":{
                "type":"string",
                "description":"Oracle Cloud Infrastructure media settings index.",
                "example":1
            }
        }
    }
}

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

{
    "description":"Configure Backup Details for Oracle Cloud Infrastructure.",
    "type":"object",
    "required":[
        "destinationMediaType"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"OCI"
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":1
                },
                "installerArgs":{
                    "type":"array",
                    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
                    "items":{
                        "type":"string",
                        "example":"-newRSAKeyPair true"
                    },
                    "example":[
                        "-newRSAKeyPair true",
                        "-libPlatform linux64"
                    ]
                },
                "skipConfiguredDbs":{
                    "type":"boolean",
                    "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
                    "example":true
                },
                "forceSerialExecution":{
                    "type":"boolean",
                    "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
                    "example":true
                },
                "proxyHost":{
                    "type":"string",
                    "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                },
                "proxyPort":{
                    "type":"integer",
                    "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
                },
                "enableArchiving":{
                    "type":"boolean",
                    "description":"Whether backups must be automatically moved from standard Object Storage buckets to Archive Storage. The default value is FALSE. Set this parameter to TRUE to enable automatic archival of backups.",
                    "example":true
                },
                "archiveAfterBackup":{
                    "type":"string",
                    "description":"Period of time, in days or years, after which backups are moved from standard Object Storage to Archive Storage. The default is 0 days.",
                    "example":"25 days"
                },
                "retainAfterRestore":{
                    "type":"string",
                    "description":"Period of time, in hours, for which backups that were restored from Archive Storage to standard Object Storage are retained in the Object Storage bucket. The default is 48 hours.",
                    "example":"24 hours"
                }
            }
        }
    }
}

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", "SPECIFIED_DB_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
isEncryptRedo: boolean

Specifies if the real-time redo has to be encrypted.

Example: true
isForceRestartDB: boolean

Specifies if the database has to be restarted for sure during the configuration procedure.

Example: false
isShipRedo: boolean

Specifies if the real-time redo has 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
isValidateOnly: boolean

Submits a procedure activity to validate the credentials and other configuration details provided.

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.

{
    "description":"Bulk Configure Backup Details for Recovery Appliance.",
    "type":"object",
    "required":[
        "destinationMediaType"
    ],
    "properties":{
        "destinationMediaType":{
            "type":"string",
            "description":"Destination media type.",
            "example":"RA"
        },
        "isShipRedo":{
            "type":"boolean",
            "description":"Specifies if the real-time redo has to be shipped.",
            "example":true
        },
        "isEncryptRedo":{
            "type":"boolean",
            "description":"Specifies if the real-time redo has to be encrypted.",
            "example":true
        },
        "isSkipControlfileAutobackup":{
            "type":"boolean",
            "description":"Specifies if control file backup should be skipped.",
            "example":true
        },
        "isUpdateSnapshotControlfileLoc":{
            "type":"boolean",
            "description":"Specifies if snapshot control file should be updated.",
            "example":false
        },
        "isDatabaseRestartPermitted":{
            "type":"boolean",
            "description":"Specifies if it is permitted to restart the database if required by the configuration procedure.",
            "example":false
        },
        "isValidateOnly":{
            "type":"boolean",
            "description":"Submits a procedure activity to validate the credentials and other configuration details provided.",
            "example":false
        },
        "isForceRestartDB":{
            "type":"boolean",
            "description":"Specifies if the database has to be restarted for sure during the configuration procedure.",
            "example":false
        },
        "backupConfig":{
            "type":"string",
            "description":"Backup configuration.",
            "example":"ALL_DG",
            "enum":[
                "NO_DG",
                "ALL_DG",
                "CUSTOM_DG",
                "SPECIFIED_DB_DG",
                "GOLD",
                "GOLD_WITH_REP"
            ]
        },
        "isBRContinuity":{
            "type":"boolean",
            "description":"Specifies if the database has to be configured with Backup and Recovery Continuity.",
            "example":false
        },
        "protocol":{
            "type":"string",
            "description":"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.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "walletParameters":{
            "type":"object",
            "description":"Wallet related parameters.",
            "properties":{
                "walletLocation":{
                    "type":"string",
                    "description":"Wallet location.",
                    "example":"$ORACLE_HOME/dbs/wallet"
                },
                "isUpdateSQLNet":{
                    "type":"boolean",
                    "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
                    "example":false
                },
                "isUpdateCRSEnv":{
                    "type":"boolean",
                    "description":"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
                },
                "isSetWalletRoot":{
                    "type":"boolean",
                    "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
                    "example":false
                }
            }
        },
        "backupModuleParameters":{
            "type":"object",
            "description":"Backup module related parameters.",
            "properties":{
                "isDownloadBackupModule":{
                    "type":"boolean",
                    "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
                    "example":false
                },
                "isForceInstallBackupModule":{
                    "type":"boolean",
                    "description":"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":{
                    "type":"string",
                    "description":"Cutom location of the backup module. Default is $ORACLE_HOME/lib.",
                    "example":"$ORACLE_HOME/lib"
                }
            }
        },
        "advanced":{
            "type":"object",
            "description":"Advanced parameters.",
            "properties":{
                "parallelism":{
                    "type":"number",
                    "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
                    "example":1
                }
            }
        }
    }
}

Nested Schema : advanced

Type: object

Advanced parameters.

Show Source

archiveAfterBackup: string

Period of time, in days or years, after which backups are moved from standard Object Storage to Archive Storage. The default is 0 days.

Example: 25 days
enableArchiving: boolean

Whether backups must be automatically moved from standard Object Storage buckets to Archive Storage. The default value is FALSE. Set this parameter to TRUE to enable automatic archival of backups.

Example: true
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.
retainAfterRestore: string

Period of time, in hours, for which backups that were restored from Archive Storage to standard Object Storage are retained in the Object Storage bucket. The default is 48 hours.

Example: 24 hours
skipConfiguredDbs: boolean

Specifies if databases that are already configured to backup to the specified destination media should be skipped.

Example: true

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for Oracle Cloud Infrastructure backup.",
            "example":1
        },
        "installerArgs":{
            "type":"array",
            "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
            "items":{
                "type":"string",
                "example":"-newRSAKeyPair true"
            },
            "example":[
                "-newRSAKeyPair true",
                "-libPlatform linux64"
            ]
        },
        "skipConfiguredDbs":{
            "type":"boolean",
            "description":"Specifies if databases that are already configured to backup to the specified destination media should be skipped.",
            "example":true
        },
        "forceSerialExecution":{
            "type":"boolean",
            "description":"Specifies if the Enterprise Manager configuration deployment procedure has to process one database at a time or in parallel.",
            "example":true
        },
        "proxyHost":{
            "type":"string",
            "description":"Proxy host used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        },
        "proxyPort":{
            "type":"integer",
            "description":"Proxy port used while downloading the Oracle Cloud Infrastructure backup module on the database target host."
        },
        "enableArchiving":{
            "type":"boolean",
            "description":"Whether backups must be automatically moved from standard Object Storage buckets to Archive Storage. The default value is FALSE. Set this parameter to TRUE to enable automatic archival of backups.",
            "example":true
        },
        "archiveAfterBackup":{
            "type":"string",
            "description":"Period of time, in days or years, after which backups are moved from standard Object Storage to Archive Storage. The default is 0 days.",
            "example":"25 days"
        },
        "retainAfterRestore":{
            "type":"string",
            "description":"Period of time, in hours, for which backups that were restored from Archive Storage to standard Object Storage are retained in the Object Storage bucket. The default is 48 hours.",
            "example":"24 hours"
        }
    }
}

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: -newRSAKeyPair true

{
    "type":"array",
    "description":"Additional arguments to be specified while invoking the Oracle Cloud Infrastructure installer to configure database backup to Oracle Cloud.",
    "items":{
        "type":"string",
        "example":"-newRSAKeyPair true"
    },
    "example":[
        "-newRSAKeyPair true",
        "-libPlatform linux64"
    ]
}

Example:

[
    "-newRSAKeyPair true",
    "-libPlatform linux64"
]

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

{
    "type":"object",
    "description":"Advanced parameters.",
    "properties":{
        "parallelism":{
            "type":"number",
            "description":"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

{
    "type":"object",
    "description":"Backup module related parameters.",
    "properties":{
        "isDownloadBackupModule":{
            "type":"boolean",
            "description":"Specifies if the latest backup module has to be downloaded into the Software Library.",
            "example":false
        },
        "isForceInstallBackupModule":{
            "type":"boolean",
            "description":"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":{
            "type":"string",
            "description":"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

{
    "type":"object",
    "description":"Wallet related parameters.",
    "properties":{
        "walletLocation":{
            "type":"string",
            "description":"Wallet location.",
            "example":"$ORACLE_HOME/dbs/wallet"
        },
        "isUpdateSQLNet":{
            "type":"boolean",
            "description":"Specifies if the SQLNET.WALLET_LOCATION has to be updated.",
            "example":false
        },
        "isUpdateCRSEnv":{
            "type":"boolean",
            "description":"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
        },
        "isSetWalletRoot":{
            "type":"boolean",
            "description":"Specifies if the WALLET_ROOT database initialization parameter has be set.",
            "example":false
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "settingsId":{
            "type":"number",
            "description":"Index.",
            "example":1
        },
        "ociEndPoint":{
            "type":"string",
            "description":"API EndPoint.",
            "example":"https://objectstorage.us-ashburn-1.oraclecloud.com"
        },
        "ociBucket":{
            "type":"string",
            "description":"Bucket.",
            "example":"Backup1"
        },
        "tempMetadataOCIBucket":{
            "type":"string",
            "description":"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"
        },
        "isOCIBucketImmutable":{
            "type":"boolean",
            "description":"Specifies if the bucket specified is an immutable bucket.",
            "example":true
        },
        "compartmentOCID":{
            "type":"string",
            "description":"Container OCID.",
            "example":"ocid1.compartment.oc1..aaaaaaaa7dlb5auhlhvhe3e6xz2hhjy64hujbwriad76q45xu2fkg6yu6fpq"
        }
    }
}

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "settingsId":{
            "type":"number",
            "description":"Recovery Appliance media settings index. [1-16] are the allowed indexes.",
            "example":1
        },
        "raTargetName":{
            "type":"string",
            "description":"Recovery Appliance target name.",
            "example":"RA19000"
        },
        "raTargetType":{
            "type":"string",
            "description":"Recovery Appliance target type.",
            "example":"oracle_dblra"
        },
        "protocol":{
            "type":"string",
            "description":"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.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "vpcUserName":{
            "type":"string",
            "description":"Virtual private catalog user name.",
            "example":"bkpUser1"
        },
        "overrideConnDesc":{
            "type":"string",
            "description":"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)))"
        }
    }
}

Nested Schema : ScheduleImmediately

Type: object

Schedule immediately.

Show Source

type(required): string

Type of schedule.

Example: immediately

{
    "type":"object",
    "description":"Schedule immediately.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "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

{
    "type":"object",
    "description":"Schedule later.",
    "required":[
        "type"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"later"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        }
    }
}

Nested Schema : Discriminator: repeatFrequency

Type: object

Discriminator: repeatFrequency

Discriminator Values

WEEKLY
MONTHLY
YEARLY
INTERVAL

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

Repeating schedule.

Match All

Repeating schedule.

Show Source

object ScheduleRepeatingBase

Repeating schedule.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

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.

{
    "type":"object",
    "description":"Repeating schedule.",
    "allOf":[
        {
            "$ref":"#/components/schemas/ScheduleRepeatingBase"
        }
    ],
    "oneOf":[
        {
            "$ref":"#/components/schemas/ScheduleWeekly"
        },
        {
            "$ref":"#/components/schemas/ScheduleMonthly"
        },
        {
            "$ref":"#/components/schemas/ScheduleYearly"
        },
        {
            "$ref":"#/components/schemas/ScheduleInterval"
        }
    ],
    "discriminator":{
        "propertyName":"repeatFrequency",
        "mapping":{
            "WEEKLY":"#/components/schemas/ScheduleWeekly",
            "MONTHLY":"#/components/schemas/ScheduleMonthly",
            "YEARLY":"#/components/schemas/ScheduleYearly",
            "INTERVAL":"#/components/schemas/ScheduleInterval"
        }
    }
}

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

{
    "type":"object",
    "description":"Repeating schedule.",
    "required":[
        "type",
        "startTime",
        "repeatFrequency"
    ],
    "properties":{
        "type":{
            "description":"Type of schedule.",
            "type":"string",
            "example":"repeating"
        },
        "startTime":{
            "$ref":"#/components/schemas/ScheduleStartTime"
        },
        "timeZone":{
            "$ref":"#/components/schemas/ScheduleTimeZone"
        },
        "endtime":{
            "$ref":"#/components/schemas/ScheduleEndTime"
        },
        "repeatFrequency":{
            "$ref":"#/components/schemas/ScheduleRepeatFrequency"
        }
    }
}

Nested Schema : ScheduleWeekly

Type: object

Repeat value for repeat frequency - weekly.

Show Source

days(required): array days

Days of the week.

{
    "description":"Repeat value for repeat frequency - weekly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Days of the week.",
            "type":"array",
            "example":"1,4",
            "items":{
                "$ref":"#/components/schemas/DaysOfTheWeekEnum"
            }
        }
    }
}

Nested Schema : ScheduleMonthly

Type: object

Repeat value for repeat frequency - monthly.

Show Source

days(required): array days

Repeat value for monthly.

{
    "description":"Repeat value for repeat frequency - monthly.",
    "required":[
        "days"
    ],
    "properties":{
        "days":{
            "description":"Repeat value for monthly.",
            "type":"array",
            "example":"1,30,31",
            "items":{
                "type":"integer",
                "description":"Day number, int -1, 1..5 representing which day number. -1 represents LAST day."
            }
        }
    }
}

Nested Schema : ScheduleYearly

Type: object

Repeat value for repeat frequency - yearly.

Show Source

months(required): array months

Repeat value for yearly.

{
    "description":"Repeat value for repeat frequency - yearly.",
    "required":[
        "months"
    ],
    "properties":{
        "months":{
            "description":"Repeat value for yearly.",
            "type":"array",
            "example":"1,3",
            "items":{
                "type":"integer",
                "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
            }
        }
    }
}

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

{
    "description":"Repeat value for repeat frequency - interval.",
    "required":[
        "repeatEvery"
    ],
    "properties":{
        "repeatEvery":{
            "description":"Repeat every N value - m(minutes), h(hours), d(days), w(week).",
            "type":"string",
            "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.

{
    "description":"Days of the week.",
    "type":"array",
    "example":"1,4",
    "items":{
        "$ref":"#/components/schemas/DaysOfTheWeekEnum"
    }
}

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.

{
    "description":"Repeat value for monthly.",
    "type":"array",
    "example":"1,30,31",
    "items":{
        "type":"integer",
        "description":"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.

{
    "description":"Repeat value for yearly.",
    "type":"array",
    "example":"1,3",
    "items":{
        "type":"integer",
        "description":"Month number, int 1, 2, 3.. representing months Januaray, February, March etc."
    }
}

Example:

1,3

Nested Schema : items

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "targetName":{
            "type":"string",
            "description":"Database target name.",
            "example":"DB19000"
        },
        "targetType":{
            "type":"string",
            "description":"Database target type.",
            "example":"oracle_database"
        },
        "databaseCredentials":{
            "type":"string",
            "description":"Database credentials used to connect to the database.",
            "example":"NAMED:NC_DB1:SYSMAN"
        },
        "hostCredentials":{
            "type":"string",
            "description":"Host credentials that are operating system credentials used to perform database backup and recovery operations.",
            "example":"NAMED:NC_VMUSER:SYSMAN"
        },
        "parallelism":{
            "type":"number",
            "description":"Number of SBT channels to set in database RMAN settings for the backup.",
            "example":1
        },
        "protocol":{
            "type":"string",
            "description":"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.",
            "enum":[
                "TCP",
                "TCPS"
            ],
            "example":"TCP"
        },
        "isForceInstallBackupModule":{
            "type":"boolean",
            "description":"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
        },
        "recoveryApplianceSettingsId":{
            "type":"number",
            "description":"Recovery Appliance media settings index.",
            "example":1
        },
        "alternateRecoveryApplianceSettingsId":{
            "type":"number",
            "description":"Alternate Recovery Appliance media settings index.",
            "example":2
        },
        "raCommonVpcUserName":{
            "type":"string",
            "description":"Common virtual private catalog user name.",
            "example":"bkpUser1"
        },
        "overrideConnDesc":{
            "type":"string",
            "description":"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)))"
        },
        "alternateOverrideConnDesc":{
            "type":"string",
            "description":"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)))"
        },
        "overallOverrideConnDesc":{
            "type":"string",
            "description":"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)))"
        },
        "ociMediaSettingsId":{
            "type":"string",
            "description":"Oracle Cloud Infrastructure media settings index.",
            "example":1
        }
    }
}

Examples

Response

Supported Media Types

application/json

202 Response

Execution details of the deployment procedure submitted.

Headers

Content-Location:

Status of the deployment procedure submitted can be viewed in this location.

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

{
    "description":"Status of operation submitted.",
    "type":"object",
    "required":[
        "submissionName",
        "submissionBy",
        "executionId",
        "procedureId"
    ],
    "properties":{
        "submissionName":{
            "description":"Name of the deployment procedure submitted.",
            "type":"string",
            "example":"BACKUP_RA_CONFIG_121222220321"
        },
        "submissionBy":{
            "description":"User that submitted the deployment procedure.",
            "type":"string",
            "example":"SYSMAN"
        },
        "executionId":{
            "description":"Deployment procedure execution ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "procedureId":{
            "description":"Deployment procedure submission ID.",
            "type":"string",
            "example":"DE8676BE8CD73086E053DE0D4B64D288"
        },
        "location":{
            "description":"URI to verify the status of the deployment procedure submitted.",
            "type":"string",
            "example":"/em/api/deploymentProcedureInstances/DE8676BE8CD73086E053DE0D4B64D288"
        }
    }
}

400 Response

Bad Request

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

code(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

401 Response

Client is not authenticated

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

code(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

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(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

404 Response

Resource not found or not authorized for access

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

code(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

500 Response

Internal Server Error

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

code(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}

503 Response

Indicates that a required service is not available

Root Schema : ErrorResponse

Type: object

Response sent back in the case of an Error

Show Source

code(required): string

customer facing error code
details: array details

(Optional) List of additional details for the errors found.
message(required): string

customer facing error description

{
    "description":"Response sent back in the case of an Error",
    "type":"object",
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string",
            "description":"customer facing error code"
        },
        "message":{
            "type":"string",
            "description":"customer facing error description"
        },
        "details":{
            "type":"array",
            "description":"(Optional) List of additional details for the errors found.",
            "items":{
                "$ref":"#/components/schemas/ErrorDetail"
            }
        }
    }
}

Nested Schema : details

Type: array

(Optional) List of additional details for the errors found.

Show Source

Array of: object ErrorDetail

listed as part of ErrorResponse

{
    "type":"array",
    "description":"(Optional) List of additional details for the errors found.",
    "items":{
        "$ref":"#/components/schemas/ErrorDetail"
    }
}

Nested Schema : ErrorDetail

Type: object

listed as part of ErrorResponse

Show Source

message(required): string

specific error description

{
    "description":"listed as part of ErrorResponse",
    "type":"object",
    "required":[
        "message"
    ],
    "properties":{
        "message":{
            "type":"string",
            "description":"specific error description"
        }
    }
}