Модуль cisco.dnac.dna_event_snmp_config_info – Информационный модуль для конфигурации SNMP событий Dna

Примечание

Этот модуль является частью коллекции cisco.dnac (версия 6.20.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля требуются дополнительные компоненты, см. Требования для получения подробной информации.

Для использования в playbook, укажите: cisco.dnac.dna_event_snmp_config_info.

Новое в cisco.dnac 6.14.0

Краткое описание
Требования
Параметры
Примечания
См. также
Примеры
Возвращаемые значения

Краткое описание

Получить все конфигурации SNMP событий Dna.
Получить назначение SNMP.

Примечание

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

Требования

Указанные ниже требования необходимы на хосте, который выполняет этот модуль.

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
configId string	Параметр запроса ConfigId. Список конфигураций SNMP.
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Информирует SDK о том, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
limit float	Параметр запроса limit. Количество конфигураций SNMP для ограничения в результирующем наборе, значение по умолчанию 10.
offset float	Параметр запроса offset. Количество конфигураций SNMP для смещения в результирующем наборе, значение по умолчанию 0.
order string	Параметр запроса order.
sortBy string	Параметр запроса sortBy. Имя поля для сортировки.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: event_management.EventManagement.get_snmp_destination,
Используемые пути: get /dna/intent/api/v1/dna-event/snmp-config,
Поддерживает check_mode
Плагин работает на узле управления и не использует какие-либо плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для управления событиями GetSNMPDestination: Полная справка по API GetSNMPDestination.

Примеры

- name: Get all Dna Event Snmp Config
  cisco.dnac.dna_event_snmp_config_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    configId: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

Значения возврата

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"version\": \"string\",\n \"tenantId\": \"string\",\n \"configId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ipAddress\": \"string\",\n \"port\": 0,\n \"snmpVersion\": \"string\",\n \"community\": \"string\",\n \"userName\": \"string\",\n \"snmpMode\": \"string\",\n \"snmpAuthType\": \"string\",\n \"authPassword\": \"string\",\n \"snmpPrivacyType\": \"string\",\n \"privacyPassword\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

список / элементы=словарь

Словарь или список с ответом, возвращённым Cisco DNAC Python SDK

Возвращается: всегда

Пример: "[\n {\n \"version\": \"string\",\n \"tenantId\": \"string\",\n \"configId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"ipAddress\": \"string\",\n \"port\": 0,\n \"snmpVersion\": \"string\",\n \"community\": \"string\",\n \"userName\": \"string\",\n \"snmpMode\": \"string\",\n \"snmpAuthType\": \"string\",\n \"authPassword\": \"string\",\n \"snmpPrivacyType\": \"string\",\n \"privacyPassword\": \"string\"\n }\n]\n"

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/dnac/dna_event_snmp_config_info_module.html