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