eos_l2_interface - Управление интерфейсами L2 на устройствах Arista EOS.
Новая версия с 2.5.
Обзор
- Этот модуль предоставляет декларативное управление интерфейсами L2 на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| access_vlan | Настройка заданного VLAN в порте доступа. Если mode=access, используется в качестве идентификатора VLAN доступа. | ||
| aggregate | Список определений интерфейсов уровня 2. | ||
| 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. | |
| mode |
| Режим, в котором должен быть настроен интерфейс. | |
| name обязательно | Имя интерфейса псевдонимы: interface | ||
| native_vlan | VLAN по умолчанию для настройки в порту trunk. Если mode=trunk, используется в качестве идентификатора VLAN по умолчанию для trunk. | ||
| provider | По умолчанию: Нет | Устаревший Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli.Этот параметр необходим только если используется eAPI. Для получения дополнительной информации см. руководство EOS Platform Options. Объект словаря содержащий данные подключения. | |
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в CLI или аутентификации eAPI в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. | ||
| authorize |
| Инструктирует модуль войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. | |
| ssh_keyfile | Указывает файл ключа SSH для аутентификации подключения к удаленному устройству. Этот параметр используется только для cli транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. | ||
| use_proxy (добавлено в 2.5) |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| auth_pass | По умолчанию: нет | Указывает пароль, необходимый для входа в привилегированный режим на удаленном устройстве. Если authorize равен false, то этот параметр не используется. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. | |
| host обязательно | Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение параметра host используется в качестве целевого адреса для транспорта. | ||
| timeout | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. | |
| use_ssl |
| Настраивает транспорт для использования SSL, если установлено в true, только когда transport=eapi. Если параметр transport не eapi, это значение игнорируется. | |
| password | По умолчанию: Нет | Указывает пароль для аутентификации подключения к удаленному устройству. Это общий параметр, используемый для транспортов cli или eapi. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. | |
| validate_certs |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах, использующих самозаверенные сертификаты. Если параметр транспорт не eapi, это значение игнорируется. | |
| port | По умолчанию: 0 (использовать общий порт) | Указывает порт для использования при построении подключения к удаленному устройству. Это значение относится к cli или eapi. Значение порта будет по умолчанию соответствовать общему порту для транспорта, если не указано в задаче. (cli=22, http=80, https=443). | |
| transport обязательно |
| Настраивает транспортное соединение для подключения к удаленному устройству. | |
| state |
| Управление состоянием конфигурации интерфейса уровня 2. | |
| trunk_allowed_vlans | Список разрешённых VLAN в заданном trunk-порте. Если mode=trunk, это ЕДИНСТВЕННЫЕ VLAN, которые будут настроены на trunk, т.е. 2-10,15. псевдонимы: trunk_vlans | ||
Примечания
Примечание
- Проверено на EOS 4.15
- Сведения об использовании CLI, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.
Примеры
- name: Ensure Ethernet1 does not have any switchport
eos_l2_interface:
name: Ethernet1
state: absent
- name: Ensure Ethernet1 is configured for access vlan 20
eos_l2_interface:
name: Ethernet1
mode: access
access_vlan: 20
- name: Ensure Ethernet1 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged)
eos_l2_interface:
name: Ethernet1
mode: trunk
native_vlan: 10
trunk_allowed_vlans: 2-50
- name: Set switchports on aggregate
eos_l2_interface:
aggregate:
- { name: ethernet1, mode: access, access_vlan: 20}
- { name: ethernet2, mode: trunk, native_vlan: 10}
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое | Описание |
|---|---|---|
| commands список | всегда. | Список команд конфигурации для отправки на устройство Пример: ['interface ethernet1', 'switchport access vlan 20'] |
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантирует обратную совместимость.
Поддержка
Для получения дополнительной информации о поддержке этого модуля 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.5/modules/eos_l2_interface_module.html