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

.so lib/ovs.tmac
.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\-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
9bccc3ff	1	.so lib/ovs.tmac
d2cb6c95	2	.TH ovs\-dpctl 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
064af421	3	.ds PN ovs\-dpctl
a9b4a41a	4	.
064af421 BP	5	.SH NAME
064af421 BP	6	ovs\-dpctl \- administer Open vSwitch datapaths
a9b4a41a	7	.
064af421 BP	8	.SH SYNOPSIS
	9	.B ovs\-dpctl
	10	[\fIoptions\fR] \fIcommand \fR[\fIswitch\fR] [\fIargs\fR\&...]
a9b4a41a	11	.
064af421	12	.SH DESCRIPTION
a9b4a41a	13	.PP
064af421	14	The \fBovs\-dpctl\fR program can create, modify, and delete Open vSwitch
6bdfa488	15	datapaths. A single machine may host any number of datapaths.
a9b4a41a	16	.PP
5989a51c BP	17	This program works only with datapaths that are implemented outside of
	18	\fBovs\-vswitchd\fR itself, such as the Linux and Windows kernel-based
	19	datapaths. To manage datapaths that are integrated into
	20	\fBovs\-vswitchd\fR, such as the userspace (\fBnetdev\fR) datapath,
	21	use \fBovs\-appctl\fR(8) to invoke the \fBdpctl/*\fR commands, which
	22	are documented in \fBovs\-vswitchd\fR(8).
	23	.PP
064af421 BP	24	A newly created datapath is associated with only one network device, a
	25	virtual network device sometimes called the datapath's ``local port''.
	26	A newly created datapath is not, however, associated with any of the
	27	host's other network devices. To intercept and process traffic on a
	28	given network device, use the \fBadd\-if\fR command to explicitly add
	29	that network device to the datapath.
a9b4a41a	30	.PP
c3827f61 BP	31	If \fBovs\-vswitchd\fR(8) is in use, use \fBovs\-vsctl\fR(8) instead
c3827f61 BP	32	of \fBovs\-dpctl\fR.
064af421	33	.PP
254f2dc8 BP	34	Most \fBovs\-dpctl\fR commands that work with datapaths take an
	35	argument that specifies the name of the datapath. Datapath names take
	36	the form [\fItype\fB@\fR]\fIname\fR, where \fIname\fR is the network
	37	device associated with the datapath's local port. If \fItype\fR is
	38	given, it specifies the datapath provider of \fIname\fR, otherwise the
	39	default provider \fBsystem\fR is assumed.
064af421 BP	40	.PP
064af421 BP	41	The following commands manage datapaths.
a9b4a41a	42	.
fceef209 DDP	43	.ds DX
	44	.de DO
	45	\\$1 \\$2 \\$3
	46	..
	47	.so lib/dpctl.man
a9b4a41a	48	.
064af421	49	.SH OPTIONS
91005f03 BP	50	.IP "\fB\-t\fR"
91005f03 BP	51	.IQ "\fB\-\-timeout=\fIsecs\fR"
064af421 BP	52	Limits \fBovs\-dpctl\fR runtime to approximately \fIsecs\fR seconds. If
	53	the timeout expires, \fBovs\-dpctl\fR will exit with a \fBSIGALRM\fR
	54	signal.
a9b4a41a	55	.
064af421 BP	56	.so lib/vlog.man
064af421 BP	57	.so lib/common.man
a9b4a41a	58	.
064af421	59	.SH "SEE ALSO"
a9b4a41a	60	.
064af421 BP	61	.BR ovs\-appctl (8),
064af421 BP	62	.BR ovs\-vswitchd (8)