eos_lldp – Управление конфигурацией LLDP на устройствах Arista EOS
Новая в версии 2.5.
Обзор
- Этот модуль предоставляет декларативное управление службой LLDP на устройствах Arista EOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| 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. | |
| 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 целое число | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль выдаст ошибку. | ||
| 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, это значение игнорируется. | |
| state - |
| Состояние конфигурации LLDP. Если значение present, LLDP будет включено, в противном случае, если это absent, оно будет отключено. | |
Примечания
Примечание
- Проверено на EOS 4.15
- Дополнительная информация по использованию CLI, eAPI и привилегированного режима см. в руководстве EOS Platform Options
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
- Дополнительная информация об использовании Ansible для управления устройствами Arista EOS см. на странице интеграции Arista Arista integration page.
Примеры
- name: Enable LLDP service
eos_lldp:
state: present
- name: Disable LLDP service
eos_lldp:
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в документации. Ниже приведены поля, уникальные для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список | всегда, кроме платформ, которые используют транспорт Netconf для управления устройством. | Список команд конфигурации для отправки на устройство Пример: ['lldp run'] |
Статус
- Не гарантируется обратная совместимость интерфейса этого модуля. [превью]
- Этот модуль поддерживается командой Ansible Network Team. [сетевой]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля компанией Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Ganesh Nalawade (@ganeshrn)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/eos_lldp_module.html