|
 |
359b1d |
From af65892658d7c271d1fb328065a35f8017610418 Mon Sep 17 00:00:00 2001
|
|
|
359b1d |
From: Andrea Claudi <aclaudi@redhat.com>
|
|
|
359b1d |
Date: Thu, 4 Jun 2020 19:28:45 +0200
|
|
|
359b1d |
Subject: [PATCH] man: mptcp man page
|
|
|
359b1d |
|
|
|
359b1d |
Bugzilla: https://bugzilla.redhat.com/show_bug.cgi?id=1812207
|
|
|
359b1d |
Upstream Status: unknown commit 2d8b5fe93e9de
|
|
|
359b1d |
|
|
|
359b1d |
commit 2d8b5fe93e9decb56acc243905d82fb22d6c4cfd
|
|
|
359b1d |
Author: Paolo Abeni <pabeni@redhat.com>
|
|
|
359b1d |
Date: Thu Apr 23 15:37:10 2020 +0200
|
|
|
359b1d |
|
|
|
359b1d |
man: mptcp man page
|
|
|
359b1d |
|
|
|
359b1d |
describe the mptcp subcommands implemented so far.
|
|
|
359b1d |
|
|
|
359b1d |
Signed-off-by: Paolo Abeni <pabeni@redhat.com>
|
|
|
359b1d |
Signed-off-by: David Ahern <dsahern@gmail.com>
|
|
|
359b1d |
---
|
|
|
359b1d |
man/man8/ip-mptcp.8 | 142 ++++++++++++++++++++++++++++++++++++++++++++
|
|
|
359b1d |
1 file changed, 142 insertions(+)
|
|
|
359b1d |
create mode 100644 man/man8/ip-mptcp.8
|
|
|
359b1d |
|
|
|
359b1d |
diff --git a/man/man8/ip-mptcp.8 b/man/man8/ip-mptcp.8
|
|
|
359b1d |
new file mode 100644
|
|
|
359b1d |
index 0000000000000..f6457e97efbe8
|
|
|
359b1d |
--- /dev/null
|
|
|
359b1d |
+++ b/man/man8/ip-mptcp.8
|
|
|
359b1d |
@@ -0,0 +1,142 @@
|
|
|
359b1d |
+.TH IP\-MPTCP 8 "4 Apr 2020" "iproute2" "Linux"
|
|
|
359b1d |
+.SH "NAME"
|
|
|
359b1d |
+ip-mptcp \- MPTCP path manager configuration
|
|
|
359b1d |
+.SH "SYNOPSIS"
|
|
|
359b1d |
+.sp
|
|
|
359b1d |
+.ad l
|
|
|
359b1d |
+.in +8
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.B ip
|
|
|
359b1d |
+.RI "[ " OPTIONS " ]"
|
|
|
359b1d |
+.B mptcp
|
|
|
359b1d |
+.RB "{ "
|
|
|
359b1d |
+.B endpoint
|
|
|
359b1d |
+.RB " | "
|
|
|
359b1d |
+.B limits
|
|
|
359b1d |
+.RB " | "
|
|
|
359b1d |
+.B help
|
|
|
359b1d |
+.RB " }"
|
|
|
359b1d |
+.sp
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp endpoint add "
|
|
|
359b1d |
+.IR IFADDR
|
|
|
359b1d |
+.RB "[ " dev
|
|
|
359b1d |
+.IR IFNAME " ]"
|
|
|
359b1d |
+.RB "[ " id
|
|
|
359b1d |
+.I ID
|
|
|
359b1d |
+.RB "] [ "
|
|
|
359b1d |
+.I FLAG-LIST
|
|
|
359b1d |
+.RB "] "
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp endpoint del id "
|
|
|
359b1d |
+.I ID
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp endpoint show "
|
|
|
359b1d |
+.RB "[ " id
|
|
|
359b1d |
+.I ID
|
|
|
359b1d |
+.RB "]"
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp endpoint flush"
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.IR FLAG-LIST " := [ " FLAG-LIST " ] " FLAG
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.IR FLAG " := ["
|
|
|
359b1d |
+.B signal
|
|
|
359b1d |
+.RB "|"
|
|
|
359b1d |
+.B subflow
|
|
|
359b1d |
+.RB "|"
|
|
|
359b1d |
+.B backup
|
|
|
359b1d |
+.RB "]"
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp limits set "
|
|
|
359b1d |
+.RB "[ "
|
|
|
359b1d |
+.B subflow
|
|
|
359b1d |
+.IR SUBFLOW_NR " ]"
|
|
|
359b1d |
+.RB "[ "
|
|
|
359b1d |
+.B add_addr_accepted
|
|
|
359b1d |
+.IR ADD_ADDR_ACCEPTED_NR " ]"
|
|
|
359b1d |
+
|
|
|
359b1d |
+.ti -8
|
|
|
359b1d |
+.BR "ip mptcp limits show"
|
|
|
359b1d |
+
|
|
|
359b1d |
+.SH DESCRIPTION
|
|
|
359b1d |
+
|
|
|
359b1d |
+MPTCP is a transport protocol built on top of TCP that allows TCP
|
|
|
359b1d |
+connections to use multiple paths to maximize resource usage and increase
|
|
|
359b1d |
+redundancy. The ip-mptcp sub-commands allow configuring several aspects of the
|
|
|
359b1d |
+MPTCP path manager, which is in charge of subflows creation:
|
|
|
359b1d |
+
|
|
|
359b1d |
+.P
|
|
|
359b1d |
+The
|
|
|
359b1d |
+.B endpoint
|
|
|
359b1d |
+object specifies the IP addresses that will be used and/or announced for
|
|
|
359b1d |
+additional subflows:
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TS
|
|
|
359b1d |
+l l.
|
|
|
359b1d |
+ip mptcp endpoint add add new MPTCP endpoint
|
|
|
359b1d |
+ip mptcp endpoint delete delete existing MPTCP endpoint
|
|
|
359b1d |
+ip mptcp endpoint show get existing MPTCP endpoint
|
|
|
359b1d |
+ip mptcp endpoint flush flush all existing MPTCP endpoints
|
|
|
359b1d |
+.TE
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.IR ID
|
|
|
359b1d |
+is a unique numeric identifier for the given endpoint
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.BR signal
|
|
|
359b1d |
+the endpoint will be announced/signalled to each peer via an ADD_ADDR MPTCP
|
|
|
359b1d |
+sub-option
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.BR subflow
|
|
|
359b1d |
+if additional subflow creation is allowed by MPTCP limits, the endpoint will
|
|
|
359b1d |
+be used as the source address to create an additional subflow after that
|
|
|
359b1d |
+the MPTCP connection is established.
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.BR backup
|
|
|
359b1d |
+the endpoint will be announced as a backup address, if this is a
|
|
|
359b1d |
+.BR signal
|
|
|
359b1d |
+endpoint, or the subflow will be created as a backup one if this is a
|
|
|
359b1d |
+.BR subflow
|
|
|
359b1d |
+endpoint
|
|
|
359b1d |
+
|
|
|
359b1d |
+.sp
|
|
|
359b1d |
+.PP
|
|
|
359b1d |
+The
|
|
|
359b1d |
+.B limits
|
|
|
359b1d |
+object specifies the constraints for subflow creations:
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TS
|
|
|
359b1d |
+l l.
|
|
|
359b1d |
+ip mptcp limits show get current MPTCP subflow creation limits
|
|
|
359b1d |
+ip mptcp limits set change the MPTCP subflow creation limits
|
|
|
359b1d |
+.TE
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.IR SUBFLOW_NR
|
|
|
359b1d |
+specifies the maximum number of additional subflows allowed for each MPTCP
|
|
|
359b1d |
+connection. Additional subflows can be created due to: incoming accepted
|
|
|
359b1d |
+ADD_ADDR option, local
|
|
|
359b1d |
+.BR subflow
|
|
|
359b1d |
+endpoints, additional subflows started by the peer.
|
|
|
359b1d |
+
|
|
|
359b1d |
+.TP
|
|
|
359b1d |
+.IR ADD_ADDR_ACCEPTED_NR
|
|
|
359b1d |
+specifies the maximum number of ADD_ADDR suboptions accepted for each MPTCP
|
|
|
359b1d |
+connection. The MPTCP path manager will try to create a new subflow for
|
|
|
359b1d |
+each accepted ADD_ADDR option, respecting the
|
|
|
359b1d |
+.IR SUBFLOW_NR
|
|
|
359b1d |
+limit.
|
|
|
359b1d |
+
|
|
|
359b1d |
+.SH AUTHOR
|
|
|
359b1d |
+Original Manpage by Paolo Abeni <pabeni@redhat.com>
|
|
|
359b1d |
--
|
|
|
359b1d |
2.26.2
|
|
|
359b1d |
|