Documentation

avi_poolgroupdeploymentpolicy - Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object

New in version 2.4.

Synopsis

Options

parameter required default choices comments
api_version
 no
Avi API version of to use for Avi API and objects.
auto_disable_old_prod_pools
 no
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.
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.
description
 no
User defined description for the object.
evaluation_duration
 no
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.
name
 yes
The name of the pool group deployment policy.
password
 no
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
rules
 no
List of pgdeploymentrule.
scheme
 no
Deployment scheme.
Enum options - BLUE_GREEN, CANARY.
Default value when not specified in API or module is interpreted by Avi Controller as BLUE_GREEN.
state
 no present
  • absent
  • present
The state that should be applied on the entity.
target_test_traffic_ratio
 no
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.
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.
test_traffic_ratio_rampup
 no
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.
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 deployment policy.
webhook_ref
 no
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.

Examples

- name: Example to create PoolGroupDeploymentPolicy object
  avi_poolgroupdeploymentpolicy:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_poolgroupdeploymentpolicy

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

name description returned type sample
obj
PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) object
 success, changed dict


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.