oracle.oci.oci_autoscaling_auto_scaling_configuration_policy – Manage an AutoScalingConfigurationPolicy resource in Oracle Cloud Infrastructure¶
Note
This plugin is part of the oracle.oci collection (version 5.0.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_autoscaling_auto_scaling_configuration_policy
.
New in version 2.9.0: of oracle.oci
Synopsis¶
This module allows the user to update an AutoScalingConfigurationPolicy resource in Oracle Cloud Infrastructure
Requirements¶
The below requirements are needed on the host that executes this module.
python >= 3.6
Python SDK for Oracle Cloud Infrastructure https://oracle-cloud-infrastructure-python-sdk.readthedocs.io
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
|
|
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
|
|
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
string
/ required
|
The OCID of the autoscaling configuration.
|
||||
auto_scaling_policy_id
string
|
The ID of the autoscaling policy.
Required for update using state=present when environment variable
OCI_USE_NAME_AS_IDENTIFIER is not set.aliases: id |
||||
capacity
dictionary
|
The capacity requirements of the autoscaling policy.
This parameter is updatable.
|
||||
initial
integer
|
For a threshold-based autoscaling policy, this value is 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.
For a schedule-based autoscaling policy, this value is the target pool size to scale to when executing the schedule that's defined in the autoscaling policy.
This parameter is updatable.
Applicable when policy_type is 'threshold'
|
||||
max
integer
|
For a threshold-based autoscaling policy, this value is the maximum number of instances the instance pool is allowed to increase to (scale out).
For a schedule-based autoscaling policy, this value is not used.
This parameter is updatable.
Applicable when policy_type is 'threshold'
|
||||
min
integer
|
For a threshold-based autoscaling policy, this value is the minimum number of instances the instance pool is allowed to decrease to (scale in).
For a schedule-based autoscaling policy, this value is not used.
This parameter is updatable.
Applicable when policy_type is 'threshold'
|
||||
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.
|
||||
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 . |
||||
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
Required for update 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 |
||||
execution_schedule
dictionary
|
The schedule for executing the autoscaling policy.
This parameter is updatable.
Applicable when policy_type is 'scheduled'
|
||||
expression
string
/ required
|
A cron expression that represents the time at which to execute the autoscaling policy.
Cron expressions have this format: `<second> <minute> <hour> <day of month> <month> <day of week> <year>`
You can use special characters that are supported with the Quartz cron implementation.
You must specify `0` as the value for seconds.
Example: `0 15 10 ? * *`
This parameter is updatable.
|
||||
timezone
string
/ required
|
|
The time zone for the execution schedule.
This parameter is updatable.
|
|||
type
string
/ required
|
|
The type of execution schedule.
This parameter is updatable.
|
|||
is_enabled
boolean
|
|
Whether the autoscaling policy is enabled.
This parameter is updatable.
|
|||
policy_type
string
/ required
|
|
Indicates the type of autoscaling policy.
|
|||
realm_specific_endpoint_template_enabled
boolean
|
|
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. |
||||
resource_action
dictionary
|
This parameter is updatable.
Applicable when policy_type is 'scheduled'
|
||||
action
string
/ required
|
|
This parameter is updatable.
|
|||
action_type
string
/ required
|
|
The type of resource action.
This parameter is updatable.
|
|||
rules
list
/ elements=dictionary
|
This parameter is updatable.
Applicable when policy_type is 'threshold'
|
||||
action
dictionary
/ required
|
Required when policy_type is 'threshold'
|
||||
type
string
/ required
|
|
The type of action to take.
This parameter is updatable.
Required when policy_type is 'threshold'
|
|||
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.
This parameter is updatable.
Required when policy_type is 'threshold'
|
||||
display_name
string
|
A user-friendly name. Does not have to be unique, and it's changeable. Avoid entering confidential information.
This parameter is updatable.
Applicable when policy_type is 'threshold'
aliases: name |
||||
metric
dictionary
/ required
|
Required when policy_type is 'threshold'
|
||||
metric_type
string
/ required
|
|
This parameter is updatable.
Required when policy_type is 'threshold'
|
|||
threshold
dictionary
/ required
|
Required when policy_type is 'threshold'
|
||||
operator
string
/ required
|
|
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`).
This parameter is updatable.
Required when policy_type is 'threshold'
|
|||
value
integer
/ required
|
This parameter is updatable.
Required when policy_type is 'threshold'
|
||||
state
string
|
|
The state of the AutoScalingConfigurationPolicy.
Use state=present to update an existing an AutoScalingConfigurationPolicy.
|
|||
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 |
Notes¶
Note
For OCI python sdk configuration, please refer to https://oracle-cloud-infrastructure-python-sdk.readthedocs.io/en/latest/configuration.html
Examples¶
- name: Update auto_scaling_configuration_policy with policy_type = threshold
oci_autoscaling_auto_scaling_configuration_policy:
# required
policy_type: threshold
# optional
rules:
- # required
action:
# required
type: CHANGE_COUNT_BY
value: 56
metric:
# required
metric_type: CPU_UTILIZATION
threshold:
# required
operator: GT
value: 56
# optional
display_name: display_name_example
display_name: display_name_example
capacity:
# optional
max: 56
min: 56
initial: 56
is_enabled: true
- name: Update auto_scaling_configuration_policy with policy_type = scheduled
oci_autoscaling_auto_scaling_configuration_policy:
# required
policy_type: scheduled
# optional
display_name: display_name_example
capacity:
# optional
max: 56
min: 56
initial: 56
is_enabled: true
execution_schedule:
# required
type: cron
timezone: UTC
expression: expression_example
resource_action:
# required
action_type: power
action: STOP
- name: Update auto_scaling_configuration_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with policy_type = threshold
oci_autoscaling_auto_scaling_configuration_policy:
# required
policy_type: threshold
# optional
rules:
- # required
action:
# required
type: CHANGE_COUNT_BY
value: 56
metric:
# required
metric_type: CPU_UTILIZATION
threshold:
# required
operator: GT
value: 56
# optional
display_name: display_name_example
display_name: display_name_example
capacity:
# optional
max: 56
min: 56
initial: 56
is_enabled: true
- name: Update auto_scaling_configuration_policy using name (when environment variable OCI_USE_NAME_AS_IDENTIFIER is set) with policy_type = scheduled
oci_autoscaling_auto_scaling_configuration_policy:
# required
policy_type: scheduled
# optional
display_name: display_name_example
capacity:
# optional
max: 56
min: 56
initial: 56
is_enabled: true
execution_schedule:
# required
type: cron
timezone: UTC
expression: expression_example
resource_action:
# required
action_type: power
action: STOP
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Oracle (@oracle)