APIs in Category: fc | API version 1.9

fc-config-adapter-disable fc-config-adapter-enable fc-config-list-iter-end fc-config-list-iter-next fc-config-list-iter-start fc-config-set-adapter-fc-type | Data ONTAP supports three separate functions with Fibre channel controllers: - Initiator mode for FC storage loops, FC TapeSAN, and OPR functionality - Target mode for SAN attach (FCP/Blocks access) functionality - FC-VI mode for MetroCluster/SlideRuler interconnect functionality These three functions are controlled by separate drivers. As DOT boots, the device driver attached to each FC adapter determines which function an adapter will support. The fc-config interface provides a user programmable mechanism to configure the personality of Fibre channel adapters by changing what driver attached to the adapter. Not all Fibre channel adapters support FC configuration. As of this writing only "embedded" Fibre channel adapters can be programmed with the fc-config interface. For more information refer to the "fcadmin config" CLI.

NetApp Manage ONTAP

fc-config-adapter-disable | [top]

> Call the corresponding adapter driver disable function to bring the adapter offline. Under some circumstances an adapter can not be put offline. (e.g. when the adapter is being used by the RAID sub-system to provide disks in a volume). In some cases, manual intervention is required. When this happens, an appropriate error messages is returned.

> Input Name | Range | Type | Description
> adapter-name |  | string | FC adapter name (e.g. 0a)

> Errno | Description
> EINTERNALERROR |  |
> EADAPTERNOTFOUND |  |
> EADAPTERINVALIDTYPE |  |
> ENOTSTARTED |  |
> EONTAPI_EINVAL |  |

fc-config-adapter-enable | [top]

> Call the corresponding adapter driver enable function to bring the adapter online. Under some circumstances an adapter can not be brought online. (e.g. when that adapter is in the UNCONFIGURED state, or when there is no cable attached to the adapter port). When this happens, an appropriate error messages is returned.

> Input Name | Range | Type | Description
> adapter-name |  | string | FC adapter name (e.g 0a)

> Errno | Description
> EINTERNALERROR |  |
> EADAPTERNOTFOUND |  |
> EADAPTERINVALIDTYPE |  |
> ENOTSTARTED |  |
> EONTAPI_EINVAL |  |

fc-config-list-iter-end | [top]

> Terminate the fc-config-list iteration

> Input Name | Range | Type | Description
> tag |  | string | Tag from a previous fc-config-list-iter-start.

> Errno | Description
> EONTAPI_ENOENT |  |

fc-config-list-iter-next | [top]

> Obtain a list of adapter configuration information.

> Input Name | Range | Type | Description
> maximum |  | integer | Maximum number of entries to retrieve.
> tag |  | string | Tag from a previous fc-config-list-iter-start.
> Output Name | Range | Type | Description
> adapter-info |  | fc-config-info[] | List of adapter information
> records |  | integer | This tells you how many records are being returned. When this value is 0, you have retrieved everything.

> Errno | Description
> EONTAPI_ENOENT |  |

fc-config-list-iter-start | [top]

> Start iteration through the list of adapter configuration information.

> Output Name | Range | Type | Description
> records |  | integer | Number of items that have been saved for future retrieval with fc-config-list-iter-next.
> tag |  | string | Tag to be used in subsequent iterations.

> Errno | Description
> EINTERNALERROR |  |
> EOPNOTSUPPORTED |  |

fc-config-set-adapter-fc-type | [top]

> fc-config-set-adapter-fc-type changes the adapter driver and/or configuration state. Each configurable adapter has an adapter-type and adapter-state. The adapter-type indicates which driver is attached to the adapter, the adapter-state indicates what the configuration state of the adapter is. The fc-type is used to modify both the adapter-type and the adapter-state. After setting the adapter fc-type a filer reboot is sometimes needed to make the change effective. Use fc-config-list-info to determine if a filer reboot is needed.

> Input Name | Range | Type | Description
> adapter-name |  | string | FC adapter name (e.g 0a)
> fc-type |  | string | Sets the type and state of the adapter. Possible inputs: "unconfigured" - set adapter-type to "initiator" and adapter-state to UNCONFIGURED "initiator" - set adapter-type to "initiator" and adapter-state to CONFIGURED "target" - set adapter-type to "target" and adapter-state to CONFIGURED "vi" - set adapter-type to "vi" and adapter-state to CONFIGURED

> Errno | Description
> EINTERNALERROR |  |
> EADAPTERNOTFOUND |  |
> EADAPTERINVALIDTYPE |  |
> EOPNOTSUPPORTED |  |
> EONTAPI_EINVAL |  |

Element definition: fc-config-info | [top]

> Name | Range | Type | Description
> adapter-name |  | string | FC adapter name (e.g. 0c)
> adapter-state |  | string | Indicates what the adapter configuration state is. Possible values: "UNDEFINED" - The default state. The adapter has never been configured. "CONFIGURED" - The adapter port is configured and the adapter is operational. "UNCONFIGURED" - The adapter is unconfigured. The initiator driver is attached, but the adapter is not operational. "PENDING" - The adapter is waiting for a filer reboot to effect an fc-type change. While in the PENDING state the adapter can not be used
> adapter-status |  | string | Possible values: "online" - adapter driver is enabled "offline" - adapter driver is disabled
> adapter-type |  | string | Indicates which driver is attached to the adapter. Possible values: "initiator" - the storage Initiator driver (default) "vi" - the FC-VI cluster interconnect driver "target" - the FCP Target driver
> pending-fc-type |  | string optional | If adapter-state is PENDING, this value tells what the last fc-config-set-adapter-fc-type command was.