1-- *******************************************************************
2-- CISCO-LWAPP-DOWNLOAD-MIB.my
3-- May 2008, Koteswara Rao Vemulapati
4-- Copyright (c) 2008-2015, 2017 by Cisco Systems Inc.
5-- All rights reserved.
6-- *******************************************************************
7
8CISCO-LWAPP-DOWNLOAD-MIB DEFINITIONS ::= BEGIN
9
10IMPORTS
11    MODULE-IDENTITY,
12    OBJECT-TYPE,
13    Unsigned32,
14    NOTIFICATION-TYPE
15        FROM SNMPv2-SMI
16    MODULE-COMPLIANCE,
17    OBJECT-GROUP,
18    NOTIFICATION-GROUP
19        FROM SNMPv2-CONF
20    TruthValue,
21    RowStatus,
22    DateAndTime,
23    TimeInterval
24        FROM SNMPv2-TC
25    SnmpAdminString
26        FROM SNMP-FRAMEWORK-MIB
27    ciscoLwappApMIB,
28    cLApSysMacAddress
29        FROM CISCO-LWAPP-AP-MIB;
30
31
32-- ********************************************************************
33-- *  MODULE IDENTITY
34-- ********************************************************************
35
36ciscoLwappDownloadMIB MODULE-IDENTITY
37    LAST-UPDATED    "201705230000Z"
38    ORGANIZATION    "Cisco Systems Inc."
39    CONTACT-INFO
40            "Cisco Systems,
41            Customer Service
42            Postal: 170 West Tasman Drive
43            San Jose, CA  95134
44            USA
45            Tel: +1 800 553-NETS
46
47            Email: cs-wnbu-snmp@cisco.com"
48    DESCRIPTION
49        "This MIB is intended to be implemented on all those
50        devices operating as Central controllers, that
51        terminate the Light Weight Access Point Protocol
52        tunnel from Cisco Light-weight LWAPP Access Points.
53
54        The relationship between the controller and the LWAPP
55        APs is depicted as follows:
56
57        +......+     +......+     +......+           +......+
58        +      +     +      +     +      +           +      +
59        +  CC  +     +  CC  +     +  CC  +           +  CC  +
60        +      +     +      +     +      +           +      +
61        +......+     +......+     +......+           +......+
62        ..            .             .                 .
63        ..            .             .                 .
64        .  .            .             .                 .
65        .    .            .             .                 .
66        .      .            .             .                 .
67        .        .            .             .                 .
68        +......+ +......+     +......+      +......+          +......+
69        +      + +      +     +      +      +      +          +      +
70        +  AP  + +  AP  +     +  AP  +      +  AP  +          +  AP  +
71        +      + +      +     +      +      +      +          +      +
72        +......+ +......+     +......+      +......+          +......+
73        .              .             .                 .
74        .  .              .             .                 .
75        .    .              .             .                 .
76        .      .              .             .                 .
77        .        .              .             .                 .
78        +......+ +......+     +......+      +......+          +......+
79        +      + +      +     +      +      +      +          +      +
80        +  MN  + +  MN  +     +  MN  +      +  MN  +          +  MN  +
81        +      + +      +     +      +      +      +          +      +
82        +......+ +......+     +......+      +......+          +......+
83
84
85                           GLOSSARY
86
87        Access Point ( AP )
88
89        An entity that contains an 802.11 medium access
90        control ( MAC ) and physical layer ( PHY ) interface
91        and provides access to the distribution services via
92        the wireless medium for associated clients.
93
94        LWAPP APs encapsulate all the 802.11 frames in
95        LWAPP frames and sends it to the controller to which
96        it is logically connected.
97
98        Wireless LAN Controller (WLC)
99
100        Wireless LAN Controller are legacy mobility device which
101        can participate in the new mobility architecture.
102
103        Central Controller ( CC )
104
105        The central entity that terminates the LWAPP protocol
106        tunnel from the LWAPP APs.  Throughout this MIB,
107        this entity also referred to as 'controller'.
108
109        Light Weight Access Point Protocol ( LWAPP )
110
111        This is a generic protocol that defines the
112        communication between the Access Points and the
113        controllers.
114
115        Mobile Node ( MN )
116
117        A roaming 802.11 wireless device in a wireless
118        network associated with an access point.
119
120
121
122        REFERENCE
123
124        [1] Wireless LAN Medium Access Control ( MAC ) and
125        Physical Layer ( PHY ) Specifications.
126
127        [2] Draft-obara-capwap-lwapp-00.txt, IETF Light
128        Weight Access Point Protocol"
129    REVISION        "201705230000Z"
130    DESCRIPTION
131        "Initial version of this MIB module."
132    ::= { ciscoLwappApMIB 4 }
133
134
135ciscoLwappDownloadMIBNotifs  OBJECT IDENTIFIER
136    ::= { ciscoLwappDownloadMIB 0 }
137
138ciscoLwappDownloadMIBObjects  OBJECT IDENTIFIER
139    ::= { ciscoLwappDownloadMIB 1 }
140
141ciscoLwappDownloadMIBConform  OBJECT IDENTIFIER
142    ::= { ciscoLwappDownloadMIB 2 }
143
144ciscoLwappDLApBoot  OBJECT IDENTIFIER
145    ::= { ciscoLwappDownloadMIBObjects 1 }
146
147ciscoLwappDLReset  OBJECT IDENTIFIER
148    ::= { ciscoLwappDownloadMIBObjects 2 }
149
150ciscoLwappDLRestart  OBJECT IDENTIFIER
151    ::= { ciscoLwappDownloadMIBObjects 3 }
152
153-- ********************************************************************
154-- *    AP Boot Information.
155-- ********************************************************************
156
157clDLApBootTable OBJECT-TYPE
158    SYNTAX          SEQUENCE OF CLDLApBootEntry
159    MAX-ACCESS      not-accessible
160    STATUS          current
161    DESCRIPTION
162        "This table represents the primary and backup software
163        image loaded on an AP.
164        An entry in this table gets added when a AP associates
165        to the controller and entry gets removed when AP
166        disassociates from the controller."
167    ::= { ciscoLwappDLApBoot 1 }
168
169cldlApBootEntry OBJECT-TYPE
170    SYNTAX          CLDLApBootEntry
171    MAX-ACCESS      not-accessible
172    STATUS          current
173    DESCRIPTION
174        "Each (conceptual) entry in this table represents version
175        information for a AP."
176    INDEX           { cLApSysMacAddress }
177    ::= { clDLApBootTable 1 }
178
179CLDLApBootEntry ::= SEQUENCE {
180        cldlAPName                      SnmpAdminString,
181        cldlAPPrimaryVersion            SnmpAdminString,
182        cldlAPBackupVersion             SnmpAdminString,
183        cldlAPSwapImage                 TruthValue,
184        cldlAPDownloadImage             INTEGER,
185        cldlPreDownloadVersion          SnmpAdminString,
186        cldlPreDownloadStatus           INTEGER,
187        cldlPreDownloadNextRetryTime    TimeInterval,
188        cldlPreDownloadRetryCount       Unsigned32,
189        cldlPredownloadImageUpgradeRole INTEGER,
190        cldlAPSoftwareName              SnmpAdminString
191}
192
193cldlAPName OBJECT-TYPE
194    SYNTAX          SnmpAdminString
195    MAX-ACCESS      read-only
196    STATUS          current
197    DESCRIPTION
198        "This object represents the name of the AP."
199    ::= { cldlApBootEntry 1 }
200
201cldlAPPrimaryVersion OBJECT-TYPE
202    SYNTAX          SnmpAdminString
203    MAX-ACCESS      read-only
204    STATUS          current
205    DESCRIPTION
206        "This object represents the AP primary image version."
207    ::= { cldlApBootEntry 2 }
208
209cldlAPBackupVersion OBJECT-TYPE
210    SYNTAX          SnmpAdminString
211    MAX-ACCESS      read-only
212    STATUS          current
213    DESCRIPTION
214        "This object represents the AP backup image version."
215    ::= { cldlApBootEntry 3 }
216
217cldlAPSwapImage OBJECT-TYPE
218    SYNTAX          TruthValue
219    MAX-ACCESS      read-write
220    STATUS          current
221    DESCRIPTION
222        "This object specifies the action to swap the primary and
223        backup images of the Access Point (AP).
224        The value of 'true' indicates that, primary and backup
225        images will be swapped.
226        The value of 'false' indicates that, no action is taken."
227    DEFVAL          { false }
228    ::= { cldlApBootEntry 4 }
229
230cldlAPDownloadImage OBJECT-TYPE
231    SYNTAX          INTEGER  {
232                        primary(1),
233                        backup(2),
234                        abort(3)
235                    }
236    MAX-ACCESS      read-write
237    STATUS          current
238    DESCRIPTION
239        "This object specifies configuration of the image
240        type while downloading from WLC to Access Point(AP).
241        A value of primary indicates that, primary image
242        is downloaded from the controller.
243        A value of backup indicates that, backup image
244        is downloaded from the controller.
245        A value of abort indicates that, active predownload
246        of the image aborts on the controller."
247    DEFVAL          { backup }
248    ::= { cldlApBootEntry 5 }
249
250cldlPreDownloadVersion OBJECT-TYPE
251    SYNTAX          SnmpAdminString
252    MAX-ACCESS      read-only
253    STATUS          current
254    DESCRIPTION
255        "This object represents the AP predownloaded version."
256    ::= { cldlApBootEntry 6 }
257
258cldlPreDownloadStatus OBJECT-TYPE
259    SYNTAX          INTEGER  {
260                        none(1),
261                        intiated(2),
262                        preDownloading(3),
263                        completed(4),
264                        failed(5),
265                        notSupported(6)
266                    }
267    MAX-ACCESS      read-only
268    STATUS          current
269    DESCRIPTION
270        "This object represents the status of the
271        predownloaded image of the AP.
272        A value of none(1) indicates that, nothing is
273        predownloading.
274        A value of intiated(2) indicates that, predownload
275        initiated.
276        A value of preDownloading(3) indicates that,
277        predownload started.
278        A value of completed(4) indicates that,
279        predownload completed.
280        A value of failed(5) indicates that,
281        predownload failed.
282        A value of notSupported(6) indicates that,
283        predownload not supported."
284    DEFVAL          { none }
285    ::= { cldlApBootEntry 7 }
286
287cldlPreDownloadNextRetryTime OBJECT-TYPE
288    SYNTAX          TimeInterval
289    UNITS           "seconds"
290    MAX-ACCESS      read-only
291    STATUS          current
292    DESCRIPTION
293        "This object represents the next retry time for
294        downloading the AP image from the WLC."
295    ::= { cldlApBootEntry 8 }
296
297cldlPreDownloadRetryCount OBJECT-TYPE
298    SYNTAX          Unsigned32
299    MAX-ACCESS      read-only
300    STATUS          current
301    DESCRIPTION
302        "This object represents the number of retry count
303        before the AP image downloaded from the WLC."
304    ::= { cldlApBootEntry 9 }
305
306cldlPredownloadImageUpgradeRole OBJECT-TYPE
307    SYNTAX          INTEGER  {
308                        masterCentral(1),
309                        masterLocal(2),
310                        slaveCentral(3),
311                        slaveLocal(4),
312                        unknown(5)
313                    }
314    MAX-ACCESS      read-only
315    STATUS          current
316    DESCRIPTION
317        "This object represents the efficient AP image upgrade role
318        for the AP.To save time during AP pre-image downloading,
319        one AP of same AP type can be configured as master which
320        will first download image from controller and then slaves
321        in that group will start downloading image from master.
322        A value of masterCentral indicates that, master AP
323        downloading image from controller.
324        A value of masterLocal indicates that, master AP
325        downloading image from another master.
326        A value of slaveCentral indicates that, slave AP
327        downloading image from controller.
328        A value of slaveLocal indicates that, slave AP
329        downloading image from master.
330        A value of unknown indicates that, nothing is
331        getting downloaded."
332    DEFVAL          { unknown }
333    ::= { cldlApBootEntry 10 }
334
335cldlAPSoftwareName OBJECT-TYPE
336    SYNTAX          SnmpAdminString
337    MAX-ACCESS      read-only
338    STATUS          current
339    DESCRIPTION
340        "This object represents the software name of the AP."
341    ::= { cldlApBootEntry 11 }
342
343
344-- ********************************************************************
345-- *    Controller Restart Options.
346-- ********************************************************************
347
348clDLRestartTable OBJECT-TYPE
349    SYNTAX          SEQUENCE OF CLDLRestartEntry
350    MAX-ACCESS      not-accessible
351    STATUS          current
352    DESCRIPTION
353        "This table represents the restart schedule of the WLC.
354        Restart is a quick reset method. User restarts WLC by
355        adding a row to this table through explicit management
356        action from the network manager."
357    ::= { ciscoLwappDLRestart 1 }
358
359cldlRestartEntry OBJECT-TYPE
360    SYNTAX          CLDLRestartEntry
361    MAX-ACCESS      not-accessible
362    STATUS          current
363    DESCRIPTION
364        "Each (conceptual) entry in this table represents
365        the information about WLC restart."
366    INDEX           { cldlRestartIndex }
367    ::= { clDLRestartTable 1 }
368
369CLDLRestartEntry ::= SEQUENCE {
370        cldlRestartIndex       Unsigned32,
371        cldlRestartDateAndTime DateAndTime,
372        cldlRestartAP          TruthValue,
373        cldlRestartRowStatus   RowStatus,
374        cldlRestartSaveConfig  TruthValue,
375        cldlRestartAlertTime   Unsigned32
376}
377
378cldlRestartIndex OBJECT-TYPE
379    SYNTAX          Unsigned32
380    MAX-ACCESS      not-accessible
381    STATUS          current
382    DESCRIPTION
383        "This object represents unique instance of
384        scheduled restart vector of the controller."
385    ::= { cldlRestartEntry 1 }
386
387cldlRestartDateAndTime OBJECT-TYPE
388    SYNTAX          DateAndTime
389    MAX-ACCESS      read-create
390    STATUS          current
391    DESCRIPTION
392        "This object specifies future restart schedule
393        time of the controller.
394        Format: MM/DD/YY:HH/MM/SS."
395    ::= { cldlRestartEntry 2 }
396
397cldlRestartAP OBJECT-TYPE
398    SYNTAX          TruthValue
399    MAX-ACCESS      read-create
400    STATUS          current
401    DESCRIPTION
402        "This object specifies to reset all the APs
403        associated to the controller..
404        The value of 'true' indicates that, all APs
405        will be reset.
406        The value of 'false' indicates that, all APs
407        will not be reset."
408    DEFVAL          { false }
409    ::= { cldlRestartEntry 3 }
410
411cldlRestartRowStatus OBJECT-TYPE
412    SYNTAX          RowStatus
413    MAX-ACCESS      read-create
414    STATUS          current
415    DESCRIPTION
416        "This is the status column for this row and is used to create
417        and delete specific instances of rows in this table."
418    ::= { cldlRestartEntry 4 }
419
420cldlRestartSaveConfig OBJECT-TYPE
421    SYNTAX          TruthValue
422    MAX-ACCESS      read-create
423    STATUS          current
424    DESCRIPTION
425        "This object specifies  whether to save the
426        configuration before rebooting the controller.
427        The value of 'true' indicates that, configuration
428        is saved and controller will be restarted.
429        The value of 'false' indicates that, controller
430        is restarted without saving the configuration."
431    DEFVAL          { true }
432    ::= { cldlRestartEntry 5 }
433
434cldlRestartAlertTime OBJECT-TYPE
435    SYNTAX          Unsigned32
436    UNITS           "seconds"
437    MAX-ACCESS      read-create
438    STATUS          current
439    DESCRIPTION
440        "This object specifies the number of seconds before
441        the scheduled restart at which the trap message will
442        be generated.
443        Trap will not be generated if schedule restart time is
444        less than the ResetAlert time."
445    ::= { cldlRestartEntry 6 }
446
447
448-- ********************************************************************
449-- *    Controller Reset Options.
450-- ********************************************************************
451
452clDLResetTable OBJECT-TYPE
453    SYNTAX          SEQUENCE OF CLDLResetEntry
454    MAX-ACCESS      not-accessible
455    STATUS          current
456    DESCRIPTION
457        "This table represents the resetting schedule
458        of the WLC. User resets WLC by adding a
459        row to this table through explicit management
460        action from the network manager."
461    ::= { ciscoLwappDLReset 1 }
462
463cldlResetEntry OBJECT-TYPE
464    SYNTAX          CLDLResetEntry
465    MAX-ACCESS      not-accessible
466    STATUS          current
467    DESCRIPTION
468        "Each(conceptual) entry in this table represents
469        the information about WLC reset."
470    INDEX           { cldlResetIndex }
471    ::= { clDLResetTable 1 }
472
473CLDLResetEntry ::= SEQUENCE {
474        cldlResetIndex       Unsigned32,
475        cldlResetDateAndTime DateAndTime,
476        cldlResetSwapImage   TruthValue,
477        cldlResetAP          TruthValue,
478        cldlResetRowStatus   RowStatus,
479        cldlResetSaveConfig  TruthValue,
480        cldlResetAlertTime   Unsigned32
481}
482
483cldlResetIndex OBJECT-TYPE
484    SYNTAX          Unsigned32
485    MAX-ACCESS      not-accessible
486    STATUS          current
487    DESCRIPTION
488        "This object represents unique instance of
489        scheduled reset vector of the controller."
490    ::= { cldlResetEntry 1 }
491
492cldlResetDateAndTime OBJECT-TYPE
493    SYNTAX          DateAndTime
494    MAX-ACCESS      read-create
495    STATUS          current
496    DESCRIPTION
497        "This object specifies to schedule the future
498        reset time of the controller.
499        Format: MM/DD/YY:HH/MM/SS."
500    ::= { cldlResetEntry 2 }
501
502cldlResetSwapImage OBJECT-TYPE
503    SYNTAX          TruthValue
504    MAX-ACCESS      read-create
505    STATUS          current
506    DESCRIPTION
507        "This object specifies whether swapping of
508        the primary and backup images needs to be
509        done after the WLC reset. On controller,
510        there are primary and backup images, by
511        default it will reboot with primary.
512        A value of 'true' indicates that, primary and backup
513        images need to be interchaged after the reset.
514        A value of 'false' indicates that, primary and backup
515        images are not interchanged after the reset."
516    DEFVAL          { false }
517    ::= { cldlResetEntry 3 }
518
519cldlResetAP OBJECT-TYPE
520    SYNTAX          TruthValue
521    MAX-ACCESS      read-create
522    STATUS          current
523    DESCRIPTION
524        "This object specifies whether to reset all the APs
525        associated to the controller during scheduled reset
526        of the controller.
527        The value of 'true' indicates that, resets all the APs.
528        The value of 'false'indicates that, do not resets
529        the APs."
530    DEFVAL          { false }
531    ::= { cldlResetEntry 4 }
532
533cldlResetRowStatus OBJECT-TYPE
534    SYNTAX          RowStatus
535    MAX-ACCESS      read-create
536    STATUS          current
537    DESCRIPTION
538        "This is the status column for this row and is used
539        to create and delete specific instances of rows in
540        this table."
541    ::= { cldlResetEntry 5 }
542
543cldlResetSaveConfig OBJECT-TYPE
544    SYNTAX          TruthValue
545    MAX-ACCESS      read-create
546    STATUS          current
547    DESCRIPTION
548        "This object specifies whether to save the configuration
549        before rebooting the controller or not.
550        The value of 'true' indicates that, save the configuration
551        and resets the controller.
552        The value of 'false' indicates that, resets the controller
553        without saving configuration."
554    DEFVAL          { true }
555    ::= { cldlResetEntry 6 }
556
557cldlResetAlertTime OBJECT-TYPE
558    SYNTAX          Unsigned32
559    UNITS           "seconds"
560    MAX-ACCESS      read-create
561    STATUS          current
562    DESCRIPTION
563        "This object specifies the number of seconds before
564        the scheduled reset at which the trap message will
565        be generated. if cldlResetDateAndTime is less than
566        cldlResetAlertTime, then the ciscoLwappScheduledResetNotif
567        notification will not be generated."
568    DEFVAL          { 0 }
569    ::= { cldlResetEntry 7 }
570
571
572
573cldlResetBootImage OBJECT-TYPE
574    SYNTAX          INTEGER  {
575                        primary(1),
576                        backup(2)
577                    }
578    MAX-ACCESS      read-write
579    STATUS          current
580    DESCRIPTION
581        "This object specifies image to be loaded
582        after reset.
583        A value of primary(1) indicates that, image
584        selected is primary.
585        A value of backup(2) indicates that, image
586        selected is secondary."
587    DEFVAL          { primary }
588    ::= { ciscoLwappDLReset 2 }
589
590-- ********************************************************************
591-- *  Notifications
592-- ********************************************************************
593
594cldlScheduledResetNotif NOTIFICATION-TYPE
595    OBJECTS         { cldlResetAlertTime }
596    STATUS          current
597    DESCRIPTION
598        "This notification is generated before the Wireless
599        LAN Controller (WLC) reset at time specified by the
600        variable, cldlResetAlertTime."
601   ::= { ciscoLwappDownloadMIBNotifs 1 }
602
603cldlResetFailedNotif NOTIFICATION-TYPE
604    STATUS          current
605    DESCRIPTION
606        "This notification is generated if controller failed to
607        scheduled reset."
608   ::= { ciscoLwappDownloadMIBNotifs 2 }
609
610cldlClearResetNotif NOTIFICATION-TYPE
611    STATUS          current
612    DESCRIPTION
613        "This notification is generated, when the reset entry is
614        deleted from the table cldlReasetTable."
615   ::= { ciscoLwappDownloadMIBNotifs 3 }
616-- ********************************************************************
617-- *    Compliance statements
618-- ********************************************************************
619
620cldlMIBCompliances  OBJECT IDENTIFIER
621    ::= { ciscoLwappDownloadMIBConform 1 }
622
623cldlMIBGroups  OBJECT IDENTIFIER
624    ::= { ciscoLwappDownloadMIBConform 2 }
625
626
627cldlMIBCompliance MODULE-COMPLIANCE
628    STATUS          current
629    DESCRIPTION
630        "The compliance statement for the SNMP entities that
631        implement the ciscoLwappDownloadMIB module."
632    MODULE          -- this module
633    MANDATORY-GROUPS {
634                        cldlApGroup,
635                        cldlResetGroup,
636                        cldlNotifsGroup,
637                        cldlRestartGroup
638                    }
639    ::= { cldlMIBCompliances 1 }
640
641-- *******************************************************************
642-- *    Units of conformance
643-- *******************************************************************
644
645cldlApGroup OBJECT-GROUP
646    OBJECTS         {
647                        cldlAPName,
648                        cldlAPPrimaryVersion,
649                        cldlAPBackupVersion,
650                        cldlAPSwapImage,
651                        cldlAPDownloadImage,
652                        cldlPreDownloadVersion,
653                        cldlPreDownloadStatus,
654                        cldlPreDownloadNextRetryTime,
655                        cldlPreDownloadRetryCount,
656                        cldlPredownloadImageUpgradeRole,
657                        cldlAPSoftwareName
658                    }
659    STATUS          current
660    DESCRIPTION
661        "This collection of objects represents the information
662        about the general attributes and functional
663        parameters of those APs that have joined the
664        controller."
665    ::= { cldlMIBGroups 1 }
666
667cldlResetGroup OBJECT-GROUP
668    OBJECTS         {
669                        cldlResetDateAndTime,
670                        cldlResetSwapImage,
671                        cldlResetAP,
672                        cldlResetRowStatus,
673                        cldlResetSaveConfig,
674                        cldlResetAlertTime,
675                        cldlResetDateAndTime,
676                        cldlResetSwapImage,
677                        cldlResetAP,
678                        cldlResetRowStatus,
679                        cldlResetSaveConfig,
680                        cldlResetBootImage
681                    }
682    STATUS          current
683    DESCRIPTION
684        "This collection of objects represents the information
685        about scheduled reset date and time of the controller."
686    ::= { cldlMIBGroups 2 }
687
688cldlRestartGroup OBJECT-GROUP
689    OBJECTS         {
690                        cldlRestartDateAndTime,
691                        cldlRestartAP,
692                        cldlRestartRowStatus,
693                        cldlRestartSaveConfig,
694                        cldlRestartAlertTime
695                    }
696    STATUS          current
697    DESCRIPTION
698        "This collection of objects represents the information
699        about restart date and time of the controller."
700    ::= { cldlMIBGroups 3 }
701
702cldlNotifsGroup NOTIFICATION-GROUP
703   NOTIFICATIONS    {
704                        cldlScheduledResetNotif,
705                        cldlResetFailedNotif,
706                        cldlClearResetNotif
707                    }
708    STATUS          current
709    DESCRIPTION
710        "This supplemental collection of objects represents the
711        shecduled reset related notifications sent by the agent
712        to a network management station."
713    ::= { cldlMIBGroups 4 }
714
715END
716
717
718
719