f5networks.f5_modules.bigip_management_route 模块 – 管理 BIG-IP 上的系统管理路由

注意

此模块是 f5networks.f5_modules 集合 (版本 1.32.1) 的一部分。

如果您使用的是 ansible 包，则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用： ansible-galaxy collection install f5networks.f5_modules。

要在剧本中使用它，请指定： f5networks.f5_modules.bigip_management_route。

f5networks.f5_modules 1.0.0 中的新增功能

概要 

配置 BIG-IP 管理接口的路由设置。

参数 

参数	注释
description 字符串	管理路由的描述。
gateway 字符串	指定系统通过指定 IP 地址的网关将数据包转发到目标。
name 字符串 / 必需	指定管理路由的名称。
network 字符串	路由的子网和掩码。要指定路由是系统的默认路由，请提供值 `default`。只允许一个 `default` 条目。设置此参数后无法更改。因此，如果您确实需要更改它，则必须将其删除并创建一个新的路由。
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` ← (默认)
state 字符串	当为 `present` 时，确保资源存在。当为 `absent` 时，确保资源被移除。选项 `"present"` ← (默认) `"absent"`

备注 

注意

有关使用 Ansible 管理 F5 网络设备的更多信息，请参见 https://ansible.org.cn/integrations/networks/f5。
需要 BIG-IP 软件版本 >= 12。
F5 模块只操作 F5 产品的运行配置。为确保 BIG-IP 特定配置持久保存到磁盘，请务必包含至少一项使用 f5networks.f5_modules.bigip_config 模块保存运行配置的任务。请参考模块的文档，了解如何正确使用该模块保存您的运行配置。

示例 

- name: Create a management route
  bigip_management_route:
    name: tacacs
    description: Route to TACACS
    gateway: 10.10.10.10
    network: 11.11.11.0/24
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

返回值 

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

键	描述
description 字符串	管理路由的新描述。返回：已更改示例： `"Route to TACACS"`
gateway 字符串	管理路由的新网关。返回：已更改示例： `"10.10.10.10"`
network 字符串	用于管理路由的新网络。返回：已更改示例： `"default"`

作者

Tim Rupp (@caphrim007)
Wojciech Wypior (@wojtek0806)