utilities/dpctl.8

   1 .TH dpctl 8 "May 2008" "OpenFlow" "OpenFlow Manual"
   2
   3 .SH NAME
   4 dpctl \- administer OpenFlow datapaths
   5
   6 .SH SYNOPSIS
   7 .B dpctl
   8 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR&...]
   9
  10 .SH DESCRIPTION
  11 The
  12 .B dpctl
  13 program is a command line tool for monitoring and administering OpenFlow
  14 datapaths.  It is able to show the current state of a datapath,
  15 including features, configuration, and tables entries.  When using the
  16 OpenFlow kernel module,
  17 .B dpctl
  18 is used to add, delete, modify, and monitor datapaths.
  19
  20 Most \fBdpctl\fR commands take an argument that specifies the
  21 method for connecting to an OpenFlow switch.  The following connection
  22 methods are supported:
  23
  24 .TP
  25 \fBnl:\fIdp_idx\fR
  26 The local Netlink datapath numbered \fIdp_idx\fR.  This form requires
  27 that the local host has the OpenFlow kernel module for Linux loaded.
  28
  29 .TP
  30 \fBssl:\fIhost\fR[\fB:\fIport\fR]
  31 The specified SSL \fIport\fR (default: 976) on the given remote
  32 \fIhost\fR.  The \fB--private-key\fR, \fB--certificate\fR, and
  33 \fB--ca-cert\fR options are mandatory when this form is used.
  34
  35 .TP
  36 \fBtcp:\fIhost\fR[\fB:\fIport\fR]
  37 The specified TCP \fIport\fR (default: 975) on the given remote
  38 \fIhost\fR.
  39
  40 .SH COMMANDS
  41
  42 With the \fBdpctl\fR program, datapaths running in the kernel can be
  43 created, deleted, modified, and monitored.  A single machine may
  44 host up to 32 datapaths (numbered 0 to 31).  In most situations,
  45 a machine hosts only one datapath.
  46
  47 A newly created datapath is not associated with any of the
  48 host's network devices thus does not process any incoming
  49 traffic.  To intercept and process traffic on a given network device, the
  50 network device must be explicitly added to a datapath through the
  51 \fBaddif\fR command.
  52
  53 The following commands manage local datapaths.
  54
  55 .TP
  56 \fBadddp nl:\fIdp_idx\fR
  57 Creates datapath numbered \fIdp_idx\fR on the local host.  This will
  58 fail if \fIdp_idx\fR is not in the range 0 to 31, or if the datapath
  59 with that number already exists on the host.
  60
  61 .TP
  62 \fBdeldp nl:\fIdp_idx\fR
  63 Deletes datapath \fIdp_idx\fR on the local host.  \fIdp_idx\fR must be
  64 an existing datapath.  All of a datapath's network devices must be
  65 explicitly removed before the datapath can be deleted (see \fBdelif\fR
  66 command).
  67
  68 .TP
  69 \fBaddif nl:\fIdp_idx netdev\fR
  70 Adds \fInetdev\fR to the list of network devices datapath
  71 \fIdp_idx\fR monitors, where \fIdp_idx\fR is the ID of an existing
  72 datapath, and \fInetdev\fR is the name of one of the host's
  73 network devices, e.g. \fBeth0\fR.  Once a network device has been added
  74 to a datapath, the datapath has complete ownership of the network device's
  75 traffic and the network device appears silent to the rest of the system.
  76
  77 .TP
  78 \fBdelif nl:\fIdp_idx netdev\fR
  79 Removes \fInetdev\fR from the list of network devices datapath
  80 \fIdp_idx\fR monitors.
  81
  82 .TP
  83 \fBmonitor nl:\fIdp_idx\fR
  84 Prints to the console all OpenFlow packets sent by datapath
  85 \fIdp_idx\fR to its controller, where \fIdp_idx\fR is the ID of an
  86 existing datapath.
  87
  88 .TP
  89 \fBbenchmark-nl nl:\fIdp_idx n size\fR
  90 Checks the netlink performance between the kernel and userspace.
  91 This is done by sending \fIN\fR packets of \fIsize\fR bytes from
  92 the kernel module to dpctl.
  93
  94 .PP
  95 The following commands can be used regardless of the connection method.
  96
  97 .TP
  98 \fBshow \fIswitch\fR
  99 Prints to the console information on datapath \fIswitch\fR including
 100 information on its flow tables and ports.
 101
 102 .TP
 103 \fBdump-tables \fIswitch\fR
 104 Prints to the console statistics for each of the flow tables used by
 105 datapath \fIswitch\fR.
 106
 107 .TP
 108 \fBdump-ports \fIswitch\fR
 109 Prints to the console statistics for each of the network devices
 110 associated with datapath \fIswitch\fR.
 111
 112 .TP
 113 \fBdump-flows \fIswitch \fR[\fIflows\fR]
 114 Prints to the console all flow entries in datapath \fIswitch\fR's
 115 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
 116 in the datapath are retrieved.  See \fBFLOW SYNTAX\fR, below, for the
 117 syntax of \fIflows\fR.
 118
 119 .TP
 120 \fBdump-aggregate \fIswitch \fR[\fIflows\fR]
 121 Prints to the console aggregate statistics for flows in datapath
 122 \fSWITCH\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted,
 123 the statistics are aggregated across all flows in the datapath's flow
 124 tables.  See \fBFLOW SYNTAX\fR, below, for the syntax of \fIflows\fR.
 125
 126 .TP
 127 \fBadd-flow \fIswitch flow\fR
 128 Add the flow entry as described by \fIflow\fR to the datapath \fIswitch\fR's
 129 tables.  The flow entry is in the format described in \fBFLOW SYNTAX\fR,
 130 below.
 131
 132 .TP
 133 \fBadd-flows \fIswitch file\fR
 134 Add flow entries as described in \fIfile\fR to the datapath \fIswitch\fR's
 135 tables.  Each line in \fIfile\fR is a flow entry in the format
 136 described in \fBFLOW SYNTAX\fR, below.
 137
 138 .TP
 139 \fBdel-flows \fIswitch \fR[\fIflow\fR]
 140 Deletes entries from the datapath \fIswitch\fR's tables that match
 141 \fIflow\fR.  If \fIflow\fR is omitted, all flows in the datapath's
 142 tables are removed.  See \fBFLOW SYNTAX\fR, below, for the syntax of
 143 \fIflows\fR.
 144
 145 .SH "FLOW SYNTAX"
 146
 147 Some \fBdpctl\fR commands accept an argument that describes a flow or
 148 flows.  Such flow descriptions comprise a series
 149 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
 150 space.
 151
 152 The following field assignments describe how a flow matches a packet.
 153 If any of these assignments is omitted from the flow syntax, the field
 154 is treated as a wildcard; thus, if all of them are omitted, the
 155 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
 156 may be specified a value to explicitly mark any of these fields as a
 157 wildcard.
 158
 159 .IP \fBin_port=\fIport_no\fR
 160 Matches physical port \fIport_no\fR.  Switch ports are numbered as
 161 displayed by \fBdpctl show\fR.
 162
 163 .IP \fBdl_vlan=\fIvlan\fR
 164 Matches IEEE 802.1q virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
 165 as \fIvlan\fR to match packets that are not tagged with a virtual LAN;
 166 otherwise, specify a number between 0 and 4095, inclusive, as the
 167 12-bit VLAN ID to match.
 168
 169 .IP \fBdl_src=\fImac\fR
 170 Matches Ethernet source address \fImac\fR, which should be specified
 171 as 6 pairs of hexadecimal digits delimited by colons,
 172 e.g. \fB00:0A:E4:25:6B:B0\fR.
 173
 174 .IP \fBdl_dst=\fImac\fR
 175 Matches Ethernet destination address \fImac\fR.
 176
 177 .IP \fBdl_type=\fIethertype\fR
 178 Matches Ethernet protocol type \fIethertype\fR, which should be
 179 specified as a integer between 0 and 65535, inclusive, either in
 180 decimal or as a hexadecimal number prefixed by \fB0x\fR,
 181 e.g. \fB0x0806\fR to match ARP packets.
 182
 183 .IP \fBnw_src=\fIip\fR
 184 Matches IPv4 source address \fIip\fR, which should be specified as an
 185 IP address or host name, e.g. \fB192.168.1.1\fR or
 186 \fBwww.example.com\fR.
 187
 188 .IP \fBnw_dst=\fInw_dst\fR
 189 Matches IPv4 destination address \fIip\fR.
 190
 191 .IP \fBnw_proto=\fIproto\fR
 192 Matches IP protocol type \fIproto\fR, which should be specified as a
 193 decimal number between 0 and 255, inclusive, e.g. 6 to match TCP
 194 packets.
 195
 196 .IP \fBtp_src=\fIport\fR
 197 Matches UDP or TCP source port \fIport\fR, which should be specified
 198 as a decimal number between 0 and 65535, inclusive, e.g. 80 to match
 199 packets originating from a HTTP server.
 200
 201 .IP \fBtp_dst=\fIport\fR
 202 Matches UDP or TCP destination port \fIport\fR.
 203
 204 .PP
 205 The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional field:
 206
 207 .IP \fIactions\fB=\fItarget\fR[\fB,\fItarget\fR...]\fR
 208 Specifies a comma-separated list of actions to take on a packet when the
 209 flow entry matches.  The \fItarget\fR may be a decimal port number
 210 designating the physical port on which to output the packet, or one of
 211 the following keywords:
 212
 213 .RS
 214 .IP \fBoutput\fR:\fIport\fR
 215 Outputs the packet on the port specified by \fIport\fR.
 216
 217 .IP \fBnormal\fR
 218 Subjects the packet to the device's normal L2/L3 processing.  (This
 219 action is not implemented by all OpenFlow switches.)
 220
 221 .IP \fBflood\fR
 222 Outputs the packet on all switch physical ports other than the port on
 223 which it was received and any ports on which flooding is disabled
 224 (typically, these would be ports disabled by the IEEE 802.1D spanning
 225 tree protocol).
 226
 227 .IP \fBall\fR
 228 Outputs the packet on all switch physical ports other than the port on
 229 which it was received.
 230
 231 .IP \fBcontroller\fR:\fImax_len\fR
 232 Sends the packet to the OpenFlow controller as a ``packet in''
 233 message.  If \fImax_len\fR is a number, then it specifies the maximum
 234 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
 235 omitted, then the entire packet is sent.
 236
 237 .IP \fBlocal\fR
 238 Outputs the packet on the ``local port,'' which corresponds to the
 239 \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
 240 \fBsecchan\fR(8) for information on the \fBof\fIn\fR network device).
 241
 242 .IP \fBmod_vlan\fR:\fIvlan_id\fR
 243 Modifies the VLAN tag on a packet.  If \fIvlan_id\fR is a number, then
 244 the VLAN tag is added or modified as necessary to match the value
 245 specified.  If \fIvlan_id\fR is \fBSTRIP\fR, then the VLAN tag is
 246 stripped from the packet if one is present.  (This action is not
 247 implemented by all OpenFlow switches.)
 248 .RE
 249
 250 .IP
 251 (The OpenFlow protocol supports other actions that \fBdpctl\fR does
 252 not yet expose to the user.)
 253
 254 .PP
 255 The \fBadd-flows\fR and \fBdel-flows\fR commands support an additional
 256 optional field:
 257
 258 .IP \fBpriority=\fIvalue\fR
 259 Sets the priority of the flow to be added or deleted to \fIvalue\fR,
 260 which should be a number between 0 and 65535, inclusive.  If this
 261 field is not specified, it defaults to 32768.
 262
 263 .PP
 264 The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
 265 additional optional field:
 266
 267 .IP \fBtable=\fInumber\fR
 268 If specified, limits the flows about which statistics are gathered to
 269 those in the table with the given \fInumber\fR.  Tables are numbered
 270 as shown by the \fBdump-tables\fR command.
 271
 272 If this field is not specified, or if \fInumber\fR is given as
 273 \fB255\fR, statistics are gathered about flows from all tables.
 274
 275 .SH OPTIONS
 276 .TP
 277 \fB-p\fR, \fB--private-key=\fIprivkey.pem\fR
 278 Specifies a PEM file containing the private key used as the
 279 identity for SSL connections to a switch.
 280
 281 .TP
 282 \fB-c\fR, \fB--certificate=\fIcert.pem\fR
 283 Specifies a PEM file containing a certificate, signed by the
 284 controller's certificate authority (CA), that certifies the
 285 private key to identify a trustworthy controller.
 286
 287 .TP
 288 \fB-C\fR, \fB--ca-cert=\fIcacert.pem\fR
 289 Specifies a PEM file containing the CA certificate used to verify that
 290 a switch is trustworthy.
 291
 292 .TP
 293 .BR \-h ", " \-\^\-help
 294 Prints a brief help message to the console.
 295
 296 .TP
 297 \fB-v\fR \fImodule\fB:\fIfacility\fB:\fIlevel\fR, \fB--verbose=\fImodule\fB:\fIfacility\fB:\fIlevel\fR
 298 Sets the logging level for \fImodule\fR in \fIfacility\fR to
 299 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
 300 displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
 301 special name \fBANY\fR to set the logging levels for all modules.  The
 302 \fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
 303 for logging to the system log or to the console, respectively, or
 304 \fBANY\fR to set the logging levels for both facilities.  The
 305 \fIlevel\fR must be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or
 306 \fBdbg\fR, designating the minimum severity of a message for it to be
 307 logged.
 308
 309 .TP
 310 \fB-v\fR, \fB--verbose\fR
 311 Sets the maximum logging verbosity level, equivalent to
 312 \fB--verbose=ANY:ANY:dbg\fR.
 313
 314 .TP
 315 .BR \-V ", " \-\^\-version
 316 Prints version information to the console.
 317
 318 .SH EXAMPLES
 319
 320 A typical dpctl command sequence for controlling an OpenFlow kernel module:
 321 .nf
 322 .TP
 323 Create datapath numbered 0:
 324
 325 .B % dpctl adddp nl:0
 326
 327 .TP
 328 Add two network devices to the new datapath:
 329
 330 .B % dpctl addif nl:0 eth0
 331 .B % dpctl addif nl:0 eth1
 332
 333 .TP
 334 Monitor traffic received by the datapath (exit with control-C):
 335
 336 .B % dpctl monitor nl:0
 337
 338
 339 .TP
 340 View the datapath's table stats after some traffic has passed through:
 341
 342 .B % dpctl dump-tables nl:0
 343
 344 .TP
 345 View the flow entries in the datapath:
 346
 347 .B % dpctl dump-flows nl:0
 348
 349 .TP
 350 Remove network devices from the datapath when finished:
 351
 352 .B % dpctl delif nl:0 eth0
 353 .B % dpctl delif nl:0 eth1
 354
 355 .TP
 356 Delete the datapath:
 357
 358 .B % dpctl deldp nl:0
 359 .fi
 360 .SH "SEE ALSO"
 361
 362 .BR secchan (8),
 363 .BR switch (8),
 364 .BR controller (8),
 365 .BR vlogconf (8)