1FIPVLAN(8)                      Open-FCoE Tools                     FIPVLAN(8)
2
3
4

NAME

6       fipvlan - Fibre Channel over Ethernet VLAN Discovery
7

SYNOPSIS

9       fipvlan     [-c|--create]    [-d|--debug]    [-s|--start]    [-m|--mode
10       fabric|vn2vn] [-u|--link-up] interfaces
11
12       fipvlan -a|--auto [-c|--create]  [-d|--debug]  [-s|--start]  [-m|--mode
13       fabric|vn2vn] [-l|--link-retry count] [-u|--link-up]
14
15       fipvlan -h|--help
16
17       fipvlan -v|--version
18

DESCRIPTION

20       The  fipvlan  command  performs  Fibre  Channel  over  Ethernet  (FCoE)
21       Initialization Protocol (FIP) VLAN Discovery over Ethernet  interfaces.
22       fipvlan  can be used as a diagnostic tool to determine which VLANs have
23       FCoE services  available  on  a  network,  prior  to  configuring  VLAN
24       interfaces  and  the  Open-FCoE  initiator. fipvlan can also be used to
25       create VLAN interfaces  as  they  are  discovered,  and  to  start  the
26       Open-FCoE  initiator.  The  --create  and --start options are primarily
27       intended to be used  as  part  of  an  Open-FCoE  boot  solution.  FCoE
28       instances started in this way cannot be destroyed or reset by fcoeadm.
29
30       fipvlan  takes  a  list  of  network  interface  names  to run the VLAN
31       discovery protocol over, or the --auto  option  to  use  all  available
32       Ethernet interfaces.
33
34       fipvlan  will  enable  any  interface  which  is  found disabled. If no
35       response is received on that interface it will be shutdown  again  when
36       fipvlan terminates.
37

OPTIONS

39       -a, --auto
40           Use all Ethernet interfaces currently available
41
42       -c, --create
43           Create  network  interfaces  for  discovered  FCoE VLANs. If a VLAN
44           device already exists for a discovered VLAN, a new VLAN device will
45           not be created.
46
47       -d, --debug
48           Enable debugging output
49
50       -s, --start
51           Start the Open-FCoE initiator on discovered FCoE VLANs
52
53       -m, --mode
54           fabric|vn2vn  Specify  whether  VLAN  discovery is performed in the
55           default fabric mode, or in VN2VN mode.
56
57       -f, --suffix suffix
58           Append the specified string suffix to VLAN interface names.
59
60       -l, --link-retry count
61           Retry check for link up to count times. The link state  is  checked
62           every 1000 ms. The default number of retries is 20.
63
64       -u, --link-up
65           Leave link up if a FIP response has been received.
66
67       -h, --help
68           Display a help message with basic usage instructions
69
70       -v, --version
71           Display the fipvlan version string
72

VLAN NAMING CONVENTIONS

74       If  a new VLAN device is created, it will have the name dev.vlan; where
75       dev is the  name  of  the  Ethernet  parent  device  and  vlan  is  the
76       discovered  VLAN  ID number. An optional suffix may be appended to this
77       with the the -f command line option.
78

EXAMPLES

80       Display all discoverable VLANs with FCoE services
81
82           fipvlan --auto
83
84       Discover FCoE VLANs on interface eth2, create VLAN  devices  and  start
85       the Open-FCoE initiator
86
87           fipvlan --create --start eth2
88
89       In  this example if FCoE services were available on VLAN 101 of network
90       interface eth2, then a VLAN interface eth2.101  would  be  created  and
91       used as the parent device for the initiator.
92

SEE ALSO

94       fcoeadm(8) fcoemon(8)
95

SUPPORT

97       fipvlan  is  part  of  the  fcoe-utils  package, maintained through the
98       Open-FCoE project. Resources for both developers and users can be found
99       at the Open-FCoE website http://open-fcoe.org/
100
101
102
103Open-FCoE                         12/02/2013                        FIPVLAN(8)