oracle.oci.oci_autoscaling_auto_scaling_configuration_facts – Fetches details about one or multiple AutoScalingConfiguration resources 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_facts
.
New in version 2.9.0: of oracle.oci
Synopsis¶
Fetches details about one or multiple AutoScalingConfiguration resources in Oracle Cloud Infrastructure
Lists autoscaling configurations in the specifed compartment.
If auto_scaling_configuration_id is specified, the details of a single AutoScalingConfiguration will be returned.
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
|
The OCID of the autoscaling configuration.
Required to get a specific auto_scaling_configuration.
aliases: id |
|
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 resource. Use tenancyId to search in the root compartment.
Required to list multiple auto_scaling_configurations.
|
|
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 filter to return only resources that match the given display name exactly.
aliases: name |
|
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. |
|
sort_by
string
|
|
The field to sort by. You can provide one sort order (`sortOrder`). Default order for TIMECREATED is descending. Default order for DISPLAYNAME is ascending. The DISPLAYNAME sort order is case sensitive.
|
sort_order
string
|
|
The sort order to use, either ascending (`ASC`) or descending (`DESC`). The DISPLAYNAME sort order is case sensitive.
|
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: Get a specific auto_scaling_configuration
oci_autoscaling_auto_scaling_configuration_facts:
# required
auto_scaling_configuration_id: "ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx"
- name: List auto_scaling_configurations
oci_autoscaling_auto_scaling_configuration_facts:
# required
compartment_id: "ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx"
# optional
display_name: display_name_example
sort_by: TIMECREATED
sort_order: ASC
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description | |||||
---|---|---|---|---|---|---|---|
auto_scaling_configurations
complex
|
on success |
List of AutoScalingConfiguration resources
Sample:
[{'compartment_id': 'ocid1.compartment.oc1..xxxxxxEXAMPLExxxxxx', 'cool_down_in_seconds': 56, 'defined_tags': {'Operations': {'CostCenter': 'US'}}, 'display_name': 'display_name_example', 'freeform_tags': {'Department': 'Finance'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'max_resource_count': 56, 'min_resource_count': 56, 'policies': [{'capacity': {'initial': 56, 'max': 56, 'min': 56}, 'display_name': 'display_name_example', 'execution_schedule': {'expression': 'expression_example', 'timezone': 'UTC', 'type': 'cron'}, 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'is_enabled': True, 'policy_type': 'scheduled', 'resource_action': {'action': 'STOP', 'action_type': 'power'}, 'rules': [{'action': {'type': 'CHANGE_COUNT_BY', 'value': 56}, 'display_name': 'display_name_example', 'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'metric': {'metric_type': 'CPU_UTILIZATION', 'threshold': {'operator': 'GT', 'value': 56}}}], 'time_created': '2013-10-20T19:20:30+01:00'}], 'resource': {'id': 'ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx', 'type': 'instancePool'}, 'time_created': '2013-10-20T19:20:30+01:00'}]
|
|||||
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 |
For threshold-based autoscaling policies, this value is 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. The cooldown period starts when the instance pool reaches the running state.
For schedule-based autoscaling policies, this value is not used.
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
|
|||||
max_resource_count
integer
|
on success |
The maximum number of resources to scale out to.
Returned for get operation
Sample:
56
|
|||||
min_resource_count
integer
|
on success |
The minimum number of resources to scale in to.
Returned for get operation
Sample:
56
|
|||||
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.
Returned for get operation
|
|||||
capacity
complex
|
on success |
The capacity requirements of the autoscaling policy.
|
|||||
initial
integer
|
on success |
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.
Sample:
56
|
|||||
max
integer
|
on success |
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.
Sample:
56
|
|||||
min
integer
|
on success |
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.
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
|
|||||
execution_schedule
complex
|
on success |
The schedule for executing the autoscaling policy.
|
|||||
expression
string
|
on success |
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 ? * *`
Sample:
expression_example
|
|||||
timezone
string
|
on success |
The time zone for the execution schedule.
Sample:
UTC
|
|||||
type
string
|
on success |
The type of execution schedule.
Sample:
cron
|
|||||
id
string
|
on success |
The ID of the autoscaling policy that is assigned after creation.
Sample:
ocid1.resource.oc1..xxxxxxEXAMPLExxxxxx
|
|||||
is_enabled
boolean
|
on success |
Whether the autoscaling policy is enabled.
Sample:
True
|
|||||
policy_type
string
|
on success |
The type of autoscaling policy.
Sample:
scheduled
|
|||||
resource_action
complex
|
on success |
|
|||||
action
string
|
on success |
Sample:
STOP
|
|||||
action_type
string
|
on success |
The type of resource action.
Sample:
power
|
|||||
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:
2013-10-20T19:20:30+01:00
|
|||||
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 autoscaling configuration 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)