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 上启用硬件同步 Cookie 模式。 当为 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。 如果使用 absent 的 state 值指定特殊 VLAN ALL，则将删除所有 VLAN。
partition 字符串	在其上管理资源的设备分区。 默认： "Common"
provider 字典 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
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 ← (默认)
sflow_poll_interval 整数	指定两次轮询之间的最大间隔时间（以秒为单位）。
sflow_sampling_rate 整数	指定观察到的数据包与生成的样本的比率。
source_check 布尔值	当为 true 时，指定系统验证初始数据包的返回路由是否与数据包始发的 VLAN 相同。 仅当 auto_last_hop 选项为 false 时，系统才会执行此验证。 选择 false true
state 字符串	系统上 VLAN 的状态。当为 present 时，保证 VLAN 存在并具有提供的属性。当为 absent 时，从系统中移除 VLAN。 选择 "absent" "present" ← (默认)
tag 整数	VLAN 的标签号。标签号可以是 1 到 4094 之间的任何整数。如果您不指定值，系统会自动分配一个标签号。
tagged_interfaces 别名: tagged_interface list / elements=string	指定要为 VLAN 配置的已标记接口和中继的列表。当您想将单个接口或中继分配给多个 VLAN 时，请使用已标记的接口或中继。 此参数与 untagged_interfaces 和 interfaces 参数互斥。
untagged_interfaces 别名: untagged_interface list / elements=string	指定要为 VLAN 配置的未标记接口和中继的列表。 此参数与 tagged_interfaces 和 interfaces 参数互斥。

注意

注意

• 需要 BIG-IP 版本 >= 12.0.0

• 有关使用 Ansible 管理 F5 Networks 设备的更多信息，请参阅 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

返回值

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

Key	描述
cmp_hash 字符串	新的流量解聚方法。 返回: changed 示例: "source-address"
dag_tunnel 字符串	新的 DAG 隧道设置。 返回: changed 示例: "outer"
description 字符串	在 VLAN 上设置的描述。 返回: changed 示例: "foo VLAN"
fail_safe 布尔值	新的故障安全设置。 返回: changed 示例: false
fail_safe_action 字符串	新的故障安全操作设置。 返回: changed 示例: "reboot"
fail_safe_timeout 整数	新的故障安全超时设置。 返回: changed 示例: 90
hw_syn_cookie 布尔值	在 VLAN 上启用硬件同步 Cookie 模式。 返回: changed 示例: false
interfaces list / elements=string	VLAN 分配到的接口。 返回: changed 示例: ["1.1", "1.2"]
partition 字符串	创建 VLAN 的分区。 返回: changed 示例: "Common"
sflow_poll_interval 整数	新的 sFlow 轮询间隔设置。 返回: changed 示例: 10
sflow_sampling_rate 整数	新的 sFlow 采样率设置。 返回: changed 示例: 20
source_check 布尔值	新的源检查设置。 返回: changed 示例: true
tag 整数	VLAN 的 ID。 返回: changed 示例: 2345

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

集合链接

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