NAME

       fcoeadm - The Fibre Channel over Ethernet (FCoE) administration tool

SYNOPSIS

       fcoeadm [-c|--create] [<ethX>]

       fcoeadm [-d|--destroy] [<ethX>]

       fcoeadm [-r|--reset] [<ethX>]

       fcoeadm [-i|--interface] [<ethX>]

       fcoeadm [-t|--target] [<ethX>]

       fcoeadm [-l|--lun] [<target_port_id> [<lun_id>]]

       fcoeadm [-s|--stats] [<ethX> [-n <interval>]]

       fcoeadm [-v|--version]

       fcoeadm [-h|--help]

DESCRIPTION

       The fcoeadm command is intended to be the FCoE management tool for the Linux systems.  The -c, -d, and -r
       options  are used to create, destroy, and reset an FCoE instance on a given network interface.  The other
       options are used to query the information of the FCoE instance which includes the interface  information,
       target information, LUN information, and port statistics.  The fcoeadm command invokes the HBAAPI library
       routines  to  obtain  these information.  The HBAAPI library routines invoke the vendor-specific library,
       libhbalinux, to grab the information from the /sys file system.  In  other  words,  the  fcoeadm  command
       requires  to  have  libHBAAPI  and  libhbalinux  installed  on  the  system  to work.  The libhbalinux is
       maintained at www.Open-FCoE.org. The installation instructions  of  libhbalinux  also  instructs  how  to
       download  the  HBAAPI source code, build and install with the libhbalinux.  The last option -h is used to
       show a brief usage message of the supported command syntax.

OPTIONS

       -c, --create <ethX>
              Creates an FCoE instance based on the given <ethX>.

       -d, --destroy <ethX>
              Destroys an FCoE instance based on the given <ethX>.

       -r, --reset <ethX>
              Resets the fc_host associated with the FCoE interface given by <ethX>.

       -i, --interface <ethX>
              Show the information of the FCoE instances created at <ethX>.  If  <ethX>  is  not  specified  the
              command will show the information of all the FCoE instances created on the system.

       -t, --target <ethX>
              Show  the information of all the discovered targets from the FCoE instances created at <ethX>.  If
              <ethX> is not specified the command will show the information of all the discovered  targets  from
              all the FCoE instances created.

       -l, --lun <target_port_id> <lun_id>
              Show  the  detailed  information  of  a  specific  LUN  with  <lun_id>  at the target with port id
              <target_port_id>. port id is also known as FC-ID. If <lun_id>  is  not  specified,  all  the  LUNs
              associated with the target will be shown.

       -s, --stats <ethX> -n <interval>
              Show  the  statistics  (including  FC4  statistics)  of the FCoE instances created at <ethX>.  The
              information will be display in one line on the screen per given time interval.  <interval>  should
              be  specified  in  whole  intergers  greater than 0. It specifies the time interval in the unit of
              second.  If <interval> is not specified, the default interval is one second.

       -v, --version
              Displays the version of the fcoeadm command.

       -h, --help
              Displays the usage message of the fcoeadm command.

       where <ethX> is the network interface name, such as eth0, eth1, etc.

EXAMPLES

       Creates an FCoE instance on eth2

              $ fcoeadm -c eth2

       Destroys the FCoE instance on eth2

              $ fcoeadm -d eth2

       Resets the FCoE instance on eth2

              $ fcoeadm -r eth2

       Show the information of all the adapters and their ports having FCoE instances created.

              $ fcoeadm -i

       Show the information of a specific interface eth3.  If eth3 has no FCoE instances  created,  the  command
       will show the error "No fc_host found for eth3".

              $ fcoeadm -i eth3

       Show the information of all the discovered targets from all the ports having FCoE instances created (they
       may  be  on different adapter cards). A brief listing of discovered LUNs are listed after the target they
       are associated with, if any.

              $ fcoeadm -t

       Show the information of all the discovered targets from a given port (eth3) having FCoE instance created.
       A brief listing of discovered LUNs are listed after each target they are associated with, if any.

              $ fcoeadm -t eth3

       Show the detailed information of all  the  LUNs  associated  with  a  specific  target.   The  target  is
       identified by its port id (aka FC-ID) 0xD700EF.

              $ fcoeadm -l 0xD700EF

              $ fcoeadm -l D700EF

              $ fcoeadm -l 0xd700ef

              $ fcoeadm -l d700ef

       Show  the  detailed  information of a LUN associated with a specific target.  The target is identified by
       its port id (aka FC-ID) 0xD700EF and the LUN is identified by its LUN id.

              $ fcoeadm -l 0xD700EF 1

       Show the statistics information of a specific port eth3 having FCoE instances  created.   The  statistics
       are  displayed  one  line  per  time  interval.  The  default  interval is one second if -n option is not
       specified.

              $ fcoeadm -s eth3

              $ fcoeadm -s eth3 -n 3

              $ fcoeadm -s eth3 -n3

REPORTING BUGS

       If you have identified a defect please either file a bug  or  engage  the  development  mailing  list  at
       <http://www.Open-FCoE.org>.

SUPPORT

       Open-FCoE  is maintained at <http://www.Open-FCoE.org>. There are resources available for both developers
       and users at that site.

Open-FCoE Applications                          November 4, 2008                                      FCOEADM(8)