Модуль vmware.vmware_rest.appliance_monitoring_query — получение данных мониторинга.
Примечание
Этот модуль входит в коллекцию vmware.vmware_rest (версия 4.10.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install vmware.vmware_rest. Для использования этого модуля требуются дополнительные компоненты. Подробнее см. в разделе Требования.
Чтобы использовать модуль в сценарии, укажите: vmware.vmware_rest.appliance_monitoring_query.
Добавлено в vmware.vmware_rest 2.0.0
Краткое описание
- Получение данных мониторинга.
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- vSphere 7.0.3 или более поздней версии
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
end_time string / обязательный | Время окончания в формате UTC. Этот параметр является обязательным. |
function string / обязательный | Перечисляемый тип function_type. Определяет функцию агрегирования. Этот параметр является обязательным. Варианты:
|
interval string / обязательный | Перечисляемый тип interval_type. Определяет интервал в часах и минутах между значениями, для которых применяется агрегирование. Этот параметр является обязательным. Варианты:
|
names list / элементы=string / обязательный | Идентификаторы отслеживаемых элементов. Например: CPU, MEMORY При передаче клиентами значения этой структуры в качестве параметра поле должно содержать идентификатор ресурса, возвращённый модулем vmware.vmware_rest.appliance_monitoring_info. |
session_timeout float добавлено в vmware.vmware_rest 2.1.0 | Настройки тайм-аута клиентского сеанса. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и получение ответа. Значение по умолчанию — 300 с. |
start_time string / обязательный | Время начала в формате UTC. Этот параметр является обязательным. |
vcenter_hostname string / обязательный | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_password string / обязательный | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_rest_log_file string | Этот необязательный параметр позволяет указать расположение файла журнала. Этот файл будет использоваться для записи взаимодействия по HTTP REST. Файл будет сохранён на хосте, где выполняется модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_username string / обязательный | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной среды |
vcenter_validate_certs boolean | Разрешает подключение при недействительных SSL-сертификатах. Установите значение Если значение не указано в задаче, вместо него будет использовано значение переменной среды Варианты:
|
Примечания
Примечание
- Проверено на vSphere 7.0.3
Примеры
- name: Query the monitoring backend
vmware.vmware_rest.appliance_monitoring_query:
end_time: 2021-04-14 09:34:56+00:00
start_time: 2021-04-14 08:34:56+00:00
names:
- mem.total
interval: MINUTES5
function: AVG
register: result
Возвращаемые значения
Общие возвращаемые значения описаны здесь. Ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
value list / элементы=string | Запрос к серверной части мониторинга Возвращается: при успешном выполнении Пример: |
Ссылки на коллекцию
© 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/vmware/vmware_rest/appliance_monitoring_query_module.html
