1TIPC-LINK(8)                         Linux                        TIPC-LINK(8)
2
3
4

NAME

6       tipc-link - show links or modify link properties
7
8

SYNOPSIS

10       tipc link set
11               [ { priority PRIORITY | tolerance TOLERANCE | window WINDOW }
12               link LINK ] |
13               [ { broadcast [ BROADCAST  | REPLICAST  | AUTOSELECT [ ratio
14               SIZE ] ] } ]
15
16       tipc link get
17               [ { priority | tolerance | window } link LINK ] |
18               [ { broadcast } ]
19
20       tipc link statistics { show [ link LINK ] | reset link LINK }
21
22       tipc link list
23
24       tipc link monitor set { threshold }
25
26       tipc link monitor get { threshold }
27
28       tipc link monitor summary
29
30       tipc link monitor list
31               [ media  { eth | ib } device DEVICE ] |
32               [ media udp name NAME ]
33
34

OPTIONS

36       Options (flags) that can be passed anywhere in the command chain.
37
38       -h, --help
39              Show help about last valid command. For example tipc link --help
40              will show link help and tipc --help will show general help. The
41              position of the option in the string is irrelevant.
42
43
44       -j, -json
45              Output results in JavaScript Object Notation (JSON).
46
47
48       -p, -pretty
49              The default JSON format is compact and more efficient to parse
50              but hard for most users to read.  This flag adds indentation for
51              readability.
52
53

DESCRIPTION

55   Link statistics
56       ACTIVE link state
57              An ACTIVE link is serving traffic. Two links to the same node
58              can become ACTIVE if they have the same link priority.  If there
59              is more than two links with the same priority the additional
60              links will be put in STANDBY state.
61
62
63       STANDBY link state
64              A STANDBY link has lower link priority than an ACTIVE link. A
65              STANDBY link has control traffic flowing and is ready to take
66              over should the ACTIVE link(s) go down.
67
68
69       MTU
70              The Maximum Transmission Unit. The two endpoints advertise their
71              default or configured MTU at initial link setup and will agree
72              to use the lower of the two values should they differ.
73
74
75       Packets
76              The total amount of transmitted or received TIPC packets on a
77              link. Including fragmented and bundled packets.
78
79
80       Fragments
81              Represented in the form fragments/fragmented.  Where fragmented
82              is the amount of data messages which have been broken into frag‐
83              ments.  Subsequently the fragments are the total amount of pack‐
84              ets that the fragmented messages has been broken into.
85
86
87       Bundles
88              Represented in the form bundles/bundled.  If a link becomes con‐
89              gested the link will attempt to bundle data from small bundled
90              packets into bundles of full MTU size packets before they are
91              transmitted.
92
93
94       Profile
95              Shows the average packet size in octets/bytes for a sample of
96              packets. It also shows the packet size distribution of the sam‐
97              pled packets in the intervals
98
99              0-64 bytes
100              64-256 bytes
101              256-1024 bytes
102              1024-4096 bytes
103              4096-16384 bytes
104              16384-32768 bytes
105              32768-66000 bytes
106
107
108       Message counters
109
110              states - Number of link state messages
111
112
113              probes - Link state messages with probe flag set. Typically sent
114              when a link is idle
115
116
117              nacks - Number of negative acknowledgement (NACK) packets sent
118              and received by the link
119
120
121              defs - Number of packets received out of order
122
123
124              dups - Number of duplicate packets received
125
126
127       Congestion link
128              The number of times an application has tried to send data when
129              the TIPC link was congested
130
131
132       Send queue
133              Max is the maximum amount of messages that has resided in the
134              out queue during the statistics collection period of a link.
135
136              Avg is the average outqueue size during the lifetime of a link.
137
138
139   Link properties
140       priority
141              The priority between logical TIPC links to a particular node.
142              Link priority can range from 0 (lowest) to 31 (highest).
143
144
145       tolerance
146              Link tolerance specifies the maximum time in milliseconds that
147              TIPC will allow a communication problem to exist before taking
148              the link down. The default value is 1500 milliseconds.
149
150
151       window
152              The link window controls how many unacknowledged messages a link
153              endpoint can have in its transmit queue before TIPC's congestion
154              control mechanism is activated.
155
156
157   Monitor properties
158       threshold
159              The threshold specifies the cluster size exceeding which the
160              link monitoring algorithm will switch from "full-mesh" to "over‐
161              lapping-ring".  If set of 0 the overlapping-ring monitoring is
162              always on and if set to a value larger than anticipated cluster
163              size the overlapping-ring is disabled.  The default value is 32.
164
165
166   Monitor information
167       table_generation
168              Represents the event count in a node's local monitoring list. It
169              steps every time something changes in the local monitor list,
170              including changes in the local domain.
171
172
173       cluster_size
174              Represents the current count of cluster members.
175
176
177       algorithm
178              The current supervision algorithm used for neighbour monitoring
179              for the bearer.  Possible values are full-mesh or overlapping-
180              ring.
181
182
183       status
184              The node status derived by the local node.  Possible status are
185              up or down.
186
187
188       monitored
189              Represent the type of monitoring chosen by the local node.  Pos‐
190              sible values are direct or indirect.
191
192
193       generation
194              Represents the domain generation which is the event count in a
195              node's local domain. Every time something changes (peer
196              add/remove/up/down) the domain generation is stepped and a new
197              version of node record is sent to inform the neighbors about
198              this change. The domain generation helps the receiver of a
199              domain record to know if it should ignore or process the record.
200
201
202       applied_node_status
203              The node status reported by the peer node for the succeeding
204              peers in the node list. The Node list is a circular list of
205              ascending addresses starting with the local node.  Possible sta‐
206              tus are: U or D. The status U implies up and D down.
207
208
209       [non_applied_node:status]
210              Represents the nodes and their status as reported by the peer
211              node.  These nodes were not applied to the monitoring list for
212              this peer node.  They are usually transient and occur during the
213              cluster startup phase or network reconfiguration.  Possible sta‐
214              tus are: U or D. The status U implies up and D down.
215
216
217   Broadcast properties
218       BROADCAST
219              Forces all multicast traffic to be transmitted via broadcast
220              only, irrespective of cluster size and number of destinations.
221
222
223       REPLICAST
224              Forces all multicast traffic to be transmitted via replicast
225              only, irrespective of cluster size and number of destinations.
226
227
228       AUTOSELECT
229              Auto switching to broadcast or replicast depending on cluster
230              size and destination node number.
231
232
233       ratio SIZE
234              Set the AUTOSELECT criteria, percentage of destination nodes vs
235              cluster size.
236
237

EXAMPLES

239       tipc link monitor list
240           Shows the link monitoring information for cluster members on device
241           data0.
242
243       tipc link monitor summary
244           The monitor summary command prints the basic attributes.
245
246

EXIT STATUS

248       Exit status is 0 if command was successful or a positive integer upon
249       failure.
250
251

SEE ALSO

253       tipc(8), tipc-media(8), tipc-bearer(8), tipc-nametable(8), tipc-
254       node(8), tipc-peer(8), tipc-socket(8)
255

REPORTING BUGS

257       Report any bugs to the Network Developers mailing list <net‐
258       dev@vger.kernel.org> where the development and maintenance is primarily
259       done.  You do not have to be subscribed to the list to send a message
260       there.
261
262

AUTHOR

264       Richard Alpe <richard.alpe@ericsson.com>
265
266
267
268iproute2                          22 Mar 2019                     TIPC-LINK(8)
Impressum