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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.meraki.networks_sm_devices_info.

Новое в cisco.meraki 2.16.0

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

Описание

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница Default: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
fields list / elements=string	Параметр запроса 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 dictionary	Дополнительные заголовки.
ids list / elements=string	Параметр запроса Ids. Фильтрует устройства по id(s).
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число), время ожидания повтора попытки при ошибке параллельной обработки действий Default: `60`
meraki_api_key string / required	meraki_api_key (строка), API ключ, сгенерированный на панели управления; может также быть установлен как переменная среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка), предшествует всем ресурсам конечных точек Default: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка), необязательный идентификатор партнера для отслеживания использования API; может также быть установлен как переменная среды BE_GEO_ID Default: `""`
meraki_caller string	meraki_caller (строка), необязательный идентификатор для отслеживания использования API; может также быть установлен как переменная среды MERAKI_PYTHON_SDK_CALLER Default: `""`
meraki_certificate_path string	meraki_certificate_path (строка), путь для проверки сертификата TLS/SSL, если находится за локальным прокси Default: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (булево), наследует ваш собственный экземпляр регистратора Choices: `false` ← (default) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка), имя файла журнала с добавлением даты и времени Default: `"meraki_api_"`
meraki_log_path string	log_path (строка), путь к выходному журналу; по умолчанию, рабочий каталог скрипта, если не указано иное Default: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число), повторить до этого количества раз при возникновении ошибок 429 или других ошибок на стороне сервера Default: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число), время ожидания повтора попытки Nginx 429 Default: `60`
meraki_output_log boolean	meraki_output_log (булево), создать файл выходного журнала? Choices: `false` `true` ← (default)
meraki_print_console boolean	meraki_print_console (булево), выводить выходные данные журнала на консоль? Choices: `false` `true` ← (default)

meraki_requests_proxy string	meraki_requests_proxy (string), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (boolean), повторить попытку при возникновении других ошибок 4XX (кроме 429)? Choices: `false` ← (default) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (integer), время ожидания повтора попытки при других ошибках 4XX Default: `60`
meraki_simulate boolean	meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить изменения? Choices: `false` ← (default) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (integer), максимальное количество секунд для каждого вызова API Default: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (boolean), отключить все логирование? тогда вы сами за себя! Choices: `false` ← (default) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (boolean), методы list* будут возвращать итератор с каждым объектом вместо полного списка со всеми элементами Choices: `false` ← (default) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (boolean), повторить попытку при возникновении ошибки ограничения скорости 429? Choices: `false` `true` ← (default)
networkId string	NetworkId параметр пути. Идентификатор сети.
perPage integer	PerPage параметр запроса. Количество записей на страницу. Допустимый диапазон - 3 - 1000. По умолчанию - 1000.
scope list / elements=string	Scope параметр запроса. Укажите область действия (одну из all, none, withAny, withAll, withoutAny или withoutAll) и набор тегов.
serials list / elements=string	Serials параметр запроса. Фильтруйте устройства по серийному(ым) номеру(ам).
startingAfter string	StartingAfter параметр запроса. Токен, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
systemTypes list / elements=string	SystemTypes параметр запроса. Фильтруйте устройства по типу(ам) системы.
total_pages string / required	total_pages(int), использовать с perPage для получения общего количества результатов до total_pages*perPage; -1 для всех страниц
uuids list / elements=string	Uuids параметр запроса. Фильтруйте устройства по uuid(s).
wifiMacs list / elements=string	WifiMacs параметр запроса. Фильтруйте устройства по wifi mac(s).

Примечания

Примечание

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

См. также

Документация 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_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 список / элементы=словарь	Словарь или список со значением, возвращаемым Cisco Meraki Python SDK Возвращается: всегда Пример: `"[\n {\n \"id\": \"string\",\n \"ip\": \"string\",\n \"name\": \"string\",\n \"notes\": \"string\",\n \"osName\": \"string\",\n \"serial\": \"string\",\n \"serialNumber\": \"string\",\n \"ssid\": \"string\",\n \"systemModel\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"uuid\": \"string\",\n \"wifiMac\": \"string\"\n }\n]\n"`

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"id\": \"string\",\n \"ip\": \"string\",\n \"name\": \"string\",\n \"notes\": \"string\",\n \"osName\": \"string\",\n \"serial\": \"string\",\n \"serialNumber\": \"string\",\n \"ssid\": \"string\",\n \"systemModel\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"uuid\": \"string\",\n \"wifiMac\": \"string\"\n }\n]\n"

Авторы

Франсиско Муньоз (@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_sm_devices_info_module.html