cisco.meraki.organizations_sensor_readings_latest_info module – Информационный модуль для organizations _sensor _readings _latest

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

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

Получить все organizations _sensor _readings _latest.
Вернуть последние доступные показания для каждой метрики от каждого датчика, отсортированные по серийному номеру датчика.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
direction string	direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница Default: `"https://api.meraki.com/api/v1"`
endingBefore string	Параметр запроса EndingBefore. Маркер, используемый сервером для указания конца страницы. Часто это метка времени или ID, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
headers dictionary	Дополнительные заголовки.
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 (целое число), время ожидания повтора попытки при ошибке 429 Nginx 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 (строка), прокси-сервер и порт, если необходимо, для HTTPS Default: `""`
meraki_retry_4xx_error boolean	meraki_retry_4xx_error (булево), повторить попытку при возникновении другой ошибки 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)
metrics list / elements=string	Параметр запроса Metrics. Типы показаний датчиков для получения. Если метрики не указаны, будут получены все доступные типы показаний. Допустимые значения: apparentPower, battery, button, co2, current, door, downstreamPower, frequency, humidity, indoorAirQuality, noise, pm25, powerFactor, realPower, remoteLockoutSwitch, temperature, tvoc, voltage и water.
networkIds list / elements=string	Параметр запроса NetworkIds. Необязательный параметр для фильтрации показаний по сети.
organizationId string	Параметр пути OrganizationId. Идентификатор организации.
perPage integer	Параметр запроса PerPage. Количество записей на страницу. Допустимый диапазон — от 3 до 1000. По умолчанию — 1000.
serials list / elements=string	Параметр запроса Serials. Необязательный параметр для фильтрации показаний по датчику.
startingAfter string	Параметр запроса StartingAfter. Маркер, используемый сервером для указания начала страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен определяться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link должна определять его.
total_pages string / required	total_pages(int), использовать с 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_, используются пакетом Cisco Meraki Python SDK для установления соединения

См. также

Документация 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_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 list / elements=dictionary	Словарь или список с ответом, возвращенным пакетом Cisco Meraki Python SDK Возвращается: всегда Пример: "[\n {\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"readings\": [\n {\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 \"metric\": \"string\",\n \"noise\": {\n \"ambient\": {\n \"level\": 0\n }\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 \"celsius\": 0,\n \"fahrenheit\": 0\n },\n \"ts\": \"string\",\n \"tvoc\": {\n \"concentration\": 0\n },\n \"voltage\": {\n \"level\": 0\n },\n \"water\": {\n \"present\": true\n }\n }\n ],\n \"serial\": \"string\"\n }\n]\n"

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"network\": {\n \"id\": \"string\",\n \"name\": \"string\"\n },\n \"readings\": [\n {\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 \"metric\": \"string\",\n \"noise\": {\n \"ambient\": {\n \"level\": 0\n }\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 \"celsius\": 0,\n \"fahrenheit\": 0\n },\n \"ts\": \"string\",\n \"tvoc\": {\n \"concentration\": 0\n },\n \"voltage\": {\n \"level\": 0\n },\n \"water\": {\n \"present\": true\n }\n }\n ],\n \"serial\": \"string\"\n }\n]\n"

Авторы

Francisco Munoz (@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/organizations_sensor_readings_latest_info_module.html