1
2-- *******************************************************************
3-- CISCO-LWAPP-DHCP-MIB.my :
4-- Light Weight Access Point Dynamic Host Configuration Protocol MIB
5-- June 2007, Arun Kumar
6--
7-- Copyright (c) 2007 by Cisco Systems, Inc.
8-- All rights reserved.
9-- *******************************************************************
10--
11CISCO-LWAPP-DHCP-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14        MODULE-IDENTITY,
15        NOTIFICATION-TYPE,
16        OBJECT-TYPE,
17        Unsigned32,
18	IpAddress
19                FROM SNMPv2-SMI
20        OBJECT-GROUP,
21        NOTIFICATION-GROUP
22                FROM SNMPv2-CONF
23        TruthValue,
24	TimeStamp
25                FROM SNMPv2-TC
26        InetAddressType,
27        InetAddress
28                FROM INET-ADDRESS-MIB
29        CiscoURLString
30                FROM CISCO-TC
31        SnmpAdminString
32                FROM SNMP-FRAMEWORK-MIB
33        ciscoMgmt
34                FROM CISCO-SMI;
35
36--********************************************************************
37--*  MODULE IDENTITY
38--********************************************************************
39
40ciscoLwappDhcpMIB    MODULE-IDENTITY
41        LAST-UPDATED    "200604051150Z"
42        ORGANIZATION    "Cisco Systems Inc."
43        CONTACT-INFO
44               "        Cisco Systems,
45                        Customer Service
46                Postal: 170 West Tasman Drive
47                        San Jose, CA  95134
48                        USA
49                   Tel: +1 800 553-NETS
50
51                 Email: cs-wnbu-snmp@cisco.com"
52
53        DESCRIPTION
54                "This MIB is intended to be implemented on all those
55                devices operating as Central controllers, that
56                terminate the Light Weight Access Point Protocol
57                tunnel from Cisco Light-weight LWAPP Access Points.
58
59                This MIB is used to show and configure Dynamic Host
60		Configuration Protocol (DHCP) related statistics.
61
62
63                The relationship between CC and the LWAPP APs
64                can be depicted as follows:
65
66        +......+     +......+     +......+           +......+
67        +      +     +      +     +      +           +      +
68        +  CC  +     +  CC  +     +  CC  +           +  CC  +
69        +      +     +      +     +      +           +      +
70        +......+     +......+     +......+           +......+
71          ..            .             .                 .
72          ..            .             .                 .
73         .  .            .             .                 .
74        .    .            .             .                 .
75       .      .            .             .                 .
76      .        .            .             .                 .
77   +......+ +......+     +......+      +......+          +......+
78   +      + +      +     +      +      +      +          +      +
79   +  AP  + +  AP  +     +  AP  +      +  AP  +          +  AP  +
80   +      + +      +     +      +      +      +          +      +
81   +......+ +......+     +......+      +......+          +......+
82              .              .             .                 .
83            .  .              .             .                 .
84           .    .              .             .                 .
85          .      .              .             .                 .
86         .        .              .             .                 .
87      +......+ +......+     +......+      +......+          +......+
88      +      + +      +     +      +      +      +          +      +
89      +  MN  + +  MN  +     +  MN  +      +  MN  +          +  MN  +
90      +      + +      +     +      +      +      +          +      +
91      +......+ +......+     +......+      +......+          +......+
92
93
94                The LWAPP tunnel exists between the controller and
95                the APs.  The MNs communicate with the APs through
96                the protocol defined by the 802.11 standard.
97
98                LWAPP APs, upon bootup, discover and join one of the
99                controllers and the controller pushes the configuration,
100                that includes the WLAN parameters, to the LWAPP APs.
101                The APs then encapsulate all the 802.11 frames from
102                wireless clients inside LWAPP frames and forward
103                the LWAPP frames to the controller.
104
105                                   GLOSSARY
106
107                Access Point ( AP )
108
109                An entity that contains an 802.11 medium access
110                control ( MAC ) and physical layer ( PHY ) interface
111                and provides access to the distribution services via
112                the wireless medium for associated clients.
113
114                LWAPP APs encapsulate all the 802.11 frames in
115                LWAPP frames and sends them to the controller to which
116                it is logically connected.
117
118                Central Controller ( CC )
119
120                The central entity that terminates the LWAPP protocol
121                tunnel from the LWAPP APs.  Throughout this MIB,
122                this entity also referred to as 'controller'.
123
124                Light Weight Access Point Protocol ( LWAPP )
125
126                This is a generic protocol that defines the
127                communication between the Access Points and the
128                Central Controller.
129
130                Mobile Node ( MN )
131
132                A roaming 802.11 wireless device in a wireless
133                network associated with an access point. Mobile Node,
134                Mobile Station(Ms) and client are used interchangeably.
135
136                REFERENCE
137
138                [1] Wireless LAN Medium Access Control ( MAC ) and
139                Physical Layer ( PHY ) Specifications.
140
141                [2] Draft-obara-capwap-lwapp-00.txt, IETF Light
142                Weight Access Point Protocol "
143
144        REVISION      "200706241150Z"
145        DESCRIPTION
146                "Initial version of this MIB module. "
147        ::= { ciscoMgmt 193999 }
148
149ciscoLwappDhcpMIBObjects OBJECT IDENTIFIER
150        ::= { ciscoLwappDhcpMIB 0 }
151
152ciscoLwappDhcpGlobalConfig OBJECT IDENTIFIER
153	::= { ciscoLwappDhcpMIBObjects 1 }
154
155ciscoLwappDhcpStatsConfig OBJECT IDENTIFIER
156	::= { ciscoLwappDhcpMIBObjects 2 }
157
158ciscoLwappDhcpShowStats OBJECT IDENTIFIER
159	::= { ciscoLwappDhcpMIBObjects  3 }
160
161--*************************************************
162--DHCP Global Config
163--*************************************************
164
165cLDhcpClearAllStats OBJECT-TYPE
166	SYNTAX	    TruthValue
167	MAX-ACCESS  read-write
168	STATUS	    current
169	DESCRIPTION
170	"This attribute when set to true, clears
171	all the statistics of all the DHCP servers."
172	::= { ciscoLwappDhcpGlobalConfig  1 }
173
174cLDhcpOpt82RemoteIdFormat OBJECT-TYPE
175      SYNTAX        INTEGER {
176                apMac (1),
177                apMacSsid (2)
178       }
179      MAX-ACCESS  read-write
180      STATUS        current
181      DESCRIPTION
182            "This object specifies the format for RemoteId field
183             in DHCP option 82 of the controller.
184             when set to apMac (1), the DHCP Option 82 RemoteID format
185             is set to ap-mac.  when set to apMacSsid(2), the DHCP Option 82
186             RemoteID format is set to apmac::SSID."
187      DEFVAL {apMac}
188      ::= { ciscoLwappDhcpGlobalConfig  2 }
189
190--********************************************************
191--DHCP Statistics Config Table
192--********************************************************
193
194cLDhcpStatsConfigTable   OBJECT-TYPE
195	SYNTAX 	     SEQUENCE OF CLDhcpStatsConfigEntry
196	MAX-ACCESS   not-accessible
197	STATUS	     current
198	DESCRIPTION
199		"This contains configurable attributes for
200		statistics of the dhcp servers, uniquely
201		identified by IP Address."
202	::= { ciscoLwappDhcpStatsConfig 1 }
203
204cLDhcpStatsConfigEntry  OBJECT-TYPE
205	SYNTAX	      CLDhcpStatsConfigEntry
206	MAX-ACCESS    not-accessible
207	STATUS	      current
208	DESCRIPTION
209		"Each entry represents a DHCP server uniquely
210		Identified by the IP Address. "
211	INDEX         { cLDhcpServerIpAddress }
212	::= { cLDhcpStatsConfigTable  1}
213
214CLDhcpStatsConfigEntry  ::=
215	SEQUENCE {
216			  cLDhcpServerIpAddress   IpAddress,
217			  cLDhcpClearStats        TruthValue
218	         }
219
220cLDhcpServerIpAddress  OBJECT-TYPE
221	SYNTAX          IpAddress
222	MAX-ACCESS      not-accessible
223	STATUS          current
224	DESCRIPTION
225               "This object represents every entry in the table uniquely."
226        ::= { cLDhcpStatsConfigEntry  1 }
227
228cLDhcpClearStats  OBJECT-TYPE
229	SYNTAX		TruthValue
230	MAX-ACCESS	read-write
231	STATUS		current
232	DESCRIPTION
233	        "This object when set to 'true', will clear the
234	         Statistics of the dhcp server represented by the
235		 unique MAC address."
236        ::= { cLDhcpStatsConfigEntry    2 }
237
238cLDhcpStatsShowTable  OBJECT-TYPE
239	SYNTAX 	      SEQUENCE OF CLDhcpStatsShowEntry
240	MAX-ACCESS    not-accessible
241	STATUS	      current
242	DESCRIPTION
243		"This contains various statistics of the dhcp
244		Servers, uniquely identified by IP Address."
245	::= { ciscoLwappDhcpShowStats 1}
246
247cLDhcpStatsShowEntry  OBJECT-TYPE
248	SYNTAX	      CLDhcpStatsShowEntry
249	MAX-ACCESS    not-accessible
250	STATUS	      current
251	DESCRIPTION
252		"Each entry represents a DHCP server uniquely
253		Identified by the IP Address. "
254	INDEX     { cLDhcpServerIpAddress }
255	::= { cLDhcpStatsShowTable   1}
256
257CLDhcpStatsShowEntry  ::=
258	SEQUENCE {
259			 cLDhcpProxy		TruthValue,
260		  	 cLDhcpDiscoverPkts     Counter32,
261		 	 cLDhcpRequestPkts      Counter32,
262                         cLDhcpDeclinePkts      Counter32,
263		       	 cLDhcpInformPkts       Counter32,
264		  	 cLDhcpReleasePkts      Counter32,
265		 	 cLDhcpReplyPkts        Counter32,
266		 	 cLDhcpOfferPkts        Counter32,
267		 	 cLDhcpAckPkts           Counter32,
268			 cLDhcpNakPkts           Counter32,
269		 	 cLDhcpTxFailures        Counter32,
270			 cLDhcpLastRspTime       TimeStamp,
271			 cLDhcpLastReqTime       TimeStamp
272		 }
273
274cLDhcpProxy   OBJECT-TYPE
275	SYNTAX		TruthValue
276	MAX-ACCESS	read-only
277	STATUS		deprecated
278	DESCRIPTION
279               "This object represents whether the proxy option is
280	        Enabled or disabled."
281	::= { cLDhcpStatsShowEntry    1 }
282
283cLDhcpDiscoverPkts     OBJECT-TYPE
284	SYNTAX          Counter32
285	UNITS           "packets"
286	MAX-ACCESS      read-only
287	STATUS          current
288	DESCRIPTION
289               "This object represents the number of DHCP discover
290	       Packets sent by the controller."
291	::= { cLDhcpStatsShowEntry  2 }
292
293cLDhcpRequestPkts    OBJECT-TYPE
294	SYNTAX       Counter32
295	UNITS        "packets"
296	MAX-ACCESS   read-only
297	STATUS       current
298	DESCRIPTION
299	        "This object represents the number of DHCP request
300	        packets sent by the controller."
301	::= { cLDhcpStatsShowEntry  3 }
302
303cLDhcpDeclinePkts    OBJECT-TYPE
304	SYNTAX       Counter32
305	UNITS        "packets"
306	MAX-ACCESS   read-only
307	STATUS       current
308	DESCRIPTION
309              "This object represents the number of DHCP decline
310	       Packets received by the controller."
311	::= { cLDhcpStatsShowEntry  4 }
312
313cLDhcpInformPkts   OBJECT-TYPE
314	SYNTAX     Counter32
315	UNITS      "packets"
316	MAX-ACCESS read-only
317	STATUS     current
318	DESCRIPTION
319	        "This object represents the number of DHCP
320	       	 inform packets."
321	::= { cLDhcpStatsShowEntry  5 }
322
323cLDhcpReleasePkts    OBJECT-TYPE
324	SYNTAX       Counter32
325	UNITS        "packets"
326	MAX-ACCESS   read-only
327	STATUS       current
328	DESCRIPTION
329              "This object represents the number of DHCP
330	      release packets."
331        ::= { cLDhcpStatsShowEntry  6 }
332
333cLDhcpReplyPkts    OBJECT-TYPE
334	SYNTAX     Counter32
335	UNITS      "packets"
336	MAX-ACCESS read-only
337	STATUS     current
338	DESCRIPTION
339	       "This object represents the number of DHCP reply
340	        Packets received by the controller."
341	::= { cLDhcpStatsShowEntry  7 }
342
343cLDhcpOfferPkts    OBJECT-TYPE
344	SYNTAX          Counter32
345	UNITS           "packets"
346	MAX-ACCESS      read-only
347	STATUS          current
348	DESCRIPTION
349              "This object represents the number of DHCP
350	      offer packets."
351       ::= { cLDhcpStatsShowEntry  8 }
352
353cLDhcpAckPkts    OBJECT-TYPE
354        SYNTAX          Counter32
355  	UNITS           "packets"
356  	MAX-ACCESS      read-only
357  	STATUS          current
358  	DESCRIPTION
359		"This object represents the number of Ack  packets"
360       ::= { cLDhcpStatsShowEntry  9 }
361
362cLDhcpNakPkts    OBJECT-TYPE
363	SYNTAX          Counter32
364	UNITS           "packets"
365	MAX-ACCESS      read-only
366	STATUS          current
367	DESCRIPTION
368              "This object represents the number of Nak packets"
369	::= { cLDhcpStatsShowEntry  10 }
370
371cLDhcpTxFailures   OBJECT-TYPE
372  	SYNTAX          Counter32
373  	MAX-ACCESS      read-only
374  	STATUS          current
375  	DESCRIPTION
376	       "This object represents the number of transmission
377	        failures."
378	::= { cLDhcpStatsShowEntry  11 }
379
380cLDhcpLastRspTime   OBJECT-TYPE
381	SYNTAX          TimeStamp
382	UNITS           "seconds"
383	MAX-ACCESS      read-only
384	STATUS          current
385	DESCRIPTION
386         	"This object represents the time at which the last
387		 DHCP response was received by the controller."
388       ::= { cLDhcpStatsShowEntry  12 }
389
390cLDhcpLastReqTime   OBJECT-TYPE
391        SYNTAX          TimeStamp
392        UNITS           "seconds"
393        MAX-ACCESS      read-only
394        STATUS          current
395        DESCRIPTION
396               "This object represents the time at which the last
397                DHCP requset was sent by the controller."
398	::= { cLDhcpStatsShowEntry  13 }
399
400END
401