Get-PveClusterMetricsExport

Retrieve metrics of the cluster.

API: GET /cluster/metrics/export, Proxmox VE API viewer

Syntax

Get-PveClusterMetricsExport
    [-PveTicket <PveTicket>]
    [-History <bool>]
    [-LocalOnly <bool>]
    [-NodeList <string>]
    [-StartTime <int>]
    [<CommonParameters>]

Parameters

Parameter	Type	Required	Description
-PveTicket	PveTicket	No	Ticket data connection.
-History	bool	No	Also return historic values. Returns full available metric history unless start-time is also set.
-LocalOnly	bool	No	Only return metrics for the current node instead of the whole cluster.
-NodeList	string	No	Only return metrics from nodes passed as comma-separated list.
-StartTime	int	No	Only include metrics with a timestamp > start-time.

Every parameter also binds by property name from the pipeline, so an object with node and vmid properties (the output of Get-PveGuest, for one) fills -Node and -Vmid. Without -PveTicket the cmdlet uses the last connection, see Connection.

Output

A PveResponse: the data returned by Proxmox VE is in .Response.data, the outcome in .IsSuccessStatusCode. See Results and Errors.