модуль cisco.meraki.networks_clients_info — информационный модуль для сетевых клиентов

Примечание

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

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

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

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

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

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

Обзор

Информационный модуль для сведений о сетевых клиентах.
Получить всех сетевых клиентов.
Получить сетевых клиентов по идентификатору.
Вывести список клиентов, использовавших эту сеть в течение заданного периода. Данные обновляются не чаще одного раза в пять минут.
Вернуть клиента, связанного с указанным идентификатором. Клиентов можно идентифицировать по ключу клиента, MAC-адресу или IP-адресу — в зависимости от того, использует ли сеть отслеживание по IP-адресу.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
clientId string	Информационный модуль для сведений о сетевых клиентах. Параметр пути clientId. Идентификатор клиента.
description string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса description. Фильтрует клиентов по частичному или полному совпадению поля описания.
direction string	direction (string), направление пагинации: «next» (по умолчанию) или страница «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса endingBefore. Токен, с помощью которого сервер обозначает конец страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
ip string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса ip. Фильтрует клиентов по частичному или полному совпадению поля IP-адреса.
ip6 string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса ip6. Фильтрует клиентов по частичному или полному совпадению поля адреса ip6.
ip6Local string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса ip6Local. Фильтрует клиентов по частичному или полному совпадению поля адреса ip6Local.
mac string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса mac. Фильтрует клиентов по частичному или полному совпадению поля MAC-адреса.
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` ← (по умолчанию)
namedVlan string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса namedVlan. Фильтрует клиентов по частичному или полному совпадению поля именованной VLAN.
networkId string	Информационный модуль для сведений о сетевых клиентах. Параметр пути networkId. Идентификатор сети.
os string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса os. Фильтрует клиентов по частичному или полному совпадению поля os (операционная система).
perPage integer	Информационный модуль для сведений о сетевых клиентах. Параметр запроса perPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 5000. Значение по умолчанию — 10.
pskGroup string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса pskGroup. Фильтрует клиентов по частичному или полному совпадению поля имени iPSK.
recentDeviceConnections list / элементы=string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса recentDeviceConnections. Фильтрует клиентов по типу недавнего подключения. Возможные значения: «Wired» или «Wireless».
startingAfter string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса startingAfter. Токен, с помощью которого сервер обозначает начало страницы. Часто это метка времени или идентификатор, но токен не ограничивается этими значениями. Клиентские приложения не должны задавать этот параметр. Его следует определять по ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
statuses list / элементы=string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса statuses. Фильтрует клиентов по статусу. Возможные значения: «Online» или «Offline».
t0 string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса t0. Начало периода, за который собираются данные. Максимальный период в прошлом — 31 день от текущей даты.
timespan float	Информационный модуль для сведений о сетевых клиентах. Параметр запроса timespan. Период, за который будут получены сведения. Если задан timespan, не указывайте параметр t0. Значение указывается в секундах и не должно превышать 31 день. По умолчанию используется период в 1 день.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; значение -1 означает все страницы
vlan string	Информационный модуль для сведений о сетевых клиентах. Параметр запроса vlan. Фильтрует клиентов по полному совпадению поля VLAN.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _clients
  cisco.meraki.networks_clients_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
    timespan: 0
    perPage: 0
    startingAfter: string
    endingBefore: string
    statuses: []
    ip: string
    ip6: string
    ip6Local: string
    mac: string
    os: string
    pskGroup: string
    description: string
    vlan: string
    namedVlan: string
    recentDeviceConnections: []
    networkId: string
    total_pages: -1
    direction: next
  register: result
- name: Get networks _clients by id
  cisco.meraki.networks_clients_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 }}"
    networkId: string
    clientId: string
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: {"cdp": [["string"]], "clientVpnConnections": [{"connectedAt": 0, "disconnectedAt": 0, "remoteIp": "string"}], "description": "string", "deviceTypePrediction": "string", "firstSeen": 0, "id": "string", "ip": "string", "ip6": "string", "ip6Local": "string", "lastSeen": 0, "lldp": [["string"]], "mac": "string", "manufacturer": "string", "namedVlan": "string", "notes": "string", "os": "string", "recentDeviceConnection": "string", "recentDeviceMac": "string", "recentDeviceName": "string", "recentDeviceSerial": "string", "smInstalled": true, "ssid": "string", "status": "string", "switchport": "string", "user": "string", "vlan": "string", "wirelessCapabilities": "string"}

Ключ

Описание

meraki_response

dictionary

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

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

Пример: {"cdp": [["string"]], "clientVpnConnections": [{"connectedAt": 0, "disconnectedAt": 0, "remoteIp": "string"}], "description": "string", "deviceTypePrediction": "string", "firstSeen": 0, "id": "string", "ip": "string", "ip6": "string", "ip6Local": "string", "lastSeen": 0, "lldp": [["string"]], "mac": "string", "manufacturer": "string", "namedVlan": "string", "notes": "string", "os": "string", "recentDeviceConnection": "string", "recentDeviceMac": "string", "recentDeviceName": "string", "recentDeviceSerial": "string", "smInstalled": true, "ssid": "string", "status": "string", "switchport": "string", "user": "string", "vlan": "string", "wirelessCapabilities": "string"}

Авторы

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