xenial (8) tipc-link.8.gz

Provided by: iproute2_4.3.0-1ubuntu3.16.04.5_amd64 bug

NAME

       tipc-link - show links or modify link properties

SYNOPSIS

       tipc link set { priority PRIORITY | tolerance TOLERANCE | window WINDOW } link LINK

       tipc link get { priority | tolerance | window } link LINK

       tipc link statistics { show [ link LINK ] | reset link LINK }

       tipc link list

OPTIONS

       Options (flags) that can be passed anywhere in the command chain.

       -h, --help
              Show help about last valid command. For example tipc link --help will show link help and tipc
              --help will show general help. The position of the option in the string is irrelevant.

DESCRIPTION

   Link statistics
       ACTIVE link state
              An ACTIVE link is serving traffic. Two links to the same node can become ACTIVE if they have the
              same link priority.  If there is more than two links with the same priority the additional links
              will be put in STANDBY state.

       STANDBY link state
              A STANDBY link has lower link priority than an ACTIVE link. A STANDBY link has control traffic
              flowing and is ready to take over should the ACTIVE link(s) go down.

       MTU
              The Maximum Transmission Unit. The two endpoints advertise their default or configured MTU at
              initial link setup and will agree to use the lower of the two values should they differ.

       Packets
              The total amount of transmitted or received TIPC packets on a link. Including fragmented and
              bundled packets.

       Fragments
              Represented in the form fragments/fragmented.  Where fragmented is the amount of data messages
              which have been broken into fragments.  Subsequently the fragments are the total amount of packets
              that the fragmented messages has been broken into.

       Bundles
              Represented in the form bundles/bundled.  If a link becomes congested the link will attempt to
              bundle data from small bundled packets into bundles of full MTU size packets before they are
              transmitted.

       Profile
              Shows the average packet size in octets/bytes for a sample of packets. It also shows the packet
              size distribution of the sampled packets in the intervals

              0-64 bytes
              64-256 bytes
              256-1024 bytes
              1024-4096 bytes
              4096-16384 bytes
              16384-32768 bytes
              32768-66000 bytes

       Message counters

              states - Number of link state messages

              probes - Link state messages with probe flag set. Typically sent when a link is idle

              nacks - Number of negative acknowledgement (NACK) packets sent and received by the link

              defs - Number of packets received out of order

              dups - Number of duplicate packets received

       Congestion link
              The number of times an application has tried to send data when the TIPC link was congested

       Send queue
              Max is the maximum amount of messages that has resided in the out queue during the statistics
              collection period of a link.

              Avg is the average outqueue size during the lifetime of a link.

   Link properties
       priority
              The priority between logical TIPC links to a particular node. Link priority can range from 0
              (lowest) to 31 (highest).

       tolerance
              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.

       window
              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.

EXIT STATUS

       Exit status is 0 if command was successful or a positive integer upon failure.

SEE ALSO

       tipc(8), tipc-media(8), tipc-bearer(8), tipc-nametable(8), tipc-node(8), tipc-socket(8)

REPORTING BUGS

       Report any bugs to the Network Developers mailing list <netdev@vger.kernel.org> where the development and
       maintenance is primarily done.  You do not have to be subscribed to the list to send a message there.

AUTHOR

       Richard Alpe <richard.alpe@ericsson.com>