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 .TP
  41 \fBunix:\fIfile\fR
  42 The Unix domain server socket named \fIfile\fR.
  43
  44 .SH COMMANDS
  45
  46 With the \fBdpctl\fR program, datapaths running in the kernel can be
  47 created, deleted, and modified.  A single machine may
  48 host up to 32 datapaths (numbered 0 to 31).  In most situations,
  49 a machine hosts only one datapath.
  50
  51 A newly created datapath is not associated with any of the
  52 host's network devices thus does not process any incoming
  53 traffic.  To intercept and process traffic on a given network device, the
  54 network device must be explicitly added to a datapath through the
  55 \fBaddif\fR command.
  56
  57 The following commands manage local datapaths.
  58
  59 .TP
  60 \fBadddp nl:\fIdp_idx\fR
  61 Creates datapath numbered \fIdp_idx\fR on the local host.  This will
  62 fail if \fIdp_idx\fR is not in the range 0 to 31, or if the datapath
  63 with that number already exists on the host.
  64
  65 .TP
  66 \fBdeldp nl:\fIdp_idx\fR
  67 Deletes datapath \fIdp_idx\fR on the local host.  \fIdp_idx\fR must be
  68 an existing datapath.  All of a datapath's network devices must be
  69 explicitly removed before the datapath can be deleted (see \fBdelif\fR
  70 command).
  71
  72 .TP
  73 \fBaddif nl:\fIdp_idx netdev\fR...
  74 Adds each \fInetdev\fR to the list of network devices datapath
  75 \fIdp_idx\fR monitors, where \fIdp_idx\fR is the ID of an existing
  76 datapath, and \fInetdev\fR is the name of one of the host's
  77 network devices, e.g. \fBeth0\fR.  Once a network device has been added
  78 to a datapath, the datapath has complete ownership of the network device's
  79 traffic and the network device appears silent to the rest of the system.
  80
  81 .TP
  82 \fBdelif nl:\fIdp_idx netdev\fR...
  83 Removes each \fInetdev\fR from the list of network devices datapath
  84 \fIdp_idx\fR monitors.
  85
  86 .PP
  87 The following commands can be apply to OpenFlow switches regardless of
  88 the connection method.
  89
  90 .TP
  91 \fBshow \fIswitch\fR
  92 Prints to the console information on datapath \fIswitch\fR including
  93 information on its flow tables and ports.
  94
  95 .TP
  96 \fBstatus \fIswitch\fR [\fIkey\fR]
  97 Prints to the console a series of key-value pairs that report the
  98 status of \fIswitch\fR.  If \fIkey\fR is specified, only the key-value
  99 pairs whose key names begin with \fIkey\fR are printed.  If \fIkey\fR is
 100 omitted, all key-value pairs are printed.
 101
 102 (In the OpenFlow reference implementation, the \fBstatus\fR command is
 103 implemented in \fBsecchan\fR(8), not in the kernel module, so the
 104 \fBnl:\fIdp_idx\fR connection method should not be used with this
 105 command.  Instead, specify \fB-l\fR or \fB--listen\fR on the
 106 \fBsecchan\fR command line and tell \fBdpctl\fR to use the connection
 107 method specified there.)
 108
 109 .TP
 110 \fBdump-tables \fIswitch\fR
 111 Prints to the console statistics for each of the flow tables used by
 112 datapath \fIswitch\fR.
 113
 114 .TP
 115 \fBdump-ports \fIswitch\fR
 116 Prints to the console statistics for each of the network devices
 117 associated with datapath \fIswitch\fR.
 118
 119 .TP
 120 \fBmod-port \fIswitch\fR \fInetdev\fR \fIaction\fR
 121 Modify characteristics of an interface monitored by \fIswitch\fR.
 122 \fInetdev\fR can be referred to by its OpenFlow assigned port number or
 123 the device name, e.g. \fBeth0\fR.  The \fIaction\fR may be any one of the
 124 following:
 125
 126 .RS
 127 .IP \fBup\fR
 128 Enables the interface.  This is equivalent to ``ifconfig up'' on a Unix
 129 system.
 130
 131 .IP \fBdown\fR
 132 Disables the interface.  This is equivalent to ``ifconfig down'' on a Unix
 133 system.
 134
 135 .IP \fBflood\fR
 136 When a \fIflood\fR action is specified, traffic will be sent out this
 137 interface.  This is the default posture for monitored ports.
 138
 139 .IP \fBnoflood\fR
 140 When a \fIflood\fR action is specified, traffic will not be sent out
 141 this interface.  This is primarily useful to prevent loops when a
 142 spanning tree protocol is not in use.
 143
 144 .RE
 145
 146 .TP
 147 \fBdump-flows \fIswitch \fR[\fIflows\fR]
 148 Prints to the console all flow entries in datapath \fIswitch\fR's
 149 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
 150 in the datapath are retrieved.  See \fBFLOW SYNTAX\fR, below, for the
 151 syntax of \fIflows\fR.
 152
 153 .TP
 154 \fBdump-aggregate \fIswitch \fR[\fIflows\fR]
 155 Prints to the console aggregate statistics for flows in datapath
 156 \fSWITCH\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted,
 157 the statistics are aggregated across all flows in the datapath's flow
 158 tables.  See \fBFLOW SYNTAX\fR, below, for the syntax of \fIflows\fR.
 159
 160 .TP
 161 \fBadd-flow \fIswitch flow\fR
 162 Add the flow entry as described by \fIflow\fR to the datapath \fIswitch\fR's
 163 tables.  The flow entry is in the format described in \fBFLOW SYNTAX\fR,
 164 below.
 165
 166 .TP
 167 \fBadd-flows \fIswitch file\fR
 168 Add flow entries as described in \fIfile\fR to the datapath \fIswitch\fR's
 169 tables.  Each line in \fIfile\fR is a flow entry in the format
 170 described in \fBFLOW SYNTAX\fR, below.
 171
 172 .TP
 173 \fBmod-flows \fIswitch flow\fR
 174 Modify the actions in entries from the datapath \fIswitch\fR's tables
 175 that match \fIflow\fR.  When invoked with the \fB--strict\fR option,
 176 wildcards are not treated as active for matching purposes.  See
 177 \fBFLOW SYNTAX\fR, below, for the syntax of \fIflows\fR.
 178
 179 .TP
 180 \fBdel-flows \fIswitch \fR[\fIflow\fR]
 181 Deletes entries from the datapath \fIswitch\fR's tables that match
 182 \fIflow\fR.  When invoked with the \fB--strict\fR option, wildcards are
 183 not treated as active for matching purposes.  If \fIflow\fR is
 184 omitted and the \fB--strict\fR option is not used, all flows in the
 185 datapath's tables are removed.  See \fBFLOW SYNTAX\fR, below, for the
 186 syntax of \fIflows\fR.
 187
 188 .TP
 189 \fBmonitor \fIswitch\fR
 190 Connects to \fIswitch\fR and prints to the console all OpenFlow
 191 messages received.  Usually, \fIswitch\fR should specify a connection
 192 named on \fBsecchan\fR(8)'s \fB-m\fR or \fB--monitor\fR command line
 193 option, in which the messages printed will be all those sent or
 194 received by \fBsecchan\fR to or from the kernel datapath module.  A
 195 \fIswitch\fR of the form \fBnl:\fIdp_idx\fR will print all
 196 asynchronously generated OpenFlow messages (such as packet-in
 197 messages), but it will not print any messages sent to the kernel by
 198 \fBsecchan\fR and other processes, nor will it print replies sent by
 199 the kernel in response to those messages.
 200
 201 .PP
 202 The following commands can be used regardless of the connection
 203 method.  They apply to OpenFlow switches and controllers.
 204
 205 .TP
 206 \fBprobe \fIvconn\fR
 207 Connects to \fIvconn\fR and sends a single OpenFlow echo-request
 208 packet and waits for the response.  With the \fB-t\fR or
 209 \fB--timeout\fR option, this command can test whether an OpenFlow
 210 switch or controller is up and running.
 211
 212 .TP
 213 \fBping \fIvconn \fR[\fIn\fR]
 214 Sends a series of 10 echo request packets to \fIvconn\fR and times
 215 each reply.  The echo request packets consist of an OpenFlow header
 216 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
 217 measures the latency of individual requests.
 218
 219 .TP
 220 \fBbenchmark \fIvconn n count\fR
 221 Sends \fIcount\fR echo request packets that each consist of an
 222 OpenFlow header plus \fIn\fR bytes of payload and waits for each
 223 response.  Reports the total time required.  This is a measure of the
 224 maximum bandwidth to \fIvconn\fR for round-trips of \fIn\fR-byte
 225 messages.
 226
 227 .SH "FLOW SYNTAX"
 228
 229 Some \fBdpctl\fR commands accept an argument that describes a flow or
 230 flows.  Such flow descriptions comprise a series
 231 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
 232 space.
 233
 234 The following field assignments describe how a flow matches a packet.
 235 If any of these assignments is omitted from the flow syntax, the field
 236 is treated as a wildcard; thus, if all of them are omitted, the
 237 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
 238 may be specified a value to explicitly mark any of these fields as a
 239 wildcard.
 240
 241 .IP \fBin_port=\fIport_no\fR
 242 Matches physical port \fIport_no\fR.  Switch ports are numbered as
 243 displayed by \fBdpctl show\fR.
 244
 245 .IP \fBdl_vlan=\fIvlan\fR
 246 Matches IEEE 802.1q virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
 247 as \fIvlan\fR to match packets that are not tagged with a virtual LAN;
 248 otherwise, specify a number between 0 and 4095, inclusive, as the
 249 12-bit VLAN ID to match.
 250
 251 .IP \fBdl_src=\fImac\fR
 252 Matches Ethernet source address \fImac\fR, which should be specified
 253 as 6 pairs of hexadecimal digits delimited by colons,
 254 e.g. \fB00:0A:E4:25:6B:B0\fR.
 255
 256 .IP \fBdl_dst=\fImac\fR
 257 Matches Ethernet destination address \fImac\fR.
 258
 259 .IP \fBdl_type=\fIethertype\fR
 260 Matches Ethernet protocol type \fIethertype\fR, which should be
 261 specified as a integer between 0 and 65535, inclusive, either in
 262 decimal or as a hexadecimal number prefixed by \fB0x\fR,
 263 e.g. \fB0x0806\fR to match ARP packets.
 264
 265 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
 266 Matches IPv4 source address \fIip\fR, which should be specified as an
 267 IP address or host name, e.g. \fB192.168.1.1\fR or
 268 \fBwww.example.com\fR.  The optional \fInetmask\fR allows matching
 269 only on an IPv4 address prefix.  It may be specified as a dotted quad
 270 (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a count of bits
 271 (e.g. \fB192.168.1.0/24\fR).
 272
 273 .IP \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
 274 Matches IPv4 destination address \fIip\fR.
 275
 276 .IP \fBnw_proto=\fIproto\fR
 277 Matches IP protocol type \fIproto\fR, which should be specified as a
 278 decimal number between 0 and 255, inclusive, e.g. 6 to match TCP
 279 packets.
 280
 281 .IP \fBtp_src=\fIport\fR
 282 Matches UDP or TCP source port \fIport\fR, which should be specified
 283 as a decimal number between 0 and 65535, inclusive, e.g. 80 to match
 284 packets originating from a HTTP server.
 285
 286 .IP \fBtp_dst=\fIport\fR
 287 Matches UDP or TCP destination port \fIport\fR.
 288
 289 .PP
 290 The following shorthand notations are also available:
 291
 292 .IP \fBip\fR
 293 Same as \fBdl_type=0x0800\fR.
 294
 295 .IP \fBicmp\fR
 296 Same as \fBdl_type=0x0800,nw_proto=1\fR.
 297
 298 .IP \fBtcp\fR
 299 Same as \fBdl_type=0x0800,nw_proto=6\fR.
 300
 301 .IP \fBudp\fR
 302 Same as \fBdl_type=0x0800,nw_proto=17\fR.
 303
 304 .IP \fBarp\fR
 305 Same as \fBdl_type=0x0806\fR.
 306
 307 .PP
 308 The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional field:
 309
 310 .IP \fIactions\fB=\fItarget\fR[\fB,\fItarget\fR...]\fR
 311 Specifies a comma-separated list of actions to take on a packet when the
 312 flow entry matches.  The \fItarget\fR may be a decimal port number
 313 designating the physical port on which to output the packet, or one of
 314 the following keywords:
 315
 316 .RS
 317 .IP \fBoutput\fR:\fIport\fR
 318 Outputs the packet on the port specified by \fIport\fR.
 319
 320 .IP \fBnormal\fR
 321 Subjects the packet to the device's normal L2/L3 processing.  (This
 322 action is not implemented by all OpenFlow switches.)
 323
 324 .IP \fBflood\fR
 325 Outputs the packet on all switch physical ports other than the port on
 326 which it was received and any ports on which flooding is disabled
 327 (typically, these would be ports disabled by the IEEE 802.1D spanning
 328 tree protocol).
 329
 330 .IP \fBall\fR
 331 Outputs the packet on all switch physical ports other than the port on
 332 which it was received.
 333
 334 .IP \fBcontroller\fR:\fImax_len\fR
 335 Sends the packet to the OpenFlow controller as a ``packet in''
 336 message.  If \fImax_len\fR is a number, then it specifies the maximum
 337 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
 338 omitted, then the entire packet is sent.
 339
 340 .IP \fBlocal\fR
 341 Outputs the packet on the ``local port,'' which corresponds to the
 342 \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
 343 \fBsecchan\fR(8) for information on the \fBof\fIn\fR network device).
 344
 345 .IP \fBmod_vlan\fR:\fIvlan_id\fR
 346 Modifies the VLAN tag on a packet.  If \fIvlan_id\fR is a number, then
 347 the VLAN tag is added or modified as necessary to match the value
 348 specified.  If \fIvlan_id\fR is \fBSTRIP\fR, then the VLAN tag is
 349 stripped from the packet if one is present.  (This action is not
 350 implemented by all OpenFlow switches.)
 351 .RE
 352
 353 .IP
 354 (The OpenFlow protocol supports other actions that \fBdpctl\fR does
 355 not yet expose to the user.)
 356
 357 .PP
 358 The \fBadd-flow\fR, \fBadd-flows\fR, and \fBdel-flows\fR commands
 359 support an additional optional field:
 360
 361 .IP \fBpriority=\fIvalue\fR
 362 Sets the priority of the flow to be added or deleted to \fIvalue\fR,
 363 which should be a number between 0 and 65535, inclusive.  If this
 364 field is not specified, it defaults to 32768.
 365
 366 .PP
 367 The \fBadd-flow\fR and \fBadd-flows\fR commands support additional
 368 optional fields:
 369
 370 .TP
 371 \fBidle_timeout=\fIseconds\fR
 372 Causes the flow to expire after the given number of seconds of
 373 inactivity.  A value of 0 prevents a flow from expiring due to
 374 inactivity.  The default is 60 seconds.
 375
 376 .IP \fBhard_timeout=\fIseconds\fR
 377 Causes the flow to expire after the given number of seconds,
 378 regardless of activity.  A value of 0 (the default) gives the flow no
 379 hard expiration deadline.
 380
 381 .PP
 382 The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
 383 additional optional field:
 384
 385 .IP \fBtable=\fInumber\fR
 386 If specified, limits the flows about which statistics are gathered to
 387 those in the table with the given \fInumber\fR.  Tables are numbered
 388 as shown by the \fBdump-tables\fR command.
 389
 390 If this field is not specified, or if \fInumber\fR is given as
 391 \fB255\fR, statistics are gathered about flows from all tables.
 392
 393 .SH OPTIONS
 394 .TP
 395 \fB--strict\fR
 396 Uses strict matching when running flow modification commands.
 397
 398 .TP
 399 \fB-t\fR, \fB--timeout=\fIsecs\fR
 400 Limits \fBdpctl\fR runtime to approximately \fIsecs\fR seconds.  If
 401 the timeout expires, \fBdpctl\fR will exit with a \fBSIGALRM\fR
 402 signal.
 403
 404 .TP
 405 \fB-p\fR, \fB--private-key=\fIprivkey.pem\fR
 406 Specifies a PEM file containing the private key used as the
 407 identity for SSL connections to a switch.
 408
 409 .TP
 410 \fB-c\fR, \fB--certificate=\fIcert.pem\fR
 411 Specifies a PEM file containing a certificate, signed by the
 412 controller's certificate authority (CA), that certifies the
 413 private key to identify a trustworthy controller.
 414
 415 .TP
 416 \fB-C\fR, \fB--ca-cert=\fIcacert.pem\fR
 417 Specifies a PEM file containing the CA certificate used to verify that
 418 a switch is trustworthy.
 419
 420 .TP
 421 .BR \-h ", " \-\^\-help
 422 Prints a brief help message to the console.
 423
 424 .TP
 425 \fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
 426 Sets the logging level for \fImodule\fR in \fIfacility\fR to
 427 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
 428 displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
 429 special name \fBANY\fR to set the logging levels for all modules.  The
 430 \fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
 431 for logging to the system log or to the console, respectively, or
 432 \fBANY\fR to set the logging levels for both facilities.  If it is
 433 omitted, \fIfacility\fR defaults to \fBANY\fR.  The \fIlevel\fR must
 434 be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating
 435 the minimum severity of a message for it to be logged.  If it is
 436 omitted, \fIlevel\fR defaults to \fBdbg\fR.
 437
 438 .TP
 439 \fB-v\fR, \fB--verbose\fR
 440 Sets the maximum logging verbosity level, equivalent to
 441 \fB--verbose=ANY:ANY:dbg\fR.
 442
 443 .TP
 444 .BR \-V ", " \-\^\-version
 445 Prints version information to the console.
 446
 447 .SH EXAMPLES
 448
 449 A typical dpctl command sequence for controlling an OpenFlow kernel module:
 450 .nf
 451 .TP
 452 Create datapath numbered 0:
 453
 454 .B % dpctl adddp nl:0
 455
 456 .TP
 457 Add two network devices to the new datapath:
 458
 459 .B % dpctl addif nl:0 eth0
 460 .B % dpctl addif nl:0 eth1
 461
 462 .TP
 463 Monitor traffic received by the datapath (exit with control-C):
 464
 465 .B % dpctl monitor nl:0
 466
 467
 468 .TP
 469 View the datapath's table stats after some traffic has passed through:
 470
 471 .B % dpctl dump-tables nl:0
 472
 473 .TP
 474 View the flow entries in the datapath:
 475
 476 .B % dpctl dump-flows nl:0
 477
 478 .TP
 479 Remove network devices from the datapath when finished:
 480
 481 .B % dpctl delif nl:0 eth0
 482 .B % dpctl delif nl:0 eth1
 483
 484 .TP
 485 Delete the datapath:
 486
 487 .B % dpctl deldp nl:0
 488 .fi
 489 .SH "SEE ALSO"
 490
 491 .BR secchan (8),
 492 .BR switch (8),
 493 .BR controller (8),
 494 .BR vlogconf (8)