ios_vrf – Управление коллекцией определений VRF на устройствах Cisco IOS
Новое в версии 2.3.
Описание
- Этот модуль предоставляет декларативное управление определениями VRF на устройствах Cisco IOS. Он позволяет плейбукам управлять отдельными или всей коллекцией VRF. Он также поддерживает удаление из конфигурации определений VRF, которые не определены явно.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| associated_interfaces - добавлен в 2.5 | Это необязательный параметр, проверяющий оперативное состояние заданного VRF name для связанных интерфейсов. Если значение в associated_interfaces не совпадает с оперативным состоянием интерфейсов VRF на устройстве, это приведёт к ошибке. | ||
| auth_pass строка | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает пароль, который необходимо использовать, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Для получения дополнительной информации см. руководство IOS Platform Options. Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| delay - добавлен в 2.4 | Значение по умолчанию: 10 | Время в секундах, которое нужно подождать перед проверкой оперативного состояния на удалённом устройстве. | |
| description - | Предоставляет краткое описание определения VRF в текущей активной конфигурации. Значение определения VRF принимает буквенно-цифровые символы, используемые для предоставления дополнительной информации о VRF. | ||
| interfaces - | Идентифицирует набор интерфейсов, которые должны быть сконфигурированы в VRF. Интерфейсы должны быть маршрутизируемыми, чтобы быть размещёнными в VRF. | ||
| name - | Имя определения VRF, которое нужно управлять на удалённом IOS устройстве. Имя определения VRF — это строка ASCII, используемая для уникальной идентификации VRF. Этот аргумент исключает аргумент vrfs. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Для получения дополнительной информации см. руководство IOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль, который необходимо использовать, если требуется вход в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент ничего не делает. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH сессии. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port целое число | Значение по умолчанию: 22 | Указывает порт, который используется при построении подключения к удалённому устройству. | |
| ssh_keyfile путь | Указывает SSH ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации SSH сессии. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | |
| username строка | Указывает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации SSH сессии. Если значение не указано в задании, будет использовано значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| purge логическое значение |
| Указывает модулю рассматривать определение VRF как абсолютное. Он удалит все ранее сконфигурированные VRF на устройстве. | |
| rd - | Значение маршрутизатора-дискриминатора (RD) уникально идентифицирует VRF для процессов маршрутизации на удалённой системе IOS. Значение RD принимает вид A:B, где A и B — числовые значения. | ||
| route_both - добавлен в 2.5 | Добавляет список экспорта и импорта расширенных сообщений целевых маршрутов в VRF. | ||
| route_both_ipv4 - добавлен в 2.7 | Добавляет список экспорта и импорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| route_both_ipv6 - добавлен в 2.7 | Добавляет список экспорта и импорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| route_export - добавлен в 2.5 | Добавляет список экспорта расширенных сообщений целевых маршрутов в VRF. | ||
| route_export_ipv4 - добавлен в 2.7 | Добавляет список экспорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| route_export_ipv6 - добавлен в 2.7 | Добавляет список экспорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| route_import - добавлен в 2.5 | Добавляет список импорта расширенных сообщений целевых маршрутов в VRF. | ||
| route_import_ipv4 - добавлен в 2.7 | Добавляет список импорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| route_import_ipv6 - добавлен в 2.7 | Добавляет список импорта расширенных сообщений целевых маршрутов в подрежиме конфигурации семейства адресов в VRF. | ||
| состояние - |
| Настраивает состояние определения VRF в отношении конфигурации работы устройства. При установке в текущее, VRF должен быть настроен в активной конфигурации устройства, а при установке в отсутствует VRF не должен быть в активной конфигурации устройства | |
| vrfs - | Набор объектов определения VRF, которые должны быть настроены на удалённом устройстве IOS. Элементы списка могут быть именем VRF или хэшем определений и атрибутов VRF. Этот аргумент взаимоисключающий с аргументом name. | ||
Примечания
Примечание
- Проверено на IOS 15.6
- Дополнительную информацию о использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию о использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: configure a vrf named management
ios_vrf:
name: management
description: oob mgmt vrf
interfaces:
- Management1
- name: remove a vrf named test
ios_vrf:
name: test
state: absent
- name: configure set of VRFs and purge any others
ios_vrf:
vrfs:
- red
- blue
- green
purge: yes
- name: Creates a list of import RTs for the VRF with the same parameters
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
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
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
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
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
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
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
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
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 |
| start строка | всегда | Время начала работы Пример: 2016-11-16 10:38:15.126146 |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Пётр Спрыгада (@privateip)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ios_vrf_module.html