avi_serverautoscalepolicy - Module for setup of ServerAutoScalePolicy Avi RESTful Object

New in version 2.4.

Synopsis

Requirements (on host that executes module)

  • avisdk

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
controller
 no
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
 no
User defined description for the object.
intelligent_autoscale
 no
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
 no
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
 no
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
 no
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
 no
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
 no
Maximum number of servers after scaleout.
Allowed values are 0-400.
min_size
 no
No scale-in happens once number of operationally up servers reach min_servers.
Allowed values are 0-400.
name
 yes
Name of the object.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
scalein_alertconfig_refs
 no
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
 no
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
 no
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
 no
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
 no present
  • absent
  • present
The state that should be applied on the entity.
tenant
 no admin
Name of tenant used for all Avi API calls and context of object.
tenant_ref
 no
It is a reference to an object of type tenant.
tenant_uuid
 no
UUID of tenant used for all Avi API calls and context of object.
url
 no
Avi controller URL of the object.
use_predicted_load
 no
Use predicted load rather than current load.
Default value when not specified in API or module is interpreted by Avi Controller as False.
username
 no
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
 no
Unique object identifier of the object.

Examples

- name: Example to create ServerAutoScalePolicy object
  avi_serverautoscalepolicy:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_serverautoscalepolicy

Return Values

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

name description returned type sample
obj
ServerAutoScalePolicy (api/serverautoscalepolicy) object
 success, changed dict

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/avi_serverautoscalepolicy_module.html