Debian Codegraph @

upstream/debian-unstable/man8/dcb.8

raw
1 .TH DCB 8 "19 October 2020" "iproute2" "Linux"
2 .SH NAME
3 dcb \- show / manipulate DCB (Data Center Bridging) settings
4 .SH SYNOPSIS
5 .sp
6 .ad l
7 .in +8
8
9 .ti -8
10 .B dcb
11 .RI "[ " OPTIONS " ] "
12 .RB "{ " app " | " buffer " | " ets " | " maxrate " | " pfc " }"
13 .RI "{ " COMMAND " | " help " }"
14 .sp
15
16 .ti -8
17 .B dcb
18 .RB "[ " -force " ] "
19 .BI "-batch " filename
20 .sp
21
22 .ti -8
23 .B dcb
24 .RI "[ " OPTIONS " ] "
25 .B help
26 .sp
27
28 .SH OPTIONS
29
30 .TP
31 .BR "\-n" , " \--netns " <NETNS>
32 Switches
33 .B dcb
34 to the specified network namespace
35 .IR NETNS .
36
37 .TP
38 .BR "\-V" , " --Version"
39 Print the version of the
40 .B dcb
41 utility and exit.
42
43 .TP
44 .BR "\-b", " --batch " <FILENAME>
45 Read commands from provided file or standard input and invoke them. The first
46 failure will cause termination of dcb.
47
48 .TP
49 .BR "\-f", " --force"
50 Don't terminate dcb on errors in batch mode. If there were any errors during
51 execution of the commands, the application return code will be non zero.
52
53 .TP
54 .BR "\-i" , " --iec"
55 When showing rates, use ISO/IEC 1024-based prefixes (Ki, Mi, Bi) instead of
56 the 1000-based ones (K, M, B).
57
58 .TP
59 .BR "\-j" , " --json"
60 Generate JSON output.
61
62 .TP
63 .BR "\-N" , " --Numeric"
64 If the subtool in question translates numbers to symbolic names in some way,
65 suppress this translation.
66
67 .TP
68 .BR "\-p" , " --pretty"
69 When combined with -j generate a pretty JSON output.
70
71 .TP
72 .BR "\-s" , " --statistics"
73 If the object in question contains any statistical counters, show them as
74 part of the "show" output.
75
76 .SH OBJECTS
77
78 .TP
79 .B app
80 - Configuration of application priority table
81
82 .TP
83 .B buffer
84 - Configuration of port buffers
85
86 .TP
87 .B ets
88 - Configuration of ETS (Enhanced Transmission Selection)
89
90 .TP
91 .B maxrate
92 - Configuration of per-TC maximum transmit rate
93
94 .TP
95 .B pfc
96 - Configuration of PFC (Priority-based Flow Control)
97
98 .SH COMMANDS
99
100 A \fICOMMAND\fR specifies the action to perform on the object. The set of
101 possible actions depends on the object type. As a rule, it is possible to
102 .B show
103 objects and to invoke topical
104 .B help,
105 which prints a list of available commands and argument syntax conventions.
106
107 .SH ARRAY PARAMETERS
108
109 Like commands, specification of parameters is in the domain of individual
110 objects (and their commands) as well. However, much of the DCB interface
111 revolves around arrays of fixed size that specify one value per some key, such
112 as per traffic class or per priority. There is therefore a single syntax for
113 adjusting elements of these arrays. It consists of a series of
114 \fIKEY\fB:\fIVALUE\fR pairs, where the meaning of the individual keys and values
115 depends on the parameter.
116
117 The elements are evaluated in order from left to right, and the latter ones
118 override the earlier ones. The elements that are not specified on the command
119 line are queried from the kernel and their current value is retained.
120
121 As an example, take a made-up parameter tc-juju, which can be set to charm
122 traffic in a given TC with either good luck or bad luck. \fIKEY\fR can therefore
123 be 0..7 (as is usual for TC numbers in DCB), and \fIVALUE\fR either of
124 \fBnone\fR, \fBgood\fR, and \fBbad\fR. An example of changing a juju value of
125 TCs 0 and 7, while leaving all other intact, would then be:
126
127 .P
128 # dcb foo set dev eth0 tc-juju 0:good 7:bad
129
130 A special key, \fBall\fR, is recognized which sets the same value to all array
131 elements. This can be combined with the usual single-element syntax. E.g. in the
132 following, the juju of all keys is set to \fBnone\fR, except 0 and 7, which have
133 other values:
134
135 .P
136 # dcb foo set dev eth0 tc-juju all:none 0:good 7:bad
137
138 .SH EXIT STATUS
139 Exit status is 0 if command was successful or a positive integer upon failure.
140
141 .SH SEE ALSO
142 .BR dcb-app (8),
143 .BR dcb-apptrust (8),
144 .BR dcb-buffer (8),
145 .BR dcb-dcbx (8),
146 .BR dcb-ets (8),
147 .BR dcb-maxrate (8),
148 .BR dcb-pfc (8),
149 .BR dcb-rewr (8)
150 .br
151
152 .SH REPORTING BUGS
153 Report any bugs to the Network Developers mailing list
154 .B <[email protected]>
155 where the development and maintenance is primarily done.
156 You do not have to be subscribed to the list to send a message there.
157
158 .SH AUTHOR
159 Petr Machata <[email protected]>