nxos_udld_interface — Управление параметрами конфигурации интерфейса UDLD.

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
interface обязательно			Полное имя интерфейса, например Ethernet1/1-
mode обязательно		Варианты: enabled disabled aggressive	Управление режимом UDLD для интерфейса.
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		Варианты: present ← absent	Управление состоянием ресурса.

Примечания

Примечание

Проверено на NXOSv 7.3.(0)D1(1) на VIRL
Для использования этого модуля на устройстве необходимо включить функцию UDLD.
Дополнительную информацию об использовании командной строки и NX-API см. в руководстве NXOS Platform Options
Дополнительную информацию об использовании Ansible для управления сетевыми устройствами см. в руководстве Ansible Network Guide
Дополнительную информацию об использовании Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# ensure Ethernet1/1 is configured to be in aggressive mode
- nxos_udld_interface:
    interface: Ethernet1/1
    mode: aggressive
    state: present
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# Remove the aggressive config only if it's currently in aggressive mode and then disable udld (switch default)
- nxos_udld_interface:
    interface: Ethernet1/1
    mode: aggressive
    state: absent
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

# ensure Ethernet1/1 has aggressive mode enabled
- nxos_udld_interface:
    interface: Ethernet1/1
    mode: enabled
    host: "{{ inventory_hostname }}"
    username: "{{ un }}"
    password: "{{ pwd }}"

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

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

Ключ	Возвращаемое значение	Описание
changed boolean	всегда	Проверка, были ли внесены изменения на устройстве Пример: True
end_state dict	всегда	Параметры конфигурации после выполнения модуля Пример: {'mode': 'enabled'}
existing dict	всегда	Параметры существующей конфигурации Пример: {'mode': 'aggressive'}
proposed dict	всегда	Параметры, переданные в модуль Пример: {'mode': 'enabled'}
updates список	всегда	Команды, отправленные на устройство Пример: ['interface ethernet1/33', 'no udld aggressive ; no udld disable']

Статус

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

Поддержка

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