oracle / oracle.oci / 4.21.0 / module / oci_database_autonomous_database_backup Manage an AutonomousDatabaseBackup resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_database_autonomous_database_backup (4.21.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.21.0
collections: - name: oracle.oci version: 4.21.0
This module allows the user to create, update and delete an AutonomousDatabaseBackup resource in Oracle Cloud Infrastructure
For I(state=present), creates a new Autonomous Database backup for the specified database based on the provided request parameters.
- name: Create autonomous_database_backup oci_database_autonomous_database_backup: # required autonomous_database_id: "ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx" # optional display_name: display_name_example is_long_term_backup: true retention_period_in_days: 56
- name: Update autonomous_database_backup oci_database_autonomous_database_backup: # required autonomous_database_backup_id: "ocid1.autonomousdatabasebackup.oc1..xxxxxxEXAMPLExxxxxx" # optional retention_period_in_days: 56
- name: Update autonomous_database_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_autonomous_database_backup: # required display_name: display_name_example # optional retention_period_in_days: 56
- name: Delete autonomous_database_backup oci_database_autonomous_database_backup: # required autonomous_database_backup_id: "ocid1.autonomousdatabasebackup.oc1..xxxxxxEXAMPLExxxxxx" state: absent
- name: Delete autonomous_database_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) oci_database_autonomous_database_backup: # required display_name: display_name_example state: absent
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 AutonomousDatabaseBackup. - Use I(state=present) to create or update an AutonomousDatabaseBackup. - Use I(state=absent) to delete an AutonomousDatabaseBackup. 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 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 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 display_name: aliases: - name description: - The user-friendly name for the backup. The name does not have to be unique. - Required for create, 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 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 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 is_long_term_backup: description: - Indicates whether the backup is long-term type: bool 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 autonomous_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database backup. - Required for create using I(state=present). 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 retention_period_in_days: description: - Retention period, in days, for long-term backups - This parameter is updatable. type: int autonomous_database_backup_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database backup. - 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 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
autonomous_database_backup: contains: autonomous_database_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database. returned: on success sample: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx type: str 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 database_size_in_tbs: description: - The size of the database in terabytes at the time the backup was taken. returned: on success sample: 10 type: float db_version: description: - A valid Oracle Database version for Autonomous Database. returned: on success sample: db_version_example type: str display_name: description: - The user-friendly name for the backup. The name does not have to be unique. returned: on success sample: display_name_example type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Autonomous Database backup. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str is_automatic: description: - Indicates whether the backup is user-initiated or automatic. returned: on success sample: true type: bool is_restorable: description: - Indicates whether the backup can be used to restore the associated Autonomous Database. returned: on success sample: true type: bool key_store_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the key store. returned: on success sample: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx type: str key_store_wallet_name: description: - The wallet name for Oracle Key Vault. returned: on success sample: key_store_wallet_name_example type: str kms_key_id: description: - The OCID of the key container that is used as the master encryption key in database transparent data encryption (TDE) operations. returned: on success sample: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx type: str kms_key_version_id: description: - The OCID of the key container version that is used in database transparent data encryption (TDE) operations KMS Key can have multiple key versions. If none is specified, the current key version (latest) of the Key Id is used for the operation. returned: on success sample: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_details: description: - Additional information about the current lifecycle state. returned: on success sample: lifecycle_details_example type: str lifecycle_state: description: - The current state of the backup. returned: on success sample: CREATING type: str retention_period_in_days: description: - Retention period, in days, for long-term backups returned: on success sample: 56 type: int size_in_tbs: description: - The backup size in terrabytes (TB). returned: on success sample: 1.2 type: float time_available_till: description: - Timestamp until when the backup will be available returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_ended: description: - The date and time the backup completed. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str time_started: description: - The date and time the backup started. returned: on success sample: '2013-10-20T19:20:30+01:00' type: str type: description: - The type of backup. returned: on success sample: INCREMENTAL type: str vault_id: description: - The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm) of the Oracle Cloud Infrastructure L(vault,https://docs.cloud.oracle.com/Content/KeyManagement/Concepts/keyoverview.htm#concepts). returned: on success sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx type: str description: - Details of the AutonomousDatabaseBackup resource acted upon by the current operation returned: on success sample: autonomous_database_id: ocid1.autonomousdatabase.oc1..xxxxxxEXAMPLExxxxxx compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx database_size_in_tbs: 10 db_version: db_version_example display_name: display_name_example id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx is_automatic: true is_restorable: true key_store_id: ocid1.keystore.oc1..xxxxxxEXAMPLExxxxxx key_store_wallet_name: key_store_wallet_name_example kms_key_id: ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx kms_key_version_id: ocid1.kmskeyversion.oc1..xxxxxxEXAMPLExxxxxx lifecycle_details: lifecycle_details_example lifecycle_state: CREATING retention_period_in_days: 56 size_in_tbs: 1.2 time_available_till: '2013-10-20T19:20:30+01:00' time_ended: '2013-10-20T19:20:30+01:00' time_started: '2013-10-20T19:20:30+01:00' type: INCREMENTAL vault_id: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx type: complex