oracle.oci.oci_blockstorage_volume_backup – Manage a VolumeBackup resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.2.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_blockstorage_volume_backup
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to create, update and delete a VolumeBackup resource in Oracle Cloud Infrastructure
For state=present, creates a new backup of the specified volume. For general information about volume backups, see Overview of Block Volume Service Backups
When the request is received, the backup object is in a REQUEST_RECEIVED state. When the data is imaged, it goes into a CREATING state. After the backup is fully uploaded to the cloud, it goes into an AVAILABLE state.
This resource has the following action operations in the oracle.oci.oci_blockstorage_volume_backup_actions module: change_compartment, copy.
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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. |
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 . |
|
defined_tags
dictionary
|
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
|
|
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable
OCI_USE_NAME_AS_IDENTIFIER is set.This parameter is updatable when
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: name |
|
force_create
boolean
|
|
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.
|
|
kms_key_id
string
|
The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
This parameter is updatable.
|
|
realm_specific_endpoint_template_enabled
boolean
|
|
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.
|
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
|
|
The state of the VolumeBackup.
Use state=present to create or update a VolumeBackup.
Use state=absent to delete a VolumeBackup.
|
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
|
|
The type of backup to create. If omitted, defaults to INCREMENTAL.
|
volume_backup_id
string
|
The OCID of the volume backup.
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 |
|
volume_id
string
|
The OCID of the volume that needs to be backed up.
Required for create using state=present.
|
|
wait
boolean
|
|
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.
|
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Create volume_backup
oci_blockstorage_volume_backup:
# required
volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"
# optional
type: FULL
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update volume_backup
oci_blockstorage_volume_backup:
# required
volume_backup_id: "ocid1.volumebackup.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
display_name: display_name_example
freeform_tags: {'Department': 'Finance'}
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Update volume_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_backup:
# required
display_name: display_name_example
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
defined_tags: {'Operations': {'CostCenter': 'US'}}
freeform_tags: {'Department': 'Finance'}
kms_key_id: "ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx"
- name: Delete volume_backup
oci_blockstorage_volume_backup:
# required
volume_backup_id: "ocid1.volumebackup.oc1..xxxxxxEXAMPLExxxxxx"
state: absent
- name: Delete volume_backup using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
oci_blockstorage_volume_backup:
# 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 | |
---|---|---|---|
volume_backup
complex
|
on success |
Details of the VolumeBackup resource acted upon by the current operation
Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'expiration_time': '2013-10-20T19:20:30+01:00', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'kms_key_id': 'ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'CREATING', 'size_in_gbs': 56, 'size_in_mbs': 56, 'source_type': 'MANUAL', 'source_volume_backup_id': 'ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx', 'system_tags': {}, 'time_created': '2013-10-20T19:20:30+01:00', 'time_request_received': '2013-10-20T19:20:30+01:00', 'type': 'FULL', 'unique_size_in_gbs': 56, 'unique_size_in_mbs': 56, 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx'}
|
|
compartment_id
string
|
on success |
The OCID of the compartment that contains the volume backup.
Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
|
|
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.
Example: `{"Operations": {"CostCenter": "42"}}`
Sample:
{'Operations': {'CostCenter': 'US'}}
|
|
display_name
string
|
on success |
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Sample:
display_name_example
|
|
expiration_time
string
|
on success |
The date and time the volume backup will expire and be automatically deleted. Format defined by RFC3339. This parameter will always be present for backups that were created automatically by a scheduled-backup policy. For manually created backups, it will be absent, signifying that there is no expiration time and the backup will last forever until manually deleted.
Sample:
2013-10-20T19:20:30+01:00
|
|
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 volume backup.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|
kms_key_id
string
|
on success |
The OCID of the Vault service key which is the master encryption key for the volume backup. For more information about the Vault service and encryption keys, see Overview of Vault service and Using Keys.
Sample:
ocid1.kmskey.oc1..xxxxxxEXAMPLExxxxxx
|
|
lifecycle_state
string
|
on success |
The current state of a volume backup.
Sample:
CREATING
|
|
size_in_gbs
integer
|
on success |
The size of the volume, in GBs.
Sample:
56
|
|
size_in_mbs
integer
|
on success |
The size of the volume in MBs. The value must be a multiple of 1024. This field is deprecated. Please use sizeInGBs.
Sample:
56
|
|
source_type
string
|
on success |
Specifies whether the backup was created manually, or via scheduled backup policy.
Sample:
MANUAL
|
|
source_volume_backup_id
string
|
on success |
The OCID of the source volume backup.
Sample:
ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx
|
|
system_tags
dictionary
|
on success |
System tags for this resource. Each key is predefined and scoped to a namespace. Example: `{"foo-namespace": {"bar-key": "value"}}`
|
|
time_created
string
|
on success |
The date and time the volume backup was created. This is the time the actual point-in-time image of the volume data was taken. Format defined by RFC3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
time_request_received
string
|
on success |
The date and time the request to create the volume backup was received. Format defined by [RFC3339]https://tools.ietf.org/html/rfc3339.
Sample:
2013-10-20T19:20:30+01:00
|
|
type
string
|
on success |
The type of a volume backup.
Sample:
FULL
|
|
unique_size_in_gbs
integer
|
on success |
The size used by the backup, in GBs. It is typically smaller than sizeInGBs, depending on the space consumed on the volume and whether the backup is full or incremental.
Sample:
56
|
|
unique_size_in_mbs
integer
|
on success |
The size used by the backup, in MBs. It is typically smaller than sizeInMBs, depending on the space consumed on the volume and whether the backup is full or incremental. This field is deprecated. Please use uniqueSizeInGBs.
Sample:
56
|
|
volume_id
string
|
on success |
The OCID of the volume.
Sample:
ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx
|
Authors¶
Oracle (@oracle)