Модуль cisco.dnac.event_subscription_details_syslog_info – Модуль информации для получения данных подписки на Syslog событий

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.event_subscription_details_syslog_info.

Новое в cisco.dnac 3.1.0

Обзор
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Обзор

Получение всех данных подписки на Syslog событий.
Получение списка данных подписки для указанного типа соединителя (connectorType).

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательно	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Сообщает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers словарь	Дополнительные заголовки.
instanceId строка	Параметр запроса InstanceId. Идентификатор экземпляра конкретной конфигурации.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Event Subscription Details Syslog
  cisco.dnac.event_subscription_details_syslog_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}}"
    name: string
    instanceId: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco DNAC Возвращается: всегда Пример: `"[\n {\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"connectorType\": \"string\",\n \"syslogConfig\": {\n \"configId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"host\": \"string\",\n \"port\": \"string\",\n \"protocol\": \"string\"\n }\n }\n]\n"`

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"connectorType\": \"string\",\n \"syslogConfig\": {\n \"configId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"host\": \"string\",\n \"port\": \"string\",\n \"protocol\": \"string\"\n }\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/event_subscription_details_syslog_info_module.html