1ovs-l3ping(1)                 Open vSwitch Manual                ovs-l3ping(1)
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       ovs-l3ping -s TunnelRemoteIP,InnerIP[/mask][:ControlPort] -t tunnelmode
11
12       ovs-l3ping -c TunnelRemoteIP,InnerIP[/mask],RemoteInnerIP -t tunnelmode
13       ovs-l3ping     -c     TunnelRemoteIP,InnerIP[/mask][:ControlPort[:Data‐
14       Port]],RemoteInnerIP[:ControlPort[:DataPort]] [-b targetbandwidth]  [-i
15       testinterval] -t tunnelmode
16
17       Common options:
18              [-h | --help] [-V | --version]
19
20

DESCRIPTION

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

OPTIONS

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

EXAMPLES

93       On  host 192.168.122.220 start ovs-l3ping in server mode.  This command
94       will create a temporary GRE tunnel with the  host  192.168.122.236  and
95       assign  10.1.1.1/28  as the inner IP address, where client will have to
96       connect:
97
98              ovs-l3ping -s 192.168.122.236,10.1.1.1/28 -t gre
99
100       On host 192.168.122.236 start ovs-l3ping in client mode.  This  command
101       will  use  10.1.1.2/28  as  the local inner IP address and will connect
102       over the L3 tunnel to the server's inner IP address at 10.1.1.1.
103
104              ovs-l3ping -c 192.168.122.220,10.1.1.2/28,10.1.1.1 -t gre
105

SEE ALSO

107       ovs-vswitchd(8),    ovs-ofctl(8),    ovs-vsctl(8),    ovs-vlan-test(8),
108       ovs-test(8), ethtool(8), uname(1)
109
110
111
112Open vSwitch                        2.10.1                       ovs-l3ping(1)
Impressum