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

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