Get-XenVMGuestMetricsProperty

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

Syntax

Get-XenVMGuestMetricsProperty [-VMGuestMetrics] <VM_guest_metrics>
    -XenProperty {Uuid | OsVersion | NetbiosName | PVDriversVersion | PVDriversUpToDate | Memory | Disks | Networks | Other | LastUpdated | OtherConfig | Live | CanUseHotplugVbd | CanUseHotplugVif | PVDriversDetected | Services}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVMGuestMetricsProperty [-Ref] <XenRef[VM_guest_metrics]>
    -XenProperty {Uuid | OsVersion | NetbiosName | PVDriversVersion | PVDriversUpToDate | Memory | Disks | Networks | Other | LastUpdated | OtherConfig | Live | CanUseHotplugVbd | CanUseHotplugVif | PVDriversDetected | Services}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VMGuestMetrics object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VM\_guest\_metrics.
OsVersion: Get the os\_version field of the given VM\_guest\_metrics.
NetbiosName: Get the netbios\_name field of the given VM\_guest\_metrics.
PVDriversVersion: Get the PV\_drivers\_version field of the given VM\_guest\_metrics.
PVDriversUpToDate: Get the PV\_drivers\_up\_to\_date field of the given VM\_guest\_metrics. (Deprecated.)
Memory: Get the memory field of the given VM\_guest\_metrics. (Removed.)
Disks: Get the disks field of the given VM\_guest\_metrics. (Removed.)
Networks: Get the networks field of the given VM\_guest\_metrics.
Other: Get the other field of the given VM\_guest\_metrics.
LastUpdated: Get the last\_updated field of the given VM\_guest\_metrics.
OtherConfig: Get the other\_config field of the given VM\_guest\_metrics.
Live: Get the live field of the given VM\_guest\_metrics.
CanUseHotplugVbd: Get the can\_use\_hotplug\_vbd field of the given VM\_guest\_metrics.
CanUseHotplugVif: Get the can\_use\_hotplug\_vif field of the given VM\_guest\_metrics.
PVDriversDetected: Get the PV\_drivers\_detected field of the given VM\_guest\_metrics.
Services: Get the services field of the given VM\_guest\_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 VMGuestMetrics object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VM_guest_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

-VMGuestMetrics

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVMGuestMetricsProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, OsVersion, NetbiosName, PVDriversVersion, PVDriversUpToDate, Memory, Disks, Networks, Other, LastUpdated, OtherConfig, Live, CanUseHotplugVbd, CanUseHotplugVif, PVDriversDetected, Services

Inputs

  • VM_guest_metrics
  • XenRef[VM_guest_metrics]

Outputs

  • System.Object

Examples

Example 1: Get the OsVersion property

PS> Get-XenVMGuestMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMGuestMetricsProperty -XenProperty OsVersion
Gets the OsVersion property of a VMGuestMetrics.

Example 2: Get the NetbiosName property

PS> Get-XenVMGuestMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMGuestMetricsProperty -XenProperty NetbiosName
Gets the NetbiosName property of a VMGuestMetrics.

Example 3: Get the PVDriversVersion property

PS> Get-XenVMGuestMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVMGuestMetricsProperty -XenProperty PVDriversVersion
Gets the PVDriversVersion property of a VMGuestMetrics.