Oracle Cloud Infrastructure Documentation

Manage Database Backup and Recovery on Oracle Exadata Database Service on Cloud@Customer

Learn how to work with the backup and recovery facilities provided by Oracle Exadata Database Service on Cloud@Customer.

Parent topic: How-to Guides

Backup Destinations

Parent topic: Manage Database Backup and Recovery on Oracle Exadata Database Service on Cloud@Customer

About Managing Backup Destinations for Exadata Database Service on Cloud@Customer

For backups, you can either use the Exadata Database Service on Cloud@Customer backup facility, or you can configure a backup location on a location you manage.

Exadata Database Service on Cloud@Customer provides a backup facility, which you can configure individually on each database.

See: Managing Databases on Exadata Cloud@Customer and Managing Database Backup and Recovery on Exadata Cloud@Customer.

If you want to store backups on a Recovery Appliance, or on a network file storage (NFS) location that you manage, then you must first create a backup destination. Each backup destination defines the properties that are required to connect to the Recovery Appliance or NFS location, and each backup destination must be accessible in your data center from the VM cluster nodes.

The Exadata Database Service on Cloud@Customer backup facility can also store backups on Oracle Cloud Infrastructure object storage, or on local Exadata storage on your Exadata Database Service on Cloud@Customer system. However, you do not need to create a backup destination for any of these other locations. Instead, applicable options for backup to cloud object storage or local Exadata storage are available directly when you create a database.

Note

Avoid entering confidential information when assigning descriptions, tags, or friendly names to your cloud resources through the Oracle Cloud Infrastructure Console, API, or CLI.

Prerequisites for Backup Destinations for Exadata Database Service on Cloud@Customer

To configure backup destinations on a Zero Data Loss Recovery Appliance location, or an NFS backup location, review the prerequisites.

  • For a Zero Data Loss Recovery Appliance backup destination:
    • The appliance must be configured with a virtual private catalog (VPC) user, which is used for taking the backups.
    • The appliance must be configured with the unique database name of the database being backed up, and a mapping to the VPC user.
    • The appliance must be accessible from the Exadata Database Service on Cloud@Customer system using the Oracle Net Services connection string, which is provided by the Zero Data Loss Recovery Appliance administrator.
  • For an NFS backup destination:
    • Exadata Database Service on Cloud@Customer non-autonomous databases:
      • You must mount the NFS server location to a local mount point directory on each node in the VM cluster.
      • The local mount point directory and the NFS server must be identical across all nodes in the cluster.
      • You must ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
      • The NFS-mounted file system must be readable and writable by the oracle operating system user on all of the VM cluster nodes.
    • Autonomous Database on Cloud@Customer:
      Note

      Oracle Autonomous Database on Exadata Cloud@Customer supports NFS versions 3 and 4. Mounts with both versions enabled, however, default to version 4.
      • To ensure that the Autonomous VM cluster can access the NFS server over the (preferred) Backup Network, enter valid Backup Network IP addresses while configuring the VM Cluster Network.

        If the backup destination is not accessible over the backup network but accessible over the client network, the backup traffic will be routed over the client network.

      • The NFS-mounted file system must be readable and writable by the oracle operating system user on all of the VM cluster nodes.
      • If permissions are being controlled at the user level, then the uid:gid of the oracle user for the Autonomous VM cluster is 1001:1001.

Parent topic: Backup Destinations

Using the Console for Backup Destinations for Exadata Database Service on Cloud@Customer

Learn how to use the console to create, edit, move, and terminate a backup destination for your infrastructure for Oracle Exadata Database Service on Cloud@Customer.

Parent topic: Backup Destinations

Using the Console to Create a Backup Destination

To create a backup destination, be prepared to provide values for the backup destination configuration.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region that contains your Exadata infrastructure.
  3. Click Backup Destinations.
  4. Click Create Backup Destination.
  5. Provide the requested information in the Create Backup Destination page:
    1. Choose a compartment.

      From the list of available compartments, choose the compartment that you want to contain the backup destination.

    2. Name your backup destination.

      Specify a user-friendly name that you can use to identify the backup destination. The name doesn't need to be unique because an Oracle Cloud Identifier (OCID) uniquely identifies the backup destination.

    3. Choose either a Zero Data Loss Recovery Appliance or a network file system (NFS) backup destination.
      Note

      You can also set OCI Object Store as a backup destination. However, you cannot set it from this screen. You can configure OCI Object Store as a backup destination when creating a database. For more information, see Backup Destination Type in Using the Console to Create a Database.

      Select Recovery Appliance or Network Storage (NFS).

      • If you select Recovery Appliance, then you must also specify the following for Zero Data Loss Recovery Appliance:
        • Provide the Recovery Appliance connection string: Specify the Oracle Net Services connection string that connects to the appliance. This information is typically provided by the Zero Data Loss Recovery Appliance administrator.
          Note

          ADB customers must ensure to provide the connection string that connects to the recovery appliance in an Oracle "easy connect" string format, as shown below:
          host:port/service name

          Where host is the SCAN hostname of the Zero Data Loss Recovery Appliance.

        • Provide the Virtual Private Catalog (VPC) Users: Provide a VPC user name for connecting to the Zero Data Loss Recovery Appliance. You can specify multiple VPC user names in case you want to use the appliance as a backup destination for multiple databases. This information is typically provided by the Zero Data Loss Recovery Appliance administrator.
      • If you select Network Storage (NFS), then you must also specify the following:

        • Self-mount for non-autonomous databases:

          Provide the local NFS mount point path: Specify the local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes.

        • Auto-mount for Autonomous Databases:

          Use this destination for Autonomous Databases:
          • NFS server: Specify the IP address of the NFS server. Optionally, you can specify up to four IP addresses. These are just extra paths to the same NFS server. Note that Oracle supports only one NFS device for backups.
          • NFS export share: Specify the directory path where the exported file system is mounted.
    4. Configure Advanced Options.
      • Tags: (Optional) You can choose to apply tags. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, refer to information about resource tags. If you are not sure if you should apply tags, then skip this option (you can apply tags later), or ask your administrator.
  6. Click Create Backup Destination.

    The Backup Destination Details page displays the newly created backup destination.

Using the Console to Edit a Backup Destination

To edit a backup destination, be prepared to provide values for the backup destination configuration.

You can only edit a backup destination if it is not currently associated with database.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to edit.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to edit.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Edit.
  6. Use the Edit Backup Destination dialog to edit the backup destination attributes:
    Note

    You cannot edit a Backup Destination if there is already a database attached to it.

    • If you are editing a Zero Data Loss Recovery Appliance backup destination:
      • Provide the Recovery Appliance connection string: Specify the Oracle Net Services connection string that connects to the Recovery Appliance. This information is typically provided by the Recovery Appliance administrator.
      • Provide the Virtual Private Catalog (VPC) Users: Provide a VPC user name for connecting to the Recovery Appliance. You can specify multiple VPC user names in case you want to use the Recovery Appliance as a backup destination for multiple databases. This information is typically provided by the Recovery Appliance administrator.
    • If you are editing an NFS backup destination:

      • Self-mount for non-autonomous databases:

        Provide the local NFS mount point path: Specify the local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes.

      • Auto-mount for Autonomous Databases:

        Use this destination for Autonomous Databases:
        • NFS server: Specify the IP address of the NFS server. Optionally, you can specify up to four IP addresses.
        • NFS export share: Specify the directory path where the exported file system is mounted.
  7. Click Save Changes.
Using the Console to Move a Backup Destination to Another Compartment

To move a backup destination, be prepared to provide values for the backup destination configuration.

You can change the compartment that contains your backup destination by moving it.

When you move a backup destination, the compartment change does not affect other associated resources. These other resources, such as the associated databases, remain in their current compartment.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to move.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to move.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Move Resource.
  6. In the resulting dialog, choose the new compartment for the backup destination and click Move Resource.
Using the Console to Delete a Backup Destination

To delete a backup destination, be prepared to provide values for the backup destination configuration.

Before you can delete a backup destination, you must ensure that it is not associated with any databases.

Deleting a backup destination:
  • Does not remove any residual backups that are left in the backup destination
  • Removes all references to the deleted backup destination from the Cloud Control Plane
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to delete.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to delete.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Delete.
  6. In the resulting dialog, enter the backup destination name and click Delete Backup Destination to confirm the action.

Using the API to Manage Exadata Cloud@Customer Backup Destinations

Review the list of API calls to manage your Exadata Database Service on Cloud@Customer backup destinations.

For information about using the API and signing requests, see "REST APIs" and "Security Credentials". For information about SDKs, see "Software Development Kits and Command Line Interface".

Use these API operations to manage Exadata Database Service on Cloud@Customer backup destinations:
  • CreateBackupDestination
  • DeleteBackupDestination
  • GetBackupDestination
  • ListBackupDestination
  • UpdateBackupDestination
  • ChangeBackupDestinationCompartment

For the complete list of APIs, see "Database Service API".

Oracle Database Backup Methods in Exadata Cloud

Oracle Exadata Cloud@Customer offers two approaches to configure and take backups as a recommended solution: Oracle Managed Backup and User Configured Backup.

  • Oracle Managed Backup
    Database backups are managed entirely by the Oracle Exadata Cloud@Customer service based on a one-time configuration.
  • User Configured Backup
    It is the user's responsibility to configure and execute backup operations using dbaascli according to their preferences.

Parent topic: Manage Database Backup and Recovery on Oracle Exadata Database Service on Cloud@Customer

Oracle Managed Backup

Database backups are managed entirely by the Oracle Exadata Cloud@Customer service based on a one-time configuration.

Once configured, you need not perform any maintenance such as backup scheduling and deletion of the backups. Oracle manages the backups through well-defined workflows. Certain backup configuration parameters are not fully integrated with the Oracle Managed Backup workflow. If you want to set any of those parameters for the backups, then you can use dbaascli database backup —configure to set them. For more information, see Configuring Database for Backup.

Backup Destinations

Parent topic: Oracle Managed Backup

About Managing Backup Destinations for Exadata Database Service on Cloud@Customer

For backups, you can either use the Exadata Database Service on Cloud@Customer backup facility, or you can configure a backup location on a location you manage.

Exadata Database Service on Cloud@Customer provides a backup facility, which you can configure individually on each database.

See: Managing Databases on Exadata Cloud@Customer and Managing Database Backup and Recovery on Exadata Cloud@Customer.

If you want to store backups on a Recovery Appliance, or on a network file storage (NFS) location that you manage, then you must first create a backup destination. Each backup destination defines the properties that are required to connect to the Recovery Appliance or NFS location, and each backup destination must be accessible in your data center from the VM cluster nodes.

The Exadata Database Service on Cloud@Customer backup facility can also store backups on Oracle Cloud Infrastructure object storage, or on local Exadata storage on your Exadata Database Service on Cloud@Customer system. However, you do not need to create a backup destination for any of these other locations. Instead, applicable options for backup to cloud object storage or local Exadata storage are available directly when you create a database.

Note

Avoid entering confidential information when assigning descriptions, tags, or friendly names to your cloud resources through the Oracle Cloud Infrastructure Console, API, or CLI.

Prerequisites for Backup Destinations for Exadata Database Service on Cloud@Customer

To configure backup destinations on a Zero Data Loss Recovery Appliance location, or an NFS backup location, review the prerequisites.

  • For a Zero Data Loss Recovery Appliance backup destination:
    • The appliance must be configured with a virtual private catalog (VPC) user, which is used for taking the backups.
    • The appliance must be configured with the unique database name of the database being backed up, and a mapping to the VPC user.
    • The appliance must be accessible from the Exadata Database Service on Cloud@Customer system using the Oracle Net Services connection string, which is provided by the Zero Data Loss Recovery Appliance administrator.
  • For an NFS backup destination:
    • Exadata Database Service on Cloud@Customer non-autonomous databases:
      • You must mount the NFS server location to a local mount point directory on each node in the VM cluster.
      • The local mount point directory and the NFS server must be identical across all nodes in the cluster.
      • You must ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
      • The NFS-mounted file system must be readable and writable by the oracle operating system user on all of the VM cluster nodes.
    • Autonomous Database on Cloud@Customer:
      Note

      Oracle Autonomous Database on Exadata Cloud@Customer supports NFS versions 3 and 4. Mounts with both versions enabled, however, default to version 4.
      • To ensure that the Autonomous VM cluster can access the NFS server over the (preferred) Backup Network, enter valid Backup Network IP addresses while configuring the VM Cluster Network.

        If the backup destination is not accessible over the backup network but accessible over the client network, the backup traffic will be routed over the client network.

      • The NFS-mounted file system must be readable and writable by the oracle operating system user on all of the VM cluster nodes.
      • If permissions are being controlled at the user level, then the uid:gid of the oracle user for the Autonomous VM cluster is 1001:1001.

Parent topic: Backup Destinations

Using the Console for Backup Destinations for Exadata Database Service on Cloud@Customer

Learn how to use the console to create, edit, move, and terminate a backup destination for your infrastructure for Oracle Exadata Database Service on Cloud@Customer.

Parent topic: Backup Destinations

Using the Console to Create a Backup Destination

To create a backup destination, be prepared to provide values for the backup destination configuration.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region that contains your Exadata infrastructure.
  3. Click Backup Destinations.
  4. Click Create Backup Destination.
  5. Provide the requested information in the Create Backup Destination page:
    1. Choose a compartment.

      From the list of available compartments, choose the compartment that you want to contain the backup destination.

    2. Name your backup destination.

      Specify a user-friendly name that you can use to identify the backup destination. The name doesn't need to be unique because an Oracle Cloud Identifier (OCID) uniquely identifies the backup destination.

    3. Choose either a Zero Data Loss Recovery Appliance or a network file system (NFS) backup destination.
      Note

      You can also set OCI Object Store as a backup destination. However, you cannot set it from this screen. You can configure OCI Object Store as a backup destination when creating a database. For more information, see Backup Destination Type in Using the Console to Create a Database.

      Select Recovery Appliance or Network Storage (NFS).

      • If you select Recovery Appliance, then you must also specify the following for Zero Data Loss Recovery Appliance:
        • Provide the Recovery Appliance connection string: Specify the Oracle Net Services connection string that connects to the appliance. This information is typically provided by the Zero Data Loss Recovery Appliance administrator.
          Note

          ADB customers must ensure to provide the connection string that connects to the recovery appliance in an Oracle "easy connect" string format, as shown below:
          host:port/service name

          Where host is the SCAN hostname of the Zero Data Loss Recovery Appliance.

        • Provide the Virtual Private Catalog (VPC) Users: Provide a VPC user name for connecting to the Zero Data Loss Recovery Appliance. You can specify multiple VPC user names in case you want to use the appliance as a backup destination for multiple databases. This information is typically provided by the Zero Data Loss Recovery Appliance administrator.
      • If you select Network Storage (NFS), then you must also specify the following:

        • Self-mount for non-autonomous databases:

          Provide the local NFS mount point path: Specify the local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes.

        • Auto-mount for Autonomous Databases:

          Use this destination for Autonomous Databases:
          • NFS server: Specify the IP address of the NFS server. Optionally, you can specify up to four IP addresses. These are just extra paths to the same NFS server. Note that Oracle supports only one NFS device for backups.
          • NFS export share: Specify the directory path where the exported file system is mounted.
    4. Configure Advanced Options.
      • Tags: (Optional) You can choose to apply tags. If you have permissions to create a resource, then you also have permissions to apply free-form tags to that resource. To apply a defined tag, you must have permissions to use the tag namespace. For more information about tagging, refer to information about resource tags. If you are not sure if you should apply tags, then skip this option (you can apply tags later), or ask your administrator.
  6. Click Create Backup Destination.

    The Backup Destination Details page displays the newly created backup destination.

Using the Console to Edit a Backup Destination

To edit a backup destination, be prepared to provide values for the backup destination configuration.

You can only edit a backup destination if it is not currently associated with database.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to edit.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to edit.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Edit.
  6. Use the Edit Backup Destination dialog to edit the backup destination attributes:
    Note

    You cannot edit a Backup Destination if there is already a database attached to it.

    • If you are editing a Zero Data Loss Recovery Appliance backup destination:
      • Provide the Recovery Appliance connection string: Specify the Oracle Net Services connection string that connects to the Recovery Appliance. This information is typically provided by the Recovery Appliance administrator.
      • Provide the Virtual Private Catalog (VPC) Users: Provide a VPC user name for connecting to the Recovery Appliance. You can specify multiple VPC user names in case you want to use the Recovery Appliance as a backup destination for multiple databases. This information is typically provided by the Recovery Appliance administrator.
    • If you are editing an NFS backup destination:

      • Self-mount for non-autonomous databases:

        Provide the local NFS mount point path: Specify the local directory path on each VM cluster node where the NFS server location is mounted. The local directory path and the NFS server location must each be the same across all of the VM cluster nodes.

      • Auto-mount for Autonomous Databases:

        Use this destination for Autonomous Databases:
        • NFS server: Specify the IP address of the NFS server. Optionally, you can specify up to four IP addresses.
        • NFS export share: Specify the directory path where the exported file system is mounted.
  7. Click Save Changes.
Using the Console to Move a Backup Destination to Another Compartment

To move a backup destination, be prepared to provide values for the backup destination configuration.

You can change the compartment that contains your backup destination by moving it.

When you move a backup destination, the compartment change does not affect other associated resources. These other resources, such as the associated databases, remain in their current compartment.

  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to move.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to move.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Move Resource.
  6. In the resulting dialog, choose the new compartment for the backup destination and click Move Resource.
Using the Console to Delete a Backup Destination

To delete a backup destination, be prepared to provide values for the backup destination configuration.

Before you can delete a backup destination, you must ensure that it is not associated with any databases.

Deleting a backup destination:
  • Does not remove any residual backups that are left in the backup destination
  • Removes all references to the deleted backup destination from the Cloud Control Plane
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the backup destination that you want to delete.
  3. Click Backup Destinations.
  4. Click the name of the backup destination that you want to delete.

    The Backup Destination Details page displays information about the selected backup destination.

  5. Click Delete.
  6. In the resulting dialog, enter the backup destination name and click Delete Backup Destination to confirm the action.
Using the API to Manage Exadata Cloud@Customer Backup Destinations

Review the list of API calls to manage your Exadata Database Service on Cloud@Customer backup destinations.

For information about using the API and signing requests, see "REST APIs" and "Security Credentials". For information about SDKs, see "Software Development Kits and Command Line Interface".

Use these API operations to manage Exadata Database Service on Cloud@Customer backup destinations:
  • CreateBackupDestination
  • DeleteBackupDestination
  • GetBackupDestination
  • ListBackupDestination
  • UpdateBackupDestination
  • ChangeBackupDestinationCompartment

For the complete list of APIs, see "Database Service API".

Automatic Backup and Recovery

Parent topic: Oracle Managed Backup

About Managing Database Backup for Oracle Exadata Database Service on Cloud@Customer

Learn how configure backup when creating the database on Oracle Exadata Database Service on Cloud@Customer.

Oracle Exadata Database Service on Cloud@Customer provides automatic database backup facilities that use Oracle Recovery Manager (RMAN). When you create a database on Oracle Exadata Database Service on Cloud@Customer, you can specify a backup destination and enable automatic backups. For more information, refer to the information in this publication about managing backup destinations for Oracle Exadata Database Service on Cloud@Customer.

After database creation, you can also:

  • View a list of available backups.
  • Enable or disable automatic backups.
  • Edit backup settings.
  • Restore a database.

You can perform these operations by using either the Console, or the API.

Automatic database backups are configured as follows:

  • Automatic backups are scheduled daily. The automatic backup process can run at any time within the daily backup window, which is between midnight and 6:00 AM in the time zone of the virtual machine (VM) cluster that hosts the database.

  • Automatic backups use a combination of full (RMAN level 0) and incremental (RMAN level 1) database backups:

    • For backups to a Zero Data Loss Recovery Appliance, after an initial full backup is performed, Zero Data Loss Recovery Appliance creates and validates virtual full backups from each daily incremental backup.
    • For backups to NFS, or OSS, the default interval between level 0 backups is seven days. The default level 0 day is Sunday.
    • For backups to Local Exadata Storage:

      The retention period option for Local Exadata Storage is 7 or 14 days. Regardless of the retention window selected for backups to Local Exadata Storage, incremental level 1 backups are always performed after the initial level 0 image copy is taken. Also, the incremental level 1 backups are merged into the level 0 image copy backup when they become older than the retention period.

      For example: A 14 day for Local retention window includes one "merged" level 0 , 14 incremental level 1's plus archivelogs for the 14 days.

  • The retention period defines the period for which automatic backups are maintained:

    • For backups to Zero Data Loss Recovery Appliance, the retention policy that is implemented in the appliance controls the retention period.
    • For backups to local Exadata storage, you can choose a retention period of 7 days, or 14 days. The default retention period is 7 days.
    • For backups to Oracle Cloud Infrastructure Object Storage, or to an NFS backup destination, you can choose one of the following preset retention periods: 7 days, 14 days, 30 days, 45 days, or 60 days. The default retention period is 30 days.
  • By default, Oracle Database runs in ARCHIVELOG mode, and archived redo log files are backed up every 30 minutes. .
  • Regardless of the backup destination, backups of user data are encrypted by default.

While a backup is in progress, Oracle recommends that you avoid performing actions that could interfere with availability, such as restarting virtual machines, or applying patches. If an automatic backup operation fails, then the backup is deferred until the next day’s backup window.

When required, you can restore Oracle Database to:

  • The latest available restore point.
  • A specific point in time by providing a time stamp.
  • An Oracle Database System Change Number (SCN).
Note

The backup and recovery facilities described in this topic cater only for database backup and recovery, which includes Oracle Database data files, log files, control files, and the server parameter (SP) file. You are responsible for backing up other files on your virtual machines. In particular, Oracle strongly recommends that you back up the Transparent Data Encryption (TDE) keystore (wallet). Without the TDE keystore, the Oracle Database backups are effectively useless, because you cannot read the data contained in the backup.
Note

If TAG based recovery fails with error ORA-01152, then use Recovery Manager (RMAN) directly to complete the recovery.

If the server parameter file (SPFILE) recovery fails for local configuration using dbaascli, then use Recovery Manager (RMAN) directly to complete the recovery.

Using the Console to Configure and Manage Backup and Recovery

Learn how to use the console to view a list of available backups, edit backup settings, and restore a database for Oracle Exadata Database Service on Cloud@Customer.

Parent topic: Automatic Backup and Recovery

Viewing a List of Available Backups with the Console

To view a list of available backups with Oracle Exadata Database Service on Cloud@Customer, complete this procedure.

Note

Only the managed backups are synced to the Console. If you configure backups directly in the backend, then they are not synced to the Console. This is an expected behavior and Oracle has no plans to change this behavior.
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the VM cluster that hosts the database in which you are interested.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that hosts the database in which you are interested.
  5. In the Resources list of the VM Cluster Details page, click Databases.
  6. Click the name of the database in which you are interested.
    The Database Details page displays information about the selected database, which includes a list of the available backups.
Editing Backup Settings with the Console

To edit backup destinations, change backup schedules and other backup administration, you can use with the Oracle Exadata Database Service on Cloud@Customer console.

Use this procedure to change the available backup settings:
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the VM cluster that hosts the database for which you want to edit backup settings.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that hosts the database for which you want to edit backup settings.
  5. In the Resources list of the VM Cluster Details page, click Databases.

  6. Click the name of the database for which you want to edit backup settings.

    The Database Details page displays information about the selected database.

  7. Click Edit Backup Settings.

  8. Your current backup configuration determines the changes that you can make in the Backup Settings dialog, as follows:

    • If automatic backups are not configured (Backup Destination Type is set to None), then you can use the following settings to define the backup configuration for the database:

      • Backup Destination Type: From the list, choose an option.

        • None Select if you do not define a backup configuration for the database.

        • Local Select to store backups locally in the Exadata Storage Servers on your Exadata Database Service on Cloud@Customer system.

          This option is available only if you enabled backups on local Exadata storage in the VM cluster that you want to host the database.

        • Object Storage Select to store backups in an object storage container managed by Oracle on Oracle Cloud Infrastructure.

          To use this option, your Exadata Database Service on Cloud@Customer system must have egress connectivity to Oracle Cloud Infrastructure Object Storage.

        • NFS Select to store backups in one of your previously defined backup destinations that uses Network File System (NFS) storage. See "Managing Backup Destinations for Exadata Database Service on Cloud@Customer".

          If you select this option, then you must also choose from the list of NFS Backup Destinations.

        • Recovery Appliance Select to store backups in one of your previously defined backup destinations that uses Oracle Zero Data Loss Recovery Appliance. See Managing Backup Destinations for Exadata Database Service on Cloud@Customer.

          If you select this option, then you must also provide the following information:

          • Choose Backup Destinations from the list of Recovery Appliance .
          • Choose from the VPC User list, which contains the list of virtual private catalog (VPC) user names that are defined in the Recovery Appliance backup destination.
          • Provide the Password for the VPC user.
          Note

          If you select a backup destination (other than None), then you cannot change it later.

          For more information on customizing Real Time Redo Transport (RTRT) behavior, see Customizing Real Time Redo Transport (RTRT) Behavior for Recovery Appliance Backups

      • Enable automatic backups: Select this option to enable daily backups using the policy for automatic backups.

        This option is only enabled when you select a Backup Destination Type other than None. You can change this setting later.

      • Backup retention period: Select this option to choose one of the options for the length of time that automatic backups are retained.

        For backups to local Exadata storage, you can choose a retention period of 7 days, or 14 days. The default retention period is 7 days.

        For backups to Oracle Cloud Infrastructure Object Storage or to an NFS backup destination, you can choose one of the following preset retention periods: 7 days, 14 days, 30 days, 45 days, or 60 days. The default retention period is 30 days.

        This option does not apply to Recovery Appliance backup destinations. For backups to Oracle Zero Data Loss Recovery Appliance, the retention policy that is implemented in the appliance controls the retention period.

    • If automatic backups were previously configured, then you can make the following changes:

      • For Oracle Zero Data Loss Recovery Appliance backup destinations, you can update the Password for the virtual private catalog (VPC) user that is used to access the appliance.
      • For backup destinations that do not use Oracle Zero Data Loss Recovery Appliance, you can update the Backup retention period for automatic backups:
        • For backups to local Exadata storage, you can choose a retention period of 7 days or 14 days. The default retention period is 7 days.
        • For backups to Oracle Cloud Infrastructure Object Storage, or to an NFS backup destination, you can choose one of the following preset retention periods: 7 days, 14 days, 30 days, 45 days, or 60 days. The default retention period is 30 days.
        • For backups to Oracle Zero Data Loss Recovery Appliance, the retention policy that is implemented in the appliance controls the retention period.
      • You can set the option to Enable automatic backups. Select this option to enable automatic database backups. Deselect this option to suspend automatic database backups.
  9. Click Save Changes.
Restoring a Database with the Console

To restore a database to a point in time, to a system change number (SCN), or to the latest backup, use the Exadata Database Service on Cloud@Customer Console.

Use the following procedure to restore a database:
  1. Open the navigation menu. Under Oracle Database, click Exadata Database Service on Cloud@Customer.
  2. Choose the Region and Compartment that contains the VM cluster that hosts the database that you want to restore.
  3. Click VM Clusters.
  4. Click the name of the VM cluster that hosts the database that you want to restore.
  5. In the Resources list of the VM Cluster Details page, click Databases.
  6. Click the name of the database that you want to restore.

    The Database Details page displays information about the selected database.

  7. Click Restore Database.
  8. In the resulting dialog box, select one of the following options, and click Restore Database:
    • Restore to latest: The database is restored and recovered with zero, or least possible, data loss.
    • Restore to a timestamp: The database is restored and recovered to the specified timestamp.
    • Restore to SCN: The database is restored and recovered to the specified Oracle Database System Change Number (SCN). The specified SCN must be valid otherwise the operation fails.
Note

Backup fails after a point in time restore to a timestamp or SCN on NFS storage. Wait for 10 minutes or so before proceeding with the backup.
Using the API to Manage Database Backup and Recovery

Learn how to use the API to manage database backup and recovery with Oracle Exadata Database Service on Cloud@Customer.

For information about using the API and signing requests, see "REST APIs" and "Security Credentials". For information about SDKs, see "Software Development Kits and Command Line Interface".

Use these API operations to manage database backup and recovery:

  • GetBackup
  • ListBackups
  • RestoreDatabase
  • UpdateDatabase - To enable and disable automatic backups.

For the complete list of APIs, see "Database Service API".

User Configured Backup

It is the user's responsibility to configure and execute backup operations using dbaascli according to their preferences.

Backups using dbaascli are not recognized as Oracle managed backups. Use the dbaascli database backup, dbaascli pdb backup, dbaascli database recover, and dbaascli pdb recover commands to configure and perform various backup and recover operations.

If customers configure backups to Object Storage using RMAN without using the OCI Control Plane or OCI APIs, customers are responsible for manually configuring TDE Wallet backups. By default, Oracle cloud automation cleans up archive log files every 24 hours. When you use RMAN to perform manual backups, there is a risk of the archive logs being deleted. Refer to dbaascli database backup for information on how to configure the archive log cleanup. The recommendation is to use Oracle managed backups.

How to Backup Using dbaascli for User Configured Backup

User configured backups involve the following 4 steps:
  1. Set up network and security rules to allow database hosts to store backup to the desired storage destination. For Exadata Cloud Service, refer to Network Setup for Exadata Cloud Service Instances.
  2. Set up Backup Destination
  3. Configure database with a Backup Destination
  4. Backup database

Related Topics

Parent topic: User Configured Backup

Setting up Backup Destination

Depending on the Oracle Database Cloud Service, Oracle Exadata Cloud@Customer, or Oracle Exadata Cloud Service, you can choose one of the following backup destinations for storing backups.

  • Oracle Cloud Infrastructure Object Storage: Applies to Exadata Cloud@Customer and Exadata Cloud Service.
  • Zero Data Loss Recovery Appliance (ZDLRA): Applies to Exadata Cloud@Customer.
  • Network File System (NFS): Applies to Exadata Cloud@Customer.
  • Fast Recovery Area (FRA): Applies to Exadata Cloud@Customer.
Configuring Database for Backup

Once the backup destination is set up and available, you can use the dbaascli utility to configure the database with backup destination and associated configuration parameters, for example, Backup Retention Recovery Window, Backup Scheduling, Archivelog Scheduling, and so on.

The configuration parameters are specified through an input configuration file having a list of parameter=value pairs. The template for this input file can be generated using --getConfig option, which can be modified according to desired destination settings and other preferences and then used as input to --configure option. 

dbaascli database backup --getConfig --dbName <value> --configFile <value>
Returns the Backup configuration of the database in a file specified by the user. If the backup is never configured, it returns the default template where the user can fill the configuration parameters with their values and use it as input to --configure command option.
Using dbaascli database backup --configure, you can set the backup configuration information for a database in the following cases:
  1. User Managed Backup: Set complete backup configuration based on the destination.
  2. Oracle Managed Backup: Set additional configuration parameters if a parameter is compatible with Oracle Managed Backup.

    Note that using dbaascli database backup --configure to set incompatible parameters with Oracle Managed Backups can lead to backup/recovery issues. Currently, Oracle does not validate whether a parameter is compatible or not. Until Oracle implements validation, it is your responsibility to verify compatibility. 

    dbaascli database backup --configure --dbName <value> --configFile <value>
    This asynchronous command generates a universally unique identifier (UUID), which you can use to track the status.
    dbaascli database backup status --uuid <value> --dbname <value>
    To retrieve the current configuration for the validation, run:
    dbaascli database --dbaname --getConfig
    Note

    When using Oracle Managed Backups, you may want to change some of the backup configuration settings based on your application requirements. You can use dbaascli to modify these parameters if they are tagged with Compatible with console automatic backup.

Configuration Parameters for Backup

Table 5-19 General Configuration Parameters (valid for all backup destinations except Local Storage (FRA))

Parameter Description Compatible with Oracle Managed Backup
bkup_rman_compression Level of compression applied to automatic backups.

Valid values are NONE, basic, low, medium, and high.

Default: low.

NONE disables RMAN compression.

Yes
bkup_set_section_size Enables the use of the RMAN multisection backup feature.

Valid values are yes and no.

Yes
bkup_section_size RMAN section size that is used for automatic backups.

The default value is 64G.

Applicable only when bkup_set_section_size is set to yes.

Yes
bkup_channels_node The number of RMAN channels per node used for automatic backups.

Valid values are between 1 and 32.

 Yes
bkup_daily_time Start time of the automatic daily backup expressed in 24-hour time format as hh:mm. Exadata Cloud@Customer: Yes

Exadata Cloud Service: No

Not compatible with Oracle Managed Backup in Exadata Cloud Service. Scheduling responsibility resides with the Control Plane.
bkup_archlog_frequency Interval in minutes between automatic backups of archived database log files.

Valid values are 15, 20, 30, 60, 120 through 1440 in 1-hour intervals expressed in minutes.

Default: 30 for Exadata Cloud@Customer.

 Yes
bkup_l0_day This parameter controls the Level 0 day of the week for both OSS and NFS.

Day of the week when a level 0 backup is taken.

Valid values are mon, tue, wed, thu, fri, sat, sun. Longer formats, for example, Monday, Tuesday are also supported.

Applicable only when bkup_oss is set to yes.

Default: sun.

Exadata Cloud@Customer: Yes

Exadata Cloud Service: No

Not compatible with Oracle Managed Backup in Exadata Cloud Service. Scheduling responsibility resides with the Control Plane.

Configuration Parameters for Object Storage Service (OSS) Destination

Table 5-20 Configuration Parameters for Object Storage Service (OSS) Destination

Parameter Description Compatible with Oracle Managed Backup
bkup_oss Object storage service will be used as the backup destination.

Valid values are yes and no.

No
bkup_oss_recovery_window The retention period for the backups is up to 90.

Applicable only when bkup_oss is set to yes.

Default: 30.

 No
bkup_oss_url Location of the storage container that is used for backup to cloud storage.

Applicable only when bkup_oss is set to yes.

No
bkup_oss_user User name of the Oracle Cloud user having the write privileges on the cloud storage container specified in bkup_oss_url.

Applicable only when bkup_oss is set to yes.

No
bkup_oss_passwd The password of the Oracle Cloud user having the write privileges on the cloud storage container specified in bkup_oss_url.

Applicable only when bkup_oss is set to yes.

No
Note

Currently, Zero Data Loss Recovery Appliance (ZDLRA) destination is supported only on Exadata Cloud@Customer.

Configuration Parameters for Zero Data Loss Recovery Appliance (ZDLRA) Destination

Table 5-21 Configuration Parameters for Zero Data Loss Recovery Appliance (ZDLRA) Destination

Parameter Description Compatible with Oracle Managed Backup
bkup_zdlra Enables backups to a Recovery Appliance.

Valid values are yes and no.

No
bkup_zdlra_url Location of the Recovery Appliance that is being used for backups.

Applicable only when bkup_zdlra is set to yes.

No
bkup_zdlra_user The virtual private catalog (VPC) user name for the Recovery Appliance specified in bkup_zdlra_url.

Applicable only when bkup_zdlra is set to yes.

No
bkup_zdlra_passwd The password of the Recovery Appliance user specified in bkup_zdlra_url.

Applicable only when bkup_zdlra is set to yes.

No

For more information, see Customizing Real Time Redo Transport (RTRT) Behavior for Recovery Appliance Backups.

Configuration Parameters for Network File System (NFS) Destination

Table 5-22 Configuration Parameters for Network File System (NFS) Destination

Parameter Description Compatible with Oracle Managed Backup
bkup_nfs Enables backups to NFS mounted directory.

Valid values are yes and no.

No
bkup_nfs_loc The NFS mounted location, the directory provided must be a mount point and available on all nodes.

Applicable only when bkup_nfs is set to yes.

No
bkup_nfs_recovery_window The retention period for backups on NFS storage is expressed as a number of days up to 90.

Applicable only when bkup_nfs is set to yes.

Default: 30.

 No
Note

Currently, Network File System (NFS) destination is supported only on Exadata Cloud@Customer.

Configuration Parameters for Local Storage (FRA) Destination

Table 5-23 Configuration Parameters for Local Storage (FRA) Destination

Parameter Description Compatible with Oracle Managed Backup
bkup_disk Enables backups to local Exadata storage.

Valid values are yes and no.

No
bkup_disk_recovery_window The retention period for backups on local Exadata storage is expressed as a number of days up to 14.

Applicable only when bkup_disk is set to yes.

Default: 7.

 No
Note

Currently, Local Storage (FRA) destination is supported only on Exadata Cloud@Customer.

Backing Up a Container Database (CDB)

Before performing a backup, you must set up the backup configuration using dbaascli database backup --configure command as a prerequisite. For more information, see dbaascli database backup.

Backing Up a Pluggable Database (PDB)

You can also perform a backup of a specific PDB. This is useful if one or more PDBs need to be backed up immediately or adhoc need basis, instead of backing up the complete CDB which has its own schedule. For more information, see dbaascli pdb backup.

Fetching Backup Job Status

As the backup operation is being run, its status can be monitored by providing the job ID that is displayed to the user when the backup command is executed. For more information, see dbaascli database backup and dbaascli pdb backup.

How to Recover a Database

To perform recovery of the database, there are various options depending on the type of fault, availability of data, and its' backup and recovery requirement. For more information, see dbaascli database recover.

Recovering a PDB

You can also recover a particular PDB instead of complete CDB whenever that can be avoided. It reduces the impact of the outage as only the particular PDB is being recovered while the rest of the CDB and PDBs are still available for business and applications. For more information, see dbaascli pdb recover.

Related Topics

Parent topic: How to Recover a Database

Fetching Recover Job Status

Similar to backup, the recovery commands' status can be monitored by providing the job ID that is displayed to the user when the recovery command is executed. To know the status of recovery operation: For more information, see dbaascli database recover and dbaascli pdb recover.

Configuring and Customizing Backups with bkup_api

In addition to the console-based automated backup option, there is a command line backup utility, bkup_api, which can allow for further customization. If configuring backups using bkup_api instead of the console, then do not enable backups for your database in the console.

Note

bkup_api will be deprecated in a future release. Use the dbaascli database backup, dbaascli pdb backup, dbaascli database recover, and dbaascli pdb recover commands to backup and recover container databases and pluggable databases. For more information, see User Configured Backup.

Related Topics

Parent topic: Manage Database Backup and Recovery on Oracle Exadata Database Service on Cloud@Customer

Customizing Backup Settings by Using a Generated Configuration File

You can customize backup settings for a database deployment by generating a file containing the current customizable settings, editing the file, and then using the file to update the backup settings.

WARNING:

In general, bkup_api configured backups, as described in this section, should not be used in conjunction with console-enabled automatic backups, other than the exceptions noted specifically below. If using parameters, other than those noted as safe below, then do not enable console-based backups; otherwise, conflicting conditions or over-writes of settings can occur, and backups may not execute successfully.

To generate a configuration file with the current backup settings and use it to update the settings:

  1. Connect to a virtual machine as opc user.

    For detailed instructions, see Connecting to a Virtual Machine with SSH.

  2. Start a root user command shell:
    sudo -s
  3. Use the bkup_api get config command to generate a file containing the current backup settings for the database deployment:
    # /var/opt/oracle/bkup_api/bkup_api get config [--file=filename] --dbname=dbname

    Where:

    filename is an optional parameter used to specify a name for the file that is generated

    dbname is the database name for the database that you want to act on

  4. Edit the parameter values in the generated file to change any settings you want to customize in the backup configuration.

    The following parameters can be modified to customize the backup configuration:

    Note

    Compatible with Console Automatic Backups=Yes indicates the parameter is safe to change, even when using console-based automatic backups. If using parameters with Compatible with Console Automatic Backups=No, then do not enable backups through the console.

    Table 5-24 Backup Configuration Parameters - Cron Parameters Specific to bkup_api

    Parameter Description Compatible with Console Automatic Backups*

    bkup_cron_entry

    Enables the automatic backup configuration.

    Valid values are yes and no.

    		No

    bkup_cfg_files
    Note

    for ZDLRA, backups of the system/database configuration will not occur.
    		No

    Table 5-25 Backup Configuration Parameters - General RMAN Configuration Parameters (valid for all backup destinations except Local Storage (FRA))

    Parameter Description Compatible with Console Automatic Backups*

    bkup_rman_compression

    Level of compression applied to automatic backups.

    Valid values are NONE, basic, low, medium, and high.

    Default value is low.

    A value of NONE disables rman compression.

    If RMAN compression is enabled, then any TDE encrypted datafile will be decrypted, compressed, and RMAN encrypted.

    Yes

    bkup_set_section_size

    Enables the use of the RMAN multisection backup feature.

    Valid values are yes and no.

    Yes

    bkup_section_size

    RMAN section size that is used for automatic backups.

    Default value is 64G.

    Applicable only when bkup_set_section_size is set to yes.

    Yes

    bkup_channels_node

    Number of RMAN channels per node used for automatic backups.

    Valid values are between 1 and 32.

    Default value is 4.

    Yes

    bkup_daily_time

    Start time of the automatic daily backup expressed in 24-hour time as hh:mm.

    Yes

    bkup_archlog_frequency

    Interval in minutes between automatic backups of archived database log files.

    Valid values are 15, 20, 30, 60, 120 through 1440 in 1 hour intervals expressed in minutes.

    Default value is 30 for Exadata Cloud@Customer.

    Yes

    Table 5-26 Backup Configuration Parameters - Local Storage (FRA) Parameters

    Parameter Description Compatible with Console Automatic Backups*

    bkup_disk

    Enables backups to local Exadata storage.

    Valid values are yes and no.

    No

    bkup_disk_recovery_window

    Retention period for backups on local Exadata storage, expressed as a number of days up to 14.

    Applicable only when bkup_disk is set to yes.

    Default value is 7.

    No

    Table 5-27 Backup Configuration Parameters - Network File System (NFS) Parameters

    Parameter Description Compatible with Console Automatic Backups*

    bkup_nfs

    Enables backups to NFS mounted directory.

    Valid values are yes and no.

    No

    bkup_nfs_loc

    The NFS mounted location, the directory provided must be a mountpoint and available on all nodes.

    No

    bkup_nfs_recovery_window

    Retention period for backups on NFS storage, expressed as a number of days up to 90.

    Applicable only when bkup_nfs is set to yes.

    Default value is 30.

    No

    bkup_oss_l0_day

    This parameter control the Level 0 day of the week for both OSS and NFS.

    Day of the week when a level 0 backup is taken and stored on cloud storage or for NFS.

    Valid values are mon, tue, wed, thu, fri, sat, sun.

    Applicable only when bkup_nfs is set to yes.

    Default value is sun.

    Yes

    Table 5-28 Backup Configuration Parameters - Object Storage Service (OSS) Parameters

    Parameter Description Compatible with Console Automatic Backups*

    bkup_oss

    Enables backups to cloud storage.

    Valid values are yes and no.

    No

    bkup_oss_recovery_window

    Retention period for backups to cloud storage, expressed as a number of days up to 90.

    Applicable only when bkup_oss is set to yes.

    Default value is 30.

    No

    bkup_oss_url

    Location of the storage container that is used for backup to cloud storage.

    Applicable only when bkup_oss is set to yes.

    No

    bkup_oss_user

    User name of the Oracle Cloud user having write privileges on the cloud storage container specified in bkup_oss_url.

    Applicable only when bkup_oss is set to yes.

    No

    bkup_oss_passwd

    Password of the Oracle Cloud user having write privileges on the cloud storage container specified in bkup_oss_url.

    Applicable only when bkup_oss is set to yes.

    No

    bkup_oss_l0_day

    This parameters control the Level 0 day of the week for both OSS and NFS.

    Day of the week when a level 0 backup is taken and stored on cloud storage.

    Valid values are mon, tue, wed, thu, fri, sat, sun.

    Applicable only when bkup_oss is set to yes.

    Default value is sun.

    Yes
    Note

    Zero Data Loss Recovery Appliance (ZDLRA) parameters are only valid for Exadara Cloud@Customer installations.

    Table 5-29 Backup Configuration Parameters - Zero Data Loss Recovery Appliance (ZDLRA) Parameters

    Parameter Description Compatible with Console Automatic Backups*

    bkup_zdlra

    Enables backups to a Recovery Appliance.

    Valid values are yes and no.

    No

    bkup_zdlra_url

    Location of the Recovery Appliance that is being used for backups.

    Applicable only when bkup_zdlra is set to yes.

    No

    bkup_zdlra_user

    The virtual private catalog (VPC) user name for the Recovery Appliance specified in bkup_zdlra_url.

    Applicable only when bkup_zdlra is set to yes.

    No

    bkup_zdlra_passwd

    Password of the Recovery Appliance user specified in bkup_zdlra_url.

    Applicable only when bkup_zdlra is set to yes.

    No

    Table 5-30 Backup Configuration Parameters - RMAN Catalog Support Parameters

    Parameter Description Compatible with Console Automatic Backups*

    bkup_use_rcat

    Enables the use of an existing RMAN recovery catalog.

    Valid values are yes and no.

    Yes (only for NFS and OSS backups)

    bkup_rcat_user

    Recovery catalog user name.

    Applicable only when bkup_use_rcat is set to yes.

    Yes (only for NFS and OSS backups)

    bkup_rcat_passwd

    Password for recovery catalog user specified in bkup_rcat_user.

    Applicable only when bkup_use_rcat is set to yes.

    Yes (only for NFS and OSS backups)

    bkup_rcat_conn

    Connection string for the RMAN recovery catalog.

    Applicable only when bkup_use_rcat is set to yes.

    Yes (only for NFS and OSS backups)

    Only the above parameters noted with *Compatible with Console Automatic Backups = Yes are safe to alter in conjunction with console-based automatic backups. If any other parameters are to be altered, then do not enable backups through the console.

  5. Use the bkup_api set config command to update the backup settings using the file containing your updated backup settings:
    /var/opt/oracle/bkup_api/bkup_api set config --file=filename --dbname=dbname

    Where:

    filename is used to specify the name of the file that contains the updated backup settings

    dbname is the database name for the database that you are acting on

  6. You can use the bkup_api configure_status command to check the status of the configuration update:
    /var/opt/oracle/bkup_api/bkup_api configure_status
  7. Exit the root user command shell:
    exit
    Note

    any changes you make by using the bkup_api command are not reflected in the Oracle Database Exadata Cloud@Customer console.

Customizing Which System Files Are Backed Up

By default, backups via the console or bkup_api backup certain system files in addition to the database files themselves.

If you need different system files backed up, then use these steps to change which system files get backed up. It is safe to alter parameters pertaining to system file backups in conjunction with the use of console-based automated backups.

If your backup configuration includes bkup_cfg_files=yes, then each backup includes system configuration files and directories specified in the oscfg.spec file.

To change which system files and directories are backed up:

  1. Connect to a virtual machine as opc user.

    For detailed instructions, see Connecting to a Virtual Machine with SSH.

  2. Switch to oracle user.
  3. Edit the contents of the oscfg.spec file.

    This file is located under /var/opt/oracle/dbaas_acfs/bkup/dbname, where dbname is the name of the database that is associated with the backup configuration.

    Following is an example of the default contents of the oscfg.spec file:
    ## OS Configuration Files
#
# Doc Spec
oscfg.spec
#
# Directories
/etc/rc.d
/home/oracle/bkup
#
# Single files
/home/oracle/.bashrc
/etc/crontab
/etc/sysctl.conf
/etc/passwd
/etc/group
/etc/oraInst.loc
/etc/oratab
/etc/fstab

Customizing Which Database Configuration Files Are Backed Up

By default, backups through the console or bkup_api backup certain database configuration files in addition to the database files themselves.

If you need different database configuration files backed up, then use these steps to change which database configuration files get backed up. It is safe to alter parameters pertaining to database configuration file backups in conjunction with the use of console-based automated backups.

If your backup configuration includes bkup_cfg_files=yes, then each backup includes database configuration files and directories specified in the dbcfg.spec file.

To change which database configuration files are backed up:

  1. Connect to a virtual machine as opc user.

    For detailed instructions, see Connecting to a Virtual Machine with SSH.

  2. Switch to oracle user.
  3. Edit the contents of the dbcfg.spec file.

    This file is located under /var/opt/oracle/dbaas_acfs/bkup/dbname, where dbname is the name of the database that is associated with the backup configuration.

    Following is an example of the contents of the dbcfg.spec file:
    ### Oracle_Home configuration files.
#
# Doc Spec
dbcfg.spec
# DB id
dbid
#
# Directories
/u02/app/oracle/product/dbversion/dbhome_n/admin/dbname/xdb_wallet
/u02/app/oracle/admin/dbname/xdb_wallet
/u02/app/oracle/admin/dbname/db_wallet
# Note: tde_wallet must be backed up in a different location than DATA bkup.
/u02/app/oracle/admin/dbname/tde_wallet
/u02/app/oracle/admin/dbname/cat_wallet
#/u01/app/oraInventory
#
# Single files
/var/opt/oracle/dbaas_acfs/dbname/opc/opcdbname.ora
/u02/app/oracle/product/dbversion/dbhome_n/dbs/opcdbname.ora
/u02/app/oracle/product/dbversion/dbhome_n/dbs/orapwinstancename
/u02/app/oracle/product/dbversion/dbhome_n/network/admin/listener.ora
/u02/app/oracle/product/dbversion/dbhome_n/network/admin/sqlnet.ora
/u02/app/oracle/product/dbversion/dbhome_n/network/admin/tnsnames.ora
/u02/app/oracle/product/dbversion/dbhome_n/rdbms/lib/env_rdbms.mk
/u02/app/oracle/product/dbversion/dbhome_n/rdbms/lib/ins_rdbms.mk
#
# Creg
/var/opt/oracle/creg/instancename.ini
#

Creating an On-Demand Backup by Using the bkup_api Utility

You can use the bkup_api utility to create an on-demand backup of a complete database or an individual pluggable database (PDB):

Note

bkup_api will be deprecated in a future release. Use the dbaascli database backup, dbaascli pdb backup, dbaascli database recover, and dbaascli pdb recover commands to backup and recover container databases and pluggable databases. For more information, see User Configured Backups and Recovery.
Note

Using this method for a manual backup is safe to use in conjunction with automatic backups managed through the Console. Manual backups done this way will appear in the console after some time due to synchronization.

To change which database configuration files are backed up:

  1. Connect as the oracle user to a compute node.

    For detailed instructions, see Connecting to a Compute Node with SSH.

  2. Start a root-user command shell:
    # sudo -s
#
  3. Enter the bkup_api command:
    • To create a backup that follows the current retention policy, use the following bkup_api command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --dbname=dbname

      where dbname is the database name for the database that you want to back up.

    • To create an on-demand backup of a specific PDB, use the following bkup_api command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --dbname=dbname --pdb=pdbname
    • To create a long-term backup of the complete database that persists until you delete it, use the following bkup_api command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --keep --dbname=dbname

      By default, the long-term backup is given a timestamp-based tag. To specify a custom backup tag, add the --tag option to the bkup_api command.

      For example, to create a long-term backup with the tag monthly, use the following command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --keep --tag=monthly --dbname=dbname
    • To create an on-demand RMAN level 0 backup, use the following bkup_api command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --level0 --dbname=dbname

      You can use this option to manually perform an RMAN level 0 (full) backup if the scheduled weekly level 0 backup fails or following a major structural change in the database, such as adding a new data file or tablespace. This option is only valid for backup configurations that use cloud storage only.

    • To create an on-demand backup that includes an image copy of the database data files, use the following bkup_api command:
      # /var/opt/oracle/bkup_api/bkup_api bkup_start --datafiles --dbname=dbname

      You can use this option to manually perform a full image backup to cloud storage if the scheduled weekly full backup fails or following a major structural change in the database, such as adding a new data file or tablespace. This option is only valid for backup configurations that use cloud storage and local Exadata storage.

  4. After you start an on-demand backup, the backup process runs in the background. To check the progress of the backup process, run the following bkup_api command on the same compute node where the backup is running:
    # /var/opt/oracle/bkup_api/bkup_api bkup_status --dbname=dbname
  5. Exit the root-user command shell and disconnect from the compute node:
    # exit
# exit

Disabling Automatic Backups to Facilitate Manual Backup and Recovery Management

Backups, configured in the Exadata Database Service on Cloud@Customer console, API or bkup_api work for a variety of backup and recovery use cases. If you require use cases not supported by the cloud-managed backups, then you can manage database backup and recovery manually, using the Oracle Recovery Manager (RMAN) utility. For information about using RMAN, see the Oracle Database Backup and Recovery User's Guide for Release 19.

Managing backup and recovery, using RMAN, on Exadata Database Service on Cloud@Customer requires taking full ownership of both database and archive log backups, and the cloud-managed backups should no longer be used. Before manual backups are started, the cloud-managed backup functionality should be disabled. This is needed so the cloud backup jobs do not purge archive logs before they are manually backed up and do not conflict with the manual backups.

You can use the bkup_api utility to disable cloud-managed backups, including disabling the automatic archive log purge job, by following this procedure:

Note

If you execute these steps, then the automation will no longer purge/backup the archive logs in the FRA for the database.
  1. Connect as the opc user to the first compute node.

    For detailed instructions, see Connecting to a Compute Node with SSH.

  2. Start a root-user command shell:
    sudo -s
  3. Use the bkup_api get config command to generate a file containing the current backup settings for the database deployment:
    /var/opt/oracle/bkup_api/bkup_api get config [--file=filename] --dbname=dbname
    Where:
    • filename is an optional parameter used to specify a name for the file that is generated
    • dbname is the database name for the database that you want to act on
  4. Edit the parameter values in the generated file to change the following parameters.
    This will remove the backup crontab entries and disable all automatic backups. If the values are set to yes, then set to no.
    bkup_cron_entry=no
bkup_archlog_cron_entry=no
bkup_nfs=no
bkup_oss=no
bkup_local=no
  5. Use the bkup_api set config command to update the backup settings using the file containing your updated backup settings:
    /var/opt/oracle/bkup_api/bkup_api set config --file=filename --dbname=dbname
    Where:
    • filename is an optional parameter used to specify a name for the file that is generated
    • dbname is the database name for the database that you want to act on

    The job to set the configuration will take several minutes to complete.

  6. You can use the bkup_api configure_status command to check the status of the configuration update:
    /var/opt/oracle/bkup_api/bkup_api configure_status --dbname=dbname
    Where:
    • dbname is the database name for the database that you want to act on

    The Configure backup status starts as running and then moves to finished when complete.

  7. Run the bkup_api get config command again and verify the settings listed above are set to no.
    /var/opt/oracle/bkup_api/bkup_api get config [--file=filename] --dbname=dbname
    Where:
    • filename is an optional parameter used to specify a name for the file that is generated
    • dbname is the database name for the database that you want to act on
    Note

    After making these changes, no backups, including archive log backups, are made by the cloud automation. Ensure that manual RMAN backups are in place to avoid filling the archive log location.
    Note

    Changes made using the bkup_api command are not reflected in the Oracle Exadata Database Service on Cloud@Customer console.
  8. Exit the root-user command shell:
    exit

Customizing Real Time Redo Transport (RTRT) Behavior for Recovery Appliance Backups

Real Time Redo Transport can be enabled or disabled using dbaascli. This is available from dbaastools 21.4.1 release.

For example, to enable RTRT for the database myTestDB:
dbaascli database backup --dbName myTestDB --configure —enableRTRT

For more information, see dbaascli database backup.

Note

  • Enabling or disabling RTRT works only for Oracle Database version 12.2 and higher.
  • If you have enabled Data Guard association between databases, then after enabling RTRT on the Primary database, you must manually copy the password file from the Primary to the Standby database. To learn more about copying the password file from the primary to the standby database, refer to 12c: Data Guard Physical Standby - Managing password files in a RAC Physical Standby (Doc ID 1984091.1).

Alternative Backup Methods

Learn about alternative backup methods that are available in addition to the OCI Console.

Backup for databases on Exadata Database Service on Cloud@Customer can be accomplished through several methods in addition to the automatic backups configured in the console. Generally, the console (or the OCI API / CLI that correspond to it) is the preferred method as it provides the simplest and most automated method. In general, it is preferable to leverage the OCI Console, OCI API, or OCI Command-Line over alternative management methods. However, if required actions cannot be completed through the preferred methods, two other options are available to manually configure backups: bkup_api and Oracle Recovery Manager (RMAN).

Note

bkup_api will be deprecated in a future release. Use the dbaascli database backup, dbaascli pdb backup, dbaascli database recover, and dbaascli pdb recover commands to backup and recover container databases and pluggable databases. For more information, see User Configured Backup.

RMAN is the backup tool included with the Oracle Database. For information about using RMAN, see the Oracle Database Backup and Recovery User's Guide for Release 19. Using RMAN to back up databases on Exadata Database Service on Cloud@Customer provides the most flexibility in terms of backup options, but also the most complexity.

Note

While using RMAN for restoring databases backed up through any method described herein is considered safe, RMAN should NEVER be used to set up backups in conjunction with either console (and OCI API / CLI), nor in conjunction with bkup_api. If you choose to orchestrate backups manually leveraging RMAN, you should not use either console automated backups, nor should you use bkup_api. You must first completely disable console based automated backups. For more information, see Disabling Automatic Backups to Facilitate Manual Backup and Recovery Management.

The bkup_api method offers a middle ground between RMAN and console automated backups in terms of flexibility and simplicity. Use bkup_api if needed functionality is not supported with console automated backups, but when you wish to avoid complexity of using RMAN directly. In certain cases, bkup_api can be used to modify the console automated backup configuration, but this is not generally the case. Generally, bkup_api must be used instead of enabling backups in the console.

Recovering a Database Using Oracle Recovery Manager (RMAN)

If you backed up your database using bkup_api, then you can manually restore that database backup by using the Oracle Recovery Manager (RMAN) utility. For information about using RMAN, see the Oracle Database Backup and Recovery User's Guide for Release 19.

Note

While recovering using RMAN is safe, you must not use RMAN to initiate backups or edit backup setting in conjunction with either backup_api usage or in conjunction with automated console backups. Doing so could result in conflicting conditions or over-writes of settings, and backups may not execute successfully.