CIM_USBHub, ROOT\CIMV2

Class | Childs (1) | Methods (3) | Properties (28) | Qualifiers (2) | Instances (7) | Namespaces (2)
Samples: VB Script | C# | VB.Net | Search on:Microsoft

Description

USB Hub Device.

CIM_USBHub - child subclasses in ROOT\cimv2

Number of classes:1
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Win32_USBHub02837---

CIM_USBHub methods

CIM_USBHub has 3 methods (3 Derived)

NameOriginReturn
GetDescriptorCIM_USBDeviceuint32 {'out':True}
ResetCIM_LogicalDeviceuint32 {'out':True}
SetPowerStateCIM_LogicalDeviceuint32 {'out':True}

CIM_USBHub properties

CIM_USBHub has 28 properties (2 Local, 26 Derived)

NameOriginCIMType
AvailabilityCIM_LogicalDevice18 [uint16]
CaptionCIM_ManagedSystemElement8 [string]
ClassCodeCIM_USBDevice17 [uint8]
ConfigManagerErrorCodeCIM_LogicalDevice19 [uint32]
ConfigManagerUserConfigCIM_LogicalDevice11 [boolean]
CreationClassNameCIM_LogicalDevice8 [string]
CurrentAlternateSettingsCIM_USBDevice17 [uint8]
CurrentConfigValueCIM_USBDevice17 [uint8]
DescriptionCIM_ManagedSystemElement8 [string]
DeviceIDCIM_LogicalDevice8 [string]
ErrorClearedCIM_LogicalDevice11 [boolean]
ErrorDescriptionCIM_LogicalDevice8 [string]
GangSwitchedCIM_USBHub11 [boolean]
InstallDateCIM_ManagedSystemElement101 [datetime]
LastErrorCodeCIM_LogicalDevice19 [uint32]
NameCIM_ManagedSystemElement8 [string]
NumberOfConfigsCIM_USBDevice17 [uint8]
NumberOfPortsCIM_USBHub17 [uint8]
PNPDeviceIDCIM_LogicalDevice8 [string]
PowerManagementCapabilitiesCIM_LogicalDevice18 [uint16]
PowerManagementSupportedCIM_LogicalDevice11 [boolean]
ProtocolCodeCIM_USBDevice17 [uint8]
StatusCIM_ManagedSystemElement8 [string]
StatusInfoCIM_LogicalDevice18 [uint16]
SubclassCodeCIM_USBDevice17 [uint8]
SystemCreationClassNameCIM_LogicalDevice8 [string]
SystemNameCIM_LogicalDevice8 [string]
USBVersionCIM_USBDevice18 [uint16]

Detailed description of CIM_USBHub methods

Derived methods (3) of CIM_USBHub class

GetDescriptor method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
RequestTypeuint80-
RequestValueuint161-
RequestIndexuint162-
RequestLengthuint163-
Bufferuint84-
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 3 classes of ROOT\cimv2 and in 3 namespaces
Reset method
Returnuint32 {'out':True}
Description'Requests a reset of the logical device. The return value should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an error occurred.'
Reset method is in 105 classes of ROOT\cimv2 and in 19 namespaces
SetPowerState method
Returnuint32 {'out':True}
Parameters
NameCIMTypeIDINOUTQualifiers
PowerStateuint160-{'ValueMap':['1', '2', '3', '4', '5', '6']}
Timedatetime1-
Description'SetPowerState defines the desired power state for a logical device and when a device should be put into that state. The desired power state is specified by setting the PowerState parameter to one of the following integer values: 1="Full Power", 2="Power Save - Low Power Mode", 3="Power Save - Standby", 4="Power Save - Other", 5="Power Cycle" or 6="Power Off". The Time parameter (for all state changes, except 5, "Power Cycle") 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). When the PowerState parameter is equal to 5, "Power Cycle", the Time parameter indicates when the device should power on again. Power off is immediate. SetPowerState should return 0 if successful, 1 if the specified PowerState and Time request is not supported, and some other value if any other error occurred. 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.'
SetPowerState method is in 106 classes of ROOT\cimv2 and in 14 namespaces

Detailed description of CIM_USBHub properties

Local properties (2) of CIM_USBHub class

GangSwitched property
CIMTYPE'boolean'
Description'Indicates whether power to the Hub Ports is individually or gang-switched. If this value is FALSE, power is switched individually for each Port. If this value is TRUE, power is switched to all Ports on the Hub at once.'
GangSwitched property is in 2 classes of ROOT\cimv2 and in 2 namespaces
NumberOfPorts property
CIMTYPE'uint8'
Description'Number of downstream Ports on the Hub, including those embedded in the Hub's silicon. Individual USBPorts are associated with the Hub using the USBPortOnHub association.'
NumberOfPorts property is in 2 classes of ROOT\cimv2 and in 3 namespaces

Derived properties (26) of CIM_USBHub class

Availability property
CIMTYPE'uint16'
Description'The availability and status of the device. For example, the Availability property indicates that the device is running and has full power (value=3), or is in a warning (4), test (5), degraded (10) or power save state (values 13-15 and 17). Regarding the power saving states, these are defined as follows: Value 13 ("Power Save - Unknown") indicates that the device is known to be in a power save mode, but its exact status in this mode is unknown; 14 ("Power Save - Low Power Mode") indicates that the device is in a power save state but still functioning, and may exhibit degraded performance; 15 ("Power Save - Standby") describes that the device is not functioning but could be brought to full power 'quickly'; and value 17 ("Power Save - Warning") indicates that the device is in a warning state, though also in a power save mode.'
MappingStrings['MIF.DMTF|Operational State|003.5', 'MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus']
readTrue
ValueMap['1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21']
Values['Other', 'Unknown', 'Running/Full Power', 'Warning', 'In Test', 'Not Applicable', 'Power Off', 'Off Line', 'Off Duty', 'Degraded', 'Not Installed', 'Install Error', 'Power Save - Unknown', 'Power Save - Low Power Mode', 'Power Save - Standby', 'Power Cycle', 'Power Save - Warning', 'Paused', 'Not Ready', 'Not Configured', 'Quiesced']
Availability property is in 108 classes of ROOT\cimv2 and in 12 namespaces
Caption property
CIMTYPE'string'
Description'The Caption property is a short textual description (one-line string) of the object.'
MaxLen64
readTrue
Caption property is in 1050 classes of ROOT\cimv2 and in 37 namespaces
ClassCode property
CIMTYPE'uint8'
Description'Indicates the USB class code.'
ClassCode property is in 3 classes of ROOT\cimv2 and in 3 namespaces
ConfigManagerErrorCode property
CIMTYPE'uint32'
Description'Indicates the Win32 Configuration Manager error code. The following values may be returned:
0 This device is working properly.
1 This device is not configured correctly.
2 Windows cannot load the driver for this device.
3 The driver for this device might be corrupted, or your system may be running low on memory or other resources.
4 This device is not working properly. One of its drivers or your registry might be corrupted.
5 The driver for this device needs a resource that Windows cannot manage.
6 The boot configuration for this device conflicts with other devices.
7 Cannot filter.
8 The driver loader for the device is missing.
9 This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.
10 This device cannot start.
11 This device failed.
12 This device cannot find enough free resources that it can use.
13 Windows cannot verify this device's resources.
14 This device cannot work properly until you restart your computer.
15 This device is not working properly because there is probably a re-enumeration problem.
16 Windows cannot identify all the resources this device uses.
17 This device is asking for an unknown resource type.
18 Reinstall the drivers for this device.
19 Your registry might be corrupted.
20 Failure using the VxD loader.
21 System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.
22 This device is disabled.
23 System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation.
24 This device is not present, is not working properly, or does not have all its drivers installed.
25 Windows is still setting up this device.
26 Windows is still setting up this device.
27 This device does not have valid log configuration.
28 The drivers for this device are not installed.
29 This device is disabled because the firmware of the device did not give it the required resources.
30 This device is using an Interrupt Request (IRQ) resource that another device is using.
31 This device is not working properly because Windows cannot load the drivers required for this device.'
readTrue
ValueMap['0', '1', '2', '3', '4', '5', '6', '7', '8', '9', '10', '11', '12', '13', '14', '15', '16', '17', '18', '19', '20', '21', '22', '23', '24', '25', '26', '27', '28', '29', '30', '31']
Values['This device is working properly.', 'This device is not configured correctly.', 'Windows cannot load the driver for this device.', 'The driver for this device might be corrupted, or your system may be running low on memory or other resources.', 'This device is not working properly. One of its drivers or your registry might be corrupted.', 'The driver for this device needs a resource that Windows cannot manage.', 'The boot configuration for this device conflicts with other devices.', 'Cannot filter.', 'The driver loader for the device is missing.', 'This device is not working properly because the controlling firmware is reporting the resources for the device incorrectly.', 'This device cannot start.', 'This device failed.', 'This device cannot find enough free resources that it can use.', 'Windows cannot verify this device's resources.', 'This device cannot work properly until you restart your computer.', 'This device is not working properly because there is probably a re-enumeration problem.', 'Windows cannot identify all the resources this device uses.', 'This device is asking for an unknown resource type.', 'Reinstall the drivers for this device.', 'Failure using the VxD loader.', 'Your registry might be corrupted.', 'System failure: Try changing the driver for this device. If that does not work, see your hardware documentation. Windows is removing this device.', 'This device is disabled.', 'System failure: Try changing the driver for this device. If that doesn't work, see your hardware documentation.', 'This device is not present, is not working properly, or does not have all its drivers installed.', 'Windows is still setting up this device.', 'Windows is still setting up this device.', 'This device does not have valid log configuration.', 'The drivers for this device are not installed.', 'This device is disabled because the firmware of the device did not give it the required resources.', 'This device is using an Interrupt Request (IRQ) resource that another device is using.', 'This device is not working properly because Windows cannot load the drivers required for this device.']
ConfigManagerErrorCode property is in 104 classes of ROOT\cimv2 and in 2 namespaces
ConfigManagerUserConfig property
CIMTYPE'boolean'
Description'Indicates whether the device is using a user-defined configuration.'
readTrue
ConfigManagerUserConfig property is in 104 classes of ROOT\cimv2 and in 2 namespaces
CreationClassName property
CIM_KeyTrue
CIMTYPE'string'
Description'CreationClassName indicates the name of the class or the subclass used in the creation of an instance. When used with the other key properties of this class, this property allows all instances of this class and its subclasses to be uniquely identified.'
readTrue
CreationClassName property is in 178 classes of ROOT\cimv2 and in 20 namespaces
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 3 classes of ROOT\cimv2 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 3 classes of ROOT\cimv2 and in 3 namespaces
Description property
CIMTYPE'string'
Description'The Description property provides a textual description of the object. '
readTrue
Description property is in 1061 classes of ROOT\cimv2 and in 142 namespaces
DeviceID property
CIM_KeyTrue
CIMTYPE'string'
Description'DeviceID is an address or other identifying information to uniquely name the logical device.'
readTrue
DeviceID property is in 108 classes of ROOT\cimv2 and in 21 namespaces
ErrorCleared property
CIMTYPE'boolean'
Description'ErrorCleared is a boolean property indicating that the error reported in LastErrorCode property is now cleared.'
readTrue
ErrorCleared property is in 104 classes of ROOT\cimv2 and in 12 namespaces
ErrorDescription property
CIMTYPE'string'
Description'ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode property, and information on any corrective actions that may be taken.'
readTrue
ErrorDescription property is in 106 classes of ROOT\cimv2 and in 142 namespaces
InstallDate property
CIMTYPE'datetime'
Description'The InstallDate property is datetime value indicating when the object was installed. A lack of a value does not indicate that the object is not installed.'
MappingStrings['MIF.DMTF|ComponentID|001.5']
readTrue
InstallDate property is in 227 classes of ROOT\cimv2 and in 23 namespaces
LastErrorCode property
CIMTYPE'uint32'
Description'LastErrorCode captures the last error code reported by the logical device.'
readTrue
LastErrorCode property is in 104 classes of ROOT\cimv2 and in 16 namespaces
Name property
CIMTYPE'string'
Description'The Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.'
readTrue
Name property is in 1046 classes of ROOT\cimv2 and in 142 namespaces
NumberOfConfigs property
CIMTYPE'uint8'
Description'Number of device configurations that are defined for the Device.'
NumberOfConfigs property is in 3 classes of ROOT\cimv2 and in 3 namespaces
PNPDeviceID property
CIMTYPE'string'
Description'Indicates the Win32 Plug and Play device ID of the logical device. Example: *PNP030b'
readTrue
PNPDeviceID property is in 104 classes of ROOT\cimv2 and in 6 namespaces
PowerManagementCapabilities property
CIMTYPE'uint16'
Description'Indicates the specific power-related capabilities of the logical device. The array values, 0="Unknown", 1="Not Supported" and 2="Disabled" are self-explanatory. The value, 3="Enabled" indicates that the power management features are currently enabled but the exact feature set is unknown or the information is unavailable. "Power Saving Modes Entered Automatically" (4) describes that a device can change its power state based on usage or other criteria. "Power State Settable" (5) indicates that the SetPowerState method is supported. "Power Cycling Supported" (6) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle"). "Timed Power On Supported" (7) indicates that the SetPowerState method can be invoked with the PowerState input variable set to 5 ("Power Cycle") and the Time parameter set to a specific date and time, or interval, for power-on.'
readTrue
Values['Unknown', 'Not Supported', 'Disabled', 'Enabled', 'Power Saving Modes Entered Automatically', 'Power State Settable', 'Power Cycling Supported', 'Timed Power On Supported']
PowerManagementCapabilities property is in 106 classes of ROOT\cimv2 and in 14 namespaces
PowerManagementSupported property
CIMTYPE'boolean'
Description'Boolean indicating that the Device can be power managed - ie, put into a power save state. This boolean does not indicate that power management features are currently enabled, or if enabled, what features are supported. Refer to the PowerManagementCapabilities array for this information. If this boolean is false, the integer value 1, for the string, "Not Supported", should be the only entry in the PowerManagementCapabilities array.'
readTrue
PowerManagementSupported property is in 106 classes of ROOT\cimv2 and in 14 namespaces
ProtocolCode property
CIMTYPE'uint8'
Description'Indicates the USB protocol code.'
ProtocolCode property is in 3 classes of ROOT\cimv2 and in 3 namespaces
Status property
CIMTYPE'string'
Description'The Status property is a string indicating the current status of the object. Various operational and non-operational statuses can be defined. Operational statuses are "OK", "Degraded" and "Pred Fail". "Pred Fail" indicates that an element may be functioning properly but predicting a failure in the near future. An example is a SMART-enabled hard drive. Non-operational statuses can also be specified. These are "Error", "Starting", "Stopping" and "Service". The latter, "Service", could apply during mirror-resilvering of a disk, reload of a user permissions list, or other administrative work. Not all such work is on-line, yet the managed element is neither "OK" nor in one of the other states.'
MaxLen10
readTrue
ValueMap['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Values['OK', 'Error', 'Degraded', 'Unknown', 'Pred Fail', 'Starting', 'Stopping', 'Service', 'Stressed', 'NonRecover', 'No Contact', 'Lost Comm']
Status property is in 230 classes of ROOT\cimv2 and in 42 namespaces
StatusInfo property
CIMTYPE'uint16'
Description'StatusInfo is a string indicating whether the logical device is in an enabled (value = 3), disabled (value = 4) or some other (1) or unknown (2) state. If this property does not apply to the logical device, the value, 5 ("Not Applicable"), should be used.'
MappingStrings['MIF.DMTF|Operational State|003.3']
readTrue
ValueMap['1', '2', '3', '4', '5']
Values['Other', 'Unknown', 'Enabled', 'Disabled', 'Not Applicable']
StatusInfo property is in 104 classes of ROOT\cimv2 and in 12 namespaces
SubclassCode property
CIMTYPE'uint8'
Description'Indicates the USB subclass code.'
SubclassCode property is in 3 classes of ROOT\cimv2 and in 3 namespaces
SystemCreationClassName property
CIM_KeyTrue
CIMTYPE'string'
Description'The scoping System's CreationClassName.'
Propagated'CIM_System.CreationClassName'
readTrue
SystemCreationClassName property is in 122 classes of ROOT\cimv2 and in 20 namespaces
SystemName property
CIM_KeyTrue
CIMTYPE'string'
Description'The scoping System's Name.'
Propagated'CIM_System.Name'
readTrue
SystemName property is in 122 classes of ROOT\cimv2 and in 22 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 3 classes of ROOT\cimv2 and in 3 namespaces

CIM_USBHub Qualifiers

NameValueToInstanceToSubclassOverridableAmendedLocal
Description'USB Hub Device.'
LOCALE1033

CIM_USBHub System properties

NameValueOriginCIMTypeLocalArray
__PATH'\\.\ROOT\cimv2:CIM_USBHub'___SYSTEM8
__NAMESPACE'ROOT\cimv2'___SYSTEM8
__SERVER'.'___SYSTEM8
__DERIVATION['CIM_USBDevice', 'CIM_LogicalDevice', 'CIM_LogicalElement', 'CIM_ManagedSystemElement']___SYSTEM8
__PROPERTY_COUNT28___SYSTEM3
__RELPATH'CIM_USBHub'___SYSTEM8
__DYNASTY'CIM_ManagedSystemElement'___SYSTEM8
__SUPERCLASS'CIM_USBDevice'___SYSTEM8
__CLASS'CIM_USBHub'___SYSTEM8
__GENUS1___SYSTEM3

Similar Classes to CIM_USBHub

Number of classes:3
Class nameChildsPropertiesMethodsClass
Instances
Child
Instances
AbstractSingleton
Win32_PerfFormattedData_usbhub_USB02608---
Win32_PerfRawData_usbhub_USB02808---
Win32_USBHub02837---
comments powered by Disqus
WUtils.com