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