1-- *********************************************************************
2-- CISCO-IMAGE-UPGRADE-MIB.my: Cisco mib to upgrade images
3--
4-- June 2003, Srini Kode
5--
6-- Copyright (c) 2003 by cisco Systems, Inc.
7-- All rights reserved.
8--
9-- *********************************************************************
10
11CISCO-IMAGE-UPGRADE-MIB DEFINITIONS ::= BEGIN
12
13IMPORTS
14    OBJECT-TYPE,
15    MODULE-IDENTITY,
16    Unsigned32, Integer32,
17    NOTIFICATION-TYPE                      FROM SNMPv2-SMI
18    TruthValue,TimeStamp,RowStatus,
19    TEXTUAL-CONVENTION                     FROM SNMPv2-TC
20    SnmpAdminString                        FROM SNMP-FRAMEWORK-MIB
21    NOTIFICATION-GROUP,MODULE-COMPLIANCE,
22    OBJECT-GROUP                           FROM SNMPv2-CONF
23    entPhysicalIndex                       FROM ENTITY-MIB
24    ciscoMgmt                              FROM CISCO-SMI
25    EntPhysicalIndexOrZero                 FROM CISCO-TC;
26
27ciscoImageUpgradeMIB MODULE-IDENTITY
28    LAST-UPDATED "201103280000Z"
29    ORGANIZATION "Cisco Systems Inc."
30    CONTACT-INFO
31                "     Cisco Systems
32                      Customer Service
33                Postal: 170 W Tasman Drive
34                      San Jose, CA  95134
35                      USA
36                Tel: +1 800 553 -NETS
37                E-mail: cs-san@cisco.com"
38
39    DESCRIPTION
40         "This mib provides, objects to upgrade images on modules in the
41         system, objects showing the status of the upgrade operation,
42         and objects showing the type of images that could be run in the
43         system. For example the modules could be Controller card, Line
44         card .. etc.
45
46         The system fills up the ciuImageVariableTable with the type of
47         images the system can support. For performing an upgrade
48         operation a management application must first read this table
49         and use this info in other tables, as explained below.
50         The ciuImageURITable table is also filled by the system and
51         provides the image name presently running for each type of
52         image in the system. The user is allowed to configure a new
53         image name for each image type as listed in
54         ciuImageVariableTable. The system would use this image on the
55         particular module on the next reboot.
56
57         The management application on deciding to do an upgrade
58         operation must first check if an upgrade operation is already
59         in progress in the system. This is done by reading the
60         ciuUpgradeOpCommand and if it contains 'none', signifies that
61         no other upgrade operation is in progress. Any other value,
62         signifies that upgrade is in progress and a new upgrade
63         operation is not allowed. To start an 'install' operation,
64         first the user must perform a 'check' operation to do the
65         version compatibility for the given set of image files
66         (provided using the ciuImageLocInputTable) against the
67         current system configuration. Only if the result of this
68         operation is 'success' can the user proceed to do an install
69         operation.  The tables, ciuVersionCompChkTable,
70         ciuUpgradeImageVersionTable, ciuUpgradeOpStatusTable,
71         provide the result of the 'check' or 'install' operation
72         performed using ciuUpgradeOpCommand. These tables are in
73         addition to objects ciuUpgradeOpStatus,
74         ciuUpgradeOpTimeStarted, ciuUpgradeOpTimeCompleted,
75         ciuUpgradeOpStatusReason. The ciuUpgradeOpStatus object
76         provides the status of the selected upgrade operation.
77
78         An option is available for user to upgrade only some modules,
79         provided using ciuUpgradeTargetTable. If this table is empty
80         than an upgrade operation would be performed on all the
81         modules in the system."
82    REVISION    "201103280000Z"
83    DESCRIPTION
84         "Added new group ciuUpgradeOpNewGroup.
85          Added new enum 'systemPreupgradeBegin' to
86          ciuUpgradeOpStatusOperation.
87          Added ciuUpgradeOpLastCommand and ciuUpgradeOpLastStatus to
88          the varbind list of ciuUpgradeOpCompletionNotify.
89          Added new compliance ciuImageUpgradeComplianceRev4
90          and deprecated ciuImageUpgradeComplianceRev3.
91          Added ciuUpgradeJobStatusNotifyOnCompletion."
92    REVISION    "200803180000Z"
93    DESCRIPTION
94         "Added new enum 'compactFlashTcamSanity' to
95          ciuUpgradeOpStatusOperation."
96    REVISION    "200707180000Z"
97    DESCRIPTION
98         "Added new enums to ciuUpgradeOpStatusOperation."
99    REVISION    "200612210000Z"
100    DESCRIPTION
101         "Added new enums to ciuUpgradeOpStatus and
102          ciuUpgradeOpStatusOperation.
103          Added new trap ciuUpgradeJobStatusNotify.
104          Changed type for ciuUpgradeOpStatusModule
105          to EntPhysicalIndexOrZero.
106          Added ciuUpgradeNotificationGroupSup group,
107          deprecated ciuImageUpgradeComplianceRev2 and
108          added ciuImageUpgradeComplianceRev3 "
109    REVISION    "200401200000Z"
110    DESCRIPTION
111         "Added new enums to ciuUpgradeOpStatus and
112          ciuUpgradeOpStatusOperation.
113          Corrected description for 'configSync' enum defined in
114          ciuUpgradeOpStatusOperation object. "
115    REVISION    "200311040000Z"
116    DESCRIPTION
117         "Updated compliance statement. Removed ciuImageLocInputGroup
118         from conditionally mandatory."
119    REVISION    "200310280000Z"
120    DESCRIPTION
121         "Added ciuUpgradeMiscInfoTable. Added more enums to
122          ciuUpgradeOpStatusOperation.
123          Added ciuUpgradeMiscInfoGroup, deprecated
124          ciuImageUpgradeComplianceRev1 and added
125          ciuImageUpgradeComplianceRev2."
126    REVISION    "200307110000Z"
127    DESCRIPTION
128         "Changed: ciuImageLocInputURI identifier from 2 to 1,
129          ciuImageLocInputEntryStatus identifier from 3 to 2 and
130          ciuImageVariableName from 2 to 1.
131          Added recommendedAction to ciuUpgradeOpStatusOperation."
132    REVISION    "200307080000Z"
133    DESCRIPTION
134         "Added ciscoImageUpgradeMisc, added ciuUpgradeMiscAutoCopy
135          under the group ciscoImageUpgradeMisc.
136          Added ciuUpgradeMiscGroup, deprecated
137          ciuImageUpgradeCompliance and added
138          ciuImageUpgradeComplianceReve1."
139    REVISION    "200306010000Z"
140    DESCRIPTION
141         "Initial version of this MIB module."
142    ::= { ciscoMgmt 360 }
143
144ciscoImageUpgradeMIBNotifs        OBJECT IDENTIFIER
145                                    ::= { ciscoImageUpgradeMIB 0 }
146ciscoImageUpgradeMIBObjects       OBJECT IDENTIFIER
147                                    ::= { ciscoImageUpgradeMIB 1 }
148ciscoImageUpgradeMIBConform       OBJECT IDENTIFIER
149                                    ::= { ciscoImageUpgradeMIB 2 }
150
151ciscoImageUpgradeConfig          OBJECT IDENTIFIER
152                                  ::= { ciscoImageUpgradeMIBObjects 1 }
153
154ciscoImageUpgradeOp              OBJECT IDENTIFIER
155                                  ::= { ciscoImageUpgradeConfig 4 }
156
157ciscoImageUpgradeMisc          OBJECT IDENTIFIER
158                                  ::= { ciscoImageUpgradeConfig 10 }
159
160
161-- Textual Conventions
162
163CiuImageVariableTypeName ::= TEXTUAL-CONVENTION
164     STATUS            current
165     DESCRIPTION
166         "The type of image that the system can run.
167		  e.g. Let us say that the device has 3 image variables names
168		  - 'system', 'kickstart' and 'ilce'. This TC would, then be
169		  as follows:
170
171                 system
172                 kickstart
173                 ilce. "
174     SYNTAX            OCTET STRING (SIZE (1..32))
175
176
177ciuTotalImageVariables OBJECT-TYPE
178        SYNTAX         Unsigned32
179        MAX-ACCESS     read-only
180        STATUS         current
181        DESCRIPTION
182            "Total number of image variables supported in
183             the device at this time."
184        ::= { ciscoImageUpgradeConfig 1 }
185
186--
187--  Image variable table
188--
189ciuImageVariableTable OBJECT-TYPE
190        SYNTAX         SEQUENCE OF CiuImageVariableEntry
191        MAX-ACCESS     not-accessible
192        STATUS         current
193        DESCRIPTION
194            "A table listing the image variable types that
195             exist in the device. "
196        ::= { ciscoImageUpgradeConfig 2 }
197
198ciuImageVariableEntry OBJECT-TYPE
199        SYNTAX         CiuImageVariableEntry
200        MAX-ACCESS     not-accessible
201        STATUS         current
202        DESCRIPTION
203	        "A ciuImageVariableEntry entry. Each entry provides the
204	         image variable type existing in the device. "
205        INDEX   { ciuImageVariableName }
206        ::= { ciuImageVariableTable 1 }
207
208CiuImageVariableEntry  ::= SEQUENCE {
209        ciuImageVariableName         CiuImageVariableTypeName
210        }
211
212ciuImageVariableName OBJECT-TYPE
213	    SYNTAX         CiuImageVariableTypeName
214        MAX-ACCESS     read-only
215        STATUS         current
216        DESCRIPTION
217		    "The type of image that the system can run. The value of
218		    this object depends on the underlying agent.
219		     e.g. Let us say that the device has 3 image variables names
220		    - 'system', 'kickstart' and 'ilce'. This table , then will
221		    list these 3 strings as entries such as follows:
222
223             ciuImageVariableName
224                 system
225                 kickstart
226                 ilce
227
228             The user can assign images (using ciuImageURITable)
229             to these variables and the system will use the assigned
230             values to boot. "
231        ::= { ciuImageVariableEntry 1 }
232
233--
234-- Image Universal Resource Identifier (URI) table
235--
236
237ciuImageURITable OBJECT-TYPE
238        SYNTAX         SEQUENCE OF CiuImageURIEntry
239        MAX-ACCESS     not-accessible
240        STATUS         current
241        DESCRIPTION
242            "A table listing the Universal Resource Identifier(URI)
243             of images that are assigned to variables of the
244             ciuImageVariableTable.
245
246             In the example for ciuImageVariableTable, there are
247             3 image types. This table will list the names
248             for those image types as follows -
249
250             entPhysicalIndex ciuImageVariableName ciuImageURI
251
252               25            'system'         m9200-ek9-mgz.1.0.bin
253               25            'kickstart'      boot-1.0.bin
254               26            'ilce'           linecard-1.0.bin
255
256             In this example, the 'system' image name is
257             'm9200-ek9-mgz.1.0.bin', the 'ilce' image name is
258             'linecard-1.0.bin' and the 'kickstart' image name is
259             'boot-1.0.bin'. "
260        ::= { ciscoImageUpgradeConfig 3 }
261
262ciuImageURIEntry OBJECT-TYPE
263        SYNTAX         CiuImageURIEntry
264        MAX-ACCESS     not-accessible
265        STATUS         current
266        DESCRIPTION
267            "A ciuImageURITable entry. Each entry provides the
268            Image URI corresponding to this image variable name,
269            identified by ciuImageVariableName, on this module
270            identified by entPhysicalIndex. Each such module of the
271            type PhysicalClass module(9),  has an entry
272            in entPhysicalTable in ENTITY-MIB, where that entry is
273            identified by entPhysicalIndex. Only modules capable of
274            running images, identified by ciuImageVariableName would
275            have an entry in this table.  "
276        INDEX   { entPhysicalIndex, ciuImageVariableName }
277        ::= { ciuImageURITable 1 }
278
279CiuImageURIEntry  ::= SEQUENCE {
280        ciuImageURI    SnmpAdminString
281}
282
283ciuImageURI          OBJECT-TYPE
284        SYNTAX         SnmpAdminString
285        MAX-ACCESS     read-write
286        STATUS         current
287        DESCRIPTION
288            "This object contains the string value of the image
289             corresponding to ciuImageVariableName on this
290             entity."
291        ::= { ciuImageURIEntry 1 }
292
293
294
295--
296-- upgrade operation group
297--
298ciuUpgradeOpCommand OBJECT-TYPE
299        SYNTAX         INTEGER {
300                                none(1),
301                                done(2),
302                                install(3),
303                                check(4)
304                               }
305        MAX-ACCESS     read-write
306        STATUS         current
307        DESCRIPTION
308            "The command to be executed.
309             Note that it is possible for a system to support
310             only a subset of these commands. If a command is
311             unsupported, it will complete immediatly with the
312             'invalidOperation' error being reported in the
313             ciuUpgradeOpStatus object.
314             The 'check' must be performed first before 'install'
315             command can be executed. If 'install'
316             is performed first the operation would fail.
317             So 'install' will be allowed only if a read of
318             this object returns 'check' and the value of object
319             ciuUpgradeOpStatus is 'success'. Also 'check'
320             will be allowed only if a read of this object returns
321             'none'.
322
323             Command                 Remarks
324
325             none      if this object is read without performing
326                       any operation listed above, 'none' would be
327                       returned. Also 'none' would be returned for a
328                       read operation if a cleanup of the previous
329                       upgrade operation is completed either through
330                       the issue of 'done' command or the maximum
331                       timeout of 5 minutes is elapsed. Setting this
332                       object to 'none', agent would return a success
333                       without any upgrade operation being performed.
334             done      if this object returns any value other than
335                       'none', then setting this to 'done' would do
336                       the required cleanup of previous upgrade
337                       operation and make the system ready for any new
338                       upgrade operation. This is needed because the
339                       system maintains the status of the previous
340                       upgrade operation for a maximum time of 5 minutes
341                       before it does the cleanup. During this period
342                       no new upgrade operation is allowed.
343             install   for all the physical entities listed in the
344                       ciuUpgradeTargetTable perform the required
345                       upgrade operation listed in that table. However
346                       the upgrade operation for a module would not be
347                       done if the current running image and the image
348                       to be upgraded given as an input through the
349                       ciuImageLocInputTable are the same.
350             check     check the version compatibility for the given
351                       set of image files against the current system
352                       configuration.
353             "
354        ::= { ciscoImageUpgradeOp 1 }
355
356ciuUpgradeOpStatus OBJECT-TYPE
357        SYNTAX         INTEGER {
358                            none(1),
359                            invalidOperation(2),
360                            failure(3),
361                            inProgress(4),
362                            success(5),
363                            abortInProgress(6),
364                            abortSuccess(7),
365                            abortFailed(8),
366                            successReset(9),
367                            fsUpgReset(10)
368                           }
369        MAX-ACCESS     read-only
370        STATUS         current
371        DESCRIPTION
372            "The status of the specified operation.
373             none(1)             - no operation was performed.
374             invalidOperation(2) - the selected operation is not
375                                   supported.
376             failure(3)          - the selected operation has failed.
377             inProgress(4)       - specified operation is active.
378             success(5)          - specified operation has completed
379                                   successfully.
380             abortInProgress(6)  - abort in progress.
381             abortSuccess(7)     - abort operation successful.
382             abortFailed(8)      - abort failed.
383             successReset(9)     - specified operation has completed
384                                   successfully and the system will
385                                   reset.
386             fsUpgReset(10)      - fabric switch upgrade reset."
387        DEFVAL { none }
388        ::= { ciscoImageUpgradeOp 2 }
389
390ciuUpgradeOpNotifyOnCompletion OBJECT-TYPE
391        SYNTAX         TruthValue
392        MAX-ACCESS     read-write
393        STATUS         current
394        DESCRIPTION
395            "Specifies whether or not a notification should be
396            generated on the completion of an operation.
397            If 'true', ciuUpgradeOpCompletionNotify
398            will be generated, else if 'false' it would not be.
399            It is the responsibility of the management entity to
400            ensure that the SNMP administrative model is configured
401            in such a way as to allow the notification to be
402            delivered.
403
404            This object can only be modified alongwith
405            ciuUpgradeOpCommand object.This object returns default
406            value when ciuUpgradeOpCommand object contains
407            'none'. To SET this object a multivarbind set containing
408            this object and ciuUpgradeOpCommand must be done in the
409            same PDU for the operation to succeed."
410        DEFVAL  { false }
411        ::= { ciscoImageUpgradeOp 3}
412
413ciuUpgradeOpTimeStarted OBJECT-TYPE
414        SYNTAX         TimeStamp
415        MAX-ACCESS     read-only
416        STATUS         current
417        DESCRIPTION
418            "Specifies the time the upgrade operation was started.
419            This object would return 0 if ciuUpgradeOpCommand contains
420            'none'."
421        ::= { ciscoImageUpgradeOp 4 }
422
423ciuUpgradeOpTimeCompleted OBJECT-TYPE
424        SYNTAX         TimeStamp
425        MAX-ACCESS     read-only
426        STATUS         current
427        DESCRIPTION
428            "Specifies the time the upgrade operation completed.
429            This object would return 0 if ciuUpgradeOpCommand contains
430            'none'. "
431        ::= { ciscoImageUpgradeOp 5 }
432
433ciuUpgradeOpAbort  OBJECT-TYPE
434        SYNTAX         TruthValue
435        MAX-ACCESS     read-write
436        STATUS         current
437        DESCRIPTION
438            "Provides the means to abort an operation.
439             If this object is set to 'true' when an upgrade operation
440             is in progress and the corresponding instance of
441             ciuUpgradeOpCommand has the value 'install' or 'check',
442             then the operation will be aborted.  Setting this
443             object to 'true' when ciuUpgradeOpCommand has a different
444             value other than 'install' or 'check' will
445             fail. If retrieved, this object always has the
446             value 'false'. "
447        DEFVAL  { false }
448        ::= { ciscoImageUpgradeOp 6 }
449
450ciuUpgradeOpStatusReason OBJECT-TYPE
451        SYNTAX         SnmpAdminString
452        MAX-ACCESS     read-only
453        STATUS         current
454        DESCRIPTION
455            "Specifies the description of the cause of 'failed' state
456            of the object 'ciuUpgradeOpStatus'.
457            This object would be a null string if value of
458            'ciuUpgradeOpStatus' is anything other than
459            'failure'."
460        ::= { ciscoImageUpgradeOp 7 }
461
462
463ciuUpgradeOpLastCommand OBJECT-TYPE
464        SYNTAX         INTEGER {
465                                none(1),
466                                done(2),
467                                install(3),
468                                check(4)
469                           }
470        MAX-ACCESS     read-only
471        STATUS         current
472        DESCRIPTION
473            "This object indicates previous OpCommand value.
474             It will be updated after new OpCommand is set and delivered
475             to upgrade process.
476             'none'    if this object is read without performing
477                       any operation listed above, 'none' would be
478                       returned. Also 'none' would be returned for a
479                       read operation if a cleanup of the previous
480                       upgrade operation is completed either through
481                       the issue of 'done' command or the maximum
482                       timeout of 5 minutes is elapsed. Setting this
483                       object to 'none', agent would return a success
484                       without any upgrade operation being performed.
485
486             'done'    if this object returns any value other than
487                       'none', then setting this to 'done' would do
488                       the required cleanup of previous upgrade
489                       operation and make the system ready for any new
490                       upgrade operation. This is needed because the
491                       system maintains the status of the previous
492                       upgrade operation for a maximum time of 5 minutes
493                       before it does the cleanup. During this period
494                       no new upgrade operation is allowed.
495
496             'install' perform the required upgrade operation listed
497                       in ciuUpgradeTargetTable table. However
498                       the upgrade operation for a module would not be
499                       done if the current running image and the image
500                       to be upgraded given as an input through the
501                       ciuImageLocInputTable are the same.
502
503             'check'   check the version compatibility for the given
504                       set of image files against the current system
505                       configuration."
506        ::= { ciscoImageUpgradeOp 8 }
507
508ciuUpgradeOpLastStatus OBJECT-TYPE
509        SYNTAX         INTEGER {
510                            none(1),
511                            invalidOperation(2),
512                            failure(3),
513                            inProgress(4),
514                            success(5),
515                            abortInProgress(6),
516                            abortSuccess(7),
517                            abortFailed(8),
518                            successReset(9),
519                            fsUpgReset(10)
520                           }
521        MAX-ACCESS     read-only
522        STATUS         current
523        DESCRIPTION
524            "This object indicates previous OpStatus value.
525             It will be updated after new OpCommand is set and delivered
526             to upgrade process.
527             'none'             - no operation was performed.
528             'invalidOperation' - the selected operation is not
529                                   supported.
530             'failure'          - the selected operation has failed.
531             'inProgress'       - specified operation is active.
532             'success'          - specified operation has completed
533                                   successfully.
534             'abortInProgress'  - abort in progress.
535             'abortSuccess'     - abort operation successful.
536             'abortFailed'      - abort failed.
537             'successReset'     - specified operation has completed
538                                   successfully and the system will
539                                   reset.
540             'fsUpgReset'      - fabric switch upgrade reset."
541        ::= { ciscoImageUpgradeOp 9 }
542
543ciuUpgradeOpLastStatusReason OBJECT-TYPE
544        SYNTAX         SnmpAdminString
545        MAX-ACCESS     read-only
546        STATUS         current
547        DESCRIPTION
548            "This object indicates the previous OpStatusReason value.
549             It will be updated after new OpCommand is set and delivered
550             to upgrade process."
551        ::= { ciscoImageUpgradeOp 10 }
552
553ciuUpgradeJobStatusNotifyOnCompletion OBJECT-TYPE
554        SYNTAX         TruthValue
555        MAX-ACCESS     read-write
556        STATUS         current
557        DESCRIPTION
558            "This object specifies whether or not
559            ciuUpgradeJobStatusCompletionNotify notification
560            should be generated on the completion of an operation.
561            If 'true', ciuUpgradeJobStatusCompletionNotify
562            will be generated, else if 'false' it would not be."
563        ::= { ciscoImageUpgradeOp 11}
564
565--
566-- target input table
567--
568ciuUpgradeTargetTable  OBJECT-TYPE
569        SYNTAX         SEQUENCE OF CiuUpgradeTargetEntry
570        MAX-ACCESS     not-accessible
571        STATUS         current
572        DESCRIPTION
573            "A table listing the modules and the type of upgrade
574            operation to be performed on these modules. "
575        ::= { ciscoImageUpgradeConfig 5 }
576
577ciuUpgradeTargetEntry  OBJECT-TYPE
578        SYNTAX         CiuUpgradeTargetEntry
579        MAX-ACCESS     not-accessible
580        STATUS         current
581        DESCRIPTION
582            "Each entry provides the module that needs to be
583            upgraded and the type of operation that needs to be
584            performed on this module. The upgrade operation, selected
585            using the object 'ciuUpgradeOpCommand', would be performed
586            on each and every module represented by an entry in this
587            table. Each such module of the type PhysicalClass
588            module(9), has an entry in entPhysicalTable in ENTITY-MIB,
589            where that entry is identified by entPhysicalIndex.
590            Only modules capable of running images, identified by
591            ciuImageVariableName would have an entry in this table.
592            This table cannot be modified when ciuUpgradeOpCommand
593            object contains value other than 'none'. "
594        INDEX   { entPhysicalIndex }
595        ::= { ciuUpgradeTargetTable 1 }
596
597CiuUpgradeTargetEntry ::= SEQUENCE {
598        ciuUpgradeTargetAction       INTEGER,
599        ciuUpgradeTargetEntryStatus  RowStatus
600}
601
602ciuUpgradeTargetAction OBJECT-TYPE
603        SYNTAX         INTEGER {
604                                 image(1),
605                                 bios(2),
606                                 loader(3),
607                                 bootrom(4)
608                               }
609        MAX-ACCESS     read-create
610        STATUS         current
611        DESCRIPTION
612            "The type of operation to be performed on this module.
613             image    - upgrade image.
614             bios     - upgrade bios.
615             loader   - upgrade loader.loader is the program that
616                        loads and starts the operating system
617             bootrom  - upgrade boot rom
618
619             This object cannot be modified while the corresponding
620             value of ciuUpgradeTargetEntryStatus is equal to
621             'active'. It is okay to support only a subset of the enums
622              defined above. "
623        ::= { ciuUpgradeTargetEntry 1 }
624
625ciuUpgradeTargetEntryStatus OBJECT-TYPE
626        SYNTAX         RowStatus
627        MAX-ACCESS     read-create
628        STATUS         current
629        DESCRIPTION
630            "The status of this table entry. A multivarbind set
631            containing this object and ciuUpgradeTargetAction must
632            be done in the same PDU for the operation to succeed.  "
633        ::= { ciuUpgradeTargetEntry 2 }
634
635
636--
637-- image location input table
638--
639
640ciuImageLocInputTable  OBJECT-TYPE
641        SYNTAX         SEQUENCE OF CiuImageLocInputEntry
642        MAX-ACCESS     not-accessible
643        STATUS         current
644        DESCRIPTION
645            "A table listing the URI of the images that need to
646             be upgraded. "
647        ::= { ciscoImageUpgradeConfig 6 }
648
649ciuImageLocInputEntry  OBJECT-TYPE
650        SYNTAX         CiuImageLocInputEntry
651        MAX-ACCESS     not-accessible
652        STATUS         current
653        DESCRIPTION
654            "Each entry provides the image location URI that need to be
655            upgraded.
656            This table cannot be modified if ciuUpgradeOpCommand object
657            contains any value other than 'none' "
658        INDEX   { ciuImageVariableName }
659        ::= { ciuImageLocInputTable 1 }
660
661CiuImageLocInputEntry ::= SEQUENCE {
662        ciuImageLocInputURI          SnmpAdminString,
663        ciuImageLocInputEntryStatus  RowStatus
664}
665
666ciuImageLocInputURI OBJECT-TYPE
667        SYNTAX         SnmpAdminString (SIZE (1..255))
668        MAX-ACCESS     read-create
669        STATUS         current
670        DESCRIPTION
671            "An ASCII string specifying the system image location.
672             For example the string could be 'bootflash:file1'.
673
674             This object cannot be modified while the corresponding
675             value of ciuImageLocInputEntryStatus is equal to
676             'active'. "
677        ::= { ciuImageLocInputEntry 1 }
678
679ciuImageLocInputEntryStatus OBJECT-TYPE
680        SYNTAX         RowStatus
681        MAX-ACCESS     read-create
682        STATUS         current
683        DESCRIPTION
684            "The status of this table entry. "
685        ::= { ciuImageLocInputEntry 2 }
686
687--
688-- version compatibility check table
689--
690ciuVersionCompChkTable  OBJECT-TYPE
691        SYNTAX         SEQUENCE OF CiuVersionCompChkEntry
692        MAX-ACCESS     not-accessible
693        STATUS         current
694        DESCRIPTION
695            "A table showing the result of the version compatibility
696            check operation performed in response to the option
697            'check' selected for ciuUpgradeOpCommand.
698            The table would be emptied out once the value of
699            ciuUpgradeOpCommand object is 'none'. "
700        ::= { ciscoImageUpgradeConfig 7 }
701
702ciuVersionCompChkEntry  OBJECT-TYPE
703        SYNTAX         CiuVersionCompChkEntry
704        MAX-ACCESS     not-accessible
705        STATUS         current
706        DESCRIPTION
707            "An entry containing the results of the version
708            compatibility check operation performed on each module,
709            identified by entPhysicalIndex.
710            Each such module of the type PhysicalClass
711            module(9), has an entry in entPhysicalTable in ENTITY-MIB,
712            where that entry is identified by entPhysicalIndex.
713            Only modules capable of running images, identified by
714            ciuImageVariableName would have an entry in this table. "
715        INDEX   { entPhysicalIndex }
716        ::= { ciuVersionCompChkTable 1 }
717
718CiuVersionCompChkEntry ::= SEQUENCE {
719        ciuVersionCompImageSame           TruthValue,
720        ciuVersionCompUpgradable          TruthValue,
721        ciuVersionCompUpgradeAction       INTEGER,
722        ciuVersionCompUpgradeBios         TruthValue,
723        ciuVersionCompUpgradeBootrom      TruthValue,
724        ciuVersionCompUpgradeLoader       TruthValue,
725        ciuVersionCompUpgradeImpact       INTEGER,
726        ciuVersionCompUpgradeReason       SnmpAdminString
727        }
728
729ciuVersionCompImageSame OBJECT-TYPE
730        SYNTAX         TruthValue
731        MAX-ACCESS     read-only
732        STATUS         current
733        DESCRIPTION
734            " Specifies whether for this module the image provided by
735            the user for upgrade is same as the current running image. "
736        ::= { ciuVersionCompChkEntry 1 }
737
738ciuVersionCompUpgradable OBJECT-TYPE
739        SYNTAX         TruthValue
740        MAX-ACCESS     read-only
741        STATUS         current
742        DESCRIPTION
743            " Specifies whether the set of images provided in
744            ciuImageLocInputTable are compatible with each other as
745            far as this module is concerned. If 'true' the set of
746            images provided are compatible and can be run on this
747            module else they are not compatible. This module would not
748            come up if it is booted with a uncompatible set of image. "
749        ::= { ciuVersionCompChkEntry 2 }
750
751ciuVersionCompUpgradeAction OBJECT-TYPE
752        SYNTAX         INTEGER {
753                                  none(1),
754                                  other(2),
755                                  rollingUpgrade(3),
756                                  switchOverReset(4),
757                                  reset(5),
758                                  copy(6),
759                                  notApplicable(7),
760                                  plugin(8)
761                                }
762        MAX-ACCESS     read-only
763        STATUS         current
764        DESCRIPTION
765            " Specifies the type of upgrade action that would be
766            performed on this module if ciuUpgradeOpCommand were
767            set to 'install' or to 'check'.
768            none(1)           : is no upgrade action.
769            other(2)          : actions other than defined here
770            rollingUpgrade(3) :  modules would be upgraded one at a
771                                time.
772            switchOverReset(4): all the modules would be reset after
773                                a switchover happens at the same time.
774            reset(5)          : all the modules would be reset without
775                                or before a switchover.
776            copy(6)           : then image upgrade would not be done,
777                                but only bios/loader/bootrom would be
778                                updated and will take effect on next
779                                reload.
780            notApplicable(7)  : upgrade action is not possible
781                                because image is not upgradable.
782            plugin(8)		  : upgrading plugin only instead of full
783                                image."
784        ::= { ciuVersionCompChkEntry 3 }
785
786ciuVersionCompUpgradeBios OBJECT-TYPE
787        SYNTAX         TruthValue
788        MAX-ACCESS     read-only
789        STATUS         current
790        DESCRIPTION
791            " Specifies whether the BIOS will be upgraded.
792            If 'true' the bios would be upgraded else it would not."
793        ::= { ciuVersionCompChkEntry 4 }
794
795ciuVersionCompUpgradeBootrom OBJECT-TYPE
796        SYNTAX         TruthValue
797        MAX-ACCESS     read-only
798        STATUS         current
799        DESCRIPTION
800            " Specifies whether the bootrom will be upgraded.
801            If 'true' the bootrom would be upgraded else it would not."
802        ::= { ciuVersionCompChkEntry 5 }
803
804ciuVersionCompUpgradeLoader OBJECT-TYPE
805        SYNTAX         TruthValue
806        MAX-ACCESS     read-only
807        STATUS         current
808        DESCRIPTION
809            " Specifies whether the loader will be upgraded.
810            If 'true' the loader would be upgraded else it would not."
811        ::= { ciuVersionCompChkEntry 6 }
812
813ciuVersionCompUpgradeImpact OBJECT-TYPE
814        SYNTAX         INTEGER {
815                                  other(1),
816                                  nonDisruptive(2),
817                                  disruptive(3),
818                                  notApplicable(4)
819                                }
820        MAX-ACCESS     read-only
821        STATUS         current
822        DESCRIPTION
823            " Specifies the impact of the upgrade operation that
824            would have on this module.
825            other(1)        : reasons other than defined here
826            nonDisruptive(2): this module would be upgraded
827                              without disruption of traffic.
828            disruptive(3)   : this module would be upgraded
829                              with disruption of traffic.
830            notApplicable(4): upgrade is not possible because image
831                              is not upgradable. "
832        ::= { ciuVersionCompChkEntry 7 }
833
834ciuVersionCompUpgradeReason OBJECT-TYPE
835        SYNTAX         SnmpAdminString
836        MAX-ACCESS     read-only
837        STATUS         current
838        DESCRIPTION
839            "This object would give the reason for the following cases:
840            1)value of object ciuVersionCompUpgradable is 'false'
841            then it would give the reason why the module is not
842            upgradable.
843            2)the value of object ciuversionCompUpgradeAction is either
844            'switchOverReset' or 'reset' and value of object
845            ciuVersionCompUpgradable is 'true'.
846            3)the value of object ciuVersionCompUpgradeImpact is
847            'disruptive' and value of objects, ciuVersionCompUpgradable
848            is 'true' and ciuversionCompUpgradeAction is neither
849            'switchOverReset' nor 'reset.
850
851            This object would have the reason in the above listed
852            order.
853
854            It would be a null string for all the other values of the
855            above mentioned objects.
856            "
857        ::= { ciuVersionCompChkEntry 8 }
858
859--
860-- image version table
861--
862ciuUpgradeImageVersionTable  OBJECT-TYPE
863        SYNTAX         SEQUENCE OF CiuUpgradeImageVersionEntry
864        MAX-ACCESS     not-accessible
865        STATUS         current
866        DESCRIPTION
867            "A table showing the current version of images running
868            on the modules and the images they would be upgraded with.
869            The table would be emptied out once the value of
870            ciuUpgradeOpCommand object is 'none'. This table becomes
871            valid when value of ciuUpgradeOpStatus is 'success'
872            in response to 'check' operation selected using
873            ciuUpgradeOpCommand. "
874        ::= { ciscoImageUpgradeConfig 8 }
875
876ciuUpgradeImageVersionEntry  OBJECT-TYPE
877        SYNTAX         CiuUpgradeImageVersionEntry
878        MAX-ACCESS     not-accessible
879        STATUS         current
880        DESCRIPTION
881            "An entry containing the current version of image running
882            on a particular module and the images they would be
883            upgraded with.
884            An ciuUpgradeImageVersionVarName identifies the type of
885            software running on this module, identified by
886            entPhysicalIndex. It is possible that the
887            same module, identified by entPhysicalIndex,
888            can run multiple instances of the software type identified
889            by ciuUpgradeImageVersionVarName.
890            Each such module of the type PhysicalClass
891            module(9), has an entry in entPhysicalTable in ENTITY-MIB,
892            where that entry is identified by entPhysicalIndex.
893            Only modules capable of running images, identified by
894            ciuImageVariableName would have an entry in this table. "
895        INDEX   { entPhysicalIndex,
896                  ciuUpgradeImageVersionIndex }
897        ::= { ciuUpgradeImageVersionTable 1 }
898
899CiuUpgradeImageVersionEntry ::= SEQUENCE {
900        ciuUpgradeImageVersionIndex           Unsigned32,
901        ciuUpgradeImageVersionVarName         CiuImageVariableTypeName,
902        ciuUpgradeImageVersionRunning         SnmpAdminString,
903        ciuUpgradeImageVersionNew             SnmpAdminString,
904        ciuUpgradeImageVersionUpgReqd         TruthValue
905        }
906
907ciuUpgradeImageVersionIndex OBJECT-TYPE
908        SYNTAX         Unsigned32
909        MAX-ACCESS     not-accessible
910        STATUS         current
911        DESCRIPTION
912            "This is an arbitrary integer which uniquely identifies
913             different rows which have the same value of
914             entPhysicalIndex."
915        ::= { ciuUpgradeImageVersionEntry 1 }
916
917ciuUpgradeImageVersionVarName OBJECT-TYPE
918        SYNTAX         CiuImageVariableTypeName
919        MAX-ACCESS     read-only
920        STATUS         current
921        DESCRIPTION
922            "The type of image on this module. "
923        ::= { ciuUpgradeImageVersionEntry 2 }
924
925ciuUpgradeImageVersionRunning OBJECT-TYPE
926        SYNTAX         SnmpAdminString (SIZE (1..255))
927        MAX-ACCESS     read-only
928        STATUS         current
929        DESCRIPTION
930            "An ASCII string specifying the running image version. "
931        ::= { ciuUpgradeImageVersionEntry 3 }
932
933ciuUpgradeImageVersionNew OBJECT-TYPE
934        SYNTAX         SnmpAdminString (SIZE (1..255))
935        MAX-ACCESS     read-only
936        STATUS         current
937        DESCRIPTION
938            "An ASCII string specifying what the new image version
939             would be after an upgrade. "
940        ::= { ciuUpgradeImageVersionEntry 4 }
941
942ciuUpgradeImageVersionUpgReqd OBJECT-TYPE
943        SYNTAX         TruthValue
944        MAX-ACCESS     read-only
945        STATUS         current
946        DESCRIPTION
947            " Specifies whether an upgrade is required for this
948            software component, identified by  entPhysicalIndex and
949            ciuUpgradeImageVersionVarName.
950            If the value of objects ciuUpgradeImageVersionRunning and
951            ciuUpgradeImageVersionNew are same then the value of this
952            object would be 'false' else it would be 'true'.
953            If 'true' then this software component, identified by
954            ciuUpgradeImageVersionVarName needs to be upgraded else
955            it would not."
956        ::= { ciuUpgradeImageVersionEntry 5 }
957
958--
959--  upgrade operation status table
960--
961ciuUpgradeOpStatusTable  OBJECT-TYPE
962        SYNTAX         SEQUENCE OF CiuUpgradeOpStatusEntry
963        MAX-ACCESS     not-accessible
964        STATUS         current
965        DESCRIPTION
966            "A table showing the result of the upgrade operation
967            selected from ciuUpgradeOpCommand in ciuUpgradeOpTable.
968            The table would be emptied out once the value of
969            ciuUpgradeOpCommand object is 'none'. "
970        ::= { ciscoImageUpgradeConfig 9 }
971
972ciuUpgradeOpStatusEntry  OBJECT-TYPE
973        SYNTAX         CiuUpgradeOpStatusEntry
974        MAX-ACCESS     not-accessible
975        STATUS         current
976        DESCRIPTION
977            "An entry containing the status of the upgrade operation. "
978        INDEX   { ciuUpgradeOpStatusOperIndex }
979        ::= { ciuUpgradeOpStatusTable 1 }
980
981CiuUpgradeOpStatusEntry ::= SEQUENCE {
982        ciuUpgradeOpStatusOperIndex        Unsigned32,
983        ciuUpgradeOpStatusOperation        INTEGER,
984        ciuUpgradeOpStatusModule           EntPhysicalIndexOrZero,
985        ciuUpgradeOpStatusSrcImageLoc      SnmpAdminString,
986        ciuUpgradeOpStatusDestImageLoc     SnmpAdminString,
987        ciuUpgradeOpStatusJobStatus        INTEGER,
988        ciuUpgradeOpStatusPercentCompl     Integer32,
989        ciuUpgradeOpStatusJobStatusReas    SnmpAdminString
990}
991
992ciuUpgradeOpStatusOperIndex OBJECT-TYPE
993        SYNTAX         Unsigned32
994        MAX-ACCESS     not-accessible
995        STATUS         current
996        DESCRIPTION
997            "This is an arbitrary integer which identifies uniquely
998             an entry in this table. "
999        ::= { ciuUpgradeOpStatusEntry 1 }
1000
1001ciuUpgradeOpStatusOperation OBJECT-TYPE
1002        SYNTAX         INTEGER {
1003                         unknown(1),
1004                         other(2),
1005                         copy(3),
1006                         verify(4),
1007                         versionExtraction(5),
1008                         imageSync(6),
1009                         configSync(7),
1010                         preUpgrade(8),
1011                         forceDownload(9),
1012                         moduleOnline(10),
1013                         hitlessLCUpgrade(11),
1014                         hitfulLCUpgrade(12),
1015                         unusedBootvar(13),
1016                         convertStartUp(14),
1017                         looseIncompatibility(15),
1018                         haSeqNumMismatch(16),
1019                         unknownModuleOnline(17),
1020                         recommendedAction(18),
1021                         recoveryAction(19),
1022                         remainingAction(20),
1023                         additionalInfo(21),
1024                         settingBootvars(22),
1025                         informLcmFsUpg(23),
1026                         sysmgrSaveRuntimeStateAndSuccessReset(24),
1027                         kexecLoadUpgImages(25),
1028                         fsUpgCleanup(26),
1029                         saveMtsState(27),
1030                         fsUpgBegin(28),
1031                         lcWarmBootStatus(29),
1032                         waitStateVerificationStatus(30),
1033                         informLcmFsUpgExternalLc(31),
1034                         externalLcWarmBootStatus(32),
1035                         total(33),
1036                         compactFlashTcamSanity(34),
1037                         systemPreupgradeBegin(35)
1038                       }
1039        MAX-ACCESS     read-only
1040        STATUS         current
1041        DESCRIPTION
1042            "Specifies the operation that is currently in progress
1043            or completed in response to the ciuUpgradeOpCommand.
1044            'unknown' - operation status unknown.
1045            'other'   - operation status other than defined here.
1046            'copy'    - the image is being copied from
1047                        ciuUpgradeOpStatusSrcImageLoc to
1048                        ciuUpgradeOpStatusDestImageLoc.
1049            'verify'  - copied images are being verified for checksum
1050                        and input consistency.
1051            'versionExtraction' - extracting the version info from
1052                                  image.
1053            'imageSync'     - Syncing image to the standby supervisor,
1054                              if standby supervisor exists.
1055            'configSync'    - saving running configuration to startup
1056                              configuration and syncing it to standby
1057                              supervisor, if it exists.
1058            'preUpgrade'    - Upgrading Bios/loader/bootrom
1059            'forceDownload' - This module is being force downloaded.
1060            'moduleOnline'  - waiting for this module to come online
1061            'hitlessLCUpgrade' - Upgrading hitless
1062            'hitfulLCUpgrade'  - Upgrading hitful
1063            'unusedBootvar'    - The image variable name type supplied
1064                                 as input for upgrade operation is
1065                                 unused.
1066            'convertStartUp'   - converting the startup config.
1067            'looseIncompatibility' - incomplete support for current
1068                                     running config in the new image.
1069            'haSeqNumMismatch'     - High availability sequence number
1070                                     mismatch, so the module will be
1071                                     power cycled.
1072            'unknownModuleOnline'  - this module was powered down
1073                                     before switchover and has now
1074                                     come online.
1075            'recommendedAction'    - Specifies the recommended action if
1076                                     upgrading operation fails. If this
1077                                     object value is 'recommendedAction'
1078                                     then the object
1079                                     'ciuUpgradeOpStatusSrcImageLoc'
1080                                     would contain the string specifying
1081                                     the recommended action.
1082            'recoveryAction'       - Specifies that installer is doing
1083                                     a recovery because of install
1084                                     failure. If this object value is
1085                                     'recoveryAction' then the object
1086                                     'ciuUpgradeOpStatusSrcImageLoc'
1087                                     would contain the string specifying
1088                                     the recovery action.
1089            'remainingAction'      - Specifies the remaining actions
1090                                     that have not been performed due
1091                                     to install failure. If this object
1092                                     value is 'remainingAction' then
1093                                     the object
1094                                     'ciuUpgradeOpStatusSrcImageLoc'
1095                                     would contain the information
1096                                     about the remaining actions.
1097            'additionalInfo'      -  Specifies the additional info
1098                                     the installer conveys to the user.
1099                                     If this object value is
1100                                     'additionalInfo' then
1101                                     the object
1102                                     'ciuUpgradeOpStatusSrcImageLoc'
1103                                     would contain the information.
1104            'settingBootvars'     -  setting the boot variables.
1105            'informLcmFsUpg'      -  save linecard runtime state.
1106            'sysmgrSaveRuntimeStateAndSuccessReset' - save supervisor
1107                                     runtime state and terminate all
1108                                     services.
1109            'kexecLoadUpgImages'  - load upgrade images into memory.
1110            'fsUpgCleanup'        - cleanup file system for upgrade.
1111            'saveMtsState'        - saving persistent transaction
1112                                    messages.
1113            'fsUpgBegin'          - notify services that upgrade is
1114                                    about to begin.
1115            'lcWarmBootStatus'    - linecard upgrade status.
1116            'waitStateVerificationStatus' - supervisor state
1117                                    verification with the new image.
1118            'informLcmFsUpgExternalLc' - save external linecard runtime
1119                                      state.
1120            'externalLcWarmBootStatus' - external linecard upgrade
1121                                     status.
1122            'total'               - total.
1123            'compactFlashTcamSanity'  - compact flash and TCAM sanity
1124                                      test.
1125            'systemPreupgradeBegin' - notify services of beginning of
1126                                      upgrade.
1127             "
1128        ::= { ciuUpgradeOpStatusEntry 2 }
1129
1130ciuUpgradeOpStatusModule OBJECT-TYPE
1131        SYNTAX         EntPhysicalIndexOrZero
1132        MAX-ACCESS     read-only
1133        STATUS         current
1134        DESCRIPTION
1135            "The physical entity of the module for which this
1136             status is being shown. For example such an entity is one of
1137             the type PhysicalClass module(9). This object must contain
1138             the same value as the entPhysicalIndex of the physical
1139             entity from entPhysicalTable in ENTITY-MIB. "
1140        ::= { ciuUpgradeOpStatusEntry 3 }
1141
1142ciuUpgradeOpStatusSrcImageLoc OBJECT-TYPE
1143        SYNTAX         SnmpAdminString
1144        MAX-ACCESS     read-only
1145        STATUS         current
1146        DESCRIPTION
1147            "An ASCII string specifying the source image location.
1148             For example the string could be 'bootflash:file1'.
1149             This object is only valid if the value of
1150             ciuUpgradeOpStatusOperation is 'copy'."
1151        ::= { ciuUpgradeOpStatusEntry 4 }
1152
1153ciuUpgradeOpStatusDestImageLoc OBJECT-TYPE
1154        SYNTAX         SnmpAdminString
1155        MAX-ACCESS     read-only
1156        STATUS         current
1157        DESCRIPTION
1158            "An ASCII string specifying the destination image location.
1159             For example the string could be 'bootflash:file1'."
1160        ::= { ciuUpgradeOpStatusEntry 5 }
1161
1162ciuUpgradeOpStatusJobStatus OBJECT-TYPE
1163        SYNTAX         INTEGER {
1164                                  unknown(1),
1165                                  other(2),
1166                                  failed(3),
1167                                  inProgress(4),
1168                                  success(5),
1169                                  planned(6)
1170                        }
1171        MAX-ACCESS     read-only
1172        STATUS         current
1173        DESCRIPTION
1174            "The status of this operation.
1175             'unknown'    - operation status unknown.
1176             'other'      - operation status other than defined here.
1177             'failed'     - this operation has failed
1178             'inProgress' - this operation is active
1179             'success'    - this operation has completed successfully.
1180             'planned'    - this operation would be executed at later
1181                            point of time."
1182        ::= { ciuUpgradeOpStatusEntry 6 }
1183
1184ciuUpgradeOpStatusPercentCompl OBJECT-TYPE
1185        SYNTAX         Integer32
1186        MAX-ACCESS     read-only
1187        STATUS         current
1188        DESCRIPTION
1189            "The percentage completion of the upgrade operation
1190             selected from ciuUpgradeOpTable.
1191             If this object is invalid for a particular operation,
1192             identified by ciuUpgradeOpStatusOperation, then the
1193             value of this object would be -1. "
1194        ::= { ciuUpgradeOpStatusEntry 7 }
1195
1196ciuUpgradeOpStatusJobStatusReas OBJECT-TYPE
1197        SYNTAX         SnmpAdminString
1198        MAX-ACCESS     read-only
1199        STATUS         current
1200        DESCRIPTION
1201            "Specifies the description of the cause of 'failed' state
1202            of the object 'ciuUpgradeOpStatusJobStatus'.
1203            This object would be a null string if value of
1204            'ciuUpgradeOpStatusJobStatus' is anything other than
1205            'failed'."
1206        ::= { ciuUpgradeOpStatusEntry 8 }
1207
1208--
1209-- Miscelleneous  group
1210--
1211
1212ciuUpgradeMiscAutoCopy OBJECT-TYPE
1213        SYNTAX           TruthValue
1214        MAX-ACCESS       read-write
1215        STATUS           current
1216        DESCRIPTION
1217            "Specifies whether or not the images on the
1218            active supervisor will be copied to the
1219            standby supervisor, if the standby supervisor
1220            exists. If the standby supervisor does not
1221            exist, the setting of this object to 'true'
1222            will not have any effect and no image copy
1223            will be done.
1224
1225            ciuImageURITable lists all the images for the
1226            supervisor cards as well as the line cards.
1227
1228            If this object is set to 'true', all the images
1229            pointed to by the instances of ciuImageURI will be
1230            automatically copied to the standby supervisor.
1231
1232            For example, assume that the ciuImageURITable looks
1233            like below -
1234
1235             entPhysicalIndex ciuImageVariableName ciuImageURI
1236
1237              25          'system'         bootflash://image.bin
1238              25          'kickstart'      slot0://boot.bin
1239              26          'ilce'           bootflash://linecard.bin
1240
1241            So, if the ciuUpgradeMiscAutoCopy is 'true', then
1242            bootflash://image.bin from the active supervisor will
1243            be copied to the  bootflash://image.bin on the
1244            standby supervisor;  slot0://boot.bin will be copied
1245            to the slot0://boot.bin on the standby supervisor etc.
1246
1247            If this object is set to 'false' then this copying
1248            of the images will not be done."
1249
1250        DEFVAL  { false }
1251        ::= { ciscoImageUpgradeMisc 1}
1252
1253--
1254-- upgrade Miscelleneous info table
1255--
1256ciuUpgradeMiscInfoTable  OBJECT-TYPE
1257        SYNTAX         SEQUENCE OF CiuUpgradeMiscInfoEntry
1258        MAX-ACCESS     not-accessible
1259        STATUS         current
1260        DESCRIPTION
1261            "A table showing additional information such as warnings
1262            during upgrade.
1263            The table would be emptied out once the value of
1264            ciuUpgradeOpCommand object is 'none'. "
1265        ::= { ciscoImageUpgradeConfig 11 }
1266
1267ciuUpgradeMiscInfoEntry  OBJECT-TYPE
1268        SYNTAX         CiuUpgradeMiscInfoEntry
1269        MAX-ACCESS     not-accessible
1270        STATUS         current
1271        DESCRIPTION
1272            "An entry containing additional information of upgrade
1273            operation being performed on modules.
1274            Each entry is uniquely identified by
1275            ciuUpgradeMiscInfoIndex. If the info given in object
1276            ciuUpgradeMiscInfoDescr is not for any module then
1277            the value of ciuUpgradeMiscInfoModule would be 0."
1278        INDEX   { ciuUpgradeMiscInfoIndex }
1279        ::= { ciuUpgradeMiscInfoTable 1 }
1280
1281CiuUpgradeMiscInfoEntry ::= SEQUENCE {
1282        ciuUpgradeMiscInfoIndex           Unsigned32,
1283        ciuUpgradeMiscInfoModule          EntPhysicalIndexOrZero,
1284        ciuUpgradeMiscInfoDescr           SnmpAdminString
1285        }
1286
1287ciuUpgradeMiscInfoIndex OBJECT-TYPE
1288        SYNTAX         Unsigned32
1289        MAX-ACCESS     not-accessible
1290        STATUS         current
1291        DESCRIPTION
1292            "This is an arbitrary integer which identifies uniquely
1293             an entry in this table. "
1294        ::= { ciuUpgradeMiscInfoEntry 1 }
1295
1296ciuUpgradeMiscInfoModule OBJECT-TYPE
1297        SYNTAX         EntPhysicalIndexOrZero
1298        MAX-ACCESS     read-only
1299        STATUS         current
1300        DESCRIPTION
1301            "The entPhysicalIndex of the module. The value of this
1302            object would be 0 if the information shown in
1303            ciuUpgradeMiscInfoDescr is not for any module."
1304        ::= { ciuUpgradeMiscInfoEntry 2 }
1305
1306ciuUpgradeMiscInfoDescr OBJECT-TYPE
1307        SYNTAX         SnmpAdminString
1308        MAX-ACCESS     read-only
1309        STATUS         current
1310        DESCRIPTION
1311            "Specifies the miscelleneous information of the
1312            upgrade operation."
1313        ::= { ciuUpgradeMiscInfoEntry 3 }
1314
1315
1316-- Notifications
1317--
1318
1319ciuUpgradeOpCompletionNotify NOTIFICATION-TYPE
1320        OBJECTS	{
1321          ciuUpgradeOpCommand,
1322          ciuUpgradeOpStatus,
1323          ciuUpgradeOpTimeCompleted,
1324          ciuUpgradeOpLastCommand,
1325          ciuUpgradeOpLastStatus
1326        }
1327        STATUS current
1328        DESCRIPTION
1329            "A ciuUpgradeOpCompletionNotify is sent at the
1330             completion of upgrade operation denoted by
1331             ciuUpgradeOpCommand object if such a notification
1332             was requested when the operation was initiated.
1333             ciuUpgradeOpCommand indicates the type of
1334             operation. ciuUpgradeOpStatus indicates the
1335             result of the operation. ciuUpgradeOpTimeCompleted
1336             indicates the time when the operation is
1337             completed. ciuUpgradeopLastCommand indicates
1338             the previous operation that was executed.
1339             ciuUpgradeOpLastStatus indicates the result of
1340             previous operation."
1341        ::= { ciscoImageUpgradeMIBNotifs 1 }
1342
1343ciuUpgradeJobStatusNotify NOTIFICATION-TYPE
1344        OBJECTS {
1345          ciuUpgradeOpStatusOperation,
1346          ciuUpgradeOpStatusModule,
1347          ciuUpgradeOpStatusSrcImageLoc,
1348          ciuUpgradeOpStatusDestImageLoc,
1349          ciuUpgradeOpStatusJobStatus,
1350          ciuUpgradeOpStatusPercentCompl,
1351          ciuUpgradeOpStatusJobStatusReas,
1352          ciuUpgradeOpStatus,
1353          ciuUpgradeOpStatusReason
1354        }
1355        STATUS current
1356        DESCRIPTION
1357            "A ciuUpgradeJobStatusNotify is sent when there
1358             is status change in the upgrade process.
1359             ciuUpgradeOpStatusOperation indicates the
1360             operation to change the upgrade status.
1361             ciuUpgradeOpStatusModule indicates which module
1362             is affected. ciuUpgradeOpStatusSrcImageLoc
1363             indicates location of source image if applicable.
1364             ciuUpgradeOpStatusDestImageLoc indicates location
1365             of destination image if applicable.
1366             ciuUpgradeOpStatusJobStatus indicates the result
1367             of this operation to change the status.
1368             ciuUpgradeOpStatusPercentCompl indicates percentage
1369             of the operation that has been completed.
1370             ciuUpgradeOpStatusJobStatusReas gives explanation
1371             of the faiure if there is a failure.
1372             ciuUpgradeOpStatus indicates the result of the
1373             operation at higher level.
1374             ciuUpgradeOpStatusReason gives detailed explanation
1375             if ciuUpgradeOpStatus is not successful."
1376        ::= { ciscoImageUpgradeMIBNotifs 2}
1377
1378--
1379-- Conformance
1380--
1381ciuImageUpgradeCompliances  OBJECT IDENTIFIER
1382                              ::= { ciscoImageUpgradeMIBConform 1 }
1383ciuImageUpgradeGroups       OBJECT IDENTIFIER
1384                              ::= { ciscoImageUpgradeMIBConform 2 }
1385
1386ciuImageUpgradeCompliance MODULE-COMPLIANCE
1387     STATUS deprecated -- by ciuImageUpgradeComplianceRev1
1388     DESCRIPTION
1389         "Compliance statement for Image Upgrade MIB.
1390
1391          For the (mandatory) ciuImageLocInputGroup, it is
1392          compliant	to allow only a limited number of entries to be
1393          created and concurrently 'active' in the
1394          ciuImageLocInputTable table. "
1395     MODULE       -- this module
1396     MANDATORY-GROUPS {
1397         ciuImageUpgradeGroup,
1398         ciuImageVariableGroup,
1399         ciuImageURIGroup,
1400         ciuUpgradeOpGroup,
1401         ciuImageLocInputGroup,
1402         ciuVersionCompChkGroup,
1403         ciuUpgradeImageVersionGroup,
1404         ciuUpgradeOpStatusGroup,
1405         ciuUpgradeNotificationGroup
1406     }
1407
1408     OBJECT  ciuUpgradeTargetEntryStatus
1409     SYNTAX  INTEGER {
1410                     active(1),
1411                     createAndGo(4),
1412                     destroy(6)}
1413     DESCRIPTION
1414         "Only three values 'createAndGo', 'destroy' and 'active'
1415         out of the six enumerated values need to be supported."
1416
1417     OBJECT ciuImageLocInputEntryStatus
1418     SYNTAX  INTEGER {
1419                     active(1),
1420                     createAndGo(4),
1421                     destroy(6)}
1422     DESCRIPTION
1423         "Only three values 'createAndGo', 'destroy' and 'active'
1424         out of the six enumerated values need to be supported."
1425
1426     OBJECT ciuImageLocInputURI
1427     DESCRIPTION
1428         "It is compliant to support a maximum value for this
1429         object which is smaller than the defined maximum value."
1430
1431     GROUP ciuUpgradeTargetGroup
1432     DESCRIPTION
1433         "Implementation of this group is optional. For some systems
1434         all the required modules in the system would be upgraded
1435         in response to ciuUpgradeOpCommand. In such cases,
1436         implementation of this group is optional."
1437
1438     ::= { ciuImageUpgradeCompliances 1 }
1439
1440
1441ciuImageUpgradeComplianceRev1 MODULE-COMPLIANCE
1442     STATUS deprecated -- by ciuImageUpgradeComplianceRev2
1443     DESCRIPTION
1444         "Compliance statement for Image Upgrade MIB.
1445
1446          For the (mandatory) ciuImageLocInputGroup, it is
1447          compliant	to allow only a limited number of entries to be
1448          created and concurrently 'active' in the
1449          ciuImageLocInputTable table. "
1450     MODULE       -- this module
1451     MANDATORY-GROUPS {
1452         ciuImageUpgradeGroup,
1453         ciuImageVariableGroup,
1454         ciuImageURIGroup,
1455         ciuUpgradeOpGroup,
1456         ciuImageLocInputGroup,
1457         ciuVersionCompChkGroup,
1458         ciuUpgradeImageVersionGroup,
1459         ciuUpgradeOpStatusGroup,
1460         ciuUpgradeNotificationGroup,
1461         ciuUpgradeMiscGroup
1462     }
1463
1464     OBJECT  ciuUpgradeTargetEntryStatus
1465     SYNTAX  INTEGER {
1466                     active(1),
1467                     createAndGo(4),
1468                     destroy(6)}
1469     DESCRIPTION
1470         "Only three values 'createAndGo', 'destroy' and 'active'
1471         out of the six enumerated values need to be supported."
1472
1473     OBJECT ciuImageLocInputEntryStatus
1474     SYNTAX  INTEGER {
1475                     active(1),
1476                     createAndGo(4),
1477                     destroy(6)}
1478     DESCRIPTION
1479         "Only three values 'createAndGo', 'destroy' and 'active'
1480         out of the six enumerated values need to be supported."
1481
1482     OBJECT ciuImageLocInputURI
1483     DESCRIPTION
1484         "It is compliant to support a maximum value for this
1485         object which is smaller than the defined maximum value."
1486
1487     GROUP ciuUpgradeTargetGroup
1488     DESCRIPTION
1489         "Implementation of this group is optional. For some systems
1490         all the required modules in the system would be upgraded
1491         in response to ciuUpgradeOpCommand. In such cases,
1492         implementation of this group is optional."
1493
1494     ::= { ciuImageUpgradeCompliances 2 }
1495
1496ciuImageUpgradeComplianceRev2 MODULE-COMPLIANCE
1497     STATUS deprecated -- by ciuImageUpgradeComplianceRev3
1498     DESCRIPTION
1499         "Compliance statement for Image Upgrade MIB.
1500
1501          For the (mandatory) ciuImageLocInputGroup, it is
1502          compliant	to allow only a limited number of entries to be
1503          created and concurrently 'active' in the
1504          ciuImageLocInputTable table."
1505     MODULE       -- this module
1506     MANDATORY-GROUPS {
1507         ciuImageUpgradeGroup,
1508         ciuImageVariableGroup,
1509         ciuImageURIGroup,
1510         ciuUpgradeOpGroup,
1511         ciuImageLocInputGroup,
1512         ciuVersionCompChkGroup,
1513         ciuUpgradeImageVersionGroup,
1514         ciuUpgradeOpStatusGroup,
1515         ciuUpgradeNotificationGroup,
1516         ciuUpgradeMiscGroup,
1517         ciuUpgradeMiscInfoGroup
1518     }
1519
1520     OBJECT  ciuUpgradeTargetEntryStatus
1521     SYNTAX  INTEGER {
1522                     active(1),
1523                     createAndGo(4),
1524                     destroy(6)}
1525     DESCRIPTION
1526         "Only three values 'createAndGo', 'destroy' and 'active'
1527         out of the six enumerated values need to be supported."
1528
1529     OBJECT ciuImageLocInputEntryStatus
1530     SYNTAX  INTEGER {
1531                     active(1),
1532                     createAndGo(4),
1533                     destroy(6)}
1534     DESCRIPTION
1535         "Only three values 'createAndGo', 'destroy' and 'active'
1536         out of the six enumerated values need to be supported."
1537
1538     OBJECT ciuImageLocInputURI
1539     DESCRIPTION
1540         "It is compliant to support a maximum value for this
1541         object which is smaller than the defined maximum value."
1542
1543     GROUP ciuUpgradeTargetGroup
1544     DESCRIPTION
1545         "Implementation of this group is optional. For some systems
1546         all the required modules in the system would be upgraded
1547         in response to ciuUpgradeOpCommand. In such cases,
1548         implementation of this group is optional."
1549
1550     ::= { ciuImageUpgradeCompliances 3 }
1551
1552ciuImageUpgradeComplianceRev3 MODULE-COMPLIANCE
1553     STATUS deprecated -- by ciuImageUpgradeComplianceRev4
1554     DESCRIPTION
1555         "Compliance statement for Image Upgrade MIB.
1556
1557          For the (mandatory) ciuImageLocInputGroup, it is
1558          compliant	to allow only a limited number of entries to be
1559          created and concurrently 'active' in the
1560          ciuImageLocInputTable table."
1561     MODULE       -- this module
1562     MANDATORY-GROUPS {
1563         ciuImageUpgradeGroup,
1564         ciuImageVariableGroup,
1565         ciuImageURIGroup,
1566         ciuUpgradeOpGroup,
1567         ciuImageLocInputGroup,
1568         ciuVersionCompChkGroup,
1569         ciuUpgradeImageVersionGroup,
1570         ciuUpgradeOpStatusGroup,
1571         ciuUpgradeNotificationGroup,
1572         ciuUpgradeNotificationGroupSup,
1573         ciuUpgradeMiscGroup,
1574         ciuUpgradeMiscInfoGroup
1575     }
1576
1577     OBJECT  ciuUpgradeTargetEntryStatus
1578     SYNTAX  INTEGER {
1579                     active(1),
1580                     createAndGo(4),
1581                     destroy(6)}
1582     DESCRIPTION
1583         "Only three values 'createAndGo', 'destroy' and 'active'
1584         out of the six enumerated values need to be supported."
1585
1586     OBJECT ciuImageLocInputEntryStatus
1587     SYNTAX  INTEGER {
1588                     active(1),
1589                     createAndGo(4),
1590                     destroy(6)}
1591     DESCRIPTION
1592         "Only three values 'createAndGo', 'destroy' and 'active'
1593         out of the six enumerated values need to be supported."
1594
1595     OBJECT ciuImageLocInputURI
1596     DESCRIPTION
1597         "It is compliant to support a maximum value for this
1598         object which is smaller than the defined maximum value."
1599
1600     GROUP ciuUpgradeTargetGroup
1601     DESCRIPTION
1602         "Implementation of this group is optional. For some systems
1603         all the required modules in the system would be upgraded
1604         in response to ciuUpgradeOpCommand. In such cases,
1605         implementation of this group is optional."
1606
1607     ::= { ciuImageUpgradeCompliances 4 }
1608
1609ciuImageUpgradeComplianceRev4 MODULE-COMPLIANCE
1610     STATUS current
1611     DESCRIPTION
1612         "Compliance statement for Image Upgrade MIB.
1613
1614          For the (mandatory) ciuImageLocInputGroup, it is
1615          compliant to allow only a limited number of entries to be
1616          created and concurrently 'active' in the
1617          ciuImageLocInputTable table."
1618     MODULE       -- this module
1619     MANDATORY-GROUPS {
1620         ciuImageUpgradeGroup,
1621         ciuImageVariableGroup,
1622         ciuImageURIGroup,
1623         ciuUpgradeOpGroup,
1624         ciuImageLocInputGroup,
1625         ciuVersionCompChkGroup,
1626         ciuUpgradeImageVersionGroup,
1627         ciuUpgradeOpStatusGroup,
1628         ciuUpgradeNotificationGroup,
1629         ciuUpgradeNotificationGroupSup,
1630         ciuUpgradeMiscGroup,
1631         ciuUpgradeMiscInfoGroup,
1632         ciuUpgradeOpNewGroup
1633     }
1634
1635     OBJECT  ciuUpgradeTargetEntryStatus
1636     SYNTAX  INTEGER {
1637                     active(1),
1638                     createAndGo(4),
1639                     destroy(6)}
1640     DESCRIPTION
1641         "Only three values 'createAndGo', 'destroy' and 'active'
1642         out of the six enumerated values need to be supported."
1643
1644     OBJECT ciuImageLocInputEntryStatus
1645     SYNTAX  INTEGER {
1646                     active(1),
1647                     createAndGo(4),
1648                     destroy(6)}
1649     DESCRIPTION
1650         "Only three values 'createAndGo', 'destroy' and 'active'
1651         out of the six enumerated values need to be supported."
1652
1653     OBJECT ciuImageLocInputURI
1654     DESCRIPTION
1655         "It is compliant to support a maximum value for this
1656         object which is smaller than the defined maximum value."
1657
1658     GROUP ciuUpgradeTargetGroup
1659     DESCRIPTION
1660         "Implementation of this group is optional. For some systems
1661         all the required modules in the system would be upgraded
1662         in response to ciuUpgradeOpCommand. In such cases,
1663         implementation of this group is optional."
1664
1665     ::= { ciuImageUpgradeCompliances 5 }
1666
1667-- Units of Conformance
1668
1669ciuImageUpgradeGroup OBJECT-GROUP
1670     OBJECTS {
1671               ciuTotalImageVariables
1672     }
1673     STATUS current
1674     DESCRIPTION
1675         "A collection of objects providing information about Image
1676          upgrade. "
1677     ::= { ciuImageUpgradeGroups 1 }
1678
1679ciuImageVariableGroup OBJECT-GROUP
1680     OBJECTS {
1681               ciuImageVariableName
1682     }
1683     STATUS current
1684     DESCRIPTION
1685         "A group containing an object providing information about
1686          the type of the system images."
1687     ::= { ciuImageUpgradeGroups 2 }
1688
1689ciuImageURIGroup OBJECT-GROUP
1690     OBJECTS {
1691               ciuImageURI
1692     }
1693     STATUS current
1694     DESCRIPTION
1695         "A group containing an object providing information about
1696          the name of system variable or parameter."
1697     ::= { ciuImageUpgradeGroups 3 }
1698
1699ciuUpgradeOpGroup OBJECT-GROUP
1700     OBJECTS {
1701               ciuUpgradeOpCommand,
1702               ciuUpgradeOpStatus,
1703               ciuUpgradeOpNotifyOnCompletion,
1704               ciuUpgradeOpTimeStarted,
1705               ciuUpgradeOpTimeCompleted,
1706               ciuUpgradeOpAbort,
1707               ciuUpgradeOpStatusReason
1708     }
1709     STATUS current
1710     DESCRIPTION
1711         "A collection of objects for Upgrade operation."
1712     ::= { ciuImageUpgradeGroups 4 }
1713
1714ciuUpgradeTargetGroup OBJECT-GROUP
1715     OBJECTS {
1716               ciuUpgradeTargetAction,
1717               ciuUpgradeTargetEntryStatus
1718     }
1719     STATUS current
1720     DESCRIPTION
1721         "A collection of objects giving the modules and the type
1722         of image to be upgraded."
1723     ::= { ciuImageUpgradeGroups 5 }
1724
1725ciuImageLocInputGroup OBJECT-GROUP
1726     OBJECTS {
1727               ciuImageLocInputURI,
1728               ciuImageLocInputEntryStatus
1729     }
1730     STATUS current
1731     DESCRIPTION
1732         "A collection of objects giving the location of the images
1733         to be upgraded."
1734     ::= { ciuImageUpgradeGroups 6 }
1735
1736ciuVersionCompChkGroup OBJECT-GROUP
1737     OBJECTS {
1738               ciuVersionCompImageSame,
1739               ciuVersionCompUpgradable,
1740               ciuVersionCompUpgradeAction,
1741               ciuVersionCompUpgradeBios,
1742               ciuVersionCompUpgradeBootrom,
1743               ciuVersionCompUpgradeLoader,
1744               ciuVersionCompUpgradeImpact,
1745               ciuVersionCompUpgradeReason
1746             }
1747     STATUS current
1748     DESCRIPTION
1749         "A collection of objects showing the results of the
1750         version compatibility check done."
1751     ::= { ciuImageUpgradeGroups 7 }
1752
1753ciuUpgradeImageVersionGroup OBJECT-GROUP
1754     OBJECTS {
1755               ciuUpgradeImageVersionVarName,
1756               ciuUpgradeImageVersionRunning,
1757               ciuUpgradeImageVersionNew,
1758               ciuUpgradeImageVersionUpgReqd
1759             }
1760     STATUS current
1761     DESCRIPTION
1762         "A collection of objects showing the current running images
1763         and the images to be upgraded with."
1764     ::= { ciuImageUpgradeGroups 8 }
1765
1766ciuUpgradeOpStatusGroup OBJECT-GROUP
1767     OBJECTS {
1768               ciuUpgradeOpStatusOperation,
1769               ciuUpgradeOpStatusModule,
1770               ciuUpgradeOpStatusSrcImageLoc,
1771               ciuUpgradeOpStatusDestImageLoc,
1772               ciuUpgradeOpStatusJobStatus,
1773               ciuUpgradeOpStatusPercentCompl,
1774               ciuUpgradeOpStatusJobStatusReas
1775             }
1776     STATUS current
1777     DESCRIPTION
1778         "A collection of objects showing the status of the upgrade
1779         operation."
1780     ::= { ciuImageUpgradeGroups 9 }
1781
1782ciuUpgradeNotificationGroup        NOTIFICATION-GROUP
1783     NOTIFICATIONS {
1784               ciuUpgradeOpCompletionNotify
1785     }
1786     STATUS current
1787     DESCRIPTION
1788            "A collection of notifications for upgrade operations. "
1789     ::= { ciuImageUpgradeGroups  10 }
1790
1791ciuUpgradeMiscGroup OBJECT-GROUP
1792     OBJECTS {
1793               ciuUpgradeMiscAutoCopy
1794     }
1795     STATUS current
1796     DESCRIPTION
1797         "A collection of objects for Miscelleneous operation."
1798     ::= { ciuImageUpgradeGroups 11 }
1799
1800ciuUpgradeMiscInfoGroup OBJECT-GROUP
1801     OBJECTS {
1802               ciuUpgradeMiscInfoModule,
1803               ciuUpgradeMiscInfoDescr
1804     }
1805     STATUS current
1806     DESCRIPTION
1807         "A collection of objects for Miscelleneous info for upgrade
1808         operation."
1809     ::= { ciuImageUpgradeGroups 12 }
1810
1811ciuUpgradeNotificationGroupSup        NOTIFICATION-GROUP
1812     NOTIFICATIONS {
1813               ciuUpgradeJobStatusNotify
1814     }
1815     STATUS current
1816     DESCRIPTION
1817            "A collection of notifications for upgrade operations. "
1818     ::= { ciuImageUpgradeGroups  13 }
1819
1820ciuUpgradeOpNewGroup OBJECT-GROUP
1821     OBJECTS {
1822               ciuUpgradeJobStatusNotifyOnCompletion,
1823               ciuUpgradeOpLastCommand,
1824               ciuUpgradeOpLastStatus,
1825               ciuUpgradeOpLastStatusReason
1826     }
1827     STATUS current
1828     DESCRIPTION
1829         "A collection of objects for Upgrade operation."
1830     ::= { ciuImageUpgradeGroups 14 }
1831
1832END
1833
1834
1835
1836