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

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

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
community -			Строка сообщества или имя пользователя v3.
provider -			Устарело Начиная с Ansible 2.5 рекомендуется использовать `connection: network_cli`. Этот параметр необходим только при использовании NX-API. Дополнительную информацию см. в руководстве NXOS Platform Options. Объект типа dict, содержащий сведения о подключении.
	auth_pass - добавлен в 2.5.3	По умолчанию: "none"	Указывает пароль, необходимый для входа в привилегированный режим на удалённом устройстве. Если authorize равно false, этот аргумент не имеет действия. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_AUTH_PASS`.
	authorize boolean добавлен в 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 - добавлен в 2.3	По умолчанию: 10	Указывает таймаут в секундах для связи с сетевым устройством при подключении или отправке команд. Если таймаут истекает до завершения операции, модуль вернёт ошибку. NX-API может медленно реагировать на длительные команды (sh mac, sh bgp и т.д.).
	transport - / обязательно	По умолчанию: "cli"	Настраивает транспортное соединение для подключения к удалённому устройству. Аргумент transport поддерживает подключение к устройству по протоколам cli (ssh) или nxapi.
	use_proxy boolean добавлен в 2.5	Варианты: no yes ←	Если `no`, переменные среды `http_proxy` и `https_proxy` будут проигнорированы.
	use_ssl boolean	Варианты: no ← yes	Настраивает транспорт transport для использования SSL, если значение true, только при `transport=nxapi`, в противном случае это значение игнорируется.
	username -		Настраивает имя пользователя для проверки подлинности подключения к удалённому устройству. Это значение используется для проверки подлинности входа CLI или аутентификации nxapi в зависимости от используемого транспорта. Если значение не указано в задаче, будет использовано значение переменной окружения `ANSIBLE_NET_USERNAME`.
	validate_certs boolean	Варианты: no yes	Если `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 для использования в качестве источника трафика.
vrf_filter -			Имя 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.7/modules/nxos_snmp_host_module.html