Spec-Zone.ru › Ansible

Модуль cisco.meraki.organizations_sensor_readings_history_info — информационный модуль для organizations _sensor _readings _history

Примечание

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

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

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

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

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

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

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

  • Информационный модуль для Organizations Sensor Readings History Info.
  • Получение всех organizations _sensor _readings _history.
  • Возвращает все показания датчиков, зарегистрированные за указанный период, в порядке временных меток.

Примечание

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

Требования

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

  • meraki >= 2.4.9
  • python >= 3.5

Параметры

Параметр

Комментарии

direction

string

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

По умолчанию: "https://api.meraki.com/api/v1"

endingBefore

string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это временная метка или идентификатор, но допустимы и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.

headers

dictionary

Дополнительные заголовки.

meraki_action_batch_retry_wait_time

integer

meraki_action_batch_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке параллельного выполнения пакета действий

По умолчанию: 60

meraki_api_key

string / обязательный

meraki_api_key (string), API-ключ, созданный на панели управления; также можно задать в переменной среды MERAKI_DASHBOARD_API_KEY

meraki_base_url

string

meraki_base_url (string), базовый URL, предшествующий ресурсам конечных точек

По умолчанию: "https://api.meraki.com/api/v1"

meraki_be_geo_id

string

meraki_be_geo_id (string), необязательный идентификатор партнера для отслеживания использования API; также можно задать в переменной среды BE_GEO_ID

По умолчанию: ""

meraki_certificate_path

string

meraki_certificate_path (string), путь к сертификату TLS/SSL для проверки, если используется локальный прокси-сервер

По умолчанию: ""

meraki_inherit_logging_config

boolean

meraki_inherit_logging_config (boolean), наследовать ваш собственный экземпляр регистратора

Варианты:

  • false ← (по умолчанию)
  • true

meraki_log_file_prefix

string

meraki_log_file_prefix (string), имя файла журнала с добавленными датой и временной меткой

По умолчанию: "meraki_api_"

meraki_log_path

string

log_path (string), путь для записи журнала; если не задан, используется рабочий каталог скрипта

По умолчанию: ""

meraki_maximum_retries

integer

meraki_maximum_retries (integer), максимальное число повторных попыток при получении ошибок 429 или других ошибок на стороне сервера

По умолчанию: 2

meraki_nginx_429_retry_wait_time

integer

meraki_nginx_429_retry_wait_time (integer), время ожидания перед повторной попыткой при ошибке 429 от Nginx

По умолчанию: 60

meraki_output_log

boolean

meraki_output_log (boolean), создавать файл журнала вывода?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_print_console

boolean

meraki_print_console (boolean), выводить журнал в консоль?

Варианты:

  • false
  • true ← (по умолчанию)

meraki_requests_proxy

string

meraki_requests_proxy (string), адрес и порт прокси-сервера для HTTPS, если необходимо

По умолчанию: ""

meraki_retry_4xx_error

boolean

meraki_retry_4xx_error (boolean), повторять попытку при других ошибках 4XX (кроме 429)?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_retry_4xx_error_wait_time

integer

meraki_retry_4xx_error_wait_time (integer), время ожидания перед повторной попыткой при других ошибках 4XX

По умолчанию: 60

meraki_simulate

boolean

meraki_simulate (boolean), имитировать вызовы POST/PUT/DELETE, чтобы предотвратить внесение изменений?

Варианты:

  • false ← (по умолчанию)
  • true

meraki_single_request_timeout

integer

meraki_single_request_timeout (integer), максимальное время выполнения каждого вызова API в секундах

По умолчанию: 60

meraki_suppress_logging

boolean

meraki_suppress_logging (boolean), отключить все ведение журналов? Тогда вы сами за себя!

Варианты:

  • false ← (по умолчанию)
  • true

meraki_use_iterator_for_get_pages

boolean

meraki_use_iterator_for_get_pages (boolean), методы list* возвращают итератор с каждым объектом вместо полного списка всех элементов

Варианты:

  • false ← (по умолчанию)
  • true

meraki_wait_on_rate_limit

boolean

meraki_wait_on_rate_limit (boolean), повторять попытку при ошибке ограничения частоты запросов 429?

Варианты:

  • false
  • true ← (по умолчанию)

metrics

list / elements=string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса Metrics. Типы показаний датчиков для получения. Если метрики не указаны, будут получены все доступные типы показаний.

networkIds

list / elements=string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса NetworkIds. Необязательный параметр для фильтрации показаний по сети.

organizationId

string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр пути OrganizationId. Идентификатор организации.

perPage

integer

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.

serials

list / elements=string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса Serials. Необязательный параметр для фильтрации показаний по датчику.

startingAfter

string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это временная метка или идентификатор, но допустимы и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.

t0

string

Информационный модуль для Organizations Sensor Readings History Info.

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

t1

string

Информационный модуль для Organizations Sensor Readings History Info.

Параметр запроса T1. Конец периода, за который запрашиваются данные. Значение T1 может быть не более чем на 7 дней позже t0.

timespan

float

Информационный модуль для Organizations Sensor Readings History Info.

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

total_pages

string / обязательный

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_, используются Python SDK Cisco meraki для установки соединения

См. также

См. также

Документация Cisco Meraki по 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_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
    t0: string
    t1: string
    timespan: 0
    networkIds: []
    serials: []
    metrics: []
    organizationId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

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

Авторы

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

Spec-Zone.ru

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