community.network.avi_poolgroup module – Module for setup of PoolGroup Avi RESTful Object
Note
This module is part of the community.network collection (version 5.1.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
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.network.avi_poolgroup
.
Note
The community.network collection has been deprecated and will be removed from Ansible 12. See the discussion thread for more information.
DEPRECATED
- Removed in:
version 6.0.0
- Why:
This collection and all content in it is unmaintained and deprecated.
- Alternative:
Unknown.
Synopsis
This module is used to configure PoolGroup object
more examples at https://github.com/avinetworks/devops
Aliases: network.avi.avi_poolgroup
Requirements
The below requirements are needed on the host that executes this module.
avisdk
Parameters
Parameter |
Comments |
---|---|
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. |
|
Avi API version of to use for Avi API and objects. Default: |
|
Patch operation to use when using avi_api_update_method as patch. Choices:
|
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. Choices:
|
|
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. |
|
Avi controller version Default: |
|
Avi controller IP or SQDN |
|
Avi controller API csrftoken to reuse existing session with session id Default: |
|
Avi controller password |
|
Avi controller port |
|
Avi controller API session id to reuse existing session with csrftoken Default: |
|
Avi controller tenant Default: |
|
Avi controller tenant UUID Default: |
|
Avi controller request timeout Default: |
|
Avi controller API token Default: |
|
Avi controller username |
|
It disables avi session information to be cached as a fact. Choices:
|
|
Checksum of cloud configuration for poolgroup. Internally set by cloud connector. |
|
It is a reference to an object of type cloud. |
|
IP address or hostname of the controller. The default value is the environment variable |
|
Name of the user who created the object. |
|
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 of pool group. |
|
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. |
|
Whether an implicit set of priority labels is generated. Field introduced in 17.1.9,17.2.3. Default value when not specified in API or module is interpreted by Avi Controller as False. Choices:
|
|
List of pool group members object of type poolgroupmember. |
|
The minimum number of servers to distribute traffic to. Allowed values are 1-65535. Special values are 0 - ‘disable’. Default value when not specified in API or module is interpreted by Avi Controller as 0. |
|
The name of the pool group. |
|
Password of Avi user in Avi controller. The default value is the environment variable |
|
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. |
|
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. |
|
The state that should be applied on the entity. Choices:
|
|
Name of tenant used for all Avi API calls and context of object. Default: |
|
It is a reference to an object of type tenant. |
|
UUID of tenant used for all Avi API calls and context of object. Default: |
|
Avi controller URL of the object. |
|
Username used for accessing Avi controller. The default value is the environment variable |
|
Uuid of the pool group. |
Notes
Note
For more information on using Ansible to manage Avi Network devices see https://www.ansible.com/ansible-avi-networks.
Examples
- name: Example to create PoolGroup object
community.network.avi_poolgroup:
controller: 10.10.25.42
username: admin
password: something
state: present
name: sample_poolgroup
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
PoolGroup (api/poolgroup) object Returned: success, changed |
Status
This module will be removed in version 6.0.0. [deprecated]
For more information see DEPRECATED.