1FCOEMON(8) Open-FCoE Tools FCOEMON(8)
2
6 fcoemon - Open-FCoE service daemon
7
9 fcoemon [-f|--foreground] [-d|--debug] [-s|--syslog]
10 fcoemon -h|--help
12 fcoemon -v|--version
14
16 The fcoemon daemon is the core component of the Open-FCoE management
17 service.
18 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 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 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 privides
33 a client interface via which the fcoeadm utility is able to issue
34 commands.
35 Instalation of the fcoe-utils package will set up an fcoe service which
37 will control the execution of the fcoemon daemon.
38
40 -f, --foreground
41 Run fcoemon in the foreground.
42 -d, --debug
44 Enable debugging messages.
45 -s, --syslog
47 Use syslogd for logging. The default behavior is to log to stdout
48 and stderr.
49 -h, --help
51 Show help message with basic usage instructions
52 -v, --version
54 Show the version of the fcoemon command.
55
57 DCB
58 Data Center Bridging A set of Ethernet enhancement standards
59 developed by the IEEE 802.1 Working Group.
60 See http://www.ieee802.org/1/pages/dcbridges.html for more
63 information.
64 DCBX
66 DCB Capabilities Exchange Protocol, implemented by the DCB module
67 of lldpad. DCBX exchanges DCB capabilities and configuration with a
68 link partner as a series of values transfered using the Link Layer
69 Discovery Protocol (LLDP).
70 PFC
72 Priority-based Flow Control, a DCB feature.
73 App:FCoE
75 The FCoE instance of application specific parameters in DCBX.
76
78 fcoemon uses two information sources for determining when to create an
79 FCoE instance: the state of the network interface, which may be a VLAN
80 interface, and, if required for the FCoE instance, the state of the DCB
81 configuration on the physical Ethernet interface.
82 First of all, the network interface must be "up" for the FCoE instance
84 to be created. Secondly, if the FCoE configuration indicates that DCB
85 is required, then the following criteria must be satisfied before the
86 FCoE interface is created:
87 · DCB is enabled on the Ethernet interface.
89 · The PFC DCB feature is enabled and operational.
91 · The App:FCoE DCB feature is enabled and operational.
93 · The priority indicated by the App:FCoE feature is also enabled for
95 PFC.
96 Once the FCoE instance is created by fcoemon, it will only be destroyed
98 under the following conditions:
99 · The driver for the Ethernet interface is unloaded.
101 · A user administratively destroys the FCoE instance using fcoeadm.
103 · The fcoemon daemon is terminated.
105 If DCB is required for the FCoE instance, and the DCB settings change
107 after the interface is created, the following criteria are used to
108 disable the FCoE instance:
109 · DCB is disabled on the Ethernet interface.
111 · The App:FCoE DCB feature is not enabled.
113 · The App:FCoE and PFC features are operational AND the priority
115 indicated by App:FCoE is not enabled for PFC.
116 Otherwise, the FCoE instance will remain enabled, but certain DCB
118 configurations that may be problematic will generate warning messages
119 in the log.
120
122 Once the fcoe-utils and lldpad packages have been installed and the
123 corresponding services are running, there are a few simple
124 configuration steps required to get an FCoE instance up and running.
125 The following assumes that DCB will be required for the interface.
126 · Ensure that the configuration on the peer device (e.g. FCoE capable
128 switch) has the necessary configurations (VLANs, DCB, DCBX).
129 · Configure any needed VLAN interfaces on the local system.
131 · Create and configure /etc/fcoe/cfg-<ifname> files for the network
133 interfaces over which FCoE instances need to be created. See the
134 FILES sections for details. Note that ifname may be for a VLAN
135 interface.
136 · Restart the fcoe service (i.e. fcoemon).
138 · The default DCB configuration of an Ethernet interface managed by
140 lldpad requires the following configuration using dcbtool.
141 dcbtool sc ethX dcb on <-- enable DCB on the interface
143 dcbtool sc ethX app:fcoe e:1 <-- enable App:FCoE on the interface
144 These steps only need to be done one time. Note that if other DCB
146 configuration changes have been made with dcbtool, then additional
147 changes may need to be made in order to satisfy the DCB criteria for
148 creating an FCoE instance. Consult dcbtool for details.
149 Once these configuration steps have been performed, use fcoeadm to
151 query the status of the FCoE instances.
152
154 /etc/fcoe/config
155 This is the primary configuration file for the fcoe system service. The
156 default options in this file are: DEBUG="no" and USE_SYSLOG="yes". The
157 former is used to enable debugging messages from the fcoe service
158 script and fcoemon (via the --debug option). The latter is to indicate
159 if the log messages are to be output to the system log (via the
160 --syslog option). Any changes to this file will require a restart of
161 the fcoe service.
162 /etc/fcoe/cfg-<ifname>
164 These files are read by fcoemon on initialization. They are used to
165 indicate which Ethernet or VLAN interfaces should have FCoE instances
166 created. The default options in this file are: FCOE_ENABLE="yes",
167 DCB_REQUIRED="yes", and AUTO_VLAN="yes".
168 FCOE_ENABLE
170 is used to enable/disable creation of the FCoE instance. If
171 FCoE_ENABLE is set to "no", then the other configuration values
172 have no effect.
173 DCB_REQUIRED
175 indicates if the DCB service is required on the Ethernet interface.
176 AUTO_VLAN
178 indicates if VLAN discovery should be performed. If AUTO_VLAN is
179 set to "yes", then once the link configuration has been validated,
180 fcoemon will run run the FIP VLAN discovery protocol on the
181 Ethernet interface. Network interfaces for any discovered FCoE
182 VLANs will be automatically created, if they are not already
183 configured, and FCoE instances will be created on the VLAN
184 interfaces. If the network interface specified by the filename is
185 already a VLAN interface, the AUTO_VLAN setting is ignored.
186 Note that the attached Ethernet peer device (e.g. FCoE capable switch
188 port) must have compatible settings For DCB and FCoE to function
189 properly.
190 /etc/init.d/fcoe
192 This is the fcoe system service script. This script is invoked by the
193 init process or by the service command to start and stop the fcoemon.
194
196 If a new VLAN device is created (see the description of the AUTO_VLAN
197 setting above), it will have the name dev.vlan-fcoe; where dev is the
198 name of the Ethernet parent device and vlan is the discovered VLAN ID
199 number.
200
202 fcoeadm(8) lldpad(8) lldptool(8) dcbtool(8)
203
205 fcoemon is part of the fcoe-utils package, maintained through the
206 Open-FCoE project. Resources for both developers and users can be found
207 at the Open-FCoE website http://open-fcoe.org/
208Open-FCoE 04/29/2010 FCOEMON(8)