REST API Reference Version 5.2.1.0Search

Read

GET v1/fibre_channel_initiator_aliases

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
pageSize NsUnsignedInt
id NsObjectID
alias NsObjectName
wwpn NsWWN
source SmFcInitiatorAliasSource

GET v1/fibre_channel_initiator_aliases/detail

Query parameters

Parameter Type
startRow NsUnsignedLong
endRow NsUnsignedLong
sortBy NsString
iSortBy NsString
fields NsCommaSeparatedList
pageSize NsUnsignedInt
id NsObjectID
alias NsObjectName
wwpn NsWWN
source SmFcInitiatorAliasSource

GET v1/fibre_channel_initiator_aliases/id

Query parameters

Parameter Type
fields NsCommaSeparatedList

Description

Retrieve information on a set of Fibre Channel initiator aliases or a single Fibre Channel initiator alias.

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 for the Fibre Channel initiator alias. A 42 digit hexadecimal number. Example: '2a0df0fe6f7dc7bb16000000000000000000004817'.  
alias NsObjectName string Alias of the Fibre Channel initiator. String of up to 64 alphanumeric characters, - and . and : are allowed after first character. Example: 'myobject-5'.  
wwpn NsWWN string WWPN (World Wide Port Name) of the Fibre Channel initiator. Eight bytes expressed in hex separated by colons. Example: 'af:32:f1:20:bc:ba:43:1a'.  
source SmFcInitiatorAliasSource string enum Source of the Fibre Channel initiator alias. Possible values: 'invalid', 'user', 'fabric'.  

JSON Response

            
            
            {
                "id": "1e00000000000004d3000000000000000000000001",
                "alias":"itor1",
                "wwpn":"00:c9:ce:90:9b:84:c9:01",
                "source":"user"
            }