appliance_monitoring_query

Query appliance monitoring statistics over time

Collection: vmware.vmware_rest

Full Name: vmware.vmware_rest.appliance_monitoring_query

Synopsis

Query appliance monitoring statistics over time

Parameters

Name	Type	Required	Default	Description
vcenter_hostname	string	yes		The hostname or IP address of the vSphere vCenter
If the value is not specified in the task, the value of environment variable C(VMWARE_HOST) will be used instead.
vcenter_username	string	yes		The vSphere vCenter username
If the value is not specified in the task, the value of environment variable C(VMWARE_USER) will be used instead.
vcenter_password	string	yes		The vSphere vCenter password
If the value is not specified in the task, the value of environment variable C(VMWARE_PASSWORD) will be used instead.
vcenter_validate_certs	bool		`true`	Allows connection when SSL certificates are not valid. Set to C(false) when certificates are not trusted.
If the value is not specified in the task, the value of environment variable C(VMWARE_VALIDATE_CERTS) will be used instead.
vcenter_rest_log_file	string			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 C(VMWARE_REST_LOG_FILE) will be used instead.
session_timeout	float			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.
end_time	string	yes		End time in UTC This parameter is mandatory.
function	string	yes		I(function_type) enumerated type Defines aggregation function This parameter is mandatory.
interval	string	yes		I(interval_type) enumerated type Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory.
names	list	yes		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 M(vmware.vmware_rest.appliance_monitoring_info).
start_time	string	yes		Start time in UTC This parameter is mandatory.

Example

yaml

- 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