oci_boot_volume_attachment_facts – Retrieve facts of boot volume attachments in OCI

New in version 2.5.

Synopsis

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

Requirements

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

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. Required to get information of all the boot volume attachments in the specified compartment_id and availability_domain.
boot_volume_attachment_id
-
The OCID of the boot volume attachment. Required to get information of a specific boot volume attachment.

aliases: id
boot_volume_id
-
The OCID of the boot volume. Use boot_volume_id with compartment_id and availability_domain to get boot volume attachment information related to boot_volume_id.
compartment_id
-
The OCID of the compartment. Required to get information of all the boot volume attachments 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.
instance_id
-
The OCID of the instance. Use instance_id with compartment_id and availability_domain to get boot volume attachment information related to instance_id.
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

Examples

- name: Get information of all boot volume attachments in a compartment and availability domain
  oci_boot_volume_attachment_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
    availability_domain: IwGV:US-ASHBURN-AD-1

- name: Get information of a specific boot volume attachment
  oci_boot_volume_attachment:
    id: ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx

Return Values

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

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

Sample:
[{'boot_volume_id': 'ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx', 'availability_domain': 'IwGV:US-ASHBURN-AD-1', 'display_name': 'Remote boot attachment for instance', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx', 'lifecycle_state': 'ATTACHED', 'time_created': '2018-01-15T07:23:10.838000+00:00', 'instance_id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx', 'id': 'ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx'}]
  availability_domain
string
always
The Availability Domain of the instance.

Sample:
BnQb:PHX-AD-1
  boot_volume_id
string
always
The OCID of the boot volume.

Sample:
ocid1.bootvolume.oc1.iad.xxxxxEXAMPLExxxxx
  compartment_id
string
always
The OCID of the compartment.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  display_name
string
always
A user-friendly name. Does not have to be unique, and it cannot be changed.

Sample:
My boot volume attachment
  id
string
always
The OCID of the boot volume attachment.

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

Sample:
ocid1.instance.oc1.iad.xxxxxEXAMPLExxxxx
  lifecycle_state
string
always
The current state of the boot volume attachment.

Sample:
ATTACHED
  time_created
string
always
The date and time the boot volume was created, in the format defined by RFC3339.



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.