1dcbtool(8)                  System Manager's Manual                 dcbtool(8)
2
3
4

NAME

6       dcbtool  -  manage the Data Center Bridging (DCB) settings of a CEE DCB
7       interface
8

SYNOPSIS

10       dcbtool -h
11       dcbtool -v
12       dcbtool [-rR]
13       dcbtool [-rR] [command] [command arguments]
14
15

DESCRIPTION

17       dcbtool is used to query and  set  the  DCB  settings  of  a  Converged
18       Enhanced Ethernet (CEE) DCB capable Ethernet interface.  It connects to
19       the client interface of lldpad to perform  these  operations.   dcbtool
20       will  operate  in interactive mode if it is executed without a command.
21       In interactive mode, dcbtool also functions as an  event  listener  and
22       will  print out events received from lldpad as they arrive. It will use
23       libreadline for interactive input when available. 802.1Qaz DCBX is  not
24       controllable from dcbtool instead lldptool can be used in this case.
25

OPTIONS

27       -h     show the dcbtool usage message
28
29       -v     shows dcbtool version information
30
31       -r     display  the raw lldpad client interface messages as well as the
32              readable output.
33
34       -R     display only the raw lldpad client interface messages
35

COMMANDS

37       help   shows the dcbtool usage message
38
39       ping   test command.  lldpad responds with "PPONG" if the client inter‐
40              face is operational.
41
42       license
43              displays dcbtool license information
44
45       quit   exit from interactive mode
46
47
48       The  following  commands  interact with lldpad to manage the daemon and
49       DCB features on DCB capable interfaces.
50
51       dcbtool general configuration commands:
52
53       <gc|go> dcbx
54              Get the configured or operational legacy  version  of  the  DCBX
55              protocol which will be supported by lldpad.  The configured ver‐
56              sion, if different from  the  operational  version,   will  take
57              effect after lldpad is restarted.
58
59       sc dcbx v:[cin|cee|force-cin|force-cee]
60              Set the legacy version of DCBX which will be supported by lldpad
61              the next time it is started.
62              Information about the CIN version can be found at:
63              <http://download.intel.com/technology/eedc/dcb_cep_spec.pdf>
64              Information about the CEE version can be found at:
65              <http://www.ieee802.org/1/files/public/docs2008/az-wadekar-dcbx-
66              capability-exchange-discovery-protocol-1108-v1.01.pdf>
67              The  dcbx  setting  is  a  global  setting and changes only take
68              effect when lldpad is restarted.  The default DCBX version  used
69              is  the  IEEE  standard  version.  If a pre-IEEE DCBX version is
70              received (per port) which matches the dcbx setting, then  lldpad
71              will  fall  back  to the configured global dcbx setting.  If the
72              dcbx setting is set to either 'force-cin'  or  'force-cee'  then
73              any  port  doing DCBX will start out in the corresponding legacy
74              DCBX mode.
75
76       DCB per-interface commands:
77
78       gc <ifname> <feature>
79              get configuration of feature on interface ifname.
80
81       go <ifname> <feature>
82              get operational status of feature on interface ifname.
83
84       gp <ifname> <feature>
85              get peer configuration of feature on interface ifname.
86
87       sc <ifname> <feature> <args>
88              set the configuration of feature on interface ifname.
89
90       feature may be one of the following:
91
92       dcb    DCB state of the port
93
94       pg     priority groups
95
96       pfc    priority flow control
97
98       app:<subtype>
99              application specific data
100
101       ll:<subtype>
102              logical link status
103
104       subtype can be:
105
106       0|fcoe Fiber Channel over Ethernet (FCoE)
107
108       1|iscsi
109              Internet Small Computer System Interface (iSCSI)
110
111       2|fip  FCoE Initialization Protocol (FIP)
112
113       args can include:
114
115       e:<0|1>
116              controls feature enable
117
118       a:<0|1>
119              controls whether the feature is advertised via DCBX to the peer
120
121       w:<0|1>
122              controls whether the feature is willing  to  change  its  opera‐
123              tional configuration based on what is received from the peer
124
125       [feature specific args]
126              arguments specific to a DCB feature
127
128
129       Feature specific arguments for dcb:
130
131       on|off enable or disable DCB for the interface.  The go and gp commands
132              are not needed for the dcb feature.  Also, the enable(e), adver‐
133              tise(a) and willing(w) arguments are not required.
134
135
136       Feature specific arguments for pg:
137
138       pgid:xxxxxxxx
139              Priority  group  ID  for  the  8 priorities.  From left to right
140              (priorities 0-7), x  is  the  corresponding  priority  group  ID
141              value, which can be 0-7 for priority groups with bandwidth allo‐
142              cations or f (priority group ID 15) for the unrestricted  prior‐
143              ity group.
144
145
146       pgpct:x,x,x,x,x,x,x,x
147              Priority group percentage of link bandwidth.  From left to right
148              (priority groups 0-7), x is the  percentage  of  link  bandwidth
149              allocated  to the corresponding priority group.  The total band‐
150              width must equal 100%.
151
152
153       uppct:x,x,x,x,x,x,x,x
154              Priority percentage of priority group bandwidth.  From  left  to
155              right  (priorities  0-7),  x is the percentage of priority group
156              bandwidth allocated to the corresponding priority.  The  sum  of
157              percentages  for  priorities  which  belong to the same priority
158              group must total 100% (except for priority group 15).
159
160
161       strict:xxxxxxxx
162              Strict priority setting.  From left to right (priorities 0-7), x
163              is 0 or 1.  1 indicates that the priority may utilize all of the
164              bandwidth allocated to its priority group.
165
166
167       up2tc:xxxxxxxx
168              Priority to traffic class mapping.  From left to right  (priori‐
169              ties 0-7), x is the traffic class (0-7) to which the priority is
170              mapped.
171
172
173       Feature specific arguments for pfc:
174
175       pfcup:xxxxxxxx
176              Enable/disable priority flow control.  From left to right  (pri‐
177              orities  0-7),  x is 0 or 1.  1 indicates that the corresponding
178              priority is configured to transmit priority pause.
179
180
181       Feature specific arguments for app:<subtype>:
182              The app features uses global enable and  willing  bits  for  all
183              subtypes. To remove or add subtypes to the TLV set the advertise
184              bit.
185
186
187       appcfg:xx
188              xx is a hexadecimal value representing an 8 bit bitmap  where  1
189              bits  indicate  the priorities which frames for the applications
190              specified by subtype should use. The lowest order  bit  maps  to
191              priority 0.
192
193
194       Feature specific arguments for ll:<subtype>:
195
196       status:[0|1]
197              For testing purposes, the logical link status may be set to 0 or
198              1.  Changes to the logical link status are not saved in the con‐
199              figuration file.
200
201

EXAMPLES

203       Enable DCB on interface eth2
204
205       dcbtool sc eth2 dcb on
206
207
208       Assign  priorities  0-3 to priority group 0, priorities 4-6 to priority
209       group 1 and priority 7 to the unrestricted  priority.   Also,  allocate
210       25% of link bandwidth to priority group 0 and 75% to group 1.
211
212       dcbtool sc eth2 pg pgid:0000111f pgpct:25,75,0,0,0,0,0,0
213
214
215       Enable transmit of Priority Flow Control for priority 3 and assign FCoE
216       to priority 3.
217
218       dcbtool sc eth2 pfc pfcup:00010000
219       dcbtool sc eth2 app:0 appcfg:08
220
221

SEE ALSO

223       lldpad(8), lldptool(8),  lldptool-dcbx(8),  lldptool-ets(8),  lldptool-
224       pfc(8), lldptool-app(8)
225
226
228       dcbtool - DCB configuration utility
229       Copyright(c)  2007-2012  Intel  Corporation.    Portions of dcbtool are
230       based on:
231
232       hostapd-0.5.7
233
234       Copyright
235              (c) 2004-2008, Jouni Malinen <j@w1.fi>
236
237

LICENSE

239       This program is free software; you can redistribute it and/or modify it
240       under  the terms and conditions of the GNU General Public License, ver‐
241       sion 2, as published by the Free Software Foundation.
242
243       This program is distributed in the hope it will be useful, but  WITHOUT
244       ANY  WARRANTY;  without even the implied warranty of MERCHANTABILITY or
245       FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General  Public  License
246       for more details.
247
248       You should have received a copy of the GNU General Public License along
249       with this program; if not, write to the Free Software Foundation, Inc.,
250       51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
251
252       The full GNU General Public License is included in this distribution in
253       the file called "COPYING".
254

SUPPORT

256       Contact Information: open-lldp Mailing List <lldp-devel@open-lldp.org>
257
258
259
260
261                                March 23, 2012                      dcbtool(8)
Impressum