oci_volume_backup_module.rst

source:	cloud/oracle/oci_volume_backup.py
orphan:

oci_volume_backup -- Manage volume backups in OCI Block Volume service

.. versionadded:: 2.5

• Synopsis
• Requirements
• Parameters
• Notes
• Examples
• Return Values
• Status

Synopsis

• This module allows the user to perform create, delete & update operations on volume backups in OCI Block Volume service.

Requirements

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

• python >= 2.7
• 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_OCID 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_type string	Choices: api_key ← instance_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.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
display_name -		A user-friendly name for the volume backup. Does not have to be unique and it's changeable. Avoid entering confidential information. 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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
key_by list		The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
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 -	Choices: present ← absent	Use state=present to create or update a volume backup. Use state=absent to delete a volume backup.
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 -	Choices: FULL INCREMENTAL ←	The type of backup to create.
volume_backup_id -		The OCID of the volume backup. Required to update a volume backup with state=present or to delete a volume backup with state=absent. aliases: id
volume_id -		The OCID of the volume that needs to be backed up. Required to create a volume backup with state=present.
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until string		The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

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 a volume backup
  oci_volume_backup:
    name: my_backup
    volume_id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
    wait_until: CREATING

- name: Forcefully ensure non-idempotent volume backup creation
  oci_volume_backup:
    name: my_backup
    volume_id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
    force_create: True

- name: Update name of a volume backup
  oci_volume_backup:
    name: test_backup
    id: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx

- name: Delete a volume backup
  oci_volume_backup:
    id: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx
    state: absent

Return Values

Common return values are documented :ref:`here <common_return_values>`, the following are the fields unique to this module:

Key		Returned	Description
volume_backup complex		on successful create, delete and update operation	Information about the volume backup Sample: {'lifecycle_state': 'AVAILABLE', 'size_in_gbs': 50, 'display_name': 'ansible_backup', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'size_in_mbs': 51200, 'time_created': '2017-12-22T15:40:53.219000+00:00', 'id': 'ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx', 'unique_size_in_gbs': 0, 'volume_id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx', 'unique_size_in_mbs': 1, 'type': 'FULL', 'time_request_received': '2017-12-22T15:40:48.111000+00:00'}
	compartment_id string	always	The OCID of the compartment that contains the volume backup. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	display_name string	always	A user-friendly name for the volume backup. Sample: test_backup
	id string	always	The OCID of the volume backup. Sample: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx
	lifecycle_state string	always	The current state of a volume backup. Allowed values for this property are "CREATING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY", "REQUEST_RECEIVED", 'UNKNOWN_ENUM_VALUE'. Sample: AVAILABLE
	size_in_gbs string	always	The size of the volume, in GBs. Sample: 50
	size_in_mbs string	always	The size of the volume, in MBs. Sample: 51200
	time_created string	always	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: 2017-12-22 15:40:53.219000
	time_request_received string	always	The date and time the request to create the volume backup was received. Format defined by RFC3339. Sample: 2017-12-22 15:40:48.111000
	type string	always	The type of a volume backup. Sample: FULL
	unique_size_in_gbs string	always	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.
	unique_size_in_mbs string	always	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. Sample: 1
	volume_id string	always	The OCID of the volume. Sample: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx

Status

• This module is not guaranteed to have a backwards compatible interface. [preview]
• This module is :ref:`maintained by the Ansible Community <modules_support>`. [community]

Authors

• Rohit Chaware (@rohitChaware)

Hint

If you notice any issues in this documentation you can edit this document to improve it.