X-Git-Url: http://git.onelab.eu/?a=blobdiff_plain;f=vswitchd%2Fovs-vswitchd.conf.5.in;h=665d3d0419589dc9d721952ed16085ad6f4e9cdf;hb=5bfc0cd3c6210fb64b614664045ab240dbd44307;hp=de0d6ea2f3b6cdaeef7cac93462b562ca7a9f878;hpb=12fb742b6f0a08590f9ef8d246cd3f57e87b57de;p=sliver-openvswitch.git diff --git a/vswitchd/ovs-vswitchd.conf.5.in b/vswitchd/ovs-vswitchd.conf.5.in index de0d6ea2f..665d3d041 100644 --- a/vswitchd/ovs-vswitchd.conf.5.in +++ b/vswitchd/ovs-vswitchd.conf.5.in @@ -16,14 +16,14 @@ . RE . PP .. -.TH ovs\-vswitchd.conf 5 "April 2009" "Open vSwitch" "OpenVSwitch Manual" +.TH ovs\-vswitchd.conf 5 "June 2009" "Open vSwitch" "Open vSwitch Manual" . .SH NAME ovs\-vswitchd.conf \- configuration file for \fBovs\-vswitchd\fR . .SH DESCRIPTION This manual page describes the syntax for the configuration file used -by \fBovs\-vswitchd\fR(8), the virtual switch daemon. +by \fBovs\-vswitchd\fR(8), the Open vSwitch daemon. .PP The configuration file is based on key-value pairs, which are given one per line in the form \fIkey\fB=\fIvalue\fR. Each \fIkey\fR @@ -50,14 +50,13 @@ configure \fBovs\-vswitchd\fR. .SS "Bridge Configuration" A bridge (switch) with a given \fIname\fR is configured by specifying the names of its network devices as values for key -\fBbridge.\fIname\fB.port\fR. (The specified \fIname\fR may not begin -with \fBdp\fR or \fBnl:\fR followed by a digit.) +\fBbridge.\fIname\fB.port\fR. .PP The names given on \fBbridge.\fIname\fB.port\fR must be the names of existing network devices, except for ``internal ports.'' An internal port is a simulated network device that receives traffic only -through the virtual switch and switches any traffic sent it through -virtual switch. An internal port may configured with an IP address, +through the switch and switches any traffic sent it through the +switch. An internal port may configured with an IP address, etc. using the usual system tools (e.g. \fBifconfig\fR, \fBip\fR). To designate network device \fInetdev\fR as an internal port, add \fBiface.\fInetdev\fB.internal=true\fR to the configuration file. @@ -167,6 +166,10 @@ enabling or disabling an interface, set the value of \fBbonding.\fIname\fB.updelay\fR or \fBbonding.\fIname\fB.downdelay\fR, respectively, to a positive integer, interpreted in milliseconds. +The \fBupdelay\fR setting is honored only when at least one bonded +interface is already enabled. When no interfaces are enabled, then +the first bond interface to come up is enabled immediately. The +\fBdowndelay\fR setting is always honored. .PP The following syntax bonds \fBeth0\fR and \fBeth1\fR into a bonding device named \fBbond0\fR, which is added to bridge \fBmybr\fR along @@ -314,15 +317,16 @@ NetFlow is a protocol that exports a number of details about terminating IP flows, such as the principals involved and duration. A bridge may be configured to send NetFlow v5 records to NetFlow collectors when flows end. To enable, define the key \fBnetflow.\fIbridge\fB.host\fR for each -collector in the form \fIhost\fB:\fIport\fR. Records from \fIbridge\fR -will be sent to each \fIhost\fR on UDP \fIport\fR. +collector in the form \fIip\fB:\fIport\fR. Records from \fIbridge\fR +will be sent to each \fIip\fR on UDP \fIport\fR. The \fIip\fR must +be specified numerically, not as a DNS name. The NetFlow messages will use the datapath index for the engine type and id. This can be overridden with the \fBnetflow.\fIbridge\fB.engine-type\fR and \fBnetflow.\fIbridge\fB.engine-id\fR, respectively. Each takes a value between 0 and 255, inclusive. -Many NetFlow collectors do not expect multiple virtual switches to be +Many NetFlow collectors do not expect multiple switches to be sending messages from the same host, and they do not store the engine information which could be used to disambiguate the traffic. To prevent flows from multiple switches appearing as if they came on the interface, @@ -347,16 +351,15 @@ supports the OpenFlow Management Protocol, such as NOX. This functionality is enabled by setting the key \fBmgmt.controller\fR to one of the following values: . -.TP -\fBssl:\fIhost\fR[\fB:\fIport\fR] -The specified SSL \fIport\fR (default: 6633) on the given remote -\fIhost\fR. SSL must be configured when this form is used (see \fBSSL +.IP "\fBssl:\fIip\fR[\fB:\fIport\fR]" +The specified SSL \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). +SSL must be configured when this form is used (see \fBSSL Configuration\fR, below). . -.TP -\fBtcp:\fIhost\fR[\fB:\fIport\fR] -The specified TCP \fIport\fR (default: 6633) on the given remote -\fIhost\fR. +.IP "\fBtcp:\fIip\fR[\fB:\fIport\fR]" +The specified TCP \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). .PP The maximum time between attempts to connect to the controller may be specified in integral seconds with the \fBmgmt.max-backoff\fR key. The @@ -397,7 +400,7 @@ switch will perform all configured bridging and switching locally. .TP \fBdiscover\fR Use controller discovery to find the local OpenFlow controller. -Refer to \fBsecchan\fR(8) for information on how to configure a DHCP +Refer to \fB\ovs\-openflowd\fR(8) for information on how to configure a DHCP server to support controller discovery. The following additional options control the discovery process: . @@ -427,15 +430,16 @@ that it receives specifies one or more DNS servers. .RE . .TP -\fBssl:\fIhost\fR[\fB:\fIport\fR] -The specified SSL \fIport\fR (default: 6633) on the given remote -\fIhost\fR. SSL must be configured when this form is used (see \fBSSL +\fBssl:\fIip\fR[\fB:\fIport\fR] +The specified SSL \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). +SSL must be configured when this form is used (see \fBSSL Configuration\fR, below). . .TP -\fBtcp:\fIhost\fR[\fB:\fIport\fR] -The specified TCP \fIport\fR (default: 6633) on the given remote -\fIhost\fR. +\fBtcp:\fIip\fR[\fB:\fIport\fR] +The specified TCP \fIport\fR (default: 6633) on the host at the given +\fIip\fR, which must be expressed as an IP address (not a DNS name). . .TP \fBunix:\fIfile\fR @@ -455,7 +459,7 @@ not in use, the following additional settings are honored: By default, or if this is set to \fBtrue\fR, \fBovs\-vswitchd\fR connects to the controller in-band. If this is set to \fBfalse\fR, \fBovs\-vswitchd\fR connects to the controller out-of-band. Refer to -\fBsecchan\fR(8) for a description of in-band and out-of-band control. +\fBovs\-openflowd\fR(8) for a description of in-band and out-of-band control. .IP "\fBbridge.\fIname\fB.controller.ip=\fIip\fR" If specified, the IP address to configure on the bridge's local port. .IP "\fBbridge.\fIname\fB.controller.netmask=\fInetmask\fR" @@ -473,11 +477,11 @@ This optional setting may be set to \fIsecs\fR, a number of seconds. The minimum value of \fIsecs\fR is 5 seconds. The default is taken from \fBmgmt.inactivity-probe\fR (see above). .IP -When the virtual switch is connected to the controller, it waits for a +When the switch is connected to the controller, it waits for a message to be received from the controller for \fIsecs\fR seconds before it sends a inactivity probe to the controller. After sending the inactivity probe, if no response is received for an additional -\fIsecs\fR seconds, the secure channel assumes that the connection has +\fIsecs\fR seconds, \fBovs-vswitchd\fR assumes that the connection has been broken and attempts to reconnect. .IP Changing the inactivity probe interval also changes the interval @@ -485,7 +489,7 @@ before entering standalone mode (see below). .IP "\fBbridge.\fIname\fB.controller.fail-mode=\fBstandalone\fR|\fBsecure\fR" .IQ "\fBmgmt.fail-mode=standalone\fR|\fBsecure\fR" When a controller is configured, it is, ordinarily, responsible for -setting up all flows on the virtual switch. Thus, if the connection to +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. @@ -510,7 +514,7 @@ connection attempts starts at 1 second and doubles on each failing attempt until it reaches the maximum. The default maximum backoff time is taken from \fBmgmt.max-backoff\fR. .ST "Controller Rate-Limiting" -These settings configure how the virtual switch applies a ``token +These settings configure how the switch applies a ``token bucket'' to limit the rate at which packets in unknown flows are forwarded to the OpenFlow controller for flow-setup processing. This feature prevents a single bridge from overwhelming a controller. @@ -563,24 +567,23 @@ When \fBovs\-vswitchd\fR is configured to connect over SSL for management or for controller connectivity, the following settings are required: .TP \fBssl.private-key=\fIprivkey.pem\fR -Specifies a PEM file containing the private key used as the virtual +Specifies a PEM file containing the private key used as the switch's identity for SSL connections to the controller. .TP \fBssl.certificate=\fIcert.pem\fR Specifies a PEM file containing a certificate, signed by the certificate authority (CA) used by the controller and manager, that -certifies the virtual switch's private key, identifying a trustworthy +certifies the switch's private key, identifying a trustworthy switch. .TP \fBssl.ca-cert=\fIcacert.pem\fR Specifies a PEM file containing the CA certificate used to verify that -the virtual switch is connected to a trustworthy controller. +the switch is connected to a trustworthy controller. .PP These files are read only once, at \fBovs\-vswitchd\fR startup time. If their contents change, \fBovs\-vswitchd\fR must be killed and restarted. .PP -These SSL settings apply to all SSL connections made by the virtual -switch. +These SSL settings apply to all SSL connections made by the switch. .ST "CA Certificate Bootstrap" Ordinarily, all of the files named in the SSL configuration must exist when \fBovs\-vswitchd\fR starts. However, if \fBssl.bootstrap-ca-cert\fR @@ -618,8 +621,11 @@ Listens for connections on the Unix domain server socket named \fIfile\fR. Listens for SSL connections on \fIport\fR (default: 6633). SSL must be configured when this form is used (see \fBSSL Configuration\fR, above). -.IP "\fBptcp:\fR[\fIport\fR]" +.IP "\fBptcp:\fR[\fIport\fR][\fB:\fIip\fR]" Listens for TCP connections on \fIport\fR (default: 6633). +By default, \fB\ovs\-vswitchd\fR listens for connections to any local +IP address, but \fIip\fR may be specified to limit connections to the +specified local \fIip\fR. .RE To entirely disable listening for management connections, set \fBbridge.\fIname\fB.openflow.listeners\fR to the single value