vmware.vmware_rest.appliance_monitoring_query module – Get monitoring data.
Note
This module is part of the vmware.vmware_rest collection (version 4.2.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install vmware.vmware_rest
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: vmware.vmware_rest.appliance_monitoring_query
.
New in vmware.vmware_rest 2.0.0
Synopsis
Get monitoring data.
Requirements
The below requirements are needed on the host that executes this module.
vSphere 7.0.3 or greater
python >= 3.6
aiohttp
Parameters
Parameter |
Comments |
---|---|
End time in UTC This parameter is mandatory. |
|
function_type enumerated type Defines aggregation function This parameter is mandatory. Choices:
|
|
interval_type enumerated type Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory. Choices:
|
|
monitored item IDs Ex: CPU, MEMORY When clients pass a value of this structure as a parameter, the field must contain the id of resources returned by vmware.vmware_rest.appliance_monitoring_info. |
|
Timeout settings for client session. The maximal number of seconds for the whole operation including connection establishment, request sending and response. The default value is 300s. |
|
Start time in UTC This parameter is mandatory. |
|
The hostname or IP address of the vSphere vCenter If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter password If the value is not specified in the task, the value of environment variable |
|
You can use this optional parameter to set the location of a log file. This file will be used to record the HTTP REST interaction. The file will be stored on the host that runs the module. If the value is not specified in the task, the value of environment variable |
|
The vSphere vCenter username If the value is not specified in the task, the value of environment variable |
|
Allows connection when SSL certificates are not valid. Set to If the value is not specified in the task, the value of environment variable Choices:
|
Notes
Note
Tested on vSphere 7.0.3
Examples
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Query the monitoring backend Returned: On success Sample: |