README

   1                  Open vSwitch <http://openvswitch.org>
   2
   3 What is Open vSwitch?
   4 ---------------------
   5
   6 Open vSwitch is a versatile software-based Ethernet switch with the
   7 following features:
   8
   9         * NIC bonding with automatic fail-over and source MAC-based TX
  10           load balancing ("SLB").
  11
  12         * 802.1Q VLAN support.
  13
  14         * Port mirroring, with optional VLAN tagging.
  15
  16         * NetFlow v5 flow logging.
  17
  18         * Connectivity to an external OpenFlow controller, such as NOX.
  19
  20 Open vSwitch supports Linux 2.6.15 and up, with testing focused on
  21 2.6.18 with Centos and Xen patches and version 2.6.26 from kernel.org.
  22 Open vSwitch also has special support for Citrix XenServer hosts.
  23
  24 What's here?
  25 ------------
  26
  27 The main components of this distribution are:
  28
  29     * ovs-vswitchd, a daemon that implements the switch, along with
  30       a companion Linux kernel module for flow-based switching.
  31
  32     * ovs-brcompatd, a daemon that allows ovs-vswitchd to act as a
  33       drop-in replacement for the Linux bridge in many environments,
  34       along with a companion Linux kernel module to intercept bridge
  35       ioctls.
  36
  37     * ovs-dpctl, a tool for configuring the switch kernel module.
  38
  39     * Scripts and specs for building RPMs that allow Open vSwitch
  40       to be installed on a Citrix XenServer host as a drop-in
  41       replacement for its switch, with additional functionality.
  42
  43     * vlog-appctl, a utility that can control Open vSwitch daemons,
  44       adjusting their logging levels among other uses.
  45
  46 Open vSwitch also provides an OpenFlow implementation and tools for
  47 those interested in OpenFlow but not additional Open vSwitch features:
  48
  49     * secchan, a program that implements a simple OpenFlow switch
  50       (without the special features provided by ovs-vswitchd) using
  51       the same kernel module as ovs-vswitchd.
  52
  53     * ovs-controller, a simple OpenFlow controller.
  54
  55     * ovs-ofctl, a utility for querying and controlling OpenFlow
  56       switches and controllers.
  57
  58     * ovs-pki, a utility for creating and managing the public-key
  59       infrastructure for OpenFlow switches.
  60
  61     * A patch to tcpdump that enables it to parse OpenFlow messages.
  62
  63 What other documentation is available?
  64 --------------------------------------
  65
  66 To install Open vSwitch on a regular Linux machine, read INSTALL.Linux.
  67
  68 To build RPMs for installing Open vSwitch on a Citrix XenServer host
  69 or resource pool, read INSTALL.XenServer.
  70
  71 To learn set up SSL support for Open vSwitch, read INSTALL.SSL.
  72
  73 Each Open vSwitch userspace program is accompanied by a manpage.  Many
  74 of the manpages are customized to your configuration as part of the
  75 build process, so we recommend building Open vSwitch before reading
  76 the manpages.
  77
  78 Contact
  79 -------
  80
  81 bugs@openvswitch.org
  82 http://openvswitch.org/