X-Git-Url: https://pintos-os.org/cgi-bin/gitweb.cgi?a=blobdiff_plain;f=vswitchd%2Fvswitch.xml;h=b9d8aaa9f3249d3a5f53e9366b2f0e72e4f47271;hb=92467099ee05b930b060d34d05b81bb1322e6fbf;hp=f3864047410923531947128fb0e726941a5bf6a3;hpb=bd1bcd39a51c6110a94392ab1551b36b8df6bc59;p=openvswitch
diff --git a/vswitchd/vswitch.xml b/vswitchd/vswitch.xml
index f3864047..b9d8aaa9 100644
--- a/vswitchd/vswitch.xml
+++ b/vswitchd/vswitch.xml
@@ -32,11 +32,20 @@
choose key names that are likely to be unique. The currently
defined common key-value pairs are:
- system-uuid
- - A universally unique identifier for the Open vSwitch's
- physical host. The form of the identifier depends on the
- type of the host. On a Citrix XenServer, this is the host
- UUID displayed by, e.g.,
xe host-list
.
+ system-type
+ - An identifier for the switch type, such as
+
XenServer
or KVM
.
+ system-version
+ - The version of the switch software, such as
+
5.6.0
on XenServer.
+ system-id
+ - A unique identifier for the Open vSwitch's physical host.
+ The form of the identifier depends on the type of the host.
+ On a Citrix XenServer, this will likely be the same as
+
xs-system-uuid
.
+ xs-system-uuid
+ - The Citrix XenServer universally unique identifier for the
+ physical host as displayed by
xe host-list
.
@@ -187,13 +196,15 @@
integrators should either use the Open vSwitch development
mailing list to coordinate on common key-value definitions, or
choose key names that are likely to be unique. The currently
- defined common key-value pairs are:
+ defined key-value pairs are:
- network-uuids
+ bridge-id
+ - A unique identifier of the bridge. On Citrix XenServer this
+ will commonly be the same as
xs-network-uuids
.
+ xs-network-uuids
- Semicolon-delimited set of universally unique identifier(s) for
- the network with which this bridge is associated. The form of the
- identifier(s) depends on the type of the host. On a Citrix
- XenServer host, the network identifiers are RFC 4122 UUIDs as
+ the network with which this bridge is associated on a Citrix
+ XenServer host. The network identifiers are RFC 4122 UUIDs as
displayed by, e.g.,
xe network-list
.
@@ -353,7 +364,7 @@
column), external IDs for the fake bridge are defined here by
prefixing a key with fake-bridge-
,
- e.g. fake-bridge-network-uuids
.
+ e.g. fake-bridge-xs-network-uuids
.
@@ -505,8 +516,9 @@
csum
- - Optional. Compute GRE checksums for outgoing packets and
- require checksums for incoming packets. Note that GRE checksums
+
- Optional. Compute GRE checksums on outgoing packets.
+ Checksums present on incoming packets will be validated
+ regardless of this setting. Note that GRE checksums
impose a significant performance penalty as they cover the
entire packet. As the contents of the packet is typically
covered by L3 and L4 checksums, this additional checksum only
@@ -528,6 +540,61 @@
Default is enabled, set to
false
to disable.
+ capwap
+ Ethernet tunneling over the UDP transport portion of CAPWAP
+ (RFC 5415). This allows interoperability with certain switches
+ where GRE is not available. Note that only the tunneling component
+ of the protocol is implemented. Due to the non-standard use of
+ CAPWAP, UDP ports 58881 and 58882 are used as the source and
+ destinations ports respectivedly. Each tunnel must be uniquely
+ identified by the combination of remote_ip
and
+ local_ip
. If two ports are defined that are the same
+ except one includes local_ip
and the other does not,
+ the more specific one is matched first. CAPWAP support is not
+ available on all platforms. Currently it is only supported in the
+ Linux kernel module with kernel versions >= 2.6.25. The following
+ options may be specified in the column:
+
+ remote_ip
+ - Required. The tunnel endpoint.
+
+
+ local_ip
+ - Optional. The destination IP that received packets must
+ match. Default is to match all addresses.
+
+
+ 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.
+
+
+ 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
@@ -553,6 +620,20 @@
Configuration options whose interpretation varies based on
.
+
+
+
+ Key-value pairs that report port status. Supported status
+ values are type
-dependent.
+
+ The only currently defined key-value pair is:
+
+ source_ip
+ - The source IP address used for an IPv4 tunnel end-point,
+ such as
gre
or capwap
. Not
+ supported by all implementations.
+
+
@@ -579,15 +660,26 @@
+ Key-value pairs for use by external frameworks that integrate
+ with Open vSwitch, rather than by Open vSwitch itself. System
+ integrators should either use the Open vSwitch development
+ mailing list to coordinate on common key-value definitions, or
+ choose key names that are likely to be unique. The currently
+ defined common key-value pairs are:
+
+ attached-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.
+ iface-id
+ - A system-unique identifier for the interface. On XenServer,
+ this will commonly be the same as
xs-vif-uuid
.
+
- Key-value pairs for use by external frameworks that integrate
- with Open vSwitch, rather than by Open vSwitch itself. System
- integrators should either use the Open vSwitch development
- mailing list to coordinate on common key-value definitions, or
- choose key names that are likely to be unique.
-
-
- All of the currently defined key-value pairs specifically
+ Additionally the following 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
@@ -596,20 +688,14 @@
UUIDs in RFC 4122 format. Other hypervisors may use other
formats.
- The currently defined key-value pairs are:
+ The currently defined key-value pairs for XenServer are:
- vif-uuid
+ xs-vif-uuid
- The virtual interface associated with this interface.
- network-uuid
+ xs-network-uuid
- The virtual network to which this interface is attached.
- vm-uuid
+ xs-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.
@@ -689,7 +775,12 @@
defined types are listed below:
linux-htb
- - Linux ``hierarchy token bucket'' classifier.
+ -
+ Linux ``hierarchy token bucket'' classifier. See tc-htb(8) (also at
+
http://linux.die.net/man/8/tc-htb
) and the HTB manual
+ (http://luxik.cdi.cz/~devik/qos/htb/manual/userg.htm
)
+ for information on how this classifier works and how to configure it.
+