BULK-DATA-MIB
File:
BULK-DATA-MIB.mib (29892 bytes)
Imported modules
Imported symbols
Defined Types
| SliceEntry |
|
| SEQUENCE |
|
|
|
| |
sliceIndex |
Unsigned32 |
|
| |
sliceSubId |
Unsigned32 |
|
| |
sliceColumnOID |
OBJECT IDENTIFIER |
|
| |
sliceSnmpContext |
DisplayString |
|
| |
sliceColumnDisplayHint |
DisplayString |
|
| |
sliceAdminString |
DisplayString |
|
| |
sliceEntryStatus |
RowStatus |
|
| XferEntry |
|
| SEQUENCE |
|
|
|
| |
xferIndex |
Unsigned32 |
|
| |
xferSubId |
Unsigned32 |
|
| |
xferHostIpType |
InetAddressType |
|
| |
xferHostIpAddr |
InetAddress |
|
| |
xferProtocol |
INTEGER |
|
| |
xferWriteControl |
INTEGER |
|
| |
xferFilePath |
DisplayString |
|
| |
xferAuthUsername |
DisplayString |
|
| |
xferAuthPassword |
DisplayString |
|
| |
xferAdminString |
DisplayString |
|
| |
xferEntryStatus |
RowStatus |
|
| SnapshotEntry |
|
| SEQUENCE |
|
|
|
| |
snapshotIndex |
Unsigned32 |
|
| |
snapshotSliceIndex |
Unsigned32 |
|
| |
snapshotXferId |
Unsigned32 |
|
| |
snapshotSnapFileName |
DisplayString |
|
| |
snapshotFileEncoding |
INTEGER |
|
| |
snapshotFileCompression |
INTEGER |
|
| |
snapshotStartTime |
TimeStamp |
|
| |
snapshotCompletionTime |
TimeStamp |
|
| |
snapshotFileSize |
Unsigned32 |
|
| |
snapshotState |
INTEGER |
|
| |
snapshotAdminString |
DisplayString |
|
| |
snapshotEntryStatus |
RowStatus |
|
| XferCtlEntry |
|
| SEQUENCE |
|
|
|
| |
xferCtlIndex |
Unsigned32 |
|
| |
xferCtlStartTime |
TimeStamp |
|
| |
xferCtlCompletionTime |
TimeStamp |
|
| |
xferCtlPercentXferred |
Unsigned32 |
|
| |
xferCtlStatus |
INTEGER |
|
Defined Values
| bulkDataMIB |
1.3.6.1.3.999 |
| The MIB module for defining Bulk Data objects along with
the Bulk Data file format, Upload Fileserver and Data Slice. |
| MODULE-IDENTITY |
|
|
|
| acFileEncoding |
1.3.6.1.3.999.1.1 |
| This describes the agent's capability in term of which
file encoding styles it supports. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
ascii(1), xml(2) |
|
| acFileCompression |
1.3.6.1.3.999.1.2 |
| This describes the agent's capability in term of which
file compression styles it supports. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
noCompression(1), bzip(2), gzip(3) |
|
| acXferProtocol |
1.3.6.1.3.999.1.3 |
| This describes the agent's capability in term of which
file transfer protocols it supports. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
cp(1), ftp(2), scp(3) |
|
| sliceTable |
1.3.6.1.3.999.2.1 |
| This 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
SliceEntry |
|
| sliceEntry |
1.3.6.1.3.999.2.1.1 |
| The data slice entry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SliceEntry |
|
|
| sliceIndex |
1.3.6.1.3.999.2.1.1.1 |
| An arbitrary integer to uniquely identify this entry. To
create an entry a management application should pick a
random number. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| sliceSubId |
1.3.6.1.3.999.2.1.1.2 |
| A sequential sub-index to identify a component of a slice
entry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| sliceColumnOID |
1.3.6.1.3.999.2.1.1.3 |
| An 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
OBJECT IDENTIFIER |
|
|
| sliceSnmpContext |
1.3.6.1.3.999.2.1.1.4 |
| In mib groups that are not inherently instancable, an snmp
manager context is used to multiply access the separate
instances (eg, the bridge mib). |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| sliceColumnDisplayHint |
1.3.6.1.3.999.2.1.1.5 |
| This 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 field |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| sliceAdminString |
1.3.6.1.3.999.2.1.1.6 |
| Used for administrative purposes. Usually meaningful only
to the controlling NMS. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| sliceEntryStatus |
1.3.6.1.3.999.2.1.1.7 |
| The control variable that allows creation, modification,
and deletion of entries in this table. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| xferTable |
1.3.6.1.3.999.2.2 |
| This table describes a bulk data slice file transfer
information. It is referenced when a snapshot is being
requested. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
XferEntry |
|
| xferEntry |
1.3.6.1.3.999.2.2.1 |
| The snapshot file transfer request table entry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
XferEntry |
|
|
| xferIndex |
1.3.6.1.3.999.2.2.1.1 |
| An integer to uniquely identify a transfer destination set. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| xferSubId |
1.3.6.1.3.999.2.2.1.2 |
| Sub index that allows several transfer entries to be
grouped together to form a transfer set. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
|
|
| xferHostIpType |
1.3.6.1.3.999.2.2.1.3 |
| Used along with xferHostIpAddr to define the IP address
version. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
InetAddressType |
|
|
| xferHostIpAddr |
1.3.6.1.3.999.2.2.1.4 |
| The IP address of the fileserver where the snapshot is to
be transferred. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
InetAddress |
|
|
| xferProtocol |
1.3.6.1.3.999.2.2.1.5 |
| This 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
cp(1), ftp(2), scp(3) |
|
| xferWriteControl |
1.3.6.1.3.999.2.2.1.6 |
| This 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
failIfExists(1), overwrite(2) |
|
| xferFilePath |
1.3.6.1.3.999.2.2.1.7 |
| The remote directory path where the file is to be saved on
the fileserver. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| xferAuthUsername |
1.3.6.1.3.999.2.2.1.8 |
| The user name to use when authenticating with the remote
fileserver. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| xferAuthPassword |
1.3.6.1.3.999.2.2.1.9 |
| The password to use when authenticating with the remote
fileserver. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| xferAdminString |
1.3.6.1.3.999.2.2.1.10 |
| Used for administrative purposes. Usually meaningful only
to the controlling NMS. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| xferEntryStatus |
1.3.6.1.3.999.2.2.1.11 |
| The 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| snapshotTable |
1.3.6.1.3.999.2.3 |
| This 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). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
SnapshotEntry |
|
| snapshotEntry |
1.3.6.1.3.999.2.3.1 |
| The snapshot request table entry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SnapshotEntry |
|
|
| snapshotIndex |
1.3.6.1.3.999.2.3.1.1 |
| An integer to uniquely identify the data slice that is to
be transferred to the fileserver. This refers to an entry
in the SliceTable. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| snapshotSliceIndex |
1.3.6.1.3.999.2.3.1.2 |
| An integer to uniquely identify the data slice to saved on
the local system. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
|
|
| snapshotXferId |
1.3.6.1.3.999.2.3.1.3 |
| An instance in the xfer table that describes where and how
to copy the bulk data snapshot to a fileserver. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
|
|
| snapshotFileEncoding |
1.3.6.1.3.999.2.3.1.5 |
| If 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
ascii(1), xml(2) |
|
| snapshotFileCompression |
1.3.6.1.3.999.2.3.1.6 |
| If 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
noCompression(1), bzip(2), gzip(3) |
|
| snapshotStartTime |
1.3.6.1.3.999.2.3.1.7 |
| The value of sysUptime on the agent when the snapshot was
initiated. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
TimeStamp |
|
|
| snapshotCompletionTime |
1.3.6.1.3.999.2.3.1.8 |
| The value of sysUptime on the agent when the snapshot was
completed (with or without an error). |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
TimeStamp |
|
|
| snapshotFileSize |
1.3.6.1.3.999.2.3.1.9 |
| The 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. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
|
|
| snapshotState |
1.3.6.1.3.999.2.3.1.10 |
| The 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. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
running(1), ready(2), noSpace(3), badName(4), writeErr(5), noMem(6), aborted(7) |
|
| snapshotAdminString |
1.3.6.1.3.999.2.3.1.11 |
| Used for administrative purposes. Usually meaningful only
to the controlling NMS. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| snapshotEntryStatus |
1.3.6.1.3.999.2.3.1.12 |
| The 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| xferCtlTable |
1.3.6.1.3.999.2.4 |
| This 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). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
XferCtlEntry |
|
| xferCtlEntry |
1.3.6.1.3.999.2.4.1 |
| The snapshot file transfer request table entry. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
XferCtlEntry |
|
|
| xferCtlIndex |
1.3.6.1.3.999.2.4.1.1 |
| An integer to uniquely identify a transfer destination set. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| xferCtlStartTime |
1.3.6.1.3.999.2.4.1.2 |
| The value of sysUptime on the agent when the file transfer
was initiated. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
TimeStamp |
|
|
| xferCtlCompletionTime |
1.3.6.1.3.999.2.4.1.3 |
| The value of sysUptime on the agent when the file transfer
was completed (with or without an error). |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
TimeStamp |
|
|
| xferCtlPercentXferred |
1.3.6.1.3.999.2.4.1.4 |
| The amount of the snapshot file that has been transferred
to the fileserver, in percent of completion (0..100). |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
0..100 |
|
| xferCtlStatus |
1.3.6.1.3.999.2.4.1.5 |
| This 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. |
| Status: current |
Access: read-write |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
inProgress(1), complete(2), noSpace(3), badName(4), writeErr(5), badLogin(6), abortXfer(7), retryXfer(8), deleteRow(9) |
|
| bulkDataXfer |
1.3.6.1.3.999.3.1 |
| Asynchronous events that are sent when a file transfer
request changes state. |
| Status: current |
Access: read-write |
| NOTIFICATION-TYPE |
|
|
|
| bulkMIBCompliance |
1.3.6.1.3.999.4.1.1 |
| The compliance statement for entities which implement
the Bulk Data MIB. Implementation of this MIB
is based on individual product needs. |
| Status: current |
Access: read-write |
| MODULE-COMPLIANCE |
|
|
|
| bulkCapabilitiesGroup |
1.3.6.1.3.999.4.2.1 |
| Bulk Data agent capabilities management. |
| Status: current |
Access: read-write |
| OBJECT-GROUP |
|
|
|
| bulkSliceGroup |
1.3.6.1.3.999.4.2.2 |
| Bulk Data slice management. |
| Status: current |
Access: read-write |
| OBJECT-GROUP |
|
|
|
| bulkFileTransferGroup |
1.3.6.1.3.999.4.2.3 |
| Bulk File transfer management. |
| Status: current |
Access: read-write |
| OBJECT-GROUP |
|
|
|
| bulkSnapshotGroup |
1.3.6.1.3.999.4.2.4 |
| Bulk data snapshot management. |
| Status: current |
Access: read-write |
| OBJECT-GROUP |
|
|
|
| bulkXferCtlGroup |
1.3.6.1.3.999.4.2.5 |
| Bulk Data transfer control management. |
| Status: current |
Access: read-write |
| OBJECT-GROUP |
|
|
|
| bulkTrapGroup |
1.3.6.1.3.999.4.2.6 |
| Bulk Data trap management. |
| Status: current |
Access: read-write |
| NOTIFICATION-GROUP |
|
|
|