oci_autoscaling_auto_scaling_configuration_policy_facts – Fetches details about one or multiple AutoScalingConfigurationPolicy resources in Oracle Cloud Infrastructure¶

New in version 2.5.

Synopsis
Requirements
Parameters
Notes
Examples
Return Values
Status

Synopsis ¶

Fetches details about one or multiple AutoScalingConfigurationPolicy resources in Oracle Cloud Infrastructure
Lists the autoscaling policies in the specified autoscaling configuration.
If auto_scaling_policy_id is specified, the details of a single AutoScalingConfigurationPolicy will be returned.

Requirements ¶

The below requirements are needed on the host that executes this module.

python >= 2.7
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_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 - / required		The OCID of the autoscaling configuration.
auto_scaling_policy_id -		The ID of the autoscaling policy. Required to get a specific auto_scaling_configuration_policy. aliases: id
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 -		A filter to return only resources that match the given display name exactly. aliases: name
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 -	Choices: TIMECREATED DISPLAYNAME	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 -	Choices: ASC DESC	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: List auto_scaling_configuration_policies
  oci_autoscaling_auto_scaling_configuration_policy_facts:
    auto_scaling_configuration_id: ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx

- name: Get a specific auto_scaling_configuration_policy
  oci_autoscaling_auto_scaling_configuration_policy_facts:
    auto_scaling_configuration_id: ocid1.autoscalingconfiguration.oc1..xxxxxxEXAMPLExxxxxx
    auto_scaling_policy_id: ocid1.autoscalingpolicy.oc1..xxxxxxEXAMPLExxxxxx

Return Values ¶

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

Key					Returned	Description
auto_scaling_configuration_policies complex					on success	List of AutoScalingConfigurationPolicy resources Sample: [{'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'}]
	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

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.

oci_autoscaling_auto_scaling_configuration_policy_facts – Fetches details about one or multiple AutoScalingConfigurationPolicy resources in Oracle Cloud Infrastructure¶

Synopsis¶

Requirements¶

Parameters¶

Notes¶

Examples¶

Return Values¶

Status¶