Модуль cisco.dnac.system_performance_historical_info – Модуль информации о исторических данных производительности системы

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: cisco.dnac.system_performance_historical_info.

Новый в cisco.dnac 3.1.0

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

Описание

Получение всех исторических данных производительности системы.
Извлекает средние значения ключевых показателей производительности (KPI) кластера, таких как использование ЦП, использование памяти или скорость сети, сгруппированные по временным интервалам в заданном диапазоне времени. Данные будут доступны за последние 24 часа.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK, который включает отладку. Варианты: `false` ← (по умолчанию) `true`
dnac_host string / обязательно	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version string	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
endTime float	Параметр запроса endTime. Это эпохальное конечное время в миллисекундах, до которого необходимо извлечь показатели производительности.
headers dictionary	Дополнительные заголовки.
kpi string	Параметр запроса kpi. Извлечь исторические данные для этого kpi. Допустимые значения cpu, memory, network.
startTime float	Параметр запроса startTime. Это эпохальное начальное время в миллисекундах, с которого необходимо извлечь показатели производительности.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения валидации запросов в соответствии со схемой JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK: health_and_performance.HealthAndPerformance.system_performance_historical,
Используемые пути: get /dna/intent/api/v1/diagnostics/system/performance/history,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует плагины подключения ansible, а вместо этого встроенный менеджер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center по Health and Performance SystemPerformanceHistoricalAPI: Полное описание API SystemPerformanceHistoricalAPI.

Примеры

- name: Get all System Performance Historical
  cisco.dnac.system_performance_historical_info:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    headers: "{{my_headers | from_json}}"
    kpi: string
    startTime: 0
    endTime: 0
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список, содержащий ответ, возвращенный Cisco DNAC Python SDK. Возвращается: всегда Пример: `{"hostName": "string", "kpis": {"cpuAvg": "string", "data": {"t1": ["string"]}, "legends": {"cpu": {"units": "string"}, "memory": {"units": "string"}, "network rx_rate": {"units": "string"}, "network tx_rate": {"units": "string"}}, "memoryAvg": "string"}, "version": "string"}`

Ключ

Описание

dnac_response

словарь

Словарь или список, содержащий ответ, возвращенный Cisco DNAC Python SDK.

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

Пример: {"hostName": "string", "kpis": {"cpuAvg": "string", "data": {"t1": ["string"]}, "legends": {"cpu": {"units": "string"}, "memory": {"units": "string"}, "network rx_rate": {"units": "string"}, "network tx_rate": {"units": "string"}}, "memoryAvg": "string"}, "version": "string"}

Авторы

Rafael Campos (@racampos)

Ссылки на коллекцию

© 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/dnac/system_performance_historical_info_module.html