CIM_USBDevice class (Hyper-V management)

The management characteristics of a USB device.

Syntax

[Abstract, Version("2.22.0"), UMLPackagePath("CIM::Device::USB")]
class CIM_USBDevice : CIM_LogicalDevice
{
  uint16   USBVersion;
  uint8    ClassCode;
  uint8    SubclassCode;
  uint8    ProtocolCode;
  uint16   USBVersionInBCD;
  uint8    MaxPacketSize;
  uint16   VendorID;
  uint16   ProductID;
  uint16   DeviceReleaseNumber;
  string   Manufacturer;
  string   Product;
  string   SerialNumber;
  uint8    NumberOfConfigs;
  uint8    CurrentConfigValue;
  uint8    CurrentAlternateSettings[];
  datetime CommandTimeout;
};

Members

The CIM_USBDevice class has these types of members:

• Methods
• Properties

Methods

The CIM_USBDevice class has these methods.

Method	Description
GetDescriptor	Retrieves a USB device descriptor.

Properties

The CIM_USBDevice class has these properties.

ClassCode

Data type: uint8

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceClass")

The USB class code.

CommandTimeout

Data type: datetime

Access type: Read-only

A timeout interval that is configurable by management applications that support USB redirection. When the redirection service redirects a USB device command to a remote device, and the remote device does not respond before timeout interval, the redirection service will emulate a media eject event. In addition, the service may re-try the command or try to re-establish the connection to the remote device.

CurrentAlternateSettings

Data type: uint8 array

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_USBDevice.CurrentConfigValue")

An array that contains the alternate settings for each interface in the current configuration of the device.

CurrentConfigValue

Data type: uint8

Access type: Read-only

Qualifiers: ModelCorrespondence ("CIM_USBDevice.CurrentAlternateSettings")

The configuration currently selected for the device. If this value is zero, the Device is not configured.

DeviceReleaseNumber

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdDevice")

The device release number in BCD format.

Manufacturer

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iManufacturer")

The manufacturer string of the device.

MaxPacketSize

Data type: uint8

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bMaxPacketSize")

The maximum packet size for the USB zero endpoint.

NumberOfConfigs

Data type: uint8

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bNumConfigurations")

The number of device configurations that are defined for the Device.

Product

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iProduct")

The product string of the device.

ProductID

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|idProduct")

The product ID assigned to the device by manufacturer.

ProtocolCode

Data type: uint8

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceProtocol")

The USB protocol code.

SerialNumber

Data type: string

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iSerialNumber")

The serial number of the device.

SubclassCode

Data type: uint8

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceSubClass")

The USB subclass code.

USBVersion

Data type: uint16

Access type: Read-only

The latest USB Version supported by the USB Device. The property is expressed as a binary-coded decimal (BCD) that contains a decimal point between the 2nd and 3rd digits. For example, a value of 0x201 indicates that version 2.01 is supported.

USBVersionInBCD

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdUSB")

The USB specification number that the device complies with. This property is formatted with BCD format.

VendorID

Data type: uint16

Access type: Read-only

Qualifiers: MappingStrings ("Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|idVendor")

The vendor ID assigned to the device by USB.org.

Requirements

Requirement	Value
Minimum supported client	Windows 8.1
Minimum supported server	Windows Server 2012 R2
Namespace	Root\virtualization\v2
MOF	WindowsVirtualization.V2.mof
DLL	Vmms.exe

See also

CIM_LogicalDevice