oci_boot_volume_facts – Retrieve facts of boot 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 boot volume or all the boot 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_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.
availability_domain -		The name of the Availability Domain. Required to get information of all the boot volumes in the specified compartment_id and availability_domain. This option is mutually exclusive with boot_volume_id.
boot_volume_id -		The OCID of the boot volume. Required to get information of a specific boot volume. This option is mutually exclusive with availability_domain. aliases: id
compartment_id -		The OCID of the compartment. Required to get information of all the boot volumes in the specified compartment_id and availability_domain.
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.
lookup_attached_instance boolean	Choices: no ← yes	Whether to fetch information of the compute instance attached to this boot 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 an attached compute instance belonging to this boot volume's compartment, is returned. This is useful when the boot 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 instance that is attached to this boot volume. Fetching information about compute instances attached to this boot 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.

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 boot volumes for a specific availability domain & compartment_id
  oci_boot_volume_facts:
    availability_domain: BnQb:PHX-AD-1
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx

- name: Get information of a boot volume
  oci_boot_volume_facts:
    boot_volume_id: ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx

Return Values ¶

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

Key			Returned	Description
boot_volumes complex			On success	List of boot volume information Sample: [{'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx', 'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'size_in_mbs': 47694, 'image_id': 'ocid1.image.oc1.iad.xxxxxEXAMPLExxxxx', 'attached_instance_information': {'boot_volume_id': 'ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx', 'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'display_name': 'Remote boot attachment for instance', 'instance_id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ATTACHED', 'time_created': '2018-01-14T19:02:49.085000+00:00'}, 'size_in_gbs': 46, 'display_name': 'demo-20171214-100_bastion_instance (Boot Volume)', 'lifecycle_state': 'AVAILABLE', 'time_created': '2018-01-14T19:02:49.042000+00:00'}]
	attached_instance_information list		always	Information of the instances the boot volume is attached to.
		availability_domain string	when this boot volume is attached to a compute instance	The Availability Domain of an instance. Sample: BnQb:PHX-AD-1
		boot_volume_id string	when this boot volume is attached to a compute instance	The OCID of the boot volume. Sample: ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx
		compartment_id string	when this boot volume is attached to a compute instance	The OCID of the compartment. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
		display_name string	when this boot volume is attached to a compute instance	A user-friendly name. Does not have to be unique, and it cannot be changed. Sample: My boot volume attachment
		id string	when this boot volume is attached to a compute instance	The OCID of the boot volume attachment. Sample: ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx
		instance_id string	when this boot volume is attached to a compute instance	The OCID of the instance the boot volume is attached to. Sample: ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx
		lifecycle_state string	when this boot volume is attached to a compute instance	The current state of the boot volume attachment. Sample: ATTACHED
		time_created string	when this boot volume is attached to a compute instance	The date and time the boot volume was created, in the format defined by RFC3339. Sample: 2016-08-25 21:10:29.600000+00:00
	availability_domain string		always	The Availability Domain of the boot volume. Sample: IwGV:US-ASHBURN-AD-2
	compartment_id string		always	The OCID of the compartment that contains the boot volume. Sample: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
	display_name string		always	Name of the boot volume. Sample: ansible_boot_volume
	id string		always	The OCID of the boot volume. Sample: ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx
	image_id string		always	The image OCID used to create the boot volume. Sample: ocid1.image.oc1.iad.xxxxxEXAMPLExxxxx
	lifecycle_state string		always	The current state of a boot volume. Sample: PROVISIONING
	size_in_gbs integer		always	The size of the boot volume in GBs. Sample: 50
	size_in_mbs integer		always	The size of the boot volume in MBs. Sample: 51200
	time_created datetime		always	The date and time the boot volume was created. Format defined by RFC3339. Sample: 2017-11-22 19:40:08.871000+00:00

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

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶