APIs in Category: fcport | 7-Mode API version 1.21

fcport-get-link-state fcport-reset-dev fcport-send-lip fcport-set-offline fcport-set-online

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.
> 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 |  |

fcport-reset-dev | [top]

> When invoked the device will be reset. The device will be temporarily suspended while it is reset, after which it will resume processing device operations. This command should be used with care as it can have adverse effects, for instance pending commands to the device will be aborted when issuing this command.

> Input Name | Range | Type | Description
> device-id |  | string | The device id is presented as a slot number followed by the port letter concatenated with the device-id. These two parts are separated by a period. For example 6b.5 If the device-id is omitted EAPIMISSINGARGUMENT will be returned. If the device-id is invalid EINVALIDINPUTERROR will be returned.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> EINVALIDINPUTERROR |  |
> EOPNOTSUPPORTED |  |

fcport-send-lip | [top]

> This will initiate a loop initialization on the specified fibrechannel loop port. The loop will be temporarily suspended while it is initialized, after which it will resume processing loop operations. This command should be used with care, because it can have adverse effects, like pending commands will be aborted when issuing this command.

> Input Name | Range | Type | Description
> loop-id |  | string | The loop id is presented as a slot number and port letter concatenated (for example 6a). If the loop-id is omitted EAPIMISSINGARGUMENT will be returned. If the loop-id is invalid EINVALIDINPUTERROR will be returned.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> EINVALIDINPUTERROR |  |
> ELOOPUNAVAILABLE |  |

fcport-set-offline | [top]

> Offline a specific adapter on this system. This API should be used with care, as it can have adverse side effects, which you lose access to all devices of that port. The operation of offlining the already offlined adapter will be considered success.

> 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.

> Errno | Description
> EAPIMISSINGARGUMENT |  |
> EOPNOTSUPPORTED |  |
> EINVALIDINPUTERROR |  |
> EINTERNALERROR |  |

fcport-set-online | [top]

> Online a specific adapter on this system. The operation of onlining the already onlined adapter will be considered success.

> 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.

> 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.

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"