модуль cisco.meraki.organizations_assurance_alerts_info – информационный модуль для оповещений _assurance _alerts организаций

Примечание

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

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

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

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

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

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

Обзор

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

Примечание

У этого модуля есть соответствующий модуль действий.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

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

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _assurance _alerts
  cisco.meraki.organizations_assurance_alerts_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
    sortBy: string
    serials: []
    deviceTypes: []
    deviceTags: []
    active: true
    dismissed: true
    resolved: true
    suppressAlertsForOfflineNodes: true
    organizationId: string
    total_pages: -1
    direction: next
  register: result
- name: Get organizations _assurance _alerts by id
  cisco.meraki.organizations_assurance_alerts_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 }}"
    organizationId: string
    id: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, полученным от Cisco Meraki Python SDK Возвращается: всегда Пример: `{"categoryType": "string", "description": {}, "deviceType": {}, "dismissedAt": {}, "id": "string", "network": {"id": "string", "name": "string"}, "resolvedAt": {}, "scope": {"applications": [{}], "devices": [{"imei": "string", "lldp": {"port": "string"}, "mac": "string", "name": "string", "order": 0, "productType": "string", "serial": "string", "url": "string"}], "others": [{}], "peers": [{}]}, "severity": "string", "startedAt": "string", "title": "string", "type": "string"}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"categoryType": "string", "description": {}, "deviceType": {}, "dismissedAt": {}, "id": "string", "network": {"id": "string", "name": "string"}, "resolvedAt": {}, "scope": {"applications": [{}], "devices": [{"imei": "string", "lldp": {"port": "string"}, "mac": "string", "name": "string", "order": 0, "productType": "string", "serial": "string", "url": "string"}], "others": [{}], "peers": [{}]}, "severity": "string", "startedAt": "string", "title": "string", "type": "string"}

Авторы

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