community.network.netscaler_server 模块 – 管理服务器配置

注意

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

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

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

要在 playbook 中使用它,请指定:community.network.netscaler_server

注意

community.network 集合已弃用,将从 Ansible 12 中移除。有关更多信息,请参阅讨论帖

已弃用

在以下版本中移除:

版本 6.0.0

原因:

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

替代方案:

未知。

概要

  • 管理服务器实体配置。

  • 此模块旨在在 ansible 控制节点或堡垒机(跳转服务器)上运行,并且可以访问实际的 netscaler 实例。

别名:network.netscaler.netscaler_server

要求

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

  • nitro python sdk

参数

参数

注释

comment

字符串

有关服务器的任何信息。

delay

字符串

时间(以秒为单位),在此时间之后,服务器上配置的所有服务都将被禁用。

仅当将 disabled 选项设置为 true 时,此选项才有意义

disabled

布尔值

当设置为 true 时,服务器状态将设置为 disabled

当设置为 false 时,服务器状态将设置为 enabled

请注意,由于底层 NITRO API 的限制,仅 disabled 状态更改不会导致模块结果报告已更改的状态。

选项

  • false ←(默认)

  • true

domain

字符串

服务器的域名。 对于基于域的配置,您必须首先创建服务器。

最小长度 = 1

domainresolveretry

字符串

DNS 解析失败后,NetScaler 设备必须等待的时间(以秒为单位),然后发送下一个 DNS 查询以解析域名。

最小值 = 5

最大值 = 20939

默认值: 5

graceful

布尔值

平稳关闭,不接受任何新连接,并在所有连接关闭时禁用每个服务。

仅当将 disabled 选项设置为 true 时,此选项才有意义

选项

  • false

  • true

ipaddress

字符串

服务器的 IPv4 或 IPv6 地址。 如果创建基于 IP 地址的服务器,则可以在创建服务时指定服务器的名称,而不是其 IP 地址。 注意:如果未创建服务器条目,则在创建服务时输入的服务器 IP 地址将成为服务器的名称。

ipv6address

布尔值

支持 IPv6 寻址模式。 如果使用 IPv6 寻址模式配置服务器,则无法在 IPv4 寻址模式下使用该服务器。

选项

  • false ←(默认)

  • true

name

字符串

服务器的名称。

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

可以在创建名称后更改。

最小长度 = 1

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。

save_config

布尔值

如果为 yes,则如果模块进行了任何更改,它将保存 netscaler 节点上的配置。

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

选项

  • false

  • true ←(默认)

state

字符串

模块在 netscaler 节点上配置的资源的状态。

如果存在,资源将会被创建,并根据模块的参数进行配置。

如果不存在,资源将会从 Netscaler 节点中删除。

选项

  • "absent"(不存在)

  • "present" ← (默认)

td

字符串

用于唯一标识要配置实体的流量域的整数值。 如果您不指定 ID,则实体将成为默认流量域的一部分,其 ID 为 0。

最小值 = 0

最大值 = 4094

translationip

字符串

用于转换服务器 DNS 解析的 IP 地址的 IP 地址。

translationmask

字符串

转换 IP 的子网掩码。

validate_certs

布尔值

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

选项

  • false

  • true ←(默认)

说明

注意

示例

- name: Setup server
  delegate_to: localhost
  community.network.netscaler_server:
      nsip: 172.18.0.2
      nitro_user: nsroot
      nitro_pass: nsroot

      state: present

      name: server-1
      ipaddress: 192.168.1.1

返回值

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

描述

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)