usr.sbin/bsnmpd/modules/snmp_wlan/snmp_wlan.3

   1 .\"-
   2 .\" Copyright (C) 2010 The FreeBSD Foundation
   3 .\"
   4 .\" This documentation was written by Shteryana Sotirova Shopova under
   5 .\" sponsorship from the FreeBSD Foundation.
   6 .\"
   7 .\" Redistribution and use in source and binary forms, with or without
   8 .\" modification, are permitted provided that the following conditions
   9 .\" are met:
  10 .\" 1. Redistributions of source code must retain the above copyright
  11 .\"    notice, this list of conditions and the following disclaimer.
  12 .\" 2. Redistributions in binary form must reproduce the above copyright
  13 .\"    notice, this list of conditions and the following disclaimer in the
  14 .\"    documentation and/or other materials provided with the distribution.
  15 .\"
  16 .\" THIS SOFTWARE IS PROVIDED BY AUTHOR AND CONTRIBUTORS ``AS IS'' AND
  17 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  18 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  19 .\" ARE DISCLAIMED.  IN NO EVENT SHALL AUTHOR OR CONTRIBUTORS BE LIABLE
  20 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  21 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  22 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  23 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  24 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  25 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  26 .\" SUCH DAMAGE.
  27 .\"
  28 .\" $FreeBSD$
  29 .\"
  30 .Dd June 28, 2010
  31 .Dt SNMP_WLAN 3
  32 .Os
  33 .Sh NAME
  34 .Nm snmp_wlan
  35 .Nd "wireless networking module for"
  36 .Xr bsnmpd 1
  37 .Sh LIBRARY
  38 .Pq begemotSnmpdModulePath."wlan" = "/usr/lib/snmp_wlan.so"
  39 .Sh DESCRIPTION
  40 The
  41 .Nm snmp_wlan
  42 module implements a private BEGEMOT-WIRELESS-MIB, which allows
  43 management of virtual wireless interfaces.
  44 The MIB defines objects similar to the state data and configuration capabilities of
  45 .Xr ifconfig 8
  46 for configuring virtual wireless interfaces.
  47 Therefore one should consider adding write communities or loading the
  48 .Nm
  49 module on systems where security is crucial.
  50 .Sh IMPLEMENTATION NOTES
  51 A short description of the Tables and interesting objects in the MIB follows.
  52 .Bl -tag -width "XXXXXXXXX"
  53 .It Va wlanInterfaceTable
  54 The table is used for creation and deletion of virtual wireless interfaces.
  55 To add a new interface, a SET should be executed on the
  56 .Va wlanIfaceName
  57 column with
  58 value the desired name of the interface.
  59 Next the parent interface must be set via
  60 .Va wlanParentIfName
  61 column.
  62 Any optional parameters may be set via the
  63 .Va wlanIfaceOperatingMode ,
  64 .Va wlanIfaceFlags ,
  65 .Va wlanIfaceBssid
  66 and
  67 .Va wlanIfaceLocalAddress
  68 columns.
  69 To finally create the interface in the system, a SET with value of active(1) to
  70 .Va wlanIfaceStatus
  71 column should be executed.
  72 To destroy a wireless interface a SET with value of destroy(6) to the relevant
  73 .Va wlanIfaceStatus
  74 column should be executed.
  75 .It Va wlanIfParentTable
  76 The table contains information about the hardware capabilities of the parent of
  77 a wireless interface.
  78 .It Va wlanIfaceConfigTable
  79 The table is used to get or set various configuration parameters for a virtual
  80 wireless interface.
  81 Depending on the operating mode of the interface and the hardware capabilities
  82 of the underlying hardware interface, not all parameters and values may be supported.
  83 .It Va wlanIfacePeerTable
  84 The table contains information about the associated stations for interfaces
  85 operating as access points, or the stations identified as neighbors in the IBSS
  86 for interfaces operating in adhoc mode.
  87 .It Va wlanIfaceChannelTable
  88 Information about the active channels for the wireless interfaces in the system.
  89 .It Va wlanIfRoamParamsTable
  90 The parameters that govern the roaming operation on the wireless interfaces.
  91 .It Va wlanIfTxParamsTable
  92 The parameters that govern the transmit operation on the wireless interfaces.
  93 .It Va wlanScanConfigTable
  94 The table that contains a configuration for channel scanning initiated via SNMP.
  95 .It Va wlanScanResultsTable
  96 The table contains the scan results from the last scan for each wireless
  97 interface on the system.
  98 .It Va wlanIfaceStatisticsTable
  99 Summary statistics for each wireless interface on the system.
 100 .It Va wlanWepInterfaceTable
 101 WEP configuration for the wireless interfaces on the system.
 102 .It Va wlanMACAccessControlTable
 103 Access Control configuration for wireless interfaces operating as access points.
 104 .It Va wlanMACAccessControlMACTable
 105 The table with Access Control MAC entries for which the configured Access
 106 Control Policy on wireless interfaces operating in Host AP mode is applied.
 107 .Va wlanMACAccessControlMACStatus
 108 column is used to add or delete MAC ACL entries.
 109 A set with value createAndGo(4) will add new entry, while with value destroy(6)
 110 will delete an existing one.
 111 .It Va wlanMeshRoutingConfig
 112 The subtree contains system configuration related to Wireless Mesh Routing.
 113 .It Va wlanMeshInterfaceTable
 114 The table contains information for wireless interfaces operating as wireless
 115 mesh points.
 116 .It Va wlanMeshNeighborTable
 117 The table contains information for the neighbors of wireless interfaces
 118 operating in mesh mode.
 119 .It Va wlanMeshRouteTable
 120 The mesh routing table for interfaces operating as mesh points, used for
 121 forwarding packets on a mesh network.
 122 .Va wlanMeshRouteStatus
 123 column is used to add or delete entries in the mesh routing table for an
 124 interface.
 125 A set with value createAndGo(4) will add new entry, while with value destroy(6)
 126 will delete an existing one.
 127 .It Va wlanMeshStatsTable
 128 Summary statistics for each virtual wireless interface operating as mesh point.
 129 .It Va wlanMeshHWMPConfig
 130 The subtree contains system configuration related to Hybrid Wireless Mesh
 131 Protocol.
 132 .It Va wlanHWMPInterfaceTable
 133 The table contains HWMP information for wireless interfaces operating in mesh
 134 mode.
 135 .It Va wlanMeshHWMPStatsTable
 136 Summary statistics for HWMP operation on interfaces operating as mesh points.
 137 .El
 138 .Sh RESTRICTIONS
 139 Not all information or configuration in the MIBs is currently available in FreeBSD.
 140 The values of the following variables carry no information:
 141 .Bl -tag -width "XXXXXXXXX"
 142 .It Va wlanStatsReset
 143 .El
 144 .Sh FILES
 145 .Bl -tag -width "XXXXXXXXX"
 146 .It Pa /usr/share/snmp/defs/wlan_tree.def
 147 The description of the MIB tree implemented by
 148 .Nm .
 149 .It Pa /usr/share/snmp/mibs/BEGEMOT-WIRELESS-MIB.txt
 150 The private BEGEMOT-WIRELESS-MIB that is implemented by this module.
 151 .El
 152 .Sh SEE ALSO
 153 .Xr bsnmpd 1 ,
 154 .Xr gensnmptree 1 ,
 155 .Xr snmpmod 3 ,
 156 .Xr wlan 4 ,
 157 .Xr wlan_acl 4 ,
 158 .Xr wlan_wep 4 ,
 159 .Xr ifconfig 8
 160 .Sh AUTHORS
 161 .An Shteryana Shopova Aq Mt syrinx@FreeBSD.org