]>
Commit | Line | Data |
---|---|---|
dcd8d142 RA |
1 | .TH TIPC-LINK 8 "02 Jun 2015" "iproute2" "Linux" |
2 | ||
85e3c87c VS |
3 | .\" For consistency, please keep padding right aligned. |
4 | .\" For example '.B "foo " bar' and not '.B foo " bar"' | |
dcd8d142 RA |
5 | |
6 | .SH NAME | |
7 | tipc-link \- show links or modify link properties | |
8 | ||
9 | .SH SYNOPSIS | |
10 | .ad l | |
11 | .in +8 | |
12 | ||
13 | .ti -8 | |
14 | ||
15 | .ti -8 | |
16 | .B tipc link set | |
17 | .RB "{ " "priority " | |
18 | .IR PRIORITY | |
19 | .RB "| " tolerance | |
20 | .IR TOLERANCE | |
21 | .RB "| " window | |
22 | .IR "WINDOW " } | |
23 | .BI "link " LINK | |
24 | ||
25 | .ti -8 | |
26 | .B tipc link get | |
27 | .RB "{ " "priority" " | " tolerance " | " window " } " link | |
28 | .I LINK | |
29 | ||
30 | .ti -8 | |
31 | .B tipc link statistics | |
32 | .RB "{ " "show " "[ " link | |
33 | .I LINK | |
34 | .RB "] | " "reset | |
35 | .BI "link " "LINK " | |
85e3c87c | 36 | } |
dcd8d142 RA |
37 | |
38 | .ti -8 | |
39 | .B tipc link list | |
40 | .br | |
41 | ||
42 | .SH OPTIONS | |
43 | Options (flags) that can be passed anywhere in the command chain. | |
44 | .TP | |
45 | .BR "\-h" , " --help" | |
46 | Show help about last valid command. For example | |
47 | .B tipc link --help | |
48 | will show link help and | |
49 | .B tipc --help | |
50 | will show general help. The position of the option in the string is irrelevant. | |
51 | .SH DESCRIPTION | |
52 | ||
53 | .SS Link statistics | |
54 | ||
55 | .TP | |
56 | .BR "ACTIVE " "link state" | |
57 | .br | |
58 | An | |
59 | .B ACTIVE | |
60 | link is serving traffic. Two links to the same node can become | |
61 | .B ACTIVE | |
62 | if they have the same link | |
63 | .BR priority . | |
64 | If there is more than two links with the same priority the additional links will | |
65 | be put in | |
66 | .B STANDBY | |
67 | state. | |
68 | ||
69 | .TP | |
70 | .BR "STANDBY " "link state" | |
71 | .br | |
72 | A | |
73 | .B STANDBY | |
74 | link has lower link priority than an | |
75 | .B ACTIVE | |
76 | link. A | |
77 | .B STANDBY | |
78 | link has control traffic flowing and is ready to take over should the | |
79 | .B ACTIVE | |
80 | link(s) go down. | |
81 | ||
82 | .TP | |
83 | .B MTU | |
84 | .br | |
85 | The Maximum Transmission Unit. The two endpoints advertise their default or | |
86 | configured | |
87 | .B MTU | |
88 | at initial link setup and will agree to use the lower of the two values should | |
89 | they differ. | |
90 | ||
91 | .TP | |
92 | .B Packets | |
93 | .br | |
94 | The total amount of transmitted or received TIPC packets on a link. Including | |
95 | .BR "fragmented " "and " "bundled " packets. | |
96 | ||
97 | .TP | |
98 | .B Fragments | |
99 | .br | |
100 | Represented in the form | |
101 | .BR fragments / fragmented . | |
102 | Where | |
103 | .B fragmented | |
104 | is the amount of data messages which have been broken into | |
105 | .BR fragments . | |
106 | Subsequently the | |
107 | .B fragments | |
108 | are the total amount of packets that the | |
109 | .B fragmented | |
110 | messages has been broken into. | |
111 | ||
112 | .TP | |
113 | .B Bundles | |
114 | .br | |
115 | Represented in the form | |
116 | .BR bundles / bundled . | |
117 | If a link becomes congested the link will attempt to bundle data from small | |
118 | .B bundled | |
119 | packets into | |
120 | .B bundles | |
121 | of full MTU size packets before they are transmitted. | |
122 | ||
123 | .TP | |
124 | .B Profile | |
125 | .br | |
126 | Shows the | |
127 | .B average | |
128 | packet size in octets/bytes for a | |
129 | .B sample | |
130 | of packets. It also shows the packet size distribution of the | |
131 | .B sampled | |
132 | packets in the intervals | |
133 | ||
134 | 0-64 bytes | |
135 | .br | |
136 | 64-256 bytes | |
137 | .br | |
138 | 256-1024 bytes | |
139 | .br | |
140 | 1024-4096 bytes | |
141 | .br | |
142 | 4096-16384 bytes | |
143 | .br | |
144 | 16384-32768 bytes | |
145 | .br | |
146 | 32768-66000 bytes | |
147 | ||
148 | .TP | |
149 | .B Message counters | |
150 | ||
151 | .B states | |
152 | - Number of link state messages | |
153 | .sp | |
154 | ||
155 | .B probes | |
156 | - Link state messages with probe flag set. Typically sent when a link is idle | |
157 | .sp | |
158 | ||
159 | .B nacks | |
160 | - Number of negative acknowledgement (NACK) packets sent and received by the | |
161 | link | |
162 | .sp | |
163 | ||
164 | .B defs | |
165 | - Number of packets received out of order | |
166 | .sp | |
167 | ||
168 | .B dups | |
169 | - Number of duplicate packets received | |
170 | ||
171 | .TP | |
172 | .B Congestion link | |
173 | The number of times an application has tried to send data when the TIPC link | |
174 | was congested | |
175 | ||
176 | .TP | |
177 | .B Send queue | |
178 | .B Max | |
179 | is the maximum amount of messages that has resided in the out queue during the | |
180 | statistics collection period of a link. | |
181 | ||
182 | .B Avg | |
183 | is the average outqueue size during the lifetime of a link. | |
184 | ||
185 | .SS Link properties | |
186 | ||
187 | .TP | |
188 | .B priority | |
189 | .br | |
190 | The priority between logical TIPC links to a particular node. Link priority can | |
191 | range from 0 (lowest) to 31 (highest). | |
192 | ||
193 | .TP | |
194 | .B tolerance | |
195 | .br | |
196 | Link tolerance specifies the maximum time in milliseconds that TIPC will allow | |
197 | a communication problem to exist before taking the link down. The default value | |
198 | is 1500 milliseconds. | |
199 | ||
200 | .TP | |
201 | .B window | |
202 | .br | |
203 | The link window controls how many unacknowledged messages a link endpoint can | |
204 | have in its transmit queue before TIPC's congestion control mechanism is | |
205 | activated. | |
206 | ||
207 | .SH EXIT STATUS | |
208 | Exit status is 0 if command was successful or a positive integer upon failure. | |
209 | ||
210 | .SH SEE ALSO | |
211 | .BR tipc (8), | |
212 | .BR tipc-media (8), | |
213 | .BR tipc-bearer (8), | |
214 | .BR tipc-nametable (8), | |
215 | .BR tipc-node (8), | |
216 | .BR tipc-socket (8) | |
217 | .br | |
218 | .SH REPORTING BUGS | |
219 | Report any bugs to the Network Developers mailing list | |
220 | .B <netdev@vger.kernel.org> | |
221 | where the development and maintenance is primarily done. | |
222 | You do not have to be subscribed to the list to send a message there. | |
223 | ||
224 | .SH AUTHOR | |
225 | Richard Alpe <richard.alpe@ericsson.com> |