# Class CIM_LogicalPort
extends CIM_LogicalDevice

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.

### Table of Contents
Hierarchy
Direct Known Subclasses
Class Qualifiers
Class Properties
Class Methods

## Class Hierarchy

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

## Direct Known Subclasses

CIM_ATAPort
CIM_FibrePort
CIM_NetworkPort
CIM_PCIPort
CIM_USBPort

## Class Qualifiers

Name | Data Type | Value
--- | --- | ---
Description | string | 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.
UMLPackagePath | string | CIM::Device::Ports
Version | string | 2.10.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
MaxSpeed | uint64 |
Description | string | The maximum bandwidth of the Port in Bits per Second.
PUnit | string | bit / second
Units | string | Bits per Second
OtherPortType | string |
Description | string | Describes the type of module, when PortType is set to 1 ("Other").
ModelCorrespondence | string | CIM_LogicalPort.PortType
PortType | uint16 |
Description | string | 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.
ModelCorrespondence | string | CIM_NetworkPort.OtherNetworkPortType
ValueMap | string | 0, 1, 2, 3..15999, 16000..65535
Values | string | Unknown, Other, Not Applicable, DMTF Reserved, Vendor Reserved
RequestedSpeed | uint64 |
Description | string | The requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.
ModelCorrespondence | string | CIM_LogicalPort.Speed
PUnit | string | bit / second
Units | string | Bits per Second
Write | boolean | true
Speed | uint64 |
Description | string | The bandwidth of the Port in Bits per Second.
PUnit | string | bit / second
Units | string | Bits per Second
UsageRestriction | uint16 |
Description | string | 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 | string | 0, 2, 3, 4
Values | string | Unknown, Front-end only, Back-end only, Not restricted

### Inherited Properties

Name | Data Type
--- | ---
AllocationState | string
Availability | uint16
Caption | string
CommunicationStatus | uint16
CreationClassName | string
Description | string
DetailedStatus | uint16
DeviceID | string
ElementName | string
EnabledDefault | uint16
EnabledState | uint16
ErrorCleared | boolean
ErrorDescription | string
Generation | uint64
HealthState | uint16
InstallDate | datetime
InstanceID | string
LastErrorCode | uint32
LocationIndicator | uint16
MaxQuiesceTime | uint64
Name | string
OperatingStatus | uint16
OtherEnabledState | string
PowerManagementSupported | boolean
PowerOnHours | uint64
PrimaryStatus | uint16
RequestedState | uint16
Status | string
StatusInfo | uint16
SystemCreationClassName | string
SystemName | string
TimeOfLastStateChange | datetime
TotalPowerOnHours | uint64
TransitioningToState | uint16
AdditionalAvailability | uint16[]
AvailableRequestedStates | uint16[]
IdentifyingDescriptions | string[]
OperationalStatus | uint16[]
OtherIdentifyingInfo | string[]
PowerManagementCapabilities | uint16[]
StatusDescriptions | string[]

## Class Methods

### Inherited Class Methods

Name | Return Type
--- | ---
EnableDevice | uint32
OnlineDevice | uint32
QuiesceDevice | uint32
RequestStateChange | uint32
Reset | uint32
RestoreProperties | uint32
SaveProperties | uint32
SetPowerState | uint32