f5networks.f5_modules.bigip_vlan 模块 – 在 BIG-IP 系统上管理 VLAN

注意

此模块是 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_vlan。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 在 BIG-IP 系统上管理 VLAN

参数

参数	注释
cmp_hash 字符串	指定如何分解 VLAN 上的流量。您选择的数值决定了流量分解方法。您可以选择根据 source-address（源 IP 地址）、destination-address（目标 IP 地址）或 default（指定默认 CMP 哈希使用 L4 端口）来分解流量。 创建新的 VLAN 时，如果未指定此参数，则默认为 default。 选项 "default" "destination-address" "source-address" "dst-ip" "src-ip" "dest" "destination" "source" "dst" "src"
dag_round_robin 布尔值	指定是否应以循环方式而不是使用静态哈希来分解 VLAN 上的一些无状态流量。无状态流量包括非 IP L2 流量、ICMP、某些 UDP 协议等等。 创建新的 VLAN 时，如果未指定此参数，则默认为 (false)。 选项 false true
dag_tunnel 字符串	指定分解器 (DAG) 如何将接收到的隧道封装数据包分配到 TMM 实例。选择 inner 以根据内部报头中的信息分配数据包。选择 outer 以根据外部报头中的信息分配数据包，而无需检查内部报头。 创建新的 VLAN 时，如果未指定此参数，则默认为 outer。 BIG-IP 的虚拟版本 (VE) 不支持此参数。 选项 "inner" "outer"
description 字符串	VLAN 的描述。
fail_safe 布尔值	当 true 时，指定如果系统检测到此 VLAN 接口上的流量丢失，则 VLAN 将采取指定的 fail_safe_action。 选项 false true
fail_safe_action 字符串	指定系统在未检测到此 VLAN 上的任何流量且 fail_safe_timeout 已过期时采取的操作。 选项 "reboot" "restart-all" "failover"
fail_safe_timeout 整数	指定系统在未检测到此 VLAN 上的网络流量之前，在采取 fail_safe_action 之前可以运行的秒数。
hw_syn_cookie 布尔值 f5networks.f5_modules 1.3.0 中添加	在 VLAN 上启用硬件 syncookie 模式。 当 true 时，当在受支持的平台上达到某个流量阈值时，会触发基于硬件的每 VLAN SYN cookie 保护。 选项 false true
interfaces 列表 / 元素=字典	要添加到 VLAN 的接口。这可以包括标记和未标记的接口，因为 tagging 参数指定。 此参数与 untagged_interfaces 和 tagged_interfaces 参数互斥。
interface 字符串	接口的名称
tagging 字符串	接口是 tagged 还是 untagged。 选项 "tagged" "untagged"
mtu 整数	指定此 VLAN 上流量的最大传输单元 (MTU)。创建新的 VLAN 时，如果未指定此参数，则使用默认值 1500。 此数字必须介于 576 到 9198 之间。
name 字符串 / 必需	要管理的 VLAN。如果使用 state 值 absent 指定特殊 VLAN ALL，则将删除所有 VLAN。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
provider 字典 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider 字符串	配置 auth 提供程序以从远程设备获取身份验证令牌。 此选项在使用 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 ← (默认)
sflow 轮询间隔 整数	指定两次轮询之间的最大间隔（秒）。
sflow 采样率 整数	指定观察到的数据包与生成的样本的比率。
源检查 布尔值	当true时，指定系统验证返回到初始数据包的路由是否与数据包发源的相同 VLAN。 仅当auto_last_hop选项为false时，系统才会执行此验证。 选项 false true
状态 字符串	系统上 VLAN 的状态。当为present时，保证 VLAN 存在且具有提供的属性。当为absent时，从系统中删除 VLAN。 选项 "absent" "present" ← (默认)
标签 整数	VLAN 的标签编号。标签编号可以是 1 到 4094 之间的任何整数。如果您没有指定值，系统会自动分配标签编号。
标记接口 别名：tagged_interface 列表 / 元素=字符串	指定要为 VLAN 配置的标记接口和中继链路的列表。当您想要将单个接口或中继链路分配给多个 VLAN 时，请使用标记接口或中继链路。 此参数与untagged_interfaces和interfaces参数互斥。
未标记接口 别名：untagged_interface 列表 / 元素=字符串	指定要为 VLAN 配置的未标记接口和中继链路的列表。 此参数与tagged_interfaces和interfaces参数互斥。

备注

注意

• 需要 BIG-IP 版本 >= 12.0.0

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

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

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

示例

- name: Create VLAN
  bigip_vlan:
    name: net1
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Set VLAN tag
  bigip_vlan:
    name: net1
    tag: 2345
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Add VLAN 2345 as tagged to interface 1.1
  bigip_vlan:
    tagged_interface: 1.1
    name: net1
    tag: 2345
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

- name: Add VLAN 1234 as tagged to interfaces 1.1 and 1.2
  bigip_vlan:
    tagged_interfaces:
      - 1.1
      - 1.2
    name: net1
    tag: 1234
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值

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

键	描述
cmp_hash 字符串	新的流量分解方法。 返回：已更改 示例："source-address"
dag_tunnel 字符串	新的 DAG 隧道设置。 返回：已更改 示例："outer"
description 字符串	在 VLAN 上设置的描述。 返回：已更改 示例："foo VLAN"
fail_safe 布尔值	新的故障安全设置。 返回：已更改 示例：false
fail_safe_action 字符串	新的故障安全操作设置。 返回：已更改 示例："reboot"
fail_safe_timeout 整数	新的故障安全超时设置。 返回：已更改 示例：90
hw_syn_cookie 布尔值	在 VLAN 上启用硬件 syncookie 模式。 返回：已更改 示例：false
interfaces 列表 / 元素=字符串	分配给 VLAN 的接口。 返回：已更改 示例：["1.1", "1.2"]
partition 字符串	创建 VLAN 的分区。 返回：已更改 示例："Common"
sflow 轮询间隔 整数	新的 sFlow 轮询间隔设置。 返回：已更改 示例：10
sflow 采样率 整数	新的 sFlow 采样率设置。 返回：已更改 示例：20
源检查 布尔值	新的源检查设置。 返回：已更改 示例：true
标签 整数	VLAN 的 ID。 返回：已更改 示例：2345

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

• 问题追踪器
• 主页
• 代码库 (源代码)