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
38
39       -j, -json
40              Output results in JavaScript Object Notation (JSON).
41
42
43       -p, -pretty
44              The default JSON format is compact and more efficient to parse
45              but hard for most users to read.  This flag adds indentation for
46              readability.
47
48

DESCRIPTION

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

EXAMPLES

213       tipc link monitor list
214           Shows the link monitoring information for cluster members on device
215           data0.
216
217       tipc link monitor summary
218           The monitor summary command prints the basic attributes.
219
220

EXIT STATUS

222       Exit status is 0 if command was successful or a positive integer upon
223       failure.
224
225

SEE ALSO

227       tipc(8), tipc-media(8), tipc-bearer(8), tipc-nametable(8), tipc-
228       node(8), tipc-peer(8), tipc-socket(8)
229

REPORTING BUGS

231       Report any bugs to the Network Developers mailing list <net‐
232       dev@vger.kernel.org> where the development and maintenance is primarily
233       done.  You do not have to be subscribed to the list to send a message
234       there.
235
236

AUTHOR

238       Richard Alpe <richard.alpe@ericsson.com>
239
240
241
242iproute2                          02 Jun 2015                     TIPC-LINK(8)
Impressum