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 [ port PORT ] [ dev IFNAME ] [ id ID ] [
13               FLAG-LIST ]
14
15       ip mptcp endpoint del id ID
16
17       ip mptcp endpoint show [ id ID ]
18
19       ip mptcp endpoint flush
20
21       FLAG-LIST := [ FLAG-LIST ] FLAG
22
23       FLAG := [ signal | subflow | backup ]
24
25       ip mptcp limits set [ subflow SUBFLOW_NR ] [ add_addr_accepted
26               ADD_ADDR_ACCEPTED_NR ]
27
28       ip mptcp limits show
29
30       ip mptcp monitor
31
32

DESCRIPTION

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

AUTHOR

102       Original Manpage by Paolo Abeni <pabeni@redhat.com>
103
104
105
106iproute2                          4 Apr 2020                       IP-MPTCP(8)
Impressum