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

f5networks.f5_modules 1.0.0 中的新增功能

概要

• 管理 BIG-IP 系统上的路由域。路由域是 BIG-IP 配置对象，用于隔离网络上特定应用程序的网络流量。

参数

参数	注释
bwc_policy 字符串	路由域的带宽控制器。
connection_limit 整数	路由域允许的最大并发连接数。将其设置为 0 将关闭连接限制。
description 字符串	指定标识路由域的描述性文本。
flow_eviction_policy 字符串	要与此路由域一起使用的逐出策略。应用逐出策略可为路由域上的流量溢出和慢速流量提供自定义响应。
fw_enforced_policy 字符串	指定要附加到路由域的 AFM 策略。 要删除附加的 AFM 策略，请使用 "" 或 none 作为值。
id 整数	表示路由域的唯一标识整数。 创建新的路由域时，此字段是必需的。 在 2.5 版中，在修改路由域时（例如在更新和删除操作期间），此值不再用于引用路由域。而是使用 name 参数。在 2.6 版中，name 值将成为必需参数。
name 字符串	路由域的名称。
parent 字符串	指定系统在配置的域中找不到路由时搜索的路由域。
partition 字符串	要在其上创建路由域的分区。分区创建后无法更新。 默认值： "Common"
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 ← (默认)
routing_protocol 列表 / 元素=字符串	系统要在路由域中使用的动态路由协议。 选项 "none" "BFD" "BGP" "IS-IS" "OSPFv2" "OSPFv3" "PIM" "RIP" "RIPng"
service_policy 字符串	要与路由域关联的服务策略。
state 字符串	路由域是否存在。 选项 "present" ← (默认) "absent"
strict 布尔值	指定系统是否强制执行交叉路由限制。 选项 false true
vlans 列表 / 元素=字符串	系统要在路由域中使用的 VLAN。

备注

注意

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

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

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

示例

- name: Create a route domain
  bigip_routedomain:
    name: foo
    id: 1234
    state: present
    provider:
      user: admin
      password: secret
      server: lb.mydomain.com
  delegate_to: localhost

- name: Set VLANs on the route domain
  bigip_routedomain:
    name: bar
    state: present
    vlans:
      - net1
      - foo
    provider:
      password: secret
      server: lb.mydomain.com
      user: admin
  delegate_to: localhost

返回值

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

键	描述
bwc_policy 字符串	新的带宽控制器。 返回值：changed 示例： "/Common/foo"
connection_limit 整数	路由域的新连接限制。 返回值：changed 示例： 100
description 字符串	路由域的描述。 返回值：changed 示例： "route domain foo"
flow_eviction_policy 字符串	此路由域将使用的新逐出策略。 返回值：changed 示例： "/Common/default-eviction-policy"
fw_enforced_policy 字符串	指定要附加到路由域的 AFM 策略。 返回值：changed 示例： "/Common/afm-blocking-policy"
id 整数	已更改的路由域的 ID。 返回值：changed 示例： 2
parent 整数	新的父路由域。 返回值：changed 示例： 0
routing_protocol 列表 / 元素=字符串	应用于路由域的路由协议列表。 返回值：changed 示例： ["bfd", "bgp"]
service_policy 字符串	此路由域将使用的新服务策略。 返回值：changed 示例： "/Common-my-service-policy"
strict 字符串	新的严格隔离设置。 返回值：changed 示例： "enabled"
vlans 列表 / 元素=字符串	应用路由域的新 VLAN 列表。 返回值：changed 示例： ["/Common/http-tunnel", "/Common/socks-tunnel"]

作者

• Tim Rupp (@caphrim007)

• Wojciech Wypior (@wojtek0806)

资源链接

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