Get-XenPIFMetricsProperty

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

Syntax

Get-XenPIFMetricsProperty [-PIFMetrics] <PIF_metrics>
    -XenProperty {Uuid | IoReadKbs | IoWriteKbs | Carrier | VendorId | VendorName | DeviceId | DeviceName | Speed | Duplex | PciBusPath | LastUpdated | OtherConfig | LldpNeighbor}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPIFMetricsProperty [-Ref] <XenRef[PIF_metrics]>
    -XenProperty {Uuid | IoReadKbs | IoWriteKbs | Carrier | VendorId | VendorName | DeviceId | DeviceName | Speed | Duplex | PciBusPath | LastUpdated | OtherConfig | LldpNeighbor}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PIFMetrics object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PIF\_metrics.
IoReadKbs: Get the io/read\_kbs field of the given PIF\_metrics. (Removed.)
IoWriteKbs: Get the io/write\_kbs field of the given PIF\_metrics. (Removed.)
Carrier: Get the carrier field of the given PIF\_metrics.
VendorId: Get the vendor\_id field of the given PIF\_metrics.
VendorName: Get the vendor\_name field of the given PIF\_metrics.
DeviceId: Get the device\_id field of the given PIF\_metrics.
DeviceName: Get the device\_name field of the given PIF\_metrics.
Speed: Get the speed field of the given PIF\_metrics.
Duplex: Get the duplex field of the given PIF\_metrics.
PciBusPath: Get the pci\_bus\_path field of the given PIF\_metrics.
LastUpdated: Get the last\_updated field of the given PIF\_metrics.
OtherConfig: Get the other\_config field of the given PIF\_metrics.
LldpNeighbor: Get the lldp\_neighbor field of the given PIF\_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

-PIFMetrics

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

-Ref

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenPIFMetricsProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, IoReadKbs, IoWriteKbs, Carrier, VendorId, VendorName, DeviceId, DeviceName, Speed, Duplex, PciBusPath, LastUpdated, OtherConfig, LldpNeighbor

Inputs

  • PIF_metrics
  • XenRef[PIF_metrics]

Outputs

  • System.Object

Examples

Example 1: Get the IoReadKbs property

PS> Get-XenPIFMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFMetricsProperty -XenProperty IoReadKbs
Gets the IoReadKbs property of a PIFMetrics.

Example 2: Get the IoWriteKbs property

PS> Get-XenPIFMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFMetricsProperty -XenProperty IoWriteKbs
Gets the IoWriteKbs property of a PIFMetrics.

Example 3: Get the Carrier property

PS> Get-XenPIFMetrics -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPIFMetricsProperty -XenProperty Carrier
Gets the Carrier property of a PIFMetrics.