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 string	管理路由的描述。
gateway string	指定系统通过指定的 IP 地址将数据包转发到网关。
name string / 必填	指定管理路由的名称。
network string	路由的子网和网络掩码。要指定该路由是系统的默认路由，请提供值 `default`。只允许一个 `default` 条目。设置后无法更改此参数。因此，如果您确实需要更改它，则必须删除它并创建一个新路由。
partition string	设备分区，用于管理资源。默认值： `"Common"`
provider dictionary 在 f5networks.f5_modules 1.0.0 中添加	包含连接详细信息的字典对象。
auth_provider string	配置身份验证提供程序，以从远程设备获取身份验证令牌。此选项实际上是在使用 BIG-IQ 设备时使用。
no_f5_teem boolean	如果 `yes`，则 TEEM 遥测数据不会发送到 F5。您可以通过设置环境变量 `F5_TELEMETRY_OFF` 来省略此选项。先前使用的变量 `F5_TEEM` 已弃用，因为它的名称令人困惑。选项 `false` ← (默认) `true`
password 别名：pass, pwd string / 必填	用于连接到 BIG-IP 或 BIG-IQ 的用户帐户的密码。您可以通过设置环境变量 `F5_PASSWORD` 来省略此选项。
server string / 必填	BIG-IP 主机或 BIG-IQ 主机。您可以通过设置环境变量 `F5_SERVER` 来省略此选项。
server_port integer	BIG-IP 服务器端口。您可以通过设置环境变量 `F5_SERVER_PORT` 来省略此选项。默认值： `443`
timeout integer	指定与网络设备通信的超时时间（以秒为单位），用于连接或发送命令。如果在操作完成之前超出超时时间，则模块将出错。
transport string	配置连接到远程设备时要使用的传输连接。选项 `"rest"` ← (默认)
user string / 必填	用于连接到 BIG-IP 或 BIG-IQ 的用户名。此用户必须具有设备上的管理权限。您可以通过设置环境变量 `F5_USER` 来省略此选项。
validate_certs boolean	如果 `no`，则不验证 SSL 证书。仅在个人控制的使用自签名证书的站点上使用此选项。您可以通过设置环境变量 `F5_VALIDATE_CERTS` 来省略此选项。选项 `false` `true` ← (默认)
state string	当 `present` 时，确保资源存在。当 `absent` 时，确保删除资源。选项 `"present"` ← (默认) `"absent"（不存在）`

说明 

注意

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

返回值 

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

Key (键)	描述
description string	管理路由的新描述。 Returned: changed (已更改) 示例: `"Route to TACACS"`
gateway string	管理路由的新网关。 Returned: changed (已更改) 示例: `"10.10.10.10"`
network string	管理路由要使用的新网络。 Returned: changed (已更改) 示例: `"default"`

作者

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