[ovs.git] / utilities / ovs-dpctl.8.in

.de IQ
.  br
.  ns
.  IP "\\$1"
..
.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
.ds PN ovs\-dpctl
.
.SH NAME
ovs\-dpctl \- administer Open vSwitch datapaths
.
.SH SYNOPSIS
.B ovs\-dpctl
[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
.
.SH DESCRIPTION
.PP
The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
datapaths.  A single machine may host any number of datapaths.
.PP
A newly created datapath is associated with only one network device, a
virtual network device sometimes called the datapath's ``local port''.
A newly created datapath is not, however, associated with any of the
host's other network devices.  To intercept and process traffic on a
given network device, use the \fBadd\-if\fR command to explicitly add
that network device to the datapath.
.PP
If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
of \fBovs\-dpctl\fR.
.PP
Most \fBovs\-dpctl\fR commands that work with datapaths take an
argument that specifies the name of the datapath.  Datapath names take
the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
device associated with the datapath's local port.  If \fItype\fR is
given, it specifies the datapath provider of \fIname\fR, otherwise the
default provider \fBsystem\fR is assumed.
.PP
The following commands manage datapaths.
.
.ds DX
.de DO
\\$1 \\$2 \\$3
..
.so lib/dpctl.man
.
.SH OPTIONS
.IP "\fB\-s\fR"
.IQ "\fB\-\-statistics\fR"
Causes the \fBshow\fR command to print packet and byte counters for
each port within the datapaths that it shows.
.
.IP "\fB\-m\fR"
.IQ "\fB\-\-more\fR"
Increases the verbosity of \fBdump\-flows\fR output.
.
.IP "\fB\-t\fR"
.IQ "\fB\-\-timeout=\fIsecs\fR"
Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds.  If
the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
signal.
.
.so lib/vlog.man
.so lib/common.man
.
.SH "SEE ALSO"
.
.BR ovs\-appctl (8),
.BR ovs\-vswitchd (8)
Commit	Line	Data
91005f03 BP	1	.de IQ
	2	. br
	3	. ns
	4	. IP "\\$1"
	5	..
d2cb6c95	6	.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
064af421	7	.ds PN ovs\-dpctl
a9b4a41a	8	.
064af421 BP	9	.SH NAME
064af421 BP	10	ovs\-dpctl \- administer Open vSwitch datapaths
a9b4a41a	11	.
064af421 BP	12	.SH SYNOPSIS
	13	.B ovs\-dpctl
	14	[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
a9b4a41a	15	.
064af421	16	.SH DESCRIPTION
a9b4a41a	17	.PP
064af421	18	The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
6bdfa488	19	datapaths. A single machine may host any number of datapaths.
a9b4a41a	20	.PP
064af421 BP	21	A newly created datapath is associated with only one network device, a
	22	virtual network device sometimes called the datapath's ``local port''.
	23	A newly created datapath is not, however, associated with any of the
	24	host's other network devices. To intercept and process traffic on a
	25	given network device, use the \fBadd\-if\fR command to explicitly add
	26	that network device to the datapath.
a9b4a41a	27	.PP
c3827f61 BP	28	If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
c3827f61 BP	29	of \fBovs\-dpctl\fR.
064af421	30	.PP
254f2dc8 BP	31	Most \fBovs\-dpctl\fR commands that work with datapaths take an
	32	argument that specifies the name of the datapath. Datapath names take
	33	the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
	34	device associated with the datapath's local port. If \fItype\fR is
	35	given, it specifies the datapath provider of \fIname\fR, otherwise the
	36	default provider \fBsystem\fR is assumed.
064af421 BP	37	.PP
064af421 BP	38	The following commands manage datapaths.
a9b4a41a	39	.
fceef209 DDP	40	.ds DX
	41	.de DO
	42	\\$1 \\$2 \\$3
	43	..
	44	.so lib/dpctl.man
a9b4a41a	45	.
064af421	46	.SH OPTIONS
91005f03 BP	47	.IP "\fB\-s\fR"
91005f03 BP	48	.IQ "\fB\-\-statistics\fR"
032aa6a3 BP	49	Causes the \fBshow\fR command to print packet and byte counters for
032aa6a3 BP	50	each port within the datapaths that it shows.
91005f03	51	.
041e7168 AZ	52	.IP "\fB\-m\fR"
	53	.IQ "\fB\-\-more\fR"
	54	Increases the verbosity of \fBdump\-flows\fR output.
	55	.
91005f03 BP	56	.IP "\fB\-t\fR"
91005f03 BP	57	.IQ "\fB\-\-timeout=\fIsecs\fR"
064af421 BP	58	Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
	59	the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
	60	signal.
a9b4a41a	61	.
064af421 BP	62	.so lib/vlog.man
064af421 BP	63	.so lib/common.man
a9b4a41a	64	.
064af421	65	.SH "SEE ALSO"
a9b4a41a	66	.
064af421 BP	67	.BR ovs\-appctl (8),
064af421 BP	68	.BR ovs\-vswitchd (8)