New in version 2.3.
parameter | required | default | choices | comments |
---|---|---|---|---|
cloud_config_cksum |
no | Checksum of cloud configuration for poolgroup. Internally set by cloud connector. | ||
cloud_ref |
no | It is a reference to an object of type cloud. | ||
controller |
no | IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER . | ||
created_by |
no | Name of the user who created the object. | ||
deployment_policy_ref |
no | 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. | ||
description |
no | Description of pool group. | ||
fail_action |
no | 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. | ||
members |
no | List of pool group members object of type poolgroupmember. | ||
min_servers |
no | The minimum number of servers to distribute traffic to. Default value when not specified in API or module is interpreted by Avi Controller as 0. | ||
name |
yes | The name of the pool group. | ||
password |
no | Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD . | ||
priority_labels_ref |
no | 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. | ||
state |
no | 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. | ||
username |
no | Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME . | ||
uuid |
no | Uuid of the pool group. |
- name: Example to create PoolGroup object avi_poolgroup: controller: 10.10.25.42 username: admin password: something state: present name: sample_poolgroup
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
obj | PoolGroup (api/poolgroup) object | success, changed | dict |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is community maintained without core committer oversight.
For more information on what this means please read Module Support
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Helping Testing PRs and Developing Modules.