nxos_udld — Управляет параметрами глобальной конфигурации UDLD.

Новая в версии 2.2.

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения
Статус
- Поддержка
- Автор

Обзор

Управляет параметрами глобальной конфигурации UDLD.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggressive		Варианты: enabled disabled Значение по умолчанию: None	Включает/выключает агрессивный режим.
msg_time		Значение по умолчанию: None	Время сообщения в секундах для пакетов UDLD или ключевое слово 'default'.
provider		Значение по умолчанию: None	Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий данные подключения.
	username		Настраивает имя пользователя для аутентификации подключения к удаленному устройству. Это значение используется для аутентификации входа в командную строку или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_USERNAME`.
	authorize (добавлено в 2.5.3)	Варианты: no ← yes	Указывает модулю войти в привилегированный режим на удаленном устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTHORIZE`.
	ssh_keyfile		Указывает SSH-ключ для аутентификации подключения к удаленному устройству. Этот параметр используется только для транспорта cli. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_SSH_KEYFILE`.
	use_proxy (добавлено в 2.5)	Варианты: yes ← no	Если `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	Варианты: yes no ←	Настраивает транспорт transport для использования SSL, если значение установлено в true только когда `transport=nxapi`, в противном случае это значение игнорируется.
	password	Значение по умолчанию: None	Указывает пароль для аутентификации подключения к удаленному устройству. Этот параметр часто используется для транспортов cli или nxapi. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_PASSWORD`.
	validate_certs	Варианты: yes no Значение по умолчанию: None	Если `no`, сертификаты SSL не будут проверены. Это следует использовать только на контролируемых локальных сайтах с самозаверяемыми сертификатами. Если параметр transport не nxapi, это значение игнорируется.
	port	Значение по умолчанию: 0 (использовать стандартный порт)	Указывает порт для подключения к удаленному устройству. Это значение относится к cli или nxapi. Значение порта по умолчанию соответствует стандартному порту для транспорта, если не указано в задаче (cli=22, http=80, https=443).
	transport обязательно	Значение по умолчанию: cli	Настраивает транспортное соединение для подключения к удаленному устройству. Параметр transport поддерживает подключение к устройству через cli (ssh) или nxapi.
reset		Варианты: true Значение по умолчанию: None	Возможность сброса всех портов, отключенных UDLD. Параметр 'state' не может быть 'absent', когда это присутствует.
state		Варианты: present ← absent	Управляет состоянием ресурса. При установке в '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 dict	всегда	параметры конфигурации udld после выполнения модуля Пример: {'msg_time': '40', 'aggressive': 'enabled'}
existing dict	всегда	параметры существующей конфигурации udld Пример: {'msg_time': '15', 'aggressive': 'disabled'}
proposed dict	всегда	параметры, переданные в модуль Пример: {'msg_time': '40', 'aggressive': 'enabled'}
updates list	всегда	команды, отправленные на устройство Пример: ['udld message-time 40', 'udld aggressive']

Статус

Этот модуль помечен как превью, что означает, что он не гарантирует обратную совместимость интерфейса.

Поддержка

Дополнительную информацию о поддержке этого модуля компанией 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.5/modules/nxos_udld_module.html