APIs in Category: fcport
Cluster-Mode API version 1.15

 
fcport-get-link-state

NetApp Manage ONTAP
 
fcport-get-link-state [top]

Get the link state of a specific adapter on this system.
Input Name Range Type Description
adapter-name string
The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name -- for example, "8a" or "11b". If adapter-name is not supplied, the command will return EAPIMISSINGARGUMENT.
node-name string
This field is only valid when the request is sent to the Admin Vserver LIF. This is the storage system name the command will be executed on.
 
Output Name Range Type Description
adapter-link-state link-state-info[]
adapter link state info
adapter-name string
The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name.
 Errno  Description
 EAPIMISSINGARGUMENT
 EOPNOTSUPPORTED
 EINVALIDINPUTERROR
 EINTERNALERROR

 
Element definition: link-state-info [top]
list link-state info of a specific adapter channel
Name Range Type Description
adapter-name string
The adapter name is either a slot number, or, if a port letter is also presented, a slot number and port letter concatenated into a single name.
fc-port-info fc-ports
optional
fiber channel port information. Present only when link-state field value is "up".
link-state string
Possible values: "initing", "down", "up", "offline-physical", "offline-logical", or "zombified", which the adapter has stopped sending I/O and is ignoring link events. This state may occur when shelf firmware is being updated.
node-name string
optional
This field is only valid when the request is sent to the Admin Vserver LIF, in which case it is the storage system name.

 
Element definition: fc-ports [top]
Information about the ports belonging to the fiber channel adapter
Name Range Type Description
port-number string
optional
This represents the physical port number of the FC port. Field is not present when port-type is "l-port"
port-type string
Type of port. Possible values: "l-port", loop port, node port used to connect a node to a Fibre Channel loop. "nl-port", network+loop port, node port which connects to both loops and switches. "n-port", network port, node port used to connect a node to a Fibre Channel switch.
switch-name string
optional
Thsi is the switch name, if any, connected to the FC port. Field is not present when port-type is "l-port"
switch-wwn string
optional
This is the world wide name of the switch, if any, connected to the FC port. Field is not present when port-type is "l-port"