doc/man_pages/udpdump.adoc

   1 include::../attributes.adoc[]
   2 = udpdump(1)
   3 :doctype: manpage
   4 :stylesheet: ws.css
   5 :linkcss:
   6 :copycss: {css_dir}/{stylesheet}
   7
   8 == NAME
   9
  10 udpdump - Provide a UDP receiver that gets packets from network devices (like Aruba routers) and exports them in PCAP format.
  11
  12 == SYNOPSIS
  13
  14 [manarg]
  15 *udpdump*
  16 [ *--help* ]
  17 [ *--version* ]
  18 [ *--extcap-interfaces* ]
  19 [ *--extcap-dlts* ]
  20 [ *--extcap-interface*=<interface> ]
  21 [ *--extcap-config* ]
  22 [ *--capture* ]
  23 [ *--fifo*=<path to file or pipe> ]
  24 [ *--port*=<port> ]
  25 [ *--payload*=<type> ]
  26
  27 == DESCRIPTION
  28
  29 *udpdump* is a extcap tool that provides a UDP receiver that listens for exported datagrams coming from
  30 any source (like Aruba routers) and exports them in PCAP format. This provides the user two basic
  31 functionalities: the first one is to have a listener that prevents the localhost to send back an ICMP
  32 port-unreachable packet. The second one is to strip out the lower layers (layer 2, IP, UDP) that are useless
  33 (are used just as export vector). The format of the exported datagrams are EXPORTED_PDU, as specified in
  34 https://gitlab.com/wireshark/wireshark/-/raw/master/epan/exported_pdu.h
  35
  36 == OPTIONS
  37
  38 --help::
  39 Print program arguments.
  40
  41 --version::
  42 Print program version.
  43
  44 --extcap-interfaces::
  45 List available interfaces.
  46
  47 --extcap-interface=<interface>::
  48 Use specified interfaces.
  49
  50 --extcap-dlts::
  51 List DLTs of specified interface.
  52
  53 --extcap-config::
  54 List configuration options of specified interface.
  55
  56 --capture::
  57 Start capturing from specified interface save saved it in place specified by --fifo.
  58
  59 --fifo=<path to file or pipe>::
  60 Save captured packet to file or send it through pipe.
  61
  62 --port=<port>::
  63 Set the listener port. Port 5555 is the default.
  64
  65 --payload=<type>::
  66 Set the payload of the exported PDU. Default: data.
  67
  68 == EXAMPLES
  69
  70 To see program arguments:
  71
  72     udpdump --help
  73
  74 To see program version:
  75
  76     udpdump --version
  77
  78 To see interfaces:
  79
  80     udpdump --extcap-interfaces
  81
  82 .Example output
  83     interface {value=udpdump}{display=UDP Listener remote capture}
  84
  85 To see interface DLTs:
  86
  87     udpdump --extcap-interface=udpdump --extcap-dlts
  88
  89 .Example output
  90     dlt {number=252}{name=udpdump}{display=Exported PDUs}
  91
  92 To see interface configuration options:
  93
  94     udpdump --extcap-interface=udpdump --extcap-config
  95
  96 .Example output
  97     arg {number=0}{call=--port}{display=Listen port}{type=unsigned}{range=1,65535}{default=5555}{tooltip=The port the receiver listens on}
  98
  99 To capture:
 100
 101     udpdump --extcap-interface=randpkt --fifo=/tmp/randpkt.pcapng --capture
 102
 103 NOTE: To stop capturing CTRL+C/kill/terminate the application.
 104
 105 == SEE ALSO
 106
 107 xref:wireshark.html[wireshark](1), xref:tshark.html[tshark](1), xref:dumpcap.html[dumpcap](1), xref:extcap.html[extcap](4)
 108
 109 == NOTES
 110
 111 *udpdump* is part of the *Wireshark* distribution.  The latest version
 112 of *Wireshark* can be found at https://www.wireshark.org.
 113
 114 HTML versions of the Wireshark project man pages are available at
 115 https://www.wireshark.org/docs/man-pages.
 116
 117 == AUTHORS
 118
 119 .Original Author
 120 [%hardbreaks]
 121 Dario Lombardo <lomato[AT]gmail.com>