Модуль cisco.meraki.networks_sm_devices_performance_history_info — информационный модуль для networks _sm _devices _performancehistory

Примечание

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

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

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

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

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

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

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

Информационный модуль для Networks Sm Devices Performancehistory Info.
Получение всех networks _sm _devices _performancehistory.
Возвращает исторические записи различных метрик клиентов Systems Manager для настольных устройств.

Примечание

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

Требования

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

meraki >= 2.4.9
python >= 3.5

Параметры

Параметр	Комментарии
deviceId string	Информационный модуль для Networks Sm Devices Performancehistory Info. Параметр пути DeviceId. Идентификатор устройства.
direction string	direction (string), направление пагинации: страница “next” (по умолчанию) или “prev” По умолчанию: `"https://api.meraki.com/api/v1"`
endingBefore string	Информационный модуль для Networks Sm Devices Performancehistory 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), время ожидания перед повторной попыткой при ответе Nginx 429 По умолчанию: `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` ← (по умолчанию)
networkId string	Информационный модуль для Networks Sm Devices Performancehistory Info. Параметр пути NetworkId. Идентификатор сети.
perPage integer	Информационный модуль для Networks Sm Devices Performancehistory Info. Параметр запроса PerPage. Количество записей на возвращаемой странице. Допустимый диапазон: 3–1000. Значение по умолчанию — 1000.
startingAfter string	Информационный модуль для Networks Sm Devices Performancehistory Info. Параметр запроса StartingAfter. Токен, который сервер использует для указания начала страницы. Часто это метка времени или идентификатор, но возможны и другие значения. Клиентские приложения не должны задавать этот параметр. Его следует указывать в ссылке на первую, последнюю, предыдущую или следующую страницу в HTTP-заголовке Link.
total_pages string / обязательный	total_pages(int), используйте вместе с perPage, чтобы получить до total_pages*perPage результатов; -1 означает все страницы

Примечания

Примечание

Используемый метод SDK: sm.Sm.get_network_sm_device_performance_history,
Используемый путь: get /networks/{networkId}/sm/devices/{deviceId}/performanceHistory,
Поддерживает check_mode
Плагин выполняется на управляющем узле и не использует плагины подключений Ansible, а вместо этого использует встроенный диспетчер подключений из Cisco meraki SDK
Параметры, начинающиеся с meraki_, используются Cisco meraki Python SDK для установления соединения

См. также

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

Примеры

- name: Get all networks _sm _devices _performancehistory
  cisco.meraki.networks_sm_devices_performance_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
    networkId: string
    deviceId: string
    total_pages: -1
    direction: next
  register: result

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

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

Ключ	Описание
meraki_response list / elements=dictionary	Словарь или список с ответом, возвращенным Cisco Meraki Python SDK Возвращается: всегда Пример: `"[\n {\n \"cpuPercentUsed\": 0,\n \"memFree\": 0,\n \"memWired\": 0,\n \"memActive\": 0,\n \"memInactive\": 0,\n \"networkSent\": 0,\n \"networkReceived\": 0,\n \"swapUsed\": 0,\n \"diskUsage\": {\n \"c\": {\n \"used\": 0,\n \"space\": 0\n }\n },\n \"ts\": \"string\"\n }\n]\n"`

Ключ

Описание

meraki_response

list / elements=dictionary

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

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

Пример: "[\n {\n \"cpuPercentUsed\": 0,\n \"memFree\": 0,\n \"memWired\": 0,\n \"memActive\": 0,\n \"memInactive\": 0,\n \"networkSent\": 0,\n \"networkReceived\": 0,\n \"swapUsed\": 0,\n \"diskUsage\": {\n \"c\": {\n \"used\": 0,\n \"space\": 0\n }\n },\n \"ts\": \"string\"\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/networks_sm_devices_performance_history_info_module.html