'\" t
.\"     Title: fcoeadm
.\"    Author: [FIXME: author] [see http://docbook.sf.net/el/author]
.\" Generator: DocBook XSL Stylesheets v1.78.1 <http://docbook.sf.net/>
.\"      Date: 10/14/2013
.\"    Manual: Open-FCoE Tools
.\"    Source: Open-FCoE
.\"  Language: English
.\"
.TH "FCOEADM" "8" "10/14/2013" "Open\-FCoE" "Open\-FCoE Tools"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
fcoeadm \- The Open\-FCoE Administration Tool
.SH "SYNOPSIS"
.sp
\fBfcoeadm\fR [\-m|\-\-mode fabric|vn2vn] \-c|\-\-create \fIethX\fR
.sp
\fBfcoeadm\fR \-d|\-\-destroy \fIethX\fR
.sp
\fBfcoeadm\fR \-r|\-\-reset \fIethX\fR
.sp
\fBfcoeadm\fR \-S|\-\-Scan [\fIethX\fR]
.sp
\fBfcoeadm\fR \-i|\-\-interface [\fIethX\fR]
.sp
\fBfcoeadm\fR \-f|\-\-fcf [\fIethX\fR]
.sp
\fBfcoeadm\fR \-t|\-\-target [\fIethX\fR]
.sp
\fBfcoeadm\fR \-l|\-\-lun [\fIethX\fR]
.sp
\fBfcoeadm\fR \-s|\-\-stats \fIethX\fR [\fIinterval\fR]
.sp
\fBfcoeadm\fR \-b|\-\-lesb \fIethX\fR [\fIinterval\fR]
.sp
\fBfcoeadm\fR \-h|\-\-help
.sp
\fBfcoeadm\fR \-v|\-\-version
.SH "DESCRIPTION"
.sp
The \fBfcoeadm\fR utility is the Fibre Channel over Ethernet (FCoE) management tool for the \fIOpen\-FCoE\fR project\&. \fBfcoeadm\fR may be used to create, destroy, and reset an FCoE instance on a given network interface\&. For these operations \fBfcoeadm\fR sends a command to a running \fBfcoemon\fR process, via a socket interface\&. \fBfcoemon\fR will then perform the requested operation\&.
.sp
\fBfcoeadm\fR also provides operations to query information about FCoE instances, including interface information, target information, LUN information, and port statistics\&. For much of this information, \fBfcoeadm\fR relies on the \fIlibhbalinux\fR implementation of the \fIHBA API\fR\&. Only one operation may be given on a command\&.
.SH "OPTIONS"
.PP
\fB\-m\fR, \fB\-\-mode\fR fabric|vn2vn
.RS 4
Used together with the create option to control the FCoE mode of operation\&. The mode defaults to fabric but this option allows the selection of vn2vn mode\&.
.RE
.SH "OPERATIONS"
.PP
\fB\-c\fR, \fB\-\-create\fR \fIethX\fR
.RS 4
Creates an FCoE instance based on the specified network interface\&. Note that if there is not an fcoemon configuration file for the interface (/etc/fcoe/cfg\-ethX, see
\fBfcoemon\fR), then the created FCoE instance will not require DCB\&.
.RE
.PP
\fB\-d\fR, \fB\-\-destroy\fR \fIethX\fR
.RS 4
Destroys the FCoE instance on the specified network interface\&. This will not destroy FCoE instances created by fipvlan\&.
.RE
.PP
\fB\-r\fR, \fB\-\-reset\fR \fIethX\fR
.RS 4
Resets the FCoE instance on the specified network interface\&. This will not reset FCoE instances created by fipvlan\&.
.RE
.PP
\fB\-S\fR, \fB\-\-Scan\fR \fIethX\fR
.RS 4
Rescan for new targets and LUNs on the provided instance\&. This command will not rescan any NPIV instances created on the same port\&. This will not rescan any FCoE instance created by fipvlan\&.
.RE
.PP
\fB\-i\fR, \fB\-\-interface\fR [\fIethX\fR]
.RS 4
Show information about the FCoE instance on the specified network interface, or all FCoE instances if no network interface is specified\&.
.RE
.PP
\fB\-f\fR, \fB\-\-fcf\fR [\fIethX\fR]
.RS 4
Show information about the discovered Fibre Channel Forwarders (FCFs) on the specified network interface, or all discovered FCFs if no network interface is specified\&.
.RE
.PP
\fB\-t\fR, \fB\-\-target\fR [\fIethX\fR]
.RS 4
Show information about the discovered targets associated with the FCoE instance on the specified network interface\&. If no network interface is specified, information about discovered targets from all FCoE instances will be shown\&.
.RE
.PP
\fB\-l\fR, \fB\-\-lun\fR [\fIethX\fR]
.RS 4
Show detailed information about the discovered SCSI LUNs associated with the FCoE instance on the specified network interface\&. If no network interface is specified, information about SCSI LUNs from all FCoE instances will be shown\&.
.RE
.PP
\fB\-s\fR, \fB\-\-stats\fR \fIethX\fR [\fIinterval\fR]
.RS 4
Show the statistics (including FC4 statistics) of the FCoE connection on the specified network interface\&. The information will be displayed repeatedly until the user cancels the command\&. The statistics will be printed every specified
\fIinterval\fR
(in seconds)\&.
\fIinterval\fR
should be specified as a whole number greater than 0\&. If
\fIinterval\fR
is not specified, a default interval of one second is used\&.
.RE
.PP
\fB\-b\fR, \fB\-\-lesb\fR \fIethX\fR [\fIinterval\fR]
.RS 4
Show the Link Error Statistics Block (LESB) of the FCoE connection on the specified network interface\&. The information will be displayed repeatedly until the user cancels the command\&. The LESB statistics will be printed every specified
\fIinterval\fR
(in seconds)\&.
\fIinterval\fR
should be specified in whole integers greater than 0\&. If the
\fIinterval\fR
is not specified, a default interval of one second is used\&.
.RE
.PP
\fB\-h\fR, \fB\-\-help\fR
.RS 4
Displays the usage message of the
\fBfcoeadm\fR
command\&.
.RE
.PP
\fB\-v\fR, \fB\-\-version\fR
.RS 4
Displays the version of the
\fBfcoeadm\fR
command\&.
.RE
.SH "INTERFACE NAMES"
.sp
The actual name for \fIethX\fR depends on the \fBAUTO_VLAN\fR setting in the fcoemon interface configuration (/etc/fcoe/cfg\-ethX, see \fBfcoemon\fR)\&.
.sp
If \fBAUTO_VLAN\fR is set to \fIyes\fR, the interface name \fIethX\fR references the network device itself\&. If \fBAUTO_VLAN\fR is set to \fIno\fR, the interface name \fIethX\fR references the VLAN device\&.
.SH "EXAMPLES"
.sp
Creates an FCoE instance on eth2\&.101
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-c eth2\&.101
.fi
.if n \{\
.RE
.\}
.sp
Creates an FCoE VN2VN instance on eth2\&.101
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-m vn2vn \-c eth2\&.101
.fi
.if n \{\
.RE
.\}
.sp
Destroys the FCoE instance on eth2\&.101
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-d eth2\&.101
.fi
.if n \{\
.RE
.\}
.sp
Resets the FCoE instance on eth2\&.101
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-r eth2\&.101
.fi
.if n \{\
.RE
.\}
.sp
Show the information of all the adapters and their ports having FCoE instances created
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-i
.fi
.if n \{\
.RE
.\}
.sp
Show the information of all FCoE instances on interface eth3\&.
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-i eth3
.fi
.if n \{\
.RE
.\}
.sp
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
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-t
.fi
.if n \{\
.RE
.\}
.sp
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
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-t eth3
.fi
.if n \{\
.RE
.\}
.sp
Show the detailed information of all the LUNs discovered on all FCoE connections
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-l
.fi
.if n \{\
.RE
.\}
.sp
Show the detailed information of all the LUNs associated with a specific interface
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-l eth3\&.101
.fi
.if n \{\
.RE
.\}
.sp
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 an interval is not specified
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-s eth3
.fi
.if n \{\
.RE
.\}
.sp
.if n \{\
.RS 4
.\}
.nf
fcoeadm \-s eth3 3
.fi
.if n \{\
.RE
.\}
.SH "SEE ALSO"
.sp
\fBfcoemon\fR(8)
.SH "SUPPORT"
.sp
\fBfcoeadm\fR is part of the \fIfcoe\-utils\fR package, maintained through the \fIOpen\-FCoE\fR project\&. Resources for both developers and users can be found at the \fIOpen\-FCoE\fR website http://open\-fcoe\&.org/