man/man8/controller.8

   1 .TH controller 8 "December 2007" "OpenFlow" "OpenFlow Manual"
   2
   3 .SH NAME
   4 controller \- OpenFlow controller reference implementation
   5
   6 .SH SYNOPSIS
   7 .B controller
   8 [OPTIONS] ptcp:[\fIPORT\fR] | nl:\fIDP_IDX\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 To connect to local datapath number \fIDP_IDX\fR (Linux only), specify
  17 nl:\fIDP_IDX\fR on the command line.  To listen for TCP connections
  18 from remote datapaths on port \fIPORT\fR, specify ptcp:[\fIPORT\fR].
  19 (\fIPORT\fR defaults to 975 if omitted.)
  20
  21 \fBcontroller\fR can control multiple datapaths.  Multiple ptcp: or
  22 nl: arguments may be given.  Multiple TCP clients may connect to a
  23 single TCP server port.
  24
  25 .SH OPTIONS
  26 .TP
  27 .BR \-H ", " \-\^\-hub
  28 By default, the controller acts as an L2 MAC-learning switch.  This
  29 option changes its behavior to that of a hub that floods packets on
  30 all ports.
  31
  32 .TP
  33 .BR \-h ", " \-\^\-help
  34 Prints a brief help message to the console.
  35
  36 .TP
  37 .BR \-n ", " \-\^\-noflow
  38 This is similar to the \fB\-\^\-hub\fR option, but does not add a
  39 flow entry in the switch.  This causes all traffic seen by the switch
  40 to be passed to the controller before being sent out all ports.
  41
  42 .TP
  43 .BR \-v ", " \-\^\-verbose
  44 Prints debug messages to the console.
  45
  46 .TP
  47 .BR \-V ", " \-\^\-version
  48 Prints version information to the console.
  49
  50 .SH EXAMPLES
  51
  52 .TP
  53 To connect directly to local datapath 0 over Netlink (Linux only):
  54
  55 .B % controller nl:0
  56
  57 .TP
  58 To bind locally to port 975 (the default) and wait for incoming connections from secure channels:
  59
  60 .B % controller ptcp:
  61
  62 .SH "SEE ALSO"
  63
  64 .BR dpctl (8),
  65 .BR secchan (8)
  66 .BR vlogconf (8)
  67
  68 .SH BUGS
  69 Currently \fBcontroller\fR does not support SSL.