oracle / oracle.oci / 5.0.0 / module / oci_database_backup_destination Manage a BackupDestination resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_backup_destination (5.0.0) — module
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections: - name: oracle.oci version: 5.0.0
This module allows the user to create, update and delete a BackupDestination resource in Oracle Cloud Infrastructure
For I(state=present), creates a backup destination in an Exadata Cloud@Customer system.
This resource has the following action operations in the M(oracle.oci.oci_database_backup_destination_actions) module: change_compartment.
- 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
type: choices: - NFS - RECOVERY_APPLIANCE description: - Type of the backup destination. - Required for create using I(state=present). type: str wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present - absent default: present description: - The state of the BackupDestination. - Use I(state=present) to create or update a BackupDestination. - Use I(state=absent) to delete a BackupDestination. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str vpc_users: description: - The Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. - This parameter is updatable. - Required when type is 'RECOVERY_APPLIANCE' elements: str type: list nfs_server: description: - IP addresses for NFS Auto mount. - This parameter is updatable. elements: str type: list cert_bundle: description: - 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. type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - This parameter is updatable. type: dict display_name: aliases: - name description: - The user-provided name of the backup destination. - Required for create using I(state=present). - Required for update, delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' - This parameter is updatable. type: dict compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. - Required for create using I(state=present). - Required for update when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. - Required for delete when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is set. type: str nfs_mount_type: choices: - SELF_MOUNT - AUTOMATED_MOUNT description: - NFS Mount type for backup destination. - This parameter is updatable. type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str connection_string: description: - The connection string for connecting to the Recovery Appliance. - This parameter is updatable. - Required when type is 'RECOVERY_APPLIANCE' type: str nfs_server_export: description: - Specifies the directory on which to mount the file system - This parameter is updatable. type: str mount_type_details: description: - '' - Applicable when type is 'NFS' suboptions: local_mount_point_path: description: - 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' type: str mount_type: choices: - SELF_MOUNT - AUTOMATED_MOUNT default: SELF_MOUNT description: - Mount type for backup destination. type: str nfs_server: description: - IP addresses for NFS Auto mount. - Required when mount_type is 'AUTOMATED_MOUNT' elements: str type: list nfs_server_export: description: - Specifies the directory on which to mount the file system - Required when mount_type is 'AUTOMATED_MOUNT' type: str type: dict config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str backup_destination_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the backup destination. - Required for update using I(state=present) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. - Required for delete using I(state=absent) when environment variable C(OCI_USE_NAME_AS_IDENTIFIER) is not set. type: str local_mount_point_path: description: - '**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' type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used. type: bool
backup_destination: contains: associated_databases: contains: db_name: description: - The display name of the database that is associated with the backup destination. returned: on success sample: db_name_example type: str id: description: - The database L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm). returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str description: - List of databases associated with the backup destination. returned: on success type: complex compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the compartment. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str connection_string: description: - For a RECOVERY_APPLIANCE backup destination, the connection string for connecting to the Recovery Appliance. returned: on success sample: connection_string_example type: str defined_tags: description: - Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). returned: on success sample: Operations: CostCenter: US type: dict display_name: description: - The user-provided name of the backup destination. returned: on success sample: display_name_example type: str freeform_tags: description: - 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 L(Resource Tags,https://docs.cloud.oracle.com/Content/General/Concepts/resourcetags.htm). - 'Example: `{"Department": "Finance"}`' returned: on success sample: Department: Finance type: dict id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the backup destination. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - A descriptive text associated with the lifecycleState. Typically contains additional displayable text returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current lifecycle state of the backup destination. returned: on success sample: ACTIVE type: str local_mount_point_path: description: - 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. returned: on success sample: local_mount_point_path_example type: str nfs_mount_type: description: - NFS Mount type for backup destination. returned: on success sample: SELF_MOUNT type: str nfs_server: description: - Host names or IP addresses for NFS Auto mount. returned: on success sample: [] type: list nfs_server_export: description: - Specifies the directory on which to mount the file system returned: on success sample: nfs_server_export_example type: str time_created: description: - The date and time the backup destination was created. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - Type of the backup destination. returned: on success sample: NFS type: str vpc_users: description: - For a RECOVERY_APPLIANCE backup destination, the Virtual Private Catalog (VPC) users that are used to access the Recovery Appliance. returned: on success sample: [] type: list description: - Details of the BackupDestination resource acted upon by the current operation returned: on success 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: [] type: complex