cisco.dnac.event_subscription модуль — Модуль ресурсов для подписки на события

Примечание

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

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

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

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

Добавлен в cisco.dnac 3.1.0

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

Обзор

Управление операциями создания, обновления и удаления ресурса «Подписка на события».
Подписка SubscriptionEndpoint на список зарегистрированных событий (Устаревшее).
Удаление EventSubscriptions.
Обновление SubscriptionEndpoint для списка зарегистрированных событий (Устаревшее).

Примечание

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

Требования

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

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 / элементы=словарь	Нагрузка подписки на события.
description string	Описание.
filter dictionary	Фильтр подписки на события.
categories list / элементы=строка	Категории.
domainsSubdomains list / элементы=словарь	Домены и поддомены подписки на события.
domain string	Домен.
subDomains list / элементы=строка	Поддомены.
eventIds list / элементы=строка	Идентификаторы событий (идентификаторы событий через запятую).
severities list / элементы=строка	Уровни серьезности.
siteIds list / элементы=строка	Идентификаторы сайтов.
sources list / элементы=строка	Источники.
types list / элементы=строка	Типы.
name string	Имя.
subscriptionEndpoints list / элементы=словарь	Конечные точки подписки на события.
instanceId string	(Из получения Rest/Webhook подписки на данные —> выберите instanceId).
subscriptionDetails dictionary	Подробные сведения о подписке на события.
connectorType string	Тип подключения (должен быть REST).

END_OF_DOCUMENT_MARKER

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Delete all
  cisco.dnac.event_subscription:
    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: absent
    subscriptions: string

- name: Update all
  cisco.dnac.event_subscription:
    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: Create
  cisco.dnac.event_subscription:
    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_module.html