Blame IbaTools/man/opapacketcapture.manPage

Packit 857059
.\" .\" *********************************************************************
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *             Copyright 2015-2019, Intel Corporation                *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *                       All Rights Reserved.                        *
Packit 857059
.\" .\" *                                                                   *
Packit 857059
.\" .\" *********************************************************************
Packit 857059
Packit 857059
.TH opapacketcapture 1 "Intel Corporation" "Copyright(C) 2015\-2019" "IFSFFCLIRG (Man Page)"
Packit 857059
.SH NAME
Packit 857059
opapacketcapture
Packit 857059
Packit 857059
Packit 857059
.PP
Packit 857059
Starts capturing packet data.
Packit 857059
.PP
Packit 857059
To stop capture and trigger dump, use SIGINT or SIGUSR1. Program dumps packets to file and exits.
Packit 857059
.PP
Packit 857059
Packit 857059
.B NOTE:
Packit 857059
Using opapacketcapture with large amounts of traffic can cause performance issues on the given host. Intel recommends you use opapacketcapture on hosts with lower packet rates and bandwidth.
Packit 857059
Packit 857059
.SH Syntax
Packit 857059
opapacketcapture [-o  \fIoutfile\fR] [-d  \fIdevfile\fR] [-f  \fIfilterfile\fR]
Packit 857059
.br
Packit 857059
[-t  \fItriggerfile\fR]
Packit 857059
[-l  \fItriggerlag\fR][-a  \fIalarm\fR] [-p  \fIpackets\fR] [-s  \fImaxblocks\fR]
Packit 857059
.br
Packit 857059
[-v [-v]]
Packit 857059
.SH Options
Packit 857059
Packit 857059
.TP 10
Packit 857059
--help
Packit 857059
Packit 857059
Produces full help text.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-o \fIoutfile\fR
Packit 857059
Packit 857059
Specifies the output file for captured packets.
Packit 857059
.br
Packit 857059
Default is packetDump.pcap
Packit 857059
Packit 857059
.TP 10
Packit 857059
-d \fIdevfile\fR
Packit 857059
Packit 857059
Specifies the device file for capturing packets.
Packit 857059
.br
Packit 857059
Packit 857059
Packit 857059
.TP 10
Packit 857059
-f \fIfilterfile\fR
Packit 857059
Packit 857059
Specifies the file used for filtering. If absent, no filtering is done.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-t \fItriggerfile\fR
Packit 857059
Packit 857059
Specifies the file used for triggering a stop capture. If absent, normal triggering is performed.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-l \fItriggerlag\fR
Packit 857059
Packit 857059
Specifies the number of packets to collect after trigger condition is met, before dumping data and exiting. Default is 10.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-a \fIalarm\fR
Packit 857059
Packit 857059
Specifies the number of seconds for alarm trigger to dump capture and exit.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-p \fIpackets\fR
Packit 857059
Packit 857059
Specifies the number of packets for alarm trigger to dump capture and exit.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-s \fImaxblocks\fR
Packit 857059
Packit 857059
Specifies the number of blocks to allocate for ring buffer. Value is in Millions. Default is 2 which corresponds to 128 MiB because 1 block = 64 Bytes.
Packit 857059
Packit 857059
.TP 10
Packit 857059
-v
Packit 857059
Packit 857059
Produces verbose output. (Use verbose Level 1+ to show levels.)
Packit 857059
Packit 857059
.SH Example
Packit 857059
# opapacketcapture
Packit 857059
.br
Packit 857059
Packit 857059
opapacketcapture: Capturing packets using 128 MiB buffer
Packit 857059
.br
Packit 857059
Packit 857059
^C
Packit 857059
.br
Packit 857059
Packit 857059
opapacketcapture: Triggered
Packit 857059
.br
Packit 857059
Packit 857059
Number of packets stored is 100
Packit 857059
.PP
Packit 857059
In the example above, opapacketcapture operates until
Packit 857059
\fBCTRL+C\fR
Packit 857059
is entered.