f5networks.f5_modules.bigip_static_route 模块 – 在 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_static_route。

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 在 BIG-IP 系统上操作静态路由。

参数

参数	注释
description 字符串	标识路由的描述性文本。
destination 字符串	指定路由表中静态条目的 IP 地址。创建新的静态路由时，此值是必需的。 此值一旦设置就不能更改。
gateway_address 字符串	指定系统在将数据包转发到目标主机或网络时使用的路由器。也称为下一跳路由器地址。这可以是 IPv4 或 IPv6 地址。当它是一个以 FE80: 开头的 IPv6 地址时，该地址被视为链路本地地址。这需要同时提供 vlan 参数。
mtu 字符串	指定特定的最大传输单元 (MTU)。
name 字符串 / 必需	静态路由的名称。
netmask 字符串	静态路由的网络掩码。创建新的静态路由时，此值是必需的。 此值可以是 IP 或 CIDR 格式。 此值一旦设置就不能更改。
partition 字符串	用于管理资源的设备分区。 默认值： "Common"
pool 字符串	指定系统通过其将数据包转发到目标的池。
provider 字典 f5networks.f5_modules 1.0.0 中新增	包含连接详细信息的字典对象。
auth_provider 字符串	配置 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 ← (默认)
reject 布尔值	指定系统丢弃发送到目标的数据包。 选项 false true
route_domain 整数	系统的路由域 ID。创建新的静态路由时，如果未指定此值，则默认值为 0。 此值一旦设置就不能更改。
state 字符串	当 present 时，确保静态路由存在。 当 absent 时，确保静态路由不存在。 选项 "present" ← (默认) "absent"
vlan 字符串	指定系统通过其将数据包转发到目标的 VLAN 或隧道。当 gateway_address 是链路本地 IPv6 地址时，此值是必需的。

注释

注意

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

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

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

示例

- name: Create static route with gateway address
  bigip_static_route:
    destination: 10.10.10.10
    netmask: 255.255.255.255
    gateway_address: 10.2.2.3
    name: test-route
    provider:
      password: secret
      server: lb.mydomain.come
      user: admin
      validate_certs: false
  delegate_to: localhost

返回值

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

键	描述
description 字符串	标识路由的描述性文本。 返回：已更改 示例： "Route tho DMZ"
destination 字符串	路由表中静态条目对应的IP地址。 返回：已更改 示例： "0.0.0.0/0"
gateway_address 字符串	系统转发数据包到目标主机或网络时使用的路由器。 返回：已更改 示例： "10.2.2.3"
netmask 字符串	目的地的网络掩码。 返回：已更改 示例： "255.255.255.255"
partition 字符串	创建静态路由的分区。 返回：已更改 示例： "Common"
pool 字符串	横幅是否启用。 返回：已更改 示例： "True"
reject 布尔值	指定系统丢弃发送到目标的数据包。 返回：已更改 示例： true
route_domain 整数	系统的路由域 ID。 返回：已更改 示例： 1
vlan 字符串	系统转发数据包到目的地的 VLAN 或隧道。 返回：已更改 示例： "/Common/vlan1"

作者

• Tim Rupp (@caphrim007)

资源链接

• 问题追踪器
• 主页
• 代码仓库