avi_poolgroup – Module for setup of PoolGroup Avi RESTful Object
avi_poolgroup – Module for setup of PoolGroup Avi RESTful Object
New in version 2.3.
Synopsis
- This module is used to configure PoolGroup object
- more examples at https://github.com/avinetworks/devops
Requirements
The below requirements are needed on the host that executes this module.
- avisdk
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
api_context - added in 2.5 |
Avi API context that includes current session ID and CSRF Token. This allows user to perform single login and re-use the session. | |
api_version - |
Default: "16.4.4" |
Avi API version of to use for Avi API and objects. |
avi_api_patch_op - added in 2.5 |
|
Patch operation to use when using avi_api_update_method as patch. |
avi_api_update_method - added in 2.5 |
|
Default method for object update is HTTP PUT. Setting to patch will override that behavior to use HTTP PATCH. |
avi_credentials - added in 2.5 |
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. | |
cloud_config_cksum - |
Checksum of cloud configuration for poolgroup. Internally set by cloud connector. | |
cloud_ref - |
It is a reference to an object of type cloud. | |
controller - |
Default: "" |
IP address or hostname of the controller. The default value is the environment variable |
created_by - |
Name of the user who created the object. | |
deployment_policy_ref - |
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 - |
Description of pool group. | |
fail_action - |
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. | |
implicit_priority_labels boolean added in 2.5 |
|
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. |
members - |
List of pool group members object of type poolgroupmember. | |
min_servers - |
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. | |
name - / required |
The name of the pool group. | |
password - |
Default: "" |
Password of Avi user in Avi controller. The default value is the environment variable |
priority_labels_ref - |
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 - |
|
The state that should be applied on the entity. |
tenant - |
Default: "admin" |
Name of tenant used for all Avi API calls and context of object. |
tenant_ref - |
It is a reference to an object of type tenant. | |
tenant_uuid - |
Default: "" |
UUID of tenant used for all Avi API calls and context of object. |
url - |
Avi controller URL of the object. | |
username - |
Default: "" |
Username used for accessing Avi controller. The default value is the environment variable |
uuid - |
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
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 | Returned | Description |
---|---|---|
obj dictionary |
success, changed |
PoolGroup (api/poolgroup) object
|
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Gaurav Rastogi ([email protected])
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/avi_poolgroup_module.html