A port within a .
Most commonly, a port has exactly one ``interface,'' pointed to by its
- column. Such a port logically
+ column. Such a port logically
corresponds to a port on a physical Ethernet switch. A port
with more than one interface is a ``bonded port'' (see
).
@@ -168,37 +211,48 @@
A bridge port must be configured for VLANs in one of two
mutually exclusive ways:
- - A ``trunk port'' has an empty value for
-
and a possibly non-empty
- value.
+ - A ``trunk port'' has an empty value for
. Its value may be
+ empty or non-empty.
- An ``implicitly tagged VLAN port'' or ``access port''
- has an nonempty value for
and an empty
- value.
+ has an nonempty value for . Its
+ value must be empty.
If and are both
nonempty, the configuration is ill-formed.
- If nonempty, this port's implicitly tagged VLAN. Frames
- arriving on trunk ports will be forwarded to this port only
- if they are tagged with the given VLAN. Frames arriving on
- other VLAN ports will be forwarded to this port only if they
- have the same value. Frames forwarded
- to this port will not have an 802.1Q header.
- When a frame with a 802.1Q header that indicates a nonzero VLAN is
- received on an implicit VLAN port, it is discarded.
- Must be empty if this is a trunk port.
+
+ If this is an access port (see above), the port's implicitly
+ tagged VLAN. Must be empty if this is a trunk port.
+
+
+ Frames arriving on trunk ports will be forwarded to this
+ port only if they are tagged with the given VLAN (or, if
+ is 0, then if they lack a VLAN header).
+ Frames arriving on other access ports will be forwarded to
+ this port only if they have the same
+ value. Frames forwarded to this port will not have an
+ 802.1Q header.
+
+
+ When a frame with a 802.1Q header that indicates a nonzero
+ VLAN is received on an access port, it is discarded.
+
- The 802.1Q VLAN(s) that this port trunks. If the column is
- empty, then the port trunks all VLANs as well as packets that
- have no VLAN header. Otherwise, only frames that have an
- 802.1Q header with one of the specified VLANs are accepted.
- If 0
is included, then frames without an 802.1Q
- header are also accepted.
- Must be empty unless this is a trunk port.
+
+ If this is a trunk port (see above), the 802.1Q VLAN(s) that
+ this port trunks; if it is empty, then the port trunks all
+ VLANs. Must be empty if this is an access port.
+
+
+ Frames arriving on trunk ports are dropped if they are not
+ in one of the specified VLANs. For this purpose, packets
+ that have no VLAN header are treated as part of VLAN 0.
+
@@ -227,17 +281,21 @@
For a bonded port, the number of milliseconds for which carrier must
stay down on an interface before the interface is considered to be
- down. Specify 0
to enable the interface immediately.
+ down. Specify 0
to disable the interface immediately.
- For a bonded port, whether to create a fake interface with the name of
- the port. Use only for compatibility with legacy software that
+ For a bonded port, whether to create a fake internal interface with the
+ name of the port. Use only for compatibility with legacy software that
requires this.
+
+ Quality of Service configuration for this port.
+
+
The MAC address to use for this port for the purpose of choosing the
bridge's MAC address. This column does not necessarily reflect the
@@ -254,9 +312,10 @@
Key-value pairs that identify this port's role in external systems. No
key-value pairs native to are currently defined.
For fake bridges (see the column), external
- IDs for the fake bridge are defined here by prefixing their keys
+ IDs for the fake bridge are defined here by prefixing a
+ key
with fake-bridge-
,
- e.g. fake-bridge-xs-network-uuids
.
+ e.g. fake-bridge-network-uuids
.
@@ -264,8 +323,15 @@
currently defined key-value pairs are:
hwaddr
- - Exactly 12 hex digits in the form
+
- An Ethernet address in the form
xx:xx:xx:xx:xx:xx
.
+ bond-rebalance-interval
+ - For a bonded port, the number of milliseconds between
+ successive attempts to rebalance the bond, that is, to
+ move source MACs and their flows from one interface on
+ the bond to another in an attempt to keep usage of each
+ interface roughly equal. The default is 10000 (10
+ seconds), and the minimum is 1000 (1 second).
@@ -293,7 +359,7 @@
whose name is first in alphabetical order). Internal ports and
bridge ports that are used as port mirroring destinations (see the
table) are ignored.
- For other internal interface, the default MAC is randomly
+ For other internal interfaces, the default MAC is randomly
generated.
External interfaces typically have a MAC address associated with
their hardware.
@@ -310,10 +376,10 @@
Open vSwitch populates this column when the port number becomes
known. If the interface is successfully added,
will be set to a number between 1 and 65535
- (generally either in the range 1 to 0xff00
, exclusive,
- or 0xfffe
, the port number for the OpenFlow ``local
- port''). If the interface cannot be added then Open vSwitch sets
- this column to -1
.
+ (generally either in the range 1 to 65280, exclusive, or 65534, the
+ port number for the OpenFlow ``local port''). If the interface
+ cannot be added then Open vSwitch sets this column
+ to -1.
@@ -328,7 +394,7 @@
vSwitch is running. The empty string is a synonym for
system
.
internal
- A simulated network devices that sent and receive traffic. An
+ A simulated network device that sends and receives traffic. An
internal interface whose is the same as its
bridge's is called the
``local interface.'' It does not make sense to bond an internal
@@ -337,7 +403,94 @@
tap
A TUN/TAP device managed by Open vSwitch.
gre
- A GRE tunnel device managed by Open vSwitch.
+ An Ethernet over RFC 1702 Generic Routing Encapsulation over IPv4
+ tunnel. Each tunnel must be uniquely identified by the
+ combination of remote_ip
, local_ip
, and
+ in_key
. Note that if two ports are defined that are
+ the same except one has an optional identifier and the other does
+ not, the more specific one is matched first. in_key
+ is considered more specific than local_ip
if a port
+ defines one and another port defines the other. The arguments
+ are:
+
+ remote_ip
+ - Required. The tunnel endpoint.
+
+
+ local_ip
+ - Optional. The destination IP that received packets must
+ match. Default is to match all addresses.
+
+
+ in_key
+ - Optional. The GRE key that received packets must contain.
+ It may either be a 32-bit number (no key and a key of 0 are
+ treated as equivalent) or the word
flow
. If
+ flow
is specified then any key will be accepted
+ and the key will be placed in the tun_id
field
+ for matching in the flow table. The ovs-ofctl manual page
+ contains additional information about matching fields in
+ OpenFlow flows. Default is no key.
+
+
+ out_key
+ - Optional. The GRE key to be set on outgoing packets. It may
+ either be a 32-bit number or the word
flow
. If
+ flow
is specified then the key may be set using
+ the set_tunnel
Nicira OpenFlow vendor extension (0
+ is used in the absense of an action). The ovs-ofctl manual
+ page contains additional information about the Nicira OpenFlow
+ vendor extensions. Default is no key.
+
+
+ key
+ - Optional. Shorthand to set
in_key
and
+ out_key
at the same time.
+
+
+ tos
+ - Optional. The value of the ToS bits to be set on the
+ encapsulating packet. It may also be the word
+
inherit
, in which case the ToS will be copied from
+ the inner packet if it is IPv4 or IPv6 (otherwise it will be
+ 0). Note that the ECN fields are always inherited. Default is
+ 0.
+
+
+ ttl
+ - Optional. The TTL to be set on the encapsulating packet.
+ It may also be the word
inherit
, in which case the
+ TTL will be copied from the inner packet if it is IPv4 or IPv6
+ (otherwise it will be the system default, typically 64).
+ Default is the system default TTL.
+
+
+ csum
+ - Optional. Compute GRE checksums for outgoing packets and
+ require checksums for incoming packets. Default is enabled,
+ set to
false
to disable.
+
+
+ pmtud
+ - Optional. Enable tunnel path MTU discovery. If enabled
+ ``ICMP destination unreachable - fragmentation'' needed
+ messages will be generated for IPv4 packets with the DF bit set
+ and IPv6 packets above the minimum MTU if the packet size
+ exceeds the path MTU minus the size of the tunnel headers. It
+ also forces the encapsulating packet DF bit to be set (it is
+ always set if the inner packet implies path MTU discovery).
+ Note that this option causes behavior that is typically
+ reserved for routers and therefore is not entirely in
+ compliance with the IEEE 802.1D specification for bridges.
+ Default is enabled, set to
false
to disable.
+
+
+ patch
+ A pair of virtual devices that act as a patch cable. A
+ peer
argument is required that indicates the name
+ of the other side of the patch. Since a patch must work in
+ pairs, a second patch interface must be declared with the
+ name
and peer
arguments reversed.
@@ -371,26 +524,178 @@
- Key-value pairs that identify this interface's role in external
- systems. The currently defined key-value pairs are:
+ Key-value pairs that identify this interface's role in external
+ systems. All of the currently defined key-value pairs specifically
+ apply to an interface that represents a virtual Ethernet interface
+ connected to a virtual machine. These key-value pairs should not be
+ present for other types of interfaces. Keys whose names end
+ in -uuid
have values that uniquely identify the entity
+ in question. For a Citrix XenServer hypervisor, these values are
+ UUIDs in RFC 4122 format. Other hypervisors may use other
+ formats.
+ The currently defined key-value pairs are:
- xs-vif-uuid
- - UUID of the Citrix XenServer VIF associated with this
- interface
- xs-network-uuid
- - UUID of the Citrix XenServer network to which this interface is
- attached
- xs-vif-vm-uuid
- - UUID of the Citrix XenServer VM to which this interface
- belongs
- xs-vif-mac
- - The value of the "MAC" field in the Citrix XenServer VIF record
- for this interface.
+ vif-uuid
+ - The virtual interface associated with this interface.
+ network-uuid
+ - The virtual network to which this interface is attached.
+ vm-uuid
+ - The VM to which this interface belongs.
+ vif-mac
+ - The MAC address programmed into the "virtual hardware" for this
+ interface, in the
+ form xx:xx:xx:xx:xx:xx.
+ For Citrix XenServer, this is the value of the
MAC
+ field in the VIF record for this interface.
+
+
+
+ Key-value pairs that report interface statistics. The current
+ implementation updates these counters periodically. In the future,
+ we plan to, instead, update them when an interface is created, when
+ they are queried (e.g. using an OVSDB select
operation),
+ and just before an interface is deleted due to virtual interface
+ hot-unplug or VM shutdown, and perhaps at other times, but not on any
+ regular periodic basis.
+
+ The currently defined key-value pairs are listed below. These are
+ the same statistics reported by OpenFlow in its struct
+ ofp_port_stats
structure. If an interface does not support a
+ given statistic, then that pair is omitted.
+
+ -
+ Successful transmit and receive counters:
+
+ rx_packets
+ - Number of received packets.
+ rx_bytes
+ - Number of received bytes.
+ tx_packets
+ - Number of transmitted packets.
+ tx_bytes
+ - Number of transmitted bytes.
+
+
+ -
+ Receive errors:
+
+ rx_dropped
+ - Number of packets dropped by RX.
+ rx_frame_err
+ - Number of frame alignment errors.
+ rx_over_err
+ - Number of packets with RX overrun.
+ rx_crc_err
+ - Number of CRC errors.
+ rx_errors
+ -
+ Total number of receive errors, greater than or equal
+ to the sum of the above.
+
+
+
+ -
+ Transmit errors:
+
+ tx_dropped
+ - Number of packets dropped by TX.
+ collisions
+ - Number of collisions.
+ tx_errors
+ -
+ Total number of transmit errors, greater
+ than or equal to the sum of the above.
+
+
+
+
+
+
A port mirror within a .
A port mirror configures a bridge to send selected frames to special
@@ -403,14 +708,17 @@
+
+ If true, every packet arriving or departing on any port is
+ selected for mirroring.
+
+
Ports on which departing packets are selected for mirroring.
- Ports on which arriving packets are selected for mirroring. If this
- column and are both empty, then all
- packets on all ports are selected for mirroring.
+ Ports on which arriving packets are selected for mirroring.
@@ -470,13 +778,20 @@
- An OpenFlow controller.
+ An OpenFlow controller.
+
+ Open vSwitch permits a bridge to have any number of OpenFlow
+ controllers. When multiple controllers are configured, Open vSwitch
+ connects to all of them simultaneously. OpenFlow 1.0 does not specify
+ how multiple controllers coordinate in interacting with a single switch,
+ so more than one controller should be specified only if the controllers
+ are themselves designed to coordinate with each other.
- Connection method for controller.
- The following connection methods are currently
- supported:
+ Connection method for controller.
+ The following connection methods are currently
+ supported:
ssl:ip
[:port
]
-
@@ -493,15 +808,58 @@
the given ip, which must be expressed as an IP address
(not a DNS name).
discover
- - Enables controller discovery.
+ -
+
Enables controller discovery.
+ In controller discovery mode, Open vSwitch broadcasts a DHCP
+ request with vendor class identifier OpenFlow
across
+ all of the bridge's network devices. It will accept any valid
+ DHCP reply that has the same vendor class identifier and includes
+ a vendor-specific option with code 1 whose contents are a string
+ specifying the location of the controller in the same format as
+ .
+ The DHCP reply may also, optionally, include a vendor-specific
+ option with code 2 whose contents are a string specifying the URI
+ to the base of the OpenFlow PKI
+ (e.g. http://192.168.0.1/openflow/pki
). This URI is
+ used only for bootstrapping the OpenFlow PKI at initial switch
+ setup; ovs-vswitchd
does not use it at all.
+
none
- Disables the controller.
+ When multiple controllers are configured for a single bridge, the
+ values must be unique. Duplicate
+ values yield unspecified results.
- Either in-band
or out-of-band
. If not
- specified, the default is implementation-specific.
+ If it is specified, this setting must be one of the following
+ strings that describes how Open vSwitch contacts this OpenFlow
+ controller over the network:
+
+
+ in-band
+ - In this mode, this controller's OpenFlow traffic travels over the
+ bridge associated with the controller. With this setting, Open
+ vSwitch allows traffic to and from the controller regardless of the
+ contents of the OpenFlow flow table. (Otherwise, Open vSwitch
+ would never be able to connect to the controller, because it did
+ not have a flow to enable it.) This is the most common connection
+ mode because it is not necessary to maintain two independent
+ networks.
+ out-of-band
+ - In this mode, OpenFlow traffic uses a control network separate
+ from the bridge associated with this controller, that is, the
+ bridge does not use any of its own network devices to communicate
+ with the controller. The control network must be configured
+ separately, before or after
ovs-vswitchd
is started.
+
+
+
+ If not specified, the default is implementation-specific. If
+ is discover
, the connection mode
+ is always treated as in-band
regardless of the actual
+ setting.
@@ -535,7 +893,7 @@
times the inactivity probe interval
(see ), then Open vSwitch
will take over responsibility for setting up flows. In
- this mode, Open vSwitch causes the datapath to act like an
+ this mode, Open vSwitch causes the bridge to act like an
ordinary MAC-learning switch. Open vSwitch will continue
to retry connecting to the controller in the background
and, when the connection succeeds, it will discontinue its
@@ -546,19 +904,20 @@
connecting to the controller forever.
- If this value is unset, the default is
- implementation-specific.
+ If this value is unset, the default is implementation-specific.
+ When more than one controller is configured,
+ is considered only when none of the
+ configured controllers can be contacted. At that point, the bridge
+ enters secure mode if any of the controllers'
+ is set to secure
. Otherwise,
+ it enters standalone mode if at least one
+ is set to standalone
. If none of the
+ values are set, the default is
+ implementation-defined.
-
- In conjunction with ,
- the maximum number of unused packet credits that the bridge will
- allow to accumulate, in packets. If not specified, the default
- is implementation-specific.
-
-
The maximum rate at which packets in unknown flows will be
forwarded to the OpenFlow controller, in packets per second. This
@@ -578,11 +937,21 @@
actual rate that packets are sent to the controller is up to
twice the specified rate.
+
+
+ In conjunction with ,
+ the maximum number of unused packet credits that the bridge will
+ allow to accumulate, in packets. If not specified, the default
+ is implementation-specific.
+
-
+
+ These values are considered only when
+ is discover
.
+
- If is discover
, a POSIX
+ A POSIX
extended regular expression against which the discovered controller
location is validated. The regular expression is implicitly
anchored at the beginning of the controller location string, as
@@ -591,8 +960,7 @@
- If is discover
,
- whether to update /etc/resolv.conf
when the
+ Whether to update /etc/resolv.conf
when the
controller is discovered. If not specified, the default
is implementation-specific. Open vSwitch will only modify
/etc/resolv.conf
if the DHCP response that it receives
@@ -600,20 +968,35 @@
-
-
- If is not discover
, the IP
- address of the gateway to configure on the local port.
-
+
+ These values are considered only in in-band control mode (see
+ ) and only when
+ is not discover
. (For controller discovery, the network
+ configuration obtained via DHCP is used instead.)
+
+ When multiple controllers are configured on a single bridge, there
+ should be only one set of unique values in these columns. If different
+ values are set for these columns in different controllers, the effect
+ is unspecified.
- If is not discover
, the IP
- address to configure on the local port.
+ The IP address to configure on the local port,
+ e.g. 192.168.0.123
. If this value is unset, then
+ and are
+ ignored.
- If is not discover
, the IP
- netmask to configure on the local port.
+ The IP netmask to configure on the local port,
+ e.g. 255.255.255.0
. If is set
+ but this value is unset, then the default is chosen based on whether
+ the IP address is class A, B, or C.
+
+
+
+ The IP address of the gateway to configure on the local port, as a
+ string, e.g. 192.168.0.1
. Leave this column unset if
+ this network has no gateway.
@@ -696,10 +1079,11 @@
of switches.
+ Records in this table describe functionality supported by the hardware
+ and software platform on which this Open vSwitch is based. Clients
+ should not modify this table.
+
+ A record in this table is meaningful only if it is referenced by the
+ column in the
+ table. The key used to reference it, called
+ the record's ``category,'' determines the meanings of the
+ column. The following general forms of
+ categories are currently defined:
+
+
+ qos-type
+ - type is supported as the value for
+
in the table.
+
+
+
+
+ Key-value pairs that describe capabilities. The meaning of the pairs
+ depends on the category key that the column in the table
+ uses to reference this record, as described above.
+
+ The presence of a record for category qos-type
+ indicates that the switch supports type as the value of
+ the column in the
+ table. The following key-value pairs are defined to further describe
+ QoS capabilities:
+
+
+ n-queues
+ - Number of supported queues, as a positive integer. Keys in the
+
column for
+ records whose value
+ equals type must range between 0 and this value minus one,
+ inclusive.
+
+
+