Class CIM_USBDevice
extends CIM_LogicalDevice

The management characterisitics of a USB Device.

Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods


Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_AllocatedLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_USBDevice

Direct Known Subclasses

CIM_USBHub

Class Qualifiers

NameData TypeValue
DescriptionstringThe management characterisitics of a USB Device.
UMLPackagePathstringCIM::Device::USB
Versionstring2.22.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
ClassCodeuint8
DescriptionstringIndicates the USB class code.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceClass
CommandTimeoutdatetime
DescriptionstringCommandTimeout is configurable by management applications supporting USB Redirections. When the Redirection Service redirects a USBDevice command to a remote device, and the remote device does not respond before CommandTimout times out, the Redirection Service will emulate a media eject event and re-try the command and/or try to re-establish the connection to the remote device. The timeout is expressed using the interval format of the datetime type.
CurrentConfigValueuint8
DescriptionstringIndicates the configuration currently selected for the Device. If this value is zero, the Device is unconfigured.
ModelCorrespondencestringCIM_USBDevice.CurrentAlternateSettings
DeviceReleaseNumberuint16
DescriptionstringFrom the USB specification Device Descriptor, Device Release Number in Binary-Coded Decimal.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdDevice
Manufacturerstring
DescriptionstringFrom the USB specification Device Descriptior, Manufacturer string.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|iManufacturer
MaxPacketSizeuint8
DescriptionstringFrom the USB specification Device Descriptor, Maximum Packet size for the USB zero endpoint. Valid sizes are 8, 16, 32, 64.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bMaxPacketSize
NumberOfConfigsuint8
DescriptionstringNumber of device configurations that are defined for the Device.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bNumConfigurations
Productstring
DescriptionstringFrom the USB specification Device Descriptor, Product String.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|iProduct
ProductIDuint16
DescriptionstringFrom the USB specification Device Descriptor, Product ID assigned by manufacturer.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|idProduct
ProtocolCodeuint8
DescriptionstringIndicates the USB protocol code.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceProtocol
SerialNumberstring
DescriptionstringFrom the USB specification Device Descriptor, Serial Number String.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|iSerialNumber
SubclassCodeuint8
DescriptionstringIndicates the USB subclass code.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceSubClass
USBVersionuint16
DescriptionstringIndicates the latest USB Version supported by the USB Device. The property is expressed as a Binary-Coded Decimal (BCD) where a decimal point is implied between the 2nd and 3rd digits. For example, a value of 0x201 indicates that version 2.01 is supported.
USBVersionInBCDuint16
DescriptionstringFrom the USB specification Device Descriptor, where 'bcdUSB' is the USB Specification Number, in Binary-Coded Decimal format, that the device complies with.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdUSB
VendorIDuint16
DescriptionstringFrom the USB specification Device Descriptor, Vendor ID assigned by USB.org.
MappingStringsstringUniversal Serial Bus Specification.USB-IF|Standard Device Descriptor|idVendor
CurrentAlternateSettingsuint8[]
DescriptionstringAn array of USB 'alternate settings' for each interface in the currently selected configuration (indicated by the CurrentConfigValue property). This array has one entry for each interface in the configuration. If the property, CurrentConfigValue, is zero (indicating the Device is not configured), the array is undefined. To understand how to parse this octet string, refer to the USB Specification.
ModelCorrespondencestringCIM_USBDevice.CurrentConfigValue

Inherited Properties

NameData TypeClass Origin
AllocationStatestringCIM_LogicalDevice
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

GetDescriptor (uint32)

Method Qualifiers (GetDescriptor)

NameData TypeValue
DescriptionstringThis method returns the USBDevice Descriptor as specified by the input parameters. Each parameter is briefly described here with more detail in its Qualifier list. RequestType is an input parameter that defines whether the request is for standard, class or vendor-specific information, as well as specifying the recipient. RequestValue is also an input parameter and defines the USB Descriptor Type and Index. RequestIndex is an input parameter which describes the language used to return a string Descriptor. RequestLength is both an input and output parameter. It specifies the length of the Descriptor that should be returned (on input) and what is actually returned in the Buffer parameter (on output). Buffer is an output parameter, containing the Descriptor data. The GetDescriptor method returns an integer value of 0 if the USB Descriptor is successfully returned, 1 if the request is not supported and any other number to indicate an error. In a subclass, the set of possible return codes could be specified, using a ValueMap qualifier on the method. The strings to which the ValueMap contents are 'translated' may also be specified in the subclass as a Values array qualifier.

Method Parameters (GetDescriptor)

NameTypeQualifiers
NameData TypeValue
RequestIndexuint16
DescriptionstringRequestIndex defines the 2 byte Language ID code used by the USBDevice when returning string Descriptor data. The parameter is typically 0 for non-string Descriptors. Refer to the USB Specification for more information.
INbooleantrue
RequestLengthuint16
DescriptionstringOn input, RequestLength is the length (in octets) of the Descriptor that should be returned. If this value is less than the actual length of the Descriptor, only the requested length will be returned. If it is more than the actual length, the actual length is returned. On output, this parameter is the length, in octets, of the Buffer being returned. If the requested Descriptor does not exist, the contents of this parameter are undefined.
INbooleantrue
OUTbooleantrue
RequestTypeuint8
DescriptionstringRequestType is bit-mapped and identifies the type of Descriptor request and the recipient. The type of request may be 'standard', 'class' or 'vendor-specific'. The recipient may be 'device', 'interface', 'endpoint' or 'other'. Refer to the USB Specification for the appropriate values for each bit.
INbooleantrue
RequestValueuint16
DescriptionstringRequestValue contains the Descriptor Type in the high byte and the Descriptor Index (for example, index or offset into the Descriptor array) in the low byte. Refer to the USB Specification for more information.
INbooleantrue
Bufferuint8[]
DescriptionstringBuffer returns the requested Descriptor information. If the Descriptor does not exist, the contents of the Buffer are undefined.
INbooleanfalse
OUTbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice