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=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
 224 .IQ \fBdl_dst=\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fB:\fIxx\fR
 225 Matches an Ethernet source (or destination) address specified as 6
 226 pairs of hexadecimal digits delimited by colons
 227 (e.g. \fB00:0A:E4:25:6B:B0\fR).
 228 .
 229 .IP \fBdl_type=\fIethertype\fR
 230 Matches Ethernet protocol type \fIethertype\fR, which is specified as an
 231 integer between 0 and 65535, inclusive, either in decimal or as a
 232 hexadecimal number prefixed by \fB0x\fR (e.g. \fB0x0806\fR to match ARP
 233 packets).
 234 .
 235 .IP \fBnw_src=\fIip\fR[\fB/\fInetmask\fR]
 236 .IQ \fBnw_dst=\fIip\fR[\fB/\fInetmask\fR]
 237 When \fBdl_type\fR is 0x0800 (possibly via shorthand, e.g. \fBip\fR
 238 or \fBtcp\fR), matches IPv4 source (or destination) address \fIip\fR,
 239 which may be specified as an IP address or host name
 240 (e.g. \fB192.168.1.1\fR or \fBwww.example.com\fR).  The optional
 241 \fInetmask\fR allows restricting a match to an IPv4 address prefix.
 242 The netmask may be specified as a dotted quad
 243 (e.g. \fB192.168.1.0/255.255.255.0\fR) or as a CIDR block
 244 (e.g. \fB192.168.1.0/24\fR).
 245 .IP
 246 When \fBdl_type=0x0806\fR or \fBarp\fR is specified, matches the
 247 \fBar_spa\fR or \fBar_tpa\fR field, respectively, in ARP packets for
 248 IPv4 and Ethernet.
 249 .IP
 250 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
 251 or 0x0806, the values of \fBnw_src\fR and \fBnw_dst\fR are silently
 252 ignored.
 253 .
 254 .IP \fBnw_proto=\fIproto\fR
 255 When \fBip\fR or \fBdl_type=0x0800\fR is specified, matches IP
 256 protocol type \fIproto\fR, which is specified as a decimal number
 257 between 0 and 255, inclusive (e.g. 6 to match TCP packets).
 258 .IP
 259 When \fBarp\fR or \fBdl_type=0x0806\fR is specified, matches the lower
 260 8 bits of the ARP opcode.  ARP opcodes greater than 255 are treated as
 261 0.
 262 .IP
 263 When \fBdl_type\fR is wildcarded or set to a value other than 0x0800
 264 or 0x0806, the value of \fBnw_proto\fR is silently ignored.
 265 .
 266 .IP \fBnw_tos=\fItos\fR
 267 Matches IP ToS/DSCP field \fItos\fR, which is specified as a decimal
 268 number between 0 and 255, inclusive.  Note that the two lower reserved
 269 bits are ignored for matching purposes.
 270 .IP
 271 The value of \fBnw_proto\fR is silently ignored unless
 272 \fBdl_type=0x0800\fR, \fBip\fR, \fBicmp\fR, \fBtcp\fR, or \fBudp\fR is
 273 also specified.
 274 .
 275 .IP \fBtp_src=\fIport\fR
 276 .IQ \fBtp_dst=\fIport\fR
 277 When \fBdl_type\fR and \fBnw_proto\fR specify TCP or UDP, \fBtp_src\fR
 278 and \fBtp_dst\fR match the UDP or TCP source or destination port
 279 \fIport\fR, respectively. which is specified as a decimal number
 280 between 0 and 65535, inclusive (e.g. 80 to match packets originating
 281 from a HTTP server).
 282 .IP
 283 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
 284 these settings are silently ignored.
 285 .
 286 .IP \fBicmp_type=\fItype\fR
 287 .IQ \fBicmp_code=\fIcode\fR
 288 When \fBdl_type\fR and \fBnw_proto\fR specify ICMP, \fItype\fR matches
 289 the ICMP type and \fIcode\fR matches the ICMP code.  Each is specified
 290 as a decimal number between 0 and 255, inclusive.
 291 .IP
 292 When \fBdl_type\fR and \fBnw_proto\fR take other values, the values of
 293 these settings are silently ignored.
 294 .
 295 .PP
 296 The following shorthand notations are also available:
 297 .
 298 .IP \fBip\fR
 299 Same as \fBdl_type=0x0800\fR.
 300 .
 301 .IP \fBicmp\fR
 302 Same as \fBdl_type=0x0800,nw_proto=1\fR.
 303 .
 304 .IP \fBtcp\fR
 305 Same as \fBdl_type=0x0800,nw_proto=6\fR.
 306 .
 307 .IP \fBudp\fR
 308 Same as \fBdl_type=0x0800,nw_proto=17\fR.
 309 .
 310 .IP \fBarp\fR
 311 Same as \fBdl_type=0x0806\fR.
 312 .
 313 .PP
 314 The \fBadd-flow\fR and \fBadd-flows\fR commands require an additional field:
 315 .
 316 .IP \fBactions=\fR[\fItarget\fR][\fB,\fItarget\fR...]\fR
 317 Specifies a comma-separated list of actions to take on a packet when the
 318 flow entry matches.  If no \fItarget\fR is specified, then packets
 319 matching the flow are dropped.  The \fItarget\fR may be a decimal port
 320 number designating the physical port on which to output the packet, or one
 321 of the following keywords:
 322 .
 323 .RS
 324 .IP \fBoutput\fR:\fIport\fR
 325 Outputs the packet on the port specified by \fIport\fR.
 326 .
 327 .IP \fBnormal\fR
 328 Subjects the packet to the device's normal L2/L3 processing.  (This
 329 action is not implemented by all OpenFlow switches.)
 330 .
 331 .IP \fBflood\fR
 332 Outputs the packet on all switch physical ports other than the port on
 333 which it was received and any ports on which flooding is disabled
 334 (typically, these would be ports disabled by the IEEE 802.1D spanning
 335 tree protocol).
 336 .
 337 .IP \fBall\fR
 338 Outputs the packet on all switch physical ports other than the port on
 339 which it was received.
 340 .
 341 .IP \fBcontroller\fR:\fImax_len\fR
 342 Sends the packet to the OpenFlow controller as a ``packet in''
 343 message.  If \fImax_len\fR is a number, then it specifies the maximum
 344 number of bytes that should be sent.  If \fImax_len\fR is \fBALL\fR or
 345 omitted, then the entire packet is sent.
 346 .
 347 .IP \fBlocal\fR
 348 Outputs the packet on the ``local port,'' which corresponds to the
 349 \fBof\fIn\fR network device (see \fBCONTACTING THE CONTROLLER\fR in
 350 \fBovs\-openflowd\fR(8) for information on the \fBof\fIn\fR network device).
 351 .
 352 .IP \fBdrop\fR
 353 Discards the packet, so no further processing or forwarding takes place.
 354 If a drop action is used, no other actions may be specified.
 355 .
 356 .IP \fBmod_vlan_vid\fR:\fIvlan_vid\fR
 357 Modifies the VLAN id on a packet.  The VLAN tag is added or modified
 358 as necessary to match the value specified.  If the VLAN tag is added,
 359 a priority of zero is used (see the \fBmod_vlan_pcp\fR action to set
 360 this).
 361 .
 362 .IP \fBmod_vlan_pcp\fR:\fIvlan_pcp\fR
 363 Modifies the VLAN priority on a packet.  The VLAN tag is added or modified
 364 as necessary to match the value specified.  Valid values are between 0
 365 (lowest) and 7 (highest).  If the VLAN tag is added, a vid of zero is used
 366 (see the \fBmod_vlan_vid\fR action to set this).
 367 .
 368 .IP \fBstrip_vlan\fR
 369 Strips the VLAN tag from a packet if it is present.
 370 .
 371 .IP \fBmod_dl_src\fB:\fImac\fR
 372 Sets the source Ethernet address to \fImac\fR.
 373 .
 374 .IP \fBmod_dl_dst\fB:\fImac\fR
 375 Sets the destination Ethernet address to \fImac\fR.
 376 .
 377 .IP \fBmod_nw_src\fB:\fIip\fR
 378 Sets the IPv4 source address to \fIip\fR.
 379 .
 380 .IP \fBmod_nw_dst\fB:\fIip\fR
 381 Sets the IPv4 destination address to \fIip\fR.
 382 .
 383 .IP \fBmod_tp_src\fB:\fIport\fR
 384 Sets the TCP or UDP source port to \fIport\fR.
 385 .
 386 .IP \fBmod_tp_dst\fB:\fIport\fR
 387 Sets the TCP or UDP destination port to \fIport\fR.
 388 .
 389 .IP \fBmod_nw_tos\fB:\fItos\fR
 390 Sets the IP ToS/DSCP field to \fItos\fR.  Valid values are between 0 and
 391 255, inclusive.  Note that the two lower reserved bits are never
 392 modified.
 393 .
 394 .RE
 395 .
 396 .IP
 397 (The OpenFlow protocol supports other actions that \fBovs\-ofctl\fR does
 398 not yet expose to the user.)
 399 .
 400 .PP
 401 The \fBadd-flow\fR, \fBadd-flows\fR, and \fBdel-flows\fR commands
 402 support an additional optional field:
 403 .
 404 .IP \fBpriority=\fIvalue\fR
 405 The priority at which a wildcarded entry will match in comparison to
 406 others.  \fIvalue\fR is a number between 0 and 65535, inclusive.  A higher
 407 \fIvalue\fR will match before a lower one.  An exact-match entry will always
 408 have priority over an entry containing wildcards, so it has an implicit
 409 priority value of 65535.  When adding a flow, if the field is not specified,
 410 the flow's priority will default to 32768.
 411 .
 412 .PP
 413 The \fBadd-flow\fR and \fBadd-flows\fR commands support additional
 414 optional fields:
 415 .
 416 .TP
 417 \fBidle_timeout=\fIseconds\fR
 418 Causes the flow to expire after the given number of seconds of
 419 inactivity.  A value of 0 prevents a flow from expiring due to
 420 inactivity.  The default is 60 seconds.
 421 .
 422 .IP \fBhard_timeout=\fIseconds\fR
 423 Causes the flow to expire after the given number of seconds,
 424 regardless of activity.  A value of 0 (the default) gives the flow no
 425 hard expiration deadline.
 426 .
 427 .PP
 428 The \fBdump-flows\fR, \fBdump-aggregate\fR, \fBdel-flow\fR
 429 and \fBdel-flows\fR commands support one additional optional field:
 430 .
 431 .TP
 432 \fBout_port=\fIport\fR
 433 If set, a matching flow must include an output action to \fIport\fR.
 434 .
 435 .PP
 436 The \fBdump-flows\fR and \fBdump-aggregate\fR commands support an
 437 additional optional field:
 438 .
 439 .IP \fBtable=\fInumber\fR
 440 If specified, limits the flows about which statistics are gathered to
 441 those in the table with the given \fInumber\fR.  Tables are numbered
 442 as shown by the \fBdump-tables\fR command.
 443 .
 444 If this field is not specified, or if \fInumber\fR is given as
 445 \fB255\fR, statistics are gathered about flows from all tables.
 446 .
 447 .SS "Table Entry Output"
 448 .
 449 The \fBdump-tables\fR and \fBdump-aggregate\fR commands print information
 450 about the entries in a datapath's tables.  Each line of output is a
 451 unique flow entry, which begins with some common information:
 452 .
 453 .IP \fBduration\fR
 454 The number of seconds the entry has been in the table.
 455 .
 456 .IP \fBtable_id\fR
 457 The table that contains the flow.  When a packet arrives, the switch
 458 begins searching for an entry at the lowest numbered table.  Tables are
 459 numbered as shown by the \fBdump-tables\fR command.
 460 .
 461 .IP \fBpriority\fR
 462 The priority of the entry in relation to other entries within the same
 463 table.  A higher value will match before a lower one.
 464 .
 465 .IP \fBn_packets\fR
 466 The number of packets that have matched the entry.
 467 .
 468 .IP \fBn_bytes\fR
 469 The total number of bytes from packets that have matched the entry.
 470 .
 471 .PP
 472 The rest of the line consists of a description of the flow entry as
 473 described in \fBFlow Syntax\fR, above.
 474 .
 475 .
 476 .SH OPTIONS
 477 .TP
 478 \fB--strict\fR
 479 Uses strict matching when running flow modification commands.
 480 .
 481 .SS "Public Key Infrastructure Options"
 482 .so lib/ssl.man
 483 .so lib/vlog.man
 484 .so lib/common.man
 485 .
 486 .SH EXAMPLES
 487 .
 488 The following examples assume that an OpenFlow switch on the local
 489 host has been configured to listen for management connections on a
 490 Unix domain socket named \fB@RUNDIR@/openflow.sock\fR, e.g. by
 491 specifying \fB--listen=punix:@RUNDIR@/openflow.sock\fR on the
 492 \fBovs\-openflowd\fR(8) command line.
 493 .
 494 .TP
 495 \fBovs\-ofctl dump-tables unix:@RUNDIR@/openflow.sock\fR
 496 Prints out the switch's table stats.  (This is more interesting after
 497 some traffic has passed through.)
 498 .
 499 .TP
 500 \fBovs\-ofctl dump-flows unix:@RUNDIR@/openflow.sock\fR
 501 Prints the flow entries in the switch.
 502 .
 503 .SH "SEE ALSO"
 504 .
 505 .BR ovs\-appctl (8),
 506 .BR ovs\-controller (8),
 507 .BR ovs\-vswitchd (8)