docsPnmCmtsUsHistFileName
DOCS-PNM-MIB ·
.1.3.6.1.4.1.4491.2.1.27.1.3.5.1.10
Object
This object is the name of the file at the CMTS which is to be
transferred to the PNM server. The data is stored as 32 bit integers
for the hit and dwell count values. This value can only be changed
while a test is not in progress. An attempt to set this value while the
value of 'docsPnmCmtsUsHistMeasStatus' is 'busy' will return
'inconsistentValue'.
If the value of this object is the DEFVAL (empty string), then a
default filename value will be used. Otherwise the value set will be
used as the filename.
If a default filename value is used, it is generated as the test name
plus a unique CCAP identifier (either a loopback address (IPv4 or IPv6)
or FQDN), plus the 'epoch time'. The epoch time (also known as 'unix time')
is defined as the number of seconds that have elapsed since midnight
Coordinated Universal Time (UTC), Thursday, 1 January 1970.
Hence, the format would be:
PNMCcapHist_<Unique CCAP Identifier>_<epoch>
For example: PNMCcapHist_ccap1.boulder.cablelabs.com_1403405123
The data file is comprised of a header plus the Histogram Data. The header
is comprised of ordered fixed-length fields. Unless otherwise specified,
the header fields contain hex values that are right-justified within the
field. If necessary the field is left-padded with zero values.
Syntax of the file is as follows:
File Type set to '504E4D68' (without the quotes) 4 bytes
Capture Time 4 bytes
ifIndex 4 bytes
Unique CCAP ID 256 bytes
CntStartTime 4 bytes
CntEndTime 4 bytes
Length in bytes of Dwell Count values that follows 4 bytes
DwellCount Values (1-4096)*4 bytes each
Length in bytes of HitCount values that follow 4 bytes
HitCount Values (1-4096)*4 bytes each
Context
- MIB
- DOCS-PNM-MIB
- OID
.1.3.6.1.4.1.4491.2.1.27.1.3.5.1.10- Type
- column
- Access
- readwrite
- Status
- current
- Parent
- docsPnmCmtsUsHistEntry
- Table
- docsPnmCmtsUsHistTable
- Siblings
- 9
Syntax
SNMP-FRAMEWORK-MIBSnmpAdminString
- Source
- SNMP-FRAMEWORK-MIBSnmpAdminString
- Base type
OctetString
Values & Constraints
Type Constraints
range: 0..255
Related Objects
Sibling Objects
| Object | Type | Syntax | OID |
|---|---|---|---|
| docsPnmCmtsUsHistEnable Setting this object to a value of 'true' instructs the CMTS to begin
collection of histogram data and when enabled, the CMTS continues
producing new data at its own rate.
… | column | SNMPv2-TCTruthValue | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.1 |
| docsPnmCmtsUsHistRestart This attribute is used to restart collection of histogram data.
If 'docsPnmCmtsUsHistEnable' is 'true' then the setting this object to
'true' clears the old data and starts collec… | column | SNMPv2-TCTruthValue | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.2 |
| docsPnmCmtsUsHistTimeOut This object sets a seconds time-out timer for capturing histogram data.
When the timeout expires the 'docsPnmCmtsUsHistEnable' object will be set to
'false' and the… | column | seconds Unsigned32 | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.3 |
| docsPnmCmtsUsHistSymmetry This attribute is used to indicate whether 256 or 255 bins were used
for the measurement.
Even Symmetry = 'false' (default):
The histogram has even symmetry about t… | column | Bins SNMPv2-TCTruthValue | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.4 |
| docsPnmCmtsUsHistDwellCnts This attribute represents the total number Dwell Counts for each
bin for the Current capture. If the dwell count for all bins is the
same then only a single value is reported. The… | column | OctetString | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.5 |
| docsPnmCmtsUsHistHitCnts This attribute represents the total number Hit Counts for each bin
for the Current capture. If odd symmetry is used then there will 255 bins.
The value for each bin is reported as… | column | OctetString | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.6 |
| docsPnmCmtsUsHistCntStartTime This attribute represents the time when the collection of
histogram data was started. | column | OctetString | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.7 |
| docsPnmCmtsUsHistCntEndTime This attribute represents the time when the collection of
histogram data was stopped. | column | OctetString | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.8 |
| docsPnmCmtsUsHistMeasStatus This attribute is used to determine the status of the measurement.
The PNM server will query this value to determine when the file
is ready for transfer. | column | MeasStatusType | .1.3.6.1.4.1.4491.2.1.27.1.3.5.1.9 |