oci_volume - Manage volumes in OCI Block Volume service¶

New in version 2.5.

Synopsis
- Requirements
Parameters
Notes
Examples
Return Values
Status
- Author

Synopsis ¶

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

Requirements ¶

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

python >= 2.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io

Parameters ¶

Parameter		Choices/Defaults	Comments
api_user			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			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			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			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		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.
availability_domain			The availability domain of the volume. Required when creating a volume with state=present.
compartment_id			The OCID of the compartment that contains the volume. Required when creating a volume with state=present.
config_file_location			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		Default: DEFAULT	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			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. Does not have to be unique, and it's changeable. Avoid entering confidential information. If display_name is not provided, it is auto-generated. aliases: name
force_create bool		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			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			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.
lookup_all_attached_instances bool		Choices: no ← yes	Whether to fetch information of compute instances attached to this volume from all the compartments in the tenancy.Fetching this information requires traversing through all the compartments in the Tenancy and therefore can potentially take a long time. This option is only supported in experimental mode. When lookup_all_attached_instances=False, only attached compute instances belonging to this volume's compartment, is returned. This is useful when the volume is used within a single compartment. When lookup_all_attached_instances=True, all the compartments in the tenancy are searched to find out the compute instances that are attached to this volume. Fetching information about compute instances attached to this volume is an experimental feature (ie, this may or may not be supported in future releases). To use such experimental features, set the environment variable OCI_ANSIBLE_EXPERIMENTAL to True.
region			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.
size_in_gbs		Default: 50	The size of the volume in GBs.
source_details			Specifies the volume source details for a new Block volume. The volume source is either another Block volume in the same Availability Domain or a Block volume backup. This is an optional field. If not specified or set to null, the new Block volume will be empty. When specified, the new Block volume will contain data from the source volume or backup.
	wait_for_copy bool	Choices: no ← yes	Whether to wait for the operation of copying from source volume or backup to complete when source_details.id is specified under `source_details`.
	type	Choices: volumeBackup volume	Type of volume source details. Use source_details.type=volumeBackup for restoring a volume backup. Use source_details.type=volume for cloning a volume.
	id		The OCID of the volume backup from which the data should be restored on the newly created volume when source_details.type=volumeBackup or the OCID of the volume to be cloned when source_details.type=volume.
	copy_timeout	Default: 1800	Time, in seconds, to wait for the operation to complete when wait_for_copy=yes.
state		Choices: present ← absent	Create or update a volume with state=present. Delete a volume with state=absent.
tenancy			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_id			The OCID of the volume. Required when updating a volume with state=present or deleting a volume with state=absent. aliases: id
wait bool		Choices: no yes ←	Whether to wait for create or delete operation to complete.
wait_timeout		Default: 1200	Time, in seconds, to wait when wait=yes.
wait_until			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
  oci_volume:
    availability_domain: IwGV:US-ASHBURN-AD-2
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: ansible_volume
    wait: no

- name: Create a clone of an existing volume
  oci_volume:
    availability_domain: IwGV:US-ASHBURN-AD-2
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: ansible_volume
    source_details:
      id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
      type: volume
      wait_for_copy: yes
      copy_timeout: 900

- name: Create a volume and initialize it from a backup
  oci_volume:
    availability_domain: IwGV:US-ASHBURN-AD-2
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    name: ansible_volume
    source_details:
      id: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx
      type: volumeBackup

- name: Update a volume
  oci_volume:
    name: ansible_test_volume
    volume_id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx

- name: Delete a volume
  oci_volume:
    volume_id: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
    state: 'absent'

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key			Returned	Description
volume complex			On successful create and update operation	Information about the volume Sample: {'lifecycle_state': 'AVAILABLE', 'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'display_name': 'ansible_test_volume', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'attached_instance_information': {'lifecycle_state': 'ATTACHED', 'availability_domain': 'IwGV:US-ASHBURN-AD-2', 'display_name': 'volumeattachment20171204124856', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'chap_username': None, 'time_created': '2017-12-04T12:48:56.497000+00:00', 'id': 'ocid1.volumeattachment.oc1.iad.xxxxxEXAMPLExxxxx', 'instance_id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx', 'iqn': 'iqn.2015-12.com.oracleiaas:8ea342ff-4687-4038-b733-d20cb1025b48', 'ipv4': '169.254.2.7', 'volume_id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx', 'attachment_type': 'iscsi', 'port': 3260, 'chap_secret': None}, 'size_in_mbs': 51200, 'time_created': '2017-12-05T15:35:28.747000+00:00', 'source_details': {'type': 'volume', 'id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx'}, 'size_in_gbs': 50, 'is_hydrated': True, 'id': 'ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx'}
	lifecycle_state string		always	The current state of a volume. Sample: PROVISIONING
	availability_domain string		always	The Availability Domain of the volume. Sample: IwGV:US-ASHBURN-AD-2
	display_name string		always	Name of the volume. Sample: ansible_test_volume
	compartment_id string		always	The OCID of the compartment that contains the volume. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	attached_instance_information dict		In experimental mode.	Information of instance currently attached to the block volume.
		lifecycle_state string	when this volume is attached to a compute instance	The current state of the volume attachment. Sample: ATTACHED
		availability_domain string	when this volume is attached to a compute instance	The Availability Domain of an instance. Sample: BnQb:PHX-AD-1
		display_name string	when this volume is attached to a compute instance	A user-friendly name. Does not have to be unique, and it cannot be changed. Sample: My volume attachment
		compartment_id string	when this volume is attached to a compute instance	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
		chap_username string	when this volume is attached to a compute instance	The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. Sample: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx
		time_created string	when this volume is attached to a compute instance	The date and time the volume was created, in the format defined by RFC3339. Sample: 2016-08-25 21:10:29.600000
		id string	when this volume is attached to a compute instance	The OCID of the volume attachment. Sample: ocid1.volumeattachment.oc1.phx.xxxxxEXAMPLExxxxx
		instance_id string	when this volume is attached to a compute instance	The OCID of the instance the volume is attached to. Sample: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx
		iqn string	when this volume is attached to a compute instance	The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Sample: iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9
		ipv4 string	when this volume is attached to a compute instance	The volume's iSCSI IP address. Sample: 169.254.0.2
		volume_id string	when this volume is attached to a compute instance	The OCID of the volume. Sample: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx
		attachment_type string	when this volume is attached to a compute instance	The type of volume attachment. Sample: iscsi
		port int	when this volume is attached to a compute instance	The volume's iSCSI port. Sample: 3260
		chap_secret string	when this volume is attached to a compute instance	The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".) Sample: d6866c0d-298b-48ba-95af-309b4faux45e
	size_in_mbs int		always	The size of the volume in MBs. Sample: 51200
	time_created datetime		always	The date and time the volume was created. Format defined by RFC3339. Sample: 2017-11-22 19:40:08.871000
	source_details dict		always	The volume source, either an existing volume in the same Availability Domain or a volume backup. Sample: {'type': 'volumeBackup', 'id': 'ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx'}
		type string	When a volume is initialized from a source volume or a backup.	Type of volume source either 'volumeBackup' or 'volume'. Sample: volumeBackup
		id string	When a volume is initialized from a source volume or a backup.	The OCID of the source volume or the OCID of the volume backup. Sample: ocid1.volumebackup.oc1.iad.xxxxxEXAMPLExxxxx
	size_in_gbs int		always	The size of the volume in GBs. Sample: 50
	is_hydrated bool		always	Specifies whether the cloned volume's data has finished copying from the source volume or backup.
	id string		always	The OCID of the volume. Sample: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Author ¶

Rohit Chaware (@rohitChaware)

Hint

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