arista.eos.eos_vrf – Управление VRF на устройствах Arista EOS
Примечание
Этот плагин является частью коллекции arista.eos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в книге задач, укажите: arista.eos.eos_vrf.
Новое в версии 1.0.0: из arista.eos
Обзор
- Этот модуль предоставляет декларативное управление VRF на сетевых устройствах Arista EOS.
Примечание
У данного модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений VRF | ||
| associated_interfaces список / элементы=строка | Это опция намерения и проверяет операционное состояние для данного vrf name для связанных интерфейсов. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов vrf на устройстве, это приведет к ошибке. | ||
| delay целое число | По умолчанию: 10 | Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. Это ожидание применимо для аргументов операционного состояния. | |
| interfaces список / элементы=строка | Определяет набор интерфейсов, которые должны быть настроены в VRF. Интерфейсы должны быть маршрутизируемыми, чтобы быть размещенными в VRF. Название интерфейса должно быть в полном формате, а не сокращенным. | ||
| name строка / обязательно | Имя VRF. | ||
| rd строка | Дискриминатор маршрута VRF | ||
| state строка |
| Состояние конфигурации VRF. | |
| associated_interfaces список / элементы=строка | Это опция намерения и проверяет операционное состояние для данного vrf name для связанных интерфейсов. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов vrf на устройстве, это приведет к ошибке. | ||
| delay целое число | По умолчанию: 10 | Время в секундах ожидания перед проверкой операционного состояния на удаленном устройстве. Это ожидание применимо для аргументов операционного состояния. | |
| interfaces список / элементы=строка | Определяет набор интерфейсов, которые должны быть настроены в VRF. Интерфейсы должны быть маршрутизируемыми, чтобы быть размещенными в VRF. Название интерфейса должно быть в полном формате, а не сокращенным. | ||
| name строка | Имя VRF. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для eAPI.Эта опция будет удалена в релизе после 2022-06-01. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря, содержащий данные соединения. | ||
| auth_pass строка | Указывает пароль для использования, если требуется ввод привилегированного режима на удаленном устройстве. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password строка | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port целое число | По умолчанию: 0 | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или eapi. Значение порта будет по умолчанию соответствовать общему порту соответствующего транспорта, если не указано в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile путь | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспортов cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout целое число | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. | ||
| transport строка |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| use_proxy логическое значение |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl логическое значение |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=eapi. Если аргумент transport не равен eapi, это значение игнорируется. | |
| username строка | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs логическое значение |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с использованием самозаверяемых сертификатов. Если аргумент transport не равен eapi, это значение игнорируется. | |
| purge логическое значение |
| Очистить VRF, не определенные в параметре aggregate. | |
| rd строка | Дискриминатор маршрута VRF | ||
| state строка |
| Состояние конфигурации VRF. | |
Примечания
Примечание
- Тестировалось на EOS 4.15
- Для получения информации об использовании CLI, eAPI и привилегированного режима см. руководство EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в Руководстве по сетям Ansible
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista.
Примеры
- name: Create vrf
arista.eos.eos_vrf:
name: test
rd: 1:200
interfaces:
- Ethernet2
state: present
- name: Delete VRFs
arista.eos.eos_vrf:
name: test
state: absent
- name: Create aggregate of VRFs with purge
arista.eos.eos_vrf:
aggregate:
- name: test4
rd: 1:204
- name: test5
rd: 1:205
state: present
purge: yes
- name: Delete aggregate of VRFs
arista.eos.eos_vrf:
aggregate:
- name: test2
- name: test3
- name: test4
- name: test5
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд режима конфигурации для отправки устройству Пример: ['vrf definition test', 'rd 1:100', 'interface Ethernet1', 'vrf forwarding test'] |
Авторы
- Ricardo Carrillo Cruz (@rcarrillocruz)
© 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/arista/eos/eos_vrf_module.html