oci_volume_facts – Retrieve facts of volumes in OCI Block Volume service¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

This module retrieves information of a specified volume or all the volumes in a specified compartment and availability domain.

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_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 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	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 name of the Availability Domain.
compartment_id -		The OCID of the compartment. Required to get information of all the volumes in a specified compartment. This option is mutually exclusive with volume_id.
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`.
display_name string		Use display_name along with the other options to return only resources that match the given display name exactly.
lifecycle_state -	Choices: PROVISIONING RESTORING AVAILABLE TERMINATING TERMINATED FAULTY	A filter to only return resources that match the given lifecycle state. The state value is case-insensitive. Allowed values are "PROVISIONING", "RESTORING", "AVAILABLE", "TERMINATING", "TERMINATED", "FAULTY".
lookup_all_attached_instances boolean	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 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_group_id -		The OCID of the volume group.
volume_id -		The OCID of the volume. Required to get information of a specific volume. This option is mutually exclusive with compartment_id. aliases: id

Notes ¶

Note

For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html

Examples ¶

- name: Get information of all the volumes for a specific availability domain & compartment_id
  oci_volume_facts:
    availability_domain: BnQb:PHX-AD-1
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get information of a volume
  oci_volume_facts:
    volume_id: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx

Return Values ¶

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

Key			Returned	Description
volumes complex			On success	List of volume information 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'}]
	attached_instance_information list		always	Information of instances currently attached to the block volume.
		attachment_type string	when this volume is attached to a compute instance	The type of volume attachment. Sample: iscsi
		availability_domain string	when this volume is attached to a compute instance	The Availability Domain of an instance. Sample: BnQb:PHX-AD-1
		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
		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
		compartment_id string	when this volume is attached to a compute instance	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
		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
		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
		ipv4 string	when this volume is attached to a compute instance	The volume's iSCSI IP address. Sample: 169.254.0.2
		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
		lifecycle_state string	when this volume is attached to a compute instance	The current state of the volume attachment. Sample: ATTACHED
		port integer	when this volume is attached to a compute instance	The volume's iSCSI port. Sample: 3260
		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
		volume_id string	when this volume is attached to a compute instance	The OCID of the volume. Sample: ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx
	availability_domain string		always	The Availability Domain of the volume. Sample: IwGV:US-ASHBURN-AD-2
	compartment_id string		always	The OCID of the compartment that contains the volume. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	display_name string		always	Name of the volume. Sample: ansible_test_volume
	id string		always	The OCID of the volume. Sample: ocid1.volume.oc1.iad.xxxxxEXAMPLExxxxx
	is_hydrated boolean		always	Specifies whether the cloned volume's data has finished copying from the source volume or backup.
	lifecycle_state string		always	The current state of a volume. Sample: PROVISIONING
	size_in_gbs integer		always	The size of the volume in GBs. Sample: 50
	size_in_mbs integer		always	The size of the volume in MBs. Sample: 51200
	source_details dictionary		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'}
		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
		type string	When a volume is initialized from a source volume or a backup.	Type of volume source either 'volumeBackup' or 'volume'. Sample: volumeBackup
	time_created datetime		always	The date and time the volume was created. Format defined by RFC3339. Sample: 2017-11-22 19:40:08.871000

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_facts – Retrieve facts of volumes in OCI Block Volume service¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶