Модуль vmware.vmware_rest.appliance_monitoring_query – Получение данных мониторинга.
Примечание
Этот модуль является частью коллекции vmware.vmware_rest (версия 3.2.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install vmware.vmware_rest. Вам потребуются дополнительные требования для использования этого модуля, см. Требования для получения подробной информации.
Для использования в playbook, укажите: vmware.vmware_rest.appliance_monitoring_query.
Новое в vmware.vmware_rest 2.0.0
Краткое описание
- Получение данных мониторинга.
Требования
Ниже указаны требования, необходимые на хосте, который выполняет этот модуль.
- vSphere 7.0.3 или выше
- python >= 3.6
- aiohttp
Параметры
Параметр | Комментарии |
|---|---|
end_time строка / обязательно | Конечное время в UTC. Этот параметр обязателен. |
function строка / обязательно | Перечисляемый тип function_type. Определяет функцию агрегации. Этот параметр обязателен. Варианты:
|
interval строка / обязательно | Перечисляемый тип interval_type. Определяет интервал между значениями в часах и минутах, к которым будет применена агрегация. Этот параметр обязателен. Варианты:
|
names список / элементы=строка / обязательно | Идентификаторы отслеживаемых элементов. Пример: CPU, MEMORY Когда клиенты передают значение этой структуры в качестве параметра, поле должно содержать идентификатор ресурсов, возвращаемых vmware.vmware_rest.appliance_monitoring_info. |
session_timeout число с плавающей точкой добавлено в vmware.vmware_rest 2.1.0 | Настройки времени ожидания для сессии клиента. Максимальное количество секунд для всей операции, включая установление соединения, отправку запроса и ответ. Значение по умолчанию — 300 с. |
start_time строка / обязательно | Начальное время в UTC. Этот параметр обязателен. |
vcenter_hostname строка / обязательно | Имя хоста или IP-адрес vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_password строка / обязательно | Пароль vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_rest_log_file строка | Этот необязательный параметр можно использовать для установки местоположения файла журнала. Этот файл будет использоваться для записи взаимодействия HTTP REST. Файл будет храниться на хосте, который запускает модуль. Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_username строка / обязательно | Имя пользователя vSphere vCenter Если значение не указано в задаче, вместо него будет использовано значение переменной окружения |
vcenter_validate_certs булево | Разрешает подключение, когда 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 список / элементы=строка | Запрос к мониторинговому бэкенду Возвращаемое значение: При успехе Пример: |
Ссылки на коллекцию
© 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/vmware/vmware_rest/appliance_monitoring_query_module.html
