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

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 Type
AllocationStatestring
Availabilityuint16
Captionstring
CommunicationStatusuint16
CreationClassNamestring
Descriptionstring
DetailedStatusuint16
DeviceIDstring
ElementNamestring
EnabledDefaultuint16
EnabledStateuint16
ErrorClearedboolean
ErrorDescriptionstring
Generationuint64
HealthStateuint16
InstallDatedatetime
InstanceIDstring
LastErrorCodeuint32
LocationIndicatoruint16
MaxQuiesceTimeuint64
Namestring
OperatingStatusuint16
OtherEnabledStatestring
PowerManagementSupportedboolean
PowerOnHoursuint64
PrimaryStatusuint16
RequestedStateuint16
Statusstring
StatusInfouint16
SystemCreationClassNamestring
SystemNamestring
TimeOfLastStateChangedatetime
TotalPowerOnHoursuint64
TransitioningToStateuint16
AdditionalAvailabilityuint16[]
AvailableRequestedStatesuint16[]
IdentifyingDescriptionsstring[]
OperationalStatusuint16[]
OtherIdentifyingInfostring[]
PowerManagementCapabilitiesuint16[]
StatusDescriptionsstring[]

Class Methods

Inherited Class Methods

NameReturn Type
EnableDeviceuint32
OnlineDeviceuint32
QuiesceDeviceuint32
RequestStateChangeuint32
Resetuint32
RestorePropertiesuint32
SavePropertiesuint32
SetPowerStateuint32