-
Notifications
You must be signed in to change notification settings - Fork 124
/
Copy pathCISCO-DATA-COLLECTION-MIB-V1SMI.my
1870 lines (1690 loc) · 68.3 KB
/
CISCO-DATA-COLLECTION-MIB-V1SMI.my
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
-- MIB file created 01-Apr-2008 06:10:05, by
-- SMICng version 2.2.11-beta(PRO)(Solaris), January 20, 2001. Enterprise key cisco.com
CISCO-DATA-COLLECTION-MIB DEFINITIONS ::= BEGIN
-- From file: "CISCO-DATA-COLLECTION-MIB.my"
-- Compile options "4 7 F H N O W 03 06 0B 0G 0N 0T"
IMPORTS
-- zeroDotZero
-- FROM SNMPv2-SMI-v1
RowStatus, DisplayString, TruthValue, DateAndTime, RowPointer,
VariablePointer
FROM SNMPv2-TC-v1
SnmpTagValue
FROM SNMP-TARGET-MIB
SnmpAdminString
FROM SNMP-FRAMEWORK-MIB
ciscoMgmt
FROM CISCO-SMI
Gauge
FROM RFC1155-SMI
OBJECT-TYPE
FROM RFC-1212
TRAP-TYPE
FROM RFC-1215;
ciscoDataCollectionMIB OBJECT IDENTIFIER ::= { ciscoMgmt 312 }
-- MODULE-IDENTITY
-- LastUpdated
-- 200210300530Z
-- OrgName
-- Cisco Systems, Inc.
-- ContactInfo
-- Cisco Systems
-- Customer Service
--
-- Postal: 170 W Tasman Drive
-- San Jose, CA 95134
-- USA
--
-- Tel: +1 800 553-NETS
--
-- E-mail: [email protected]
-- Descr
-- The MIB module allows a management application to
-- select a set of MIB object instances whose values need
-- to be collected on a periodic basis. The term 'data' in
-- the context of this MIB is used to generically refer to
-- the values of the selected set of object instances.
--
-- Once the required setup is done, the MIB implementation
-- carries out the following periodic tasks:
-- - collects the required object values into local
-- file-like entities called VFiles (virtual files).
-- - transfers the VFiles to specified locations.
-- - carries out VFile management operations.
--
-- Some of the key features of this MIB are:
-- a) Allows grouping of MIB objects into groups called
-- data groups. The constraint is that the MIB objects
-- grouped into a data group, need to have the same
-- semantic MIB index. So it is possible to group MIB
-- objects belonging to different MIB tables into a
-- single data group as long as the above constraint is
-- met.
-- For e.g. it is possible to group ifInOctets from
-- ifTable, ifHCInOctets from ifXTable,
-- dot3StatsExcessiveCollisions from dot3StatsTable
-- into a single data group.
--
-- b) Allows the application to specify a set of instances
-- (of the MIB objects in a data group) whose values
-- need to be collected.
--
-- c) The required data can be collected for each such
-- data group on a periodic basis into a virtual file
-- (VFile). A VFile is an abstraction of a file.
--
-- d) The format of the contents of the VFile, can be
-- specified by the application.
--
-- e) An application can also specify a collection period.
-- A collection period is an interval of time during
-- which data is collected into a VFile. After the
-- collection period ends, the VFile is frozen, and a
-- new VFile is created for storing data. The frozen
-- VFile is then transferred to a specified destination.
-- An application can choose to retain such frozen
-- VFiles on the device for a certain period of time,
-- called the retention period.
--
-- Data Collection MIB vs Bulkfile MIB
-- ***********************************
-- The data collection MIB can pretty much do what the
-- CISCO-BULK-FILE-MIB (Bulkfile MIB) can do. The 'manual'
-- mode of the Data collection MIB is similar to the way
-- in which the Bulkfile MIB operates.
--
-- However the data collection MIB is mainly targetted
-- for medium to high-end platforms which have sufficient
-- local storage (volatile or permanent) to store VFiles.
-- Locally storing VFiles, helps minimize loss of data
-- during temporary network outages. If the local store
-- is permament, then the collected data is also available
-- across agent restarts.
--
-- The data collection MIB has more powerful data
-- selection features than the Bulkfile MIB. It allows
-- grouping of MIB objects from different tables into
-- data groups. It also incorporates a more flexible
-- instance selection mechanism, where the application
-- is not restricted to fetching an entire MIB table.
--
-- Definitions:
-- ************
-- Base objects:
-- *************
-- MIB objects whose values an application needs to
-- collect.
--
-- Data group:
-- ***********
-- A group of base objects. Can be of 2 types: 'object'
-- and 'table'. An 'object' type data group can consist
-- of only one fully instantiated base object. A 'table'
-- type data group can consist of more than one base
-- objects, each a columnar object in a conceptual
-- table. In addition a 'table' type data group can
-- specify the instances of the base objects whose
-- values need to be collected. In the context of this
-- MIB, collecting data for a data group means fetching
-- the values of the associated base object instances
-- and storing them into VFiles.
--
-- Virtual File (VFile):
-- *********************
-- A VFile is a file like entity used to collect data.
-- An agent might choose to implement a VFile as a
-- simple in-memory buffer, or it might choose to
-- use a file in it's filesystem. An application does
-- not really need to know the location of a VFile
-- - the MIB provides mechanisms to transfer the
-- VFile to application specified locations. However
-- if the implementation supports it, the application
-- can specify the location of the VFiles.
--
-- Current VFile:
-- **************
-- The VFile into which data is currently being
-- collected.
--
-- Frozen VFile:
-- *************
-- A VFile which is no longer used for collecting
-- data. Only frozen VFiles can be transferred to
-- specified destinations.
--
-- Collection interval:
-- ********************
-- A collection interval is associated with a VFile.
-- It is the interval of time over which a VFile
-- is used to collect data.
-- This interval of time can be specified by the
-- application. However there are conditions under
-- which a collection interval can be shorter than
-- the specified time. For e.g. a collection
-- interval is prematurely terminated when the
-- maximum size of a VFile is exceeded, or when
-- there is an error condition.
--
-- Polling period:
-- ***************
-- A polling period is associated with a data
-- group. It determines the frequency at which
-- the base objects of a data group should
-- be fetched and stored into a VFile.
--
-- Data collection operations:
-- **************************
-- A generic term used to refer to operations
-- that are carried out while collecting data.
-- These include:
-- - Periodically creating new VFiles for
-- collecting data.
-- - Transferring frozen VFiles either
-- automatically or on demand.
-- - Fetching base object values and storing
-- them into current VFiles, either periodically
-- or on demand.
-- - Deleting frozen VFiles, either periodically
-- or on demand.
-- RevDate
-- 200210300530Z
-- RevDescr
-- Initial Version.
ciscoDataCollMIBNotifs OBJECT IDENTIFIER ::= { ciscoDataCollectionMIB 0 }
ciscoDataCollMIBObjects OBJECT IDENTIFIER ::= { ciscoDataCollectionMIB 1 }
ciscoDataCollMIBConformance OBJECT IDENTIFIER ::= { ciscoDataCollectionMIB 2 }
cdcVFile OBJECT IDENTIFIER ::= { ciscoDataCollMIBObjects 1 }
cdcDataGroup OBJECT IDENTIFIER ::= { ciscoDataCollMIBObjects 2 }
cdcFileXfer OBJECT IDENTIFIER ::= { ciscoDataCollMIBObjects 3 }
ciscoDataCollMIBCompliances OBJECT IDENTIFIER ::= { ciscoDataCollMIBConformance 1 }
ciscoDataCollMIBGroups OBJECT IDENTIFIER ::= { ciscoDataCollMIBConformance 2 }
CdcCollectionSubtree ::= OBJECT IDENTIFIER
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- The subtree component of a (subtree, list) tuple.
-- The purpose of a tuple is to identify the columns
-- (base objects) in a 'table' type data group.
--
-- The subtree specifies a single OBJECT IDENTIFIER value such
-- that each object in the set is named by the subtree value
-- appended with a single additional sub-identifier derived from
-- the list component of the tuple.
--
-- A typical example would be the OBJECT IDENTIFER of the
-- fooEntry construct in a MIB table.
-- e.g. ifEntry.
CdcCollectionList ::= OCTET STRING(SIZE(0..16))
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- The list component of a (subtree, list) tuple. The purpose of
-- a tuple is to identify the base objects of a 'table' type
-- data group.
--
-- The subtree specifies a single OBJECT IDENTIFIER value such
-- that each object in the set is named by the subtree value
-- appended with a single additional sub-identifier. The list
-- specifies a set of data items, where the presence of an item
-- in the list indicates that the item is selected as a column
-- of the 'table' type data group; the absence of an item
-- from the list indicates that the item is not selected as a
-- column of the 'table' type data group.
-- Each data item is represented by an integer which when
-- appended (as as additional sub-identifier) to the OBJECT
-- IDENTIFIER value of the subtree identified by the tuple, is
-- the name of an object defining that data item (its description
-- and its syntax).
--
-- The list is specified as an OCTET STRING in which each data
-- item is represented by a single bit, where data items 1
-- through 8 are represented by the bits in the first octet,
-- data items 9 through 16 by the bits in the second octet,
-- etc. In each octet, the lowest numbered data item is
-- represented by the most significant bit, and the highest
-- numbered data item by the least significant bit. A data
-- item is present in the list when its bit is set, and absent
-- when its bit is reset. If the length of an OCTET STRING
-- value is too short to represent one or more data items
-- defined in a subtree, then those data items are absent from
-- the set identified by the tuple of that subtree and that
-- OCTET STRING value.
CdcRowInstanceId ::= OBJECT IDENTIFIER
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- A fragment of a OBJECT IDENTIFIER (OID). It is used to
-- specify the instances of the base objects whose values
-- need to be fetched. To comply with the definition of an
-- OBJECT IDENTIFIER, the first two sub-ids of a
-- CdcRowInstanceId value is {0,0}.
CdcUrl ::= OCTET STRING(SIZE(0..255))
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- Represents a string that contains a Uniformed Resource
-- Locator as defined in RFC 1738.
CdcFileFormat ::= INTEGER {
cdcBulkASCII(1),
cdcBulkBinary(2),
cdcSchemaASCII(3)
}
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- The file formats supported are:
--
-- cdcBulkASCII ASCII format similar to
-- the 'bulkASCII' format of the
-- CISCO-BULK-FILE-MIB.
--
-- cdcBulkBinary Binary format similar to
-- the 'bulkBinary' format of the
-- CISCO-BULK-FILE-MIB.
--
-- cdcSchemaASCII Again an ASCII format, but contains
-- parser friendly hints for parsing data
-- values.
--
-- Format descriptions :
-- =====================
--
-- The below description applies to cdcBulkASCII & cdcBulkBinary
-- and is extracted from CISCO-BULK-FILE-MIB. Some differences are
-- highlighted below:
--
-- 1) Data for a single data group can be collected more than
-- once into the same VFile (due to periodic polling). Each
-- such instance of a data group, can be treated much like
-- different 'table' types in the CISCO-BULK-FILE-MIB.
--
-- 2) Every object & table tag contains an additional sysUpTime
-- field. Similarly each row tag contains the value of the
-- sysUpTime when the data for that row was collected.
--
-- The rest of the description is taken from the
-- CISCO-BULK-FILE-MIB.
-- The file contains two types of fields: tags and data. Tags
-- identify portions of the file and are discussed in detail
-- below. All other information is in data fields.
--
-- Note: For efficiency and compactness data fields are not
-- tagged with a type. The interpreter of the data must thus
-- know or have access to appropriate MIB syntax descriptions to
-- understand the file.
--
-- All data fields are positional relative to a tag and every
-- data field has a length prefix. All initial length prefixes
-- are one byte. For any data type the distinguished length
-- value 255 indicates that the data content is null, that is,
-- no data content value was available and there are no
-- additional bytes in the data field.
--
-- INTEGER data fields include all data that maps to ASN.1
-- INTEGER, regardless of length and whether signed or unsigned.
-- They have a length prefix value of zero to eight, followed by
-- that many bytes of data, high-order byte first. High order
-- bytes that are all zero are omitted, thus a length of zero
-- indicates a value of zero. For signed numbers, leading bytes
-- of all ones (hex FF) are omitted if the next remaining byte
-- has the high bit on. This implies that the file parser must
-- know the difference between signed and unsigned integers.
--
-- OCTET STRING values have a length prefix value of zero to two
-- for a subsequent unsigned byte count for the number of bytes
-- in the OCTET STRING itself, which immediately follows the
-- byte count. The byte count can thus range from zero to 65,535.
--
-- OBJECT IDENTIFIER values have a length of zero to 128, for
-- the number of sub-identifiers. Each subsequent
-- sub-identifier is encoded as an unsigned INTEGER of 0-4 bytes.
--
-- The bulk binary file layout directly reflects the contents of
-- the cbfDefineFileObjectTable. It has tagged sections
-- corresponding to cbfDefineObjectClass with a few additional
-- tags for utility purposes.
-- A tag is one byte with one of the following values:
-- -2 row
-- -1 prefix
-- 0 reserved
-- 2 table
--
-- The prefix tag changes the default OID prefix that is assumed
-- to precede all OIDs that are not MIB object data values. The
-- prefix tag may appear anywhere another tag could appear. A
-- prefix tag is followed by one OID data field. The default
-- prefix is 1.3.6.1. A file need not set the prefix to the
-- default value. Note that when changing the prefix, the
-- default portion must be included at the beginning of the new
-- prefix. Typically the prefix will change for each table or
-- group of scalar objects.
--
-- A table tag is followed by one INTEGER data field whose value
-- is the number of columns in the table (including the
-- sysUpTime column), as implemented by the agent. This is
-- followed by an OID field containing the sysUpTime OID. This
-- is followed by one OID data field for each column. This is
-- the OID for the column minus the prefix and the instance
-- (typically one subidentifier).
--
-- The OIDs are then followed by one row for each row in the
-- table. A row starts with a row tag, one OID data field
-- containing only the instance portion of the OIDs for the
-- objects in that row and one data field indicating the
-- sysUpTime when the row was sampled.
-- Following this is one data field of appropriate type for each
-- column.
--
-- The bulk ASCII form mechanically translates bulk binary into
-- human-readable text.
--
-- The indicator for a null value is '~'.
--
-- An INTEGER becomes the integer value with a preceding '-' for
-- negative values and no leading zeros.
--
-- An OCTET STRING becomes the byte values in hexadecimal, lower
-- case, two characters per byte (that is, with leading zeros),
-- no delimiters between bytes.
--
-- An OBJECT IDENTIFIER becomes the usual dotted decimal form.
--
-- A tag becomes the tag's name, spelled out fully in lower
-- case, followed by one blank and the data field(s) for the
-- tag, separated by spaces and ending with a carriage
-- return/line feed. All tags are at the beginning of a 'line'
-- that is terminated with a carriage return/line feed that
-- immediately precedes the next tag or the end of file.
CdcFileXferStatus ::= INTEGER {
notStarted(1),
success(2),
aborted(3),
fileOpenFailRemote(4),
badDomainName(5),
unreachableIpAddress(6),
networkFailed(7),
fileWriteFailed(8),
authFailed(9)
}
-- TEXTUAL-CONVENTION
-- Status
-- mandatory
-- Descr
-- The status of a file transfer. The different values are given
-- below:
--
-- notStarted File transfer has not started.
-- success File transfer has successfully
-- completed.
-- aborted File transfer has been aborted.
-- fileOpenFailRemote Remote file could not be opened.
-- badDomainName Bad domain name given in the URL.
-- unreachableIpAddress IP address given in the URL could not
-- be reached.
-- networkFailure Transfer failed due to a network
-- failure.
-- fileWriteFailed A write on the remote file has
-- failed.
-- authFailed Authentication failed. For instance
-- incorrect password in CdcUrl incase
-- of FTP(File Transfer Protocol).
cdcVFilePersistentStorage OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-only
STATUS mandatory
DESCRIPTION
"This object's value reads 'true', if the agent
implementation of this MIB supports placement of VFiles in
application specified persistent storage locations. Otherwise
the value is 'false'."
::= { cdcVFile 1 }
cdcVFileMaxSizeHitsLimit OBJECT-TYPE
SYNTAX Gauge(1..4294967295)
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A global limit for the number of consecutive times the
maximum VFile size (cdcVFileMaxSize) is exceeded for a
given VFile. When this limit is exceeded the offending
cdcVFileEntry is moved to the error state (see
cdcVFileOperStatus)."
DEFVAL { 3 }
::= { cdcVFile 2 }
cdcVFileTable OBJECT-TYPE
SYNTAX SEQUENCE OF CdcVFileEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A table for setting up VFiles for collecting data."
::= { cdcVFile 3 }
cdcVFileEntry OBJECT-TYPE
SYNTAX CdcVFileEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"An entry in the cdcVFileTable. Each entry contains
application specified configuration that is used to create
virtual files (VFile) and start data collection operations.
A VFile is used to store data (values of base object
instances) as selected by entities called data groups.
A data group is defined in cdcDGTable.
An entry in this table is said to be 'activated' when the
corresponding instances of cdcVFileRowStatus is 'active' AND
cdcVFileOperStatus is 'enabled'. The value of sysUpTime.0 when
the condition evaluates to 'true' is called the activation
time of the entry. The activation time for each entry is
maintained internally by the agent."
INDEX { cdcVFileIndex }
::= { cdcVFileTable 1 }
CdcVFileEntry ::= SEQUENCE {
cdcVFileIndex Gauge,
cdcVFileName DisplayString,
cdcVFileDescription SnmpAdminString,
cdcVFileCommand INTEGER,
cdcVFileMaxSize Gauge,
cdcVFileCurrentSize Gauge,
cdcVFileFormat CdcFileFormat,
cdcVFileCollectMode INTEGER,
cdcVFileCollectionPeriod Gauge,
cdcVFileRetentionPeriod Gauge,
cdcVFileAdminStatus INTEGER,
cdcVFileOperStatus INTEGER,
cdcVFileErrorCode INTEGER,
cdcVFileCollectionErrorEnable TruthValue,
cdcVFileRowStatus RowStatus
}
cdcVFileIndex OBJECT-TYPE
SYNTAX Gauge(1..4294967295)
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"An arbitrary integer for uniquely identifying this
entry. When creating a row, the application should pick a
random number.
If the configuration in this entry is persisted across
system/agent restarts then the same value of cdcVFileIndex
must be assigned to this entry after the restart."
::= { cdcVFileEntry 1 }
cdcVFileName OBJECT-TYPE
SYNTAX DisplayString(SIZE(0..255))
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The base-name of the VFiles (created by data collection
operations corresponding to this entry) into which data is to
be collected.
When a VFile is created, it's full name is obtained by the
concatentation of a suffix to this value. The suffix will be
chosen by the agent such that the VFiles created for this
entry have unique names. For e.g. the suffix could be a
string representation of the date and time when the VFile was
created.
If VFiles are to be placed in the agent's local filesystem
(provided the agent supports it) then this value should also
contain the absolute path of the location as a prefix to the
base name.
An agent will respond with inconsistentValue to
a management set operation which attempts to modify the value
of this object to the same value as already held by another
instance of cdcVFileName, or wrongValue if the new value
is invalid for use as a file name on the local file
system (e.g., many file systems do not support white
space embedded in file names).
This object's value may be modified at any time. However
the new name will be used only when the next VFile is
created for this entry."
::= { cdcVFileEntry 2 }
cdcVFileDescription OBJECT-TYPE
SYNTAX SnmpAdminString
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A string that can be used for administrative purposes.
This object's value may be modified at any time."
DEFVAL { ''H }
::= { cdcVFileEntry 3 }
cdcVFileCommand OBJECT-TYPE
SYNTAX INTEGER {
idle(1),
swapToNewFile(2),
collectNow(3)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"An object for controlling collection of data.
'idle' Indicates that no command is in progress.
'swapToNewFile' When written, the current VFile is frozen,
and a new VFile is created for collecting
data.
If the data collection mode is automatic
(see cdcVFileCollectMode), then the current
collection interval is stopped and a new
collection interval is started
(see cdcVFileCollectPeriod).
'collectNow' When written, base object values for
all associated data groups are fetched
and stored into the current VFile. This
value can only be written when the
collection mode is 'manual' (see
cdcVFileCollectMode)."
DEFVAL { idle }
::= { cdcVFileEntry 4 }
cdcVFileMaxSize OBJECT-TYPE
SYNTAX Gauge(512..4294967295)
-- Units
-- bytes
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The maximum size of a VFile.
The agent maintains an internal counter for each
cdcVFileEntry. This counter counts the number of consecutive
times the size of a VFile has exceeded the value of this
object. When the value of this counter exceeds the value of
cdcVFileMaxSizeHitsLimit, this entry is moved to the 'error'
state (see cdcVFileOperStatus).
However if the value of cdcVFileMaxSizeHitsLimit is not
exceeded, then the current VFile is frozen, and a new VFile
is created for data collection.
If the data collection mode is automatic (see
cdcVFileCollectMode), then the current collection interval is
stopped and a new collection interval is started.
This object's value may be modified at any time. The new
size limit MUST be checked against the size of the current
VFile at the time of modification, and appropriate action
taken."
DEFVAL { 50000 }
::= { cdcVFileEntry 5 }
cdcVFileCurrentSize OBJECT-TYPE
SYNTAX Gauge(0..4294967295)
-- Units
-- bytes
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The size of the current VFile."
::= { cdcVFileEntry 6 }
cdcVFileFormat OBJECT-TYPE
SYNTAX CdcFileFormat
-- Rsyntax INTEGER {
-- cdcBulkASCII(1),
-- cdcBulkBinary(2),
-- cdcSchemaASCII(3)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The format in which data is stored into the current VFile.
This object's value cannot be modified while the entry
is in the 'activated' state."
DEFVAL { cdcSchemaASCII }
::= { cdcVFileEntry 7 }
cdcVFileCollectMode OBJECT-TYPE
SYNTAX INTEGER {
auto(1),
manual(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Determines the mode of data collection.
'auto' Data is periodically fetched for all data
groups associated with this entry. This is
done at data group specific periodic intervals
(cdcDGPollPeriod).
The data thus collected, is formatted and
stored into the current VFile.
In addition at regular intervals (see
cdcVFileCollectPeriod) a new VFile
is created to store data, and the current
VFile is frozen and transferred.
'manual' Data for all data groups is fetched and
collected into the current VFile only when
cdcVFileCommand is set to 'collectNow'.
This object's value cannot be modified while the entry
is in the 'activated' state."
DEFVAL { auto }
::= { cdcVFileEntry 8 }
cdcVFileCollectionPeriod OBJECT-TYPE
SYNTAX Gauge(60..604800)
-- Units
-- seconds
ACCESS read-write
STATUS mandatory
DESCRIPTION
"Specifies the period of a collection interval. The value
of this object is used only when the data collection mode is
automatic (see cdcVFileCollectMode).
A periodic timer (one per entry) is started when this
entry is 'activated'. The time at which this entry is
'activated' is called the 'activation time' for this entry,
and is internally maintained by the agent.
When this periodic timer expires, the current VFile is
frozen and a new VFile is created for data collection.
Transfer is then initiated for the frozen VFile.
In addition, the internally maintained counter for counting
the number of consecutive times the size of a VFile has
exceeded the maximum limit, is reset to zero. (See
cdcVFileMaxSize)
This object's value may be modified at any time, and the
new value takes effect immediately. i.e setting a new
value can cause the current collection interval to terminate
and a new collection interval to start."
DEFVAL { 1800 }
::= { cdcVFileEntry 9 }
cdcVFileRetentionPeriod OBJECT-TYPE
SYNTAX Gauge(60..86400)
-- Units
-- seconds
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The time for which a frozen VFile is retained by the
agent. When a VFile is frozen, a timer (one per frozen VFile)
is started to keep track of the retention period for the
VFile. Once this timer expires, the VFile is deleted.
Till the expiry of the retention period, information
about frozen VFiles is maintained in
cdcVFileMgmtTable.
This object's value may be modified at any time, however
the new value will take effect only for new frozen VFiles."
DEFVAL { 1800 }
::= { cdcVFileEntry 10 }
cdcVFileAdminStatus OBJECT-TYPE
SYNTAX INTEGER {
enabled(1),
disabled(2)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A control object to indicate the administratively desired
state of data collection for this entry. On setting the value
to 'disabled' data collection operations for this
entry are stopped, the current VFile is frozen and it's
transfer is initiated.
Modifying the value of cdcVFileAdminStatus to 'disabled' does
not remove or change the current configuration as represented
by the active rows in this table."
DEFVAL { disabled }
::= { cdcVFileEntry 11 }
cdcVFileOperStatus OBJECT-TYPE
SYNTAX INTEGER {
enabled(1),
disabled(2),
error(3)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A status object to indicate the operational state of
collection for this entry.
When the value of cdcVFileAdminStatus is modified to be
'enabled', the value of this object will change to 'enabled'
providing it is possible to begin collecting data. If at any
point of time data cannot be collected because of some error,
then the value of this object is changed to 'error' and all
collection operations stop, as if cdcVFileAdminStatus has
been set to 'disabled'. More information about the nature of
the error can be obtained by retrieving the value of
cdcVFileErrorCode.
When the value of cdcVFileAdminStatus is modified to be
'disabled', the value of this object will change to
'disabled' and data collection operations are stopped for
this entry."
::= { cdcVFileEntry 12 }
cdcVFileErrorCode OBJECT-TYPE
SYNTAX INTEGER {
noError(1),
otherError(2),
noSpace(3),
openError(4),
tooSmallMaxSize(5),
tooManyMaxSizeHits(6),
noResource(7)
}
ACCESS read-only
STATUS mandatory
DESCRIPTION
"A value indicating the type of error that has occurred during
data collection operations for this entry.
noError The value is 'noError' when
the corresponding value of
cdcVFileOperStatus is not 'error'.
otherError Any error other than one of the
following listed errors.
noSpace There is no space left to write into
the current VFile.
openError Could not open VFile for writing. One
possible reason could be the existence
of another file by the same name in
the agent's filesystem.
tooSmallMaxSize Indicates that cdcVFileMaxSize is
too small for data collection. The
cdcVFileMaxSize configured for this
VFile is not sufficient even to hold
the data collected in one poll.
tooManyMaxSizeHits Indicates that data collection
operations are stopped because
the value of cdcVFileMaxSizeHitsLimit
has been exceeded.
noResource Some kind of resource was unavailable
while collecting data. For
e.g. unavailability of dynamic memory."
::= { cdcVFileEntry 13 }
cdcVFileCollectionErrorEnable OBJECT-TYPE
SYNTAX TruthValue
-- Rsyntax INTEGER {
-- true(1),
-- false(2)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"When set to 'true', cdcVFileCollectionError notification will
be sent out in the event of a data collection error."
DEFVAL { false }
::= { cdcVFileEntry 14 }
cdcVFileRowStatus OBJECT-TYPE
SYNTAX RowStatus
-- Rsyntax INTEGER {
-- active(1),
-- notInService(2),
-- notReady(3),
-- createAndGo(4),
-- createAndWait(5),
-- destroy(6)
-- }
ACCESS read-write
STATUS mandatory
DESCRIPTION
"The status of this conceptual row.
A valid cdcVFileName is only mandatory object for setting
this object to 'active'. But collection of data in to active
vfile starts only on setting cdcVFileAdminStatus
to 'enabled'.
Setting this object to 'destroy' stops all data collection
operations for this entry, deletes all VFiles and removes
this entry from cdcVFileTable."
::= { cdcVFileEntry 15 }
cdcVFileMgmtTable OBJECT-TYPE
SYNTAX SEQUENCE OF CdcVFileMgmtEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"A table to manage frozen VFiles."
::= { cdcVFile 4 }
cdcVFileMgmtEntry OBJECT-TYPE
SYNTAX CdcVFileMgmtEntry
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"An entry in cdcVFileMgmtTable. Each entry corresponds to a
frozen VFile. An entry is created in this table, whenever a
VFile is frozen. An entry is removed from this table whenever
a frozen VFile is deleted either because the retention period
elapsed or because it was adminstratively deleted.
If the configuration specified in cdcVFileEntry is persisted
across system/agent restarts AND the VFiles created as a
result of that configuration are persisted across restarts,
then this table must be populated with entries corresponding
to those persisted VFiles. However any state related to an
entry, like time to live etc. need not be maintained
across restarts."
INDEX { cdcVFileIndex, cdcVFileMgmtIndex }
::= { cdcVFileMgmtTable 1 }
CdcVFileMgmtEntry ::= SEQUENCE {
cdcVFileMgmtIndex Gauge,
cdcVFileMgmtName DisplayString,
cdcVFileMgmtTimestamp DateAndTime,
cdcVFileMgmtTimeToLive Gauge,
cdcVFileMgmtCommand INTEGER,
cdcVFileMgmtXferURL CdcUrl,
cdcVFileMgmtLastXferStatus CdcFileXferStatus,
cdcVFileMgmtLastXferURL CdcUrl
}
cdcVFileMgmtIndex OBJECT-TYPE
SYNTAX Gauge(1..4294967295)
ACCESS not-accessible
STATUS mandatory
DESCRIPTION
"This value is a running counter starting at 1,
generated by the agent so that the combination of
cdcVFileIndex and cdcVFileMgmtIndex uniquely
identifies a frozen VFile. The deleted file indicies
do not get reused.
This object's value needs to be unique only across the
set of frozen VFiles corresponding to a cdcVFileEntry
(identified by cdcVFileIndex)."
::= { cdcVFileMgmtEntry 1 }
cdcVFileMgmtName OBJECT-TYPE
SYNTAX DisplayString
-- Rsyntax OCTET STRING(SIZE(0..255))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The full name of the VFile. If the VFile is stored as a file
in the agent's filesystem, then this value also contains the
absolute path of the file."
::= { cdcVFileMgmtEntry 2 }
cdcVFileMgmtTimestamp OBJECT-TYPE
SYNTAX DateAndTime
-- Rsyntax OCTET STRING(SIZE(8|11))
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The timestamp when this VFile was created, in the date-time
format."
::= { cdcVFileMgmtEntry 3 }
cdcVFileMgmtTimeToLive OBJECT-TYPE
SYNTAX Gauge(60..86400)
-- Units
-- seconds
ACCESS read-only
STATUS mandatory
DESCRIPTION
"The time left before this VFile is deleted (see
cdcVFileRetentionPeriod)."
::= { cdcVFileMgmtEntry 4 }
cdcVFileMgmtCommand OBJECT-TYPE
SYNTAX INTEGER {
idle(1),
delete(2),
transfer(3),
abortTransfer(4)
}
ACCESS read-write
STATUS mandatory
DESCRIPTION
"A control to manage VFiles.
idle This value can be only be read. It indicates
that no management action is currently being
performed on this VFile.
delete This value is only written, and is used to
delete the frozen VFile. Writing this value
will cause this entry to be removed from this
table.
transfer This value can be both read and written.
When read it means that the VFile is in the
process of being transferred. When written, it
initiates a transfer for the VFile.
abortTransfer This value can only be written, and is used
to abort an ongoing transfer."