Read
GET v1/fibre_channel_interfaces/id
Query parameters
| Parameter | Type |
|---|---|
| fields | NsCommaSeparatedList |
GET v1/fibre_channel_interfaces
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
| partial_response_ok | NsBoolean |
GET v1/fibre_channel_interfaces/detail
Query parameters
| Parameter | Type |
|---|---|
| startRow | NsUnsignedLong |
| endRow | NsUnsignedLong |
| sortBy | NsString |
| iSortBy | NsString |
| fields | NsCommaSeparatedList |
| pageSize | NsUnsignedInt |
| array_name_or_serial | NsObjectName |
| partial_response_ok | NsBoolean |
Description
List a set of Fibre Channel interfaces or a single Fibre Channel interface.
Normal Response Codes
200
HTTP Error Codes
400 401 403 404 500 503
Detail Codes
Response
| Parameter | Type | JSON Type | Description | Deprecated |
|---|---|---|---|---|
| id | NsObjectID | string | Identifier for the Fibre Channel interface. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'. | |
| array_name_or_serial | NsObjectName | string | Name or serial number of array where the interface is hosted. 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 where the interface is hosted. Plain string. | |
| fc_port_id | NsFibreChannelPortID | string | ID of the port with which the interface is associated. An ID of a Fibre Channel Port. Example: '1f01067316132'. | |
| name | NsObjectName | string | Name of Fibre Channel interface. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'. | |
| wwnn | NsWWN | string | WWNN (World Wide Node Name) for this Fibre Channel interface. Eight bytes expressed in hex separated by colons. Example: 'af:32:f1:20:bc:ba:43:1a'. | |
| wwpn | NsWWN | string | WWPN (World Wide Port Name) for this Fibre Channel interface. Eight bytes expressed in hex separated by colons. Example: 'af:32:f1:20:bc:ba:43:1a'. | |
| online | NsBoolean | boolean | Identify whether the Fibre Channel interface is online. Possible values: 'true', 'false'. | |
| firmware_version | NsString | string | Version of the Fibre Channel firmware. Plain string. | |
| logical_port_number | NsUnsignedLong | number | Logical port number for the Fibre Channel port. Unsigned 64-bit integer. Example: 1234. | |
| fc_port_name | NsObjectName | string | Name of 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 for this Fibre Channel port. Platform HBA (Host Bus Adapter) bus location. Example : 0000:81:00.0. | |
| slot | NsPlatSlot | number | HBA slot number for this Fibre Channel port. Slot that is mapped on the PCIe bus. | |
| port | NsPlatPort | number | HBA port number for this Fibre Channel port. Port on the HBA (Host Bus Adapter). | |
| link_info | NsFcLinkInfo | object | Information about the Fibre Channel link at which interface is operating. Fibre Channel link information. | |
| fabric_info | NsFcFabricInfo | object | Fibre Channel fabric information. Fibre Channel fabric information. |
JSON Response
{"data":[
{
"array_name_or_serial": "g1a1",
"bus_location": "0000:81:00.0",
"controller_name": "A",
"fabric_info": {
"fabric_switch_name": "fakeswitch",
"fabric_switch_port": "10",
"fabric_switch_wwnn": "da:ad:da:ad:da:ad:da:ad",
"fabric_switch_wwpn": "d0:0d:d0:0d:d0:0d:d0:0d",
"fabric_wwn": "fa:b4:1c:fa:b4:1c:fa:b4",
"fc_id": "1ceace",
"logged_in": "true"
},
"fc_port_id": "1f01067316131",
"fc_port_name": "fc1",
"firmware_version": "1.1.59.0",
"id": "2100000000000004d3000000000000000000000001",
"link_info": {
"link_speed": "plat_fc_link_speed_16G",
"link_status": "plat_fc_link_status_up",
"max_link_speed": "plat_fc_link_speed_16G",
"operational_status": "plat_fc_operational_status_operational"
},
"logical_port_number": "0",
"name": "fc1.1",
"online": "true",
"port": "0",
"slot": "1",
"wwnn": "56:c9:ce:90:9b:84:c9:00",
"wwpn": "56:c9:ce:90:9b:84:c9:01"
},
{
"array_name_or_serial": "g1a1",
"bus_location": "0000:81:00.1",
"controller_name": "A",
"fabric_info": {
"fabric_switch_name": "fakeswitch",
"fabric_switch_port": "10",
"fabric_switch_wwnn": "da:ad:da:ad:da:ad:da:ad",
"fabric_switch_wwpn": "d0:0d:d0:0d:d0:0d:d0:0d",
"fabric_wwn": "fa:b4:1c:fa:b4:1c:fa:b4",
"fc_id": "1ceace",
"logged_in": "true"
},
"fc_port_id": "1f01167316131",
"fc_port_name": "fc2",
"firmware_version": "1.1.59.0",
"id": "2100000000000004d3000000000000000000000002",
"link_info": {
"link_speed": "plat_fc_link_speed_16G",
"link_status": "plat_fc_link_status_up",
"max_link_speed": "plat_fc_link_speed_16G",
"operational_status": "plat_fc_operational_status_operational"
},
"logical_port_number": "0",
"name": "fc2.1",
"online": "true",
"port": "1",
"slot": "1",
"wwnn": "56:c9:ce:90:9b:84:c9:00",
"wwpn": "56:c9:ce:90:9b:84:c9:02"
},
{
"array_name_or_serial": "g1a1",
"bus_location": "0000:81:00.0",
"controller_name": "B",
"fabric_info": {
"fabric_switch_name": "fakeswitch",
"fabric_switch_port": "10",
"fabric_switch_wwnn": "da:ad:da:ad:da:ad:da:ad",
"fabric_switch_wwpn": "d0:0d:d0:0d:d0:0d:d0:0d",
"fabric_wwn": "fa:b4:1c:fa:b4:1c:fa:b4",
"fc_id": "1ceace",
"logged_in": "true"
},
"fc_port_id": "1f11067316131",
"fc_port_name": "fc1",
"firmware_version": "1.1.59.0",
"id": "2100000000000004d3000000000000000000000003",
"link_info": {
"link_speed": "plat_fc_link_speed_16G",
"link_status": "plat_fc_link_status_up",
"max_link_speed": "plat_fc_link_speed_16G",
"operational_status": "plat_fc_operational_status_operational"
},
"logical_port_number": "0",
"name": "fc1.1",
"online": "true",
"port": "0",
"slot": "1",
"wwnn": "56:c9:ce:90:9b:84:c9:00",
"wwpn": "56:c9:ce:90:9b:84:c9:03"
},
{
"array_name_or_serial": "g1a1",
"bus_location": "0000:81:00.1",
"controller_name": "B",
"fabric_info": {
"fabric_switch_name": "fakeswitch",
"fabric_switch_port": "10",
"fabric_switch_wwnn": "da:ad:da:ad:da:ad:da:ad",
"fabric_switch_wwpn": "d0:0d:d0:0d:d0:0d:d0:0d",
"fabric_wwn": "fa:b4:1c:fa:b4:1c:fa:b4",
"fc_id": "1ceace",
"logged_in": "true"
},
"fc_port_id": "1f11167316131",
"fc_port_name": "fc2",
"firmware_version": "1.1.59.0",
"id": "2100000000000004d3000000000000000000000004",
"link_info": {
"link_speed": "plat_fc_link_speed_16G",
"link_status": "plat_fc_link_status_up",
"max_link_speed": "plat_fc_link_speed_16G",
"operational_status": "plat_fc_operational_status_operational"
},
"logical_port_number": "0",
"name": "fc2.1",
"online": "true",
"port": "1",
"slot": "1",
"wwnn": "56:c9:ce:90:9b:84:c9:00",
"wwpn": "56:c9:ce:90:9b:84:c9:04"
}
]}