utilities/ovs-ofctl.8.in

   1 .\" -*- nroff -*-
   2 .de IQ
   3 .  br
   4 .  ns
   5 .  IP "\\$1"
   6 ..
   7 .TH ovs\-ofctl 8 "January 2010" "Open vSwitch" "Open vSwitch Manual"
   8 .ds PN ovs\-ofctl
   9 .
  10 .SH NAME
  11 ovs\-ofctl \- administer OpenFlow switches
  12 .
  13 .SH SYNOPSIS
  14 .B ovs\-ofctl
  15 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
  16 .
  17 .SH DESCRIPTION
  18 The
  19 .B ovs\-ofctl
  20 program is a command line tool for monitoring and administering
  21 OpenFlow switches.  It can also show the current state of an OpenFlow
  22 switch, including features, configuration, and table entries.
  23 .
  24 .SS "OpenFlow Switch Management Commands"
  25 .PP
  26 These commands allow \fBovs\-ofctl\fR to monitor and administer an OpenFlow
  27 switch.  It is able to show the current state of a switch, including
  28 features, configuration, and table entries.
  29 .PP
  30 Most of these commands take an argument that specifies the method for
  31 connecting to an OpenFlow switch.  The following connection methods
  32 are supported:
  33 .
  34 .RS
  35 .so lib/vconn-active.man
  36 .
  37 .IP "\fIfile\fR"
  38 This is short for \fBunix:\fIfile\fR, as long as \fIfile\fR does not
  39 contain a colon.
  40 .
  41 .IP \fIbridge\fR
  42 This is short for \fBunix:@RUNDIR@/\fIbridge\fB.mgmt\fR, as long as
  43 \fIbridge\fR does not contain a colon.
  44 .
  45 .IP [\fItype\fB@\fR]\fIdp\fR
  46 Attempts to look up the bridge associated with \fIdp\fR and open as
  47 above.  If \fItype\fR is given, it specifies the datapath provider of
  48 \fIdp\fR, otherwise the default provider \fBsystem\fR is assumed.
  49 .RE
  50 .
  51 .TP
  52 \fBshow \fIswitch\fR
  53 Prints to the console information on \fIswitch\fR, including
  54 information on its flow tables and ports.
  55 .
  56 .TP
  57 \fBstatus \fIswitch\fR [\fIkey\fR]
  58 Prints to the console a series of key-value pairs that report the
  59 status of \fIswitch\fR.  If \fIkey\fR is specified, only the key-value
  60 pairs whose key names begin with \fIkey\fR are printed.  If \fIkey\fR is
  61 omitted, all key-value pairs are printed.
  62 .
  63 .TP
  64 \fBdump-tables \fIswitch\fR
  65 Prints to the console statistics for each of the flow tables used by
  66 \fIswitch\fR.
  67 .
  68 .TP
  69 \fBdump-ports \fIswitch\fR [\fInetdev\fR]
  70 Prints to the console statistics for network devices associated with
  71 \fIswitch\fR.  If \fInetdev\fR is specified, only the statistics
  72 associated with that device will be printed.  \fInetdev\fR can be an
  73 OpenFlow assigned port number or device name, e.g. \fBeth0\fR.
  74 .
  75 .TP
  76 \fBmod-port \fIswitch\fR \fInetdev\fR \fIaction\fR
  77 Modify characteristics of an interface monitored by \fIswitch\fR.
  78 \fInetdev\fR can be referred to by its OpenFlow assigned port number or
  79 the device name, e.g. \fBeth0\fR.  The \fIaction\fR may be any one of the
  80 following:
  81 .
  82 .RS
  83 .IP \fBup\fR
  84 Enables the interface.  This is equivalent to ``ifconfig up'' on a Unix
  85 system.
  86 .
  87 .IP \fBdown\fR
  88 Disables the interface.  This is equivalent to ``ifconfig down'' on a Unix
  89 system.
  90 .
  91 .IP \fBflood\fR
  92 When a \fIflood\fR action is specified, traffic will be sent out this
  93 interface.  This is the default posture for monitored ports.
  94 .
  95 .IP \fBnoflood\fR
  96 When a \fIflood\fR action is specified, traffic will not be sent out
  97 this interface.  This is primarily useful to prevent loops when a
  98 spanning tree protocol is not in use.
  99 .
 100 .RE
 101 .
 102 .TP
 103 \fBdump-flows \fIswitch \fR[\fIflows\fR]
 104 Prints to the console all flow entries in \fIswitch\fR's
 105 tables that match \fIflows\fR.  If \fIflows\fR is omitted, all flows
 106 in the switch are retrieved.  See \fBFlow Syntax\fR, below, for the
 107 syntax of \fIflows\fR.  The output format is described in
 108 \fBTable Entry Output\fR.
 109 .
 110 .TP
 111 \fBdump-aggregate \fIswitch \fR[\fIflows\fR]
 112 Prints to the console aggregate statistics for flows in
 113 \fIswitch\fR's tables that match \fIflows\fR.  If \fIflows\fR is omitted,
 114 the statistics are aggregated across all flows in the switch's flow
 115 tables.  See \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
 116 The output format is descrbed in \fBTable Entry Output\fR.
 117 .
 118 .TP
 119 \fBadd-flow \fIswitch flow\fR
 120 Add the flow entry as described by \fIflow\fR to the \fIswitch\fR's
 121 tables.  The flow entry is in the format described in \fBFlow Syntax\fR,
 122 below.
 123 .
 124 .TP
 125 \fBadd-flows \fIswitch file\fR
 126 Add flow entries as described in \fIfile\fR to \fIswitch\fR's
 127 tables.  Each line in \fIfile\fR is a flow entry in the format
 128 described in \fBFlow Syntax\fR, below.
 129 .
 130 .TP
 131 \fBmod-flows \fIswitch flow\fR
 132 Modify the actions in entries from the \fIswitch\fR's tables
 133 that match \fIflow\fR.  When invoked with the \fB--strict\fR option,
 134 wildcards are not treated as active for matching purposes.  See
 135 \fBFlow Syntax\fR, below, for the syntax of \fIflows\fR.
 136 .
 137 .TP
 138 \fBdel-flows \fIswitch \fR[\fIflow\fR]
 139 Deletes entries from the \fIswitch\fR's tables that match
 140 \fIflow\fR.  When invoked with the \fB--strict\fR option, wildcards are
 141 not treated as active for matching purposes.  If \fIflow\fR is
 142 omitted and the \fB--strict\fR option is not used, all flows in the
 143 switch's tables are removed.  See \fBFlow Syntax\fR, below, for the
 144 syntax of \fIflows\fR.
 145 .
 146 .TP
 147 \fBmonitor \fIswitch\fR [\fImiss-len\fR]
 148 Connects to \fIswitch\fR and prints to the console all OpenFlow
 149 messages received.  Usually, \fIswitch\fR should specify a connection
 150 named on \fBovs\-openflowd\fR(8)'s \fB-l\fR or \fB--listen\fR command line
 151 option.
 152 .IP
 153 If \fImiss-len\fR is provided, \fBovs\-ofctl\fR sends an OpenFlow ``set
 154 configuration'' message at connection setup time that requests
 155 \fImiss-len\fR bytes of each packet that misses the flow table.  The
 156 OpenFlow reference implementation does not send these messages to the
 157 \fBovs\-ofctl monitor\fR client connection unless a nonzero value is
 158 specified on this argument.
 159 .IP
 160 This command may be useful for debugging switch or controller
 161 implementations.
 162 .
 163 .SS "OpenFlow Switch and Controller Commands"
 164 .
 165 The following commands, like those in the previous section, may be
 166 applied to OpenFlow switches, using any of the connection methods
 167 described in that section.  Unlike those commands, these may also be
 168 applied to OpenFlow controllers.
 169 .
 170 .TP
 171 \fBprobe \fItarget\fR
 172 Sends a single OpenFlow echo-request message to \fItarget\fR and waits
 173 for the response.  With the \fB-t\fR or \fB--timeout\fR option, this
 174 command can test whether an OpenFlow switch or controller is up and
 175 running.
 176 .
 177 .TP
 178 \fBping \fItarget \fR[\fIn\fR]
 179 Sends a series of 10 echo request packets to \fItarget\fR and times
 180 each reply.  The echo request packets consist of an OpenFlow header
 181 plus \fIn\fR bytes (default: 64) of randomly generated payload.  This
 182 measures the latency of individual requests.
 183 .
 184 .TP
 185 \fBbenchmark \fItarget n count\fR
 186 Sends \fIcount\fR echo request packets that each consist of an
 187 OpenFlow header plus \fIn\fR bytes of payload and waits for each
 188 response.  Reports the total time required.  This is a measure of the
 189 maximum bandwidth to \fItarget\fR for round-trips of \fIn\fR-byte
 190 messages.
 191 .
 192 .SS "Flow Syntax"
 193 .PP
 194 Some \fBovs\-ofctl\fR commands accept an argument that describes a flow or
 195 flows.  Such flow descriptions comprise a series
 196 \fIfield\fB=\fIvalue\fR assignments, separated by commas or white
 197 space.  (Embedding spaces into a flow description normally requires
 198 quoting to prevent the shell from breaking the description into
 199 multiple arguments.)
 200 .PP
 201 The following field assignments describe how a flow matches a packet.
 202 If any of these assignments is omitted from the flow syntax, the field
 203 is treated as a wildcard; thus, if all of them are omitted, the
 204 resulting flow matches all packets.  The string \fB*\fR or \fBANY\fR
 205 may be specified to explicitly mark any of these fields as a wildcard.
 206 (\fB*\fR should be quoted to protect it from shell expansion.)
 207 .
 208 .IP \fBin_port=\fIport_no\fR
 209 Matches physical port \fIport_no\fR.  Switch ports are numbered as
 210 displayed by \fBovs\-ofctl show\fR.
 211 .
 212 .IP \fBdl_vlan=\fIvlan\fR
 213 Matches IEEE 802.1q Virtual LAN tag \fIvlan\fR.  Specify \fB0xffff\fR
 214 as \fIvlan\fR to match packets that are not tagged with a Virtual LAN;
 215 otherwise, specify a number between 0 and 4095, inclusive, as the
 216 12-bit VLAN ID to match.
 217 .
 218 .IP \fBdl_vlan_pcp=\fIpriority\fR
 219 Matches IEEE 802.1q Priority Code Point (PCP) \fIpriority\fR, which is
 220 specified as a value between 0 and 7, inclusive.  A higher value
 221 indicates a higher frame priority level.
 222 .
 223 .IP \fBdl_src=\fImac\fR
 224 Matches Ethernet source address \fImac\fR, which is specified as 6 pairs
 225 of hexadecimal digits delimited by colons (e.g. \fB00:0A:E4:25:6B:B0\fR).
 226 .IP \fBdl_dst=\fImac\fR
 227 Matches Ethernet destination address \fImac\fR.
 228 .IP \fBdl_type=\fIethertype\fR
 229 Matches Ethernet protocol type \fIethertype\fR, which is specified as an
 230 integer between 0 and 65535, inclusive, either in decimal or as a
 231 hexadecimal number prefixed by \fB0x\fR (e.g. \fB0x0806\fR to match ARP
 232 packets).
 233 .
 234 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
 235 Matches IPv4 source address \fIip\fR, which may be specified as an
 236 IP address or host name (e.g. \fB192.168.1.1\fR or
 237 \fBwww.example.com\fR).  The optional \fInetmask\fR allows restricting a
 238 match to an IPv4 address prefix.  The netmask may be specified as a dotted
 239 quad (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block
 240 (e.g. \fB192.168.1.0/24\fR).
 241 .
 242 .IP \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
 243 Matches IPv4 destination address \fIip\fR.
 244 .IP \fBnw_proto=\fIproto\fR
 245 .
 246 Matches IP protocol type \fIproto\fR, which is specified as a decimal
 247 number between 0 and 255, inclusive (e.g. 6 to match TCP packets).
 248 .IP \fBnw_tos=\fItos\fR
 249 Matches IP ToS/DSCP field \fItos\fR, which is specified as a decimal
 250 number between 0 and 255, inclusive.  Note that the two lower reserved
 251 bits are ignored for matching purposes.
 252 .
 253 .IP \fBtp_src=\fIport\fR
 254 Matches UDP or TCP source port \fIport\fR, which is specified as a decimal
 255 number between 0 and 65535, inclusive (e.g. 80 to match packets originating
 256 from a HTTP server).
 257 .
 258 .IP \fBtp_dst=\fIport\fR
 259 Matches UDP or TCP destination port \fIport\fR.
 260 .IP \fBicmp_type=\fItype\fR
 261 .
 262 Matches ICMP message with \fItype\fR, which is specified as a decimal
 263 number between 0 and 255, inclusive.
 264 .IP \fBicmp_code=\fIcode\fR
 265 Matches ICMP messages with \fIcode\fR.
 266 .PP
 267 The following shorthand notations are also available:
 268 .
 269 .IP \fBip\fR
 270 Same as \fBdl_type=0x0800\fR.
 271 .
 272 .IP \fBicmp\fR
 273 Same as \fBdl_type=0x0800,nw_proto=1\fR.
 274 .
 275 .IP \fBtcp\fR
 276 Same as \fBdl_type=0x0800,nw_proto=6\fR.
 277 .
 278 .IP \fBudp\fR
 279 Same as \fBdl_type=0x0800,nw_proto=17\fR.
 280 .
 281 .IP \fBarp\fR
 282 Same as \fBdl_type=0x0806\fR.
 283 .
 284 .PP
 285 The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional field:
 286 .
 287 .IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
 288 Specifies a comma-separated list of actions to take on a packet when the
 289 flow entry matches.  If no \fItarget\fR is specified, then packets
 290 matching the flow are dropped.  The \fItarget\fR may be a decimal port
 291 number designating the physical port on which to output the packet, or one
 292 of the following keywords:
 293 .
 294 .RS
 295 .IP \fBoutput\fR:\fIport\fR
 296 Outputs the packet on the port specified by \fIport\fR.
 297 .
 298 .IP \fBnormal\fR
 299 Subjects the packet to the device's normal L2/L3 processing.  (This
 300 action is not implemented by all OpenFlow switches.)
 301 .
 302 .IP \fBflood\fR
 303 Outputs the packet on all switch physical ports other than the port on
 304 which it was received and any ports on which flooding is disabled
 305 (typically, these would be ports disabled by the IEEE 802.1D spanning
 306 tree protocol).
 307 .
 308 .IP \fBall\fR
 309 Outputs the packet on all switch physical ports other than the port on
 310 which it was received.
 311 .
 312 .IP \fBcontroller\fR:\fImax_len\fR
 313 Sends the packet to the OpenFlow controller as a ``packet in''
 314 message.  If \fImax_len\fR is a number, then it specifies the maximum
 315 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
 316 omitted, then the entire packet is sent.
 317 .
 318 .IP \fBlocal\fR
 319 Outputs the packet on the ``local port,'' which corresponds to the
 320 \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
 321 \fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device).
 322 .
 323 .IP \fBdrop\fR
 324 Discards the packet, so no further processing or forwarding takes place.
 325 If a drop action is used, no other actions may be specified.
 326 .
 327 .IP \fBmod_vlan_vid\fR:\fIvlan_vid\fR
 328 Modifies the VLAN id on a packet.  The VLAN tag is added or modified
 329 as necessary to match the value specified.  If the VLAN tag is added,
 330 a priority of zero is used (see the \fBmod_vlan_pcp\fR action to set
 331 this).
 332 .
 333 .IP \fBmod_vlan_pcp\fR:\fIvlan_pcp\fR
 334 Modifies the VLAN priority on a packet.  The VLAN tag is added or modified
 335 as necessary to match the value specified.  Valid values are between 0
 336 (lowest) and 7 (highest).  If the VLAN tag is added, a vid of zero is used
 337 (see the \fBmod_vlan_vid\fR action to set this).
 338 .
 339 .IP \fBstrip_vlan\fR
 340 Strips the VLAN tag from a packet if it is present.
 341 .
 342 .IP \fBmod_dl_src\fB:\fImac\fR
 343 Sets the source Ethernet address to \fImac\fR.
 344 .
 345 .IP \fBmod_dl_dst\fB:\fImac\fR
 346 Sets the destination Ethernet address to \fImac\fR.
 347 .
 348 .IP \fBmod_nw_src\fB:\fIip\fR
 349 Sets the IPv4 source address to \fIip\fR.
 350 .
 351 .IP \fBmod_nw_dst\fB:\fIip\fR
 352 Sets the IPv4 destination address to \fIip\fR.
 353 .
 354 .IP \fBmod_tp_src\fB:\fIport\fR
 355 Sets the TCP or UDP source port to \fIport\fR.
 356 .
 357 .IP \fBmod_tp_dst\fB:\fIport\fR
 358 Sets the TCP or UDP destination port to \fIport\fR.
 359 .
 360 .IP \fBmod_nw_tos\fB:\fItos\fR
 361 Sets the IP ToS/DSCP field to \fItos\fR.  Valid values are between 0 and
 362 255, inclusive.  Note that the two lower reserved bits are never
 363 modified.
 364 .
 365 .RE
 366 .
 367 .IP
 368 (The OpenFlow protocol supports other actions that \fBovs\-ofctl\fR does
 369 not yet expose to the user.)
 370 .
 371 .PP
 372 The \fBadd-flow\fR, \fBadd-flows\fR, and \fBdel-flows\fR commands
 373 support an additional optional field:
 374 .
 375 .IP \fBpriority=\fIvalue\fR
 376 The priority at which a wildcarded entry will match in comparison to
 377 others.  \fIvalue\fR is a number between 0 and 65535, inclusive.  A higher
 378 \fIvalue\fR will match before a lower one.  An exact-match entry will always
 379 have priority over an entry containing wildcards, so it has an implicit
 380 priority value of 65535.  When adding a flow, if the field is not specified,
 381 the flow's priority will default to 32768.
 382 .
 383 .PP
 384 The \fBadd-flow\fR and \fBadd-flows\fR commands support additional
 385 optional fields:
 386 .
 387 .TP
 388 \fBidle_timeout=\fIseconds\fR
 389 Causes the flow to expire after the given number of seconds of
 390 inactivity.  A value of 0 prevents a flow from expiring due to
 391 inactivity.  The default is 60 seconds.
 392 .
 393 .IP \fBhard_timeout=\fIseconds\fR
 394 Causes the flow to expire after the given number of seconds,
 395 regardless of activity.  A value of 0 (the default) gives the flow no
 396 hard expiration deadline.
 397 .
 398 .PP
 399 The \fBdump-flows\fR, \fBdump-aggregate\fR, \fBdel-flow\fR
 400 and \fBdel-flows\fR commands support one additional optional field:
 401 .
 402 .TP
 403 \fBout_port=\fIport\fR
 404 If set, a matching flow must include an output action to \fIport\fR.
 405 .
 406 .PP
 407 The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
 408 additional optional field:
 409 .
 410 .IP \fBtable=\fInumber\fR
 411 If specified, limits the flows about which statistics are gathered to
 412 those in the table with the given \fInumber\fR.  Tables are numbered
 413 as shown by the \fBdump-tables\fR command.
 414 .
 415 If this field is not specified, or if \fInumber\fR is given as
 416 \fB255\fR, statistics are gathered about flows from all tables.
 417 .
 418 .SS "Table Entry Output"
 419 .
 420 The \fBdump-tables\fR and \fBdump-aggregate\fR commands print information
 421 about the entries in a datapath's tables.  Each line of output is a
 422 unique flow entry, which begins with some common information:
 423 .
 424 .IP \fBduration\fR
 425 The number of seconds the entry has been in the table.
 426 .
 427 .IP \fBtable_id\fR
 428 The table that contains the flow.  When a packet arrives, the switch
 429 begins searching for an entry at the lowest numbered table.  Tables are
 430 numbered as shown by the \fBdump-tables\fR command.
 431 .
 432 .IP \fBpriority\fR
 433 The priority of the entry in relation to other entries within the same
 434 table.  A higher value will match before a lower one.
 435 .
 436 .IP \fBn_packets\fR
 437 The number of packets that have matched the entry.
 438 .
 439 .IP \fBn_bytes\fR
 440 The total number of bytes from packets that have matched the entry.
 441 .
 442 .PP
 443 The rest of the line consists of a description of the flow entry as
 444 described in \fBFlow Syntax\fR, above.
 445 .
 446 .
 447 .SH OPTIONS
 448 .TP
 449 \fB--strict\fR
 450 Uses strict matching when running flow modification commands.
 451 .
 452 .so lib/ssl.man
 453 .so lib/vlog.man
 454 .so lib/common.man
 455 .
 456 .SH EXAMPLES
 457 .
 458 The following examples assume that an OpenFlow switch on the local
 459 host has been configured to listen for management connections on a
 460 Unix domain socket named \fB@RUNDIR@/openflow.sock\fR, e.g. by
 461 specifying \fB--listen=punix:@RUNDIR@/openflow.sock\fR on the
 462 \fBovs\-openflowd\fR(8) command line.
 463 .
 464 .TP
 465 \fBovs\-ofctl dump-tables unix:@RUNDIR@/openflow.sock\fR
 466 Prints out the switch's table stats.  (This is more interesting after
 467 some traffic has passed through.)
 468 .
 469 .TP
 470 \fBovs\-ofctl dump-flows unix:@RUNDIR@/openflow.sock\fR
 471 Prints the flow entries in the switch.
 472 .
 473 .SH "SEE ALSO"
 474 .
 475 .BR ovs\-appctl (8),
 476 .BR ovs\-controller (8),
 477 .BR ovs\-vswitchd (8)