CISCO-BULK-FILE-MIB

File: CISCO-BULK-FILE-MIB.mib (36662 bytes)

Imported modules

SNMPv2-SMI SNMPv2-TC SNMPv2-CONF
CISCO-SMI

Imported symbols

MODULE-IDENTITY OBJECT-TYPE NOTIFICATION-TYPE
zeroDotZero Counter32 Gauge32
Unsigned32 RowStatus DisplayString
TruthValue TimeStamp MODULE-COMPLIANCE
OBJECT-GROUP NOTIFICATION-GROUP ciscoMgmt

Defined Types

CbfDefineFileEntry  
SEQUENCE    
  cbfDefineFileIndex Unsigned32
  cbfDefineFileName DisplayString
  cbfDefineFileStorage INTEGER
  cbfDefineFileFormat INTEGER
  cbfDefineFileNow INTEGER
  cbfDefineFileEntryStatus RowStatus
  cbfDefineFileNotifyOnCompletion TruthValue

CbfDefineObjectEntry  
SEQUENCE    
  cbfDefineObjectIndex Unsigned32
  cbfDefineObjectClass INTEGER
  cbfDefineObjectID OBJECT IDENTIFIER
  cbfDefineObjectEntryStatus RowStatus
  cbfDefineObjectTableInstance OBJECT IDENTIFIER
  cbfDefineObjectNumEntries Unsigned32
  cbfDefineObjectLastPolledInst OBJECT IDENTIFIER

CbfStatusFileEntry  
SEQUENCE    
  cbfStatusFileIndex Unsigned32
  cbfStatusFileState INTEGER
  cbfStatusFileCompletionTime TimeStamp
  cbfStatusFileEntryStatus RowStatus

Defined Values

ciscoBulkFileMIB 1.3.6.1.4.1.9.9.81
The MIB module for creating and deleting bulk files of SNMP data for file transfer.
MODULE-IDENTITY    

ciscoBulkFileMIBObjects 1.3.6.1.4.1.9.9.81.1
OBJECT IDENTIFIER    

cbfDefine 1.3.6.1.4.1.9.9.81.1.1
OBJECT IDENTIFIER    

cbfStatus 1.3.6.1.4.1.9.9.81.1.2
OBJECT IDENTIFIER    

cbfDefineMaxFiles 1.3.6.1.4.1.9.9.81.1.1.1
The maximum number of file definitions this system can hold in cbfDefineFileTable. A value of 0 indicates no configured limit. This object may be read-only on some systems. Changing this number does not disturb existing entries.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cbfDefineFiles 1.3.6.1.4.1.9.9.81.1.1.2
The current number of file definitions in cbfDefineFileTable.
OBJECT-TYPE    
  Gauge32  

cbfDefineHighFiles 1.3.6.1.4.1.9.9.81.1.1.3
The maximum value of cbfDefineFiles since system initialization.
OBJECT-TYPE    
  Gauge32  

cbfDefineFilesRefused 1.3.6.1.4.1.9.9.81.1.1.4
The number of attempts to create a file definition that failed due to exceeding cbfDefineMaxFiles.
OBJECT-TYPE    
  Counter32  

cbfDefineMaxObjects 1.3.6.1.4.1.9.9.81.1.1.5
The maximum total number of object selections to go with file definitions this system, that is, the total number of objects this system can hold in cbfDefineObjectTable. A value of 0 indicates no configured limit. This object may be read-only on some systems. Changing this number does not disturb existing entries.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cbfDefineObjects 1.3.6.1.4.1.9.9.81.1.1.6
The current number of object selections in cbfDefineObjectTable.
OBJECT-TYPE    
  Gauge32  

cbfDefineHighObjects 1.3.6.1.4.1.9.9.81.1.1.7
The maximum value of cbfDefineObjects since system initialization.
OBJECT-TYPE    
  Gauge32  

cbfDefineObjectsRefused 1.3.6.1.4.1.9.9.81.1.1.8
The number of attempts to create an object selection that failed due to exceeding cbfDefineMaxObjects.
OBJECT-TYPE    
  Counter32  

cbfDefineFileTable 1.3.6.1.4.1.9.9.81.1.1.9
A table of bulk file definition and creation controls.
OBJECT-TYPE    
  SEQUENCE OF  
    CbfDefineFileEntry

cbfDefineFileEntry 1.3.6.1.4.1.9.9.81.1.1.9.1
Information for creation of a bulk file. To creat a bulk file an application creates an entry in this table and corresponding entries in cbfDefineObjectTable. When the entry in this table and the corresponding entries in cbfDefineObjectTable are 'active' the appliction uses cbfDefineFileNow to create the file and a corresponding entry in cbfStatusFileTable. Deleting an entry in cbfDefineFileTable deletes all corresponding entries in cbfDefineObjectTable and cbfStatusFileTable. An entry may not be modified or deleted while its cbfDefineFileNow has the value 'running'.
OBJECT-TYPE    
  CbfDefineFileEntry  

cbfDefineFileIndex 1.3.6.1.4.1.9.9.81.1.1.9.1.1
An arbitrary integer to uniquely identify this entry. To create an entry a management application should pick a random number.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

cbfDefineFileName 1.3.6.1.4.1.9.9.81.1.1.9.1.2
The file name which is to be created. Explicit device or path choices in the value of this object override cbfDefineFileStorage.
OBJECT-TYPE    
  DisplayString Size(0..255)  

cbfDefineFileStorage 1.3.6.1.4.1.9.9.81.1.1.9.1.3
The type of file storage to use: ephemeral data exists in small amounts until read volatile data exists in volatile memory permanent data survives reboot An ephemeral file is suitable to be read only one time. Note that this value is taken as advisory and may be overridden by explicit device or path choices in cbfDefineFile. A given system may support any or all of these.
OBJECT-TYPE    
  INTEGER ephemeral(1), volatile(2), permanent(3)  

cbfDefineFileFormat 1.3.6.1.4.1.9.9.81.1.1.9.1.4
The format of the data in the file: StandardBER standard SNMP ASN.1 BER bulkBinary a binary format specified with this MIB bulkASCII a human-readable form of bulkBinary variantBERWithCksum ASN.1 BER encoding with checksum variantBinWithCksum a binary format with checksum A given system may support any or all of these.
OBJECT-TYPE    
  INTEGER standardBER(1), bulkBinary(2), bulkASCII(3), variantBERWithCksum(4), variantBinWithCksum(5)  

cbfDefineFileNow 1.3.6.1.4.1.9.9.81.1.1.9.1.5
The control to cause file creation. The only values that can be set are 'create' and 'forcedCreate'. These can be set only when the value is 'ready'. Setting it to 'create' begins a file creation and creates a corresponding entry in cbfStatusFileTable. The system may choose to use an already existing copy of the file instead of creating a new one. This may happen if there has been no configuration change on the system and a request to recreate the file is received. Setting this object to 'forcedCreate' forces the system to create a new copy of the file. The value is 'notActve' as long as cbfDefineFileEntryStatus or any corresponding cbfDefineObjectEntryStatus is not active. When cbfDefineFileEntryStatus becomes active and all corresponding cbfDefineObjectEntryStatuses are active this object automatically goes to 'ready'.
OBJECT-TYPE    
  INTEGER notActive(1), ready(2), create(3), running(4), forcedCreate(5)  

cbfDefineFileEntryStatus 1.3.6.1.4.1.9.9.81.1.1.9.1.6
The control that allows creation, modification, and deletion of entries. For detailed rules see the DESCRIPTION for cbfDefineFileEntry.
OBJECT-TYPE    
  RowStatus  

cbfDefineFileNotifyOnCompletion 1.3.6.1.4.1.9.9.81.1.1.9.1.7
This controls the cbfDefineFileCompletion notification. If true, cbfDefineFileCompletion notification will be generated. It is the responsibility of the management entity to ensure that the SNMP administrative model is configured in such a way as to allow the notification to be delivered.
OBJECT-TYPE    
  TruthValue  

cbfDefineObjectTable 1.3.6.1.4.1.9.9.81.1.1.10
A table of objects to go in bulk files.
OBJECT-TYPE    
  SEQUENCE OF  
    CbfDefineObjectEntry

cbfDefineObjectEntry 1.3.6.1.4.1.9.9.81.1.1.10.1
Information about one object for a particular file. An application uses cbfDefineObjectEntryStatus to create entries in this table in correspondence with entries in cbfDefineFileTable, which must be created first. Entries in this table may not be changed, created or deleted while the corresponding value of cbfDefineFileNow is 'running'.
OBJECT-TYPE    
  CbfDefineObjectEntry  

cbfDefineObjectIndex 1.3.6.1.4.1.9.9.81.1.1.10.1.1
An arbitrary integer to uniquely identify this entry. The numeric order of the entries controls the order of the objects in the file.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

cbfDefineObjectClass 1.3.6.1.4.1.9.9.81.1.1.10.1.2
The meaning of each object class is given below: object a single MIB object is retrieved. lexicalTable an entire table or partial table is retrieved in lexical order of rows. leastCpuTable an entire table is retrieved with lowest CPU utilization. Lexical ordering of rows may not be maintained and is dependent upon individual MIB implementation.
OBJECT-TYPE    
  INTEGER object(1), lexicalTable(2), leastCpuTable(3)  

cbfDefineObjectID 1.3.6.1.4.1.9.9.81.1.1.10.1.3
The object identifier of a MIB object to be included in the file. If cbfDefineObjectClass is 'object' this must be a full OID, including all instance information. If cbfDefineObjectClass is 'lexicalTable' or 'leastCpuTable' this must be the OID of the table-defining SEQUENCE OF registration point.
OBJECT-TYPE    
  OBJECT IDENTIFIER  

cbfDefineObjectEntryStatus 1.3.6.1.4.1.9.9.81.1.1.10.1.4
The control that allows creation, modification, and deletion of entries. For detailed rules see the DESCRIPTION for cbfDefineObjectEntry.
OBJECT-TYPE    
  RowStatus  

cbfDefineObjectTableInstance 1.3.6.1.4.1.9.9.81.1.1.10.1.5
If cbfDefineObjectClass is 'lexicalTable', then this object represents the starting instance in the cbfDefineObjectID table. The file created will have entries starting from the lexicographically next instance of the OID represented by this object. For Eg: ------- Let us assume we are polling ifTable and we have information till the second row(ifIndex.2). Now we may be interested in 10 rows lexically following the second row. So, we set cbfDefineObjectTableInstance as ifIndex.2 and cbfDefineObjectNumEntries as 10. We will get information for the next 10 rows or if there are less than 10 populated rows, we will receive information till the end of the table is reached. The default value for this object is zeroDotZero. If this object has the value of zeroDotZero and cbfDefineObjectNumEntries has value 0, then the whole table(represented by cbfDefineObjectID) is retrieved. If this object has the value of zeroDotZero, cbfDefineObjectNumEntries has value n (>0) and there are m(>0) entries in the table(represented by cbfDefineObjectID) then the first n entries in the table are retrieved if n < m. If n >= m, then the whole table is retrieved. When the value of cbfDefineObjectNumEntries is 0, it means all the entries in the table(represented by cbfDefineObjectID) which lexicographically follow cbfDefineObjectTableInstance are retrieved. This object is irrelevent if cbfDefineObjectClass is not 'lexicalTable'.
OBJECT-TYPE    
  OBJECT IDENTIFIER  

cbfDefineObjectNumEntries 1.3.6.1.4.1.9.9.81.1.1.10.1.6
If cbfDefineObjectClass is 'lexicalTable', then this object represents the maximum number of entries which will be populated in the file starting from the lexicographically next instance of the OID represented by cbfDefineObjectTableInstance. This object is irrelevent if cbfDefineObjectClass is not 'lexicalTable'. Refer to the description of cbfDefineObjectTableInstance for examples and different scenarios relating to this object.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cbfDefineObjectLastPolledInst 1.3.6.1.4.1.9.9.81.1.1.10.1.7
This object represents the last polled instance in the table. The value represented by this object will be relevent only if the corresponding cbfStatusFileState is emptied(3) for ephemeral files or ready(2) for volatile or permanent files. A value of zeroDotZero indicates an absence of last polled object. An NMS can use the value of this object and populate the cbfDefineObjectTableInstance to retrieve a contiguous set of rows in a table.
OBJECT-TYPE    
  OBJECT IDENTIFIER  

cbfStatusMaxFiles 1.3.6.1.4.1.9.9.81.1.2.1
The maximum number of file statuses this system can hold in cbfStatusFileTable. A value of 0 indicates no configured limit. This object may be read-only on some systems. Changing this number deletes the oldest finished entries until the new limit is satisfied.
OBJECT-TYPE    
  Unsigned32 0..4294967295  

cbfStatusFiles 1.3.6.1.4.1.9.9.81.1.2.2
The current number of file statuses in cbfStatusFileTable.
OBJECT-TYPE    
  Gauge32  

cbfStatusHighFiles 1.3.6.1.4.1.9.9.81.1.2.3
The maximum value of cbfStatusFiles since system initialization.
OBJECT-TYPE    
  Gauge32  

cbfStatusFilesBumped 1.3.6.1.4.1.9.9.81.1.2.4
The number times the oldest entry was deleted due to exceeding cbfStatusMaxFiles.
OBJECT-TYPE    
  Counter32  

cbfStatusFileTable 1.3.6.1.4.1.9.9.81.1.2.5
A table of bulk file status.
OBJECT-TYPE    
  SEQUENCE OF  
    CbfStatusFileEntry

cbfStatusFileEntry 1.3.6.1.4.1.9.9.81.1.2.5.1
Status for a particular file. An entry exists in this table for each time cbfDefineFileNow has been set to 'create' and the corresponding entry here has not been explicitly deleted by the application or bumped to make room for a new entry. Deleting an entry with cbfStatusFileState 'running' aborts the file creation attempt. It is implementation and file-system specific whether deleting the entry also deletes the file.
OBJECT-TYPE    
  CbfStatusFileEntry  

cbfStatusFileIndex 1.3.6.1.4.1.9.9.81.1.2.5.1.1
An arbitrary integer to uniquely identify this file. The numeric order of the entries implies the creation order of the files.
OBJECT-TYPE    
  Unsigned32 1..4294967295  

cbfStatusFileState 1.3.6.1.4.1.9.9.81.1.2.5.1.2
The file state: running data is being written to the file ready the file is ready to be read emptied an ephemeral file was successfully consumed noSpace no data due to insufficient file space badName no data due to a name or path problem writeErr no data due to fatal file write error noMem no data due to insufficient dynamic memory buffErr implementation buffer too small aborted short terminated by operator command Only the 'ready' state implies that the file is available for transfer. The disposition of files after an error is implementation and file-syste specific.
OBJECT-TYPE    
  INTEGER running(1), ready(2), emptied(3), noSpace(4), badName(5), writeErr(6), noMem(7), buffErr(8), aborted(9)  

cbfStatusFileCompletionTime 1.3.6.1.4.1.9.9.81.1.2.5.1.3
The value of sysUpTime when the creation attempt completed. A value of 0 indicates not complete. For ephemeral files this is the time when cbfStatusFileState goes to 'emptied'. For others this is the time when the state leaves 'running'.
OBJECT-TYPE    
  TimeStamp  

cbfStatusFileEntryStatus 1.3.6.1.4.1.9.9.81.1.2.5.1.4
The control that allows deletion of entries. For detailed rules see the DESCRIPTION for cbfStatusFileEntry. This object may not be set to any value other than 'destroy'.
OBJECT-TYPE    
  RowStatus  

ciscoBulkFileMIBNotificationPrefix 1.3.6.1.4.1.9.9.81.2
OBJECT IDENTIFIER    

ciscoBulkFileMIBNotifications 1.3.6.1.4.1.9.9.81.2.0
OBJECT IDENTIFIER    

cbfDefineFileCompletion 1.3.6.1.4.1.9.9.81.2.0.1
A cbfDefineFileCompletion notification is sent on the following conditions : - completion of a file consumption operation in case of ephemeral files. - completion of file creation operation in case of volatile or permanent files. - any error during file creation.
NOTIFICATION-TYPE    

ciscoBulkFileMIBConformance 1.3.6.1.4.1.9.9.81.3
OBJECT IDENTIFIER    

ciscoBulkFileMIBCompliances 1.3.6.1.4.1.9.9.81.3.1
OBJECT IDENTIFIER    

ciscoBulkFileMIBGroups 1.3.6.1.4.1.9.9.81.3.2
OBJECT IDENTIFIER    

ciscoBulkFileMIBCompliance 1.3.6.1.4.1.9.9.81.3.1.1
The compliance statement for entities which implement the Cisco Bulk File MIB. Implementation of this MIB is based on individual product needs.
MODULE-COMPLIANCE    

ciscoBulkFileMIBComplianceRev1 1.3.6.1.4.1.9.9.81.3.1.2
The compliance statement for entities which implement the Cisco Bulk File MIB. Implementation of this MIB is based on individual product needs.
MODULE-COMPLIANCE    

ciscoBulkFileDefineGroup 1.3.6.1.4.1.9.9.81.3.2.1
Bulk file definition management.
OBJECT-GROUP    

ciscoBulkFileStatusGroup 1.3.6.1.4.1.9.9.81.3.2.2
Bulk file status management.
OBJECT-GROUP    

ciscoBulkFileNotiGroup 1.3.6.1.4.1.9.9.81.3.2.3
A collection of notification objects for supporting Bulk file notification management.
NOTIFICATION-GROUP    

ciscoBulkFileDefineGroupRev1 1.3.6.1.4.1.9.9.81.3.2.4
Bulk file definition management.
OBJECT-GROUP