cisco.meraki.organizations_assurance_alerts_overview_info module – Информационный модуль для organizations _assurance _alerts _overview

Примечание

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

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

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

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

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

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

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

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

Примечание

Для этого модуля предусмотрен соответствующий модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
active логическое значение	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Active. Необязательный параметр для фильтрации активных оповещений; по умолчанию — true. Допустимые значения: `false` `true`
category строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Category. Необязательный параметр для фильтрации по категории.
deviceTags список / элементы=строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса DeviceTags. Необязательный параметр для фильтрации по тегам устройств.
deviceTypes список / элементы=строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса DeviceTypes. Необязательный параметр для фильтрации по типам устройств.
dismissed логическое значение	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Dismissed. Необязательный параметр для фильтрации отклонённых оповещений; по умолчанию — false. Допустимые значения: `false` `true`
headers словарь	Дополнительные заголовки.
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 (целое число), время ожидания перед повтором при ошибке Nginx 429 По умолчанию: `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 строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса NetworkId. Необязательный параметр для фильтрации обзора оповещений по идентификаторам сетей.
organizationId строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр пути OrganizationId. Идентификатор организации.
resolved логическое значение	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Resolved. Необязательный параметр для фильтрации разрешённых оповещений; по умолчанию — false. Допустимые значения: `false` `true`
serials список / элементы=строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Serials. Необязательный параметр для фильтрации по серийному номеру основного устройства.
severity строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Severity. Необязательный параметр для фильтрации обзора оповещений по уровню серьёзности.
suppressAlertsForOfflineNodes логическое значение	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса SuppressAlertsForOfflineNodes. Если задано значение true, API будет возвращать для устройства только оповещения о подключении, если это устройство находится в автономном состоянии. Это относится только к устройствам. Параметр игнорируется, если resolved имеет значение true. Например, если у коммутатора обнаружено несоответствие VLAN и он недоступен, будет возвращено только оповещение о недоступности. По умолчанию — false. Допустимые значения: `false` `true`
tsEnd строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса TsEnd. Необязательный параметр для фильтрации по конечной временной метке.
tsStart строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса TsStart. Необязательный параметр для фильтрации по начальной временной метке.
types список / элементы=строка	Информационный модуль для получения обзора оповещений Assurance организации. Параметр запроса Types. Необязательный параметр для фильтрации по типу оповещения.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _assurance _alerts _overview
  cisco.meraki.organizations_assurance_alerts_overview_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 }}"
    networkId: string
    severity: string
    types: []
    tsStart: string
    tsEnd: string
    category: string
    serials: []
    deviceTypes: []
    deviceTags: []
    active: true
    dismissed: true
    resolved: true
    suppressAlertsForOfflineNodes: true
    organizationId: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"bySeverity": [{"count": 0, "type": "string"}], "total": 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_info_module.html