Try SpotterPerform actions on a Backup resource in Oracle Cloud Infrastructure
| "added in version" 2.9.0 of oracle.oci"
Authors: Oracle (@oracle)
preview | supported by community
Install with ansible-galaxy collection install oracle.oci:==5.0.0
collections:
- name: oracle.oci
version: 5.0.0Perform actions on a Backup resource in Oracle Cloud Infrastructure
For I(action=cancel), cancel automatic/standalone full/incremental create backup workrequests specified by the backup Id.
- name: Perform action cancel on backup
oci_database_backup_actions:
# required
backup_id: "ocid1.backup.oc1..xxxxxxEXAMPLExxxxxx"
action: cancel
wait:
default: true
description: Whether to wait for create or delete operation to complete.
type: bool
action:
choices:
- cancel
description:
- The action to perform on the Backup.
required: true
type: str
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
backup_id:
aliases:
- id
description:
- The backup L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm).
required: true
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
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
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
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:
contains:
availability_domain:
description:
- The name of the availability domain where the database backup is stored.
returned: on success
sample: Uocm:PHX-AD-1
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_edition:
description:
- The Oracle Database edition of the DB system from which the database backup
was taken.
returned: on success
sample: STANDARD_EDITION
type: str
database_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the database.
returned: on success
sample: ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
type: str
database_size_in_gbs:
description:
- The size of the database in gigabytes at the time the backup was taken.
returned: on success
sample: 1.2
type: float
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 backup.
returned: on success
sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
type: str
key_store_id:
description:
- The L(OCID,https://docs.cloud.oracle.com/Content/General/Concepts/identifiers.htm)
of the key store of Oracle Vault.
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. Autonomous Database Serverless does not use key versions,
hence is not applicable for Autonomous Database Serverless instances.
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
shape:
description:
- Shape of the backup's source database.
returned: on success
sample: shape_example
type: str
time_ended:
description:
- The date and time the backup was 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).
This parameter and `secretId` are required for Customer Managed Keys.
returned: on success
sample: ocid1.vault.oc1..xxxxxxEXAMPLExxxxxx
type: str
version:
description:
- Version of the backup's source database
returned: on success
sample: version_example
type: str
description:
- Details of the Backup resource acted upon by the current operation
returned: on success
sample:
availability_domain: Uocm:PHX-AD-1
compartment_id: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
database_edition: STANDARD_EDITION
database_id: ocid1.database.oc1..xxxxxxEXAMPLExxxxxx
database_size_in_gbs: 1.2
display_name: display_name_example
id: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
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
shape: shape_example
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
version: version_example
type: complex