Get Fibre Channel ports

Edit online

Retrieves information about the Fibre Channel ports in the library. Querying ports for a specific drive is accomplished by using filters. Supported filter values include driveLocation and driveSn.

Request syntax

GET /v1/fcPorts
Retrieves information about all Fibre Channel ports in the tape library.

GET /v1/fcports/{location}
Retrieves information about the Fibre Channel ports in the specified location.

Path parameters

location (string): The unique location of the Fibre Channel port.

Query parameters

driveLocation (string, optional): The drive location of the ports to be returned.

driveSn (string, optional): The drive serial number of the ports to be returned.

Example

> GET /v1/fcports
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: 45992

[
     {
          "location": "fcPort_F1C4R2P0",
          "driveLocation": "drive_F1C4R2", 
          "driveSn": "YD1068012621",  
          "portNumber": 0, 
          "state": "communicationEstablished", 
          "wwpn": "50050763005a400c", 
          "speedSetting": "auto", 
          "speedActual": "4Gbps", 
          "topologySetting": "auto-L", 
          "topologyActual": "L-Port", 
          "loopID": 14,
     }, {
          ...
     }
]

Attributes

location (string)

The unique location of the Fibre Channel port.

driveLocation (string)

The unique location of the drive the port is installed on in the library.

driveSn (string)

The globally unique serial number of the drive the port is installed on.

portNumber (string)

The port number on the drive this port represents.

state (string)

The health status of the Fibre Channel port. Values include:

State	Description/user action
`unknown`	Drive or LCC Node Card that is associated with this port might be unreachable or the state that is recorded by firmware for this resource is unknown. Reset the associated LCC node card and contact IBM for support if issue persists.
`noLightDetected`	Light is not detected which indicates no device is connected.
`communicationNotEstablished`	Device is connected but no WWPNs are logged in.
`communicationEstablished`	Device is connected and at least one WWPN is logged in.

WWPN (string)

The globally unique worldwide port name (WWPN) of the port.

speedSetting (string)

The setting for the port's current data transfer speed. Values include auto, 1Gbps, 2Gbps, 4Gbps, 8Gbps, and 16Gbps.

speedActual (string)

The actual data transfer speed across the port. If the speedSetting is set to auto or the speedSetting is set higher than the supported SAN speed, this value can be different than the setting. Values include 1Gbps, 2Gbps, 4Gbps, 8Gbps, and 16Gbps.

topologySetting (string)

The current setting for the topology or protocol of the port. Values include auto-L, auto-N, N-Port, and L-Port.

topologyActual (string)

The actual topology followed by the port. Values include N-Port and L-Port.

loopID (number)

A unique value that identifies the position of the drive in the tape library. For more information, see Default SCSI ID and Loop ID (AL_PA) Assignments for Drives.