oci_volume_backup_actions – Perform actions on a VolumeBackup resource in Oracle Cloud Infrastructure¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Perform actions on a VolumeBackup resource in Oracle Cloud Infrastructure
For action=copy, creates a volume backup copy in specified region. For general information about volume backups, see Overview of Block Volume Service Backups

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
action - / required	Choices: copy	The action to perform on the VolumeBackup.
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_type string	Choices: api_key ← instance_principal instance_obo_user	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`.
destination_region - / required		The name of the destination region. Example: `us-ashburn-1`
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
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.
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
volume_backup_id - / required		The OCID of the volume backup. aliases: id
wait boolean	Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout integer	Default: 2000	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: Perform action copy on volume_backup
  oci_volume_backup_actions:
    volume_backup_id: ocid1.volumebackup.oc1..xxxxxxEXAMPLExxxxxx
    destination_region: us-ashburn-1
    action: copy

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: {'freeform_tags': {'Department': 'Finance'}, 'unique_size_in_mbs': 56, 'size_in_gbs': 56, 'display_name': 'display_name_example', 'lifecycle_state': 'CREATING', 'time_created': '2013-10-20T19:20:30+01:00', 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx', 'unique_size_in_gbs': 56, 'source_volume_backup_id': 'ocid1.sourcevolumebackup.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'FULL', 'size_in_mbs': 56, 'time_request_received': '2013-10-20T19:20:30+01:00', 'source_type': 'MANUAL', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'expiration_time': '2013-10-20T19:20:30+01:00', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.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 for the volume backup. 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-20 19: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
	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
	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-20 19: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. Sample: 2013-10-20 19: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

Status ¶

This module is not guaranteed to have a backwards compatible interface. [preview]
This module is maintained by the Ansible Community. [community]

Authors¶

Manoj Meda (@manojmeda)
Mike Ross (@mross22)
Nabeel Al-Saber (@nalsaber)

Hint

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

oci_volume_backup_actions – Perform actions on a VolumeBackup resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶