ovs-save: Add "dev" keyword before interface names in the ip commands
[openvswitch] / utilities / ovs-dpctl.8.in
1 .de IQ
2 .  br
3 .  ns
4 .  IP "\\$1"
5 ..
6 .TH ovs\-dpctl 8 "August 2009" "Open vSwitch" "Open vSwitch Manual"
7 .ds PN ovs\-dpctl
8 .
9 .SH NAME
10 ovs\-dpctl \- administer Open vSwitch datapaths
11 .
12 .SH SYNOPSIS
13 .B ovs\-dpctl
14 [\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
15 .
16 .SH DESCRIPTION
17 .PP
18 The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
19 datapaths.  A single machine may host up to 256 datapaths (numbered 0
20 to 255).
21 .PP
22 A newly created datapath is associated with only one network device, a
23 virtual network device sometimes called the datapath's ``local port''.
24 A newly created datapath is not, however, associated with any of the
25 host's other network devices.  To intercept and process traffic on a
26 given network device, use the \fBadd\-if\fR command to explicitly add
27 that network device to the datapath.
28 .PP
29 If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
30 of \fBovs\-dpctl\fR.
31 .PP
32 Most \fBovs\-dpctl\fR commands that work with datapaths take an
33 argument that specifies the name of the datapath.  Datapath names take
34 the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
35 device associated with the datapath's local port.  If \fItype\fR is
36 given, it specifies the datapath provider of \fIname\fR, otherwise the
37 default provider \fBsystem\fR is assumed.
38 .PP
39 The following commands manage datapaths.
40 .
41 .TP
42 \fBadd\-dp \fIdp\fR [\fInetdev\fR[\fB,\fIoption\fR]...]
43 Creates datapath \fIdp\fR, with a local port also named \fIdp\fR.
44 This will fail if a network device \fIdp\fR already exists.
45 .IP
46 If \fInetdev\fRs are specified, \fBovs\-dpctl\fR adds them to the
47 new datapath, just as if \fBadd\-if\fR was specified.
48 .
49 .TP
50 \fBdel\-dp \fIdp\fR
51 Deletes datapath \fIdp\fR.  If \fIdp\fR is associated with any network
52 devices, they are automatically removed.
53 .
54 .TP
55 \fBadd\-if \fIdp netdev\fR[\fB,\fIoption\fR]...
56 Adds each \fInetdev\fR to the set of network devices datapath
57 \fIdp\fR monitors, where \fIdp\fR is the name of an existing
58 datapath, and \fInetdev\fR is the name of one of the host's
59 network devices, e.g. \fBeth0\fR.  Once a network device has been added
60 to a datapath, the datapath has complete ownership of the network device's
61 traffic and the network device appears silent to the rest of the
62 system.
63 .IP
64 A \fInetdev\fR may be followed by a comma-separated list of options.
65 The following options are currently supported:
66 .
67 .RS
68 .IP "\fBtype=\fItype\fR"
69 Specifies the type of port to add.  The default type is \fBsystem\fR.
70 .IP "\fIkey\fB=\fIvalue\fR"
71 Adds an arbitrary key-value option to the port's configuration.
72 .RE
73 .IP
74 \fBovs\-vswitchd.conf.db\fR(5) documents the available port types and
75 options.
76 .
77 .IP "\fBset\-if \fIdp port\fR[\fB,\fIoption\fR]..."
78 Reconfigures each \fIport\fR in \fIdp\fR as specified.  An
79 \fIoption\fR of the form \fIkey\fB=\fIvalue\fR adds the specified
80 key-value option to the port or overrides an existing key's value.  An
81 \fIoption\fR of the form \fIkey\fB=\fR, that is, without a value,
82 deletes the key-value named \fIkey\fR.  The type of a port cannot be
83 changed, so \fBtype=\fItype\fR is only allowed if \fItype\fR is the
84 port's existing type.
85 .TP
86 \fBdel\-if \fIdp netdev\fR...
87 Removes each \fInetdev\fR from the list of network devices datapath
88 \fIdp\fR monitors.
89 .
90 .TP
91 \fBdump\-dps\fR
92 Prints the name of each configured datapath on a separate line.
93 .
94 .TP
95 [\fB\-s\fR | \fB\-\-statistics\fR] \fBshow \fR[\fIdp\fR...]
96 Prints a summary of configured datapaths, including their datapath
97 numbers and a list of ports connected to each datapath.  (The local
98 port is identified as port 0.)  If \fB\-s\fR or \fB\-\-statistics\fR
99 is specified, then packet and byte counters are also printed for each
100 port.
101 .IP
102 If one or more datapaths are specified, information on only those
103 datapaths are displayed.  Otherwise, \fBovs\-dpctl\fR displays information
104 about all configured datapaths.
105 .
106 .IP "\fBdump\-flows \fIdp\fR"
107 Prints to the console all flow entries in datapath \fIdp\fR's
108 flow table.
109 .IP
110 This command is primarily useful for debugging Open vSwitch.  The flow
111 table entries that it displays are not
112 OpenFlow flow entries.  Instead, they are different and considerably
113 simpler flows maintained by the Open vSwitch kernel module.
114 .IP "\fBdel\-flows \fIdp\fR"
115 Deletes all flow entries from datapath \fIdp\fR's flow table.
116 .IP
117 This command is primarily useful for debugging Open vSwitch.  As
118 discussed in \fBdump\-flows\fR, these entries are
119 not OpenFlow flow entries.  By deleting them, the process that set them
120 up may be confused about their disappearance.
121 .
122 .SH OPTIONS
123 .IP "\fB\-s\fR"
124 .IQ "\fB\-\-statistics\fR"
125 Causes the \fBshow\fR command to print packet and byte counters for
126 each port within the datapaths that it shows.
127 .
128 .IP "\fB\-t\fR"
129 .IQ "\fB\-\-timeout=\fIsecs\fR"
130 Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
131 the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
132 signal.
133 .
134 .so lib/vlog.man
135 .so lib/common.man
136 .
137 .SH "SEE ALSO"
138 .
139 .BR ovs\-appctl (8),
140 .BR ovs\-vswitchd (8)