oracle.oci.oci_compute_management_instance_pool – Manage an InstancePool resource in Oracle Cloud Infrastructure

Note

This plugin is part of the oracle.oci collection (version 4.10.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.

New in version 2.9.0: of oracle.oci

Synopsis

  • This module allows the user to create, update and delete an InstancePool resource in Oracle Cloud Infrastructure

  • For state=present, create an instance pool.

  • This resource has the following action operations in the oracle.oci.oci_compute_management_instance_pool_actions module: attach_load_balancer, change_compartment, detach_load_balancer, reset, softreset, start, stop.

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
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
The OCID of the compartment containing the instance pool.
Required for create using state=present.
Required for update when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
Required for delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
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.
defined_tags
dictionary
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`
This parameter is updatable.
display_name
string
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for create, update, delete when environment variable OCI_USE_NAME_AS_IDENTIFIER is set.
This parameter is updatable when OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: name
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.
freeform_tags
dictionary
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`
This parameter is updatable.
instance_configuration_id
string
The OCID of the instance configuration associated with the instance pool.
Required for create using state=present.
This parameter is updatable.
instance_pool_id
string
The OCID of the instance pool.
Required for update using state=present when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.
Required for delete using state=absent when environment variable OCI_USE_NAME_AS_IDENTIFIER is not set.

aliases: id
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.
load_balancers
list / elements=dictionary
The load balancers to attach to the instance pool.
backend_set_name
string / required
The name of the backend set on the load balancer to add instances to.
load_balancer_id
string / required
The OCID of the load balancer to attach to the instance pool.
port
integer / required
The port value to use when creating the backend set.
vnic_selection
string / required
Indicates which VNIC on each instance in the pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.
placement_configurations
list / elements=dictionary
The placement configurations for the instance pool. Provide one placement configuration for each availability domain.
To use the instance pool with a regional subnet, provide a placement configuration for each availability domain, and include the regional subnet in each placement configuration.
Required for create using state=present.
This parameter is updatable.
availability_domain
string / required
The availability domain to place instances.
Example: `Uocm:PHX-AD-1`
This parameter is updatable.
fault_domains
list / elements=string
The fault domains to place instances.
If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity.
To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability.
To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]`
This parameter is updatable.
primary_subnet_id
string / required
The OCID of the primary subnet to place instances.
This parameter is updatable.
secondary_vnic_subnets
list / elements=dictionary
The set of secondary VNIC data for instances in the pool.
display_name
string
The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.

aliases: name
subnet_id
string / required
The subnet OCID for the secondary VNIC.
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.
size
integer
The number of instances that should be in the instance pool.
Required for create using state=present.
This parameter is updatable.
state
string
    Choices:
  • present ←
  • absent
The state of the InstancePool.
Use state=present to create or update an InstancePool.
Use state=absent to delete an InstancePool.
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
  oci_compute_management_instance_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    instance_configuration_id: "ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
    placement_configurations:
    - # required
      availability_domain: Uocm:PHX-AD-1
      primary_subnet_id: "ocid1.primarysubnet.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      fault_domains: [ "fault_domains_example" ]
      secondary_vnic_subnets:
      - # required
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        display_name: display_name_example
    size: 56

    # optional
    load_balancers:
    - # required
      load_balancer_id: "ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx"
      backend_set_name: backend_set_name_example
      port: 56
      vnic_selection: vnic_selection_example
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}

- name: Update instance_pool
  oci_compute_management_instance_pool:
    # required
    instance_pool_id: "ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx"

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    display_name: display_name_example
    freeform_tags: {'Department': 'Finance'}
    instance_configuration_id: "ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
    placement_configurations:
    - # required
      availability_domain: Uocm:PHX-AD-1
      primary_subnet_id: "ocid1.primarysubnet.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      fault_domains: [ "fault_domains_example" ]
      secondary_vnic_subnets:
      - # required
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        display_name: display_name_example
    size: 56

- name: Update instance_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_management_instance_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example

    # optional
    defined_tags: {'Operations': {'CostCenter': 'US'}}
    freeform_tags: {'Department': 'Finance'}
    instance_configuration_id: "ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
    placement_configurations:
    - # required
      availability_domain: Uocm:PHX-AD-1
      primary_subnet_id: "ocid1.primarysubnet.oc1..xxxxxxEXAMPLExxxxxx"

      # optional
      fault_domains: [ "fault_domains_example" ]
      secondary_vnic_subnets:
      - # required
        subnet_id: "ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx"

        # optional
        display_name: display_name_example
    size: 56

- name: Delete instance_pool
  oci_compute_management_instance_pool:
    # required
    instance_pool_id: "ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx"
    state: absent

- name: Delete instance_pool using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set)
  oci_compute_management_instance_pool:
    # required
    compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
    display_name: display_name_example
    state: absent

Return Values

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

Key Returned Description
instance_pool
complex
on success
Details of the InstancePool resource acted upon by the current operation

Sample:
{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_configuration_id': 'ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'PROVISIONING', 'load_balancers': [{'backend_set_name': 'backend_set_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'instance_pool_id': 'ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx', 'lifecycle_state': 'ATTACHING', 'load_balancer_id': 'ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx', 'port': 56, 'vnic_selection': 'vnic_selection_example'}], 'placement_configurations': [{'availability_domain': 'Uocm:PHX-AD-1', 'fault_domains': [], 'primary_subnet_id': 'ocid1.primarysubnet.oc1..xxxxxxEXAMPLExxxxxx', 'secondary_vnic_subnets': [{'display_name': 'display_name_example', 'subnet_id': 'ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx'}]}], 'size': 56, 'time_created': '2013-10-20T19:20:30+01:00'}
 
compartment_id
string
on success
The OCID of the compartment containing the instance pool.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
 
defined_tags
dictionary
on success
Defined tags for this resource. Each key is predefined and scoped to a namespace. For more information, see Resource Tags.
Example: `{"Operations": {"CostCenter": "42"}}`

Sample:
{'Operations': {'CostCenter': 'US'}}
 
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
 
freeform_tags
dictionary
on success
Free-form tags for this resource. Each tag is a simple key-value pair with no predefined name, type, or namespace. For more information, see Resource Tags.
Example: `{"Department": "Finance"}`

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

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
 
instance_configuration_id
string
on success
The OCID of the instance configuration associated with the instance pool.

Sample:
ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx
 
lifecycle_state
string
on success
The current state of the instance pool.

Sample:
PROVISIONING
 
load_balancers
complex
on success
The load balancers attached to the instance pool.

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

Sample:
backend_set_name_example
   
id
string
on success
The OCID of the load balancer attachment.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
   
instance_pool_id
string
on success
The OCID of the instance pool of the load balancer attachment.

Sample:
ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx
   
lifecycle_state
string
on success
The status of the interaction between the instance pool and the load balancer.

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

Sample:
ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx
   
port
integer
on success
The port value used for the backends.

Sample:
56
   
vnic_selection
string
on success
Indicates which VNIC on each instance in the instance pool should be used to associate with the load balancer. Possible values are "PrimaryVnic" or the displayName of one of the secondary VNICs on the instance configuration that is associated with the instance pool.

Sample:
vnic_selection_example
 
placement_configurations
complex
on success
The placement configurations for the instance pool.

   
availability_domain
string
on success
The availability domain to place instances.
Example: `Uocm:PHX-AD-1`

Sample:
Uocm:PHX-AD-1
   
fault_domains
list / elements=string
on success
The fault domains to place instances.
If you don't provide any values, the system makes a best effort to distribute instances across all fault domains based on capacity.
To distribute the instances evenly across selected fault domains, provide a set of fault domains. For example, you might want instances to be evenly distributed if your applications require high availability.
To get a list of fault domains, use the ListFaultDomains operation in the Identity and Access Management Service API.
Example: `[FAULT-DOMAIN-1, FAULT-DOMAIN-2, FAULT-DOMAIN-3]`

   
primary_subnet_id
string
on success
The OCID of the primary subnet to place instances.

Sample:
ocid1.primarysubnet.oc1..xxxxxxEXAMPLExxxxxx
   
secondary_vnic_subnets
complex
on success
The set of secondary VNIC data for instances in the pool.

     
display_name
string
on success
The display name of the VNIC. This is also use to match against the instance configuration defined secondary VNIC.

Sample:
display_name_example
     
subnet_id
string
on success
The subnet OCID for the secondary VNIC.

Sample:
ocid1.subnet.oc1..xxxxxxEXAMPLExxxxxx
 
size
integer
on success
The number of instances that should be in the instance pool.

Sample:
56
 
time_created
string
on success
The date and time the instance pool 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)