controller/controller.8.in

   1 .TH controller 8 "May 2008" "OpenFlow" "OpenFlow Manual"
   2
   3 .SH NAME
   4 controller \- simple OpenFlow controller reference implementation
   5
   6 .SH SYNOPSIS
   7 .B controller
   8 [\fIoptions\fR] \fImethod\fR \fB[\fImethod\fR]\&...
   9
  10 .SH DESCRIPTION
  11 A sample OpenFlow controller which functions as an L2 MAC-learning
  12 switch or hub.  \fBcontroller\fR can manage a remote datapath through
  13 a secure channel (see \fBsecchan(8)\fR).  It can also connect directly
  14 to a local datapath via Netlink.
  15
  16 \fBcontroller\fR controls one or more OpenFlow switches, specified as
  17 one or more of the following OpenFlow connection methods:
  18
  19 .TP
  20 \fBpssl:\fR[\fIport\fR]
  21 Listens for SSL connections from remote OpenFlow switches on
  22 \fIport\fR (default: 976).  The \fB--private-key\fR,
  23 \fB--certificate\fR, and \fB--ca-cert\fR options are mandatory when
  24 this form is used.
  25
  26 .TP
  27 \fBptcp:\fR[\fIport\fR]
  28 Listens for TCP connections from remote OpenFlow switches on
  29 \fIport\fR (default: 975).
  30
  31 .TP
  32 \fBnl:\fIdp_idx\fR
  33 The local Netlink datapath numbered \fIdp_idx\fR, as configured with
  34 .BR dpctl (8).
  35 This form requires that the local host has the OpenFlow kernel
  36 module for Linux loaded.
  37
  38 .TP
  39 \fBssl:\fIhost\fR[\fB:\fIport\fR]
  40 The specified SSL \fIport\fR (default: 976) on the given remote
  41 \fIhost\fR.  The \fB--private-key\fR, \fB--certificate\fR, and
  42 \fB--ca-cert\fR options are mandatory when this form is used.
  43
  44 .TP
  45 \fBtcp:\fIhost\fR[\fB:\fIport\fR]
  46 The specified TCP \fIport\fR (default: 975) on the given remote
  47 \fIhost\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=\fIcacert.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 .BR \-n ", " \-\^\-noflow
  68 By default, the controller sets up a flow in each OpenFlow switch
  69 whenever it receives a packet whose destination is known due through
  70 MAC learning.  This option disables flow setup, so that every packet
  71 in the network passes through the controller.
  72
  73 This option is most useful for debugging.  It reduces switching
  74 performance, so it should not be used in production.
  75
  76 .TP
  77 \fB--max-idle=\fIsecs\fR|\fBpermanent\fR
  78 Sets \fIsecs\fR as the number of seconds that a flow set up by the
  79 controller will remain in the switch's flow table without any matching
  80 packets being seen.  If \fBpermanent\fR is specified, which is not
  81 recommended, flows will never expire.  The default is 60 seconds.
  82
  83 This option affects only flows set up by the OpenFlow controller.  In
  84 some configurations, the OpenFlow secure channel can set up some flows
  85 on its own.  To set the idle time for those flows, pass
  86 \fB--max-idle\fR to \fBsecchan\fR(8).
  87
  88 This option has no effect when \fB-n\fR (or \fB--noflow\fR) is in use
  89 (because the controller does not set up flows in that case).
  90
  91 .TP
  92 .BR \-H ", " \-\^\-hub
  93 By default, the controller acts as an L2 MAC-learning switch.  This
  94 option changes its behavior to that of a hub that floods packets on
  95 all but the incoming port.
  96
  97 If \fB-H\fR (or \fB--hub\fR) and \fB-n\fR (or \fB--noflow\fR) are used
  98 together, then the cumulative effect is that every packet passes
  99 through the controller and every packet is flooded.
 100
 101 This option is most useful for debugging.  It reduces switching
 102 performance, so it should not be used in production.
 103
 104 .TP
 105 \fB-P\fR[\fIpidfile\fR], \fB--pidfile\fR[\fB=\fIpidfile\fR]
 106 Causes a file (by default, \fBcontroller.pid\fR) to be created indicating
 107 the PID of the running process.  If \fIpidfile\fR is not specified, or
 108 if it does not begin with \fB/\fR, then it is created in
 109 \fB@rundir@\fR.
 110
 111 .TP
 112 \fB-D\fR, \fB--detach\fR
 113 Causes \fBcontroller\fR to detach itself from the foreground session and
 114 run as a background process.
 115
 116 .TP
 117 .BR \-h ", " \-\^\-help
 118 Prints a brief help message to the console.
 119
 120 .TP
 121 \fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
 122 Sets the logging level for \fImodule\fR in \fIfacility\fR to
 123 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
 124 displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
 125 special name \fBANY\fR to set the logging levels for all modules.  The
 126 \fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
 127 for logging to the system log or to the console, respectively, or
 128 \fBANY\fR to set the logging levels for both facilities.  If it is
 129 omitted, \fIfacility\fR defaults to \fBANY\fR.  The \fIlevel\fR must
 130 be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating
 131 the minimum severity of a message for it to be logged.  If it is
 132 omitted, \fIlevel\fR defaults to \fBdbg\fR.
 133
 134 .TP
 135 \fB-v\fR, \fB--verbose\fR
 136 Sets the maximum logging verbosity level, equivalent to
 137 \fB--verbose=ANY:ANY:dbg\fR.
 138
 139 .TP
 140 .BR \-V ", " \-\^\-version
 141 Prints version information to the console.
 142
 143 .SH EXAMPLES
 144
 145 .TP
 146 To connect directly to local datapath 0 over netlink (Linux only):
 147
 148 .B % controller nl:0
 149
 150 .TP
 151 To bind locally to port 975 (the default) and wait for incoming connections from OpenFlow switches:
 152
 153 .B % controller ptcp:
 154
 155 .SH "SEE ALSO"
 156
 157 .BR dpctl (8),
 158 .BR switch (8),
 159 .BR secchan (8),
 160 .BR vlogconf (8)