| 1 |
.TH TIPC-LINK 8 "22 Mar 2019" "iproute2" "Linux" |
| 2 |
|
| 3 |
.\" For consistency, please keep padding right aligned. |
| 4 |
.\" For example '.B "foo " bar' and not '.B foo " bar"' |
| 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 |
.br |
| 18 |
.RB "[ " "{ " "priority " |
| 19 |
.IR PRIORITY |
| 20 |
.RB "| " tolerance |
| 21 |
.IR TOLERANCE |
| 22 |
.RB "| " window |
| 23 |
.IR "WINDOW " } |
| 24 |
.BI "link " LINK " ]" |
| 25 |
.RB "|" |
| 26 |
.br |
| 27 |
.RB "[ " |
| 28 |
.RB "{ " broadcast " [ " |
| 29 |
.IR BROADCAST |
| 30 |
.RB " | " |
| 31 |
.IR REPLICAST |
| 32 |
.RB " | " |
| 33 |
.IR AUTOSELECT |
| 34 |
.RB "[ " ratio |
| 35 |
.IR SIZE |
| 36 |
.RB "] " ] " } " "]" |
| 37 |
|
| 38 |
.ti -8 |
| 39 |
.B tipc link get |
| 40 |
.br |
| 41 |
.RB "[ " "{ " "priority" " | " tolerance " | " window " } " link |
| 42 |
.IR LINK " ] " |
| 43 |
.RB "|" |
| 44 |
.br |
| 45 |
.RB "[ " { " broadcast " } " ]" |
| 46 |
.br |
| 47 |
|
| 48 |
.ti -8 |
| 49 |
.B tipc link statistics |
| 50 |
.RB "{ " "show " "[ " link |
| 51 |
.I LINK |
| 52 |
.RB "] | " "reset |
| 53 |
.BI "link " "LINK " |
| 54 |
} |
| 55 |
|
| 56 |
.ti -8 |
| 57 |
.B tipc link list |
| 58 |
.br |
| 59 |
|
| 60 |
.ti -8 |
| 61 |
.B tipc link monitor set |
| 62 |
.RB "{ " "threshold" " } " |
| 63 |
|
| 64 |
.ti -8 |
| 65 |
.B tipc link monitor get |
| 66 |
.RB "{ " "threshold" " } " |
| 67 |
|
| 68 |
.ti -8 |
| 69 |
.B tipc link monitor summary |
| 70 |
.br |
| 71 |
|
| 72 |
.ti -8 |
| 73 |
.B tipc link monitor list |
| 74 |
.br |
| 75 |
.RB "[ " "media " " { " eth " | " ib " } " device |
| 76 |
.IR "DEVICE" " ]" |
| 77 |
.RB "|" |
| 78 |
.br |
| 79 |
.RB "[ " "media udp name" |
| 80 |
.IR NAME " ]" |
| 81 |
.br |
| 82 |
|
| 83 |
.SH OPTIONS |
| 84 |
Options (flags) that can be passed anywhere in the command chain. |
| 85 |
.TP |
| 86 |
.BR "\-h" , " --help" |
| 87 |
Show help about last valid command. For example |
| 88 |
.B tipc link --help |
| 89 |
will show link help and |
| 90 |
.B tipc --help |
| 91 |
will show general help. The position of the option in the string is irrelevant. |
| 92 |
|
| 93 |
.TP |
| 94 |
.BR "\-j", " \-json" |
| 95 |
Output results in JavaScript Object Notation (JSON). |
| 96 |
|
| 97 |
.TP |
| 98 |
.BR "\-p", " \-pretty" |
| 99 |
The default JSON format is compact and more efficient to parse but hard for most users to read. |
| 100 |
This flag adds indentation for readability. |
| 101 |
|
| 102 |
.SH DESCRIPTION |
| 103 |
|
| 104 |
.SS Link statistics |
| 105 |
|
| 106 |
.TP |
| 107 |
.BR "ACTIVE " "link state" |
| 108 |
.br |
| 109 |
An |
| 110 |
.B ACTIVE |
| 111 |
link is serving traffic. Two links to the same node can become |
| 112 |
.B ACTIVE |
| 113 |
if they have the same link |
| 114 |
.BR priority . |
| 115 |
If there is more than two links with the same priority the additional links will |
| 116 |
be put in |
| 117 |
.B STANDBY |
| 118 |
state. |
| 119 |
|
| 120 |
.TP |
| 121 |
.BR "STANDBY " "link state" |
| 122 |
.br |
| 123 |
A |
| 124 |
.B STANDBY |
| 125 |
link has lower link priority than an |
| 126 |
.B ACTIVE |
| 127 |
link. A |
| 128 |
.B STANDBY |
| 129 |
link has control traffic flowing and is ready to take over should the |
| 130 |
.B ACTIVE |
| 131 |
link(s) go down. |
| 132 |
|
| 133 |
.TP |
| 134 |
.B MTU |
| 135 |
.br |
| 136 |
The Maximum Transmission Unit. The two endpoints advertise their default or |
| 137 |
configured |
| 138 |
.B MTU |
| 139 |
at initial link setup and will agree to use the lower of the two values should |
| 140 |
they differ. |
| 141 |
|
| 142 |
.TP |
| 143 |
.B Packets |
| 144 |
.br |
| 145 |
The total amount of transmitted or received TIPC packets on a link. Including |
| 146 |
.BR "fragmented " "and " "bundled " packets. |
| 147 |
|
| 148 |
.TP |
| 149 |
.B Fragments |
| 150 |
.br |
| 151 |
Represented in the form |
| 152 |
.BR fragments / fragmented . |
| 153 |
Where |
| 154 |
.B fragmented |
| 155 |
is the amount of data messages which have been broken into |
| 156 |
.BR fragments . |
| 157 |
Subsequently the |
| 158 |
.B fragments |
| 159 |
are the total amount of packets that the |
| 160 |
.B fragmented |
| 161 |
messages have been broken into. |
| 162 |
|
| 163 |
.TP |
| 164 |
.B Bundles |
| 165 |
.br |
| 166 |
Represented in the form |
| 167 |
.BR bundles / bundled . |
| 168 |
If a link becomes congested the link will attempt to bundle data from small |
| 169 |
.B bundled |
| 170 |
packets into |
| 171 |
.B bundles |
| 172 |
of full MTU size packets before they are transmitted. |
| 173 |
|
| 174 |
.TP |
| 175 |
.B Profile |
| 176 |
.br |
| 177 |
Shows the |
| 178 |
.B average |
| 179 |
packet size in octets/bytes for a |
| 180 |
.B sample |
| 181 |
of packets. It also shows the packet size distribution of the |
| 182 |
.B sampled |
| 183 |
packets in the intervals |
| 184 |
|
| 185 |
0-64 bytes |
| 186 |
.br |
| 187 |
64-256 bytes |
| 188 |
.br |
| 189 |
256-1024 bytes |
| 190 |
.br |
| 191 |
1024-4096 bytes |
| 192 |
.br |
| 193 |
4096-16384 bytes |
| 194 |
.br |
| 195 |
16384-32768 bytes |
| 196 |
.br |
| 197 |
32768-66000 bytes |
| 198 |
|
| 199 |
.TP |
| 200 |
.B Message counters |
| 201 |
|
| 202 |
.B states |
| 203 |
- Number of link state messages |
| 204 |
.sp |
| 205 |
|
| 206 |
.B probes |
| 207 |
- Link state messages with probe flag set. Typically sent when a link is idle |
| 208 |
.sp |
| 209 |
|
| 210 |
.B nacks |
| 211 |
- Number of negative acknowledgment (NACK) packets sent and received by the |
| 212 |
link |
| 213 |
.sp |
| 214 |
|
| 215 |
.B defs |
| 216 |
- Number of packets received out of order |
| 217 |
.sp |
| 218 |
|
| 219 |
.B dups |
| 220 |
- Number of duplicate packets received |
| 221 |
|
| 222 |
.TP |
| 223 |
.B Congestion link |
| 224 |
The number of times an application has tried to send data when the TIPC link |
| 225 |
was congested |
| 226 |
|
| 227 |
.TP |
| 228 |
.B Send queue |
| 229 |
.B Max |
| 230 |
is the maximum amount of messages that has resided in the out queue during the |
| 231 |
statistics collection period of a link. |
| 232 |
|
| 233 |
.B Avg |
| 234 |
is the average outqueue size during the lifetime of a link. |
| 235 |
|
| 236 |
.SS Link properties |
| 237 |
|
| 238 |
.TP |
| 239 |
.B priority |
| 240 |
.br |
| 241 |
The priority between logical TIPC links to a particular node. Link priority can |
| 242 |
range from 0 (lowest) to 31 (highest). |
| 243 |
|
| 244 |
.TP |
| 245 |
.B tolerance |
| 246 |
.br |
| 247 |
Link tolerance specifies the maximum time in milliseconds that TIPC will allow |
| 248 |
a communication problem to exist before taking the link down. The default value |
| 249 |
is 1500 milliseconds. |
| 250 |
|
| 251 |
.TP |
| 252 |
.B window |
| 253 |
.br |
| 254 |
The link window controls how many unacknowledged messages a link endpoint can |
| 255 |
have in its transmit queue before TIPC's congestion control mechanism is |
| 256 |
activated. |
| 257 |
|
| 258 |
.SS Monitor properties |
| 259 |
|
| 260 |
.TP |
| 261 |
.B threshold |
| 262 |
.br |
| 263 |
The threshold specifies the cluster size exceeding which the link monitoring |
| 264 |
algorithm will switch from "full-mesh" to "overlapping-ring". |
| 265 |
If set to 0 the overlapping-ring monitoring is always on and if set to a |
| 266 |
value larger than anticipated cluster size the overlapping-ring is disabled. |
| 267 |
The default value is 32. |
| 268 |
|
| 269 |
.SS Monitor information |
| 270 |
|
| 271 |
.TP |
| 272 |
.B table_generation |
| 273 |
.br |
| 274 |
Represents the event count in a node's local monitoring list. It steps every |
| 275 |
time something changes in the local monitor list, including changes in the |
| 276 |
local domain. |
| 277 |
|
| 278 |
.TP |
| 279 |
.B cluster_size |
| 280 |
.br |
| 281 |
Represents the current count of cluster members. |
| 282 |
|
| 283 |
.TP |
| 284 |
.B algorithm |
| 285 |
.br |
| 286 |
The current supervision algorithm used for neighbour monitoring for the bearer. |
| 287 |
Possible values are full-mesh or overlapping-ring. |
| 288 |
|
| 289 |
.TP |
| 290 |
.B status |
| 291 |
.br |
| 292 |
The node status derived by the local node. |
| 293 |
Possible statuses are up or down. |
| 294 |
|
| 295 |
.TP |
| 296 |
.B monitored |
| 297 |
.br |
| 298 |
Represent the type of monitoring chosen by the local node. |
| 299 |
Possible values are direct or indirect. |
| 300 |
|
| 301 |
.TP |
| 302 |
.B generation |
| 303 |
.br |
| 304 |
Represents the domain generation which is the event count in a node's local |
| 305 |
domain. Every time something changes (peer add/remove/up/down) the domain |
| 306 |
generation is stepped and a new version of node record is sent to inform |
| 307 |
the neighbors about this change. The domain generation helps the receiver |
| 308 |
of a domain record to know if it should ignore or process the record. |
| 309 |
|
| 310 |
.TP |
| 311 |
.B applied_node_status |
| 312 |
.br |
| 313 |
The node status reported by the peer node for the succeeding peers in |
| 314 |
the node list. The Node list is a circular list of ascending addresses |
| 315 |
starting with the local node. |
| 316 |
Possible statuses are: U or D. The status U implies up and D down. |
| 317 |
|
| 318 |
.TP |
| 319 |
.B [non_applied_node:status] |
| 320 |
.br |
| 321 |
Represents the nodes and their status as reported by the peer node. |
| 322 |
These nodes were not applied to the monitoring list for this peer node. |
| 323 |
They are usually transient and occur during the cluster startup phase |
| 324 |
or network reconfiguration. |
| 325 |
Possible statuses are: U or D. The status U implies up and D down. |
| 326 |
|
| 327 |
.SS Broadcast properties |
| 328 |
.TP |
| 329 |
.B BROADCAST |
| 330 |
.br |
| 331 |
Forces all multicast traffic to be transmitted via broadcast only, |
| 332 |
irrespective of cluster size and number of destinations. |
| 333 |
|
| 334 |
.TP |
| 335 |
.B REPLICAST |
| 336 |
.br |
| 337 |
Forces all multicast traffic to be transmitted via replicast only, |
| 338 |
irrespective of cluster size and number of destinations. |
| 339 |
|
| 340 |
.TP |
| 341 |
.B AUTOSELECT |
| 342 |
.br |
| 343 |
Auto switching to broadcast or replicast depending on cluster size and |
| 344 |
destination node number. |
| 345 |
|
| 346 |
.TP |
| 347 |
.B ratio SIZE |
| 348 |
.br |
| 349 |
Set the AUTOSELECT criteria, percentage of destination nodes vs cluster |
| 350 |
size. |
| 351 |
|
| 352 |
.SH EXAMPLES |
| 353 |
.PP |
| 354 |
tipc link monitor list |
| 355 |
.RS 4 |
| 356 |
Shows the link monitoring information for cluster members on device data0. |
| 357 |
.RE |
| 358 |
.PP |
| 359 |
tipc link monitor summary |
| 360 |
.RS 4 |
| 361 |
The monitor summary command prints the basic attributes. |
| 362 |
.RE |
| 363 |
|
| 364 |
.SH EXIT STATUS |
| 365 |
Exit status is 0 if command was successful or a positive integer upon failure. |
| 366 |
|
| 367 |
.SH SEE ALSO |
| 368 |
.BR tipc (8), |
| 369 |
.BR tipc-media (8), |
| 370 |
.BR tipc-bearer (8), |
| 371 |
.BR tipc-nametable (8), |
| 372 |
.BR tipc-node (8), |
| 373 |
.BR tipc-peer (8), |
| 374 |
.BR tipc-socket (8) |
| 375 |
.br |
| 376 |
.SH REPORTING BUGS |
| 377 |
Report any bugs to the Network Developers mailing list |
| 378 |
.B <[email protected]> |
| 379 |
where the development and maintenance is primarily done. |
| 380 |
You do not have to be subscribed to the list to send a message there. |
| 381 |
|
| 382 |
.SH AUTHOR |
| 383 |
Richard Alpe <[email protected]> |