fipvlan(8)

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] [-s|--start]
12
13       fipvlan -h|--help
14
15       fipvlan -v|--version
16

DESCRIPTION

18       The  fipvlan  command  performs  Fibre  Channel  over  Ethernet  (FCoE)
19       Initialization Protocol (FIP) VLAN Discovery over Ethernet  interfaces.
20       fipvlan  can be used as a diagnostic tool to determine which VLANs have
21       FCoE services  available  on  a  network,  prior  to  configuring  VLAN
22       interfaces  and  the  Open-FCoE  initiator. fipvlan can also be used to
23       create VLAN  interfaces  as  the  are  discovered,  and  to  start  the
24       Open-FCoE  initiator.  The  --create  and --start options are primarily
25       intended to be used as part of an Open-FCoE boot solution.
26
27       fipvlan takes a list  of  network  interface  names  to  run  the  VLAN
28       discovery  protocol  over,  or  the  --auto option to use all available
29       Ethernet interfaces.
30

OPTIONS

32       -a, --auto
33           Use all Ethernet interfaces currently available
34
35       -c, --create
36           Create network interfaces for discovered  FCoE  VLANs.  If  a  VLAN
37           device already exists for a discovered VLAN, a new VLAN device will
38           not be created.
39
40       -s, --start
41           Start the Open-FCoE initiator on discovered FCoE VLANs
42
43       -h, --help
44           Display a help message with basic usage instructions
45
46       -v, --version
47           Display the fipvlan version string
48

VLAN NAMING CONVENTIONS

50       If a new VLAN device is created, it will have the  name  dev.vlan-fcoe;
51       where  dev  is  the  name of the Ethernet parent device and vlan is the
52       discovered VLAN ID number.
53

EXAMPLES

55       Display all discoverable VLANs with FCoE services
56
57           fipvlan --auto
58
59       Discover FCoE VLANs on interface eth2, create VLAN  devices  and  start
60       the Open-FCoE initiator
61
62           fipvlan --create --start eth2
63
64       In  this example if FCoE services were available on VLAN 101 of network
65       interface eth2, then a VLAN interface eth2.101-fcoe  would  be  created
66       and used as the parent device for the initiator.
67

SUPPORT

72       fipvlan  is  part  of  the  fcoe-utils  package, maintained through the
73       Open-FCoE project. Resources for both developers and users can be found
74       at the Open-FCoE website http://open-fcoe.org/
75
76
77
78Open-FCoE                         04/01/2010                        FIPVLAN(8)