oci_instance_pool_instances_facts – Retrieve facts of instance pool instances of an instance pool in OCI Compute Service

New in version 2.5.

Synopsis

  • This module retrieves information of all instances in a specified instance pool.

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.
compartment_id
- / required
The OCID of the compartment.
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.
instance_pool_id
- / required
The OCID of the instance pool.

aliases: 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 instances in the specified instance_pool_id
  oci_instance_pool_instances_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...abcd
    instance_pool_id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...efgh

Return Values

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

Key Returned Description
instance_pool_instances
complex
On success
List of instances in a specified instance pool

Sample:
[{'lifecycle_state': 'TERMINATED', 'availability_domain': 'BnQb:PHX-AD-1', 'extended_metadata': {}, 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx....62xq', 'region': 'phx', 'time_created': '2017-11-20T04:52:54.541000+00:00', 'display_name': 'ansible-modname-968', 'image_id': 'ocid1.image.oc1.phx.xxxxxEXAMPLExxxxx....lnoa', 'shape': 'BM.Standard1.36', 'ipxe_script': None, 'volume_attachments': [{'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}], 'boot_volume_attachment': {'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'}, 'id': 'ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx.....2siq', 'metadata': {'foo': 'bar', 'baz': 'quux'}}]
  availability_domain
string
always
The Availability Domain the instance is running in.

Sample:
BnQb:PHX-AD-1
  boot_volume_attachment
dictionary
In experimental mode.
Information of the boot volume attachment.

    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.phx.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.

Sample:
2016-08-25 21:10:29.600000
  compartment_id
string
always
The OCID of the compartment that contains the instance.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx....62xq
  display_name
string
always
A user-friendly name for the instance

Sample:
ansible-instance-968
  extended_metadata
dict(str, str)
always
Additional key-value pairs associated with the instance

Sample:
{'foo': 'bar'}
  id
string
always
The OCID of the instance.

Sample:
ocid1.instance.oc1.phx.xxxxxEXAMPLExxxxx
  image_id
string
always
The OCID of the image that the instance is based on

Sample:
ocid1.image.oc1.iad.xxxxxEXAMPLExxxxx
  ipxe_script
string
always
A custom iPXE script that will run when the instance boots

  lifecycle_state
string
always
The current state of the instance.

Sample:
TERMINATED
  metadata
dict(str, str)
always
Custom metadata that was associated with the instance

Sample:
{'foo': 'bar'}
  region
string
always
The region that contains the Availability Domain the instance is running in.

Sample:
phx
  shape
string
always
The shape of the instance. The shape determines the number of CPUs and the amount of memory allocated to the instance.

Sample:
BM.Standard1.36
  time_created
string
always
The date and time the instance was created, in the format defined by RFC3339

Sample:
2017-11-20 04:52:54.541000
  volume_attachments
complex
In experimental mode.
List of information about volume attachments

    attachment_type
string
always
The type of volume attachment.

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

Sample:
BnQb:PHX-AD-1
    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
    chap_username
string
always
The volume's system-generated Challenge-Handshake-Authentication-Protocol (CHAP) user name.

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

Sample:
169.254.0.2
    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
    lifecycle_state
string
always
The current state of the volume attachment.

Sample:
ATTACHED
    port
integer
always
The volume's iSCSI port.

Sample:
3260
    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
    volume_id
string
always
The OCID of the volume.

Sample:
ocid1.volume.oc1.phx.xxxxxEXAMPLExxxxx


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Sivakumar Thyagarajan (@sivakumart)

Hint

If you notice any issues in this documentation you can edit this document to improve it.