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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
|
-- ============================================================================
-- AT-FILEv2.MIB, Allied Telesis enterprise MIB:
-- File MIB for the AlliedWare Plus(tm) operating system
--
-- Copyright (c) 2011, 2012 by Allied Telesis, Inc.
-- All rights reserved.
--
-- ============================================================================
AT-FILEv2-MIB DEFINITIONS ::= BEGIN
IMPORTS
modules
FROM AT-SMI-MIB
IpAddress, Integer32, Unsigned32, Counter64, OBJECT-TYPE, MODULE-IDENTITY
FROM SNMPv2-SMI
DisplayString, TruthValue
FROM SNMPv2-TC;
atFilev2 MODULE-IDENTITY
LAST-UPDATED "201703310000Z"
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 "201703310000Z"
DESCRIPTION
"Remove '_' in the MIB object names to comply with the ASN.1 standard."
REVISION "201404300000Z"
DESCRIPTION
"Updated decriptions to refer to chassisMappingTable"
REVISION "201404230000Z"
DESCRIPTION
"Added more descriptions to atFilev2FileViewerDevice"
REVISION "201404160000Z"
DESCRIPTION
"Added more descriptions to atFilev2StackID, atFilev2SourceStackID,
atFilev2DestinationStackID, atFilev2DirStackID, atFilev2USBMediaStackMemberId,
atFilev2FileViewerStackId for VCStack Plus."
REVISION "201401170000Z"
DESCRIPTION
"Obsoleted atFilev2InfoTable table, so this cannot be used in the future"
REVISION "201209270000Z"
DESCRIPTION
"Deprecate atFilev2InfoTable table, since this has been replaced by
atFilev2FileViewer table."
REVISION "201209210000Z"
DESCRIPTION
"Added chassis switch (e.g. SBx8100) descriptions to stack-related MIB objects"
REVISION "201205220500Z"
DESCRIPTION
"Change syntax of atFilev2DirFileSystem to have USB in line with
its definition in other parts of the MIB."
REVISION "201205070000Z"
DESCRIPTION
"Added atFilev2FileViewer group. This allows a directory at a
time view of files on the device. This change also foreshadows
the deprecation of the atFilev2InfoTable, which the
atFilev2FileViewer group replaces. However, the InfoTable will
be left in place as a transition mechanism. However, support for
SD cards and USB memory devices has been removed from this table."
REVISION "201109120000Z"
DESCRIPTION
"Added support for USB media."
REVISION "201105300000Z"
DESCRIPTION
"Updated enumeration type to use INTEGER."
REVISION "201104210000Z"
DESCRIPTION
"Clarified object descriptions."
REVISION "201103240000Z"
DESCRIPTION
"Obsoleted existing file listing objects and created
replacements."
REVISION "201101260000Z"
DESCRIPTION
"Added new objects to manipulate directories."
REVISION "201009070000Z"
DESCRIPTION
"Generic syntax tidy up"
REVISION "201006140459Z"
DESCRIPTION
"MIB revision history dates in descriptions updated."
REVISION "200812050000Z"
DESCRIPTION
"Added SD card table."
REVISION "200811110000Z"
DESCRIPTION
"Normalised object names."
REVISION "200809240000Z"
DESCRIPTION
"Initial revision."
::= { modules 600 }
--
-- Node definitions
--
-- ---------------------------------------------------------- --
-- The options objects
-- ---------------------------------------------------------- --
atFilev2TableOptions OBJECT IDENTIFIER ::= { atFilev2 1 }
atFilev2Recursive OBJECT-TYPE
SYNTAX Integer32 (0..1)
MAX-ACCESS read-write
STATUS obsolete
DESCRIPTION
"Set a value of '1' to enable recursive listing of directories
in the atFilev2Table listing.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
DEFVAL { 0 }
::= { atFilev2TableOptions 1 }
atFilev2AllFiles OBJECT-TYPE
SYNTAX Integer32 (0..1)
MAX-ACCESS read-write
STATUS obsolete
DESCRIPTION
"Set a value of '1' to enable listing of all files (including
hidden etc) in the atFilev2Table listing.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
DEFVAL { 0 }
::= { atFilev2TableOptions 2 }
atFilev2Device OBJECT-TYPE
SYNTAX Integer32 (1..3)
MAX-ACCESS read-write
STATUS obsolete
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.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
DEFVAL { 1 }
::= { atFilev2TableOptions 3 }
atFilev2StackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS obsolete
DESCRIPTION
"Set an integer to correspond to the stack ID of a stack
member. For devices that are not capable of being stacked, set
with the value 1. For a chassis switch, it corresponds to the
card ID. For VCStack Plus, 1-12 refers to the cards on VCS stack
member 1 and 13-24 refers to the cards on VCS stack member 2.
Refer to chassisMappingTable for more details.
Subsequent SNMP queries to the atFilev2Table will use this as
the stack member to generate a file listing from.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
DEFVAL { 1 }
::= { atFilev2TableOptions 4 }
-- ---------------------------------------------------------- --
-- The file table
-- ---------------------------------------------------------- --
atFilev2Table OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2Entry
MAX-ACCESS not-accessible
STATUS obsolete
DESCRIPTION
"A list of files present on the device and stack-member
specified by the atFilev2Device and atFilev2StackID objects.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2 2 }
atFilev2Entry OBJECT-TYPE
SYNTAX AtFilev2Entry
MAX-ACCESS not-accessible
STATUS obsolete
DESCRIPTION
"An entry in the list of files containing information about a
single file.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
INDEX { atFilev2Filename }
::= { atFilev2Table 1 }
AtFilev2Entry ::=
SEQUENCE {
atFilev2Filename
OCTET STRING,
atFilev2FileSize
Integer32,
atFilev2FileCreationTime
OCTET STRING,
atFilev2FileAttribs
OCTET STRING
}
atFilev2Filename OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (1..112))
MAX-ACCESS read-only
STATUS obsolete
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.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2Entry 1 }
atFilev2FileSize OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"The size of the file in bytes.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2Entry 2 }
atFilev2FileCreationTime OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"File creation time in the form <MMM DD YYYY HH:MM:SS>.
Eg: Sep 7 2008 06:07:54.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2Entry 3 }
atFilev2FileAttribs OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS obsolete
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.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2Entry 4 }
-- ---------------------------------------------------------- --
-- The file operation objects
-- ---------------------------------------------------------- --
atFilev2FileOperation OBJECT IDENTIFIER ::= { atFilev2 3 }
atFilev2SourceStackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the stack ID of the source device to be used for the
file operation. For devices that are not capable of being
stacked, set with the value 1. For a chassis switch, it
corresponds to the card ID. For VCStack Plus, 1-12 refers
to the cards on VCS stack member 1 and 13-24 refers to the
cards on VCS stack member 2. Refer to chassisMappingTable
for more details.
This value is ignored if the source device is set to TFTP."
::= { atFilev2FileOperation 1 }
atFilev2SourceDevice OBJECT-TYPE
SYNTAX INTEGER
{
flash(1),
card(2),
nvs(3),
tftp(4),
usb(5)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the value representing the source file system to be
used for the file operation:
1. Flash
2. Card
3. NVS
4. TFTP
5. USB
For copying files, any combination of source and destination
file system types may be selected, with the exception of TFTP
to TFTP, which is not supported.
For moving files, TFTP may not be selected as the source or
destination file system type.
For deleting files, the source file system type cannot be TFTP.
All required parameters must be fully configured before an
operation can commence. Where a TFTP operation is configured,
an IP address must also be set via atFilev2TftpIPAddr."
::= { atFilev2FileOperation 2 }
atFilev2SourceFilename OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The filename of the source file to be copied, moved or deleted.
Include any path as required, but the file system type is not
necessary.
For example, to copy the file latest.cfg from the
backupconfigs/routers directory on the TFTP server, this object
should be set to:
backupconfigs/routers/latest.cfg"
::= { atFilev2FileOperation 3 }
atFilev2DestinationStackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the stack ID of the destination device to be used for
the file operation. For devices that are not capable of being
stacked, set with the value 1. For a chassis switch, it
corresponds to the card ID. For VCStack Plus, 1-12 refers to
the cards on VCS stack member 1 and 13-24 refers to the cards
on VCS stack member 2. Refer to chassisMappingTable for more details.
This value is ignored if the destination device is set to TFTP,
or if a deletion operation is carried out."
::= { atFilev2FileOperation 4 }
atFilev2DestinationDevice OBJECT-TYPE
SYNTAX INTEGER
{
flash(1),
card(2),
nvs(3),
tftp(4),
usb(5)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the value representing the destination file system to
be used for the file operation:
1. Flash
2. Card
3. NVS
4. TFTP
5. USB
For copying files, any combination of source and destination
file system types may be selected, with the exception of TFTP
to TFTP, which is not supported.
For moving files, TFTP may not be selected as the source or
destination file system type.
For deleting files, this object is ignored.
All required parameters must be fully configured before an
operation can commence. Where a TFTP operation is configured,
an IP address must also be set via atFilev2TftpIPAddr."
::= { atFilev2FileOperation 5 }
atFilev2DestinationFilename OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The destination filename for the copy or move operation.
Include any path as required, but the file system type is not
necessary. The destination filename does not need to be the
same as the source filename, and this object is ignored for
file deletion operations.
For example, to copy a release file from a TFTP server to the
backuprelease directory on the flash file system, this object
should be set to:
backuprelease/latest.rel
Note: Any file at the destination that shares the destination
filename will be overwritten by a move or copy operation."
::= { atFilev2FileOperation 6 }
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 a read returns 'idle', a new file
operation can 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
Note that if the above requirements are met and the operation
would result in a system file being modified, then an SNMP set
to this object will be disallowed.
For valid operations, immediately upon executing the SNMP set
operation on this object, the file copy will begin and will
continue on the device until either it has completed, or a
failure occurs. For large files, operations can take several
minutes to complete.
Subsequent reads of the object will return one of the messages
shown above, to track the progress of the copy operation."
::= { atFilev2FileOperation 7 }
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 a read returns 'idle', a new file
operation can 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.
Note that if the above requirements are met and the operation
would result in a system file being modified or deleted, then
an SNMP set to this object will be disallowed.
For valid operations, immediately upon executing the SNMP set
operation on this object, the file move will begin and will
continue on the device until either it has completed, or a
failure occurs. For large files, operations can take several
minutes to complete.
Subsequent reads of the object will return one of the messages
shown above, to track the progress of the move operation."
::= { atFilev2FileOperation 8 }
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 a read returns 'idle', a new file
operation can be started.
File deletion operations ignore the values set in the
atFilev2DestinationStackID, atFilev2DestinationDevice and
atFilev2DestinationFilename objects.
Error codes for file deletion:
1 - atFilev2SourceDevice has not been set
2 - atFilev2SourceFilename has not been set
3 - atFilev2SourceDevice has been set to TFTP
Note that if the above requirements are met and the operation
would result in a system file being deleted, then an SNMP set
to this object will be disallowed.
For valid operations, immediately upon executing the SNMP set
operation on this object, the file deletion will begin and will
continue on the device until either it has completed, or a
failure occurs. For large files, operations can take several
minutes to complete.
Subsequent reads of the object will return one of the messages
shown above, to track the progress of the deletion operation."
::= { atFilev2FileOperation 9 }
-- Begin file operation devices.
atFilev2Flash1 OBJECT IDENTIFIER ::= { atFilev2FileOperation 10 }
atFilev2Card2 OBJECT IDENTIFIER ::= { atFilev2FileOperation 11 }
atFilev2Nvs3 OBJECT IDENTIFIER ::= { atFilev2FileOperation 12 }
atFilev2Tftp4 OBJECT IDENTIFIER ::= { atFilev2FileOperation 13 }
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 }
atFilev2Usb5 OBJECT IDENTIFIER ::= { atFilev2FileOperation 15 }
-- End file operation devices.
-- Directory operations.
atFilev2DirOperation OBJECT IDENTIFIER ::= { atFilev2FileOperation 14 }
atFilev2DirStackID OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the stack ID of the device containing the directory to
be renamed or deleted, or to the stack ID of the device on
which to create a new directory. For devices that are not
capable of being stacked, set with the value 1. For a chassis
switch, it corresponds to the card ID. For VCStack Plus,
1-12 refers to the cards on VCS stack member 1 and 13-24 refers
to the cards on VCS stack member 2.
Refer to chassisMappingTable for more details."
::= { atFilev2DirOperation 1 }
atFilev2DirFileSystem OBJECT-TYPE
SYNTAX INTEGER
{
flash(1),
card(2),
nvs(3),
usb(5)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"Set to the value representing the file system on which the
existing directory resides, or on which a new directory should
be created:
1. Flash
2. Card
3. NVS
5. USB"
::= { atFilev2DirOperation 2 }
atFilev2DirPath OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object should be set to the path of the directory to be
created/deleted/renamed, but should not include the name of the
directory itself, or the file system on which it resides.
For example, to delete directory 'backupconfigs/old' from the
flash filesystem, this object should be set to 'backupconfigs'."
::= { atFilev2DirOperation 3 }
atFilev2SourceDirName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is required for directory deletion or rename
operations only. It should be set to the name of the directory
to be deleted/renamed, but should not include any path data.
Operations on hidden directories are not supported.
For example, to delete directory 'backupconfigs/old' from the
flash filesystem, this object should be set to 'old'."
::= { atFilev2DirOperation 4 }
atFilev2DestDirName OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"This object is required for directory creation or rename
operations only. It should be set to the name of the directory
to be created, or the destination directory name for a rename
operation. It should not include any path data and operations
on hidden directories are not supported.
For example, to create directory 'backupconfigs/old' on the
flash filesystem, this object should be set to 'old'."
::= { atFilev2DirOperation 5 }
atFilev2BeginDirOperation OBJECT-TYPE
SYNTAX INTEGER
{
idle(1),
createDir(2),
renameDir(3),
deleteEmptyDir(4),
deleteForceDir(5)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"A read of this object will always return 'idle' (1). All
applicable objects above must have been set correctly in order
to commence an operation.
The following values may be set to perform the operations
described:
createDir (2) : This will create a new directory with a
name equating to atFilev2DestDirName, on
the device indicated by
atFilev2DirStackID, and the file system
indicated by atFilev2DirFileSystem, with
the path to the directory being
indicated by atFilev2DirPath. The given
path structure must already exist.
renameDir (3) : This will rename an existing directory
with a name equating to
atFilev2SourceDirName, to a name
equating to atFilev2DestDirName on the
device indicated by atFilev2DirStackID,
and the file system indicated by
atFilev2DirFileSystem, with the path to
the directory being indicated by
atFilev2DirPath. The given path
structure and source directory must
already exist, and a rename operation
cannot change the path where the
directory currently resides.
deleteEmptyDir (4) : This will delete an existing directory
with a name equating to
atFilev2SourceDirName, on the device
indicated by atFilev2DirStackID, and the
file system indicated by
atFilev2DirFileSystem, with the path to
the directory being indicated by
atFilev2DirPath. However, the operation
will fail if the specified directory is
not empty. Only sub-directories within
the specified file system can be
deleted.
deleteForceDir (5) : This will delete an existing directory
with a name equating to
atFilev2SourceDirName, on the device
indicated by atFilev2DirStackID, and the
file system indicated by
atFilev2DirFileSystem, with the path to
the directory being indicated by
atFilev2DirPath. The operation will also
automatically delete any contents within
the specified directory. Only sub-
directories within the specified file
system can be deleted."
::= { atFilev2DirOperation 6 }
atFilev2LastDirOpResult OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Gives an indication of the result of the last completed SNMP
directory operation."
::= { atFilev2DirOperation 7 }
-- ---------------------------------------------------------- --
-- The SD Card Table
-- ---------------------------------------------------------- --
atFilev2SDcardTable OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2SDcardEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of information about SD cards."
::= { atFilev2 4 }
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
}
atFilev2SDcardStackMemberId OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index of the stack member hosting this SD card. For
devices that are not capable of being stacked, this object will
always return the value 1."
::= { atFilev2SDcardEntry 1 }
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
in a slot."
::= { atFilev2SDcardEntry 2 }
-- ---------------------------------------------------------- --
-- The file info table
-- ---------------------------------------------------------- --
atFilev2InfoTable OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2InfoEntry
MAX-ACCESS not-accessible
STATUS obsolete
DESCRIPTION
"A list of all files, including pathnames, that are present on
the device. Hidden system files are not displayed.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2 5 }
atFilev2InfoEntry OBJECT-TYPE
SYNTAX AtFilev2InfoEntry
MAX-ACCESS not-accessible
STATUS obsolete
DESCRIPTION
"An entry in the list of files, containing information about a
single file.
NOTE: atFilev2Table and associated objects have been replaced
by atFilev2FileViewer."
INDEX { IMPLIED atFilev2InfoFilepath }
::= { atFilev2InfoTable 1 }
AtFilev2InfoEntry ::=
SEQUENCE {
atFilev2InfoFilepath
OCTET STRING,
atFilev2InfoFileSize
Counter64,
atFilev2InfoFileCreationTime
OCTET STRING,
atFilev2InfoFileIsDirectory
TruthValue,
atFilev2InfoFileIsReadable
TruthValue,
atFilev2InfoFileIsWriteable
TruthValue,
atFilev2InfoFileIsExecutable
TruthValue
}
atFilev2InfoFilepath OBJECT-TYPE
SYNTAX OCTET STRING (SIZE (1..112))
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"The full path and name of the file. Files are sorted in
alphabetical order, and any filepath that is longer than 112
characters will not be displayed due to SNMP OID length
limitations.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 1 }
atFilev2InfoFileSize OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"The size of the file in bytes.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 2 }
atFilev2InfoFileCreationTime OBJECT-TYPE
SYNTAX OCTET STRING
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"File creation time in the form <MMM DD YYYY HH:MM:SS>.
Eg: Sep 7 2008 06:07:54.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 3 }
atFilev2InfoFileIsDirectory OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"Returns TRUE if the entry is a directory, FALSE otherwise.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 4 }
atFilev2InfoFileIsReadable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"Returns TRUE if the file is readable, FALSE otherwise.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 5 }
atFilev2InfoFileIsWriteable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"Returns TRUE if the file is writeable, FALSE otherwise.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 6 }
atFilev2InfoFileIsExecutable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS obsolete
DESCRIPTION
"Returns TRUE if the file is executable, FALSE otherwise.
NOTE: atFilev2InfoTable and associated objects have been replaced
by atFilev2FileViewer."
::= { atFilev2InfoEntry 7 }
-- ---------------------------------------------------------- --
-- The USB Media Table
-- ---------------------------------------------------------- --
atFilev2USBMediaTable OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2USBMediaEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A table of information about USB media."
::= { atFilev2 6 }
atFilev2USBMediaEntry OBJECT-TYPE
SYNTAX AtFilev2USBMediaEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"Data pertaining to an USB media instance."
INDEX { atFilev2USBMediaStackMemberId }
::= { atFilev2USBMediaTable 1 }
AtFilev2USBMediaEntry ::=
SEQUENCE {
atFilev2USBMediaStackMemberId
Unsigned32,
atFilev2USBMediaPresence
INTEGER
}
atFilev2USBMediaStackMemberId OBJECT-TYPE
SYNTAX Unsigned32
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The index of the stack member hosting this USB media. For
devices that are not capable of being stacked, this object will
always return the value 1. For a chassis switch, it corresponds
to the card ID. For VCStack Plus, 1-12 refers to the cards on
VCS stack member 1 and 13-24 refers to the cards on VCS stack
member 2. Refer to chassisMappingTable for more details."
::= { atFilev2USBMediaEntry 1 }
atFilev2USBMediaPresence OBJECT-TYPE
SYNTAX INTEGER
{
notPresent(1),
present(2)
}
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"This object indicates whether or not an USB media is inserted
in a slot."
::= { atFilev2USBMediaEntry 2 }
-- ---------------------------------------------------------- --
-- The file viewer
-- The set of objects in this section allow for a view of the files
-- on this managed device that is reminiscent of the view that a
-- shell user on a device would have, with the concepts of current
-- working directory, changing directories and viewing files
-- within a directory all supported.
-- This section obseletes the first two attempts at creating a view
-- of files for the reason that performance and functionality of the
-- original views was not sufficient. In particular, trying to
-- create a view of all files in the device, sorted by path and
-- file name, proved to be very difficult when scaling considerations
-- were taken into account.
-- Note that in order to use this group of objects the ability to
-- write MIB variables is required.
-- ---------------------------------------------------------- --
atFilev2FileViewer OBJECT IDENTIFIER ::= { atFilev2 7 }
atFilev2FileViewerStackId OBJECT-TYPE
SYNTAX Integer32
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The stack ID of the stack member for which files will be displayed
in the FileViewer table. For devices that are not capable of being
stacked, this variable will always read as 1, and will cause an error
on being written to with any value other than 1.
Write this variable with the stack ID of the stack member for which
a view of files is required. If the stack member doesn't exist, an
error will be returned. For a chassis switch, it corresponds to
the card ID. For VCStack Plus, 1-12 refers to the cards on VCS stack
member 1 and 13-24 refers to the cards on VCS stack member 2.
Refer to chassisMappingTable for more details.
Note that the other variables specifying the files to view will
not be altered by changing the stack ID, which means that the
file view table could be empty if a non-existant device or path
has been referenced previously."
DEFVAL { 1 }
::= { atFilev2FileViewer 1 }
atFilev2FileViewerDevice OBJECT-TYPE
SYNTAX INTEGER
{
flash(1),
card(2),
nvs(3),
tftp(4),
usb(5)
}
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The file system device for which files will be displayed in the
FileViewer table. The values supported for this variable are
identical to the values for other variables in the MIB, although not
all values will actually result in the display of files.
The different devices and whether they will result in the display
of files are:
1. Flash - Onboard Flash - supported
2. Card - Removable SD card - supported
3. NVS - Onboard battery backed RAM - supported
4. TFTP - not supported
5. USB - Removable USB media - supported
Note: Card and USB are supported on the stack master or Active
CFC. The devices cannot be read if atFilev2FileViewerStackId is
set with the ID of a different stack member or chassis card.
Setting this variable to an unsupported value will result in an error,
but setting to a value that is supported but on a system that doesn't
contain that type of device will not. However, no files will be
displayed in the File Viewer table in this case."
DEFVAL { 1 }
::= { atFilev2FileViewer 2 }
atFilev2FileViewerCurrentPath OBJECT-TYPE
SYNTAX DisplayString
MAX-ACCESS read-write
STATUS current
DESCRIPTION
"The file system path for which files will be displayed in
the FileViewer table. This path will always read as a full
pathname starting with the '/' character.
Setting this variable will specify a new directory for which
files will be displayed. The path specified must be the full
path, relative setting of path does not work. Only paths with
invalid characters in them will cause an error, paths specifying
non-existant directories will be accepted, but no files will be
displayed in the File Viewer table in this case."
-- DEFVAL { "//" }
::= { atFilev2FileViewer 3 }
atFilev2FileViewerTable OBJECT-TYPE
SYNTAX SEQUENCE OF AtFilev2FileViewerEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"A list of all files, not including pathnames, that are present
on the device specified by atFilev2FileViewerStackId and
atFilev2FileViewerDevice, in the path specified by
atFilev2FileViewerCurrentPath.
Hidden and system files are not displayed.
If the Stack ID, device and path are invalid (the path is for
a non-existant directory), the table will be empty. This will
allow a MIB walk through the table even though the setup
parameters are incorrect."
::= { atFilev2FileViewer 4 }
atFilev2FileViewerEntry OBJECT-TYPE
SYNTAX AtFilev2FileViewerEntry
MAX-ACCESS not-accessible
STATUS current
DESCRIPTION
"An entry in the list of files, containing information about a
single file."
INDEX { IMPLIED atFilev2FileViewerName }
::= { atFilev2FileViewerTable 1 }
AtFilev2FileViewerEntry ::=
SEQUENCE {
atFilev2FileViewerName
DisplayString,
atFilev2FileViewerSize
Counter64,
atFilev2FileViewerCreationTime
DisplayString,
atFilev2FileViewerIsDirectory
TruthValue,
atFilev2FileViewerIsReadable
TruthValue,
atFilev2FileViewerIsWriteable
TruthValue,
atFilev2FileViewerIsExecutable
TruthValue
}
atFilev2FileViewerName OBJECT-TYPE
SYNTAX DisplayString (SIZE (1..112))
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The name of the file. Files are sorted in alphabetical order,
and any name that is longer than 112 characters will not be
displayed due to SNMP OID length limitations."
::= { atFilev2FileViewerEntry 1 }
atFilev2FileViewerSize OBJECT-TYPE
SYNTAX Counter64
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"The size of the file in bytes."
::= { atFilev2FileViewerEntry 2 }
atFilev2FileViewerCreationTime OBJECT-TYPE
SYNTAX DisplayString
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."
::= { atFilev2FileViewerEntry 3 }
atFilev2FileViewerIsDirectory OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Returns TRUE if the entry is a directory, FALSE otherwise."
::= { atFilev2FileViewerEntry 4 }
atFilev2FileViewerIsReadable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Returns TRUE if the file is readable, FALSE otherwise."
::= { atFilev2FileViewerEntry 5 }
atFilev2FileViewerIsWriteable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Returns TRUE if the file is writeable, FALSE otherwise."
::= { atFilev2FileViewerEntry 6 }
atFilev2FileViewerIsExecutable OBJECT-TYPE
SYNTAX TruthValue
MAX-ACCESS read-only
STATUS current
DESCRIPTION
"Returns TRUE if the file is executable, FALSE otherwise."
::= { atFilev2FileViewerEntry 7 }
END
--
-- at-filev2.mib
--
|