ios_lldp — Управление конфигурацией LLDP на устройствах Cisco IOS
Новая версия с 2.5.
Обзор
- Этот модуль предоставляет декларативное управление службой LLDP на устройствах Cisco IOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| auth_pass |
Устаревший
Начиная с Ansible 2.5 рекомендуется использовать
connection: network_cli и become: yes с become_pass. Дополнительная информация в руководстве IOS Platform Options.
Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения
ANSIBLE_NET_AUTH_PASS. |
||
| authorize bool |
|
Устаревший
Начиная с Ansible 2.5 рекомендуется использовать
connection: network_cli и become: yes. Дополнительная информация в руководстве IOS Platform Options.
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения
ANSIBLE_NET_AUTHORIZE. |
|
| provider |
Устаревший
Начиная с Ansible 2.5 рекомендуется использовать
connection: network_cli. Дополнительная информация в руководстве IOS Platform Options.
Объект типа dict, содержащий данные подключения.
|
||
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. | ||
| port | По умолчанию: 22 |
Указывает порт для подключения к удалённому устройству. | |
| username | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME.
|
||
| password | Указывает пароль для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD.
|
||
| timeout | По умолчанию: 10 |
Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль вернёт ошибку. | |
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Это значение — путь к ключу, используемому для аутентификации сеанса SSH. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE.
|
||
| authorize bool |
|
Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE.
|
|
| auth_pass | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет эффекта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS.
|
||
| state |
|
Состояние конфигурации LLDP. Если значение равно present, LLDP будет включено, в противном случае, если значение равно absent, оно будет отключено. | |
Примечания
Примечание
- Тестировано на IOS 15.2
- Дополнительная информация об использовании Ansible для управления сетевыми устройствами в руководстве Руководство по сетям Ansible
- Дополнительная информация об использовании Ansible для управления устройствами Cisco на странице интеграции Cisco Cisco.
Примеры
- name: Enable LLDP service
ios_lldp:
state: present
- name: Disable LLDP service
ios_lldp:
state: absent
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список |
всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. |
Список команд конфигурационного режима, которые необходимо отправить устройству.
Пример:
['lldp run']
|
Статус
Этот модуль помечен как preview, что означает, что его интерфейс не гарантируется обратной совместимостью.
Техническое обслуживание
Этот модуль помечен как сетевой, что означает, что он поддерживается Ansible Network Team. См. Техническое обслуживание и поддержка модулей для получения дополнительной информации.
Список других модулей, которые также поддерживаются Ansible Network Team, см. здесь.
Поддержка
Дополнительную информацию о поддержке этого модуля Red Hat см. в этой статье базы знаний Knowledge Base article
Автор
- 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.6/modules/ios_lldp_module.html
