X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=cd50f556de0619410992e090ebbab22bad112cb8;hb=5e0c05bc058c78a11be6747f62e6ad88e5d06b70;hp=2aba34fdf4f1840d4db4c3635c2477586832893d;hpb=8872051980d541cd7b88c624ac3a08e85171df40;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index 2aba34fd..cd50f556 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -1,45 +1,75 @@
+
A database with this schema holds the configuration for one Open
- vSwitch daemon. The root of the configuration for the daemon is
- the table, which must have exactly one
+
+ A database with this schema holds the configuration for one Open
+ vSwitch daemon. The top-level configuration for the daemon is the
+ table, which must have exactly one
record. Records in other tables are significant only when they
- can be reached directly or indirectly from the
- table.
+ Most tables contain two special columns, named other_config
+ and external_ids
. These columns have the same form and
+ purpose each place that they appear, so we describe them here to save space
+ later.
+
other_config
: map of string-string pairs+ Key-value pairs for configuring rarely used features. Supported keys, + along with the forms taken by their values, are documented individually + for each table. +
+
+ A few tables do not have other_config
columns because no
+ key-value pairs have yet been defined for them.
+
external_ids
: map of string-string pairs+ VLAN IDs of VLANs on which MAC address learning should be disabled, + so that packets are flooded instead of being sent to specific ports + that are believed to contain packets' destination MACs. This should + ordinarily be used to disable MAC learning on VLANs used for + mirroring (RSPAN VLANs). It may also be useful for debugging. +
+
+ SLB bonding (see the column in
+ the table) is incompatible with
+ flood_vlans
. Consider using another bonding mode or
+ a different type of mirror instead.
+
+ OpenFlow controller set. If unset, then no OpenFlow controllers + will be used. +
+ ++ If there are primary controllers, removing all of them clears the + flow table. If there are no primary controllers, adding one also + clears the flow table. Other changes to the set of controllers, such + as adding or removing a service controller, adding another primary + controller to supplement an existing primary controller, or removing + only one of two primary controllers, have no effect on the flow + table. +
+When a controller is configured, it is, ordinarily, responsible + for setting up all flows on the switch. Thus, if the connection to + the controller fails, no new network connections can be set up. + If the connection to the controller stays down long enough, + no packets can pass through the switch at all. This setting + determines the switch's response to such a situation. It may be set + to one of the following: +
standalone
secure
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.
++ Changing when no primary controllers are + configured clears the flow table. +
true
, disable in-band control on the bridge
+ regardless of controller and manager settings.
+ forwarding
, in seconds. By default, the
+ forwarding delay is 15 seconds.
netdev
.
- network-uuids
xe network-list
.datapath-id
hwaddr
xe network-list
.
+ + A number of flows as a nonnegative integer. This sets number of + flows at which eviction from the kernel flow table will be triggered. + If there are a large number of flows then increasing this value to + around the number of flows present can result in reduced CPU usage + and packet loss. +
++ The default is 1000. Values below 100 will be rounded up to 100. +
+true
to enable.
+ + The maximum number of seconds to retain a MAC learning entry for + which no packets have been seen. The default is currently 300 + seconds (5 minutes). The value, if specified, is forced into a + reasonable range, currently 15 to 3600 seconds. +
+ ++ A short MAC aging time allows a network to more quickly detect that a + host is no longer connected to a switch port. However, it also makes + it more likely that packets will be flooded unnecessarily, when they + are addressed to a connected host that rarely transmits packets. To + reduce the incidence of unnecessary flooding, use a MAC aging time + longer than the maximum interval at which a host will ordinarily + transmit packets. +
++ Status information about bridges. +
+
+ The bridge-id (in hex) used in spanning tree advertisements.
+ Configuring the bridge-id is described in the
+ stp-system-id
and stp-priority
keys
+ of the other_config
section earlier.
+
+ The designated root (in hex) for this spanning tree. +
++ The path cost of reaching the designated bridge. A lower + number is better. +
Common
+ Columns
at the beginning of this document.
+
+ Ethernet address to set for this interface. If unset then the - default MAC address is used:
+ default MAC address is used:Some interfaces may not have a software-controllable MAC address.
@@ -323,302 +1113,1360 @@OpenFlow port number for this interface. Unlike most columns, this - column's value should be set only by Open vSwitch itself. Other - clients should set this column to an empty set (the default) when - creating an .
+ column's value should be set only by Open vSwitch itself. Other + clients should set this column to an empty set (the default) when + creating an .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 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.
+ known. If the interface is successfully added, + will be set to a number between 1 and 65535 + (generally either in the range 1 to 65279, inclusive, or 65534, the + port number for the OpenFlow ``local port''). If the interface + cannot be added then Open vSwitch sets this column + to -1.+ The interface type, one of: +
+system
eth0
on Linux.
- Sometimes referred to as ``external interfaces'' since they are
- generally connected to hardware external to that on which the Open
- vSwitch is running. The empty string is a synonym for
- system
.system
.
+
internal
tap
gre
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
local_ip
in_key
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
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
in_key
and
- out_key
at the same time.tos
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
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
false
to disable.pmtud
false
to disable.ipsec_gre
capwap
patch
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.null
Maximum burst size for data received on this interface, in kb. The
- default burst size if set to 0
is 1000 kb. This value
- has no effect if
- is 0
.
The burst size should be at least the size of the interface's - MTU.
-
+ These options apply to interfaces with of
+ gre
, ipsec_gre
, and capwap
.
+
Maximum rate for data received on this interface, in kbps. Data
- received faster than this rate is dropped. Set to 0
to
- disable policing.
The meaning of ``ingress'' is from Open vSwitch's perspective. If - configured on a physical interface, then it limits the rate at which - traffic is allowed into the system from the outside. If configured - on a virtual interface that is connected to a virtual machine, then - it limits the rate at which the guest is able to transmit.
++ Each tunnel must be uniquely identified by the combination of , , , and . 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. is + considered more specific than if + a port defines one and another port defines the other. +
+ ++ Required. The tunnel endpoint. Unicast and multicast endpoints are + both supported. +
+ ++ When a multicast endpoint is specified, a routing table lookup occurs + only when the tunnel is created. Following a routing change, delete + and then re-create the tunnel to force a new routing table lookup. +
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:
-vif-uuid
network-uuid
vm-uuid
vif-mac
MAC
- field in the VIF record for this interface.