CISCO-DATA-COLLECTION-MIB
89 objects
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.
Imported Objects
| CISCO-SMI | ciscoMgmt |
| SNMP-FRAMEWORK-MIB | SnmpAdminString |
| SNMP-TARGET-MIB | SnmpTagValue |
| SNMPv2-CONF | MODULE-COMPLIANCE NOTIFICATION-GROUP OBJECT-GROUP |
| SNMPv2-SMI | MODULE-IDENTITY NOTIFICATION-TYPE OBJECT-TYPE Unsigned32 zeroDotZero |
| SNMPv2-TC | DateAndTime DisplayString RowPointer RowStatus TEXTUAL-CONVENTION TruthValue VariablePointer |
| OID | Name | Access | Status | Description |
|---|---|---|---|---|
| 1.3.6.1.4.1.9.9.312 | IdentityciscoDataCollectionMIB | 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' i… | ||
| 1.3.6.1.4.1.9.9.312.0 | NodeciscoDataCollMIBNotifs | |||
| 1.3.6.1.4.1.9.9.312.0.1 | NotificationcdcVFileCollectionError | current | Notification that data collection operations for a cdcVFileEntry has encountered an error. The cdcVFileEntry is identified by the instance portion of cdcVFileN… | |
| 1.3.6.1.4.1.9.9.312.0.2 | NotificationcdcFileXferComplete | current | Notification that file transfer to the destination specified by the cdcVFileMgmtLastXferURL variable, has completed with the status specified by the cdcVFileMg… | |
| 1.3.6.1.4.1.9.9.312.1 | NodeciscoDataCollMIBObjects | |||
| 1.3.6.1.4.1.9.9.312.1.1 | NodecdcVFile | |||
| 1.3.6.1.4.1.9.9.312.1.1.1 | ScalarcdcVFilePersistentStorage | read-only | current | This object's value reads 'true', if the agent implementation of this MIB supports placement of VFiles in application specified persistent storage locations. O… |
| 1.3.6.1.4.1.9.9.312.1.1.2 | ScalarcdcVFileMaxSizeHitsLimit | read-write | current | 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 offe… |
| 1.3.6.1.4.1.9.9.312.1.1.3 | TablecdcVFileTable | not-accessible | current | A table for setting up VFiles for collecting data. |
| 1.3.6.1.4.1.9.9.312.1.1.3.1 | RowcdcVFileEntry | not-accessible | current | An entry in the cdcVFileTable. Each entry contains application specified configuration that is used to create virtual files (VFile) and start data collection o… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.1 | ColumncdcVFileIndex | not-accessible | current | 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 … |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.2 | ColumncdcVFileName | read-create | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.3 | ColumncdcVFileDescription | read-create | current | A string that can be used for administrative purposes. This object's value may be modified at any time. |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.4 | ColumncdcVFileCommand | read-create | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.5 | ColumncdcVFileMaxSize | read-create | current | 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 … |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.6 | ColumncdcVFileCurrentSize | read-only | current | The size of the current VFile. |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.7 | ColumncdcVFileFormat | read-create | current | 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. |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.8 | ColumncdcVFileCollectMode | read-create | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.9 | ColumncdcVFileCollectionPeriod | read-create | current | 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 pe… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.10 | ColumncdcVFileRetentionPeriod | read-create | current | 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 pe… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.11 | ColumncdcVFileAdminStatus | read-create | current | A control object to indicate the administratively desired state of data collection for this entry. On setting the value to 'disabled' data collection operation… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.12 | ColumncdcVFileOperStatus | read-only | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.13 | ColumncdcVFileErrorCode | read-only | current | 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 … |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.14 | ColumncdcVFileCollectionErrorEnable | read-create | current | When set to 'true', cdcVFileCollectionError notification will be sent out in the event of a data collection error. |
| 1.3.6.1.4.1.9.9.312.1.1.3.1.15 | ColumncdcVFileRowStatus | read-create | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.4 | TablecdcVFileMgmtTable | not-accessible | current | A table to manage frozen VFiles. |
| 1.3.6.1.4.1.9.9.312.1.1.4.1 | RowcdcVFileMgmtEntry | not-accessible | current | 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 fro… |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.1 | ColumncdcVFileMgmtIndex | not-accessible | current | This value is a running counter starting at 1, generated by the agent so that the combination of cdcVFileIndex and cdcVFileMgmtIndex uniquely identifies a froz… |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.2 | ColumncdcVFileMgmtName | read-only | current | 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. |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.3 | ColumncdcVFileMgmtTimestamp | read-only | current | The timestamp when this VFile was created, in the date-time format. |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.4 | ColumncdcVFileMgmtTimeToLive | read-only | current | The time left before this VFile is deleted (see cdcVFileRetentionPeriod). |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.5 | ColumncdcVFileMgmtCommand | read-write | current | 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… |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.6 | ColumncdcVFileMgmtXferURL | read-write | current | The complete URL of the destination to which this VFile will be transferred in the next attempt. The URL also includes the complete filename of the remote file… |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.7 | ColumncdcVFileMgmtLastXferStatus | read-only | current | Indicates the status of the last completed transfer. |
| 1.3.6.1.4.1.9.9.312.1.1.4.1.8 | ColumncdcVFileMgmtLastXferURL | read-only | current | Indicates the URL of the destination to which the last (completed) transfer was initiated. |
| 1.3.6.1.4.1.9.9.312.1.2 | NodecdcDataGroup | |||
| 1.3.6.1.4.1.9.9.312.1.2.1 | TablecdcDGTable | not-accessible | current | A table for specifying data groups. |
| 1.3.6.1.4.1.9.9.312.1.2.1.1 | RowcdcDGEntry | not-accessible | current | An entry in this table. Each entry corresponds to a data group. A data group is used to select data that needs to be collected into VFiles. The selection is do… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.1 | ColumncdcDGIndex | not-accessible | current | An arbitrary integer used to uniquely identify this entry. When creating an entry, a management application should pick a random number. |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.2 | ColumncdcDGComment | read-create | current | A descriptive string. This object's value may be modified at any time. |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.3 | ColumncdcDGType | read-create | current | Identifies the type of this data group. object Data is a single MIB object. The fully instantiated OID is specified in cdcDGBaseObject. table Data is a logical… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.4 | ColumncdcDGVFileIndex | read-create | current | Corresponds to a value of cdcVFileIndex. It is used to associate this data group with a cdcVFileEntry. The values of the base objects for this data group are s… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.5 | ColumncdcDGTargetTag | read-create | current | The tag for the target from which to obtain the data for this data group. A length of 0 indicates the local system. In this case, access to the objects of this… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.6 | ColumncdcDGContextName | read-create | current | The management context from which to obtain data for this data group. This object's value may be modified at any time. The change takes effect the next time da… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.7 | ColumncdcDGObject | read-create | current | The fully instantiated name of the MIB object whose value needs to be fetched. This object's value is used only when cdcDGType is of type 'object'. This object… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.8 | ColumncdcDGObjectGrpIndex | read-create | current | Corresponds to a value of cdcDGBaseObjectGrpIndex, thus identifying a set of entries in cdcDGBaseObjectTable, having this value of cdcDGBaseObjectGrpIndex. Thi… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.9 | ColumncdcDGInstGrpIndex | read-create | current | Corresponds to a value of cdcDGInstanceGrpIndex, thus identifying a set of entries in cdcDGInstanceTable, having this value of cdcDGInstanceGrpIndex. This obje… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.10 | ColumncdcDGPollPeriod | read-create | current | Specifies the time intervals at which the data should be fetched for this data group. This object's value is used only when the collection mode of the associat… |
| 1.3.6.1.4.1.9.9.312.1.2.1.1.11 | ColumncdcDGRowStatus | read-create | current | The status of this conceptual row. This object cannot be set to 'active' until values have been assigned to cdcDGVFileIndex & cdcDGColGrpIndex. |
| 1.3.6.1.4.1.9.9.312.1.2.2 | TablecdcDGBaseObjectTable | not-accessible | current | A table specifying the base objects of a 'table' type data group. |
| 1.3.6.1.4.1.9.9.312.1.2.2.1 | RowcdcDGBaseObjectEntry | not-accessible | current | An individual entry in this table. Each entry is a {subtree, list} tuple. Each tuple identifies a set of base objects for the associated data group. |
| 1.3.6.1.4.1.9.9.312.1.2.2.1.1 | ColumncdcDGBaseObjectGrpIndex | not-accessible | current | This object's value when combined with the value of cdcDGBaseObjectIndex uniquely identifies an entry in this table. An application must use the same value (ca… |
| 1.3.6.1.4.1.9.9.312.1.2.2.1.2 | ColumncdcDGBaseObjectIndex | not-accessible | current | This object's value when combined with the value of cdcDGBaseObjectGrpIndex uniquely identifies an entry in this table. A managment application can assign incr… |
| 1.3.6.1.4.1.9.9.312.1.2.2.1.3 | ColumncdcDGBaseObjectSubtree | read-create | current | The subtree component of a {subtree, list} tuple. This object's value may be modified at any time. The change takes effect the next time data is fetched for th… |
| 1.3.6.1.4.1.9.9.312.1.2.2.1.4 | ColumncdcDGBaseObjectList | read-create | current | The list component of a {subtree, list} tuple. This object's value may be modified at any time. The change takes effect the next time data is fetched for this … |
| 1.3.6.1.4.1.9.9.312.1.2.2.1.5 | ColumncdcDGBaseObjectRowStatus | read-create | current | The status of this conceptual row. This object cannot be set to 'active' until values have been assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList. |
| 1.3.6.1.4.1.9.9.312.1.2.3 | TablecdcDGInstanceTable | not-accessible | current | Identifies the instances of the base objects that need to be fetched for a 'table' type data group. The agent is not responsible for verifying that the instanc… |
| 1.3.6.1.4.1.9.9.312.1.2.3.1 | RowcdcDGInstanceEntry | not-accessible | current | An entry in this table. Each entry identifies one or more instances of the base objects that need to be fetched. An instance is represented by an OID fragment. |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.1 | ColumncdcDGInstanceGrpIndex | not-accessible | current | This object's value when combined with the value of cdcDGInstanceIndex uniquely identifies an entry in this table. An application must use the same value (can … |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.2 | ColumncdcDGInstanceIndex | not-accessible | current | This object's value when combined with the value of cdcDGInstanceGrpIndex uniquely identifies an entry in this table. A managment application can assign increm… |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.3 | ColumncdcDGInstanceType | read-create | current | Specifies the way in which the instances are to be used while collecting data. individual The value of cdcDGInstanceOid is appended to each base object of the … |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.4 | ColumncdcDGInstanceOid | read-create | current | Contains the OBJECT IDENTIFIER fragment that identifies the instances of the base objects that need to be collected. If cdcDGInstanceType is 'individual' then … |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.5 | ColumncdcDGInstanceOidEnd | read-create | current | Contains the OID fragment that, when appended to each base object gives the end of the range of object instances that needs to be fetched. This value is used o… |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.6 | ColumncdcDGInstanceNumRepititions | read-create | current | Specifies the number of lexicographically consecutive object instances to fetch. This value is used only when the value of cdcDGInstanceType is of type 'repiti… |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.7 | ColumncdcDGInstanceOtherPtr | read-create | current | Contains a pointer to a row in another MIB table that contains MIB specific criteria for selecting instances. This value is used only when the value of cdcDGIn… |
| 1.3.6.1.4.1.9.9.312.1.2.3.1.8 | ColumncdcDGInstanceRowStatus | read-create | current | The status of this conceptual row. |
| 1.3.6.1.4.1.9.9.312.1.3 | NodecdcFileXfer | |||
| 1.3.6.1.4.1.9.9.312.1.3.1 | TablecdcFileXferConfTable | not-accessible | current | A table for configuring file transfer operations. |
| 1.3.6.1.4.1.9.9.312.1.3.1.1 | RowcdcFileXferConfEntry | not-accessible | current | An individual entry in the cdcFileXferConfTable. Each entry identifies a primary and an optional secondary destination. An entry is automatically created in th… |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.1 | ColumncdcFileXferConfPriUrl | read-create | current | The URL which specifies the primary destination to which the file has to be transferred. The URL should contain the base-name of the remote file, the suffix wi… |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.2 | ColumncdcFileXferConfSecUrl | read-create | current | The URL which specifies the secondary destination to which the file has to be transferred if the transfer to the primary destination fails. Failure occurs when… |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.3 | ColumncdcFileXferConfRetryPeriod | read-create | current | Specifies the time interval after which transfer has to be retried. Transfer needs to be retried only if in a previous attempt the file could not be successful… |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.4 | ColumncdcFileXferConfRetryCount | read-create | current | Maximum number of times, transfer has to be retried. If the retry count exceeds this value, then no further attempts will be made. This object's value may be m… |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.5 | ColumncdcFileXferConfSuccessEnable | read-create | current | When set to 'true', cdcFileXferComplete notification will be sent out in the event of a successful file transfer. |
| 1.3.6.1.4.1.9.9.312.1.3.1.1.6 | ColumncdcFileXferConfFailureEnable | read-create | current | When set to 'true', cdcFileXferComplete notification will be sent out in the event of a file transfer failure. |
| 1.3.6.1.4.1.9.9.312.2 | NodeciscoDataCollMIBConformance | |||
| 1.3.6.1.4.1.9.9.312.2.1 | NodeciscoDataCollMIBCompliances | |||
| 1.3.6.1.4.1.9.9.312.2.1.1 | ComplianceciscoDataCollMIBCompliance | current | The compliance statement for entities which implement the Cisco Data Collection MIB. | |
| 1.3.6.1.4.1.9.9.312.2.2 | NodeciscoDataCollMIBGroups | |||
| 1.3.6.1.4.1.9.9.312.2.2.1 | GroupcdcVFileGroup | current | Objects related to VFiles. | |
| 1.3.6.1.4.1.9.9.312.2.2.2 | GroupcdcDataSelectionGroup | current | Objects related to data selection. | |
| 1.3.6.1.4.1.9.9.312.2.2.3 | GroupcdcFileXferGroup | current | Objects related to file transfer. | |
| 1.3.6.1.4.1.9.9.312.2.2.4 | GroupcdcNotificationGroup | current | Collection of Notifications to inform errors occurred in data collection and status of file transfer operation. |
Type Definitions
| Name | Syntax | Status | Description |
|---|---|---|---|
| CdcCollectionList | OCTET STRING (SIZE(0..16)) | current | 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… |
| CdcCollectionSubtree | current | 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 obje… | |
| CdcFileFormat | current | ||
| CdcFileXferStatus | INTEGER { notStarted(1), success(2), aborted(3), fileOpenFailRemote(4), badDomainName(5), unreachableIpAddress(6), networkFailed(7), fileWriteFailed(8), authFailed(9) } | current | 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… |
| CdcRowInstanceId | current | 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 CdcRowI… | |
| CdcUrl | OCTET STRING (SIZE(0..255)) | current | Represents a string that contains a Uniformed Resource Locator as defined in RFC 1738. |