This repository has been archived by the owner. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 40
/
AT-FILEv2-MIB
662 lines (530 loc) · 22 KB
/
AT-FILEv2-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
-- ============================================================================
-- AT-FILEv2.MIB, Allied Telesis enterprise MIB:
-- File MIB for the AlliedWare Plus(tm) operating system
--
-- Copyright (c) 2008 by Allied Telesis, Inc.
-- All rights reserved.
--
-- ============================================================================
AT-FILEv2-MIB DEFINITIONS ::= BEGIN
IMPORTS
modules
FROM AT-SMI-MIB
IpAddress, Integer32, OBJECT-TYPE, MODULE-IDENTITY
FROM SNMPv2-SMI
DisplayString
FROM SNMPv2-TC;
-- 1.3.6.1.4.1.207.8.4.4.4.600
atFilev2 MODULE-IDENTITY
LAST-UPDATED "200809240000Z" -- September 24, 2008 at 00:00 GMT
ORGANIZATION
"Allied Telesis Labs New Zealand"
CONTACT-INFO
"http://www.alliedtelesis.com"
DESCRIPTION
"The AT File v2 MIB, for listing file contents of flash, nvs
and sd-cards on local and stacked devices, and copying, moving
and deleting files from local, stacked and remote sources."
REVISION "200809240000Z" -- September 24, 2008 at 00:00 GMT
DESCRIPTION
"Initial revision."
::= { modules 600 }
--
-- Node definitions
--
-- ---------------------------------------------------------- --
-- The options objects
-- ---------------------------------------------------------- --
-- 1.3.6.1.4.1.207.8.4.4.4.600.1
atFilev2TableOptions OBJECT IDENTIFIER::= { atFilev2 1 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.1.1
atFilev2Recursive OBJECT-TYPE
SYNTAX Integer32 (0..1)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set a value of '1' to enable recursive listing of directories
in the atFilev2Table listing."
DEFVAL { 0 }
::= { atFilev2TableOptions 1 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.1.2
atFilev2AllFiles OBJECT-TYPE
SYNTAX Integer32 (0..1)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set a value of '1' to enable listing of all files (including
hidden etc) in the atFilev2Table listing."
DEFVAL { 0 }
::= { atFilev2TableOptions 2 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.1.3
atFilev2Device OBJECT-TYPE
SYNTAX Integer32 (1..3)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set a value that corresponds with the various devices listed
below:
1. Flash (default)
2. Card
3. NVS
Subsequent SNMP queries to the atFilev2Table will use this as
the device to generate a file listing from."
DEFVAL { 1 }
::= { atFilev2TableOptions 3 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.1.4
atFilev2StackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set an integer to correspond to the stack ID of a stack
member.
Subsequent SNMP queries to the atFilev2Table will use this as
the stack member to generate a file listing from.
If running a stand-alone unit, use the default value of 1."
DEFVAL { 1 }
::= { atFilev2TableOptions 4 }
-- ---------------------------------------------------------- --
-- The file table
-- ---------------------------------------------------------- --
-- 1.3.6.1.4.1.207.8.4.4.4.600.2
atFilev2Table OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2Entry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of files present on the device and stack-member
specified by the atFilev2Device and atFilev2StackID objects."
::= { atFilev2 2 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.2.1
atFilev2Entry OBJECT-TYPE
SYNTAX AtFilev2Entry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the list of files containing information about a
single file."
INDEX { atFilev2Filename }
::= { atFilev2Table 1 }
AtFilev2Entry ::=
SEQUENCE {
atFilev2Filename
OCTET STRING,
atFilev2FileSize
Integer32,
atFilev2FileCreationTime
OCTET STRING,
atFilev2FileAttribs
OCTET STRING
}
-- 1.3.6.1.4.1.207.8.4.4.4.600.2.1.1
atFilev2Filename OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the file. Files are sorted in alphabetical order.
Directory names end with / and have a 'd' present in the
atFilev2FileAttribs object.
The filename is truncated at 112 characters due to SNMP OID
length limitations. If two files are not uniquely
distinguishable within the first 112 characters, the listing
will halt after the first file."
::= { atFilev2Entry 1 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.2.1.2
atFilev2FileSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The size of the file in bytes."
::= { atFilev2Entry 2 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.2.1.3
atFilev2FileCreationTime OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"File creation time in the form <MMM DD YYYY HH:MM:SS>.
Eg: Sep 7 2008 06:07:54."
::= { atFilev2Entry 3 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.2.1.4
atFilev2FileAttribs OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The standard file accessibility attributes in the form <drwx>.
d - directory
r - readable
w - writeable
x - executable
If a file does not have a particular attribute set, the
respective position will contain a -. For example, <-r-x>
indicates a readable and executable file that is not a
directory or writeable."
::= { atFilev2Entry 4 }
-- ---------------------------------------------------------- --
-- The file operation objects
-- ---------------------------------------------------------- --
-- 1.3.6.1.4.1.207.8.4.4.4.600.3
atFilev2FileOperation OBJECT IDENTIFIER::= { atFilev2 3 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.1
atFilev2SourceStackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set an integer corresponding to the stack ID of the stack
member to use as the source. This value is ignored if the
source device is set to TFTP.
If running a stand-alone unit, use the default value of 1."
::= { atFilev2FileOperation 1 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.2
atFilev2SourceDevice OBJECT-TYPE
SYNTAX Integer32 (0..4)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set an integer that corresponds with a device found below:
0. Unconfigured (not settable)
1. Flash
2. Card
3. NVS
4. TFTP
For copying, you may use any combination of devices for the
source and destination except for copying from TFTP to TFTP.
For moving files you cannot use TFTP as source or destination.
For deleting, the source cannot be TFTP.
To copy a file from TFTP to flash, use 4 for source and 1 for
destination.
You must fully configure all required parameters for each
device. Only TFTP has an IP address required."
DEFVAL { '1'b }
::= { atFilev2FileOperation 2 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.3
atFilev2SourceFilename OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The filename of the source file to copy, move or delete.
Include any path as required, but the storage type is not
necessary. Setting a null string will return an error.
For example, to copy the file latest.cfg from the
backupconfigs/routers directory on the TFTP server, you would
set:
backupconfigs/routers/latest.cfg"
::= { atFilev2FileOperation 3 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.4
atFilev2DestinationStackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set an integer corresponding to the stack ID of the stack
member to use as the destination. This value is ignored if the
destination device is set to TFTP, or if a deletion operation
is carried out.
If running a stand-alone unit, use the default value of 1."
::= { atFilev2FileOperation 4 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.5
atFilev2DestinationDevice OBJECT-TYPE
SYNTAX Integer32 (0..4)
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set an integer that corresponds with a device found below:
0. Unconfigured (not settable)
1. Flash
2. Card
3. NVS
4. TFTP
For copying, you may use any combination of devices for the
source and destination except for copying from TFTP to TFTP.
For moving files you cannot use TFTP as source or destination.
For deleting, the destination source is ignored.
To copy a file from TFTP to flash, use 4 for source and 1 for
destination.
You must fully configure all required parameters for each
device. Only TFTP has an IP address required."
DEFVAL { '1'b }
::= { atFilev2FileOperation 5 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.6
atFilev2DestinationFilename OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The destination filename of the file to copy or move. Include
any path as required, but the storage type is not necessary.
For any operation other than a file deletion, setting a null
string will return an error. For deletions, any value set to
this object is ignored.
Note: If the destination is set to flash, card or nvs, any file
at the destination that shares the destination filename will be
overwritten by a move or copy operation.
The destination filename does not need to be the same as the
source filename.
For example, to copy a release file from the TFTP server to the
local flash into the backuprelease directory, you would set:
backuprelease/latest.rel"
::= { atFilev2FileOperation 6 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.7
atFilev2CopyBegin OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A read on this object can return several possible values,
depending on the current status of the system and the
various file operation objects:
idle There is no file operation
in progress and all required
objects have been set
correctly. Setting a '1' to
this object will begin the
file copy.
Error codes: [1-7] A copy operation cannot be
started until these errors
are resolved. See below for
key.
[action]ing x [--> y] A file operation is
currently in progress. You
cannot start another
operation while the object
is returning this value.
[action] x [--> y] success The last copy, move or
delete operation was
successfully completed.
[action] x [--> y] failure: [err] The last copy, move or
delete operation failed,
with the error message
attached. Common failures
include lack of space on the
destination file system,
incorrect source file names
or communication errors with
remote services.
Upon reading a success or failure message, the message will be
cleared and the next read will result in either an 'idle'
message or an 'Error codes' message if not all required objects
have been correctly set. If the read returned 'idle', a new
file operation can now be started.
Error codes for file copy:
1 - atFilev2SourceDevice has not been set
2 - atFilev2SourceFilename has not been set
3 - atFilev2DestinationDevice has not been set
4 - atFilev2DestinationFilename has not been set
5 - atFilev2SourceDevice and atFilev2DestinationDevice are both
set to TFTP
6 - the combination of source device, stackID and filename is
the same as the destination device, stackID and filename
(i.e. it is not valid to copy a file onto itself.
7 - TFTP IP address has not been set and TFTP has been set for
one of the devices
Provided all above requirements are met, immediately upon
executing the SNMP set, the device will indicate that it was a
success. The actual file copy itself will be started and
continue on the device until it has completed. For large files,
operations can take several minutes to complete.
Subsequent reads of the object will return one of messages
shown in the first table, to allow for tracking of the progress
of the copy operation."
::= { atFilev2FileOperation 7 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.8
atFilev2MoveBegin OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A read on this object can return several possible values,
depending on the current status of the system and the various
file operation objects:
idle There is no file operation
in progress and all required
objects have been set
correctly. Setting a '1' to
this object will begin the
file move.
Error codes: [1-6] A move operation cannot be
started until these errors
are resolved. See below for
key.
[action]ing x [--> y] A file operation is
currently in progress. You
cannot start another
operation while the object
is returning this value.
[action] x [--> y] success The last copy, move or
delete operation was
successfully completed.
[action] x [--> y] failure: [err] The last copy, move or
delete operation failed,
with the error message
attached. Common failures
include lack of space on the
destination file system,
incorrect source file names
or communication errors with
remote services.
Upon reading a success or failure message, the message will be
cleared and the next read will result in either an 'idle'
message or an 'Error codes' message if not all required objects
have been correctly set. If the read returned 'idle', a new
file operation can now be started.
Error codes for file move:
1 - atFilev2SourceDevice has not been set
2 - atFilev2SourceFilename has not been set
3 - atFilev2DestinationDevice has not been set
4 - atFilev2DestinationFilename has not been set
5 - either atFilev2SourceDevice or atFilev2DestinationDevice
are set to TFTP
6 - the combination of source device, stackID and filename is
the same as the destination device, stackID and filename
(i.e. it is not valid to move a file onto itself.
Provided all above requirements are met, immediately upon
executing the SNMP set, the device will indicate that it was a
success. The actual file move itself will be started and
continue on the device until it has completed. For large files,
operations can take several minutes to complete.
Subsequent reads of the object will return one of messages
shown in the first table, to allow for tracking of the progress
of the move operation."
::= { atFilev2FileOperation 8 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.9
atFilev2DeleteBegin OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A read on this object can return several possible values,
depending on the current status of the system and the various
file operation objects:
idle There is no file operation
in progress and all required
objects have been set
correctly. Setting a '1' to
this object will begin the
file deletion.
Error codes: [1-3] A delete operation cannot be
started until these errors
are resolved. See below for
key.
[action]ing x [--> y] A file operation is
currently in progress. You
cannot start another
operation while the object
is returning this value.
[action] x [--> y] success The last copy, move or
delete operation was
successfully completed.
[action] x [--> y] failure: [err] The last copy, move or
delete operation failed,
with the error message
attached. Common failures
include lack of space on the
destination file system,
incorrect source file names
or communication errors with
remote services.
Upon reading a success or failure message, the message will be
cleared and the next read will result in either an 'idle'
message or an 'Error codes' message if not all required objects
have been correctly set. If the read returned 'idle', a new
file operation can now be started.
File deletion operations ignore the values set in the
atFilev2DestinationStackID, atFilev2DestinationDevice and
atFilev2DestinationFilename objects.
The file deletion operation is equivalent to the CLI 'delete
force [file]' command, so it is possible to delete any
normally-protected system files, such as the currently
configured boot release.
Error codes for file deletion:
1 - atFilev2SourceDevice has not been set
2 - atFilev2SourceFilename has not been set
3 - atFilev2SourceDevice has been set to TFTP
Provided all above requirements are met, immediately upon
executing the SNMP set, the device will indicate that it was a
success. The actual file deletion itself will be started and
continue on the device until it has completed. For large files,
operations can take several minutes to complete.
Subsequent reads of the object will return one of messages
shown in the first table, to allow for tracking of the progress
of the delete operation."
::= { atFilev2FileOperation 9 }
-- Begin file operation devices.
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.10
atFilev2Flash1 OBJECT IDENTIFIER::= { atFilev2FileOperation 10 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.11
atFilev2Card2 OBJECT IDENTIFIER::= { atFilev2FileOperation 11 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.12
atFilev2Nvs3 OBJECT IDENTIFIER::= { atFilev2FileOperation 12 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.13
atFilev2Tftp4 OBJECT IDENTIFIER::= { atFilev2FileOperation 13 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.3.13.1
atFilev2TftpIPAddr OBJECT-TYPE
SYNTAX IpAddress
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The IP address of the TFTP server that is to be used for the
file copy process. This IP address needs to be reachable from
the device or the file copy will fail."
::= { atFilev2Tftp4 1 }
-- End file operation devices.
-- ---------------------------------------------------------- --
-- The SD Card Table
-- ---------------------------------------------------------- --
-- 1.3.6.1.4.1.207.8.4.4.4.600.4
atFilev2SDcardTable OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2SDcardEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of information about SD cards."
::= { atFilev2 4 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.4.1
atFilev2SDcardEntry OBJECT-TYPE
SYNTAX AtFilev2SDcardEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Data pertaining to an SD card instance."
INDEX { atFilev2SDcardStackMemberId }
::= { atFilev2SDcardTable 1 }
AtFilev2SDcardEntry ::=
SEQUENCE
{
atFilev2SDcardStackMemberId
Unsigned32,
atFilev2SDcardPresence
INTEGER
}
-- 1.3.6.1.4.1.207.8.4.4.4.600.4.1.1
atFilev2SDcardStackMemberId OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index of the stack member hosting this SD card."
::= { atFilev2SDcardEntry 1 }
-- 1.3.6.1.4.1.207.8.4.4.4.600.4.1.2
atFilev2SDcardPresence OBJECT-TYPE
SYNTAX INTEGER
{
notPresent(1),
present(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates whether or not an SD card is inserted
into a slot."
::= { atFilev2SDcardEntry 2 }
-- Add any new devices to the bottom as required.
END
--
-- at-filev2.mib
--