doc/udpdump.pod

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