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 boolean |
| Устарело Начиная с 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. Объект типа dict, содержащий данные подключения. | ||
| auth_pass - | Указывает пароль для использования, если требуется ввод привилегированного режима на удалённом устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password - | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | ||
| port - | Значение по умолчанию: 22 | Указывает порт для создания подключения к удалённому устройству. | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - | Значение по умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| purge - | Значение по умолчанию: "no" | Инструктирует модуль рассматривать определение 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 Cisco integration page.
Примеры
- 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
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| команды список | всегда | Список команд конфигурации в режиме конфигурации для отправки на устройство Пример: ['vrf definition ansible', 'description management vrf', {'rd': '1:100'}] |
| delta строка | всегда | Прошедшее время выполнения всех операций Пример: 0:00:10.469466 |
| конец строка | всегда | Время завершения работы Пример: 2016-11-16 10:38:25.595612 |
| начало строка | всегда | Время начала работы Пример: 2016-11-16 10:38:15.126146 |
Статус
- Гарантии обратной совместимости интерфейса этого модуля нет. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний Red Hat Red Hat Knowledge Base article.
Авторы
- Peter Sprygada (@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.7/modules/ios_vrf_module.html