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 字符串	配置授权提供程序以从远程设备获取身份验证令牌。 此选项主要用于处理 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 Networks 设备的更多信息，请参阅 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 字符串	标识路由的描述性文本。 返回: changed 示例: "Route tho DMZ"
destination 字符串	路由表中静态条目的 IP 地址。 返回: changed 示例: "0.0.0.0/0"
gateway_address 字符串	系统将数据包转发到目标主机或网络时使用的路由器。 返回: changed 示例: "10.2.2.3"
netmask 字符串	目标的网络掩码。 返回: changed 示例: "255.255.255.255"
partition 字符串	创建静态路由的分区。 返回: changed 示例: "Common"
pool 字符串	是否启用了横幅。 返回: changed 示例: "True"
reject 布尔值	指定系统丢弃发送到目标的数据包。 返回: changed 示例: true
route_domain 整数	系统的路由域 ID。 返回: changed 示例: 1
vlan 字符串	系统将数据包转发到目标时所使用的 VLAN 或隧道。 返回: changed 示例: "/Common/vlan1"

作者

• Tim Rupp (@caphrim007)

集合链接

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