Get-XenUSBGroupProperty

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

Syntax

Get-XenUSBGroupProperty [-USBGroup] <USB_group>
    -XenProperty {Uuid | NameLabel | NameDescription | PUSBs | VUSBs | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenUSBGroupProperty [-Ref] <XenRef[USB_group]>
    -XenProperty {Uuid | NameLabel | NameDescription | PUSBs | VUSBs | OtherConfig}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a USBGroup object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given USB\_group.
NameLabel: Get the name/label field of the given USB\_group.
NameDescription: Get the name/description field of the given USB\_group.
PUSBs: Get the PUSBs field of the given USB\_group.
VUSBs: Get the VUSBs field of the given USB\_group.
OtherConfig: Get the other\_config field of the given USB\_group.

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

-USBGroup

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenUSBGroupProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, NameLabel, NameDescription, PUSBs, VUSBs, OtherConfig

Inputs

  • USB_group
  • XenRef[USB_group]

Outputs

  • System.Object

Examples

Example 1: Get the PUSBs property

PS> Get-XenUSBGroup -Name "Demo USBGroup" | Get-XenUSBGroupProperty -XenProperty PUSBs
Gets the PUSBs property of a USBGroup.

Example 2: Get the VUSBs property

PS> Get-XenUSBGroup -Name "Demo USBGroup" | Get-XenUSBGroupProperty -XenProperty VUSBs
Gets the VUSBs property of a USBGroup.

Example 3: Get the OtherConfig property

PS> Get-XenUSBGroup -Name "Demo USBGroup" | Get-XenUSBGroupProperty -XenProperty OtherConfig
Gets the OtherConfig property of a USBGroup.