nxos_udld – Управляет параметрами глобальной конфигурации UDLD.
Новая в версии 2.2.
Обзор
- Управляет параметрами глобальной конфигурации UDLD.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |
|---|---|---|---|
| aggressive - |
| Включает/выключает агрессивный режим. | |
| msg_time - | Время сообщения в секундах для пакетов UDLD или ключевое слово 'default'. | ||
| provider - | Устарело Начиная с Ansible 2.5, рекомендуется использовать connection: network_cli. Этот параметр нужен только при использовании NX-API. Для получения дополнительной информации см. руководство по параметрам платформы NXOS NXOS Platform Options guide. Объект словаря, содержащий данные соединения. | ||
| auth_pass - добавлен в 2.5.3 | По умолчанию: "none" | Указывает пароль для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, этот параметр игнорируется. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTH_PASS. | |
| authorize boolean добавлен в 2.5.3 |
| Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_AUTHORIZE. | |
| host - / обязательно | Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному протоколу. Значение host используется как адрес назначения для протокола. | ||
| password - | Указывает пароль для аутентификации подключения к удалённому устройству. Этот параметр обычно используется для протоколов cli или nxapi. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_PASSWORD. | ||
| port - | По умолчанию: "0 (используется стандартный порт)" | Указывает порт, используемый при построении подключения к удалённому устройству. Это значение относится к протоколам cli или nxapi. Значение порта по умолчанию соответствует стандартному порту протокола, если оно не указано в задаче (cli=22, http=80, https=443). | |
| ssh_keyfile - | Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот параметр используется только для протокола cli. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_SSH_KEYFILE. | ||
| timeout - добавлен в 2.3 | По умолчанию: 10 | Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истечёт до завершения операции, модуль вернёт ошибку. NX-API может медленно отвечать при выполнении длительных команд (sh mac, sh bgp и т. д.). | |
| transport - / обязательно | По умолчанию: "cli" | Настраивает протокол подключения к удалённому устройству. Параметр transport поддерживает подключение к устройству по cli (ssh) или nxapi. | |
| use_proxy boolean добавлен в 2.5 |
| Если no, переменные среды http_proxy и https_proxy будут проигнорированы. | |
| use_ssl boolean |
| Настраивает протокол transport на использование SSL, если значение равно true, только если transport=nxapi, в противном случае это значение игнорируется. | |
| username - | Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого протокола. Если значение не указано в задаче, используется значение переменной среды ANSIBLE_NET_USERNAME. | ||
| validate_certs boolean |
| Если no, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых сайтах с самозаверенными сертификатами. Если параметр transport не равен nxapi, это значение игнорируется. | |
| reset boolean |
| Возможность сбросить все отключённые UDLD порты. Параметр 'state' не может быть 'absent', когда этот параметр присутствует. | |
| state - |
| Управление состоянием ресурса. При установке в 'absent', aggressive и msg_time устанавливаются в значения по умолчанию. | |
Примечания
Примечание
- Проверено на NXOSv 7.3.(0)D1(1) на VIRL
- Модуль завершится ошибкой, если функция udld не была ранее включена.
- Для получения информации об использовании CLI и NX-API см. руководство по параметрам платформы NXOS Platform Options
- Для получения дополнительной информации об использовании Ansible для управления сетевыми устройствами см. руководство по сетям Ansible Ansible Network Guide
- Для получения дополнительной информации об использовании Ansible для управления устройствами Cisco см. страницу интеграции Cisco Cisco integration page.
Примеры
# 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.7/modules/nxos_udld_module.html
