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_LogicalDevice
   |
   +--CIM_LogicalPort

Direct Known Subclasses

CIM_ATAPort
CIM_DAPort
CIM_FibrePort
CIM_NetworkPort
CIM_ParallelPort
CIM_PCIPort
CIM_SerialPort
CIM_SPIPort
CIM_USBPort

Class Qualifiers

NameData TypeValue
DescriptionstringThe 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.
UMLPackagePathstringCIM::Device::Ports
Versionstring2.10.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
MaxSpeeduint64
DescriptionstringThe maximum bandwidth of the Port in Bits per Second.
PUnitstringbit / second
UnitsstringBits per Second
OtherPortTypestring
DescriptionstringDescribes the type of module, when PortType is set to 1 ("Other").
ModelCorrespondencestringCIM_LogicalPort.PortType
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.
ModelCorrespondencestringCIM_NetworkPort.OtherNetworkPortType
ValueMapstring0, 1, 2, 3..15999, 16000..65535
ValuesstringUnknown, Other, Not Applicable, DMTF Reserved, Vendor Reserved
RequestedSpeeduint64
DescriptionstringThe requested bandwidth of the Port in Bits per Second. The actual bandwidth is reported in LogicalPort.Speed.
ModelCorrespondencestringCIM_LogicalPort.Speed
PUnitstringbit / second
UnitsstringBits per Second
Writebooleantrue
Speeduint64
DescriptionstringThe bandwidth of the Port in Bits per Second.
PUnitstringbit / second
UnitsstringBits per Second
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'.
ValueMapstring0, 2, 3, 4
ValuesstringUnknown, Front-end only, Back-end only, Not restricted

Inherited Properties

NameData TypeClass Origin
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedStateuint16CIM_EnabledLogicalElement
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice