Invoke-XenVUSB

Last published : Nov 12, 2026
Invokes an operation on a VUSB object.
Related information
VUSB cmdlets

Syntax

Invoke-XenVUSB [-VUSB] <VUSB> -XenAction {Unplug} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenVUSB [-Ref] <XenRef[VUSB]> -XenAction {Unplug} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
Invoke-XenVUSB [-Uuid] <guid> -XenAction {Unplug} [-PassThru] [-BestEffort]
    [-SessionOpaqueRef <string>] [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]

Description

Invokes an operation on a VUSB object. Use the -XenAction parameter to select which operation to perform.
Unplug: Unplug the vusb device from the vm.

Parameters

-Async

If set, the operation runs asynchronously and returns a Task object that can be used to track its progress.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False

-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

-Confirm

Prompts for confirmation before running the cmdlet.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases cf

-PassThru

If set, the cmdlet returns the affected object. By default the cmdlet does not generate any output.
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

-Uuid

The UUID of the VUSB to operate on.
Attribute Value
Type guid
Required True
Position 0
Accepts pipeline input True (ByPropertyName)

-VUSB

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

-WhatIf

Shows what would happen if the cmdlet runs. The cmdlet is not run.
Attribute Value
Type SwitchParameter
Required False
Position Named
Accepts pipeline input False
Aliases wi

-XenAction

Selects which action to use.
Attribute Value
Type XenVUSBAction
Required True
Position Named
Accepts pipeline input False
Accepted values Unplug

Inputs

  • VUSB
  • XenRef[VUSB]
  • guid

Outputs

  • System.Object

Examples

Example 1: Run the Unplug operation

PS> Get-XenVUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff | Invoke-XenVUSB -XenAction Unplug
Invokes the Unplug operation on a VUSB.

Example 2: Run the Unplug operation by uuid

PS> Invoke-XenVUSB -XenAction Unplug -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff
Invokes the Unplug operation on a VUSB. -Uuid is the way to be sure of exactly one object.

Example 3: Run Unplug asynchronously

PS> Invoke-XenVUSB -Uuid 1871ac51-ce6b-efc3-7fd0-28bc65aa39ff -XenAction Unplug -Async -PassThru | Wait-XenTask -ShowProgress
Runs the same operation asynchronously and follows the task it returns.
  • VUSB cmdlets
  • Class: VUSB
  • Using the XenServer PowerShell module