nxos_udld – Управляет параметрами глобальной конфигурации UDLD
Обзор
- Управляет параметрами глобальной конфигурации UDLD.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggressive - |
| Переключает агрессивный режим. | |
| msg_time - | Время сообщения в секундах для пакетов UDLD или ключевое слово 'default'. | ||
| provider dictionary | Устарело Начиная с Ansible 2.5 рекомендуется использовать connection: network_cli. Этот параметр необходим только при использовании NX-API. Дополнительную информацию можно найти в руководстве NXOS Platform Options. Объект словаря, содержащий данные подключения. | ||
| auth_pass string добавлен в 2.5.3 | Указывает пароль, который нужно использовать, если требуется войти в привилегированный режим на удалённом устройстве. Если authorize равно false, то этот аргумент ничего не делает. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | ||
| authorize boolean добавлен в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host string / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному транспорту. Значение хоста используется в качестве адреса назначения для транспорта. | ||
| password string | Указывает пароль, используемый для аутентификации подключения к удалённому устройству. Этот аргумент обычно используется для транспортов cli или nxapi. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port integer | По умолчанию: "0 (использовать общий порт)" | Указывает порт, используемый при создании подключения к удалённому устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего транспорта, если он не указан в задании (cli=22, http=80, https=443). | |
| ssh_keyfile string | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout integer | По умолчанию: 10 | Указывает время ожидания в секундах для связи с сетевым устройством для подключения или отправки команд. Если время ожидания истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.). | |
| transport string / обязательно |
| Настраивает транспортное соединение, используемое при подключении к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает transport для использования SSL, если установлено yes, только когда transport=nxapi, в противном случае это значение игнорируется. | |
| username string | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задании, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых вами сайтах с самозаверяемыми сертификатами. Если аргумент transport не равен nxapi, это значение игнорируется. | |
| reset boolean |
| Возможность сбросить все порты, отключенные UDLD. Параметр 'state' не может быть 'absent', когда он присутствует. | |
| state - |
| Управляет состоянием ресурса. При установке в 'absent' агрессивный режим и msg_time устанавливаются в значения по умолчанию. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершится ошибкой, если функция udld не была ранее включена.
- Дополнительную информацию об использовании CLI и NX-API можно найти в руководстве NXOS Platform Options
- Дополнительную информацию об использовании Ansible для управления сетевыми устройствами можно найти в руководстве Ansible Network Guide
- Дополнительную информацию об использовании Ansible для управления устройствами Cisco можно найти на странице интеграции Cisco.
Примеры
# ensure udld aggressive mode is globally disabled and se global message interval is 20
- nxos_udld:
aggressive: disabled
msg_time: 20
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
# Ensure agg mode is globally enabled and msg time is 15
- nxos_udld:
aggressive: enabled
msg_time: 15
host: "{{ inventory_hostname }}"
username: "{{ un }}"
password: "{{ pwd }}"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| changed boolean | всегда | проверка внесения изменений на устройстве Пример: True |
| end_state словарь | всегда | k/v пары конфигурации udld после выполнения модуля Пример: {'aggressive': 'enabled', 'msg_time': '40'} |
| existing словарь | всегда | k/v пары существующей конфигурации udld Пример: {'aggressive': 'disabled', 'msg_time': '15'} |
| proposed словарь | всегда | k/v пары параметров, переданных в модуль Пример: {'aggressive': 'enabled', 'msg_time': '40'} |
| updates список | всегда | команда, отправленная на устройство Пример: ['udld message-time 40', 'udld aggressive'] |
Статус
- Этот модуль не гарантирует обратной совместимости. [превью]
- Этот модуль поддерживается командой Ansible Network. [сеть]
Поддержка Red Hat
Дополнительную информацию о поддержке этого модуля Red Hat можно найти в этой статье базы знаний Red Hat.
Авторы
- Jason Edelman (@jedelman8)
Подсказка
Если вы обнаружите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 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/nxos_udld_module.html
