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