cisco.ios.ios_vrf – Управление набором определений VRF на устройствах Cisco IOS
Примечание
Этот плагин входит в состав коллекции cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Для использования в книге задач укажите: cisco.ios.ios_vrf.
Новое в версии 1.0.0: of cisco.ios
Обзор
- Этот модуль обеспечивает декларативное управление определениями VRF на устройствах Cisco IOS. Он позволяет задачам управления отдельными или всеми определениями VRF. Он также поддерживает удаление определений VRF из конфигурации, которые не определены явно.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| associated_interfaces список / элементы=строка | Это параметр намерения, и он проверяет операционное состояние для заданной vrf name для интерфейсов, связанных с ней. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vrf на устройстве, это приведет к ошибке. | ||
| delay целое число | По умолчанию: 10 | Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. | |
| description строка | Предоставляет краткое описание определения VRF в текущей активной конфигурации. Значение определения VRF принимает алфавитно-цифровые символы, используемые для предоставления дополнительной информации о VRF. | ||
| interfaces список / элементы=строка | Идентифицирует набор интерфейсов, которые должны быть сконфигурированы в VRF. Интерфейсы должны быть маршрутизируемыми для размещения в VRF. | ||
| name строка | Имя определения VRF, подлежащего управлению на удаленном устройстве IOS. Имя определения VRF - это имя ASCII-строки, используемое для уникальной идентификации VRF. Этот аргумент взаимоисключает аргумент vrfs | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Дополнительную информацию можно найти в руководстве по платформам IOS IOS Platform Options guide. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования при необходимости входа в привилегированный режим на удаленном устройстве. Если authorize имеет значение false, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | Указывает порт для построения подключения к удаленному устройству. | ||
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечет до завершения операции, модуль вернет ошибку. | ||
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| purge логическое значение |
| Указывает модулю рассматривать определение VRF как абсолютное. Он удалит все ранее настроенные VRF на устройстве. | |
| rd строка | Значение router-distinguisher уникально идентифицирует VRF для процессов маршрутизации на удаленной системе IOS. Значение RD имеет вид A:B, где A и B — числовые значения. | ||
| route_both список / элементы=строка | Добавляет список экспорта и импорта расширенных сообщений о целевых маршрутах в VRF. | ||
| route_both_ipv4 список / элементы=строка | Добавляет список экспорта и импорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| route_both_ipv6 список / элементы=строка | Добавляет список экспорта и импорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| route_export список / элементы=строка | Добавляет список экспорта расширенных сообщений о целевых маршрутах в VRF. | ||
| route_export_ipv4 список / элементы=строка | Добавляет список экспорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| route_export_ipv6 список / элементы=строка | Добавляет список экспорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| route_import список / элементы=строка | Добавляет список импорта расширенных сообщений о целевых маршрутах в VRF. | ||
| route_import_ipv4 список / элементы=строка | Добавляет список импорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| route_import_ipv6 список / элементы=строка | Добавляет список импорта расширенных сообщений о целевых маршрутах в подрежиме конфигурации адресной семьи в VRF. | ||
| state строка |
| Настраивает состояние определения VRF, которое относится к операционной конфигурации устройства. При установке в значение настроен VRF должен быть сконфигурирован в активной конфигурации устройства, а при установке в отсутствует VRF не должен присутствовать в активной конфигурации устройства | |
| vrfs список / элементы=сырой | Набор объектов определения VRF, которые должны быть настроены на удаленном устройстве IOS. Элементы списка могут быть именем VRF или хешем определений и атрибутов VRF. Этот аргумент взаимоисключает аргумент name. | ||
Примечания
Примечание
- Тестировалось на IOS 15.6
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции 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: yes
- 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 список / elements=строка | всегда | Список команд режима конфигурации для отправки устройству Пример: ['vrf определение ansible', 'описание управления 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 |
Авторы
- Питер Спрыгада (@privateip)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_vrf_module.html