f5networks.f5_modules.bigip_virtual_address 模块 – 在 BIG-IP 上管理 LTM 虚拟地址

注意

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

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

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

要在 playbook 中使用它，请指定：f5networks.f5_modules.bigip_virtual_address。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 在 BIG-IP 系统上管理 LTM 虚拟地址。

参数

参数	注释
address 字符串	指定虚拟地址。此值设置后无法修改。 如果您从未创建虚拟地址，但创建了虚拟服务器，则会自动为每个虚拟服务器创建一个虚拟地址。此虚拟地址的名称是其 IP 地址值。
arp 布尔值	指定系统是否接受 ARP 请求。 当为 false 时，指定系统不接受 ARP 请求。 当为 true 时，数据包将被丢弃。 必须禁用 ARP 和 ICMP Echo，才能使使用该虚拟地址的转发虚拟服务器转发 ICMP 数据包。 创建新虚拟地址时，如果未指定此参数，则默认值为 true。 选项 false true
auto_delete 布尔值	指定系统是否在删除最后一个关联的虚拟服务器时自动删除虚拟地址。当为 false 时，指定系统保留虚拟地址，即使所有关联的虚拟服务器都已被删除。创建虚拟地址时，默认值为 true。 选项 false true
availability_calculation 别名: advertise_route 字符串	指定系统通告虚拟地址的哪些路由。当为 when_any_available 时，当任何虚拟服务器可用时通告路由。当为 when_all_available 时，当所有虚拟服务器都可用时通告路由。当为 (always) 时，始终通告路由，无论虚拟服务器是否可用。 选项 "always" "when_all_available" "when_any_available"
connection_limit 整数	指定系统在此虚拟地址上允许的并发连接数。
icmp_echo 字符串	指定系统如何针对每个虚拟地址发送对 (ICMP) 回显请求的响应，以启用路由通告。当为 enabled 时，BIG-IP 系统会拦截 ICMP 回显请求数据包并直接响应它们。当为 disabled 时，BIG-IP 系统会将 ICMP 回显请求传递到后端服务器。当为 (selective) 时，会导致 BIG-IP 系统根据虚拟服务器状态在内部启用或禁用响应；when_any_available，when_all_available, or C(always，而不管任何虚拟服务器的状态如何。 选项 "enabled" "disabled" "selective"
name 字符串	虚拟地址的名称。 如果未提供此参数，则系统将使用 address 的值。
netmask 字符串	指定所提供虚拟地址的网络掩码。此值设置后无法修改。 创建新虚拟地址时，如果未指定此参数，则 IPv4 地址的默认值为 255.255.255.255，IPv6 地址的默认值为 ffff:ffff:ffff:ffff:ffff:ffff:ffff:ffff。
partition 字符串	用于管理资源的设备分区。 默认值: "Common"
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的 dict 对象。
auth_provider 字符串	配置身份验证提供程序以从远程设备获取身份验证令牌。 此选项在处理 BIG-IQ 设备时真正使用。
no_f5_teem 布尔值	如果为 yes，则不会将 TEEM 遥测数据发送到 F5。 您可以通过设置环境变量 F5_TELEMETRY_OFF 来省略此选项。 先前使用的变量 F5_TEEM 已被弃用，因为它名称容易引起混淆。 选项 false ← (默认) true
password 别名：pass, pwd 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。 您可以通过设置环境变量 F5_PASSWORD 来省略此选项。
server 字符串 / 必需	BIG-IP 主机或 BIG-IQ 主机。 您可以通过设置环境变量 F5_SERVER 来省略此选项。
server_port 整数	BIG-IP 服务器端口。 您可以通过设置环境变量 F5_SERVER_PORT 来省略此选项。 默认值: 443
timeout 整数	指定与网络设备通信（连接或发送命令）的超时时间（以秒为单位）。如果操作在超时之前未完成，模块将报错。
transport 字符串	配置连接到远程设备时使用的传输连接。 选项 "rest" ← (默认)
user 字符串 / 必需	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须在设备上拥有管理权限。 您可以通过设置环境变量 F5_USER 来省略此选项。
validate_certs 布尔值	如果为 no，则不验证 SSL 证书。仅在个人控制的站点上使用自签名证书时才使用此项。 您可以通过设置环境变量 F5_VALIDATE_CERTS 来省略此选项。 选项 false true ← (默认)
route_advertisement 字符串	指定系统是否为此虚拟地址使用路由通告。 禁用后，系统不会为此虚拟地址通告路由。 大多数选项仅在 13.0.0-HF1 或更高版本上受支持。在早期版本上，除了 disabled 之外的所有选择都会转换为 enabled。 当为 always 时，无论可用性状态如何，BIG-IP 系统始终会通告虚拟地址的路由。这需要一个 enabled 虚拟地址。 当为 enabled 时，BIG-IP 系统会根据可用性计算中的计算方法，通告可用虚拟地址的路由。 当为 disabled 时，无论可用性状态如何，BIG-IP 系统都不会通告虚拟地址的路由。 当为 selective 时，您还可以有选择地启用 ICMP 回显响应，这会导致 BIG-IP 系统根据虚拟服务器状态在内部启用或禁用响应。 当为 any 时，当任何虚拟服务器可用时，BIG-IP 系统会通告虚拟地址的路由。 当为 all 时，当所有虚拟服务器都可用时，BIG-IP 系统会通告虚拟地址的路由。 选项 "disabled" "enabled" "always" "selective" "any" "all"
route_domain 字符串	要使用的 address 的路由域。 设置后，此值无法修改。
spanning 布尔值	使设备组中的所有 BIG-IP 系统能够侦听并处理同一虚拟地址上的流量。 当您在设备上启用 spanning 选项，然后将虚拟地址同步到设备组的其他成员时，会发生虚拟地址的跨越。 跨越还依赖于上游路由器使用 ECMP 路由将应用程序流分发到 BIG-IP 系统。ECMP 使用在每个 BIG-IP 系统上配置的不同浮动自 IP 地址定义到虚拟地址的路由。 启用跨越时，您还必须配置 MAC 伪装地址，并禁用虚拟地址上的 arp。 创建新的虚拟地址时，如果未指定此参数，则默认值为 false。 选项 false true
state 字符串	虚拟地址状态。如果为 absent，则系统会尝试删除该虚拟地址。只有当虚拟服务器未使用此虚拟地址时，此操作才会成功。present 创建虚拟地址并启用它。如果为 enabled，则启用已存在的虚拟地址。如果为 disabled，则在需要时创建虚拟地址，并将状态设置为 disabled。 选项 "present" ← (默认) "absent" "enabled" "disabled"
traffic_group 字符串	虚拟地址的流量组。创建新地址时，如果未指定此值，则默认值为 /Common/traffic-group-1。

注释

注意

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

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

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

示例

- name: Add virtual address
  bigip_virtual_address:
    state: present
    partition: Common
    address: 10.10.10.10
    provider:
      server: lb.mydomain.net
      user: admin
      password: secret
  delegate_to: localhost

- name: Enable route advertisement on the virtual address
  bigip_virtual_address:
    state: present
    address: 10.10.10.10
    route_advertisement: any
    provider:
      server: lb.mydomain.net
      user: admin
      password: secret
  delegate_to: localhost

返回值

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

键	描述
address 整数	虚拟地址的地址。 返回: 已创建 示例: 2345
arp 布尔值	虚拟地址处理 ARP 请求的新方式。 返回: 已更改 示例: true
auto_delete 布尔值	用于自动删除虚拟地址的新设置。 返回: 已更改 示例: true
availability_calculation 字符串	指定系统通告虚拟地址的哪些路由。 返回: 已更改 示例: "always"
connection_limit 整数	虚拟地址的新连接限制。 返回: 已更改 示例: 1000
icmp_echo 字符串	应用于虚拟地址的新 ICMP 回显设置。 返回: 已更改 示例: "disabled"
netmask 整数	虚拟地址的网络掩码。 返回: 已创建 示例: 2345
spanning 字符串	是否启用跨越。 返回: 已更改 示例: "disabled"
state 字符串	虚拟地址的新状态。 返回: 已更改 示例: "disabled"

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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