community.network.avi_gslbservice 模块 – 用于设置 GslbService Avi RESTful 对象的模块

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除：

版本 6.0.0

原因：

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

替代方案：

未知。

概要

别名：network.avi.avi_gslbservice

需求

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

  • avisdk

参数

参数

注释

api_context

字典

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

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

api_version

字符串

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

默认值： "16.4.4"

application_persistence_profile_ref

字符串

与 gslbservice 站点持久性功能关联的联合应用程序持久性。

它是 applicationpersistenceprofile 类型对象的引用。

在 17.2.1 中引入的字段。

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。

controller_health_status_enabled

布尔值

Gs 成员的整体运行状况基于控制器和数据路径运行状况输入的组合。

请注意，数据路径状态由运行状况监视器配置文件的关联确定。

仅通过此配置确定控制器提供的状态。

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

选项

  • false

  • true

created_by

字符串

创建者名称。

在 17.1.2 中引入的字段。

description

字符串

对象的自定义描述。

domain_names

字符串

gslb 服务的完全限定域名。

down_response

字符串

gslb 服务关闭时对客户端查询的响应。

enabled

布尔值

启用或禁用 gslb 服务。

如果启用 gslb 服务，则基于可达性和配置的算法，vip 将发送到 dns 响应中。

如果禁用 gslb 服务，则 vip 将不再出现在 dns 响应中。

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

选项

  • false

  • true

groups

字符串

属于此 gslb 服务的池的选择列表。

health_monitor_refs

字符串

通过应用一个或多个运行状况监视器来验证 vs 运行状况。

活动监视器会从 dns 服务引擎生成合成流量，并根据响应标记 vs 上线或下线。

它是 healthmonitor 类型对象的引用。

health_monitor_scope

字符串

运行状况监视器探测可以针对所有成员执行，也可以仅针对第三方成员执行。

此操作模式对于减少混合场景中的运行状况监视器探测数量很有用。

在这种情况下，avi 成员可以具有控制器派生的状态，而非 avi 成员可以通过数据平面中的运行状况监视器探测进行探测。

枚举选项 - GSLB_SERVICE_HEALTH_MONITOR_ALL_MEMBERS、GSLB_SERVICE_HEALTH_MONITOR_ONLY_NON_AVI_MEMBERS。

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

hm_off

布尔值

此字段是内部字段，用于 se。

在 18.2.2 中引入的字段。

选项

  • false

  • true

is_federated

布尔值

此字段指示此对象在 gslb 联合中进行复制。

字段在 17.1.3 版本中引入。

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

选项

  • false

  • true

min_members

字符串

分配流量的最小成员数。

允许的值为 1-65535。

特殊值：0 - ‘禁用’。

字段在 17.2.4 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 0。

name

字符串 / 必填

GSLB 服务的名称。

num_dns_ip

字符串

DNS 服务返回的此 GSLB 服务的 IP 地址数量。

输入 0 表示返回所有 IP 地址。

允许的值为 1-20。

特殊值：0 - ‘返回所有 IP 地址’。

password

字符串

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

pool_algorithm

字符串

负载均衡算法将从 GSLB 服务可用池列表中选择一个 GSLB 池。

枚举选项 - GSLB_SERVICE_ALGORITHM_PRIORITY, GSLB_SERVICE_ALGORITHM_GEO。

字段在 17.2.3 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 GSLB_SERVICE_ALGORITHM_PRIORITY。

site_persistence_enabled

布尔值

为 Gslbservice 启用站点持久性。

在 17.2.1 中引入的字段。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 False。

选项

  • false

  • true

state

字符串

应应用于实体的状态。

选项

  • "absent"

  • "present" ← (默认)

tenant

字符串

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

默认值： "admin"

tenant_ref

字符串

它是对 tenant 类型对象的引用。

tenant_uuid

字符串

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

默认值： ""

ttl

字符串

DNS 服务为此 GSLB 服务提供的记录的 TTL 值（以秒为单位）。

允许的值为 0-86400。

url

字符串

对象的 Avi 控制器 URL。

use_edns_client_subnet

布尔值

使用来自 EDNS 选项的客户端 IP 子网作为客户端地理位置和一致哈希算法的源 IP 地址。

默认为 true。

字段在 17.1.1 版本中引入。

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

选项

  • false

  • true

username

字符串

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

uuid

字符串

GSLB 服务的 UUID。

wildcard_match

布尔值

启用通配符匹配，如果在 DNS 表中找不到完全匹配，则通过对 DNS 中的 FQDN 使用通配符来选择最长的匹配项。

请求。

默认为 false。

字段在 17.1.1 版本中引入。

如果在 API 或模块中未指定，Avi Controller 将默认值解释为 False。

选项

  • false

  • true

备注

注意

示例

- name: Example to create GslbService object
  community.network.avi_gslbservice:
    controller: 10.10.25.42
    username: admin
    password: something
    state: present
    name: sample_gslbservice

返回值

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

键

描述

obj

字典

GslbService (api/gslbservice) 对象

返回：成功，已更改

状态

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

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

作者

  • Gaurav Rastogi (@grastogi23)