cisco.nxos.nxos_vrf 模块 – （已弃用，将于 2026-07-25 后移除）管理全局 VRF 配置。

注意

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

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

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

要在剧本中使用它，请指定： cisco.nxos.nxos_vrf。

cisco.nxos 1.0.0 中的新增功能

概要 

此模块提供对 Cisco NXOS 网络设备上的 VRF 的声明式管理。

参数 

参数	注释
admin_state 字符串	VRF 的管理状态。选项 `"up"` ← (默认) `"down"`
aggregate 列表 / 元素=字典	VRF 定义列表。
admin_state 字符串	VRF 的管理状态。选项 `"up"` `"down"`
associated_interfaces 列表 / 元素=字符串	这是一个意图选项，用于检查给定 vrf `name` 的关联接口的操作状态。如果 `associated_interfaces` 中的值与设备上 vrf 接口的操作状态不匹配，则会导致失败。
delay 整数	在检查远程设备的操作状态之前等待的时间（以秒为单位）。此等待时间适用于操作状态参数。
description 字符串	VRF 的描述或关键字“default”。
interfaces 列表 / 元素=字符串	要检查 VRF 是否已正确配置的接口列表或关键字“default”。
name 别名：vrf 字符串	要管理的 VRF 的名称。
rd 字符串	VPN 路由区分器 (RD)。有效值为以下路由区分器格式之一的字符串（ASN2:NN、ASN4:NN 或 IPV4:NN）；关键字“auto”或关键字“default”。
state 字符串	管理资源的所需状态。选项 `"present"` `"absent"`
vni 字符串	指定虚拟网络标识符。有效值为整数或关键字“default”。
associated_interfaces 列表 / 元素=字符串	这是一个意图选项，用于检查给定 vrf `name` 的关联接口的操作状态。如果 `associated_interfaces` 中的值与设备上 vrf 接口的操作状态不匹配，则会导致失败。
delay 整数	在检查远程设备的操作状态之前等待的时间（以秒为单位）。此等待时间适用于操作状态参数。默认值： `10`
description 字符串	VRF 的描述或关键字“default”。
interfaces 列表 / 元素=字符串	要检查 VRF 是否已正确配置的接口列表或关键字“default”。
name 别名：vrf 字符串	要管理的 VRF 的名称。
purge 布尔值	清除aggregate 参数中未定义的 VRF。选项 `false` ← (默认) `true`
rd 字符串	VPN 路由区分器 (RD)。有效值为以下路由区分器格式之一的字符串（ASN2:NN、ASN4:NN 或 IPV4:NN）；关键字“auto”或关键字“default”。
state 字符串	管理资源的所需状态。选项 `"present"` ← (默认) `"absent"`
vni 字符串	指定虚拟网络标识符。有效值为整数或关键字“default”。

备注 

注意

在 VIRL 上针对 NXOSv 7.3.(0)D1(1) 进行了测试
不支持 Cisco MDS
Cisco NX-OS 会自行创建默认 VRF。因此，不允许在此模块中使用 default 作为vrf 名称。
vrf 名称必须少于 32 个字符。
在 NX-OS 中，VRF 名称不区分大小写。但是，名称的存储方式与用户插入的方式完全相同，除非删除并重新创建 VRF，否则不会再次更改。例如，vrf=NTC 将创建一个名为 NTC 的 VRF，但再次使用 vrf=ntc 运行不会导致配置更改。
有关使用 CLI 和 NX-API 的信息，请参见：ref:`NXOS 平台选项指南 <nxos_platform_options>`
有关使用 Ansible 管理网络设备的更多信息，请参见：ref:`Ansible 网络指南 <network_guide>`
有关使用 Ansible 管理 Cisco 设备的更多信息，请参见`Cisco 集成页面 <https://ansible.org.cn/integrations/networks/cisco>`_。

示例 

- name: Ensure ntc VRF exists on switch
  cisco.nxos.nxos_vrf:
    name: ntc
    description: testing
    state: present
- name: Aggregate definition of VRFs
  cisco.nxos.nxos_vrf:
    aggregate:
      - name: test1
        description: Testing
        admin_state: down
      - name: test2
        interfaces: Ethernet1/2
- name: Aggregate definitions of VRFs with Purge
  cisco.nxos.nxos_vrf:
    aggregate:
      - name: ntc1
        description: purge test1
      - name: ntc2
        description: purge test2
    state: present
    purge: true
- name: Delete VRFs exist on switch
  cisco.nxos.nxos_vrf:
    aggregate:
      - name: ntc1
      - name: ntc2
    state: absent
- name: Assign interfaces to VRF declaratively
  cisco.nxos.nxos_vrf:
    name: test1
    interfaces:
      - Ethernet2/3
      - Ethernet2/5
- name: Check interfaces assigned to VRF
  cisco.nxos.nxos_vrf:
    name: test1
    associated_interfaces:
      - Ethernet2/3
      - Ethernet2/5
- name: >-
    Ensure VRF is tagged with interface Ethernet2/5 only (Removes from
    Ethernet2/3)
  cisco.nxos.nxos_vrf:
    name: test1
    interfaces:
      - Ethernet2/5
- name: Delete VRF
  cisco.nxos.nxos_vrf:
    name: ntc
    state: absent

返回值 

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

键	描述
commands 列表 / 元素=字符串	发送到设备的命令返回：始终示例： `["vrf context ntc", "no shutdown", "interface Ethernet1/2", "no switchport", "vrf member test2"]`

作者

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)
Trishna Guha (@trishnaguha)