nxos_snmp_contact — Управление информацией о контактах SNMP.

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

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

Описание

Управление информацией о контактах SNMP.

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
contact обязательный			Информация о контакте.
provider		Значение по умолчанию: None	Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Дополнительная информация в руководстве NXOS Platform Options. Объект типа dict содержащий детали подключения.
	username		Устанавливает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа в CLI или аутентификации 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.
state обязательный		Варианты: present ← absent	Управление состоянием ресурса.

Примечания

Примечание

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

Примеры

# ensure snmp contact is configured
- nxos_snmp_contact:
    contact: Test
    state: present

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

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

Ключ	Возвращённое значение	Описание
commands список	всегда	Команды, отправленные устройству Пример: ['snmp-server contact New_Test']

Статус

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

Поддержка

Дополнительная информация о поддержке этого модуля Red Hat находится в этой статье базы знаний.

Автор

Jason Edelman (@jedelman8)
Gabriele Gerbino (@GGabriele)

Подсказка

Если вы заметили какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 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_snmp_contact_module.html