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

Примечание

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

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

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

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

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

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

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

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

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction строка	direction (строка): направление перехода по страницам — «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore строка	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса EndingBefore. Токен, который сервер использует для обозначения конца страницы. Обычно это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers словарь	Дополнительные заголовки.
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` ← (по умолчанию)
metrics список / элементы=строки	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса Metrics. Типы показаний датчиков для получения. Если метрики не указаны, будут получены все доступные типы показаний.
networkIds список / элементы=строки	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса NetworkIds. Необязательный параметр для фильтрации показаний по сети.
organizationId строка	Информационный модуль для получения последних показаний датчиков организации. Параметр пути OrganizationId. Идентификатор организации.
perPage целое число	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
serials список / элементы=строки	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса Serials. Необязательный параметр для фильтрации показаний по датчику.
startingAfter строка	Информационный модуль для получения последних показаний датчиков организации. Параметр запроса StartingAfter. Токен, который сервер использует для обозначения начала страницы. Обычно это метка времени или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует брать из ссылки на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
total_pages строка / обязательный	total_pages (целое число): используйте вместе с perPage, чтобы получить общее количество результатов до total_pages*perPage; -1 — все страницы

Примечания

Примечание

Используемый метод SDK: sensor.Sensor.get_organization_sensor_readings_latest,
Используемые пути: get /organizations/{organizationId}/sensor/readings/latest,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключения Ansible, а вместо них — встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

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

Примеры

- name: Get all organizations _sensor _readings _latest
  cisco.meraki.organizations_sensor_readings_latest_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
    networkIds: []
    serials: []
    metrics: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response список / элементы=словарь	Словарь или список с ответом, полученным от Python SDK Cisco Meraki Возвращается: всегда Пример: "[\n {\n \"serial\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"readings\": [\n {\n \"ts\": \"string\",\n \"metric\": \"string\",\n \"apparentPower\": {\n \"draw\": 0\n },\n \"battery\": {\n \"percentage\": 0\n },\n \"button\": {\n \"pressType\": \"string\"\n },\n \"co2\": {\n \"concentration\": 0\n },\n \"current\": {\n \"draw\": 0\n },\n \"door\": {\n \"open\": true\n },\n \"downstreamPower\": {\n \"enabled\": true\n },\n \"frequency\": {\n \"level\": 0\n },\n \"humidity\": {\n \"relativePercentage\": 0\n },\n \"indoorAirQuality\": {\n \"score\": 0\n },\n \"noise\": {\n \"ambient\": {\n \"level\": 0\n }\n },\n \"no2\": {\n \"concentration\": 0\n },\n \"o3\": {\n \"concentration\": 0\n },\n \"pm10\": {\n \"concentration\": 0\n },\n \"pm25\": {\n \"concentration\": 0\n },\n \"powerFactor\": {\n \"percentage\": 0\n },\n \"realPower\": {\n \"draw\": 0\n },\n \"remoteLockoutSwitch\": {\n \"locked\": true\n },\n \"temperature\": {\n \"fahrenheit\": 0,\n \"celsius\": 0\n },\n \"tvoc\": {\n \"concentration\": 0\n },\n \"voltage\": {\n \"level\": 0\n },\n \"water\": {\n \"present\": true\n },\n \"rawTemperature\": {\n \"fahrenheit\": 0,\n \"celsius\": 0\n }\n }\n ]\n }\n]\n"

Ключ

Описание

meraki_response

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

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

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

Пример: "[\n {\n \"serial\": \"string\",\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"readings\": [\n {\n \"ts\": \"string\",\n \"metric\": \"string\",\n \"apparentPower\": {\n \"draw\": 0\n },\n \"battery\": {\n \"percentage\": 0\n },\n \"button\": {\n \"pressType\": \"string\"\n },\n \"co2\": {\n \"concentration\": 0\n },\n \"current\": {\n \"draw\": 0\n },\n \"door\": {\n \"open\": true\n },\n \"downstreamPower\": {\n \"enabled\": true\n },\n \"frequency\": {\n \"level\": 0\n },\n \"humidity\": {\n \"relativePercentage\": 0\n },\n \"indoorAirQuality\": {\n \"score\": 0\n },\n \"noise\": {\n \"ambient\": {\n \"level\": 0\n }\n },\n \"no2\": {\n \"concentration\": 0\n },\n \"o3\": {\n \"concentration\": 0\n },\n \"pm10\": {\n \"concentration\": 0\n },\n \"pm25\": {\n \"concentration\": 0\n },\n \"powerFactor\": {\n \"percentage\": 0\n },\n \"realPower\": {\n \"draw\": 0\n },\n \"remoteLockoutSwitch\": {\n \"locked\": true\n },\n \"temperature\": {\n \"fahrenheit\": 0,\n \"celsius\": 0\n },\n \"tvoc\": {\n \"concentration\": 0\n },\n \"voltage\": {\n \"level\": 0\n },\n \"water\": {\n \"present\": true\n },\n \"rawTemperature\": {\n \"fahrenheit\": 0,\n \"celsius\": 0\n }\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_sensor_readings_latest_info_module.html