| 1 |
.TH DCB-ETS 8 "19 October 2020" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
dcb-ets \- show / manipulate ETS (Enhanced Transmission Selection) settings of |
| 4 |
the DCB (Data Center Bridging) subsystem |
| 5 |
.SH SYNOPSIS |
| 6 |
.sp |
| 7 |
.ad l |
| 8 |
.in +8 |
| 9 |
|
| 10 |
.ti -8 |
| 11 |
.B dcb |
| 12 |
.RI "[ " OPTIONS " ] " |
| 13 |
.B ets |
| 14 |
.RI "{ " COMMAND " | " help " }" |
| 15 |
.sp |
| 16 |
|
| 17 |
.ti -8 |
| 18 |
.B dcb ets show dev |
| 19 |
.RI DEV |
| 20 |
.RB "[ " willing " ]" |
| 21 |
.RB "[ " ets-cap " ]" |
| 22 |
.RB "[ " cbs " ]" |
| 23 |
.RB "[ " tc-tsa " ]" |
| 24 |
.RB "[ " reco-tc-tsa " ]" |
| 25 |
.RB "[ " pg-bw " ]" |
| 26 |
.RB "[ " tc-bw " ]" |
| 27 |
.RB "[ " reco-tc-bw " ]" |
| 28 |
.RB "[ " prio-tc " ]" |
| 29 |
.RB "[ " reco-prio-tc " ]" |
| 30 |
|
| 31 |
.ti -8 |
| 32 |
.B dcb ets set dev |
| 33 |
.RI DEV |
| 34 |
.RB "[ " willing " { " on " | " off " } ]" |
| 35 |
.RB "[ { " tc-tsa " | " reco-tc-tsa " } " \fITSA-MAP\fB " ]" |
| 36 |
.RB "[ { " pg-bw " | " tc-bw " | " reco-tc-bw " } " \fIBW-MAP\fB " ]" |
| 37 |
.RB "[ { " prio-tc " | " reco-prio-tc " } " \fIPRIO-MAP\fB " ]" |
| 38 |
|
| 39 |
.ti -8 |
| 40 |
.IR TSA-MAP " := [ " TSA-MAP " ] " TSA-MAPPING |
| 41 |
|
| 42 |
.ti -8 |
| 43 |
.IR TSA-MAPPING " := { " TC " | " \fBall " }" \fB: "{ " \fBstrict\fR " | " |
| 44 |
.IR \fBcbs\fR " | " \fBets\fR " | " \fBvendor\fR " }" |
| 45 |
|
| 46 |
.ti -8 |
| 47 |
.IR BW-MAP " := [ " BW-MAP " ] " BW-MAPPING |
| 48 |
|
| 49 |
.ti -8 |
| 50 |
.IR BW-MAPPING " := { " TC " | " \fBall " }" \fB:\fIINTEGER\fR |
| 51 |
|
| 52 |
.ti -8 |
| 53 |
.IR PRIO-MAP " := [ " PRIO-MAP " ] " PRIO-MAPPING |
| 54 |
|
| 55 |
.ti -8 |
| 56 |
.IR PRIO-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fITC\fR |
| 57 |
|
| 58 |
.ti -8 |
| 59 |
.IR TC " := { " \fB0\fR " .. " \fB7\fR " }" |
| 60 |
|
| 61 |
.ti -8 |
| 62 |
.IR PRIO " := { " \fB0\fR " .. " \fB7\fR " }" |
| 63 |
|
| 64 |
.SH DESCRIPTION |
| 65 |
|
| 66 |
.B dcb ets |
| 67 |
is used to configure Enhanced Transmission Selection attributes through Linux |
| 68 |
DCB (Data Center Bridging) interface. ETS permits configuration of mapping of |
| 69 |
priorities to traffic classes, traffic selection algorithm to use per traffic |
| 70 |
class, bandwidth allocation, etc. |
| 71 |
|
| 72 |
Two DCB TLVs are related to the ETS feature: a configuration and recommendation |
| 73 |
values. Recommendation values are named with a prefix |
| 74 |
.B reco-, |
| 75 |
while the configuration ones have plain names. |
| 76 |
|
| 77 |
.SH PARAMETERS |
| 78 |
|
| 79 |
For read-write parameters, the following describes only the write direction, |
| 80 |
i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the |
| 81 |
parameter name is to be used as a simple keyword without further arguments. This |
| 82 |
instructs the tool to show the value of a given parameter. When no parameters |
| 83 |
are given, the tool shows the complete ETS configuration. |
| 84 |
|
| 85 |
.TP |
| 86 |
.B ets-cap |
| 87 |
A read-only property that shows the number of supported ETS traffic classes. |
| 88 |
|
| 89 |
.TP |
| 90 |
.B cbs |
| 91 |
A read-only property that is enabled if the driver and the hardware support the |
| 92 |
CBS Transmission Selection Algorithm. |
| 93 |
|
| 94 |
.TP |
| 95 |
.B willing \fR{ \fBon\fR | \fBoff\fR } |
| 96 |
Whether local host should accept configuration from peer TLVs. |
| 97 |
|
| 98 |
.TP |
| 99 |
.B prio-tc \fIPRIO-MAP |
| 100 |
.TQ |
| 101 |
.B reco-prio-tc \fIPRIO-MAP |
| 102 |
\fIPRIO-MAP\fR uses the array parameter syntax, see |
| 103 |
.BR dcb (8) |
| 104 |
for details. Keys are priorities, values are traffic classes. For each priority, |
| 105 |
sets a TC where traffic with that priority is directed to. |
| 106 |
|
| 107 |
.TP |
| 108 |
.B tc-tsa \fITSA-MAP |
| 109 |
.TQ |
| 110 |
.B reco-tc-tsa \fITSA-MAP |
| 111 |
\fITSA-MAP\fR uses the array parameter syntax, see |
| 112 |
.BR dcb (8) |
| 113 |
for details. Keys are TCs, values are Transmission Selection Algorithm (TSA) |
| 114 |
keywords described below. For each TC, sets an algorithm used for deciding how |
| 115 |
traffic queued up at this TC is scheduled for transmission. Supported TSAs are: |
| 116 |
|
| 117 |
.B strict |
| 118 |
- for strict priority, where traffic in higher-numbered TCs always takes |
| 119 |
precedence over traffic in lower-numbered TCs. |
| 120 |
.br |
| 121 |
.B ets |
| 122 |
- for Enhanced Traffic Selection, where available bandwidth is distributed among |
| 123 |
the ETS-enabled TCs according to the weights set by |
| 124 |
.B tc-bw |
| 125 |
and |
| 126 |
.B reco-tc-bw\fR, |
| 127 |
respectively. |
| 128 |
.br |
| 129 |
.B cbs |
| 130 |
- for Credit Based Shaper, where traffic is scheduled in a strict manner up to |
| 131 |
the limit set by a shaper. |
| 132 |
.br |
| 133 |
.B vendor |
| 134 |
- for vendor-specific traffic selection algorithm. |
| 135 |
|
| 136 |
.TP |
| 137 |
.B tc-bw \fIBW-MAP |
| 138 |
.TQ |
| 139 |
.B reco-tc-bw \fIBW-MAP |
| 140 |
\fIBW-MAP\fR uses the array parameter syntax, see |
| 141 |
.BR dcb (8) |
| 142 |
for details. Keys are TCs, values are integers representing percent of available |
| 143 |
bandwidth given to the traffic class in question. The value should be 0 for TCs |
| 144 |
whose TSA is not \fBets\fR, and the sum of all values shall be 100. As an |
| 145 |
exception to the standard wording, a configuration with no \fBets\fR TCs is |
| 146 |
permitted to sum up to 0 instead. |
| 147 |
.br |
| 148 |
|
| 149 |
.TP |
| 150 |
.B pg-bw \fIBW-MAP |
| 151 |
The precise meaning of \fBpg-bw\fR is not standardized, but the assumption seems |
| 152 |
to be that the same scheduling process as on the transmit side is applicable on |
| 153 |
receive side as well, and configures receive bandwidth allocation for \fBets\fR |
| 154 |
ingress traffic classes (priority groups). |
| 155 |
|
| 156 |
.SH EXAMPLE & USAGE |
| 157 |
|
| 158 |
Configure ETS priomap in a one-to-one fashion: |
| 159 |
|
| 160 |
.P |
| 161 |
# dcb ets set dev eth0 prio-tc 0:0 1:1 2:2 3:3 4:4 5:5 6:6 7:7 |
| 162 |
|
| 163 |
Set TSA and transmit bandwidth configuration: |
| 164 |
|
| 165 |
.P |
| 166 |
# dcb ets set dev eth0 tc-tsa all:strict 0:ets 1:ets 2:ets \\ |
| 167 |
.br |
| 168 |
tc-bw all:0 0:33 1:33 2:34 |
| 169 |
|
| 170 |
Show what was set: |
| 171 |
|
| 172 |
.P |
| 173 |
# dcb ets show dev eth0 prio-tc tc-tsa tc-bw |
| 174 |
.br |
| 175 |
prio-tc 0:0 1:1 2:2 3:3 4:4 5:5 6:6 7:7 |
| 176 |
.br |
| 177 |
tc-tsa 0:ets 1:ets 2:ets 3:strict 4:strict 5:strict 6:strict 7:strict |
| 178 |
.br |
| 179 |
tc-bw 0:33 1:33 2:34 3:0 4:0 5:0 6:0 7:0 |
| 180 |
|
| 181 |
.SH EXIT STATUS |
| 182 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 183 |
|
| 184 |
.SH SEE ALSO |
| 185 |
.BR dcb (8) |
| 186 |
|
| 187 |
.SH REPORTING BUGS |
| 188 |
Report any bugs to the Network Developers mailing list |
| 189 |
.B <[email protected]> |
| 190 |
where the development and maintenance is primarily done. |
| 191 |
You do not have to be subscribed to the list to send a message there. |
| 192 |
|
| 193 |
.SH AUTHOR |
| 194 |
Petr Machata <[email protected]> |