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 { priority PRIORITY | tolerance TOLERANCE | window WINDOW
11               } link LINK
12
13       tipc link get { priority | tolerance | window } link LINK
14
15       tipc link statistics { show [ link LINK ] | reset link LINK }
16
17       tipc link list
18
19       tipc link monitor set { threshold }
20
21       tipc link monitor get { threshold }
22
23       tipc link monitor summary
24
25       tipc link monitor list
26               [ media  { eth | ib } device DEVICE ] |
27               [ media udp name NAME ]
28
29

OPTIONS

31       Options (flags) that can be passed anywhere in the command chain.
32
33       -h, --help
34              Show help about last valid command. For example tipc link --help
35              will show link help and tipc --help will show general help. The
36              position of the option in the string is irrelevant.
37

DESCRIPTION

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

EXAMPLES

202       tipc link monitor list
203           Shows the link monitoring information for cluster members on device
204           data0.
205
206       tipc link monitor summary
207           The monitor summary command prints the basic attributes.
208
209

EXIT STATUS

211       Exit status is 0 if command was successful or a positive integer upon
212       failure.
213
214

SEE ALSO

216       tipc(8), tipc-media(8), tipc-bearer(8), tipc-nametable(8), tipc-
217       node(8), tipc-peer(8), tipc-socket(8)
218

REPORTING BUGS

220       Report any bugs to the Network Developers mailing list <net‐
221       dev@vger.kernel.org> where the development and maintenance is primarily
222       done.  You do not have to be subscribed to the list to send a message
223       there.
224
225

AUTHOR

227       Richard Alpe <richard.alpe@ericsson.com>
228
229
230
231iproute2                          02 Jun 2015                     TIPC-LINK(8)
Impressum