Debian Codegraph @

upstream/debian-unstable/man8/dcb-pfc.8

raw
1 .TH DCB-PFC 8 "31 October 2020" "iproute2" "Linux"
2 .SH NAME
3 dcb-pfc \- show / manipulate PFC (Priority-based Flow Control) 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 pfc
14 .RI "{ " COMMAND " | " help " }"
15 .sp
16
17 .ti -8
18 .B dcb pfc show dev
19 .RI DEV
20 .RB "[ " pfc-cap " ]"
21 .RB "[ " prio-pfc " ]"
22 .RB "[ " macsec-bypass " ]"
23 .RB "[ " delay " ]"
24 .RB "[ " requests " ]"
25 .RB "[ " indications " ]"
26
27 .ti -8
28 .B dcb pfc set dev
29 .RI DEV
30 .RB "[ " prio-pfc " " \fIPFC-MAP " ]"
31 .RB "[ " macsec-bypass " { " on " | " off " } ]"
32 .RB "[ " delay " " \fIINTEGER\fR " ]"
33
34 .ti -8
35 .IR PFC-MAP " := [ " PFC-MAP " ] " PFC-MAPPING
36
37 .ti -8
38 .IR PFC-MAPPING " := { " PRIO " | " \fBall " }" \fB:\fR "{ "
39 .IR \fBon\fR " | " \fBoff\fR " }"
40
41 .ti -8
42 .IR PRIO " := { " \fB0\fR " .. " \fB7\fR " }"
43
44 .SH DESCRIPTION
45
46 .B dcb pfc
47 is used to configure Priority-based Flow Control attributes through Linux
48 DCB (Data Center Bridging) interface. PFC permits marking flows with a
49 certain priority as lossless, and holds related configuration, as well as
50 PFC counters.
51
52 .SH PARAMETERS
53
54 For read-write parameters, the following describes only the write direction,
55 i.e. as used with the \fBset\fR command. For the \fBshow\fR command, the
56 parameter name is to be used as a simple keyword without further arguments. This
57 instructs the tool to show the value of a given parameter. When no parameters
58 are given, the tool shows the complete PFC configuration.
59
60 .TP
61 .B pfc-cap
62 A read-only property that shows the number of traffic classes that may
63 simultaneously support PFC.
64
65 .TP
66 .B requests
67 A read-only count of the sent PFC frames per traffic class. Only shown when
68 -s is given, or when requested explicitly.
69
70 .TP
71 .B indications
72 A read-only count of the received PFC frames per traffic class. Only shown
73 when -s is given, or when requested explicitly.
74
75 .TP
76 .B macsec-bypass \fR{ \fBon\fR | \fBoff\fR }
77 Whether the sending station is capable of bypassing MACsec processing when
78 MACsec is disabled.
79
80 .TP
81 .B prio-pfc \fIPFC-MAP
82 \fIPFC-MAP\fR uses the array parameter syntax, see
83 .BR dcb (8)
84 for details. Keys are priorities, values are on / off indicators of whether
85 PFC is enabled for a given priority.
86
87 .TP
88 .B delay \fIINTEGER
89 The allowance made for round-trip propagation delay of the link in bits.
90 The value shall be 0..65535.
91
92 .SH EXAMPLE & USAGE
93
94 Enable PFC on priorities 6 and 7, leaving the rest intact:
95
96 .P
97 # dcb pfc set dev eth0 prio-pfc 6:on 7:on
98
99 Disable PFC of all priorities except 6 and 7, and configure delay to 4096
100 bits:
101
102 .P
103 # dcb pfc set dev eth0 prio-pfc all:off 6:on 7:on delay 0x1000
104
105 Show what was set:
106
107 .P
108 # dcb pfc show dev eth0
109 .br
110 pfc-cap 8 macsec-bypass off delay 4096
111 .br
112 prio-pfc 0:off 1:off 2:off 3:off 4:off 5:off 6:on 7:on
113
114 .SH EXIT STATUS
115 Exit status is 0 if command was successful or a positive integer upon failure.
116
117 .SH SEE ALSO
118 .BR dcb (8)
119
120 .SH REPORTING BUGS
121 Report any bugs to the Network Developers mailing list
122 .B <[email protected]>
123 where the development and maintenance is primarily done.
124 You do not have to be subscribed to the list to send a message there.
125
126 .SH AUTHOR
127 Petr Machata <[email protected]>