CISCO-DATA-COLLECTION-MIB
File:
CISCO-DATA-COLLECTION-MIB.mib (73313 bytes)
Imported modules
Imported symbols
Defined Types
| CdcCollectionSubtree |
|
| 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. |
| TEXTUAL-CONVENTION |
|
|
|
| |
OBJECT IDENTIFIER |
|
|
| CdcCollectionList |
|
| 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. |
| TEXTUAL-CONVENTION |
|
|
|
| |
OCTET STRING |
Size(0..16) |
|
| CdcRowInstanceId |
|
| 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}. |
| TEXTUAL-CONVENTION |
|
|
|
| |
OBJECT IDENTIFIER |
|
|
| CdcUrl |
|
| Represents a string that contains a Uniformed Resource
Locator as defined in RFC 1738. |
| TEXTUAL-CONVENTION |
|
|
|
| |
OCTET STRING |
Size(0..255) |
|
| CdcFileXferStatus |
|
| 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). |
| TEXTUAL-CONVENTION |
|
|
|
| |
INTEGER |
notStarted(1), success(2), aborted(3), fileOpenFailRemote(4), badDomainName(5), unreachableIpAddress(6), networkFailed(7), fileWriteFailed(8), authFailed(9) |
|
| CdcVFileEntry |
|
| SEQUENCE |
|
|
|
| |
cdcVFileIndex |
Unsigned32 |
|
| |
cdcVFileName |
DisplayString |
|
| |
cdcVFileDescription |
SnmpAdminString |
|
| |
cdcVFileCommand |
INTEGER |
|
| |
cdcVFileMaxSize |
Unsigned32 |
|
| |
cdcVFileCurrentSize |
Unsigned32 |
|
| |
cdcVFileFormat |
CdcFileFormat |
|
| |
cdcVFileCollectMode |
INTEGER |
|
| |
cdcVFileCollectionPeriod |
Unsigned32 |
|
| |
cdcVFileRetentionPeriod |
Unsigned32 |
|
| |
cdcVFileAdminStatus |
INTEGER |
|
| |
cdcVFileOperStatus |
INTEGER |
|
| |
cdcVFileErrorCode |
INTEGER |
|
| |
cdcVFileCollectionErrorEnable |
TruthValue |
|
| |
cdcVFileRowStatus |
RowStatus |
|
| CdcVFileMgmtEntry |
|
| SEQUENCE |
|
|
|
| |
cdcVFileMgmtIndex |
Unsigned32 |
|
| |
cdcVFileMgmtName |
DisplayString |
|
| |
cdcVFileMgmtTimestamp |
DateAndTime |
|
| |
cdcVFileMgmtTimeToLive |
Unsigned32 |
|
| |
cdcVFileMgmtCommand |
INTEGER |
|
| |
cdcVFileMgmtXferURL |
CdcUrl |
|
| |
cdcVFileMgmtLastXferStatus |
CdcFileXferStatus |
|
| |
cdcVFileMgmtLastXferURL |
CdcUrl |
|
| CdcDGEntry |
|
| SEQUENCE |
|
|
|
| |
cdcDGIndex |
Unsigned32 |
|
| |
cdcDGComment |
SnmpAdminString |
|
| |
cdcDGType |
INTEGER |
|
| |
cdcDGVFileIndex |
Unsigned32 |
|
| |
cdcDGTargetTag |
SnmpTagValue |
|
| |
cdcDGContextName |
SnmpAdminString |
|
| |
cdcDGObject |
VariablePointer |
|
| |
cdcDGObjectGrpIndex |
Unsigned32 |
|
| |
cdcDGInstGrpIndex |
Unsigned32 |
|
| |
cdcDGPollPeriod |
Unsigned32 |
|
| |
cdcDGRowStatus |
RowStatus |
|
| CdcDGBaseObjectEntry |
|
| SEQUENCE |
|
|
|
| |
cdcDGBaseObjectGrpIndex |
Unsigned32 |
|
| |
cdcDGBaseObjectIndex |
Unsigned32 |
|
| |
cdcDGBaseObjectSubtree |
CdcCollectionSubtree |
|
| |
cdcDGBaseObjectList |
CdcCollectionList |
|
| |
cdcDGBaseObjectRowStatus |
RowStatus |
|
| CdcDGInstanceEntry |
|
| SEQUENCE |
|
|
|
| |
cdcDGInstanceGrpIndex |
Unsigned32 |
|
| |
cdcDGInstanceIndex |
Unsigned32 |
|
| |
cdcDGInstanceType |
INTEGER |
|
| |
cdcDGInstanceOid |
CdcRowInstanceId |
|
| |
cdcDGInstanceOidEnd |
CdcRowInstanceId |
|
| |
cdcDGInstanceNumRepititions |
Unsigned32 |
|
| |
cdcDGInstanceOtherPtr |
RowPointer |
|
| |
cdcDGInstanceRowStatus |
RowStatus |
|
| CdcFileXferConfEntry |
|
| SEQUENCE |
|
|
|
| |
cdcFileXferConfPriUrl |
CdcUrl |
|
| |
cdcFileXferConfSecUrl |
CdcUrl |
|
| |
cdcFileXferConfRetryPeriod |
Unsigned32 |
|
| |
cdcFileXferConfRetryCount |
Unsigned32 |
|
| |
cdcFileXferConfSuccessEnable |
TruthValue |
|
| |
cdcFileXferConfFailureEnable |
TruthValue |
|
Defined Values
| ciscoDataCollectionMIB |
1.3.6.1.4.1.9.9.312 |
| 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. |
| MODULE-IDENTITY |
|
|
|
| cdcVFile |
1.3.6.1.4.1.9.9.312.1.1 |
| OBJECT IDENTIFIER |
|
|
|
| cdcVFilePersistentStorage |
1.3.6.1.4.1.9.9.312.1.1.1 |
| 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'. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
TruthValue |
|
|
| cdcVFileMaxSizeHitsLimit |
1.3.6.1.4.1.9.9.312.1.1.2 |
| 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). |
| Status: current |
Access: read-write |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcVFileTable |
1.3.6.1.4.1.9.9.312.1.1.3 |
| A table for setting up VFiles for collecting data. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
CdcVFileEntry |
|
| cdcVFileEntry |
1.3.6.1.4.1.9.9.312.1.1.3.1 |
| 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcVFileEntry |
|
|
| cdcVFileIndex |
1.3.6.1.4.1.9.9.312.1.1.3.1.1 |
| 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcVFileName |
1.3.6.1.4.1.9.9.312.1.1.3.1.2 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
Size(0..255) |
|
| cdcVFileDescription |
1.3.6.1.4.1.9.9.312.1.1.3.1.3 |
| A string that can be used for administrative purposes.
This object's value may be modified at any time. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
SnmpAdminString |
|
|
| cdcVFileCommand |
1.3.6.1.4.1.9.9.312.1.1.3.1.4 |
| 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). |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
idle(1), swapToNewFile(2), collectNow(3) |
|
| cdcVFileMaxSize |
1.3.6.1.4.1.9.9.312.1.1.3.1.5 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
512..4294967295 |
|
| cdcVFileCurrentSize |
1.3.6.1.4.1.9.9.312.1.1.3.1.6 |
| The size of the current VFile. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
0..4294967295 |
|
| cdcVFileCollectMode |
1.3.6.1.4.1.9.9.312.1.1.3.1.8 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
auto(1), manual(2) |
|
| cdcVFileCollectionPeriod |
1.3.6.1.4.1.9.9.312.1.1.3.1.9 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
60..604800 |
|
| cdcVFileRetentionPeriod |
1.3.6.1.4.1.9.9.312.1.1.3.1.10 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
60..86400 |
|
| cdcVFileAdminStatus |
1.3.6.1.4.1.9.9.312.1.1.3.1.11 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
enabled(1), disabled(2) |
|
| cdcVFileOperStatus |
1.3.6.1.4.1.9.9.312.1.1.3.1.12 |
| 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. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
enabled(1), disabled(2), error(3) |
|
| cdcVFileErrorCode |
1.3.6.1.4.1.9.9.312.1.1.3.1.13 |
| 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. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
noError(1), otherError(2), noSpace(3), openError(4), tooSmallMaxSize(5), tooManyMaxSizeHits(6), noResource(7) |
|
| cdcVFileCollectionErrorEnable |
1.3.6.1.4.1.9.9.312.1.1.3.1.14 |
| When set to 'true', cdcVFileCollectionError notification will
be sent out in the event of a data collection error. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
TruthValue |
|
|
| cdcVFileRowStatus |
1.3.6.1.4.1.9.9.312.1.1.3.1.15 |
| 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. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| cdcVFileMgmtEntry |
1.3.6.1.4.1.9.9.312.1.1.4.1 |
| 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcVFileMgmtEntry |
|
|
| cdcVFileMgmtIndex |
1.3.6.1.4.1.9.9.312.1.1.4.1.1 |
| 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). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcVFileMgmtName |
1.3.6.1.4.1.9.9.312.1.1.4.1.2 |
| 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. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
DisplayString |
|
|
| cdcVFileMgmtTimestamp |
1.3.6.1.4.1.9.9.312.1.1.4.1.3 |
| The timestamp when this VFile was created, in the date-time
format. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
DateAndTime |
|
|
| cdcVFileMgmtTimeToLive |
1.3.6.1.4.1.9.9.312.1.1.4.1.4 |
| The time left before this VFile is deleted (see
cdcVFileRetentionPeriod). |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
60..86400 |
|
| cdcVFileMgmtCommand |
1.3.6.1.4.1.9.9.312.1.1.4.1.5 |
| 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. |
| Status: current |
Access: read-write |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
idle(1), delete(2), transfer(3), abortTransfer(4) |
|
| cdcVFileMgmtXferURL |
1.3.6.1.4.1.9.9.312.1.1.4.1.6 |
| 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 that will be
created. When the default value of this object is
retained this VFile will be transferred to the URL
specified in cdcFileXferConfPriUrl or cdcFileXferConfSecUrl,
as the case may be.
However an application can specify a different URL, in which
case the VFile will be transferred to this new URL the next
time transfer is initiated.
This object's value may be modified at any time. |
| Status: current |
Access: read-write |
| OBJECT-TYPE |
|
|
|
| |
CdcUrl |
|
|
| cdcVFileMgmtLastXferURL |
1.3.6.1.4.1.9.9.312.1.1.4.1.8 |
| Indicates the URL of the destination to which the last
(completed) transfer was initiated. |
| Status: current |
Access: read-only |
| OBJECT-TYPE |
|
|
|
| |
CdcUrl |
|
|
| cdcDGTable |
1.3.6.1.4.1.9.9.312.1.2.1 |
| A table for specifying data groups. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
CdcDGEntry |
|
| cdcDGEntry |
1.3.6.1.4.1.9.9.312.1.2.1.1 |
| 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 done by specifying
the base objects and their instances for which the values
need to be fetched.
Data is collected only for those data groups, that have
the corresponding instance of cdcDGRowStatus set to
'active'.
In order for data to be collected, each data group has to
be associated with a cdcVFileEntry (see cdcDGVFileIndex). If
the data collection mode of the associated cdcVFileEntry is
automatic, then data is fetched and stored into the current
VFile of the associated cdcVFileEntry at periodic
intervals (cdcDGPollPeriod). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcDGEntry |
|
|
| cdcDGIndex |
1.3.6.1.4.1.9.9.312.1.2.1.1.1 |
| An arbitrary integer used to uniquely identify this entry.
When creating an entry, a management application should pick a
random number. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGType |
1.3.6.1.4.1.9.9.312.1.2.1.1.3 |
| 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 table. The columns of
this table correspond to the base objects
specified in cdcDGBaseObjectTable, and the
rows correspond to the values of the instances
specified in cdcDGInstanceTable.
This object's value cannot be modified while the value of
cdcDGRowStatus is 'active'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
object(1), table(2) |
|
| cdcDGVFileIndex |
1.3.6.1.4.1.9.9.312.1.2.1.1.4 |
| 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 stored into the current VFile of the
associated cdcVFileEntry.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGTargetTag |
1.3.6.1.4.1.9.9.312.1.2.1.1.5 |
| 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 data group is under
the security credentials of the requester that set
cdcDGRowStatus to 'active'. Those credentials are
the input parameters for isAccessAllowed from the
Architecture for Describing SNMP Management Frameworks.
Otherwise a search is carried out for an entry in the
snmpTargetAddrTable whose snmpTargetAddrTagList contains the
tag specified by the value of this object. The security
credentials (snmpTargetParamsEntry) of the first entry that
satisfies the above criteria, are passed as input parameters
for isAccessAllowed.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
SnmpTagValue |
|
|
| cdcDGContextName |
1.3.6.1.4.1.9.9.312.1.2.1.1.6 |
| 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 data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
SnmpAdminString |
|
|
| cdcDGObject |
1.3.6.1.4.1.9.9.312.1.2.1.1.7 |
| 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's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
VariablePointer |
|
|
| cdcDGObjectGrpIndex |
1.3.6.1.4.1.9.9.312.1.2.1.1.8 |
| Corresponds to a value of cdcDGBaseObjectGrpIndex, thus
identifying a set of entries in cdcDGBaseObjectTable, having
this value of cdcDGBaseObjectGrpIndex. This object's value is
used only when cdcDGType is of type 'table'.
This set of entries in cdcDGBaseObjectTable in turn
identifies the set of base objects, that makes up the columns
of this 'table' type data group.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGInstGrpIndex |
1.3.6.1.4.1.9.9.312.1.2.1.1.9 |
| Corresponds to a value of cdcDGInstanceGrpIndex, thus
identifying a set of entries in cdcDGInstanceTable, having
this value of cdcDGInstanceGrpIndex. This object's value is
used only when cdcDGType is of type 'table'.
The set of entries in cdcDGInstanceTable, in turn identifies
the set of instances of the base objects, whose values need
to fetched. If the value is 0, then all instances of the base
objects will be fetched.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
0..4294967295 |
|
| cdcDGPollPeriod |
1.3.6.1.4.1.9.9.312.1.2.1.1.10 |
| 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 associated cdcVFileEntry is automatic (see
cdcVFileCollectMode).
A periodic timer is started for this data group when
cdcDGRowStatus is set to 'active', provided the associated
cdcVFileEntry has already been 'activated', otherwise it is
started when the associated cdcVFileEntry is finally
activated.
The time interval after which the first expiration of this
timer should occur, is calculated as follows:
(value of sysUpTime.0) +
(value of cdcPollPeriod for this entry -
(value of sysUpTime.0 - VFile activation time for the
associated cdcVFileEntry) % cdcPollPeriod)
Subsequent expirations of the periodic timer can occur as per
the value specified in cdcDGPollPeriod. This helps in
synchronizing periodic polling of the data groups with
respect to the VFile activation time.
This object's value may be modified at any time, and the
change must take effect immediately. i.e. if the periodic
timer has been started, it's expiry time may need to be
re-adjusted. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..86400 |
|
| cdcDGRowStatus |
1.3.6.1.4.1.9.9.312.1.2.1.1.11 |
| The status of this conceptual row.
This object cannot be set to 'active' until values have been
assigned to cdcDGVFileIndex & cdcDGColGrpIndex. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| cdcDGBaseObjectEntry |
1.3.6.1.4.1.9.9.312.1.2.2.1 |
| 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcDGBaseObjectEntry |
|
|
| cdcDGBaseObjectGrpIndex |
1.3.6.1.4.1.9.9.312.1.2.2.1.1 |
| 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 (can
be randomly picked) for this object while creating a group of
entries that collectively identifies the set of base
objects for a data group. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGBaseObjectIndex |
1.3.6.1.4.1.9.9.312.1.2.2.1.2 |
| This object's value when combined with the value of
cdcDGBaseObjectGrpIndex uniquely identifies an entry in
this table.
A managment application can assign incremental values
starting from one, when creating each entry in a group of
entries (as identified by the value of
cdcDGBaseObjectGrpIndex). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGBaseObjectSubtree |
1.3.6.1.4.1.9.9.312.1.2.2.1.3 |
| 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 this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcCollectionSubtree |
|
|
| cdcDGBaseObjectList |
1.3.6.1.4.1.9.9.312.1.2.2.1.4 |
| 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 data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcCollectionList |
|
|
| cdcDGBaseObjectRowStatus |
1.3.6.1.4.1.9.9.312.1.2.2.1.5 |
| The status of this conceptual row.
This object cannot be set to 'active' until values have been
assigned to cdcDGBaseObjectSubtree & cdcDGBaseObjectList. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowStatus |
|
|
| cdcDGInstanceTable |
1.3.6.1.4.1.9.9.312.1.2.3 |
| 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 instances
specified for a data group do not overlap. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
SEQUENCE OF |
|
|
| |
|
CdcDGInstanceEntry |
|
| cdcDGInstanceEntry |
1.3.6.1.4.1.9.9.312.1.2.3.1 |
| 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. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcDGInstanceEntry |
|
|
| cdcDGInstanceGrpIndex |
1.3.6.1.4.1.9.9.312.1.2.3.1.1 |
| 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
be randomly picked) for this object while creating a group of
entries that collectively identifies the set of instances for a
data group. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGInstanceIndex |
1.3.6.1.4.1.9.9.312.1.2.3.1.2 |
| This object's value when combined with the value of
cdcDGInstanceGrpIndex uniquely identifies an entry in
this table.
A managment application can assign incremental values
starting from one, when creating each entry within a group
of entries (as identified by the value of
cdcDGInstanceGrpIndex). |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
1..4294967295 |
|
| cdcDGInstanceType |
1.3.6.1.4.1.9.9.312.1.2.3.1.3 |
| 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
associated data group, thus giving the exact
instance of the objects to be collected.
range The value of cdcDGInstanceOid is
appended to each base object in the
associated data group, thus giving the
starting object instance of the range.
The value of cdcDGInstanceEndOid
is appended to to each base object in the
associated data group, thus giving the
last object instances of the range.
repititions The value of cdcDGInstanceOid is
appended to each base object in the
associated data group, thus giving the
first object instance of the next 'n'
instances that need to be collected.
The value of 'n' is set in
cdcDGInstanceNumRepititions.
subTree The value of cdcDGInstanceOid is
appended to each base object in the
associated data group, thus identifying the
OBJECT IDENTFIFIER sub-tree, whose leaf
instances need to be collected.
other The value of cdcDGInstanceOtherPtr points to a
row (in another MIB table) that contains MIB
specific instance selection criteria. A MIB
defined for such purposes should describe
the selection criteria.
This object's value cannot be modified while the value of
cdcDGInstanceStatus is 'active'. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
INTEGER |
individual(1), range(2), repititions(3), subTree(4), other(5) |
|
| cdcDGInstanceOid |
1.3.6.1.4.1.9.9.312.1.2.3.1.4 |
| Contains the OBJECT IDENTIFIER fragment that identifies the
instances of the base objects that need to be collected.
If cdcDGInstanceType is 'individual' then this value
should be the OID fragment that, when appended to each base
MIB object gives the fully instantiated OID to be fetched.
If cdcDGInstanceType is 'range' then this value
should be the OID fragment that, when appended to each base
MIB object gives the start of a range of object instances
that needs to be fetched.
If cdcDGInstanceType is 'subTree' then this value
should be the OID fragment that, when appended to each base
MIB gives the sub-tree under which all leaf object instances
need to be fetched.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcRowInstanceId |
|
|
| cdcDGInstanceOidEnd |
1.3.6.1.4.1.9.9.312.1.2.3.1.5 |
| 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 only when the value of cdcDGInstanceType
is of type 'range'.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcRowInstanceId |
|
|
| cdcDGInstanceNumRepititions |
1.3.6.1.4.1.9.9.312.1.2.3.1.6 |
| Specifies the number of lexicographically consecutive object
instances to fetch.
This value is used only when the value of cdcDGInstanceType
is of type 'repititions'.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
|
|
| cdcDGInstanceOtherPtr |
1.3.6.1.4.1.9.9.312.1.2.3.1.7 |
| 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 cdcDGInstanceType
is of type 'other'.
This object's value may be modified at any time. The change
takes effect the next time data is fetched for this data
group. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
RowPointer |
|
|
| cdcFileXferConfEntry |
1.3.6.1.4.1.9.9.312.1.3.1.1 |
| An individual entry in the cdcFileXferConfTable. Each entry
identifies a primary and an optional secondary destination.
An entry is automatically created in this table, whenever an
entry is created in the cdcVFileTable. The application needs
to specify the URLs of the destination to which frozen VFiles
are transferred.
When a VFile is frozen, transfer will be first initiated to
the primary destination, if the transfer fails, then transfer
is initiated to the secondary destination. If this too fails,
then the cycle is repeated again after a specified time
period (value of cdcFileXferConfRetryPeriod) elapses. |
| Status: current |
Access: not-accessible |
| OBJECT-TYPE |
|
|
|
| |
CdcFileXferConfEntry |
|
|
| cdcFileXferConfPriUrl |
1.3.6.1.4.1.9.9.312.1.3.1.1.1 |
| 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 will be carried over
from the name of the VFile being tranferred, and will be
automatically appended by the agent.
This object's value may be modified at any time. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcUrl |
|
|
| cdcFileXferConfSecUrl |
1.3.6.1.4.1.9.9.312.1.3.1.1.2 |
| 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 the file
cannot be transferred in it's entirety to the specified
destination for some reason. Some common reasons for such
failures are listed out in CdcFileXferStatus.
The specified URL should contain the base-name of the remote
file, the suffix will be carried over from the name of the
VFile being tranferred, and will be automatically appended by
the agent.
This object's value may be modified at any time. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
CdcUrl |
|
|
| cdcFileXferConfRetryPeriod |
1.3.6.1.4.1.9.9.312.1.3.1.1.3 |
| 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 successfully transferred to
either the primary destination or the secondary destination.
This object's value may be modified at any time. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
60..86400 |
|
| cdcFileXferConfRetryCount |
1.3.6.1.4.1.9.9.312.1.3.1.1.4 |
| 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 modified at any time. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
Unsigned32 |
0..256 |
|
| cdcFileXferConfSuccessEnable |
1.3.6.1.4.1.9.9.312.1.3.1.1.5 |
| When set to 'true', cdcFileXferComplete notification will
be sent out in the event of a successful file transfer. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
TruthValue |
|
|
| cdcFileXferConfFailureEnable |
1.3.6.1.4.1.9.9.312.1.3.1.1.6 |
| When set to 'true', cdcFileXferComplete notification will
be sent out in the event of a file transfer failure. |
| Status: current |
Access: read-create |
| OBJECT-TYPE |
|
|
|
| |
TruthValue |
|
|
| cdcVFileCollectionError |
1.3.6.1.4.1.9.9.312.0.1 |
| Notification that data collection operations for a
cdcVFileEntry has encountered an error.
The cdcVFileEntry is identified by the instance portion of
cdcVFileName. The error code is available as the value of the
cdcVFileErrorCode variable. |
| Status: current |
Access: read-create |
| NOTIFICATION-TYPE |
|
|
|
| cdcFileXferComplete |
1.3.6.1.4.1.9.9.312.0.2 |
| Notification that file transfer to the destination
specified by the cdcVFileMgmtLastXferURL variable, has
completed with the status specified by the
cdcVFileMgmtLastXferStatus variable. |
| Status: current |
Access: read-create |
| NOTIFICATION-TYPE |
|
|
|
| ciscoDataCollMIBCompliance |
1.3.6.1.4.1.9.9.312.2.1.1 |
| The compliance statement for entities which implement
the Cisco Data Collection MIB. |
| Status: current |
Access: read-create |
| MODULE-COMPLIANCE |
|
|
|
| cdcVFileGroup |
1.3.6.1.4.1.9.9.312.2.2.1 |
| Objects related to VFiles. |
| Status: current |
Access: read-create |
| OBJECT-GROUP |
|
|
|
| cdcDataSelectionGroup |
1.3.6.1.4.1.9.9.312.2.2.2 |
| Objects related to data selection. |
| Status: current |
Access: read-create |
| OBJECT-GROUP |
|
|
|
| cdcFileXferGroup |
1.3.6.1.4.1.9.9.312.2.2.3 |
| Objects related to file transfer. |
| Status: current |
Access: read-create |
| OBJECT-GROUP |
|
|
|
| cdcNotificationGroup |
1.3.6.1.4.1.9.9.312.2.2.4 |
| Collection of Notifications to inform errors
occurred in data collection and status of file
transfer operation. |
| Status: current |
Access: read-create |
| NOTIFICATION-GROUP |
|
|
|