vmware.vmware_rest.appliance_monitoring_info module – Gather information about the monitored statistics of the vCenter Server Appliance.

Note

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

To use it in a playbook, specify: vmware.vmware_rest.appliance_monitoring_info.

New in vmware.vmware_rest 5.0.0

Synopsis

  • Retrieve information about the metrics that the vCenter Server Appliance monitors, such as CPU, memory, network, and storage statistics.

  • When stat_id is provided, return the details of that single monitored item, including its display name, category, unit of measure, and description.

  • When stat_id is omitted, list every monitored item available on the appliance.

  • This module only reports the metadata that describes each monitored item. Use vmware.vmware_rest.appliance_monitoring_query to retrieve the actual data points for a metric.

Parameters

Parameter

Comments

session_timeout

float

Timeout in seconds for the whole operation including connection establishment, request sending, and response.

Default: 300.0

stat_id

string

The identifier of the monitored item to retrieve detailed information for.

When omitted, information about all monitored items on the appliance is returned.

The value must be the ID of a monitored item returned by this module, for example cpu.util or mem.util.

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_port

integer

The port number of the vSphere vCenter.

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

vcenter_rest_log_file

string

Optional path to a log file for HTTP REST interaction.

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

  • Generated from vSphere API spec 9.1.0.

  • Compatible with vSphere API 7.0.3.

  • Compatible with vSphere API 8.0.2.

Examples

- name: List all monitored items on the appliance
  vmware.vmware_rest.appliance_monitoring_info:
  register: all_stats

- name: Get information about a single monitored item
  vmware.vmware_rest.appliance_monitoring_info:
    stat_id: cpu.util
  register: cpu_stat

- name: Display the unit of measure for the monitored item
  ansible.builtin.debug:
    var: cpu_stat.value.units

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

id

string

The identifier of the monitored item that was queried.

Returned: When only one monitored item, identified by stat_id, was queried

Sample: "cpu.util"

info

list / elements=dictionary

A list of detailed information about the monitored items on the appliance.

Returned: When stat_id is not provided

Sample: [{"category": "cpu", "description": "com.vmware.applmgmt.mon.descr.cpu.util", "id": "cpu.util", "instance": "", "name": "CPU utilization", "units": "%"}, {"category": "memory", "description": "com.vmware.applmgmt.mon.descr.mem.util", "id": "mem.util", "instance": "", "name": "Memory utilization", "units": "KB"}]

value

dictionary

Detailed information about a single monitored item.

Returned: When only one monitored item, identified by stat_id, was queried

Sample: {"category": "cpu", "description": "com.vmware.applmgmt.mon.descr.cpu.util", "id": "cpu.util", "instance": "", "name": "CPU utilization", "units": "%"}

Authors

  • Ansible Eco Content Team (@eco-ansible-content)