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

Примечание

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

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

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

Чтобы использовать его в playbook, укажите: cisco.meraki.networks_sensor_alerts_overview_by_metric_info.

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

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

Обзор

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
headers dictionary	Дополнительные заголовки.
interval integer	Параметр интервала запроса. Временной интервал в секундах для возвращаемых данных. Допустимые интервалы: 86400, 604800. По умолчанию: 604800.
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), время ожидания повторной попытки при ошибке 429 Nginx 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 для предотвращения изменений? Варианты: `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. Идентификатор сети.
t0 string	Параметр запроса T0. Начало временного интервала для данных. Максимальный период ожидания — 365 дней с текущей даты.
t1 string	Параметр запроса T1. Конец временного интервала для данных. T1 может быть не более чем на 31 день после t0.
timespan float	Параметр запроса timespan. Временной интервал, для которого будут получены данные. При указании timespan не нужно указывать параметры t0 и t1. Значение должно быть в секундах и не превышать 31 дня. По умолчанию 7 дней.

Примечания

Примечание

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

См. также

Документация Cisco Meraki по сенсору 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_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 список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\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 \"endTs\": \"string\",\n \"startTs\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\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 \"endTs\": \"string\",\n \"startTs\": \"string\"\n }\n]\n"

Авторы

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