Add doc for debugging port status update
[netvirt.git] / docs / user-guide / bridge-configuration.rst
1 Bridge Configuration
2 ====================
3
4 .. contents:: Table of Contents
5    :depth: 2
6
7 The following describes OVS bridge configurations supported by OpenDaylight.
8
9 The "br-int" Bridge
10 -------------------
11 If the br-int bridge is not configured prior to the ovsdb manager connection with ODL,
12 ODL will create it. If br-int exists prior to the ovsdb manager connection, ODL will retain
13 any existing configurations on br-int. Note that if you choose to create br-int prior to
14 connecting to ODL, ``disable-in-band`` MUST be set to true and any flows configured may interfere
15 with the flows ODL will create. ODL will add the following configuration items to br-int:
16
17 1. ODL will set itself as br-int's controller
18 2. Any provider network configuration (see section "Provider Networks" below)
19
20 It is important to note that once the ovsdb manager connection is established with ODL, ODL
21 "owns" br-int and other applications should not modify its settings.
22
23 Provider Networks
24 -----------------
25 Provider networks should be configured prior to OVSDB connecting to ODL. These are configured
26 in the Open_vSwitch table’s other_Config column and have the format ``<physnet>:<connector>``
27 where ``<physnet>`` is the name of the provider network and ``<connector>`` is one of the following
28 three options:
29
30 1. The name of a local interface (ODL will add this port to br-int)
31 2. The name of a bridge on OpenVSwitch (ODL will create patch ports between br-int and this bridge)
32 3. The name of a port already present on br-int (ODL will use that port)
33
34 For example, assume your provider network is called extnet and it is attached to the eth0 interface
35 on your host you can set this in OVSDB using the following command:
36
37 ``sudo ovs-vsctl set Open_vSwitch . Other_Config:provider_mappings=extnet:eth0``
38
39 If instead of ``eth0`` the provider network is accesable via on OVS bridge called ``br-int``, ``eth0`` in the
40 above command would be substituted with ``br-int``.