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, modified, and monitored.  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 \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 \fInetdev\fR from the list of network devices datapath
  84 \fIdp_idx\fR monitors.
  85
  86 .TP
  87 \fBmonitor nl:\fIdp_idx\fR
  88 Prints to the console all OpenFlow packets sent by datapath
  89 \fIdp_idx\fR to its controller, where \fIdp_idx\fR is the ID of an
  90 existing datapath.
  91
  92 .PP
  93 The following commands can be apply to OpenFlow switches regardless of
  94 the connection method.
  95
  96 .TP
  97 \fBshow \fIswitch\fR
  98 Prints to the console information on datapath \fIswitch\fR including
  99 information on its flow tables and ports.
 100
 101 .TP
 102 \fBdump-tables \fIswitch\fR
 103 Prints to the console statistics for each of the flow tables used by
 104 datapath \fIswitch\fR.
 105
 106 .TP
 107 \fBdump-ports \fIswitch\fR
 108 Prints to the console statistics for each of the network devices
 109 associated with datapath \fIswitch\fR.
 110
 111 .TP
 112 \fBdump-flows \fIswitch \fR[\fIflows\fR]
 113 Prints to the console all flow entries in datapath \fIswitch\fR's
 114 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
 115 in the datapath are retrieved.  See \fBFLOW SYNTAX\fR, below, for the
 116 syntax of \fIflows\fR.
 117
 118 .TP
 119 \fBdump-aggregate \fIswitch \fR[\fIflows\fR]
 120 Prints to the console aggregate statistics for flows in datapath
 121 \fSWITCH\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted,
 122 the statistics are aggregated across all flows in the datapath's flow
 123 tables.  See \fBFLOW SYNTAX\fR, below, for the syntax of \fIflows\fR.
 124
 125 .TP
 126 \fBadd-flow \fIswitch flow\fR
 127 Add the flow entry as described by \fIflow\fR to the datapath \fIswitch\fR's
 128 tables.  The flow entry is in the format described in \fBFLOW SYNTAX\fR,
 129 below.
 130
 131 .TP
 132 \fBadd-flows \fIswitch file\fR
 133 Add flow entries as described in \fIfile\fR to the datapath \fIswitch\fR's
 134 tables.  Each line in \fIfile\fR is a flow entry in the format
 135 described in \fBFLOW SYNTAX\fR, below.
 136
 137 .TP
 138 \fBdel-flows \fIswitch \fR[\fIflow\fR]
 139 Deletes entries from the datapath \fIswitch\fR's tables that match
 140 \fIflow\fR.  If \fIflow\fR is omitted, all flows in the datapath's
 141 tables are removed.  See \fBFLOW SYNTAX\fR, below, for the syntax of
 142 \fIflows\fR.
 143
 144 .PP
 145 The following commands can be used regardless of the connection
 146 method.  They apply to OpenFlow switches and controllers.
 147
 148 .TP
 149 \fBprobe \fIvconn\fR
 150 Connects to \fIvconn\fR and sends a single OpenFlow echo-request
 151 packet and waits for the response.  With the \fB-t\fR or
 152 \fB--timeout\fR option, this command can test whether an OpenFlow
 153 switch or controller is up and running.
 154
 155 .TP
 156 \fBping \fIvconn \fR[\fIn\fR]
 157 Sends a series of 10 echo request packets to \fIvconn\fR and times
 158 each reply.  The echo request packets consist of an OpenFlow header
 159 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
 160 measures the latency of individual requests.
 161
 162 .TP
 163 \fBbenchmark \fIvconn n count\fR
 164 Sends \fIcount\fR echo request packets that each consist of an
 165 OpenFlow header plus \fIn\fR bytes of payload and waits for each
 166 response.  Reports the total time required.  This is a measure of the
 167 maximum bandwidth to \fIvconn\fR for round-trips of \fIn\fR-byte
 168 messages.
 169
 170 .SH "FLOW SYNTAX"
 171
 172 Some \fBdpctl\fR commands accept an argument that describes a flow or
 173 flows.  Such flow descriptions comprise a series
 174 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
 175 space.
 176
 177 The following field assignments describe how a flow matches a packet.
 178 If any of these assignments is omitted from the flow syntax, the field
 179 is treated as a wildcard; thus, if all of them are omitted, the
 180 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
 181 may be specified a value to explicitly mark any of these fields as a
 182 wildcard.
 183
 184 .IP \fBin_port=\fIport_no\fR
 185 Matches physical port \fIport_no\fR.  Switch ports are numbered as
 186 displayed by \fBdpctl show\fR.
 187
 188 .IP \fBdl_vlan=\fIvlan\fR
 189 Matches IEEE 802.1q virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
 190 as \fIvlan\fR to match packets that are not tagged with a virtual LAN;
 191 otherwise, specify a number between 0 and 4095, inclusive, as the
 192 12-bit VLAN ID to match.
 193
 194 .IP \fBdl_src=\fImac\fR
 195 Matches Ethernet source address \fImac\fR, which should be specified
 196 as 6 pairs of hexadecimal digits delimited by colons,
 197 e.g. \fB00:0A:E4:25:6B:B0\fR.
 198
 199 .IP \fBdl_dst=\fImac\fR
 200 Matches Ethernet destination address \fImac\fR.
 201
 202 .IP \fBdl_type=\fIethertype\fR
 203 Matches Ethernet protocol type \fIethertype\fR, which should be
 204 specified as a integer between 0 and 65535, inclusive, either in
 205 decimal or as a hexadecimal number prefixed by \fB0x\fR,
 206 e.g. \fB0x0806\fR to match ARP packets.
 207
 208 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
 209 Matches IPv4 source address \fIip\fR, which should be specified as an
 210 IP address or host name, e.g. \fB192.168.1.1\fR or
 211 \fBwww.example.com\fR.  The optional \fInetmask\fR allows matching
 212 only on an IPv4 address prefix.  It may be specified as a dotted quad
 213 (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a count of bits
 214 (e.g. \fB192.168.1.0/24\fR).
 215
 216 .IP \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
 217 Matches IPv4 destination address \fIip\fR.
 218
 219 .IP \fBnw_proto=\fIproto\fR
 220 Matches IP protocol type \fIproto\fR, which should be specified as a
 221 decimal number between 0 and 255, inclusive, e.g. 6 to match TCP
 222 packets.
 223
 224 .IP \fBtp_src=\fIport\fR
 225 Matches UDP or TCP source port \fIport\fR, which should be specified
 226 as a decimal number between 0 and 65535, inclusive, e.g. 80 to match
 227 packets originating from a HTTP server.
 228
 229 .IP \fBtp_dst=\fIport\fR
 230 Matches UDP or TCP destination port \fIport\fR.
 231
 232 .PP
 233 The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional field:
 234
 235 .IP \fIactions\fB=\fItarget\fR[\fB,\fItarget\fR...]\fR
 236 Specifies a comma-separated list of actions to take on a packet when the
 237 flow entry matches.  The \fItarget\fR may be a decimal port number
 238 designating the physical port on which to output the packet, or one of
 239 the following keywords:
 240
 241 .RS
 242 .IP \fBoutput\fR:\fIport\fR
 243 Outputs the packet on the port specified by \fIport\fR.
 244
 245 .IP \fBnormal\fR
 246 Subjects the packet to the device's normal L2/L3 processing.  (This
 247 action is not implemented by all OpenFlow switches.)
 248
 249 .IP \fBflood\fR
 250 Outputs the packet on all switch physical ports other than the port on
 251 which it was received and any ports on which flooding is disabled
 252 (typically, these would be ports disabled by the IEEE 802.1D spanning
 253 tree protocol).
 254
 255 .IP \fBall\fR
 256 Outputs the packet on all switch physical ports other than the port on
 257 which it was received.
 258
 259 .IP \fBcontroller\fR:\fImax_len\fR
 260 Sends the packet to the OpenFlow controller as a ``packet in''
 261 message.  If \fImax_len\fR is a number, then it specifies the maximum
 262 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
 263 omitted, then the entire packet is sent.
 264
 265 .IP \fBlocal\fR
 266 Outputs the packet on the ``local port,'' which corresponds to the
 267 \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
 268 \fBsecchan\fR(8) for information on the \fBof\fIn\fR network device).
 269
 270 .IP \fBmod_vlan\fR:\fIvlan_id\fR
 271 Modifies the VLAN tag on a packet.  If \fIvlan_id\fR is a number, then
 272 the VLAN tag is added or modified as necessary to match the value
 273 specified.  If \fIvlan_id\fR is \fBSTRIP\fR, then the VLAN tag is
 274 stripped from the packet if one is present.  (This action is not
 275 implemented by all OpenFlow switches.)
 276 .RE
 277
 278 .IP
 279 (The OpenFlow protocol supports other actions that \fBdpctl\fR does
 280 not yet expose to the user.)
 281
 282 .PP
 283 The \fBadd-flow\fR, \fBadd-flows\fR, and \fBdel-flows\fR commands
 284 support an additional optional field:
 285
 286 .IP \fBpriority=\fIvalue\fR
 287 Sets the priority of the flow to be added or deleted to \fIvalue\fR,
 288 which should be a number between 0 and 65535, inclusive.  If this
 289 field is not specified, it defaults to 32768.
 290
 291 .PP
 292 The \fBadd-flow\fR and \fBadd-flows\fR commands support additional
 293 optional fields:
 294
 295 .TP
 296 \fBidle_timeout=\fIseconds\fR
 297 Causes the flow to expire after the given number of seconds of
 298 inactivity.  A value of 0 prevents a flow from expiring due to
 299 inactivity.  The default is 60 seconds.
 300
 301 .IP \fBhard_timeout=\fIseconds\fR
 302 Causes the flow to expire after the given number of seconds,
 303 regardless of activity.  A value of 0 (the default) gives the flow no
 304 hard expiration deadline.
 305
 306 .PP
 307 The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
 308 additional optional field:
 309
 310 .IP \fBtable=\fInumber\fR
 311 If specified, limits the flows about which statistics are gathered to
 312 those in the table with the given \fInumber\fR.  Tables are numbered
 313 as shown by the \fBdump-tables\fR command.
 314
 315 If this field is not specified, or if \fInumber\fR is given as
 316 \fB255\fR, statistics are gathered about flows from all tables.
 317
 318 .SH OPTIONS
 319 .TP
 320 \fB-t\fR, \fB--timeout=\fIsecs\fR
 321 Limits \fBdpctl\fR runtime to approximately \fIsecs\fR seconds.  If
 322 the timeout expires, \fBdpctl\fR will exit with a \fBSIGALRM\fR
 323 signal.
 324
 325 .TP
 326 \fB-p\fR, \fB--private-key=\fIprivkey.pem\fR
 327 Specifies a PEM file containing the private key used as the
 328 identity for SSL connections to a switch.
 329
 330 .TP
 331 \fB-c\fR, \fB--certificate=\fIcert.pem\fR
 332 Specifies a PEM file containing a certificate, signed by the
 333 controller's certificate authority (CA), that certifies the
 334 private key to identify a trustworthy controller.
 335
 336 .TP
 337 \fB-C\fR, \fB--ca-cert=\fIcacert.pem\fR
 338 Specifies a PEM file containing the CA certificate used to verify that
 339 a switch is trustworthy.
 340
 341 .TP
 342 .BR \-h ", " \-\^\-help
 343 Prints a brief help message to the console.
 344
 345 .TP
 346 \fB-v\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]], \fB--verbose=\fImodule\fR[\fB:\fIfacility\fR[\fB:\fIlevel\fR]]
 347 Sets the logging level for \fImodule\fR in \fIfacility\fR to
 348 \fIlevel\fR.  The \fImodule\fR may be any valid module name (as
 349 displayed by the \fB--list\fR action on \fBvlogconf\fR(8)), or the
 350 special name \fBANY\fR to set the logging levels for all modules.  The
 351 \fIfacility\fR may be \fBsyslog\fR or \fBconsole\fR to set the levels
 352 for logging to the system log or to the console, respectively, or
 353 \fBANY\fR to set the logging levels for both facilities.  If it is
 354 omitted, \fIfacility\fR defaults to \fBANY\fR.  The \fIlevel\fR must
 355 be one of \fBemer\fR, \fBerr\fR, \fBwarn\fR, or \fBdbg\fR, designating
 356 the minimum severity of a message for it to be logged.  If it is
 357 omitted, \fIlevel\fR defaults to \fBdbg\fR.
 358
 359 .TP
 360 \fB-v\fR, \fB--verbose\fR
 361 Sets the maximum logging verbosity level, equivalent to
 362 \fB--verbose=ANY:ANY:dbg\fR.
 363
 364 .TP
 365 .BR \-V ", " \-\^\-version
 366 Prints version information to the console.
 367
 368 .SH EXAMPLES
 369
 370 A typical dpctl command sequence for controlling an OpenFlow kernel module:
 371 .nf
 372 .TP
 373 Create datapath numbered 0:
 374
 375 .B % dpctl adddp nl:0
 376
 377 .TP
 378 Add two network devices to the new datapath:
 379
 380 .B % dpctl addif nl:0 eth0
 381 .B % dpctl addif nl:0 eth1
 382
 383 .TP
 384 Monitor traffic received by the datapath (exit with control-C):
 385
 386 .B % dpctl monitor nl:0
 387
 388
 389 .TP
 390 View the datapath's table stats after some traffic has passed through:
 391
 392 .B % dpctl dump-tables nl:0
 393
 394 .TP
 395 View the flow entries in the datapath:
 396
 397 .B % dpctl dump-flows nl:0
 398
 399 .TP
 400 Remove network devices from the datapath when finished:
 401
 402 .B % dpctl delif nl:0 eth0
 403 .B % dpctl delif nl:0 eth1
 404
 405 .TP
 406 Delete the datapath:
 407
 408 .B % dpctl deldp nl:0
 409 .fi
 410 .SH "SEE ALSO"
 411
 412 .BR secchan (8),
 413 .BR switch (8),
 414 .BR controller (8),
 415 .BR vlogconf (8)