Модуль cisco.meraki.networks_events_info — модуль сведений о событиях сетей

Примечание

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

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

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

Чтобы использовать модуль в плейбуке, укажите: cisco.meraki.networks_events_info.

Добавлено в cisco.meraki 1.0.0

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

Краткое описание

Модуль сведений о событиях сетей.
Получение всех событий сетей.
Вывод списка событий для сети.

Примечание

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

Требования

Следующие компоненты должны быть установлены на узле, на котором выполняется этот модуль.

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clientIp string	Модуль сведений о событиях сетей. Параметр запроса ClientIp. IP-адрес клиента, по которому будет фильтроваться список событий. Поддерживается только для сетей, отслеживающих клиентов по IP-адресу.
clientMac string	Модуль сведений о событиях сетей. Параметр запроса ClientMac. MAC-адрес клиента, по которому будет фильтроваться список событий. Поддерживается только для сетей, отслеживающих клиентов по MAC-адресу.
clientName string	Модуль сведений о событиях сетей. Параметр запроса ClientName. Имя клиента или его часть, по которым будет фильтроваться список событий.
deviceMac string	Модуль сведений о событиях сетей. Параметр запроса DeviceMac. MAC-адрес устройства Meraki, по которому будет фильтроваться список событий.
deviceName string	Модуль сведений о событиях сетей. Параметр запроса DeviceName. Имя устройства Meraki, по которому будет фильтроваться список событий.
deviceSerial string	Модуль сведений о событиях сетей. Параметр запроса DeviceSerial. Серийный номер устройства Meraki, по которому будет фильтроваться список событий.
direction string	direction (string), направление перехода по страницам: “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Модуль сведений о событиях сетей. Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует получать из ссылки на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
eventDetails string	Модуль сведений о событиях сетей. Параметр запроса EventDetails. Сведения о событии (только для устройств Catalyst), по которым будет фильтроваться список событий.
eventSeverity string	Модуль сведений о событиях сетей. Параметр запроса EventSeverity. Уровень важности события (только для устройств Catalyst), по которому будет фильтроваться список событий.
excludedEventTypes list / elements=string	Модуль сведений о событиях сетей. Параметр запроса ExcludedEventTypes. Список типов событий. Из возвращаемых событий будут исключены события этих типов.
headers dictionary	Дополнительные заголовки.
includedEventTypes list / elements=string	Модуль сведений о событиях сетей. Параметр запроса IncludedEventTypes. Список типов событий. В возвращаемые события будут включены только события этих типов.
isCatalyst boolean	Модуль сведений о событиях сетей. Параметр запроса IsCatalyst. Логическое значение, указывающее, является ли устройство устройством Catalyst. Для устройств Catalyst можно фильтровать события по параметрам eventDetails и eventSeverity. Допустимые значения: `false` `true`
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельной обработки пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (string), ключ API, созданный в панели управления; также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнёра для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследовать экземпляр вашего регистратора Допустимые значения: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала с добавленными датой и меткой времени По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (string), путь для вывода журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (integer), количество повторных попыток при получении ответа 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (boolean), создавать файл журнала вывода? Допустимые значения: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (boolean), выводить журнал в консоль? Допустимые значения: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять запрос при получении других ошибок 4XX (кроме 429)? Допустимые значения: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать запросы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Допустимые значения: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить ведение журнала? Тогда вы действуете на свой страх и риск! Допустимые значения: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов Допустимые значения: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторять запрос при достижении ограничения частоты запросов (ошибка 429)? Допустимые значения: `false` `true` ← (по умолчанию)
networkId string	Модуль сведений о событиях сетей. Параметр пути NetworkId. Идентификатор сети.
perPage integer	Модуль сведений о событиях сетей. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 10.
productType string	Модуль сведений о событиях сетей. Параметр запроса ProductType. Тип продукта, для которого необходимо получить события. Этот параметр обязателен для сетей с несколькими типами устройств. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway, wirelessController, campusGateway и secureConnect.
smDeviceMac string	Модуль сведений о событиях сетей. Параметр запроса SmDeviceMac. MAC-адрес устройства Systems Manager, по которому будет фильтроваться список событий.
smDeviceName string	Модуль сведений о событиях сетей. Параметр запроса SmDeviceName. Имя устройства Systems Manager, по которому будет фильтроваться список событий.
startingAfter string	Модуль сведений о событиях сетей. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует получать из ссылки на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить все результаты в пределах total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используемые методы SDK: networks.Networks.get_network_events,
Используемые пути: get /networks/{networkId}/events,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений Cisco Meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco Meraki для установления подключения

См. также

Документация Cisco Meraki по методу getNetworkEvents для сетей: Полное описание API getNetworkEvents.

Примеры

- name: Get all networks _events
  cisco.meraki.networks_events_info:
    meraki_api_key: "{{ meraki_api_key }}"
    meraki_base_url: "{{ meraki_base_url }}"
    meraki_single_request_timeout: "{{ meraki_single_request_timeout }}"
    meraki_certificate_path: "{{ meraki_certificate_path }}"
    meraki_requests_proxy: "{{ meraki_requests_proxy }}"
    meraki_wait_on_rate_limit: "{{ meraki_wait_on_rate_limit }}"
    meraki_nginx_429_retry_wait_time: "{{ meraki_nginx_429_retry_wait_time }}"
    meraki_action_batch_retry_wait_time: "{{ meraki_action_batch_retry_wait_time }}"
    meraki_retry_4xx_error: "{{ meraki_retry_4xx_error }}"
    meraki_retry_4xx_error_wait_time: "{{ meraki_retry_4xx_error_wait_time }}"
    meraki_maximum_retries: "{{ meraki_maximum_retries }}"
    meraki_output_log: "{{ meraki_output_log }}"
    meraki_log_file_prefix: "{{ meraki_log_file_prefix }}"
    meraki_log_path: "{{ meraki_log_path }}"
    meraki_print_console: "{{ meraki_print_console }}"
    meraki_suppress_logging: "{{ meraki_suppress_logging }}"
    meraki_simulate: "{{ meraki_simulate }}"
    meraki_be_geo_id: "{{ meraki_be_geo_id }}"
    meraki_caller: "{{ meraki_caller }}"
    meraki_use_iterator_for_get_pages: "{{ meraki_use_iterator_for_get_pages }}"
    meraki_inherit_logging_config: "{{ meraki_inherit_logging_config }}"
    productType: string
    includedEventTypes: []
    excludedEventTypes: []
    deviceMac: string
    deviceSerial: string
    deviceName: string
    clientIp: string
    clientMac: string
    clientName: string
    smDeviceMac: string
    smDeviceName: string
    eventDetails: string
    eventSeverity: string
    isCatalyst: true
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"events": [{"category": "string", "clientDescription": "string", "clientId": "string", "clientMac": "string", "description": "string", "deviceName": "string", "deviceSerial": "string", "eventData": {"aid": "string", "channel": "string", "client_ip": "string", "client_mac": "string", "radio": "string", "rssi": "string", "vap": "string"}, "networkId": "string", "occurredAt": "string", "ssidNumber": 0, "type": "string"}], "message": "string", "pageEndAt": "string", "pageStartAt": "string"}`

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"events": [{"category": "string", "clientDescription": "string", "clientId": "string", "clientMac": "string", "description": "string", "deviceName": "string", "deviceSerial": "string", "eventData": {"aid": "string", "channel": "string", "client_ip": "string", "client_mac": "string", "radio": "string", "rssi": "string", "vap": "string"}, "networkId": "string", "occurredAt": "string", "ssidNumber": 0, "type": "string"}], "message": "string", "pageEndAt": "string", "pageStartAt": "string"}

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/meraki/networks_events_info_module.html