community.network.avi_poolgroup 模块 – 用于设置 PoolGroup Avi RESTful 对象的模块

注意

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

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

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

要在 playbook 中使用它，请指定：community.network.avi_poolgroup。

注意

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

已弃用

在：中删除

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_poolgroup

要求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

avi_api_patch_op

字符串

当使用 avi_api_update_method 作为 patch 时，要使用的 Patch 操作。

选项

  • "add"

  • "replace"

  • "delete"

avi_api_update_method

字符串

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

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

选项

  • "put" ←（默认）

  • "patch"

avi_credentials

字典

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

api_version

字符串

Avi 控制器版本

默认值： "16.4.4"

控制器

字符串

Avi 控制器 IP 或 SQDN

csrftoken

字符串

Avi 控制器 API csrftoken，用于重用具有会话 id 的现有会话

默认值： ""

密码

字符串

Avi 控制器密码

端口

字符串

Avi 控制器端口

session_id

字符串

Avi 控制器 API 会话 id，用于重用具有 csrftoken 的现有会话

默认值： ""

租户

字符串

Avi 控制器租户

默认值： "admin"

tenant_uuid

字符串

Avi 控制器租户 UUID

默认值： ""

超时

字符串

Avi 控制器请求超时

默认值： 300

令牌

字符串

Avi 控制器 API 令牌

默认值： ""

用户名

字符串

Avi 控制器用户名

avi_disable_session_cache_as_fact

布尔值

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

选项

  • false ←（默认）

  • true

cloud_config_cksum

字符串

池组的云配置的校验和。

由云连接器内部设置。

cloud_ref

字符串

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

控制器

字符串

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

created_by

字符串

创建对象的用户的名称。

deployment_policy_ref

字符串

当设置自动缩放管理器时，当达到部署目标时，会自动将新池提升到生产环境。

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

description

字符串

池组的描述。

fail_action

字符串

当池组发生故障时，启用一个操作 - 关闭连接、http 重定向或本地 http 响应。

默认情况下，如果池组发生故障，则将关闭连接。

implicit_priority_labels

布尔值

是否生成一组隐式的优先级标签。

在 17.1.9、17.2.3 中引入的字段。

API 或模块中未指定时的默认值被 Avi 控制器解释为 False。

选项

  • false

  • true

成员

字符串

poolgroupmember 类型的池组成员对象的列表。

min_servers

字符串

要将流量分配到的最小服务器数。

允许的值为 1-65535。

特殊值为 0 - “disable”。

API 或模块中未指定时的默认值被 Avi 控制器解释为 0。

名称

字符串 / 必需

池组的名称。

密码

字符串

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

priority_labels_ref

字符串

优先级标签的 Uuid。

如果未提供，则池组成员优先级标签将被解释为一个数字，较大的数字被视为较高优先级。

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

service_metadata

字符串

与此池组提供的服务相关的元数据。

在 openshift/kubernetes 环境中，会存储应用程序元数据信息。

对此字段的任何用户输入都将被 avi vantage 覆盖。

在 17.2.14、18.1.5、18.2.1 中引入的字段。

状态

字符串

应在实体上应用的状态。

选项

  • "absent"

  • "present" ←（默认）

租户

字符串

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

默认值： "admin"

tenant_ref

字符串

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

tenant_uuid

字符串

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

默认值： ""

url

字符串

对象的 Avi 控制器 URL。

用户名

字符串

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

uuid

字符串

池组的 UUID。

注释

注意

示例

- name: Example to create PoolGroup object
  community.network.avi_poolgroup:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_poolgroup

返回值

通用返回值记录在此处，以下是此模块独有的字段

键

描述

obj

字典

PoolGroup (api/poolgroup) 对象

返回: 成功, 已更改

状态

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

  • 有关更多信息，请参阅已弃用。

作者

  • Gaurav Rastogi (@grastogi23)