openflow: Separate OF1.0, OF1.1 flow_mod constants and types.
[openvswitch] / utilities / ovs-vlan-test.8.in
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .TH ovs\-vlan\-test 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
7 .
8 .SH NAME
9 \fBovs\-vlan\-test\fR \- check Linux drivers for problems with vlan traffic
10 .
11 .SH SYNOPSIS
12 \fBovs\-vlan\-test\fR [\fB\-s\fR | \fB\-\-server\fR] \fIcontrol_ip\fR \fIvlan_ip\fR
13 .so lib/common-syn.man
14 .
15 .SH DESCRIPTION
16 The \fBovs\-vlan\-test\fR utility has some limitations, for example, it does
17 not use TCP in its tests. Also it does not take into account MTU to detect
18 potential edge cases. To overcome those limitations a new tool was
19 developed \- \fBovs\-test\fR. \fBovs\-test\fR is currently supported only
20 on Debian so, if possible try to use that on instead of \fBovs\-vlan\-test\fR.
21 .PP
22 The \fBovs\-vlan\-test\fR program may be used to check for problems sending
23 802.1Q traffic which may occur when running Open vSwitch. These problems can
24 occur when Open vSwitch is used to send 802.1Q traffic through physical
25 interfaces running certain drivers of certain Linux kernel versions. To run a
26 test, configure Open vSwitch to tag traffic originating from \fIvlan_ip\fR and
27 forward it out the target interface. Then run the \fBovs\-vlan\-test\fR in
28 client mode connecting to an \fBovs\-vlan\-test\fR server.
29 \fBovs\-vlan\-test\fR will display "OK" if it did not detect problems.
30 .PP
31 Some examples of the types of problems that may be encountered are:
32 .so utilities/ovs-vlan-bugs.man
33 .
34 .SS "Client Mode"
35 An \fBovs\-vlan\-test\fR client may be run on a host to check for VLAN
36 connectivity problems.  The client must be able to establish HTTP connections
37 with an \fBovs\-vlan\-test\fR server located at the specified \fIcontrol_ip\fR
38 address.  UDP traffic sourced at \fIvlan_ip\fR should be tagged and directed out
39 the interface whose connectivity is being tested.
40 .
41 .SS "Server Mode"
42 To conduct tests, an \fBovs\-vlan\-test\fR server must be running on a host
43 known not to have VLAN connectivity problems.  The server must have a
44 \fIcontrol_ip\fR on a non\-VLAN network which clients can establish
45 connectivity with.  It must also have a \fIvlan_ip\fR address on a VLAN network
46 which clients will use to test their VLAN connectivity.  Multiple clients may
47 test against a single \fBovs\-vlan\-test\fR server concurrently.
48 .
49 .SH OPTIONS
50 .
51 .IP "\fB\-s\fR"
52 .IQ "\fB\-\-server\fR"
53 Run in server mode.
54 .
55 .so lib/common.man
56 .SH EXAMPLES
57 Display the Linux kernel version and driver of \fBeth1\fR.
58 .IP
59 .B uname \-r
60 .IP
61 .B ethtool \-i eth1
62 .
63 .PP
64 Set up a bridge which forwards traffic originating from \fB1.2.3.4\fR out
65 \fBeth1\fR with VLAN tag 10.
66 .IP
67 .B ovs\-vsctl \-\- add\-br vlan\-br \(rs
68 .IP
69 .B \-\- add\-port vlan\-br eth1 \(rs
70 .IP
71 .B \-\- add\-port vlan\-br vlan\-br\-tag tag=10 \(rs
72 .IP
73 .B \-\- set Interface vlan\-br\-tag type=internal
74 .IP
75 .B ifconfig vlan\-br\-tag up 1.2.3.4
76 .
77 .PP
78 Run an \fBovs\-vlan\-test\fR server listening for client control traffic on
79 172.16.0.142 port 8080 and VLAN traffic on the default port of 1.2.3.3.
80 .IP
81 .B ovs\-vlan\-test \-s 172.16.0.142:8080 1.2.3.3
82 .
83 .PP
84 Run an \fBovs\-vlan\-test\fR client with a control server located at
85 172.16.0.142 port 8080 and a local VLAN ip of 1.2.3.4.
86 .IP
87 .B ovs\-vlan\-test 172.16.0.142:8080 1.2.3.4
88 .
89 .SH SEE ALSO
90 .
91 .BR ovs\-vswitchd (8),
92 .BR ovs\-ofctl (8),
93 .BR ovs\-vsctl (8),
94 .BR ovs\-test (8),
95 .BR ethtool (8),
96 .BR uname (1)