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) 列表。一条监控消息最多支持八个此类 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 消息最多支持八个此类 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

调度程序IP

字符串

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

调度程序端口

字符串

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

域

字符串

存在XenDesktop桌面交付控制器(DDC)服务器或Web界面服务器的域。CITRIX-XD-DDC和CITRIX-WI-EXTENDED监控程序分别需要此域才能登录到DDC服务器和Web界面服务器。

停机时间

字符串

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

最小值 = 1

最大值 = 20939

评估规则

字符串

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

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

失败重试次数

字符串

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

最小值 = 0

最大值 = 32

文件名

字符串

FTP服务器上的文件名。设备通过定期检查服务器上文件的存在来监控FTP服务。适用于FTP-EXTENDED监控程序。

最小长度 = 1

过滤器

字符串

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

最小长度 = 1

固件版本

字符串

用于监控Diameter服务器的“功能交换请求”(CER)消息的固件版本值。

组

字符串

要监控的NNTP服务上可用的新闻组的名称。设备会定期生成NNTP查询以获取新闻组的名称并评估响应。如果在服务器上找到新闻组，则服务标记为UP。如果新闻组不存在或搜索失败，则服务标记为DOWN。适用于NNTP监控程序。

最小长度 = 1

主机IP地址

字符串

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

最小长度 = 1

主机名

字符串

FQDN格式的主机名（例如：porche.cars.org）。适用于STOREFRONT监控程序。

最小长度 = 1

HTTP请求

字符串

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

内带安全ID

字符串

用于监控Diameter服务器的“功能交换请求”(CER)消息的内带安全ID。

选项

  • “NO_INBAND_SECURITY”

  • “TLS”

间隔

字符串

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

最小值 = 1

最大值 = 20940

IP地址

字符串

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

最小长度 = 1

IP隧道

布尔值

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

选项

  • false

  • true

KCD帐户

字符串

MSSQL监控程序使用的KCD帐户。

最小长度 = 1

最大长度 = 32

LAS版本

字符串

Citrix高级访问控制登录代理的版本号。CITRIX-AAC-LAS监控程序需要此版本号。

登录点名称

字符串

为Citrix Access Gateway高级访问控制软件配置的登录点的名称。如果要监控关联的登录页面或登录代理，则需要此名称。适用于CITRIX-AAC-LAS和CITRIX-AAC-LOGINPAGE监控程序。

LRTM

字符串

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

选项

  • “已启用”

  • “已禁用”

最大转发次数

字符串

用于监控的SIP请求可以遍历以到达服务器的最大跳数。仅适用于SIP-UDP类型的监控程序。

最小值 = 0

最大值 = 255

指标表

字符串

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

最小长度 = 1

最大长度 = 99

监控程序名称

字符串

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

最小长度 = 1

MSSQL协议版本

字符串

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

选项

  • "70"

  • "2000"

  • “2000SP1”

  • "2005"

  • "2008"

  • “2008R2”

  • "2012"

  • "2014"

网络配置文件

字符串

网络配置文件的名称。

最小长度 = 1

最大长度 = 127

nitro_pass

字符串 / 必需

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

nitro_protocol

字符串

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

选项

  • "http" ← (默认)

  • “https”

nitro_timeout

浮点数

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

默认： 310.0

nitro_user

字符串 / 必需

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

NS IP

字符串 / 必需

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

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

Oracle SID

字符串

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

最小长度 = 1

源主机

字符串

用于监控Diameter服务器的“功能交换请求”(CER)消息的源主机值。

最小长度 = 1

源域

字符串

用于监控Diameter服务器的“功能交换请求”(CER)消息的源域值。

最小长度 = 1

密码

字符串

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

最小长度 = 1

产品名称

字符串

用于监控Diameter服务器的“功能交换请求”(CER)消息的产品名称值。

最小长度 = 1

查询

字符串

要解析为监控DNS服务一部分的域名（例如，example.com）。

查询类型

字符串

要为其发送监控查询的DNS记录类型。对于查询A记录，设置为Address；对于查询AAAA记录，设置为AAAA；对于查询SOA记录，设置为Zone。

选项

  • “地址”

  • “区域”

  • “AAAA”

RADIUS计费会话

字符串

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

最小长度 = 1

RADIUS计费类型

字符串

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

最小值 = 0

最大值 = 15

RADIUS接入点名称

字符串

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

最小长度 = 1

RADIUS帧IP

字符串

数据包将从中发出的源IP。适用于RADIUS_ACCOUNTING类型的监控程序。

RADIUS密钥

字符串

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

最小长度 = 1

RADIUS MSISDN

字符串

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

最小长度 = 1

RADIUS NAS ID

字符串

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

最小长度 = 1

RADIUS NAS IP

字符串

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

接收

字符串

服务器为将服务标记为UP而期望的字符串。适用于TCP-ECV、HTTP-ECV和UDP-ECV监控程序。

响应代码

字符串

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

响应超时

字符串

设备必须等待的时间量，之后它将探测标记为FAILED。必须小于为“间隔”参数指定的值。

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

最小值 = 1

最大值 = 20939

响应超时阈值

字符串

作为“响应超时”参数百分比指定的响应时间阈值。如果在达到阈值时监控探测的响应尚未到达，则设备会生成名为monRespTimeoutAboveThresh的SNMP陷阱。响应时间返回到低于阈值的值后，设备会生成monRespTimeoutBelowThresh SNMP陷阱。要生成陷阱，“MONITOR-RTO-THRESHOLD”警报也必须启用。

最小值 = 0

最大值 = 100

重试次数

字符串

为监控探测失败的服务建立状态而发送的最大探测数。

最小值 = 1

最大值 = 127

反转

布尔值

当探测标准满足时，将服务标记为DOWN，而不是UP；当探测标准不满足时，将服务标记为UP，而不是DOWN。

选项

  • 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的监控。安全选项不能与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。如果监控器绑定到服务，则在确定服务状态时不会考虑监控器的状态。

选项

  • “已启用”

  • “已禁用”

默认： "present"

storedb

字符串

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

选项

  • “已启用”

  • “已禁用”

storefrontacctservice

布尔值

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

选项

  • false

  • true

storefrontcheckbackendservices

布尔值

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

选项

  • false

  • true

storename

字符串

存储名称。对于STOREFRONT类型的监控器，storename是一个可选参数，用于定义StoreFront服务存储名称。适用于STOREFRONT监控器。

最小长度 = 1

successretries

字符串

将服务的状太从DOWN转换为UP所需的连续成功探测次数。

最小值 = 1

最大值 = 32

supportedvendorids

字符串

用于监控Diameter服务器的Capabilities-Exchange-Request (CER)消息的Supported-Vendor-Id属性值对(AVP)列表。监控消息中最多支持8个此类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']

返回值

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

键

描述

diff

字典

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

返回：失败

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

loglines

列表 / 元素=字符串

模块记录的消息列表

返回：始终

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

msg

字符串

详细说明故障原因的消息

返回：失败

示例： "Action does not exist"

状态

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

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

作者

  • George Nikolopoulos (@giorgos-nikolopoulos)