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

Примечание

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

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

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

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

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

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

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

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

Примечание

Этому модулю соответствует модуль действия.

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
configurationUpdatedAfter строка	Модуль сведений об устройствах. Параметр запроса ConfigurationUpdatedAfter. Фильтрует результаты по признаку обновления конфигурации устройства после указанной временной метки.
direction строка	direction (строка) — направление постраничной навигации: «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Модуль сведений об устройствах. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это временная метка или идентификатор, но не обязательно. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
mac строка	Модуль сведений об устройствах. Параметр запроса Mac. Необязательный параметр для фильтрации устройств по MAC-адресу. У всех возвращённых устройств MAC-адрес будет содержать искомую строку или точно ей соответствовать.
macs список / элементы=строка	Модуль сведений об устройствах. Параметр запроса Macs. Необязательный параметр для фильтрации устройств по одному или нескольким MAC-адресам. MAC-адрес каждого возвращённого устройства будет точно совпадать с указанным.
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 (целое число) — время ожидания перед повторной попыткой при ошибке 429 от Nginx По умолчанию: `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` ← (по умолчанию)
model строка	Модуль сведений об устройствах. Параметр запроса Model. Необязательный параметр для фильтрации устройств по модели. У всех возвращённых устройств модель будет содержать искомую строку или точно ей соответствовать.
models список / элементы=строка	Модуль сведений об устройствах. Параметр запроса Models. Необязательный параметр для фильтрации устройств по одной или нескольким моделям. Модель каждого возвращённого устройства будет точно совпадать с указанной.
name строка	Модуль сведений об устройствах. Параметр запроса Name. Необязательный параметр для фильтрации устройств по имени. Имя каждого возвращённого устройства будет содержать искомую строку или точно ей соответствовать.
networkIds список / элементы=строка	Модуль сведений об устройствах. Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по сети.
organizationId строка	Модуль сведений об устройствах. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Модуль сведений об устройствах. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–5000. Значение по умолчанию — 1000.
productTypes список / элементы=строка	Модуль сведений об устройствах. Параметр запроса ProductTypes. Необязательный параметр для фильтрации устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway и secureConnect.
sensorAlertProfileIds список / элементы=строка	Модуль сведений об устройствах. Параметр запроса SensorAlertProfileIds. Необязательный параметр для фильтрации устройств по назначенным им профилям оповещений. Применяется только к устройствам-датчикам.
sensorMetrics список / элементы=строка	Модуль сведений об устройствах. Параметр запроса SensorMetrics. Необязательный параметр для фильтрации устройств по предоставляемым ими метрикам. Применяется только к устройствам-датчикам.
serial строка	Модуль сведений об устройствах. Параметр пути Serial.
serials список / элементы=строка	Модуль сведений об устройствах. Параметр запроса Serials. Необязательный параметр для фильтрации устройств по одному или нескольким серийным номерам. Серийный номер каждого возвращённого устройства будет точно совпадать с указанным.
startingAfter строка	Модуль сведений об устройствах. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но не обязательно. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
tags список / элементы=строка	Модуль сведений об устройствах. Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам.
tagsFilterType строка	Модуль сведений об устройствах. Параметр запроса TagsFilterType. Необязательное значение «withAnyTags» или «withAllTags», определяющее, следует ли возвращать сети, содержащие ЛЮБЫЕ или ВСЕ указанные теги. Если тип не указан, выбирается «withAnyTags».
total_pages строка / обязательный	total_pages (целое число) — используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 означает все страницы

Примечания

Примечание

Используются методы SDK devices.Devices.get_device, devices.Devices.get_organization_devices,
Используются пути get /devices/{serial}, get /organizations/{organizationId}/devices,
Поддерживает check_mode
Плагин запускается на управляющем узле и не использует плагины подключений Ansible, а вместо этого применяет встроенный менеджер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установления подключения

См. также

Документация Cisco Meraki по методу devices getDevice: Полное описание API getDevice.
Документация Cisco Meraki по методу devices getOrganizationDevices: Полное описание API getOrganizationDevices.

Примеры

- name: Get all devices
  cisco.meraki.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 }}"
    perPage: 0
    startingAfter: string
    endingBefore: string
    configurationUpdatedAfter: string
    networkIds: []
    productTypes: []
    tags: []
    tagsFilterType: string
    name: string
    mac: string
    serial: string
    model: string
    macs: []
    serials: []
    sensorMetrics: []
    sensorAlertProfileIds: []
    models: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result
- name: Get devices by id
  cisco.meraki.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 }}"
    serial: string
  register: result

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

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

Ключ	Описание
meraki_response словарь	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"address": "string", "beaconIdParams": {"major": 0, "minor": 0, "uuid": "string"}, "details": [{"name": "string", "value": "string"}], "firmware": "string", "floorPlanId": "string", "lanIp": "string", "lat": 0, "lng": 0, "mac": "string", "model": "string", "name": "string", "networkId": "string", "notes": "string", "serial": "string", "tags": ["string"]}`

Ключ

Описание

meraki_response

словарь

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

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

Пример: {"address": "string", "beaconIdParams": {"major": 0, "minor": 0, "uuid": "string"}, "details": [{"name": "string", "value": "string"}], "firmware": "string", "floorPlanId": "string", "lanIp": "string", "lat": 0, "lng": 0, "mac": "string", "model": "string", "name": "string", "networkId": "string", "notes": "string", "serial": "string", "tags": ["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/devices_info_module.html