nxos_lldp — Управление конфигурацией LLDP на устройствах Cisco NXOS.
Новая версия с 2.5.
Описание
- Этот модуль предоставляет декларативное управление службой LLDP на устройствах Cisco NXOS.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| provider | По умолчанию: None |
Устарело
Начиная с Ansible 2.5, рекомендуется использовать
connection: network_cli. Этот параметр требуется только при использовании NX-API.
Дополнительную информацию можно найти в руководстве NXOS Platform Options.
Объект словаря, содержащий данные подключения.
|
|
| username | Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_USERNAME. |
||
| authorize (добавлено в 2.5.3) |
|
Указывает модулю на вход в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTHORIZE. |
|
| ssh_keyfile | Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_SSH_KEYFILE. |
||
| use_proxy (добавлено в 2.5) |
|
Если no, переменные окружения http_proxy и https_proxy будут проигнорированы. |
|
| auth_pass (добавлено в 2.5.3) |
По умолчанию: none |
Указывает пароль для входа в привилегированный режим на удаленном устройстве, если это необходимо. Если authorize равно false, этот аргумент ничего не делает. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_AUTH_PASS. |
|
| host обязательно |
Указывает имя хоста DNS или адрес для подключения к удаленному устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта. |
||
| timeout (добавлено в 2.3) |
По умолчанию: 10 |
Указывает таймаут в секундах для связи с сетевым устройством для подключения или отправки команд. Если таймаут истечет до завершения операции, модуль вернет ошибку. NX-API может медленно возвращать данные при выполнении длительных команд (sh mac, sh bgp и т. д.). |
|
| use_ssl |
|
Настраивает transport на использование SSL, если значение true, только когда transport=nxapi, в противном случае это значение игнорируется. |
|
| password | По умолчанию: None |
Указывает пароль для аутентификации подключения к удаленному устройству. Это общий аргумент, используемый для cli или nxapi транспортов. Если значение не указано в задаче, используется значение переменной окружения ANSIBLE_NET_PASSWORD. |
|
| validate_certs |
None |
Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с использованием самоподписанных сертификатов. Если аргумент transport не равен nxapi, это значение игнорируется. |
|
| port | По умолчанию: 0 (используется стандартный порт) |
Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию будет соответствовать обычному порту транспорта, если он не указан в задаче (cli=22, http=80, https=443). |
|
| transport обязательно |
По умолчанию: cli |
Настраивает транспортное соединение для подключения к удаленному устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. |
|
| state |
|
Состояние конфигурации LLDP. Если значение present, lldp будет включен, иначе, если значение absent, он будет отключен. |
|
Примечания
Примечание
- Проверено на NXOSv 7.0(3)I5(1).
- Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options.
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide.
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.
Примеры
- name: Enable LLDP service
nxos_lldp:
state: present
- name: Disable LLDP service
nxos_lldp:
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в разделе. Следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| commands список |
всегда, за исключением платформ, использующих транспорт Netconf для управления устройством. | Список команд конфигурации в режиме конфигурации для отправки на устройство
Пример:
['feature lldp'] |
Статус
Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратная совместимость.
Поддержка
Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_lldp_module.html