Documentation
  • Docs »
  • avi_poolgroupdeploymentpolicy – Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object
  • Edit on GitHub

avi_poolgroupdeploymentpolicy – Module for setup of PoolGroupDeploymentPolicy Avi RESTful Object

New in version 2.4.

Synopsis

Requirements

The below requirements are needed on the host that executes this module.

  • avisdk

Parameters

Parameter Choices/Defaults Comments
api_context
dictionary
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
string
Default:
"16.4.4"
Avi API version of to use for Avi API and objects.
auto_disable_old_prod_pools
boolean
    Choices:
  • no
  • yes
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.
avi_api_patch_op
-
added in 2.5
    Choices:
  • add
  • replace
  • delete
Patch operation to use when using avi_api_update_method as patch.
avi_api_update_method
-
added in 2.5
    Choices:
  • put ←
  • patch
Default method for object update is HTTP PUT.
Setting to patch will override that behavior to use HTTP PATCH.
avi_credentials
dictionary
added in 2.5
Avi Credentials dictionary which can be used in lieu of enumerating Avi Controller login details.
cloud_ref
-
It is a reference to an object of type cloud.
controller
string
Default:
""
IP address or hostname of the controller. The default value is the environment variable AVI_CONTROLLER.
description
-
User defined description for the object.
evaluation_duration
-
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.
Units(SEC).
name
- / required
The name of the pool group deployment policy.
password
string
Default:
""
Password of Avi user in Avi controller. The default value is the environment variable AVI_PASSWORD.
rules
-
List of pgdeploymentrule.
scheme
-
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
-
    Choices:
  • absent
  • present ←
The state that should be applied on the entity.
target_test_traffic_ratio
-
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.
Units(RATIO).
tenant
string
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
string
Default:
""
UUID of tenant used for all Avi API calls and context of object.
test_traffic_ratio_rampup
-
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
-
Avi controller URL of the object.
username
string
Default:
""
Username used for accessing Avi controller. The default value is the environment variable AVI_USERNAME.
uuid
-
Uuid of the pool group deployment policy.
webhook_ref
-
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.

Notes

Note

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, the following are the fields unique to this module:

Key Returned Description
obj
dictionary
success, changed
PoolGroupDeploymentPolicy (api/poolgroupdeploymentpolicy) object



Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.