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 ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize bool |
| Устарело Начиная с 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. Объект словаря, содержащий данные подключения. | ||
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 | Указывает порт для построения подключения к удаленному устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| password | Указывает пароль для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут превышен до завершения операции, модуль сообщит об ошибке. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Это путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| authorize bool |
| Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| auth_pass | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize ложно, то этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| purge | По умолчанию: "нет" | Указывает модулю рассматривать определение VRF как абсолютное. Он удалит все ранее сконфигурированные VRF на устройстве. | |
| rd | Значение идентификатора маршрутизатора уникально идентифицирует VRF для процессов маршрутизации на удаленной системе IOS. Значение RD имеет вид A:B, где A и B — числовые значения. | ||
| route_both (добавлен в 2.5) | Добавляет список экспорта и импорта расширенных сообщений о целевых маршрутах в VRF. | ||
| route_export (добавлен в 2.5) | Добавляет список экспорта расширенных сообщений о целевых маршрутах в VRF. | ||
| route_import (добавлен в 2.5) | Добавляет список импорта расширенных сообщений о целевых маршрутах в VRF. | ||
| state |
| Настраивает состояние определения VRF, относящееся к оперативной конфигурации устройства. При установке в настоящее определение VRF должно быть сконфигурировано в активной конфигурации устройства, а при установке в отсутствующее — определение VRF не должно быть в активной конфигурации устройства. | |
| vrfs | Набор объектов определения VRF, которые будут сконфигурированы на удаленном устройстве IOS. Элементы списка могут быть именем VRF или хешем определений VRF и атрибутов. Этот аргумент взаимоисключает аргумент name. | ||
Примечания
Примечание
- Проверено на IOS 15.6
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по Ansible по сетям
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco https://www.ansible.com/integrations/networks/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 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 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
Возвращаемые значения
Общие возвращаемые значения описаны в разделе, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands list | всегда | Список команд режима конфигурации для отправки устройству Пример: ['vrf definition ansible', 'description management vrf', {'rd': '1:100'}] |
| delta str | всегда | Время, затраченное на выполнение всех операций Пример: 0:00:10.469466 |
| end str | всегда | Время завершения работы Пример: 2016-11-16 10:38:25.595612 |
| start str | всегда | Время начала работы Пример: 2016-11-16 10:38:15.126146 |
Статус
Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается командой Ansible Network Team. Подробнее см. Техническое обслуживание и поддержка модулей.
Список других модулей, поддерживаемых командой Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией Red Hat см. в этой статье базы знаний
Автор
- 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.6/modules/ios_vrf_module.html