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

Примечание

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

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

Для использования в книге задач укажите: cisco.nxos.nxos_snmp_contact.

Новое в версии 1.0.0: из cisco.nxos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
contact строка / обязательно			Информация о контакте.
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, это значение игнорируется.
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
- cisco.nxos.nxos_snmp_contact:
    contact: Test
    state: present

Значения возврата

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

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

Авторы

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

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