Class CIM_FibrePort
extends CIM_LogicalPort

Note: The use of the FibrePort class is deprecated because FibreChannel Adapter has been deprecated in lieu of FCPort and this class overlaps with FCPort. The new FCPort class should be used in lieu of both FibreChannelAdapter and FibrePort. Deprecated description: FibrePort describes the capabilities and management aspects of a Fibre Channel Port Device.

Class Hierarchy

CIM_ManagedElement
   |
   +--CIM_ManagedSystemElement
   |
   +--CIM_LogicalElement
   |
   +--CIM_EnabledLogicalElement
   |
   +--CIM_LogicalDevice
   |
   +--CIM_LogicalPort
   |
   +--CIM_FibrePort

Direct Known Subclasses

None.

Class Qualifiers

NameData TypeValueScopeFlavors
DeprecatedstringCIM_FCPortTOSUBCLASS= falseNone
DescriptionstringNote: The use of the FibrePort class is deprecated because FibreChannel Adapter has been deprecated in lieu of FCPort and this class overlaps with FCPort. The new FCPort class should be used in lieu of both FibreChannelAdapter and FibrePort. Deprecated description: FibrePort describes the capabilities and management aspects of a Fibre Channel Port Device.None TRANSLATABLE= true
UMLPackagePathstringCIM::Device::NetworkAdapterNone None
Versionstring2.10.0TOSUBCLASS= falseTRANSLATABLE= true

Local Class Properties

NameData TypeQualifiers
NameData TypeValueScopeFlavors
AdditionalAvailabilityuint16
DescriptionstringAdditional availability and status of the Device in addition to that specified in the Availability property. The Availability property denotes the primary status and availability of the Device. In some cases, this property 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, the primary Availability of a device might be "Off line" (value=8) or in a low-power state (AdditionalAvailability value=14), or the Device could be running Diagnostics (AdditionalAvailability value=5, "In Test").None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalDevice.AvailabilityNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringOther, 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, QuiescedNone TRANSLATABLE= true
AddressIdentifieruint32
DeprecatedstringCIM_FCPort.PermanentAddressTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: An address value that is used to identify the source (S_ID) or destination (D_ID) of a frame. The FC-SW standard includes a table of special address identifier values and their meanings. Consult the FC-SW documentation for additional information.None TRANSLATABLE= true
AliasAddressesuint32
DeprecatedstringCIM_FCPort.NetworkAddressesTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: One or more address identifiers that can be recognized by the Port, in addition to its port-specific identifier. Multicast or hunt group addresses that are recognized by the Port would be identified in this array.None TRANSLATABLE= true
Availabilityuint16
DeprecatedstringCIM_AssociatedPowerManagementService.PowerState, CIM_ManagedSystemElement.OperationalStatus, CIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Deprecated 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). The Power Save states 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; value 14 ("Power Save - Low Power Mode") indicates that the Device is in a power save state but still functioning, and might exhibit degraded performance; value 15 ("Power Save - Standby") indicates 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, but is also in a power save mode.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Operational State|006.5, MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus, MIF.DMTF|Host Device|001.5None None
ModelCorrespondencestringCIM_LogicalDevice.AdditionalAvailabilityNone None
ValueMapstring1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21None None
ValuesstringOther, 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, QuiescedNone TRANSLATABLE= true
AvailableRequestedStatesuint16
DescriptionstringAvailableRequestedStates indicates the possible values for the RequestedState parameter of the method RequestStateChange, used to initiate a state change. The values listed shall be a subset of the values contained in the RequestedStatesSupported property of the associated instance of CIM_EnabledLogicalElementCapabilities where the values selected are a function of the current state of the CIM_EnabledLogicalElement. This property may be non-null if an implementation is able to advertise the set of possible values as a function of the current state. This property shall be null if an implementation is unable to determine the set of possible values as a function of the current state.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElementCapabilities.RequestedStatesSupportedNone None
ValueMapstring2, 3, 4, 6, 7, 8, 9, 10, 11None None
ValuesstringEnabled, Disabled, Shut Down, Offline, Test, Defer, Quiesce, Reboot, ResetNone TRANSLATABLE= true
BypassedStateuint16
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Indication of whether the Port is currently bypassed (value=2) or not (value=1). A value of 3 ("Forced Insert") describes that the Port is forced active, when it would otherwise be "Bypassed".None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3None None
ValuesstringUnknown, Not Bypassed, Bypassed, Forced InsertNone TRANSLATABLE= true
Captionstring
DescriptionstringThe Caption property is a short textual description (one- line string) of the object.None TRANSLATABLE= true
MaxLenuint3264None None
CommunicationStatusuint16
DescriptionstringCommunicationStatus indicates the ability of the instrumentation to communicate with the underlying ManagedElement. CommunicationStatus consists of one of the following values: Unknown, None, Communication OK, Lost Communication, or No Contact. A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Communication OK " indicates communication is established with the element, but does not convey any quality of service. "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 Managed Element is known to exist and has been contacted successfully in the past, but is currently unreachable.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ValueMapstring0, 1, 2, 3, 4, .., 0x8000..None None
ValuesstringUnknown, Not Available, Communication OK, Lost Communication, No Contact, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
ConnectedMediauint16
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The type of cabling as sensed by the Port. Not all Fibre Ports are capable of providing this information. In this case, a value of 0, "Unknown", will be returned. Also, when single or multi-mode fiber cabling cannot be distinguished, the more general value 4, "Fiber-optic" can be specified.None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3, 4, 5, 6None None
ValuesstringUnknown, Other, No Media, Copper/Twinaxial, Fiber-optic, Fiber Single Mode, Fiber MultimodeNone TRANSLATABLE= true
CRCErrorsuint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.CRCErrorsTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Number of times that the CRC in a frame does not match the CRC computed by the receiver.None TRANSLATABLE= true
CreationClassNamestring
DescriptionstringCreationClassName 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.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
CurrentPortTypeuint16
DeprecatedstringCIM_FCPort.PortTypeTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The specific mode in which the Port is currently running. The value is one of the entries in the EnabledPortTypes array. The current port type or mode is dependent on the fibre technology. For example, in a public loop network, you might indicate a port type of "FL" (value=6) or "NL" (value=2).None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.EnabledPortTypes, CIM_FibrePort.CurrentVersionNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, N, NL-Private, NL-Public, E, F, FL, BNone TRANSLATABLE= true
CurrentVersionstring
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Version information for the CurrentPortType that is active.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.CurrentPortTypeNone None
Descriptionstring
DescriptionstringThe Description property provides a textual description of the object.None TRANSLATABLE= true
DetailedStatusuint16
DescriptionstringDetailedStatus compliments PrimaryStatus with additional status detail. It consists of one of the following values: Not Available, No Additional Information, Stressed, Predictive Failure, Error, Non-Recoverable Error, SupportingEntityInError. Detailed status is used to expand upon the PrimaryStatus of the element. A Null return indicates the implementation (provider) does not implement this property. "Not Available" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "No Additional Information" indicates that the element is functioning normally as indicated by PrimaryStatus = "OK". "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 normally but a failure is predicted in the near future. "Non-Recoverable Error " indicates that this element is in an error condition that requires human intervention. "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.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.PrimaryStatus, CIM_ManagedSystemElement.HealthStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, .., 0x8000..None None
ValuesstringNot Available, No Additional Information, Stressed, Predictive Failure, Non-Recoverable Error, Supporting Entity in Error, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
DeviceIDstring
DescriptionstringAn address or other identifying information used to uniquely name the LogicalDevice.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint3264None None
ElasticityBufferOverrunsuint64
CounterbooleantrueNone None
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The number of times that a fill word could not be deleted, when required. The Elasticity Buffer is defined in FC-AL. This event might cause data corruption and might indicate a configuration error or a device out of spec.None TRANSLATABLE= true
ElasticityBufferUnderrunsuint64
CounterbooleantrueNone None
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The number of times that a fill word could not be inserted, when required. The Elasticity Buffer is defined in FC-AL. This event might cause data corruption and might indicate a configuration error or that a device is out of spec.None TRANSLATABLE= true
ElementNamestring
DescriptionstringA 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.None TRANSLATABLE= true
EnabledDefaultuint16
DescriptionstringAn 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).None TRANSLATABLE= true
ValueMapstring2, 3, 5, 6, 7, 9, .., 32768..65535None None
ValuesstringEnabled, Disabled, Not Applicable, Enabled but Offline, No Default, Quiesce, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
WritebooleantrueNone None
EnabledPortTypesuint16
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The specific modes currently enabled for the Port. The values are equal to, or a subset of the values in the Supported PortTypes array.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.SupportedPortTypes, CIM_FibrePort.EnabledVersionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, N, NL-Private, NL-Public, E, F, FL, BNone TRANSLATABLE= true
EnabledStateuint16
DescriptionstringEnabledState 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.OtherEnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11..32767, 32768..65535None None
ValuesstringUnknown, Other, Enabled, Disabled, Shutting Down, Not Applicable, Enabled but Offline, In Test, Deferred, Quiesce, Starting, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
EnabledVersionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Version information for each of the EnabledPortTypes. A particular PortType (mode) might be listed multiple times in the EnabledPortTypes array in order to define multiple, unique version levels. Note, each entry of this array is related to the entry in EnabledPortTypes that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.EnabledPortTypesNone None
ErrorClearedboolean
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: ErrorCleared is a Boolean property that indicates that the error reported in LastErrorCode is now cleared.None TRANSLATABLE= true
ErrorDescriptionstring
DeprecatedstringCIM_DeviceErrorData.ErrorDescriptionTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: ErrorDescription is a free-form string that supplies more information about the error recorded in LastErrorCode and information on any corrective actions that can be taken.None TRANSLATABLE= true
FramesTooLonguint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.FramesTooLongTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The number of frames that were received that were longer than 2140 octets. The value of 2140 is calculated based on an assumption of 24 header bytes plus 4 CRC bytes and 2112 bytes of payload.None TRANSLATABLE= true
FramesTooShortuint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.FramesTooShortTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The number of frames that were received that were shorter than 28 octets. The value of 28 is calculated based on an assumption of 24 header bytes plus 4 CRC bytes. The count does not include SOF/EOF bytes that are not data.None TRANSLATABLE= true
HealthStateuint16
DescriptionstringIndicates 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.None TRANSLATABLE= true
ValueMapstring0, 5, 10, 15, 20, 25, 30, ..None None
ValuesstringUnknown, OK, Degraded/Warning, Minor failure, Major failure, Critical failure, Non-recoverable error, DMTF ReservedNone TRANSLATABLE= true
IdentifyingDescriptionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringAn array of free-form strings providing explanations and details behind the entries in the OtherIdentifyingInfo array. Note that each entry of this array is related to the entry in OtherIdentifyingInfo that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalDevice.OtherIdentifyingInfoNone None
InstallDatedatetime
DescriptionstringA datetime value that indicates when the object was installed. Lack of a value does not indicate that the object is not installed.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|ComponentID|001.5None None
InvalidTransmissionWordsuint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.InvalidTransmissionWordsTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: The number of transmission words that had an 8b10b code violation in one or more of its characters, had a K28.5 in its second, third, or fourth character positions, or was an ordered set that had an incorrect Beginning Running Disparity.None TRANSLATABLE= true
LastErrorCodeuint32
DeprecatedstringCIM_DeviceErrorData.LastErrorCodeTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: LastErrorCode captures the last error code reported by the LogicalDevice.None TRANSLATABLE= true
LocationIndicatoruint16
DescriptionstringAn integer that reflects the state of an indicator (e.g., LED) that is part of a device. Reading the value gives the current state. Writing the value with 'On'/'Off' turns the indicator on/off, other values may not be written.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_AlarmDevice.AlarmState, CIM_AlarmDevice.AudioIndicatorIsDisabled, CIM_AlarmDevice.VisualIndicatorIsDisabled, CIM_AlarmDevice.MotionIndicatorIsDisabledNone None
ValueMapstring0, 2, 3, 4None None
ValuesstringUnknown, On, Off, Not SupportedNone TRANSLATABLE= true
WritebooleantrueNone None
LossOfSignalCounteruint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.LossOfSignalCounterTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Number of times that the signal has been lost on the Port since the last reset of the Device.None TRANSLATABLE= true
LossOfSyncCounteruint64
CounterbooleantrueNone None
DeprecatedstringCIM_FCPortStatistics.LossOfSyncCounterTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Number of times that synchronization has been lost on the Port since the last reset of the Device. Synchronization is assumed lost after a timeout period that is identified by the Receiver TransmitterTimeout property.None TRANSLATABLE= true
MaxQuiesceTimeuint64
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. When evaluating the use of Quiesce, it was determined 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 decision will be re-evaluated and repositioned later. Deprecated description: Maximum time, in milliseconds, that a Device can run in a "Quiesced" state. The 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 can unquiesce, can be offline, or can take other actions. A value of 0 indicates that a Device can remain quiesced indefinitely.None TRANSLATABLE= true
PUnitstringsecond * 10^-3None None
UnitsstringMilliSecondsNone TRANSLATABLE= true
MaxSpeeduint64
DescriptionstringThe maximum bandwidth of the Port in Bits per Second.None TRANSLATABLE= true
PUnitstringbit / secondNone None
UnitsstringBits per SecondNone TRANSLATABLE= true
Namestring
DescriptionstringThe Name property defines the label by which the object is known. When subclassed, the Name property can be overridden to be a Key property.None TRANSLATABLE= true
MaxLenuint321024None None
OperatingStatusuint16
DescriptionstringOperatingStatus provides a current status value for the operational condition of the element and can be used for providing more detail with respect to the value of EnabledState. It can also provide the transitional states when an element is transitioning from one state to another, such as when an element is transitioning between EnabledState and RequestedState, as well as other transitional conditions. OperatingStatus consists of one of the following values: Unknown, Not Available, In Service, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emmigrating, Immigrating, Snapshotting. Shutting Down, In Test A Null return indicates the implementation (provider) does not implement this property. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "None" indicates that the implementation (provider) is capable of returning a value for this property, but not ever for this particular piece of hardware/software or the property is intentionally not used because it adds no meaningful information (as in the case of a property that is intended to add additional info to another property). "Servicing" describes an element being configured, maintained, cleaned, or otherwise administered. "Starting" describes an element being initialized. "Stopping" describes an element being brought to an orderly stop. "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. "Completed" indicates that the element has completed its operation. This value should be combined with either OK, Error, or Degraded in the PrimaryStatus 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). "Migrating" element is being moved between host elements. "Immigrating" element is being moved to new host element. "Emigrating" element is being moved away from host element. "Shutting Down" describes an element being brought to an abrupt stop. "In Test" element is performing test functions. "Transitioning" describes an element that is between states, that is, it is not fully available in either its previous state or its next state. This value should be used if other values indicating a transition to a specific state are not applicable. "In Service" describes an element that is in service and operational.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, .., 0x8000..None None
ValuesstringUnknown, Not Available, Servicing, Starting, Stopping, Stopped, Aborted, Dormant, Completed, Migrating, Emigrating, Immigrating, Snapshotting, Shutting Down, In Test, Transitioning, In Service, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
OperationalStatusuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringIndicates 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.StatusDescriptionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, .., 0x8000..None None
ValuesstringUnknown, Other, OK, Degraded, Stressed, Predictive Failure, Error, Non-Recoverable Error, Starting, Stopping, Stopped, In Service, No Contact, Lost Communication, Aborted, Dormant, Supporting Entity in Error, Completed, Power Mode, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
OtherEnabledStatestring
DescriptionstringA 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
OtherIdentifyingInfostring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringOtherIdentifyingInfo captures data, in addition to DeviceID information, that could be used to identify a LogicalDevice. For example, you could use this property to hold the operating system's user-friendly name for the Device.None TRANSLATABLE= true
MaxLenuint32256None None
ModelCorrespondencestringCIM_LogicalDevice.IdentifyingDescriptionsNone None
OtherPortTypestring
DescriptionstringDescribes the type of module, when PortType is set to 1 ("Other").None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalPort.PortTypeNone None
PortTypeuint16
DescriptionstringPortType 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_NetworkPort.OtherNetworkPortTypeNone None
ValueMapstring0, 1, 2, 3..15999, 16000..65535None None
ValuesstringUnknown, Other, Not Applicable, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
PortTypeVersionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Version information for each of the SupportedPortTypes. A particular PortType (mode) can be listed multiple times in the SupportedPortTypes array in order to define multiple, unique version levels. Note, each entry of this array is related to the entry in SupportedPortTypes that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.SupportedPortTypesNone None
PowerManagementCapabilitiesuint16
DeprecatedstringCIM_PowerManagementCapabilities.PowerCapabilitiesTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Instead, use the PowerCapabilites property in an associated PowerManagementCapabilities class. Deprecated description: An enumerated array describing the power management capabilities of the Device.None TRANSLATABLE= true
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, Not Supported, Disabled, Enabled, Power Saving Modes Entered Automatically, Power State Settable, Power Cycling Supported, Timed Power On SupportedNone TRANSLATABLE= true
PowerManagementSupportedboolean
DeprecatedstringCIM_PowerManagementCapabilitiesTOSUBCLASS= falseNone
DescriptionstringNote: The use of this property has been deprecated. Instead, the existence of an associated PowerManagementCapabilities class (associated using the ElementCapabilities relationship) indicates that power management is supported. Deprecated description: Boolean that indicates that the Device can use power management.None TRANSLATABLE= true
PowerOnHoursuint64
CounterbooleantrueNone None
DeprecatedstringCIM_PoweredStatisticalData.PowerOnHoursTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: The number of consecutive hours that this Device has been powered on since its last power cycle.None TRANSLATABLE= true
PUnitstringhourNone None
UnitsstringHoursNone TRANSLATABLE= true
PrimaryStatusuint16
DescriptionstringPrimaryStatus provides a high level status value, intended to align with Red-Yellow-Green type representation of status. It should be used in conjunction with DetailedStatus to provide high level and detailed health status of the ManagedElement and its subcomponents. PrimaryStatus consists of one of the following values: Unknown, OK, Degraded or Error. "Unknown" indicates the implementation is in general capable of returning this property, but is unable to do so at this time. "OK" indicates the ManagedElement is functioning normally. "Degraded" indicates the ManagedElement is functioning below normal. "Error" indicates the ManagedElement is in an Error condition.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_ManagedSystemElement.DetailedStatus, CIM_ManagedSystemElement.HealthStateNone None
ValueMapstring0, 1, 2, 3, .., 0x8000..None None
ValuesstringUnknown, OK, Degraded, Error, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
ReceiverTransmitterTimeoutuint64
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: Timeout value in milliseconds that is used to determine when loss of synchronization has occurred. The typical default is 100 msec.None TRANSLATABLE= true
PUnitstringsecond * 10^-3None None
UnitsstringMillisecondsNone TRANSLATABLE= true
RequestedSpeeduint64
DescriptionstringThe requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.None TRANSLATABLE= true
ModelCorrespondencestringCIM_LogicalPort.SpeedNone None
PUnitstringbit / secondNone None
UnitsstringBits per SecondNone TRANSLATABLE= true
WritebooleantrueNone None
RequestedStateuint16
DescriptionstringRequestedState 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".None TRANSLATABLE= true
ModelCorrespondencestringCIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, .., 32768..65535None None
ValuesstringUnknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Deferred, Quiesce, Reboot, Reset, Not Applicable, DMTF Reserved, Vendor ReservedNone TRANSLATABLE= true
Speeduint64
DescriptionstringThe bandwidth of the Port in Bits per Second.None TRANSLATABLE= true
PUnitstringbit / secondNone None
UnitsstringBits per SecondNone TRANSLATABLE= true
Statusstring
DeprecatedstringCIM_ManagedSystemElement.OperationalStatusTOSUBCLASS= falseNone
DescriptionstringA 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.None TRANSLATABLE= true
MaxLenuint3210None None
ValueMapstringOK, Error, Degraded, Unknown, Pred Fail, Starting, Stopping, Service, Stressed, NonRecover, No Contact, Lost Comm, StoppedNone None
StatusDescriptionsstring
ArrayTypestringIndexedNone OVERRIDABLE= false
DescriptionstringStrings 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.None TRANSLATABLE= true
ModelCorrespondencestringCIM_ManagedSystemElement.OperationalStatusNone None
StatusInfouint16
DeprecatedstringCIM_EnabledLogicalElement.EnabledStateTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated in lieu of a more clearly named property (EnabledState) that is inherited from ManagedSystemElement and that has additional enumerated values. Deprecated description: The StatusInfo property indicates whether the Logical Device is in an enabled state (value=3), disabled state (value=4), some other state (value=1), or an unknown state (value=2). If this property does not apply to the LogicalDevice, the value 5 ("Not Applicable") should be used. If a Device is ("Enabled")(value=3), it has been powered up and is configured and operational. The Device might or might not be functionally active, depending on whether its Availability (or AdditionalAvailability) indicates that it is ("Running/Full Power")(value=3) or ("Off line") (value=8). In an enabled but offline mode, a Device might be performing out-of-band requests, such as running Diagnostics. If StatusInfo is ("Disabled") (value=4), a Device can only be "enabled" or powered off. In a personal computer environment, ("Disabled") means that the driver of the device 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 it cannot be communicated with until a driver is loaded, a configuration file is loaded, or some other "enabling" activity has occurred.None TRANSLATABLE= true
MappingStringsstringMIF.DMTF|Operational State|006.4None None
ValueMapstring1, 2, 3, 4, 5None None
ValuesstringOther, Unknown, Enabled, Disabled, Not ApplicableNone TRANSLATABLE= true
SupportedPortTypesuint16
ArrayTypestringIndexedNone OVERRIDABLE= false
DeprecatedstringNo valueTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method has been deprecated. Deprecated description: An array that indicates the modes in which the Port can operate. PortType values describe the role and behavior of the Fibre Channel entity: "N" = Node Port, "NL" = Node Port supporting FC arbitrated loop, "E" = Expansion Port connecting fabric elements (for example, FC switches), "F"=Fabric (element) Port, "FL"=Fabric (element) Port supporting FC arbitrated loop, and "B"=Bridge Port. PortTypes are defined in the ANSI X3 standards. A particular mode can be listed multiple times in the SupportedPortTypes array in order to define that multiple, unique version levels are supported. Version information is defined in the PortTypeVersions property. Note, each entry of the SupportedPortTypes array is related to the entry in PortTypeVersions that is located at the same index.None TRANSLATABLE= true
ModelCorrespondencestringCIM_FibrePort.PortTypeVersionsNone None
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7None None
ValuesstringUnknown, N, NL-Private, NL-Public, E, F, FL, BNone TRANSLATABLE= true
SystemCreationClassNamestring
DescriptionstringThe CreationClassName of the scoping system.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.CreationClassNameNone OVERRIDABLE= false
SystemNamestring
DescriptionstringThe System Name of the scoping system.None TRANSLATABLE= true
KeybooleantrueNone OVERRIDABLE= false
MaxLenuint32256None None
PropagatedstringCIM_System.NameNone OVERRIDABLE= false
TimeOfLastStateChangedatetime
DescriptionstringThe 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.None TRANSLATABLE= true
TotalPowerOnHoursuint64
CounterbooleantrueNone None
DeprecatedstringCIM_PoweredStatisticalData.TotalPowerOnHoursTOSUBCLASS= falseNone
DescriptionstringNote: The use of this method is deprecated. Deprecated description: The total number of hours that this Device has been powered on.None TRANSLATABLE= true
PUnitstringhourNone None
UnitsstringHoursNone TRANSLATABLE= true
TransitioningToStateuint16
DescriptionstringTransitioningToState indicates the target state to which the instance is transitioning. A value of 5 "No Change" shall indicate that no transition is in progress.A value of 12 "Not Applicable" shall indicate the implementation does not support representing ongoing transitions. A value other than 5 or 12 shall identify the state to which the element is in the process of transitioning.None TRANSLATABLE= true
ExperimentalbooleantrueTOSUBCLASS= falseNone
ModelCorrespondencestringCIM_EnabledLogicalElement.RequestStateChange, CIM_EnabledLogicalElement.RequestedState, CIM_EnabledLogicalElement.EnabledStateNone None
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12None None
ValuesstringUnknown, Enabled, Disabled, Shut Down, No Change, Offline, Test, Defer, Quiesce, Reboot, Reset, Not ApplicableNone TRANSLATABLE= true
UsageRestrictionuint16
DescriptionstringIn 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'.None TRANSLATABLE= true
ValueMapstring0, 2, 3, 4None None
ValuesstringUnknown, Front-end only, Back-end only, Not restrictedNone TRANSLATABLE= true

Copyright 2004-2008 VMware, Inc. All rights reserved.