forked from simonjj/SnmpMibs
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathCISCO-LICENSE-MGMT-MIB.mib
2242 lines (2005 loc) · 90.7 KB
/
CISCO-LICENSE-MGMT-MIB.mib
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
-- *********************************************************************
-- CISCO-LICENSE-MGMT-MIB.my: Cisco MIB to manage licenses on
-- Cisco devices
--
-- July 2006, Sunil Gudurvalmiki
--
-- Copyright (c) 2006-2007 by Cisco Systems Inc.
-- All rights reserved.
--
-- ********************************************************************
CISCO-LICENSE-MGMT-MIB DEFINITIONS ::= BEGIN
IMPORTS
OBJECT-TYPE,
MODULE-IDENTITY,
Unsigned32,
NOTIFICATION-TYPE
FROM SNMPv2-SMI
MODULE-COMPLIANCE,
OBJECT-GROUP,
NOTIFICATION-GROUP
FROM SNMPv2-CONF
TEXTUAL-CONVENTION,
TruthValue,
RowStatus,
StorageType
FROM SNMPv2-TC
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
entPhysicalIndex,
PhysicalIndexOrZero
FROM ENTITY-MIB
InetAddressType,
InetAddress
FROM INET-ADDRESS-MIB
ciscoMgmt
FROM CISCO-SMI;
ciscoLicenseMgmtMIB MODULE-IDENTITY
LAST-UPDATED "200610030000Z"
ORGANIZATION "Cisco Systems Inc."
CONTACT-INFO
"Cisco Systems
Customer Service
Postal: 170 W Tasman Drive
San Jose, CA 95134
USA
Tel: +1 800 553 -NETS
E-mail: cs-snmp@cisco.com"
DESCRIPTION
"The MIB module for managing licenses on the system.
The licensing mechanism provides flexibility to
enforce licensing for various features in the system.
The following text introduces different concepts and
terms those are necessary to understand the MIB definition
and to perform license management.
UDI
Universal Device Identifier that uniquely identifies a
device. It comprises of product ID, version ID and serial
number of the device.
NODE LOCKED LICENSE:
Node locked licenses are locked to one of the device
identifiers in the system. For example, the license
can be locked to the UDI value of one of the devices
in the system. Locking a license to an UDI guarantees
that the license will not be moved to a device with a
different UDI.
NON-NODE LOCKED LICENSE:
Non-node locked licenses are not locked to any device
identifier. They can be used on other similar devices.
METERED LICENSE:
Metered licenses are valid for limited period of time
and they expire after that. This period is the usage
period of a license and it is not based on real time
clock, but system clock.
EULA:
End User License Agreement.
EVALUATION LICENSE:
Evaluation licenses are non-node locked metered
licenses which are valid only for a limited period.
They are used only when there are no permanent,
extension or grace period licenses for a feature.
User will have to accept EULA (End User License
Agreement) before using an evaluation license. Even
though they are not node locked, their usage is
recorded on the device.
EXTENSION LICENSE:
Extension licenses are node locked metered licenses.
These licenses are issued by Cisco's licensing portal.
These licenses need to be installed using management
interfaces on the device. User will have to accept an
EULA as part of installation of extension license.
GRACE PERIOD LICENSE:
Grace period licenses are node locked metered licenses.
These licenses are issued by Cisco's licensing portal
as part of the permission ticket to rehost a license.
These licenses are installed on the device as part of
the rehost operation. User will have to accept an
EULA as part of the rehost operation for this type
of license. Details on permission ticket, rehost
operations are provided further down in this
description clause.
PERMANENT LICENSE:
Permanent licenses are node locked licenses that have
no usage period associated with them. These licenses
are issued by Cisco's licensing portal. These licenses
need to be installed using management interfaces on
the device. Once these licenses are installed, they
will provide needed permission for the feature/image
across different versions.
COUNTED LICENSE:
Counted licenses limit the number of similar entities
that can use the license. For example, a counted
license when used by a feature can limit the number
of IP phones that can connect or the number of tunnels
that can be created.
UNCOUNTED LICENSE:
Uncounted licenses do not limit the number of similar
entities that can use the licenses.
License can be enforced at the image level or at the feature
level and this MIB module supports both.
IMAGE LEVEL LICENSING:
A universal image that contains all levels of
software packages is loaded on to the device. At boot
time, the device determines the highest level of license
and brings up the appropriate software features or
subsystems.
FEATURE LEVEL LICENSING:
Feature level licensing will support enforcement of
license at individual feature. Features have to check
for their licenses before enabling themselves. If it
does not have a license, the feature should disable
itself.
There is a one-to-one relationship between
a feature and a license. That is, a feature can use
only one license at a time and a license can be used
by only one feature at a time.
LICENSE LINE:
A License line is an atomic set of ASCII characters
arranged in a particular format that holds the license
for a single feature within it. A line has all the
necessary fields and attributes that make it a valid,
non-tamper able and complete license.
LICENSE FILE:
File generated by Cisco licensing portal. It is used
to install license on product. It has a user readable
part and it contains one or more license lines.
DEVICE CREDENTIALS:
Device credentials file is a document that is generated
by a licensed device. This document establishes the
identity of the device and proves that the sender/user
has/had authorized access to the device.
REHOST:
Rehost operation allows a node locked license that
is installed on a device to be installed on other
similar device. As part of rehost operation, a device
processes the permission ticket, revokes the license(s)
on the device and generates a rehost ticket as the
proof of revocation. This rehost ticket needs to be
presented to the Cisco's licensing portal to get the
license transferred on to a new similar device.
PERMISSION TICKET:
Permission ticket is a document generated by Cisco
licensing portal that allows a device to rehost its
licenses.
REHOST TICKET:
Rehost ticket is document generated by a device after
it has applied a permission ticket. The rehost ticket
is a proof of revocation.
LICENSING PORTAL:
Generates licenses, permission tickets and verifies
device credentials and rehost tickets.
This MIB module provides MIB objects to install, clear,
revoke licenses. It also provides objects to regenerate
last rehost ticket, backup all the licenses installed
on a device, generate & export EULA for licenses.
STEPS TO INSTALL A LICENSE:
To install a license, the management application
1. Retrieves device credentials of the device.
2. Communicates with Cisco's licensing portal to get
the license file, uses device credentials to identify
the device
3. Executes the license install action.
STEPS TO CLEAR A LICENSE:
To clear a license, the management application
1. Identifies the license to be cleared using license
index.
2. Executes the license clear action.
STEPS TO REHOST A LICENSE:
To rehost a license, the management application
1. Retrieves device credentials of the device.
2. Communicates with Cisco's licensing portal to get
the permission ticket, uses device credentials to
identify the device.
3. Executes the processPermissionTicket action. Device
revokes the license and generates rehost ticket to be
submitted as proof of revocation.
4. Retrieves device credentials of the device where the
license needs to be transferred to.
5. Submits rehost ticket as proof of revocation to
Cisco's licensing portal, uses device credentials of
the new device to identify the device, gets license
file.
6. Executes the license install action on the new
device.
STEPS TO REGENERATE LAST REHOST TICKET:
To regenerate last rehost ticket, the management
application
1. Retrieves device credentials of the device.
2. Uses already obtained permission ticket or
communicates with Cisco's licensing portal to get
the permission ticket, uses device credentials to
identify the device.
3. Executes the regenerateLastRehostTicket action.
Device generates rehost ticket to be submitted as
proof of revocation.
STEPS TO BACKUP ALL LICENSES:
To backup all licenses installed in the device, the
management application
1. Specifies the backup file path.
2. Executes the license backup action.
STEPS TO GENERATE & EXPORT EULA:
To install certain kind of licenses, the management
application must accept EULA first. The management
application can generate and export EULA for one or
more licenses with out installing licenses as follows.
1. Specifies the license file path that has licenses to be
installed
2. Specifies the EULA file path where EULA need to be
exported to
3. Executes the generate EULA action.
To support the various license actions, this MIB module
also defines MIB objects to know if a device supports
licensing, retrieve device credentials, retrieve
information on license stores in the device.
It also defines MIB objects to expose management
information associated with the licenses installed on the
device, with the licensable features in the software image.
This MIB module also defines various notifications that
will be triggered to asynchronously notify the management
application of any critical events.
This MIB module is defined generically so it can be
implemented on stand alone devices or stack of devices.
In stack of devices, one device in the stack acts as
master agent and rest are slave agents. Each device in the
stack has its own UDI. The master agent receives requests
on behalf of all the devices in the stack including itself
and delegates it to other devices as needed. It also
collects responses from other devices and sends them to
the management application. Examples of such devices include
stackable switches, devices with route processor and line
cards. On the other hand, stand alone device is a single
device and has only one UDI associated with it.
entPhysicalIndex imported from ENTITY-MIB is used to
identify the device uniquely. It is specified as the index
or one of the index for tables in this MIB as needed."
REVISION "200610030000Z"
DESCRIPTION
"Initial version of this MIB module."
::= { ciscoMgmt 543 }
ciscoLicenseMgmtMIBNotifs OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIB 0 }
ciscoLicenseMgmtMIBObjects OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIB 1 }
ciscoLicenseMgmtMIBConform OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIB 2 }
clmgmtLicenseConfiguration OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIBObjects 1 }
clmgmtLicenseInformation OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIBObjects 2 }
clmgmtLicenseDeviceInformation OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIBObjects 3 }
clmgmtLicenseNotifObjects OBJECT IDENTIFIER
::= { ciscoLicenseMgmtMIBObjects 4 }
ClmgmtLicenseIndex ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"A unique value, for each license in the managed system.
It is not necessary to have values assigned contiguously.
The value for each license must remain constant
at least from one re-initialization of the entity's
network management system to the next re-initialization"
SYNTAX Unsigned32 (1..4294967295 )
ClmgmtLicenseIndexOrZero ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"This textual convention is an extension of the ClmgmtLicenseIndex
convention. The latter defines a greater than zero value
used to identify a license in the managed system. This
extension permits the additional value of zero. The value
zero is object-specific and must therefore be defined as
part of the description of any object which uses this
syntax. Examples of the usage of zero might include
situations where license was not present or unknown."
SYNTAX Unsigned32
ClmgmtLicenseTransferProtocol ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The transfer protocol that should be used for copying files
when performing license management. When the protocol is
set to local(2), local file system (flash or disk) is used.
Different agents may support different transfer protocols
and the management application is expected to some how determine
which protocol is supported and use."
SYNTAX INTEGER {
none(1),
local(2),
tftp(3),
ftp(4),
rcp(5),
http(6),
scp(7),
sftp(8)
}
ClmgmtLicenseActionState ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"The state of license action execution.
none(1) - action is not yet scheduled to be
executed.
pending(2) - All the required parameters for the
action are set and the action is
scheduled to be executed.
inProgress(3) - action execution has started and is
in progress.
successful(4) - action has completed successfully.
partiallySuccessful(5) - action has completed, but was
partially successful. Management
application can query additional MIB
objects to know what is successful
and what has failed. These addtional
objects are listed in the
description of the corresponding
action tables.
failed(6) - action has failed."
SYNTAX INTEGER {
none(1),
pending(2),
inProgress(3),
successful(4),
partiallySuccessful(5),
failed(6)
}
ClmgmtLicenseActionFailCause ::= TEXTUAL-CONVENTION
STATUS current
DESCRIPTION
"Reason for license action failure. Defines error codes for
all the license actions.
none(1) - action execution has not
started yet. If the action
is completed and the action
is successful, then also
none(1) is returned to
indicate that there are no
errors.
generalFailure(2) - General licensing failure.
This will be used for resource
unavailability failures.
Ex: Lack of memory.
transferProtocolNotSupported(3) - protocol selected is not
supported.
fileServerNotReachable(4) - file server is not reachable.
unrecognizedEntPhysicalIndex(5) - entPhysicalIndex is not
valid
invalidLicenseFilePath(6) - The license file path is not
accessible.
invalidLicenseFile(7) - Contents of license file are
not valid.
invalidLicenseLine(8) - License string in the license
file is not valid.
licenseAlreadyExists(9) - Management application is trying
to install a license that already
exists.
licenseNotValidForDevice(10) - This license is not valid for
the device/entPhysicalIndex
specified.
invalidLicenseCount(11) - Invalid count for this counted
license.
invalidLicensePeriod(12) - Validity period is invalid for
this expiring license.
licenseInUse(13) - License file is in use by a
feature/image.
invalidLicenseStore(14) - License store is not valid.
licenseStorageFull(15) - There is no more space in the
license storage.
invalidPermissionTicketFile(16) - The permission ticket file
path is not accecssible.
invalidPermissionTicket(17) - The permission ticket file
contents are not valid.
invalidRehostTicketFile(18) - The rehost ticket file path is
not accessible.
invalidRehostTicket(19) - The rehost ticket file contents
are not valid.
invalidLicenseBackupFile(20) - License backup store path
is not accessible.
licenseClearInProgress(21) - When license clear action is
in progress, license backup
action is not permitted to
avoid race conditions. This
error code is sent back in
response to a license backup
action when a license clear
action is in progress or in
pending state. Try again in few
seconds.
invalidLicenseEULAFile(22) - EULA file path is not accessible."
SYNTAX INTEGER {
none(1),
generalFailure(2),
transferProtocolNotSupported(3),
fileServerNotReachable(4),
unrecognizedEntPhysicalIndex(5),
invalidLicenseFilePath(6),
invalidLicenseFile(7),
invalidLicenseLine(8),
licenseAlreadyExists(9),
licenseNotValidForDevice(10),
invalidLicenseCount(11),
invalidLicensePeriod(12),
licenseInUse(13),
invalidLicenseStore(14),
licenseStorageFull(15),
invalidPermissionTicketFile(16),
invalidPermissionTicket(17),
invalidRehostTicketFile(18),
invalidRehostTicket(19),
invalidLicenseBackupFile(20),
licenseClearInProgress(21),
invalidLicenseEULAFile(22)
}
clmgmtNextFreeLicenseActionIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295 )
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object contains appropriate value for
clmgmtLicenseActionIndex that can be used to create
an entry in clmgmtLicenseActionTable. The management application
should read this object first and then use this as the
value for clmgmtLicenseActionIndex to avoid collisions
when creating entries in clmgmtLicenseActionTable.
Following this approach does not guarantee collision free
row creation, but will reduce the probability. The
collision will happen if two management applications read this
object at the same time and attempt to create an entry
with this value at the same time. In this case, the
management application whose request is processed after the first
request will get an error and the process of reading this object
and entry creation needs to be repeated."
::= { clmgmtLicenseConfiguration 1 }
-- Table for executing license management actions.
clmgmtLicenseActionTable OBJECT-TYPE
SYNTAX SEQUENCE OF ClmgmtLicenseActionEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table for invoking license management actions. Management
application must create a row in this table to trigger any of
the license management actions. The following are different
actions that can be executed using this table.
1. install
2. clear
3. processPermissionTicket
4. regenerateLastRehostTicket
5. backup
6. generateEULA
Refer to the description of clmgmtLicenseAction for more
information on what these actions do on the device.
Once the request completes, the management application should
retrieve the values of the objects of interest, and then
delete the entry. In order to prevent old entries from
clogging the table, entries will be aged out, but an entry
will never be deleted within 5 minutes of completion."
::= { clmgmtLicenseConfiguration 2 }
clmgmtLicenseActionEntry OBJECT-TYPE
SYNTAX ClmgmtLicenseActionEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry for each action that is being executed or was
executed recently. The management application executes an
action
by creating this entry. This can be done in the following
2 methods
1. CREATE-AND-GO method
Management application sets clmgmtLicenseActionRowStatus to
createAndGo(4) and all other required objects to valid
values in a single SNMP SET request. If all the values
are valid, the device creates the entry and executes the
action. If the SET request fails, the entry will not be
created.
2. CREATE-AND-WAIT method
Management application sets clmgmtLicenseActionRowStatus to
createAndWait(5) to create an entry. Management application
can set all other required objects to valid
values in more than one SNMP SET request. If SET request
for any of the objects fails, management application can
set
just only that object. Once all the required objects
are set to valid values, management application triggers
action
execution by setting clmgmtLicenseActionRowStatus to
active(1).
To stop the action from being executed, the management
application
can delete the entry by setting clmgmtLicenseActionRowStatus
to destroy(6) when clmgmtLicenseActionState is pending(2).
The status of action execution can be known by querying
clmgmtLicenseActionState. If the action is still in
pending(2) or in inProgress(3) state, the management
application need to check back again after few seconds.
Once the action completes and status of the action is
failed(6), the reason for failure can be retrieved
from clmgmtLicenseActionFailCause. If the status of the
action is partiallySuccessful(5), results of individual
licenses can be queried from clmgmtLicenseActionResultTable.
Not all objects in the entry are needed to execute every
action. Below is the list of actions and the required
objects that are needed to be set for executing that
action.
1. Installing a license
The following MIB objects need to be set for installing a
license
a. clmgmtLicenseActionTransferProtocol
b. clmgmtLicenseServerAddressType
c. clmgmtLicenseServerAddress
d. clmgmtLicenseServerUsername
e. clmgmtLicenseServerPassword
f. clmgmtLicenseFile
g. clmgmtLicenseStore
h. clmgmtLicenseStopOnFailure
i. clmgmtLicenseAcceptEULA
j. clmgmtLicenseAction
clmgmtLicenseActionEntPhysicalIndex need not be set
explicitly for license installs. License itself identifes
the device where the license needs to be installed.
clmgmtLicenseStore need to be set to store the licenses
in a non-default license store. But, if a license file
has more than one license and licenses need to be
installed on multiple devices (for example to multiple
members with in a stack), then value of clmgmtLicenseStore
is ignored and the licenses will be installed in default
license stores of the respective devices.
2. Clearing a license
The following MIB objects need to be set for clearing a
license
a. clmgmtLicenseActionEntPhysicalIndex
b. clmgmtLicenseActionLicenseIndex
c. clmgmtLicenseStore
d. clmgmtLicenseAction
3. Revoking a license
The following MIB objects need to be set for revoking a
license
a. clmgmtLicenseActionTransferProtocol
b. clmgmtLicenseServerAddressType
c. clmgmtLicenseServerAddress
d. clmgmtLicenseServerUsername
e. clmgmtLicenseServerPassword
f. clmgmtLicensePermissionTicketFile
g. clmgmtLicenseRehostTicketFile
h. clmgmtLicenseStopOnFailure
i. clmgmtLicenseAction
4. Regenerate last rehost ticket
The following MIB objects need to be set for regenerating
last rehost ticket
a. clmgmtLicenseActionTransferProtocol
b. clmgmtLicenseServerAddressType
c. clmgmtLicenseServerAddress
d. clmgmtLicenseServerUsername
e. clmgmtLicenseServerPassword
f. clmgmtLicensePermissionTicketFile
g. clmgmtLicenseRehostTicketFile
h. clmgmtLicenseStopOnFailure
i. clmgmtLicenseAction
5. Save all licenses to a backup storage
The following MIB objects need to be set for storing all
licenses to a backup store
a. clmgmtLicenseActionEntPhysicalIndex
b. clmgmtLicenseActionTransferProtocol
c. clmgmtLicenseServerAddressType
d. clmgmtLicenseServerAddress
e. clmgmtLicenseServerUsername
f. clmgmtLicenseServerPassword
g. clmgmtLicenseBackupFile
h. clmgmtLicenseAction
6. Generate and export EULA if the licenses need EULA to be
accepted for installing.
The following MIB objects need to be set exporting required
EULAs
a. clmgmtLicenseActionTransferProtocol
b. clmgmtLicenseServerAddressType
c. clmgmtLicenseServerAddress
d. clmgmtLicenseServerUsername
e. clmgmtLicenseServerPassword
f. clmgmtLicenseFile
g. clmgmtLicenseEULAFile
h. clmgmtLicenseAction
For any action, if clmgmtLicenseActionTransferProtocol
is set to local(2), the following objects need not be set.
a. clmgmtLicenseServerAddressType
b. clmgmtLicenseServerAddress
c. clmgmtLicenseServerUsername
d. clmgmtLicenseServerPassword
Entry can be deleted except when clmgmtLicenseAction is set
to pending(2). All entries are volatile and are cleared
on agent reset."
INDEX { clmgmtLicenseActionIndex }
::= { clmgmtLicenseActionTable 1 }
ClmgmtLicenseActionEntry ::= SEQUENCE {
clmgmtLicenseActionIndex Unsigned32,
clmgmtLicenseActionEntPhysicalIndex PhysicalIndexOrZero,
clmgmtLicenseActionTransferProtocol ClmgmtLicenseTransferProtocol,
clmgmtLicenseServerAddressType InetAddressType,
clmgmtLicenseServerAddress InetAddress,
clmgmtLicenseServerUsername SnmpAdminString,
clmgmtLicenseServerPassword SnmpAdminString,
clmgmtLicenseFile SnmpAdminString,
clmgmtLicenseStore Unsigned32,
clmgmtLicenseActionLicenseIndex ClmgmtLicenseIndexOrZero,
clmgmtLicensePermissionTicketFile SnmpAdminString,
clmgmtLicenseRehostTicketFile SnmpAdminString,
clmgmtLicenseBackupFile SnmpAdminString,
clmgmtLicenseStopOnFailure TruthValue,
clmgmtLicenseAction INTEGER ,
clmgmtLicenseActionState ClmgmtLicenseActionState,
clmgmtLicenseJobQPosition Unsigned32,
clmgmtLicenseActionFailCause ClmgmtLicenseActionFailCause,
clmgmtLicenseActionStorageType StorageType,
clmgmtLicenseActionRowStatus RowStatus,
clmgmtLicenseAcceptEULA TruthValue,
clmgmtLicenseEULAFile SnmpAdminString
}
clmgmtLicenseActionIndex OBJECT-TYPE
SYNTAX Unsigned32 (1..4294967295 )
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"This object uniquely identifies a row in
clmgmtLicenseActionTable. The management application should choose
this value by reading clmgmtNextFreeLicenseActionIndex
while creating an entry in this table. If an entry already
exists with this index, the creation of the entry will not
continue and error will be returned. The management application
should read the value of clmgmtNextFreeLicenseActionIndex
again and retry with the new value for this object."
::= { clmgmtLicenseActionEntry 1 }
clmgmtLicenseActionEntPhysicalIndex OBJECT-TYPE
SYNTAX PhysicalIndexOrZero
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object represents the entPhysicalIndex of the device
where the action is being executed. This object is mainly
used in devices where one device is acting as a master and
rest of the devices as slaves. The master device is
responsible for SNMP communication with the management
application. Examples include stackable switches, devices
with route processor and line card configuration. If this
object is not set, the license action will be executed on
the master device. Note: This object need not be set if
there is a stand alone device"
DEFVAL { 0 }
::= { clmgmtLicenseActionEntry 2 }
clmgmtLicenseActionTransferProtocol OBJECT-TYPE
SYNTAX ClmgmtLicenseTransferProtocol
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object represents the transfer protocol to be used
when copying files as specified in the following objects.
1. clmgmtLicenseFile
2. clmgmtLicensePermissionTicketFile
3. clmgmtLicenseRehostTicketFile
4. clmgmtLicenseBackupFile
Note: This object need not be set if the all the files
required for the action are in device's local file system."
DEFVAL { none }
::= { clmgmtLicenseActionEntry 3 }
clmgmtLicenseServerAddressType OBJECT-TYPE
SYNTAX InetAddressType
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the transport type of the
address contained in clmgmtLicenseServerAddress object.
This must be set when clmgmtLicenseActionTransferProtocol
is not none(1) or local(2)."
DEFVAL { unknown }
::= { clmgmtLicenseActionEntry 4 }
clmgmtLicenseServerAddress OBJECT-TYPE
SYNTAX InetAddress
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the ip address of the server from
which the files must be read or written to if
clmgmtLicenseActionTransferProtocol is not none(1) or
local(2).
All bits as 0s or 1s for clmgmtLicenseServerAddress are not
allowed.
The format of this address depends on the value of the
clmgmtLicenseServerAddressType object"
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 5 }
clmgmtLicenseServerUsername OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..96))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the remote user name for accessing
files via ftp, rcp, sftp or scp protocols. This object must
be set when the clmgmtLicenseActionTransferProtocol is
ftp(4), rcp(5), scp(7) or sftp(8). If
clmgmtLicenseActionTransferProtocol is rcp(5), the remote
username is sent as the server username in an rcp command
request sent by the system to a remote rcp server."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 6 }
clmgmtLicenseServerPassword OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..96))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the password used by ftp, sftp or
scp for copying a file to/from an ftp/sftp/scp server.
This object must be set when the
clmgmtLicenseActionTransferProtocol is ftp(4) or scp(7)
or sftp(8). Reading it returns a zero-length string for
security reasons."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 7 }
clmgmtLicenseFile OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object represents the location of the license file
on the server identified by clmgmtLicenseServerAddress. This
object MUST be set to a valid value before or concurrently
with setting the value of the clmgmtLicenseAction object to
install(2). For other operations, the value of this
object is not considered, it is irrelevant."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 8 }
clmgmtLicenseStore OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object represents the clmgmtLicenseStoreIndex of the
license store to use within the device. The license store
can be a local disk or flash. A device can have more than
one license stores. If this object is not set, the license
will be stored in the default license store as exposed by
clmgmtDefaultLicenseStore object."
DEFVAL { 0 }
::= { clmgmtLicenseActionEntry 9 }
clmgmtLicenseActionLicenseIndex OBJECT-TYPE
SYNTAX ClmgmtLicenseIndexOrZero
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the the license index of the license
that is the subject of this action. This is used for
identifying a license for performing actions specific to
that license. This object need to be set only if
clmgmtLicenseAction is set to clear(4). The value of this
object is same as the clmgmtLicenseIndex object in
clmgmtLicenseInfoEntry for license that is subject of this
action."
DEFVAL { 0 }
::= { clmgmtLicenseActionEntry 10 }
clmgmtLicensePermissionTicketFile OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the file name of the permission
ticket. This object need to be set only if
clmgmtLicenseAction is set to processPermissionTicket(4)
or regenerateLastRehostTicket(5) actions. The permission
ticket is obtained from Cisco licensing portal to revoke
a license. The management application must set this object
to valid value before invoking the action."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 11 }
clmgmtLicenseRehostTicketFile OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the file where the rehost ticket
generated by the device need to be exported to. The rehost
ticket is generated as a result of processPermissionTicket
and regenerateLastRehostTicket actions. After generating
the rehost ticket, the device exports the rehost ticket
contents to this file. This object need to be set only
if clmgmtLicenseAction is set to processPermissionTicket(4)
or regenerateLastRehostTicket(5) actions."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 12 }
clmgmtLicenseBackupFile OBJECT-TYPE
SYNTAX SnmpAdminString (SIZE (0..255))
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the file where all the licenses in
the device need to be backed up. This object need to be set
only if clmgmtLicenseAction is set to backup(6) and the
management application must set the value of this object
to valid value before invoking action."
DEFVAL { "" }
::= { clmgmtLicenseActionEntry 13 }
clmgmtLicenseStopOnFailure OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates whether the license action should
stop if the action on a license fails. This object is
applicable only if there are more than one licenses
involved in an action."
DEFVAL { false }
::= { clmgmtLicenseActionEntry 14 }
clmgmtLicenseAction OBJECT-TYPE
SYNTAX INTEGER {
noOp(1),
install(2),
clear(3),
processPermissionTicket(4),
regenerateLastRehostTicket(5),
backup(6),
generateEULA(7)
}
MAX-ACCESS read-create
STATUS current
DESCRIPTION
"This object indicates the the command/action to be executed.
Command Remarks
------- -------
noOp(1) No operation will be
performed.
install(2) Installs the license.
clear(3) Clears the license.
processPermissionTicket(4) Processes thee permission
ticket and generates and
exports rehost ticket.
regenerateLastRehostTicket(5) Generates and exports the
last generated rehost
ticket.
backup(6) Backs up all the licenses
installed currently onto a
backup store.
generateEULA(7) Checks whether the licenses
in the license file need EULA
acceptance and uploads the
needed EULA contents to a file."
DEFVAL { noOp }
::= { clmgmtLicenseActionEntry 15 }
clmgmtLicenseActionState OBJECT-TYPE
SYNTAX ClmgmtLicenseActionState
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the state of this license action."
::= { clmgmtLicenseActionEntry 16 }
clmgmtLicenseJobQPosition OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object represents the position of the action
in the license action job queue that is maintained
internally. Only actions in pending(2) state will
be put in the queue until they are executed. By
reading this object, the management application can make
intelligent decision on whether to execute another
action that it is planning on. For example, if there
is already a license clear action in the queue in
pending(2) state, management application can choose to
defer its license back up action to a later time. This
object will return a value of 0 if the action is not in
pending(2) state."
::= { clmgmtLicenseActionEntry 17 }
clmgmtLicenseActionFailCause OBJECT-TYPE
SYNTAX ClmgmtLicenseActionFailCause
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates the reason for this license action
failure. The value of this object is valid only when
clmgmtLicenseActionState is failed(6)."
::= { clmgmtLicenseActionEntry 18 }