{
    "mode": "man",
    "parameter": "tipc-link",
    "section": "8",
    "url": "https://www.chedong.com/phpMan.php/man/tipc-link/8/json",
    "generated": "2026-10-10T09:47:26Z",
    "synopsis": "",
    "sections": {
        "NAME": {
            "content": "tipc-link - show links or modify link properties\n\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "",
            "subsections": [
                {
                    "name": "tipc link set",
                    "content": "[ { priority PRIORITY | tolerance TOLERANCE | window WINDOW } link LINK ] |\n[ { broadcast [ BROADCAST  | REPLICAST  | AUTOSELECT [ ratio SIZE ] ] } ]\n"
                },
                {
                    "name": "tipc link get",
                    "content": "[ { priority | tolerance | window } link LINK ] |\n[ { broadcast } ]\n\ntipc link statistics { show [ link LINK ] | reset link LINK }\n"
                },
                {
                    "name": "tipc link list",
                    "content": "tipc link monitor set { threshold }\n\ntipc link monitor get { threshold }\n"
                },
                {
                    "name": "tipc link monitor summary",
                    "content": ""
                },
                {
                    "name": "tipc link monitor list",
                    "content": "[ media  { eth | ib } device DEVICE ] |\n[ media udp name NAME ]\n\n"
                }
            ]
        },
        "OPTIONS": {
            "content": "Options (flags) that can be passed anywhere in the command chain.\n",
            "subsections": [
                {
                    "name": "-h --help",
                    "content": "Show  help  about last valid command. For example tipc link --help will show link help\nand tipc --help will show general help. The position of the option in  the  string  is\nirrelevant.\n\n",
                    "flag": "-h",
                    "long": "--help"
                },
                {
                    "name": "-j -json",
                    "content": "Output results in JavaScript Object Notation (JSON).\n\n",
                    "flag": "-j"
                },
                {
                    "name": "-p -pretty",
                    "content": "The default JSON format is compact and more efficient to parse but hard for most users\nto read.  This flag adds indentation for readability.\n\n",
                    "flag": "-p"
                }
            ]
        },
        "DESCRIPTION": {
            "content": "",
            "subsections": [
                {
                    "name": "Link statistics",
                    "content": "ACTIVE link state\nAn  ACTIVE  link  is  serving traffic. Two links to the same node can become ACTIVE if\nthey have the same link priority.  If there is more than two links with the same  pri‐\nority the additional links will be put in STANDBY state.\n\n\nSTANDBY link state\nA STANDBY link has lower link priority than an ACTIVE link. A STANDBY link has control\ntraffic flowing and is ready to take over should the ACTIVE link(s) go down.\n\n\nMTU\nThe Maximum Transmission Unit. The two endpoints advertise their default or configured\nMTU  at  initial  link  setup and will agree to use the lower of the two values should\nthey differ.\n\n"
                },
                {
                    "name": "Packets",
                    "content": "The total amount of transmitted or received TIPC packets on a  link.  Including  frag‐\nmented and bundled packets.\n\n"
                },
                {
                    "name": "Fragments",
                    "content": "Represented  in the form fragments/fragmented.  Where fragmented is the amount of data\nmessages which have been broken into fragments.  Subsequently the  fragments  are  the\ntotal amount of packets that the fragmented messages has been broken into.\n\n"
                },
                {
                    "name": "Bundles",
                    "content": "Represented  in  the  form bundles/bundled.  If a link becomes congested the link will\nattempt to bundle data from small bundled packets into bundles of full MTU size  pack‐\nets before they are transmitted.\n\n"
                },
                {
                    "name": "Profile",
                    "content": "Shows  the  average packet size in octets/bytes for a sample of packets. It also shows\nthe packet size distribution of the sampled packets in the intervals\n\n0-64 bytes\n64-256 bytes\n256-1024 bytes\n1024-4096 bytes\n4096-16384 bytes\n16384-32768 bytes\n32768-66000 bytes\n\n"
                },
                {
                    "name": "Message counters",
                    "content": "states - Number of link state messages\n\n\nprobes - Link state messages with probe flag set. Typically sent when a link is idle\n\n\nnacks - Number of negative acknowledgement (NACK) packets sent  and  received  by  the\nlink\n\n\ndefs - Number of packets received out of order\n\n\ndups - Number of duplicate packets received\n\n"
                },
                {
                    "name": "Congestion link",
                    "content": "The  number of times an application has tried to send data when the TIPC link was con‐\ngested\n\n"
                },
                {
                    "name": "Send queue",
                    "content": "Max is the maximum amount of messages that has resided in the  out  queue  during  the\nstatistics collection period of a link.\n\nAvg is the average outqueue size during the lifetime of a link.\n\n"
                },
                {
                    "name": "Link properties",
                    "content": ""
                },
                {
                    "name": "priority",
                    "content": "The  priority between logical TIPC links to a particular node. Link priority can range\nfrom 0 (lowest) to 31 (highest).\n\n"
                },
                {
                    "name": "tolerance",
                    "content": "Link tolerance specifies the maximum time in milliseconds that TIPC will allow a  com‐\nmunication  problem  to  exist  before taking the link down. The default value is 1500\nmilliseconds.\n\n"
                },
                {
                    "name": "window",
                    "content": "The link window controls how many unacknowledged messages a link endpoint can have  in\nits transmit queue before TIPC's congestion control mechanism is activated.\n\n"
                },
                {
                    "name": "Monitor properties",
                    "content": ""
                },
                {
                    "name": "threshold",
                    "content": "The threshold specifies the cluster size exceeding which the link monitoring algorithm\nwill  switch from \"full-mesh\" to \"overlapping-ring\".  If set of 0 the overlapping-ring\nmonitoring is always on and if set to a value larger than anticipated cluster size the\noverlapping-ring is disabled.  The default value is 32.\n\n"
                },
                {
                    "name": "Monitor information",
                    "content": ""
                },
                {
                    "name": "table_generation",
                    "content": "Represents the event count in a node's local monitoring  list.  It  steps  every  time\nsomething changes in the local monitor list, including changes in the local domain.\n\n"
                },
                {
                    "name": "cluster_size",
                    "content": "Represents the current count of cluster members.\n\n"
                },
                {
                    "name": "algorithm",
                    "content": "The  current supervision algorithm used for neighbour monitoring for the bearer.  Pos‐\nsible values are full-mesh or overlapping-ring.\n\n"
                },
                {
                    "name": "status",
                    "content": "The node status derived by the local node.  Possible status are up or down.\n\n"
                },
                {
                    "name": "monitored",
                    "content": "Represent the type of monitoring chosen by the local node.  Possible values are direct\nor indirect.\n\n"
                },
                {
                    "name": "generation",
                    "content": "Represents the domain generation which is the event count in a  node's  local  domain.\nEvery  time  something  changes  (peer  add/remove/up/down)  the  domain generation is\nstepped and a new version of node record is sent to inform the  neighbors  about  this\nchange.  The  domain  generation  helps  the receiver of a domain record to know if it\nshould ignore or process the record.\n\n"
                },
                {
                    "name": "applied_node_status",
                    "content": "The node status reported by the peer node for the succeeding peers in the  node  list.\nThe  Node list is a circular list of ascending addresses starting with the local node.\nPossible status are: U or D. The status U implies up and D down.\n\n"
                },
                {
                    "name": "[non_applied_node:status]",
                    "content": "Represents the nodes and their status as reported by the peer node.  These nodes  were\nnot applied to the monitoring list for this peer node.  They are usually transient and\noccur  during  the  cluster startup phase or network reconfiguration.  Possible status\nare: U or D. The status U implies up and D down.\n\n"
                },
                {
                    "name": "Broadcast properties",
                    "content": "BROADCAST\nForces all multicast traffic to be transmitted via  broadcast  only,  irrespective  of\ncluster size and number of destinations.\n\n\nREPLICAST\nForces  all  multicast  traffic  to be transmitted via replicast only, irrespective of\ncluster size and number of destinations.\n\n\nAUTOSELECT\nAuto switching to broadcast or replicast depending on  cluster  size  and  destination\nnode number.\n\n"
                },
                {
                    "name": "ratio SIZE",
                    "content": "Set the AUTOSELECT criteria, percentage of destination nodes vs cluster size.\n\n"
                }
            ]
        },
        "EXAMPLES": {
            "content": "tipc link monitor list\nShows the link monitoring information for cluster members on device data0.\n\ntipc link monitor summary\nThe monitor summary command prints the basic attributes.\n\n",
            "subsections": []
        },
        "EXIT STATUS": {
            "content": "Exit status is 0 if command was successful or a positive integer upon failure.\n\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "tipc(8),  tipc-media(8), tipc-bearer(8), tipc-nametable(8), tipc-node(8), tipc-peer(8), tipc-\nsocket(8)\n",
            "subsections": []
        },
        "REPORTING BUGS": {
            "content": "Report any bugs to the Network Developers mailing list <netdev@vger.kernel.org> where the de‐\nvelopment and maintenance is primarily done.  You do not have to be subscribed to the list to\nsend a message there.\n\n",
            "subsections": []
        },
        "AUTHOR": {
            "content": "Richard Alpe <richard.alpe@ericsson.com>\n\niproute2                                     22 Mar 2019                                TIPC-LINK(8)",
            "subsections": []
        }
    },
    "summary": "tipc-link - show links or modify link properties",
    "flags": [
        {
            "flag": "-h",
            "long": "--help",
            "arg": null,
            "description": "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."
        },
        {
            "flag": "-j",
            "long": null,
            "arg": null,
            "description": "Output results in JavaScript Object Notation (JSON)."
        },
        {
            "flag": "-p",
            "long": null,
            "arg": null,
            "description": "The default JSON format is compact and more efficient to parse but hard for most users to read. This flag adds indentation for readability."
        }
    ],
    "examples": [
        "tipc link monitor list",
        "Shows the link monitoring information for cluster members on device data0.",
        "tipc link monitor summary",
        "The monitor summary command prints the basic attributes."
    ],
    "see_also": [
        {
            "name": "tipc",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc/8/json"
        },
        {
            "name": "tipc-media",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc-media/8/json"
        },
        {
            "name": "tipc-bearer",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc-bearer/8/json"
        },
        {
            "name": "tipc-nametable",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc-nametable/8/json"
        },
        {
            "name": "tipc-node",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc-node/8/json"
        },
        {
            "name": "tipc-peer",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/tipc-peer/8/json"
        },
        {
            "name": "socket",
            "section": "8",
            "url": "https://www.chedong.com/phpMan.php/man/socket/8/json"
        }
    ]
}