Spec-Zone.ru › Ansible

cisco.dnac.event_series_audit_logs_info модуль — Модуль информации для журналов аудита серии событий

Примечание

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

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

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

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

Новый в cisco.dnac 3.1.0

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

Обзор

  • Получить все журналы аудита серии событий.
  • Получить экземпляры событий журналов аудита из Event-Hub.

Примечание

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

Требования

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

  • dnacentersdk >= 2.7.2
  • python >= 3.5

Параметры

Параметр

Комментарии

category

string

Параметр запроса категории. Категория события уведомления журнала аудита. Поддерживаемые значения INFO, WARN, ERROR, ALERT, TASK_PROGRESS, TASK_FAILURE, TASK_COMPLETE, COMMAND, QUERY, CONVERSATION.

context

string

Параметр запроса контекста. correlationId события уведомления журнала аудита.

description

string

Параметр запроса описания. Полный/частичный поиск строки - (предоставленная входная строка сопоставляется без учёта регистра для записей).

deviceId

string

Параметр запроса DeviceId. deviceId уведомления журнала аудита.

dnac_debug

boolean

Флаг для Cisco DNA Center SDK для включения отладки.

Варианты:

  • false ← (default)
  • true

dnac_host

string / required

Имя хоста Cisco DNA Center.

dnac_password

string

Пароль Cisco DNA Center для аутентификации.

dnac_port

integer

Порт Cisco DNA Center.

По умолчанию: 443

dnac_username

aliases: user

string

Имя пользователя Cisco DNA Center для аутентификации.

По умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (default)

dnac_version

string

Информирует SDK о том, какую версию Cisco DNA Center использовать.

По умолчанию: "2.3.7.6"

domain

string

Параметр запроса домена. Домен события уведомления журнала аудита.

endTime

float

Параметр запроса endTime. Конечное время в миллисекундах с момента эпохи, например, 1597961437211 (при указании startTime startTime является обязательным).

eventHierarchy

string

Параметр запроса eventHierarchy. eventHierarchy события уведомления журнала аудита. Пример «US.CA.San Jose» ИЛИ «US.CA» ИЛИ «CA.San Jose» - Разделитель для разделения иерархии - «.».

eventId

string

Параметр запроса eventId. ID события уведомления журнала аудита.

headers

dictionary

Дополнительные заголовки.

instanceId

string

Параметр запроса InstanceId. InstanceID журнала аудита.

isSystemEvents

boolean

Параметр запроса IsSystemEvents. Параметр для фильтрации журналов аудита, созданных системой.

Варианты:

  • false
  • true

limit

float

Параметр запроса limit. Количество записей журнала аудита, которые должны быть возвращены на одну страницу.

name

string

Параметр запроса name. Имя события уведомления журнала аудита.

offset

float

Параметр запроса offset. Позиция конкретной записи журнала аудита в данных.

order

string

Параметр запроса order. Порядок отсортированных записей журнала аудита. Значение по умолчанию - desc по метке времени. Поддерживаемые значения asc, desc.

parentInstanceId

string

Параметр запроса ParentInstanceId. instanceID родительской записи журнала аудита.

severity

string

Параметр запроса severity. Уровень события уведомления аудита журнала. Поддерживаемые значения 1, 2, 3, 4, 5.

siteId

string

Параметр запроса siteId. Идентификатор сайта уведомления аудита журнала.

sortBy

string

Параметр запроса sortBy. Сортировка журналов аудита по определенным полям. Поддерживаемые значения — атрибуты заголовка уведомления о событии.

source

string

Параметр запроса source. Источник события уведомления аудита журнала.

startTime

float

Параметр запроса startTime. Начальное время в миллисекундах с эпохи, например, 1597950637211 (при указании endTime обязательно).

subDomain

string

Параметр запроса subDomain. Поддомен события уведомления аудита журнала.

userId

string

Параметр запроса userId. Идентификатор пользователя события уведомления аудита журнала.

validate_response_schema

boolean

Флаг для Cisco DNA Center SDK, который включает проверку запросов по JSON-схеме.

Варианты:

  • false
  • true ← (по умолчанию)

Примечания

Примечание

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

См. также

См. также

Документация Cisco DNA Center по управлению событиями GetAuditLogRecords

Полное описание API GetAuditLogRecords.

Примеры

- name: Get all Event Series Audit Logs
  cisco.dnac.event_series_audit_logs_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}}"
    parentInstanceId: string
    instanceId: string
    name: string
    eventId: string
    category: string
    severity: string
    domain: string
    subDomain: string
    source: string
    userId: string
    context: string
    eventHierarchy: string
    siteId: string
    deviceId: string
    isSystemEvents: True
    description: string
    offset: 0
    limit: 0
    startTime: 0
    endTime: 0
    sortBy: string
    order: string
  register: result

Возвращаемые значения

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

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n  {\n    \"version\": \"string\",\n    \"instanceId\": \"string\",\n    \"eventId\": \"string\",\n    \"namespace\": \"string\",\n    \"name\": \"string\",\n    \"description\": \"string\",\n    \"type\": \"string\",\n    \"category\": \"string\",\n    \"domain\": \"string\",\n    \"subDomain\": \"string\",\n    \"severity\": 0,\n    \"source\": \"string\",\n    \"timestamp\": 0,\n    \"tags\": [\n      {}\n    ],\n    \"details\": {},\n    \"ciscoDnaEventLink\": \"string\",\n    \"note\": \"string\",\n    \"tntId\": \"string\",\n    \"context\": \"string\",\n    \"userId\": \"string\",\n    \"i18n\": \"string\",\n    \"eventHierarchy\": \"string\",\n    \"message\": \"string\",\n    \"messageParams\": \"string\",\n    \"additionalDetails\": {},\n    \"parentInstanceId\": \"string\",\n    \"network\": \"string\",\n    \"childCount\": 0,\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_series_audit_logs_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API