oracle / oracle.oci / 4.43.0 / module / oci_compute_management_instance_pool_instance Manage an InstancePoolInstance resource in Oracle Cloud Infrastructure | "added in version" 2.9.0 of oracle.oci" Authors: Oracle (@oracle) preview | supported by communityoracle.oci.oci_compute_management_instance_pool_instance (4.43.0) — module
Install with ansible-galaxy collection install oracle.oci:==4.43.0
collections: - name: oracle.oci version: 4.43.0
This module allows the user to create an InstancePoolInstance resource in Oracle Cloud Infrastructure
For I(state=present), attaches an instance to an instance pool. For information about the prerequisites that an instance must meet before you can attach it to a pool, see L(Attaching an Instance to an Instance Pool,https://docs.cloud.oracle.com/iaas/Content/Compute/Tasks/updatinginstancepool.htm#attach-instance).
This resource has the following action operations in the M(oracle.oci.oci_compute_management_instance_pool_instance_actions) module: detach.
- 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"
wait: default: true description: Whether to wait for create or delete operation to complete. type: bool state: choices: - present default: present description: - The state of the InstancePoolInstance. - Use I(state=present) to create an InstancePoolInstance. required: false type: str key_by: description: 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. elements: str type: list region: description: - 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 C(config_file_location)). Please refer to U(https://docs.us-phoenix-1.oraclecloud.com/Content/General/Concepts/regions.htm) for more information on OCI regions. type: str tenancy: description: - 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 C(config_file_location)). To get the tenancy OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm) type: str api_user: description: - 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 C(config_file_location)). To get the user's OCID, please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str auth_type: choices: - api_key - instance_principal - instance_obo_user - resource_principal - security_token default: api_key description: - The type of authentication to use for making API requests. By default C(auth_type="api_key") based authentication is performed and the API key (see I(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 C(auth_type="instance_principal") to use instance principal based authentication when running ansible playbooks within an OCI compute instance. type: str cert_bundle: description: - 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. type: str instance_id: aliases: - id description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. required: true type: str auth_purpose: choices: - service_principal description: - The auth purpose which can be used in conjunction with 'auth_type=instance_principal'. The default auth_purpose for instance_principal is None. type: str force_create: default: false description: 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 I(key_by). type: bool wait_timeout: description: Time, in seconds, to wait when I(wait=yes). Defaults to 1200 for most of the services but some services might have a longer wait timeout. type: int compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment. required: true type: str instance_pool_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. required: true type: str api_user_key_file: description: - 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 C(config_file_location)). If the key is encrypted with a pass-phrase, the C(api_user_key_pass_phrase) option must also be provided. type: str config_profile_name: description: - The profile to load from the config file referenced by C(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 C(config_file_location). type: str api_user_fingerprint: description: - 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 C(config_file_location)). To get the key pair's fingerprint value please refer U(https://docs.us-phoenix-1.oraclecloud.com/Content/API/Concepts/apisigningkey.htm). type: str config_file_location: description: - 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. type: str api_user_key_pass_phrase: description: - Passphrase used by the key referenced in C(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 C(config_file_location)). type: str realm_specific_endpoint_template_enabled: description: - 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. type: bool
instance_pool_instance: contains: availability_domain: description: - The availability domain the instance is running in. returned: on success sample: Uocm:PHX-AD-1 type: str compartment_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the compartment that contains the instance. returned: on success sample: ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx type: str display_name: description: - A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information. returned: on success sample: display_name_example type: str fault_domain: description: - The fault domain the instance is running in. returned: on success sample: FAULT-DOMAIN-1 type: str id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance. returned: on success sample: ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx type: str instance_configuration_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance configuration used to create the instance. returned: on success sample: ocid1.instanceconfiguration.oc1..xxxxxxEXAMPLExxxxxx type: str instance_pool_id: description: - The L(OCID,https://docs.cloud.oracle.com/iaas/Content/General/Concepts/identifiers.htm) of the instance pool. returned: on success sample: ocid1.instancepool.oc1..xxxxxxEXAMPLExxxxxx type: str lifecycle_state: description: - The attachment state of the instance in relation to the instance pool. returned: on success sample: ATTACHING type: str load_balancer_backends: contains: backend_health_status: description: - The health of the backend as observed by the load balancer. returned: on success sample: OK type: str backend_name: description: - The name of the backend in the backend set. returned: on success sample: backend_name_example type: str backend_set_name: description: - The name of the backend set on the load balancer. returned: on success sample: backend_set_name_example type: str load_balancer_id: description: - The OCID of the load balancer attached to the instance pool. returned: on success sample: ocid1.loadbalancer.oc1..xxxxxxEXAMPLExxxxxx type: str description: - The load balancer backends that are configured for the instance. returned: on success type: complex region: description: - The region that contains the availability domain the instance is running in. returned: on success sample: us-phoenix-1 type: str shape: description: - The shape of the instance. The shape determines the number of CPUs, amount of memory, and other resources allocated to the instance. returned: on success sample: shape_example type: str state: description: - The lifecycle state of the instance. Refer to `lifecycleState` in the L(Instance,https://docs.cloud.oracle.com/en- us/iaas/api/#/en/iaas/latest/Instance) resource. returned: on success sample: state_example type: str time_created: description: - 'The date and time the instance pool instance was created, in the format defined by L(RFC3339,https://tools.ietf.org/html/rfc3339). Example: `2016-08-25T21:10:29.600Z`' returned: on success sample: '2013-10-20T19:20:30+01:00' type: str description: - Details of the InstancePoolInstance resource acted upon by the current operation returned: on success 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' type: complex