New-XenVUSB

Last published : Nov 12, 2026
Creates a new VUSB object.
Related information
VUSB cmdlets

Syntax

New-XenVUSB -HashTable <hashtable> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVUSB -Record <VUSB> [-PassThru] [-BestEffort] [-SessionOpaqueRef <string>]
    [-WhatIf] [-Confirm] [-Async] [<CommonParameters>]
New-XenVUSB [-PassThru] [-VM <XenRef[VM]>] [-USBGroup <XenRef[USB_group]>]
    [-OtherConfig <hashtable>] [-BestEffort] [-SessionOpaqueRef <string>] [-WhatIf]
    [-Confirm] [-Async] [<CommonParameters>]

Description

Creates a new VUSB object.
VUSB.create: Create a new VUSB record in the database only.
VUSB: Describes the vusb device.

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

-HashTable

A hashtable of field names to values, from which to create the VUSB.
Attribute Value
Type hashtable
Required True
Position Named
Accepts pipeline input False

-OtherConfig

This parameter has no documentation.
Attribute Value
Type hashtable
Required False
Position Named
Accepts pipeline input False

-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

-Record

An existing VUSB record whose fields are used to create the new object.
Attribute Value
Type VUSB
Required True
Position Named
Accepts pipeline input False

-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

This parameter has no documentation.
Attribute Value
Type XenRef[USB_group]
Required False
Position Named
Accepts pipeline input False

-VM

The VM
Attribute Value
Type XenRef[VM]
Required False
Position Named
Accepts pipeline input False

-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

Inputs

  • None

Outputs

  • VUSB
  • Task
  • void

Examples

Example 1: Create a VUSB

PS> $vm = Get-XenVM | Select-Object -First 1
PS> $usb_group = Get-XenUSBGroup | Select-Object -First 1
PS> New-XenVUSB -VM $vm -USBGroup $usb_group -OtherConfig @{ "key" = "value" } -PassThru
New-XenVUSB takes the arguments of the create call rather than a record of fields, and needs all of them. -PassThru returns the new VUSB.

Example 2: Create a VUSB and wait for the task

PS> $vm = Get-XenVM | Select-Object -First 1
PS> $usb_group = Get-XenUSBGroup | Select-Object -First 1
PS> New-XenVUSB -VM $vm -USBGroup $usb_group -OtherConfig @{ "key" = "value" } -Async -PassThru |
    Wait-XenTask -ShowProgress
-Async hands the work to the server and returns the Task that represents it, which pipes into Wait-XenTask.

Example 3: See what would be created

PS> $vm = Get-XenVM | Select-Object -First 1
PS> $usb_group = Get-XenUSBGroup | Select-Object -First 1
PS> New-XenVUSB -VM $vm -USBGroup $usb_group -OtherConfig @{ "key" = "value" } -WhatIf
Reports what would be created without creating it. Every cmdlet that changes the server takes -WhatIf and -Confirm.
  • VUSB cmdlets
  • Class: VUSB
  • Using the XenServer PowerShell module