f5networks.f5_modules.bigip_tunnel 模块 – 在 BIG-IP 上管理隧道

注意

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

f5networks.f5_modules 1.0.0 中的新增功能

摘要

• 管理 BIG-IP 上的隧道。隧道通常基于隧道配置文件，该配置文件定义隧道的默认参数和约束。

• 因此，此模块公开了许多可能与您正在使用的隧道类型相关或不相关的设置。在声明隧道配置时，务必考虑这一点。

• 如果特定隧道不支持您正在考虑的参数，则该参数的文档通常会提到这一点。否则，在设备上配置该参数时，设备会通知您。

参数

参数	注释
auto_last_hop 字符串	允许您基于每个隧道配置自动最后一跳。 创建新隧道时，如果隧道配置文件支持此参数但未指定，则默认为 default。 当为 default 时，表示系统使用全局自动最后一跳设置来发送回请求。 当为 enabled 时，允许系统将返回流量发送到传输请求的 MAC 地址，即使路由表指向不同的网络或接口也是如此。因此，即使没有匹配的路由，系统也可以将返回流量发送到客户端。 选项 "default" "enabled" "disabled"
description 字符串	隧道的描述。
key 整数	应用于 GRE 隧道时，此值指定 GRE 头中的可选字段，用于验证数据包的来源。 应用于 VXLAN 或 Geneve 隧道时，此值指定虚拟网络标识符 (VNI)。 应用于 NVGRE 隧道时，此值指定虚拟子网标识符 (VSID)。 创建新隧道时，如果隧道配置文件支持此参数但未指定，则默认值为 0。
local_address 字符串	指定隧道的本地端点的 IP 地址。
mode 字符串	指定隧道如何传输流量。 创建新隧道时，如果隧道配置文件支持此参数但未指定，则默认为 bidirectional。 当为 bidirectional 时，指定隧道同时传输入站和出站流量。 当为 inbound 时，指定隧道只传输入站流量。 当为 outbound 时，指定隧道只传输出站流量。 选项 "bidirectional" "inbound" "outbound"
mtu 整数	指定隧道的最大传输单元 (MTU)。 创建新隧道时，如果隧道配置文件支持此参数但未指定，则默认值为 0。 有效范围是 0 到 65515。
name 字符串 / 必填	指定隧道的名称。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
profile 字符串	指定要与隧道关联的配置文件，用于处理流量。 根据您的选择，其他设置可用或消失。 设置此参数后，可能无法更改。
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
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 ← (默认)
远程地址 (remote_address) 字符串	指定隧道远程端点的 IP 地址。 对于 dslite、fec（仅配置用于接收流量的 FEC 隧道）、v6rd（配置为边界中继）或 map，隧道必须具有未指定的远程地址（任何地址）。
辅助地址 (secondary_address) 字符串	指定隧道的非浮动 IP 地址，用于主机发起的流量。
状态 (state) 字符串	当 present 时，确保隧道存在。 当 absent 时，确保隧道被移除。 选项 "present" ← (默认) "absent"
服务类型 (tos) 字符串	指定要插入到传输数据包封装报头中的服务类型 (TOS) 值。 创建新隧道时，如果隧道配置文件支持此参数但未指定，则默认值为 preserve。 当 preserve 时，系统会将 TOS 值从内部报头复制到外部报头。 您也可以指定数值。可能的值范围为 0 到 255。
流量组 (traffic_group) 字符串	指定要与隧道关联的流量组。 此值设置后无法更改。这是 BIG-IP 的限制。
透明模式 (transparent) 布尔值	指定隧道以透明模式运行。 当 true 时，您可以检查和操作流经 BIG-IP 系统的封装流量。 透明隧道终止隧道，同时呈现隧道未经修改地传输设备的错觉（即，BIG-IP 系统看起来就像一个简单的通过设备路由 IP 流量的中间路由器）。 选项 false true
使用 PMTU (use_pmtu) 布尔值	启用或禁用隧道使用 ICMP NeedFrag 错误消息提供的 PMTU（路径 MTU）信息。 如果 true 且隧道 mtu 设置为 0，则隧道将使用 PMTU 信息。 如果 true 且隧道 mtu 固定为非零值，则隧道将使用 PMTU 和 MTU 中的较小值。 如果 false，则隧道将使用固定 MTU 或使用隧道封装配置计算其 MTU。 选项 false true

注释

注意

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

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

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

示例

- name: Create a VXLAN tunnel
  bigip_tunnel:
    name: openshift-tunnel
    local_address: 192.1681.240
    key: 0
    secondary_address: 192.168.1.100
    mtu: 0
    use_pmtu: true
    tos: preserve
    auto_last_hop: default
    traffic_group: traffic-group-1
    state: present
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
param1 布尔值	资源的新 param1 值。 返回：changed 示例： true
param2 字符串	资源的新 param2 值。 返回：changed 示例： "Foo is bar"

作者

• Tim Rupp (@caphrim007)

集合链接

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