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 40The 41.Nm snmp_wlan 42module implements a private BEGEMOT-WIRELESS-MIB, which allows 43management of virtual wireless interfaces. 44The MIB defines objects similar to the state data and configuration capabilities of 45.Xr ifconfig 8 46for configuring virtual wireless interfaces. 47Therefore one should consider adding write communities or loading the 48.Nm 49module on systems where security is crucial. 50.Sh IMPLEMENTATION NOTES 51A short description of the Tables and interesting objects in the MIB follows. 52.Bl -tag -width "XXXXXXXXX" 53.It Va wlanInterfaceTable 54The table is used for creation and deletion of virtual wireless interfaces. 55To add a new interface, a SET should be executed on the 56.Va wlanIfaceName 57column with 58value the desired name of the interface. 59Next the parent interface must be set via 60.Va wlanParentIfName 61column. 62Any optional parameters may be set via the 63.Va wlanIfaceOperatingMode , 64.Va wlanIfaceFlags , 65.Va wlanIfaceBssid 66and 67.Va wlanIfaceLocalAddress 68columns. 69To finally create the interface in the system, a SET with value of active(1) to 70.Va wlanIfaceStatus 71column should be executed. 72To destroy a wireless interface a SET with value of destroy(6) to the relevant 73.Va wlanIfaceStatus 74column should be executed. 75.It Va wlanIfParentTable 76The table contains information about the hardware capabilities of the parent of 77a wireless interface. 78.It Va wlanIfaceConfigTable 79The table is used to get or set various configuration parameters for a virtual 80wireless interface. 81Depending on the operating mode of the interface and the hardware capabilities 82of the underlying hardware interface, not all parameters and values may be supported. 83.It Va wlanIfacePeerTable 84The table contains information about the associated stations for interfaces 85operating as access points, or the stations identified as neighbors in the IBSS 86for interfaces operating in adhoc mode. 87.It Va wlanIfaceChannelTable 88Information about the active channels for the wireless interfaces in the system. 89.It Va wlanIfRoamParamsTable 90The parameters that govern the roaming operation on the wireless interfaces. 91.It Va wlanIfTxParamsTable 92The parameters that govern the transmit operation on the wireless interfaces. 93.It Va wlanScanConfigTable 94The table that contains a configuration for channel scanning initiated via SNMP. 95.It Va wlanScanResultsTable 96The table contains the scan results from the last scan for each wireless 97interface on the system. 98.It Va wlanIfaceStatisticsTable 99Summary statistics for each wireless interface on the system. 100.It Va wlanWepInterfaceTable 101WEP configuration for the wireless interfaces on the system. 102.It Va wlanMACAccessControlTable 103Access Control configuration for wireless interfaces operating as access points. 104.It Va wlanMACAccessControlMACTable 105The table with Access Control MAC entries for which the configured Access 106Control Policy on wireless interfaces operating in Host AP mode is applied. 107.Va wlanMACAccessControlMACStatus 108column is used to add or delete MAC ACL entries. 109A set with value createAndGo(4) will add new entry, while with value destroy(6) 110will delete an existing one. 111.It Va wlanMeshRoutingConfig 112The subtree contains system configuration related to Wireless Mesh Routing. 113.It Va wlanMeshInterfaceTable 114The table contains information for wireless interfaces operating as wireless 115mesh points. 116.It Va wlanMeshNeighborTable 117The table contains information for the neighbors of wireless interfaces 118operating in mesh mode. 119.It Va wlanMeshRouteTable 120The mesh routing table for interfaces operating as mesh points, used for 121forwarding packets on a mesh network. 122.Va wlanMeshRouteStatus 123column is used to add or delete entries in the mesh routing table for an 124interface. 125A set with value createAndGo(4) will add new entry, while with value destroy(6) 126will delete an existing one. 127.It Va wlanMeshStatsTable 128Summary statistics for each virtual wireless interface operating as mesh point. 129.It Va wlanMeshHWMPConfig 130The subtree contains system configuration related to Hybrid Wireless Mesh 131Protocol. 132.It Va wlanHWMPInterfaceTable 133The table contains HWMP information for wireless interfaces operating in mesh 134mode. 135.It Va wlanMeshHWMPStatsTable 136Summary statistics for HWMP operation on interfaces operating as mesh points. 137.El 138.Sh RESTRICTIONS 139Not all information or configuration in the MIBs is currently available in FreeBSD. 140The 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 147The description of the MIB tree implemented by 148.Nm . 149.It Pa /usr/share/snmp/mibs/BEGEMOT-WIRELESS-MIB.txt 150The 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 162