# 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

Name | Data Type | Value
--- | --- | ---
Description | string | Capabilities and management of a Fibre Channel Port Device.
UMLPackagePath | string | CIM::Device::FC
Version | string | 2.31.0

## Class Properties

### Local Class Properties

Name | Data Type | Default Value | Qualifiers
--- | --- | --- | ---
Name | Data Type | Value
DetailedPortState | uint16 |
Description | string | Additional 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, .., 0x8000..
Values | string | Unknown, Other, Transceiver Validation, Locking To Reference Signal, Sync, Invalid Transceiver, No Light, No Sync, Laser Fault, Port Fault, Diagnostic Fault, Vendor Reserved, DMTF Reserved
DomainPortNumber | uint16 |
Description | string | The port number used for domain id and physical port zone members.
Experimental | boolean | true
LogicalModulePortNumber | uint16 |
Description | string | The port number labeled for an administrative purposes relative to the logical module.
Experimental | boolean | true
PortAvailability | uint16 | 2
Description | string | The 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.
Experimental | boolean | true
ValueMap | string | 0, 2, 3, 4, 5, ..
Values | string | Unknown, Available, Not Installed, No Transceiver, Not Licensed, DMTF Reserved
PortNumber | uint16 |
Description | string | The labeled port number for administrative purposes. This is typically what is exposed through the devices element manager or CLI.
Override | string | PortNumber
PortType | uint16 |
Description | string | The 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.
ModelCorrespondence | string | CIM_NetworkPort.OtherNetworkPortType
Override | string | PortType
ValueMap | string | 0, 1, 10, 11, 12, 13, 14, 15, 16, 17, 18, 16000..65535
Values | string | Unknown, Other, N, NL, F/NL, Nx, E, F, FL, B, G, Vendor Reserved
ActiveCOS | uint16[] |
Description | string | An array of integers that indicates the Classes of Service that are active. The Active COS is indicated in ActiveCOS.
ModelCorrespondence | string | CIM_FCPort.SupportedCOS
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7
Values | string | Unknown, 1, 2, 3, 4, 5, 6, F
ActiveFC4Types | uint16[] |
Description | string | An 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.
ModelCorrespondence | string | CIM_FCPort.SupportedFC4Types
ValueMap | string | 0, 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..
Values | string | Unknown, 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
PortDiscriminator | uint16[] |
Description | string | An 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.
Experimental | boolean | true
ValueMap | string | 0, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, ..
Values | string | Unknown, Not Applicable, VF, FCIP, IFR, IFR (Virtual), NPIV, Internal, Chassis, FCoE, FC (Native), HBA, Storage, DMTF Reserved
SupportedCOS | uint16[] |
Description | string | An array of integers that indicates the Fibre Channel Classes of Service that are supported. The active COS are indicated in ActiveCOS.
ValueMap | string | 0, 1, 2, 3, 4, 5, 6, 7
Values | string | Unknown, 1, 2, 3, 4, 5, 6, F
SupportedFC4Types | uint16[] |
Description | string | An 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.
ValueMap | string | 0, 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..
Values | string | Unknown, 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

Name | Data Type | Class Origin
--- | --- | ---
ActiveMaximumTransmissionUnit | uint64 | CIM_NetworkPort
AllocationState | string | CIM_LogicalDevice
AutoSense | boolean | CIM_NetworkPort
Availability | uint16 | CIM_LogicalDevice
Caption | string | CIM_ManagedElement
CommunicationStatus | uint16 | CIM_ManagedSystemElement
CreationClassName | string | CIM_LogicalDevice
Description | string | CIM_ManagedElement
DetailedStatus | uint16 | CIM_ManagedSystemElement
DeviceID | string | CIM_LogicalDevice
ElementName | string | CIM_ManagedElement
EnabledDefault | uint16 | CIM_EnabledLogicalElement
EnabledState | uint16 | CIM_EnabledLogicalElement
ErrorCleared | boolean | CIM_LogicalDevice
ErrorDescription | string | CIM_LogicalDevice
FullDuplex | boolean | CIM_NetworkPort
Generation | uint64 | CIM_ManagedElement
HealthState | uint16 | CIM_ManagedSystemElement
InstallDate | datetime | CIM_ManagedSystemElement
InstanceID | string | CIM_ManagedElement
LastErrorCode | uint32 | CIM_LogicalDevice
LinkTechnology | uint16 | CIM_NetworkPort
LocationIndicator | uint16 | CIM_LogicalDevice
MaxQuiesceTime | uint64 | CIM_LogicalDevice
MaxSpeed | uint64 | CIM_LogicalPort
Name | string | CIM_ManagedSystemElement
OperatingStatus | uint16 | CIM_ManagedSystemElement
OtherEnabledState | string | CIM_EnabledLogicalElement
OtherLinkTechnology | string | CIM_NetworkPort
OtherNetworkPortType | string | CIM_NetworkPort
OtherPortType | string | CIM_LogicalPort
PermanentAddress | string | CIM_NetworkPort
PowerManagementSupported | boolean | CIM_LogicalDevice
PowerOnHours | uint64 | CIM_LogicalDevice
PrimaryStatus | uint16 | CIM_ManagedSystemElement
RequestedSpeed | uint64 | CIM_LogicalPort
RequestedState | uint16 | CIM_EnabledLogicalElement
Speed | uint64 | CIM_NetworkPort
Status | string | CIM_ManagedSystemElement
StatusInfo | uint16 | CIM_LogicalDevice
SupportedMaximumTransmissionUnit | uint64 | CIM_NetworkPort
SystemCreationClassName | string | CIM_LogicalDevice
SystemName | string | CIM_LogicalDevice
TimeOfLastStateChange | datetime | CIM_EnabledLogicalElement
TotalPowerOnHours | uint64 | CIM_LogicalDevice
TransitioningToState | uint16 | CIM_EnabledLogicalElement
UsageRestriction | uint16 | CIM_LogicalPort
AdditionalAvailability | uint16[] | CIM_LogicalDevice
AvailableRequestedStates | uint16[] | CIM_EnabledLogicalElement
IdentifyingDescriptions | string[] | CIM_LogicalDevice
NetworkAddresses | string[] | CIM_NetworkPort
OperationalStatus | uint16[] | CIM_ManagedSystemElement
OtherIdentifyingInfo | string[] | CIM_LogicalDevice
PowerManagementCapabilities | uint16[] | CIM_LogicalDevice
StatusDescriptions | string[] | CIM_ManagedSystemElement

## Class Methods

### Local Class Methods

#### Decommission (uint32)

#### Method Qualifiers (Decommission)

Name | Data Type | Value
--- | --- | ---
Description | string | Requests 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, 3, .., 0x8000..
Values | string | Success, Other error, Denied Port is in use, Denied Port is last path to device, DMTF Reserved, Vendor Reserved

#### Method Parameters (Decommission)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Force | boolean
Description | string | Indicates 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.
In | boolean | true
Messages | string[]
ArrayType | string | Indexed
Description | string | When 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.
EmbeddedInstance | string | CIM_Message
In | boolean | false
Out | boolean | true

#### Recommission (uint32)

#### Method Qualifiers (Recommission)

Name | Data Type | Value
--- | --- | ---
Description | string | Requests 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.
Experimental | boolean | true
ValueMap | string | 0, 1, 2, .., 0x8000..
Values | string | Success, Other error, Denied Port not decommissioned, DMTF Reserved, Vendor Reserved

#### Method Parameters (Recommission)

Name | Type | Qualifiers
--- | --- | ---
Name | Data Type | Value
Messages | string[]
ArrayType | string | Indexed
Description | string | When 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.
EmbeddedInstance | string | CIM_Message
In | boolean | false
Out | boolean | true

### Inherited Class Methods

Name | Return Type | Class Origin
--- | --- | ---
EnableDevice | uint32 | CIM_LogicalDevice
OnlineDevice | uint32 | CIM_LogicalDevice
QuiesceDevice | uint32 | CIM_LogicalDevice
RequestStateChange | uint32 | CIM_EnabledLogicalElement
Reset | uint32 | CIM_LogicalDevice
RestoreProperties | uint32 | CIM_LogicalDevice
SaveProperties | uint32 | CIM_LogicalDevice
SetPowerState | uint32 | CIM_LogicalDevice