cisco.meraki.networks_events_info модуль — Информационный модуль для событий сети

Примечание

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

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

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

Для использования в книге задач укажите: cisco.meraki.networks_events_info.

Новое в cisco.meraki 2.16.0

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

Обзор

Получить все события сети.
Получить список событий для сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clientIp string	Параметр запроса ClientIp. IP-адрес клиента, по которому будет отфильтрован список событий. Поддерживается только для сетей track-by-IP.
clientMac string	Параметр запроса ClientMac. MAC-адрес клиента, по которому будет отфильтрован список событий. Поддерживается только для сетей track-by-MAC.
clientName string	Параметр запроса ClientName. Имя или частичное имя клиента, по которому будет отфильтрован список событий.
deviceMac string	Параметр запроса DeviceMac. MAC-адрес устройства Meraki, по которому будет отфильтрован список событий.
deviceName string	Параметр запроса DeviceName. Имя устройства Meraki, по которому будет отфильтрован список событий.
deviceSerial string	Параметр запроса DeviceSerial. Серийный номер устройства Meraki, по которому будет отфильтрован список событий.
direction string	direction (string), направление для постраничной навигации, либо «next» (по умолчанию), либо «prev» страница Default: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен задаваться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link должна определять его.
excludedEventTypes list / elements=string	Параметр запроса ExcludedEventTypes. Список типов событий. Возвращаемые события будут отфильтрованы для исключения событий с этими типами.
headers dictionary	Дополнительные заголовки.
includedEventTypes list / elements=string	Параметр запроса IncludedEventTypes. Список типов событий. Возвращаемые события будут отфильтрованы для включения только событий с этими типами.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (integer), время ожидания повтора попытки при ошибке параллельной обработки пакета действий Default: `60`
meraki_api_key string / required	meraki_api_key (string), API ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (string), предшествует всем конечным точкам ресурсов Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (string), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (string), путь для проверки сертификата TLS/SSL, если используется локальный прокси-сервер Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (boolean), наследует ваш собственный экземпляр логгера Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (string), имя файла журнала, к которому добавляется дата и метка времени Default: `"meraki_api_"`
meraki_log_path string	log_path (string), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано Default: `""`

meraki_maximum_retries integer	meraki_maximum_retries (integer), повторить до такого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (integer), время ожидания повтора при ошибке Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (boolean), создать файл журнала вывода? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (boolean), выводить сообщения журнала в консоль? Choices: `false` `true` ← (default)
meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторять попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора при других ошибках 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все ведение журнала? тогда вы сами за себя отвечаете! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку, если обнаружена ошибка ограничения скорости 429? Choices: `false` `true` ← (default)
networkId string	NetworkId параметр пути. Идентификатор сети.
perPage integer	PerPage параметр запроса. Количество записей на страницу. Допустимый диапазон — от 3 до 1000. По умолчанию — 10.
productType string	ProductType параметр запроса. Тип продукта для получения событий. Этот параметр обязателен для сетей с несколькими типами устройств. Допустимые типы: wireless, appliance, switch, systemsManager, camera и cellularGateway.
smDeviceMac string	SmDeviceMac параметр запроса. MAC-адрес устройства Systems Manager, по которому будет отфильтрован список событий.
smDeviceName string	SmDeviceName параметр запроса. Название устройства Systems Manager, по которому будет отфильтрован список событий.
startingAfter string	StartingAfter параметр запроса. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
total_pages string / required	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_, используются Cisco meraki Python SDK для установления подключения

См. также

Документация Cisco Meraki для networks 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_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
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список со значением возврата Cisco Meraki Python SDK Возвращается: всегда Пример: `{"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

словарь

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

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

Пример: {"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_events_info_module.html