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 会话信息缓存在 fact 中。

选项

  • 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 服务，则根据可达性和配置的算法在 dns 响应中发送 vip。

如果禁用了 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控制器将默认值解释为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控制器将默认值解释为GSLB_SERVICE_ALGORITHM_PRIORITY。

site_persistence_enabled

布尔值

启用GSLB服务的站点持久性。

在 17.2.1 中引入的字段。

如果API或模块中未指定，Avi控制器将默认值解释为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控制器将默认值解释为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)