community.network.netscaler_lb_vserver 模块 – 管理负载均衡 vserver 配置
注意
此模块是 community.network 集合（版本 5.1.0）的一部分。
如果您正在使用 ansible 包，您可能已经安装了这个集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用： ansible-galaxy collection install community.network。您需要进一步的要求才能使用此模块，请参阅 要求 了解详细信息。
要在 playbook 中使用它，请指定： community.network.netscaler_lb_vserver。
注意
community.network 集合已被弃用，并将从 Ansible 12 中删除。有关更多信息，请参阅讨论主题。
已弃用
- 已在以下版本中删除:
版本 6.0.0
- 原因:
此集合及其中的所有内容均未维护和已弃用。
- 替代方案:
未知。
概要
管理负载均衡 vserver 配置
此模块旨在在 Ansible 控制节点或可以访问实际 NetScaler 实例的堡垒机（跳转服务器）上运行
别名：network.netscaler.netscaler_lb_vserver
要求
在执行此模块的主机上需要以下要求。
nitro python sdk
参数
参数 |
注释 |
|---|---|
将 AppFlow 日志记录应用于虚拟服务器。 选择
|
|
启用或禁用用户身份验证。 选择
|
|
用户必须重定向到的身份验证虚拟服务器的完全限定域名 (FQDN)。确保将“身份验证”参数设置为 最小长度 = 3 最大长度 = 252 |
|
启用或禁用使用 HTTP 401 响应的用户身份验证。 选择
|
|
启用身份验证时要使用的身份验证配置文件的名称。 |
|
用于对用户进行身份验证的身份验证虚拟服务器的名称。 最小长度 = 1 最大长度 = 252 |
|
备份负载均衡方法。如果主负载均衡方法 方法失败或无法使用，则变为可操作。 仅当主方法基于静态邻近性时才有效。 选择
|
|
备份持久性生效的时间段。 最小值 = 最大值 = |
|
如果在解析 DNS64 查询时启用此选项，则不会将 AAAA 查询发送到后端 DNS 服务器。 选择
|
|
将可缓存的请求路由到缓存重定向虚拟服务器。负载均衡虚拟服务器只能将请求转发到具有 *:80 IP 地址和端口组合的透明缓存重定向虚拟服务器，因此必须在设备上配置此类缓存重定向虚拟服务器。 选择
|
|
客户端连接终止后的空闲时间（以秒为单位）。 最小值 = 最大值 = |
|
您可能想要与虚拟服务器关联的任何注释。 |
|
虚拟服务器必须运行连接故障转移功能的模式。故障转移后，已建立的 TCP 连接和 UDP 数据包流将保持活动状态，并在辅助设备上恢复。客户端保持连接到同一服务器。可用设置的功能如下 * * * 选择
|
|
使用此参数为 |
|
从传入数据包的数据段中提取的令牌的长度，用于负载均衡的令牌方法。令牌的长度（以字节为单位）不得大于 24 KB。适用于 TCP 类型的虚拟服务器。 最小值 = 最大值 = |
|
从 TCP 负载中提取令牌时要考虑的偏移量。适用于使用令牌负载均衡方法的 TCP 类型的虚拟服务器。必须在 TCP 负载的前 24 KB 内。 最小值 = 最大值 = |
|
要应用于虚拟服务器的数据库配置文件名称。 最小长度 = 1 最大长度 = 127 |
|
为 MySQL 和 MSSQL 服务类型启用特定于数据库的负载均衡。 选择
|
|
设置为 设置为 请注意，由于底层 NITRO API 的限制，仅 选择
|
|
如果主虚拟服务器出现故障，则不允许其恢复为主状态，除非手动启用。 选择
|
|
此参数用于在 lbvserver 上启用/禁用 选择
|
|
要与 VServer 关联的 DNS 配置文件的名称。DNS 配置文件属性将应用于由 VServer 处理的事务。此参数仅对 DNS 和 DNS-TCP VServer 有效。 最小长度 = 1 最大长度 = 127 |
|
刷新与状态从 UP 转换为 DOWN 的虚拟服务器关联的所有活动事务。对于必须完成事务的应用程序，请勿启用此选项。 选择
|
|
用于 URLHASH 和 DOMAINHASH 负载均衡方法的哈希值的字节数。 最小值 = 最大值 = |
|
活动服务低于此百分比阈值时，vserver 状态将变为 down。如果此阈值为 0，即使只有一个绑定服务处于 up 状态，vserver 状态也将为 up。 最小值 = 最大值 = |
|
要应用于虚拟服务器的 HTTP 配置文件的名称。 最小长度 = 1 最大长度 = 127 |
|
NetScaler 设备如何响应针对一个或多个虚拟服务器共有的 IP 地址收到的 ping 请求。可用设置的功能如下 * 如果在共享 IP 地址的所有虚拟服务器上设置为 * 如果在共享 IP 地址的所有虚拟服务器上设置为 * 如果在某些虚拟服务器上设置为 注意：此参数在虚拟服务器级别可用。类似的参数“ICMP Response”在 IP 地址级别可用，适用于类型为 VIP 的 IPv4 地址。要设置该参数，请在 CLI 中使用 add ip 命令或在 GUI 中使用“创建 IP”对话框。 选择
|
|
在将请求转发到服务器之前，插入一个 HTTP 标头，其值为虚拟服务器的 IP 地址和端口号。标头的格式为 <vipHeader>: <虚拟服务器 IP 地址>_<端口号>，其中 vipHeader 是您为标头指定的名称。如果虚拟服务器具有 IPv6 地址，则标头中的地址将用方括号 ([ 和 ]) 括起来，以将其与端口号分隔开。如果您已将 IPv4 地址映射到虚拟服务器的 IPv6 地址，则此参数的值将确定在标头中插入哪个 IP 地址，如下所示 * * * 选择
|
|
IP 掩码，以点分十进制表示法表示，用于 IP 模式参数。可以有前导或尾随的非零八位字节（例如， |
|
IP 地址模式，以点分十进制表示法表示，用于标识虚拟服务器接受的数据包。IP 掩码参数指定目标 IP 地址的哪个部分与模式匹配。与 IP 地址参数互斥。 例如，如果分配给虚拟服务器的 IP 模式是 如果目标 IP 地址与多个 IP 模式匹配，则选择匹配最长的模式，并且关联的虚拟服务器处理该请求。例如，如果虚拟服务器 |
|
要分配给虚拟服务器的 IPv4 或 IPv6 地址。 |
|
除了用于标识连接的 4 元组（<源 IP>:<源端口>::<目标 IP>:<目标端口>）之外，还使用第 2 层参数（通道号、MAC 地址和 VLAN ID）。允许具有相同 4 元组的多个 TCP 和非 TCP 连接在 NetScaler 设备上共存。 选择
|
|
负载均衡方法。可用设置的功能如下 * * * * * * * 还有一些哈希方法，其中设备提取请求的预定部分，创建该部分的哈希值，然后检查是否有任何之前的请求具有相同的哈希值。如果找到匹配项，则将请求转发到为这些先前请求提供服务的服务。以下是哈希方法 * * * * * * * * 选择
|
|
标识虚拟服务器接受的流量的默认语法表达式。可以是表达式（例如， |
|
指定侦听策略优先级的整数。数字越大，优先级越低。如果请求与多个虚拟服务器的侦听策略匹配，则侦听策略优先级最高（优先级数字最低）的虚拟服务器接受该请求。 最小值 = 最大值 = |
|
负载均衡的重定向模式。可用设置的功能如下 * * * * 您可以使用 选择
|
|
启用 macmode 时，此选项用于保留传入数据包的 vlan 信息。 选择
|
|
当 vserver 用于自动缩放时，预期的最大成员数量。 最小值 = 最大值 = |
|
当 vserver 用于自动缩放时，预期的最小成员数量。 最小值 = 最大值 = |
|
对于类型为 选择
|
|
虚拟服务器向客户端通告的字符集。 |
|
虚拟服务器向客户端通告的 MySQL 协议版本。 |
|
虚拟服务器向客户端通告的服务器功能。 |
|
虚拟服务器向客户端通告的 MySQL 服务器版本字符串。 最小长度 = 1 最大长度 = 31 |
|
虚拟服务器的名称。必须以 ASCII 字母数字或下划线 最小长度 = 1 |
|
当负载均衡方法为 最小长度 = 1 |
|
要与虚拟服务器关联的网络配置文件的名称。如果设置此参数，则虚拟服务器在与服务器建立连接时，仅使用网络配置文件中的 IP 地址作为源 IP 地址。 最小长度 = 1 最大长度 = 127 |
|
在慢启动模式下，新服务在每个间隔增加的请求数量或现有服务负载的百分比。非零值表示慢启动适用。零值表示应用全局 RR 启动参数。将该值更改为零将导致当前处于慢启动状态的服务承担由 LB 方法确定的全部流量。随后，添加的任何新服务将使用全局 RR 因子。 |
|
新服务或状态刚从 DOWN 更改为 UP 的服务，其负载连续增加之间的时间间隔（以秒为单位）。值为 0（零）表示手动慢启动。 最小值 = 最大值 = |
|
在慢启动模式下，每个间隔增加负载的单位。 选择
|
|
用于向 netscaler 节点进行身份验证的密码。 |
|
访问 nitro API 对象时要使用的协议。 选择
|
|
与 Netscaler 建立新会话时，超时错误抛出之前的秒数 默认值： |
|
用于向 netscaler 节点进行身份验证的用户名。 |
|
将执行 nitro API 调用的 netscaler 设备的 IP 地址。 端口可以使用冒号 (:) 指定。例如：192.168.1.1:555。 |
|
Oracle 服务器版本。 选择
|
|
用于 Diameter 持久性的持久 AVP 编号。 如果此 AVP 未在基本 RFC 3588 中定义，并且嵌套在分组 AVP 中， 请按父级到子级的顺序定义 AVP 编号序列（最多 3 个）。例如，如果持久 AVP 编号 X 嵌套在 AVP Y 中，而 AVP Y 又嵌套在 Z 中，则将列表定义为 Z Y X。 最小值 = |
|
虚拟服务器的备份持久性类型。如果主持久性机制失败，则会生效。 选择
|
|
虚拟服务器的持久性类型。可用设置的功能如下： * * * * * * * * * * * FIXSESSION - 具有相同的 SenderCompID 和 TargetCompID 值的连接属于同一持久性会话。 选择
|
|
基于 IP 的持久性类型的持久性掩码，适用于 IPv4 虚拟服务器。 最小长度 = 1 |
|
虚拟服务器的端口号。 范围 * 在 CLI 中表示为 |
|
启用此选项后，发往集群中 vserver 的数据包将不会进行任何转向。对于单数据包请求响应模式，或当上游设备正在执行基于连接的分布的适当 RSS 时，请启用此选项。 选择
|
|
使用绑定到此负载均衡虚拟服务器的推送虚拟服务器处理流量。 选择
|
|
用于从服务器响应中提取标签的表达式。可以是表达式或命名表达式的名称。 |
|
允许来自同一客户端的多个 Web 2.0 连接连接到虚拟服务器并期望更新。 选择
|
|
类型为 PUSH 或 SSL_PUSH 的负载均衡虚拟服务器的名称，服务器将在此虚拟服务器上接收的更新推送到您正在配置的负载均衡虚拟服务器。 最小长度 = 1 |
|
设备必须生成并分配给虚拟服务器的 IP 地址数量。然后，虚拟服务器充当网络虚拟服务器，接受任何生成的 IP 地址上的流量。IP 地址会自动生成，如下所示： * 对于范围 n，由 IP 地址参数指定的地址的最后一个八位字节递增 n-1 次。 * 如果最后一个八位字节超过 255，则它将回滚到 0，并且第三个八位字节递增 1。 注意：Range 参数将多个 IP 地址分配给一个虚拟服务器。要生成一组虚拟服务器，每个虚拟服务器仅拥有一个 IP 地址，请在 IP 地址和名称参数中使用方括号来指定范围。例如： add lb vserver my_vserver[1-3] HTTP 192.0.2.[1-3] 80. 最小值 = 最大值 = |
|
当设置为 YES 时，此选项会导致来自此 vserver 的 DNS 回复将 RA 位设置为启用。通常，当 vserver 负载均衡一组支持递归查询的 DNS 服务器时，会将此选项设置为 YES。 选择
|
|
重写端口并更改协议，以确保服务成功进行 HTTP 重定向。 选择
|
|
如果虚拟服务器不可用，则将流量重定向到的 URL。 警告！请确保 URL 中的域名与为内容切换策略指定的域名不匹配。如果匹配，请求将不断重定向到不可用的虚拟服务器。 最小长度 = 1 |
|
默认语法表达式，指定使用服务器响应的哪个部分来创建基于规则的持久性会话（持久性类型为 RULE）。可以是表达式或命名表达式的名称。 示例
|
|
NetScaler 设备用于宣告与虚拟服务器关联的 VIP 地址路由的路由健康注入 (RHI) 功能。当 Vserver RHI Level (RHI) 参数设置为 VSVR_CNTRLD 时，以下是 VIP 地址基于与 VIP 地址关联的虚拟服务器上的 RHIstate (RHI STATE) 设置的不同 RHI 行为 * 如果您在所有虚拟服务器上将 * 如果您在所有虚拟服务器上将 * 如果您在某些虚拟服务器上将 选择
|
|
对 RTSP 数据连接使用网络地址转换 (NAT)。 选择
|
|
如果为 如果模块没有进行任何更改，则不会在 netscaler 节点上保存配置。 选择
|
|
与负载均衡权重一起的服务的列表。 以下子选项可用。 |
|
要绑定到虚拟服务器的服务。 最小长度 = 1 |
|
要分配给指定服务的权重。 最小值 = 最大值 = |
|
与负载均衡权重一起的服务组列表。 以下子选项可用。 |
|
绑定到所选负载均衡虚拟服务器的服务组名称。 |
|
指定服务权重的整数。数字越大，权重越大。定义服务相对于负载均衡配置中其他服务的容量。确定在负载均衡决策中赋予服务的优先级。 最小值 = 最大值 = |
|
服务使用的协议（也称为服务类型）。 选择
|
|
在每个数据包的基础上执行负载均衡，而不建立会话。建议用于负载均衡入侵检测系统 (IDS) 服务器和涉及直接服务器返回 (DSR) 的场景，其中会话信息是不必要的。 选择
|
|
此参数决定了当从现有持久会话中选择的服务达到阈值时要采取的行为。 选择
|
|
如果溢出要生效，但没有可用的或存在的溢出备份链时要执行的操作。 选择
|
|
超出时触发溢出的阈值类型。可用设置的功能如下 * * DYNAMICCONNECTION - 当虚拟服务器的客户端连接数超过绑定服务的最大客户端 (Max Clients) 设置的总和时发生溢出。不要为此设置指定溢出阈值，因为阈值是由绑定服务的最大客户端设置隐含的。 * * * 选择
|
|
如果发生溢出，则为主要和备份虚拟服务器维护基于源 IP 地址的持久性。 选择
|
|
溢出持久性的超时时间，以分钟为单位。 最小值 = 最大值 = |
|
发生溢出的阈值。为 最小值 = 最大值 = |
|
绑定到此服务的 SSL 证书的名称。 SSL 证书必须已经存在。 可以使用 community.network.netscaler_ssl_certkey 模块创建证书。 此选项仅在 |
|
模块在 netscaler 节点上配置的资源的状态。 如果存在，则将根据模块的参数创建和配置资源。 如果不存在，则将从 netscaler 节点中删除资源。 选择
|
|
要应用于虚拟服务器的 TCP 配置文件名称。 最小长度 = 1 最大长度 = 127 |
|
唯一标识要在其中配置实体的流量域的整数值。如果未指定 ID，则该实体将成为默认流量域的一部分，其 ID 为 0。 最小值 = 最大值 = |
|
持久会话生效的时间段。 最小值 = 最大值 = |
|
虚拟服务器的 TOS ID。仅当负载均衡重定向模式设置为 TOS 时才适用。 最小值 = 最大值 = |
|
在 IPv6 目标或源 IP 地址中要考虑的位数，用于创建 最小值 = 最大值 = |
|
基于 IP 的持久性类型的持久性掩码，用于 IPv6 虚拟服务器。 最小值 = 最大值 = |
|
如果为 选择
|
|
插入标头的名称。默认名称为 vip-header。 最小长度 = 1 |
注释
注意
有关使用 Ansible 管理 Citrix NetScaler 网络设备的更多信息，请参阅 https://ansible.org.cn/ansible-netscaler。
示例
# Netscaler services service-http-1, service-http-2 must have been already created with the netscaler_service module
- name: Create a load balancing vserver bound to services
delegate_to: localhost
community.network.netscaler_lb_vserver:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
validate_certs: false
state: present
name: lb_vserver_1
servicetype: HTTP
timeout: 12
ipv46: 6.93.3.3
port: 80
servicebindings:
- servicename: service-http-1
weight: 80
- servicename: service-http-2
weight: 20
# Service group service-group-1 must have been already created with the netscaler_servicegroup module
- name: Create load balancing vserver bound to servicegroup
delegate_to: localhost
community.network.netscaler_lb_vserver:
nsip: 172.18.0.2
nitro_user: nsroot
nitro_pass: nsroot
validate_certs: false
state: present
name: lb_vserver_2
servicetype: HTTP
ipv46: 6.92.2.2
port: 80
timeout: 10
servicegroupbindings:
- servicegroupname: service-group-1
返回值
常见返回值记录在此处，以下是此模块独有的字段
键 |
描述 |
|---|---|
实际配置的对象与模块中指定的配置之间的差异列表 返回：失败 示例: |
|
模块记录的消息列表 返回: 总是 示例: |
|
详细说明失败原因的消息 返回：失败 示例: |
状态
此模块将在 6.0.0 版本中移除。[已弃用]
有关更多信息，请参阅已弃用。