BULK-DATA-MIB
AI MIB Summary
The BULK-DATA-MIB facilitates the transfer of large data sets between network management stations and agents by defining objects for file uploads, fileserver interactions, and data slicing. It enables the monitoring of bulk data transfer sessions, file integrity, and chunked transmission states within SNMP-managed environments.
The MIB module for defining Bulk Data objects along with the Bulk Data file format, Upload Fileserver and Data Slice.
Main OID:
bulkDataMIB.1.3.6.1.3.999
61
Objects
Active
Status
4
Dependencies
Imported Objects
Objects
61 total| Object Name |
|---|
bulkDataMIBThe MIB module for defining Bulk Data objects along with the Bulk Data file format, Upload Fileserver and Data Slice. MODULE-IDENTITY .1.3.6.1.3.999 |
bulkDataAgentCapabilities OBJECT IDENTIFIER .1.3.6.1.3.999.1 |
acFileEncodingThis describes the agent's capability in term of which file encoding styles it supports.ro Enumeration .1.3.6.1.3.999.1.1 |
acFileCompressionThis describes the agent's capability in term of which file compression styles it supports.ro Enumeration .1.3.6.1.3.999.1.2 |
acXferProtocolThis describes the agent's capability in term of which file transfer protocols it supports.ro Enumeration .1.3.6.1.3.999.1.3 |
bulkDataObjects OBJECT IDENTIFIER .1.3.6.1.3.999.2 |
sliceTableThis table describes a bulk data slice that is a user- defined subset of the current running agent's MIB data. Virtual tables are built by specifying a sequence of columnar Object Identifiers from real mib tables. SEQUENCE OF SliceEntry .1.3.6.1.3.999.2.1 |
sliceEntryThe data slice entry. SliceEntry .1.3.6.1.3.999.2.1.1 |
sliceIndexAn arbitrary integer to uniquely identify this entry. To create an entry a management application should pick a random number. Unsigned32 .1.3.6.1.3.999.2.1.1.1 |
sliceSubIdA sequential sub-index to identify a component of a slice entry. Unsigned32 .1.3.6.1.3.999.2.1.1.2 |
sliceColumnOIDAn Object Identifier, which must refer to a column of a conceptual table. A slice is defined to be a series of columns OIDs that exist in various tables which are accessible via the local agent.rw OBJECT IDENTIFIER .1.3.6.1.3.999.2.1.1.3 |
sliceSnmpContextIn mib groups that are not inherently instancable, an snmp manager context is used to multiply access the separate instances (eg, the bridge mib).rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.1.1.4 |
sliceColumnDisplayHintThis defines how the data file will render this OID's value in the snapshot data file. The following subset of the C printf-style formatting macros is supported: %s - ascii string field %d - numeric fieldrw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.1.1.5 |
sliceAdminStringUsed for administrative purposes. Usually meaningful only to the controlling NMS.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.1.1.6 |
sliceEntryStatusThe control variable that allows creation, modification, and deletion of entries in this table.rw RowStatus (SNMPv2-TC) .1.3.6.1.3.999.2.1.1.7 |
xferTableThis table describes a bulk data slice file transfer information. It is referenced when a snapshot is being requested. SEQUENCE OF XferEntry .1.3.6.1.3.999.2.2 |
xferEntryThe snapshot file transfer request table entry. XferEntry .1.3.6.1.3.999.2.2.1 |
xferIndexAn integer to uniquely identify a transfer destination set. Unsigned32 .1.3.6.1.3.999.2.2.1.1 |
xferSubIdSub index that allows several transfer entries to be grouped together to form a transfer set. Unsigned32 .1.3.6.1.3.999.2.2.1.2 |
xferHostIpTypeUsed along with xferHostIpAddr to define the IP address version.rw InetAddressType (INET-ADDRESS-MIB) .1.3.6.1.3.999.2.2.1.3 |
xferHostIpAddrThe IP address of the fileserver where the snapshot is to be transferred.rw InetAddress (INET-ADDRESS-MIB) .1.3.6.1.3.999.2.2.1.4 |
xferProtocolThis defines the standard protocol that is used to upload the snapshot to the fileserver. The agent is the client in this transaction; ie, it initiates the upload to the fileserver. When the snapshot is being kept on the local system, cp(1) is to be specified. For remote file transfers, ftp(2) or scp(3) should be specified.rw Enumeration .1.3.6.1.3.999.2.2.1.5 |
xferWriteControlThis defines the action to take when uploading bulk data to a fileserver. If set to failIfExists(1) and a file already exists on the fileserver, the upload will fail and the existing file on the server will not be overwritten. If set to overwrite(2), a file will be uploaded and saved under the specified path and name even if one by that composite name already exists; if none exists by that composite name, a new file will be created.rw Enumeration .1.3.6.1.3.999.2.2.1.6 |
xferFilePathThe remote directory path where the file is to be saved on the fileserver.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.2.1.7 |
xferAuthUsernameThe user name to use when authenticating with the remote fileserver.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.2.1.8 |
xferAuthPasswordThe password to use when authenticating with the remote fileserver.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.2.1.9 |
xferAdminStringUsed for administrative purposes. Usually meaningful only to the controlling NMS.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.2.1.10 |
xferEntryStatusThe control that allows creation, modification, and deletion of entries. Setting this variable to createAndGo(4) or active(1) will case a row creation to be performed in this table. Note that no actual file transfer occurs until a snapshot table entry is created. Setting this variable to delete will delete this row entry.rw RowStatus (SNMPv2-TC) .1.3.6.1.3.999.2.2.1.11 |
snapshotTableThis table describes a bulk data slice snapshot request. The agent is expected to capture the values of the slice (atomically, if possible) and save them in a file on the local system when a row in this table is created and set to createAndGo(4) or active(1). SEQUENCE OF SnapshotEntry .1.3.6.1.3.999.2.3 |
snapshotEntryThe snapshot request table entry. SnapshotEntry .1.3.6.1.3.999.2.3.1 |
snapshotIndexAn integer to uniquely identify the data slice that is to be transferred to the fileserver. This refers to an entry in the SliceTable. Unsigned32 .1.3.6.1.3.999.2.3.1.1 |
snapshotSliceIndexAn integer to uniquely identify the data slice to saved on the local system. Unsigned32 .1.3.6.1.3.999.2.3.1.2 |
snapshotXferIdAn instance in the xfer table that describes where and how to copy the bulk data snapshot to a fileserver. Unsigned32 .1.3.6.1.3.999.2.3.1.3 |
snapshotSnapFileNameThe bulk data snapshot is saved under this filename.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.3.1.4 |
snapshotFileEncodingIf set to ascii(1), the format is human-readable ascii with a lines in the form: # timestampStart timestampCompletion col-1 col-2 ... col-n instance-1 value-1 value-2 ... instance-2 value-3 value-4 ... ... where: timestampStart and timestampCompletion are the values of sysUptime on the agent when the snapshot of the data slice was initiated and completed (with or without errors). column-1 thru column-n are the human-readable MIB module column names that are included in this data slice. instance-1 (etc) are human-readable MIB module instance names in usual dotted notation. value-1 (etc) are human-readable ascii representations of the actual values of the data cells. This is in DisplayString format regardless of the native data type of the column. It is implementation-specific if the column name is stored in dotted-OID format (.1.3.6...) or in symbolic format (ifInOctets). For example, an ifTable data slice file fragment might be: # 28711187 28711190 ifDescr ifType ifInOctets ifOutOctets 1 lo0 softwareLoopback 54550782 54552115 2 eth0 ethernet-csmacd 372380346 2746062289 3 eth0.0 ethernet-csmacd 4002949 126167 If set to xml(2), the data will be saved in XML tagged format.rw Enumeration .1.3.6.1.3.999.2.3.1.5 |
snapshotFileCompressionIf set to noCompression(1), no file compression will be applied before the data slice is transferred to the fileserver. If set to bzip(2), the standard bzip compression algorithm will be applied to the data slice before the file is uploaded to the fileserver. If set to gzip(3), the standard GNU gzip compression algorithm will be applied to the data slice before the file is uploaded to the fileserver.rw Enumeration .1.3.6.1.3.999.2.3.1.6 |
snapshotStartTimeThe value of sysUptime on the agent when the snapshot was initiated.ro TimeStamp (SNMPv2-TC) .1.3.6.1.3.999.2.3.1.7 |
snapshotCompletionTimeThe value of sysUptime on the agent when the snapshot was completed (with or without an error).ro TimeStamp (SNMPv2-TC) .1.3.6.1.3.999.2.3.1.8 |
snapshotFileSizeThe actual size of the file (after optional file compression was applied) at the completion of the snapshot. The size is measured in bytes. This variable is only valid upon the successful completion of a slice snapshot.ro Unsigned32 .1.3.6.1.3.999.2.3.1.9 |
snapshotStateThe file state: running data is being written to the file ready the file is ready to be sent or retrieved 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 aborted terminated by operator command Only the 'ready' state implies that snapshot has successfully completed.ro Enumeration .1.3.6.1.3.999.2.3.1.10 |
snapshotAdminStringUsed for administrative purposes. Usually meaningful only to the controlling NMS.rw DisplayString (SNMPv2-TC) .1.3.6.1.3.999.2.3.1.11 |
snapshotEntryStatusThe control that allows creation, modification, and deletion of entries. Setting this variable to createAndGo(4) or active(1) will initiate a snapshot of a slice entry to the local system and optionally initiate a remote file copy. Setting this variable to delete() will delete this row entry and delete the corresponding data file on the local system. Note that in practice, this variable could be set by an operator via the agent's craft interface, remotely via an NMS using SNMP or locally within the agent via automatic means, such as described in the DISMAN-SCHEDULE-MIB.rw RowStatus (SNMPv2-TC) .1.3.6.1.3.999.2.3.1.12 |
xferCtlTableThis table contains individual (fileserver host) transfer requests. There will be an entry in this table For each filserver that is to receive a snapshot slice. The current transfer status can be monitored as well as controlled (aborted, retried). SEQUENCE OF XferCtlEntry .1.3.6.1.3.999.2.4 |
xferCtlEntryThe snapshot file transfer request table entry. XferCtlEntry .1.3.6.1.3.999.2.4.1 |
xferCtlIndexAn integer to uniquely identify a transfer destination set. Unsigned32 .1.3.6.1.3.999.2.4.1.1 |
xferCtlStartTimeThe value of sysUptime on the agent when the file transfer was initiated.ro TimeStamp (SNMPv2-TC) .1.3.6.1.3.999.2.4.1.2 |
xferCtlCompletionTimeThe value of sysUptime on the agent when the file transfer was completed (with or without an error).ro TimeStamp (SNMPv2-TC) .1.3.6.1.3.999.2.4.1.3 |
xferCtlPercentXferredThe amount of the snapshot file that has been transferred to the fileserver, in percent of completion (0..100).ro Unsigned32 .1.3.6.1.3.999.2.4.1.4 |
xferCtlStatusThis allows individual file transfer requests to be controlled. inProgress(1) is returned if a file transfer is currently being performed by the local system. This is a read-only value. complete(2) is returned upon successful file transfer. This is a read-only value. noSpace(3), badName(4), writeErr(5), badLogin(6) are error status values that describe the error conditions of insufficient fileserver space to create the file, invalid filename, misc write error or authentication error on the fileserver. These values are readable but not writable. abortXfer(7), retryXfer(8) are writable values and allow remote control of currently pending file transfer requests. deleteRow(9) is a writable value that causes a row deletion from this table. In addition, any pending operations on this row are aborted.rw Enumeration .1.3.6.1.3.999.2.4.1.5 |
bulkDataTraps OBJECT IDENTIFIER .1.3.6.1.3.999.3 |
bulkDataXferAsynchronous events that are sent when a file transfer request changes state. NOTIFICATION-TYPE .1.3.6.1.3.999.3.1 |
bulkMIBConformance OBJECT IDENTIFIER .1.3.6.1.3.999.4 |
bulkMIBCompliances OBJECT IDENTIFIER .1.3.6.1.3.999.4.1 |
bulkMIBComplianceThe compliance statement for entities which implement the Bulk Data MIB. Implementation of this MIB is based on individual product needs. Unknown .1.3.6.1.3.999.4.1.1 |
bulkMIBGroups OBJECT IDENTIFIER .1.3.6.1.3.999.4.2 |
bulkCapabilitiesGroupBulk Data agent capabilities management. Unknown .1.3.6.1.3.999.4.2.1 |
bulkSliceGroupBulk Data slice management. Unknown .1.3.6.1.3.999.4.2.2 |
bulkFileTransferGroupBulk File transfer management. Unknown .1.3.6.1.3.999.4.2.3 |
bulkSnapshotGroupBulk data snapshot management. Unknown .1.3.6.1.3.999.4.2.4 |
bulkXferCtlGroupBulk Data transfer control management. Unknown .1.3.6.1.3.999.4.2.5 |
bulkTrapGroupBulk Data trap management. Unknown .1.3.6.1.3.999.4.2.6 |