5bf824f32dfbdf6cfb7ead7d15d2833f8b89da08
[mirror/dsa-puppet.git] / 3rdparty / modules / vswitch / README.md
1 VSwitch
2 =======
3
4 1.1.0 - 2014.2 - Juno
5
6 A Puppet module providing things for vSwitches. At the moment OVS is the only
7 one I've added but please feel free to contribute new providers through
8 Stackforge. It's based upon types and providers so we can support more then just
9 OVS or one vSwitch type.
10
11 The current layout is:
12
13 * bridges - A "Bridge" is basically the thing you plug ports / interfaces into.
14 * ports - A Port is a interface you plug into the bridge (switch).
15
16 ## USAGE:
17 To create a new bridge, use the `vs_bridge` type:
18
19 ```
20 vs_bridge { 'br-ex':
21   ensure => present,
22 }
23 ```
24
25 You can then attach a device to the bridge with a virtual port:
26 ```
27 vs_port { 'eth2':
28   ensure => present,
29   bridge => 'br-ex',
30 }
31 ```
32
33 ## TODO:
34 * OpenFlow controller settings
35 * OpenFlow Settings
36 * OpenFlow Tables
37 * More facts
38 * Others that are not named here