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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
contact - / обязательно			Информация о контакте.
provider словарь			Устарело Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр требуется только при использовании NX-API. Для получения дополнительной информации см. руководство NXOS Platform Options. Объект словаря, содержащий сведения о подключении.
	auth_pass строка добавлено в 2.5.3		Указывает пароль, который необходимо использовать для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет значения. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение добавлено в 2.5.3	Варианты: no ← yes	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_AUTHORIZE`.
	host строка / обязательно		Указывает имя хоста DNS или адрес для подключения к удалённому устройству через указанный транспорт. Значение host используется в качестве адреса назначения для транспорта.
	password строка		Указывает пароль для аутентификации подключения к удалённому устройству. Это общий аргумент, используемый для транспортов cli или nxapi. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_PASSWORD`.
	port целое число	По умолчанию: "0 (использовать общий порт)"	Указывает порт, используемый при построении подключения к удалённому устройству. Это значение относится как к cli, так и к nxapi. Если в задаче не указан порт, используется соответствующий общий порт транспорта (cli=22, http=80, https=443).
	ssh_keyfile строка		Указывает SSH-ключ для аутентификации подключения к удалённому устройству. Этот аргумент используется только для транспорта cli. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_SSH_KEYFILE`.
	timeout целое число	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать результаты при выполнении длительных команд (sh mac, sh bgp и т.д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое значение добавлено в 2.5	Варианты: no yes ←	Если `no`, переменные окружения `http_proxy` и `https_proxy` будут игнорироваться.
	use_ssl логическое значение	Варианты: no ← yes	Настраивает transport для использования SSL, если значение равно `yes`, только при `transport=nxapi`, в противном случае это значение игнорируется.
	username строка		Настраивает имя пользователя для аутентификации подключения к удалённому устройству. Это значение используется для аутентификации входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, используется значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs логическое значение	Варианты: no yes ←	Если `no`, сертификаты SSL не будут проверяться. Это следует использовать только на контролируемых сайтах с использованием самозаверяющих сертификатов. Если транспорт не 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']

Статус

Этот модуль не гарантирует обратной совместимости интерфейса. [preview]
Этот модуль поддерживается командой Ansible Network Team. [network]

Поддержка Red Hat

Дополнительную информацию о поддержке этого модуля Red Hat см. в статье Базы знаний 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.9/modules/nxos_snmp_contact_module.html