Class CIM_FCPort
extends CIM_NetworkPort

Capabilities and management of a Fibre Channel Port Device.

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
   |
   +--CIM_NetworkPort
   |
   +--CIM_FCPort

Direct Known Subclasses

Class Qualifiers

NameData TypeValue
DescriptionstringCapabilities and management of a Fibre Channel Port Device.
UMLPackagePathstringCIM::Device::FC
Versionstring2.31.0

Class Properties

Local Class Properties

NameData TypeDefault ValueQualifiers
NameData TypeValue
DetailedPortStateuint16
DescriptionstringAdditional port state/status information for the FCPort beyond that provided in OperationalStatus and EnabledState. The following detailed port states may occur when OperationStatus is set to OK: Transceiver Validation(2) indicates that the transceiver is being validated. Locking To Reference Signal(3) indicates that the port is locking to the reference signal. Sync (4) indicates the port is receiving light and is synchronized with the other port. The following detailed port states may occur when OperationStatus is set to Error: Invalid Transceiver (5) indicates the port has detected an invalid transceiver. No Light (6) indicates transciever is not receiving light. No Sync (7) indicates that port is receiving light but cannot synchronize. Laser Fault (8) indicates the transceiver is reporting the laser is not working or the transceiver is not reporting data for the laser, or software detected the error by polling the transceiver and shut the port down Port Fault (9) indicates the port encountered errors beyond the transceiver including excessive low level link initializations. Diagnostic Fault (10) indicates that diagnoistic tests running various traffic types.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 0x8000..
ValuesstringUnknown, Other, Transceiver Validation, Locking To Reference Signal, Sync, Invalid Transceiver, No Light, No Sync, Laser Fault, Port Fault, Diagnostic Fault, Vendor Reserved, DMTF Reserved
DomainPortNumberuint16
DescriptionstringThe port number used for domain id and physical port zone members.
Experimentalbooleantrue
LogicalModulePortNumberuint16
DescriptionstringThe port number labeled for an administrative purposes relative to the logical module.
Experimentalbooleantrue
PortAvailabilityuint162
DescriptionstringThe availability of the port for a client to determine whether the port can be made operational. The values: Available (2) indicates that the port can be made operational, Not Installed (3) indicates some aspect of the port has not been installed preventing it from being operational but is discoverable through instrumentation, No Transceiver (4) indicates that the transceiver is not installed to allow the port to become operational, Not Licensed (5) indicates that the port cannot be made operational due to a license not existing for the port.
Experimentalbooleantrue
ValueMapstring0, 2, 3, 4, 5, ..
ValuesstringUnknown, Available, Not Installed, No Transceiver, Not Licensed, DMTF Reserved
PortNumberuint16
DescriptionstringThe labeled port number for administrative purposes. This is typically what is exposed through the devices element manager or CLI.
OverridestringPortNumber
PortTypeuint16
DescriptionstringThe specific mode currently enabled for the Port. If the port is logged in, this will be the negotiated port type, otherwise the configured port type will be reported. The values: "N" = Node Port, "NL" = Node Port supporting FC arbitrated loop, "NX" = Port may negotiate to become either a node port (N) or a node port supporting FC arbitrated loop (NL), "E" = Expansion Port connecting fabric elements (for example, FC switches), "F" = Fabric (element) Port, "FL" = Fabric (element) Port supporting FC arbitrated loop, "FX" = Port may negotiate to become a fabric port (F), or a fabric port supporting FC arbitrated loop (FL). "B" = Bridge port, and "G" = Port may negotiate to become either an expansion port (E), or a fabric port (F), "GL" = Port may negotiate to become an expansion port (E), a fabric port (F), or a fabric port supporting FC arbitrated loop (FL). PortTypes are defined in the ANSI X3 standards. When set to 1 ("Other"), the related property OtherPortType contains a string description of the type of port.
ModelCorrespondencestringCIM_NetworkPort.OtherNetworkPortType
OverridestringPortType
ValueMapstring0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 16000..65535
ValuesstringUnknown, Other, N, NL, F/NL, Nx, E, F, FL, B, G, Vendor Reserved
ActiveCOSuint16[]
DescriptionstringAn array of integers that indicates the Classes of Service that are active. The Active COS is indicated in ActiveCOS.
ModelCorrespondencestringCIM_FCPort.SupportedCOS
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7
ValuesstringUnknown, 1, 2, 3, 4, 5, 6, F
ActiveFC4Typesuint16[]
DescriptionstringAn array of integers that indicates the Fibre Channel FC-4 protocols currently running. A list of all supported protocols is indicated in the SupportedFC4Types property.
ModelCorrespondencestringCIM_FCPort.SupportedFC4Types
ValueMapstring0, 1, 4, 5, 8, 9, 17, 18, 19, 21, 22, 23, 25, 26, 27, 28, 32, 34, 36, 64, 80, 81, 82, 88, 96, 255..
ValuesstringUnknown, Other, ISO/IEC 8802 - 2 LLC, IP over FC, SCSI - FCP, SCSI - GPP, IPI - 3 Master, IPI - 3 Slave, IPI - 3 Peer, CP IPI - 3 Master, CP IPI - 3 Slave, CP IPI - 3 Peer, SBCCS Channel, SBCCS Control Unit, FC-SB-2 Channel, FC-SB-2 Control Unit, Fibre Channel Services (FC-GS, FC-GS-2, FC-GS-3), FC-SW, FC - SNMP, HIPPI - FP, BBL Control, BBL FDDI Encapsulated LAN PDU, BBL 802.3 Encapsulated LAN PDU, FC - VI, FC - AV, Vendor Unique
PortDiscriminatoruint16[]
DescriptionstringAn enumeration used to discriminate the context in which this FCPort is instantiated: Not Applicable (2) indicates that this FCPort was not instantiated in any special context. VF (3) indicates this FCPort was instantiated in the context of Virtual Fabrics (VF). FCIP (4) indicates that this FCport was instantiated in the context of FC over IP (FCIP). IFR (5) indicates that this FCPort was instantiated in the context of Inter-Fabric Routing (IFR). IFR (Virtual) (6) indicates that this FCPort was instantiated in the context of Inter-Fabric Routing (IFR) and has no physical representation. NPIV (7) indicates that this FCPort was instantiated in the context of N Port Virtualization (NPIV). Internal (8) indicates that this FCPort is not externally visible and is represented physically internally in the hardware (unlike VF). Chassis (9) indicates that this FCPort is externally visible but is not supported by a traditional fibre channel connector (for example a chassis to chassis connection). FCoE (10) indicates that this FCPort is instantiated for Fibre Channel over Ethernet (FCoE). FC (Native) (11) indicates that this FCPort represents a native FCPort. HBA (12) indicates that this FCPort is instantiated in a Host Bus Adapter (HBA) context. Storage (13) indicates that this FCPort in instantiated in a storage (e.g., disk array) context.
Experimentalbooleantrue
ValueMapstring0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, ..
ValuesstringUnknown, Not Applicable, VF, FCIP, IFR, IFR (Virtual), NPIV, Internal, Chassis, FCoE, FC (Native), HBA, Storage, DMTF Reserved
SupportedCOSuint16[]
DescriptionstringAn array of integers that indicates the Fibre Channel Classes of Service that are supported. The active COS are indicated in ActiveCOS.
ValueMapstring0, 1, 2, 3, 4, 5, 6, 7
ValuesstringUnknown, 1, 2, 3, 4, 5, 6, F
SupportedFC4Typesuint16[]
DescriptionstringAn array of integers that indicates the Fibre Channel FC-4 protocols supported. The protocols that are active and running are indicated in the ActiveFC4Types property.
ValueMapstring0, 1, 4, 5, 8, 9, 17, 18, 19, 21, 22, 23, 25, 26, 27, 28, 32, 34, 36, 64, 80, 81, 82, 88, 96, 255..
ValuesstringUnknown, Other, ISO/IEC 8802 - 2 LLC, IP over FC, SCSI - FCP, SCSI - GPP, IPI - 3 Master, IPI - 3 Slave, IPI - 3 Peer, CP IPI - 3 Master, CP IPI - 3 Slave, CP IPI - 3 Peer, SBCCS Channel, SBCCS Control Unit, FC-SB-2 Channel, FC-SB-2 Control Unit, Fibre Channel Services (FC-GS, FC-GS-2, FC-GS-3), FC-SW, FC - SNMP, HIPPI - FP, BBL Control, BBL FDDI Encapsulated LAN PDU, BBL 802.3 Encapsulated LAN PDU, FC - VI, FC - AV, Vendor Unique

Inherited Properties

NameData TypeClass Origin
ActiveMaximumTransmissionUnituint64CIM_NetworkPort
AllocationStatestringCIM_LogicalDevice
AutoSensebooleanCIM_NetworkPort
Availabilityuint16CIM_LogicalDevice
CaptionstringCIM_ManagedElement
CommunicationStatusuint16CIM_ManagedSystemElement
CreationClassNamestringCIM_LogicalDevice
DescriptionstringCIM_ManagedElement
DetailedStatusuint16CIM_ManagedSystemElement
DeviceIDstringCIM_LogicalDevice
ElementNamestringCIM_ManagedElement
EnabledDefaultuint16CIM_EnabledLogicalElement
EnabledStateuint16CIM_EnabledLogicalElement
ErrorClearedbooleanCIM_LogicalDevice
ErrorDescriptionstringCIM_LogicalDevice
FullDuplexbooleanCIM_NetworkPort
Generationuint64CIM_ManagedElement
HealthStateuint16CIM_ManagedSystemElement
InstallDatedatetimeCIM_ManagedSystemElement
InstanceIDstringCIM_ManagedElement
LastErrorCodeuint32CIM_LogicalDevice
LinkTechnologyuint16CIM_NetworkPort
LocationIndicatoruint16CIM_LogicalDevice
MaxQuiesceTimeuint64CIM_LogicalDevice
MaxSpeeduint64CIM_LogicalPort
NamestringCIM_ManagedSystemElement
OperatingStatusuint16CIM_ManagedSystemElement
OtherEnabledStatestringCIM_EnabledLogicalElement
OtherLinkTechnologystringCIM_NetworkPort
OtherNetworkPortTypestringCIM_NetworkPort
OtherPortTypestringCIM_LogicalPort
PermanentAddressstringCIM_NetworkPort
PowerManagementSupportedbooleanCIM_LogicalDevice
PowerOnHoursuint64CIM_LogicalDevice
PrimaryStatusuint16CIM_ManagedSystemElement
RequestedSpeeduint64CIM_LogicalPort
RequestedStateuint16CIM_EnabledLogicalElement
Speeduint64CIM_NetworkPort
StatusstringCIM_ManagedSystemElement
StatusInfouint16CIM_LogicalDevice
SupportedMaximumTransmissionUnituint64CIM_NetworkPort
SystemCreationClassNamestringCIM_LogicalDevice
SystemNamestringCIM_LogicalDevice
TimeOfLastStateChangedatetimeCIM_EnabledLogicalElement
TotalPowerOnHoursuint64CIM_LogicalDevice
TransitioningToStateuint16CIM_EnabledLogicalElement
UsageRestrictionuint16CIM_LogicalPort
AdditionalAvailabilityuint16[]CIM_LogicalDevice
AvailableRequestedStatesuint16[]CIM_EnabledLogicalElement
IdentifyingDescriptionsstring[]CIM_LogicalDevice
NetworkAddressesstring[]CIM_NetworkPort
OperationalStatusuint16[]CIM_ManagedSystemElement
OtherIdentifyingInfostring[]CIM_LogicalDevice
PowerManagementCapabilitiesuint16[]CIM_LogicalDevice
StatusDescriptionsstring[]CIM_ManagedSystemElement

Class Methods

Local Class Methods

Decommission (uint32)

Method Qualifiers (Decommission)

NameData TypeValue
DescriptionstringRequests the fibre channel port represented by an instance of this class to be taken into the decommissioned state. The decommissioned state is an intended offline state, so the system does not attempt to take the port back online as part of any automated recovery actions. This method supports a normal mode of operation and a forceful mode of operation. In the normal mode of operation, it behaves gracefully by not decommissioning the port if this would cause any functional disruption. In the forceful mode of operation, it decommissions the port even if this causes functional disruptions. This method shall return one of the following return values: 0 (Success): The port was decommissioned. 1 (Other error): The port was not decommissioned because some other error occurred. 2 (Denied: Port is in use): The port was not decommissioned because it is currently in use. This reason for denying the decommissioning request shall be used only in the normal mode of operation. 3 (Denied: Port is last path to device): The port was not decommissioned because it is the last path to a device. This reason for denying the decommissioning request shall be used only in the normal mode of operation.
Experimentalbooleantrue
ValueMapstring0, 1, 2, 3, .., 0x8000..
ValuesstringSuccess, Other error, Denied Port is in use, Denied Port is last path to device, DMTF Reserved, Vendor Reserved

Method Parameters (Decommission)

NameTypeQualifiers
NameData TypeValue
Forceboolean
DescriptionstringIndicates that the forceful mode of operation shall be used, as follows: A value of True indicates that the forceful mode of operation shall be used. A value of False or Null indicates that the normal mode of operation shall be used.
Inbooleantrue
Messagesstring[]
ArrayTypestringIndexed
DescriptionstringWhen the decommissioning request has failed (denied or error), this parameter shall return one ore more DMTF standard messages describing the reason for the failure. When the decommissioning request has succeeded, this parameter may return one or more DMTF standard messages providing additional information on the actions that have been performed when the request was processed.
EmbeddedInstancestringCIM_Message
Inbooleanfalse
Outbooleantrue

Recommission (uint32)

Method Qualifiers (Recommission)

NameData TypeValue
DescriptionstringRequests the fibre channel port represented by an instance of this class to be taken online after it was previously decommissioned. This method shall return one of the following return values: 0 (Success): The port was taken online. 1 (Other error): The port was not taken online because some other error occurred. 2 (Denied: Port not decommissioned): The port was not taken online because the port is not currently in the decommissioned state.
Experimentalbooleantrue
ValueMapstring0, 1, 2, .., 0x8000..
ValuesstringSuccess, Other error, Denied Port not decommissioned, DMTF Reserved, Vendor Reserved

Method Parameters (Recommission)

NameTypeQualifiers
NameData TypeValue
Messagesstring[]
ArrayTypestringIndexed
DescriptionstringWhen the recommissioning request has failed (denied or error), this parameter shall return one ore more DMTF standard messages describing the reason for the failure. When the recommissioning request has succeeded, this parameter may return one or more DMTF standard messages providing additional information on the actions that have been performed when the request was processed.
EmbeddedInstancestringCIM_Message
Inbooleanfalse
Outbooleantrue

Inherited Class Methods

NameReturn TypeClass Origin
EnableDeviceuint32CIM_LogicalDevice
OnlineDeviceuint32CIM_LogicalDevice
QuiesceDeviceuint32CIM_LogicalDevice
RequestStateChangeuint32CIM_EnabledLogicalElement
Resetuint32CIM_LogicalDevice
RestorePropertiesuint32CIM_LogicalDevice
SavePropertiesuint32CIM_LogicalDevice
SetPowerStateuint32CIM_LogicalDevice