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
|
-- ============================================================================
-- at-license.mib, Allied Telesis enterprise MIB:
-- License MIB for the AlliedWare Plus(tm) operating system
--
-- Copyright (c) 2008 by Allied Telesis, Inc.
-- All rights reserved.
--
-- ============================================================================
AT-LICENSE-MIB DEFINITIONS ::= BEGIN
IMPORTS
sysinfo
FROM AT-SMI-MIB
Integer32, OBJECT-TYPE, MODULE-IDENTITY
FROM SNMPv2-SMI
DisplayString, RowStatus, TruthValue
FROM SNMPv2-TC;
license MODULE-IDENTITY
LAST-UPDATED "201404290000Z"
ORGANIZATION
"Allied Telesis Labs New Zealand"
CONTACT-INFO
"http://www.alliedtelesis.com"
DESCRIPTION
"The license MIB, for listing applied software licenses, adding
new licenses, and deleting existing licenses."
REVISION "201404290000Z"
DESCRIPTION
"Added more descriptions to the baseLicenseStackId and
licenseStackId"
REVISION "201009070000Z"
DESCRIPTION
"Generic syntax tidy up"
REVISION "201008300000Z"
DESCRIPTION
"Added support for adding or deleting a license to/from all
devices in a stack, using a single operation."
REVISION "201006140509Z"
DESCRIPTION
"MIB revision history dates in descriptions updated."
REVISION "200811100000Z"
DESCRIPTION
"Initial revision."
::= { sysinfo 22 }
--
-- Node definitions
--
-- ---------------------------------------------------------- --
-- The Base Software License Table
-- ---------------------------------------------------------- --
baseLicenseTable OBJECT-TYPE
SYNTAX SEQUENCE OF BaseLicenseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table representing the installed base software licenses on the device."
::= { license 1 }
baseLicenseEntry OBJECT-TYPE
SYNTAX BaseLicenseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Each entry represents the base software license on a device."
INDEX { baseLicenseStackId }
::= { baseLicenseTable 1 }
BaseLicenseEntry ::=
SEQUENCE {
baseLicenseStackId
Integer32,
baseLicenseName
DisplayString,
baseLicenseQuantity
Integer32,
baseLicenseType
DisplayString,
baseLicenseIssueDate
DisplayString,
baseLicenseExpiryDate
DisplayString,
baseLicenseFeatures
OCTET STRING
}
baseLicenseStackId OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index of the base license entry.
The stack member ID is used as an index to search the table."
::= { baseLicenseEntry 1 }
baseLicenseName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the base license."
::= { baseLicenseEntry 2 }
baseLicenseQuantity OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of licenses issued for this entry."
::= { baseLicenseEntry 3 }
baseLicenseType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of base license issued."
::= { baseLicenseEntry 4 }
baseLicenseIssueDate OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date of issue of the base license."
::= { baseLicenseEntry 5 }
baseLicenseExpiryDate OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date that the base license expires on."
::= { baseLicenseEntry 6 }
baseLicenseFeatures OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The featureset that this license enables. Each bit in the returned octet
string represents a particular feature that can be license-enabled.
The bit position within the string maps to the feature entry with the
same index, in licenseFeatureTable. A binary '1' indicates that the
feature is included in the license, with a '0' indicating that it is not "
::= { baseLicenseEntry 7 }
-- ---------------------------------------------------------- --
-- The Installed Software License Table
-- ---------------------------------------------------------- --
licenseTable OBJECT-TYPE
SYNTAX SEQUENCE OF LicenseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table representing the installed software licenses on the device."
::= { license 2 }
licenseEntry OBJECT-TYPE
SYNTAX LicenseEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Each entry represents a single installed software license on the device."
INDEX { licenseStackId, licenseIndex }
::= { licenseTable 1 }
LicenseEntry ::=
SEQUENCE {
licenseStackId
Integer32,
licenseIndex
Integer32,
licenseName
DisplayString,
licenseCustomer
DisplayString,
licenseQuantity
Integer32,
licenseType
DisplayString,
licenseIssueDate
DisplayString,
licenseExpiryDate
DisplayString,
licenseFeatures
OCTET STRING,
licenseRowStatus
RowStatus
}
licenseStackId OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index of the license entry.
The stack member ID is used as an index to search the table."
::= { licenseEntry 1 }
licenseIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index of the license entry."
::= { licenseEntry 2 }
licenseName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the license."
::= { licenseEntry 3 }
licenseCustomer OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the customer of the license."
::= { licenseEntry 4 }
licenseQuantity OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The number of licenses issued for this entry."
::= { licenseEntry 5 }
licenseType OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The type of license issued."
::= { licenseEntry 6 }
licenseIssueDate OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date of issue of the license."
::= { licenseEntry 7 }
licenseExpiryDate OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The date that the license expires on."
::= { licenseEntry 8 }
licenseFeatures OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The featureset that this license enables. Each bit in the returned octet
string represents a particular feature that can be license-enabled.
The bit position within the string maps to the feature entry with the
same index, in licenseFeatureTable. A binary '1' indicates that the
feature is included in the license, with a '0' indicating that it is not "
::= { licenseEntry 9 }
licenseRowStatus OBJECT-TYPE
SYNTAX RowStatus
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The current status of the license. The following values may be returned
when reading this object:
active (1) - The license is currently installed and valid.
notInService (2) - The license has expired or is invalid.
The following values may be written to this object:
destroy (6) - The license will be removed from the device -
this may result in some features being
disabled. Note that a stacked device that has a
license de-installed on it may not be able to
rejoin the stack after reboot, unless the license
is also de-installed on all other devices in the
stack."
::= { licenseEntry 10 }
-- ---------------------------------------------------------- --
-- The Available Software Features Table
-- ---------------------------------------------------------- --
licenseFeatureTable OBJECT-TYPE
SYNTAX SEQUENCE OF LicenseFeatureEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of all features that must be license-enabled to be utilised on
the device."
::= { license 3 }
licenseFeatureEntry OBJECT-TYPE
SYNTAX LicenseFeatureEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Each entry represents a single feature that must be license-enabled in
order to be utilised on the device."
INDEX { licenseFeatureIndex }
::= { licenseFeatureTable 1 }
LicenseFeatureEntry ::=
SEQUENCE {
licenseFeatureIndex
Integer32,
licenseFeatureName
DisplayString,
licenseFeatureStkMembers
OCTET STRING
}
licenseFeatureIndex OBJECT-TYPE
SYNTAX Integer32 (1..2147483647)
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"The index of the feature which must be license-enabled."
::= { licenseFeatureEntry 1 }
licenseFeatureName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the feature under licensing control."
::= { licenseFeatureEntry 2 }
licenseFeatureStkMembers OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"A bitmap with each bit representing an individual stacking
member. Bit one represents stacking member one etc.
A bit value of '1' indicates that the applicable feature is
enabled on the matching device. A '0' indicates that it is
disabled."
::= { licenseFeatureEntry 3 }
-- ---------------------------------------------------------- --
-- Objects to install a new software license.
-- ---------------------------------------------------------- --
licenseNew OBJECT IDENTIFIER ::= { license 4 }
licenseNewStackId OBJECT-TYPE
SYNTAX Integer32 (0..2147483647)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The stack ID of the member upon which the new license is to be
installed. Setting this object to the value zero, will result
in the license being installed on all stack members."
::= { licenseNew 1 }
licenseNewName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The name of the new license to be installed."
::= { licenseNew 2 }
licenseNewKey OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The key for the new license to be installed."
::= { licenseNew 3 }
licenseNewInstall OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is used to install a new software license on the
device. To commence installation, a valid license name and key
must first have been set via the licenseNewName and
licenseNewKey objects respectively. The current value of
licenseNewInstallStatus must also be idle(1), indicating that
no other license installation operation is in progress. This
object should then be set to the value true(1).
The status of the installation operation can be determined by
reading object licenseNewInstallStatus. Once installed, the
software modules affected by any newly enabled features will
automatically be restarted.
Note that a stacked device that has a new license installed on
it may not be able to rejoin the stack after reboot, unless the
license is also added to all other devices in the stack.
When read, the object shall always return false(2)."
::= { licenseNew 4 }
licenseNewInstallStatus OBJECT-TYPE
SYNTAX INTEGER {
idle(1),
processing(2),
success(3),
failure(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Shows the current status of the last requested license
installation request. One of the following values will be
returned:
idle (1) - No new operation has been requested.
processing (2) - The last request is in progress.
success (3) - The last request was successful.
failure (4) - The last request failed.
Upon completion of a stack license installation operation, the
first read of this object will return a success/failure
indication. Subsequent reads will then return idle(1)."
::= { licenseNew 5 }
-- ---------------------------------------------------------- --
-- Objects to remove a software license from all stack members
-- on which it exists.
-- ---------------------------------------------------------- --
licenseStackRemove OBJECT IDENTIFIER ::= { license 5 }
licenseStackRemoveName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The name of the license to be removed from all stack members on
which it currently exists. All existing licenses with the given
name must activate the same feature set, in order for the
removal operation to be successful."
::= { licenseStackRemove 1 }
licenseStackRemoveExecute OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is used to remove a new license from all stack
members on which it exists. To commence removal, a valid
license name must first have been set via
licenseStackRemoveName. The current value of
licenseStackRemoveStatus must also be idle(1), indicating that
no other license installation operation is in progress. This
object should then be set to the value true(1).
The status of the removal operation can be determined by
reading object licenseStackRemoveStatus. Once removed, the
software modules affected by any newly disabled features will
automatically be restarted.
When read, the object shall always return false(2)."
::= { licenseStackRemove 2 }
licenseStackRemoveStatus OBJECT-TYPE
SYNTAX INTEGER {
idle(1),
processing(2),
success(3),
failure(4)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Shows the current status of the last requested stack license
removal request. One of the following values will be returned:
idle (1) - No new removal operation has been requested.
processing (2) - The last request is in progress.
success (3) - The last request was successful.
failure (4) - The last request failed.
Upon completion of a stack license removal operation, the first
read of this object will return a success/failure indication.
Subsequent reads will then return idle(1)."
::= { licenseStackRemove 3 }
END
--
-- at-license.mib
--
|
