Модуль cisco.ios.ios_vrf — модуль для настройки определений VRF.

Примечание

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

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

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

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

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

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

Этот модуль обеспечивает декларативное управление определениями VRF на устройствах Cisco IOS. Он позволяет плейбукам управлять отдельными VRF или всей коллекцией VRF. Также поддерживается удаление из конфигурации определений VRF, которые не указаны явно.

Примечание

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

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

Параметры

Параметр	Комментарии
address_family list / elements=dictionary	Список семейств адресов с параметрами MDT, которые требуется настроить на удалённом устройстве IOS.
afi string	Идентификатор семейства адресов. Варианты: `"ipv4"` `"ipv6"`
mdt dictionary	Параметры MDT.
auto_discovery dictionary	Параметры автоматического обнаружения.
vxlan dictionary	Параметры VXLAN.
enable boolean	Включить VXLAN. Варианты: `false` `true`
inter_as boolean	Включить взаимодействие между автономными системами. Варианты: `false` `true`
data dictionary	Параметры параметра data.
threshold integer	Пороговое значение.
vxlan_mcast_group string	Значение группы многоадресной рассылки VXLAN.
default dictionary	Параметры параметра default.
vxlan_mcast_group string	Значение группы многоадресной рассылки VXLAN.
overlay dictionary	Параметры параметра overlay.
use_bgp dictionary	Параметры параметра BGP.
enable boolean	Включить использование BGP. Варианты: `false` `true`
spt_only boolean	Включить только SPT. Варианты: `false` `true`
associated_interfaces list / elements=string	Это параметр намерения, который проверяет рабочее состояние указанных интерфейсов для данной VRF `name`. Если значение в `associated_interfaces` не совпадает с рабочим состоянием интерфейсов VRF на устройстве, задача завершится ошибкой.
delay integer	Время ожидания в секундах перед проверкой рабочего состояния на удалённом устройстве. По умолчанию: `10`
description string	Добавляет краткое описание определения VRF в текущую активную конфигурацию. Значение определения VRF может содержать буквенно-цифровые символы, используемые для предоставления дополнительной информации о VRF.
interfaces list / elements=string	Определяет набор интерфейсов, которые следует настроить в VRF. Чтобы включить интерфейс в VRF, он должен быть маршрутизируемым.
name string	Имя определения VRF, которым нужно управлять на удалённом устройстве IOS. Имя определения VRF — это строка ASCII, используемая для уникальной идентификации VRF. Этот аргумент взаимоисключающий с аргументом `vrfs`
purge boolean	Указывает модулю считать определение VRF абсолютным. Удаляет все ранее настроенные VRF на устройстве. Варианты: `false` ← (по умолчанию) `true`
rd string	Значение различителя маршрутизаторов (RD) уникально идентифицирует VRF для процессов маршрутизации в удалённой системе IOS. Значение RD имеет формат `A:B`, где `A` и `B` — числовые значения.
route_both list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта и импорта.
route_both_ipv4 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта и импорта в подрежиме настройки семейства адресов.
route_both_ipv6 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта и импорта в подрежиме настройки семейства адресов.
route_export list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта.
route_export_ipv4 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта в подрежиме настройки семейства адресов.
route_export_ipv6 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для экспорта в подрежиме настройки семейства адресов.
route_import list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для импорта.
route_import_ipv4 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для импорта в подрежиме настройки семейства адресов.
route_import_ipv6 list / elements=string	Добавляет в VRF список расширенных сообществ целевых маршрутов для импорта в подрежиме настройки семейства адресов.
state string	Задаёт состояние определения VRF относительно рабочей конфигурации устройства. Если задано значение present, VRF должна быть настроена в активной конфигурации устройства; если задано значение absent, VRF не должна присутствовать в активной конфигурации устройства. Варианты: `"present"` ← (по умолчанию) `"absent"`
vrfs list / elements=any	Набор объектов определений VRF, которые требуется настроить на удалённом устройстве IOS. Записи списка могут представлять собой имя VRF или хеш с определениями и атрибутами VRF. Этот аргумент взаимоисключающий с аргументом `name`.

Примечания

Примечание

Проверено на Cisco IOSXE версии 17.3 в CML.
Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`руководстве Ansible по сетям <network_guide>`
Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/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 list / elements=string	Список команд режима конфигурации, отправляемых устройству Возвращается: всегда Пример: `["vrf definition ansible", "description management vrf", {"rd": "1:100"}]`
delta string	Время, затраченное на выполнение всех операций Возвращается: всегда Пример: `"0:00:10.469466"`
end string	Время завершения задания Возвращается: всегда Пример: `"2016-11-16 10:38:25.595612"`
start string	Время начала задания Возвращается: всегда Пример: `"2016-11-16 10:38:15.126146"`

Авторы

Peter Sprygada (@privateip)

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

© 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/ios/ios_vrf_module.html