1 README.Debian for openvswitch-switch
2 ---------------------------------
4 * To use the Linux kernel-based switch implementation, you will need
5 to build and install the Open vSwitch kernel module. To do so, install
6 the openvswitch-datapath-source package, then follow the instructions
7 given in /usr/share/doc/openvswitch-datapath-source/README.Debian
9 * This package does not yet support the userspace datapath-based
10 switch implementation.
12 -- Ben Pfaff <blp@nicira.com>, Fri, 6 Jul 2012 15:12:38 -0700
14 Debian network scripts integration
15 ----------------------------------
16 This package lets a user to optionally configure Open vSwitch bridges
17 and ports from /etc/network/interfaces. Please refer to the interfaces(5)
18 manpage for more details regarding /etc/network/interfaces.
20 The stanzas that configure the OVS bridges should begin with "allow-ovs"
21 followed by name of the bridge. Here is an example.
24 The stanzas that configure the OVS ports should begin with
25 "allow-${bridge-name}" followed by name of the port. Here is an example.
28 The following OVS specific "command" options are supported:
30 - ovs_type: This can either be OVSBridge, OVSPort, OVSIntPort, OVSBond or
31 OVSTunnel depending on whether you configure a bridge, port, an internal
32 port, a bond or a tunnel. This is a required option.
34 - ovs_ports: This option specifies all the ports that belong to a bridge.
36 - ovs_bridge: This options specifies a bridge to which a port belongs.
37 This is a required option for a port.
39 - ovs_bonds: This option specifies the list of physical interfaces to be
42 - ovs_tunnel_type: For "OVSTunnel" interfaces, the type of the tunnel.
43 For example, "gre", "vxlan", etc.
45 - ovs_tunnel_options: For "OVSTunnel" interfaces, this field should be
46 used to specify the tunnel options like remote_ip, key, etc.
48 - ovs_options: This option lets you add extra arguments to a ovs-vsctl
49 command. See examples.
51 - ovs_extra: This option lets you run additional ovs-vsctl commands,
52 separated by "--" (double dash). Variables can be part of the "ovs_extra"
53 option. You can provide all the standard environmental variables
54 described in the interfaces(5) man page. You can also pass shell
57 More implementation specific details can be seen in the examples.
61 ex 1: A standalone bridge.
69 ex 2: A bridge with one port.
77 iface eth0 inet manual
81 ex 3: A bridge with multiple physical ports.
89 iface eth0 inet manual
94 iface eth1 inet manual
98 ex 4: A bridge with an OVS internal port.
101 iface br1 inet static
103 netmask 255.255.255.0
108 iface vlan100 inet manual
112 ovs_extra set interface ${IFACE} external-ids:iface-id=$(hostname -s)
117 iface br2 inet static
119 netmask 255.255.255.0
124 iface bond0 inet manual
128 ovs_options bond_mode=balance-tcp lacp=active
133 iface br1 inet static
135 netmask 255.255.255.0
140 iface gre1 inet manual
144 ovs_tunnel_options options:remote_ip=182.168.1.2 options:key=1
146 ex 7: Create and destroy bridges.
148 ifup --allow=ovs $list_of_bridges
149 ifdown --allow=ovs $list_of_bridges
151 -- Gurucharan Shetty <gshetty@nicira.com>, Fri, 04 May 2012 12:58:19 -0700