oci_volume_attachment_facts - Retrieve facts of volume attachments in OCI

New in version 2.5.

Synopsis

  • This module retrieves information of a specified volume attachment or all the volume attachments in a specified compartment.

Requirements

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

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.
compartment_id
The OCID of the compartment. Required to get information of all the volume attachments in a specific compartment.
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.
display_name
Use display_name along with the other options to return only resources that match the given display name exactly.
instance_id
The OCID of the instance. Use instance_id with compartment_id to get volume attachment information related to instance_id.
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.
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_attachment_id
The OCID of the volume attachment. Required to get information of a specific volume attachment.

aliases: id
volume_id
The OCID of the volume. Use volume_id with compartment_id to get volume attachment information related to volume_id.

Examples

- name: Get information of all volume attachments in a compartment
  oci_volume_attachment_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get volume attachment information for a specified compartment & instance
  oci_volume_attachment_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    instance_id: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx

- name: Get volume attachment information for a specified compartment & block volume
  oci_volume_attachment_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    volume_id: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx

- name: Get information of a specific volume attachment
  oci_volume_attachment:
    volume_attachment_id: ocid1.volumeattachment.oc1.phx.xxxxxEXAMPLExxxxx

Return Values

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

Key Returned Description
volume_attachments
complex
 On success
List of information about volume attachments

Sample:
[{'lifecycle_state': 'ATTACHED', 'availability_domain': 'BnQb:PHX-AD-1', 'display_name': 'ansible_volume_attachment', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'chap_username': None, 'time_created': '2017-11-23T11:17:50.139000+00:00', 'id': 'ocid1.volumeattachment.oc1.phx.xxxxxEXAMPLExxxxx', 'instance_id': 'ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx', 'iqn': 'iqn.2015-12.com.oracleiaas:472a085d-41a9-4c18-ae7d-dea5b296dad3', 'ipv4': '169.254.2.2', 'volume_id': 'ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx', 'attachment_type': 'iscsi', 'port': 3260, 'chap_secret': None}]
  lifecycle_state
string
 always
The current state of the volume attachment.

Sample:
ATTACHED
  availability_domain
string
 always
The Availability Domain of an instance.

Sample:
BnQb:PHX-AD-1
  display_name
string
 always
A user-friendly name. Does not have to be unique, and it cannot be changed.

Sample:
My volume attachment
  compartment_id
string
 always
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  chap_username
string
 always
The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name.

Sample:
ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx
  time_created
string
 always
The date and time the volume was created, in the format defined by RFC3339.

Sample:
2016-08-25 21:10:29.600000
  id
string
 always
The OCID of the volume attachment.

Sample:
ocid1.volumeattachment.oc1.phx.xxxxxEXAMPLExxxxx
  instance_id
string
 always
The OCID of the instance the volume is attached to.

Sample:
ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx
  iqn
string
 always
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
 always
The volume's iSCSI IP address.

Sample:
169.254.0.2
  volume_id
string
 always
The OCID of the volume.

Sample:
ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx
  attachment_type
string
 always
The type of volume attachment.

Sample:
iscsi
  port
int
 always
The volume's iSCSI port.

Sample:
3260
  chap_secret
string
 always
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


Status

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

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.