модуль cisco.meraki.networks_wireless_failed_connections_info – информационный модуль для сетей _wireless _failedconnections

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
apTag string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса ApTag. Фильтрация результатов по тегу точки доступа.
band string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса Band. Фильтрация результатов по диапазону (значение «2.4», «5» или «6»). Обратите внимание: данные до февраля 2020 года не содержат сведений о диапазоне.
clientId string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса ClientId. Фильтрация по MAC-адресу клиента.
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` ← (по умолчанию)
networkId string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр пути NetworkId. Идентификатор сети.
serial string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса Serial. Фильтрация по точке доступа.
ssid integer	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса Ssid. Фильтрация результатов по SSID.
t0 string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса T0. Начало периода, за который собираются данные. Максимальный период ретроспективного просмотра составляет 180 дней от текущей даты.
t1 string	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса T1. Конец периода, за который собираются данные. Значение T1 может отстоять от t0 не более чем на 7 дней.
timespan float	Информационный модуль для получения сведений о неудачных подключениях беспроводных сетей. Параметр запроса Timespan. Период, за который будут получены сведения. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 7 дней.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _wireless _failedconnections
  cisco.meraki.networks_wireless_failed_connections_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
    band: string
    ssid: 0
    apTag: string
    serial: string
    clientId: string
    networkId: string
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"ssidNumber\": 0,\n \"vlan\": 0,\n \"clientMac\": \"string\",\n \"serial\": \"string\",\n \"radio\": 0,\n \"failureStep\": \"string\",\n \"type\": \"string\",\n \"ts\": \"string\"\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_failed_connections_info_module.html