1-- *******************************************************************
2-- CISCO-LWAPP-DOT11-CLIENT-TS-MIB.my:
3-- Wireless Client Trouble Shooting
4--
5-- March 2007, Ambika Prasad Mohanty
6--
7-- Copyright (c) 2007, 2011-2012 by Cisco Systems Inc.
8-- All rights reserved.
9-- *******************************************************************
10
11CISCO-LWAPP-DOT11-CLIENT-TS-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    MODULE-IDENTITY,
15    OBJECT-TYPE,
16    Unsigned32
17        FROM SNMPv2-SMI
18    MODULE-COMPLIANCE,
19    OBJECT-GROUP
20        FROM SNMPv2-CONF
21    RowStatus,
22    TruthValue,
23    TimeStamp
24        FROM SNMPv2-TC
25    SnmpAdminString
26        FROM SNMP-FRAMEWORK-MIB
27    cldcClientMacAddress
28        FROM CISCO-LWAPP-DOT11-CLIENT-MIB
29    ciscoMgmt
30        FROM CISCO-SMI;
31
32
33ciscoLwappDot11ClientTsMIB MODULE-IDENTITY
34    LAST-UPDATED    "201206110000Z"
35    ORGANIZATION    "Cisco Systems Inc."
36    CONTACT-INFO
37            "Cisco Systems,
38            Customer Service
39            Postal: 170 West Tasman Drive
40            San Jose, CA  95134
41            USA
42            Tel: +1 800 553-NETS
43
44            Email: cs-wnbu-snmp@cisco.com"
45    DESCRIPTION
46        "This MIB is intended to be implemented on all those
47        devices operating as Central controllers, that
48        terminate the Light Weight Access Point Protocol
49        tunnel from Cisco Light-weight LWAPP Access Points.
50
51        This MIB provides information about troubleshooting 802.11
52        clients during their association with the controller.
53        The clients that need to be monitored are added by the
54        controller to a watchlist. Once added the controller
55        will start storing the messages related to that client.
56        These messages are useful to troubleshoot the reasons
57        for failures during assoication.
58
59        The relationship between CC and the LWAPP APs
60        can be depicted as follows:
61
62        +......+     +......+     +......+           +......+
63        +      +     +      +     +      +           +      +
64        +  CC  +     +  CC  +     +  CC  +           +  CC  +
65        +      +     +      +     +      +           +      +
66        +......+     +......+     +......+           +......+
67        ..            .             .                 .
68        ..            .             .                 .
69        .  .            .             .                 .
70        .    .            .             .                 .
71        .      .            .             .                 .
72        .        .            .             .                 .
73        +......+ +......+     +......+      +......+          +......+
74        +      + +      +     +      +      +      +          +      +
75        +  AP  + +  AP  +     +  AP  +      +  AP  +          +  AP  +
76        +      + +      +     +      +      +      +          +      +
77        +......+ +......+     +......+      +......+          +......+
78        .              .             .                 .
79        .  .              .             .                 .
80        .    .              .             .                 .
81        .      .              .             .                 .
82        .        .              .             .                 .
83        +......+ +......+     +......+      +......+          +......+
84        +      + +      +     +      +      +      +          +      +
85        +  MN  + +  MN  +     +  MN  +      +  MN  +          +  MN  +
86        +      + +      +     +      +      +      +          +      +
87        +......+ +......+     +......+      +......+          +......+
88
89
90        The LWAPP tunnel exists between the controller and
91        the APs.  The MNs communicate with the APs through
92        the protocol defined by the 802.11 standard.
93
94        LWAPP APs, upon bootup, discover and join one of the
95        controllers and the controller pushes the configuration,
96        that includes the WLAN parameters, to the LWAPP APs.
97        The APs then encapsulate all the 802.11 frames from
98        wireless clients inside LWAPP frames and forward
99        the LWAPP frames to the controller.
100
101                           GLOSSARY
102
103        Access Point ( AP )
104
105        An entity that contains an 802.11 medium access
106        control ( MAC ) and physical layer ( PHY ) interface
107        and provides access to the distribution services via
108        the wireless medium for associated clients.
109
110        LWAPP APs encapsulate all the 802.11 frames in
111        LWAPP frames and sends them to the controller to which
112        it is logically connected.
113
114        Central Controller ( CC )
115
116        The central entity that terminates the LWAPP protocol
117        tunnel from the LWAPP APs.  Throughout this MIB,
118        this entity also referred to as 'controller'.
119
120        Cisco Compatible eXtensions (CCX)
121
122        Wireless LAN Access Points (APs) manufactured by Cisco
123        Systems have features and capabilities beyond those in
124        related standards (e.g., IEEE 802.11 suite of
125        standards, Wi-Fi recommendations by WECA, 802.1X
126        security suite, etc). A number of features provide
127        higher performance. For example, Cisco AP transmits a
128        specific Information Element, which the clients adapt
129        to for enhanced performance. Similarly, a number of
130        features are implemented by means of proprietary
131        Information Elements, which Cisco clients use in
132        specific ways to carry out tasks above and beyond the
133        standard. Other examples of feature categories are
134        roaming and power saving.
135
136        Light Weight Access Point Protocol ( LWAPP )
137
138        This is a generic protocol that defines the
139        communication between the Access Points and the
140        Central Controller.
141
142        Mobile Node ( MN )
143
144        A roaming 802.11 wireless device in a wireless
145        network associated with an access point.  The terms
146        'Mobile node' and 'client' are used interchangeably.
147
148        Radio Management (RM)
149
150        This term refers to managing the 802.11 radio
151        environment to provide the best quality service to
152        to the 802.11 wireless clients.
153
154        Service Set Identifier ( SSID )
155
156        SSID is a unique identifier that APs and clients
157        use to identify with each other.  SSID is a simple
158        means of access control and is not for security.
159        The SSID can be any alphanumeric entry up to 32
160        characters.
161
162        REFERENCE
163
164        [1] Wireless LAN Medium Access Control ( MAC ) and
165        Physical Layer ( PHY ) Specifications
166
167        [2] Draft-obara-capwap-lwapp-00.txt, IETF Light
168        Weight Access Point Protocol"
169    REVISION        "201206110000Z"
170    DESCRIPTION
171        "Added new bit mobility to cldctWatchListModuleList
172        and cldctClientInfoModule."
173    REVISION        "201201250000Z"
174    DESCRIPTION
175        "Added the following new object to cldctClientInfoTable.
176        cldctClientInfoMessageType and cldctClientInfoMessageSubType
177
178        Added two new bits voiceQoS and misc to
179        cldctWatchListModuleList and cldctClientInfoModule.
180
181        Added a new supplement group
182        ciscoLwappDot11ClientTsStatusSupGroupRev1.
183
184        Added new compliance ciscoLwappDot11ClientTsMIBComplianceRev1
185        which deprecates ciscoLwappDot11ClientTsMIBCompliance."
186    REVISION        "200703080000Z"
187    DESCRIPTION
188        "Initial version of this MIB module."
189    ::= { ciscoMgmt 622 }
190
191
192ciscoLwappDot11ClientTsMIBNotifs  OBJECT IDENTIFIER
193    ::= { ciscoLwappDot11ClientTsMIB 0 }
194
195ciscoLwappDot11ClientTsMIBObjects  OBJECT IDENTIFIER
196    ::= { ciscoLwappDot11ClientTsMIB 1 }
197
198ciscoLwappDot11ClientTsMIBConfirm  OBJECT IDENTIFIER
199    ::= { ciscoLwappDot11ClientTsMIB 2 }
200
201cldctClientInfo  OBJECT IDENTIFIER
202    ::= { ciscoLwappDot11ClientTsMIBObjects 1 }
203
204cldctWatchList  OBJECT IDENTIFIER
205    ::= { ciscoLwappDot11ClientTsMIBObjects 2 }
206
207cldctLastPemStateInfo  OBJECT IDENTIFIER
208    ::= { ciscoLwappDot11ClientTsMIBObjects 3 }
209
210
211cldctWatchListTable OBJECT-TYPE
212    SYNTAX          SEQUENCE OF CldctWatchListEntry
213    MAX-ACCESS      not-accessible
214    STATUS          current
215    DESCRIPTION
216        "This table represents the clients which are being monitored by
217        the controller during association.
218        The types of clients that can be monitored are CCX, non-CCX
219        and WGB clients.
220
221        Entries are created by explicit management action by the
222        user.
223
224        A row is created by specifying the cldctWatchListModuleList,
225         cldctWatchListTimeRemaining and cldcClientMacAddress with the
226        'RowStatus' changed to createAndGo.
227        This indicates that the request is made to start storing the
228        the messages on the controller for the client identified by
229        cldcClientMacAddress.
230
231        The added row is deleted by setting the corresponding
232        instance of the RowStatus object to 'destroy'. In
233        case if the agent finds that the time duration
234        represented by cldctWatchListTimeRemaining has elapsed since
235        the addtion of the client to the watchlist, it proceeds to
236        delete the row automatically, if the row exists at that point
237        of time.
238        The messages stored on the controller can be obtained
239        from cldctClientInfoTable."
240    ::= { cldctWatchList 1 }
241
242cldctWatchListEntry OBJECT-TYPE
243    SYNTAX          CldctWatchListEntry
244    MAX-ACCESS      not-accessible
245    STATUS          current
246    DESCRIPTION
247        "Each entry in this table represents one instance
248        of the client troubleshooting initiated by the user
249        through a network manager."
250    INDEX           { cldcClientMacAddress }
251    ::= { cldctWatchListTable 1 }
252
253CldctWatchListEntry ::= SEQUENCE {
254        cldctWatchListModuleList    BITS,
255        cldctWatchListTimeRemaining Unsigned32,
256        cldctWatchListRowStatus     RowStatus
257}
258
259cldctWatchListModuleList OBJECT-TYPE
260    SYNTAX          BITS {
261                        dot11(0),
262                        dot1x(1),
263                        pem(2),
264                        dhcp(3),
265                        aaa(4),
266                        voiceQoS(5),
267                        misc(6),
268                        mobility(7)
269                    }
270    MAX-ACCESS      read-create
271    STATUS          current
272    DESCRIPTION
273        "This object is used to specify the list of modules per
274        client whose messages will be stored by the controller.
275        Any combination of the modules can be set.
276
277        'dot11' - This value represents the module in controller
278                  responsible for handling the 802.11 messages.
279
280        'dot1x' - This value represents the module responsible
281                  for handling the extensible authentication protocol
282                  related messages.
283
284        'pem'  -  This value represents the module responsible for
285                  handling the policy enforcement module.
286
287        'dhcp' -  This value represents the module responsible for
288                  handling dhcp related messages.
289
290        'aaa'  -  This value represents the module responsible for
291                  handling radius related messages.
292
293        'voiceQoS'  -  This value represents the module responsible for
294                  handling voice/Qos module related messages.
295
296        'misc' - This value represents the module responsible for
297                 handling miscellaneous module messages
298                 (eg: roam history).
299
300        'mobility'  -  This value represents the module responsible for
301                  handling mobility related messages."
302    ::= { cldctWatchListEntry 1 }
303
304cldctWatchListTimeRemaining OBJECT-TYPE
305    SYNTAX          Unsigned32 (5..1000)
306    UNITS           "minutes"
307    MAX-ACCESS      read-create
308    STATUS          current
309    DESCRIPTION
310        "This object is used to specify the time after which
311        the client will be automatically removed from the
312        watchlist."
313    DEFVAL          { 10 }
314    ::= { cldctWatchListEntry 2 }
315
316cldctWatchListRowStatus OBJECT-TYPE
317    SYNTAX          RowStatus
318    MAX-ACCESS      read-create
319    STATUS          current
320    DESCRIPTION
321        "This object represents the status of a row and
322        is used to create and delete specific instances
323        of rows in this table."
324    ::= { cldctWatchListEntry 3 }
325
326
327-- ******************************************************************
328-- Client Debug Logs
329-- ******************************************************************
330
331cldctClientInfoTable OBJECT-TYPE
332    SYNTAX          SEQUENCE OF CldctClientInfoEntry
333    MAX-ACCESS      not-accessible
334    STATUS          current
335    DESCRIPTION
336        "Ths table populates the messages generated during client's
337        association with the controller.
338        Entries are automatically addded by the controller
339        when the client for the cldctWatchListTable associates
340        with the controller.
341        Each row represents a message generated on the
342        controller for the client on the watch list.
343        Entries are automatically removed by the controller
344        when the client is removed from the watchlist.
345        The number of message per client is limited to the number
346        specified by the cldctClientInfoMaxEntries object. When
347        the maximum number of entries is reached the older entries
348        will be deleted."
349    ::= { cldctClientInfo 1 }
350
351cldctClientInfoEntry OBJECT-TYPE
352    SYNTAX          CldctClientInfoEntry
353    MAX-ACCESS      not-accessible
354    STATUS          current
355    DESCRIPTION
356        "Each entry in this table represents the messages
357        generated on the controller during the client's
358        association with it."
359    INDEX           {
360                        cldcClientMacAddress,
361                        cldctClientInfoIndex
362                    }
363    ::= { cldctClientInfoTable 1 }
364
365CldctClientInfoEntry ::= SEQUENCE {
366        cldctClientInfoIndex          Unsigned32,
367        cldctClientInfoGeneratedTime  TimeStamp,
368        cldctClientInfoLevel          INTEGER,
369        cldctClientInfoSeverity       INTEGER,
370        cldctClientInfoModule         INTEGER,
371        cldctClientInfoResultCode     TruthValue,
372        cldctClientInfoMsgString      OCTET STRING,
373        cldctClientInfoMessageType    Unsigned32,
374        cldctClientInfoMessageSubType Unsigned32
375}
376
377cldctClientInfoIndex OBJECT-TYPE
378    SYNTAX          Unsigned32 (1..4294967295)
379    MAX-ACCESS      not-accessible
380    STATUS          current
381    DESCRIPTION
382        "This object uniquely identifies the sequence number of
383        the message for a watch listed client."
384    ::= { cldctClientInfoEntry 1 }
385
386cldctClientInfoGeneratedTime OBJECT-TYPE
387    SYNTAX          TimeStamp
388    MAX-ACCESS      read-only
389    STATUS          current
390    DESCRIPTION
391        "This object represents the absolute time when entry
392        was added to table."
393    ::= { cldctClientInfoEntry 2 }
394
395cldctClientInfoLevel OBJECT-TYPE
396    SYNTAX          INTEGER  {
397                        phase(1),
398                        state(2),
399                        normal(3)
400                    }
401    MAX-ACCESS      read-only
402    STATUS          current
403    DESCRIPTION
404        "This object indicates the types of messages generated
405        by the watch listed client.
406
407        There can be three types of messages.
408
409        'phase' - This value represents phase transition of a
410                 wireless client. The various phases include
411                 802.11, 8021x, dhcp etc.
412
413        'state' - This value represents a state transition of a
414                 wireless client. The states could be association
415                 request, authentication request etc. for 802.11
416                 phase.
417
418        'normal' - This value represents an informational message
419                  generated during 802.11 client's association to
420                  the controller."
421    ::= { cldctClientInfoEntry 3 }
422
423cldctClientInfoSeverity OBJECT-TYPE
424    SYNTAX          INTEGER  {
425                        info(1),
426                        error(2),
427                        critical(3)
428                    }
429    MAX-ACCESS      read-only
430    STATUS          current
431    DESCRIPTION
432        "This object indicates severity of the information of
433        the client trouble shooting messages. This object holds
434        good only if the corresponding cldctClientInfoLevel is set
435        to 'normal'.
436
437        'info' -  This is an information message.
438
439        'error' - This is an error message.
440
441        'critical' - This is a critical message."
442    ::= { cldctClientInfoEntry 4 }
443
444cldctClientInfoModule OBJECT-TYPE
445    SYNTAX          INTEGER  {
446                        dot11(1),
447                        dot1x(2),
448                        pem(3),
449                        dhcp(4),
450                        aaa(5),
451                        voiceQoS(6),
452                        misc(7),
453                        mobility(8)
454                    }
455    MAX-ACCESS      read-only
456    STATUS          current
457    DESCRIPTION
458        "This object indicates the module which
459        generated the message.
460
461        'dot11' - This value represents the module in controller
462                  responsible for handling the 802.11 messages.
463
464        'dot1x' - This value represents the module responsible for
465                  handling the extensible authentication protocol.
466
467        'pem'   - This value represents the module responsible for
468                  handling the policy enforcement module.
469
470        'dhcp'  - This value represents the module responsible for
471                  handling dhcp related messages.
472
473        'aaa'   - This value represents the module responsible for
474                  handling radius related messages.
475
476        'voiceQoS'  -  This value represents the module responsible for
477                  handling voice/Qos module related messages.
478
479        'misc' - This value represents the module responsible for
480                 handling miscellaneous module messages.
481                 (eg: roam history).
482
483        'mobility'  - This value represents the module responsible for
484                  handling mobility related messages."
485    ::= { cldctClientInfoEntry 5 }
486
487cldctClientInfoResultCode OBJECT-TYPE
488    SYNTAX          TruthValue
489    MAX-ACCESS      read-only
490    STATUS          current
491    DESCRIPTION
492        "This object indicates if this message is an
493        informational message or an error message.
494        This object holds good only if the corresponding
495        cldctClientInfoLevel object has a value of
496        'phase' or 'state'.
497        A value of true indicates that this message is an
498        informational message.
499        A value of false indicates that this message is an
500        error message."
501    ::= { cldctClientInfoEntry 6 }
502
503cldctClientInfoMsgString OBJECT-TYPE
504    SYNTAX          OCTET STRING (SIZE  (0..255))
505    MAX-ACCESS      read-only
506    STATUS          current
507    DESCRIPTION
508        "This object represents the variable part of the
509        message generated by the controller for this client.
510        For example if the message to be shown to the user is
511        'Client got ip address 10.52.43.54', the '10.52.43.54'
512        is a variable part which will be different for different
513        clients."
514    ::= { cldctClientInfoEntry 7 }
515
516cldctClientInfoMessageType OBJECT-TYPE
517    SYNTAX          Unsigned32 (0..255)
518    MAX-ACCESS      read-only
519    STATUS          current
520    DESCRIPTION
521        "This object represents the type of the
522        messsage generated by the controller for this client."
523    ::= { cldctClientInfoEntry 8 }
524
525cldctClientInfoMessageSubType OBJECT-TYPE
526    SYNTAX          Unsigned32 (0..255)
527    MAX-ACCESS      read-only
528    STATUS          current
529    DESCRIPTION
530        "This objects represents sub-type of the
531        messsage generated by the controller for this client."
532    ::= { cldctClientInfoEntry 9 }
533
534
535
536cldctClientInfoMaxEntries OBJECT-TYPE
537    SYNTAX          Unsigned32
538    MAX-ACCESS      read-write
539    STATUS          current
540    DESCRIPTION
541        "This object represents the maximum number of
542        entries per client(cldcClientMacAddress) in the
543        cldctClientInfoTable."
544    DEFVAL          { 2000 }
545    ::= { cldctClientInfo 2 }
546
547cldctLastPemStateTable OBJECT-TYPE
548    SYNTAX          SEQUENCE OF CldctLastPemStateEntry
549    MAX-ACCESS      not-accessible
550    STATUS          current
551    DESCRIPTION
552        "This table stores the last policy enforcement
553        state of client in the controller. The state here is
554        represented as a string. For example the state can be
555        'RUN','WEBAUTH_REQUIRED' etc.
556        Entries are automaticaly added to this table when a
557        802.11 client associates to a controller.
558        Entries in this table are automaticaly deleted by
559        the controller when the 802.11 client disassociates
560        from the controller."
561    ::= { cldctLastPemStateInfo 1 }
562
563cldctLastPemStateEntry OBJECT-TYPE
564    SYNTAX          CldctLastPemStateEntry
565    MAX-ACCESS      not-accessible
566    STATUS          current
567    DESCRIPTION
568        "Each entry represents a conceptual row in this table.
569        An entry represents the last PEM state report by a wireless
570        client."
571    INDEX           { cldcClientMacAddress }
572    ::= { cldctLastPemStateTable 1 }
573
574CldctLastPemStateEntry ::= SEQUENCE {
575        cldctLastPemState SnmpAdminString
576}
577
578cldctLastPemState OBJECT-TYPE
579    SYNTAX          SnmpAdminString
580    MAX-ACCESS      read-only
581    STATUS          current
582    DESCRIPTION
583        "This object represents the last policy enforcement
584        manager state of the client in controller."
585    ::= { cldctLastPemStateEntry 1 }
586
587
588-- *******************************************************************
589-- *    Compliance statements
590-- *******************************************************************
591
592ciscoLwappDot11ClientTsMIBCompliances  OBJECT IDENTIFIER
593    ::= { ciscoLwappDot11ClientTsMIBConfirm 1 }
594
595ciscoLwappDot11ClientTsMIBGroups  OBJECT IDENTIFIER
596    ::= { ciscoLwappDot11ClientTsMIBConfirm 2 }
597
598
599ciscoLwappDot11ClientTsMIBCompliance MODULE-COMPLIANCE
600    STATUS          deprecated
601    DESCRIPTION
602        "The compliance statement for the SNMP entities that
603        implement the ciscoLwappDot11ClientTsMIB module."
604    MODULE          -- this module
605    MANDATORY-GROUPS {
606                        ciscoLwappDot11ClientTsConfigGroup,
607                        ciscoLwappDot11ClientTsStatusGroup
608                    }
609    ::= { ciscoLwappDot11ClientTsMIBCompliances 1 }
610
611ciscoLwappDot11ClientTsMIBComplianceRev1 MODULE-COMPLIANCE
612    STATUS          current
613    DESCRIPTION
614        "The compliance statement for the SNMP entities that
615        implement the ciscoLwappDot11ClientTsMIB module."
616    MODULE          -- this module
617    MANDATORY-GROUPS {
618                        ciscoLwappDot11ClientTsConfigGroup,
619                        ciscoLwappDot11ClientTsStatusGroup,
620                        ciscoLwappDot11ClientTsStatusSupGroupRev1
621                    }
622    ::= { ciscoLwappDot11ClientTsMIBCompliances 2 }
623
624-- *******************************************************************
625-- *    Units of conformance
626-- *******************************************************************
627
628ciscoLwappDot11ClientTsConfigGroup OBJECT-GROUP
629    OBJECTS         {
630                        cldctWatchListModuleList,
631                        cldctWatchListTimeRemaining
632                    }
633    STATUS          current
634    DESCRIPTION
635        "This is a collection of objects which can
636        be configured per 802.11 clients for the
637        controller to start monitoring them."
638    ::= { ciscoLwappDot11ClientTsMIBGroups 1 }
639
640ciscoLwappDot11ClientTsStatusGroup OBJECT-GROUP
641    OBJECTS         {
642                        cldctClientInfoGeneratedTime,
643                        cldctClientInfoLevel,
644                        cldctClientInfoSeverity,
645                        cldctClientInfoModule,
646                        cldctClientInfoResultCode,
647                        cldctClientInfoMsgString,
648                        cldctWatchListRowStatus,
649                        cldctClientInfoMaxEntries,
650                        cldctLastPemState
651                    }
652    STATUS          current
653    DESCRIPTION
654        "This is a collection of objects which represent
655        the information of various watch listed
656        clients present on the controller. The information
657        includes the various states and phases that the client
658        goes through while getting associated with the
659        controller."
660    ::= { ciscoLwappDot11ClientTsMIBGroups 2 }
661
662ciscoLwappDot11ClientTsStatusSupGroupRev1 OBJECT-GROUP
663    OBJECTS         {
664                        cldctClientInfoMessageType,
665                        cldctClientInfoMessageSubType
666                    }
667    STATUS          current
668    DESCRIPTION
669        "This is a collection of objects which represent
670        the information on the types and sub-types of
671        messages generated by the controller for the clients."
672    ::= { ciscoLwappDot11ClientTsMIBGroups 3 }
673
674END
675
676
677
678