cisco.nxos.nxos_snmp_host – Управляет конфигурацией хоста SNMP.

Примечание

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

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

Для использования в плейбуке укажите: cisco.nxos.nxos_snmp_host

Новое в версии 1.0.0: модуля cisco.nxos

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

Обзор

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

Примечание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
community строка			Строка сообщества или имя пользователя v3.
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, это значение игнорируется.
snmp_host строка / обязательно			IP-адрес или имя хоста целевого хоста.
snmp_type строка		Варианты: trap inform	Тип сообщения, отправляемого хосту. Если не указано, используется тип trap.
src_intf строка			Исходный интерфейс. Должен быть полностью квалифицированным именем интерфейса. Если state = absent, интерфейс удаляется.
state строка		Варианты: present ← absent	Управляет состоянием ресурса. Если state = present, хост добавляется в конфигурацию. Если указаны только vrf и/или vrf_filter и/или src_intf, они будут добавлены в существующую конфигурацию хоста. Если state = absent, хост удаляется, если указан параметр community. Можно удалить только vrf и/или src_int и/или vrf_filter, указав только эти параметры без параметра community.
udp строка		Значение по умолчанию: 162	Номер порта UDP (0-65535).
v3 строка		Варианты: noauth auth priv	Используйте это, когда версия SNMP v3. Уровень безопасности SNMPv3.
version строка		Варианты: v1 v2c v3	Версия SNMP. Если не указано, используется v1.
vrf строка			VRF для отправки трафика источнику. Если state = absent, vrf удаляется.
vrf_filter строка			Имя VRF для фильтрации. Если state = absent, VRF удаляется из фильтра.

Примечания

Примечание

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

Примеры

# ensure snmp host is configured
- cisco.nxos.nxos_snmp_host:
    snmp_host: 192.0.2.3
    community: TESTING
    state: present

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

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

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

Авторы

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.10/collections/cisco/nxos/nxos_snmp_host_module.html