utilities/ovs-controller.8.in

   1 .TH ovs\-controller 8 "March 2009" "Open vSwitch" "Open vSwitch Manual"
   2 .ds PN ovs\-controller
   3
   4 .SH NAME
   5 ovs\-controller \- simple OpenFlow controller reference implementation
   6
   7 .SH SYNOPSIS
   8 .B ovs\-controller
   9 [\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&...
  10
  11 .SH DESCRIPTION
  12 \fBovs\-controller\fR manages any number of remote switches over OpenFlow
  13 protocol, causing them to function as L2 MAC-learning switches or hub.
  14
  15 \fBovs\-controller\fR controls one or more OpenFlow switches, specified as
  16 one or more of the following OpenFlow connection methods:
  17
  18 .TP
  19 \fBpssl:\fR[\fIport\fR]
  20 Listens for SSL connections from remote OpenFlow switches on
  21 \fIport\fR (default: 6633).  The \fB--private-key\fR,
  22 \fB--certificate\fR, and \fB--ca-cert\fR options are mandatory when
  23 this form is used.
  24
  25 .TP
  26 \fBptcp:\fR[\fIport\fR]
  27 Listens for TCP connections from remote OpenFlow switches on
  28 \fIport\fR (default: 6633).
  29
  30 .TP
  31 \fBpunix:\fIfile\fR
  32 Listens for connections from OpenFlow switches on the Unix domain
  33 server socket named \fIfile\fR.
  34
  35 .IP "\fBssl:\fIip\fR[\fB:\fIport\fR]"
  36 The specified SSL \fIport\fR (default: 6633) on the host at the given
  37 \fIip\fR, which must be expressed as an IP address (not a DNS name).
  38 The \fB--private-key\fR, \fB--certificate\fR, and \fB--ca-cert\fR
  39 options are mandatory when this form is used.
  40
  41 .IP "\fBtcp:\fIip\fR[\fB:\fIport\fR]"
  42 The specified TCP \fIport\fR (default: 6633) on the host at the given
  43 \fIip\fR, which must be expressed as an IP address (not a DNS name).
  44
  45 .TP
  46 \fBunix:\fIfile\fR
  47 The Unix domain server socket named \fIfile\fR.
  48
  49 .SH OPTIONS
  50 .TP
  51 \fB-p\fR, \fB--private-key=\fIprivkey.pem\fR
  52 Specifies a PEM file containing the private key used as the switch's
  53 identity for SSL connections to the controller.
  54
  55 .TP
  56 \fB-c\fR, \fB--certificate=\fIcert.pem\fR
  57 Specifies a PEM file containing a certificate, signed by the
  58 controller's certificate authority (CA), that certifies the switch's
  59 private key to identify a trustworthy switch.
  60
  61 .TP
  62 \fB-C\fR, \fB--ca-cert=\fIswitch-cacert.pem\fR
  63 Specifies a PEM file containing the CA certificate used to verify that
  64 the switch is connected to a trustworthy controller.
  65
  66 .TP
  67 \fB--peer-ca-cert=\fIcontroller-cacert.pem\fR
  68 Specifies a PEM file that contains one or more additional certificates
  69 to send to switches.  \fIcontroller-cacert.pem\fR should be the CA
  70 certificate used to sign the controller's own certificate (the
  71 certificate specified on \fB-c\fR or \fB--certificate\fR).
  72
  73 This option is not useful in normal operation, because the switch must
  74 already have the controller CA certificate for it to have any
  75 confidence in the controller's identity.  However, this option allows
  76 a newly installed switch to obtain the controller CA certificate on
  77 first boot using, e.g., the \fB--bootstrap-ca-cert\fR option to
  78 \fBsecchan\fR(8).
  79
  80 .IP "\fB-n\fR, \fB--noflow\fR"
  81 By default, \fBovs\-controller\fR sets up a flow in each OpenFlow switch
  82 whenever it receives a packet whose destination is known due through
  83 MAC learning.  This option disables flow setup, so that every packet
  84 in the network passes through the controller.
  85
  86 This option is most useful for debugging.  It reduces switching
  87 performance, so it should not be used in production.
  88
  89 .TP
  90 \fB--max-idle=\fIsecs\fR|\fBpermanent\fR
  91 Sets \fIsecs\fR as the number of seconds that a flow set up by the
  92 controller will remain in the switch's flow table without any matching
  93 packets being seen.  If \fBpermanent\fR is specified, which is not
  94 recommended, flows will never expire.  The default is 60 seconds.
  95
  96 This option affects only flows set up by the OpenFlow controller.  In
  97 some configurations, the switch can set up some flows
  98 on its own.  To set the idle time for those flows, pass
  99 \fB--max-idle\fR to \fBsecchan\fR (on the switch).
 100
 101 This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use
 102 (because the controller does not set up flows in that case).
 103
 104 .IP "\fB-H\fR, \fB--hub\fR"
 105 By default, the controller acts as an L2 MAC-learning switch.  This
 106 option changes its behavior to that of a hub that floods packets on
 107 all but the incoming port.
 108
 109 If \fB-H\fR (or \fB--hub\fR) and \fB-n\fR (or \fB--noflow\fR) are used
 110 together, then the cumulative effect is that every packet passes
 111 through the controller and every packet is flooded.
 112
 113 This option is most useful for debugging.  It reduces switching
 114 performance, so it should not be used in production.
 115
 116 .so lib/daemon.man
 117 .so lib/vlog.man
 118 .so lib/common.man
 119
 120 .SH EXAMPLES
 121
 122 .TP
 123 To bind locally to port 6633 (the default) and wait for incoming connections from OpenFlow switches:
 124
 125 .B % ovs\-controller ptcp:
 126
 127 .SH "SEE ALSO"
 128
 129 .BR secchan (8),
 130 .BR ovs\-appctl (8),
 131 .BR ovs\-dpctl (8)