Модуль cisco.dnac.event_subscription_info – Модуль информации для подписки на события

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

Получить все подписки на события.
Получить список подписок на основе предоставленных смещения и ограничения. Устарело.

Примечание

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

Требования

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

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"`
eventIds string	Параметр запроса eventIds. Список подписок, относящихся к соответствующим eventIds.
headers словарь	Дополнительные заголовки.
limit float	Параметр запроса limit. Количество подписок, которые следует ограничить в результирующем наборе, значение по умолчанию 10.
offset float	Параметр запроса offset. Количество подписок, которые следует сместить в результирующем наборе, значение по умолчанию 0.
order string	Параметр запроса order.
sortBy string	Параметр запроса sortBy. Имя сортируемого поля.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK, чтобы включить проверку тел запросов по схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all Event Subscription
  cisco.dnac.event_subscription_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
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: "[\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\": true,\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\": 0,\n \"readTimeout\": 0\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\": true,\n \"tenantId\": \"string\"\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\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\": true,\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\": 0,\n \"readTimeout\": 0\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\": true,\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_info_module.html