PowerCLI Reference

Get-UsbDevice

Synopsis

This cmdlet retrieves the USB devices available on a vCenter Server system.

Syntax

Get-UsbDevice [-Id <String[]>] [-Server <VIServer[]>] [[-VM] <VirtualMachine[]>] [[-Template] <Template[]>] [[-Snapshot] <Snapshot[]>] [-Name <String[]>] [<CommonParameters>]

Related Commands

Online version
Remove-UsbDevice

Detailed Description

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.

Parameters

NameTypeDescriptionRequired?Pipeline InputDefault Value
VMVirtualMachine[]Specifies the virtual machines whose virtual USB drives you want to retrieve.falsetrue (ByValue)
TemplateTemplate[]Specifies the virtual machine templates whose virtual USB drives you want to retrieve.falsetrue (ByValue)
SnapshotSnapshot[]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.falsetrue (ByValue)
IdString[]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.
falsefalse
NameString[]Specifies the names of the USB devices you want to retrieve.falsefalse
ServerVIServer[]Specifies the vCenter Server systems on which you want to run the cmdlet. If no 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.falsefalse

Return Type

Zero or more UsbDevice objects

Notes

The -Snapshot parameter is supported only on vCenter Server 4.1 and ESX 4.1 and later.

Examples

-------------- Example 1 --------------

Get-UsbDevice -VM (Get-VM -Location Host)

Retrieves the USB devices attached to the virtual machines on the Host host.


Copyright © VMware, Inc. All rights reserved.