Модуль cisco.dnac.event_snmp_config_info – Информационный модуль для Event Snmp Config

Примечание

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

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

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

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

Новое в cisco.dnac 6.7.0

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

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

Получить все конфигурации Event Snmp.
Получить назначение SNMP.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.9

Параметры

Параметр	Комментарии
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 integer	Параметр запроса limit. Количество конфигураций SNMP для ограничения в результирующем наборе, значение по умолчанию 10.
offset integer	Параметр запроса 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/event/snmp-config,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

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

Примеры

- name: Get all Event Snmp Config
  cisco.dnac.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 Возвращается: всегда Пример: `{"apiStatus": "string", "errorMessage": {"errors": ["string"]}, "statusMessage": [{"authPassword": "string", "community": "string", "configId": "string", "description": "string", "ipAddress": "string", "name": "string", "port": 0, "privacyPassword": "string", "snmpAuthType": "string", "snmpMode": "string", "snmpPrivacyType": "string", "snmpVersion": "string", "tenantId": "string", "userName": "string", "version": "string"}]}`

Ключ

Описание

dnac_response

словарь

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

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

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

Авторы

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/event_snmp_config_info_module.html