Get-XenVBDMetricsProperty

Last published : Nov 12, 2026
\[Removed\] Gets a property of a VBDMetrics object.
Related information
VBDMetrics cmdlets

Syntax

Get-XenVBDMetricsProperty [-VBDMetrics] <VBD_metrics>
    -XenProperty {Uuid | IoReadKbs | IoWriteKbs | LastUpdated | OtherConfig} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVBDMetricsProperty [-Ref] <XenRef[VBD_metrics]>
    -XenProperty {Uuid | IoReadKbs | IoWriteKbs | LastUpdated | OtherConfig} [-BestEffort]
    [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

REMOVED. This class has been removed.
Gets a specified property of a VBDMetrics object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VBD\_metrics.
IoReadKbs: Get the io/read\_kbs field of the given VBD\_metrics. (Removed.)
IoWriteKbs: Get the io/write\_kbs field of the given VBD\_metrics. (Removed.)
LastUpdated: Get the last\_updated field of the given VBD\_metrics. (Removed.)
OtherConfig: Get the other\_config field of the given VBD\_metrics. (Removed.)

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 VBDMetrics object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[VBD_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

-VBDMetrics

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVBDMetricsProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, IoReadKbs, IoWriteKbs, LastUpdated, OtherConfig

Inputs

  • VBD_metrics
  • XenRef[VBD_metrics]

Outputs

  • System.Object

Examples

Example 1: Get the IoReadKbs property

PS> Get-XenVBDMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDMetricsProperty -XenProperty IoReadKbs
Gets the IoReadKbs property of a VBDMetrics.

Example 2: Get the IoWriteKbs property

PS> Get-XenVBDMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDMetricsProperty -XenProperty IoWriteKbs
Gets the IoWriteKbs property of a VBDMetrics.

Example 3: Get the LastUpdated property

PS> Get-XenVBDMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVBDMetricsProperty -XenProperty LastUpdated
Gets the LastUpdated property of a VBDMetrics.