Get-UsbDevice
This cmdlet retrieves the USB devices available on a vCenter Server system. The cmdlet returns a set of virtual USB devices assigned to the virtual machines, templates, and snapshots specified by the VirtualMachine, Template, and Snapshot parameters. At least one of these parameters must be provided. To specify a server different from the default one, use the Server parameter.
Syntax
[
[-Template
]
< Template[] > ]
[
[-Snapshot
]
< Snapshot[] > ]
[-Id
< String[] > ]
[-Name
< String[] > ]
[-ProgressAction
< ActionPreference > ]
[-Server
< VIServer[] > ]
[-VM
< VirtualMachine[] > ]
[CommonParameters]
Parameters
| Required | Parameter Name | Type | Position | Features | Description |
|---|---|---|---|---|---|
| optional | Template | Template[] | 1 |
|
Specifies the virtual machine templates whose virtual USB drives you want to retrieve. |
| optional | Snapshot | Snapshot[] | 2 |
|
Specifies the virtual machine snapshots whose virtual USB you want to retrieve. Supported only on vCenter Server 4.1 and ESX 4.1 and later. |
| optional | Id | String[] | named |
|
Specifies the IDs of the USB devices you want to retrieve. Note: When a list of values is specified for the Id parameter, the returned objects would have an ID that matches exactly one of the string values in that list. |
| optional | Name | String[] | named |
|
Specifies the names of the USB devices you want to retrieve. |
| optional | ProgressAction | ActionPreference | named |
|
|
| optional | Server | VIServer[] | named |
|
Specifies the vCenter Server systems on which you want to run the cmdlet. If no value is provided or $null value is passed to this parameter, the command runs on the default servers. For more information about default servers, see the description of Connect-VIServer. |
| optional | VM | VirtualMachine[] | named |
|
Specifies the virtual machines whose virtual USB drives you want to retrieve. |
Output
VMware.VimAutomation.ViCore.Types.V1.VirtualDevice.UsbDeviceExamples
Example 1
Get-UsbDevice -VM (Get-VM -Location Host)
Retrieves the USB devices attached to the virtual machines on the Host host.
Related Commands
UsbDevice
This cmdlet retrieves the USB devices available on a vCenter Server system.
This cmdlet removes the specified USB devices from a virtual machine.