модуль cisco.meraki.organizations_summary_top_networks_by_status_info — информационный модуль для organizations _summary _top _networks _bystatus

Примечание

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

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

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

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

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

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

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

Информационный модуль Organizations Summary Top Networks Bystatus Info.
Получить все organizations _summary _top _networks _bystatus.
Вывести обзорную информацию о клиентах и состоянии сетей организации. Использование измеряется в килобайтах за последние семь дней.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceTag string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса DeviceTag. Сопоставить результат с точным тегом устройства.
direction string	direction (string) — направление пагинации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса 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` ← (по умолчанию)
networkTag string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса NetworkTag. Сопоставить результат с точным тегом сети.
organizationId string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–5000.
quantity integer	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса Quantity. Задаёт количество возвращаемых результатов. По умолчанию — 10. Максимум — 50.
ssidName string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса SsidName. Фильтрация результатов по имени SSID.
startingAfter string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Обычно это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages string / обязательный	total_pages(int) — используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; -1 означает все страницы
usageUplink string	Информационный модуль Organizations Summary Top Networks Bystatus Info. Параметр запроса UsageUplink. Фильтрация результатов по использованию восходящего канала.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _summary _top _networks _bystatus
  cisco.meraki.organizations_summary_top_networks_by_status_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 }}"
    networkTag: string
    deviceTag: string
    quantity: 0
    ssidName: string
    usageUplink: string
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / элементы=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"networkId\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"clients\": {\n \"counts\": {\n \"total\": 0\n },\n \"usage\": {\n \"upstream\": 0,\n \"downstream\": 0\n }\n },\n \"statuses\": {\n \"overall\": \"string\",\n \"byProductType\": [\n {\n \"productType\": \"string\",\n \"counts\": {\n \"online\": 0,\n \"offline\": 0,\n \"alerting\": 0,\n \"dormant\": 0\n }\n }\n ]\n },\n \"devices\": {\n \"byProductType\": [\n {\n \"productType\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"productTypes\": [\n \"string\"\n ]\n }\n]\n"

Ключ

Описание

meraki_response

list / элементы=dictionary

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

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

Пример: "[\n {\n \"networkId\": \"string\",\n \"name\": \"string\",\n \"url\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"clients\": {\n \"counts\": {\n \"total\": 0\n },\n \"usage\": {\n \"upstream\": 0,\n \"downstream\": 0\n }\n },\n \"statuses\": {\n \"overall\": \"string\",\n \"byProductType\": [\n {\n \"productType\": \"string\",\n \"counts\": {\n \"online\": 0,\n \"offline\": 0,\n \"alerting\": 0,\n \"dormant\": 0\n }\n }\n ]\n },\n \"devices\": {\n \"byProductType\": [\n {\n \"productType\": \"string\",\n \"url\": \"string\"\n }\n ]\n },\n \"productTypes\": [\n \"string\"\n ]\n }\n]\n"

Авторы

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