arista.eos.eos_vlan – (устаревшее, удалено после 2022-06-01) Управление VLAN на устройствах сети Arista EOS
Примечание
Этот плагин входит в коллекцию arista.eos (версия 1.2.0).
Для его установки используйте: ansible-galaxy collection install arista.eos.
Для использования в playbook укажите: 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 | Задержка, которую должен подождать playbook для проверки значений декларативных параметров намерения. | |
| interfaces список / элементы=строка | Список интерфейсов, которые должны быть связаны с VLAN. Имя интерфейса чувствительно к регистру и должно быть в полном формате, а не сокращенном. | ||
| name строка | Имя VLAN. | ||
| state строка |
| Состояние конфигурации VLAN. | |
| vlan_id целое число / обязательно | ID VLAN. | ||
| associated_interfaces список / элементы=строка | Это опция намерения и проверяет оперативное состояние для заданной vlan name для интерфейсов. Имя интерфейса чувствительно к регистру и должно быть в полном формате, а не сокращенном. Если значение в associated_interfaces не соответствует оперативному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке. | ||
| delay целое число | По умолчанию: 10 | Задержка, которую должен подождать playbook для проверки значений декларативных параметров намерения. | |
| 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 целое число | 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–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/arista/eos/eos_vlan_module.html
