| 1 |
.TH DCB-MAXRATE 8 "22 November 2020" "iproute2" "Linux" |
| 2 |
.SH NAME |
| 3 |
dcb-maxrate \- show / manipulate port maxrate 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 maxrate |
| 14 |
.RI "{ " COMMAND " | " help " }" |
| 15 |
.sp |
| 16 |
|
| 17 |
.ti -8 |
| 18 |
.B dcb maxrate show dev |
| 19 |
.RI DEV |
| 20 |
.RB "[ " tc-maxrate " ]" |
| 21 |
|
| 22 |
.ti -8 |
| 23 |
.B dcb maxrate set dev |
| 24 |
.RI DEV |
| 25 |
.RB "[ " tc-maxrate " " \fIRATE-MAP " ]" |
| 26 |
|
| 27 |
.ti -8 |
| 28 |
.IR RATE-MAP " := [ " RATE-MAP " ] " RATE-MAPPING |
| 29 |
|
| 30 |
.ti -8 |
| 31 |
.IR RATE-MAPPING " := { " TC " | " \fBall " }" \fB:\fIRATE\fR |
| 32 |
|
| 33 |
.ti -8 |
| 34 |
.IR TC " := { " \fB0\fR " .. " \fB7\fR " }" |
| 35 |
|
| 36 |
.ti -8 |
| 37 |
.IR RATE " := { " INTEGER "[" \fBbit\fR "] | " INTEGER\fBKbit\fR " | " |
| 38 |
.IR INTEGER\fBMib\fR " | " ... " }" |
| 39 |
|
| 40 |
.SH DESCRIPTION |
| 41 |
|
| 42 |
.B dcb maxrate |
| 43 |
is used to configure and inspect maximum rate at which traffic is allowed to |
| 44 |
egress from a given traffic class. |
| 45 |
|
| 46 |
.SH PARAMETERS |
| 47 |
|
| 48 |
The following describes only the write direction, i.e. as used with the |
| 49 |
\fBset\fR command. For the \fBshow\fR command, the parameter name is to be used |
| 50 |
as a simple keyword without further arguments. This instructs the tool to show |
| 51 |
the value of a given parameter. When no parameters are given, the tool shows the |
| 52 |
complete maxrate configuration. |
| 53 |
|
| 54 |
.TP |
| 55 |
.B tc-maxrate \fIRATE-MAP |
| 56 |
\fIRATE-MAP\fR uses the array parameter syntax, see |
| 57 |
.BR dcb (8) |
| 58 |
for details. Keys are TC indices, values are traffic rates in bits per second. |
| 59 |
The rates can use the notation documented in section PARAMETERS at |
| 60 |
.BR tc (8). |
| 61 |
Note that under that notation, "bit" stands for bits per second whereas "b" |
| 62 |
stands for bytes per second. When showing, the command line option |
| 63 |
.B -i |
| 64 |
toggles between using decadic and ISO/IEC prefixes. |
| 65 |
|
| 66 |
.SH EXAMPLE & USAGE |
| 67 |
|
| 68 |
Set rates of all traffic classes to 25Gbps, except for TC 6, which will |
| 69 |
have the rate of 100Gbps: |
| 70 |
|
| 71 |
.P |
| 72 |
# dcb maxrate set dev eth0 tc-maxrate all:25Gbit 6:100Gbit |
| 73 |
|
| 74 |
Show what was set: |
| 75 |
|
| 76 |
.P |
| 77 |
# dcb maxrate show dev eth0 |
| 78 |
.br |
| 79 |
tc-maxrate 0:25Gbit 1:25Gbit 2:25Gbit 3:25Gbit 4:25Gbit 5:25Gbit 6:100Gbit 7:25Gbit |
| 80 |
|
| 81 |
.SH EXIT STATUS |
| 82 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 83 |
|
| 84 |
.SH SEE ALSO |
| 85 |
.BR dcb (8) |
| 86 |
|
| 87 |
.SH REPORTING BUGS |
| 88 |
Report any bugs to the Network Developers mailing list |
| 89 |
.B <[email protected]> |
| 90 |
where the development and maintenance is primarily done. |
| 91 |
You do not have to be subscribed to the list to send a message there. |
| 92 |
|
| 93 |
.SH AUTHOR |
| 94 |
Petr Machata <[email protected]> |