[mirror_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
This program works only with datapaths that are implemented outside of
\fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
datapaths.  To manage datapaths that are integrated into
\fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
are documented in \fBovs\-vswitchd\fR(8).
.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
5989a51c BP	21	This program works only with datapaths that are implemented outside of
	22	\fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
	23	datapaths. To manage datapaths that are integrated into
	24	\fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
	25	use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
	26	are documented in \fBovs\-vswitchd\fR(8).
	27	.PP
064af421 BP	28	A newly created datapath is associated with only one network device, a
	29	virtual network device sometimes called the datapath's ``local port''.
	30	A newly created datapath is not, however, associated with any of the
	31	host's other network devices. To intercept and process traffic on a
	32	given network device, use the \fBadd\-if\fR command to explicitly add
	33	that network device to the datapath.
a9b4a41a	34	.PP
c3827f61 BP	35	If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
c3827f61 BP	36	of \fBovs\-dpctl\fR.
064af421	37	.PP
254f2dc8 BP	38	Most \fBovs\-dpctl\fR commands that work with datapaths take an
	39	argument that specifies the name of the datapath. Datapath names take
	40	the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
	41	device associated with the datapath's local port. If \fItype\fR is
	42	given, it specifies the datapath provider of \fIname\fR, otherwise the
	43	default provider \fBsystem\fR is assumed.
064af421 BP	44	.PP
064af421 BP	45	The following commands manage datapaths.
a9b4a41a	46	.
fceef209 DDP	47	.ds DX
	48	.de DO
	49	\\$1 \\$2 \\$3
	50	..
	51	.so lib/dpctl.man
a9b4a41a	52	.
064af421	53	.SH OPTIONS
91005f03 BP	54	.IP "\fB\-s\fR"
91005f03 BP	55	.IQ "\fB\-\-statistics\fR"
032aa6a3 BP	56	Causes the \fBshow\fR command to print packet and byte counters for
032aa6a3 BP	57	each port within the datapaths that it shows.
91005f03	58	.
041e7168 AZ	59	.IP "\fB\-m\fR"
	60	.IQ "\fB\-\-more\fR"
	61	Increases the verbosity of \fBdump\-flows\fR output.
	62	.
91005f03 BP	63	.IP "\fB\-t\fR"
91005f03 BP	64	.IQ "\fB\-\-timeout=\fIsecs\fR"
064af421 BP	65	Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
	66	the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
	67	signal.
a9b4a41a	68	.
064af421 BP	69	.so lib/vlog.man
064af421 BP	70	.so lib/common.man
a9b4a41a	71	.
064af421	72	.SH "SEE ALSO"
a9b4a41a	73	.
064af421 BP	74	.BR ovs\-appctl (8),
064af421 BP	75	.BR ovs\-vswitchd (8)