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

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

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

Описание

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

Параметры

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

Примеры

# ensure snmp host is configured
- nxos_snmp_host:
    snmp_host: 3.3.3.3
    community: TESTING
    state: present

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

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

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

Статус

Этот модуль помечен как превью, что означает, что его интерфейс не гарантируется как обратной совместимости.

Поддержка

Дополнительную информацию о поддержке этого модуля 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.5/modules/nxos_snmp_host_module.html