oci_volume_attachment – Attach or detach a volume in OCI Block Volume service¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module allows the user to attach a volume to an instance or detach a volume from an instance in OCI.

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_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`.
device -		The device name.
display_name -		A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information.
instance_id -		The OCID of the instance. Required to attach a volume to an instance with state=present.
is_read_only boolean	Choices: no ← yes	Whether the attachment was created in read-only mode.
is_shareable -		Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified.
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 attach a volume to an instance. Use state=absent to detach a volume from an instance.
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: iscsi paravirtualized	The type of volume. Required to attach a volume to an instance with state=present.
use_chap boolean	Choices: no ← yes	Whether to use CHAP authentication for the volume attachment.
volume_attachment_id -		The OCID of the volume attachment. Required to detach a volume from an instance with state=absent. aliases: id
volume_id -		The OCID of the volume. Required to attach a volume to an instance with state=present.
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: Attach a volume to an instance
  oci_volume_attachment:
    instance_id: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx
    type: iscsi
    volume_id: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx

- name: Detach a volume from an instance
  oci_volume_attachment:
    volume_attachment_id: ocid1.volumeattachment.oc1.phx.xxxxxEXAMPLExxxxx
    state: absent

Return Values ¶

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

Key		Returned	Description
volume_attachment complex		on success	Details of the VolumeAttachment resource acted upon by the current operation Sample: {'is_pv_encryption_in_transit_enabled': True, 'availability_domain': 'Uocm:PHX-AD-1', 'iscsi_attach_commands': ['sudo iscsiadm -m node -o new -T iqn.2015-12.com.oracleiaas:1edac499-4d1b-4451-ba52-b803d0fb7328 -p 169.254.2.2:3260', 'sudo iscsiadm -m node -o update -T iqn.2015-12.com.oracleiaas:1edac499-4d1b-4451-ba52-b803d0fb7328 -n node.startup -v automatic', 'sudo iscsiadm -m node -T iqn.2015-12.com.oracleiaas:1edac499-4d1b-4451-ba52-b803d0fb7328 -p 169.254.2.2:3260 -l'], 'port': 3260, 'iscsi_detach_commands': ['sudo iscsiadm -m node -T iqn.2015-12.com.oracleiaas:1edac499-4d1b-4451-ba52-b803d0fb7328 -p 169.254.2.2:3260 -u', 'sudo iscsiadm -m node -o delete -T iqn.2015-12.com.oracleiaas:1edac499-4d1b-4451-ba52-b803d0fb7328'], 'attachment_type': 'attachment_type_example', 'ipv4': '169.254.0.2', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'My volume attachment', 'chap_username': 'ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q', 'is_shareable': True, 'time_created': '2016-08-25T21:10:29.600Z', 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ATTACHING', 'chap_secret': 'd6866c0d-298b-48ba-95af-309b4faux45e', 'iqn': 'iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9', 'is_read_only': True, 'device': '/dev/oracleoci/oraclevdb', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}
	attachment_type string	on success	The type of volume attachment. Sample: attachment_type_example
	availability_domain string	on success	The availability domain of an instance. Example: `Uocm:PHX-AD-1` Sample: Uocm:PHX-AD-1
	chap_secret string	on success	The Challenge-Handshake-Authentication-Protocol (CHAP) secret valid for the associated CHAP user name. (Also called the "CHAP password".) Example: `d6866c0d-298b-48ba-95af-309b4faux45e` Sample: d6866c0d-298b-48ba-95af-309b4faux45e
	chap_username string	on success	The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. Example: `ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q` Sample: ocid1.volume.oc1.phx.abyhqljrgvttnlx73nmrwfaux7kcvzfs3s66izvxf2h4lgvyndsdsnoiwr5q
	compartment_id string	on success	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	device string	on success	The device name. Sample: /dev/oracleoci/oraclevdb
	display_name string	on success	A user-friendly name. Does not have to be unique, and it cannot be changed. Avoid entering confidential information. Example: `My volume attachment` Sample: My volume attachment
	id string	on success	The OCID of the volume attachment. Sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
	instance_id string	on success	The OCID of the instance the volume is attached to. Sample: ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx
	ipv4 string	on success	The volume's iSCSI IP address. Example: `169.254.0.2` Sample: 169.254.0.2
	iqn string	on success	The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: `iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9` Sample: iqn.2015-12.us.oracle.com:456b0391-17b8-4122-bbf1-f85fc0bb97d9
	is_pv_encryption_in_transit_enabled boolean	on success	Whether in-transit encryption for the data volume's paravirtualized attachment is enabled or not. Sample: True
	is_read_only boolean	on success	Whether the attachment was created in read-only mode. Sample: True
	is_shareable boolean	on success	Whether the attachment should be created in shareable mode. If an attachment is created in shareable mode, then other instances can attach the same volume, provided that they also create their attachments in shareable mode. Only certain volume types can be attached in shareable mode. Defaults to false if not specified. Sample: True
	lifecycle_state string	on success	The current state of the volume attachment. Sample: ATTACHING
	port integer	on success	The volume's iSCSI port. Example: `3260` Sample: 3260
	time_created string	on success	The date and time the volume was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z` Sample: 2016-08-25 21:10:29.600000+00:00
	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¶

Rohit Chaware (@rohitChaware)

Hint

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

oci_volume_attachment – Attach or detach a volume in OCI Block Volume service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶