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