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