eos_vlan – Управление VLAN на устройствах сети Arista EOS
Новая версия 2.4.
Краткое описание
- Этот модуль обеспечивает декларативное управление VLAN на сетевых устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggregate - | Список определений VLAN. | ||
| associated_interfaces - добавлен в 2.5 | Этот параметр служит для проверки операционного состояния для заданной VLAN name на интерфейсах, связанных с ней. Название интерфейса чувствительно к регистру и должно быть указано в полном формате, а не сокращенно. Если значение в associated_interfaces не соответствует операционному состоянию интерфейсов VLAN на устройстве, это приведет к ошибке. | ||
| auth_pass строка | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes с become_pass. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот параметр не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize логическое |
| Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli и become: yes. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| delay - | По умолчанию: 10 | Задержка, которую должен ожидать проигрыватель при проверке параметров декларативного намерения. | |
| interfaces - | Список интерфейсов, которые должны быть связаны с VLAN. Название интерфейса чувствительно к регистру и должно быть указано в полном формате, а не сокращенно. | ||
| name - | Имя VLAN. | ||
| provider словарь | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании eAPI. Для получения дополнительной информации обратитесь к руководству EOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass строка | Указывает пароль для входа в привилегированный режим на удаленном устройстве. Если authorize равно false, этот параметр не имеет эффекта. Если значение не указано в задаче, будет использовано значение переменной среды 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 целое число | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истечет до завершения операции, модуль выдаст ошибку. | |
| transport строка / обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| use_proxy логическое добавлен в 2.5 |
| Если 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
eos_vlan:
vlan_id: 4000
name: vlan-4000
state: present
- name: Add interfaces to vlan
eos_vlan:
vlan_id: 4000
state: present
interfaces:
- Ethernet1
- Ethernet2
- name: Check if interfaces is assigned to vlan
eos_vlan:
vlan_id: 4000
associated_interfaces:
- Ethernet1
- Ethernet2
- name: Suspend vlan
eos_vlan:
vlan_id: 4000
state: suspend
- name: Unsuspend vlan
eos_vlan:
vlan_id: 4000
state: active
- name: Create aggregate of vlans
eos_vlan:
aggregate:
- vlan_id: 4000
- {vlan_id: 4001, name: vlan-4001}
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда | Список команд конфигурационного режима, которые необходимо отправить устройству Пример: ['vlan 20', 'name test-vlan'] |
Статус
- Интерфейс этого модуля не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается командой Ansible по работе с сетями Команда по работе с модулями Ansible. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке данного модуля Red Hat см. в статье базы знаний Red Hat.
Авторы
- 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.8/modules/eos_vlan_module.html
