Skip to content

Latest commit

 

History

History
668 lines (648 loc) · 29.6 KB

avi_serverautoscalepolicy.rst

File metadata and controls

668 lines (648 loc) · 29.6 KB

vmware.alb.avi_serverautoscalepolicy

Module for setup of ServerAutoScalePolicy Avi RESTful Object

Synopsis

Parameters

Parameter Choices/Defaults Comments
state
str
  • absent
  • present ←
- The state that should be applied on the entity.
avi_api_update_method
str
  • put ←
  • patch
- Default method for object update is HTTP PUT.
- Setting to patch will override that behavior to use HTTP PATCH.
avi_api_patch_op
str
  • add ←
  • replace
  • delete
  • remove
- Patch operation to use when using avi_api_update_method as patch.
avi_patch_path
str
- Patch path to use when using avi_api_update_method as patch.
avi_patch_value
str
- Patch value to use when using avi_api_update_method as patch.
configpb_attributes
dict
- Protobuf versioning for config pbs.
- Field introduced in 21.1.1.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
delay_for_server_garbage_collection
int
- Delay in minutes after which a down server will be removed from pool.
- Value 0 disables this functionality.
- Field introduced in 20.1.3.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
description
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
intelligent_autoscale
bool
- Use avi intelligent autoscale algorithm where autoscale is performed by comparing load on the pool against estimated capacity of all the servers.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
intelligent_scalein_margin
int
- Maximum extra capacity as percentage of load used by the intelligent scheme.
- Scale-in is triggered when available capacity is more than this margin.
- Allowed values are 1-99.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 40.
intelligent_scaleout_margin
int
- Minimum extra capacity as percentage of load used by the intelligent scheme.
- Scale-out is triggered when available capacity is less than this margin.
- Allowed values are 1-99.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 20.
markers
list
- List of labels to be used for granular rbac.
- Field introduced in 20.1.5.
- Allowed in enterprise edition with any value, essentials edition with any value, basic edition with any value, enterprise with cloud services
- edition.
max_scalein_adjustment_step
int
- Maximum number of servers to scale-in simultaneously.
- The actual number of servers to scale-in is chosen such that target number of servers is always more than or equal to the min_size.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
max_scaleout_adjustment_step
int
- Maximum number of servers to scale-out simultaneously.
- The actual number of servers to scale-out is chosen such that target number of servers is always less than or equal to the max_size.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 1.
max_size
int
- Maximum number of servers after scale-out.
- Allowed values are 0-400.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
min_size
int
- No scale-in happens once number of operationally up servers reach min_servers.
- Allowed values are 0-400.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
name
str
required: true
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
scalein_alertconfig_refs
list
- Trigger scale-in when alerts due to any of these alert configurations are raised.
- It is a reference to an object of type alertconfig.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
scalein_cooldown
int
- Cooldown period during which no new scale-in is triggered to allow previous scale-in to successfully complete.
- Unit is sec.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
scaleout_alertconfig_refs
list
- Trigger scale-out when alerts due to any of these alert configurations are raised.
- It is a reference to an object of type alertconfig.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
scaleout_cooldown
int
- Cooldown period during which no new scale-out is triggered to allow previous scale-out to successfully complete.
- Unit is sec.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 300.
scheduled_scalings
list
- Scheduled-based scale-in/out policy.
- During scheduled intervals, metrics based autoscale is not enabled and number of servers will be solely derived from schedulescale policy.
- Field introduced in 21.1.1.
- Maximum of 1 items allowed.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
tenant_ref
str
- It is a reference to an object of type tenant.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
url
str
- Avi controller URL of the object.
use_predicted_load
bool
- Use predicted load rather than current load.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as False.
uuid
str
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.

Examples

- hosts: localhost
  connection: local
  collections:
    - vmware.alb
  vars:
    avi_credentials:
      username: "avi_user"
      password: "avi_password"
      controller: "192.168.138.18"
      api_version: "21.1.1"
  tasks:
    - name: Example to create ServerAutoScalePolicy object
      avi_serverautoscalepolicy:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_serverautoscalepolicy

Authors