oci_autoscaling_auto_scaling_configuration – Manage an AutoScalingConfiguration resource in Oracle Cloud Infrastructure

New in version 2.5.

Synopsis

  • This module allows the user to create, update and delete an AutoScalingConfiguration resource in Oracle Cloud Infrastructure
  • For state=present, creates an autoscaling configuration.

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.
auto_scaling_configuration_id
-
The OCID of the autoscaling configuration.
Required for update using state=present, state=absent.

aliases: id
compartment_id
-
The OCID of the compartment containing the autoscaling configuration.
Required for create using state=present.
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.
cool_down_in_seconds
integer
The minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default.
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"}}`
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

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"}`
is_enabled
boolean
    Choices:
  • no
  • yes
Whether the autoscaling configuration is enabled.
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.
policies
list
Required for create using state=present.
capacity
dictionary / required
The capacity requirements of the autoscaling policy.
initial
integer / required
The initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.
max
integer / required
The maximum number of instances the instance pool is allowed to increase to (scale out).
min
integer / required
The minimum number of instances the instance pool is allowed to decrease to (scale in).
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
policy_type
- / required
    Choices:
  • threshold
The type of autoscaling policy.
rules
list / required
action
dictionary / required
type
- / required
    Choices:
  • CHANGE_COUNT_BY
The type of action to take.
value
integer / required
To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value.
display_name
-
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.

aliases: name
metric
dictionary / required
metric_type
- / required
    Choices:
  • CPU_UTILIZATION
  • MEMORY_UTILIZATION
threshold
dictionary / required
operator
- / required
    Choices:
  • GT
  • GTE
  • LT
  • LTE
The comparison operator to use. Options are greater than (`GT`), greater than or equal to (`GTE`), less than (`LT`), and less than or equal to (`LTE`).
value
integer / required
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.
resource
dictionary
Required for create using state=present.
id
- / required
The OCID of the resource that is managed by the autoscaling configuration.
type
- / required
    Choices:
  • instancePool
The type of resource.
state
-
    Choices:
  • present ←
  • absent
The state of the AutoScalingConfiguration.
Use state=present to create or update an AutoScalingConfiguration.
Use state=absent to delete an AutoScalingConfiguration.
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: Create auto_scaling_configuration
  oci_autoscaling_auto_scaling_configuration:
    compartment_id: ocid1.compartment.oc1..<var>&lt;unique_ID&gt;</var>
    display_name: example_autoscaling_configuration
    cool_down_in_seconds: 300
    is_enabled: true
    policies:
    - capacity:
        max: 50
        min: 10
        initial: 15
      display_name: example_autoscaling_policy
      policy_type: threshold
      rules:
      - action:
          type: CHANGE_COUNT_BY
          value: 5
        display_name: example_scale_out_condition
        metric:
          metric_type: CPU_UTILIZATION
          threshold:
            operator: GTE
            value: 90
      - action:
          type: CHANGE_COUNT_BY
          value: -5
        display_name: example_scale_in_condition
        metric:
          metric_type: CPU_UTILIZATION
          threshold:
            operator: LTE
            value: 25
    resource:
      type: instancePool
      id: ocid1.instancepool.oc1..<var>&lt;unique_ID&gt;</var>

- name: Update auto_scaling_configuration
  oci_autoscaling_auto_scaling_configuration:
    display_name: example_autoscaling_configuration
    is_enabled: false
    cool_down_in_seconds: 600
    auto_scaling_configuration_id: ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx

- name: Delete auto_scaling_configuration
  oci_autoscaling_auto_scaling_configuration:
    auto_scaling_configuration_id: ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx
    state: absent

Return Values

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

Key Returned Description
auto_scaling_configuration
complex
on success
Details of the AutoScalingConfiguration resource acted upon by the current operation

Sample:
{'is_enabled': True, 'display_name': 'display_name_example', 'cool_down_in_seconds': 56, 'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'freeform_tags': {'Department': 'Finance'}, 'time_created': '2016-08-25T21:10:29.600Z', 'policies': [{'display_name': 'display_name_example', 'policy_type': 'policy_type_example', 'rules': [{'action': {'type': 'CHANGE_COUNT_BY', 'value': 56}, 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'operator': 'GT', 'value': 56}}, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}], 'capacity': {'max': 56, 'initial': 56, 'min': 56}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'time_created': '2016-08-25T21:10:29.600Z'}], 'resource': {'type': 'instancePool', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx'}
  compartment_id
string
on success
The OCID of the compartment containing the autoscaling configuration.

Sample:
ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx
  cool_down_in_seconds
integer
on success
The minimum period of time to wait between scaling actions. The cooldown period gives the system time to stabilize before rescaling. The minimum value is 300 seconds, which is also the default.

Sample:
56
  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 autoscaling configuration.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
  is_enabled
boolean
on success
Whether the autoscaling configuration is enabled.

Sample:
True
  policies
complex
on success
Autoscaling policy definitions for the autoscaling configuration. An autoscaling policy defines the criteria that trigger autoscaling actions and the actions to take.
Each autoscaling configuration can have one autoscaling policy.

    capacity
complex
on success
The capacity requirements of the autoscaling policy.

      initial
integer
on success
The initial number of instances to launch in the instance pool immediately after autoscaling is enabled. After autoscaling retrieves performance metrics, the number of instances is automatically adjusted from this initial number to a number that is based on the limits that you set.

Sample:
56
      max
integer
on success
The maximum number of instances the instance pool is allowed to increase to (scale out).

Sample:
56
      min
integer
on success
The minimum number of instances the instance pool is allowed to decrease to (scale in).

Sample:
56
    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
    id
string
on success
The ID of the autoscaling policy that is assigned after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    policy_type
string
on success
The type of autoscaling policy.

Sample:
policy_type_example
    rules
complex
on success

      action
complex
on success

        type
string
on success
The type of action to take.

Sample:
CHANGE_COUNT_BY
        value
integer
on success
To scale out (increase the number of instances), provide a positive value. To scale in (decrease the number of instances), provide a negative value.

Sample:
56
      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
      id
string
on success
ID of the condition that is assigned after creation.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
      metric
complex
on success

        metric_type
string
on success

Sample:
CPU_UTILIZATION
        threshold
complex
on success

          operator
string
on success
The comparison operator to use. Options are greater than (`GT`), greater than or equal to (`GTE`), less than (`LT`), and less than or equal to (`LTE`).

Sample:
GT
          value
integer
on success

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

Sample:
2016-08-25 21:10:29.600000
  resource
complex
on success

    id
string
on success
The OCID of the resource that is managed by the autoscaling configuration.

Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
    type
string
on success
The type of resource.

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

Sample:
2016-08-25 21:10:29.600000


Status

  • This module is not guaranteed to have a backwards compatible interface. [preview]
  • This module is maintained by the Ansible Community. [community]

Authors

  • Manoj Meda (@manojmeda)
  • Mike Ross (@mross22)
  • Nabeel Al-Saber (@nalsaber)

Hint

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