Модуль cisco.meraki.networks_alerts_history_info — информационный модуль для истории оповещений сети

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об истории оповещений сети.
Получает историю оповещений всех сетей.
Возвращает историю оповещений для этой сети.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление постраничной навигации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений об истории оповещений сети. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Он должен указываться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка), ключ API, созданный в панели управления; также его можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также его можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь к сертификату для проверки TLS/SSL при работе за локальным прокси-сервером По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение), наследовать ваш экземпляр регистратора Допустимые значения: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь для вывода журнала; если не задан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ответов 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повторной попыткой после ответа Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение), создавать файл журнала вывода? Допустимые значения: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение), выводить журнал в консоль? Допустимые значения: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка), прокси-сервер и порт для HTTPS, если требуется По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение), повторять запрос при получении других ошибок 4XX (кроме 429)? Допустимые значения: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повторной попыткой после другой ошибки 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Допустимые значения: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число), максимальное время в секундах для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение), отключить ведение всех журналов? Тогда вы действуете на свой страх и риск! Допустимые значения: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение), методы list* возвращают итератор с отдельными объектами вместо полного списка всех элементов Допустимые значения: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Допустимые значения: `false` `true` ← (по умолчанию)
networkId string	Информационный модуль для получения сведений об истории оповещений сети. Параметр пути NetworkId. Идентификатор сети.
perPage integer	Информационный модуль для получения сведений об истории оповещений сети. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон — от 3 до 1000. Значение по умолчанию — 100.
startingAfter string	Информационный модуль для получения сведений об истории оповещений сети. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Он должен указываться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

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

См. также

Документация Cisco Meraki по методу networks getNetworkAlertsHistory: Полный справочник по API getNetworkAlertsHistory.

Примеры

- name: Get all networks _alerts _history
  cisco.meraki.networks_alerts_history_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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"occurredAt\": \"string\",\n \"alertTypeId\": \"string\",\n \"alertType\": \"string\",\n \"device\": {\n \"serial\": \"string\"\n },\n \"destinations\": {\n \"email\": {\n \"sentAt\": \"string\"\n },\n \"push\": {\n \"sentAt\": \"string\"\n },\n \"sms\": {\n \"sentAt\": \"string\"\n },\n \"webhook\": {\n \"sentAt\": \"string\"\n }\n },\n \"alertData\": {}\n }\n]\n"

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n {\n \"occurredAt\": \"string\",\n \"alertTypeId\": \"string\",\n \"alertType\": \"string\",\n \"device\": {\n \"serial\": \"string\"\n },\n \"destinations\": {\n \"email\": {\n \"sentAt\": \"string\"\n },\n \"push\": {\n \"sentAt\": \"string\"\n },\n \"sms\": {\n \"sentAt\": \"string\"\n },\n \"webhook\": {\n \"sentAt\": \"string\"\n }\n },\n \"alertData\": {}\n }\n]\n"

Авторы

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_alerts_history_info_module.html