vmware.vmware_rest.appliance_monitoring_query module – Get monitoring data.

Note

This module is part of the vmware.vmware_rest collection (version 3.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

string / required

End time in UTC This parameter is mandatory.

function

string / required

function_type enumerated type Defines aggregation function This parameter is mandatory.

Choices:

  • "AVG"

  • "COUNT"

  • "MAX"

  • "MIN"

interval

string / required

interval_type enumerated type Defines interval between the values in hours and mins, for which aggregation will apply This parameter is mandatory.

Choices:

  • "DAY1"

  • "HOURS2"

  • "HOURS6"

  • "MINUTES30"

  • "MINUTES5"

names

list / elements=string / required

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.

session_timeout

float

added in vmware.vmware_rest 2.1.0

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

string / required

Start time in UTC This parameter is mandatory.

vcenter_hostname

string / required

The hostname or IP address of the vSphere vCenter

If the value is not specified in the task, the value of environment variable VMWARE_HOST will be used instead.

vcenter_password

string / required

The vSphere vCenter password

If the value is not specified in the task, the value of environment variable VMWARE_PASSWORD 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 run the module.

If the value is not specified in the task, the value of

environment variable VMWARE_REST_LOG_FILE will be used instead.

vcenter_username

string / required

The vSphere vCenter username

If the value is not specified in the task, the value of environment variable VMWARE_USER will be used instead.

vcenter_validate_certs

boolean

Allows connection when SSL certificates are not valid. Set to false when certificates are not trusted.

If the value is not specified in the task, the value of environment variable VMWARE_VALIDATE_CERTS will be used instead.

Choices:

  • false

  • true ← (default)

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

value

list / elements=string

Query the monitoring backend

Returned: On success

Sample: [{"data": ["", "", "", "", "", "", "", "", "", "", "", "", ""], "end_time": "2021-04-14T09:34:56.000Z", "function": "AVG", "interval": "MINUTES5", "name": "mem.total", "start_time": "2021-04-14T08:34:56.000Z"}]

Authors

  • Ansible Cloud Team (@ansible-collections)