ansible / ansible.builtin / v2.9.3 / module / avi_poolgroupdeploymentpolicy Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object | "added in version" 2.4 of ansible.builtin" Authors: Gaurav Rastogi (@grastogi23) <grastogi@avinetworks.com> preview | supported by communityansible.builtin.avi_poolgroupdeploymentpolicy (v2.9.3) — module
pip
Install with pip install ansible==2.9.3
This module is used to configure PoolGroupDeploymentPolicy object
more examples at U(https://github.com/avinetworks/devops)
- name: Example to create PoolGroupDeploymentPolicy object avi_poolgroupdeploymentpolicy: controller: 10.10.25.42 username: admin password: something state: present name: sample_poolgroupdeploymentpolicy
url: description: - Avi controller URL of the object. name: description: - The name of the pool group deployment policy. required: true uuid: description: - Uuid of the pool group deployment policy. rules: description: - List of pgdeploymentrule. state: choices: - absent - present default: present description: - The state that should be applied on the entity. scheme: description: - Deployment scheme. - Enum options - BLUE_GREEN, CANARY. - Default value when not specified in API or module is interpreted by Avi Controller as BLUE_GREEN. tenant: default: admin description: - Name of tenant used for all Avi API calls and context of object. type: str password: default: '' description: - Password of Avi user in Avi controller. The default value is the environment variable C(AVI_PASSWORD). type: str username: default: '' description: - Username used for accessing Avi controller. The default value is the environment variable C(AVI_USERNAME). type: str controller: default: '' description: - IP address or hostname of the controller. The default value is the environment variable C(AVI_CONTROLLER). type: str 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: - User defined description for the object. tenant_uuid: default: '' description: - UUID of tenant used for all Avi API calls and context of object. type: str webhook_ref: description: - Webhook configured with url that avi controller will pass back information about pool group, old and new pool information and current deployment - rule results. - It is a reference to an object of type webhook. - Field introduced in 17.1.1. 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: description: - Avi controller API csrftoken to reuse existing session with session id password: description: - Avi controller password port: description: - Avi controller port session_id: description: - Avi controller API session id to reuse existing session with csrftoken tenant: default: admin description: - Avi controller tenant tenant_uuid: description: - Avi controller tenant UUID timeout: default: 300 description: - Avi controller request timeout token: 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. version_added: '2.5' version_added_collection: ansible.builtin evaluation_duration: description: - Duration of evaluation period for automatic deployment. - Allowed values are 60-86400. - Default value when not specified in API or module is interpreted by Avi Controller as 300. 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. version_added: '2.5' version_added_collection: ansible.builtin target_test_traffic_ratio: description: - Target traffic ratio before pool is made production. - Allowed values are 1-100. - Default value when not specified in API or module is interpreted by Avi Controller as 100. test_traffic_ratio_rampup: description: - Ratio of the traffic that is sent to the pool under test. - Test ratio of 100 means blue green. - Allowed values are 1-100. - Default value when not specified in API or module is interpreted by Avi Controller as 100. auto_disable_old_prod_pools: description: - It will automatically disable old production pools once there is a new production candidate. - Default value when not specified in API or module is interpreted by Avi Controller as True. 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: PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) object returned: success, changed type: dict