oracle.oci.oci_database_backup_destination – Manage a BackupDestination resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_database_backup_destination.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete a BackupDestination resource in Oracle Cloud Infrastructure

  • For state=present, creates a backup destination in an Exadata Cloud@Customer system.

  • This resource has the following action operations in the oracle.oci.oci_database_backup_destination_actions module: change_compartment.

Requirements

The below requirements are needed on the host that executes this module.

Parameters

Parameter Choices/Defaults Comments
api_user
string
The OCID of the user, on whose behalf, OCI APIs are invoked. If not set, then the value of the OCI_USER_ID environment variable, if any, is used. This option is required if the user is not specified through a configuration file (See config_file_location). To get the user's OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_fingerprint
string
Fingerprint for the key pair being used. If not set, then the value of the OCI_USER_FINGERPRINT environment variable, if any, is used. This option is required if the key fingerprint is not specified through a configuration file (See config_file_location). To get the key pair's fingerprint value please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm.
api_user_key_file
string
Full path and filename of the private key (in PEM format). If not set, then the value of the OCI_USER_KEY_FILE variable, if any, is used. This option is required if the private key is not specified through a configuration file (See config_file_location). If the key is encrypted with a pass-phrase, the api_user_key_pass_phrase option must also be provided.
api_user_key_pass_phrase
string
Passphrase used by the key referenced in api_user_key_file, if it is encrypted. If not set, then the value of the OCI_USER_KEY_PASS_PHRASE variable, if any, is used. This option is required if the key passphrase is not specified through a configuration file (See config_file_location).
auth_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
The type of authentication to use for making API requests. By default auth_type="api_key" based authentication is performed and the API key (see api_user_key_file) in your config file will be used. If this 'auth_type' module option is not specified, the value of the OCI_ANSIBLE_AUTH_TYPE, if any, is used. Use auth_type="instance_principal" to use instance principal based authentication when running ansible playbooks within an OCI compute instance.
backup_destination_id
string
The OCID of the backup destination.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string
The OCID of the compartment.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
config_file_location
string
Path to configuration file. If not set then the value of the OCI_CONFIG_FILE environment variable, if any, is used. Otherwise, defaults to ~/.oci/config.
config_profile_name
string
The profile to load from the config file referenced by config_file_location. If not set, then the value of the OCI_CONFIG_PROFILE environment variable, if any, is used. Otherwise, defaults to the "DEFAULT" profile in config_file_location.
connection_string
string
The connection string for connecting to the Recovery Appliance.
This parameter is updatable.
Required when type is 'RECOVERY_APPLIANCE'
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
This parameter is updatable.
display_name
string
The user-provided name of the backup destination.
Required for create using state=present.
Required for update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.

aliases: name
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
local_mount_point_path
string
**Deprecated.** 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. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes. This field is deprecated. Use the mountTypeDetails field instead to specify the mount type for NFS.
This parameter is updatable.
Applicable when type is 'NFS'
mount_type_details
dictionary
Applicable when type is 'NFS'
local_mount_point_path
string
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. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.
Required when mount_type is 'SELF_MOUNT'
mount_type
string
    Choices:
  • SELF_MOUNT ←
  • AUTOMATED_MOUNT
Mount type for backup destination.
nfs_server
list / elements=string
IP addresses for NFS Auto mount.
Required when mount_type is 'AUTOMATED_MOUNT'
nfs_server_export
string
Specifies the directory on which to mount the file system
Required when mount_type is 'AUTOMATED_MOUNT'
nfs_mount_type
string
    Choices:
  • SELF_MOUNT
  • AUTOMATED_MOUNT
NFS Mount type for backup destination.
This parameter is updatable.
nfs_server
list / elements=string
IP addresses for NFS Auto mount.
This parameter is updatable.
nfs_server_export
string
Specifies the directory on which to mount the file system
This parameter is updatable.
region
string
The Oracle Cloud Infrastructure region to use for all OCI API requests. If not set, then the value of the OCI_REGION variable, if any, is used. This option is required if the region is not specified through a configuration file (See config_file_location). Please refer to https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm for more information on OCI regions.
state
string
    Choices:
  • present ←
  • absent
The state of the BackupDestination.
Use state=present to create or update a BackupDestination.
Use state=absent to delete a BackupDestination.
tenancy
string
OCID of your tenancy. If not set, then the value of the OCI_TENANCY variable, if any, is used. This option is required if the tenancy OCID is not specified through a configuration file (See config_file_location). To get the tenancy OCID, please refer https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm
type
string
    Choices:
  • NFS
  • RECOVERY_APPLIANCE
Type of the backup destination.
Required for create using state=present.
vpc_users
list / elements=string
The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.
This parameter is updatable.
Required when type is 'RECOVERY_APPLIANCE'
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create backup_destination with type = NFS
  oci_database_backup_destination:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: NFS

    # optional
    mount_type_details:
      # required
      local_mount_point_path: local_mount_point_path_example

      # optional
      mount_type: SELF_MOUNT
    local_mount_point_path: local_mount_point_path_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Create backup_destination with type = RECOVERY_APPLIANCE
  oci_database_backup_destination:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    type: RECOVERY_APPLIANCE
    vpc_users: [ "vpc_users_example" ]
    connection_string: connection_string_example

    # optional
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update backup_destination
  oci_database_backup_destination:
    # required
    backup_destination_id: "ocid1.backupdestination.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    vpc_users: [ "vpc_users_example" ]
    connection_string: connection_string_example
    local_mount_point_path: local_mount_point_path_example
    nfs_mount_type: SELF_MOUNT
    nfs_server: [ "nfs_server_example" ]
    nfs_server_export: nfs_server_export_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Update backup_destination using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_backup_destination:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    vpc_users: [ "vpc_users_example" ]
    connection_string: connection_string_example
    local_mount_point_path: local_mount_point_path_example
    nfs_mount_type: SELF_MOUNT
    nfs_server: [ "nfs_server_example" ]
    nfs_server_export: nfs_server_export_example
    freeform_tags: {'Department': 'Finance'}
    defined_tags: {'Operations': {'CostCenter': 'US'}}

- name: Delete backup_destination
  oci_database_backup_destination:
    # required
    backup_destination_id: "ocid1.backupdestination.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete backup_destination using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_database_backup_destination:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
backup_destination
complex
on success
Details of the BackupDestination resource acted upon by the current operation

Sample:
{'associated_databases': [{'db_name': 'db_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'connection_string': 'connection_string_example', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_details': 'lifecycle_details_example', 'lifecycle_state': 'ACTIVE', 'local_mount_point_path': 'local_mount_point_path_example', 'nfs_mount_type': 'SELF_MOUNT', 'nfs_server': [], 'nfs_server_export': 'nfs_server_export_example', 'time_created': '2013-10-20T19:20:30+01:00', 'type': 'NFS', 'vpc_users': []}
 
associated_databases
complex
on success
List of databases associated with the backup destination.

   
db_name
string
on success
The display name of the database that is associated with the backup destination.

Sample:
db_name_example
   
id
string
on success
The database OCID.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
compartment_id
string
on success
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
connection_string
string
on success
For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance.

Sample:
connection_string_example
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.

Sample:
{'Operations': {'CostCenter': 'US'}}
 
display_name
string
on success
The user-provided name of the backup destination.

Sample:
display_name_example
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

Sample:
{'Department': 'Finance'}
 
id
string
on success
The OCID of the backup destination.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_details
string
on success
A descriptive text associated with the lifecycleState. Typically contains additional displayable text

Sample:
lifecycle_details_example
 
lifecycle_state
string
on success
The current lifecycle state of the backup destination.

Sample:
ACTIVE
 
local_mount_point_path
string
on success
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. Ensure that the NFS mount is maintained continuously on all of the VM cluster nodes.

Sample:
local_mount_point_path_example
 
nfs_mount_type
string
on success
NFS Mount type for backup destination.

Sample:
SELF_MOUNT
 
nfs_server
list / elements=string
on success
Host names or IP addresses for NFS Auto mount.

 
nfs_server_export
string
on success
Specifies the directory on which to mount the file system

Sample:
nfs_server_export_example
 
time_created
string
on success
The date and time the backup destination was created.

Sample:
2013-10-20T19:20:30+01:00
 
type
string
on success
Type of the backup destination.

Sample:
NFS
 
vpc_users
list / elements=string
on success
For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance.



Authors

  • Oracle (@oracle)