Read
GET v1/fibre_channel_ports
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
GET v1/fibre_channel_ports/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
Description
List a set of Fibre Channel ports for all reachable arrays or a set of Fibre Channel ports for a single array.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsFibreChannelPortID | string | Identifier for the Fibre Channel port. An ID of a Fibre Channel Port. Example: '1f01067316132'. | |
| array_name_or_serial | NsObjectName | string | Name or serial number of the array. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| controller_name | NsString | string | Name (A or B) of the controller to which the port belongs. Plain string. | |
| fc_port_name | NsObjectName | string | Name of the Fibre Channel port. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| bus_location | NsBusLocation | string | PCI bus location of the HBA (Host Bus Adapter) for this Fibre Channel port. Platform HBA (Host Bus Adapter) bus location. Example : 0000:81:00.0. | |
| port | NsPlatPort | number | HBA (Host Bus Adapter) port number for this Fibre Channel port. Port on the HBA (Host Bus Adapter). | |
| slot | NsPlatSlot | number | HBA (Host Bus Adapter) slot number for this Fibre Channel port. Slot that is mapped on the PCIe bus. | |
| link_info | NsFcLinkInfo | object | Information about the Fibre Channel link associated with this port. Fibre Channel link information. |
JSON Response
{
"data": {
"array_name_or_serial": "g1a2",
"bus_location": "0000:81:00.0",
"controller_name": "A",
"fc_port_name": "fc1",
"id": "1f01067316132",
"link_info": {
"link_speed": "plat_fc_link_speed_16G",
"link_status": "plat_fc_link_status_up",
"max_link_speed": "plat_fc_link_speed_unknown",
"operational_status": "plat_fc_operational_status_operational"
},
"port": "0",
"slot": "1"
}
}