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

Примечание

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

Для его установки используйте: 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, для NX-API рекомендуется использовать `connection: httpapi`. Этот параметр будет удален в релизе после 2022-06-01. Для получения дополнительной информации см. руководство по вариантам платформы NXOS. Объект словаря, содержащий данные соединения.
	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	Используйте это, когда версия 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
Для получения дополнительной информации об использовании 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/nxos/nxos_snmp_host_module.html