Модуль cisco.dnac.event_subscription_rest – Модуль ресурса для REST-подписки на события

Примечание

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

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

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

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

Впервые в cisco.dnac 3.1.0

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

Описание

Управление операциями создания и обновления ресурса REST-подписки на события.
Создание конечной точки REST/Webhook-подписки для списка зарегистрированных событий.
Обновление конечной точки REST/Webhook-подписки для списка зарегистрированных событий.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, для включения отладки. Выбираемые значения: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Выбираемые значения: `false` `true` ← (по умолчанию)
dnac_version string	Уведомляет SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
payload list / элементы=словарь	Загрузка Event Subscription Rest.
description string	Описание.
filter dictionary	Фильтр Event Subscription Rest.
categories list / элементы=строка	Категории.
domainsSubdomains list / элементы=словарь	Области и поддомены Event Subscription Rest.
domain string	Домен.
subDomains list / элементы=строка	Поддомены.
eventIds list / элементы=строка	Идентификаторы событий (идентификаторы событий через запятую).
severities list / элементы=строка	Уровни критичности.
siteIds list / элементы=строка	Идентификаторы сайта.
sources list / элементы=строка	Источники.
types list / элементы=строка	Типы.
name string	Имя.
subscriptionEndpoints list / элементы=словарь	Подписки Event Subscription Rest.
instanceId string	(Из Подробные данные подписки REST/Webhook –> выбрать instanceId).
subscriptionDetails dictionary	Подробные данные подписки Event Subscription Rest.
connectorType string	Тип коннектора (должен быть REST).

subscriptionId string	Идентификатор подписки (уникальный UUID).
version string	Версия.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, позволяющий включить проверку запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Create
  cisco.dnac.event_subscription_rest:
    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}}"
    state: present
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - string
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
      subscriptionId: string
      version: string

- name: Update all
  cisco.dnac.event_subscription_rest:
    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}}"
    state: present
    payload:
    - description: string
      filter:
        categories:
        - string
        domainsSubdomains:
        - domain: string
          subDomains:
          - string
        eventIds:
        - string
        severities:
        - string
        siteIds:
        - string
        sources:
        - string
        types:
        - string
      name: string
      subscriptionEndpoints:
      - instanceId: string
        subscriptionDetails:
          connectorType: string
      subscriptionId: string
      version: string

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: `{"statusUri": "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_subscription_rest_module.html