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

NAME

6       dcbtool  -  manage  the  Data  Center  Bridging (DCB) settings of a 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 DCB capable Eth‐
18       ernet interface.  It connects to the client interface of lldpad to per‐
19       form these operations.  dcbtool will operate in interactive mode if  it
20       is executed without a command.  In interactive mode, dcbtool also func‐
21       tions as an event listener and will print out events received from lld‐
22       pad as they arrive.
23

OPTIONS

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

COMMANDS

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

EXAMPLES

183       Enable DCB on interface eth2
184
185       dcbtool sc eth2 dcb on
186
187
188       Assign  priorites  0-3  to  priority group 0, priorites 4-6 to priority
189       group 1 and priority 7 to the unrestricted  priority.   Also,  allocate
190       25% of link bandwidth to priority group 0 and 75% to group 1.
191
192       dcbtool sc eth2 pg pgid:0000111f pgpct:25,75,0,0,0,0,0,0
193
194
195       Enable transmit of Priority Flow Control for priority 3 and assign FCoE
196       to priority 3.
197
198       dcbtool sc eth2 pfc pfcup:00010000
199       dcbtool sc eth2 app:0 appcfg:08
200
201
203       dcbtool - DCB configuration utility
204       Copyright(c) 2007-2010 Intel Corporation.    Portions  of  dcbtool  are
205       based on:
206
207       hostapd-0.5.7
208
209       Copyright
210              (c) 2004-2008, Jouni Malinen <j@w1.fi>
211
212

LICENSE

214       This program is free software; you can redistribute it and/or modify it
215       under the terms and conditions of the GNU General Public License,  ver‐
216       sion 2, as published by the Free Software Foundation.
217
218       This  program is distributed in the hope it will be useful, but WITHOUT
219       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
220       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
221       for more details.
222
223       You should have received a copy of the GNU General Public License along
224       with this program; if not, write to the Free Software Foundation, Inc.,
225       51 Franklin St - Fifth Floor, Boston, MA 02110-1301 USA.
226
227       The full GNU General Public License is included in this distribution in
228       the file called "COPYING".
229

SUPPORT

231       Contact  Information: e1000-eedc Mailing List <e1000-eedc@lists.source‐
232       forge.net> Intel Corporation, 5200 N.E. Elam Young Parkway,  Hillsboro,
233       OR 97124-6497
234
235
236
237
238                                 June 29, 2009                      dcbtool(8)
Impressum