community.network.netscaler_service 模块 – 在 Netscaler 中管理服务配置

注意

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

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

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

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

注意

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

已弃用 

在以下版本中移除:: 版本 6.0.0
原因:: 此集合及其中的所有内容均未维护且已弃用。
替代方案:: 未知。

概要 

在 Netscaler 中管理服务配置。
此模块允许创建、删除和修改 Netscaler 服务。
此模块旨在 Ansible 控制节点或堡垒机（跳板服务器）上运行，并有权访问实际的 Netscaler 实例。
此模块支持检查模式。

别名：network.netscaler.netscaler_service

要求 

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

nitro python sdk

参数 

参数	注释
accessdown 布尔值	如果服务标记为 DOWN，则使用第 2 层模式来桥接发送到此服务的包。如果服务为 DOWN，并且禁用此参数，则会丢弃数据包。选项 `false` ←（默认） `true`
appflowlog 字符串	启用 AppFlow 信息记录。选项 `"enabled"` `"disabled"`
cacheable 布尔值	使用透明缓存重定向虚拟服务器将请求转发到缓存服务器。注意：如果设置了“缓存类型”参数，请勿指定此参数。选项 `false` ←（默认） `true`
cachetype 字符串	缓存服务器支持的缓存类型。选项 `"TRANSPARENT"` `"REVERSE"` `"FORWARD"`
cip 字符串	在将请求转发到服务之前，插入一个 HTTP 标头，其值为客户端的 IPv4 或 IPv6 地址。如果服务器需要客户端的 IP 地址用于安全、记帐或其他目的，并且设置“使用源 IP”参数不是可行的选择，则使用此参数。选项 `"enabled"` `"disabled"`
cipheader 字符串	HTTP 标头的名称，其值必须设置为客户端的 IP 地址。与“客户端 IP”参数一起使用。如果设置了“客户端 IP”参数，并且未指定标头的名称，则设备将使用为全局“客户端 IP 标头”参数指定的标头名称（set ns param CLI 命令中的 cipHeader 参数或“系统”>“设置”>“更改 HTTP 参数”对话框中的“客户端 IP 标头”参数）。如果未指定全局“客户端 IP 标头”参数，则设备会插入一个名称为“client-ip”的标头。最小长度 = 1
cka 布尔值	为服务启用客户端保持活动状态。选项 `false` `true`
cleartextport 字符串	设备解密传入 SSL 流量后必须将明文数据发送到的端口。适用于透明 SSL 服务。最小值 = 1
clttimeout 字符串	终止空闲客户端连接的时间（以秒为单位）。最小值 = 0 最大值 = 31536000
cmp 布尔值	为服务启用压缩。选项 `false` `true`
comment 字符串	有关服务的任何信息。
customserverid 字符串	服务的唯一标识符。当虚拟服务器的持久性类型设置为“自定义服务器 ID”时使用。默认值： `"None"`
disabled 布尔值	当设置为 `yes` 时，服务状态将被设置为 DISABLED（禁用）。当设置为 `no` 时，服务状态将被设置为 ENABLED（启用）。请注意，由于底层 NITRO API 的限制，仅 `disabled` 状态的更改不会导致模块结果报告状态已更改。选项 `false` ←（默认） `true`
dnsprofilename 字符串	要与服务关联的 DNS 配置文件的名称。 DNS 配置文件属性将应用于服务处理的事务。此参数仅对 ADNS 和 ADNS-TCP 服务有效。最小长度 = 1 最大长度 = 127
downstateflush 字符串	刷新与状态从 UP（启动）转换为 DOWN（关闭）的服务关联的所有活动事务。对于必须完成其事务的应用程序，请勿启用此选项。选项 `"enabled"` `"disabled"`
graceful 布尔值	平稳关闭，不接受任何新连接，并在所有连接关闭后禁用服务。选项 `false` ←（默认） `true`
hashid 字符串	一个数字标识符，可以被基于哈希的负载均衡方法使用。对于每个服务必须是唯一的。最小值 = 1
healthmonitor 布尔值	监控此服务的健康状况选项 `false` `true` ← (默认)
httpprofilename 字符串	包含服务 HTTP 配置设置的 HTTP 配置文件的名称。最小长度 = 1 最大长度 = 127
ip 字符串	要分配给服务的 IP。最小长度 = 1
ipaddress 字符串	服务的新 IP 地址。
maxbandwidth 字符串	分配给服务的最大带宽，单位为 Kbps。最小值 = 0 最大值 = 4294967287
maxclient 字符串	与服务同时打开的最大连接数。最小值 = 0 最大值 = 4294967294
maxreq 字符串	可以在与服务的持久连接上发送的最大请求数。注意：超出此值的连接请求将被拒绝。最小值 = 0 最大值 = 65535
monitor_bindings 字符串	要绑定到此服务的负载均衡监视器列表。每个监视器条目都是一个字典，其中可能包含以下选项。请注意，如果不使用内置监视器，则必须先进行设置。
dup_state 字符串	监视器的状态。给定类型的监视器的状态设置会影响该类型的所有监视器。例如，如果启用了 HTTP 监视器，则设备上的所有 HTTP 监视器都将（或保持）启用状态。如果禁用了 HTTP 监视器，则设备上的所有 HTTP 监视器都将被禁用。选项 `"enabled"` `"disabled"`
dup_weight 字符串	分配给监视器和服务之间绑定的权重。
monitorname 字符串	监视器的名称。
weight 字符串	分配给监视器和服务之间绑定的权重。
monthreshold 字符串	绑定到此服务的监视器的最小权重总和。用于确定是否将服务标记为 UP（启动）或 DOWN（关闭）。最小值 = 0 最大值 = 65535
name 字符串	服务的名称。必须以 ASCII 字母或下划线 `_` 字符开头，并且只能包含 ASCII 字母数字、下划线 `_`、井号 `#`、句点 `.`、空格、冒号 `:`、at `@`、等于号 `=` 和连字符 `-` 字符。服务创建后无法更改。最小长度 = 1
netprofile 字符串	用于服务的网络配置文件。最小长度 = 1 最大长度 = 127
nitro_pass string / required	用于向 netscaler 节点进行身份验证的密码。
nitro_protocol 字符串	访问 nitro API 对象时要使用的协议。选项 `"http"` ← (默认) `"https"`
nitro_timeout float	与 Netscaler 建立新会话时，抛出超时错误之前的秒数默认值: `310.0`
nitro_user string / required	用于向 netscaler 节点进行身份验证的用户名。
nsip string / required	将进行 nitro API 调用的 netscaler 设备的 IP 地址。可以使用冒号 (:) 指定端口。例如：192.168.1.1:555。
pathmonitor 字符串	用于集群的路径监控。
pathmonitorindv 字符串	单独的路径监控决策。
port 字符串	服务的端口号。范围 1 - 65535 * 在 CLI 中，在 NITRO API 中表示为 65535
processlocal 字符串	通过启用此选项，发往集群中服务的包将不会进行任何转向。对于单包请求响应模式或上游设备正在为基于连接的分配执行适当的 RSS 时，请启用此选项。选项 `"enabled"` `"disabled"`
rtspsessionidremap 布尔值	为服务启用 RTSP 会话 ID 映射。选项 `false` ←（默认） `true`
save_config 布尔值	如果为 `yes`，如果模块进行了任何更改，则该模块将在 netscaler 节点上保存配置。如果模块没有进行任何更改，则该模块不会在 netscaler 节点上保存配置。选项 `false` `true` ← (默认)
serverid 字符串	服务的标识符。当持久性类型设置为“自定义服务器 ID”时使用。
servername 字符串	托管服务的服务器名称。最小长度 = 1
servicetype 字符串	与服务交换数据的协议。选项 `"HTTP"` `"FTP"` `"TCP"` `"UDP"` `"SSL"` `"SSL_BRIDGE"` `"SSL_TCP"` `"DTLS"` `"NNTP"` `"RPCSVR"` `"DNS"` `"ADNS"` `"SNMP"` `"RTSP"` `"DHCPRA"` `"ANY"` `"SIP_UDP"` `"SIP_TCP"` `"SIP_SSL"` `"DNS_TCP"` `"ADNS_TCP"` `"MYSQL"` `"MSSQL"` `"ORACLE"` `"RADIUS"` `"RADIUSListener"` `"RDP"` `"DIAMETER"` `"SSL_DIAMETER"` `"TFTP"` `"SMPP"` `"PPTP"` `"GRE"` `"SYSLOGTCP"` `"SYSLOGUDP"` `"FIX"` `"SSL_FIX"`
sp 布尔值	为服务启用突发保护。选项 `false` `true`
state 字符串	模块在 netscaler 节点上配置的资源的状态。如果存在，则将根据模块的参数创建并配置资源（如果需要）。如果不存在，则将从 netscaler 节点删除资源。选项 `"absent" （不存在）` `"present"` ← (默认)
svrtimeout 字符串	终止空闲服务器连接的时间（以秒为单位）。最小值 = 0 最大值 = 31536000
tcpb 布尔值	为服务启用 TCP 缓冲。选项 `false` `true`
tcpprofilename 字符串	包含服务 TCP 配置设置的 TCP 配置文件的名称。最小长度 = 1 最大长度 = 127
td 字符串	一个整数值，用于唯一标识要在其中配置实体的流量域。如果不指定 ID，则实体将成为默认流量域的一部分，其 ID 为 0。最小值 = 0 最大值 = 4094
useproxyport 布尔值	使用代理端口作为与服务器建立连接时的源端口。如果设置为 NO，则客户端连接端口将用作服务器端连接的源端口。注意：此参数仅当“使用源 IP (USIP)”参数设置为 YES 时可用。选项 `false` `true`
usip 布尔值	在启动与服务器的连接时，使用客户端的 IP 地址作为源 IP 地址。创建服务时，如果不设置此参数，则服务将继承全局“使用源 IP”设置（可在“启用 ns 模式”和“禁用 ns 模式”CLI 命令或“系统”>“设置”>“配置模式”>“配置模式”对话框中找到）。但是，您可以在创建服务后覆盖此设置。选项 `false` `true`
validate_certs 布尔值	如果为 `no`，则不会验证 SSL 证书。这应该仅在个人控制的使用自签名证书的站点上使用。选项 `false` `true` ← (默认)

备注 

注意

有关使用 Ansible 管理 Citrix NetScaler 网络设备的更多信息，请参阅 https://ansible.org.cn/ansible-netscaler。

示例 

# Monitor monitor-1 must have been already setup

- name: Setup http service
  gather_facts: false
  delegate_to: localhost
  community.network.netscaler_service:
    nsip: 172.18.0.2
    nitro_user: nsroot
    nitro_pass: nsroot

    state: present

    name: service-http-1
    servicetype: HTTP
    ipaddress: 10.78.0.1
    port: 80

    monitor_bindings:
      - monitor-1

返回值 

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

Key（键）	描述
diff（差异） dictionary（字典）	一个字典，其中包含实际配置的对象与模块中指定的配置之间的差异列表返回: 失败示例: `{"clttimeout": "difference. ours: (float) 10.0 other: (float) 20.0"}`
loglines list / elements=string	模块记录的消息列表返回: 总是示例: `["['message 1'", " 'message 2']"]`

community.network.netscaler_service 模块 – 在 Netscaler 中管理服务配置

已弃用 

概要 

要求 

参数 

备注 

示例 

返回值 

状态 

作者

集合链接