модуль cisco.meraki.networks_wireless_client_count_history_info — информационный модуль для networks _wireless _clientcounthistory

Примечание

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

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

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

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

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

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

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

Информационный модуль для Networks Wireless Clientcounthistory Info.
Получение всех networks _wireless _clientcounthistory.
Возвращает количество беспроводных клиентов с течением времени для сети, устройства или сетевого клиента.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса ApTag. Фильтрация результатов по тегу точки доступа.
autoResolution логический	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса AutoResolution. Автоматически выбирает разрешение данных на основе заданного временного интервала; при этом переопределяется значение, указанное параметром «resolution». По умолчанию установлено значение false. Варианты: `false` `true`
band строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса Band. Фильтрация результатов по диапазону (значение «2.4», «5» или «6»).
clientId строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса ClientId. Фильтрация результатов по сетевому клиенту. Возвращает количество клиентов для каждого устройства с течением времени, связывая данные с историей подключений запрошенного клиента.
deviceSerial строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса DeviceSerial. Фильтрация результатов по устройству.
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 строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр пути NetworkId. Идентификатор сети.
resolution целое число	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса Resolution. Временное разрешение возвращаемых данных в секундах. Допустимые значения: 300, 600, 1200, 3600, 14400, 86400. Значение по умолчанию — 86400.
ssid целое число	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса Ssid. Фильтрация результатов по номеру SSID.
t0 строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса T0. Начало временного интервала для данных. Максимальная глубина просмотра составляет 31 день от текущей даты.
t1 строка	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может отстоять от t0 не более чем на 31 день.
timespan вещественное число	Информационный модуль для Networks Wireless Clientcounthistory Info. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть указано в секундах и не превышать 31 день. Значение по умолчанию — 7 дней.

Примечания

Примечание

Используемый метод SDK: wireless.Wireless.get_network_wireless_client_count_history,
Используемые пути: get /networks/{networkId}/wireless/clientCountHistory,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible; вместо этого он использует встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

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

Примеры

- name: Get all networks _wireless _clientcounthistory
  cisco.meraki.networks_wireless_client_count_history_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 }}"
    t0: string
    t1: string
    timespan: 0
    resolution: 0
    autoResolution: true
    clientId: string
    deviceSerial: string
    apTag: string
    band: string
    ssid: 0
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"startTs\": \"string\",\n \"endTs\": \"string\",\n \"clientCount\": 0\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/networks_wireless_client_count_history_info_module.html