cisco.ios.ios_vrf 模块 – 配置 VRF 定义的模块。

注意

此模块是 cisco.ios 集合 (版本 9.0.3) 的一部分。

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

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

要在 playbook 中使用它，请指定： cisco.ios.ios_vrf。

cisco.ios 1.0.0 中的新增功能

概要

• 此模块提供对 Cisco IOS 设备上 VRF 定义的声明式管理。它允许 playbook 管理单个 VRF 或整个 VRF 集合。它还支持从未明确定义的配置中清除 VRF 定义。

参数

参数	注释
address_family 列表 / 元素=字典	具有要在远程 IOS 设备上配置的 MDT 参数的地址族列表。
afi 字符串	地址族标识符。 选项 "ipv4" "ipv6"
mdt 字典	MDT 参数。
auto_discovery 字典	自动发现参数。
vxlan 字典	Vxlan 参数。
enable 布尔值	启用 VXLAN。 选项 false true
inter_as 布尔值	启用跨 AS。 选项 false true
data 字典	数据选项的参数。
threshold 整数	阈值。
vxlan_mcast_group 字符串	VXLAN 多播组值。
default 字典	默认选项的参数。
vxlan_mcast_group 字符串	VXLAN 多播组值。
overlay 字典	覆盖选项的参数。
use_bgp 字典	BGP 选项的参数。
enable 布尔值	启用使用 BGP。 选项 false true
spt_only 布尔值	仅启用 SPT。 选项 false true
associated_interfaces 列表 / 元素=字符串	这是一个意图选项，它检查给定 vrf name 的关联接口的操作状态。如果 associated_interfaces 中的值与设备上 vrf 接口的操作状态不匹配，则会导致失败。
delay 整数	在检查远程设备上的操作状态之前等待的时间（秒）。 默认值： 10
description 字符串	提供当前活动配置中 VRF 定义的简短描述。VRF 定义值接受用于提供有关 VRF 的附加信息的字母数字字符。
interfaces 列表 / 元素=字符串	标识应在 VRF 中配置的接口集。接口必须是路由接口才能放入 VRF。
name 字符串	要在远程 IOS 设备上管理的 VRF 定义的名称。VRF 定义名称是用于唯一标识 VRF 的 ASCII 字符串名称。此参数与 vrfs 参数互斥
purge 布尔值	指示模块将 VRF 定义视为绝对值。它将删除设备上以前配置的任何 VRF。 选项 false ← (默认) true
rd 字符串	路由区分器值唯一地标识远程 IOS 系统上路由进程的 VRF。RD 值采用 A:B 的形式，其中 A 和 B 都是数值。
route_both 列表 / 元素=字符串	向 VRF 添加扩展路由目标社区的导出和导入列表。
route_both_ipv4 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导出和导入列表。
route_both_ipv6 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导出和导入列表。
route_export 列表 / 元素=字符串	向 VRF 添加扩展路由目标社区的导出列表。
route_export_ipv4 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导出列表。
route_export_ipv6 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导出列表。
route_import 列表 / 元素=字符串	向 VRF 添加扩展路由目标社区的导入列表。
route_import_ipv4 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导入列表。
route_import_ipv6 列表 / 元素=字符串	向 VRF 的地址族配置子模式中添加扩展路由目标社区的导入列表。
state 字符串	配置 VRF 定义的状态，因为它与设备操作配置相关。设置为 *present* 时，VRF 应配置在设备活动配置中；设置为 *absent* 时，VRF 不应在设备活动配置中。 选项 "present" ← (默认) "absent"
vrfs 列表 / 元素=任意	要在远程 IOS 设备上配置的 VRF 定义对象集。列表条目可以是 VRF 名称或 VRF 定义和属性的哈希值。此参数与 name 参数互斥。

备注

注意

• 在 CML 上针对 Cisco IOSXE 版本 17.3 进行测试。

• 此模块与连接 network_cli 配合使用。请参阅 https://docs.ansible.org.cn/ansible/latest/network/user_guide/platform_ios.html

• 有关使用 Ansible 管理网络设备的更多信息，请参阅：ref:`Ansible 网络指南 <network_guide>`

• 有关使用 Ansible 管理 Cisco 设备的更多信息，请参阅 `Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例

- name: Configure a vrf named management
  cisco.ios.ios_vrf:
    name: management
    description: oob mgmt vrf
    interfaces:
      - Management1

- name: Remove a vrf named test
  cisco.ios.ios_vrf:
    name: test
    state: absent

- name: Configure set of VRFs and purge any others
  cisco.ios.ios_vrf:
    vrfs:
      - red
      - blue
      - green
    purge: true

- name: Creates a list of import RTs for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_import
    rd: 1:100
    route_import:
      - 1:100
      - 3:100

- name:
    Creates a list of import RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_import_ipv4
    rd: 1:100
    route_import_ipv4:
      - 1:100
      - 3:100

- name:
    Creates a list of import RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_import_ipv6
    rd: 1:100
    route_import_ipv6:
      - 1:100
      - 3:100

- name: Creates a list of export RTs for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_export
    rd: 1:100
    route_export:
      - 1:100
      - 3:100

- name:
    Creates a list of export RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_export_ipv4
    rd: 1:100
    route_export_ipv4:
      - 1:100
      - 3:100

- name:
    Creates a list of export RTs in address-family configuration submode for the
    VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_export_ipv6
    rd: 1:100
    route_export_ipv6:
      - 1:100
      - 3:100

- name:
    Creates a list of import and export route targets for the VRF with the same
    parameters
  cisco.ios.ios_vrf:
    name: test_both
    rd: 1:100
    route_both:
      - 1:100
      - 3:100

- name:
    Creates a list of import and export route targets in address-family configuration
    submode for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_both_ipv4
    rd: 1:100
    route_both_ipv4:
      - 1:100
      - 3:100

- name:
    Creates a list of import and export route targets in address-family configuration
    submode for the VRF with the same parameters
  cisco.ios.ios_vrf:
    name: test_both_ipv6
    rd: 1:100
    route_both_ipv6:
      - 1:100
      - 3:100

返回值

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

键	描述
commands 列表 / 元素=字符串	要发送到设备的配置模式命令列表 返回： 始终 示例： ["vrf definition ansible", "description management vrf", {"rd": "1:100"}]
delta 字符串	执行所有操作所花费的时间 返回： 始终 示例： "0:00:10.469466"
end 字符串	作业结束时间 返回： 始终 示例： "2016-11-16 10:38:25.595612"
开始时间 字符串	作业开始时间 返回： 始终 示例： "2016-11-16 10:38:15.126146"

作者

• Peter Sprygada (@privateip)

资源链接

• 问题跟踪器
• 代码仓库