Get-XenVMMetricsProperty

Last published : Nov 12, 2026
Gets a property of a VMMetrics object.
Related information
VMMetrics cmdlets

Syntax

Get-XenVMMetricsProperty [-VMMetrics] <VM_metrics>
    -XenProperty {Uuid | MemoryActual | VCPUsNumber | VCPUsUtilisation | VCPUsCPU | VCPUsParams | VCPUsFlags | State | StartTime | InstallTime | LastUpdated | OtherConfig | Hvm | NestedVirt | Nomigrate | CurrentDomainType | NumaOptimised | NumaNodes | NumaNodeMemory}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMMetricsProperty [-Ref] <XenRef[VM_metrics]>
    -XenProperty {Uuid | MemoryActual | VCPUsNumber | VCPUsUtilisation | VCPUsCPU | VCPUsParams | VCPUsFlags | State | StartTime | InstallTime | LastUpdated | OtherConfig | Hvm | NestedVirt | Nomigrate | CurrentDomainType | NumaOptimised | NumaNodes | NumaNodeMemory}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VMMetrics object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VM\_metrics.
MemoryActual: Get the memory/actual field of the given VM\_metrics.
VCPUsNumber: Get the VCPUs/number field of the given VM\_metrics.
VCPUsUtilisation: Get the VCPUs/utilisation field of the given VM\_metrics. (Removed.)
VCPUsCPU: Get the VCPUs/CPU field of the given VM\_metrics.
VCPUsParams: Get the VCPUs/params field of the given VM\_metrics.
VCPUsFlags: Get the VCPUs/flags field of the given VM\_metrics.
State: Get the state field of the given VM\_metrics.
StartTime: Get the start\_time field of the given VM\_metrics.
InstallTime: Get the install\_time field of the given VM\_metrics.
LastUpdated: Get the last\_updated field of the given VM\_metrics.
OtherConfig: Get the other\_config field of the given VM\_metrics.
Hvm: Get the hvm field of the given VM\_metrics.
NestedVirt: Get the nested\_virt field of the given VM\_metrics.
Nomigrate: Get the nomigrate field of the given VM\_metrics.
CurrentDomainType: Get the current\_domain\_type field of the given VM\_metrics.
NumaOptimised: Get the numa\_optimised field of the given VM\_metrics.
NumaNodes: Get the numa\_nodes field of the given VM\_metrics.
NumaNodeMemory: Get the numa\_node\_memory field of the given VM\_metrics.

Parameters

-BestEffort

If set, the cmdlet continues processing further objects instead of throwing a terminating error when an operation fails for one object.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-Ref

The VMMetrics object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_metrics]
Required True
Position 0
Accepts pipeline input True (ByPropertyName)
Aliases opaque_ref

-SessionOpaqueRef

The session object on which to run the cmdlet. This overrides the default session and lets you target a specific open XenServer connection.
Attribute Value
Type string
Required False
Position Named
Accepts pipeline input False

-VMMetrics

The VMMetrics object to operate on.
Attribute Value
Type VM_metrics
Required True
Position 0
Accepts pipeline input True (ByValue)

-XenProperty

Selects which property to use.
Attribute Value
Type XenVMMetricsProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, MemoryActual, VCPUsNumber, VCPUsUtilisation, VCPUsCPU, VCPUsParams, VCPUsFlags, State, StartTime, InstallTime, LastUpdated, OtherConfig, Hvm, NestedVirt, Nomigrate, CurrentDomainType, NumaOptimised, NumaNodes, NumaNodeMemory

Inputs

  • VM_metrics
  • XenRef[VM_metrics]

Outputs

  • System.Object

Examples

Example 1: Get the MemoryActual property

PS> Get-XenVMMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMMetricsProperty -XenProperty MemoryActual
Gets the MemoryActual property of a VMMetrics.

Example 2: Get the VCPUsNumber property

PS> Get-XenVMMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMMetricsProperty -XenProperty VCPUsNumber
Gets the VCPUsNumber property of a VMMetrics.

Example 3: Get the VCPUsUtilisation property

PS> Get-XenVMMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMMetricsProperty -XenProperty VCPUsUtilisation
Gets the VCPUsUtilisation property of a VMMetrics.