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