Get-XenPBDProperty

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

Syntax

Get-XenPBDProperty [-PBD] <PBD>
    -XenProperty {Uuid | Host | SR | DeviceConfig | CurrentlyAttached | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPBDProperty [-Ref] <XenRef[PBD]>
    -XenProperty {Uuid | Host | SR | DeviceConfig | CurrentlyAttached | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PBD object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PBD.
Host: Get the host field of the given PBD.
SR: Get the SR field of the given PBD.
DeviceConfig: Get the device\_config field of the given PBD.
CurrentlyAttached: Get the currently\_attached field of the given PBD.
OtherConfig: Get the other\_config field of the given PBD.

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

-PBD

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

-Ref

The PBD object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PBD]
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 XenPBDProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, Host, SR, DeviceConfig, CurrentlyAttached, OtherConfig

Inputs

  • PBD
  • XenRef[PBD]

Outputs

  • System.Object

Examples

Example 1: Get the Host property

PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPBDProperty -XenProperty Host
Gets the Host property of a PBD.

Example 2: Get the SR property

PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPBDProperty -XenProperty SR
Gets the SR property of a PBD.

Example 3: Get the DeviceConfig property

PS> Get-XenPBD -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPBDProperty -XenProperty DeviceConfig
Gets the DeviceConfig property of a PBD.
  • PBD cmdlets
  • Class: PBD
  • Using the XenServer PowerShell module