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

.so lib/ovs.tmac
.TH ovs\-tcpdump 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
.
.SH NAME
ovs\-tcpdump \- Dump traffic from an Open vSwitch port using \fBtcpdump\fR.
.
.SH SYNOPSIS
\fBovs\-tcpdump\fR \fB\-i\fR \fIport\fR \fBtcpdump options...\fR
.
.SH DESCRIPTION
\fBovs\-tcpdump\fR creates switch mirror ports in the \fBovs\-vswitchd\fR
daemon and executes \fBtcpdump\fR to listen against those ports. When the
\fBtcpdump\fR instance exits, it then cleans up the mirror port it created.
.PP
\fBovs\-tcpdump\fR will not allow multiple mirrors for the same port. It has
some logic to parse the current configuration and prevent duplicate mirrors.
.PP
The \fB\-i\fR option may not appear multiple times.
.PP
It is important to note that under \fBLinux\fR based kernels, tap devices do
not receive packets unless the specific tuntap device has been opened by an
application. This requires \fBCAP_NET_ADMIN\fR privileges, so the
\fBovs-tcpdump\fR command must be run as a user with such permissions (this
is usually a super-user).
.
.SH "OPTIONS"
.so lib/common.man
.
.IP "\fB\-\-db\-sock\fR"
The Open vSwitch database socket connection string. The default is
\fIunix:@RUNDIR@/db.sock\fR
.
.IP "\fB\-\-dump\-cmd\fR"
The command to run instead of \fBtcpdump\fR.
.
.IP "\fB\-i\fR"
.IQ "\fB\-\-interface\fR"
The interface for which a mirror port should be created, and packets should
be dumped.
.
.IP "\fB\-\-mirror\-to\fR"
The name of the interface which should be the destination of the mirrored
packets. The default is miINTERFACE
.
.IP "\fB\-\-span\fR"
If specified, mirror all ports (optional).
.
.SH "SEE ALSO"
.
.BR ovs\-appctl (8),
.BR ovs\-vswitchd (8),
.BR ovs\-pcap (1),
.BR ovs\-tcpundump (1),
.BR tcpdump (8),
.BR wireshark (8).
Commit	Line	Data
9bccc3ff	1	.so lib/ovs.tmac
314ce647 AC	2	.TH ovs\-tcpdump 8 "@VERSION@" "Open vSwitch" "Open vSwitch Manual"
	3	.
	4	.SH NAME
	5	ovs\-tcpdump \- Dump traffic from an Open vSwitch port using \fBtcpdump\fR.
	6	.
	7	.SH SYNOPSIS
	8	\fBovs\-tcpdump\fR \fB\-i\fR \fIport\fR \fBtcpdump options...\fR
	9	.
	10	.SH DESCRIPTION
	11	\fBovs\-tcpdump\fR creates switch mirror ports in the \fBovs\-vswitchd\fR
	12	daemon and executes \fBtcpdump\fR to listen against those ports. When the
	13	\fBtcpdump\fR instance exits, it then cleans up the mirror port it created.
	14	.PP
	15	\fBovs\-tcpdump\fR will not allow multiple mirrors for the same port. It has
	16	some logic to parse the current configuration and prevent duplicate mirrors.
	17	.PP
	18	The \fB\-i\fR option may not appear multiple times.
	19	.PP
	20	It is important to note that under \fBLinux\fR based kernels, tap devices do
	21	not receive packets unless the specific tuntap device has been opened by an
	22	application. This requires \fBCAP_NET_ADMIN\fR privileges, so the
	23	\fBovs-tcpdump\fR command must be run as a user with such permissions (this
	24	is usually a super-user).
	25	.
	26	.SH "OPTIONS"
	27	.so lib/common.man
	28	.
	29	.IP "\fB\-\-db\-sock\fR"
	30	The Open vSwitch database socket connection string. The default is
	31	\fIunix:@RUNDIR@/db.sock\fR
	32	.
	33	.IP "\fB\-\-dump\-cmd\fR"
	34	The command to run instead of \fBtcpdump\fR.
	35	.
	36	.IP "\fB\-i\fR"
	37	.IQ "\fB\-\-interface\fR"
	38	The interface for which a mirror port should be created, and packets should
	39	be dumped.
	40	.
	41	.IP "\fB\-\-mirror\-to\fR"
	42	The name of the interface which should be the destination of the mirrored
	43	packets. The default is miINTERFACE
	44	.
0475db71 MF	45	.IP "\fB\-\-span\fR"
	46	If specified, mirror all ports (optional).
	47	.
314ce647 AC	48	.SH "SEE ALSO"
	49	.
	50	.BR ovs\-appctl (8),
	51	.BR ovs\-vswitchd (8),
	52	.BR ovs\-pcap (1),
	53	.BR ovs\-tcpundump (1),
	54	.BR tcpdump (8),
	55	.BR wireshark (8).