projects / mirror_ovs.git / blame
| Commit | Line | Data |
|---|---|---|
| 9bccc3ff | 1 | .so lib/ovs.tmac |
| d2cb6c95 | 2 | .TH ovs\-l3ping 1 "@VERSION@" "Open vSwitch" "Open vSwitch Manual" |
| 2d8bdd8f AA |
3 | . |
| 4 | .SH NAME | |
| 5 | \fBovs\-l3ping\fR \- check network deployment for L3 tunneling | |
| 6 | problems | |
| 7 | . | |
| 8 | .SH SYNOPSIS | |
| 9 | \fBovs\-l3ping\fR \fB\-s\fR \fITunnelRemoteIP,InnerIP[/mask]\fR \fB\-t\fR \fItunnelmode\fR | |
| 10 | .br | |
| 11 | \fBovs\-l3ping\fR \fB\-s\fR \fITunnelRemoteIP,InnerIP[/mask][:ControlPort]\fR \fB\-t\fR \fItunnelmode\fR | |
| 12 | .PP | |
| 13 | \fBovs\-l3ping\fR \fB\-c\fR \fITunnelRemoteIP,InnerIP[/mask],RemoteInnerIP\fR \fB\-t\fR \fItunnelmode\fR | |
| 14 | .br | |
| 15 | \fBovs\-l3ping\fR \fB\-c\fR \fITunnelRemoteIP,InnerIP[/mask][:ControlPort\ | |
| 16 | [:DataPort]],RemoteInnerIP[:ControlPort[:DataPort]]\fR | |
| 17 | [\fB\-b\fR \fItargetbandwidth\fR] [\fB\-i\fR \fItestinterval\fR] | |
| 18 | \fB\-t\fR \fItunnelmode\fR | |
| 19 | .so lib/common-syn.man | |
| 20 | . | |
| 21 | .SH DESCRIPTION | |
| 22 | The \fBovs\-l3ping\fR program may be used to check for problems that could | |
| 23 | be caused by invalid routing policy, misconfigured firewall in the tunnel | |
| 24 | path or a bad NIC driver. On one of the nodes, run \fBovs\-l3ping\fR in | |
| 25 | server mode and on the other node run it in client mode. The client and | |
| 26 | server will establish L3 tunnel, over which client will give further testing | |
| 27 | instructions. The \fBovs\-l3ping\fR client will perform UDP and TCP tests. | |
| 28 | This tool is different from \fBovs\-test\fR that it encapsulates XML/RPC | |
| 29 | control connection over the tunnel, so there is no need to open special holes | |
| 30 | in firewall. | |
| 31 | .PP | |
| 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 | .PP | |
| 35 | TCP tests report only achieved bandwidth, because kernel TCP stack | |
| 36 | takes care of flow control and packet loss. | |
| 37 | . | |
| 38 | .SS "Client Mode" | |
| 39 | An \fBovs\-l3ping\fR client will create a L3 tunnel and connect over it to the | |
| 40 | \fBovs\-l3ping\fR server to schedule the tests. \fITunnelRemoteIP\fR is the | |
| 41 | peer's IP address, where tunnel will be terminated. \fIInnerIP\fR is the | |
| 42 | address that will be temporarily assigned during testing. All test traffic | |
| 43 | originating from this IP address to the \fIRemoteInnerIP\fR will be tunneled. | |
| 44 | It is possible to override default \fIControlPort\fR and \fIDataPort\fR, if | |
| 45 | there is any other application that already listens on those two ports. | |
| 46 | . | |
| 47 | .SS "Server Mode" | |
| 48 | To conduct tests, \fBovs\-l3ping\fR server must be running. It is required | |
| 49 | that both client and server \fIInnerIP\fR addresses are in the same subnet. | |
| 50 | It is possible to specify \fIInnerIP\fR with netmask in CIDR format. | |
| 51 | . | |
| 52 | .SH OPTIONS | |
| 53 | One of \fB\-s\fR or \fB\-c\fR is required. The \fB\-t\fR option is | |
| 54 | also required. | |
| 55 | . | |
| 56 | .IP "\fB\-s \fITunnelRemoteIP,InnerIP[/mask][:ControlPort]\fR" | |
| 57 | .IQ "\fB\-\-server\fR \fITunnelRemoteIP,InnerIP[/mask][:ControlPort]\fR" | |
| 58 | Run in server mode and create L3 tunnel with the client that will be | |
| 59 | accepting tunnel at \fITunnelRemoteIP\fR address. The socket on | |
| 60 | \fIInnerIP[:ControlPort]\fR will be used to receive further instructions | |
| 61 | from the client. | |
| 62 | . | |
| 63 | .IP "\fB\-c \fITunnelRemoteIP,InnerIP[/mask][:ControlPort\ | |
| 64 | [:DataPort]],RemoteInnerIP[:ControlPort[:DataPort]]\fR" | |
| 65 | .IQ "\fB\-\-client \fITunnelRemoteIP,InnerIP[/mask][:ControlPort\ | |
| 66 | [:DataPort]],RemoteInnerIP[:ControlPort[:DataPort]]\fR" | |
| 67 | Run in client mode and create L3 tunnel with the server on | |
| 68 | \fITunnelRemoteIP\fR. The client will use \fIInnerIP\fR to generate test | |
| 69 | traffic with the server's \fIRemoteInnerIP\fR. | |
| 70 | . | |
| 71 | .IP "\fB\-b \fItargetbandwidth\fR" | |
| 72 | .IQ "\fB\-\-bandwidth\fR \fItargetbandwidth\fR" | |
| 73 | Target bandwidth for UDP tests. The \fItargetbandwidth\fR must be given in | |
| 74 | bits per second. It is possible to use postfix M or K to alter the target | |
| 75 | bandwidth magnitude. | |
| 76 | . | |
| 77 | .IP "\fB\-i \fItestinterval\fR" | |
| 78 | .IQ "\fB\-\-interval\fR \fItestinterval\fR" | |
| 79 | How long each test should run. By default 5 seconds. | |
| 80 | . | |
| 81 | .IP "\fB\-t \fItunnelmode\fR" | |
| 82 | .IQ "\fB\-\-tunnel\-mode\fR \fItunnelmode\fR" | |
| 83 | Specify the tunnel type. This option must match on server and client. | |
| 84 | . | |
| 85 | .so lib/common.man | |
| 86 | . | |
| 87 | .SH EXAMPLES | |
| 88 | .PP | |
| 89 | On host 192.168.122.220 start \fBovs\-l3ping\fR in server mode. This command | |
| 90 | will create a temporary GRE tunnel with the host 192.168.122.236 and assign | |
| 91 | 10.1.1.1/28 as the inner IP address, where client will have to connect: | |
| 92 | .IP | |
| 93 | .B ovs\-l3ping -s 192.168.122.236,10.1.1.1/28 -t gre | |
| 94 | . | |
| 95 | .PP | |
| 96 | On host 192.168.122.236 start \fBovs\-l3ping\fR in client mode. This command | |
| 97 | will use 10.1.1.2/28 as the local inner IP address and will connect over the | |
| 98 | L3 tunnel to the server's inner IP address at 10.1.1.1. | |
| 99 | .IP | |
| 100 | .B ovs\-l3ping -c 192.168.122.220,10.1.1.2/28,10.1.1.1 -t gre | |
| 101 | . | |
| 102 | .SH SEE ALSO | |
| 103 | . | |
| 104 | .BR ovs\-vswitchd (8), | |
| 105 | .BR ovs\-ofctl (8), | |
| 106 | .BR ovs\-vsctl (8), | |
| 107 | .BR ovs\-vlan\-test (8), | |
| 108 | .BR ovs\-test (8), | |
| 109 | .BR ethtool (8), | |
| 110 | .BR uname (1) |