Модуль cisco.dnac.event_subscription_rest_info – Модуль информации для Event Subscription Rest

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.dnac.event_subscription_rest_info.

Новая функция в cisco.dnac 3.1.0

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

Описание

Получение всех Event Subscription Rest.
Получение списка Rest/Webhook подписок на основе предоставленных параметров запроса.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
category строка	Параметр запроса категории. Список подписок, относящихся к соответствующей категории.
dnac_debug логическое значение	Флаг для 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 логическое значение	Флаг для включения или отключения проверки сертификатов SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
domain строка	Параметр запроса домена. Список подписок, относящихся к соответствующему домену.
... (остальные строки)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Event Subscription Rest
  cisco.dnac.event_subscription_rest_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}}"
    eventIds: string
    offset: 0
    limit: 0
    sortBy: string
    order: string
    domain: string
    subDomain: string
    category: string
    type: string
    name: string
  register: result

END_OF_DOCUMENT_MARKER

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco DNAC Возвращается: всегда Пример: "[\n {\n \"version\": \"string\",\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"subscriptionEndpoints\": [\n {\n \"instanceId\": \"string\",\n \"subscriptionDetails\": {\n \"connectorType\": \"string\",\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"url\": \"string\",\n \"basePath\": \"string\",\n \"resource\": \"string\",\n \"method\": \"string\",\n \"trustCert\": \"string\",\n \"headers\": [\n {\n \"string\": \"string\"\n }\n ],\n \"queryParams\": [\n {\n \"string\": \"string\"\n }\n ],\n \"pathParams\": [\n {\n \"string\": \"string\"\n }\n ],\n \"body\": \"string\",\n \"connectTimeout\": \"string\",\n \"readTimeout\": \"string\"\n },\n \"connectorType\": \"string\"\n }\n ],\n \"filter\": {\n \"eventIds\": [\n \"string\"\n ],\n \"others\": [\n \"string\"\n ],\n \"domainsSubdomains\": [\n {\n \"domain\": \"string\",\n \"subDomains\": [\n \"string\"\n ]\n }\n ],\n \"types\": [\n \"string\"\n ],\n \"categories\": [\n \"string\"\n ],\n \"severities\": [\n \"string\"\n ],\n \"sources\": [\n \"string\"\n ],\n \"siteIds\": [\n \"string\"\n ]\n },\n \"isPrivate\": \"string\",\n \"tenantId\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"version\": \"string\",\n \"subscriptionId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"subscriptionEndpoints\": [\n {\n \"instanceId\": \"string\",\n \"subscriptionDetails\": {\n \"connectorType\": \"string\",\n \"instanceId\": \"string\",\n \"name\": \"string\",\n \"description\": \"string\",\n \"url\": \"string\",\n \"basePath\": \"string\",\n \"resource\": \"string\",\n \"method\": \"string\",\n \"trustCert\": \"string\",\n \"headers\": [\n {\n \"string\": \"string\"\n }\n ],\n \"queryParams\": [\n {\n \"string\": \"string\"\n }\n ],\n \"pathParams\": [\n {\n \"string\": \"string\"\n }\n ],\n \"body\": \"string\",\n \"connectTimeout\": \"string\",\n \"readTimeout\": \"string\"\n },\n \"connectorType\": \"string\"\n }\n ],\n \"filter\": {\n \"eventIds\": [\n \"string\"\n ],\n \"others\": [\n \"string\"\n ],\n \"domainsSubdomains\": [\n {\n \"domain\": \"string\",\n \"subDomains\": [\n \"string\"\n ]\n }\n ],\n \"types\": [\n \"string\"\n ],\n \"categories\": [\n \"string\"\n ],\n \"severities\": [\n \"string\"\n ],\n \"sources\": [\n \"string\"\n ],\n \"siteIds\": [\n \"string\"\n ]\n },\n \"isPrivate\": \"string\",\n \"tenantId\": \"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/event_subscription_rest_info_module.html