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] [-s|--start] interfaces
10
11       fipvlan     -a|--auto     [-c|--create]    [-d|--debug]    [-s|--start]
12       [-l|--link-retry count]
13
14       fipvlan -h|--help
15
16       fipvlan -v|--version
17

DESCRIPTION

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

OPTIONS

38       -a, --auto
39           Use all Ethernet interfaces currently available
40
41       -c, --create
42           Create network interfaces for discovered  FCoE  VLANs.  If  a  VLAN
43           device already exists for a discovered VLAN, a new VLAN device will
44           not be created.
45
46       -d, --debug
47           Enable debugging output
48
49       -s, --start
50           Start the Open-FCoE initiator on discovered FCoE VLANs
51
52       -f, --suffix suffix
53           Append the specified string suffix to VLAN interface names.
54
55       -l, --link-retry count
56           Retry check for link up to count times. The link state  is  checked
57           every 500 ms. The default number of retries is 20.
58
59       -h, --help
60           Display a help message with basic usage instructions
61
62       -v, --version
63           Display the fipvlan version string
64

VLAN NAMING CONVENTIONS

66       If  a new VLAN device is created, it will have the name dev.vlan; where
67       dev is the  name  of  the  Ethernet  parent  device  and  vlan  is  the
68       discovered  VLAN  ID number. An optional suffix may be appended to this
69       with the the -f command line option.
70

EXAMPLES

72       Display all discoverable VLANs with FCoE services
73
74           fipvlan --auto
75
76       Discover FCoE VLANs on interface eth2, create VLAN  devices  and  start
77       the Open-FCoE initiator
78
79           fipvlan --create --start eth2
80
81       In  this example if FCoE services were available on VLAN 101 of network
82       interface eth2, then a VLAN interface eth2.101  would  be  created  and
83       used as the parent device for the initiator.
84

SEE ALSO

86       fcoeadm(8) fcoemon(8)
87

SUPPORT

89       fipvlan  is  part  of  the  fcoe-utils  package, maintained through the
90       Open-FCoE project. Resources for both developers and users can be found
91       at the Open-FCoE website http://open-fcoe.org/
92
93
94
95Open-FCoE                         02/06/2013                        FIPVLAN(8)