FCoE instances are not allowed to be controlled by fcoeadm. They cannot be destroyed, reset or even scanned by fcoeadm. They can, however, be monitored by fcoeadm. This patch tries to clarify this behavior in the documentation.
V2: Added --Scan fix per Ross. V3: Further --Scan description change per Ross. Signed-off-by: Mark Rustad <mark.d.rus...@intel.com> Tested-by: Ross Brattain <ross.b.bratt...@intel.com> --- doc/fcoeadm.8 | 10 +++++----- doc/fcoeadm.txt | 10 +++++++--- doc/fcoemon.8 | 4 ++-- doc/fipvlan.8 | 6 +++--- doc/fipvlan.txt | 5 +++-- 5 files changed, 20 insertions(+), 15 deletions(-) diff --git a/doc/fcoeadm.8 b/doc/fcoeadm.8 index 6773710..3df0082 100644 --- a/doc/fcoeadm.8 +++ b/doc/fcoeadm.8 @@ -2,12 +2,12 @@ .\" Title: fcoeadm .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 05/24/2011 +.\" Date: 10/18/2011 .\" Manual: Open-FCoE Tools .\" Source: Open-FCoE .\" Language: English .\" -.TH "FCOEADM" "8" "05/24/2011" "Open\-FCoE" "Open\-FCoE Tools" +.TH "FCOEADM" "8" "10/18/2011" "Open\-FCoE" "Open\-FCoE Tools" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -54,12 +54,12 @@ Creates an FCoE instance based on the specified network interface\&. Note that i .PP \fB\-d\fR, \fB\-\-destroy\fR \fIethX\fR .RS 4 -Destroys the FCoE instance on the specified network interface\&. +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\&. +Resets the FCoE instance on the specified network interface\&. This will not reset FCoE instances created by fipvlan\&. .RE .PP \fB\-i\fR, \fB\-\-interface\fR [\fIethX\fR] @@ -69,7 +69,7 @@ Show information about the FCoE instance on the specified network interface, or .PP \fB\-S\fR, \fB\-\-Scan\fR \fIethX\fR .RS 4 -Validates that the interface name has an active FCoE session\&. +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\-t\fR, \fB\-\-target\fR [\fIethX\fR] diff --git a/doc/fcoeadm.txt b/doc/fcoeadm.txt index 75cee9a..e70dd7f 100644 --- a/doc/fcoeadm.txt +++ b/doc/fcoeadm.txt @@ -61,17 +61,21 @@ OPTIONS FCoE instance will not require DCB. *-d*, *--destroy* _ethX_:: - Destroys the FCoE instance on the specified network interface. + Destroys the FCoE instance on the specified network interface. This + will not destroy FCoE instances created by fipvlan. *-r*, *--reset* _ethX_:: - Resets the FCoE instance on the specified network interface. + Resets the FCoE instance on the specified network interface. This + will not reset FCoE instances created by fipvlan. *-i*, *--interface* [_ethX_]:: Show information about the FCoE instance on the specified network interface, or all FCoE instances if no network interface is specified. *-S*, *--Scan* _ethX_:: - Validates that the interface name has an active FCoE session. + 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. *-t*, *--target* [_ethX_]:: Show information about the discovered targets associated with the diff --git a/doc/fcoemon.8 b/doc/fcoemon.8 index 1510828..9641b26 100644 --- a/doc/fcoemon.8 +++ b/doc/fcoemon.8 @@ -2,12 +2,12 @@ .\" Title: fcoemon .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 05/25/2011 +.\" Date: 10/06/2011 .\" Manual: Open-FCoE Tools .\" Source: Open-FCoE .\" Language: English .\" -.TH "FCOEMON" "8" "05/25/2011" "Open\-FCoE" "Open\-FCoE Tools" +.TH "FCOEMON" "8" "10/06/2011" "Open\-FCoE" "Open\-FCoE Tools" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- diff --git a/doc/fipvlan.8 b/doc/fipvlan.8 index 74fb30e..c26ea1c 100644 --- a/doc/fipvlan.8 +++ b/doc/fipvlan.8 @@ -2,12 +2,12 @@ .\" Title: fipvlan .\" Author: [FIXME: author] [see http://docbook.sf.net/el/author] .\" Generator: DocBook XSL Stylesheets v1.75.2 <http://docbook.sf.net/> -.\" Date: 04/01/2010 +.\" Date: 10/06/2011 .\" Manual: Open-FCoE Tools .\" Source: Open-FCoE .\" Language: English .\" -.TH "FIPVLAN" "8" "04/01/2010" "Open\-FCoE" "Open\-FCoE Tools" +.TH "FIPVLAN" "8" "10/06/2011" "Open\-FCoE" "Open\-FCoE Tools" .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -29,7 +29,7 @@ fipvlan \- Fibre Channel over Ethernet VLAN Discovery \fBfipvlan\fR \-v|\-\-version .SH "DESCRIPTION" .sp -The \fBfipvlan\fR command performs Fibre Channel over Ethernet (FCoE) Initialization Protocol (FIP) VLAN Discovery over Ethernet interfaces\&. \fBfipvlan\fR can be used as a diagnostic tool to determine which VLANs have FCoE services available on a network, prior to configuring VLAN interfaces and the \fIOpen\-FCoE\fR initiator\&. \fBfipvlan\fR can also be used to create VLAN interfaces as the are discovered, and to start the \fIOpen\-FCoE\fR initiator\&. The \fB\-\-create\fR and \fB\-\-start\fR options are primarily intended to be used as part of an \fIOpen\-FCoE\fR boot solution\&. +The \fBfipvlan\fR command performs Fibre Channel over Ethernet (FCoE) Initialization Protocol (FIP) VLAN Discovery over Ethernet interfaces\&. \fBfipvlan\fR can be used as a diagnostic tool to determine which VLANs have FCoE services available on a network, prior to configuring VLAN interfaces and the \fIOpen\-FCoE\fR initiator\&. \fBfipvlan\fR can also be used to create VLAN interfaces as they are discovered, and to start the \fIOpen\-FCoE\fR initiator\&. The \fB\-\-create\fR and \fB\-\-start\fR options are primarily intended to be used as part of an \fIOpen\-FCoE\fR boot solution\&. FCoE instances started in this way cannot be destroyed or reset by fcoeadm\&. .sp \fBfipvlan\fR takes a list of network interface names to run the VLAN discovery protocol over, or the \fB\-\-auto\fR option to use all available Ethernet interfaces\&. .SH "OPTIONS" diff --git a/doc/fipvlan.txt b/doc/fipvlan.txt index 6e894e9..aa90d8b 100644 --- a/doc/fipvlan.txt +++ b/doc/fipvlan.txt @@ -34,9 +34,10 @@ Initialization Protocol (FIP) VLAN Discovery over Ethernet interfaces. *fipvlan* can be used as a diagnostic tool to determine which VLANs have FCoE services available on a network, prior to configuring VLAN interfaces and the _Open-FCoE_ initiator. *fipvlan* can also be used to create VLAN -interfaces as the are discovered, and to start the _Open-FCoE_ initiator. +interfaces as they are discovered, and to start the _Open-FCoE_ initiator. The *--create* and *--start* options are primarily intended to be used as -part of an _Open-FCoE_ boot solution. +part of an _Open-FCoE_ boot solution. FCoE instances started in this way +cannot be destroyed or reset by fcoeadm. *fipvlan* takes a list of network interface names to run the VLAN discovery protocol over, or the *--auto* option to use all available Ethernet _______________________________________________ devel mailing list devel@open-fcoe.org https://lists.open-fcoe.org/mailman/listinfo/devel
