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

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

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

Требования

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

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

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Update all
  cisco.dnac.event_subscription_syslog:
    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_syslog:
    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_syslog_module.html