модуль cisco.meraki.organizations_assurance_alerts_overview_historical_info — информационный модуль для organizations _assurance _alerts _overview _historical

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации.
Получает все organizations _assurance _alerts _overview _historical.
Возвращает сводки исторических оповещений о состоянии.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
category string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса Category. Необязательный параметр для фильтрации по категории.
deviceTypes list / elements=string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса DeviceTypes. Необязательный параметр для фильтрации по типам устройств.
headers dictionary	Дополнительные заголовки.
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	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса NetworkId. Необязательный параметр для фильтрации обзора оповещений по идентификаторам сетей.
organizationId string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр пути OrganizationId. Идентификатор организации.
segmentDuration integer	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса SegmentDuration. Продолжительность каждого сегмента в возвращаемом наборе данных, в секундах.
serials list / elements=string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса Serials. Необязательный параметр для фильтрации по серийному номеру основного устройства.
severity string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса Severity. Необязательный параметр для фильтрации обзора оповещений по степени серьёзности.
tsEnd string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса TsEnd. Необязательный параметр для фильтрации по конечной временной метке; по умолчанию используется текущее время.
tsStart string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса TsStart. Параметр для определения начальной временной метки исторических итоговых данных.
types list / elements=string	Информационный модуль для получения исторических сведений об обзоре оповещений Assurance организации. Параметр запроса Types. Необязательный параметр для фильтрации по типу оповещения.

Примечания

Примечание

Используемый метод SDK: organizations.Organizations.get_organization_assurance_alerts_overview_historical,
Используемые пути: get /organizations/{organizationId}/assurance/alerts/overview/historical,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления подключения

См. также

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

Примеры

- name: Get all organizations _assurance _alerts _overview _historical
  cisco.meraki.organizations_assurance_alerts_overview_historical_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 }}"
    segmentDuration: 0
    networkId: string
    severity: string
    types: []
    tsStart: string
    tsEnd: string
    category: string
    serials: []
    deviceTypes: []
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"items": [{"byAlertType": [{"critical": 0, "informational": 0, "type": "string", "warning": 0}], "segmentStart": "string", "totals": {"critical": 0, "informational": 0, "warning": 0}}], "meta": {"counts": {"items": 0}}}`

Авторы

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/organizations_assurance_alerts_overview_historical_info_module.html