ip-mptcp(8) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | AUTHOR | COLOPHON

IP-MPTCP(8)                       Linux                      IP-MPTCP(8)

NAME         top

       ip-mptcp - MPTCP path manager configuration

SYNOPSIS         top

       ip [ OPTIONS ] mptcp { endpoint  | limits  | help  }

       ip mptcp endpoint add IFADDR [ dev IFNAME ] [ id ID ] [ FLAG-LIST
               ]

       ip mptcp endpoint del id ID

       ip mptcp endpoint show [ id ID ]

       ip mptcp endpoint flush

       FLAG-LIST := [ FLAG-LIST ] FLAG

       FLAG := [ signal | subflow | backup ]

       ip mptcp limits set [ subflow SUBFLOW_NR ] [ add_addr_accepted
               ADD_ADDR_ACCEPTED_NR ]

       ip mptcp limits show

DESCRIPTION         top

       MPTCP is a transport protocol built on top of TCP that allows TCP
       connections to use multiple paths to maximize resource usage and
       increase redundancy. The ip-mptcp sub-commands allow configuring
       several aspects of the MPTCP path manager, which is in charge of
       subflows creation:

       The endpoint object specifies the IP addresses that will be used
       and/or announced for additional subflows:

       ip mptcp endpoint add      add new MPTCP endpoint
       ip mptcp endpoint delete   delete existing MPTCP endpoint
       ip mptcp endpoint show     get existing MPTCP endpoint
       ip mptcp endpoint flush    flush all existing MPTCP endpoints

       ID     is a unique numeric identifier for the given endpoint

       signal the endpoint will be announced/signalled to each peer via
              an ADD_ADDR MPTCP sub-option

       subflow
              if additional subflow creation is allowed by MPTCP limits,
              the endpoint will be used as the source address to create
              an additional subflow after that the MPTCP connection is
              established.

       backup the endpoint will be announced as a backup address, if
              this is a signal endpoint, or the subflow will be created
              as a backup one if this is a subflow endpoint

       The limits object specifies the constraints for subflow
       creations:

       ip mptcp limits show   get current MPTCP subflow creation limits
       ip mptcp limits set    change the MPTCP subflow creation limits

       SUBFLOW_NR
              specifies the maximum number of additional subflows
              allowed for each MPTCP connection. Additional subflows can
              be created due to: incoming accepted ADD_ADDR option,
              local subflow endpoints, additional subflows started by
              the peer.

       ADD_ADDR_ACCEPTED_NR
              specifies the maximum number of ADD_ADDR suboptions
              accepted for each MPTCP connection. The MPTCP path manager
              will try to create a new subflow for each accepted
              ADD_ADDR option, respecting the SUBFLOW_NR limit.

AUTHOR         top

       Original Manpage by Paolo Abeni <pabeni@redhat.com>

COLOPHON         top

       This page is part of the iproute2 (utilities for controlling
       TCP/IP networking and traffic) project.  Information about the
       project can be found at 
       ⟨http://www.linuxfoundation.org/collaborate/workgroups/networking/iproute2⟩.
       If you have a bug report for this manual page, send it to
       netdev@vger.kernel.org, shemminger@osdl.org.  This page was
       obtained from the project's upstream Git repository
       ⟨https://git.kernel.org/pub/scm/network/iproute2/iproute2.git⟩ on
       2021-04-01.  (At that time, the date of the most recent commit
       that was found in the repository was 2021-03-22.)  If you
       discover any rendering problems in this HTML version of the page,
       or you believe there is a better or more up-to-date source for
       the page, or you have corrections or improvements to the
       information in this COLOPHON (which is not part of the original
       manual page), send a mail to man-pages@man7.org

iproute2                       4 Apr 2020                    IP-MPTCP(8)

Pages that refer to this page: ip(8)