модуль cisco.meraki.networks_sensor_alerts_overview_by_metric_info — информационный модуль для networks _sensor _alerts _overview _bymetric

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам.
Получить все networks _sensor _alerts _overview _bymetric.
Возвращает обзор возникновения предупреждений по метрикам за указанный период.

Примечание

Этому модулю соответствует модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers словарь	Дополнительные заголовки.
interval целое число	Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам. Параметр запроса interval. Интервал времени в секундах для возвращаемых данных. Допустимые значения интервала: 900, 3600, 86400, 604800, 2592000. Значение по умолчанию — 604800. Если указаны параметры времени, интервал рассчитывается автоматически.
meraki_action_batch_retry_wait_time целое число	meraki_action_batch_retry_wait_time (целое число), время ожидания перед повтором при ошибке параллельного выполнения пакета действий По умолчанию: `60`
meraki_api_key строка / обязательный	meraki_api_key (строка), ключ API, созданный на панели управления; также можно задать как переменную среды MERAKI_DASHBOARD_API_KEY
meraki_base_url строка	meraki_base_url (строка), базовый URL для всех конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id строка	meraki_be_geo_id (строка), необязательный идентификатор партнёра для отслеживания использования API; также можно задать как переменную среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path строка	meraki_certificate_path (строка), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config логическое значение	meraki_inherit_logging_config (логическое значение), наследовать экземпляр вашего регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix строка	meraki_log_file_prefix (строка), имя файла журнала с добавленными датой и временем По умолчанию: `"meraki_api_"`
meraki_log_path строка	log_path (строка), путь для выходного журнала; если не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries целое число	meraki_maximum_retries (целое число), максимальное количество повторных попыток при получении ошибок 429 или других ошибок на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time целое число	meraki_nginx_429_retry_wait_time (целое число), время ожидания перед повтором после ошибки 429 от Nginx По умолчанию: `60`
meraki_output_log логическое значение	meraki_output_log (логическое значение), создавать выходной файл журнала? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console логическое значение	meraki_print_console (логическое значение), выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy строка	meraki_requests_proxy (строка), адрес и порт прокси-сервера для HTTPS, если он требуется По умолчанию: `""`
meraki_retry_4xx_error логическое значение	meraki_retry_4xx_error (логическое значение), повторять запрос при других ошибках 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time целое число	meraki_retry_4xx_error_wait_time (целое число), время ожидания перед повтором после другой ошибки 4XX По умолчанию: `60`
meraki_simulate логическое значение	meraki_simulate (логическое значение), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout целое число	meraki_single_request_timeout (целое число), максимальное время выполнения каждого вызова API в секундах По умолчанию: `60`
meraki_suppress_logging логическое значение	meraki_suppress_logging (логическое значение), отключить ведение журнала? Тогда действуйте на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages логическое значение	meraki_use_iterator_for_get_pages (логическое значение), методы list* будут возвращать итератор с каждым объектом вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit логическое значение	meraki_wait_on_rate_limit (логическое значение), повторять запрос при ошибке ограничения частоты запросов 429? Варианты: `false` `true` ← (по умолчанию)
networkId строка	Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам. Параметр пути NetworkId. Идентификатор сети.
t0 строка	Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам. Параметр запроса T0. Начало периода, за который собираются данные. Максимальная глубина просмотра — 731 день от текущей даты.
t1 строка	Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам. Параметр запроса T1. Конец периода, за который собираются данные. Значение T1 может быть не более чем на 366 дней позже t0.
timespan число с плавающей точкой	Информационный модуль для получения сведений об обзоре предупреждений датчиков сети по метрикам. Параметр запроса Timespan. Период, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 366 дней. Значение по умолчанию — 7 дней. Если указан interval, период рассчитывается автоматически.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _sensor _alerts _overview _bymetric
  cisco.meraki.networks_sensor_alerts_overview_by_metric_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 }}"
    t0: string
    t1: string
    timespan: 0
    interval: 0
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"counts\": {\n \"apparentPower\": 0,\n \"co2\": 0,\n \"current\": 0,\n \"door\": 0,\n \"frequency\": 0,\n \"humidity\": 0,\n \"indoorAirQuality\": 0,\n \"noise\": {\n \"ambient\": 0\n },\n \"pm25\": 0,\n \"powerFactor\": 0,\n \"realPower\": 0,\n \"temperature\": 0,\n \"tvoc\": 0,\n \"upstreamPower\": 0,\n \"voltage\": 0,\n \"water\": 0\n }\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"counts\": {\n \"apparentPower\": 0,\n \"co2\": 0,\n \"current\": 0,\n \"door\": 0,\n \"frequency\": 0,\n \"humidity\": 0,\n \"indoorAirQuality\": 0,\n \"noise\": {\n \"ambient\": 0\n },\n \"pm25\": 0,\n \"powerFactor\": 0,\n \"realPower\": 0,\n \"temperature\": 0,\n \"tvoc\": 0,\n \"upstreamPower\": 0,\n \"voltage\": 0,\n \"water\": 0\n }\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_sensor_alerts_overview_by_metric_info_module.html