community / community.network / 5.0.2 / module / avi_poolgroup Module for setup of PoolGroup Avi RESTful Object Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com>community.network.avi_poolgroup (5.0.2) — module
Install with ansible-galaxy collection install community.network:==5.0.2
collections: - name: community.network version: 5.0.2
This module is used to configure PoolGroup object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create PoolGroup object community.network.avi_poolgroup: controller: 10.10.25.42 username: admin password: something state: present name: sample_poolgroup
url: description: - Avi controller URL of the object. name: description: - The name of the pool group. required: true uuid: description: - Uuid of the pool group. state: choices: - absent - present default: present description: - The state that should be applied on the entity. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str members: description: - List of pool group members object of type poolgroupmember. password: description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str cloud_ref: description: - It is a reference to an object of type cloud. controller: description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str created_by: description: - Name of the user who created the object. tenant_ref: description: - It is a reference to an object of type tenant. api_context: description: - Avi API context that includes current session ID and CSRF Token. - This allows user to perform single login and re-use the session. type: dict api_version: default: 16.4.4 description: - Avi API version of to use for Avi API and objects. type: str description: description: - Description of pool group. fail_action: description: - 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. min_servers: description: - 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. tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str avi_credentials: description: - Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details. suboptions: api_version: default: 16.4.4 description: - Avi controller version controller: description: - Avi controller IP or SQDN csrftoken: default: '' description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: default: '' description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: default: '' description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: default: '' description: - Avi controller API token username: description: - Avi controller username type: dict avi_api_patch_op: choices: - add - replace - delete description: - Patch operation to use when using avi_api_update_method as patch. service_metadata: description: - 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. cloud_config_cksum: description: - Checksum of cloud configuration for poolgroup. - Internally set by cloud connector. priority_labels_ref: description: - 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. avi_api_update_method: choices: - put - patch default: put description: - Default method for object update is HTTP PUT. - Setting to patch will override that behavior to use HTTP PATCH. deployment_policy_ref: description: - 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. implicit_priority_labels: description: - 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. type: bool avi_disable_session_cache_as_fact: default: false description: - It disables avi session information to be cached as a fact. type: bool
obj: description: PoolGroup (api/poolgroup) object returned: success, changed type: dict