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

NAME

6       fcoemon - Open-FCoE service daemon
7

SYNOPSIS

9       fcoemon [-f|--foreground] [-l|--legacy] [-d|--debug] [-s|--syslog]
10
11       fcoemon -h|--help
12
13       fcoemon -v|--version
14

DESCRIPTION

16       The  fcoemon  daemon  is the core component of the Open-FCoE management
17       service.
18
19       The primary function of fcoemon is to control FCoE  instances.  fcoemon
20       will create, destroy, reset, enable and disable FCoE instances based on
21       system configuration, administrative commands, and runtime events.
22
23       On  startup,  fcoemon  will  create  FCoE  instances  defined  by   the
24       configuration  files  (see  FILES  section below). Since FCoE typically
25       relies on the Data Center Bridging (DCB) capabilities  of  an  Ethernet
26       interface, fcoemon establishes a connection with the LLDP daemon lldpad
27       to query the status of the DCB features on relevant Ethernet interfaces
28       and receive DCB configuration change events.
29
30       During  runtime, fcoemon will monitor network and lldpad events for the
31       relevant Ethernet interfaces and perform appropriate  actions  (create,
32       destroy,  enable, disable) on the FCoE instances. fcoemon also provides
33       a client interface via which the  fcoeadm  utility  is  able  to  issue
34       commands.
35
36       Installation  of  the  fcoe-utils  package  will set up an fcoe service
37       which will control the execution of the fcoemon daemon.
38

OPTIONS

40       -f, --foreground
41           Run fcoemon in the foreground.
42
43       -d, --debug
44           Enable debugging messages.
45
46       -l, --legacy
47           Force fcoemon to  use  the  legacy  /sys/module/libfcoe/parameters/
48           interface.   The   default  is  to  use  the  newer  /sys/bus/fcoe/
49           interfaces if they are available.
50
51       -s, --syslog
52           Use syslogd for logging. The default behavior is to log  to  stdout
53           and stderr.
54
55       -h, --help
56           Show help message with basic usage instructions
57
58       -v, --version
59           Show the version of the fcoemon command.
60

TERMINOLOGY

62       DCB
63           Data  Center  Bridging  A  set  of  Ethernet  enhancement standards
64           developed by the IEEE 802.1 Working Group.
65
66
67           See    http://www.ieee802.org/1/pages/dcbridges.html    for    more
68           information.
69
70       DCBX
71           DCB  Capabilities  Exchange Protocol, implemented by the DCB module
72           of lldpad. DCBX exchanges DCB capabilities and configuration with a
73           link partner as a series of values transferred using the Link Layer
74           Discovery Protocol (LLDP).
75
76       PFC
77           Priority-based Flow Control, a DCB feature.
78
79       App:FCoE
80           The FCoE instance of application specific parameters in DCBX.
81

CRITERIA USED FOR CONTROLLING THE FCOE INSTANCE

83       fcoemon uses two information sources for determining when to create  an
84       FCoE  instance: the state of the network interface, which may be a VLAN
85       interface, and, if required for the FCoE instance, the state of the DCB
86       configuration on the physical Ethernet interface.
87
88       First  of all, the network interface must be "up" for the FCoE instance
89       to be created. Secondly, if the FCoE configuration indicates  that  DCB
90       is  required,  then the following criteria must be satisfied before the
91       FCoE interface is created:
92
93       ·   DCB is enabled on the Ethernet interface.
94
95       ·   The PFC DCB feature is enabled and operational.
96
97       ·   The App:FCoE DCB feature is enabled and operational.
98
99       ·   The priority indicated by the App:FCoE feature is also enabled  for
100           PFC.
101
102       Once the FCoE instance is created by fcoemon, it will only be destroyed
103       under the following conditions:
104
105       ·   The driver for the Ethernet interface is unloaded.
106
107       ·   A user administratively destroys the FCoE instance using fcoeadm.
108
109       ·   The fcoemon daemon is terminated.
110
111       If DCB is required for the FCoE instance, and the DCB  settings  change
112       after  the  interface  is  created,  the following criteria are used to
113       disable the FCoE instance:
114
115       ·   DCB is disabled on the Ethernet interface.
116
117       ·   The App:FCoE DCB feature is not enabled.
118
119       ·   The App:FCoE and PFC features  are  operational  AND  the  priority
120           indicated by App:FCoE is not enabled for PFC.
121
122       Otherwise, the FCoE instance will always remain enabled.
123

CONFIGURATION

125       Once  the  fcoe-utils  and  lldpad packages have been installed and the
126       corresponding  services  are  running,   there   are   a   few   simple
127       configuration  steps  required  to get an FCoE instance up and running.
128       The following assumes that DCB will be required for the interface.
129
130       ·   Ensure that the configuration on the peer device (e.g. FCoE capable
131           switch) has the necessary configurations (VLANs, DCB, DCBX).
132
133       ·   Configure any needed VLAN interfaces on the local system.
134
135       ·   Create  and  configure /etc/fcoe/cfg-<ifname> files for the network
136           interfaces over which FCoE instances need to be  created.  See  the
137           FILES  sections  for  details.  Note  that ifname may be for a VLAN
138           interface.
139
140       ·   Restart the fcoe service (i.e.  fcoemon).
141
142       ·   The default DCB configuration of an Ethernet interface  managed  by
143           lldpad requires the following configuration using dcbtool.
144
145               dcbtool sc ethX dcb on          <-- enable DCB on the interface
146               dcbtool sc ethX app:fcoe e:1    <-- enable App:FCoE on the interface
147
148       These  steps  only  need  to  be  done one time. Note that if other DCB
149       configuration changes have been  made  with  dcbtool,  then  additional
150       changes  may  need  to be made in order to satisfy the DCB criteria for
151       creating an FCoE instance. Consult dcbtool for details.
152
153       Once these configuration steps have  been  performed,  use  fcoeadm  to
154       query the status of the FCoE instances.
155

FILES

157   /etc/fcoe/config
158       This is the primary configuration file for the fcoe system service. The
159       default options in this file are: DEBUG="no" and USE_SYSLOG="yes".  The
160       former  is  used  to  enable  debugging  messages from the fcoe service
161       script and fcoemon (via the --debug option). The latter is to  indicate
162       if  the  log  messages  are  to  be  output  to the system log (via the
163       --syslog  option).  SUPPORTED_DRIVERS  is  the  list  of   drivers   to
164       automatically  load during fcoe service start. Any changes to this file
165       will require a restart of the fcoe service.
166
167   /etc/sysconfig/fcoe
168       On systemd-enabled systems, this is the primary configuration file used
169       for  the  fcoe  system  service.  Add --debug to FCOEMON_OPTS to enable
170       debug log messages. Any changes to this file will require a restart  of
171       the fcoe service.
172
173   /etc/fcoe/cfg-<ifname>
174       These  files  are  read  by fcoemon on initialization. They are used to
175       indicate which Ethernet or VLAN interfaces should have  FCoE  instances
176       created.    The    option   values   in   this   file   normally   are:
177       FCOE_ENABLE="yes", DCB_REQUIRED="yes", and AUTO_VLAN="yes",  though  if
178       the variable values are omitted, they default to "no".
179
180       FCOE_ENABLE
181           is  used  to  enable/disable  creation  of  the  FCoE  instance. If
182           FCoE_ENABLE is set to "no", then  the  other  configuration  values
183           have no effect.
184
185       DCB_REQUIRED
186           indicates if the DCB service is required on the Ethernet interface.
187
188       AUTO_VLAN
189           indicates  if  VLAN  discovery should be performed. If AUTO_VLAN is
190           set to "yes", then once the link configuration has been  validated,
191           fcoemon  will  run  run  the  FIP  VLAN  discovery  protocol on the
192           Ethernet interface. Network  interfaces  for  any  discovered  FCoE
193           VLANs  will  be  automatically  created,  if  they  are not already
194           configured,  and  FCoE  instances  will  be  created  on  the  VLAN
195           interfaces.  If  the network interface specified by the filename is
196           already a VLAN interface, the AUTO_VLAN setting is ignored.
197
198       MODE
199           indicates whether operation will be in fabric or  vn2vn  mode.  The
200           default is fabric.
201
202       FIP_RESP
203           indicates  whether  a  FIP  responder  should  be activated on this
204           device to support  VLAN  discovery  in  a  vn2vn  environment.  The
205           default  is  "no".  Often  this  will  be used on a vn2vn node also
206           serving as a target. When using this option, the  AUTO_VLAN  should
207           not  be set and the supported VLANs should have configuration files
208           supplied, constituting a static VLAN  configuration  that  provides
209           the information for the FIP responder to return. This should be set
210           on a base device, which should probably  have  FCOE_ENABLE  set  to
211           "no"  since  presumably  FCoE  operation  will be on the configured
212           VLANs.
213
214       Note that the attached Ethernet peer device (e.g. FCoE  capable  switch
215       port)  must  have  compatible  settings  For  DCB  and FCoE to function
216       properly.
217
218   /etc/init.d/fcoe
219       This is the fcoe system service script. This script is invoked  by  the
220       init  process  or by the service command to start and stop the fcoemon.
221       On systemd-enabled systems, fcoemon is controlled via the  fcoe.service
222       unit.
223

VLAN NAMING CONVENTIONS

225       If  a  new VLAN device is created (see the description of the AUTO_VLAN
226       setting above), it will have the name dev.vlan-fcoe; where dev  is  the
227       name  of  the Ethernet parent device and vlan is the discovered VLAN ID
228       number.
229

SEE ALSO

231       fcoeadm(8) lldpad(8) lldptool(8) dcbtool(8)
232

SUPPORT

234       fcoemon is part of  the  fcoe-utils  package,  maintained  through  the
235       Open-FCoE project. Resources for both developers and users can be found
236       at the Open-FCoE website http://open-fcoe.org/
237
238
239
240Open-FCoE                         09/30/2015                        FCOEMON(8)
Impressum