Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_sensor_readings_history_info – Модуль информации об истории данных датчиков организаций

Примечание

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

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

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

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

Новое в cisco.meraki 2.16.0

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

Обзор

  • Получение всей истории данных датчиков организаций.
  • Возвращение всех сообщённых показаний датчиков за заданный период, отсортированные по метке времени.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

direction (строка), направление для постраничной навигации, либо “next” (по умолчанию), либо “prev” страница

Default: "https://api.meraki.com/api/v1"

endingBefore

string

Параметр запроса EndingBefore. Маркер, используемый сервером для обозначения конца страницы. Часто это метка времени или идентификатор, но не ограничивается ими. Этот параметр не должен задаваться клиентскими приложениями. Ссылка на первую, последнюю, предыдущую или следующую страницу в заголовке 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 должна определять его.

t0

string

Параметр запроса T0. Начало временного интервала для данных. Максимальный период обратного просмотра составляет 365 дней и 6 часов с сегодняшнего дня.

t1

string

Параметр запроса T1. Конец временного интервала для данных. T1 может быть максимум на 7 дней позже t0.

timespan

float

Параметр запроса Timespan. Временной интервал, для которого будет извлечена информация. При указании timespan не указывайте параметры t0 и t1. Значение должно быть в секундах и быть меньше или равно 7 дням. По умолчанию - 2 часа.

total_pages

string / required

total_pages(int), использовать с perPage для получения всех результатов до total_pages*perPage; -1 для всех страниц

Примечания

Примечание

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

См. также

См. также

Cisco Meraki documentation for sensor getOrganizationSensorReadingsHistory

Полная справка по API getOrganizationSensorReadingsHistory.

Примеры

- name: Get all organizations _sensor _readings _history
  cisco.meraki.organizations_sensor_readings_history_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
    t0: string
    t1: string
    timespan: 0
    networkIds: []
    serials: []
    metrics: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

Значения возврата

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

Ключ

Описание

meraki_response

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

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

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

Пример: "[\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    \"network\": {\n      \"id\": \"string\",\n      \"name\": \"string\"\n    },\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    \"serial\": \"string\",\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"

Авторы

  • 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_history_info_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API