1OVS-L3PING(8)                    Open vSwitch                    OVS-L3PING(8)
2
3
4

NAME

6       ovs-l3ping - check network deployment for L3 tunneling problems
7

SYNOPSIS

9       ovs-l3ping -s <TunnelRemoteIP>,<InnerIP>[/<mask>] -t <tunnelmode>
10
11       ovs-l3ping  -s  <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>]  -t
12       <tunnelmode>
13
14       ovs-l3ping  -c  <TunnelRemoteIP>,<InnerIP>[/<mask>],<RemoteInnerIP>  -t
15       <tunnelmode>
16
17       ovs-l3ping -c <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>[:<Dat‐
18       aPort>]],<RemoteInnerIP>[:<ControlPort>[:<DataPort>]] [-b  <targetband‐
19       width>] [-i <testinterval>] -t <tunnelmode>
20
21       ovs-l3ping -h | --help
22
23       ovs-l3ping -V | --version
24

DESCRIPTION

26       The  ovs-l3ping program may be used to check for problems that could be
27       caused by invalid routing policy, misconfigured firewall in the  tunnel
28       path  or  a  bad  NIC  driver.   On one of the nodes, run ovs-l3ping in
29       server mode and on the other node run it in client  mode.   The  client
30       and  server  will establish L3 tunnel, over which client will give fur‐
31       ther testing instructions. The ovs-l3ping client will perform  UDP  and
32       TCP  tests.   This tool is different from ovs-test that it encapsulates
33       XML/RPC control connection over the tunnel, so there is no need to open
34       special holes in firewall.
35
36       UDP  tests  can  report  packet loss and achieved bandwidth for various
37       datagram sizes. By default target bandwidth for UDP tests is 1Mbit/s.
38
39       TCP tests report only achieved  bandwidth,  because  kernel  TCP  stack
40       takes care of flow control and packet loss.
41
42   Client Mode
43       An ovs-l3ping client will create a L3 tunnel and connect over it to the
44       ovs-l3ping server to  schedule  the  tests.   <TunnelRemoteIP>  is  the
45       peer’s  IP  address, where tunnel will be terminated.  <InnerIP> is the
46       address that will be temporarily assigned  during  testing.   All  test
47       traffic originating from this IP address to the <RemoteInnerIP> will be
48       tunneled.  It is possible to override default <ControlPort> and  <Data‐
49       Port>,  if there is any other application that already listens on those
50       two ports.
51
52   Server Mode
53       To conduct tests, ovs-l3ping server must be running.   It  is  required
54       that both client and server <InnerIP> addresses are in the same subnet.
55       It is possible to specify <InnerIP> with netmask in CIDR format.
56

OPTIONS

58       One of -s or -c is required.  The -t option is also required.
59
60       • -s  <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>]  or  --server
61         <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>]
62
63         Run  in server mode and create L3 tunnel with the client that will be
64         accepting tunnel at <TunnelRemoteIP> address.   The  socket  on  <In‐
65         nerIP>[:<ControlPort>]  will  be used to receive further instructions
66         from the client.
67
68       • -c         <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>[:<Data‐
69         Port>]],<RemoteInnerIP>[:<ControlPort>[:<DataPort>]]    or   --client
70         <TunnelRemoteIP>,<InnerIP>[/<mask>][:<ControlPort>[:<DataPort>]],<Re‐
71         moteInnerIP>[:<ControlPort>[:<DataPort>]]
72
73         Run in client mode and create L3 tunnel with the server on <TunnelRe‐
74         moteIP>.  The client will use <InnerIP> to generate test traffic with
75         the server’s <RemoteInnerIP>.
76
77       • -b <targetbandwidth> or --bandwidth <targetbandwidth>
78
79         Target  bandwidth  for UDP tests. The <targetbandwidth> must be given
80         in bits per second.  Use postfix M or K to alter the target bandwidth
81         magnitude.
82
83       • -i <testinterval> or --interval <testinterval>
84
85         How long each test should run. By default 5 seconds.
86
87       • -t <tunnelmode> or --tunnel-mode <tunnelmode>
88
89         Specify the tunnel type. This option must match on server and client.
90
91       • -h or --help
92
93         Prints a brief help message to the console.
94
95       • -V or --version
96
97         Prints version information to the console.
98

EXAMPLES

100       On  host 192.168.122.220 start ovs-l3ping in server mode.  This command
101       will create a temporary GRE tunnel with the  host  192.168.122.236  and
102       assign  10.1.1.1/28  as the inner IP address, where client will have to
103       connect:
104
105          ovs-l3ping -s 192.168.122.236,10.1.1.1/28 -t gre
106
107       On host 192.168.122.236 start ovs-l3ping in client mode.  This  command
108       will  use  10.1.1.2/28  as  the local inner IP address and will connect
109       over the L3 tunnel to the server’s inner IP address at 10.1.1.1:
110
111          ovs-l3ping -c 192.168.122.220,10.1.1.2/28,10.1.1.1 -t gre
112

SEE ALSO

114       ovs-vswitchd(8),    ovs-ofctl(8),    ovs-vsctl(8),    ovs-vlan-test(8),
115       ovs-test(8), ethtool(8), uname(1).
116

AUTHOR

118       The Open vSwitch Development Community
119

121       2021, The Open vSwitch Development Community
122
123
124
125
1262.15                             Feb 21, 2021                    OVS-L3PING(8)
Impressum