All MIBs › DOCS-PNM-MIB
Organization: Cable Television Laboratories, Inc.
Last Updated: 2017-04-13
Category: Domain: CATV/Cable, Standard: DOCSIS
Description: Manages Proactive Network Maintenance (PNM) measurements and impairment detection in DOCSIS networks.
Start monitoring vendor-neutral, standards-based MIB, any SNMPv3-capable network device (SNMP engine identity/boot/clock status) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.
What Is DOCS-PNM-MIB?
DOCS-PNM-MIB is the CableLabs standard MIB for DOCSIS 3.1 Proactive Network Maintenance (PNM), a feature set that lets operators run diagnostic measurements on cable modems to detect RF plant impairments before they cause service outages. It exposes bulk-data upload configuration (destination IP address and path for measurement files), a docsPnmBulkFileTable tracking individual measurement files with control and upload status per entry, and cable-modem test-control objects such as docsPnmCmCtlTest and its duration. For monitoring purposes this MIB is squarely about proactive fault detection: docsPnmBulkFileUploadStatus reveals whether a diagnostic capture has successfully been retrieved from the modem, and running docsPnmCmCtlTest lets an operator trigger on-demand diagnostics to catch degrading RF conditions, like micro-reflections or noise, before they escalate into outright connectivity loss. It builds on DOCSIS 3.1's broader physical-layer and cable-device MIBs, since PNM measurements are taken against those underlying PHY channels. It is deployed by cable operators as part of proactive network maintenance programs across their DOCSIS 3.1 CM/CMTS footprint. Network engineers evaluating or troubleshooting this functionality can download the DOCS-PNM-MIB file directly to load it into their MIB browser.
IPNetwork Monitor allows you to monitor SNMP objects defined in DOCS-PNM-MIB. Use the built-in SNMP Monitoring Browser to explore available variables, view their current values and descriptions, and select the objects you want to monitor. You can then create SNMP monitors, configure thresholds, and receive alerts when monitored values change.
Supported Devices
- DOCSIS 3.1 cable modem
- cable modem termination system (CMTS)
- vendor-neutral, standards-based DOCSIS MIB
Monitoring Examples
An operator configures docsPnmBulkDestIpAddr and docsPnmBulkDestPath so measurement files land on a collection server, then polls docsPnmBulkFileTable/docsPnmBulkFileEntry (keyed by docsPnmBulkFileIndex) to check docsPnmBulkFileControl and docsPnmBulkFileUploadStatus for each capture, confirming files transferred successfully. Triggering docsPnmCmCtlTest with a set docsPnmCmCtlTestDuration runs an on-demand diagnostic sweep on a suspect modem. A repeatedly failing docsPnmBulkFileUploadStatus could indicate connectivity or storage problems separate from the RF impairment the test itself is trying to detect.
What Can Be Monitored
- bulk measurement file upload status
- bulk upload destination configuration
- on-demand cable modem diagnostic test control/duration
- measurement file inventory
This MIB depends on
Related MIBs
Imported Objects
From CLAB-DEF-MIB
| clabProjDocsis | OBJECT-IDENTITY |
From DOCS-IF-MIB
| TenthdB |
From DOCS-IF3-MIB
| docsIf3CmSpectrumAnalysisCtrlCmd | OBJECT-IDENTITY |
From DOCS-IF31-MIB
| DsOfdmModulationType |
From IF-MIB
| InterfaceIndex | |
| InterfaceIndexOrZero | |
| ifIndex | OBJECT-TYPE |
From INET-ADDRESS-MIB
| InetAddress | |
| InetAddressType |
From SNMP-FRAMEWORK-MIB
| SnmpAdminString |
From SNMPv2-CONF
| MODULE-COMPLIANCE | |
| OBJECT-GROUP |
From SNMPv2-SMI
| Counter64 | |
| Integer32 | |
| MODULE-IDENTITY | |
| OBJECT-TYPE | |
| Unsigned32 |
From SNMPv2-TC
| MacAddress | |
| RowStatus | |
| TEXTUAL-CONVENTION | |
| TimeStamp | |
| TruthValue |
OIDs
| OID symbolic | OID numeric | Type | Access | Description |
|---|---|---|---|---|
| T/F docsIf3CmSpectrumAnalysisCtrlCmdFileEnable | 1.3.6.1.4.1.4491.2.1.20.1.34.10 | TruthValue | read-write | This attribute, when set to 'true', causes the CM to begin a Spectrum Analysis measurement with the parameters defined by the docsIf3CmSpectrumAnalysisCtrlCmd set of attributes. In order to set this object to 'true', the Enable must already be set to 'true'. When the measurement is completed successfully, a file is generated and is made available for transfer and the MeasStatus attribute is set to 'sampleReady'. The file will contain one complete snapshot of the spectrum data. Setting this object to a value of 'false' instructs the CM to stop the measurement. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is unable to perform a spectrum measurement for any reason. Examples might include DOCSIS Light Sleep (DLS) mode or battery-backup mode. - A default value for 'docsIf31CmSpectrumAnalysisCtrlCmdFileName' is defined; thus, this object may be set to 'true' without explicitly setting this value. - Setting this object to a value of 'true' will change the value of the 'docsIf31CmSpectrumAnalysisCtrlCmdMeasStatus' to 'busy'. After completion, 'docsIf31CmSpectrumAnalysisCtrlCmdMeasStatus' will be changed to reflect the status of the test. -This object will return a value of 'true' if it is actively taking a measurement; otherwise it returns 'false'. |
| MEA docsIf3CmSpectrumAnalysisCtrlCmdMeasStatus | 1.3.6.1.4.1.4491.2.1.20.1.34.11 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. An application server will query this value to determine when the file is ready for transfer. |
| STR docsIf3CmSpectrumAnalysisCtrlCmdFileName | 1.3.6.1.4.1.4491.2.1.20.1.34.12 | SnmpAdminString | read-write | This attribute is the name of the file containing the spectrum analysis data. This value can only be changed while a test is not in progress. An attempt to set this value while the value of MeasStatus 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMSpecAnData__ For example: PNMSpecAnData_0010181A2D11_1403405123 The data file is comprised of a header plus the Spectrum Analysis 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 '504E4D09' (without the quotes) 4 bytes Capture Time 4 bytes Channel Id (use zero for this test) 1 byte CM MAC Address 6 bytes FirstSegmentCenterFrequency 4 bytes LastSegmentCenterFrequency 4 bytes SegmentFrequencySpan 4 bytes NumBinsPerSegment 2 bytes EquivalentNoiseBandWidth 2 bytes WindowFunction(SpectrumAnalysisWindowFunction enum) 2 bytes Length in bytes of SpecAnData that follows 4 bytes Spectrum Analysis Data BinAmplitudeFileData If the size of the data the CM is commanded to collect would exceed the maximum file-size limit of the data collection mechanism, the CM will limit the file size accordingly and set the 'MeasStatus' attribute to a value of 'sampleTruncated'. If this occurs, the file will contain valid data, from the beginning of the capture, but will represent fewer bins than configured for the measurement. |
| docsPnmMIB | 1.3.6.1.4.1.4491.2.1.27 | This MIB module contains management objects for the management of DOCSIS 3.1 Proactive Network Maintenance. Copyright 2015-2017 Cable Television Laboratories, Inc. All rights reserved. | ||
| docsPnmNotifications | 1.3.6.1.4.1.4491.2.1.27.0 | |||
| docsPnmMibObjects | 1.3.6.1.4.1.4491.2.1.27.1 | |||
| docsPnmBulkData | 1.3.6.1.4.1.4491.2.1.27.1.1 | |||
| docsPnmBulkCtl | 1.3.6.1.4.1.4491.2.1.27.1.1.1 | |||
| IPt docsPnmBulkDestIpAddrType | 1.3.6.1.4.1.4491.2.1.27.1.1.1.1 | InetAddressType | read-write | This object represents the IP address type of the 'docsPnmBulkDestIpAddr' object. This value is of type InetAddressType which is defined by RFC4001. Allowed values for this object are: 'unknown', 'ipv4', 'ipv6'. A successful connection depends on the value of this attribute being set to an IP Family supported by the device. For example, if this value is set to IPv6 and the device is operating in an IPv4-only mode, a successful upload will not be possible. In this case the 'docsPnmBulkFileUploadStatus' object would reflect the error. The CM must NOT allow the value of docsPnmBulkDestIpAddrType to change if the value of PnmCmCtlStatus is any value other than 'ready'. |
| IP docsPnmBulkDestIpAddr | 1.3.6.1.4.1.4491.2.1.27.1.1.1.2 | InetAddress | read-write | This object represents the IP address of the server to which the bulk data file is to be sent. This attribute is further defined by the 'docsPnmBulkDestIpAddrType' object. The CM must NOT allow the value of docsPnmBulkDestIpAddr to change if the value of PnmCmCtlStatus is any value other than 'ready'. |
| STR docsPnmBulkDestPath | 1.3.6.1.4.1.4491.2.1.27.1.1.1.3 | SnmpAdminString | read-write | This object represents the path, excluding the filename, at the server to which the captured data file is to be sent. The CM must NOT allow the value of docsPnmBulkDestPath to change if the value of PnmCmCtlStatus is any value other than 'ready'. By default, the value of this object is an empty string. If used, this value must include all expected delimiters. The following examples, are valid values: /Directory1/directory2/ /pnm/ |
| INT docsPnmBulkUploadControl | 1.3.6.1.4.1.4491.2.1.27.1.1.1.4 | INTEGER | read-write | This attribute controls the action taken by the device when a new bulk data file is generated. The possible values are defined below. noAutoUpload - Bulk Data files are not automatically uploaded by the device. All bulk data files are available to be uploaded, on demand, by manipulating the FileControl attribute in the BulkDataFile object for that file's row instance. autoUpload - When this option is selected, the device must automatically uploaded bulk data files as they become available. A file becomes available when a file-generation application completes the file and creates a row in the BulkDataFileTable. If this value is set, the bulk data file is automatically uploaded to the parameters defined by the DestIpAddr, DestIpAddrType, and DestPath. If the upload fails or additional uploads are desired, the file can be re-uploaded by manipulating the FileControl attribute in the BulkDataFile object for that file's row instance. |
| docsPnmBulkFileTable | 1.3.6.1.4.1.4491.2.1.27.1.1.2 | not-accessible | This table provides the objects needed for the device to upload a bulk data file to the Server. This object is a table with a row for each file that is available in the device for upload. The parameters used for the upload are provided under the 'docsPnmBulkCtl' object. | |
| docsPnmBulkFileEntry | 1.3.6.1.4.1.4491.2.1.27.1.1.2.1 | not-accessible | The conceptual row of the 'docsPnmBulkFileTable'. An instance is dynamically created and exists for each file that is available for upload. The device must create a row for each file that is available for upload. The device could have have limited resources to save captured data files. Therefore, if the number of files exceeds the minimum supported number of files requirements for the device, newly created rows can overwrite/replace existing rows as new data files become available. If a bulk data file is no longer available for upload, the device must remove that file's details from the BulkDataFile table. The conceptual rows do not persist across device resets. | |
| U32 docsPnmBulkFileIndex | 1.3.6.1.4.1.4491.2.1.27.1.1.2.1.1 | Unsigned32 | not-accessible | This object is the index for the table. |
| STR docsPnmBulkFileName | 1.3.6.1.4.1.4491.2.1.27.1.1.2.1.2 | SnmpAdminString | read-only | This object contains the name of the bulk data file stored in the device, that is available to be uploaded to the server. Filenames are defined by the application that creates them. |
| INT docsPnmBulkFileControl | 1.3.6.1.4.1.4491.2.1.27.1.1.2.1.3 | INTEGER | read-write | This object controls the action taken by the device regarding the file specified by the 'docsPnmBulkFileName' object. When a value is written to this object for a given row instance, the device is required to take that action on the specified bulk data file. The possible actions are: other(1) - This value is returned when the object is read. This value is not writeable. tftpUpload(2) The device must initiate a TFTP-Write to the server with the parameters specified in the 'docsPnmBulkDestIpAddr', 'docsPnmBulkDestIpAddrType', and 'docsPnmBulkDestPath' objects. This action will change the value of the 'docsPnmBulkFileUploadStatus' to 'uploadInProgress' while the transfer is ongoing. This object can only be set to 'tftpUpload' when the value of the 'docsPnmBulkFileUploadStatus' object is not set to a value of 'uploadInProgress' for this row OR for any row in the table. This limits the upload process to one upload at a time. This object will return 'inconsistentValue' for this case. cancelUpload(3) The device must cancel a pending upload or an upload currently in progress on this bulk data file. The value of 'docsPnmBulkFileUploadStatus' will be changed to 'uploadCancelled'. deleteFile(4) The device must delete the file from its memory and from this table. This object can not be set to 'deleteFile' while an upload is in progress. |
| INT docsPnmBulkFileUploadStatus | 1.3.6.1.4.1.4491.2.1.27.1.1.2.1.4 | INTEGER | read-only | This attribute reflects the status of the bulk data file. The possible values are listed below. other(1) - Any condition not covered by the other defined values. availableForUpload(2) - The file is available to be uploaded. uploadInProgress(3) - The file is currently being uploaded. uploadCompleted(4) - The file was successfully uploaded. uploadPending(5) - The file has been selected for upload but a condition does not allow the upload to take place. The upload will start when the condition blocking uploads has been removed. For example, another upload that is currently in progress could cause this value to be returned. uploadCancelled(6) - An upload was cancelled before it completed. error(7) - An error occurred and the file was not successfully uploaded. |
| docsPnmCmObjects | 1.3.6.1.4.1.4491.2.1.27.1.2 | |||
| docsPnmCmControlObjects | 1.3.6.1.4.1.4491.2.1.27.1.2.1 | |||
| INT docsPnmCmCtlTest | 1.3.6.1.4.1.4491.2.1.27.1.2.1.1 | INTEGER | read-only | This attribute represents the current test. The value could represent the current test in-progress or if no test is running, the last test that was attempted. Any test that is not specifically covered by the enumeration for this object, but manipulates the 'PnmCmCtlStatus' object, the CM must set this object to a value of 'other' and will update the 'PnmCmCtlTestDuration' object. The value of this object is not required to persist across device resets. After a reset and before any test is run, the object will return a value of 'other'. |
| U32 docsPnmCmCtlTestDuration | 1.3.6.1.4.1.4491.2.1.27.1.2.1.2 | Unsigned32 | read-only | This attribute represents the number of seconds that the test specified in 'PnmCmCtlTest' spent with a 'PnmCmCtlStatus' of 'testInProgress'. This serves to provide a rough (seconds resolution) estimate of the time spent under test. If this object is read while the value of 'PnmCmCtlStutus' is 'testInProgress', then this object will return the number of seconds since the test started. This value is informative only and is not a guarantee of future performance. |
| INT docsPnmCmCtlStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.1.3 | INTEGER | read-only | This attribute represents the overall status of the PNM test platform. Individual tests, within the PNM test suite, have their own specific objects to start and stop. For each test defined by the data-type enumeration for 'PnmCmCtlTest', the CM must first check the status of this object before starting. If this object is set to any value other than 'ready', the CM must not start the test. If the CM was not able to start the test and the test has a 'MeasStatusType' object, the CM must set the 'MeasStatusType' to a value of 'resourceUnavailable'. If the test is allowed to start, the CM must change the value of this object to 'testInProgress'. When the test is no longer in progress, the CM must change the value of this object to a value other than 'testInProgress'. This mechanism serves to allow only one instance of only one test to run at a time. There may be some tests that are not included by this control object. That is, if any test is not defined by the data-type enumeration for 'PnmCmCtlTest', then it is not included (unless otherwise stated by the test definition) and is not required to check or to change this object. If a test is not included or covered by this set of objects, then it is allowed to run regardless of any other tests in progress. The possible values for this object are: 'other' - Any condition not otherwise defined 'ready' - The PNM platform is capable and ready to support a test. A test can be initiated 'testInProgress' - A PNM test is currently in progress 'tempReject' - A temporary condition exists that prohibits a test from starting, e.g., DBC |
| docsPnmCmDsOfdmSymCapTable | 1.3.6.1.4.1.4491.2.1.27.1.2.2 | not-accessible | The purpose of downstream symbol capture is to provide partial functionality of a network analyzer to analyze the response of the cable plant from the CM's perspective. At the CM, the received I and Q time-domain samples of one full OFDM symbol before the FFT, not including the guard interval, are captured and made available for analysis. This capture will result in a number of data points equal to the FFT length in use, time aligned for receiver FFT processing. The number of captured samples can be reduced for narrower channels if the sampling rate, which is implementation dependent, is reduced. The capture includes a bit indicating if receiver windowing effects are present in the data. The time domain samples are expressed as 16 bit two's complement numbers using s3.12 format. The CM samples are scaled such that the average power of the samples is approximately 1, in order to avoid excessive clipping and quantization noise. Capturing the input and output of the cable plant is equivalent to a wideband sweep of the channel, which permits full characterization of the linear and nonlinear response of the downstream plant. The MAC provides signaling via the PLC Trigger Message to ensure that the same symbol is captured at the CMTS and CM. The Downstream Symbol Capture is controlled by setting the 'docsPnmCmDsOfdmSymTrigEnable' object. The status of the capture is obtained by reading the value of the 'docsPnmCmDsOfdmSymMeasStatus' object. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsOfdmSymCapEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1 | not-accessible | The conceptual row of the docsPnmCmDsOfdmSymCapTable. An instance is dynamically created and exists for an associated ifIndex of the physical downstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmDsOfdmSymTrigEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.1 | TruthValue | read-write | If this attribute is set to a value of 'true' the CM must begin looking for the presence of the Trigger Message Block in the PLC with a Group ID matching the CM's 'docsPnmCmDsOfdmSymTrigGroupId'. The TrigEnable is a one-shot enable and the attribute is internally disabled when a PLC containing a Group ID matching the CM's 'docsPnmCmDsOfdmSymTrigGroupId' in a Trigger Message Block is received. If this attribute is set to a value of 'false' the CM must stop looking for the presence of the Trigger Message Block in the PLC with a Group ID matching the CM's 'docsPnmCmDsOfdmSymTrigGroupId'. In this case the value of the 'docsPnmCmDsOfdmSymMeasStatus' attribute will be set to 'inactive'. When read, the CM must return a value of 'true' if the CM is actively looking for the presence of the Trigger Message Block in the PLC with a Group ID matching the CM's 'docsPnmCmDsOfdmSymTrigGroupId'. Otherwise the CM must return 'false'. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - Default values for 'docsPnmCmDsOfdmSymCaptFileName', 'docsPnmCmDsOfdmSymTrigEnableTimeout', and 'docsPnmCmDsOfdmSymTrigGroupId' objects are defined; thus, this object may be set to 'true' without explicitly setting these values. Care should be taken to insure these values are correct for the desired test case. - Setting this attribute to a value of 'true' will change the value of the 'docsPnmCmDsOfdmSymMeasStatus' attribute to 'busy'. |
| U32 docsPnmCmDsOfdmSymTrigEnableTimeout | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.2 | Unsigned32 | read-write | This attribute is used to disable the TrigEnable if no PLC containing a Group ID matching the CM's TrigGroupId in a Trigger Message Block is received within the timeout period. The CM must timeout the test after TriggerEnableTimeout seconds from the time when the TriggerEnable was set to 'true'. A value of 0 indicates that no timeout is enforced, in this case the CM must enable the test until it completes, note in this case, the trigger could be enabled indefinitely. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmSymMeasStatus' is 'busy' will return 'inconsistentValue'. |
| U32 docsPnmCmDsOfdmSymTrigGroupId | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.3 | Unsigned32 | read-write | This attribute is used to associate a CM with a group of CMs expected to perform Symbol Capture measurements for the designated symbol. This value can only be changed while a test is not in progress. If the CM receives an attempt to set this value while the value of 'docsPnmCmDsOfdmSymMeasStatus' is 'busy' it will return 'inconsistentValue'. for this attribute. |
| T/F docsPnmCmDsOfdmSymRxWindowing | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.4 | TruthValue | read-only | This attribute is a flag indicating if vendor proprietary receiver windowing was enabled during the capture. |
| U32 docsPnmCmDsOfdmSymTransactionId | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.5 | Unsigned32 | read-only | This attribute is the Transaction ID sent by the CMTS in the Trigger Message Block. The CMTS increments this field by one on each trigger message that is sent, rolling over at value 255. Prior to completion of a measurement this attribute has no meaning. |
| U32 docsPnmCmDsOfdmSymSampleRate | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.6 | Unsigned32 | read-only | This attribute is the FFT sample rate in use by the CM for the channel. Typically the sample rate for the downstream channel will be 204.8MHz. |
| U32 docsPnmCmDsOfdmSymFftLength | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.7 | Unsigned32 | read-only | This attribute is the FFT length in use by the CM for the channel; typically this value is 4096 or 8192 for the Downstream Channel. |
| MEA docsPnmCmDsOfdmSymMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.8 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsOfdmSymCaptFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.2.1.9 | SnmpAdminString | read-write | This attribute is the name of the file, at the CM and containing captured symbol data, which is to be downloaded by the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmSymMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMSymCap__ For example: PNMSymCap_0010181A2D11_1403405123 The data file is comprised of a header plus the Symbol Capture 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 '504E4D01' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes Subcarrier zero Frequency in Hz 4 bytes SampleRate in Hz 4 bytes FFT Size 4 bytes TriggerGroupId 2 bytes Transaction ID 1 byte Length in bytes of Capture Data that follows 4 bytes Symbol Capture Data ComplexData |
| docsPnmCmOfdmChanEstCoefTable | 1.3.6.1.4.1.4491.2.1.27.1.2.3 | not-accessible | The purpose of this table is for the CM to report its estimate of the downstream channel response. The reciprocals of the channel response coefficients are typically used by the CM as its frequency-domain downstream equalizer coefficients. The channel estimate consists of a single complex valued coefficient per subcarrier. The channel response coefficients are expressed as 16 bit two's complement numbers using s2.13 format. The CM samples are scaled such that the average power of the samples is approximately 1, in order to avoid excessive clipping and quantization noise. Summary metrics (slope, ripple, and mean) are defined in order to avoid having to send all coefficients on every query. The summary metrics are calculated when the corresponding MIB is queried. A Coefficient filename and trigger are provided to obtain the channel coefficients. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmOfdmChanEstCoefEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1 | not-accessible | The conceptual row of the docsPnmCmOfdmChanEstCoefTable. An instance is dynamically created and exists for an associated ifIndex of the physical downstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmOfdmChEstCoefTrigEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.1 | TruthValue | read-write | Setting this object to a value of 'true' instructs the CM to begin collection and storing the channel estimate coefficients into the file specified by the 'docsPnmCmOfdmChEstCoefFileName' object. Setting this object to a value of 'false' instructs the CM to stop storing channel estimate coefficients in the file. When read, this object returns 'true' if the CM is actively storing channel estimate coefficients in the file. Otherwise it returns 'false'. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - A default value for 'docsPnmCmOfdmChEstCoefFileName' is defined; thus, this object may be set to 'true' without explicitly setting this value. - Setting this object to a value of 'true' will change the value of 'docsPnmCmOfdmChEstCoefMeasStatus' to 'busy'. |
| THO docsPnmCmOfdmChEstCoefAmpRipplePkToPk | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.2 | ThousandthdB | read-only | This attribute represents the value of the peak to peak ripple in the magnitude of the equalizer coefficients [PHYv3.1]. The slope component calculated for the AmplitudeSlope is subtracted from the frequency domain data and the peak to peak Ripple is calculated from the resultant data. This attribute represents the ripple across the entire OFDM channel. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section 6.5 and D.3 of the the DOCSIS 3.1 CM OSSI Specification. |
| THO docsPnmCmOfdmChEstCoefAmpRippleRms | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.3 | ThousandthdB | read-only | This attribute represents the value of the RMS ripple in the magnitude of the equalizer coefficients. The slope component calculated for the AmplitudeSlope is subtracted from the frequency domain data the RMS Ripple is calculated from the resultant data. This attribute represents the ripple across the entire OFDM channel. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the the DOCSIS 3.1 CM OSSI Specification. |
| I32 docsPnmCmOfdmChEstCoefAmpSlope | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.4 | Integer32 | read-only | This attribute represents the slope in 0.001 dB per MHz in the magnitude of the equalizer coefficients. The slope is calculated as the slope of a linear least squares fit of the frequency domain data. This attribute represents the slope across the entire OFDM channel. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the the DOCSIS 3.1 CM OSSI Specification. |
| U32 docsPnmCmOfdmChEstCoefGrpDelayRipplePkToPk | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.5 | Unsigned32 | read-only | This attribute represents the peak-to-peak group delay ripple expressed in units of 0.001 nsec. This attribute represents the group delay variation across the entire OFDM channel. The slope component calculated for the GroupDelaySlope is subtracted from the frequency domain data and the peak-to-peak ripple is calculated from the resultant data. |
| U32 docsPnmCmOfdmChEstCoefGrpDelayRippleRms | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.6 | Unsigned32 | read-only | This attribute represents the RMS value of the group delay ripple expressed in units of 0.001 nsec. This attribute represents the group delay variation across the entire OFDM channel. The slope component calculated for the GroupDelaySlope is subtracted from the frequency domain data and the RMS ripple is calculated from the resultant data. This attribute is not stored in the data file. |
| MEA docsPnmCmOfdmChEstCoefMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.7 | MeasStatusType | read-only | 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. |
| STR docsPnmCmOfdmChEstCoefFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.8 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. The data is stored as 16 bit integers for the I and Q data. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmOfdmChEstCoefMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMChEstCoef__ For example: PNMChEstCoef_0010181A2D11_1403405123 The data file is comprised of a header plus the Chan Estimate Coefficient 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 '504E4D02' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes Subcarrier zero frequency inHz 4 bytes FirstActiveSubcarrier Index 2 bytes Subcarrier spacing in kHz 1 byte Length in bytes of Chan Estimate Data that follows 4 bytes Channel estimate coefficient Data ComplexData |
| THO docsPnmCmOfdmChEstCoefAmpMean | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.9 | ThousandthdB | read-only | This attribute represents the mean, in 0.001 dB, of the magnitude of the equilizer coefficients. |
| I32 docsPnmCmOfdmChEstCoefGrpDelaySlope | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.10 | Integer32 | read-only | This attribute represents the slope in 0.001 nsec per MHz in the group delay of the equalizer coefficients. This attribute represents the slope across the entire OFDM channel. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| I32 docsPnmCmOfdmChEstCoefGrpDelayMean | 1.3.6.1.4.1.4491.2.1.27.1.2.3.1.11 | Integer32 | read-only | This attribute represents the mean of the group delay, in units of 0.001 nsec. |
| docsPnmCmDsConstDispMeasTable | 1.3.6.1.4.1.4491.2.1.27.1.2.4 | not-accessible | The downstream constellation display provides received QAM constellation points for display. Equalized soft decisions (I and Q) at the slicer input are collected over time, possibly subsampling to reduce complexity, and made available for analysis. This measurement is intended for data subcarriers only. Up to 8192 samples are provided for each query; additional queries can be made to further fill in the plot. The complex Constellation Display values are expressed as 16 bit two's complement numbers using s2.13 format. The CM samples are scaled such that the average power of the QAM constellation is approximately 1, in order to avoid excessive clipping and quantization noise. The object controls the CM capturing and reporting of received soft-decision samples, for a single selected constellation from the set of profiles it is receiving, within a single OFDM downstream channel. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsConstDispMeasEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1 | not-accessible | The conceptual row of the docsPnmCmDsConstDispMeasTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmDsConstDispTrigEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.1 | TruthValue | read-write | Setting this object to a value of 'true' instructs the CM to begin collection and storing the constellation points into the file specified by the 'docsPnmCmDsConstDispFileName' object. Setting this object to a value of 'false' instructs the CM to stop storing constellation points in the file. When read, this object returns 'true' if the CM is actively storing constellation points in the file. Otherwise it returns 'false'. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - A default value for 'docsPnmCmDsConstDispFileName' is defined; thus, this object may be set to 'true' without explicitly setting this value. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsConstDispMeasStatus' to 'busy'. |
| U32 docsPnmCmDsConstDispModOrderOffset | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.2 | Unsigned32 | read-write | This attribute specifies an offset from the lowest order modulation for the data subcarriers in any of the profiles in the downstream channel. If the lowest order modulation order that the CM was receiving was 1024-QAM and the ModulationOrderOffset was zero, then the CM would capture the soft decision samples for all of the subcarriers which were using 1024-QAM modulation order. If the ModulationOrderOffset was 1, then the CM would capture the soft decision samples for all of the subcarriers using the next highest modulation order in use for the profiles in the downstream channel. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsConstDispMeasStatus' is 'busy' will return 'inconsistentValue'. |
| U32 docsPnmCmDsConstDispNumSampleSymb | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.3 | Unsigned32 | read-write | This attribute tells the CM how many soft decision samples of OFDM subcarriers with the specified modulation order are captured. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsConstDispMeasStatus' is 'busy' will return 'inconsistentValue'. |
| DSO docsPnmCmDsConstDispSelModOrder | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.4 | DsOfdmModulationType | read-only | This object provides the actual Modulation Order that will be used for the Constellation display based on the selected ModulationOrderOffset. |
| MEA docsPnmCmDsConstDispMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.5 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsConstDispFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.4.1.6 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. The data is stored as 16 bit integers for the I and Q data. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsConstDispMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMDSConDisp__ For example: PNMDSConDisp_0010181A2D11_1403405123 The data file is comprised of a header plus the Constellation Display 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 '504E4D03' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes Subcarrier zero frequency in Hz 4 bytes Actual Modulation Order (DsOfdmModulationType enum) 2 bytes NumSampleSymbols 1 byte Subcarrier Spacing in kHz 1 byte Length in bytes of Constellation Data that follows 4 bytes Constellation Display Data ComplexData |
| docsPnmCmDsOfdmRxMerTable | 1.3.6.1.4.1.4491.2.1.27.1.2.5 | not-accessible | This item provides measurements of the receive modulation error ratio (RxMER) for each subcarrier. Each subcarrier RxMER value consists of one byte which represents the RxMER value with range 0 to 63.5 dB in 0.25 dB steps. If some subcarriers (such as exclusion bands) cannot be measured by the CM, the CM indicates that condition by reporting a value of 0xFF for the RxMER for those subcarriers. Any measured RxMER value below 0 dB is clipped to 0 dB (0x00), and any measured value above 63.5 dB is clipped to 63.5 dB (0xFE). Mathematical notation for the calculation of RxMER is provided in [PHYv3.1]: 'Downstream Receive Modulation Error Ratio (RxMER) Per Subcarrier'. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsOfdmRxMerEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1 | not-accessible | The conceptual row of the docsPnmCmDsOfdmRxMerTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmDsOfdmRxMerFileEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.1 | TruthValue | read-write | This attribute causes the CM to begin the RxMer measurement for the purpose of creating a file of RxMer data. When the measurement is complete the FileEnable attribute is set internally to 'false' by the CM. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - Setting this value to 'true' will change the value of the 'docsPnmCmDsOfdmRxMerMeasStatus' to 'busy' while the test is in progress. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - A default value for 'docsPnmCmDsOfdmRxMerFileName' is defined; thus, this object may be set to 'true' without explicitly setting this this value. - Setting this object to a value of 'false' instructs the CM to stop the measurement. - This object returns 'true' if the CM is actively taking a measurement. Otherwise it returns 'false'. |
| U32 docsPnmCmDsOfdmRxMerPercentile | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.2 | Unsigned32 | read-write | This attribute specifies the percentile (such as 2nd percentile or 5th percentile) of all active subcarriers in an OFDM channel at which the ThresholdRxMerValue occurs. That is, (Percentile) % of the subcarriers have RxMER <= ThresholdRxMerValue. |
| U32 docsPnmCmDsOfdmRxMerMean | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.3 | Unsigned32 | read-only | This attribute is the mean of the dB values of the RxMER measurements of all active subcarriers. The mean is computed directly on the dB values as follows: Mean = sum of (RxMER dB values) / number of RxMER values |
| U32 docsPnmCmDsOfdmRxMerStdDev | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.4 | Unsigned32 | read-only | This attribute is the standard deviation of the dB values of the RxMER measurements of all active subcarriers. The standard deviation is computed directly on the dB values as follows: StdDev = sqrt(sum of (RxMER dB values - RxMER_mean)^2 / number of RxMER values) |
| U32 docsPnmCmDsOfdmRxMerThrVal | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.5 | Unsigned32 | read-only | This attribute is the RxMER value corresponding to the specified Percentile value. The CM sorts the subcarriers in ascending order of RxMER, resulting in a post-sorting subcarrier index ranging from 1 to the number of active subcarriers. If the percentile value corresponds to a non-integer post-sorting subcarrier index, the post-sorting index is truncated (floor function is applied), that is, the post-sorting index is selected which is the greatest integer less than or equal to the corresponding percentile value. For example, if there are 3677 active subcarriers and the 2nd percentile is specified, the CM computes floor(3677*0.02) = 73. That is, the RxMER value of the 73rd subcarrier in the sorted list is associated with the 2nd percentile. |
| U32 docsPnmCmDsOfdmRxMerThrHighestFreq | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.6 | Unsigned32 | read-only | This attribute is the frequency in Hz of the highest-frequency subcarrier having RxMER = ThresholdRxMerValue. |
| MEA docsPnmCmDsOfdmRxMerMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.7 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsOfdmRxMerFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.5.1.8 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be downloaded by the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmRxMerMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMDsMer__ For example: PNMDsMer_0010181A2D11_1403405123 The data file is comprised of a header plus the Subcarrier RxMER 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 '504E4D04' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes Subcarrier zero frequency in Hz 4 bytes FirstActiveSubcarrierIndex 2 bytes Subcarrier Spacing in kHz 1 byte Length in bytes of RxMerData that follows 4 bytes Subcarrier RxMER Data RxMerData |
| docsPnmCmDsOfdmMerMarTable | 1.3.6.1.4.1.4491.2.1.27.1.2.6 | not-accessible | The purpose of this item is to provide an estimate of the MER margin available on the downstream data channel with respect to a candidate modulation profile. This is similar to the MER Margin reported in the OPT-RSP Message [MULPIv3.1]. The CM calculates the Required Average MER based on the bit loading for the profile and the Required MER per Modulation Order provided in the RequiredDsOfdmQamMer Table. The CM then measures the RxMER per subcarrier and calculates the Average MER for the Active Subcarriers used in the Profile and stores the value as MeasuredAvgMer. The CM also counts the number of MER per Subcarrier values that are below the threshold determined by the Required MER for the Modulation Order and the ThrshldOffset. The CM reports that value as NumSubcarriersBelowThrshld. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsOfdmMerMarEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1 | not-accessible | The conceptual row of the docsPnmCmDsOfdmMerMarTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| U32 docsPnmCmDsOfdmMerMarProfileId | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.1 | Unsigned32 | read-write | This attribute represents the Downstream Profile ID of the candidate Profile. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmMerMarMeasStatus' is 'busy' will return 'inconsistentValue'. |
| U32 docsPnmCmDsOfdmMerMarThrshldOffset | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.2 | Unsigned32 | read-write | This attribute represents the number of dB below the RequiredDsOfdmQamMer value which is likely to cause uncorrectable errors. Measurements of Subcarrier MER that are this number of dB or more below the RequiredDsOfdmQamMer for the Subcarrier for the profile being tested, will cause the CM to increment the count of the 'docsPnmCmDsOfdmMerMarNumSubCarBelowThrshld' attribute. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmMerMarMeasStatus' is 'busy' will return 'inconsistentValue'. |
| T/F docsPnmCmDsOfdmMerMarMeasEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.3 | TruthValue | read-write | This attribute causes the CM to begin the measurement. When the measurement is complete the MeasEnable attribute is set internally to 'false' by the CM. Setting this object to a value of 'false' instructs the CM to stop the measurement. This object returns 'true' if the CM is actively taking a measurement. Otherwise it returns 'false'. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmDsOfdmMerMarMeasStatus' is a value of 'busy' for this row OR for any row in the table. That is, ONLY ONE ROW IN THE TABLE MAY BE ALLOWED TO BE 'true' AT THE SAME TIME. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsOfdmMerMarMeasStatus' to 'busy'. |
| U32 docsPnmCmDsOfdmMerMarNumSymPerSubCarToAvg | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.4 | Unsigned32 | read-write | This attribute represents the number of symbols that will be used in the calculation of the average MER per subcarrier. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmMerMarMeasStatus' is 'busy' will return 'inconsistentValue'. |
| U32 docsPnmCmDsOfdmMerMarReqAvgMer | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.5 | Unsigned32 | read-write | This attribute represents the minimum required average MER. The CM subtracts this value from the MeasuredAvgMer to obtain the AverageMerMargin. If this value is not provided by the PNM server (i.e., it is the default value of zero), the CM computes the value as the average of the required MER for all of the subcarriers, based on the values in the RequiredDsOfdmQamMer table, for the Modulation order used for each of the subcarriers for the profile being analyzed. |
| U32 docsPnmCmDsOfdmMerMarNumSubCarBelowThrshld | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.6 | Unsigned32 | read-only | This object represents the number of subcarriers which were counted due to satisfying the criteria defined for the 'docsPnmCmDsOfdmMerMarThrshldOffset' object. |
| U32 docsPnmCmDsOfdmMerMarMeasuredAvgMer | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.7 | Unsigned32 | read-only | This attribute is the average of all MER dB values measured over all of the subcarriers. That is, the average is taken of all the dB values. |
| U32 docsPnmCmDsOfdmMerMarAvgMerMargin | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.8 | Unsigned32 | read-only | This attribute represents the difference between the 'docsPnmCmDsOfdmMerMarMeasuredAvgMer' and the 'docsPnmCmDsOfdmMerMarReqAvgMer'. |
| MEA docsPnmCmDsOfdmMerMarMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.6.1.9 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. The PNM server will query this value to determine when the data is ready for evaluation. |
| docsPnmCmDsOfdmFecTable | 1.3.6.1.4.1.4491.2.1.27.1.2.7 | not-accessible | The purpose of the table is to provide a series of codword error rate measurements on a per profle basis over a set period of time. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsOfdmFecEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.7.1 | not-accessible | The conceptual row of the docsPnmCmDsOfdmFecTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| INT docsPnmCmDsOfdmFecSumType | 1.3.6.1.4.1.4491.2.1.27.1.2.7.1.1 | INTEGER | read-write | This attribute is the type of summary test to be performed. If set to 'interval10min(2)', when enabled the CM must perform a test of 10 minutes in duration recording codeword data every second for a total of 600 measurements. If set to 'interval24hr(3)', when enabled the CM must perform a test of 24hours in duration recording codeword data every 60 seconds for a total of 1440 measurements. |
| T/F docsPnmCmDsOfdmFecFileEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.7.1.2 | TruthValue | read-write | When this attribute is set to 'true' the CM must begin the SummaryType codeword error summary test. While the test is in progress, the CM must return a MeasStatus value of 'busy'. When the measurement is complete the CM must set the MeasEnable attribute to 'false'. If this attribute is set to 'false' during a test, the CM must stop the test. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - A default value for 'docsPnmCmDsOfdmFecFileName' is defined; thus, this object may be set to 'true' without explicitly setting this value. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsOfdmFecMeasStatus' to 'busy'. The CM must return the value of 'true' if it is actively taking a measurement; otherwise it must return 'false'. |
| MEA docsPnmCmDsOfdmFecMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.7.1.3 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsOfdmFecFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.7.1.4 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmFecMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMFecSum__ For example: PNMFecSum_0010181A2D11_1403405123 The data file is comprised of a header plus the Chan Estimate Coefficient 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 '504E4D08' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes TestStartTimestamp 4 bytes TestEndTimestamp 4 bytes SummaryType 1 byte Number of Profiles 1 byte Profile Id 1 byte Length (in bytes) of the per Profile FEC Data 2 bytes Total Codewords (600 | 1440) * 4 bytes Corrected Codewords (600 | 1440) * 4 bytes Uncorrectable Codewords (600 | 1440) * 4 bytes |
| docsPnmCmDsOfdmReqMERObjects | 1.3.6.1.4.1.4491.2.1.27.1.2.8 | |||
| U32 docsPnmCmDsOfdmReqMerQam16 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.1 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam64 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.2 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam128 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.3 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam256 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.4 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam512 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.5 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam1024 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.6 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam2048 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.7 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam4096 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.8 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam8192 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.9 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| U32 docsPnmCmDsOfdmReqMerQam16384 | 1.3.6.1.4.1.4491.2.1.27.1.2.8.10 | Unsigned32 | read-write | This attribute represents the minimum required MER value for this Modulation Order. It is used in determining the SNR Margin for the Candidate Downstream Profile. |
| docsPnmCmDsHistTable | 1.3.6.1.4.1.4491.2.1.27.1.2.9 | not-accessible | The purpose of the downstream histogram is to provide a measurement of nonlinear effects in the channel such as amplifier compression and laser clipping. For example, laser clipping causes one tail of the histogram to be truncated and replaced with a spike. The CM captures the histogram of time domain samples at the wideband front end of the receiver (full downstream band). The histogram is two-sided; that is, it encompasses values from far-negative to far-positive values of the samples. The histogram will have a minimum of 255 or 256 equally spaced bins. These bins typically correspond to the 8 MSBs of the wideband analog-to-digital converter (ADC) for the case of 255 or 256 bins. The histogram dwell count, a 32-bit unsigned integer, is the number of samples observed while counting hits for a given bin, and may have the same value for all bins. The histogram hit count, a 32-bit unsigned integer, is the number of samples falling in a given bin. The CM reports the dwell count per bin and the hit count per bin. When enabled, the CM computes a histogram with a dwell of at least 10 million samples at each bin in 30 seconds or less. The CM continues accumulating histogram samples until it is restarted, disabled or times out. If the highest dwell count approaches its 32-bit overflow value, the CM stops counting and sets the docsPnmCmDsHistMeasStatus attribute to 'sampleReady'. The CM reports the capture time of the histogram measurement in the Header Elements of the file for TFTP download using the 32-bit Universal Time Code. This table will have a row for each docsCableMaclayer type ifIndex for the modem. | |
| docsPnmCmDsHistEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.9.1 | not-accessible | The conceptual row of the docsPnmCmDsHistTable. An instance is dynamically created and exists for an associated ifIndex of the RF MAC interface upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmDsHistEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.9.1.1 | TruthValue | read-write | Setting this object to a value of 'true' instructs the CM to begin collection of histogram data and when enabled, the CM continues producing new data at its own rate. Setting this object to a value of 'false' instructs the CM to stop the collection of histogram data. This object returns 'true' if the CM is actively collecting histogram data. Otherwise it returns 'false'. A restart may be accomplished by setting this attribute to 'false' and then back to 'true'. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsHistMeasStatus' to 'busy'. |
| U32 docsPnmCmDsHistTimeOut | 1.3.6.1.4.1.4491.2.1.27.1.2.9.1.2 | Unsigned32 | read-write | This object sets a seconds time-out timer for capturing histogram data. This attribute is used to automatically clear the Enable attribute when the timeout expires. If the value of this attribute is zero, the CM will collect data until the value is changed, stopped, or until any dwell counter approaches its 32 bit rollover value. If the Timeout attribute is re-written while Enable is 'true', the CM will restart the timeout timer with the new Timeout value and continue collecting data. When the timeout expires the 'docsPnmCmDsHistEnable' object will be set to 'false' and the capture will stop. When this happens, the data collected up to this point will be saved in the the file defined by the 'docsPnmCmDsHistFileName', and the value of 'docsPnmCmDsHistMeasStatus' will be set to 'sampleReady'. Setting this value does not start a capture. Captures can only be started by setting the 'docsPnmCmDsHistEnable' object. If this object is written while the 'docsPnmCmDsHistEnable' object is 'true', the timer is restarted. If this object is set to a value of 'zero', there is no timeout and the collection of data will continue indefinitely. This object returns the value that it was last set with. |
| MEA docsPnmCmDsHistMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.9.1.3 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsHistFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.9.1.4 | SnmpAdminString | read-write | This object is the name of the file at the CM 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 'docsPnmCmDsHistMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMHist__ For example: PNMHist_0010181A2D11_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 '504E4D05' (without the quotes) 4 bytes Capture Time 4 bytes CM MAC Address 6 bytes Symmetry 1 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 |
| docsPnmCmUsPreEqTable | 1.3.6.1.4.1.4491.2.1.27.1.2.10 | not-accessible | This object provides access to CM upstream pre-equalizer coefficients. The CM pre-equalizer coefficients and the CMTS upstream adaptive equalizer coefficient update values, when taken together describe the linear response of the upstream cable plant for a given CM. During the ranging process, the CMTS computes adaptive equalizer coefficients based on upstream probes; these coefficients describe the residual channel remaining after any pre-equalization. The CMTS sends these equalizer coefficients to the CM as a set of Transmit Equalization Adjust coefficients as part of the ranging process. The CM Pre-Equalizer coefficients are expressed as 16 bit two's complement numbers using s2.13 format. The power averaged over all coefficients approximately 1, in order to avoid excessive clipping and quantization noise. The Pre-Equalizer coefficient update values sent to the CM by the CMTS in the RNG-RSP are expressed as 16 bit two's complement numbers using s1.14 format. The CM provides the capability to report its upstream pre-equalizer coefficients (full set or summary) upon request. The CM also provides the capability to also report the most recent set of Transmit Equalization Adjust coefficients which were applied to produce the reported set of upstream pre-equalizer coefficients. The CM indicates the status of the most recent Transmit Equalization Adjust coefficients sent to it by the CMTS. If the CM was able to apply the coefficients it sets the status to success(2). If the CM was unable to fully apply the adjustments (for example, due to excess tilt or ripple in the channel), and it was necessary for the CM to clip the coefficients, it sets the status to clipped(3). If the CM modified the coefficients other than by simply clipping them, it sets the status to other(1). If for some reason the CM is unable to apply the adjustments at all, it sets the status to rejected(4). The 'docsPnmCmUsPreEqFileEnable' object is used to create files. Other objects are updated as read. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmUsPreEqEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1 | not-accessible | The conceptual row of the docsPnmCmUsPreEqTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmUsPreEqFileEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.1 | TruthValue | read-write | This object causes the files defined by the 'docsPnmCmUsPreEqFileName' and the 'docsPnmCmUsPreEqlastUpdateFileName' objects to be created. The files, once created, are available via the 'docsPnmBulkFileTable' mechanism. The 'docsPnmCmUsPreEqMeasStatus' object can be checked to determine the outcome of setting this object. Interaction with other table rows: - This object is subject to the rules specified by the 'docsPnmCmCtlStatus' object. Therefore this object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmCtlStatus' is any value other than 'ready'. - Setting this value to 'true' will change the value of the 'docsPnmCmUsPreEqMeasStatus' to 'busy' while the file generation is in progress. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - Default values for 'docsPnmCmUsPreEqFileName' and 'docsPnmCmUsPreEqLastUpdateFileName' are defined; thus, this object may be set to 'true' without explicitly setting these values. - This object returns 'true' if the CM is actively generating the files. Otherwise it returns 'false'. |
| THO docsPnmCmUsPreEqAmpRipplePkToPk | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.2 | ThousandthdB | read-only | This attribute represents the value of the peak to peak ripple in the magnitude of the equalizer coefficients. This attribute represents the ripple across the entire OFDMA channel. This attribute is not stored in the data files. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| THO docsPnmCmUsPreEqAmpRippleRms | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.3 | ThousandthdB | read-only | This attribute represents the value of the RMS ripple in the magnitude of the equalizer coefficients. This attribute represents the ripple across the entire OFDMA channel. This attribute is not stored in the data files. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| I32 docsPnmCmUsPreEqAmpSlope | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.4 | Integer32 | read-only | This attribute represents the slope in 0.001 dB per MHz in the magnitude of the equalizer coefficients. This attribute represents the slope across the entire OFDMA channel. This attribute is not stored in the data files. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| U32 docsPnmCmUsPreEqGrpDelayRipplePkToPk | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.5 | Unsigned32 | read-only | This attribute represents the peak-to-peak Group Delay Ripple expressed in units of 0.001 nsec. This attribute represents the group delay variation across the entire OFDMA channel. This attribute is not stored in the data files. The slope component calculated for the GroupDelaySlope is subtracted from the frequency domain data and the peak-to-peak ripple is calculated from the resultant data. |
| U32 docsPnmCmUsPreEqGrpDelayRippleRms | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.6 | Unsigned32 | read-only | This attribute represents the RMS value of the Group Delay Ripple expressed in units of 0.001 nsec. This attribute represents the group delay variation across the entire OFDMA channel. The slope component calculated for the GroupDelaySlope is subtracted from the frequency domain data and the RMS ripple is calculated from the resultant dataThis attribute is not stored in the data files. |
| INT docsPnmCmUsPreEqPreEqCoAdjStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.7 | INTEGER | read-only | This object represents whether the last set of Pre-Equalization coefficient adjustments that were fully applied or were only partially applied due to excessive ripple or tilt in the Pre-Equalization coefficient values. |
| MEA docsPnmCmUsPreEqMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.8 | MeasStatusType | read-only | 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. Summary Metrics: These values are not calculated unless a specific query of any of the summary metrics has been performed. |
| STR docsPnmCmUsPreEqLastUpdateFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.9 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. The data represents the values sent to the CM by the CMTS in the last RNG-RSP that contained Pre-Equalization updates and is stored as 16 bit integers for the I and Q data. This object cannot be changed while a file generation is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmUsPreEqMeasStatus' is set to a value of 'busy'. 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMUsPreEqLastUpdate__ For example: PNMUsPreEqLastUpdate_0010181A2D11_1403405123 The data file is comprised of a header plus the Pre-EQ Data. The header is composed 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 '504E4D07' (without the quotes) 4 bytes Capture Time 4 bytes Upstream Channel Id 1 byte CM MAC Address 6 bytes CMTS MAC Address 6 bytes Subcarrier zero frequency in Hz 4 bytes FirstActiveSubcarrierIndex 2 bytes Subcarrier spacing in kHz 1 byte Length in bytes of Pre-EQ Data that follows 4 bytes Pre-EQ coefficient Data ComplexData |
| STR docsPnmCmUsPreEqFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.10 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. The data represents the current value of the Pre-Equalization values for all of the active subcarriers and is stored as 16 bit integers for the I and Q data. This object cannot be changed while a file generation is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmUsPreEqMeasStatus' is set to a value of 'busy'. 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMUsPreEq__ For example: PNMUsPreEq_0010181A2D11_1403405123 The data file is comprised of a header plus the Pre-EQ 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 '504E4D06' (without the quotes) 4 bytes Collection Time 4 bytes Upstream Channel Id 1 byte CM MAC Address 6 bytes CMTS MAC Address 6 bytes Subcarrier zero frequency in Hz 4 bytes FirstActiveSubcarrierIndex 2 bytes Subcarrier spacing in Hz 1 bytes Length in bytes of Pre-EQ Data that follows 4 bytes Pre-EQ Coefficient Update Data ComplexData |
| THO docsPnmCmUsPreEqAmpMean | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.11 | ThousandthdB | read-only | This attribute represents the mean in 0.001 dB, of the magnitude of the equalizer coefficients. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| I32 docsPnmCmUsPreEqGrpDelaySlope | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.12 | Integer32 | read-only | This attribute represents the slope in 0.001 nsec per MHz in the group delay of the equalizer coefficients. This attribute represents the slope across the entire OFDM channel. Note: An algorithm for calculating the ripple and slope for these measurements is provided in section D.3 of the DOCSIS 3.1 CM OSSI Specification. |
| I32 docsPnmCmUsPreEqGrpDelayMean | 1.3.6.1.4.1.4491.2.1.27.1.2.10.1.13 | Integer32 | read-only | This attribute represents the mean of the group delay in units of 0.001 nsec. |
| docsPnmCmDsOfdmModProfTable | 1.3.6.1.4.1.4491.2.1.27.1.2.11 | not-accessible | The purpose of the table is to provide the per subcarrier bit load of the modulation profiles. This table will have a row for each ifIndex for the modem. | |
| docsPnmCmDsOfdmModProfEntry | 1.3.6.1.4.1.4491.2.1.27.1.2.11.1 | not-accessible | The conceptual row of the docsPnmCmDsOfdmModProfTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmDsOfdmModProfFileEnable | 1.3.6.1.4.1.4491.2.1.27.1.2.11.1.1 | TruthValue | read-write | When this attribute is set to 'true' the CM must begin the Modulation Profile Summary report. While the report is in progress, the CM must return a MeasStatus value of 'busy'. When the measurement is complete the CM must set the FileEnable attribute to 'false'. If this attribute is set to 'false' during a report, the CM must stop the report. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - A default value for 'docsPnmCmDsOfdmModProfFileName' is defined; thus, this object may be set to 'true' without explicitly setting this value. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsOfdmModProfMeasStatus' to 'busy'. The CM must return the value of 'true' if it is actively compiling the report; otherwise it must return 'false'. |
| MEA docsPnmCmDsOfdmModProfMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.2.11.1.2 | MeasStatusType | read-only | 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. |
| STR docsPnmCmDsOfdmModProfFileName | 1.3.6.1.4.1.4491.2.1.27.1.2.11.1.3 | SnmpAdminString | read-write | This attribute is the name of the file at the CM which is to be transferred to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmDsOfdmModProfMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. If a default filename value is used, it is generated as the test name plus the CM MAC Address 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: PNMModProfile__ For example: PNMModProfile_0010181A2D11_1403405123 The data file is comprised of a header plus the Modulation Profile 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 '504E4D0A' (without the quotes) 4 bytes Capture Time 4 bytes DS Channel Id 1 byte CM MAC Address 6 bytes NumberOfProfiles 1 bytes Subcarrier zero frequency in Hz 4 bytes First Active Subcarrier Index 2 bytes Subcarrier spacing in kHz 1 byte Length in bytes of the Modulation Profile Data 4 bytes Modulation Profile Data N bytes |
| docsPnmCmtsObjects | 1.3.6.1.4.1.4491.2.1.27.1.3 | |||
| docsPnmCmtsDsOfdmSymCapTable | 1.3.6.1.4.1.4491.2.1.27.1.3.1 | not-accessible | The DsOfdmSymbolCapture object capture provides partial functionality of a network analyzer to analyze the response of the cable plant. At the CMTS, the transmitted frequency-domain modulation values of one full OFDM symbol before the IFFT are captured and made available for analysis. The frequency domain samples are expressed as 16-bit two's complement numbers using s3.12 format. This includes the I and Q modulation values of all subcarriers in the active bandwidth of the OFDM channel, including data subcarriers, pilots, PLC preamble symbols and excluded subcarriers. This capture will result in a number of samples that depends on the OFDM channel width. As examples, for 50 kHz subcarrier spacing in a 192 MHz channel with 204.8 MHz sampling rate, 3800 samples will be captured; for 25 kHz subcarrier spacing in a 192 MHz channel with 204.8 MHz sampling rate, 7600 samples will be captured; for 50 kHz subcarrier spacing in a 24 MHz channel with a reduced sampling rate of 25.6 MHz, 475 samples would be captured. Note: Excluded subcarriers in the guard band on either side of the encompassed spectrum are not captured. Capturing the input and output of the cable plant is equivalent to a wideband sweep of the channel, which permits full characterization of the linear and nonlinear response of the downstream plant. The MAC provides signaling via the PLC Trigger Message to ensure that the same symbol is captured at the CMTS and CM. The Downstream Symbol Capture is controlled by setting the 'docsPnmCmtsDsOfdmSymTrigEnable' object. The status of the capture is obtained by reading the value of the 'docsPnmCmDsOfdmSymMeasStatus' object. | |
| docsPnmCmtsDsOfdmSymCapEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1 | not-accessible | The conceptual row of the 'docsPnmCmtsDsOfdmSymCapTable'. An instance is dynamically created and exists for an associated ifIndex of the physical downstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsDsOfdmSymTrigEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.1 | TruthValue | read-write | Setting this object to a value of 'true' instructs the CMTS to insert a Trigger Message Block in the PLC with a Group ID matching the CM's TriggerGroupID. The CMTS captures the Symbol that it designated in the Trigger Message Block. The TriggerEnable is a one-shot enable and the attribute is disabled when the CMTS has completed the acquisition of the designated Symbol. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsDsOfdmSymTrigMeasStatus' is a value of 'busy' for this row OR for any row in the table. That is, ONLY ONE ROW IN THE TABLE MAY BE ALLOWED TO BE 'true' AT THE SAME TIME. - Default values for 'docsPnmCmtsDsOfdmSymCaptFileName', and 'docsPnmCmtsDsOfdmSymTrigGroupId' objects are defined; thus, this object may be set to 'true' without explicitly setting these values. Care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsDsOfdmSymTrigMeasStatus' to 'busy'. |
| U32 docsPnmCmtsDsOfdmSymTrigGroupId | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.2 | Unsigned32 | read-write | This attribute is used by the CMTS to be inserted in the PLC Trigger Message Block to identify a CM or a group of CMs expected to perform Symbol Capture measurements for the designated symbol. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsDsOfdmSymMeasStatus' is 'busy' will return 'inconsistentValue'. |
| U32 docsPnmCmtsDsOfdmSymFirstActSubCarIdx | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.3 | Unsigned32 | read-only | This object is used to denote the subcarrier index of the lowest frequency of the Encompassed Spectrum for the OFDM channel. |
| U32 docsPnmCmtsDsOfdmSymLastActSubCarIdx | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.4 | Unsigned32 | read-only | This object is used to denote the subcarrier index of the highest frequency of the Encompassed Spectrum for the OFDM channel. |
| T/F docsPnmCmtsDsOfdmSymRxWindowing | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.5 | TruthValue | read-only | This attribute is a flag indicating if vendor proprietary windowing was enabled during the capture. |
| U32 docsPnmCmtsDsOfdmSymTransactionId | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.6 | Unsigned32 | read-only | This attribute is the Transaction ID sent by the CMTS in the Trigger Message Block. Prior to completion of a measurement this attribute has no meaning. |
| U32 docsPnmCmtsDsOfdmSymSampleRate | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.7 | Unsigned32 | read-only | This attribute is the FFT sample rate in use by the CM for the channel; typically the sample rate for the downstream channel will be 204.8MHz. |
| U32 docsPnmCmtsDsOfdmSymFftLength | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.8 | Unsigned32 | read-only | This attribute is the FFT length in use by the CM for the channel; typically this value is 4096 or 8192 for the Downstream Channel. |
| MEA docsPnmCmtsDsOfdmSymMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.9 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. The PNM server will query this value to determine when the measurement is complete. |
| STR docsPnmCmtsDsOfdmSymCaptFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.1.1.10 | SnmpAdminString | read-write | This attribute is the name of the file with the captured symbol data at the CMTS that is to be downloaded using TFTP by the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsDsOfdmSymMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapSymCap__ For example: PNMCcapSymCap_ccap1.boulder.cablelabs.com_1403405123 The data file is comprised of a header plus the Symbol Capture 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 '504E4D65' (without the quotes) 4 bytes Capture Time 4 bytes ifIndex 4 bytes Unique CCAP ID 256 bytes Subcarrier zero Frequency in Hz 4 bytes Subcarrier Spacing in kHz 1 byte FirstActiveSubcarrierIndex 2 bytes LastActiveSubcarrierIndex 2 bytes TriggerGroupId 2 bytes Transaction ID 1 byte Length in bytes of Capture Data that follows 4 bytes Symbol Capture Data ComplexData |
| docsPnmCmtsDsOfdmNoisePwrRatioTable | 1.3.6.1.4.1.4491.2.1.27.1.3.2 | not-accessible | The purpose of downstream NPR measurement is to view the noise, interference and intermodulation products underlying a portion of the OFDM signal. As an out-of-service test, the CMTS can define an exclusion band of zero-valued subcarriers which forms a spectral notch in the downstream OFDM signal for all profiles of a given downstream channel. The CM provides its normal spectral capture measurements, or symbol capture, which permit analysis of the notch depth. A possible use case is to observe LTE interference occurring within an OFDM band; another is to observe intermodulation products resulting from signal-level alignment issues. Since the introduction and removal of a notch affects all profiles, causing possible link downtime, this feature is intended for infrequent maintenance. | |
| docsPnmCmtsDsOfdmNoisePwrRatioEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.2.1 | not-accessible | The conceptual row of the 'docsPnmCmtsDsOfdmNoisePwrRatioTable'. An instance is dynamically created and exists for an associated ifIndex of the physical downstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| U32 docsPnmCmtsDsOfdmNprStartSubcar | 1.3.6.1.4.1.4491.2.1.27.1.3.2.1.1 | Unsigned32 | read-write | This attribute is the Subcarrier index corresponding to the frequency at the start of the spectral notch. This value can only be changed while the value of 'docsPnmCmtsDsOfdmNprEnable' is 'false'. An attempt to set this value while the value of 'docsPnmCmtsDsOfdmNprEnable' is 'true' will return 'inconsistentValue'. |
| U32 docsPnmCmtsDsOfdmNprStopSubcar | 1.3.6.1.4.1.4491.2.1.27.1.3.2.1.2 | Unsigned32 | read-write | This object is the Subcarrier index corresponding to the frequency at the upper end of the spectral notch. This value can only be changed while the value of 'docsPnmCmtsDsOfdmNprEnable' is 'false'. An attempt to set this value while the value of 'docsPnmCmtsDsOfdmNprEnable' is 'true' will return 'inconsistentValue'. |
| T/F docsPnmCmtsDsOfdmNprEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.2.1.3 | TruthValue | read-write | This object is used to enable the CMTS to create the spectral notch. The CMTS MAY require the interface to have an ifAdminStatus of 'down' before allowing the Enable value to be successfully set to 'true' for this test. If the CMTS is unable to create the spectral notch, the attempt to set Enable to 'true' must be rejected by the CMTS. The Enable flag must be cleared internally by the CMTS when the operation is complete. Default values for 'docsPnmCmtsDsOfdmNprStartSubcar', 'docsPnmCmtsDsOfdmNprStopSubcar', and 'docsPnmCmtsDsOfdmNprDuration' are defined; thus, this object may be set to 'true' without explicitly setting these values. Care should be taken to insure these values are correct for the desired test case. |
| U32 docsPnmCmtsDsOfdmNprDuration | 1.3.6.1.4.1.4491.2.1.27.1.3.2.1.4 | Unsigned32 | read-write | This object indicates the length of time in seconds that the spectral notch is to be maintained. The CMTS MAY make the excluded subcarriers active after the expiration of the Duration attribute. There is no expectation that CMTS will re-activate the excluded subcarriers immediately after the expiration of the timer. It is recommended that the CMTS use the OCD message to create the spectral notch. This value can only be changed while value of 'docsPnmCmtsDsOfdmNprEnable' is 'false'. An attempt to set this value while the value of 'docsPnmCmtsDsOfdmNprEnable' is 'true' will return 'inconsistentValue'. |
| docsPnmCmtsUsOfdmaAQProbeTable | 1.3.6.1.4.1.4491.2.1.27.1.3.3 | not-accessible | The purpose of upstream capture is to measure plant response and view the underlying noise floor, by capturing at least one OFDMA symbol during a scheduled active or quiet probe. An active probe provides the partial functionality of a network analyzer, since the input is known and the output is captured. This permits full characterization of the linear and nonlinear response of the upstream cable plant. A quiet probe provides an opportunity to view the underlying noise and ingress while no traffic is being transmitted in the OFDMA band being measured. The PNM server selects an active CM to analyze by specifying its MAC address, or performs a quiet probe measurement. When enabled to perform the capture, the CMTS selects a specified transmitting CM, or quiet period when no CMs are transmitting, for the capture. The CMTS sets up the capture as described in MULPIv3.1, selecting either an active SID corresponding to the specified MAC address or the idle SID, and defining an active or quiet probe. The active probe symbol for this capture normally includes all non-excluded subcarriers across the upstream OFDMA channel, with pre-equalization on or off as specified in the MIB. The quiet probe symbol normally includes all subcarriers, that is, during the quiet probe time there are no transmissions in the given upstream OFDMA channel. For the quiet probe, the CMTS captures samples of at least one full OFDMA symbol including the guard interval. The CMTS begins the capture with the first symbol of the specified probe. The sample rate is the FFT sample rate (102.4 Msps). The CMTS reports the list of excluded subcarriers, the cyclic prefix length, and the transmit window rolloff period in order to fully define the transmitted waveform. The CMTS also reports the index of the starting sample used by the receiver for its FFT. For possible comparison with other events, the CMTS reports the timestamp corresponding to the beginning of the probe. In the case where the P-MAPs for the OFDMA upstream being analyzed are being sent in an OFDM downstream, the timestamp reported is the extended timestamp, while in a case with OFDMA upstream channels but no OFDM downstream channels, the reported timestamp is the D3.0 timestamp. For an active probe, the CMTS reports the contents of the Probe Information Element (P-IE) message describing that probe. | |
| docsPnmCmtsUsOfdmaAQProbeEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1 | not-accessible | The conceptual row of the 'docsPnmCmtsUsOfdmaAQProbeTable'. An instance is dynamically created and exists for an associated ifIndex of the physical upstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| MAC docsPnmCmtsUsOfdmaAQProbeCmMacAddr | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.1 | MacAddress | read-write | This attribute represents the MAC address of the CM transmitting the probe to be measured. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is set to a value of 'busy'. |
| T/F docsPnmCmtsUsOfdmaAQProbeUseIdleSid | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.2 | TruthValue | read-write | This attribute, when enabled, causes the CMTS to measure the channel during a quiet period when no CM is transmitting. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is set to a value of 'busy'. |
| T/F docsPnmCmtsUsOfdmaAQProbePreEqOn | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.3 | TruthValue | read-write | This attribute, when enabled, causes the CMTS to enable pre-equalization in the Probe Information Element for the CM transmitting the probe to be measured. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is set to a value of 'busy'. |
| T/F docsPnmCmtsUsOfdmaAQProbeEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.4 | TruthValue | read-write | This attribute causes the CMTS to begin the measurement of a probe for the selected CM or for a quiet period if the UseIdleSid attribute is enabled. The Enable attribute is cleared internally by the CMTS when the measurement has been completed. Setting this object to a value of 'false' instructs the CMTS to stop the measurement. In this case the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' will be set to 'inactive'. When read, this object returns 'true' if the CMTS is actively taking a measurement, otherwise it returns 'false'. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is a value of 'busy'. - Default values are provided for read-write objects in this table; thus, this object may be set to 'true' without explicitly setting these values. However, the default values may not be appropriate and care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmDsOfdmSymMeasStatus' to 'busy'. |
| U32 docsPnmCmtsUsOfdmaAQProbeTimeout | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.5 | Unsigned32 | read-write | This attribute provides a timeout for the measurement if the CMTS is unable to perform the measurement for some reason. A value of zero for the Timeout attribute means that the measurement continues to be active until the measurement is completed or until the Enable attribute is cleared. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsOfdmaAQProbeNumSymToCapt | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.6 | Unsigned32 | read-write | This object represents the number of symbols the CMTS is to capture for the modem whose probe is being measured or the number of symbol times to measure for the idle Sid. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsOfdmaAQProbeMaxCaptSymbols | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.7 | Unsigned32 | read-only | This object represents the number of symbols the CMTS can capture for one measurement. Typically for a 50kHz Subcarrier Spacing the CMTS can capture two symbols and for 25kHz, the CMTS can capture one symbol. In order to capture more than one symbol the CMTS would need to schedule multiple probe opportunities for the CM whose probe is being measured. |
| U32 docsPnmCmtsUsOfdmaAQProbeNumSamples | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.8 | Unsigned32 | read-only | This object represents the number of FFT samples used for the measurement. |
| OCT docsPnmCmtsUsOfdmaAQProbeTimeStamp | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.9 | OCTET STRING | read-only | This object represents the timestamp corresponding to the time when the measurement was performed. In the case in which the Primary Downstream is an OFDM channel this is the 64 bit timestamp. In the case in which the Primary Downstream is an SC-QAM channel this is the 32 bit timestamp. If the 32 bit timestamp is used, the 32 most significant bits of the timestamp are set to zero. |
| MEA docsPnmCmtsUsOfdmaAQProbeMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.10 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. When the Status = 'SampleReady', the CCAP has completed the measurement and the Enable attribute has been cleared. |
| STR docsPnmCmtsUsOfdmaAQProbeFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.3.1.11 | SnmpAdminString | read-write | This attribute is the name of the file, with the captured probe data, at the CMTS that is to be downloaded using TFTP to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsUsOfdmaAQProbeMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapAQProbe__ For example: PNMCcapAQProbe_cap1.boulder.cablelabs.com_1403405123 The data file is comprised of a header plus the Probe Capture 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 '504E4D66' (without the quotes) 4 bytes Capture Time 4 bytes ifIndex 4 bytes Unique CCAP ID 256 bytes Subcarrier zero frequency in Hz 4 bytes Subcarrier Spacing in kHz 1 byte Length in bytes of Excluded Subcarrier data 4 bytes Excluded subcarrier data ExclSubCarrierType Length in bytes of Probe Capture data 4 bytes Probe Capture data CompexData |
| docsPnmCmtsUsImpNoiseTable | 1.3.6.1.4.1.4491.2.1.27.1.3.4 | not-accessible | This table provides statistics of burst/impulse noise occurring in a selected narrow band. A bandpass filter is positioned in an unoccupied upstream band. A threshold is set, energy exceeding the threshold triggers the measurement of an event, and energy falling below the threshold ends the event. An optional feature allows the threshold to be set to zero, in which case the average power in the band will be measured. The measurement is time-stamped using the DOCSIS 3.0 field of the 64-bit extended timestamp (bits 9-40, where bit 0 is the LSB), which provides a resolution of 98 ns and a range of 7 minutes. The CMTS provides the capability to capture the following statistics in a selected band up to 5.12 MHz wide: Timestamp of event, Duration of event, Average power of event. The CMTS provides a time history buffer of up to 1024 events. In steady state operation, a ring buffer provides the measurements of the last 1024 events that occurred while the measurement was enabled. | |
| docsPnmCmtsUsImpNoiseEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1 | not-accessible | The conceptual row of the docsPnmCmtsUsImpNoiseTable. An instance is dynamically created and exists for an associated ifIndex of the physical upstream channel upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsUsImpNoiseEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.1 | TruthValue | read-write | This attribute causes the CCAP to begin the collection of the configured Impulse Noise events. If the FreeRunDuration is set to a value greater than zero, the StartTriggerLevel is ignored and measurement of the signal power at the RF port begins when the Enable is set to true. The Enable attribute is cleared internally if FreeRunDuration has expired. If the FreeRunDuration is equal to zero and the Enable attribute is set to true, clearing the Enable causes the CCAP to stop the capture and generate the file of impulse noise data. If the NumEventsCounted is zero when the Enable is cleared, no file will be created. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is a value of 'busy'. - Default values are provided for read-write objects in this table; thus, this object may be set to 'true' without explicitly setting these values. However, the default values may not be appropriate and care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsUsImpNoiseMeasStatus' to 'busy'. |
| U32 docsPnmCmtsUsImpNoiseFreeRunDuration | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.2 | Unsigned32 | read-write | This attribute provides length of time to perform the measurement when the Enable attribute is set to true. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsImpNoiseStTrigLvl | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.3 | Unsigned32 | read-write | If the FreeRunDuration is set to zero and the Enable attribute is set to true, an individual burst event starts when the burst noise exceeds the StartTriggerLevel. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsImpNoiseEndTrigLvl | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.4 | Unsigned32 | read-write | The measurement of an individual burst event ends when the burst noise falls below the EndTriggerLevel. It is worth noting that if the EndTriggerLevel is set to zero, the FreeRunDuration is set to zero and the Enable attribute is set to true, then at most a single Impulse Noise Event will be recorded when triggered by a burst event exceeding the StartTriggerLevel. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsImpNoiseCenterFrq | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.5 | Unsigned32 | read-write | This attribute defines the center frequency for the noise power measurement. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsImpNoiseMeasBw | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.6 | Unsigned32 | read-write | This attribute defines the bandwidth for the noise power measurement. The MeasurementBw is the -3 dB bandwidth; the occupied bandwidth is typically 1.25 times the measurement bandwidth. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsImpNoiseNumEvtsCnted | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.7 | Unsigned32 | read-only | This attribute is used to indicate how many impulse noise events have been recorded since the enable was set to true. This value will be 1024 in steady state, after the ring buffer has filled with measurements. If the StartTriggerLevel is set to zero then the NumEventsCounted will be set to 1 when the FreeRunDuration has expired and the Enable has been internally cleared. |
| OCT docsPnmCmtsUsImpNoiseLastEvtTimeStamp | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.8 | OCTET STRING | read-only | This attribute provides represents the timestamp corresponding to the start of the last recorded event. The measurement is time-stamped using the 64-bit extended timestamp. If the CMTS is not using the 64-bit Extended Timestamp, then the 8 bit value is constructed from the 32-bit DOCSIS 3.0 Timestamp as follows: Bits 63 through 41 = 0 Bits 40 through 9 = 32-bit DOCSIS 3.0 Timestamp Bits 8 through 0 = 0 |
| U32 docsPnmCmtsUsImpNoiseLastEvtDuration | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.9 | Unsigned32 | read-only | This attribute provides represents the time corresponding to the duration of the last recorded event. The EventDuration is expressed in ns. |
| I32 docsPnmCmtsUsImpNoiseLastEvtAvgPwr | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.10 | Integer32 | read-only | This attribute represents the average power measured during the last recorded event. The LastEventAveragePower is expressed in units of dBmV with 32-bit fixed point, fractional, two's complement notation encoded using the S5.26 format. |
| MEA docsPnmCmtsUsImpNoiseMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.11 | MeasStatusType | read-only | This attribute is used to determine the status of the command. When the Status is sampleReady, the CCAP has completed the measurement and the Enable attribute has been cleared. If the StartTriggerLevel is set to a non zero value and the Enable attribute is set to true, then collection of Impulse Noise events is in progress and the MeasStatus attribute will return a value of 'busy'. If the Enable attribute is cleared while collection of Impulse Noise events is active, the MeasStatus attribute will be set to 'sampleReady. |
| STR docsPnmCmtsUsImpNoiseFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.4.1.12 | SnmpAdminString | read-write | This attribute is the name of the file with the captured impulse noise data at the CMTS that is to be downloaded using TFTP to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsUsImpNoiseMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapImpNoise__ For example: PNMCcapImpNoise_ccap1.boulder.cablelabs.com_1403405123 The data file is created when the Enable is cleared by the PNM server. If the NumEventsCounted attribute is zero when the Enable is cleared, then no file will be created by the CMTS. 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 '504E4D67' (without the quotes) 4 bytes Capture Time 4 bytes ifIndex 4 bytes Unique CCAP ID 256 bytes Start trigger level 4 bytes End trigger level 4 bytes Number of events being reported 4 bytes Length (in bytes) of Impulse Event Data 4 bytes Impulse Noise Capture Data ImpulseNoiseEventType |
| docsPnmCmtsUsHistTable | 1.3.6.1.4.1.4491.2.1.27.1.3.5 | not-accessible | The Upstream Histogram provides a measurement of nonlinear effects in the channel such as amplifier compression and laser clipping. For example, laser clipping causes one tail of the histogram to be truncated and replaced with a spike. When the UpstreamHistogram Enable attribute is set to 'true', the CMTS will begin capturing the histogram of time domain samples at the wideband front end of the receiver (full upstream band). The histogram is two-sided; that is, it encompasses values from far-negative to far-positive values of the samples. The histogram will have a minimum of 255 or 256 equally spaced bins. These bins typically correspond to the 8 MSBs of the wideband analog-to-digital converter (ADC) for the case of 255 or 256 bins. The histogram dwell count, a 32-bit unsigned integer, is the number of samples observed while counting hits for a given bin, and may have the same value for all bins. The histogram hit count, a 32-bit unsigned integer, is the number of samples falling in a given bin. The CMTS will report the dwell count per bin and the hit count per bin. When enabled, the CMTS will compute a histogram with a dwell of at least 10 million samples at each bin in 30 seconds or less. The CMTS will continue accumulating histogram samples until it is restarted, disabled or times out. If the highest dwell count approaches its 32-bit overflow value, the CMTS will save the current set of histogram values and reset the histogram, so that in a steady-state condition a complete measurement is always available. | |
| docsPnmCmtsUsHistEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.5.1 | not-accessible | The conceptual row of the docsPnmCmtsUsHistTable. An instance is dynamically created and exists for an associated ifIndex of an upstream RF port upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsUsHistEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.5.1.1 | TruthValue | read-write | Setting this object to a value of 'true' instructs the CCAP to begin collection of histogram data and when enabled, the CCAP continues producing new data at its own rate. This value is only allowed to be set to 'true' if the value of 'docsPnmCmtsUsHistMeasStatus' is a value other than 'busy'. Setting this value to 'true' will change the value of the 'docsPnmCmtsUsHistMeasStatus' to 'busy'. Setting this object to a value of 'false' instructs the CCAP to stop the collection of histogram data and to generate the file. This object returns 'true' if the CCAP is actively collecting histogram data. Otherwise it returns 'false'. A restart may be accomplished by setting this attribute to 'false' and then back to 'true'. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsHistMeasStatus' is a value of 'busy' for this row OR for any row in the table. That is, ONLY ONE ROW IN THE TABLE MAY BE ALLOWED TO BE 'true' AT THE SAME TIME. - This object returns 'inconsistentValue' if set to 'true' while the CM is in DOCSIS Light Sleep (DLS) mode or the CM is in battery-backup mode. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsUsHistMeasStatus' to 'busy'. |
| U32 docsPnmCmtsUsHistTimeOut | 1.3.6.1.4.1.4491.2.1.27.1.3.5.1.2 | Unsigned32 | read-write | This attribute sets a seconds time-out timer for capturing histogram data. This attribute is used to automatically clear the Enable attribute when the timeout expires. If the value of this attribute is zero, the CCAP MUST collect data until the value is changed, stopped, or until any dwell counter approaches its 32 bit rollover value. If the Timeout attribute is re-written while Enable is 'true', the CCAP MUST restart the timeout timer with the new Timeout value and continue collecting data. When the timeout expires the 'docsPnmCmtsUsHistEnable' object will be set to 'false' and the capture will stop. When this happens, the data collected up to this point will be saved in the the file defined by the 'docsPnmCmtsUsHistFileName', and the value of 'docsPnmCmtsUsHistMeasStatus' will be set to 'sampleReady'. Setting this value does not start a capture. Captures can only be started by setting the 'docsPnmCmtsUsHistEnable' object. If this object is written while the 'docsPnmCmtsUsHistEnable' object is 'true', the timer is restarted. If this object is set to a value of 'zero', there is no timeout and the collection of data will continue indefinitely. This object returns the value that it was last set with. |
| MEA docsPnmCmtsUsHistMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.5.1.3 | MeasStatusType | read-only | 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. |
| STR docsPnmCmtsUsHistFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.5.1.4 | SnmpAdminString | read-write | This object is the name of the file at the CCAP 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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__ 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 Symmetry 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 |
| docsPnmCmtsUsOfdmaRxPwrTable | 1.3.6.1.4.1.4491.2.1.27.1.3.6 | not-accessible | The purpose of the upstream channel power metric is to provide an estimate of the received power in a specified OFDMA channel at the F connector input of the CMTS line card for a given user. The measurement is based on upstream probes, which are typically the same probes used for pre-equalization adjustment. The CMTS measures the total power of the probe subcarriers received from the CM. For channels without boosted pilots, the CCAP calculates the average power per subcarrier (Paverage) and then calculates the power normalized to 1.6 MHz as a)Paverage + 10 * log10(32) for 50 kHz subcarrier spacing, or as b)Paverage + 10 *log10(64) for 25 kHz subcarrier spacing. For channels with boosted pilots, the CCAP calculates the average power per subcarrier (Paverage) and then calculates the power normalized to 1.6 MHz as a)Paverage + 10 * log10(32) + 1 dB for 50 kHz subcarrier spacing, or as b)Paverage + 10 *log10(64) + 0.5 dB for 25 kHz subcarrier spacing. NOTE: The CMTS would also use that adjusted value for comparison with the Target Receive Power for the purposes of transmit power adjustments in the RNG-RSP. | |
| docsPnmCmtsUsOfdmaRxPwrEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1 | not-accessible | The conceptual row of the docsPnmCmtsUsOfdmaRxPwrTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsUsOfdmaRxPwrEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.1 | TruthValue | read-write | This attribute causes the CMTS to begin a measurement of the received upstream channel power for the CM whose MAC address was specified in the CmMac attribute. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsOfdmaRxPwrMeasStatus' is a value of 'busy'. - Default values are provided for read-write objects in this table; thus, this object may be set to 'true' without explicitly setting these values. However, the default values may not be appropriate and care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsUsOfdmaRxPwrMeasStatus' to 'busy'. |
| MAC docsPnmCmtsUsOfdmaRxPwrCmMac | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.2 | MacAddress | not-accessible | This attribute represents the MAC address of the CM whose Received upstream channel power is being measured. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxPwrMeasStatus' is set to a value of 'busy'. |
| T/F docsPnmCmtsUsOfdmaRxPwrPreEq | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.3 | TruthValue | read-write | This attribute is used by the CMTS to enable or disable pre-equalization of the probe. The pre-equalization is controlled by a bit in the Probe Information Element sent in a MAP to the CM. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxPwrMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsOfdmaRxPwrNumAvgs | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.4 | Unsigned32 | read-write | This attribute controls the time average over the number of probes the CCAP will use to calculate the docsPnmCmtsUsOfdmaRxPwrOnePtSix. The average is simply the sum of the docsPnmCmtsUsOfdmaRxPwrOnePtSix values divided by the NumAverages. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxPwrMeasStatus' is set to a value of 'busy'. |
| TEN docsPnmCmtsUsOfdmaRxPwrOnePtSixPsd | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.5 | TenthdB | read-only | This attribute represents the average power of the probe measured by the CCAP, reported as the Power Spectral Density in an equivalent 1.6 MHz spectrum, for the CM whose MAC address was specified in the CmMac attribute. If the NumberOfAverages attribute was greater than one, then this attribute represents the accumulated average 1.6 MHz PSD. |
| MEA docsPnmCmtsUsOfdmaRxPwrMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.6.1.6 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. When the Status = SampleReady, the CCAP is ready for the Upstream Power data to be read. |
| docsPnmCmtsUsOfdmaRxMerTable | 1.3.6.1.4.1.4491.2.1.27.1.3.7 | not-accessible | This item provides measurements of the upstream receive modulation error ratio (RxMER) for each subcarrier. The CMTS measures the RxMER using an upstream probe, which is not subject to symbol errors as data subcarriers would be. The probes used for RxMER measurement are typically distinct from the probes used for pre-equalization adjustment. For the purposes of this measurement, RxMER is defined as the ratio of the average power of the ideal QAM constellation to the average error-vector power. The error vector is the difference between the equalized received probe value and the known correct probe value. If some subcarriers (such as exclusion bands) cannot be measured by the CMTS, the CMTS indicates that condition in the measurement data for those subcarriers. | |
| docsPnmCmtsUsOfdmaRxMerEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1 | not-accessible | The conceptual row of the docsPnmCmtsUsOfdmaRxMerTable. An instance is dynamically created and exists for an associated ifIndex upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsUsOfdmaRxMerEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.1 | TruthValue | read-write | This attribute causes the CMTS to begin a measurement of the received MER per subcarrier for the CM whose MAC address was specified in the CmMac attribute. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsOfdmaRxMerMeasStatus' is a value of 'busy'. - Default values are provided for read-write objects in this table; thus, this object may be set to 'true' without explicitly setting these values. However, the default values may not be appropriate and care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsUsOfdmaRxMerMeasStatus' to 'busy'. |
| MAC docsPnmCmtsUsOfdmaRxMerCmMac | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.2 | MacAddress | read-write | This attribute represents the MAC address of the CM whose Rx MER is being measured. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxMerMeasStatus' is set to a value of 'busy'. |
| T/F docsPnmCmtsUsOfdmaRxMerPreEq | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.3 | TruthValue | read-write | This attribute is used by the CMTS to enable or disable Pre Equalization of the probe. The Pre Equalization is controlled by a bit in the Probe Information Element sent in a MAP to the CM. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxMerMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsOfdmaRxMerNumAvgs | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.4 | Unsigned32 | read-write | This attribute controls the number of probes the CMTS will use to calculate the Rx MER per subcarrier. The average will be computed using the 'leaky integrator' method, where reported Rx MER per subcarrier value = alpha*accumulated values + (1-alpha)*current value. Alpha is one minus the reciprocal of the number of averages. For example, if N=25, then alpha = 0.96. A value of 1 indicates no averaging. Re-writing the number of averages will restart the averaging process. If there are no accumulated values, the accumulators are made equal to the first measured bin amplitudes. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsOfdmaRxMerMeasStatus' is set to a value of 'busy'. |
| MEA docsPnmCmtsUsOfdmaRxMerMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.5 | MeasStatusType | read-only | This attribute is used to determine the status of the measurement. When the MeasStatus = SampleReady, the CMTS is ready for the RxMER data to be read. |
| STR docsPnmCmtsUsOfdmaRxMerFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.7.1.6 | SnmpAdminString | read-write | This attribute is the name of the file with the RxMER data for a specified CM at the CMTS that is to be downloaded using TFTP to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsUsOfdmaRxMerMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapRxMER__ For example: PNMCcapRxMER_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 '504E4D69' (without the quotes) 4 bytes Capture Time 4 bytes ifIndex 4 bytes Unique CCAP ID 256 bytes CM MAC Address 6 bytes Number of Averages 2 bytes PreEq On or Off 1 byte Subcarrier zero center frequency 4 bytes FirstActiveSubcarrierIndex 2 bytes Subcarrier Spacing in kHz 1 byte Length in bytes of RxMERData 4 bytes Subcarrier RxMER data RxMerData |
| docsPnmCmtsUsSpecAnTable | 1.3.6.1.4.1.4491.2.1.27.1.3.8 | not-accessible | The upstream triggered spectrum analysis measurement provides a wideband spectrum analyzer function in the CMTS which can be triggered to examine desired upstream transmissions as well as underlying noise/interference during a quiet period. The CMTS provides wideband upstream spectrum analysis capability covering the full upstream spectrum of the cable plant. The CMTS can be made to use 100 kHz or better resolution (bin spacing) in the wideband upstream spectrum measurement. Depending on the particular CMTS implementation, variable upstream spectrum analysis span is possible. It is also possible that the CMTS will provide the collection of time-domain input samples as an alternative to the frequency-domain upstream spectrum results. In pre-DOCSIS-3.1 mode, the CMTS provides the ability to trigger the spectrum sample capture and perform spectrum analysis using the following modes: - Free running - Trigger on minislot count - Trigger on SID (service identifier) - Trigger during quiet period (idle SID) In DOCSIS 3.1 mode, the CMTS provides the ability to trigger spectrum sample capture and perform spectrum analysis using the following modes: - Free running - A specified timestamp value - Minislot Number - A specified MAC address defining a SID, triggering at the beginning of the first minislot granted to that SID - The idle SID, triggering at the beginning of the first minislot granted to that SID - A specified active or quiet probe symbol, triggering at the beginning of the probe symbol | |
| docsPnmCmtsUsSpecAnEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1 | not-accessible | The conceptual row of the docsPnmCmtsUsSpecAnTable. An instance is dynamically created and exists for an associated ifIndex of an OFDMA upstream RF Port upon which the test defined by this table can take place. The conceptual rows do not persist across device resets. | |
| T/F docsPnmCmtsUsSpecAnEnable | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.1 | TruthValue | read-write | This attribute causes the CMTS to begin the measurement of a probe for the selected CM or for a quiet period if the UseIdleSid attribute is enabled. The Enable attribute is cleared when the measurement has been completed. If the TriggerMode is FreeRunning then the Enable attribute will remain true until cleared by the PNM server. Interaction with other table rows: - This object returns 'inconsistentValue' if set to 'true' while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is a value of 'busy'. - Default values are provided for read-write objects in this table; thus, this object may be set to 'true' without explicitly setting these values. However, the default values may not be appropriate and care should be taken to insure these values are correct for the desired test case. - Setting this object to a value of 'true' will change the value of the 'docsPnmCmtsUsSpecAnMeasStatus' to 'busy'. |
| INT docsPnmCmtsUsSpecAnTrigMode | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.2 | INTEGER | read-write | This attribute is used to control the trigger mode for the Spectrum Analysis capture. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnMiniSlotCnt | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.3 | Unsigned32 | read-write | This attribute controls the numbe rof minislots the CMTS capturs during the Spectrum Analysis capture. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnSid | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.4 | Unsigned32 | read-write | This attribute is the SID corresponding to the CM which is granted a burst opportunity for the purpose of Spectrum Analysis. Typically the CMTS will schedule a unicast Station Maintenance opportunity for the CM with a grant size much longer than a normal Station Maintenance grant. This attribute is used when the TriggerMode is Sid. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnMiniSlotNum | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.5 | Unsigned32 | read-write | This attribute provides a mechanism by which the CMTS can begin the Spectrum Analysis at a subcarrier frequency corresponding to the MiniSlotNumber. This attribute is used when the TriggerMode is MiniSlotNumber. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| MAC docsPnmCmtsUsSpecAnCmMac | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.6 | MacAddress | read-write | This attribute is used by the CCAP to trigger on a grant for any SID assigned to the CM and to perform the Spectrum Analysis Capture when the burst corresponding to that grant is received by the CCAP. This attribute is used when the TriggerMode is CmMac and is an alternative to using Sid for the TriggerMode. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnCenterFreq | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.7 | Unsigned32 | read-write | This attribute determines the center frequency of the Spectrum Analysis capture if the trigger mode is FreeRunning. If the trigger mode is not FreeRunning, the CMTS determines the value for the CenterFrequency attribute. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnSpan | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.8 | Unsigned32 | read-write | This attribute determines the frequency span of the Spectrum Analysis capture if the trigger mode is FreeRunning. If the trigger mode is not FreeRunning, the CMTS determines the value for the Span attribute. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| U32 docsPnmCmtsUsSpecAnNumberOfBins | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.9 | Unsigned32 | read-write | This attribute determines the number of bins for the Spectrum Analysis capture if the trigger mode is FreeRunning. If the trigger mode is not FreeRunning, the CMTS determines the value for the NumberOfBins attribute. This object cannot be changed while a capture is in progress. It will return a value of 'inconsistentValue' if set while the value of 'docsPnmCmtsUsSpecAnMeasStatus' is set to a value of 'busy'. |
| MEA docsPnmCmtsUsSpecAnMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.10 | MeasStatusType | read-only | 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. |
| STR docsPnmCmtsUsSpecAnFileName | 1.3.6.1.4.1.4491.2.1.27.1.3.8.1.11 | SnmpAdminString | read-write | This attribute is the name of the file with the Spectrum Analysis data at the CMTS that is to be downloaded using TFTP to the PNM server. This value can only be changed while a test is not in progress. An attempt to set this value while the value of 'docsPnmCmtsUsSpecAnMeasStatus' 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 is generated, then that value will be returned in this object and will represent the filename that was used for the test. All subsequent tests should set this object to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapSpecAn__ For example: PNMCcapSpecAn_ccap1.boulder.cablelabs_1403405123 The data file is comprised of a header plus the Spectrum Analyzer 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 '504E4D6A' (without the quotes) 4 bytes Capture Time 4 bytes ifIndex 4 bytes Unique CCAP ID 256 bytes Center Frequency in Hz 4 bytes Frequency Span in Hz 4 bytes Number of Bins 2 bytes Length in bytes of Spectrum Analysis data 4 bytes Spectrum Analysis Bin Amplitude Data BinAmplitudeData |
| docsPnmCmtsOptObjects | 1.3.6.1.4.1.4491.2.1.27.1.3.9 | |||
| docsPnmCmtsOptReqTable | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1 | not-accessible | This table is used to initiate the OPT-REQ message for a given OFDM DS channel. The message and resulting tests and requirements are defined in the OPT-REQ TLV Encodings section of the MULPI Spec. To use the object the Operator or PMA Application uses the CM MAC address, the DsOfdmChannelCfgIndex, DsOfdmProfileCfgProfileId as the key to initiate a test. The specific tests that are defined in MULPI are accessed with the ProfileTest attribute. This attribute is a BITS data type and will allow one or more of the OPT tests to be configured to be performed by the CM. Due to the nature of the ProfileTest attribute one or more tests can be requested in a single message and thus different amounts of data need to be configured in order for the OPT Message to have the required TLVs. Some of these tests perform evaluations of thresholds or margins. To facilitate these evaluations by the CM, these values are defined in the test request or the OptMerThresholdCfg table. | |
| docsPnmCmtsOptReqEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1 | not-accessible | The conceptual row of the docsPnmCmtsOptReqTable. The conceptual rows do not persist across device resets. | |
| MAC docsPnmCmtsOptReqCmMacAddr | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.1 | MacAddress | not-accessible | This attribute is a key which represents the MAC address for the referenced CM. |
| U32 docsPnmCmtsOptReqDsOfdmChanCfgIndex | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.2 | Unsigned32 | not-accessible | This attribute is a key which represents an instance of the DsOfdmChannelCfg of the Downstream OFDM channel. |
| U32 docsPnmCmtsOptReqDsOfdmProfCfgId | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.3 | Unsigned32 | not-accessible | This attribute is a key that is the targeted profile being tested with OPT for the instance of DsOfdmChannelIndex. For Data Profile testing the ID of the profile that is being tested is used. The value 254 is used for RxMER statistics only. The value 255 is used to for NCP Profile Testing. |
| INT docsPnmCmtsOptReqOpCode | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.4 | INTEGER | read-create | This attribute controls the testing to be performed by the CM receiving the OPT-REQ message. |
| BIT docsPnmCmtsOptReqProfileTest | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.5 | Bits | read-create | This attribute defines which of the OPT tests are to be run by the CM. The tests are encoded as individual bits according to rxMerSubCarrierStats(0) RxMER Statistics per Subcarrier rxMerSubCarrierThreshComp(1) RxMER per Subcarrier Threshold Comparison for Candidate Profile snrMarginCandidateProfile(2) SNR Margin for Candidate Profile codewordStats(3) Codeword Statistics for Candidate Profile codewordThreshComp(4) Codeword Threshold Comparison for Candidate Profile ncpFieldStats(5) NCP Field statistics ncpCrcThreshComp(6) NCP CRC Threshold Comparison reserved(7) Reserved other(8) Placeholder for vendor extensions When a given bit is set then that test will be performed by the CM. Note that the tests rxMerSubCarrierThreshComp(1), snrMarginCandidateProfile(2) require entries in the OptMerThreshold object for these tests to be performed. This attribute corresponds to TLV 1 in the OPT Request message. |
| U32 docsPnmCmtsOptReqMaxDuration | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.6 | Unsigned32 | read-create | This attribute allows the tester to determine how long a test may run before returning results or aborting. This attribute corresponds to TLV 4 in the OPT Request message. |
| U32 docsPnmCmtsOptReqMaxCodewords | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.7 | Unsigned32 | read-create | This attribute defines the maximum number of codewords that the CM should examine before the test is complete. When either Nc or more codewords have been received, or Ne or more codeword errors have occurred, since the start of the test, the CM will send an OPT-RSP with a Complete status. This attribute is only present in the OPT-REQ message for Codeword tests: codewordStats(3), codewordThreshComp(4). This attribute corresponds to TLV 5.1 in the OPT Request message. |
| U32 docsPnmCmtsOptReqMaxUncorrectableCws | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.8 | Unsigned32 | read-create | This attribute defines the max num of uncorrectable codewords the CM should examine before the test is complete. When either Nc or more codewords have been received, or Ne or more codeword errors have occurred, since the start of the test, the CM will send an OPT-RSP with a Complete status. This attribute is only present in the OPT-REQ message for Codeword tests: codewordStats(3), codewordThreshComp(4). This attribute corresponds to TLV 5.2 in the OPT Request message. |
| T/F docsPnmCmtsOptReqCwTaggingEnabled | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.9 | TruthValue | read-create | This attribute indicates whether Codeword Tagging is in use for this test. This attribute is defined as a Boolean with the value 'false' meaning that codeword tagging is disabled and a value of 'true' means that codeword tagging is enabled. When codeword tagging is enabled, The CM will report codeword counts that include only codewords received on the profile in question for the duration of the test for which the 'T' bit is set to 1 in the NCP pointing to the codeword. The location of the 'T' bit is specified in [DOCSIS PHYv3.1]. If codeword tagging is disabled, the CM only reports codeword counts that include all codewords received on the profile in question for the duration of the test. This attribute is only present in the OPT-REQ message for Codeword tests: codewordStats(3), codewordThreshComp(4). This attribute corresponds to TLV 5.3 in the OPT Request message. |
| U32 docsPnmCmtsOptReqNcpFields | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.10 | Unsigned32 | read-create | This attribute defines the maximum number of NCP fields to be examined during the test. When the CM has examined this number or more NCP fields, it returns the OPT Request with a completed test status and the collected statistic information. This attribute is only present in the OPT-REQ message for NcpFieldTests: ncpFieldStats(5), ncpCrcThreshComp(6), This attribute corresponds to the TLV 6.1 in the OPT-REQ. |
| U32 docsPnmCmtsOptReqMaxNcpCrcFails | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.11 | Unsigned32 | read-create | This attribute defines the maximum number of NCP fields that are allowed to fail the NCP CRC checks to be examined during the test. When the CM has examined this number or more NCP fields, it returns the OPT Request with a completed test status and the collected statistic information. This attribute is only present in the OPT-REQ message for NcpFieldTests: ncpFieldStats(5), ncpCrcThreshComp(6), This attribute corresponds to the TLV 6.2 in the OPT-REQ. |
| ROW docsPnmCmtsOptReqStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.9.1.1.12 | RowStatus | read-create | The status of this instance. |
| docsPnmCmtsOptMerThreshCfgTable | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2 | not-accessible | This table is used to configure parameters for RxMER tests defined in docsPnmCmtsOptReqTable that require Pass/Fail criteria. It is necessary to define the parameters separately as the OPT-REQ message needs these values on a per modulation basis. This means that for each modulation order defined in a profile, the OPT-REQ includes a TLV entry for the required MER target value for each. | |
| docsPnmCmtsOptMerThreshCfgEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2.1 | not-accessible | The conceptual row of the docsPnmCmtsOptMerThreshCfgTable. The conceptual rows do not persist across device resets. | |
| DSO docsPnmCmtsOptMerThreshCfgModOrder | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2.1.1 | DsOfdmModulationType | not-accessible | This attribute is a key which represents the modulation types supported by the CCAP modulator. The value of zeroBitLoaded means that the subcarrier is BPSK modulated. This attribute corresponds to the TLV 2.1 in the OPT-REQ. |
| U32 docsPnmCmtsOptMerThreshCfgRxMerVsBitloadingTarget | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2.1.2 | Unsigned32 | read-create | This attribute is the required value for the profile RxMER (refer to OPT-RSP) in units of 0.25dB (0xFF is 63.75dB). This is the required RxMER value that the CM uses to calculate the SNR margin for the profile. The default values for this attribute are defined in the PHY3.1 Spec as CM Minimum CNR Performance in AWGN Channel. This attribute corresponds to the TLV 2.2 in the OPT-REQ. |
| U32 docsPnmCmtsOptMerThreshCfgRxMerMargin | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2.1.3 | Unsigned32 | read-create | The CM reports the number of subcarriers with a measured RxMER value that is at least this value below the target RxMER for the bitloading of the given subcarrier in the OPT-RSP message. This attribute corresponds to the TLV 2.3 in the OPT-REQ. |
| ROW docsPnmCmtsOptMerThreshCfgStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.9.2.1.4 | RowStatus | read-create | The status of this instance. |
| docsPnmCmtsOptProfChgCfgTable | 1.3.6.1.4.1.4491.2.1.27.1.3.9.3 | not-accessible | This table allows the Operator to force changes in the assigned profiles on a given registered CM. | |
| docsPnmCmtsOptProfChgCfgEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.9.3.1 | not-accessible | The conceptual row of the docsPnmCmtsOptProfChgCfgTable. The conceptual rows do not persist across device resets. | |
| NUM docsPnmCmtsOptProfChgCfgIfIndex | 1.3.6.1.4.1.4491.2.1.27.1.3.9.3.1.1 | InterfaceIndex | not-accessible | This attribute is the ifIndex of the DS OFDM channel that the CMTS will instruct the CM to adjust it's profiles for. |
| OCT docsPnmCmtsOptProfChgCfgDsProfList | 1.3.6.1.4.1.4491.2.1.27.1.3.9.3.1.2 | OCTET STRING | read-create | This attribute is a list of N 1-byte downstream OFDM profile IDs assigned for the OFDM channel. |
| ROW docsPnmCmtsOptProfChgCfgStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.9.3.1.3 | RowStatus | read-create | The status of this instance. |
| docsPnmCmtsOptRespTable | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4 | not-accessible | This table is used to read the OPT-RSP message for a given OFDM DS channel. One of the main issues for the modeling for OPT-RSP is that all OPT responses will not be alike. Some tests will only require 1 test or maybe a combination of one or more tests. As a result, this table needs to be able to gather the needed data for each CM and provide that to the PMA. MER data from the CM will be recorded as a series of hex values (0x00 to 0xFF) that will represent the MER values that the CM has measured. These values are gathered from the first active subcarrier to the last active subcarrier in the OFDM channel definition. The data from the CM will not contain pairs of values (subcarrierId and MER value) but just the subcarrier MER value. For the PMA to make sense of the data, the CCAP must provide the first active subcarrier to allow the PMA to know where it should start associating the values from the CM to the individual subcarriers defined in the channel. | |
| docsPnmCmtsOptRespEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1 | not-accessible | The conceptual row of the docsPnmCmtsOptRespTable. The conceptual rows do not persist across device resets. | |
| INT docsPnmCmtsOptRespStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.1 | INTEGER | read-only | This attribute allows the CCAP to return the status of a specific OPT test request. The value of this attribute is found in the status portion of the OPT-RSP header that is returned from the CM when the OPT-REQ is received by the CM. The values include: testing(1) - the CM has initiated the requested tests profileAlreadyUnderTest(2) - The CM received a request, but the profileId requested was already being used for an active test. unavailableResources(3) - The CM had an error with the request related to available resources to run the test collection. maxDurationExpired(4) - The CM has reported that for this test, the maximum duration value has expired. aborted(5) - The CM received an OPT-REQ request with an OpCode of abort and is aborting the tests requested. complete(6) - The CM has successfully completed the requested testing profileAlreadyAssigned(7) - The CM is reporting that the referenced profileId is already assigned and may not be used for the requested tests. |
| U32 docsPnmCmtsOptRespFirstActiveSubcarrierNum | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.2 | Unsigned32 | read-only | This attribute is the subcarrier index of the lowest subcarrier in the Occupied Bandwidth of the channel. |
| OCT docsPnmCmtsOptRespMerData | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.3 | OCTET STRING | read-only | This attribute contains the MER data for the active subcarriers in the instance of the DsOfdmChannel. The data represents Integer modulation error ratio measurements in 0.25 dB steps (0x00-0xFE represents 0-63.5 dB; 0xFF indicates no measurement available). These are encoded as a packed sequence of 8-bit values for N consecutive subcarriers (N less than or equal to 7680) from lowest active subcarrier to the highest active subcarrier, including all the subcarriers in between. This attribute is a variable length and is dependent on the channel width and the number of active subcarriers that are available. This attribute is a channel level measurement and is independent of the profile being tested. |
| OCT docsPnmCmtsOptRespMerPassFailData | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.4 | OCTET STRING | read-only | This attribute contains a Pass/Fail indication for each subcarrier's RxMER (1 bit for each subcarrier). A value of 1 indicates that the measured MER is greater than or equal to the target value in the OPT-REQ. A value of 0 indicates that the measured MER < target value in the OPT-REQ. These are encoded as a sequence of 1-bit values for N consecutive subcarriers (N less than or equal to 7680) from lowest active subcarrier. |
| U32 docsPnmCmtsOptRespNumSubcarriersBelowThresh | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.5 | Unsigned32 | read-only | This attribute indicates the number of subcarriers (less then or equal to 7680) whose RxMER is greater then or equal to the RxMER Margin below the RxMER target for the bitloading of the given subcarrier. |
| U32 docsPnmCmtsOptRespSnrMarginData | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.6 | Unsigned32 | read-only | This attribute indicates the SNR margin of the candidate data profile (signed integer), in units of 0.25dB, calculation is as defined in the PHY3.1 Spec. |
| C64 docsPnmCmtsOptRespCodewordCt | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.7 | Counter64 | read-only | This attribute is a count of the measured number of codewords that the CM has successfully received during the testing interval for the profile being tested. Unsigned integer count of codewords that were examined during testing. If Codeword Tagging is disabled, this count includes all codewords received on the profile in question for the duration of the test. If Codeword Tagging is enabled, this count includes only codewords received on the profile in question for the duration of the test for which the 'T' bit was set in the NCP pointing to the codeword. The location of the 'T' bit is specified in the PHYv3.1 Spec. |
| C64 docsPnmCmtsOptRespCorrectedCodewordCt | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.8 | Counter64 | read-only | This attribute is a count of the measured number of codewords that the CM has successfully received and was able to correct during the testing interval for the profile being tested. Unsigned integer count of codewords that were examined during testing. If Codeword Tagging is disabled, this count includes all codewords received on the profile in question for the duration of the test. If Codeword Tagging is enabled, this count includes only codewords received on the profile in question for the duration of the test for which the 'T' bit was set in the NCP pointing to the codeword. The location of the 'T' bit is specified in the PHYv3.1 Spec. |
| C64 docsPnmCmtsOptRespUncorrectableCodewordCt | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.9 | Counter64 | read-only | This attribute is a count of the measured num of uncorrectable codewords that the CM has received during the testing interval for the profile being tested. Unsigned integer count of codewords that failed pre-decoding LDPC syndrome check and passed BCH decoding. If Codeword Tagging is disabled, this count includes all codewords received on the profile in question for the duration of the test. If Codeword Tagging is enabled, this count includes only codewords received on the profile in question for the duration of the test for which the 'T' bit was set in the NCP pointing to the codeword. The location of the 'T' bit is specified in the PHYv3.1 Spec. |
| C64 docsPnmCmtsOptRespNcpFieldCt | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.10 | Counter64 | read-only | This attribute records the number of NCP fields that were examined by the CM during the test interval. |
| C64 docsPnmCmtsOptRespNcpCrcFailCt | 1.3.6.1.4.1.4491.2.1.27.1.3.9.4.1.11 | Counter64 | read-only | This attribute records the number of NCP fields that failed the NCP CRC check. |
| docsPnmCmtsUtscObjects | 1.3.6.1.4.1.4491.2.1.27.1.3.10 | |||
| docsPnmCmtsUtscCapabTable | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1 | not-accessible | This table exposes capabilities supported by the CCAP for Upstream Triggered Spectrum Capture trigger modes, data output formats, and windowing function used when performing the discrete Fourier transform. | |
| docsPnmCmtsUtscCapabEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1.1 | not-accessible | The conceptual row of the docsPnmCmtsUtscCapabTable. The conceptual rows persist across device resets. A separate entry exists for every Upstream RF Port which supports the capability. | |
| BIT docsPnmCmtsUtscCapabTriggerMode | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1.1.1 | Bits | read-only | This attribute indicates which of the upstream triggered spectrum capture function trigger modes is supported by the CCAP. The attribute is reported in BITS format, with value 0 for each bit definition indicating the CCAP does not support the corresponding TriggerMode and value 1 for each bit definition indicating the CCAP supports the corresponding trigger mode. See the description of the UsTriggeredSpectrumCaptureCfg object TriggerMode attribute for more information about CCAP upstream triggered spectrum capture trigger modes. The value other(0) is provided for vendor proprietary and future extensions. |
| BIT docsPnmCmtsUtscCapabOutputFormat | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1.1.2 | Bits | read-only | This attribute indicates which of the upstream triggered spectrum capture function data output formats are supported by the CCAP. This attribute is reported in BITS format, with value 0 for each bit definition indicating the CCAP does not support the corresponding OutputFormat and value for each bit definition 1 indicating the CCAP supports the corresponding output data format. See the description of the UsTriggeredSpectrumCaptureCfg object OutputFormat attribute for more information about CCAP upstream triggered spectrum capture output formats. The value other(0) is provided for vendor proprietary and future extensions. |
| BIT docsPnmCmtsUtscCapabWindow | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1.1.3 | Bits | read-only | This attribute indicates which of the upstream triggered spectrum capture function window formats are supported by the CCAP. This attribute is reported in BITS format, with value for each bit definition 0 indicating the CCAP does not support the corresponding Window option and value for each bit definition 1 indicating the CCAP supports the corresponding Window option. See the description of the UsTriggeredSpectrumCaptureCfg object Window attribute for more information about CCAP upstream triggered spectrum capture window options. The value other(0) is provided for vendor proprietary and future extensions. |
| STR docsPnmCmtsUtscCapabDescription | 1.3.6.1.4.1.4491.2.1.27.1.3.10.1.1.4 | SnmpAdminString | read-only | This attribute reports a textual description of a CCAPs upstream triggered spectrum capture capabilities. The format is vendor-specific. Example content can include, but is not limited to: - Center Frequency range and resolution - Frequency Span range and resolution - Sampling rate each frequency span - Averaging range and resolution - Averaging method - Number of time domain IQ samples - Number of FFT bins |
| docsPnmCmtsUtscCfgTable | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2 | not-accessible | This table provides configuration functionality for the Upstream Triggered Spectrum Capture function. Refer to the reference for additional details. | |
| docsPnmCmtsUtscCfgEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1 | not-accessible | The conceptual row of the docsPnmCmtsUtscCfgTable. The conceptual rows does not persist across device resets. A separate entry exists for every Upstream RF Port which supports the capability. This table supports the creation and deletion of at least one instance. | |
| U32 docsPnmCmtsUtscCfgIndex | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.1 | Unsigned32 | not-accessible | This key attribute is a unique identifier for a particular set of configuration settings. If the CCAP does not support multiple Upstream Triggered Spectrum Sample Capture configuration settings, the CCAP MUST only support a value of 1 for this attribute and reject any attempt to configure it to a value other than 1. |
| NUM docsPnmCmtsUtscCfgLogicalChIfIndex | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.2 | InterfaceIndexOrZero | read-write | This attribute is the interface index of the logical channel to which the sample capture trigger applies, when TriggerMode is miniSlotCount, sid, idleSid, quietProbeSymbol, and burstIuc. The value 0 means the CCAP is triggering on something specific to the upstream RF port, not a specific channel. When the value of LogicalChannelIndex is the ifIndex of a physical or logical channel and upstream triggered spectrum sample capture is initiated, the CCAP MUST trigger on the assigned trigger mode event for the physical or logical channel indicated by the value of LogicalChannelIndex. |
| INT docsPnmCmtsUtscCfgTriggerMode | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.3 | INTEGER | read-write | This attribute is used to control the trigger mode for the Upstream Triggered Spectrum Analysis sample capture. Values allowed for this attribute are listed and described below. Each trigger mode requires the Enable attribute to be set to true as well as the proper configuration settings applied which are applicable to the specific trigger mode. other: The CCAP initiates sampling the upstream spectrum as the result of a trigger condition not defined in this specification. freeRunning: The CCAP immediately initiates sampling and continues sampling until the length of time configured in attribute FreeRunDuration has transpired. Sampling terminates when the length of time configured in FreeRunDuration has elapsed or when FFT is disabled. The interval between captures is RepeatPeriod, or the minimum period supported by the CCAP, whichever is greater. miniSlotCount: The CCAP initiates sampling when the minislot number equals the value configured for attribute MinislotCount. sid:The CCAP immediately initiates capturing samples corresponding to the Service Flow identified with the Service Identifier (SID) numbered with the value of attribute Sid. The CCAP continues to sample the configured upstream spectrum after being triggered on transmissions corresponding to the specified SID until FFT is disabled or a new configuration is applied. idleSid: The CCAP immediately initiates capturing samples during an idle period selected by the CCAP. The CCAP will continue to sample the configured upstream spectrum during transmissions corresponding to the idle SID until FFT is disabled or a new configuration is applied. cmMacAddr: The CCAP immediately initiates sampling data on a grant for any SID assigned to the cable modem whose MAC address is the value of attribute CmMac. The CCAP continues to sample the configured upstream spectrum during transmissions corresponding to the configured CM MAC until FFT is disabled or a new configuration is applied. quietProbeSymbol: The CCAP immediately initiates sampling data when a configured OFDMA Quiet Probe Symbol occurs. The CCAP will continue to sample the configured upstream spectrum during Quiet Probe Symbols until FFT is disabled or a new configuration is applied. The Upstream Triggered Spectrum Capture test with quietProbeSymbol trigger is different from the Upstream Capture for Active and Quiet Probes PNM feature in that the Upstream Triggered Spectrum Capture test is more general than the Upstream Capture for Active and Quiet Probes test. Upstream Triggered Spectrum Capture test can be done in any band, while the Upstream Capture for Active and Quiet Probes test is specifically for an OFDMA channel. burstIuc: The CCAP immediately initiates sampling when the CCAP issues the grant for the configured burst Interval Usage Code. The CCAP will continue to sample the configured upstream spectrum during transmissions corresponding to the configured IUC until FFT is disabled or a new configuration is applied. timestamp: The CCAP initiates sampling when the configured timestamp occurs. The CCAP will continue to sample the configured upstream spectrum until FFT is disabled or a new configuration is applied; however, a single capture typically is made in this mode. This is the DOCSIS 3.1 timestamp defined in MULPIv3.1. Note that if the CCAP supports only one set of Upstream Triggered Spectrum Capture configuration, then if a test is configured with timestamp trigger it effectively blocks any other test setup and execution until it completes since setting up the other test will overwrite the timestamp test configuration. |
| U32 docsPnmCmtsUtscCfgMinislotCount | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.4 | Unsigned32 | read-write | This attribute specifies the minislot number at the beginning of which the CCAP starts the upstream spectrum sample capture. This attribute is applicable only when the TriggerMode attribute is set to MiniSlotCount and is ignored if TriggerMode is set to any other value. |
| U32 docsPnmCmtsUtscCfgSid | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.5 | Unsigned32 | read-write | This attribute specifies the SID corresponding to the CM which is granted a burst opportunity for the purpose of Upstream Triggered Spectrum Analysis. This attribute is applicable only when the TriggerMode attribute is set to Sid and is ignored if TriggerMode is set to any other value. |
| MAC docsPnmCmtsUtscCfgCmMacAddr | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.6 | MacAddress | read-write | This attribute specifies from which cable modem the CCAP will capture upstream transmissions. The CCAP MUST trigger upstream spectrum sample capture on a grant for any SID assigned to the CM whose MAC address is configured in this attribute, and capture upstream spectrum samples when the burst corresponding to that grant is received by the CCAP. This attribute is used when the TriggerMode is CmMac and is an alternative to using Sid for the TriggerMode. This attribute is ignored if TriggerMode is set to any value other than CmMac. |
| TIM docsPnmCmtsUtscCfgTimestamp | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.7 | TimeStamp | read-write | This attribute specifies the specific time in the future when upstream spectrum sample capture is required to be initiated. If Enable is true, TriggerMode is set to timestamp, configuration settings have been applied, and InitiateTest is true the CCAP MUST initiate sampling when the configured timestamp occurs. The CCAP will continue to sample the configured upstream spectrum until FFT is disabled or a new configuration is applied; however, a single capture typically is made in this mode. |
| U32 docsPnmCmtsUtscCfgCenterFreq | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.8 | Unsigned32 | read-write | This attribute specifies the center frequency of the upstream spectrum to be sampled for analysis. When this attribute is read, it provides the actual center frequency, which may be different from the requested (configured) center frequency due to implementation effects. |
| U32 docsPnmCmtsUtscCfgSpan | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.9 | Unsigned32 | read-write | This attribute determines the frequency span of the upstream spectrum sample capture. When this attribute is read, it provides the actual span, which may be different from the requested (configured) span due to implementation effects. |
| U32 docsPnmCmtsUtscCfgNumBins | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.10 | Unsigned32 | read-write | This attribute determines the number of frequency bins or samples per span when sampling the upstream spectrum. When this attribute is read, it provides the actual number of bins, which may be different from the requested (configured) number of bins due to implementation effects. The number of bins is typically less than the FFT length in use, due to filter rolloff at the edges of the analysis band. A larger number of frequency bins will result in better frequency resolution, for a given frequency span. |
| U32 docsPnmCmtsUtscCfgAveraging | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.11 | Unsigned32 | read-write | This attribute specifies whether the CCAP is to average spectral frequency domain sample power to remove spurious spectral peaks and troughs, and the number of samples to use to calculate the average power. The CCAP MUST NOT calculate the average of the upstream spectrum samples when the value of this attribute is zero. The CCAP MUST calculate the average power of upstream spectrum samples, over the number of samples specified by this attribute when the value of is nonzero. The CCAP MUST use quantities in the linear power domain when performing time averaging over multiple spectra. Please refer to the Reference for additional details. |
| STR docsPnmCmtsUtscCfgFilename | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.12 | SnmpAdminString | read-write | This attribute specifies the name of the file with the upstream triggered spectrum capture data at the CCAP that is to be transferred from the CCAP using TFTP to the PNM server or other TFTP client. The content of the sample data file transferred from the CCAP using TFTP is the same as the content returned in attribute Output of the corresponding Result table. If the value of this attribute is an empty string, then a default filename value will be used. Otherwise, the value set will be used as the filename. If a default filename is generated, then that value will be returned in this attribute and will represent the filename that was used for the test. All subsequent tests should set this attribute to a meaningful value or to an 'empty string' value (to generate a new default filename) before starting a new test. 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: PNMCcapUsTrigSpecCapt__ Hence, the upstream spectrum sample capture filename format would be as shown in the following example: PNMCcapUsTrigSpecCapt_ccap1.boulder.cablelabs.com_1403405123 Refer to the Reference for the Format of upstream triggered spectrum capture file. |
| U32 docsPnmCmtsUtscCfgQualifyCenterFreq | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.13 | Unsigned32 | read-write | This attribute specifies the center frequency of a band that is used to qualify a spectrum for upload. The average of the FFT linear power values in this band is computed and compared to a threshold. If the average power in the band is below the threshold, the spectrum is discarded. If the power average is greater than or equal to the threshold, the spectrum is considered qualified. |
| U32 docsPnmCmtsUtscCfgQualifyBw | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.14 | Unsigned32 | read-write | This attribute specifies the bandwidth of a band that is used to qualify a spectrum for upload. The average of the FFT linear power values in this band is computed and compared to a threshold. If the average power in the band is below the threshold, the spectrum is discarded. If the power average is greater than or equal to the threshold, the spectrum is considered qualified. |
| I32 docsPnmCmtsUtscCfgQualifyThrshld | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.15 | Integer32 | read-write | This attribute specifies the threshold applied to qualify a spectrum for upload. The average of the FFT linear power values in the specified band is computed and compared to this threshold. If the average power in the band is below the threshold, the spectrum is discarded. If the power average is greater than or equal to the threshold, the spectrum is considered qualified. If this threshold is set to -100 dB or lower, the threshold qualification feature is disabled (all spectra are then considered qualified). |
| INT docsPnmCmtsUtscCfgWindow | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.16 | INTEGER | read-write | This attribute specifies the windowing function that will be used when performing the discrete Fourier transform for the upstream spectrum analysis. Use of 'modern' windowing functions not yet defined will likely be specified as 'other'. The CCAP MUST be capable of implementing rectangular windowing and at least one of the following other window types when performing discrete Fourier transform on upstream spectrum sample data: - Hann windowing - Blackman Harris windowing. The CCAP SHOULD implement Hamming windowing for performing discrete Fourier transform on upstream spectrum sample data. The CCAP MAY implement Flat Top windowing for performing discrete Fourier transform on upstream spectrum sample data. The CCAP MAY implement Gaussian windowing for performing discrete Fourier transform on upstream spectrum sample data. The CCAP MAY implement Chebyshev windowing for performing discrete Fourier transform on upstream spectrum sample data. |
| INT docsPnmCmtsUtscCfgOutputFormat | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.17 | INTEGER | read-write | This attribute specifies the format of the data returned in the upstream spectrum sample capture file and in the Output attribute of the Results table. The CCAP MUST be capable of reporting upstream spectrum sample FFT input data in complex time-domain in-phase and quadrature (I/Q) format. The enumeration value for complex time-domain I/Q format is timeIQ. The CCAP MUST use 4 bytes per upstream spectrum sample to represent the data when reporting in complex time-domain I/Q format. The CCAP MUST be capable of reporting upstream spectrum sample FFT output data in power format. The enumeration value for power format is fftPower. The CCAP MUST use 4 bytes per bin to represent upstream spectrum sample FFT output data when reporting upstream spectrum sample data in power format. The CCAP MAY be capable of reporting upstream spectrum sample real FFT input data in raw analog-to-digital converter (ADC) output format. The enumeration value for raw ADC output format is rawAdc. The CCAP MUST use 2 bytes per upstream spectrum sample to represent the data when reporting in raw ADC output format. The CCAP MAY support reporting of upstream spectrum sample FFT output data in I/Q format. The enumeration value for I/Q format is fftIQ. The CCAP MUST use 4 bytes per bin to represent FFT output data when reporting upstream spectrum sample data in I/Q format. The CCAP MAY support reporting of upstream spectrum sample FFT output data in amplitude format. The enumeration value for amplitude format is fftAmplitude. The CCAP MUST use 2 bytes per bin to represent upstream spectrum sample FFT output data when reporting upstream spectrum sample data in amplitude format. The CCAP MAY support reporting of upstream spectrum sample FFT data in dB format using units of hundredths dB. The enumeration value for spectrum amplitude format is fftDb. The CCAP MUST use 2 bytes per bin to represent upstream spectrum sample FFT output data when reporting in dB format. The CCAP MUST reject any attempt to set OutputFormat to an optional value not supported by the CCAP. |
| U32 docsPnmCmtsUtscCfgRepeatPeriod | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.18 | Unsigned32 | read-write | This attribute specifies the interval in microseconds between consecutive triggers for FFT sample capture. The CCAP is permitted to trigger at larger intervals if unable to support the requested interval. Configuring a zero value indicates the test is to run once only. The CCAP MUST reject an attempt to set RepeatPeriod to a value greater than the current value of FreeRunDuration. |
| U32 docsPnmCmtsUtscCfgFreeRunDuration | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.19 | Unsigned32 | read-write | This attribute specifies the length of time in milliseconds for which the CCAP continues to capture and return FFT results when in free running mode. Sample captures are expected to take a few microseconds so if FreeRunDuration is set for longer than a sample capture duration the CCAP could potentially capture more sample data than it can store. The CCAP MUST reject an attempt to set FreeRunDuration to a value less than the current value of RepeatPeriod. |
| U32 docsPnmCmtsUtscCfgTriggerCount | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.20 | Unsigned32 | read-write | This attribute determines the number of times to trigger upstream spectrum sample capture when Enable and InitiateTest are set to true and configured trigger conditions are met. The CCAP MUST trigger upstream spectrum sample capture continuously when the value of TriggerCount is zero. This attribute is applicable to FreeRun trigger modes as well as other trigger modes. |
| ROW docsPnmCmtsUtscCfgStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.10.2.1.21 | RowStatus | read-write | The status of this conceptual table row entry. |
| docsPnmCmtsUtscCtrlTable | 1.3.6.1.4.1.4491.2.1.27.1.3.10.3 | not-accessible | This table provides command and control functionality for the Upstream Triggered Spectrum Capture function. Refer to the reference for additional details. | |
| docsPnmCmtsUtscCtrlEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.10.3.1 | not-accessible | The conceptual row of the docsPnmCmtsUtscCtrlTable. The conceptual rows does not persist across device resets. A separate entry exists for every Upstream RF Port which supports the capability. This table supports the creation and deletion of at least one instance. Instances are created and/or deleted when the corresponding UsTriggeredSpectrumCaptureCfg object instances are instantiated. | |
| T/F docsPnmCmtsUtscCtrlInitiateTest | 1.3.6.1.4.1.4491.2.1.27.1.3.10.3.1.1 | TruthValue | read-write | This attribute is used to trigger an Upstream Triggered Spectrum Capture. Setting this attribute to true applies all configured upstream triggered spectrum sample capture attributes and initiates the triggered upstream spectrum sample capture and sample output conversion process. Read-write attributes, which are used to configure the Upstream Triggered Spectrum Capture, can only be configured while a test is not in progress. The CCAP MUST reject any attempt to modify a UsTriggeredSpectrumCaptureCfg table attribute, or UsTriggeredSpectrumCaptureCtrl table attribute for the same instance of InitiateTest configured to true when the triggered spectrum capture is in progress as indicated by value 'busy' for MeasStatus. The CCAP MUST allow writable UsTriggeredSpectrumCaptureCfg table attributes, or UsTriggeredSpectrumCaptureCtrl table attributes to be modified if the value of attribute MeasStatus for the instance is not 'busy'. The CCAP initiates an upstream triggered spectrum sample capture only if Enable bit 1 is set to true, InitiateTest is set to true and all of the UsTriggeredSpectrumCaptureCfg configuration attributes are properly configured. Refer to section 7.3.4.1.6 and Table 1 of the Reference. While a test is in progress, this attribute returns the value true. Configuring a value of false for this attribute, while a test is in progress, will abort the currently executing test. If a test is aborted, the result data is discarded. |
| docsPnmCmtsUtscStatusTable | 1.3.6.1.4.1.4491.2.1.27.1.3.10.4 | not-accessible | This table provides functionality for monitoring and reporting status of the Upstream Triggered Spectrum Capture function. Refer to the reference for additional details. | |
| docsPnmCmtsUtscStatusEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.10.4.1 | not-accessible | The conceptual row of the docsPnmCmtsUtscStatusTable. The conceptual rows does not persist across device resets. A separate entry exists for every Upstream RF Port which supports the capability. This table supports the creation and deletion of at least one instance. Instances are created and/or deleted when the corresponding UsTriggeredSpectrumCaptureCfg object instances are instantiated. | |
| MEA docsPnmCmtsUtscStatusMeasStatus | 1.3.6.1.4.1.4491.2.1.27.1.3.10.4.1.1 | MeasStatusType | read-only | This attribute is used to report the status of the Upstream Triggered Spectrum Capture. When the value is sampleReady, the CCAP has completed capturing and recording samples. |
| docsPnmCmtsUtscResultTable | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5 | not-accessible | This table provides functionality for reporting results of the Upstream Triggered Spectrum Capture function. Refer to the reference for additional details. | |
| docsPnmCmtsUtscResultEntry | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1 | not-accessible | The conceptual row of the docsPnmCmtsUtscResultTable. The conceptual rows does not persist across device resets. A separate entry exists for every Upstream RF Port which supports the capability. This table supports the creation and deletion of at least one instance. Instances are created and/or deleted when the corresponding UsTriggeredSpectrumCaptureCfg object instances are instantiated. | |
| U32 docsPnmCmtsUtscResultSampleRate | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1.1 | Unsigned32 | read-only | This attribute reports the FFT sample rate used by the CCAP when sampling the upstream spectrum. The input to the FFT can be the ADC output, the ADC output followed by a down-mixer and half-band filter, the ADC output followed by a down-mixer and quarter-band filter, or the received channel's Nyquist filter output. |
| U32 docsPnmCmtsUtscResultUsSampleSize | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1.2 | Unsigned32 | read-only | This attribute reports the number of samples collected for FFT. The FFT payload size will be the number of samples multiplied by the number of bytes per sample as determined by OutputFormat. The duration of the FFT sample will be the number of samples divided by the sample rate as reported in attribute SampleRate. |
| TIM docsPnmCmtsUtscResultSampleTimestamp | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1.3 | TimeStamp | read-only | This attribute reports the date and time when the FFT sample was recorded. |
| U32 docsPnmCmtsUtscResultResolutionBw | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1.4 | Unsigned32 | read-only | This attribute reports the resolution bandwidth used when samples were collected. The resolution bandwidth is the same as the bin spacing for rectangular windowing, is 1.5*bin spacing for Hanning window, etc. The resolution bandwidth used by the CCAP is needed in order to obtain an accurate power measurement for all signals when both CW and noise-like (QAM, OFDM) signals are present in the spectrum. |
| OCT docsPnmCmtsUtscResultOutput | 1.3.6.1.4.1.4491.2.1.27.1.3.10.5.1.5 | OCTET STRING | read-only | This attribute returns the upstream spectrum sample capture data in hexadecimal format according to the output format configured in attribute OutputFormat. Refer to the Reference for the format of the sample capture data returned by this attribute. This attribute provides an alternative to TFTP file transfer for reporting sample data. Due to small data sizes for upstream captures, this may be a more responsive method for screen updates than TFTP file transfer. |
| docsPnmMibConformance | 1.3.6.1.4.1.4491.2.1.27.2 | |||
| docsPnmMibCompliances | 1.3.6.1.4.1.4491.2.1.27.2.1 | |||
| docsPnmCmtsCompliance | 1.3.6.1.4.1.4491.2.1.27.2.1.1 | The compliance statement for the CMTS. | ||
| docsPnmCmCompliance | 1.3.6.1.4.1.4491.2.1.27.2.1.2 | The compliance statement for the CM. | ||
| docsPnmCmtsDeprecatedCompliance | 1.3.6.1.4.1.4491.2.1.27.2.1.3 | The compliance statement for deprecated objects. | ||
| docsPnmMibGroups | 1.3.6.1.4.1.4491.2.1.27.2.2 | |||
| docsPnmBulkDataGroup | 1.3.6.1.4.1.4491.2.1.27.2.2.1 | Group of objects implemented For Bulk-Data support | ||
| docsPnmCmtsGroup | 1.3.6.1.4.1.4491.2.1.27.2.2.2 | Group of objects implemented in the CMTS | ||
| docsPnmCmGroup | 1.3.6.1.4.1.4491.2.1.27.2.2.3 | Group of objects implemented in the CM | ||
| docsPnmCmtsDeprecatedGroup | 1.3.6.1.4.1.4491.2.1.27.2.2.4 | Deprecated Objects of objects implemented in the CMTS |
RFC description
DOCSIS 3.1 Proactive Network Maintenance MIB managed by CableLabs, providing SNMP management objects for PNM functions including RxMER probes, bulk data transfers, and spectrum analysis in cable systems.
Start monitoring DOCSIS 3.1 cable modem/CMTS (Proactive Network Maintenance, vendor-neutral CableLabs standard) with a free 30-day trial of IPNetwork Monitor. Import MIBs, browse SNMP OIDs, create custom SNMP monitors, configure alerts, and monitor any SNMP-enabled network device from a single console.