community.network.avi_poolgroupdeploymentpolicy 模块 – 用于设置 PoolGroupDeploymentPolicy Avi RESTful 对象的模块

注意

此模块是 community.network 集合 (版本 5.1.0) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install community.network。您需要其他要求才能使用此模块，有关详细信息，请参阅 要求。

要在剧本中使用它，请指定：community.network.avi_poolgroupdeploymentpolicy。

注意

community.network 集合已弃用，并将从 Ansible 12 中删除。有关更多信息，请参阅 讨论主题。

已弃用

在以下版本中移除：

版本 6.0.0

原因：

此集合及其中的所有内容均未维护且已弃用。

替代方案：

未知。

概要

别名：network.avi.avi_poolgroupdeploymentpolicy

要求

执行此模块的主机需要以下要求。

  • avisdk

参数

参数

注释

api_context

字典

包含当前会话 ID 和 CSRF 令牌的 Avi API 上下文。

这允许用户执行单次登录并重用会话。

api_version

字符串

用于 Avi API 和对象的 Avi API 版本。

默认值： "16.4.4"

auto_disable_old_prod_pools

布尔值

一旦有新的生产候选者，它将自动禁用旧的生产池。

未在 API 或模块中指定时的默认值由 Avi Controller 解释为 True。

选项

  • false

  • true

avi_api_patch_op

字符串

当使用 avi_api_update_method 为 patch 时使用的修补操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

对象更新的默认方法是 HTTP PUT。

设置为 patch 将覆盖该行为以使用 HTTP PATCH。

选项

  • "put" ← (默认)

  • "patch"

avi_credentials

字典

Avi 凭据字典，可用于代替枚举 Avi Controller 登录详细信息。

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

controller

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于与 session id 重用现有会话

默认值： ""

password

字符串

Avi 控制器密码

port

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API session id，用于与 csrftoken 重用现有会话

默认值： ""

tenant

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

timeout

字符串

Avi 控制器请求超时

默认值： 300

token

字符串

Avi 控制器 API 令牌

默认值： ""

username

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

它禁用将 avi 会话信息作为事实缓存。

选项

  • false ← (默认)

  • true

controller

字符串

控制器的IP地址或主机名。默认值为环境变量AVI_CONTROLLER。

描述

字符串

用户为对象定义的描述。

评估时长

字符串

自动部署的评估期时长。

允许的值为60-86400。

如果API或模块中未指定，Avi控制器将默认值解释为300。

名称

字符串 / 必填

池组部署策略的名称。

password

字符串

Avi控制器中Avi用户的密码。默认值为环境变量AVI_PASSWORD。

规则

字符串

pgdeploymentrule列表。

方案

字符串

部署方案。

枚举选项 - BLUE_GREEN, CANARY。

如果API或模块中未指定，Avi控制器将默认值解释为BLUE_GREEN。

状态

字符串

应应用于实体的状态。

选项

  • "不存在"

  • "存在" ← (默认)

目标测试流量比例

字符串

池变为生产环境之前的目标流量比例。

允许的值为1-100。

如果API或模块中未指定，Avi控制器将默认值解释为100。

tenant

字符串

用于所有Avi API调用和对象上下文的租户名称。

默认值： "admin"

租户引用

字符串

它是对类型为租户的对象的引用。

tenant_uuid

字符串

用于所有Avi API调用和对象上下文的租户UUID。

默认值： ""

测试流量比例逐步提升

字符串

发送到正在测试的池的流量比例。

测试比例为100表示蓝绿部署。

允许的值为1-100。

如果API或模块中未指定，Avi控制器将默认值解释为100。

URL

字符串

对象的Avi控制器URL。

username

字符串

用于访问Avi控制器的用户名。默认值为环境变量AVI_USERNAME。

UUID

字符串

池组部署策略的UUID。

Webhook引用

字符串

配置了URL的Webhook，Avi控制器将通过该URL回传有关池组、旧池和新池信息以及当前部署的信息

规则结果。

它是对类型为Webhook的对象的引用。

在17.1.1版本中引入的字段。

备注

注意

示例

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

返回值

常见的返回值已在此处记录，以下是此模块特有的字段

键

描述

obj

字典

池组部署策略 (api/poolgroupdeploymentpolicy) 对象

返回：成功，已更改

状态

  • 此模块将在6.0.0版本中移除。 [已弃用]

  • 更多信息请参见 已弃用。

作者

  • Gaurav Rastogi (@grastogi23)