Модуль cisco.nxos.nxos_vrf — (устарел, будет удалён после 2026-07-25) Управляет глобальной конфигурацией VRF.

Примечание

Этот модуль входит в коллекцию cisco.nxos (версия 11.2.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install cisco.nxos.

Чтобы использовать её в плейбуке, укажите: cisco.nxos.nxos_vrf.

Добавлен в cisco.nxos 1.0.0

Краткое описание
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль обеспечивает декларативное управление VRF на сетевых устройствах CISCO NXOS.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: vrf

Параметры

Параметр	Комментарии
admin_state string	Административное состояние VRF. Варианты: `"up"` ← (по умолчанию) `"down"`
aggregate list / elements=dictionary	Список определений VRF.
admin_state string	Административное состояние VRF. Варианты: `"up"` `"down"`
associated_interfaces list / elements=string	Это параметр намерения, который проверяет операционное состояние заданного VRF `name` для связанных интерфейсов. Если значение в `associated_interfaces` не соответствует операционному состоянию интерфейсов VRF на устройстве, проверка завершится ошибкой.
delay integer	Время ожидания в секундах перед проверкой операционного состояния на удалённом устройстве. Эта задержка применяется к аргументам операционного состояния.
description string	Описание VRF или ключевое слово ‘default’.
interfaces list / elements=string	Список интерфейсов для проверки правильности настройки VRF или ключевое слово ‘default’.
name псевдонимы: vrf string	Имя управляемой VRF.
rd string	Различитель маршрутов VPN (RD). Допустимые значения: строка в одном из форматов route distinguisher (ASN2:NN, ASN4:NN или IPV4:NN), ключевое слово ‘auto’ или ключевое слово ‘default’.
state string	Управляет требуемым состоянием ресурса. Варианты: `"present"` `"absent"`
vni string	Указывает идентификатор виртуальной сети. Допустимые значения: целое число или ключевое слово ‘default’.
associated_interfaces list / elements=string	Это параметр намерения, который проверяет операционное состояние заданного VRF `name` для связанных интерфейсов. Если значение в `associated_interfaces` не соответствует операционному состоянию интерфейсов VRF на устройстве, проверка завершится ошибкой.
delay integer	Время ожидания в секундах перед проверкой операционного состояния на удалённом устройстве. Эта задержка применяется к аргументам операционного состояния. По умолчанию: `10`
description string	Описание VRF или ключевое слово ‘default’.
interfaces list / elements=string	Список интерфейсов для проверки правильности настройки VRF или ключевое слово ‘default’.
name псевдонимы: vrf string	Имя управляемой VRF.
purge boolean	Удалять VRF, не указанные в параметре aggregate. Варианты: `false` ← (по умолчанию) `true`
rd string	Различитель маршрутов VPN (RD). Допустимые значения: строка в одном из форматов route distinguisher (ASN2:NN, ASN4:NN или IPV4:NN), ключевое слово ‘auto’ или ключевое слово ‘default’.
state string	Управляет требуемым состоянием ресурса. Варианты: `"present"` ← (по умолчанию) `"absent"`
vni string	Указывает идентификатор виртуальной сети. Допустимые значения: целое число или ключевое слово ‘default’.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) в VIRL
Не поддерживается для Cisco MDS
Cisco NX-OS самостоятельно создаёт VRF по умолчанию. Поэтому в этом модуле нельзя использовать default в качестве имени vrf.
vrf Имя должно быть короче 32 символов.
В NX-OS имена VRF нечувствительны к регистру. Однако имя сохраняется в том виде, в каком его ввёл пользователь, и не изменяется, пока VRF не будет удалена и создана заново. Например, vrf=NTC создаст VRF с именем NTC, но повторный запуск с vrf=ntc не приведёт к изменению конфигурации.
Информацию об использовании CLI и NX-API см. в :ref:`руководстве по параметрам платформы NXOS <nxos_platform_options>`
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве по сетям Ansible <network_guide>`
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/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 list / elements=string	команды, отправленные устройству Возвращается: всегда Пример: `["vrf context ntc", "no shutdown", "interface Ethernet1/2", "no switchport", "vrf member test2"]`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/nxos/nxos_vrf_module.html