Get-XenVUSBProperty

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

Syntax

Get-XenVUSBProperty [-VUSB] <VUSB>
    -XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | USBGroup | OtherConfig | CurrentlyAttached}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]
Get-XenVUSBProperty [-Ref] <XenRef[VUSB]>
    -XenProperty {Uuid | AllowedOperations | CurrentOperations | VM | USBGroup | OtherConfig | CurrentlyAttached}
    [-BestEffort] [-SessionOpaqueRef <string>] [<CommonParameters>]

Description

Gets a specified property of a VUSB object. Use the -XenProperty parameter to select which property to retrieve.
Uuid: Get the uuid field of the given VUSB.
AllowedOperations: Get the allowed\_operations field of the given VUSB.
CurrentOperations: Get the current\_operations field of the given VUSB.
VM: Get the VM field of the given VUSB.
USBGroup: Get the USB\_group field of the given VUSB.
OtherConfig: Get the other\_config field of the given VUSB.
CurrentlyAttached: Get the currently\_attached field of the given VUSB.

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

-VUSB

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

-XenProperty

Selects which property to use.
Attribute Value
Type XenVUSBProperty
Required True
Position Named
Accepts pipeline input False
Accepted values Uuid, AllowedOperations, CurrentOperations, VM, USBGroup, OtherConfig, CurrentlyAttached

Inputs

  • VUSB
  • XenRef[VUSB]

Outputs

  • System.Object

Examples

Example 1: Get the AllowedOperations property

PS> Get-XenVUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVUSBProperty -XenProperty AllowedOperations
Gets the AllowedOperations property of a VUSB.

Example 2: Get the CurrentOperations property

PS> Get-XenVUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVUSBProperty -XenProperty CurrentOperations
Gets the CurrentOperations property of a VUSB.

Example 3: Get the VM property

PS> Get-XenVUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Get-XenVUSBProperty -XenProperty VM
Gets the VM property of a VUSB.
  • VUSB cmdlets
  • Class: VUSB
  • Using the XenServer PowerShell module