man/man8/ip-mptcp.8

   1 .TH IP\-MPTCP 8 "4 Apr 2020" "iproute2" "Linux"
   2 .SH "NAME"
   3 ip-mptcp \- MPTCP path manager configuration
   4 .SH "SYNOPSIS"
   5 .ad l
   6 .in +8
   7 .ti -8
   8 .B ip
   9 .RI "[ " OPTIONS " ]"
  10 .B mptcp
  11 .RB "{ "
  12 .B endpoint
  13 .RB " | "
  14 .B limits
  15 .RB " | "
  16 .B help
  17 .RB " }"
  18 .sp
  19
  20 .ti -8
  21 .BR "ip mptcp endpoint add "
  22 .IR IFADDR
  23 .RB "[ " dev
  24 .IR IFNAME " ]"
  25 .RB "[ " id
  26 .I ID
  27 .RB "] [ "
  28 .I FLAG-LIST
  29 .RB "] "
  30
  31 .ti -8
  32 .BR "ip mptcp endpoint del id "
  33 .I ID
  34
  35 .ti -8
  36 .BR "ip mptcp endpoint show "
  37 .RB "[ " id
  38 .I ID
  39 .RB "]"
  40
  41 .ti -8
  42 .BR "ip mptcp endpoint flush"
  43
  44 .ti -8
  45 .IR FLAG-LIST " := [ "  FLAG-LIST " ] " FLAG
  46
  47 .ti -8
  48 .IR FLAG " := ["
  49 .B signal
  50 .RB "|"
  51 .B subflow
  52 .RB "|"
  53 .B backup
  54 .RB  "]"
  55
  56 .ti -8
  57 .BR "ip mptcp limits set "
  58 .RB "[ "
  59 .B subflow
  60 .IR SUBFLOW_NR " ]"
  61 .RB "[ "
  62 .B add_addr_accepted
  63 .IR  ADD_ADDR_ACCEPTED_NR " ]"
  64
  65 .ti -8
  66 .BR "ip mptcp limits show"
  67
  68 .SH DESCRIPTION
  69
  70 MPTCP is a transport protocol built on top of TCP that allows TCP
  71 connections to use multiple paths to maximize resource usage and increase
  72 redundancy. The ip-mptcp sub-commands allow configuring several aspects of the
  73 MPTCP path manager, which is in charge of subflows creation:
  74
  75 .P
  76 The
  77 .B endpoint
  78 object specifies the IP addresses that will be used and/or announced for
  79 additional subflows:
  80
  81 .TS
  82 l l.
  83 ip mptcp endpoint add   add new MPTCP endpoint
  84 ip mptcp endpoint delete        delete existing MPTCP endpoint
  85 ip mptcp endpoint show  get existing MPTCP endpoint
  86 ip mptcp endpoint flush flush all existing MPTCP endpoints
  87 .TE
  88
  89 .TP
  90 .IR ID
  91 is a unique numeric identifier for the given endpoint
  92
  93 .TP
  94 .BR signal
  95 the endpoint will be announced/signalled to each peer via an ADD_ADDR MPTCP
  96 sub-option
  97
  98 .TP
  99 .BR subflow
 100 if additional subflow creation is allowed by MPTCP limits, the endpoint will
 101 be used as the source address to create an additional subflow after that
 102 the MPTCP connection is established.
 103
 104 .TP
 105 .BR backup
 106 the endpoint will be announced as a backup address, if this is a
 107 .BR signal
 108 endpoint, or the subflow will be created as a backup one if this is a
 109 .BR subflow
 110 endpoint
 111
 112 .sp
 113 .PP
 114 The
 115 .B limits
 116 object specifies the constraints for subflow creations:
 117
 118 .TS
 119 l l.
 120 ip mptcp limits show    get current MPTCP subflow creation limits
 121 ip mptcp limits set     change the MPTCP subflow creation limits
 122 .TE
 123
 124 .TP
 125 .IR SUBFLOW_NR
 126 specifies the maximum number of additional subflows allowed for each MPTCP
 127 connection. Additional subflows can be created due to: incoming accepted
 128 ADD_ADDR option, local
 129 .BR subflow
 130 endpoints, additional subflows started by the peer.
 131
 132 .TP
 133 .IR ADD_ADDR_ACCEPTED_NR
 134 specifies the maximum number of ADD_ADDR suboptions accepted for each MPTCP
 135 connection. The MPTCP path manager will try to create a new subflow for
 136 each accepted ADD_ADDR option, respecting the
 137 .IR SUBFLOW_NR
 138 limit.
 139
 140 .SH AUTHOR
 141 Original Manpage by Paolo Abeni <pabeni@redhat.com>