class CIM_LogicalPort : CIM_LogicalDevice

Description:

The abstraction of a port or connection point of a Device. This object should be instantiated when the Port has independent management characteristics from the Device that includes it. Examples are a Fibre Channel Port and a USB Port.

Definition:

Feature Type Class Origin Qualifiers
InstanceID string CIM_ManagedElement
Description InstanceID is an optional property that may be used to opaquely and uniquely identify an instance of this class within the scope of the instantiating Namespace. Various subclasses of this class may override this property to make it required, or a key. Such subclasses may also modify the preferred algorithms for ensuring uniqueness that are defined below. To ensure uniqueness within the NameSpace, the value of InstanceID should be constructed using the following "preferred" algorithm: <OrgID>:<LocalID> Where <OrgID> and <LocalID> are separated by a colon (:), and where <OrgID> must include a copyrighted, trademarked, or otherwise unique name that is owned by the business entity that is creating or defining the InstanceID or that is a registered ID assigned to the business entity by a recognized global authority. (This requirement is similar to the <Schema Name>_<Class Name> structure of Schema class names.) In addition, to ensure uniqueness, <OrgID> must not contain a colon (:). When using this algorithm, the first colon to appear in InstanceID must appear between <OrgID> and <LocalID>. <LocalID> is chosen by the business entity and should not be reused to identify different underlying (real-world) elements. If not null and the above "preferred" algorithm is not used, the defining entity must assure that the resulting InstanceID is not reused across any InstanceIDs produced by this or other providers for the NameSpace of this instance. If not set to null for DMTF-defined instances, the "preferred" algorithm must be used with the <OrgID> set to CIM.
Caption string CIM_ManagedElement
Description The Caption property is a short textual description (one- line string) of the object.
MaxLen 64
Description string CIM_ManagedElement
Description The Description property provides a textual description of the object.
ElementName string CIM_ManagedElement
Description 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. Note that the Name property of ManagedSystemElement is also defined as a user-friendly name. But, it is often subclassed to be a Key. It is not reasonable that the same property can convey both identity and a user-friendly name, without inconsistencies. Where Name exists and is not a Key (such as for instances of LogicalDevice), the same information can be present in both the Name and ElementName properties.
InstallDate datetime CIM_ManagedSystemElement
Description A datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.
MappingStrings MIF.DMTF|ComponentID|001.5
Name string CIM_ManagedSystemElement
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.
MaxLen 1024
OperationalStatus uint16[] CIM_ManagedSystemElement
Description Indicates the current statuses of the element. Various operational statuses are defined. Many of the enumeration's values are self-explanatory. However, a few are not and are described here in more detail. "Stressed" indicates that the element is functioning, but needs attention. Examples of "Stressed" states are overload, overheated, and so on. "Predictive Failure" indicates that an element is functioning nominally but predicting a failure in the near future. "In Service" describes an element being configured, maintained, cleaned, or otherwise administered. "No Contact" indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it. "Lost Communication" indicates that the ManagedSystem Element is known to exist and has been contacted successfully in the past, but is currently unreachable. "Stopped" and "Aborted" are similar, although the former implies a clean and orderly stop, while the latter implies an abrupt stop where the state and configuration of the element might need to be updated. "Dormant" indicates that the element is inactive or quiesced. "Supporting Entity in Error" indicates that this element might be "OK" but that another element, on which it is dependent, is in error. An example is a network service or endpoint that cannot function due to lower-layer networking problems. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded so that a client can tell if the complete operation Completed with OK (passed), Completed with Error (failed), or Completed with Degraded (the operation finished, but it did not complete OK or did not report an error). "Power Mode" indicates that the element has additional power model information contained in the Associated PowerManagementService association. OperationalStatus replaces the Status property on ManagedSystemElement to provide a consistent approach to enumerations, to address implementation needs for an array property, and to provide a migration path from today's environment to the future. This change was not made earlier because it required the deprecated qualifier. Due to the widespread use of the existing Status property in management applications, it is strongly recommended that providers or instrumentation provide both the Status and OperationalStatus properties. Further, the first value of OperationalStatus should contain the primary status for the element. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.
ValueMap 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..
Values "Unknown" [0]
"Other" [1]
"OK" [2]
"Degraded" [3]
"Stressed" [4]
"Predictive Failure" [5]
"Error" [6]
"Non-Recoverable Error" [7]
"Starting" [8]
"Stopping" [9]
"Stopped" [10]
"In Service" [11]
"No Contact" [12]
"Lost Communication" [13]
"Aborted" [14]
"Dormant" [15]
"Supporting Entity in Error" [16]
"Completed" [17]
"Power Mode" [18]
"DMTF Reserved" [..]
"Vendor Reserved" [0x8000..]
ArrayType Indexed
ModelCorrespondence CIM_ManagedSystemElement.StatusDescriptions
StatusDescriptions string[] CIM_ManagedSystemElement
Description Strings describing the various OperationalStatus array values. For example, if "Stopping" is the value assigned to OperationalStatus, then this property may contain an explanation as to why an object is being stopped. Note that entries in this array are correlated with those at the same array index in OperationalStatus.
ArrayType Indexed
ModelCorrespondence CIM_ManagedSystemElement.OperationalStatus
Status string CIM_ManagedSystemElement
Deprecated CIM_ManagedSystemElement.OperationalStatus
Description A string indicating the current status of the object. Various operational and non-operational statuses are defined. This property is deprecated in lieu of OperationalStatus, which includes the same semantics in its enumeration. This change is made for 3 reasons: 1) Status is more correctly defined as an array. This definition overcomes the limitation of describing status using a single value, when it is really a multi-valued property (for example, an element might be OK AND Stopped. 2) A MaxLen of 10 is too restrictive and leads to unclear enumerated values. 3) The change to a uint16 data type was discussed when CIM V2.0 was defined. However, existing V1.0 implementations used the string property and did not want to modify their code. Therefore, Status was grandfathered into the Schema. Use of the deprecated qualifier allows the maintenance of the existing property, but also permits an improved definition using OperationalStatus.
ValueMap OK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, Stopped
MaxLen 10
HealthState uint16 CIM_ManagedSystemElement
Description Indicates the current health of the element. This attribute expresses the health of this element but not necessarily that of its subcomponents. The possible values are 0 to 30, where 5 means the element is entirely healthy and 30 means the element is completely non-functional. The following continuum is defined: "Non-recoverable Error" (30) - The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost. "Critical Failure" (25) - The element is non-functional and recovery might not be possible. "Major Failure" (20) - The element is failing. It is possible that some or all of the functionality of this component is degraded or not working. "Minor Failure" (15) - All functionality is available but some might be degraded. "Degraded/Warning" (10) - The element is in working order and all functionality is provided. However, the element is not working to the best of its abilities. For example, the element might not be operating at optimal performance or it might be reporting recoverable errors. "OK" (5) - The element is fully functional and is operating within normal operational parameters and without error. "Unknown" (0) - The implementation cannot report on HealthState at this time. DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
ValueMap 0, 5, 10, 15, 20, 25, 30, ..
Values "Unknown" [0]
"OK" [5]
"Degraded/Warning" [10]
"Minor failure" [15]
"Major failure" [20]
"Critical failure" [25]
"Non-recoverable error" [30]
"DMTF Reserved" [..]
EnabledState uint16 CIM_EnabledLogicalElement
Description EnabledState is an integer enumeration that indicates the enabled and disabled states of an element. It can also indicate the transitions between these requested states. For example, shutting down (value=4) and starting (value=10) are transient states between enabled and disabled. The following text briefly summarizes the various enabled and disabled states: Enabled (2) indicates that the element is or could be executing commands, will process any queued commands, and queues new requests. Disabled (3) indicates that the element will not execute commands and will drop any new requests. Shutting Down (4) indicates that the element is in the process of going to a Disabled state. Not Applicable (5) indicates the element does not support being enabled or disabled. Enabled but Offline (6) indicates that the element might be completing commands, and will drop any new requests. Test (7) indicates that the element is in a test state. Deferred (8) indicates that the element might be completing commands, but will queue any new requests. Quiesce (9) indicates that the element is enabled but in a restricted mode. Starting (10) indicates that the element is in the process of going to an Enabled state. New requests are queued.
ValueMap 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535
Values "Unknown" [0]
"Other" [1]
"Enabled" [2]
"Disabled" [3]
"Shutting Down" [4]
"Not Applicable" [5]
"Enabled but Offline" [6]
"In Test" [7]
"Deferred" [8]
"Quiesce" [9]
"Starting" [10]
"DMTF Reserved" [11..32767]
"Vendor Reserved" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.OtherEnabledState
OtherEnabledState string CIM_EnabledLogicalElement
Description A string that describes the enabled or disabled state of the element when the EnabledState property is set to 1 ("Other"). This property must be set to null when EnabledState is any value other than 1.
ModelCorrespondence CIM_EnabledLogicalElement.EnabledState
RequestedState uint16 CIM_EnabledLogicalElement
Description RequestedState is an integer enumeration that indicates the last requested or desired state for the element, irrespective of the mechanism through which it was requested. The actual state of the element is represented by EnabledState. This property is provided to compare the last requested and current enabled or disabled states. Note that when EnabledState is set to 5 ("Not Applicable"), then this property has no meaning. Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. "Unknown" (0) indicates the last requested state for the element is unknown. Note that the value "No Change" (5) has been deprecated in lieu of indicating the last requested state is "Unknown" (0). If the last requested or desired state is unknown, RequestedState should have the value "Unknown" (0), but may have the value "No Change" (5).Offline (6) indicates that the element has been requested to transition to the Enabled but Offline EnabledState. It should be noted that there are two new values in RequestedState that build on the statuses of EnabledState. These are "Reboot" (10) and "Reset" (11). Reboot refers to doing a "Shut Down" and then moving to an "Enabled" state. Reset indicates that the element is first "Disabled" and then "Enabled". The distinction between requesting "Shut Down" and "Disabled" should also be noted. Shut Down requests an orderly transition to the Disabled state, and might involve removing power, to completely erase any existing state. The Disabled state requests an immediate disabling of the element, such that it will not execute or accept any commands or processing requests. This property is set as the result of a method invocation (such as Start or StopService on CIM_Service), or can be overridden and defined as WRITEable in a subclass. The method approach is considered superior to a WRITEable property, because it allows an explicit invocation of the operation and the return of a result code. If knowledge of the last RequestedState is not supported for the EnabledLogicalElement, the property shall be NULL or have the value 12 "Not Applicable".
ValueMap 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535
Values "Unknown" [0]
"Enabled" [2]
"Disabled" [3]
"Shut Down" [4]
"No Change" [5]
"Offline" [6]
"Test" [7]
"Deferred" [8]
"Quiesce" [9]
"Reboot" [10]
"Reset" [11]
"Not Applicable" [12]
"DMTF Reserved" [..]
"Vendor Reserved" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.EnabledState
EnabledDefault uint16 CIM_EnabledLogicalElement
Write TRUE
Description An enumerated value indicating an administrator's default or startup configuration for the Enabled State of an element. By default, the element is "Enabled" (value=2).
ValueMap 2, 3, 5, 6, 7, 9, .., 32768..65535
Values "Enabled" [2]
"Disabled" [3]
"Not Applicable" [5]
"Enabled but Offline" [6]
"No Default" [7]
"Quiesce" [9]
"DMTF Reserved" [..]
"Vendor Reserved" [32768..65535]
TimeOfLastStateChange datetime CIM_EnabledLogicalElement
Description The date or time when the EnabledState of the element last changed. If the state of the element has not changed and this property is populated, then it must be set to a 0 interval value. If a state change was requested, but rejected or not yet processed, the property must not be updated.
RequestStateChange method CIM_EnabledLogicalElement
Description Requests that the state of the element be changed to the value specified in the RequestedState parameter. When the requested state change takes place, the EnabledState and RequestedState of the element will be the same. Invoking the RequestStateChange method multiple times could result in earlier requests being overwritten or lost. A return code of 0 shall indicate the state change was successfully initiated. A return code of 3 shall indicate that the state transition cannot complete within the interval specified by the TimeoutPeriod parameter. A return code of 4096 (0x1000) shall indicate the state change was successfully initiated, a ConcreteJob has been created, and its reference returned in the output parameter Job. Any other return code indicates an error condition.
ValueMap 0, 1, 2, 3, 4, 5, 6, .., 4096, 4097, 4098, 4099, 4100..32767, 32768..65535
Values "Completed with No Error" [0]
"Not Supported" [1]
"Unknown or Unspecified Error" [2]
"Cannot complete within Timeout Period" [3]
"Failed" [4]
"Invalid Parameter" [5]
"In Use" [6]
"DMTF Reserved" [..]
"Method Parameters Checked - Job Started" [4096]
"Invalid State Transition" [4097]
"Use of Timeout Parameter Not Supported" [4098]
"Busy" [4099]
"Method Reserved" [4100..32767]
"Vendor Specific" [32768..65535]
ModelCorrespondence CIM_EnabledLogicalElement.RequestedState
SystemCreationClassName string CIM_LogicalDevice
Key TRUE
Description The scoping System's CreationClassName.
MaxLen 256
Propagated CIM_System.CreationClassName
SystemName string CIM_LogicalDevice
Key TRUE
Description The scoping System's Name.
MaxLen 256
Propagated CIM_System.Name
CreationClassName string CIM_LogicalDevice
Key TRUE
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.
MaxLen 256
DeviceID string CIM_LogicalDevice
Key TRUE
Description An address or other identifying information to uniquely name the LogicalDevice.
MaxLen 64
PowerManagementSupported boolean CIM_LogicalDevice
Deprecated CIM_PowerManagementCapabilities
Description Boolean indicating that the Device can be power managed. The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationhip) indicates that power management is supported.
PowerManagementCapabilities uint16[] CIM_LogicalDevice
Deprecated CIM_PowerManagementCapabilities.PowerCapabilities
Description An enumerated array describing the power management capabilities of the Device. The use of this property has been deprecated. Instead, the PowerCapabilites property in an associated PowerManagementCapabilities class should be used.
ValueMap 0, 1, 2, 3, 4, 5, 6, 7
Values "Unknown" [0]
"Not Supported" [1]
"Disabled" [2]
"Enabled" [3]
"Power Saving Modes Entered Automatically" [4]
"Power State Settable" [5]
"Power Cycling Supported" [6]
"Timed Power On Supported" [7]
Availability uint16 CIM_LogicalDevice
Description The primary availability and status of the Device. (Additional status information can be specified using the Additional Availability array property.) 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 Save 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.
ValueMap 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21
Values "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]
MappingStrings MIF.DMTF|Operational State|006.5, MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus, MIF.DMTF|Host Device|001.5
ModelCorrespondence CIM_LogicalDevice.AdditionalAvailability
StatusInfo uint16 CIM_LogicalDevice
Deprecated CIM_EnabledLogicalElement.EnabledState
Description The StatusInfo property indicates 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 LogicalDevice, the value, 5 ("Not Applicable"), should be used. StatusInfo has been deprecated in lieu of a more clearly named property with additional enumerated values (EnabledState), that is inherited from ManagedSystemElement. If a Device is ("Enabled")(value=3), it has been powered up, and is configured and operational. The Device may or may not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicate that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an enabled but offline mode, a Device may be performing out-of-band requests, such as running Diagnostics. If ("Disabled") StatusInfo value=4), a Device can only be "enabled" or powered off. In a personal computer environment, ("Disabled") means that the Device's driver is not available in the stack. In other environments, a Device can be disabled by removing its configuration file. A disabled device is physically present in a System and consuming resources, but can not be communicated with until a load of a driver, a load of a configuration file or some other "enabling" activity has occurred.
ValueMap 1, 2, 3, 4, 5
Values "Other" [1]
"Unknown" [2]
"Enabled" [3]
"Disabled" [4]
"Not Applicable" [5]
MappingStrings MIF.DMTF|Operational State|006.4
LastErrorCode uint32 CIM_LogicalDevice
Deprecated CIM_DeviceErrorData.LastErrorCode
Description LastErrorCode captures the last error code reported by the LogicalDevice.
ErrorDescription string CIM_LogicalDevice
Deprecated CIM_DeviceErrorData.ErrorDescription
Description ErrorDescription is a free-form string supplying more information about the error recorded in LastErrorCode, and information on any corrective actions that may be taken.
ErrorCleared boolean CIM_LogicalDevice
Deprecated CIM_ManagedSystemElement.OperationalStatus
Description ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared.
OtherIdentifyingInfo string[] CIM_LogicalDevice
Description OtherIdentifyingInfo captures additional data, beyond DeviceID information, that could be used to identify a LogicalDevice. One example would be to hold the Operating System's user friendly name for the Device in this property.
ArrayType Indexed
MaxLen 256
ModelCorrespondence CIM_LogicalDevice.IdentifyingDescriptions
PowerOnHours uint64 CIM_LogicalDevice
Description The number of consecutive hours that this Device has been powered, since its last power cycle.
Units Hours
Counter TRUE
TotalPowerOnHours uint64 CIM_LogicalDevice
Description The total number of hours that this Device has been powered.
Units Hours
Counter TRUE
IdentifyingDescriptions string[] CIM_LogicalDevice
Description An array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note, each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.
ArrayType Indexed
ModelCorrespondence CIM_LogicalDevice.OtherIdentifyingInfo
AdditionalAvailability uint16[] CIM_LogicalDevice
Description Additional availability and status of the Device, beyond that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this will not be sufficient to denote the complete status of the Device. In those cases, the AdditionalAvailability property can be used to provide further information. For example, a Device's primary Availability may be "Off line" (value=8), but it may also be in a low power state (AdditonalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, "In Test").
ValueMap 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21
Values "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]
ModelCorrespondence CIM_LogicalDevice.Availability
MaxQuiesceTime uint64 CIM_LogicalDevice
Deprecated No value
Description The MaxQuiesceTime property has been deprecated. When evaluating the use of Quiesce, it was determine that this single property is not adequate for describing when a device will automatically exit a quiescent state. In fact, the most likely scenario for a device to exit a quiescent state was determined to be based on the number of outstanding requests queued rather than on a maximum time. This will be re-evaluated and repositioned later. Maximum time in milliseconds, that a Device can run in a "Quiesced" state. A Device's state is defined in its Availability and AdditionalAvailability properties, where "Quiesced" is conveyed by the value 21. What occurs at the end of the time limit is device-specific. The Device may unquiesce, may offline or take other action. A value of 0 indicates that a Device can remain quiesced indefinitely.
Units MilliSeconds
SetPowerState method CIM_LogicalDevice
Deprecated CIM_PowerManagementService.SetPowerState
Description Sets the power state of the Device. The use of this method has been deprecated. Instead, use the SetPowerState method in the associated PowerManagementService class.
Reset method CIM_LogicalDevice
Description Requests a reset of the LogicalDevice. 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. 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.
EnableDevice method CIM_LogicalDevice
Deprecated CIM_EnabledLogicalElement.RequestStateChange
Description The EnableDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be enabled ("Enabled" input parameter = TRUE) or disabled (= FALSE). If successful, the Device's StatusInfo/EnabledState properties should reflect the desired state (enabled/disabled). Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the EnableDevice method should set the RequestedState property appropriately. The return code should be 0 if the request was successfully executed, 1 if the request is not supported and some other value if an 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.
OnlineDevice method CIM_LogicalDevice
Deprecated CIM_EnabledLogicalElement.RequestStateChange
Description The OnlineDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice be brought online ("Online" input parameter = TRUE) or taken offline (= FALSE). "Online" indicates that the Device is ready to accept requests, and is operational and fully functioning. In this case, the Device's Availability property would be set to a value of 3 ("Running/Full Power"). "Offline" indicates that a Device is powered up and operational, but not processing functional requests. In an offline state, a Device may be capable of running diagnostics or generating operational alerts. For example, when the "Offline" button is pushed on a Printer, the Device is no longer available to process print jobs, but could be available for diagnostics or maintenance. If this method is successful, the Device's Availability and AdditionalAvailability properties should reflect the updated status. If a failure occurs trying to bring the Device online or offline, it should remain in its current state. IE, the request, if unsuccessful, should not leave the Device in an indeterminate state. When bringing a Device back "Online", from an "Offline" mode, the Device should be restored to its last "Online" state, if at all possible. Only a Device that has an EnabledState/StatusInfo of "Enabled" and has been configured can be brought online or taken offline. OnlineDevice should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, 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. Note that this method's function overlaps with the RequestedState property. RequestedState was added to the model to maintain a record (i.e., a persisted value) of the last state request. Invoking the OnlineDevice method should set the RequestedState property appropriately.
QuiesceDevice method CIM_LogicalDevice
Deprecated CIM_EnabledLogicalElement.RequestStateChange
Description The QuiesceDevice method has been deprecated in lieu of the more general RequestStateChange method that directly overlaps with the functionality provided by this method. Requests that the LogicalDevice cleanly cease all current activity ("Quiesce" input parameter = TRUE) or resume activity (= FALSE). For this method to quiesce a Device, that Device should have an Availability (or Additional Availability) of "Running/Full Power" (value=3) and an EnabledStatus/StatusInfo of "Enabled". For example, if quiesced, a Device may then be offlined for diagnostics, or disabled for power off and hot swap. For the method to "unquiesce" a Device, that Device should have an Availability (or AdditionalAvailability) of "Quiesced" (value=21) and an EnabledStatus/StatusInfo of "Enabled". In this case, the Device would be returned to an "Enabled" and "Running/Full Power" status. The method's return code should indicate the success or failure of the quiesce. It should return 0 if successful, 1 if the request is not supported at all, 2 if the request is not supported due to the current state of the Device, 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.
SaveProperties method CIM_LogicalDevice
Description Requests that the Device capture its current configuration, setup and/or state information in a backing store. The goal would be to use this information at a later time (via the RestoreProperties method), to return a Device to its present "condition". This method may not be supported by all Devices. The method should return 0 if successful, 1 if the 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.
RestoreProperties method CIM_LogicalDevice
Description Requests that the Device re-establish its configuration, setup and/or state information from a backing store. The intent is to capture this information at an earlier time (via the SaveProperties method), and use it to return a Device to this earlier "condition". This method may not be supported by all Devices. The method should return 0 if successful, 1 if the 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.
Speed uint64 CIM_LogicalPort
Description The bandwidth of the Port in Bits per Second.
Units Bits per Second
PUnit bit / second
MaxSpeed uint64 CIM_LogicalPort
Description The maximum bandwidth of the Port in Bits per Second.
Units Bits per Second
PUnit bit / second
RequestedSpeed uint64 CIM_LogicalPort
Write TRUE
Description The requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.
Units Bits per Second
ModelCorrespondence CIM_LogicalPort.Speed
PUnit bit / second
UsageRestriction uint16 CIM_LogicalPort
Description In some circumstances, a LogicalPort might be identifiable as a front end or back end port. An example of this situation would be a storage array that might have back end ports to communicate with disk drives and front end ports to communicate with hosts. If there is no restriction on the use of the port, then the value should be set to 'not restricted'.
ValueMap 0, 2, 3, 4
Values "Unknown" [0]
"Front-end only" [2]
"Back-end only" [3]
"Not restricted" [4]
PortType uint16 CIM_LogicalPort
Description PortType is defined to force consistent naming of the 'type' property in subclasses and to guarantee unique enum values for all instances of NetworkPort. When set to 1 ("Other"), related property OtherPortType contains a string description of the type of port. A range of values, DMTF_Reserved, has been defined that allows subclasses to override and define their specific types of ports.
ValueMap 0, 1, 2, 3..15999, 16000..65535
Values "Unknown" [0]
"Other" [1]
"Not Applicable" [2]
"DMTF Reserved" [3..15999]
"Vendor Reserved" [16000..65535]
ModelCorrespondence CIM_NetworkPort.OtherNetworkPortType
OtherPortType string CIM_LogicalPort
Description Describes the type of module, when PortType is set to 1 ("Other").
ModelCorrespondence CIM_LogicalPort.PortType

Direct Subclasses:

CIM_NetworkPort, CIM_USBPort, CIM_FibrePort

Typographical Conventions:

  1. Inherited properties are italicized.
  2. Local properties are bolded.
  3. Key properties are highlighted in gold

Generated by mof2html v.2.1.0(002). simplewbem.org Mon Nov 2 09:43:14 2009