Модуль cisco.meraki.organizations_wireless_clients_overview_by_device_info — информационный модуль для получения сведений о беспроводных клиентах организаций по устройству

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
campusGatewayClusterIds list / elements=string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса CampusGatewayClusterIds. Необязательный параметр для фильтрации количества клиентов точек доступа по идентификаторам кластеров MCG. Для фильтра используются несколько точных совпадений.
direction string	direction (string) — направление постраничного вывода: «next» (по умолчанию) или «prev». По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса 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` ← (по умолчанию)
networkIds list / elements=string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса NetworkIds. Необязательный параметр для фильтрации количества клиентов точек доступа по идентификатору сети. Для фильтра используются несколько точных совпадений.
organizationId string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 1000.
serials list / elements=string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса Serials. Необязательный параметр для фильтрации количества клиентов точек доступа по их серийным номерам. Для фильтра используются несколько точных совпадений.
startingAfter string	Информационный модуль для получения сведений о беспроводных клиентах организаций по устройству. Параметр запроса StartingAfter. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его должно определять значение ссылки на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages(int) — используется вместе с perPage для получения общего количества результатов до total_pages*perPage; значение -1 означает все страницы.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _wireless _clients _overview _by _device
  cisco.meraki.organizations_wireless_clients_overview_by_device_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 }}"
    networkIds: []
    serials: []
    campusGatewayClusterIds: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki. Возвращается: всегда Пример: `{"items": [{"counts": {"byStatus": {"online": 0}}, "network": {"id": "string"}, "serial": "string"}], "meta": {"counts": {"items": {"remaining": 0, "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_wireless_clients_overview_by_device_info_module.html