CIM_ProtocolController class
Represents a group of controllers that control the operation and function of devices that initiate protocols. Simpler bus and device controllers are modeled using the CIM_Controller class.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.8.0"), AMENDMENT]
class CIM_ProtocolController : CIM_LogicalDevice
{
string Caption;
string Description;
string ElementName;
datetime InstallDate;
string Name;
uint16 OperationalStatus[];
string StatusDescriptions[];
string Status;
uint16 HealthState;
uint16 EnabledState = 5;
string OtherEnabledState;
uint16 RequestedState = 12;
uint16 EnabledDefault = 2;
datetime TimeOfLastStateChange;
string SystemCreationClassName;
string SystemName;
string CreationClassName;
string DeviceID;
boolean PowerManagementSupported;
uint16 PowerManagementCapabilities[];
uint16 Availability;
uint16 StatusInfo;
uint32 LastErrorCode;
string ErrorDescription;
boolean ErrorCleared;
string OtherIdentifyingInfo[];
uint64 PowerOnHours;
uint64 TotalPowerOnHours;
string IdentifyingDescriptions[];
uint16 AdditionalAvailability[];
uint64 MaxQuiesceTime;
uint16 LocationIndicator;
uint32 MaxUnitsControlled;
};
Members
The CIM_ProtocolController class has these types of members:
Methods
The CIM_ProtocolController class has these methods.
| Method | Description |
|---|---|
| EnableDevice | Deprecated description: Enables or disables the logical device. This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. |
| OnlineDevice | Deprecated description: Brings the logical device online so it can accept requests, or offline so it can no longer accept requests. This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. |
| QuiesceDevice | Deprecated description: Temporarily suspends activity on the logical device, or re-enables the activity. This method is deprecated. Instead we recommend that you use the RequestStateChange method. This method is inherited from CIM_LogicalDevice. |
| RequestStateChange | Requests that the state of the element be changed to the specified value. This method is inherited from CIM_EnabledLogicalElement. |
| Reset | Resets the logical device. This method is inherited from CIM_LogicalDevice. |
| RestoreProperties | Restores a previous configuration and state of the logical device. This method is inherited from CIM_LogicalDevice. |
| SaveProperties | Saves the configuration and state of the logical device. This method is inherited from CIM_LogicalDevice. |
| SetPowerState | Deprecated description: Sets the power state of the logical device. Instead we recommend that you use the SetPowerState property of the CIM_PowerManagementService class. This method is inherited from CIM_LogicalDevice. |
Properties
The CIM_ProtocolController class has these properties.
-
AdditionalAvailability
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")
An array that contains availability information about of the logical device, in addition to the that of the Availability property.
This property is inherited from CIM_LogicalDevice.
The possible values are.
-
-
Other (1)
-
Unknown (2)
-
Running/Full Power (3)
-
Warning (4)
-
In Test (5)
-
Not Applicable (6)
-
Power Off (7)
-
Off Line (8)
-
Off Duty (9)
-
Degraded (10)
-
Not Installed (11)
-
Install Error (12)
-
Power Save - Unknown (13)
-
Power Save - Low Power Mode (14)
-
Power Save - Standby (15)
-
Power Cycle (16)
-
Power Save - Warning (17)
-
Paused (18)
-
Not Ready (19)
-
Not Configured (20)
-
Quiesced (21)
-
Quiescent
Availability
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_AssociatedPowerManagementService.PowerState", "CIM_ManagedSystemElement.OperationalStatus", "CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")
Contains the availability of the logical device.
This property is inherited from CIM_LogicalDevice.
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
A short textual description of the object.
This property is inherited from CIM_ManagedElement.
CreationClassName
The class name used to create an instance of the logical device. CreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
This property is inherited from CIM_LogicalDevice.
Description
-
Data type: string
-
Access type: Read-only
A textual description of the object.
This property is inherited from CIM_ManagedElement.
DeviceID
A unique identifier of the logical device, such as the address.
This property is inherited from CIM_LogicalDevice.
ElementName
-
Data type: string
-
Access type: Read-only
A user-friendly name for the object. This property allows each instance to define a user-friendly name in addition to its key properties, identity data, and description information.
This property is inherited from CIM_ManagedElement.
EnabledDefault
-
Data type: uint16
-
Access type: Read/write
Indicates an administrator's default or startup configuration for the enabled state of an element. The default value Enabled (2).
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Enabled (2)
Disabled (3)
Not Applicable (5)
Enabled but Offline (6)
No Default (7)
Quiesce (9)
DMTF Reserved
Vendor Reserved
EnabledState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.OtherEnabledState")
Indicates the enabled state of an element. Possible values include the transitions between states. For example, Shutting Down (4) and Starting (10) are transient states between Enabled and Disabled.
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Unknown (0)
Indicates that the state of the element is unknown.
Other (1)
Indicates that the state of the element is described in the OtherEnabledState property.
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Disabled (3)
Indicates that the element does not execute commands and that it drops any new requests.
Shutting Down (4)
Indicates that the element is in the process of changing to a Disabled state.
Not Applicable (5)
Indicates the element does not support to be enabled or disabled.
Enabled but Offline (6)
Indicates that the element might be completing commands and that it drops any new requests.
In Test (7)
Indicates that the element is in a test state.
Deferred (8)
Indicates that the element might be completing commands, but that it queues any new requests.
Quiesce (9)
Indicates that the element is enabled but is in a restricted mode.
Starting (10)
Indicates that the element is in the process of changing to an Enabled state. New requests are queued.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
ErrorCleared
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")
This property is deprecated. Instead, use the OperationalStatus property from the CIM_ManagedSystemElement class.
Deprecated description: Indicates whether an error reported by the LastErrorCode property is cleared.
This property is inherited from CIM_LogicalDevice.
ErrorDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")
This property is deprecated. Instead, use the ErrorDescription property from the CIM_DeviceErrorData class.
Deprecated description: Additional information about the error reported by the LastErrorCode property.
This property is inherited from CIM_LogicalDevice.
HealthState
-
Data type: uint16
-
Access type: Read-only
Indicates the current health of the element. This attribute expresses the health of this element, but not necessarily the health of its subcomponents.
This property is inherited from CIM_ManagedSystemElement.
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and operates within normal operational parameters and without error.
Degraded/Warning (10)
The element is in working order, and all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Minor failure (15)
All functionality is available, but some functionality might be degraded.
Major failure (20)
The element is failing. It is possible that some or all of the functionality of this component is degraded or does not work.
Critical failure (25)
The element is nonfunctional, and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality that this element provides has been lost.
DMTF Reserved
Reserved.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")
An array of strings that describe the OtherIdentifyingInfo array items of the same index.
This property is inherited from CIM_LogicalDevice.
InstallDate
-
Data type: datetime
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|ComponentID|001.5")
Indicates when the object was installed. The lack of a value does not indicate that the object is not installed.
This property is inherited from CIM_ManagedSystemElement.
LastErrorCode
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.LastErrorCode")
This property is deprecated. Instead, we use the LastErrorCode property from theCIM_DeviceErrorData class.
Deprecated description: The last error code reported by the logical device.
This property is inherited from CIM_LogicalDevice.
LocationIndicator
-
Data type: uint16
-
Access type: Read/write
-
Qualifiers: Experimental, ModelCorrespondence ("CIM_AlarmDevice.AlarmState", "CIM_AlarmDevice.AudioIndicatorIsDisabled", "CIM_AlarmDevice.VisualIndicatorIsDisabled", "CIM_AlarmDevice.MotionIndicatorIsDisabled")
This property is not supported.
This property is inherited from CIM_LogicalDevice.
Unknown (0)
On (2)
Off (3)
Not Supported (4)
MaxQuiesceTime
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")
This property is deprecated and should not be used.
Deprecated description: The maximum time in milliseconds, that a device can remain in a temporarily disabled state (Availability and AdditionalAvailability properties set to "21" quiescent ). A value of "0" indicates that the logical device can remain in a temporarily disabled state indefinitely.
This property is inherited from CIM_LogicalDevice.
MaxUnitsControlled
-
Data type: uint32
-
Access type: Read-only
The maximum number of units that can be controlled by or accessed through the protocol controller.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
The label by which the object is known. When subclassed, the Name property can be overridden to be a key property.
This property is inherited from CIM_ManagedSystemElement.
OperationalStatus
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.StatusDescriptions")
Contains indicators of the current status of the element. The first value of the OperationalStatus property should contain the primary status for the element.
Note
The OperationalStatus property replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, we strongly recommend that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status, because it is a single-valued property, should also provide the primary status of the element.
This property is inherited from CIM_ManagedSystemElement.
The possible values are.
Unknown (0)
Indicates that the implementation cannot report on the OperationalStatus property at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates that the element is in working order and that all functionality is provided. However, the element does not function to the best of its abilities. For example, the element might not operate at optimal performance, or it might report recoverable errors.
Stressed (4)
Indicates that the element functions, but requires attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element functions nominally, but predicts a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
Indicates that a nonrecoverable error has occurred.
Starting (8)
Indicates that the job is starting.
Stopping (9)
Indicates that the job is stopping.
Stopped (10)
Indicates that the element has been intentionally stopped.
In Service (11)
Indicates that the element is in process to be configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has information about this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the monitoring system has successfully contacted this element in the past, but it is currently unavailable.
Aborted (14)
Indicates that the job stopped in an unexpected way. The state and configuration of the job might require an update.
Dormant (15)
Indicates that the job is inactive.
Supporting Entity in Error (16)
Indicates that an element on which this job depends is in error. This element might be OK but cannot function because of the state of a dependent element. An example is a network service or endpoint that cannot function due to lower-layer networking problems.
Completed (17)
Indicates that the job has completed its operation. This value should be combined with either OK, Error, or Degraded to indicate to a client whether the complete operation Completed with OK and passed, or completed with Error and failed, or completed with Degraded and finished the operation, but did not complete OK or did not report an error.
Power Mode (18)
Indicates that the element has additional power model information that is contained in the associated power management service.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Describes the state of the element when the value of the EnabledState property is Other. This property must be set to NULL when EnabledState is not Other.
This property is inherited from CIM_EnabledLogicalElement.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: MaxLen (256), ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")
Information that identifies the logical device, other than DeviceID.
This property is inherited from CIM_LogicalDevice.
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")
This property is deprecated. Instead, use the CIM_PowerManagementCapabilities class.
Deprecated description: An array that contains the power management capabilities of the device.
This property is inherited from CIM_LogicalDevice.
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")
This property is deprecated. Instead, use the PowerManagementCapabilities class.
Deprecated description: true if the logical device can be power managed; otherwise, false.
This property is inherited from CIM_LogicalDevice.
PowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.PowerOnHours"), Units ("Hours"), Counter
The number of consecutive hours the logical device has been powered, since its last power cycle.
This property is inherited from CIM_LogicalDevice.
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
Indicates the last requested state for the element. The current state is indicated by the EnabledState property. This property enables you to compare the last requested and current states.
Note
When the value of the EnabledState property is Not Applicable, this property has no meaning.
This property is inherited from CIM_EnabledLogicalElement.
The possible values are.
Unknown (0)
Indicates the last requested state for the element is unknown.
Enabled (2)
Indicates that the element executes or could execute commands, processes any queued commands, and queues new requests.
Disabled (3)
Indicates a request to immediately disable the element, such that it does not execute or accept any commands or processing requests.
Shut Down (4)
Indicates a request for an orderly transition to the Disabled state, and might require you to shut off the power to completely erase any existing state.
No Change (5)
No state change has been requested.
Offline (6)
Indicates a request to change to the Enabled but Offline state.
Test (7)
Indicates that the element is in a test state.
Deferred (8)
Indicates that the element might be completing commands, but that it queues any new requests.
Quiesce (9)
Indicates that the element is enabled but is in a restricted mode.
Reboot (10)
Indicates a request to shut down and then change to an Enabled state.
Reset (11)
Indicates a request to change to a Disabled state and then change to an Enabled state.
Not Applicable (12)
Indicates that this instance does not support the RequestedState property.
DMTF Reserved
Reserved.
Vendor Reserved
Reserved.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Indicates the primary status of the object.
Note
This property is deprecated. It is replaced by the OperationalStatus property. If you choose to use the Status property for backward compatibility, it should be secondary to the OperationalStatus property.
This property is inherited from CIM_ManagedSystemElement.
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Indicates descriptions of the corresponding values in the OperationalStatus array. For example, if an element in the OperationalStatus property contains the value Stopping, then the element at the same array index in this property might contain an explanation as to why an object is being stopped.
This property is inherited from CIM_ManagedSystemElement.
StatusInfo
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_EnabledLogicalElement.EnabledState"), MappingStrings ("MIF.DMTF|Operational State|006.4")
This property is deprecated. Instead, use the CIM_PowerManagementCapabilities class.
Deprecated description: Indicates whether the logical device is enabled or in a related state.
This property is inherited from CIM_LogicalDevice.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The class name used to create an instance of the system that contains the logical device. SystemCreationClassName is combined with other key properties of this class to uniquely identify instances of this class and its subclasses.
This property is inherited from CIM_LogicalDevice.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The name of the system that contains the logical device.
This property is inherited from CIM_LogicalDevice.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
Indicates when the element last changed state. If the state of the element has not changed and this property is populated, then it must be set to a zero interval value. If a state change was requested, but was rejected or is not yet processed, the property must not be updated.
This property is inherited from CIM_EnabledLogicalElement.
TotalPowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PoweredStatisticalData.TotalPowerOnHours"), Units ("Hours"), Counter
The total number of hours the logical device has been powered.
This property is inherited from CIM_LogicalDevice.
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2008 |
| End of client support |
None supported |
| End of server support |
Windows Server 2012 R2 |
| Namespace |
Root\virtualization |
| MOF |
|