community.network.netscaler_lb_monitor 模块 – 管理负载均衡监控器

注意

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

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

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

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

注意

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

已弃用

在以下版本中移除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 管理负载均衡监控器。

  • 此模块旨在在 Ansible 控制节点或可以访问实际 NetScaler 实例的堡垒机（跳转服务器）上运行。

别名：network.netscaler.netscaler_lb_monitor

要求

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

  • nitro python sdk

参数

参数

注释

acctapplicationid

字符串

用于监控 Diameter 服务器的 Capabilities-Exchange-Request (CER) 消息的 Acct-Application-Id 属性值对 (AVP) 列表。监控消息最多支持 8 个此类 AVP。

最小值 = 0

最大值 = 4294967295

action

字符串

当对内联监控器（类型为 HTTP-INLINE 的监控器）的响应指示服务已关闭时执行的操作。如果响应代码不是为响应代码参数指定的代码之一，则内联监控器监控的服务将被视为 DOWN。

可用设置的功能如下

* NONE - 不执行任何操作。但是，show service 命令和 show lb monitor 命令会指示检查的响应总数以及上次成功探测后收到的连续错误响应数。

* LOG - 将事件记录在 NSLOG 或 SYSLOG 中。

* DOWN - 将服务标记为关闭，然后在配置的关闭时间到期之前不将任何流量定向到该服务。一旦服务被标记为 DOWN，则会终止与该服务的持久连接。此外，将事件记录在 NSLOG 或 SYSLOG 中。

选项

  • "NONE"

  • "LOG"

  • "DOWN"

alertretries

字符串

设备生成名为 monProbeFailed 的 SNMP 陷阱之前，连续探测失败的次数。

最小值 = 0

最大值 = 32

application

字符串

用于确定服务状态的应用程序的名称。适用于类型为 CITRIX-XML-SERVICE 的监控器。

最小长度 = 1

attribute

字符串

当 LDAP 服务器响应查询时要评估的属性。监控探测的成功或失败取决于响应中是否存在该属性。可选。

最小长度 = 1

authapplicationid

字符串

用于监控 Diameter 服务器的 Capabilities-Exchange-Request (CER) 消息的 Auth-Application-Id 属性值对 (AVP) 列表。监控 CER 消息最多支持 8 个此类 AVP。

最小值 = 0

最大值 = 4294967295

basedn

字符串

LDAP 服务的基本专有名称，LDAP 服务器可以从此处开始搜索监控查询中的属性。 LDAP 服务监控需要此项。

最小长度 = 1

binddn

字符串

用于 LDAP 监视器在 LDAP 服务器上执行绑定操作的专有名称。可选。适用于 LDAP 监视器。

最小长度 = 1

customheaders

字符串

包含在监视探测中的自定义标头字符串。

database

字符串

身份验证期间要连接的数据库的名称。

最小长度 = 1

destip

字符串

要将探测发送到的服务的 IP 地址。如果该参数设置为 0，则将监视器绑定到的服务器的 IP 地址视为目标 IP 地址。

destport

字符串

要将探测发送到的 TCP 或 UDP 端口。如果该参数设置为 0，则将监视器绑定到的服务的端口号视为目标端口。但是，对于 USER 类型的监视器，目标端口是发送到调度程序的 HTTP 请求中包含的端口号。不适用于 PING 类型的监视器。

deviation

字符串

在动态响应时间监视 (DRTM) 中添加到学习到的平均响应时间的时间值。指定偏差后，设备会学习绑定服务的平均响应时间，并将偏差添加到平均值。然后，不断调整最终值，以适应响应时间随时间的变化。以毫秒、秒或分钟为单位指定。

最小值 = 0

最大值 = 20939

dispatcherip

字符串

要将探测发送到的调度程序的 IP 地址。

dispatcherport

字符串

调度程序侦听监视探测的端口号。

domain

字符串

XenDesktop 桌面交付控制器 (DDC) 服务器或 Web Interface 服务器所在的域。CITRIX-XD-DDC 和 CITRIX-WI-EXTENDED 监视器分别用于登录到 DDC 服务器和 Web Interface 服务器时需要。

downtime

字符串

在探测标记为“DOWN”的服务之前等待的时间长度。以毫秒、秒或分钟为单位表示。

最小值 = 1

最大值 = 20939

evalrule

字符串

默认语法表达式，用于评估数据库服务器对 MYSQL-ECV 或 MSSQL-ECV 监视查询的响应。必须产生布尔结果。结果决定服务器的状态。如果表达式返回 TRUE，则探测成功。

例如，如果希望设备评估错误消息以确定服务器的状态，请使用规则 MYSQL.RES.ROW(10 .TEXT_ELEM(2).EQ(“MySQL”))。

failureretries

字符串

在为“重试”参数指定的次数中，必须失败的重试次数，服务才会被标记为“DOWN”。例如，如果“重试”参数设置为 10，“失败重试”参数设置为 6，则在发送的 10 个探测中，至少有 6 个探测必须失败，服务才会被标记为“DOWN”。默认值 0 表示如果服务要被标记为“DOWN”，则所有重试都必须失败。

最小值 = 0

最大值 = 32

filename

字符串

FTP 服务器上的文件的名称。设备通过定期检查服务器上是否存在该文件来监视 FTP 服务。适用于 FTP-EXTENDED 监视器。

最小长度 = 1

filter

字符串

LDAP 查询的筛选条件。可选。

最小长度 = 1

firmwarerevision

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Firmware-Revision 值。

group

字符串

要监视的 NNTP 服务上可用的新闻组的名称。设备会定期生成针对新闻组名称的 NNTP 查询并评估响应。如果在服务器上找到该新闻组，则将服务标记为“UP”。如果该新闻组不存在或搜索失败，则将服务标记为“DOWN”。适用于 NNTP 监视器。

最小长度 = 1

hostipaddress

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Host-IP-Address 值。如果未指定 Host-IP-Address，则设备会插入从中发送 CER 请求（监视探测）的映射 IP (MIP) 地址或子网 IP (SNIP) 地址。

最小长度 = 1

hostname

字符串

FQDN 格式的主机名（示例：porche.cars.org）。适用于 STOREFRONT 监视器。

最小长度 = 1

httprequest

字符串

要发送到服务器的 HTTP 请求（例如，"HEAD /file.html"）。

inbandsecurityid

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Inband-Security-Id。

选项

  • "NO_INBAND_SECURITY"

  • "TLS"

interval

字符串

两次连续探测之间的时间间隔。必须大于响应超时的值。

最小值 = 1

最大值 = 20940

ipaddress

字符串

如果记录类型为 A 或 AAAA，则 DNS 服务器的监视响应中预期存在的 IP 地址集。适用于 DNS 监视器。

最小长度 = 1

iptunnel

布尔值

通过 IP 隧道将监视探测发送到服务。必须指定目标 IP 地址。

选项

  • false

  • true

kcdaccount

字符串

MSSQL 监视器使用的 KCD 帐户。

最小长度 = 1

最大长度 = 32

lasversion

字符串

Citrix Advanced Access Control Logon Agent 的版本号。 CITRIX-AAC-LAS 监视器需要。

logonpointname

字符串

为 Citrix Access Gateway Advanced Access Control 软件配置的登录点的名称。如果要监视关联的登录页面或登录代理，则需要此项。适用于 CITRIX-AAC-LAS 和 CITRIX-AAC-LOGINPAGE 监视器。

lrtm

字符串

计算绑定服务的最小响应时间。如果未启用此参数，则设备不会学习绑定服务的响应时间。也用于 LRTM 负载平衡。

选项

  • "enabled"

  • "disabled"

maxforwards

字符串

用于监视的 SIP 请求可以遍历以到达服务器的最大跃点数。仅适用于 SIP-UDP 类型的监视器。

最小值 = 0

最大值 = 255

metrictable

字符串

要将指标绑定到的指标表。

最小长度 = 1

最大长度 = 99

monitorname

字符串

监视器的名称。必须以 ASCII 字母数字或下划线 _ 字符开头，并且只能包含 ASCII 字母数字、下划线、井号 #、句点 .、空格 、冒号 :、at 符 @、等于号 = 和连字符 - 字符。

最小长度 = 1

mssqlprotocolversion

字符串

要监视的 MSSQL 服务器的版本。

选项

  • "70"

  • "2000"

  • "2000SP1"

  • "2005"

  • "2008"

  • "2008R2"

  • "2012"

  • "2014"

netprofile

字符串

网络配置文件的名称。

最小长度 = 1

最大长度 = 127

nitro_pass

字符串 / 必需

用于向 Netscaler 节点进行身份验证的密码。

nitro_protocol

字符串

访问 nitro API 对象时要使用的协议。

选项

  • "http" ←（默认）

  • "https"

nitro_timeout

浮点数

与 Netscaler 建立新会话时，抛出超时错误之前的时间（以秒为单位）

默认值： 310.0

nitro_user

字符串 / 必需

用于向 Netscaler 节点进行身份验证的用户名。

nsip

字符串 / 必需

将进行 nitro API 调用的 Netscaler 设备的 IP 地址。

可以使用冒号 (:) 指定端口。例如，192.168.1.1:555。

oraclesid

字符串

在身份验证期间用于连接到 Oracle 数据库的服务标识符的名称。

最小长度 = 1

originhost

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Origin-Host 值。

最小长度 = 1

originrealm

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Origin-Realm 值。

最小长度 = 1

password

字符串

登录 RADIUS、NNTP、FTP、FTP-EXTENDED、MYSQL、MSSQL、POP3、CITRIX-AG、CITRIX-XD-DDC、CITRIX-WI-EXTENDED、CITRIX-XNC-ECV 或 CITRIX-XDM 服务器时需要的密码。与为 username 参数指定的用户名称结合使用。

最小长度 = 1

productname

字符串

用于监视 Diameter 服务器的功能交换请求 (CER) 消息的 Product-Name 值。

最小长度 = 1

query

字符串

作为监视 DNS 服务的一部分进行解析的域名（例如，example.com）。

querytype

字符串

要发送监视查询的 DNS 记录的类型。设置为 Address 以查询 A 记录，设置为 AAAA 以查询 AAAA 记录，设置为 Zone 以查询 SOA 记录。

选项

  • "Address"

  • "Zone"

  • "AAAA"

radaccountsession

字符串

要在帐户请求数据包中使用的帐户会话 ID。适用于 RADIUS_ACCOUNTING 类型的监视器。

最小长度 = 1

radaccounttype

字符串

要在帐户请求数据包中使用的帐户类型。适用于 RADIUS_ACCOUNTING 类型的监视器。

最小值 = 0

最大值 = 15

radapn

字符串

要在帐户请求数据包中使用的被叫站 ID。适用于 RADIUS_ACCOUNTING 类型的监视器。

最小长度 = 1

radframedip

字符串

数据包将发出的源 IP。适用于 RADIUS_ACCOUNTING 类型的监视器。

radkey

字符串

RADIUS 客户端和服务器交换的身份验证密钥（共享密钥文本字符串）。适用于 RADIUS 和 RADIUS_ACCOUNTING 类型的监视器。

最小长度 = 1

radmsisdn

字符串

要在帐户请求数据包中使用的呼叫站 ID。适用于 RADIUS_ACCOUNTING 类型的监视器。

最小长度 = 1

radnasid

字符串

要在访问请求数据包中发送的 NAS 标识符。适用于 RADIUS 类型的监视器。

最小长度 = 1

radnasip

字符串

监视 RADIUS 服务器时用作源 IP 地址的网络接入服务器 (NAS) IP 地址。适用于 RADIUS 和 RADIUS_ACCOUNTING 类型的监视器。

recv

字符串

服务要标记为“UP”时，预期从服务器收到的字符串。适用于 TCP-ECV、HTTP-ECV 和 UDP-ECV 监视器。

respcode

字符串

将服务标记为“正常”的响应代码。对于任何其他响应代码，执行的操作取决于监控器类型。HTTP 监控器和 RADIUS 监控器将服务标记为“故障”，而 HTTP-INLINE 监控器则执行 Action 参数指示的操作。

resptimeout

字符串

设备在将探测标记为“失败”之前必须等待的时间量。必须小于为 Interval 参数指定的值。

注意：对于未配置接收字符串的 UDP-ECV 监控器，响应超时不适用。对于没有接收字符串的 UDP-ECV 监控器，探测失败通过从服务接收到的 ICMP 端口不可达错误来指示。

最小值 = 1

最大值 = 20939

resptimeoutthresh

字符串

响应时间阈值，指定为“响应超时”参数的百分比。如果达到阈值时仍未收到对监控探测的响应，则设备会生成一个名为 monRespTimeoutAboveThresh 的 SNMP 陷阱。响应时间恢复到低于阈值的值后，设备会生成一个 monRespTimeoutBelowThresh SNMP 陷阱。要生成陷阱，还必须启用“MONITOR-RTO-THRESHOLD”警报。

最小值 = 0

最大值 = 100

retries

字符串

为确定监控探测失败的服务的状态而发送的最大探测次数。

最小值 = 1

最大值 = 127

reverse

布尔值

当满足探测条件时将服务标记为“故障”，而不是“正常”，当不满足探测条件时则标记为“正常”，而不是“故障”。

选项

  • false

  • true

rtsprequest

字符串

要发送到服务器的 RTSP 请求（例如，"OPTIONS *"）。

save_config

布尔值

如果为 yes，则模块会在 netscaler 节点上保存配置（如果进行了任何更改）。

如果模块没有进行任何更改，则不会在 netscaler 节点上保存配置。

选项

  • false

  • true ← (默认)

scriptargs

字符串

脚本的参数字符串。该字符串按原样复制到请求中。

scriptname

字符串

要执行的脚本的路径和名称。该脚本必须在 NetScaler 设备上可用，位于 /nsconfig/monitors/ 目录中。

最小长度 = 1

secondarypassword

字符串

用户可能必须提供的辅助密码才能登录到 Access Gateway 服务器。适用于 CITRIX-AG 监控器。

secure

布尔值

在监控服务时使用安全的 SSL 连接。仅适用于基于 TCP 的监控器。secure 选项不能与 CITRIX-AG 监控器一起使用，因为 CITRIX-AG 监控器默认使用安全连接。

选项

  • false

  • true

send

字符串

要发送到服务的字符串。适用于 TCP-ECV、HTTP-ECV 和 UDP-ECV 监控器。

sipmethod

字符串

用于查询的 SIP 方法。仅适用于类型为 SIP-UDP 的监控器。

选项

  • "OPTIONS"

  • "INVITE"

  • "REGISTER"

sipreguri

字符串

要注册的 SIP 用户。仅当监控器类型为 SIP-UDP 且 SIP 方法参数设置为 REGISTER 时才适用。

最小长度 = 1

sipuri

字符串

要发送到服务的 SIP URI 字符串（例如，sip:sip.test）。仅适用于类型为 SIP-UDP 的监控器。

最小长度 = 1

sitepath

字符串

登录页面的 URL。对于类型为 CITRIX-WEB-INTERFACE 的监控器，要监控站点路径下的动态页面，请使用斜杠 / 终止站点路径。适用于 CITRIX-WEB-INTERFACE、CITRIX-WI-EXTENDED 和 CITRIX-XDM 监控器。

最小长度 = 1

snmpcommunity

字符串

SNMP 监控器的团体名称。

最小长度 = 1

Snmpoid

字符串

SNMP 监控器的 SNMP OID。

最小长度 = 1

snmpthreshold

字符串

SNMP 监控器的阈值。

最小长度 = 1

snmpversion

字符串

用于 SNMP 监控器的 SNMP 版本。

选项

  • "V1"

  • "V2"

sqlquery

字符串

MYSQL-ECV 或 MSSQL-ECV 监控器的 SQL 查询。在服务器验证连接后发送到数据库服务器。

最小长度 = 1

state

字符串

监控器的状态。disabled 设置不仅会禁用正在配置的监控器，还会禁用所有相同类型的监控器，直到参数设置为 enabled。如果监控器绑定到服务，则在确定服务的状态时不会考虑监控器的状态。

选项

  • "enabled"

  • "disabled"

默认值： "present"

storedb

字符串

存储填充了对监控探测的响应的数据库列表。如果配置了 MSSQL-ECV/MYSQL-ECV 监控器，则在特定于数据库的负载均衡中使用。

选项

  • "enabled"

  • "disabled"

storefrontacctservice

布尔值

启用/禁用对帐户服务的探测。仅适用于 Store Front 监控器。对于多租户配置，用户可以跳过帐户服务。

选项

  • false

  • true

storefrontcheckbackendservices

布尔值

此选项将启用对 storefront 服务器上运行的服务的监控。通过探测在 storefront 服务器上运行并公开哪些 storefront 服务正在运行的 Windows 服务来监控 storefront 服务。

选项

  • false

  • true

storename

字符串

商店名称。对于类型为 STOREFRONT 的监控器，storename 是一个可选参数，用于定义 storefront 服务商店名称。适用于 STOREFRONT 监控器。

最小长度 = 1

successretries

字符串

将服务的状态从“故障”转换为“正常”所需的连续成功探测的次数。

最小值 = 1

最大值 = 32

supportedvendorids

字符串

用于监控 Diameter 服务器的 Capabilities-Exchange-Request (CER) 消息的 Supported-Vendor-Id 属性值对 (AVP) 列表。在监控消息中最多支持八个此类 AVP。

最小值 = 1

最大值 = 4294967295

tos

布尔值

通过在 IP TOS (6) 位中编码目标 IP 地址来探测服务。

选项

  • false

  • true

tosid

字符串

指定目标 IP 的 TOS ID。仅当设置了 TOS 参数时才适用。

最小值 = 1

最大值 = 63

transparent

布尔值

监控器绑定到透明设备，例如防火墙或路由器。透明设备的状态取决于其后服务的响应能力。如果要监控透明设备，则必须指定目标 IP 地址。通过使用透明设备的 MAC 地址将探测发送到指定的 IP 地址。

选项

  • false

  • true

trofscode

字符串

当服务器处于维护状态时预期的代码。

trofsstring

字符串

从服务器预期返回的字符串，以便将服务标记为 trofs。适用于 HTTP-ECV/TCP-ECV 监控器。

type

字符串

要创建的监控器类型。

选项

  • "PING"

  • "TCP"

  • "HTTP"

  • "TCP-ECV"

  • "HTTP-ECV"

  • "UDP-ECV"

  • "DNS"

  • "FTP"

  • "LDNS-PING"

  • "LDNS-TCP"

  • "LDNS-DNS"

  • "RADIUS"

  • "USER"

  • "HTTP-INLINE"

  • "SIP-UDP"

  • "SIP-TCP"

  • "LOAD"

  • "FTP-EXTENDED"

  • "SMTP"

  • "SNMP"

  • "NNTP"

  • "MYSQL"

  • "MYSQL-ECV"

  • "MSSQL-ECV"

  • "ORACLE-ECV"

  • "LDAP"

  • "POP3"

  • "CITRIX-XML-SERVICE"

  • "CITRIX-WEB-INTERFACE"

  • "DNS-TCP"

  • "RTSP"

  • "ARP"

  • "CITRIX-AG"

  • "CITRIX-AAC-LOGINPAGE"

  • "CITRIX-AAC-LAS"

  • "CITRIX-XD-DDC"

  • "ND6"

  • "CITRIX-WI-EXTENDED"

  • "DIAMETER"

  • "RADIUS_ACCOUNTING"

  • "STOREFRONT"

  • "APPC"

  • "SMPP"

  • "CITRIX-XNC-ECV"

  • "CITRIX-XDM"

  • "CITRIX-STA-SERVICE"

  • "CITRIX-STA-SERVICE-NHOP"

units1

字符串

“偏差”参数的计量单位。创建监控器后无法更改。

选项

  • "SEC"

  • "MSEC"

  • "MIN"

units2

字符串

“停机时间”参数的计量单位。创建监控器后无法更改。

选项

  • "SEC"

  • "MSEC"

  • "MIN"

units3

字符串

监控间隔单位。

选项

  • "SEC"

  • "MSEC"

  • "MIN"

units4

字符串

监控响应超时单位。

选项

  • "SEC"

  • "MSEC"

  • "MIN"

username

字符串

用于探测 RADIUS、NNTP、FTP、FTP-EXTENDED、MYSQL、MSSQL、POP3、CITRIX-AG、CITRIX-XD-DDC、CITRIX-WI-EXTENDED、CITRIX-XNC 或 CITRIX-XDM 服务器的用户名。

最小长度 = 1

validate_certs

布尔值

如果为 no，则不会验证 SSL 证书。这仅应在个人控制的使用自签名证书的站点上使用。

选项

  • false

  • true ← (默认)

validatecred

布尔值

验证 Xen Desktop DDC 服务器用户的凭据。适用于类型为 CITRIX-XD-DDC 的监控器。

选项

  • false

  • true

vendorid

字符串

用于监控 Diameter 服务器的 Capabilities-Exchange-Request (CER) 消息的 Vendor-Id 值。

vendorspecificacctapplicationids

字符串

用于监控 Diameter 服务器的 Vendor-Specific-Acct-Application-Id 属性值对 (AVP) 列表。监控消息中最多支持 8 个此类 AVP。指定值与 vendorSpecificVendorId 的值组合，以在 CER 监控消息中获得 Vendor-Specific-Application-Id AVP。

最小值 = 0

最大值 = 4294967295

vendorspecificauthapplicationids

字符串

用于监控 Diameter 服务器的 Capabilities-Exchange-Request (CER) 消息的 Vendor-Specific-Auth-Application-Id 属性值对 (AVP) 列表。监控消息中最多支持 8 个此类 AVP。指定值与 vendorSpecificVendorId 的值组合，以在 CER 监控消息中获得 Vendor-Specific-Application-Id AVP。

最小值 = 0

最大值 = 4294967295

vendorspecificvendorid

字符串

在监控 CER 消息的 Vendor-Specific-Application-Id 分组属性值对 (AVP) 中使用的 Vendor-Id。要在 Vendor-Specific-Application-Id 中指定 Auth-Application-Id 或 Acct-Application-Id，请分别使用 vendorSpecificAuthApplicationIds 或 vendorSpecificAcctApplicationIds。在 CER 监控消息中，所有 Vendor-Specific-Application-Id AVP 仅支持一个 Vendor-Id。

最小值 = 1

注释

注意

示例

- name: Set lb monitor
  local_action:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot
    validate_certs: false


    module: netscaler_lb_monitor
    state: present

    monitorname: monitor_1
    type: HTTP-INLINE
    action: DOWN
    respcode: ['400']

返回值

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

键

描述

差异

字典

实际配置的对象与模块中指定的配置之间的差异列表

返回： 失败

示例： {"targetlbvserver": "difference. ours: (str) server1 other: (str) server2"}

日志行

列表 / 元素=字符串

模块记录的消息列表

返回： 始终

示例： ["message 1", "message 2"]

消息

字符串

详细说明失败原因的消息

返回： 失败

示例： "操作不存在"

状态

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

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

作者

  • George Nikolopoulos (@giorgos-nikolopoulos)