< Back

Get-UsbDevice

Sun Jan 19, 2020 6:53 pm

NAME Get-UsbDevice



SYNOPSIS

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





SYNTAX

Get-UsbDevice [[-VM] <VirtualMachine[]>] [[-Template] <Template[]>] [[-Snapshot] <Snapshot[]>] [-Id <String[]>]

[-Name <String[]>] [-Server <VIServer[]>] [<CommonParameters>]





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

-Id <String[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Name <String[]>

Specifies the names of the USB devices you want to retrieve.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Server <VIServer[]>

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.



Required? false

Position? named

Default value None

Accept pipeline input? False

Accept wildcard characters? true



-Snapshot <Snapshot[]>

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.



Required? false

Position? 3

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-Template <Template[]>

Specifies the virtual machine templates whose virtual USB drives you want to retrieve.



Required? false

Position? 2

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



-VM <VirtualMachine[]>

Specifies the virtual machines whose virtual USB drives you want to retrieve.



Required? false

Position? 1

Default value None

Accept pipeline input? True (ByValue)

Accept wildcard characters? false



<CommonParameters>

This cmdlet supports the common parameters: Verbose, Debug,

ErrorAction, ErrorVariable, WarningAction, WarningVariable,

OutBuffer, PipelineVariable, and OutVariable. For more information, see

about_CommonParameters (https:/go.microsoft.com/fwlink/?LinkID=113216).



INPUTS



OUTPUTS

Zero or more UsbDevice objects







NOTES





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



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



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



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



RELATED LINKS

Online Version: https://code.vmware.com/doc/preview?id= ... evice.html

Remove-UsbDevice