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

Примечание

Этот плагин является частью коллекции cisco.nxos (версия 1.4.0).

Для его установки используйте: ansible-galaxy collection install cisco.nxos.

Для использования в playbook, укажите: cisco.nxos.nxos_udld.

Новый в версии 1.0.0: коллекции cisco.nxos

Обзор
Параметры
Примечания
Примеры
Возвращаемые значения

Обзор

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

Примечание

У данного модуля есть соответствующий плагин действия.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
aggressive строка		Варианты: enabled disabled	Включает/отключает агрессивный режим.
msg_time строка			Время сообщения в секундах для пакетов UDLD или ключевое слово 'default'.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Начиная с Ansible 2.6, рекомендуется использовать `connection: httpapi` для NX-API. Этот параметр будет удален в выпуске после 2022-06-01. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка		Указывает пароль для использования при необходимости входа в привилегированный режим на удалённом устройстве. Если authorize имеет значение false, этот аргумент не действует. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize булево	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой любых команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка		Указывает имя хоста DNS или адрес для подключения к удалённому устройству по указанному каналу передачи. Значение host используется в качестве адреса назначения для канала передачи.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для каналов передачи cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число		Указывает порт для использования при построении подключения к удалённому устройству. Это значение относится к каналам передачи cli или nxapi. Значение порта по умолчанию соответствует общему порту соответствующего канала передачи, если не указано в задаче (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для канала передачи cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число		Указывает время ожидания в секундах для связи с сетевым устройством при подключении или отправке команд. Если время ожидания истекает до завершения операции, модуль возвращает ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т. д.).
	transport строка	Варианты: cli ← nxapi	Настраивает канал передачи для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy булево	Варианты: нет да ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl булево	Варианты: нет ← да	Настраивает transport для использования SSL, если установлено `yes`, только когда `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации nxapi в зависимости от используемого канала передачи. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs булево	Варианты: нет ← да	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых лично сайтах, использующих самозаверяющие сертификаты. Если аргумент transport не nxapi, это значение игнорируется.
reset булево		Варианты: нет да	Возможность сброса всех портов, отключенных UDLD. Параметр 'state' не может быть 'absent', когда он присутствует.
state строка		Варианты: present ← absent	Управление состоянием ресурса. При установке в 'absent', aggressive и 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
- cisco.nxos.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
- cisco.nxos.nxos_udld:
    aggressive: enabled
    msg_time: 15
    host: '{{ inventory_hostname }}'
    username: '{{ un }}'
    password: '{{ pwd }}'

Возвращаемые значения

Общие возвращаемые значения описаны в разделе здесь, следующие поля уникальны для данного модуля:

Ключ	Возвращённое значение	Описание
changed булево	всегда	проверка, было ли внесено изменение на устройстве Пример: 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']

Авторы

Jason Edelman (@jedelman8)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_udld_module.html