Note
This plugin is part of the community.network collection (version 3.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 community.network.
To use it in a playbook, specify: community.network.avi_serverautoscalepolicy.
The below requirements are needed on the host that executes this module.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| api_context dictionary | Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. | ||
| api_version string | Default: "16.4.4" | Avi API version of to use for Avi API and objects. | |
| avi_api_patch_op string |
| Patch operation to use when using avi_api_update_method as patch. | |
| avi_api_update_method string |
| Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. | |
| avi_credentials dictionary | Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | ||
| api_version string | Default: "16.4.4" | Avi controller version | |
| controller string | Avi controller IP or SQDN | ||
| csrftoken string | Avi controller API csrftoken to reuse existing session with session id | ||
| password string | Avi controller password | ||
| port string | Avi controller port | ||
| session_id string | Avi controller API session id to reuse existing session with csrftoken | ||
| tenant string | Default: "admin" | Avi controller tenant | |
| tenant_uuid string | Avi controller tenant UUID | ||
| timeout string | Default: 300 | Avi controller request timeout | |
| token string | Avi controller API token | ||
| username string | Avi controller username | ||
| avi_disable_session_cache_as_fact boolean |
| It disables avi session information to be cached as a fact. | |
| controller string | Default: "" | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER. | |
| description string | User defined description for the object. | ||
| intelligent_autoscale boolean |
| Use avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers. Default value when not specified in API or module is interpreted by Avi Controller as False. | |
| intelligent_scalein_margin string | Maximum extra capacity as percentage of load used by the intelligent scheme. Scalein is triggered when available capacity is more than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by Avi Controller as 40. | ||
| intelligent_scaleout_margin string | Minimum extra capacity as percentage of load used by the intelligent scheme. Scaleout is triggered when available capacity is less than this margin. Allowed values are 1-99. Default value when not specified in API or module is interpreted by Avi Controller as 20. | ||
| max_scalein_adjustment_step string | Maximum number of servers to scalein simultaneously. The actual number of servers to scalein is chosen such that target number of servers is always more than or equal to the min_size. Default value when not specified in API or module is interpreted by Avi Controller as 1. | ||
| max_scaleout_adjustment_step string | Maximum number of servers to scaleout simultaneously. The actual number of servers to scaleout is chosen such that target number of servers is always less than or equal to the max_size. Default value when not specified in API or module is interpreted by Avi Controller as 1. | ||
| max_size string | Maximum number of servers after scaleout. Allowed values are 0-400. | ||
| min_size string | No scale-in happens once number of operationally up servers reach min_servers. Allowed values are 0-400. | ||
| name string / required | Name of the object. | ||
| password string | Default: "" | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD. | |
| scalein_alertconfig_refs string | Trigger scalein when alerts due to any of these alert configurations are raised. It is a reference to an object of type alertconfig. | ||
| scalein_cooldown string | Cooldown period during which no new scalein is triggered to allow previous scalein to successfully complete. Default value when not specified in API or module is interpreted by Avi Controller as 300. | ||
| scaleout_alertconfig_refs string | Trigger scaleout when alerts due to any of these alert configurations are raised. It is a reference to an object of type alertconfig. | ||
| scaleout_cooldown string | Cooldown period during which no new scaleout is triggered to allow previous scaleout to successfully complete. Default value when not specified in API or module is interpreted by Avi Controller as 300. | ||
| state string |
| The state that should be applied on the entity. | |
| tenant string | Default: "admin" | Name of tenant used for all Avi API calls and context of object. | |
| tenant_ref string | It is a reference to an object of type tenant. | ||
| tenant_uuid string | Default: "" | UUID of tenant used for all Avi API calls and context of object. | |
| url string | Avi controller URL of the object. | ||
| use_predicted_load boolean |
| Use predicted load rather than current load. Default value when not specified in API or module is interpreted by Avi Controller as False. | |
| username string | Default: "" | Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME. | |
| uuid string | Unique object identifier of the object. | ||
Note
- name: Example to create ServerAutoScalePolicy object
community.network.avi_serverautoscalepolicy:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_serverautoscalepolicy
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| obj dictionary | success, changed | ServerAutoScalePolicy (api/serverautoscalepolicy) object |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/avi_serverautoscalepolicy_module.html