README

   1 About
   2 -----
   3 Wireless Access Point Utilites for Unix - it's a set of utilites to configure
   4 and monitor Wireless Access Points under Unix using SNMP protocol. Utilites
   5 are known to compile and run under Linux, FreeBSD, NetBSD, MacOS-X, AIX,
   6 QNX and OpenBSD.
   7
   8 The software was initially written by Roman Festchook
   9 (ÕËÒÁ§ÎÓØËÏÀ òÏÍÁÎ æÅÝÕË) without any help from manufacturers
  10 and released under the terms GNU General Public License version 2.0.
  11 A copy of the license file is included with this distribution package.
  12
  13 The project also has a number of contributions, thanks to whose this
  14 software has grown significantly; for a list of them, see files "THANKS"
  15 and "ChangeLog".
  16
  17 As for version 1.2 Wireless Access Point Utilites for Unix include three utils:
  18
  19 ap-config: config and get stats from AP:
  20             setting bridging, wireless and ip options, WEP encryption,
  21                 mac authorization, radio signal power, and communities to
  22                 restrict access to AP, enabling/disabling antennas,
  23                 hiding ESSID in broadcast messages;
  24             device test mode;
  25             getting info about AP sofware and hardware, dynamically updated
  26                 ethernet and wireless ports statistics, list of associated
  27                 stations and visible APs (option to save mac addresses of
  28                 current associated stations to file);
  29             executing commands on AP;
  30         config and get stats from devices that support
  31             MIB-II, IEEE 802.11 MIB and NWN DOT11EXT MIB:
  32             setting bridging and wireless options, WEP encryption,
  33                 mac authorization, communities to restrict access to AP,
  34                 enabling/disabling antennas;
  35             getting info about AP sofware and hardware, dynamically updated
  36                 wireless port statistics, information about latest events
  37                 and errors, list of current associated stations with info
  38                 about signal quality and station activity (option to save
  39                 mac addresses of associated stations to file);
  40         search for connected APs;
  41         nice and portable ncurses-based user interface with context-help
  42                 navigation menus, floating drop-down menus to choose from
  43                 options list, options file to store connect options and
  44                 subshell.
  45
  46 ap-mrtg: to get stat from AP (ATMEL based) and return it in MRTG parseable format:
  47         getting ethernet statistics in bytes, wireless statistics in packets,
  48                 associated stations number and Link Quality/Signal Strenght
  49                 stats from AP in client mode.
  50
  51 ap-trapd: to receive, parse and log trap messages from AP (ATMEL based):
  52         log data using standart syslogd;
  53         running by not privileged user;
  54         listening on the specified interface (only on Linux).
  55
  56 Supported Hardware
  57 ------------------
  58 ap-utils support Atmel chipset based Access Points with ATMEL Private MIB
  59 with enterprises ID 410 (ATMEL410), Access Points with newer ATMEL Private
  60 MIB with enterprises ID 12350 (ATMEL12350) such as Netgear ME102,
  61 and No Wires Needed APs with IEEE 802.11 MIB and NWN DOT11EXT MIB
  62 (NWN).
  63 You can find Known/Reported-to-work hardware in the table below.
  64 If you have had success with ap-utils working with a hardware thats
  65 not in the table below, please report.
  66 Please, if possible, include informations from the ap-config's "sysinfo"
  67 screen in your report.
  68 Also, if possible, please send the MIB file that comes with your device.
  69 This may result in supporting more options in ap-config in the future!
  70 The file may look like 'AT76C510.mib' (in case of ATMEL-based APs),
  71 and usually comes with your SNMP management utility for Windows.
  72
  73 +------------------------------------------------------------------------------+
  74 |                               Supported Access Points                        |
  75 +------------------------------------------------------------------------------+
  76 | Manufacturer                  | Models                | Type                 |
  77 +-------------------------------+-----------------------+----------------------+
  78 | Global Sun                    | ProWave GL2411AP      | ATMEL410             |
  79 | Linksys                       | WAP11 pre2 version    | ATMEL410             |
  80 | SMC                           | MC2655W               | ATMEL410             |
  81 | Netgear                       | ME102                 | ATMEL12350, ATMEL410 |
  82 | Eumitcom                      | WA3001A               | ATMEL410             |
  83 | Edimax                        | EW-7205               | ATMEL410             |
  84 | Target                        | WLAP 24212            | ATMEL410             |
  85 | Micronet                      | SP918                 | ATMEL410             |
  86 | Smartbridges                  | airPoint, airBridge   | ATMEL410             |
  87 | Belkin Components             | F5D6130               | ATMEL410             |
  88 | GemTek                        | TEW-210APB            | ATMEL410             |
  89 | GemTek                        | WX-1500               | NWN                  |
  90 | Intellinet                    | AP, Wireless Bridge   | ATMEL410             |
  91 | D-Link                        | DWL 900AP             | ATMEL410             |
  92 | D-Link                        | DWL 1000AP            | NWN                  |
  93 | WLink Syst. (D-Link subs.)    | Wen-2021              | ATMEL410             |
  94 | Advantek Networks             | AWN-AP128             | ATMEL410             |
  95 | Compex                        | WavePort WP11         | NWN                  |
  96 | Zoom                          | ZoomAir11AP           | NWN                  |
  97 | Telecom                       | T-Sinus 130X          | ATMEL410             |
  98 | Ovislink                      | Airlive WL-1100AP     | ATMEL410             |
  99 | CC&C Technologies             | Access Point          | ATMEL410             |
 100 | Compaq                        | WL-400                | NWN (mostly works)   |
 101 | Asus                          | WL-300                | ATMEL410             |
 102 | Topcom                        | SkyLanR@cer 500       | ATMEL410             |
 103 | Fiberline                     | WL-1200AP             | ATMEL12350           |
 104 | CNet                          | CNAP-711              | ATMEL410             |
 105 | Yakumo                        | Access Point          | ATMEL410             |
 106 | Dynalink (Askey)              | RTW020                | ATMEL410             |
 107 | Acer                          | Warplink EJA-A        | NWN                  |
 108 | Svec                          | FD1811                | ATMEL12350, ATMEL410 |
 109 | Tellus Group Corp             | A14                   | ATMEL12350           |
 110 | Wline                         | A14                   | ATMEL12350           |
 111 | i-Tec                         | i-Tec AP SILVER       | ATMEL410             |
 112 | i-Tec                         | i-Tec AP GOLD         | ATMEL410             |
 113 | Infosmart                     | INAP88                | ATMEL410             |
 114 | Ark                           | SOHO-WLAP             | ATMEL410             |
 115 | Svec                          | SOHO-WLAP             | ATMEL410             |
 116 | GigaFast                      | WF711-AP              | ATMEL12350           |
 117 | Cameo Communications          | WLB-2000/2001         | ATMEL410             |
 118 | Wline                         | W-2000                | ATMEL410             |
 119 +-------------------------------+-----------------------+----------------------+
 120
 121 Please read also HARDWARE-NOTES about hardware-specific information!
 122
 123 Please note that although many of these devices may use the same MIB enterprise
 124 identification, the actual MIBs may slightly differ, depending on whether
 125 the manufacturer has decided upon hardware modifications.
 126 In ap-config, an effort has been made to only include functionality
 127 for features that are common to 2 or more MIBs with the same enterprise
 128 ID. If you have qualms, then please send us the MIB file that came
 129 with your device!
 130
 131 I got an AP and I would like ap-utils to support it (it is not on the
 132 ---------------------------------------------------------------------
 133 list above)
 134 -----------
 135 The device has to be either ATMEL- or NWN-based. The first good sign
 136 of a chance it could be supported by the ap-utils, is the presence
 137 of file 'AT76C510.mib', that gets installed along with the original
 138 Windows-based setup utility.
 139 Try to install the accompanying Windows SNMP setup utility, and
 140 browse the directory to which you have got it installed.
 141 If you find the mentioned file, send this file via e-mail
 142 to <aputils-wmibs at cedric dot vabo dot cz> or <roma at polesye dot net>.
 143 Chances are, that this file matches more or less the MIBs
 144 of other devices already being supported by ap-utils, and thus the
 145 utility code can be tailored accordingly to support your AP
 146 in as broad number of its features as possible.
 147
 148 Where to get more information
 149 -----------------------------
 150 You can find info about utils from this README and from man pages
 151 for utilites; as well as in INSTALL and TODO files at toplevel directory.
 152 Additional info and useful links may be found in the Documentation
 153 directory of this package and on our web page http://ap-utils.polesye.net/ .
 154 We also run maillist to discuss any related topics - for more info please
 155 visit http://ap-utils.polesye.net/ .
 156
 157 Contributing & reporting problems
 158 ---------------------------------
 159 Any help in developing, bugfixing and testing is welcome. Also any
 160 additional documentation, free hardware to support this project and job offers
 161 are greatly welcome.
 162 Please send your comments, if any, to my email -
 163 roma at polesye.net or to the maillist.
 164
 165 Before sending bugreports please be sure to read docs (firstly, README and FAQ)
 166 and upgrade to the latest version of ap-utils. If problem still exists, then
 167 please send a detailed description of your problem to the maillist.
 168 Include the version of the program, the operating system that you are
 169 using, the compiler and compiler flags used to compile the program (if
 170 you know them), what kind of distribution you are using (in case of a GNU/Linux
 171 system).
 172 If the program crashed and produces a core dump, please provide a
 173 stack trace of the program.
 174 You can do this by running dbx or gdb like this:
 175     gdb <utility_name> core
 176     (gdb) where
 177