Модуль cisco.meraki.organizations_assurance_alerts_overview_by_network_info — информационный модуль для обзора оповещений _assurance _alerts _overview _by _network организаций

Примечание

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

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

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

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

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

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

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

Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network.
Получение всех организаций _assurance _alerts _overview _by _network.
Возвращает сводку оповещений, сгруппированных по сети и уровню критичности.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
active boolean	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Active. Необязательный параметр для фильтрации активных оповещений; по умолчанию — true. Возможные значения: `false` `true`
category string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Category. Необязательный параметр для фильтрации по категории.
deviceTags list / elements=string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса DeviceTags. Необязательный параметр для фильтрации по тегам устройств.
deviceTypes list / elements=string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса DeviceTypes. Необязательный параметр для фильтрации по типам устройств.
direction string	direction (string), направление постраничной навигации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
dismissed boolean	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Dismissed. Необязательный параметр для фильтрации отклонённых оповещений; по умолчанию — false. Возможные значения: `false` `true`
endingBefore string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса EndingBefore. Токен, используемый сервером для указания конца страницы. Обычно это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
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	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса NetworkId. Необязательный параметр для фильтрации обзора оповещений по идентификатору сети.
organizationId string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
resolved boolean	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Resolved. Необязательный параметр для фильтрации по разрешённым оповещениям; по умолчанию — false. Возможные значения: `false` `true`
serials list / elements=string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Serials. Необязательный параметр для фильтрации по серийному номеру основного устройства.
severity string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Severity. Необязательный параметр для фильтрации обзора оповещений по уровню критичности.
sortOrder string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса SortOrder. Порядок сортировки записей. Возможные значения: ‘ascending’ и ‘descending’. По умолчанию используется ‘ascending’.
startingAfter string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Обычно это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
suppressAlertsForOfflineNodes boolean	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса SuppressAlertsForOfflineNodes. Если задано значение true, API вернёт для устройства оповещения о подключении только в том случае, если устройство находится в автономном режиме. Это применимо только к устройствам. Если resolved имеет значение true, этот параметр игнорируется. Например, если у коммутатора обнаружено несовпадение VLAN и он недоступен, будет возвращено только оповещение о недоступности. По умолчанию — false. Возможные значения: `false` `true`
total_pages string / обязательный	total_pages(int), используйте вместе с perPage для получения общего числа результатов до total_pages*perPage; -1 — все страницы
tsEnd string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса TsEnd. Необязательный параметр для фильтрации по конечной временной метке.
tsStart string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса TsStart. Необязательный параметр для фильтрации по начальной временной метке.
types list / elements=string	Информационный модуль для получения обзора оповещений Organizations Assurance Alerts Overview By Network. Параметр запроса Types. Необязательный параметр для фильтрации по типу оповещения.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _assurance _alerts _overview _by _network
  cisco.meraki.organizations_assurance_alerts_overview_by_network_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
    sortOrder: string
    networkId: string
    severity: string
    types: []
    tsStart: string
    tsEnd: string
    category: string
    serials: []
    deviceTypes: []
    deviceTags: []
    active: true
    dismissed: true
    resolved: true
    suppressAlertsForOfflineNodes: true
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

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