CIM_USBDevice, ROOT\virtualization\v2

Class | Methods (9) | Properties (54) | Qualifiers (4) | Instances | Namespaces (3)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

The management characterisitics of a USB Device.

CIM_USBDevice methods

CIM_USBDevice has 9 methods (1 Local, 8 Derived)

NameOriginReturn
EnableDeviceCIM_LogicalDeviceuint32 {'out':True}
GetDescriptorCIM_USBDeviceuint32 {'out':True}
OnlineDeviceCIM_LogicalDeviceuint32 {'out':True}
QuiesceDeviceCIM_LogicalDeviceuint32 {'out':True}
RequestStateChangeCIM_EnabledLogicalElementuint32 {'out':True}
ResetCIM_LogicalDeviceuint32 {'out':True}
RestorePropertiesCIM_LogicalDeviceuint32 {'out':True}
SavePropertiesCIM_LogicalDeviceuint32 {'out':True}
SetPowerStateCIM_LogicalDeviceuint32 {'out':True}

CIM_USBDevice properties

CIM_USBDevice has 54 properties (16 Local, 38 Derived)

NameOriginCIMType
AdditionalAvailabilityCIM_LogicalDevice18 [uint16]
AvailabilityCIM_LogicalDevice18 [uint16]
AvailableRequestedStatesCIM_EnabledLogicalElement18 [uint16]
CaptionCIM_ManagedElement8 [string]
ClassCodeCIM_USBDevice17 [uint8]
CommandTimeoutCIM_USBDevice101 [datetime]
CommunicationStatusCIM_ManagedSystemElement18 [uint16]
key
CreationClassName
CIM_LogicalDevice8 [string]
CurrentAlternateSettingsCIM_USBDevice17 [uint8]
CurrentConfigValueCIM_USBDevice17 [uint8]
DescriptionCIM_ManagedElement8 [string]
DetailedStatusCIM_ManagedSystemElement18 [uint16]
key
DeviceID
CIM_LogicalDevice8 [string]
DeviceReleaseNumberCIM_USBDevice18 [uint16]
ElementNameCIM_ManagedElement8 [string]
EnabledDefaultCIM_EnabledLogicalElement18 [uint16]
EnabledStateCIM_EnabledLogicalElement18 [uint16]
ErrorClearedCIM_LogicalDevice11 [boolean]
ErrorDescriptionCIM_LogicalDevice8 [string]
HealthStateCIM_ManagedSystemElement18 [uint16]
IdentifyingDescriptionsCIM_LogicalDevice8 [string]
InstallDateCIM_ManagedSystemElement101 [datetime]
InstanceIDCIM_ManagedElement8 [string]
LastErrorCodeCIM_LogicalDevice19 [uint32]
ManufacturerCIM_USBDevice8 [string]
MaxPacketSizeCIM_USBDevice17 [uint8]
MaxQuiesceTimeCIM_LogicalDevice21 [uint64]
NameCIM_ManagedSystemElement8 [string]
NumberOfConfigsCIM_USBDevice17 [uint8]
OperatingStatusCIM_ManagedSystemElement18 [uint16]
OperationalStatusCIM_ManagedSystemElement18 [uint16]
OtherEnabledStateCIM_EnabledLogicalElement8 [string]
OtherIdentifyingInfoCIM_LogicalDevice8 [string]
PowerManagementCapabilitiesCIM_LogicalDevice18 [uint16]
PowerManagementSupportedCIM_LogicalDevice11 [boolean]
PowerOnHoursCIM_LogicalDevice21 [uint64]
PrimaryStatusCIM_ManagedSystemElement18 [uint16]
ProductCIM_USBDevice8 [string]
ProductIDCIM_USBDevice18 [uint16]
ProtocolCodeCIM_USBDevice17 [uint8]
RequestedStateCIM_EnabledLogicalElement18 [uint16]
SerialNumberCIM_USBDevice8 [string]
StatusCIM_ManagedSystemElement8 [string]
StatusDescriptionsCIM_ManagedSystemElement8 [string]
StatusInfoCIM_LogicalDevice18 [uint16]
SubclassCodeCIM_USBDevice17 [uint8]
key
SystemCreationClassName
CIM_LogicalDevice8 [string]
key
SystemName
CIM_LogicalDevice8 [string]
TimeOfLastStateChangeCIM_EnabledLogicalElement101 [datetime]
TotalPowerOnHoursCIM_LogicalDevice21 [uint64]
TransitioningToStateCIM_EnabledLogicalElement18 [uint16]
USBVersionCIM_USBDevice18 [uint16]
USBVersionInBCDCIM_USBDevice18 [uint16]
VendorIDCIM_USBDevice18 [uint16]

Detailed description of CIM_USBDevice methods

Local methods (1) of CIM_USBDevice class

GetDescriptor method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestTypeuint80-{'Description':'RequestType 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.'}
RequestValueuint161-{'Description':'RequestValue 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.'}
RequestIndexuint162-{'Description':'RequestIndex 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.'}
RequestLengthuint163-{'Description':'On 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.'}
Bufferuint84-{'Description':'Buffer returns the requested Descriptor information. If the Descriptor does not exist, the contents of the Buffer are undefined.'}
Description'This 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.'
GetDescriptor method is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces

Derived methods (8) of CIM_USBDevice class

EnableDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Enabledboolean0-{'Description':'If TRUE enable the device, if FALSE disable the device.'}
EnableDevice method is in 63 classes of ROOT\virtualization\v2 and in 10 namespaces
OnlineDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Onlineboolean0-{'Description':'If TRUE, take the device online, if FALSE, take the device OFFLINE.'}
OnlineDevice method is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
QuiesceDevice method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
Quiesceboolean0-{'Description':'If set to TRUE then cleanly cease all activity, if FALSE resume activity.'}
QuiesceDevice method is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
RequestStateChange method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestedStateuint160-{'Description':'The state requested for the element. This information will be placed into the RequestedState property of the instance if the return code of the RequestStateChange method is 0 ('Completed with No Error'), or 4096 (0x1000) ('Job Started'). Refer to the description of the EnabledState and RequestedState properties for the detailed explanations of the RequestedState values.','ModelCorrespondence':['CIM_EnabledLogicalElement.RequestedState'],'ValueMap':['2', '3', '4', '6', '7', '8', '9', '10', '11', '..', '32768..65535'],'Values':['Enabled', 'Disabled', 'Shut Down', 'Offline', 'Test', 'Defer', 'Quiesce', 'Reboot', 'Reset', 'DMTF Reserved', 'Vendor Reserved']}
Jobref:CIM_ConcreteJob1-{'Description':'May contain a reference to the ConcreteJob created to track the state transition initiated by the method invocation.'}
TimeoutPerioddatetime2-{'Description':'A timeout period that specifies the maximum amount of time that the client expects the transition to the new state to take. The interval format must be used to specify the TimeoutPeriod. A value of 0 or a null parameter indicates that the client has no time requirements for the transition. If this property does not contain 0 or null and the implementation does not support this parameter, a return code of 'Use Of Timeout Parameter Not Supported' shall be returned.'}
RequestStateChange method is in 111 classes of ROOT\virtualization\v2 and in 15 namespaces
Reset method
Returnuint32 {'out':True}
Reset method is in 63 classes of ROOT\virtualization\v2 and in 19 namespaces
RestoreProperties method
Returnuint32 {'out':True}
RestoreProperties method is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
SaveProperties method
Returnuint32 {'out':True}
SaveProperties method is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint160-{'Description':'The power state to set.','ValueMap':['1', '2', '3', '4', '5', '6'],'Values':['Full Power', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Save - Other', 'Power Cycle', 'Power Off']}
Timedatetime1-{'Description':'Time indicates when the power state should be set, either as a regular date-time value or as an interval value (where the interval begins when the method invocation is received.'}
SetPowerState method is in 68 classes of ROOT\virtualization\v2 and in 14 namespaces

Detailed description of CIM_USBDevice properties

Local properties (16) of CIM_USBDevice class

ClassCode property
CIMTYPE'uint8'
Description'Indicates the USB class code.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceClass']
ClassCode property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
CommandTimeout property
CIMTYPE'datetime'
Description'CommandTimeout 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.'
CommandTimeout property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 1 namespace
CurrentAlternateSettings property
CIMTYPE'uint8'
Description'An 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.'
ModelCorrespondence['CIM_USBDevice.CurrentConfigValue']
CurrentAlternateSettings property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
CurrentConfigValue property
CIMTYPE'uint8'
Description'Indicates the configuration currently selected for the Device. If this value is zero, the Device is unconfigured.'
ModelCorrespondence['CIM_USBDevice.CurrentAlternateSettings']
CurrentConfigValue property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
DeviceReleaseNumber property
CIMTYPE'uint16'
Description'From the USB specification Device Descriptor, Device Release Number in Binary-Coded Decimal.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdDevice']
DeviceReleaseNumber property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 1 namespace
Manufacturer property
CIMTYPE'string'
Description'From the USB specification Device Descriptior, Manufacturer string.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iManufacturer']
Manufacturer property is in 4 classes of ROOT\virtualization\v2 and in 17 namespaces
MaxPacketSize property
CIMTYPE'uint8'
Description'From the USB specification Device Descriptor, Maximum Packet size for the USB zero endpoint. Valid sizes are 8, 16, 32, 64.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bMaxPacketSize']
MaxPacketSize property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 1 namespace
NumberOfConfigs property
CIMTYPE'uint8'
Description'Number of device configurations that are defined for the Device.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bNumConfigurations']
NumberOfConfigs property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
Product property
CIMTYPE'string'
Description'From the USB specification Device Descriptor, Product String.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iProduct']
Product property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
ProductID property
CIMTYPE'uint16'
Description'From the USB specification Device Descriptor, Product ID assigned by manufacturer.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|idProduct']
ProductID property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 14 namespaces
ProtocolCode property
CIMTYPE'uint8'
Description'Indicates the USB protocol code.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceProtocol']
ProtocolCode property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
SerialNumber property
CIMTYPE'string'
Description'From the USB specification Device Descriptor, Serial Number String.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|iSerialNumber']
SerialNumber property is in 4 classes of ROOT\virtualization\v2 and in 24 namespaces
SubclassCode property
CIMTYPE'uint8'
Description'Indicates the USB subclass code.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bDeviceSubClass']
SubclassCode property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
USBVersion property
CIMTYPE'uint16'
Description'Indicates 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.'
USBVersion property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 3 namespaces
USBVersionInBCD property
CIMTYPE'uint16'
Description'From the USB specification Device Descriptor, where 'bcdUSB' is the USB Specification Number, in Binary-Coded Decimal format, that the device complies with.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|bcdUSB']
USBVersionInBCD property is in 1 class (CIM_USBDevice) of ROOT\virtualization\v2 and in 1 namespace
VendorID property
CIMTYPE'uint16'
Description'From the USB specification Device Descriptor, Vendor ID assigned by USB.org.'
MappingStrings['Universal Serial Bus Specification.USB-IF|Standard Device Descriptor|idVendor']
VendorID property is in 2 classes of ROOT\virtualization\v2 and in 9 namespaces

Derived properties (38) of CIM_USBDevice class

AdditionalAvailability property
CIMTYPE'uint16'
AdditionalAvailability property is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
Availability property
CIMTYPE'uint16'
Availability property is in 63 classes of ROOT\virtualization\v2 and in 12 namespaces
AvailableRequestedStates property
CIMTYPE'uint16'
AvailableRequestedStates property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces
Caption property
CIMTYPE'string'
Caption property is in 222 classes of ROOT\virtualization\v2 and in 37 namespaces
CommunicationStatus property
CIMTYPE'uint16'
CommunicationStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
CreationClassName property
CIMTYPE'string'
keyTrue
CreationClassName property is in 113 classes of ROOT\virtualization\v2 and in 20 namespaces
Description property
CIMTYPE'string'
Description property is in 225 classes of ROOT\virtualization\v2 and in 142 namespaces
DetailedStatus property
CIMTYPE'uint16'
DetailedStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
DeviceID property
CIMTYPE'string'
keyTrue
DeviceID property is in 66 classes of ROOT\virtualization\v2 and in 21 namespaces
ElementName property
CIMTYPE'string'
ElementName property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
EnabledDefault property
CIMTYPE'uint16'
EnabledDefault property is in 106 classes of ROOT\virtualization\v2 and in 10 namespaces
EnabledState property
CIMTYPE'uint16'
EnabledState property is in 116 classes of ROOT\virtualization\v2 and in 13 namespaces
ErrorCleared property
CIMTYPE'boolean'
ErrorCleared property is in 63 classes of ROOT\virtualization\v2 and in 12 namespaces
ErrorDescription property
CIMTYPE'string'
ErrorDescription property is in 71 classes of ROOT\virtualization\v2 and in 142 namespaces
HealthState property
CIMTYPE'uint16'
HealthState property is in 128 classes of ROOT\virtualization\v2 and in 15 namespaces
IdentifyingDescriptions property
CIMTYPE'string'
IdentifyingDescriptions property is in 69 classes of ROOT\virtualization\v2 and in 15 namespaces
InstallDate property
CIMTYPE'datetime'
InstallDate property is in 127 classes of ROOT\virtualization\v2 and in 23 namespaces
InstanceID property
CIMTYPE'string'
InstanceID property is in 223 classes of ROOT\virtualization\v2 and in 21 namespaces
LastErrorCode property
CIMTYPE'uint32'
LastErrorCode property is in 63 classes of ROOT\virtualization\v2 and in 16 namespaces
MaxQuiesceTime property
CIMTYPE'uint64'
MaxQuiesceTime property is in 63 classes of ROOT\virtualization\v2 and in 8 namespaces
Name property
CIMTYPE'string'
Name property is in 152 classes of ROOT\virtualization\v2 and in 142 namespaces
OperatingStatus property
CIMTYPE'uint16'
OperatingStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
OperationalStatus property
CIMTYPE'uint16'
OperationalStatus property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
OtherEnabledState property
CIMTYPE'string'
OtherEnabledState property is in 107 classes of ROOT\virtualization\v2 and in 11 namespaces
OtherIdentifyingInfo property
CIMTYPE'string'
OtherIdentifyingInfo property is in 69 classes of ROOT\virtualization\v2 and in 20 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
PowerManagementCapabilities property is in 68 classes of ROOT\virtualization\v2 and in 14 namespaces
PowerManagementSupported property
CIMTYPE'boolean'
PowerManagementSupported property is in 63 classes of ROOT\virtualization\v2 and in 14 namespaces
PowerOnHours property
CIMTYPE'uint64'
PowerOnHours property is in 63 classes of ROOT\virtualization\v2 and in 13 namespaces
PrimaryStatus property
CIMTYPE'uint16'
PrimaryStatus property is in 127 classes of ROOT\virtualization\v2 and in 9 namespaces
RequestedState property
CIMTYPE'uint16'
RequestedState property is in 106 classes of ROOT\virtualization\v2 and in 12 namespaces
Status property
CIMTYPE'string'
Status property is in 127 classes of ROOT\virtualization\v2 and in 42 namespaces
StatusDescriptions property
CIMTYPE'string'
StatusDescriptions property is in 128 classes of ROOT\virtualization\v2 and in 18 namespaces
StatusInfo property
CIMTYPE'uint16'
StatusInfo property is in 63 classes of ROOT\virtualization\v2 and in 12 namespaces
SystemCreationClassName property
CIMTYPE'string'
keyTrue
SystemCreationClassName property is in 109 classes of ROOT\virtualization\v2 and in 20 namespaces
SystemName property
CIMTYPE'string'
keyTrue
SystemName property is in 109 classes of ROOT\virtualization\v2 and in 22 namespaces
TimeOfLastStateChange property
CIMTYPE'datetime'
TimeOfLastStateChange property is in 111 classes of ROOT\virtualization\v2 and in 17 namespaces
TotalPowerOnHours property
CIMTYPE'uint64'
TotalPowerOnHours property is in 63 classes of ROOT\virtualization\v2 and in 10 namespaces
TransitioningToState property
CIMTYPE'uint16'
TransitioningToState property is in 106 classes of ROOT\virtualization\v2 and in 7 namespaces

CIM_USBDevice Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
AbstractTrue
Description'The management characterisitics of a USB Device.'
UMLPackagePath'CIM::Device::USB'
Version'2.22.0'

CIM_USBDevice System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\virtualization\v2:CIM_USBDevice'___SYSTEM8
__NAMESPACE'ROOT\virtualization\v2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_LogicalDevice', 'CIM_EnabledLogicalElement', 'CIM_LogicalElement', 'CIM_ManagedSystemElement', 'CIM_ManagedElement']___SYSTEM8
__PROPERTY_COUNT54___SYSTEM3
__RELPATH'CIM_USBDevice'___SYSTEM8
__DYNASTY'CIM_ManagedElement'___SYSTEM8
__SUPERCLASS'CIM_LogicalDevice'___SYSTEM8
__CLASS'CIM_USBDevice'___SYSTEM8
__GENUS1___SYSTEM3
comments powered by Disqus
WUtils.com