REST API Reference Version 5.2.1.0Search

Read

GET v1/fibre_channel_sessions

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID

GET v1/fibre_channel_sessions/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID

GET v1/fibre_channel_sessions/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Retrieve information on a set of Fibre Channel sessions or a single Fibre Channel session.

Normal Response Codes

200 206

HTTP Error Codes

400 401 403 404 500 503

Response

Parameter Type JSON Type Description Deprecated
id NsObjectID string Unique identifier of the Fibre Channel session. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
initiator_info NsFcSessionInitiator object Information about the Fibre Channel initiator. Information of the Fibre Channel Session Initiator.  
target_info NsFcSessionTarget object Information about the Fibre Channel target. Information of the Fibre Channel session target.  

JSON Response

            
            
            {
                "id": "330000000000c9ce909b84c90156c9ce909b84c901",
                "initiator_info": {
                    "initiator_alias": "itor1",
                    "initiator_fcid": 11,
                    "initiator_switch_name": "itor1_switch_name",
                    "initiator_switch_port": "itor1_switch_port",
                    "initiator_symbolic_nodename": "itor1_symbolic_nodename",
                    "initiator_symbolic_portname": "itor1_symbolic_portname",
                    "initiator_wwpn": "00:c9:ce:90:9b:84:c9:01"
                },
                "target_info" : {
                    "target_fcid": FF11,
                    "target_port_array_name": "g1a1",
                    "target_port_ctrlr_name": A,
                    "target_port_interface_name": "fc1.1",
                    "target_wwnn": "56:c9:ce:90:9b:84:c9:00",
                    "target_wwpn": "56:c9:ce:90:9b:84:c9:01"
                }
            }