Get-XenPUSBProperty

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

Syntax

Get-XenPUSBProperty [-PUSB] <PUSB>
    -XenProperty {Uuid | USBGroup | Host | Path | VendorId | VendorDesc | ProductId | ProductDesc | Serial | Version | Description | PassthroughEnabled | OtherConfig | Speed}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenPUSBProperty [-Ref] <XenRef[PUSB]>
    -XenProperty {Uuid | USBGroup | Host | Path | VendorId | VendorDesc | ProductId | ProductDesc | Serial | Version | Description | PassthroughEnabled | OtherConfig | Speed}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a PUSB object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given PUSB.
USBGroup: Get the USB\_group field of the given PUSB.
Host: Get the host field of the given PUSB.
Path: Get the path field of the given PUSB.
VendorId: Get the vendor\_id field of the given PUSB.
VendorDesc: Get the vendor\_desc field of the given PUSB.
ProductId: Get the product\_id field of the given PUSB.
ProductDesc: Get the product\_desc field of the given PUSB.
Serial: Get the serial field of the given PUSB.
Version: Get the version field of the given PUSB.
Description: Get the description field of the given PUSB.
PassthroughEnabled: Get the passthrough\_enabled field of the given PUSB.
OtherConfig: Get the other\_config field of the given PUSB.
Speed: Get the speed field of the given PUSB.

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

-PUSB

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

-Ref

The PUSB object to operate on, specified by its opaque reference.
Attribute Value
Type XenRef[PUSB]
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 XenPUSBProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, USBGroup, Host, Path, VendorId, VendorDesc, ProductId, ProductDesc, Serial, Version, Description, PassthroughEnabled, OtherConfig, Speed

Inputs

  • PUSB
  • XenRef[PUSB]

Outputs

  • System.Object

Examples

Example 1: Get the USBGroup property

PS> Get-XenPUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPUSBProperty -XenProperty USBGroup
Gets the USBGroup property of a PUSB.

Example 2: Get the Host property

PS> Get-XenPUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPUSBProperty -XenProperty Host
Gets the Host property of a PUSB.

Example 3: Get the Path property

PS> Get-XenPUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenPUSBProperty -XenProperty Path
Gets the Path property of a PUSB.
  • PUSB cmdlets
  • Class: PUSB
  • Using the XenServer PowerShell module