arista.eos.eos_vlan – (устаревшее, удалено после 2022-06-01) Управление VLAN на устройствах сети Arista EOS
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в плейбуке укажите: arista.eos.eos_vlan.
Введено в версии 1.0.0: of arista.eos
УСТАРЕВШЕЕ
- Убрано в
-
главном релизе после 2022-06-01
- Почему
-
Выпущены обновлённые модули с большей функциональностью
- Альтернатива
-
eos_vlans
Обзор
- Этот модуль предоставляет декларативное управление VLAN на сетевых устройствах Arista EOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate список / элементы=словарь | Список определений VLAN. | ||
| associated_interfaces список / элементы=строка | Это параметр намерений и проверяет операционное состояние заданного vlan name для связанных интерфейсов. Имя интерфейса чувствительно к регистру и должно быть в расширенном формате, а не сокращённом. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vlan на устройстве, это приведёт к ошибке. | ||
| delay целое число | По умолчанию: 10 | Задержка, которую плейбук должен ожидать, чтобы проверить значения декларативных параметров намерений. | |
| interfaces список / элементы=строка | Список интерфейсов, которые должны быть связаны с VLAN. Имя интерфейса чувствительно к регистру и должно быть в расширенном формате, а не сокращённом. | ||
| name строка | Имя VLAN. | ||
| state строка |
| Состояние конфигурации VLAN. | |
| vlan_id целое число / обязательно | Идентификатор VLAN. | ||
| associated_interfaces список / элементы=строка | Это параметр намерений и проверяет операционное состояние заданного vlan name для связанных интерфейсов. Имя интерфейса чувствительно к регистру и должно быть в расширенном формате, а не сокращённом. Если значение в associated_interfaces не совпадает с операционным состоянием интерфейсов vlan на устройстве, это приведёт к ошибке. | ||
| delay целое число | По умолчанию: 10 | Задержка, которую плейбук должен ожидать, чтобы проверить значения декларативных параметров намерений. | |
| interfaces список / элементы=строка | Список интерфейсов, которые должны быть связаны с VLAN. Имя интерфейса чувствительно к регистру и должно быть в расширенном формате, а не сокращённом. | ||
| name строка | Имя VLAN. | ||
| provider словарь | Устаревший Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli.Начиная с Ansible 2.6, рекомендуется использовать connection: httpapi для eAPI.Этот параметр будет удален в релизе после 2022-06-01. Дополнительную информацию можно найти в руководстве EOS Platform Options. Словарь, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для использования при входе в привилегированный режим на удалённом устройстве. Если authorize ложно, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое значение |
| Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| host строка | Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| 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 логическое значение |
| Удалить VLAN, не определённые в параметре aggregate. | |
| state строка |
| Состояние конфигурации VLAN. | |
| vlan_id целое число | Идентификатор VLAN. | ||
Примечания
Примечание
- Проверено на EOS 4.15
- Для получения информации об использовании CLI, eAPI и привилегированного режима, см. руководство Параметры платформы EOS
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами, см. руководство Руководство по Ansible для сетей
- Для получения дополнительной информации об использовании Ansible для управления устройствами Arista EOS см. страницу интеграции Arista.
Примеры
- name: Create vlan
arista.eos.eos_vlan:
vlan_id: 4000
name: vlan-4000
state: present
- name: Add interfaces to vlan
arista.eos.eos_vlan:
vlan_id: 4000
state: present
interfaces:
- Ethernet1
- Ethernet2
- name: Check if interfaces is assigned to vlan
arista.eos.eos_vlan:
vlan_id: 4000
associated_interfaces:
- Ethernet1
- Ethernet2
- name: Suspend vlan
arista.eos.eos_vlan:
vlan_id: 4000
state: suspend
- name: Unsuspend vlan
arista.eos.eos_vlan:
vlan_id: 4000
state: active
- name: Create aggregate of vlans
arista.eos.eos_vlan:
aggregate:
- vlan_id: 4000
- {vlan_id: 4001, name: vlan-4001}
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список / элементы=строка | всегда | Список команд режима конфигурации для отправки устройству Пример: ['vlan 20', 'name test-vlan'] |
Статус
- Этот модуль будет удалён в релизе следующего основного выпуска после 2022-06-01. [устаревший]
- Для получения дополнительной информации см. УСТАРЕВШИЙ.
Авторы
- 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_vlan_module.html
