logo
Manual Pages
Table of Contents

NAME

na_fcadmin - Commands for managing Fibre Channel adapters.

SYNOPSIS

fcadmin command argument ...

DESCRIPTION

The fcadmin utility manages the Fibre Channel adapters used by the storage subsystem. Use these commands to show link and loop level protocol statistics, list the storage devices connected to the filer, and configure the personality of embedded adapters.

USAGE

fcadmin config
[ <adapter_name> ... ] fcadmin config
[ -? ]
[ -e | -d ]
[ -t {target|initiator|unconfigured} ] [ <adapter_name> ... ] fcadmin [link_stats|fcal_stats|device_map] <adapter_name>

DESCRIPTION

The fcadmin link_stats, fcal_stats and device_map commands are identical to the fcstat command options. For more information, see na_fcstat(1) The fcadmin config command configures the personality of embedded Fibre channel (FC) adapters. When no arguments are given, the fcadmin config command returns configuration information about all of the embedded FC adapter(s) on the filer. Embedded FC adapters always appear in slot 0. If no embedded FC adapters exist, the fcadmin config command is not supported and an error is returned. The fcadmin config command displays the following information: Adapter:
An adapter name of the form Xy, where X is zero and y is a letter (e.g. 0a or 0c). Type: The type of adapter: initiator or target. The adapter type is determined by which device driver controls the adapter. When the storage initiator driver is attached, the adapter is an initiator. When the FCP target mode driver is attached, the adapter is a target. A filer reboot is required to attach a new driver when the adapter type is changed. The storage initiator driver is attached prior to any configuration changes. The default adapter type is initiator. Status:
The status of the adapter, online or offline, reported from the attached driver. Before changing the adapter type, the status must indicate that the adapter is offline. State: The configuration state of the adapter. Use the configuration state to track changes in the the type and state of the adapter. The following configuration states exist:
CONFIGURED
The adapter is configured and the specified driver is attached. This is the normal operating state.
UNCONFIGURED
The adapter is forced offline by the attached driver and cannot be used. This state is only valid when the initiator driver is attached (the adapter Type is initiator).
PENDING
An adapter Type and/or State change is pending. A filer reboot is required for the change to take effect. While in the PENDING state, the adapter is forced offline by the attached driver and cannot be used.
There are three possible PENDING substates: (target), (initiator), and (unconfigured). When changing the adapter type from initiator to target, the adapter moves to the PENDING (target) state. When changing the adapter type from target to initiator, the adapter moves to the PENDING (initiator) state. The PENDING (unconfigured) state means that a change is pending that will affect both the type and state of the adapter. The PENDING (unconfigured) state only occurs when the target driver is attached to the adapter (the adapter ype is target) and a change has been made to move the adapter to the UNCONFIGURED state. When the initiator driver is attached, no reboot is required to change between the CONFIGURED and UNCONFIGURED state.

DISPLAYS

Example output: 
  filer> fcadmin config

                    Local
  Adapter Type      State                  Status
  ---------------------------------------------------
    0a   initiator  CONFIGURED             online
    0b   initiator  UNCONFIGURED           offline
    0c   initiator  PENDING (target)       offline
    0d   target     PENDING (unconfigured) offline

OPTIONS

-?
Provides online help for the fcadmin config command.
-e
Enables the adapter by calling the attached driver's online routine. When the adapter type is initiator, it has the same effect as the storage enable adapter command. When the adapter type is target, it has the same effect as the fcp config up command. Enabling the adapter changes the adapter status from offline to online.
-d
Disables the adapter by calling the attached driver's offline routine. When the adapter type is initiator, it has the same effect as the storage disable adapter command. When the adapter type is target, it has the same effect as calling the fcp con_fig down command. Disabling the adapter changes the adapter status from online to offline.
-t type
Changes the adapter type and/or state. Valid type arguments are initiator, target, and unconfigured. Before changing the adapter configuration with this option, the adapter must be offline. You can take the adapter offline in a number of ways. If using the -d option does not work, use the utilities for the attached driver. You can also force the adapter offline by removing the FC cable from the adapter port at the back of the filer. If a filer reboot is required to change the adapter configuration following the use of this option, the adapter moves to the PENDING (type) state to indicate that a reboot is required.
adapter_name
The name of one or more adapters, separated by spaces. When no other option is provided, the specified adapter(s) configuration displays. If no adapter_name argument is provided, the configurations of all adapters display.

NOTES

Automatic Reconfiguration
Under some circumstances, the filer may boot with the wrong driver attached. When this happens the embedded adapters are reprogrammed to their proper type and state and the filer is automatically rebooted to attach the correct driver. Before rebooting, the fci.config.autoReboot EMS message displays on the console. Events that can cause this problem include maintenance head swaps, use of the console set-defaults command, and other operations that affect the filer's boot environment state. Repair
When DataONTAP is fully initialized and running, configuring an adapter with the fcadmin config utility records the adapter configuration in both the filer's boot environment and on-disk, in the filer's root volume. Following a console set_defaults operation, a maintenance head swap, or other event that destroys the boot environment state, the initiator driver is attached to all embedded adapters during boot. This ensures that all storage loops are discovered during boot. After the filer's root volume comes online, the boot environment configuration is checked against the on-disk configuration information. If a misconfiguration is detected, the boot environment information is restored and the filer automatically reboots to attach the correct drivers and restore the original configuration. This provides consistency between maintenance head swaps and other events which destroy the boot environment. Maintenance Mode Operation
You can use the fcadmin config utility while in Maintenance Mode. After changing the adapter configuration in Maintenance Mode, a reboot is required for the change to take effect. When run from Maintenance Mode, no on-disk configuration information can be stored because the filer's root volume is unavailable. To account for this, the fcadmin config utility indicates that the boot environment configuration needs to be recorded ondisk during a subsequent reboot. After changing the adapter configuration in Maintenance Mode, the boot environment configuration becomes canonical. Otherwise, the on-disk configuration is canonical. New Installations
Following a new installation of Data ONTAP, the ondisk configuration information is undefined. When this condition is encountered, then the boot environment configuration becomes canonical and the ondisk configuration is programmed to match the existing boot environment configuration. In this way the embedded adapter configuration is preserved across new installations. To modify this behavior you must perform a console set-defaults operation, and/or use the fcadmin config utility in Maintenance Mode to change the configuration, prior to installing Data ONTAP.

CLUSTER CONSIDERATIONS

Symmetric target adapter configuration needed in a CFO: To support the FCP cfmodes partner, standby, mixed, and dual_fabric, both filers must share a symmetric adapter configuration. For example, if adapters 0a and 0c are configured as a target on one CFO filer, then adapters 0a and 0c must be configured as a target on the partner filer. Non-symmetric adapter configurations cause service interruptions during CFO takeover and giveback. Use of fcadmin config during takeover: After a takeover occurs, you can use the fcadmin config utility to read the partner head's on-disk configuration information. When this is done, only the adapter type and state are reported. The online/offline status cannot be reported because no hardware is present. You can use this functionality to determine the partner head's embedded port configuration prior to doing a giveback. You cannot change the adapter type and state when run from partner mode. Example output: 
  dopey(takeover)> partner fcadmin config

  Warning: The system has been taken over. Adapter configuration is not possible.

                    Partner
  Adapter Type      State                  Status
  ---------------------------------------------------
    0a   initiator  CONFIGURED.            ---
    0b   initiator  UNCONFIGURED           ---
    0c   target     CONFIGURED             ---
    0d   target     CONFIGURED             ---

  Maintenance head swaps in a CFO:

  During a maintenance head swap procedure in a CFO, the embedded adapter configuration
  must be changed before doing a giveback to avoid FCP service interruptions. When the
  embedded adapters are used for FCP target mode operation in a CFO, boot
  the new head into Maintenance Mode prior to doing the first giveback and use
  the fcadmin config utility to restore the adapter configuration.
  For more information about Maintenance Mode operation, see na_floppyboot(1).


EMS MESSAGES
  fci.config.offline:

         The fci.config.offline message displays anytime  an
         adapter  fails to come online because of a mismatch
         in the configuration state.

         _NF_NF_
         For example:

          surf> storage enable adapter 0a
          Host adapter 0a enable failed
          Tue Aug 3 16:13:46 EDT [surf: fci.config.offline:notice]: Fibre channel adapter 0a is offline because it is in the PENDING (target) state.
fci.config.state: The fci.config.state message displays anytime an adapter has changed states: 
  For example:

  surf> fcadmin config -t target 0a
  A reboot is required for the new adapter configuration to take effect.
  Mon Aug    2 14:53:04 EDT [surf: fci.config.state:notice]: Fibre channel initiator adapter 0a is in the PENDING (target) state.
fci.config.needsReboot: The fci.config.needsReboot message displays when a service is started while there are adapters in the PENDING state waiting for reconfiguration: 
  For example:

     surf> fcp start
     FCP service is running
     Thu Aug 5 16:09:27 EDT [surf: fci.config.needsReboot:warning]: Reboot the filer for Fibre channel target adapter(s) 5a 5b to become available.
fci.config.autoReboot: Under some circumstances, the filer automatically reboots to ensure the adapter configuration is correct. The fci.config.autoReboot message displays to notify the user of this condition. This condition is normally only encountered after a maintenance head swap procedure. fci.config.error: This message indicates an error has occured during the Auto-reconfiguration process. The specified adapter(s) will be unavailable until the problem is fixed. fcp.service.config: The fcp.service.config message displays anytime the FCP service is started on a platform which supports fc configuration but no target adapters are present.

ERRORS

"The system has been taken over. Adapter configuration is not possible." "platform does not support FC adapter configuration" "adapter adapter_name is not configurable" "can't find adapter adapter_name" "can't configure adapter adapter_name to type type" "invalid boardType value" "invalid adapterType value" "Invalid type argument: type" "internal error" "can't determine adapter adapter_name status" "adapter adapter_name must be offline before changing configuration" "adapter adapter_name failed to come online" "adapter adapter_name failed to go offline" "failed to configure adapter adapter_name to the <offline or online> state" "adapter adapter_name is in use. Must set adapter offline by storage disable adapter command, or disconnect cable."

BUGS

Under some circumstances an adapter can not be put offline with the fcadmin config -d command. When this happens use the associated driver utility, fcp config or storage disable adapter, to change the adapter status or remove the cable from the adapter port at the back of the filer.

SEE ALSO

na_cf(1), na_fcp(1), na_storage(1), na_san(1), na_floppyboot(1), na_fcstat(1)
Table of Contents