621 lines
11 KiB
HTML
621 lines
11 KiB
HTML
|
|
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
|
|
<HTML><HEAD><TITLE>Man page of TIPC-LINK</TITLE>
|
|
</HEAD><BODY>
|
|
<H1>TIPC-LINK</H1>
|
|
Section: Linux (8)<BR>Updated: 22 Mar 2019<BR><A HREF="#index">Index</A>
|
|
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
|
|
|
|
<P>
|
|
|
|
|
|
<P>
|
|
<A NAME="lbAB"> </A>
|
|
<H2>NAME</H2>
|
|
|
|
tipc-link - show links or modify link properties
|
|
<P>
|
|
<A NAME="lbAC"> </A>
|
|
<H2>SYNOPSIS</H2>
|
|
|
|
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link set</B>
|
|
|
|
<BR>
|
|
|
|
[ <B>{ </B>priority
|
|
|
|
<I>PRIORITY</I>
|
|
|
|
| <B>tolerance</B>
|
|
|
|
<I>TOLERANCE</I>
|
|
|
|
| <B>window</B>
|
|
|
|
<I>WINDOW </I>}
|
|
|
|
<B>link </B><I>LINK</I><B> ]</B>
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
[
|
|
|
|
{ <B>broadcast</B> [
|
|
|
|
<I>BROADCAST</I>
|
|
|
|
|
|
|
|
|
<I>REPLICAST</I>
|
|
|
|
|
|
|
|
|
<I>AUTOSELECT</I>
|
|
|
|
[ <B>ratio</B>
|
|
|
|
<I>SIZE</I>
|
|
|
|
] <B>]</B> } <B>]</B>
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link get</B>
|
|
|
|
<BR>
|
|
|
|
[ <B>{ </B>priority<B> | </B>tolerance<B> | </B>window<B> } </B>link
|
|
|
|
<I>LINK</I> ]
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
[ <B>{</B> broadcast <B>}</B> ]
|
|
|
|
<BR>
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link statistics</B>
|
|
|
|
{ <B>show </B>[ <B>link</B>
|
|
|
|
<I>LINK</I>
|
|
|
|
] | <B>reset</B>
|
|
|
|
<B>link </B><I>LINK </I>
|
|
|
|
}
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link list</B>
|
|
|
|
<BR>
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link monitor set</B>
|
|
|
|
{ <B>threshold</B> }
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link monitor get</B>
|
|
|
|
{ <B>threshold</B> }
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link monitor summary</B>
|
|
|
|
<BR>
|
|
|
|
<P>
|
|
<BR>
|
|
|
|
<B>tipc link monitor list</B>
|
|
|
|
<BR>
|
|
|
|
[ <B>media </B> { <B>eth</B> | <B>ib</B> } <B>device</B>
|
|
|
|
<I>DEVICE</I> ]
|
|
|
|
|
|
|
|
|
<BR>
|
|
|
|
[ <B>media udp name</B>
|
|
|
|
<I>NAME</I> ]
|
|
|
|
<BR>
|
|
|
|
<P>
|
|
<A NAME="lbAD"> </A>
|
|
<H2>OPTIONS</H2>
|
|
|
|
Options (flags) that can be passed anywhere in the command chain.
|
|
<DL COMPACT>
|
|
<DT id="1"><B>-h</B>,<B> --help</B>
|
|
|
|
<DD>
|
|
Show help about last valid command. For example
|
|
<B>tipc link --help</B>
|
|
|
|
will show link help and
|
|
<B>tipc --help</B>
|
|
|
|
will show general help. The position of the option in the string is irrelevant.
|
|
<P>
|
|
<DT id="2"><B>-j,</B> -json
|
|
|
|
<DD>
|
|
Output results in JavaScript Object Notation (JSON).
|
|
<P>
|
|
<DT id="3"><B>-p,</B> -pretty
|
|
|
|
<DD>
|
|
The default JSON format is compact and more efficient to parse but hard for most users to read.
|
|
This flag adds indentation for readability.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAE"> </A>
|
|
<H2>DESCRIPTION</H2>
|
|
|
|
<P>
|
|
<A NAME="lbAF"> </A>
|
|
<H3>Link statistics</H3>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="4"><B>ACTIVE </B>link state
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
An
|
|
<B>ACTIVE</B>
|
|
|
|
link is serving traffic. Two links to the same node can become
|
|
<B>ACTIVE</B>
|
|
|
|
if they have the same link
|
|
<B>priority</B>.
|
|
|
|
If there is more than two links with the same priority the additional links will
|
|
be put in
|
|
<B>STANDBY</B>
|
|
|
|
state.
|
|
<P>
|
|
<DT id="5"><B>STANDBY </B>link state
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
A
|
|
<B>STANDBY</B>
|
|
|
|
link has lower link priority than an
|
|
<B>ACTIVE</B>
|
|
|
|
link. A
|
|
<B>STANDBY</B>
|
|
|
|
link has control traffic flowing and is ready to take over should the
|
|
<B>ACTIVE</B>
|
|
|
|
link(s) go down.
|
|
<P>
|
|
<DT id="6"><B>MTU</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The Maximum Transmission Unit. The two endpoints advertise their default or
|
|
configured
|
|
<B>MTU</B>
|
|
|
|
at initial link setup and will agree to use the lower of the two values should
|
|
they differ.
|
|
<P>
|
|
<DT id="7"><B>Packets</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The total amount of transmitted or received TIPC packets on a link. Including
|
|
<B>fragmented </B>and <B>bundled </B>packets.
|
|
|
|
<P>
|
|
<DT id="8"><B>Fragments</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represented in the form
|
|
<B>fragments</B>/<B>fragmented</B>.
|
|
|
|
Where
|
|
<B>fragmented</B>
|
|
|
|
is the amount of data messages which have been broken into
|
|
<B>fragments</B>.
|
|
|
|
Subsequently the
|
|
<B>fragments</B>
|
|
|
|
are the total amount of packets that the
|
|
<B>fragmented</B>
|
|
|
|
messages has been broken into.
|
|
<P>
|
|
<DT id="9"><B>Bundles</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represented in the form
|
|
<B>bundles</B>/<B>bundled</B>.
|
|
|
|
If a link becomes congested the link will attempt to bundle data from small
|
|
<B>bundled</B>
|
|
|
|
packets into
|
|
<B>bundles</B>
|
|
|
|
of full MTU size packets before they are transmitted.
|
|
<P>
|
|
<DT id="10"><B>Profile</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Shows the
|
|
<B>average</B>
|
|
|
|
packet size in octets/bytes for a
|
|
<B>sample</B>
|
|
|
|
of packets. It also shows the packet size distribution of the
|
|
<B>sampled</B>
|
|
|
|
packets in the intervals
|
|
<P>
|
|
0-64 bytes
|
|
<BR>
|
|
|
|
64-256 bytes
|
|
<BR>
|
|
|
|
256-1024 bytes
|
|
<BR>
|
|
|
|
1024-4096 bytes
|
|
<BR>
|
|
|
|
4096-16384 bytes
|
|
<BR>
|
|
|
|
16384-32768 bytes
|
|
<BR>
|
|
|
|
32768-66000 bytes
|
|
<P>
|
|
<DT id="11"><B>Message counters</B>
|
|
|
|
<DD>
|
|
<P>
|
|
<B>states</B>
|
|
|
|
- Number of link state messages
|
|
<P>
|
|
<P>
|
|
<B>probes</B>
|
|
|
|
- Link state messages with probe flag set. Typically sent when a link is idle
|
|
<P>
|
|
<P>
|
|
<B>nacks</B>
|
|
|
|
- Number of negative acknowledgement (NACK) packets sent and received by the
|
|
link
|
|
<P>
|
|
<P>
|
|
<B>defs</B>
|
|
|
|
- Number of packets received out of order
|
|
<P>
|
|
<P>
|
|
<B>dups</B>
|
|
|
|
- Number of duplicate packets received
|
|
<P>
|
|
<DT id="12"><B>Congestion link</B>
|
|
|
|
<DD>
|
|
The number of times an application has tried to send data when the TIPC link
|
|
was congested
|
|
<P>
|
|
<DT id="13"><B>Send queue</B>
|
|
|
|
<DD>
|
|
<B>Max</B>
|
|
|
|
is the maximum amount of messages that has resided in the out queue during the
|
|
statistics collection period of a link.
|
|
<P>
|
|
<B>Avg</B>
|
|
|
|
is the average outqueue size during the lifetime of a link.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAG"> </A>
|
|
<H3>Link properties</H3>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="14"><B>priority</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The priority between logical TIPC links to a particular node. Link priority can
|
|
range from 0 (lowest) to 31 (highest).
|
|
<P>
|
|
<DT id="15"><B>tolerance</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Link tolerance specifies the maximum time in milliseconds that TIPC will allow
|
|
a communication problem to exist before taking the link down. The default value
|
|
is 1500 milliseconds.
|
|
<P>
|
|
<DT id="16"><B>window</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The link window controls how many unacknowledged messages a link endpoint can
|
|
have in its transmit queue before TIPC's congestion control mechanism is
|
|
activated.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAH"> </A>
|
|
<H3>Monitor properties</H3>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="17"><B>threshold</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The threshold specifies the cluster size exceeding which the link monitoring
|
|
algorithm will switch from "full-mesh" to "overlapping-ring".
|
|
If set of 0 the overlapping-ring monitoring is always on and if set to a
|
|
value larger than anticipated cluster size the overlapping-ring is disabled.
|
|
The default value is 32.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAI"> </A>
|
|
<H3>Monitor information</H3>
|
|
|
|
<P>
|
|
<DL COMPACT>
|
|
<DT id="18"><B>table_generation</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represents the event count in a node's local monitoring list. It steps every
|
|
time something changes in the local monitor list, including changes in the
|
|
local domain.
|
|
<P>
|
|
<DT id="19"><B>cluster_size</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represents the current count of cluster members.
|
|
<P>
|
|
<DT id="20"><B>algorithm</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The current supervision algorithm used for neighbour monitoring for the bearer.
|
|
Possible values are full-mesh or overlapping-ring.
|
|
<P>
|
|
<DT id="21"><B>status</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The node status derived by the local node.
|
|
Possible status are up or down.
|
|
<P>
|
|
<DT id="22"><B>monitored</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represent the type of monitoring chosen by the local node.
|
|
Possible values are direct or indirect.
|
|
<P>
|
|
<DT id="23"><B>generation</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represents the domain generation which is the event count in a node's local
|
|
domain. Every time something changes (peer add/remove/up/down) the domain
|
|
generation is stepped and a new version of node record is sent to inform
|
|
the neighbors about this change. The domain generation helps the receiver
|
|
of a domain record to know if it should ignore or process the record.
|
|
<P>
|
|
<DT id="24"><B>applied_node_status</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
The node status reported by the peer node for the succeeding peers in
|
|
the node list. The Node list is a circular list of ascending addresses
|
|
starting with the local node.
|
|
Possible status are: U or D. The status U implies up and D down.
|
|
<P>
|
|
<DT id="25"><B>[non_applied_node:status]</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Represents the nodes and their status as reported by the peer node.
|
|
These nodes were not applied to the monitoring list for this peer node.
|
|
They are usually transient and occur during the cluster startup phase
|
|
or network reconfiguration.
|
|
Possible status are: U or D. The status U implies up and D down.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAJ"> </A>
|
|
<H3>Broadcast properties</H3>
|
|
|
|
<DL COMPACT>
|
|
<DT id="26"><B>BROADCAST</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Forces all multicast traffic to be transmitted via broadcast only,
|
|
irrespective of cluster size and number of destinations.
|
|
<P>
|
|
<DT id="27"><B>REPLICAST</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Forces all multicast traffic to be transmitted via replicast only,
|
|
irrespective of cluster size and number of destinations.
|
|
<P>
|
|
<DT id="28"><B>AUTOSELECT</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Auto switching to broadcast or replicast depending on cluster size and
|
|
destination node number.
|
|
<P>
|
|
<DT id="29"><B>ratio SIZE</B>
|
|
|
|
<DD>
|
|
<BR>
|
|
|
|
Set the AUTOSELECT criteria, percentage of destination nodes vs cluster
|
|
size.
|
|
<P>
|
|
</DL>
|
|
<A NAME="lbAK"> </A>
|
|
<H2>EXAMPLES</H2>
|
|
|
|
<P>
|
|
|
|
tipc link monitor list
|
|
<DL COMPACT><DT id="30"><DD>
|
|
Shows the link monitoring information for cluster members on device data0.
|
|
</DL>
|
|
|
|
<P>
|
|
|
|
tipc link monitor summary
|
|
<DL COMPACT><DT id="31"><DD>
|
|
The monitor summary command prints the basic attributes.
|
|
</DL>
|
|
|
|
<P>
|
|
<A NAME="lbAL"> </A>
|
|
<H2>EXIT STATUS</H2>
|
|
|
|
Exit status is 0 if command was successful or a positive integer upon failure.
|
|
<P>
|
|
<A NAME="lbAM"> </A>
|
|
<H2>SEE ALSO</H2>
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc">tipc</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-media">tipc-media</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-bearer">tipc-bearer</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-nametable">tipc-nametable</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-node">tipc-node</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-peer">tipc-peer</A></B>(8),
|
|
|
|
<B><A HREF="/cgi-bin/man/man2html?8+tipc-socket">tipc-socket</A></B>(8)
|
|
|
|
<BR>
|
|
|
|
<A NAME="lbAN"> </A>
|
|
<H2>REPORTING BUGS</H2>
|
|
|
|
Report any bugs to the Network Developers mailing list
|
|
<B><<A HREF="mailto:netdev@vger.kernel.org">netdev@vger.kernel.org</A>></B>
|
|
|
|
where the development and maintenance is primarily done.
|
|
You do not have to be subscribed to the list to send a message there.
|
|
<P>
|
|
<A NAME="lbAO"> </A>
|
|
<H2>AUTHOR</H2>
|
|
|
|
Richard Alpe <<A HREF="mailto:richard.alpe@ericsson.com">richard.alpe@ericsson.com</A>>
|
|
<P>
|
|
|
|
<HR>
|
|
<A NAME="index"> </A><H2>Index</H2>
|
|
<DL>
|
|
<DT id="32"><A HREF="#lbAB">NAME</A><DD>
|
|
<DT id="33"><A HREF="#lbAC">SYNOPSIS</A><DD>
|
|
<DT id="34"><A HREF="#lbAD">OPTIONS</A><DD>
|
|
<DT id="35"><A HREF="#lbAE">DESCRIPTION</A><DD>
|
|
<DL>
|
|
<DT id="36"><A HREF="#lbAF">Link statistics</A><DD>
|
|
<DT id="37"><A HREF="#lbAG">Link properties</A><DD>
|
|
<DT id="38"><A HREF="#lbAH">Monitor properties</A><DD>
|
|
<DT id="39"><A HREF="#lbAI">Monitor information</A><DD>
|
|
<DT id="40"><A HREF="#lbAJ">Broadcast properties</A><DD>
|
|
</DL>
|
|
<DT id="41"><A HREF="#lbAK">EXAMPLES</A><DD>
|
|
<DT id="42"><A HREF="#lbAL">EXIT STATUS</A><DD>
|
|
<DT id="43"><A HREF="#lbAM">SEE ALSO</A><DD>
|
|
<DT id="44"><A HREF="#lbAN">REPORTING BUGS</A><DD>
|
|
<DT id="45"><A HREF="#lbAO">AUTHOR</A><DD>
|
|
</DL>
|
|
<HR>
|
|
This document was created by
|
|
<A HREF="/cgi-bin/man/man2html">man2html</A>,
|
|
using the manual pages.<BR>
|
|
Time: 00:06:18 GMT, March 31, 2021
|
|
</BODY>
|
|
</HTML>
|