oci_instance_pool – Manage Instance Pools in OCI

New in version 2.5.

Synopsis

  • This module allows the user to create, update, terminate and perform other power actions (such as reset, soft-reset, start and stop) on an Instance Pool in OCI.

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 containing the instance pool. Required to create an instance pool.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
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 https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/resourcetags.htm.
instance_configuration_id
-
The OCID of the instance configuration associated to the instance pool. Required for creating an Instance pool
instance_pool_id
-
The OCID of the instance pool. Required for updating and terminating the instance pool

aliases: id
key_by
list
The list of comma-separated attributes of this resource which should be used to uniquely identify an instance of the resource. By default, all the attributes of a resource except freeform_tags are used to uniquely identify a resource.
name
-
The user-friendly name. Does not have to be unique.

aliases: display_name
placement_configurations
-
The placement configurations for the instance pool. There should be 1 placement configuration for each desired AD. Required to create an instance pool.
availability_domain
- / required
The availability domain to place instances.
primary_subnet_id
- / required
The OCID of the primary subnet to place instances.
secondary_vnics
-
A list of secondary VNIC configurations for instances in the pool.
display_name
-
The displayName of the vnic. This is also use to match against the Instance Configuration defined secondary vnic.
subnet_id
-
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
-
The number of instances that should be in the instance pool. Required to create an instance pool.
state
-
    Choices:
  • present ←
  • absent
  • running
  • reset
  • softreset
  • stopped
Create or update an instance pool with state=present. Use state=absent to delete an instance pool. When state=stopped, stop (power off) action is performed on the specified instance pool, which performs the action on all the instances in the pool. When state=softreset, the softreset (ACPI shutdown and power on) action is performed on the specified instance pool, which performs the action on all the instances in the pool. When state=reset, the reset (power off and power on) action is performed on the specified instance pool, which performs the action on all the instances in the pool. Note that state=softreset and state=reset states are not idempotent. Every time a play is executed with these state options, a shutdown and a power on sequence is executed against the instance pool.
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
Default:
1200
Time, in seconds, to wait when wait=yes.
wait_until
string
The lifecycle state to wait for the resource to transition into when wait=yes. By default, when wait=yes, we wait for the resource to get into ACTIVE/ATTACHED/AVAILABLE/PROVISIONED/ RUNNING applicable lifecycle state during create operation & to get into DELETED/DETACHED/ TERMINATED lifecycle state during delete operation.

Examples

- name: Create an instance pool
  oci_instance_pool:
    name: "backend-servers-pool"
    compartment_id: "ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...vm62xq"
    instance_configuration_id: ocid1.instanceconfiguration.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    size: 5
    placement_configurations:
        - availability_domain: "Uocm PHX-AD-1"
          primary_subnet_id: "ocid1.subnet.oci1.phx.xxxxxEXAMPLExxxxx...abcd"
        - availability_domain: "Uocm PHX-AD-2"
          primary_subnet_id: "ocid1.subnet.oci1.phx.xxxxxEXAMPLExxxxx...efgh"

- name: Stop an instance pool
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    state: stopped

- name: Start an instance pool
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    state: running

- name: Reset an instance pool
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    state: reset

- name: Soft-reset an instance pool
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    state: softreset

- name: Update an instance pool's display name
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    name: "old-backend-servers-pool"

- name: Delete an instance pool
  oci_instance_pool:
    id: ocid1.instancepool.oc1.phx.xxxxxEXAMPLExxxxx...rz3fhq
    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 successful create, delete operations on instance pools
Information about the Instance Pool

Sample:
{'time-created': '2018-11-09T16:58:35.270000+00:00', 'lifecycle_state': 'PROVISIONING', 'display_name': 'backend-servers-pool', 'compartment_id': 'ocid1.compartment.oc1..xxxxxEXAMPLExxxxx...glmkwq', 'defined_tags': {}, 'freeform_tags': {}, 'placement_configurations': [{'secondary-vnic-subnets': None, 'availability-domain': 'IwGV:US-ASHBURN-AD-1', 'primary-subnet-id': 'ocid1.subnet.oc1.iad.xxxxxEXAMPLExxxxx...dq4a'}], 'instance_configuration_id': 'ocid1.instanceconfiguration.oc1.iad.xxxxxEXAMPLExxxxx...iejka', '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.