utilities: Implement ovs-vlan-test script
[openvswitch] / utilities / ovs-vlan-test.8.in
1 .TH ovs\-vlan\-test 1 "December 2010" "Open vSwitch" "Open vSwitch Manual"
2 .
3 .SH NAME
4 \fBovs\-vlan\-test\fR \- check Linux drivers for problems with vlan traffic
5 .
6 .SH SYNOPSIS
7 \fBovs\-vlan\-test\fR [\fB\-s\fR | \fB\-\-server\fR] \fIcontrol_ip\fR \fIvlan_ip\fR
8 .so lib/common-syn.man
9 .
10 .SH DESCRIPTION
11 The \fBovs\-vlan\-test\fR program may be used to check for problems sending
12 802.1Q traffic which may occur when running Open vSwitch. These problems can
13 occur when Open vSwitch is used to send 802.1Q traffic through physical
14 interfaces running certain drivers of certain Linux kernel versions. To run a
15 test, configure Open vSwitch to tag traffic originating from \fIvlan_ip\fR and
16 forward it out the target interface. Then run the \fBovs\-vlan\-test\fR in
17 client mode connecting to an \fBovs\-vlan\-test\fR server.
18 \fBovs\-vlan\-test\fR will display "OK" if it did not detect problems.
19 .
20 .SS "Client Mode"
21 An \fBovs\-vlan\-test\fR client may be run on a host to check for VLAN
22 connectivity problems.  The client must be able to establish HTTP connections
23 with an \fBovs\-vlan\-test\fR server located at the specified \fIcontrol_ip\fR
24 address.  UDP traffic sourced at \fIvlan_ip\fR should be tagged and directed out
25 the interface whose connectivity is being tested.
26 .
27 .SS "Server Mode"
28 To conduct tests, an \fBovs\-vlan\-test\fR server must be running on a host
29 known not to have VLAN connectivity problems.  The server must have a
30 \fIcontrol_ip\fR on a non\-VLAN network which clients can establish
31 connectivity with.  It must also have a \fIvlan_ip\fR address on a VLAN network
32 which clients will use to test their VLAN connectivity.  Multiple clients may
33 test against a single \fBovs\-vlan\-test\fR server concurrently.
34 .
35 .SH OPTIONS
36 .
37 .TP
38 \fB\-s\fR, \fB\-\-server\fR
39 Run in server mode.
40 .
41 .so lib/common.man
42 .SH EXAMPLES
43 Display the Linux kernel version and driver of \fBeth1\fR.
44 .IP
45 .B uname \-r
46 .IP
47 .B ethtool \-i eth1
48 .
49 .PP
50 Set up a bridge which forwards traffic originating from \fB1.2.3.4\fR out
51 \fBeth1\fR with VLAN tag 10.
52 .IP
53 .B ovs\-vsctl \-\- add\-br vlan\-br \(rs
54 .IP
55 .B \-\- add\-port vlan\-br eth1 \(rs
56 .IP
57 .B \-\- add\-port vlan\-br vlan\-br\-tag tag=10 \(rs
58 .IP
59 .B \-\- set Interface vlan\-br\-tag type=internal
60 .IP
61 .B ifconfig vlan\-br\-tag up 5.6.7.8
62 .
63 .PP
64 Run an \fBovs\-vlan\-test\fR server listening for client control traffic on
65 5.6.7.8 port 80 and VLAN traffic on the default port of 1.2.3.0.
66 .IP
67 .B ovs\-vlan\-test \-s 5.6.7.8:80 1.2.3.0
68 .
69 .PP
70 Run an \fBovs\-vlan\-test\fR client with a control server located at 5.6.7.8
71 port 80 and a local VLAN ip of 1.2.3.4.
72 .IP
73 .B ovs\-vlan\-test 5.6.7.8:80 1.2.3.4
74 .
75 .TP
76
77 .SH SEE ALSO
78 .
79 .BR ovs\-vswitchd (8),
80 .BR ovs\-ofctl (8),
81 .BR ovs\-vsctl (8),
82 .BR ethtool (8),
83 .BR uname (1)