oracle.oci.oci_compute_management_instance_pool_instance – Manage an InstancePoolInstance resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 5.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install oracle.oci.

To use it in a playbook, specify: oracle.oci.oci_compute_management_instance_pool_instance.

New in version 2.9.0: of oracle.oci

Synopsis

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_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_purpose
string
    Choices:
  • service_principal
The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None.
auth_type
string
    Choices:
  • api_key ←
  • instance_principal
  • instance_obo_user
  • resource_principal
  • security_token
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.
cert_bundle
string
The full path to a CA certificate bundle to be used for SSL verification. This will override the default CA certificate bundle. If not set, then the value of the OCI_ANSIBLE_CERT_BUNDLE variable, if any, is used.
compartment_id
string / 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.
force_create
boolean
    Choices:
  • no ←
  • yes
Whether to attempt non-idempotent creation of a resource. By default, create resource is an idempotent operation, and doesn't create the resource if it already exists. Setting this option to true, forcefully creates a copy of the resource, even if it already exists.This option is mutually exclusive with key_by.
instance_id
string / required
The OCID of the instance.

aliases: id
instance_pool_id
string / required
The OCID of the instance pool.
key_by
list / elements=string
The list of attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource are used to uniquely identify a resource.
realm_specific_endpoint_template_enabled
boolean
    Choices:
  • no
  • yes
Enable/Disable realm specific endpoint template for service client. By Default, realm specific endpoint template is disabled. If not set, then the value of the OCI_REALM_SPECIFIC_SERVICE_ENDPOINT_TEMPLATE_ENABLED variable, if any, is used.
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.
state
string
    Choices:
  • present ←
The state of the InstancePoolInstance.
Use state=present to create an InstancePoolInstance.
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
wait
boolean
    Choices:
  • no
  • yes ←
Whether to wait for create or delete operation to complete.
wait_timeout
integer
Time, in seconds, to wait when wait=yes. Defaults to 1200 for most of the services but some services might have a longer wait timeout.

Examples

- name: Create instance_pool_instance
  oci_compute_management_instance_pool_instance:
    # required
    instance_pool_id: "ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx"
    instance_id: "ocid1.instance.oc1..xxxxxxEXAMPLExxxxxx"

Return Values

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

Key Returned Description
instance_pool_instance
complex
on success
Details of the InstancePoolInstance resource acted upon by the current operation

Sample:
{'availability_domain': 'Uocm:PHX-AD-1', 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'display_name': 'display_name_example', 'fault_domain': 'FAULT-DOMAIN-1', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_configuration_id': 'ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx', 'instance_pool_id': 'ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ATTACHING', 'load_balancer_backends': [{'backend_health_status': 'OK', 'backend_name': 'backend_name_example', 'backend_set_name': 'backend_set_name_example', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx'}], 'region': 'us-phoenix-1', 'shape': 'shape_example', 'state': 'state_example', 'time_created': '2013-10-20T19:20:30+01:00'}
 
availability_domain
string
on success
The availability domain the instance is running in.

Sample:
Uocm:PHX-AD-1
 
compartment_id
string
on success
The OCID of the compartment that contains the instance.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
display_name
string
on success
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

Sample:
display_name_example
 
fault_domain
string
on success
The fault domain the instance is running in.

Sample:
FAULT-DOMAIN-1
 
id
string
on success
The OCID of the instance.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
instance_configuration_id
string
on success
The OCID of the instance configuration used to create the instance.

Sample:
ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx
 
instance_pool_id
string
on success
The OCID of the instance pool.

Sample:
ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The attachment state of the instance in relation to the instance pool.

Sample:
ATTACHING
 
load_balancer_backends
complex
on success
The load balancer backends that are configured for the instance.
   
backend_health_status
string
on success
The health of the backend as observed by the load balancer.

Sample:
OK
   
backend_name
string
on success
The name of the backend in the backend set.

Sample:
backend_name_example
   
backend_set_name
string
on success
The name of the backend set on the load balancer.

Sample:
backend_set_name_example
   
load_balancer_id
string
on success
The OCID of the load balancer attached to the instance pool.

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
 
region
string
on success
The region that contains the availability domain the instance is running in.

Sample:
us-phoenix-1
 
shape
string
on success
The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance.

Sample:
shape_example
 
state
string
on success
The lifecycle state of the instance. Refer to `lifecycleState` in the Instance resource.

Sample:
state_example
 
time_created
string
on success
The date and time the instance pool instance was created, in the format defined by RFC3339. Example: `2016-08-25T21:10:29.600Z`

Sample:
2013-10-20T19:20:30+01:00


Authors

  • Oracle (@oracle)