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

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

Описание

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
community -			Строка сообщества или имя пользователя v3.
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	Варианты: нет ← да	Указывает модулю войти в привилегированный режим на удалённом устройстве перед отправкой команд. Если не указано, устройство попытается выполнить все команды в режиме без привилегий. Если значение не указано в задаче, используется значение переменной окружения `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`, переменные среды `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	Используйте этот параметр, когда версия 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 Network Guide
Дополнительную информацию по использованию Ansible для управления устройствами Cisco см. на странице интеграции Cisco.

Примеры

# ensure snmp host is configured
- 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']

Статус

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