Skip to content

Latest commit

 

History

History
613 lines (593 loc) · 26.3 KB

avi_poolgroup.rst

File metadata and controls

613 lines (593 loc) · 26.3 KB

vmware.alb.avi_poolgroup

Module for setup of PoolGroup 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.
cloud_config_cksum
str
- Checksum of cloud configuration for poolgroup.
- Internally set by cloud connector.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
cloud_ref
str
- It is a reference to an object of type cloud.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
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.
created_by
str
- Name of the user who created the object.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
deactivate_primary_pool_on_down
bool
- Deactivate primary pool for selection when down until it is activated by user via clear poolgroup command.
- Field introduced in 20.1.7, 21.1.2, 21.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 False.
deployment_policy_ref
str
- When setup autoscale manager will automatically promote new pools into production when deployment goals are met.
- It is a reference to an object of type poolgroupdeploymentpolicy.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
description
str
- Description of pool group.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
enable_http2
bool
- Enable http/2 for traffic from virtualservice to all the backend servers in all the pools configured under this poolgroup.
- Field deprecated in 30.2.1.
- Field introduced in 20.1.1.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
fail_action
dict
- Enable an action - close connection, http redirect, or local http response - when a pool group failure happens.
- By default, a connection will be closed, in case the pool group experiences a failure.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
implicit_priority_labels
bool
- Whether an implicit set of priority labels is generated.
- Field introduced in 17.1.9,17.2.3.
- 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.
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.
members
list
- List of pool group members object of type poolgroupmember.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
min_servers
int
- The minimum number of servers to distribute traffic to.
- Allowed values are 1-65535.
- Special values are 0 - disable.
- Allowed in enterprise edition with any value, essentials edition(allowed values- 0), basic edition(allowed values- 0), enterprise with cloud
- services edition.
- Default value when not specified in API or module is interpreted by Avi Controller as 0.
name
str
required: true
- The name of the pool group.
- Allowed in enterprise edition with any value, essentials, basic, enterprise with cloud services edition.
priority_labels_ref
str
- Uuid of the priority labels.
- If not provided, pool group member priority label will be interpreted as a number with a larger number considered higher priority.
- It is a reference to an object of type prioritylabels.
- Allowed in enterprise edition with any value, enterprise with cloud services edition.
service_metadata
str
- Metadata pertaining to the service provided by this poolgroup.
- In openshift/kubernetes environments, app metadata info is stored.
- Any user input to this field will be overwritten by avi vantage.
- Field introduced in 17.2.14,18.1.5,18.2.1.
- Allowed in enterprise edition with any value, essentials, basic, 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.
uuid
str
- Uuid of the pool group.
- 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 PoolGroup object
      avi_poolgroup:
        avi_credentials: "{{ avi_credentials }}"
        state: present
        name: sample_poolgroup

Authors