CIM_EthernetPort class
Capabilities and management of an EthernetPort.
The following syntax is simplified from Managed Object Format (MOF) code and includes all of the inherited properties.
Syntax
[Abstract, Version("2.10.0"), UMLPackagePath("CIM::Device::Ports")]
class CIM_EthernetPort : CIM_NetworkPort
{
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;
uint64 MaxSpeed;
uint64 RequestedSpeed;
uint16 UsageRestriction;
string OtherPortType;
uint64 Speed;
string OtherNetworkPortType;
uint16 PortNumber;
uint16 LinkTechnology;
string OtherLinkTechnology;
string PermanentAddress;
boolean FullDuplex;
boolean AutoSense;
uint64 SupportedMaximumTransmissionUnit;
uint64 ActiveMaximumTransmissionUnit;
uint16 PortType;
string NetworkAddresses[];
uint32 MaxDataSize;
uint16 Capabilities[];
string CapabilityDescriptions[];
uint16 EnabledCapabilities[];
string OtherEnabledCapabilities[];
};
Members
The CIM_EthernetPort class has these types of members:
Methods
The CIM_EthernetPort class has these methods.
| Method | Description |
|---|---|
| EnableDevice | 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. This method is inherited from CIM_LogicalDevice. |
| OnlineDevice | 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. This method is inherited from CIM_LogicalDevice. |
| QuiesceDevice | 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. This method is inherited from CIM_LogicalDevice. |
| RequestStateChange | 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. If 0 is returned, then the task completed successfully and the use of ConcreteJob was not required. If 4096 (0x1000) is returned, then the task will take some time to complete, ConcreteJob will be created, and its reference returned in the output parameter Job. Any other return code indicates an error condition. This method is inherited from CIM_EnabledLogicalElement. |
| Reset | 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. This method is inherited from CIM_LogicalDevice. |
| RestoreProperties | 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. This method is inherited from CIM_LogicalDevice. |
| SaveProperties | 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. This method is inherited from CIM_LogicalDevice. |
| SetPowerState | 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. This method is inherited from CIM_LogicalDevice. |
Properties
The CIM_EthernetPort class has these properties.
-
ActiveMaximumTransmissionUnit
-
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Punit ("byte"), Units ("Bytes")
The active or negotiated maximum transmission unit (MTU) that can be supported.
This property is inherited from CIM_NetworkPort.
-
-
AdditionalAvailability
-
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalDevice.Availability")
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").
This property is inherited from CIM_LogicalDevice.
-
-
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)
AutoSense
-
Data type: boolean
-
Access type: Read-only
A Boolean that indicates whether the NetworkPort is capable of automatically determining the speed or other communications characteristics of the attached network media.
This property is inherited from CIM_NetworkPort.
Availability
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIF.DMTF|Operational State|006.5", "MIB.IETF|HOST-RESOURCES-MIB.hrDeviceStatus", "MIF.DMTF|Host Device|001.5"), ModelCorrespondence ("CIM_LogicalDevice.AdditionalAvailability")
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.
This property is inherited from CIM_LogicalDevice.
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)
Capabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.CapabilityDescriptions")
Capabilities of the EthernetPort. For example, the Device might support AlertOnLan, WakeOnLan, Load Balancing, or FailOver. If failover or load balancing capabilities are listed, a SpareGroup (failover) or ExtraCapacityGroup (load balancing) should also be defined to completely describe the capability.
Unknown (0)
Other (1)
AlertOnLan (2)
WakeOnLan (3)
FailOver (4)
LoadBalancing (5)
CapabilityDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.Capabilities")
An array of free-form strings that provides more detailed explanations for any of the EthernetPort features that are indicated in the Capabilities array. Note, each entry of this array is related to the entry in the Capabilities array that is located at the same index.
Caption
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64)
The Caption property is a short textual description (one- line string) of the object.
This property is inherited from CIM_ManagedElement.
CreationClassName
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.
This property is inherited from CIM_LogicalDevice.
Description
-
Data type: string
-
Access type: Read-only
Contains a textual description of the object.
This property is inherited from CIM_ManagedElement.
DeviceID
An address or other identifying information to uniquely name the LogicalDevice.
This property is inherited from CIM_LogicalDevice.
ElementName
-
Data type: string
-
Access type: Read-only
Contains 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.
EnabledCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.Capabilities", "CIM_EthernetPort.OtherEnabledCapabilities")
Specifies which capabilities are enabled from the list of all supported ones, which are defined in the Capabilities array.
Unknown (0)
Other (1)
AlertOnLan (2)
WakeOnLan (3)
FailOver (4)
LoadBalancing (5)
EnabledDefault
-
Data type: uint16
-
Access type: Read/write
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).
This property is inherited from CIM_EnabledLogicalElement.
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")
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.
This property is inherited from CIM_EnabledLogicalElement.
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
Vendor Reserved
ErrorCleared
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus")
ErrorCleared is a boolean property indicating that the error reported in LastErrorCode is now cleared.
This property is inherited from CIM_LogicalDevice.
ErrorDescription
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_DeviceErrorData.ErrorDescription")
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.
This property is inherited from CIM_LogicalDevice.
FullDuplex
-
Data type: boolean
-
Access type: Read-only
Boolean that indicates that the port is operating in full duplex mode.
This property is inherited from CIM_NetworkPort.
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 that of its sub-components.
This property is inherited from CIM_ManagedSystemElement.
The following values have been defined:
Unknown (0)
The implementation cannot report on HealthState at this time.
OK (5)
The element is fully functional and is operating within normal operational parameters and without error.
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
Minor failure (15)
All functionality is available but some 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 not working.
Critical failure (25)
The element is non-functional and recovery might not be possible.
Non-recoverable error (30)
The element has completely failed, and recovery is not possible. All functionality provided by this element has been lost.
DMTF Reserved
DMTF has reserved the unused portion of the continuum for additional HealthStates in the future.
IdentifyingDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_LogicalDevice.OtherIdentifyingInfo")
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.
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")
LastErrorCode captures the last error code reported by the LogicalDevice.
This property is inherited from CIM_LogicalDevice.
LinkTechnology
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.OtherLinkTechnology")
An enumeration of the types of links. When set to 1 ("Other"), the related property OtherLinkTechnology contains a string description of the type of link.
This property is inherited from CIM_NetworkPort.
Unknown (0)
Other (1)
Ethernet (2)
IB (3)
FC (4)
FDDI (5)
ATM (6)
Token Ring (7)
Frame Relay (8)
Infrared (9)
BlueTooth (10)
Wireless LAN (11)
MaxDataSize
-
Data type: uint32
-
Access type: Read-only
-
Qualifiers: MappingStrings ("MIB.IETF|BRIDGE-MIB.dot1dTpPortMaxInfo")
The maximum size of the INFO (non-MAC) field that will be received or transmitted.
MaxQuiesceTime
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Deprecated ("No value"), Units ("MilliSeconds")
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.
This property is inherited from CIM_LogicalDevice.
MaxSpeed
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Punit ("bit / second"), Units ("Bits per Second")
The maximum bandwidth of the Port in Bits per Second.
This property is inherited from CIM_LogicalPort.
Name
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (1024)
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.
This property is inherited from CIM_ManagedSystemElement.
NetworkAddresses
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: Override ("NetworkAddresses")
Ethernet/802.3 MAC addresses formatted as twelve hexadecimal digits (for example, "010203040506"), with each pair representing one of the six octets of the MAC address in "canonical" bit order. (Therefore, the Group address bit is found in the low order bit of the first character of the string.)
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 OperationalStatus should contain the primary status for the element.
Note
OperationalStatus replaces the deprecated Status property. Due to the widespread use of the existing Status property in management applications, Microsoft strongly recommends that providers or instrumentation provide both the Status and OperationalStatus properties. When instrumented, Status (because it is single-valued) should also provide the primary status of the element.
This property is inherited from CIM_ManagedSystemElement.
The following values have been defined:
Unknown (0)
Indicates the implementation cannot report on OperationalStatus at this time.
Other (1)
Indicates an undefined state.
OK (2)
Indicates full functionality without errors.
Degraded (3)
Indicates the element is working 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
Stressed (4)
Indicates that the element is functioning, but needs attention. Overload and overheated are examples of Stressed states.
Predictive Failure (5)
Indicates that an element is functioning nominally but predicting a failure in the near future.
Error (6)
Indicates that an error has occurred.
Non-Recoverable Error (7)
A non-recoverable error has occurred.
Starting (8)
The job is starting.
Stopping (9)
The job is stopping.
Stopped (10)
The element has been intentionally stopped.
In Service (11)
Indicates the element is being configured, maintained, cleaned, or otherwise administered.
No Contact (12)
Indicates that the monitoring system has knowledge of this element, but has never been able to establish communications with it.
Lost Communication (13)
Indicates that the job is known to exist and has been contacted successfully in the past, but is currently unreachable.
Aborted (14)
Indicates the job stopped in an unexpected way. The state and configuration of the job might need to be updated.
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 may be OK but is unable to 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, ErrorError, 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 (18)
"Power Mode" indicates that the element has additional power model information contained in the associated PowerManagementService association.
DMTF Reserved
DMTF has reserved this portion of the range for additional OperationalStatus values in the future.
Vendor Reserved
Microsoft has reserved the unused portion of the range for additional OperationalStatus values in the future.
OtherEnabledCapabilities
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_EthernetPort.EnabledCapabilities")
An array of free-form strings that provides more detailed explanations for any of the enabled capabilities that are specified as 'Other'.
OtherEnabledState
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
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.
This property is inherited from CIM_EnabledLogicalElement.
OtherIdentifyingInfo
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), MaxLen (256), ModelCorrespondence ("CIM_LogicalDevice.IdentifyingDescriptions")
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.
This property is inherited from CIM_LogicalDevice.
OtherLinkTechnology
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_NetworkPort.LinkTechnology")
A string value that describes LinkTechnology when it is set to 1, "Other".
This property is inherited from CIM_NetworkPort.
OtherNetworkPortType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_NetworkPort.OtherPortType"), ModelCorrespondence ("CIM_LogicalPort.PortType")
Note: The use of this property is deprecated in lieu of CIM_LogicalPort.PortType.
Deprecated description: The type of module, when PortType is set to 1 ("Other".)
This property is inherited from CIM_NetworkPort.
OtherPortType
-
Data type: string
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_LogicalPort.PortType")
Describes the type of module, when PortType is set to 1 ("Other").
This property is inherited from CIM_LogicalPort.
PermanentAddress
-
Data type: string
-
Access type: Read-only
-
Qualifiers: MaxLen (64), MappingStrings ("MIF.DMTF|Network Adapter 802 Port|001.2")
PermanentAddress defines the network address that is hardcoded into a port. This 'hardcoded' address can be changed using a firmware upgrade or a software configuration. When this change is made, the field should be updated at the same time. PermanentAddress should be left blank if no 'hardcoded' address exists for the NetworkAdapter.
This property is inherited from CIM_NetworkPort.
PortNumber
-
Data type: uint16
-
Access type: Read-only
NetworkPorts are often numbered relative to either a logical module or a network element.
This property is inherited from CIM_NetworkPort.
PortType
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: Override ("PortType")
The specific mode that is currently enabled for the Port. When set to 1 ("Other"), the related property OtherPortType contains a string description of the type of port.
Unknown (0)
Other (1)
10BaseT (50)
10-100BaseT (51)
100BaseT (52)
1000BaseT (53)
2500BaseT (54)
10GBaseT (55)
10GBase-CX4 (56)
100Base-FX (100)
100Base-SX (101)
1000Base-SX (102)
1000Base-LX (103)
1000Base-CX (104)
10GBase-SR (105)
10GBase-SW (106)
10GBase-LX4 (107)
10GBase-LR (108)
10GBase-LW (109)
10GBase-ER (110)
10GBase-EW (111)
Vendor Reserved
PowerManagementCapabilities
-
Data type: uint16 array
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities.PowerCapabilities")
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.
This property is inherited from CIM_LogicalDevice.
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)
PowerManagementSupported
-
Data type: boolean
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_PowerManagementCapabilities")
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 relationship) indicates that power management is supported.
This property is inherited from CIM_LogicalDevice.
PowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Units ("Hours"), Counter
The number of consecutive hours that this Device has been powered, since its last power cycle.
This property is inherited from CIM_LogicalDevice.
RequestedSpeed
-
Data type: uint64
-
Access type: Read/write
-
Qualifiers: Punit ("bit / second"), Units ("Bits per Second"), ModelCorrespondence ("CIM_LogicalPort.Speed")
The requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.
This property is inherited from CIM_LogicalPort.
RequestedState
-
Data type: uint16
-
Access type: Read-only
-
Qualifiers: ModelCorrespondence ("CIM_EnabledLogicalElement.EnabledState")
RequestedState is an integer enumeration that indicates the last requested or desired state for the element. 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. By default, the RequestedState of the element is 5 ("No Change"). Refer to the EnabledState property description for explanations of the values in the RequestedState enumeration. 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. A particular instance of EnabledLogicalElement might not support RequestedStateChange. If this occurs, the value 12 ("Not Applicable") is used.
This property is inherited from CIM_EnabledLogicalElement.
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
Speed
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Punit ("bit / second"), Units ("Bits per Second"), MappingStrings ("MIB.IETF|MIB-II.ifSpeed", "MIF.DMTF|Network Adapter 802 Port|001.5")
The current bandwidth of the Port in Bits per Second. For ports that vary in bandwidth or for those where no accurate estimation can be made, this property should contain the nominal bandwidth.
This property is inherited from CIM_NetworkPort.
Status
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Deprecated ("CIM_ManagedSystemElement.OperationalStatus"), MaxLen (10)
Contains a string indicating the primary status of the object.
Note
This property is deprecated and 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.
("OK")
("Error")
("Degraded")
("Unknown")
("Pred Fail")
("Starting")
("Stopping")
("Service")
("Stressed")
("NonRecover")
("No Contact")
("Lost Comm")
("Stopped")
StatusDescriptions
-
Data type: string array
-
Access type: Read-only
-
Qualifiers: ArrayType ("Indexed"), ModelCorrespondence ("CIM_ManagedSystemElement.OperationalStatus")
Contains strings describing the corresponding values in the OperationalStatus array. For example, if an element in OperationalStatus contains the value Stopping, then the element at the same array index in this property may 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")
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
This property is inherited from CIM_LogicalDevice.
Other (1)
Unknown (2)
Enabled (3)
Disabled (4)
Not Applicable (5)
SupportedMaximumTransmissionUnit
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Punit ("byte"), Units ("Bytes")
The maximum transmission unit (MTU) that can be supported.
This property is inherited from CIM_NetworkPort.
SystemCreationClassName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.CreationClassName"), MaxLen (256)
The scoping System's CreationClassName.
This property is inherited from CIM_LogicalDevice.
SystemName
-
Data type: string
-
Access type: Read-only
-
Qualifiers: Key, Propagated ("CIM_System.Name"), MaxLen (256)
The scoping System's Name.
This property is inherited from CIM_LogicalDevice.
TimeOfLastStateChange
-
Data type: datetime
-
Access type: Read-only
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.
This property is inherited from CIM_EnabledLogicalElement.
TotalPowerOnHours
-
Data type: uint64
-
Access type: Read-only
-
Qualifiers: Units ("Hours"), Counter
The total number of hours that this Device has been powered.
This property is inherited from CIM_LogicalDevice.
UsageRestriction
-
Data type: uint16
-
Access type: Read-only
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'.
This property is inherited from CIM_LogicalPort.
Unknown (0)
Front-end only (2)
Back-end only (3)
Not restricted (4)
Requirements
| Minimum supported client |
None supported |
| Minimum supported server |
Windows Server 2012 R2 |
| Namespace |
Root\CIMv2\Storage\iScsiTarget |
| MOF |
|
| DLL |
|