| 123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275 |
- <!DOCTYPE html>
- <html lang="en">
- <head>
- <meta charset="UTF-8">
- <meta http-equiv="X-UA-Compatible" content="IE=edge">
- <meta name="viewport" content="width=device-width, initial-scale=1.0">
- <meta name="generator" content="Asciidoctor 2.0.17">
- <title>udpdump(1)</title>
- <link rel="stylesheet" href="./ws.css">
- </head>
- <body class="manpage">
- <div id="header">
- <h1>udpdump(1) Manual Page</h1>
- <h2 id="_name">NAME</h2>
- <div class="sectionbody">
- <p>udpdump - Provide a UDP receiver that gets packets from network devices (like Aruba routers) and exports them in PCAP format.</p>
- </div>
- </div>
- <div id="content">
- <div class="sect1">
- <h2 id="_synopsis">SYNOPSIS</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p><span class="nowrap"><strong>udpdump</strong></span>
- <span class="nowrap">[ <strong>--help</strong> ]</span>
- <span class="nowrap">[ <strong>--version</strong> ]</span>
- <span class="nowrap">[ <strong>--extcap-interfaces</strong> ]</span>
- <span class="nowrap">[ <strong>--extcap-dlts</strong> ]</span>
- <span class="nowrap">[ <strong>--extcap-interface</strong>=<interface> ]</span>
- <span class="nowrap">[ <strong>--extcap-config</strong> ]</span>
- <span class="nowrap">[ <strong>--capture</strong> ]</span>
- <span class="nowrap">[ <strong>--fifo</strong>=<path to file or pipe> ]</span>
- <span class="nowrap">[ <strong>--port</strong>=<port> ]</span>
- <span class="nowrap">[ <strong>--payload</strong>=<type> ]</span></p>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_description">DESCRIPTION</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p><strong>udpdump</strong> is a extcap tool that provides a UDP receiver that listens for exported datagrams coming from
- any source (like Aruba routers) and exports them in PCAP format. This provides the user two basic
- functionalities: the first one is to have a listener that prevents the localhost to send back an ICMP
- port-unreachable packet. The second one is to strip out the lower layers (layer 2, IP, UDP) that are useless
- (are used just as export vector). The format of the exported datagrams are EXPORTED_PDU, as specified in
- <a href="https://gitlab.com/wireshark/wireshark/-/raw/master/epan/exported_pdu.h" class="bare">https://gitlab.com/wireshark/wireshark/-/raw/master/epan/exported_pdu.h</a></p>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_options">OPTIONS</h2>
- <div class="sectionbody">
- <div class="dlist">
- <dl>
- <dt class="hdlist1">--help</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Print program arguments.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--version</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Print program version.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--extcap-interfaces</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>List available interfaces.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--extcap-interface=<interface></dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Use specified interfaces.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--extcap-dlts</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>List DLTs of specified interface.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--extcap-config</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>List configuration options of specified interface.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--capture</dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Start capturing from specified interface save saved it in place specified by --fifo.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--fifo=<path to file or pipe></dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Save captured packet to file or send it through pipe.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--port=<port></dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Set the listener port. Port 5555 is the default.</p>
- </div>
- </div>
- </div>
- </dd>
- <dt class="hdlist1">--payload=<type></dt>
- <dd>
- <div class="openblock">
- <div class="content">
- <div class="paragraph">
- <p>Set the payload of the exported PDU. Default: data.</p>
- </div>
- </div>
- </div>
- </dd>
- </dl>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_examples">EXAMPLES</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p>To see program arguments:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --help</pre>
- </div>
- </div>
- <div class="paragraph">
- <p>To see program version:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --version</pre>
- </div>
- </div>
- <div class="paragraph">
- <p>To see interfaces:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --extcap-interfaces</pre>
- </div>
- </div>
- <div class="literalblock">
- <div class="title">Example output</div>
- <div class="content">
- <pre>interface {value=udpdump}{display=UDP Listener remote capture}</pre>
- </div>
- </div>
- <div class="paragraph">
- <p>To see interface DLTs:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --extcap-interface=udpdump --extcap-dlts</pre>
- </div>
- </div>
- <div class="literalblock">
- <div class="title">Example output</div>
- <div class="content">
- <pre>dlt {number=252}{name=udpdump}{display=Exported PDUs}</pre>
- </div>
- </div>
- <div class="paragraph">
- <p>To see interface configuration options:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --extcap-interface=udpdump --extcap-config</pre>
- </div>
- </div>
- <div class="literalblock">
- <div class="title">Example output</div>
- <div class="content">
- <pre>arg {number=0}{call=--port}{display=Listen port}{type=unsigned}{range=1,65535}{default=5555}{tooltip=The port the receiver listens on}</pre>
- </div>
- </div>
- <div class="paragraph">
- <p>To capture:</p>
- </div>
- <div class="literalblock">
- <div class="content">
- <pre>udpdump --extcap-interface=randpkt --fifo=/tmp/randpkt.pcapng --capture</pre>
- </div>
- </div>
- <div class="admonitionblock note">
- <table>
- <tr>
- <td class="icon">
- <div class="title">Note</div>
- </td>
- <td class="content">
- To stop capturing CTRL+C/kill/terminate the application.
- </td>
- </tr>
- </table>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_see_also">SEE ALSO</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p><a href="wireshark.html">wireshark</a>(1), <a href="tshark.html">tshark</a>(1), <a href="dumpcap.html">dumpcap</a>(1), <a href="extcap.html">extcap</a>(4)</p>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_notes">NOTES</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <p><strong>udpdump</strong> is part of the <strong>Wireshark</strong> distribution. The latest version
- of <strong>Wireshark</strong> can be found at <a href="https://www.wireshark.org" class="bare">https://www.wireshark.org</a>.</p>
- </div>
- <div class="paragraph">
- <p>HTML versions of the Wireshark project man pages are available at
- <a href="https://www.wireshark.org/docs/man-pages" class="bare">https://www.wireshark.org/docs/man-pages</a>.</p>
- </div>
- </div>
- </div>
- <div class="sect1">
- <h2 id="_authors">AUTHORS</h2>
- <div class="sectionbody">
- <div class="paragraph">
- <div class="title">Original Author</div>
- <p>Dario Lombardo <lomato[AT]gmail.com></p>
- </div>
- </div>
- </div>
- </div>
- </body>
- </html>
|