oci_instance_pool_facts – Retrieve facts of instance pools in OCI Compute Service

New in version 2.5.

Synopsis

  • This module retrieves information of a specified instance pool or all the instance pools in a specified compartment.

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
-
The OCID of the compartment. Required to get information of all the instance pools in a specified 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
-
The OCID of the instance pool. Required to get information of the specified 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 the instance pools for a specific availability domain & compartment_id
  oci_instance_pool_facts:
    compartment_id: ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...abcd

- name: Get information of a instance pool
  oci_instance_pool_facts:
    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_pools
complex
On success
List of instance pool information

Sample:
[{'time-created': '2018-11-09T16:58:35.270000+00:00', 'lifecycle-state': 'PROVISIONING', 'placement-configurations': [{'secondary-vnic-subnets': None, 'availability-domain': 'IwGV:US-ASHBURN-AD-1', 'primary-subnet-id': 'ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx...dq4a'}], 'compartment-id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...glmkwq', 'freeform-tags': {}, 'instance-configuration-id': 'ocid1.instanceconfiguration.oc1.iad.xxxxxEXAMPLExxxxx...iejka', 'display-name': 'backend-servers-pool', 'defined-tags': {}, 'id': 'ocid1.instancepool.oc1.iad.xxxxxEXAMPLExxxxx...tztpq', 'size': 1}]
  compartment_id
string
always
The OCID of the compartment containing the instance pool.

Sample:
ocid1.compartment.oc1..xxxxxEXAMPLExxxxx
  defined_tags
string
always
Defined tags for this resource. Each key is predefined and scoped to a namespace.

Sample:
{'Operations': {'CostCenter': '42'}}
  display_name
string
always
A user-friendly name for the instance pool. Does not have to be unique.

Sample:
backend-servers-pool
  freeform_tags
string
always
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace.

Sample:
{'Department': 'Finance'}
  id
string
always
The OCID of the instance pool.

Sample:
ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
  instance_configuration_id
string
always
The OCID of the instance configuration associated to the intance pool.

Sample:
ocid1.instanceconfiguration.oc1.phx.xxxxxEXAMPLExxxxx...rzxkhq
  lifecycle_state
string
always
The current state of the instance pool.

Sample:
RUNNING
  placement_configurations
complex
always
The placement configurations for the instance pool.

  size
integer
always
The number of instances in the instance pool.

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

Sample:
2018-11-07T04:16:20.454000+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

  • Sivakumar Thyagarajan (@sivakumart)

Hint

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