APIs in Category: fc
 Cluster-Mode API version 1.15

 
fc-config-adapter-disable
fc-config-adapter-enable
fc-config-list-info
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)
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.
 Errno  Description
 EINTERNALERROR
 EADAPTERNOTFOUND
 EADAPTERINVALIDTYPE
 ENOTSTARTED
 EONTAPI_EINVAL
 ENODENOTFOUND

 
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)
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.
 Errno  Description
 EINTERNALERROR
 EADAPTERNOTFOUND
 EADAPTERINVALIDTYPE
 ENOTSTARTED
 EONTAPI_EINVAL
 ENODENOTFOUND

 
fc-config-list-info [top]
Iterate over a list of fc objects.
Input Name Range Type Description
desired-attributes fc-config
optional
Specify the attributes that should be returned. If not present, all attributes for which information is available will be returned. If present, only the desired attributes for which information is available will be returned.
max-records [1..100] integer
optional
The maximum number of records to return in this call. Default: 20
query fc-config
optional
A query that specifies which objects to return. A query could be specified on any number of attributes in the fc object. All fc objects matching this query up to 'max-records' will be returned.
tag string
optional
Specify the tag from the last call. It is usually not specified for the first call. For subsequent calls, copy values from the 'next-tag' obtained from the previous call.
 
Output Name Range Type Description
attributes-list fc-config[]
optional
The list of attributes of fc objects.
next-tag string
optional
Tag for the next call. Not present when there are no more fc objects to return.
num-records [0..100] integer
The number of records returned in this call.
 Errno  Description
 EONTAPI_ENOENT
 EONTAPI_EINVAL
 EINTERNALERROR
 EADAPTERNOTFOUND
 EADAPTERINVALIDTYPE
 ENOTSTARTED
 ENODENOTFOUND

 
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
node-name string
optional
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.
 Errno  Description
 EINTERNALERROR
 EADAPTERNOTFOUND
 EADAPTERINVALIDTYPE
 EOPNOTSUPPORTED
 EONTAPI_EINVAL
 ENODENOTFOUND

 
Element definition: fc-config [top]
fc config When returned as part of the output, all elements of this typedef are reported, unless limited by a set of desired attributes specified by the caller.

When used as input to specify desired attributes to return, omitting a given element indicates that it shall not be returned in the output. In contrast, by providing an element (even with no value) the caller ensures that a value for that element will be returned, given that the value can be retrieved.

When used as input to specify queries, any element can be omitted in which case the resulting set of objects is not constrained by any specific value of that attribute.

Name Range Type Description
adapter-name string
optional
Adapter name Attributes: key, non-creatable, non-modifiable
adapter-state string
optional
Adapter current state Attributes: non-creatable, non-modifiable
adapter-status string
optional
Adapter online status Attributes: non-creatable, non-modifiable
adapter-type string
optional
Adaptaer type Attributes: non-creatable, non-modifiable
node-name string
optional
Node name Attributes: key, non-creatable, non-modifiable
pending-fc-type string
optional
Pending reason Attributes: non-creatable, non-modifiable