1IP-MPTCP(8)                          Linux                         IP-MPTCP(8)
2
3
4

NAME

6       ip-mptcp - MPTCP path manager configuration
7

SYNOPSIS

9       ip [ OPTIONS ] mptcp { endpoint  | limits  | help  }
10
11
12       ip mptcp endpoint add IFADDR [ dev IFNAME ] [ id ID ] [ FLAG-LIST ]
13
14       ip mptcp endpoint del id ID
15
16       ip mptcp endpoint show [ id ID ]
17
18       ip mptcp endpoint flush
19
20       FLAG-LIST := [ FLAG-LIST ] FLAG
21
22       FLAG := [ signal | subflow | backup ]
23
24       ip mptcp limits set [ subflow SUBFLOW_NR ] [ add_addr_accepted
25               ADD_ADDR_ACCEPTED_NR ]
26
27       ip mptcp limits show
28
29

DESCRIPTION

31       MPTCP is a transport protocol built on top of TCP that allows TCP con‐
32       nections to use multiple paths to maximize resource usage and increase
33       redundancy. The ip-mptcp sub-commands allow configuring several aspects
34       of the MPTCP path manager, which is in charge of subflows creation:
35
36
37       The endpoint object specifies the IP addresses that will be used and/or
38       announced for additional subflows:
39
40
41       ip mptcp endpoint add      add new MPTCP endpoint
42       ip mptcp endpoint delete   delete existing MPTCP endpoint
43       ip mptcp endpoint show     get existing MPTCP endpoint
44       ip mptcp endpoint flush    flush all existing MPTCP endpoints
45
46
47       ID     is a unique numeric identifier for the given endpoint
48
49
50       signal the endpoint will be announced/signalled to each peer via an
51              ADD_ADDR MPTCP sub-option
52
53
54       subflow
55              if additional subflow creation is allowed by MPTCP limits, the
56              endpoint will be used as the source address to create an addi‐
57              tional subflow after that the MPTCP connection is established.
58
59
60       backup the endpoint will be announced as a backup address, if this is a
61              signal endpoint, or the subflow will be created as a backup one
62              if this is a subflow endpoint
63
64
65
66       The limits object specifies the constraints for subflow creations:
67
68
69       ip mptcp limits show   get current MPTCP subflow creation limits
70       ip mptcp limits set    change the MPTCP subflow creation limits
71
72
73       SUBFLOW_NR
74              specifies the maximum number of additional subflows allowed for
75              each MPTCP connection. Additional subflows can be created due
76              to: incoming accepted ADD_ADDR option, local subflow endpoints,
77              additional subflows started by the peer.
78
79
80       ADD_ADDR_ACCEPTED_NR
81              specifies the maximum number of ADD_ADDR suboptions accepted for
82              each MPTCP connection. The MPTCP path manager will try to create
83              a new subflow for each accepted ADD_ADDR option, respecting the
84              SUBFLOW_NR limit.
85
86

AUTHOR

88       Original Manpage by Paolo Abeni <pabeni@redhat.com>
89
90
91
92iproute2                          4 Apr 2020                       IP-MPTCP(8)
Impressum