модуль cisco.meraki.networks_sm_devices_info — модуль сведений об устройствах _sm сети

Примечание

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

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

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

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

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

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

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

Модуль сведений об устройствах SM сети.
Получение всех устройств _sm сети.
Вывод списка устройств, зарегистрированных в сети SM, с указанными полями и фильтрами.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction строка	direction (строка) — направление разбиения на страницы: «next» (по умолчанию) или «prev». По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Модуль сведений об устройствах SM сети. Параметр запроса EndingBefore. Токен, с помощью которого сервер обозначает конец страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
fields список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса Fields. Дополнительные поля, отображаемые для каждого устройства. По умолчанию используются поля id, name, tags, ssid, wifiMac, osName, systemModel, uuid и serialNumber. Дополнительные поля: ip, systemType, availableDeviceCapacity, kioskAppName, biosVersion, lastConnected, missingAppsCount, userSuppliedAddress, location, lastUser, ownerEmail, ownerUsername, osBuild, publicIp, phoneNumber, diskInfoJson, deviceCapacity, isManaged, hadMdm, isSupervised, meid, imei, iccid, simCarrierNetwork, cellularDataUsed, isHotspotEnabled, createdAt, batteryEstCharge, quarantined, avName, avRunning, asName, fwName, isRooted, loginRequired, screenLockEnabled, screenLockDelay, autoLoginDisabled, autoTags, hasMdm, hasDesktopAgent, diskEncryptionEnabled, hardwareEncryptionCaps, passCodeLock, usesHardwareKeystore, androidSecurityPatchVersion, cellular и url.
headers словарь	Дополнительные заголовки.
ids список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса Ids. Фильтрация устройств по идентификатору(-ам).
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 строка	Модуль сведений об устройствах SM сети. Параметр пути NetworkId. Идентификатор сети.
perPage целое число	Модуль сведений об устройствах SM сети. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 1000.
scope список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса Scope. Укажите область (одно из значений: all, none, withAny, withAll, withoutAny или withoutAll) и набор тегов.
serials список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса Serials. Фильтрация устройств по серийному номеру(-ам).
startingAfter строка	Модуль сведений об устройствах SM сети. Параметр запроса StartingAfter. Токен, с помощью которого сервер обозначает начало страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Он должен определяться ссылкой на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
systemTypes список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса SystemTypes. Фильтрация устройств по типу(-ам) системы.
total_pages строка / обязательный	total_pages (целое число) — используйте вместе с perPage, чтобы получить общее число результатов до total_pages*perPage; значение -1 означает все страницы
uuids список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса Uuids. Фильтрация устройств по UUID.
wifiMacs список / элементы=строки	Модуль сведений об устройствах SM сети. Параметр запроса WifiMacs. Фильтрация устройств по MAC-адресу(-ам) Wi-Fi.

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all networks _sm _devices
  cisco.meraki.networks_sm_devices_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 }}"
    fields: []
    wifiMacs: []
    serials: []
    ids: []
    uuids: []
    systemTypes: []
    scope: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    networkId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"ssid\": \"string\",\n \"wifiMac\": \"string\",\n \"osName\": \"string\",\n \"systemModel\": \"string\",\n \"uuid\": \"string\",\n \"serialNumber\": \"string\",\n \"serial\": \"string\",\n \"ip\": \"string\",\n \"notes\": \"string\"\n }\n]\n"`

Ключ

Описание

meraki_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"name\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"ssid\": \"string\",\n \"wifiMac\": \"string\",\n \"osName\": \"string\",\n \"systemModel\": \"string\",\n \"uuid\": \"string\",\n \"serialNumber\": \"string\",\n \"serial\": \"string\",\n \"ip\": \"string\",\n \"notes\": \"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_sm_devices_info_module.html