Documentation/ap-mrtg.8

   1 .\"      Manpage for ap-mrtg utility
   2 .\"   from Wireless Access Point Utilitess for Unix
   3 .\"
   4 .\"  Copyright (c) 2002 Roman Festchook <roma at polesye dot net>
   5 .\"
   6 .\"  This program is free software; you can redistribute it and/or modify
   7 .\"  it under the terms of the GNU General Public License Version 2 from
   8 .\"  June 1991 as published by the Free Software Foundation.
   9 .\"
  10 .\"  This program is distributed in the hope that it will be useful, but
  11 .\"  WITHOUT ANY WARRANTY; without even the implied warranty of
  12 .\"  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  13 .\"  GNU General Public License for more details.
  14 .\"
  15 .\"  You should have received a copy of the GNU General Public License along
  16 .\"  with this program; if not, write to the Free Software Foundation, Inc.,
  17 .\"  59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
  18 .TH ap-mrtg 8 "Wireless Access Point Utilites for Unix"
  19 .SH NAME
  20 ap-mrtg \- AP to MRTG data translator
  21
  22 .SH SYNOPSIS
  23 .B ap-mrtg
  24 .B -i
  25 .IR ip
  26 .B -c
  27 .IR community
  28 .B -t
  29 .IR type
  30 .B [-b
  31 .IR bssid
  32 .B ]
  33 .B [-v]
  34 .B [-r]
  35 .B [-h]
  36
  37 .SH DESCRIPTION
  38 .B ap-mrtg
  39 get stats from AP and return it in MRTG parsable format.
  40 .br
  41 The Multi Router Traffic Grapher (MRTG) is a tool to monitor the traffic load on network-links. MRTG generates HTML pages containing graphical images which provide a LIVE visual representation of this traffic. You may get it from: http://people.ee.ethz.ch/~oetiker/webtools/mrtg/.
  42
  43 .SH OPTIONS
  44 .TP
  45 .B -i ip
  46 AP ip address
  47 .TP
  48 .B -c community
  49 SNMP community string
  50 .TP
  51 .B -t type
  52 Statistics type <w>ireless, <e>thernet, associated <s>tations or <l>ink quality in client mode;
  53 .TP
  54 .B -b bssid
  55 Mac address of the AP to which get link quality.
  56 .TP
  57 .B -v
  58 report MRTG about problems connecting to AP - if you want to get report about when AP spot work enable it
  59 .TP
  60 .B -r
  61 reset AP when getting LinkQuality stats
  62 .TP
  63 .B -h
  64 print help screen
  65
  66 .SH MRTG Configuration Example
  67 Simple mrtg.cfg for get stats from Atmel based AP:
  68 .nf
  69 Target[ap_e]: `/usr/local/bin/ap-mrtg -i 192.168.0.1 -c "public" -t ethernet -v`
  70 Options[ap_e]: noinfo, growright, bits
  71 MaxBytes[ap_e]: 12500
  72 Title[ap_e]: Traffic Analysis for AP Ethernet port
  73 PageTop[ap_e]: <H1>Traffic Analysis for AP Ethernet port</H1>
  74
  75 Target[ap_w]: `/usr/local/bin/ap-mrtg -i 192.168.0.1 -c "public" -t wireless -v`
  76 Options[ap_w]: noinfo, growright, perminute
  77 ShortLegend[ap_w]: pkt/min
  78 MaxBytes[ap_w]: 100000000
  79 Legend1[ap_w]:  Packets In
  80 Legend2[ap_w]:  Packets Out
  81 YLegend[ap_w]: packets/min
  82 Title[ap_w]: Traffic Analysis for AP Wireless port
  83 PageTop[ap_w]: <H1>Traffic Analysis for AP Wireless port</H1>
  84
  85 Target[ap_s]: `/usr/local/bin/ap-mrtg -i 192.168.0.1 -c "public" -t stations -v`
  86 Options[ap_s]: growright, gauge, noinfo
  87 ShortLegend[ap_s]: stations
  88 MaxBytes[ap_s]: 10
  89 YTics[ap_s]: 10
  90 Legend2[ap_s]: none
  91 Legend1[ap_s]: Associated Stations
  92 YLegend[ap_s]: Associated Stations
  93 Title[ap_s]: Traffic Analysis for AP Associated Stations
  94 PageTop[ap_s]: <H1>Traffic Analysis for AP Associated Stations</H1>
  95 LegendO[ap_s]: none
  96 LegendI[ap_s]: Associated Stations
  97 .fi
  98
  99 .SH Link Quality stats
 100 If the AP is not in client mode, it errors out. Grabbing the signal strength resets the ethernet and wireless stats and AP. It's
 101 .B safe
 102 do not use this type of stat.
 103 .BR
 104 Optionally you may set mac address (bssid) of the AP to which getting link quality stats, by default used first returned AP.
 105 .BR
 106 Simple mrtg.cfg for get stats from Atmel based AP with Link Quality and reset stats:
 107
 108 .nf
 109 Target[ap_e]: `/usr/local/bin/ap-mrtg -i 192.168.0.1 -c "public" -t ethernet -v`
 110 Options[ap_e]: noinfo, growright, bits, gauge
 111 MaxBytes[ap_e]: 12500
 112 Title[ap_e]: Traffic Analysis for AP Ethernet port
 113 PageTop[ap_e]: <H1>Traffic Analysis for AP Ethernet port</H1>
 114
 115 Target[ap_w]: `/usr/local/bin//ap-mrtg -i 192.168.0.1 -c "public" -t wireless -v`
 116 Options[ap_w]: noinfo, growright, perminute, gauge
 117 ShortLegend[ap_w]: pkt/min
 118 MaxBytes[ap_w]: 100000000
 119 Legend1[ap_w]:  Packets In
 120 Legend2[ap_w]:  Packets Out
 121 YLegend[ap_w]: packets/min
 122 Title[ap_w]: Traffic Analysis for AP Wireless port
 123 PageTop[ap_w]: <H1>Traffic Analysis for AP Wireless port</H1>
 124
 125 Target[EdAP_s]: `/usr/local/bin/ap-mrtg -i 192.168.0.1 -c "public" -t link -b FFFFFFFF -v -r`
 126 MaxBytes[EdAP_s]: 100
 127 Options[EdAP_s]: noinfo,growright,integer,unknaszero,nopercent,gauge
 128 Title[EdAP_s]: Signal Analysis for EdAP Wireless port
 129 YLegend[EdAP_s]: Signal Strength dBm/Quality
 130 ShortLegend[EdAP_s]: dBm
 131 PageTop[EdAP_s]: <H1>Signal/Quality Strength for EdAP</H1>
 132 LegendI[EdAP_s]: Signal Quality
 133 LegendO[EdAP_s]: Signal Strength in dBm
 134 .fi
 135
 136 .SH AUTHOR
 137 Roman Festchook <roma@polesye.net>
 138 .br
 139 http://ap-utils.polesye.net
 140
 141 .SH SEE ALSO
 142 ap-config(8), ap-trapd(8)
 143