oracle.oci.oci_compute_volume_attachment – Manage a VolumeAttachment resource in Oracle Cloud Infrastructure¶

Note

This plugin is part of the oracle.oci collection (version 5.3.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_compute_volume_attachment.

New in version 2.9.0: of oracle.oci

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

Synopsis ¶

This module allows the user to create, update and delete a VolumeAttachment resource in Oracle Cloud Infrastructure
For state=present, attaches the specified storage volume to the specified instance.

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	Choices: service_principal	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	Choices: api_key ← instance_principal instance_obo_user resource_principal security_token	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`.
device string		The device name. To retrieve a list of devices for a given instance, see ListInstanceDevices.
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. aliases: name
encryption_in_transit_type string	Choices: NONE BM_ENCRYPTION_IN_TRANSIT	Refer the top-level definition of encryptionInTransitType. The default value is NONE. Applicable when type is 'iscsi'
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.
instance_id string		The OCID of the instance. Required for create using state=present.
is_agent_auto_iscsi_login_enabled boolean	Choices: no yes	Whether to enable Oracle Cloud Agent to perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments. Applicable when type is 'iscsi'
is_pv_encryption_in_transit_enabled boolean	Choices: no yes	Whether to enable in-transit encryption for the data volume's paravirtualized attachment. The default value is false. Applicable when type is 'paravirtualized'
is_read_only boolean	Choices: no yes	Whether the attachment was created in read-only mode.
is_shareable boolean	Choices: no yes	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.
iscsi_login_state string	Choices: UNKNOWN LOGGING_IN LOGIN_SUCCEEDED LOGIN_FAILED LOGGING_OUT LOGOUT_SUCCEEDED LOGOUT_FAILED	The iscsi login state of the volume attachment. For a multipath volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. 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.
realm_specific_endpoint_template_enabled boolean	Choices: no yes	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	Choices: present ← absent	The state of the VolumeAttachment. Use state=present to create or update a VolumeAttachment. Use state=absent to delete a VolumeAttachment.
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	Choices: service_determined emulated iscsi paravirtualized	The type of volume. The only supported values are "iscsi" and "paravirtualized". Required for create using state=present.
use_chap boolean	Choices: no yes	Whether to use CHAP authentication for the volume attachment. Defaults to false. Applicable when type is 'iscsi'
volume_attachment_id string		The OCID of the volume attachment. 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. Required for create using state=present.
wait boolean	Choices: no yes ←	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_attachment with type = service_determined
  oci_compute_volume_attachment:
    # required
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
    type: service_determined
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    device: device_example
    display_name: display_name_example
    is_read_only: true
    is_shareable: true

- name: Create volume_attachment with type = emulated
  oci_compute_volume_attachment:
    # required
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
    type: emulated
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    device: device_example
    display_name: display_name_example
    is_read_only: true
    is_shareable: true

- name: Create volume_attachment with type = iscsi
  oci_compute_volume_attachment:
    # required
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
    type: iscsi
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    use_chap: true
    encryption_in_transit_type: NONE
    is_agent_auto_iscsi_login_enabled: true
    device: device_example
    display_name: display_name_example
    is_read_only: true
    is_shareable: true

- name: Create volume_attachment with type = paravirtualized
  oci_compute_volume_attachment:
    # required
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"
    type: paravirtualized
    volume_id: "ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    device: device_example
    display_name: display_name_example
    is_read_only: true
    is_shareable: true
    is_pv_encryption_in_transit_enabled: true

- name: Update volume_attachment
  oci_compute_volume_attachment:
    # required
    volume_attachment_id: "ocid1.volumeattachment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    iscsi_login_state: UNKNOWN

- name: Update volume_attachment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_volume_attachment:
    # required
    display_name: display_name_example
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    iscsi_login_state: UNKNOWN

- name: Delete volume_attachment
  oci_compute_volume_attachment:
    # required
    volume_attachment_id: "ocid1.volumeattachment.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete volume_attachment using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_volume_attachment:
    # 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_attachment complex			on success	Details of the VolumeAttachment resource acted upon by the current operation Sample: {'attachment_type': 'emulated', 'availability_domain': 'Uocm:PHX-AD-1', 'chap_secret': 'chap_secret_example', 'chap_username': 'chap_username_example', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'device': 'device_example', 'display_name': 'display_name_example', 'encryption_in_transit_type': 'NONE', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_id': 'ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx', 'ipv4': 'ipv4_example', 'iqn': 'iqn_example', 'is_agent_auto_iscsi_login_enabled': True, 'is_multipath': True, 'is_pv_encryption_in_transit_enabled': True, 'is_read_only': True, 'is_shareable': True, 'iscsi_attach_commands': ['sudo iscsiadm -m node -o new -T IQN -p IP:PORT', 'sudo iscsiadm -m node -o update ...'], 'iscsi_detach_commands': ['sudo iscsiadm -m node -T IQN -p IP:PORT -u', 'sudo iscsiadm -m node -o delete -T IQN'], 'iscsi_login_state': 'UNKNOWN', 'lifecycle_state': 'ATTACHING', 'multipath_devices': [{'ipv4': 'ipv4_example', 'iqn': 'iqn_example', 'port': 56}], 'port': 56, 'time_created': '2013-10-20T19:20:30+01:00', 'volume_id': 'ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx'}
	attachment_type string		on success	The type of volume attachment. Sample: emulated
	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".) Sample: chap_secret_example
	chap_username string		on success	The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name. See RFC 1994 for more on CHAP. Example: `ocid1.volume.oc1.phx.<unique_ID>` Sample: chap_username_example
	compartment_id string		on success	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
	device string		on success	The device name. Sample: device_example
	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
	encryption_in_transit_type string		on success	Refer the top-level definition of encryptionInTransitType. The default value is NONE. Sample: NONE
	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: ipv4_example
	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:<CHAP_username>` Sample: iqn_example
	is_agent_auto_iscsi_login_enabled boolean		on success	Whether Oracle Cloud Agent is enabled perform the iSCSI login and logout commands after the volume attach or detach operations for non multipath-enabled iSCSI attachments. Sample: True
	is_multipath boolean		on success	Whether the Iscsi or Paravirtualized attachment is multipath or not, it is not applicable to NVMe attachment. Sample: True
	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
	iscsi_attach_commands list / elements=string		on success	Commands to attach the iSCSI block volume. Empty if attachment_type is not iscsi. Sample: ['sudo iscsiadm -m node -o new -T IQN -p IP:PORT', 'sudo iscsiadm -m node -o update ...']
	iscsi_detach_commands list / elements=string		on success	Commands to detach the iSCSI block volume. Empty if attachment_type is not iscsi. Sample: ['sudo iscsiadm -m node -T IQN -p IP:PORT -u', 'sudo iscsiadm -m node -o delete -T IQN']
	iscsi_login_state string		on success	The iscsi login state of the volume attachment. For a Iscsi volume attachment, all iscsi sessions need to be all logged-in or logged-out to be in logged-in or logged-out state. Sample: UNKNOWN
	lifecycle_state string		on success	The current state of the volume attachment. Sample: ATTACHING
	multipath_devices complex		on success	A list of secondary multipath devices
		ipv4 string	on success	The volume's iSCSI IP address. Example: `169.254.2.2` Sample: ipv4_example
		iqn string	on success	The target volume's iSCSI Qualified Name in the format defined by RFC 3720. Example: `iqn.2015-12.com.oracleiaas:40b7ee03-883f-46c6-a951-63d2841d2195` Sample: iqn_example
		port integer	on success	The volume's iSCSI port, usually port 860 or 3260. Example: `3260` Sample: 56
	port integer		on success	The volume's iSCSI port, usually port 860 or 3260. Example: `3260` Sample: 56
	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: 2013-10-20T19:20:30+01:00
	volume_id string		on success	The OCID of the volume. Sample: ocid1.volume.oc1..xxxxxxEXAMPLExxxxxx

Authors¶

Oracle (@oracle)

oracle.oci.oci_compute_volume_attachment – Manage a VolumeAttachment resource in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶