Модуль cisco.meraki.networks_wireless_devices_connection_stats_info – Модуль информации для сетей _wireless _devices _connectionstats

Примечание

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

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

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

Для использования его в книге задач, укажите: cisco.meraki.networks_wireless_devices_connection_stats_info.

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

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

Описание

Получить все сети _wireless _devices _connectionstats.
Сводная информация о подключении для этой сети, сгруппированная по узлам.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag строка	Параметр запроса apTag. Фильтрует результаты по тегу AP.
band строка	Параметр запроса band. Фильтрует результаты по полосе частот (либо ‘2.4’, либо ‘5’, либо ‘6’). Обратите внимание, что данные до февраля 2020 года не будут содержать информацию о полосе.
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 (строка), предшествующая всем ресурсам конечной точки По умолчанию: `"https://api.meraki.com/api/v1"`
... (rest of the translated table)

END_OF_DOCUMENT_MARKER

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 строка	Параметр пути NetworkId. Идентификатор сети.
ssid целое число	Параметр запроса Ssid. Фильтр результатов по SSID.
t0 строка	Параметр запроса T0. Начало временного интервала для данных. Максимальный период поиска — 180 дней с сегодняшнего дня.
t1 строка	Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум через 7 дней после t0.
timespan число с плавающей запятой	Параметр запроса Timespan. Временной интервал, для которого будут извлечены данные. Если указывается timespan, не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 7 дням.
vlan целое число	Параметр запроса Vlan. Фильтр результатов по VLAN.

Примечания

Примечание

Используемые методы SDK — wireless.Wireless.get_network_wireless_devices_connection_stats,
Используемые пути — get /networks/{networkId}/wireless/devices/connectionStats,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует какие-либо плагины подключения ansible, а вместо этого встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления соединения

См. также

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

Примеры

- name: Get all networks _wireless _devices _connectionstats
  cisco.meraki.networks_wireless_devices_connection_stats_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_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
    band: string
    ssid: 0
    vlan: 0
    apTag: string
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, возвращённым Cisco Meraki Python SDK Возвращается: всегда Пример: `"[\n {\n \"connectionStats\": {\n \"assoc\": 0,\n \"auth\": 0,\n \"dhcp\": 0,\n \"dns\": 0,\n \"success\": 0\n },\n \"serial\": \"string\"\n }\n]\n"`

Авторы

Francisco Munoz (@fmunoz)

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/meraki/networks_wireless_devices_connection_stats_info_module.html