модуль cisco.meraki.devices_sensor_commands_info — информационный модуль для devices _sensor _commands

Примечание

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

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

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

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

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

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

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

Информационный модуль Devices Sensor Commands Info.
Получение всех devices _sensor _commands.
Получение devices _sensor _commands по идентификатору.
Возвращает журнал истории всех команд.
Возвращает сведения о выполнении команды, включая её статус.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
commandId string	Информационный модуль Devices Sensor Commands Info. Параметр пути CommandId. Идентификатор команды.
direction string	direction (строка), направление пагинации: страница «next» (по умолчанию) или «prev» По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль Devices Sensor Commands Info. Параметр запроса EndingBefore. Токен, используемый сервером для обозначения конца страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
headers dictionary	Дополнительные заголовки.
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` ← (по умолчанию)
operations list / elements=string	Информационный модуль Devices Sensor Commands Info. Параметр запроса Operations. Необязательный параметр для фильтрации команд по операции. Допустимые значения: disableDownstreamPower, enableDownstreamPower, cycleDownstreamPower и refreshData.
perPage integer	Информационный модуль Devices Sensor Commands Info. Параметр запроса PerPage. Количество возвращаемых записей на странице. Допустимый диапазон: от 3 до 1000. Значение по умолчанию — 10.
serial string	Информационный модуль Devices Sensor Commands Info. Параметр пути Serial.
sortOrder string	Информационный модуль Devices Sensor Commands Info. Параметр запроса SortOrder. Порядок сортировки записей. Варианты: «ascending» и «descending». Значение по умолчанию — «descending».
startingAfter string	Информационный модуль Devices Sensor Commands Info. Параметр запроса StartingAfter. Токен, используемый сервером для обозначения начала страницы. Часто это временная метка или идентификатор, но возможны и другие значения. Клиентским приложениям не следует задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в заголовке HTTP Link.
t0 string	Информационный модуль Devices Sensor Commands Info. Параметр запроса T0. Начало временного интервала для данных. Максимальная глубина выборки — 30 дней от текущей даты.
t1 string	Информационный модуль Devices Sensor Commands Info. Параметр запроса T1. Конец временного интервала для данных. Значение T1 может быть не более чем на 30 дней позже t0.
timespan float	Информационный модуль Devices Sensor Commands Info. Параметр запроса Timespan. Временной интервал, за который будут получены данные. Если указан timespan, не указывайте параметры t0 и t1. Значение должно быть задано в секундах и не превышать 30 дней. По умолчанию — 30 дней.
total_pages string / обязательный	total_pages (целое число), используйте вместе с perPage, чтобы получить результаты на количестве страниц до total_pages*perPage; значение -1 означает все страницы

Примечания

Примечание

Используются методы SDK sensor.Sensor.get_device_sensor_command, sensor.Sensor.get_device_sensor_commands,
Используются пути get /devices/{serial}/sensor/commands, get /devices/{serial}/sensor/commands/{commandId},
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный менеджер подключений Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Python SDK Cisco meraki для установки соединения

См. также

Документация Cisco Meraki по sensor getDeviceSensorCommand: Полное описание API getDeviceSensorCommand.
Документация Cisco Meraki по sensor getDeviceSensorCommands: Полное описание API getDeviceSensorCommands.

Примеры

- name: Get all devices _sensor _commands
  cisco.meraki.devices_sensor_commands_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 }}"
    operations: []
    perPage: 0
    startingAfter: string
    endingBefore: string
    sortOrder: string
    t0: string
    t1: string
    timespan: 0
    serial: string
    total_pages: -1
    direction: next
  register: result
- name: Get devices _sensor _commands by id
  cisco.meraki.devices_sensor_commands_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 }}"
    serial: string
    commandId: string
  register: result

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

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

Ключ	Описание
meraki_response dictionary	Словарь или список с ответом, возвращённым Python SDK Cisco Meraki Возвращается: всегда Пример: `{"commandId": "string", "completedAt": "string", "createdAt": "string", "createdBy": {"adminId": "string", "email": "string", "name": "string"}, "errors": ["string"], "operation": "string", "status": "string"}`

Авторы

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/devices_sensor_commands_info_module.html