CIM_ProtocolController class
A superclass for grouping controllers that are used to control the operation and function of sophisticated devices that instantiate a protocol such as SCSI. Simpler bus and device controllers are modeled using the CIM_Controller class.
Important The DMTF (Distributed Management Task Force) CIM (Common Information Model) classes are the parent classes upon which WMI classes are built. WMI currently supports only the CIM 2.x version schemas.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
class CIM_ProtocolController : CIM_LogicalDevice
{
string SystemName;
string SystemCreationClassName;
uint16 StatusInfo;
string Status;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
string PNPDeviceID;
string Name;
uint32 LastErrorCode;
datetime InstallDate;
string ErrorDescription;
boolean ErrorCleared;
string DeviceID;
string Description;
string CreationClassName;
boolean ConfigManagerUserConfig;
uint32 ConfigManagerErrorCode;
string Caption;
uint16 Availability;
uint32 MaxUnitsControlled;
};
Members
The CIM_ProtocolController class has these types of members:
- Properties
Properties
The CIM_ProtocolController class has these properties.
Availability
Data type: uint16
Access type: Read-only
Availability and status of the device. Inherited from CIM_LogicalDevice.
| Value | Meaning |
|---|---|
| 1 (0x1) | Other |
| 2 (0x2) | Unknown |
| 3 (0x3) | Running/Full Power |
| 4 (0x4) | Warning |
| 5 (0x5) | In Test |
| 6 (0x6) | Not Applicable |
| 7 (0x7) | Power Off |
| 8 (0x8) | Off Line |
| 9 (0x9) | Off Duty |
| 10 (0xA) | Degraded |
| 11 (0xB) | Not Installed |
| 12 (0xC) | Install Error |
| 13 (0xD) | Power Save - Unknown The device is known to be in a power save mode, but its exact status is unknown. |
| 14 (0xE) | Power Save - Low Power Mode The device is in a power save state but still functioning, and may exhibit degraded performance. |
| 15 (0xF) | Power Save - Standby The device is not functioning but could be brought to full power quickly. |
| 16 (0x10) | Power Cycle |
| 17 (0x11) | Power Save - Warning The device is in a warning state, though also in a power save mode. |
Caption
Data type: string
Access type: Read-only
Short textual description of the object. This property is inherited from CIM_ManagedSystemElement.
ConfigManagerErrorCode
Data type: uint32
Access type: Read-only
Win32 Configuration Manager error code.
| Value | Meaning |
|---|---|
| 0 (0x0) | Device is working properly. |
| 1 (0x1) | Device is not configured correctly. |
| 2 (0x2) | Windows cannot load the driver for this device. |
| 3 (0x3) | Driver for this device might be corrupted, or the system may be low on memory or other resources. |
| 4 (0x4) | Device is not working properly. One of its drivers or the registry might be corrupted. |
| 5 (0x5) | Driver for the device requires a resource that Windows cannot manage. |
| 6 (0x6) | Boot configuration for the device conflicts with other devices. |
| 7 (0x7) | Cannot filter. |
| 8 (0x8) | Driver loader for the device is missing. |
| 9 (0x9) | Device is not working properly; the controlling firmware is incorrectly reporting the resources for the device. |
| 10 (0xA) | Device cannot start. |
| 11 (0xB) | Device failed. |
| 12 (0xC) | Device cannot find enough free resources to use. |
| 13 (0xD) | Windows cannot verify the device's resources. |
| 14 (0xE) | Device cannot work properly until the computer is restarted. |
| 15 (0xF) | Device is not working properly due to a possible re-enumeration problem. |
| 16 (0x10) | Windows cannot identify all of the resources that the device uses. |
| 17 (0x11) | Device is requesting an unknown resource type. |
| 18 (0x12) | Device drivers must be reinstalled. |
| 19 (0x13) | Failure using the VxD loader. |
| 20 (0x14) | Registry might be corrupted. |
| 21 (0x15) | System failure. If changing the device driver is ineffective, see the hardware documentation. Windows is removing the device. |
| 22 (0x16) | Device is disabled. |
| 23 (0x17) | System failure. If changing the device driver is ineffective, see the hardware documentation. |
| 24 (0x18) | Device is not present, not working properly, or does not have all of its drivers installed. |
| 25 (0x19) | Windows is still setting up the device. |
| 26 (0x1A) | Windows is still setting up the device. |
| 27 (0x1B) | Device does not have valid log configuration. |
| 28 (0x1C) | Device drivers are not installed. |
| 29 (0x1D) | Device is disabled; the device firmware did not provide the required resources. |
| 30 (0x1E) | Device is using an IRQ resource that another device is using. |
| 31 (0x1F) | Device is not working properly; Windows cannot load the required device drivers. |
ConfigManagerUserConfig
Data type: boolean
Access type: Read-only
If TRUE, the device is using a user-defined configuration.
CreationClassName
Data type: string
Access type: Read-only
Name of the class or subclass used in the creation of an instance. When used with other key properties of the class, this property allows all instances of the class and its subclasses to be uniquely identified.
Description
Data type: string
Access type: Read-only
Textual description of the object. This property is inherited from CIM_ManagedSystemElement.
DeviceID
Data type: string
Access type: Read-only
Address or other identifying information to uniquely name the logical device.
ErrorCleared
Data type: boolean
Access type: Read-only
If TRUE, the error reported in the LastErrorCode property is now cleared.
ErrorDescription
Data type: string
Access type: Read-only
Free-form string that supplies information about the error recorded in the LastErrorCode property and corrective actions to perform.
InstallDate
Data type: datetime
Access type: Read-only
Date and time the object was installed. This property does not require a value to indicate that the object is installed. This property is inherited from CIM_ManagedSystemElement.
LastErrorCode
Data type: uint32
Access type: Read-only
Last error code reported by the logical device.
MaxUnitsControlled
Data type: uint32
Access type: Read-only
Maximum number of units that can be controlled by or accessed through this protocol controller.
Name
Data type: string
Access type: Read-only
Label by which the object is known. When subclassed, this property can be overridden to be a key property. This property is inherited from CIM_ManagedSystemElement.
PNPDeviceID
Data type: string
Access type: Read-only
Indicates the Win32 Plug and Play device identifier of the logical device.
Example: "*PNP030b"
PowerManagementCapabilities
Data type: uint16 array
Access type: Read-only
Array of the specific power-related capabilities of a logical device. This property is inherited from CIM_LogicalDevice.
| Value | Meaning |
|---|---|
| 0 (0x0) | Unknown |
| 1 (0x1) | Not Supported |
| 2 (0x2) | Disabled |
| 3 (0x3) | Enabled The power management features are currently enabled but the exact feature set is unknown or the information is unavailable. |
| 4 (0x4) | Power Saving Modes Entered Automatically The device can change its power state based on usage or other criteria. |
| 5 (0x5) | Power State Settable The SetPowerState method is supported. This method is found on the parent CIM_LogicalDevice class and can be implemented. For more information, see Designing Managed Object Format (MOF) Classes. |
| 6 (0x6) | Power Cycling Supported The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle). |
| 7 (0x7) | Timed Power On Supported The SetPowerState method can be invoked with the PowerState parameter set to 5 (Power Cycle) and Time set to a specific date and time, or interval, for power-on. |
PowerManagementSupported
Data type: boolean
Access type: Read-only
If TRUE, the device can be power managed, that is, put into a power-save state. If FALSE, the integer value 1 ("Not Supported") should be the only entry in the PowerManagementCapabilities array.
This property does not indicate whether power management features are currently enabled, or if enabled, which features are supported. For more information, see the PowerManagementCapabilities array.
Status
Data type: string
Access type: Read-only
Current status of the object. This property is inherited from CIM_ManagedSystemElement.
Values include the following:
"OK"
"Error"
"Degraded"
"Unknown"
"Pred Fail"
"Starting"
"Stopping"
"Service"
"Stressed"
"NonRecover"
"No Contact"
"Lost Comm"
StatusInfo
Data type: uint16
Access type: Read-only
State of the logical device. If this property does not apply to the logical device, the value 5 (Not Applicable) should be used. This property is inherited from CIM_LogicalDevice.
| Value | Meaning |
|---|---|
| 1 (0x1) | Other |
| 2 (0x2) | Unknown |
| 3 (0x3) | Enabled |
| 4 (0x4) | Disabled |
| 5 (0x5) | Not Applicable |
SystemCreationClassName
Data type: string
Access type: Read-only
Scoping system's creation class name.
SystemName
Data type: string
Access type: Read-only
Scoping system's name.
Requirements
Namespace |
Root\CIMV2 |