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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
contact - / обязательно			Информация о контакте.
provider словарь			Устаревший Начиная с Ansible 2.5, рекомендуется использовать `connection: network_cli`. Этот параметр необходим только если вы используете NX-API. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект типа dict, содержащий данные подключения.
	auth_pass строка добавлен в 2.5.3		Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize ложно, то этот аргумент не работает. Если значение не указано в задаче, будет использовано значение переменной среды `ANSIBLE_NET_AUTH_PASS`.
	authorize логическое значение добавлен в 2.5.3	Варианты: нет ← да	Инструктирует модуль войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, будет использовано значение переменной среды `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 целое число добавлен в 2.3	Значение по умолчанию: 10	Указывает тайм-аут в секундах для связи с сетевым устройством при подключении или отправке команд. Если тайм-аут истечёт до завершения операции, модуль выдаст ошибку. NX-API может медленно возвращать данные при длительных командах (sh mac, sh bgp и т.д.).
	transport строка / обязательно	Варианты: cli ← nxapi	Настраивает протокол подключения для соединения с удалённым устройством. Аргумент transport поддерживает подключение к устройству через cli (ssh) или nxapi.
	use_proxy логическое значение добавлен в 2.5	Варианты: нет да ←	Если `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
- nxos_snmp_contact:
    contact: Test
    state: present

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

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

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

Статус

Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается командой Ansible 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.8/modules/nxos_snmp_contact_module.html