Модуль cisco.meraki.organizations_devices_info — информационный модуль для устройств организаций

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
configurationUpdatedAfter string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса ConfigurationUpdatedAfter. Фильтрует результаты по тому, обновлялась ли конфигурация устройства после указанной временной метки.
direction string	direction (строка): направление постраничной навигации — следующая страница («next», значение по умолчанию) или предыдущая («prev») По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса EndingBefore. Токен, с помощью которого сервер указывает конец страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Он должен быть указан в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
headers dictionary	Дополнительные заголовки.
mac string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Mac. Необязательный параметр для фильтрации устройств по MAC-адресу. У всех возвращённых устройств MAC-адрес будет содержать искомую строку или точно ей соответствовать.
macs list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Macs. Необязательный параметр для фильтрации устройств по одному или нескольким MAC-адресам. MAC-адреса всех возвращённых устройств будут точно совпадать с указанными.
meraki_action_batch_retry_wait_time integer	meraki_action_batch_retry_wait_time (целое число): время ожидания перед повторной попыткой при ошибке параллелизма пакетной операции По умолчанию: `60`
meraki_api_key string / обязательный	meraki_api_key (строка): ключ API, созданный на панели управления; его также можно задать с помощью переменной среды MERAKI_DASHBOARD_API_KEY
meraki_base_url string	meraki_base_url (строка): базовый URL, предшествующий всем ресурсам конечных точек По умолчанию: `"https://api.meraki.com/api/v1"`
meraki_be_geo_id string	meraki_be_geo_id (строка): необязательный идентификатор партнёра для отслеживания использования API; его также можно задать с помощью переменной среды BE_GEO_ID По умолчанию: `""`
meraki_certificate_path string	meraki_certificate_path (строка): путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер По умолчанию: `""`
meraki_inherit_logging_config boolean	meraki_inherit_logging_config (логическое значение): наследовать собственный экземпляр регистратора Варианты: `false` ← (по умолчанию) `true`
meraki_log_file_prefix string	meraki_log_file_prefix (строка): к имени файла журнала добавляются дата и временная метка По умолчанию: `"meraki_api_"`
meraki_log_path string	log_path (строка): путь для записи журнала; если он не указан, используется рабочий каталог скрипта По умолчанию: `""`
meraki_maximum_retries integer	meraki_maximum_retries (целое число): максимальное количество повторных попыток при ответе 429 или других ошибках на стороне сервера По умолчанию: `2`
meraki_nginx_429_retry_wait_time integer	meraki_nginx_429_retry_wait_time (целое число): время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `60`
meraki_output_log boolean	meraki_output_log (логическое значение): создавать файл журнала вывода? Варианты: `false` `true` ← (по умолчанию)
meraki_print_console boolean	meraki_print_console (логическое значение): выводить журнал в консоль? Варианты: `false` `true` ← (по умолчанию)
meraki_requests_proxy string	meraki_requests_proxy (строка): прокси-сервер и порт для HTTPS, если они необходимы По умолчанию: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (логическое значение): повторять запрос при возникновении других ошибок 4XX (кроме 429)? Варианты: `false` ← (по умолчанию) `true`
meraki_retry_4xx_error_wait_time integer	meraki_retry_4xx_error_wait_time (целое число): время ожидания перед повторной попыткой при других ошибках 4XX По умолчанию: `60`
meraki_simulate boolean	meraki_simulate (логическое значение): имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений? Варианты: `false` ← (по умолчанию) `true`
meraki_single_request_timeout integer	meraki_single_request_timeout (целое число): максимальное количество секунд для каждого вызова API По умолчанию: `60`
meraki_suppress_logging boolean	meraki_suppress_logging (логическое значение): отключить ведение журнала? Тогда вы действуете на свой страх и риск! Варианты: `false` ← (по умолчанию) `true`
meraki_use_iterator_for_get_pages boolean	meraki_use_iterator_for_get_pages (логическое значение): методы list* возвращают итератор с отдельными объектами вместо полного списка всех элементов Варианты: `false` ← (по умолчанию) `true`
meraki_wait_on_rate_limit boolean	meraki_wait_on_rate_limit (логическое значение): повторять запрос при превышении ограничения частоты запросов (ошибка 429)? Варианты: `false` `true` ← (по умолчанию)
model string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Model. Необязательный параметр для фильтрации устройств по модели. У всех возвращённых устройств модель будет содержать искомую строку или точно ей соответствовать.
models list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Models. Необязательный параметр для фильтрации устройств по одной или нескольким моделям. Модели всех возвращённых устройств будут точно совпадать с указанными.
name string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Name. Необязательный параметр для фильтрации устройств по имени. Имя всех возвращённых устройств будет содержать искомую строку или точно ей соответствовать.
networkIds list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса NetworkIds. Необязательный параметр для фильтрации устройств по сети.
organizationId string	Информационный модуль для получения сведений об устройствах организаций. Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–5000. Значение по умолчанию — 1000.
productTypes list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса ProductTypes. Необязательный параметр для фильтрации устройств по типу продукта. Допустимые типы: wireless, appliance, switch, systemsManager, camera, cellularGateway, sensor, wirelessController, campusGateway и secureConnect.
sensorAlertProfileIds list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса SensorAlertProfileIds. Необязательный параметр для фильтрации устройств по назначенным им профилям оповещений. Применяется только к датчикам.
sensorMetrics list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса SensorMetrics. Необязательный параметр для фильтрации устройств по предоставляемым ими метрикам. Применяется только к датчикам.
serial string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Serial. Необязательный параметр для фильтрации устройств по серийному номеру. Серийный номер всех возвращённых устройств будет содержать искомую строку или точно ей соответствовать.
serials list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Serials. Необязательный параметр для фильтрации устройств по одному или нескольким серийным номерам. Серийные номера всех возвращённых устройств будут точно совпадать с указанными.
startingAfter string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса StartingAfter. Токен, с помощью которого сервер указывает начало страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Он должен быть указан в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
tags list / elements=string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса Tags. Необязательный параметр для фильтрации устройств по тегам.
tagsFilterType string	Информационный модуль для получения сведений об устройствах организаций. Параметр запроса TagsFilterType. Необязательное значение «withAnyTags» или «withAllTags», указывающее, следует ли возвращать сети, содержащие ЛЮБЫЕ или ВСЕ указанные теги. Если тип не указан, выбирается «withAnyTags».
total_pages string / обязательный	total_pages (целое число): используйте вместе с perPage, чтобы получить общее количество результатов, не превышающее total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

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

См. также

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

Примеры

- name: Get all organizations _devices
  cisco.meraki.organizations_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

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"name\": \"string\",\n \"lat\": 0,\n \"lng\": 0,\n \"address\": \"string\",\n \"notes\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"imei\": \"string\",\n \"mac\": \"string\",\n \"lanIp\": \"string\",\n \"firmware\": \"string\",\n \"productType\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"name\": \"string\",\n \"lat\": 0,\n \"lng\": 0,\n \"address\": \"string\",\n \"notes\": \"string\",\n \"tags\": [\n \"string\"\n ],\n \"networkId\": \"string\",\n \"serial\": \"string\",\n \"model\": \"string\",\n \"imei\": \"string\",\n \"mac\": \"string\",\n \"lanIp\": \"string\",\n \"firmware\": \"string\",\n \"productType\": \"string\",\n \"details\": [\n {\n \"name\": \"string\",\n \"value\": \"string\"\n }\n ]\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/organizations_devices_info_module.html