f5networks.f5_modules.bigip_node 模块 – 管理 F5 BIG-IP LTM 节点

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

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

要安装它，请使用：ansible-galaxy collection install f5networks.f5_modules。

要在剧本中使用它，请指定：f5networks.f5_modules.bigip_node。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 F5 BIG-IP LTM 节点。

参数

参数	注释
address 别名：ip, host 字符串	节点的 IP 地址。可以是 IPv4 或 IPv6。创建新节点时，必须提供 address 或 fqdn 之一。此参数设置后无法更新。
availability_requirements 字典	如果您激活了多个健康检查器，则指定必须接收成功响应的健康检查器的数量，才能将链接视为可用。
at_least 整数	指定在将链接视为已启动之前，必须成功的活动健康检查器的最小数量。 此参数仅在使用 type 为 at_least 时才相关。 如果使用 all 类型，则会忽略此参数。
type 字符串 / 必需	指定 monitors 的健康检查规则类型。 创建新的池时，如果未指定此值，则将使用默认值“all”。 选项 "all" "at_least"
connection_limit 整数	节点连接限制。将其设置为 0 将禁用限制。
description 字符串	指定标识节点的描述性文本。 您可以通过指定空字符串或特殊值 none 来删除描述。
dynamic_ratio 整数	节点的动态比率数字。用于动态比率负载均衡。 创建新节点时，如果未指定此参数，则将使用默认值 1。
fqdn 别名：hostname 字符串	节点的 FQDN 名称。可以是任何有效的 RFC 1123 DNS 名称。因此，唯一可用的字符是“A”到“Z”，“a”到“z”，“0”到“9”，连字符（“-”）和句点（“.”）。 FQDN 名称必须包含至少一个句点；将主机与域区分开来。例如，host.domain。 FQDN 名称必须以字母或数字结尾。 创建新节点时，必须提供 address 或 fqdn 之一。此参数设置后无法更新。
fqdn_address_type 字符串	指定节点的 FQDN 解析为 IPv4 地址还是 IPv6 地址。 创建新节点时，如果未指定此参数且指定了 fqdn，则此参数将默认为 ipv4。 此参数设置后无法更改。 选项 "ipv4" "ipv6" "all"
fqdn_auto_populate 布尔值	指定系统是否使用为由 FQDN 定义的节点的 DNS 查询返回的 IP 地址自动创建临时节点。 当为 true 时，系统会为响应 FQDN 的 DNS 查询而返回的每个 IP 地址生成一个临时节点。此外，当 DNS 响应指示临时节点的 IP 地址不再存在时，系统会删除该临时节点。 当为 false 时，系统会使用与 FQDN 关联的单个 IP 地址解析 FQDN 的 DNS 查询。 创建新节点时，如果未指定此参数且指定了 fqdn，则此参数默认为 true。 此参数设置后无法更改。 选项 false true
fqdn_down_interval 整数	指定 DNS 服务器关闭时查询发生的间隔。只要 DNS 服务器关闭，关联的监视器就会继续轮询。 创建新节点时，如果未指定此参数且指定了 fqdn，则此参数将默认为 5。
fqdn_up_interval 字符串	指定 DNS 服务器启动时查询发生的间隔。关联的监视器会尝试探测三次，如果在三倍于间隔值（以秒为单位）的时间内没有响应，则会将服务器标记为关闭。 此参数接受 ttl 值进行查询，基于 FQDN 的 TTL。默认 TTL 间隔类似于指定 3600。 创建新节点时，如果未指定此参数且指定了 fqdn，则此参数将默认为 3600。
monitors 列表 / 元素=字符串	指定系统当前用于监视此节点的健康检查器。
名称 字符串 / 必需	指定节点的名称。
分区 字符串	用于管理资源的设备分区。 默认值： "Common"
提供程序 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
身份验证提供程序 字符串	配置身份验证提供程序，以从远程设备获取身份验证令牌。 此选项在使用 BIG-IQ 设备时非常有用。
no_f5_teem 布尔值	如果 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已弃用，因为其名称令人困惑。 选项 false ← (默认) true
密码 别名：pass、pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
服务器 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
服务器端口 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值： 443
超时 整数	指定与网络设备通信的超时时间（秒），用于连接或发送命令。如果在操作完成之前超时，模块将出错。
传输 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
用户 字符串 / 必需	连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理员权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
验证证书 布尔值	如果 no，则不验证 SSL 证书。仅在使用自签名证书的个人控制站点上使用此选项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
速率限制 整数	节点速率限制（每秒连接数）。将其设置为 0 将禁用限制。
比率 整数	节点比率权重。有效值范围为 1 到 100。 创建新节点时，如果未指定此参数，则将使用默认值 1。
状态 字符串	指定节点的当前状态。enabled（允许所有流量）指定系统无论节点的状态如何都将流量发送到此节点。disabled（仅允许持久连接或活动连接）指定节点只能处理持久连接或活动连接。offline（仅允许活动连接）指定节点只能处理活动连接。在所有情况下（absent 除外），如果节点尚不存在，则将创建该节点。 对于无法解析 FQDN 的节点，更改其状态时要格外小心。这些情况会禁用您将其 state 更改为 disabled 或 offline 的能力。它们将保持在 *不可用 - 已启用* 状态。 选项 "present" ← (默认) "absent" "enabled" "disabled" "offline"

备注

注意

• 有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。

• 需要 BIG-IP 软件版本 >= 12。

• F5 模块仅操作 F5 产品的运行配置。为确保 BIG-IP 特定的配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参阅模块的文档，了解保存运行配置的模块的正确用法。

示例

- name: Add node
  bigip_node:
    host: 10.20.30.40
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add node with a single 'ping' monitor
  bigip_node:
    host: 10.20.30.40
    name: mytestserver
    monitors:
      - /Common/icmp
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Modify node description
  bigip_node:
    name: 10.20.30.40
    description: Our best server yet
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Delete node
  bigip_node:
    state: absent
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Force node offline
  bigip_node:
    state: disabled
    name: 10.20.30.40
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

- name: Add node by their FQDN
  bigip_node:
    fqdn: foo.bar.com
    name: foobar.net
    provider:
      server: lb.mydomain.com
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
description 字符串	节点描述的已更改值。 返回：changed 和 success 示例： "E-Commerce webserver in ORD"
monitors 列表 / 元素=字符串	节点监视器的已更改列表。 返回：changed 和 success 示例： ["icmp", "tcp_echo"]
会话 字符串	节点内部会话的已更改值。 返回：changed 和 success 示例： "user-disabled"
状态 字符串	节点内部状态的已更改值。 返回：changed 和 success 示例： "user-down"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

收藏链接

• 问题跟踪器
• 主页
• 代码库（源代码）