Data-Over-Cable Service Interface Specifications MHAv2

Remote PHY OSS Interface Specification

CM-SP-R-OSSI-I16-210903 ISSUED

Notice

This DOCSIS® specification is the result of a cooperative effort undertaken at the direction of Cable Television Laboratories, Inc. for the benefit of the cable industry and its customers. You may download, copy, distribute, and reference the documents herein only for the purpose of developing products or services in accordance with such documents, and educational use. Except as granted by CableLabs® in a separate written license agreement, no license is granted to modify the documents herein (except via the Engineering Change process), or to use, copy, modify or distribute the documents for any other purpose.

This document may contain references to other documents not owned or controlled by CableLabs. Use and understanding of this document may require access to such other documents. Designing, manufacturing, distributing, using, selling, or servicing products, or providing services, based on this document may require intellectual property licenses from third parties for technology referenced in this document. To the extent this document contains or refers to documents of third parties, you agree to abide by the terms of any licenses associated with such third-party documents, including open source licenses, if any. © Cable Television Laboratories, Inc. 2015-2021

CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

DISCLAIMER

This document is furnished on an "AS IS" basis and neither CableLabs nor its members provides any representation or warranty, express or implied, regarding the accuracy, completeness, noninfringement, or fitness for a particular purpose of this document, or any document referenced herein. Any use or reliance on the information or opinion in this document is at the risk of the user, and CableLabs and its members shall not be liable for any damage or injury incurred by any person arising out of the completeness, accuracy, or utility of any information or opinion contained in the document. CableLabs reserves the right to revise this document for any reason including, but not limited to, changes in laws, regulations, or standards promulgated by various entities, technology advances, or changes in equipment design, manufacturing techniques, or operating procedures described, or referred to, herein. This document is not to be construed to suggest that any company modify or change any of its products or procedures, nor does this document represent a commitment by CableLabs or any of its members to purchase any product whether or not it meets the characteristics described in the document. Unless granted in a separate written agreement from CableLabs, nothing contained herein shall be construed to confer any license or right to any intellectual property. This document is not to be construed as an endorsement of any product or company or as the adoption or promulgation of any guidelines, standards, or recommendations.

2 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Document Status Sheet

Document Control Number: CM-SP-R-OSSI-I16-210903

Document Title: Remote PHY OSS Interface Specification

Revision History: I01 - Released 08/17/2015 I09 - Released 05/09/2018 I02 - Released 01/21/2016 I10 - Released 09/26/2018 I03 - Released 05/12/2016 I11 - Released 01/21/2019 I04 - Released 09/23/2016 I12 - Released 05/10/2019 I05 - Released 01/11/2017 I13 - Released 08/28/2019 I06 - Released 05/24/2017 I14 - Released 04/21/2020 I07 - Released 09/08/2017 I15 - Released 03/01/2021 I08 - Released 12/20/2017 I16 - Released 09/03/2021

Date: September 3, 2021

Status: Work in Draft Issued Closed Progress

Distribution Restrictions: Author Only CL/Member CL/ Member/ Public Vendor

Key to Document Status Codes

Work in Progress An incomplete document, designed to guide discussion and generate feedback that may include several alternative requirements for consideration.

Draft A document in specification format considered largely complete, but lacking review by Members and vendors. Drafts are susceptible to substantial change during the review process.

Issued A generally public document that has undergone Member and Technology Supplier review, cross-vendor interoperability, and is for Certification testing if applicable. Issued Specifications are subject to the Engineering Change Process. Closed A static document, reviewed, tested, validated, and closed to further engineering change requests to the specification through CableLabs.

Trademarks CableLabs® is a registered trademark of Cable Television Laboratories, Inc. Other CableLabs marks are listed at https://www.cablelabs.com/specs/certification/trademarks/. All other marks are the property of their respective owners.

 09/03/21 CableLabs 3 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table of Contents

1 SCOPE ...... 15 1.1 Introduction and Purpose ...... 15 1.2 MHAv2 Interface Documents ...... 15 1.3 Requirements ...... 15 1.4 Conventions ...... 16 1.4.1 GCP TLVs ...... 16 1.5 Organization of Document ...... 16 1.5.1 Annexes (Normative)...... 17 1.5.2 Appendices (Informative) ...... 17 2 REFERENCES ...... 18 2.1 Normative References...... 18 2.2 Informative References ...... 20 2.3 Reference Acquisition...... 21 3 TERMS AND DEFINITIONS ...... 22 4 ABBREVIATIONS, ACRONYMS, AND NAMESPACES ...... 25 5 OVERVIEW...... 29 5.1 FCAPS Network Management Model ...... 29 5.2 Management Architectural Overview ...... 29 5.3 Remote PHY OSSI Key Features ...... 31 5.3.1 Fault Management Features ...... 32 5.3.2 Configuration Management Features ...... 32 5.3.3 Performance Management Features ...... 32 5.4 Information Models ...... 34 6 CONFIGURATION MANAGEMENT ...... 35 6.1 RPD Configuration Theory of Operation...... 35 6.2 CCAP Configuration and Transport Protocol Requirements ...... 35 6.2.1 Configuration Object Datastore ...... 35 6.2.2 Dynamic Management of RPDs ...... 36 6.3 CCAP UML Configuration Information Model Overview ...... 36 6.3.1 CCAP UML Configuration Object Model Overview ...... 36 6.3.2 Vendor-Specific Extensions ...... 37 6.4 Data Type Definitions ...... 37 6.4.1 DtiModeType ...... 38 6.4.2 EvPriorityType ...... 38 6.4.3 RpdEvReportingType ...... 38 6.4.4 SyncEQLType ...... 39 6.4.5 RfmStatusType ...... 39 6.5 CCAP Core Configuration Information Model ...... 39 6.5.1 CcapCore ...... 39 6.5.2 CCAP Chassis Configuration Information Model ...... 40 6.5.3 DOCSIS Upstream Interface Configuration ...... 43 6.5.4 Downstream DOCSIS and Video Channel Configuration Information Model ...... 49 6.5.5 CCAP Core RPD Configuration Information Model ...... 52 6.5.6 Network Configuration Information Model ...... 75 6.5.7 OOB 55-1 Configuration Information Model ...... 77 6.5.8 R-DTI Configuration Information Model ...... 82 6.5.9 OOB Narrowband Digital Configuration Information Model ...... 89 6.6 CCAP Core Control Information Model ...... 94 6.6.1 CCAP Core RPD Control Information Model ...... 94

4 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.7 RPD Information Model ...... 101 6.7.1 RPD Configuration Information Model ...... 101 6.7.2 RPD Control Information Model ...... 103 7 PERFORMANCE MANAGEMENT ...... 109 7.1 Performance Management UML Information Model ...... 109 7.1.1 Data Type Definitions ...... 109 7.1.2 General Attribute Requirements ...... 109 7.1.3 RPD Device Information Model ...... 110 7.1.4 RPD Capabilities Information Model ...... 138 7.1.5 RPD Interface Information Model ...... 170 7.1.6 RPD IP Information Model ...... 199 7.1.7 RPD PTP Status Information Model ...... 210 7.1.8 CCAP Core General Information Model ...... 212 7.1.9 CCAP Core PTP Status Information Model ...... 223 7.1.10 CMTS CM Status Information Model ...... 234 7.1.11 RPD Statistics Information Model ...... 236 7.1.12 Upstream OFDMA Status Information Model ...... 250 7.1.13 Streaming Telemetry Status Information Model ...... 252 8 ACCOUNTING MANAGEMENT ...... 255 9 FAULT MANAGEMENT AND REPORTING REQUIREMENTS ...... 256 9.1 Fault Management Requirements and Transport Protocols ...... 256 9.2 Event Reporting ...... 256 9.2.1 CCAP Core Event Notification ...... 256 9.2.2 RPD Event Reporting...... 256 9.2.3 RPD Clearing of Previously Reported Conditions ...... 260 9.3 Fault Management UML Information Model ...... 260 9.3.1 CCAP Core Event Notification Objects ...... 260 9.3.2 RPD Event Notification Information Model ...... 260 9.4 RPD Diagnostic LED Indicators ...... 262 9.4.1 System LED Indicator ...... 263 9.4.2 CIN LED Indicators ...... 263 9.4.3 RF LED Indicators ...... 263 9.5 Proactive Network Maintenance (PNM)...... 264 10 SNMP AND MIB REQUIREMENTS ...... 265 10.1 Protocol and Agent Requirements ...... 265 10.2 CableLabs MIBs ...... 265 10.3 Specific MIB Object Implementation Requirements ...... 265 10.3.1 Requirements for SNMPv2 MIB (RFC 3418)...... 265 10.3.2 Requirements for Interfaces Group MIB (RFC 2863) ...... 265 10.3.3 Requirements for Entity-MIB (RFC 6933) ...... 276 10.3.4 Requirements for Entity Sensor MIB (RFC 3433) ...... 277 10.3.5 Requirements for Internet Protocol MIB (RFC 4293) ...... 277 10.3.6 Requirements for DOCSIS Remote PHY MIB (DOCS-RPHY-MIB) ...... 277 10.3.7 Requirements for DOCSIS Remote PHY Control MIB (DOCS-RPHY-CTRL-MIB) ...... 277 10.3.8 Requirements for DOCSIS Remote PHY PTP MIB (DOCS-RPHY-PTP-MIB) ...... 277 10.3.9 Requirements for DOCSIS Remote PHY Statistics MIB (DOCS-RPHY-STATS-MIB)...... 278 10.3.10 Requirements for DOCSIS Baseline Privacy Plus MIB (RFC 4131) ...... 278 10.3.11 Requirements for DOCSIS IF MIBs ...... 278 10.3.12 Requirements for DOCSIS Remote PHY Security (DOCS-RPHY-SEC-MIB) ...... 284 11 SECURITY MANAGEMENT ...... 285 11.1 Secure Shell Requirements ...... 285

 09/03/21 CableLabs 5 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

11.2 Local Management Access ...... 286 11.3 Certificate Management ...... 286 11.4 Security Management UML Information Model ...... 286 11.4.1 CCAP Core Security Management Information Model ...... 286 11.4.2 CCAP Core RPD Security Management Information Model ...... 291 ANNEX A DETAILED MIB REQUIREMENTS (NORMATIVE) ...... 293 A.1 CCAP Core MIB Object Details ...... 293 A.2 DOCS-RPHY-MIB Object Details ...... 294 A.3 DOCS-RPHY-CTRL-MIB Object Details...... 309 A.4 DOCS-RPHY-PTP-MIB Object Details ...... 310 A.5 DOCS-RPHY-STATS-MIB Object Details...... 313 A.6 DOCS-RPHY-SEC-MIB Object Details ...... 316 ANNEX B FORMAT AND CONTENT FOR EVENT, SYSLOG, AND SNMP NOTIFICATION (NORMATIVE) ...... 317 B.1 Deprecated Events ...... 340 B.2 Example CCAP Core SNMP Notification and Syslog Event Message (Informative) ...... 341 B.3 Example RPD Syslog Event Message (Informative) ...... 341 ANNEX C DATA TYPE DEFINITIONS (NORMATIVE) ...... 342 C.1 Overview ...... 342 C.1.1 Data Types Mapping ...... 342 C.1.2 Data Types Requirements and Classification ...... 342 C.1.3 Data Type Mapping Methodology ...... 342 C.1.4 General Data Types (SNMP Mapping) ...... 343 C.1.5 Primitive Data Types (YANG Mapping) ...... 344 C.1.6 Extended Data Types (SNMP Mapping) ...... 344 C.1.7 Derived Data Types (YANG Mapping) ...... 345 C.2 Remote PHY Common Data Type Definitions ...... 346 C.3 Common Terms Shortened ...... 346 C.3.1 Exceptions ...... 347 APPENDIX I ACKNOWLEDGMENTS (INFORMATIVE) ...... 348 APPENDIX II REVISION HISTORY ...... 349

List of Figures

Figure 1 - Remote PHY Management Overview ...... 29 Figure 2 - Remote PHY Management Component Diagram ...... 30 Figure 3 - Remote PHY Streaming Telemetry Management Architecture ...... 33 Figure 4 - CCAP Core Configuration Information Model ...... 39 Figure 5 - CCAP Chassis Configuration Information Model ...... 40 Figure 6 - DOCSIS Upstream Interface Configuration Information Model ...... 44 Figure 7 - Downstream DOCSIS and Video Configuration Information Model ...... 49 Figure 8 - CCAP Core RPD Configuration Information Model ...... 53 Figure 9 - Streaming Telemetry Configuration Information Model ...... 72 Figure 10 - Network Configuration Information Model ...... 75 Figure 11 - OOB-551 Configuration Information Model ...... 77 Figure 12 - CCAP Core R-DTI Configuration Information Model ...... 83 Figure 13 - OOB Narrowband Digital Configuration Network Diagram ...... 89

6 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 14 - OOB Narrowband Digital Configuration Information Model...... 90 Figure 15 - CCAP Core RPD Control Information Model ...... 94 Figure 16 - RPD Configuration Information Model ...... 101 Figure 17 - RPD Control Information Model ...... 103 Figure 18 - RPD Device Information Model ...... 111 Figure 19 - RPD Capabilities Information Model ...... 139 Figure 20 - RPD Interface Information Model ...... 171 Figure 21 - RPD IP Information Model ...... 199 Figure 22 - RPD PTP Status Information Model ...... 210 Figure 23 - CCAP Core General Information Model ...... 212 Figure 24 - CCAP Core PTP Status Information Model ...... 224 Figure 25 - CMTS CM Status Information Model ...... 235 Figure 26 - RPD Statistics Information Model ...... 237 Figure 27 - Upstream OFDMA Status Information Model ...... 250 Figure 28 - Streaming Telemetry Status Information Model ...... 252 Figure 29 - RPD Fault Management Reporting Information Model...... 261 Figure 30 - RPD DOCSIS IF-MIB Counter Model ...... 271 Figure 31 - CCAP Core Interface Stack Relationship Object Diagram ...... 274 Figure 32 - CCAP Core Security Management Information Model ...... 287 Figure 33 - CCAP Core RPD Security Management Information Model ...... 291

List of Tables

Table 1 - Management Feature Requirements for Remote PHY ...... 31 Table 2 - Data Types ...... 38 Table 3 - CcapCore Object Associations ...... 40 Table 4 - New Chassis Object Associations ...... 41 Table 5 - RphyLineCard Object Associations ...... 41 Table 6 - UsRfChanResourceGrp Object Attributes ...... 42 Table 7 - UsRfChanResourceGrp Object Associations ...... 42 Table 8 - DsRfChanResourceGrp Object Attributes ...... 43 Table 9 - DsRfChanResourceGrp Object Associations ...... 43 Table 10 - RpdUsAssocList Object Attributes ...... 44 Table 11 - RpdUsAssocList Object Associations ...... 44 Table 12 - RpdUsPortRef Object Attributes ...... 45 Table 13 - New UpstreamPhysicalChannel Object Associations ...... 45 Table 14 - New UsOfdmaChannelCfg Object Associations ...... 45 Table 15 - DocsIfCfg Object Associations ...... 46 Table 16 - ConfigPreamble Object Attributes ...... 46 Table 17 - New IntervalUsageCode Object Attributes ...... 47 Table 18 - ModulationProfile Object Associations ...... 47 Table 19 - New UsOfdmaInitialRangingIuc Object Attributes ...... 48 Table 20 - New UsOfdmaFineRangingIuc Object Attributes ...... 48 Table 21 - New UsOfdmaModulationTemplate Object Associations ...... 49

 09/03/21 CableLabs 7 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 22 - RpdDsAssocList Object Attributes ...... 50 Table 23 - RpdDsAssocList Object Associations ...... 50 Table 24 - RpdDsPortRef Object Attributes ...... 50 Table 25 - New DownChannel Object Associations ...... 51 Table 26 - New DocsisDownChannel Object Attributes ...... 51 Table 27 - New DsOfdmChannelCfg Object Attributes ...... 52 Table 28 - New DsOfdmChannelCfg Object Associations ...... 52 Table 29 - RpdCfg Object Attributes ...... 53 Table 30 - RpdCfg Object Associations ...... 53 Table 31 - DefaultRpdEvReportingCfg Object Attributes ...... 54 Table 32 - DefaultRpdReconnectCfg Object Attributes ...... 55 Table 33 - RemotePhyDevice Object Attributes ...... 56 Table 34 - RemotePhyDevice Object Associations ...... 57 Table 35 - RpdEvReportingCfg Object Attributes ...... 57 Table 36 - RpdDsRfPort Object Attributes ...... 58 Table 37 - RpdDsRfPort Object Associations ...... 58 Table 38 - CwTones Object Attributes ...... 59 Table 39 - RpdUsRfPort Object Associations ...... 60 Table 40 - Oob551DsSg Object Attributes ...... 60 Table 41 - Oob551DsSg Object Associations ...... 60 Table 42 - Oob551DsSgRpd Object Attributes ...... 61 Table 43 - Oob551DsSgRpd Object Associations ...... 61 Table 44 - Oob551DsSgRfPort Object Attributes ...... 61 Table 45 - Oob551UsSg Object Attributes ...... 61 Table 46 - Oob551UsSg Object Associations ...... 61 Table 47 - Oob551UsSgRpd Object Attributes ...... 62 Table 48 - Oob551UsSgRpd Object Associations ...... 62 Table 49 - Oob551UsSgRfPort Object Attributes ...... 62 Table 50 - RpdPtpClkCfg Object Associations ...... 62 Table 51 - RpdPtpPortCfg Object Attributes ...... 62 Table 52 - RpdPtpPortCfg Object Associations ...... 63 Table 53 - VendorSpecificPreCfg Object Attributes ...... 63 Table 54 - RpdReconnectCfg Object Attributes ...... 64 Table 55 - DefaultCwTonesCfg Object Attributes ...... 65 Table 56 - RpdSyncECfg Object Attributes ...... 66 Table 57 - RpdSyncECfg Object Associations ...... 66 Table 58 - RpdSyncEPortCfg Object Attributes ...... 67 Table 59 - RpdClkCfg Object Attributes ...... 69 Table 60 - RpdSyslogCfg Object Associations ...... 70 Table 61 - RpdSyslogServerCfg Object Attributes ...... 70 Table 62 - RpdSyslogNotificationCfg Object Attributes ...... 71 Table 63 - RpdSyslogThrottleCfg Object Attributes ...... 71 Table 64 - StreamingTelemetryCfg Object Associations ...... 72 Table 65 - TelemetryClientAccessCfg Object Attributes ...... 73

8 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 66 - TelemetryClientAccessCfg Object Associations ...... 73 Table 67 - TelemetryClientDialInAccessListCfg Object Attributes ...... 74 Table 68 - TelemetryClientDialOutAccessListCfg Object Attributes ...... 74 Table 69 - TelemetryClientDialOutRetryCfg Object Attributes ...... 75 Table 70 - New NetworkCfg Object Associations ...... 76 Table 71 - DefaultRphySessionCinDsLatencyMeasCfg Object Attributes ...... 76 Table 72 - DepiMcast Object Attributes ...... 77 Table 73 - Oob551Cfg Object Associations ...... 78 Table 74 - Oob551Ctlrs Object Attributes ...... 78 Table 75 - Oob551DsChan Object Attributes ...... 78 Table 76 - Oob551DsChan Object Associations ...... 79 Table 77 - Oob551VirtArpd Object Attributes ...... 80 Table 78 - Oob551VirtArpd Object Associations ...... 80 Table 79 - Oob551VirtUsRfPort Object Attributes ...... 81 Table 80 - Oob551VirtUsRfPort Object Associations ...... 81 Table 81 - Oob551VirtUsChan Object Attributes ...... 81 Table 82 - Oob551ThrshldGrp Object Attributes ...... 82 Table 83 - PtpClkCfg Object Attributes ...... 84 Table 84 - PtpPortCfg Object Attributes ...... 84 Table 85 - PtpPortCfg Object Associations ...... 85 Table 86 - PtpTemplateCfg Object Attributes ...... 85 Table 87 - PtpTemplateCfg Object Associations ...... 86 Table 88 - PtpMasterClkCfg Object Attributes ...... 87 Table 89 - CorePtpClkCfg Object Associations ...... 88 Table 90 - CorePtpPortCfg Object Attributes ...... 88 Table 91 - CorePtpPortCfg Object Associations ...... 88 Table 92 - OobNdEngine Object Attributes ...... 90 Table 93 - OobNdfDsChan Object Attributes ...... 91 Table 94 - OobNdfDsChan Object Associations ...... 91 Table 95 - OobNdrDsSession Object Attributes ...... 92 Table 96 - OobNdrUsChan Object Attributes ...... 93 Table 97 - OobNdrUsChan Object Associations ...... 93 Table 98 - OobNdrUsSession Object Attributes ...... 94 Table 99 - RpdCtrl Object Attributes ...... 95 Table 100 - RpdCtrl Object Associations ...... 95 Table 101 - RpdResetCtrl Object Attributes ...... 95 Table 102 - RpdLogCtrl Object Attributes ...... 96 Table 103 - RpdSsdCtrl Object Attributes ...... 96 Table 104 - RpdCrashDataFileCtrl Object Attributes...... 98 Table 105 - RpdCrashDataServerCtrl Object Attributes ...... 99 Table 106 - RpdInitProvCtrl Object Attributes ...... 100 Table 107 - RemotePhyDevice Object Attributes ...... 101 Table 108 - RemotePhyDevice Object Associations ...... 102 Table 109 - Location Object Attributes ...... 102

 09/03/21 CableLabs 9 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 110 - MutualAuthentication Object Attributes ...... 102 Table 111 - IpAcquisition Object Attributes ...... 103 Table 112 - RemotePhyDevice Object Associations ...... 104 Table 113 - RebootDisableCtrl Object Attributes ...... 104 Table 114 - ResetCtrl Object Attributes ...... 104 Table 115 - RpdLogCtrl Object Attributes ...... 105 Table 116 - CrashDataFileCtrl Object Attributes ...... 105 Table 117 - CrashDataServerCtrl Object Attributes ...... 106 Table 118 - SsdCtrl Object Attributes ...... 107 Table 119 - Data Types ...... 109 Table 120 - CcapCore Object Associations ...... 112 Table 121 - RpdInfo Object Attributes ...... 112 Table 122 - RpdInfo Object Associations ...... 112 Table 123 - Identification Object Attributes ...... 113 Table 124 - Identification Object Associations ...... 114 Table 125 - Location Object Attributes ...... 115 Table 126 - CoresConnected Object Attributes ...... 116 Table 127 - CandidateBackupCores Object Attributes ...... 119 Table 128 - DsUsRfPortAlloc Object Attributes ...... 120 Table 129 - RpdL2tpSessionInfo Object Associations ...... 121 Table 130 - RpdSessionStats Object Attributes ...... 121 Table 131 - DiagnosticStatus Object Attributes ...... 122 Table 132 - DepiMcastSession Object Attributes ...... 123 Table 133 - Oob551UsChanStatus Object Attributes ...... 124 Table 134 - CrashDataFileStatus Object Attributes ...... 126 Table 135 - RpdUsSignalQuality Object Attributes ...... 127 Table 136 - HostResources Object Associations ...... 128 Table 137 - HostResourcesSystem Object Attributes ...... 128 Table 138 - HostResourcesStorage Object Attributes ...... 129 Table 139 - HostResourcesSwRun Object Attributes ...... 130 Table 140 - ExtSwImageSupport Object Attributes ...... 131 Table 141 - ResetHistory Object Attributes...... 132 Table 142 - RpdShelfInfo Object Attributes ...... 134 Table 143 - ChanBcastGroupStatus Object Attributes ...... 135 Table 144 - RpdTrfStats Object Attributes ...... 135 Table 145 - RpdLcceStats Object Attributes ...... 136 Table 146 - RpdCurrentControlConnections Object Attributes ...... 137 Table 147 - RpdInfo Object Associations ...... 140 Table 148 - CapabilitiesGrp Object Associations ...... 140 Table 149 - UsCapabilitiesGrp Object Associations ...... 141 Table 150 - UsCapabilities Object Attributes ...... 141 Table 151 - UsPowerCapabilities Object Attributes ...... 143 Table 152 - OfdmaCfgCapabilities Object Attributes ...... 144 Table 153 - DsCapabilitiesGrp Object Associations ...... 145

10 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 154 - DsCapabilities Object Attributes ...... 146 Table 155 - DsPowerCapabilities Object Attributes ...... 148 Table 156 - ToneCapabilities Object Attributes ...... 149 Table 157 - OfdmCfgCapabilities Object Attributes ...... 150 Table 158 - StaticPwCapabilities Object Attributes ...... 150 Table 159 - ChannelReachability Object Attributes ...... 153 Table 160 - BufferMonitoringCapabilities ...... 154 Table 161 - SwImageCapabilities Object Attributes ...... 154 Table 162 - MiscellaneousCapabilities Object Attributes ...... 155 Table 163 - GcpCapabilities Object Attributes ...... 155 Table 164 - RpdCoreRedundancyCapabilities Object Attributes ...... 156 Table 165 - InitializationCapabilities Object Attributes ...... 156 Table 166 - ResetCapabilities Object Attributes ...... 157 Table 167 - PnmCapabilities Object Attributes ...... 157 Table 168 - PnmCapabilities Object Associations ...... 158 Table 169 - UpcCapabilities Object Attributes ...... 158 Table 170 - FdxCapabilities Object Attributes ...... 159 Table 171 - FdxCapabilities Object Associations ...... 159 Table 172 - EchoCancellerCapabilities Object Attributes ...... 160 Table 173 - PmtudCapabilities Object Attributes ...... 161 Table 174 - RdtiCapabilities Object Attributes ...... 162 Table 175 - SpectrumCaptureCapabilities Object Attributes...... 162 Table 176 - SpectrumCaptureCapabilities Object Associations ...... 162 Table 177 - SacCapabilities Object Attributes ...... 162 Table 178 - LogCapabilities Object Attributes ...... 165 Table 179 - NetworkingCapabilities Object Attributes ...... 166 Table 180 - RfmCapabilities Object Attributes ...... 167 Table 181 - RfmCapabilities Object Associations ...... 168 Table 182 - NodeRfPortCapabilities Object Attributes ...... 169 Table 183 - TelemetryCapabilities Object Attributes ...... 170 Table 184 - RpdInfo Object Associations ...... 171 Table 185 - RPD Module Entity Attributes ...... 172 Table 186 - Entity Object Attributes...... 173 Table 187 - Entity Object Associations ...... 173 Table 188 - Sensor Object Attributes ...... 177 Table 189 - IfEnet Object Attributes ...... 179 Table 190 - IfEnetStats Object Attributes ...... 182 Table 191 - SfpPlusStatus Object Attributes ...... 184 Table 192 - RpdEnetToCoreEntityMap Object Attributes ...... 194 Table 193 - CoreToRpdMap Object Attributes ...... 195 Table 194 - RpdToCoreMap Object Attributes ...... 196 Table 195 - SyncEPortStatus Object Attributes ...... 197 Table 196 - RfmStatus Object Attributes ...... 197 Table 197 - RpdInfo Object Associations ...... 200

 09/03/21 CableLabs 11 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 198 - IpInterfaceGrp Object Attributes ...... 200 Table 199 - IpInterfaceGrp Object Associations ...... 200 Table 200 - IpInterface Object Attributes ...... 201 Table 201 - Ipv6Interface Object Attributes ...... 201 Table 202 - IpIfStats Object Attributes ...... 202 Table 203 - IpAddress Object Attributes ...... 204 Table 204 - IpAddress Object Associations...... 205 Table 205 - IpNetToPhysical Object Attributes ...... 207 Table 206 - IpDefaultRouter Object Attributes ...... 208 Table 207 - IcmpMsgStats Object Attributes ...... 209 Table 208 - RpdInfo Object Associations ...... 210 Table 209 - RpdPtpStatus Object Associations ...... 211 Table 210 - RpdPtpPortStatus Object Attributes ...... 211 Table 211 - RpdPtpPortStatus Object Associations ...... 211 Table 212 - RpdSyncEClockStatus Object Attributes ...... 211 Table 213 - CcapCore Object Associations ...... 213 Table 214 - CcapL2tpSessionInfo Object Attributes ...... 213 Table 215 - CcapL2tpSessionInfo Object Associations ...... 213 Table 216 - SessionInfo Object Attributes...... 214 Table 217 - RpdIfMtu Values ...... 216 Table 218 - CoreIfMtu Values ...... 216 Table 219 - CcapL2tpSessionFlow Object Attributes ...... 217 Table 220 - CcapL2tpSessionFlow Object Associations ...... 217 Table 221 - CcapSessionStats Object Attributes ...... 218 Table 222 - CinDsLatency Object Attributes ...... 219 Table 223 - SessionCinDsLatencyStats Object Attributes ...... 219 Table 224 - CwToneStatus Object Attributes ...... 220 Table 225 - CcapTrfStats Object Attributes ...... 220 Table 226 - CcapLcceStats Object Attributes ...... 221 Table 227 - CcapCurrentControlConnections Object Attributes ...... 222 Table 228 - CcapCore Object Associations ...... 224 Table 229 - CcapPtpStatus Object Associations ...... 225 Table 230 - PtpDefaultDataset Object Attributes ...... 225 Table 231 - PtpCurrentDataset Object Attributes ...... 226 Table 232 - PtpParentDataset Object Attributes ...... 227 Table 233 - PtpTimeProperties Object Attributes ...... 228 Table 234 - PtpPortDataset Object Attributes ...... 229 Table 235 - PtpClockStatus Object Attributes ...... 230 Table 236 - PtpPortStatus Object Attributes ...... 231 Table 237 - CorePtpPortStatus Object Attributes ...... 231 Table 238 - CorePtpPortStatus Object Associations ...... 231 Table 239 - PtpPortMasterClockStatus Object Attributes ...... 232 Table 240 - New CmtsCmRegStatus Object Attributes...... 235 Table 241 - New CmtsCmRegStatus Object Associations ...... 235

12 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 242 - CcapRpdToCmMapStatus Object Attributes ...... 236 Table 243 - RpdInfo Object Associations ...... 237 Table 244 - RpdDsInterfaceStats Object Attributes ...... 238 Table 245 - DsScQamPerfStats Object Attributes ...... 239 Table 246 - DsOfdmPerfStats Object Attributes ...... 239 Table 247 - DsOfdmPerfStats Object Associations ...... 239 Table 248 - DsOfdmProfilePerfStats Object Attributes ...... 240 Table 249 - DsOob551PerfStats Object Attributes ...... 240 Table 250 - DsOob552PerfStats Object Attributes ...... 241 Table 251 - DsNdfPerfStats Object Attributes ...... 241 Table 252 - RpdUsInterfaceStats Object Attributes ...... 242 Table 253 - UsScQamChanPerfStats Object Attributes ...... 243 Table 254 - UsScQamChanPerfStats Object Associations ...... 243 Table 255 - UsOfdmaChanPerfStats Object Attributes ...... 243 Table 256 - UsOfdmaChanPerfStats Object Associations ...... 244 Table 257 - RpdUsInterfaceLowIucStats Object Attributes ...... 244 Table 258 - RpdUsInterfaceHighIucStats Object Attributes ...... 245 Table 259 - UsOfdmaEcStatus Object Attributes ...... 246 Table 260 - RpdUsScQamIucStats Object Attributes ...... 247 Table 261 - RpdUsOfdmaIucStats Object Attributes ...... 248 Table 262 - UsOfdmaHighIucPerfStats Object Attributes ...... 248 Table 263 - UsOob552PerfStats Object Attributes ...... 248 Table 264 - UsNdrPerfStats Object Attributes ...... 250 Table 265 - UsOfdmaChannelStatus New Object Association ...... 251 Table 266 - CcapUsOfdmaFdxEcStatus Object Attributes ...... 251 Table 267 - StreamingTelemetryStatus Object Associations ...... 253 Table 268 - TelemetryClientConnectionStatus Object Attributes ...... 253 Table 269 - RPD Default Event Reporting Mechanism Versus Priority ...... 258 Table 270 - Event Priorities Assignment ...... 259 Table 271 - RpdInfo Object Associations ...... 261 Table 272 - Event Object Attributes ...... 261 Table 273 - System LED Operation ...... 263 Table 274 - CIN LED Operation ...... 263 Table 275 - D-RF LEDs ...... 264 Table 276 - U-RF LED Operation ...... 264 Table 277 - CableLabs R-PHY MIBs ...... 265 Table 278 - CCAP Core ifStack Table Representation...... 274 Table 279 - ifTable/ifXTable for RF and DOCSIS Interfaces ...... 275 Table 280 - IfTable/IfXTable for RPHY Interfaces ...... 276 Table 281 - entPhysicalTable Requirements ...... 276 Table 282 - DOCS-IF-MIB Reporting Requirements...... 278 Table 283 - DOCS-IF3-MIB Reporting Requirements...... 280 Table 284 - DOCS-IF31-MIB Reporting Requirements...... 280 Table 285 - CcapCore Object Associations ...... 287

 09/03/21 CableLabs 13 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 286 - CaCert Object Attributes ...... 287 Table 287 - ServerCert Object Attributes ...... 289 Table 288 - ProvisionedDeviceCertTrust Object Attributes ...... 290 Table 289 - RpdInfo Object Associations ...... 291 Table 290 - RpdCert Object Attributes ...... 291 Table 291 - TrustAnchorCert Object Attributes ...... 292 Table 292 - Ieee8021xPaeSupplicantStatus Object Attributes ...... 292 Table 293 - MIB Implementation Support...... 293 Table 294 - SNMP Access Requirements ...... 293 Table 295 - CCAP Core MIB Object Details ...... 293 Table 296 - DOCS-RPHY-MIB CCAP Core Object Details ...... 294 Table 297 - DOCS-RPHY-CTRL-MIB Object Details ...... 309 Table 298 - DOCS-RPHY-PTP-MIB Object Details ...... 310 Table 299 - DOCS-RPHY-STATS-MIB Object Details ...... 313 Table 300 - DOCS-RPHY-SEC-MIB Object Details ...... 316 Table 301 - CCAP Core Event Format and Content ...... 319 Table 302 - RPD Event Format and Content ...... 322 Table 303 - Deprecated Events ...... 340 Table 304 - General Data Types ...... 343 Table 305 - Primitive Data Types ...... 344 Table 306 - Extended Data Types...... 345 Table 307 - Derived Data Types ...... 345 Table 308 - Shortened Common Terms ...... 346

14 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

1 SCOPE

1.1 Introduction and Purpose

This document describes the Operations Support System Interface (OSSI) for the Modular Headend Architecture version 2 (MHAv2). MHAv2 is initially targeted to permit a CMTS to support an IP-based digital HFC plant. In an IP-based digital HFC plant, the fiber portion utilizes a baseband network transmission technology such as Ethernet, EPON (Ethernet Passive Optical Network), GPON (Gigabit Passive Optical Network), or any layer 2 technology that would support a fiber-based layer 1. MHAv2 uses a layer 3 pseudowire between a CCAP Core and a series of Remote PHY devices. One of the common locations for a Remote PHY device is at an optical node at the junction of the fiber and coax plants.

1.2 MHAv2 Interface Documents

A list of the documents in the MHAv2 family of specifications is provided below. For updates, refer to https://www.cablelabs.com/specifications Project Category: DOCSIS, Subcategory: MHAv2.

Designation Title [R-PHY] Remote PHY Specification [R-DEPI] Remote Downstream External PHY Interface Specification [R-UEPI] Remote Upstream External PHY Interface Specification [GCP] Generic Control Plane Specification [R-DTI] Remote DOCSIS Timing Interface Specification [R-OOB] Remote Out-of-Band Specification R-OSSI (this document) Remote PHY Operations Support System Interface Specification

MHAv2 does not explicitly use the DTI specification or any of the MHA specifications.

1.3 Requirements

Throughout this document, the words that are used to define the significance of particular requirements are capitalized. These words are:

"MUST" This word means that the item is an absolute requirement of this specification. "MUST NOT" This phrase means that the item is an absolute prohibition of this specification. "SHOULD" This word means that there may exist valid reasons in particular circumstances to ignore this item, but the full implications should be understood and the case carefully weighed before choosing a different course. "SHOULD NOT" This phrase means that there may exist valid reasons in particular circumstances when the listed behavior is acceptable or even useful, but the full implications should be understood and the case carefully weighed before implementing any behavior described with this label. "MAY" This word means that this item is truly optional. One vendor may choose to include the item because a particular marketplace requires it or because it enhances the product, for example; another vendor may omit the same item. This document defines many features and parameters, and a valid range for each parameter is usually specified. Equipment (CCAP Core and RPD) requirements are always explicitly stated. Equipment complying with all mandatory (MUST and MUST NOT) requirements is considered compliant with this specification. Support of non- mandatory features and parameter values is optional.

 09/03/21 CableLabs 15 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

1.4 Conventions

In this specification the following convention applies any time a bit field is displayed in a figure. The bit field should be interpreted by reading the figure from left to right, then from top to bottom, with the MSB being the first bit so read and the LSB being the last bit so read.

MIB syntax, XML Schema and YANG module syntax are represented by this code sample font. NOTE: Notices and/or Warnings are identified by this style font and label.

1.4.1 GCP TLVs This document defines Information Model elements that often map to GCP TLVs. Refer to Annex B of [R-PHY] for the definition of GCP TLVs. For Information Model elements which map to GCP TLVs, a “TLV Type” column is added to the object (class) attribute table to list the mapping. Refer to [R-PHY] for details on each TLV definition. As an extension to Annex B of [R-PHY], this document fully defines all 100x TLV types, with a listing of these TLVs included in Annex B of [R-PHY]. For 100.x TLV definitions, the Information Model attribute definition in combination with the “TLV Type” column entry and “TLV Value Field Length” column entry provide for the full definition of the TLV.

1.5 Organization of Document

Section 1 provides an overview of the MHAv2 Remote PHY OSS specification including a list of the MHAv2 family of specifications. Section 2 includes a list of normative and informative references used within this specification. Section 3 defines the terms used throughout this specification. Section 4 defines the acronyms and namespaces used throughout this specification. Section 5 provides an introduction to the FCAPS Network Management Model, which forms the organizational structure of this specification. In order to provide a more logical flow, one that mirrors processes in place at MSOs, the order of functions has been shifted, and is organized as CPAF: • Configuration Management • Performance Management • Accounting Management • Fault Management • Security Management Key features for each management function are provided along with a high-level MHAv2 management architectural view. An introduction to the concept of Information Models and Data Models is also provided. Section 6 defines the Configuration Management functions of the CCAP Core and RPD including theory of operation, network management protocols and Information Models. Section 7 defines the Performance Management functions of the CCAP Core and RPD including Information Models. Section 8 defines the Accounting Management functions of the CCAP Core and RPD. Section 9 defines the Fault Management functions of the CCAP Core and RPD including network management protocols, event reporting requirements, RPD event reporting scenarios, Information Models and RPD LED Indicators. Section 10 defines CCAP Core and RPD SNMP Protocol and MIB data model requirements.

16 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Section 11 defines RPD Security Management functions for the CCAP Core and RPD including SSH and Certification Management.

1.5.1 Annexes (Normative) Annex A includes a detailed list of MIB object requirements for the CCAP Core and RPD that support SNMP. Annex B describes the format and content for Event, SYSLOG, and SNMP Notification. Annex C describes the Data Type Definitions used in both the Information Models and data models.

1.5.2 Appendices (Informative) Appendix I listed the acknowledgements for authoring this specification. Appendix II contains the revision history.

 09/03/21 CableLabs 17 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

2 REFERENCES

2.1 Normative References

In order to claim compliance with this specification, it is necessary to conform to the following standards and other works as indicated, in addition to the other requirements of this specification. Notwithstanding, intellectual property rights may be required to use or implement such normative references.

[CANN] CableLabs Assigned Names and Numbers, CL-SP-CANN-I20-200715, July 15, 2020, Cable Television Laboratories, Inc. [CCAP-CORE- CCAP Core YANG Configuration Module, [email protected], CONFIG-YANG] http://www.cablelabs.com/YANG/DOCSIS/rphy/. [CCAP-EVENTS- CCAP YANG Module for Event Messaging, CCAPevents.yang, YANG] http://www.cablelabs.com/YANG/DOCSIS. [CCAP-OSSIv4.0] DOCSIS 4.0 CCAP Operations Support System Interface Specification, CM-SP-CCAP-OSSIv4.0-I04- 210521, May 21, 2021, Cable Television Laboratories, Inc. [DOCS-IF3-MIB] DOCSIS Interface 3 MIB Module, DOCS-IF3-MIB, http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-IF31-MIB] DOCSIS Interface 3.1 MIB Module, DOCS-IF31-MIB, http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-PNM-MIB] DOCSIS PNM MIB Module, DOCS-PNM-MIB, http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-RPHY-CTRL- DOCSIS Remote PHY Control MIB Module, DOCS-RPHY-CTRL-MIB, MIB] http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-RPHY-MIB] DOCSIS Remote PHY MIB Module, DOCS-RPHY-MIB, http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-RPHY-PTP- DOCSIS Remote PHY PTP MIB Module, DOCS-RPHY-PTP-MIB, MIB] http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-RPHY-SEC- DOCSIS Remote PHY Security MIB Module, DOCS-RPHY-SEC-MIB, MIB] http://www.cablelabs.com/MIBs/DOCSIS/. [DOCS-RPHY-STATS- DOCSIS Remote PHY Statistics MIB Module, DOCS-RPHY-STATS-MIB, MIB] http://www.cablelabs.com/MIBs/DOCSIS/. [FIPS-46-3] Federal Information Processing Standards Publications 46-3, Data Encryption Standard (DES), October 25, 1999, http://csrc.nist.gov/publications/fips/archive/fips46-3/fips46-3.pdf. [FIPS-180-4] Federal Information Processing Standards Publications 180-4, Secure Hash Standard, August 2015. [FIPS-197] Federal Information Processing Standards Publications 197, Specification for the Advanced Encryption Standard (AES), November 26, 2001. [GCP] Generic Control Plane Specification, CM-SP-GCP-I05-200323, March 23, 2020, Cable Television Laboratories, Inc. [gNMI] gRPC Network Management Interface. https://github.com/openconfig/reference/tree/master/rpc/gnmi [GPB] Google Protocol Buffers. https://developers.google.com/protocol-buffers [gRPC] A modern, open source, high-performance remote procedure call (RPC) framework. https://grpc.io/ [IEEE 1588] IEEE Std 1588-2008, IEEE Standard for a Precision Clock Synchronization Protocol for Networked Measurement and Control Systems, July 2008. [ISO 6709] ISO 6709:2008, Standard representation of geographic point location by coordinates. [MULPIv3.1] DOCSIS 3.1 MAC and Upper Layer Protocols Interface Specification, CM-SP-MULPIv3.1-I21- 201020, October 20, 2020, Cable Television Laboratories, Inc. [MULPIv4.0] MAC and Upper Layer Protocols Interface Specification, CM-SP-MULPIv4.0-I04-210826, August 26, 2021, Cable Television Laboratories, Inc. [PHYv4.0] DOCSIS 4.0, Physical Layer Specification, CM-SP-PHYv4.0-I04-210826, August 26, 2021, Cable Television Laboratories, Inc. [R-DEPI] Remote Downstream External PHY Interface Specification, CM-SP-R-DEPI-I16-210804, August 4, 2021, Cable Television Laboratories, Inc. [R-DTI] Remote DOCSIS Timing Interface Specification, CM-SP-R-DTI-I08-200323, March 23, 2020, Cable Television Laboratories, Inc. [RFC 2578] IETF RFC 2578, Structure of Management Information Version 2 (SMIv2), April 1999. [RFC 2790] IETF RFC 2790, Host Resources MIB, March 2000. [RFC 2856] IETF RFC 2856, Textual Conventions for Additional High Capacity Data Types, June 2000. [RFC 2863] IETF RFC 2863, The Interfaces Group MIB, June 2000.

18 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

[RFC 3164] IETF RFC 3164, The BSD Syslog Protocol, August 2001. [RFC 3418] IETF RFC 3418/STD0062, Management Information Base (MIB) for the Simple Network Management Protocol (SNMP), December 2002. [RFC 3433] IETF RFC 3433, Entity Sensor Management Information Base, December 2002. [RFC 3635] IETF RFC 3635, Definitions of Managed Objects for the Ethernet-like Interface Types, October 2003. [RFC 3931] IETF RFC 3931, Layer Two Tunneling Protocol - Version 3 (L2TPv3), March 2005. [RFC 3986] IETF RFC 3986, Uniform Resource Identifier (URI): Generic Syntax, January 2005. [RFC 4122] IETF RFC 4122, A Universally Unique IDentifier (UUID) URN Namespace, July 2005. [RFC 4131] IETF RFC 4131, Management Information Base for Data Over Cable Service Interface Specification (DOCSIS) Cable Modems and Cable Modem Termination Systems for Baseline Privacy Plus, September 2005. [RFC 4250] IETF RFC 4250, The Secure Shell (SSH) Protocol Assigned Numbers, January 2006. [RFC 4251] IETF RFC 4251, The Secure Shell (SSH) Protocol Architecture, January 2006. [RFC 4252] IETF RFC 4252, The Secure Shell (SSH) Authentication Protocol, January 2006. [RFC 4253] IETF RFC 4253, The Secure Shell (SSH) Transport Layer Protocol, January 2006. [RFC 4254] IETF RFC 4254, The Secure Shell (SSH) Connection Protocol, January 2006. [RFC 4293] IETF RFC 4293, Management Information Base for the Internet Protocol (IP), April 2006. [RFC 4546] IETF RFC 4546, Radio Frequency (RF) Interface Management Information Base for Data over Cable Service Interface Specifications (DOCSIS) 2.0 Compliant RF Interfaces, June 2006. [RFC 4639] IETF RFC 4639, Cable Device Management Information Base for Data-Over-Cable Service Interface Specification (DOCSIS) Compliant Cable Modems and Cable Modem Termination Systems, December 2006. [RFC 5424] IETF RFC 5424, The Syslog Protocol, March 2009. [RFC 5601] IETF RFC 5601, Pseudowire (PW) Management Information Base (MIB), July 2009. [RFC 5612] IETF RFC 5612, Enterprise Number for Documentation Use, August 2009. [RFC 6668] IETF RFC 6668, SHA-2 Data Integrity Verification for the Secure Shell (SSH) Transport Layer Protocol. [RFC 6933] IETF RFC 6933, Entity MIB (Version 4), May 2013. [RFC 6991] IETF RFC 6991, Common YANG Data Types, July 2013. [RFC 7540] IETF RFC 7540, Hypertext Transfer Protocol Version 2 (HTTP/2), May 2015. [R-OOB] Remote Out-of-Band Specification, CM-SP-R-OOB-I12-200323, March 23, 2020, Cable Television Laboratories, Inc. [R-PHY] Remote PHY System Specification, CM-SP-R-PHY-I16-210804, August 4, 2021, Cable Television Laboratories, Inc. [R-UEPI] Remote Upstream External PHY Interface Specification, CM-SP-R-UEPI-I13-201207, December 7, 2020, Cable Television Laboratories, Inc. [R-YANG] Remote PHY YANG Repository, http://mibs.cablelabs.com/YANG/DOCSIS/RPHY/ [SCTE 55-1] ANSI SCTE 55-1 2009, Digital Broadband Delivery System: Out of Band Transport Part 1: Mode A. [SCTE 154-2] ANSI SCTE 154-2 2008, SCTE-HMS-QAM-MIB. [SCTE 154-5] ANSI SCTE 154-5 2008, SCTE-HMS-HEADENDIDENT TEXTUAL CONVENTIONS MIB. [SECv4.0] DOCSIS 4.0 Security Specification, CM-SP-SECv4.0-I03-210826, August 26, 2021, Cable Television Laboratories, Inc. [SFF 8024] SNIA SFF TWG, SFF-8024 SFF Module Management Reference Code Tables, Rev. 4.8a, April 16, 2021. [SFF 8079] SNIA SFF TWG, SFF-8079 SFP Rate and Application Selection, Rev. 1.7, February 2, 2005. [SFF 8419] SNIA SFF TWG, SFF-8419 SFP+ Power and Low Speed Interface, Rev. 1.3, June 11, 2015. [SFF 8431] SNIA SFF TWG, SFF-8431 SFP+ 10 Gb/s and Low Speed Electrical Interface, Rev. 4.1, July 6, 2009. [SFF 8472] SNIA SFF TWG, SFF-8472 Management Interface for SFP+, Rev 12.4, March 31, 2021. [SYNC] Synchronization Techniques for DOCSIS® Technology Specification, CM-SP-SYNC-I02-210407, April 7, 2021, Cable Television Laboratories, Inc.

 09/03/21 CableLabs 19 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

2.2 Informative References

This specification uses the following informative references.

[CCAP TR] Converged Cable Access Platform Architecture Technical Report, CM-TR-CCAP-V03-120511, May 11, 2012, Cable Television Laboratories, Inc. [DRFI] DOCSIS Downstream RF Interface Specification, CM-SP-DRFI-I16-170111, January 11, 2017, Cable Television Laboratories, Inc. [G.781] ITU-T Recommendation G.781, Synchronization layer functions, August, 2017 [G.8262] ITU-T Recommendation G.8262, Timing characteristics of synchronous Ethernet equipment slave clock, November, 2018. [G.8264] ITU-T Recommendation G.8264, Distribution of timing information through packet networks, August, 2017. [IEEE 802.1x] IEEE Std 802.1x-2010, IEEE Standard for Local and metropolitan area networks--Port-Based Network Access Control, February 2010. [IEEE 802.3x] 802.3x-1997 - IEEE Standards for Local and Metropolitan Area Networks: Specification for 802.3 Full Duplex Operation [ISO 11404] BS ISO/IEC 11404:1996 Information technology--Programming languages, their environments and system software interfaces--Language-independent datatypes, January 2002. [ISO 19501] ISO/IEC 19501:2005, Information technology - Open Distributed Processing - Unified Modeling Language (UML) Version 1.4.2. [ITU-T G.8275.1] ITU-T Recommendation G.8275.1/Y.1369.1, Precision time protocol telecom profile for phase/time synchronization with full timing support from the network. March, 2020 [ITU-T G.8275.2] ITU-T Recommendation G.8275.2/Y.1369.2. Precision time protocol telecom profile for phase/time synchronization with partial timing support from the network. March 2020 [ITU-T X.692] ITU-T Recommendation X.692 (08/2015), Information technology - ASN.1 encoding rules: Specification of Encoding Control Notation (ECN). [ITU-T M.3400] ITU-T Recommendation M.3400 (02/2000): TMN AND Network Maintenance: International Transmission Systems, Telephone Circuits, Telegraphy, Facsimile and Leased Circuits, TMN management functions. [M-OSSI] DOCSIS M-CMTS Operations Support Interface, CM-SP-M-OSSI-I08-081209, December 9, 2008, Cable Television Laboratories, Inc. [NSI] Cable Modem Termination System - Network Side Interface Specification, SP-CMTS-NSI-C01-171207, December 7, 2017, Cable Television Laboratories, Inc. [PMI] Edge QAM Provisioning and Management Interface Specification, CM-SP-EQAM-PMI-I02-111117, November 17, 2011, Cable Television Laboratories, Inc. [RFC 1042] IETF RFC 1042/STD0043, Standard for the transmission of IP datagrams over IEEE 802 networks, February 1988. [RFC 1157] IETF RFC 1157, Simple Network Management Protocol (SNMP), May 1990. [RFC 1191] IETF RFC 1191, Path MTU discovery, November 1990. [RFC 1901] IETF RFC 1901, Introduction to Community-based SNMPv2, January 1996. [RFC 2579] IETF RFC 2579, Textual Conventions for SMIv2, April 1999. [RFC 2580] IETF RFC 2580, Conformance Statements for SMIv2, April 1999. [RFC 3260] IETF RFC 3260, New Terminology and Clarifications for Diffserv, April 2002. [RFC 3339] IETF RFC 3339, Date and Time on the Internet: Timestamps, July 2002. [RFC 3410] IETF RFC 3410, Introduction and Applicability Statements for Internet-Standard Management Framework, December 2002. [RFC 3411] IETF RFC 3411/STD0062, An Architecture for Describing Simple Network Management Protocol (SNMP) Management Frameworks, December 2002. [RFC 3413] IETF RFC 3413, Simple Network Management Protocol (SNMP) Applications, December 2002. [RFC 3415] IETF RFC 3415, View-based Access Control Model (VACM) for the Simple Network Management Protocol (SNMP), December 2002. [RFC 3416] IETF RFC 3416, Version 2 of the Protocol Operations for the Simple Network Management Protocol (SNMP), December 2002. [RFC 3419] IETF RFC 3419, Textual Conventions for Transport Addresses, December 2002. [RFC 4001] IETF RFC 4001, Textual Conventions for Internet Network Addresses, February 2005.

20 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

[RFC 4181] IETF RFC 4181, Guidelines for Authors and Reviewers of MIB Documents, September 2005. [RFC 4821] IETF RFC 4821, Packetization Layer Path MTU Discovery, March 2007. [RFC 6020] IETF RFC 6020, YANG - A data modeling language for the Network Configuration Protocol (NETCONF), October 2010. [RFC 8201] IETF RFC 8201, Path MTU Discovery for IP version 6, July 2017. [UML Modeling UML Modeling Guidelines, CM-GL-OSS-UML-V01-180627, June 27, 2018, Cable Television Guidelines] Laboratories, Inc.

2.3 Reference Acquisition

• Cable Television Laboratories, Inc., 858 Coal Creek Circle, Louisville, CO 80027; Phone +1-303-661-9100; Fax +1-303-661-9199; http://www.cablelabs.com • IANA, Internet Assigned Numbers Authority (IANA); http://www.iana.org • The Institute of Electrical and Electronics Engineers, Inc. (IEEE); http://standards/ieee.org • IETF, Internet Engineering Task Force (IETF) Secretariat, 48377 Fremont Blvd., Suite 117, Fremont, California 94538, USA; Phone: +1-510-492-4080, Fax: +1-510-492-4001; http://www.ietf.org/ • ISO Specifications, International Organization for Standardization (ISO), 1, rue de Varembé, Case postale 56, CH-1211 Geneva 20, Switzerland; Phone +41 22 749 01 11; Fax +41 22 733 34 30; http://www.iso.org • ITU Recommendations, International Telecommunication Union, Place des Nations, CH-1211, Geneva 20, Switzerland; Phone +41-22-730-51-11; Fax +41-22-733-7256; http://www.itu.int • SCTE•ISBE, Society of Cable Telecommunications Engineers Inc., 140 Philips Road, Exton, PA 19341; Phone: 1+610-363-6888 /1+ 800-542-5040; Fax: 1+610-363-5898; http://www.scte.org/ • World Wide Web Consortium (W3C), Massachusetts Institute of Technology, 32 Vassar Street, Room 32- G515, Cambridge, MA 02139; Phone +1-617-253-2613, Fax +1-617-258-5999; http://www.w3.org/Consortium/ • Storage Networking Industry Association, https://www.snia.org/technology-communities/sff/specifications

 09/03/21 CableLabs 21 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

3 TERMS AND DEFINITIONS

This specification uses the following terms:

Aggregation A special type of object association for Configuration Object Models in which objects are assembled or configured together to create a more complex object. Bonded Channels A logical channel comprising multiple individual channels. Bridging CMTS A CMTS that makes traffic forwarding decisions between its Network Systems Interfaces and MAC Domain Interfaces based upon the Layer 2 Ethernet MAC address of a data frame. Cable Modem A modulator-demodulator at subscriber locations intended for use in conveying data communications on a cable television system. Cable Modem An access-side networking element or set of elements that includes one or more MAC Domains Termination System and one or more Network System Interfaces. This unit is located at the cable television system headend or distribution hub and provides data connectivity between a DOCSIS Radio Frequency Interface and a wide-area network. Cable Modem The interface, defined in [NSI], between a CMTS and the equipment on its network side. Termination System - Network Side Interface (CMTS-NSI) Carrier-to-Noise plus The ratio of the expected commanded received signal power at the CMTS input to the noise Interference Ratio (CNIR) plus interference in the channel. CCAP Core A CCAP device which uses MHAv2 protocols to interconnect to R-PHY Entity devices. Channel The frequency spectrum occupied by a signal. Usually specified by center frequency and bandwidth parameters. Command Line Interface A mechanism used to interact with the CCAP by typing text-based commands into a system interface. Configuration Objects Managed objects in the CCAP configuration that support writability. The CCAP is configured by specifying the attributes of these objects. Converged Cable Access An access-side networking element or set of elements that combines the functionality of a Platform CMTS with that of an Edge QAM, providing high-density services to cable subscribers. Converged Interconnect The network (generally gigabit Ethernet) that connects a CCAP Core to an R-PHY Entity. Network Customer Premises Equipment at the end user's premises; may be provided by the service provider. Equipment Downstream 1. Transmissions from CMTS to CM. This includes transmission from the CCAP Core to the RPD, as well as the RF transmissions from the RPD to the CM. 2. RF spectrum used to transmit signals from a cable operator's headend or hub site to subscriber locations. Extensible Markup A universal file format for storing and exchanging structured data. Language FCAPS A set of principles for managing networks and systems, wherein each letter represents one principle. F is for Fault, C is for Configuration, A is for Accounting, P is for Performance, and S is for Security. Flow A stream of packets in DEPI used to transport data of a certain priority from the CCAP Core to a particular QAM channel of the R-PHY Entity. In PSP operation, there can exist several flows per QAM channel. Generalization A relationship in which one configuration model element (the child) is based on another model element (the parent). A generalization relationship indicates that the child receives all of the attributes, operations, and relationships that are defined in the parent. Hybrid Fiber/Coax A broadband bidirectional shared-media transmission system using optical fiber trunks between System the headend and the fiber nodes, and coaxial cable distribution from the fiber nodes to the customer locations. Institute of Electrical and A voluntary organization which, among other things, sponsors standards committees and is Electronic Engineers accredited by the American National Standards Institute (ANSI). Internet Engineering A body responsible for, among other things, developing standards used in the Internet. Task Force Internet Protocol An Internet network-layer protocol.

22 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

L2TP Pseudowire (PW) An emulated circuit as it traverses a packet-switched network. There is one Pseudowire per L2TP Session. L2TP Pseudowire Type The payload type being carried within an L2TP session. Examples include PPP, Ethernet, and Frame Relay. L2TP Session An L2TP session is the entity that is created between two LCCEs in order to exchange parameters for and maintain an emulated L2 connection. Multiple sessions may be associated with a single Control Connection. Lower Camel Case A naming convention where the first letter of each word is capitalized, excluding the first letter of the first word. For example, thisIsAnExample. MAC Domain A grouping of Layer 2 devices that can communicate with each other without using bridging or routing. In DOCSIS, it is the group of CMs that are using upstream and downstream channels linked together through a MAC forwarding entity. MAC Domain Cable The subset of a Cable Modem Service Group which is confined to the Downstream Channels Modem Service Group and Upstream Channels of a single MAC domain. Differs from a CM-SG only if multiple MAC domains are assigned to the same CM-SGs. Management Functions on the CCAP that monitor for faults and for overall system performance, including traps and alarms. Management Information A database of device configuration and performance information which is acted upon by SNMP. Base Media Access Control Used to refer to the Layer 2 element of the system which would include DOCSIS framing and signaling. Multiple System Operator A corporate entity that owns and/or operates more than one cable system. Network Configuration An IETF network management protocol that provides mechanisms to manipulate the Protocol configuration of a device, commonly referred to as NETCONF. NETCONF executes YANG- based XML files containing configuration objects. Null MAC address A MAC address consisting of all zeroes. Open Systems A framework of ISO standards for communication between different systems made by different Interconnection (OSI) vendors, in which the communications process is organized into seven different categories that are placed in a layered sequence based on their relationship to the user. Each layer uses the layer immediately below it and provides a service to the layer above. Layers 7 through 4 deal with end-to-end communication between the message source and destination, and layers 3 through 1 deal with network functions. Physical (PHY) Layer Layer 1 in the Open System Interconnection (OSI) architecture; the layer that provides services to transmit bits or groups of bits over a transmission link between open systems and which entails electrical, mechanical and handshaking procedures. Precision Time Protocol A protocol used to synchronize clocks throughout a network. Protocol Buffers A language-neutral, platform-neutral, extensible mechanism for serializing structured data. (protobuf) (https://developers.google.com/protocol-buffers) Quadrature Amplitude A modulation technique in which an analog signal's amplitude and phase vary to convey Modulation information, such as digital data. QAM Channel Analog RF channel that uses quadrature amplitude modulation (QAM) to convey information. Radio Frequency In cable television systems, this refers to electromagnetic signals in the range 5 to 1000 MHz. Remote PHY Device The Remote PHY Device contains mainly PHY related circuitry, such as downstream QAM modulators, upstream QAM demodulators, and pseudowire logic to connect to the CCAP Core. Together, the CCAP Core and the R-PHY Entity are the functional equivalent of an I-CMTS (Integrated CMTS), just with different packaging. Request for Comments A technical policy document of the IETF; these documents can be accessed at http://www.rfc- editor.org/. RESTCONF An HTTP-based protocol that provides a programmatic interface for accessing data defined in YANG, using the datastore concepts defined in the Network Configuration Protocol (NETCONF). Routing CMTS A CMTS that makes traffic forwarding decisions between its Network System Interfaces and MAC Domain Interfaces based upon the Layer 3 (network) address of a packet. Running-config Configuration objects that control CCAP behavior, along with any vendor-proprietary configurations. Secure Copy Protocol A secure file transfer protocol based on Secure Shell (SSH). Simple Network Allows a host to query modules for network-related statistics and error conditions. Management Protocol

 09/03/21 CableLabs 23 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Specialization A relationship in which one configuration model element (the parent) is used to model another element (the child). The specialized child element receives all of the attributes, operations, and relationships that are defined in the parent and defines additional attributes, operations and relationships that enable its specialized behavior. Startup-config The configuration objects stored in non-volatile memory. Streaming Telemetry The transmission of Telemetry via a streaming transport protocol from remote points or systems to receiving systems. Telemetry The automatic recording and transmission of measurements/data from remote points/systems to receiving systems (in different locations) for monitoring and analysis. Upper Camel Case A naming convention where the first letter of each word is capitalized, including the first letter of the first word. For example, ThisIsAnExample. Upstream 1. Transmissions from CM to CCAP. This includes transmission from the RPD to the CCAP Core, as well as the RF transmissions from the CM to the RPD. 2. RF spectrum used to transmit signals from a subscriber location to a cable operator's headend or hub site. X.509 ITU-T Recommendation standard for a public key infrastructure (PKI) for single sign-on (SSO) and Privilege Management Infrastructure (PMI). YANG A data modeling language used to model configuration data, state data, Remote Procedure Calls, and notifications for network management protocols.

24 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

4 ABBREVIATIONS, ACRONYMS, AND NAMESPACES

This specification uses the following abbreviations:

AAA Network Authentication, Authorization, and Accounting ARPD Advanced Return Path Demodulator AVP Attribute Value Pair BCG Broadcast Channel Group BDR Broadcast Downstream Resource BPI Baseline Privacy Interface BSS Business Support Systems CA Certificate Authority CCAP Converged Cable Access Platform CCID Control Connection Identifier CIN Converged Interconnect Network CLI Command Line Interface CM Cable Modem CMTS Cable Modem Termination System CPAF Configuration, Performance, Accounting, Fault Management CPE Customer Premises Equipment CRL Certificate Revocation List CW Codeword or Continuous Wave DEPI Downstream External PHY Interface DHCP Dynamic Host Configuration Protocol DPoE DOCSIS Provisioning of EPON DS Downstream DSID Downstream Service ID DTI DOCSIS Timing Interface DTU DEPI Tunnel Update EAP Extensible Authentication Protocol EC Echo Canceler ECT Echo Canceler Training ECTO Echo Canceler Training Opportunity EEC Ethernet Equipment Clock EPON Ethernet Passive Optical Network EQAM Edge QAM ERM Edge Resource Manager ERMI Edge Resource Manager Interface FCAPS Fault, Configuration, Accounting, Performance and Security FEC Forward Error Correction FQDN Fully Qualified Domain Name FRU Field Replaceable Unit GCP Generic Control Plane gNMI gRPC Network Management Interface GPB Google Protocol Buffers gRPC gRPC Remote Procedure Calls HA High Availability HC High Capacity HFC Hybrid Fiber/Coax System

 09/03/21 CableLabs 25 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

HTTP Hypertext Transfer Protocol HTTP/2 Hypertext Transfer Protocol Version 2 HTTPS Secure Hypertext Transfer Protocol I-CCAP Integrated CCAP I-CMTS Integrated CMTS IUC Interval Usage Code IEEE Institute of Electrical and Electronic Engineers IETF Internet Engineering Task Force IP Internet Protocol IRA Identification and Resource Advertising ITU International Telecommunication Union L2VPN Layer 2 Virtual Private Network LCC Lower Camel Case LCCE L2TP Control Connection Endpoint MAC Media Access Control MBH Mobile BackHaul MD-CM-SG Media Access Control Domain Cable Modem Service Group MER Modulation Error Ratio MHA Modular Headend Architecture MIB Management Information Base MMM MAC Management Message MPEG Moving Picture Experts Group MPEG-TS Moving Picture Experts Group-Transport Stream MPT MPEG-TS mode of DEPI MSI Main Software Image MSO Multiple System Operator MTU Maximum Transmission Unit NDF Narrowband Digital Forwarding NDR Narrowband Digital Return NETCONF Network Configuration Protocol NMS Network Management System NSI Network Side Interface OFDM Orthogonal Frequency Division Multiplexing OFDMA Orthogonal Frequency Division Multiplexing with Multiple Access OM Object Model (Information Model) OOB Out-of-Band OOS Out-of-Service OSS Operations Support System OSSI Operations Support System Interface OUI Organization Unique Identifier PAE Port Access Entity PACP Port Access Controller Protocol PDU Protocol Data Unit PHY Physical Layer PLC Phy Link Channel PMTUD Path MTU Discovery PTP Precision Time Protocol PW Pseudowire QAM Quadrature Amplitude Modulation

26 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

QoS Quality of Service QPSK Quadrature Phase Shift Keying RCP Remote PHY Control Protocol R-DTI Remote DOCSIS Timing Interface RF Radio Frequency RFC Request for Comments RFM RF Module RPD Remote PHY Device RPN Remote PHY Node RPS Remote PHY Shelf R-PHY Remote PHY SAC Spectrum Analysis Circuit SCCRQ L2TPv3 Start-Control-Connection-Request message SC-QAM Single-Carrier QAM SFP/SFP+ Small form-factor pluggable transceiver / Enhanced small form-factor pluggable transceiver SG Service Group SID Service Identifier SMIv2 Structure of Management Information Version 2 SNMP Simple Network Management Protocol SNMPv1 Version 1 of the Simple Network Management Protocol SNMPv2 Version 2 of the Simple Network Management Protocol SNMPv3 Version 3 of the Simple Network Management Protocol SSD Secure Software Download SSH Secure Shell SSM Source Specific Multicast ST2 STratum 2 (Clock Accuracy Level) ST3 STratum 3 (Clock Accuracy Level) ST3E STratum 3 Enhanced STP Spanning Tree Protocol SYNCEDNU Do Not Use (SyncE Quality Level) SYNCEDUS Do not Use for Sync (SyncE Quality Level) SYNCEPRC Primary Reference Clock SYNCEPRS Primary Reference Source SYNCEQL Quality Level (SyncE) SYNCESU Synchronization Supply Unit (SyncE) SYNCESSU-A Primary Level SSU SYNCESSU-B Secondary Level SSU SYNCESTU Synchronization Traceability Unknown (SyncE) SYNCE Synchronous Ethernet SYNCETNC Transit Node Clock (SyncE) TCP Transmission Control Protocol TFTP Trivial File Transfer Protocol TLV Type Length Value Attribute ToD Time of Day TRF Tunnel Recovery and Failover TS Transport Stream UCD Upstream Channel Descriptor UDP User Datagram Protocol UML Unified Modeling Language

 09/03/21 CableLabs 27 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

UPC Upstream Probe Capture, Upstream Capture of Active and Quiet Probes URL Uniform Resource Locator US Upstream UTID Universal Tunnel Identifier VLAN Virtual Local Area Network XML Extensible Markup Language XSD XML Schema Definition YANG Yet Another Next Generation (modeling language)

28 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

5 OVERVIEW

5.1 FCAPS Network Management Model

The International Telecommunication Union (ITU) Recommendation [ITU-T M.3400] defines a set of management categories, referred to as the FCAPS model, represented by the individual management categories of Fault, Configuration, Accounting, Performance and Security. Telecommunications operators, including MSOs, commonly use this model to manage large networks of devices. This specification uses these management categories to organize the requirements for the configuration and management of the Remote PHY platform. Fault management seeks to identify, isolate, correct and record system faults. Configuration management modifies system configuration variables and collects configuration information. Accounting management collects usage statistics for subscribers, sets usage quotas and bills users according to their use of the system. Performance management focuses on the collection of performance metrics, analysis of these metrics and the setting of thresholds and rate limits. Security management encompasses identification and authorization of users and equipment, provides audit logs and alerting functions, as well as providing vulnerability assessment. Each of these management categories is discussed in further detail in [CCAP-OSSIv4.0].

5.2 Management Architectural Overview

Figure 1 provides an overview of the Remote PHY management architecture. More detail of the Remote PHY management architecture is provided in this section.

Figure 1 - Remote PHY Management Overview

The Remote PHY Component Diagram in Figure 2 illustrates a more detailed Remote PHY management architecture including management interfaces shown in Figure 1 and logical components of the MSO Backoffice,

 09/03/21 CableLabs 29 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

CCAP Core, and RPD. Refer to [CCAP-OSSIv4.0] for descriptions of the architectural components and interfaces common to both the CCAP and CCAP Core. Refer to the R-PHY specification [R-PHY] for the R-PHY System Diagram and MHAv2 Reference Architecture.

Figure 2 - Remote PHY Management Component Diagram

30 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The Remote PHY Device (RPD) and CCAP Core reside within the Network Layer where services are provided to end Subscribers and various metrics are collected about network and service performance, among other things. Referring to the architecture in Figure 2 from the bottom up, the Remote PHY Device (RPD) resides at the bottom of the Network Layer stack. An RPD has managed resources that are accessed through different types of management interfaces. A resource may be managed ("via proxy") through the CCAP Core over the R-PHY Control Protocol (RCP) [R-PHY] using the Generic Control Plane encapsulation protocol [GCP] ("CcapCore-Rpd interface"). A resource may be managed via an SSH interface (refer to Section 11.1) to the RPD for vendor-specific CLI management actions ("Oss-Rpd interface"). A Telemetry resource may be managed and streamed via the Telemetry interface ("Oss-Rpd interface"). Refer to [R-PHY] for additional details on RPHY Streaming Telemetry components and interfaces relevant to the RPD. The RPD YANG Data Models component represents the set of data models containing groupings of managed objects which enable the back office and the CCAP Core to manage, administer, monitor, and provision the RPD. RPD YANG data models [R-YANG] include the RPD managed resources which enable the back office and the CCAP Core to manage aspects of the RPD, and models for Telemetry measurement data. Next, a CCAP Core sits at the top of the Network Layer stack and has three types of management resources: 1) a DOCSIS CCAP-Specific Resource that manages resources such as those in an I-CCAP (as defined in the DOCSIS 4.0 CCAP information model), 2) an RPD Proxy Resource that resides on an RPD device but is mirrored on a CCAP Core, and 3) an RPHY CCAP Core-Related Resource that is specified in this document as CCAP Core resources needed for the R-PHY architecture. The CCAP Core provides various back office management interfaces, as specified in [CCAP-OSSIv4.0] ("Oss-CcapCore interface"), and utilizes the RCP interface of the RPD for Proxy resources ("CcapCore-Rpd interface"). Finally, the Network Support Services, a component of the Back Office Systems, resides in the Network Management Layer and has a representation of all CCAP Core and RPD-managed resources, i.e., Management Data Models. The Network Management Applications Southbound Interface utilizes the CCAP Core Northbound Interface management interfaces ("Oss-CcapCore interface") for resources within the CCAP Core and an SSH or Streaming Telemetry interface for RPD resources not managed by the CCAP Core ("Oss-Rpd interface"). From the Back Office Systems point of view, there are no separate DOCSIS CCAP Core resources for CCAP, RPD Proxy, and CCAP Core RPHY-Related resources because the CCAP Core abstracts these into a unified view, shown as CCAP Core Managed Objects in Figure 2. The CCAP Core implements the managed objects in the data models support by the CCAP Core. The layered stack shown in Figure 2 represents a model-driven architecture for the management of RPHY network devices.

5.3 Remote PHY OSSI Key Features

The primary goals of the Remote PHY OSSI are: • Ensure that existing management interfaces on the CCAP are supported transparently to the NMS. • Ensure that the RPD can be configured and managed both indirectly via the CCAP Core and, when necessary, directly. Table 1 - Management Feature Requirements for Remote PHY

Features Management OSI Layer Description Functional Area RPD Configuration Configuration PHY, Data Link Provisioning physical downstream and upstream interfaces and other features on the RPD indirectly via the CCAP Core. CCAP Core Remote PHY Configuration PHY, Data Link Configuration of the Remote PHY feature set Configuration and the RPD on the CCAP Core. RPD Fault Detection Fault PHY, Network Remote PHY Device fault definition and detection CCAP Core Remote PHY Fault Fault PHY, Network Detection of faults related to the Remote PHY Detection feature set on the CCAP Core.

 09/03/21 CableLabs 31 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Features Management OSI Layer Description Functional Area RPD Performance/Status Performance PHY, Network Interface for a management agent on the RPD to communicate non-DOCSIS performance and status information. RPD Telemetry Performance Network Interface for back office to collect Telemetry directly from the RPD. CCAP Core Performance/Status Performance PHY, Network Monitoring of the DOCSIS Phy (indirectly via the RPD) and direct monitoring of non-DOCSIS performance and status information related to the Remote PHY feature set. CCAP Core Telemetry Performance Network Interface for back office to collect Telemetry directly from the CCAP Core.

5.3.1 Fault Management Features The Remote PHY Fault Management requirements include: • Extended lists of events related to the new set of Remote PHY features for both the CCAP Core and RPD. • Management requirements for the RPD to be managed directly, including an SNMP management agent (and associated MIBs) required on the RPD itself. • Remote PHY Device (RPD) fault management requirements. • Ensuring that existing faults defined for the CCAP function transparently in a Remote PHY environment.

5.3.2 Configuration Management Features The configuration of the RPD by the CCAP Core is defined in this specification. The reporting of configuration state and status information is done via SNMP MIB objects. Configuration of features and functions of the CCAP is performed via vendor-proprietary mechanisms or via NETCONF if supported. The Remote PHY configuration requirements include: • Configuration management of the CCAP Core as it relates to the Remote PHY Device and Remote PHY features. • Configuration management of the Remote PHY by the CCAP Core.

5.3.3 Performance Management Features The Remote PHY performance management requirements include: • Non-DOCSIS performance management objects defined on the RPD and CCAP Core to monitor the performance and status of the Remote PHY feature. • Ensuring that existing performance management objects defined for the CCAP function transparently in a Remote PHY environment. • The CCAP Core controls and facilitates the Secure Software Download (SSD) for the RPD. • Back office collection of CCAP Core and RPD Telemetry data

5.3.3.1 Streaming Telemetry Refer to [R-PHY] for details on the Remote PHY Streaming Telemetry description, components, interfaces and protocols. Figure 3 provides a view of the Remote PHY Streaming Telemetry management architecture, including the corresponding components, as a more detailed view into the management architecture defined in Figure 1.

32 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 3 - Remote PHY Streaming Telemetry Management Architecture

The Remote PHY Streaming Telemetry management architecture components are described below: • Network Support Services Network Support Services represents the different network management applications in the operator's back office. Since Streaming Telemetry is based on subscription to the monitored data via the monitored, or target, device's YANG model, the Network Support Services support configuration of the Streaming Telemetry subscriptions, in addition to Telemetry Server operational configuration within the target device's configuration, and a YANG model for the telemetry measurements streamed from the monitored devices. The Telemetry Client is responsible for subscription and collection of Telemetry data from the monitored devices.

The Telemetry Client in the Network Support Services represents only the first stage of the Telemetry data processing pipeline within the operator's Streaming Telemetry back office system. This specification focuses on the definition of the OSS interface and streaming of Telemetry measurements from both the CCAP Core and the RPD to the Network Support Services Telemetry Client. Refer to [R-PHY] for additional details on the RPD Streaming Telemetry specifications. Any further data processing steps after the collection, such as how telemetry measurements are stored, how they are further distributed for analysis

 09/03/21 CableLabs 33 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

or archiving, the data analysis, the visualization, or the operational outcomes are outside of the scope of this specification. • CCAP Core The CCAP Core is a monitored, or target, network element. The CCAP Core implements a YANG model for the Network Support Services to configure the Streaming Telemetry subscriptions and operation. The Telemetry Server in the CCAP Core Northbound Interface accepts subscription configuration from the Network Support Services Telemetry Client via the Oss-CcapCore interface. In the context of Streaming Telemetry, the Oss-CcapCore interface between the Telemetry Client and Telemetry Server is realized using gNMI/gRPC/HTTP/2 protocols. The CCAP Core provisions the Streaming Telemetry Client and operational information for the RPD's Telemetry Server via the CcapCore-Rpd interface using the RCP/GCP protocol. • Remote PHY Device The RPD is a monitored, or target, network element. The RPD receives configuration of Telemetry Client and Telemetry Server operational information from the CCAP Core, via the CcapCore-Rpd interface using the RCP/GCP protocol. The Telemetry Server in the RPD receives configuration of Telemetry Subscriptions from the Telemetry Client in the Network Support Services, via the Oss-Rpd interface. The Telemetry Server in the RPD also streams Telemetry measurements from the RPD to the Telemetry Client in the Network Support Services via the Oss-Rpd interface. Refer to [R-PHY] for additional details. Streaming Telemetry Use Cases are described in [CCAP-OSSIv4.0] Performance Management Use Cases section.

5.4 Information Models

The Information Model approach is based on an object-oriented modeling approach well known in the industry for capturing requirements and system behavior and analyzing the structural data in a protocol-independent representation. UML is a general purpose modeling language to visualize (through diagrams) the design of a system. UML includes many diagram types to graphically represent parts of a system's model. The two types of diagrams include structural views and behavioral views. Structural views represent the static nature of the system using objects, attributes, and relationships (e.g., information or components that must be present in the system). Behavioral views represent the dynamic nature of the system through collaboration of objects and state changes (e.g., activities performed by the system). This document defines requirements with UML Use Case Diagrams and Sequence Diagrams to describe the interactions between the operations support systems and the network element (i.e., describes system behavior. The management information is represented in terms of objects along with their attributes and the interactions between these encapsulated objects (or also referred to as entities in some representations). The diagrams developed to capture these managed objects and their attributes and associations are UML Class Diagrams (i.e., structure diagrams). The collection of UML structure and behavior diagrams are referred to as the Remote PHY Information Model. With the introduction of several new, complex features in Remote PHY and operator needs for a more proactive and efficient approach to management information, information modeling methodologies offer the ability to reuse the same definitions when new protocols are introduced in the future. The managed objects are then represented in a protocol-specific form referred to as a Management Data Model. The Management Data Models when using SNMP are described using the Structure of Management Information Version 2 (SMIv2) [RFC 2578] and the design of these models is determined by the capabilities of the protocol. The Management Data Models when using NETCONF are described using YANG [RFC 6020]. The Management Data Models when using GCP are defined as TLVs. Refer to [UML Modeling Guidelines] for information modeling concepts used throughout this specification.

34 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6 CONFIGURATION MANAGEMENT

In the Remote PHY architecture, the Remote PHY Device (RPD) has very minimal local configuration (e.g., certificates, passwords) and the majority of its operational configuration is provided during RPD initialization by the CCAP Core(s) via the control plane. Thus, operator configuration of the RPD is performed in two steps. In step one the operator configures the CCAP Core. This step includes configuration of traditional CCAP resources such as services and RF channels using the methods and models identical or substantially similar between I-CCAP and R- PHY CCAP Cores. The goal is to maximize the commonality of configuration between these two types of CCAP systems. This step also includes the configuration of a set of RPD specific attributes for RPDs directly connected to the CCAP Core. In step two, the RPD is configured by the CCAP Core(s) from configuration stored in the CCAP Core or by the operational processes running in the CCAP Core. Steps one and two are typically performed at different times. An RPD can be connected to multiple CCAP Cores. The R-PHY model supports configuration by a Principal CCAP Core and zero or more Auxiliary CCAP Cores. This document will use the term CCAP Core to refer to either one. Each CCAP Core manages and configures an independent subset of the RPD resources, e.g., one or more RF channels. There are certain types of parameters that are common across resource sets, such as the power level of a downstream RF port. The Principal CCAP Core is responsible for the configuration of these common parameters for the RPD and for certain device management functions. Auxiliary CCAP Cores are responsible for providing DOCSIS, video, or OOB services. They are restricted to the resource set assigned to them by the Principal Core.

6.1 RPD Configuration Theory of Operation

While a Cable Modem supports operational configuration via configuration file and SNMP SET operations, an RPD supports operational configuration via one or more connected CCAP Cores. The CCAP Core controls its connected RPDs using the R-PHY Control Protocol (RCP) [R-PHY]. RCP operates as an abstraction layer over the foundation of the GCP protocol [GCP]. RCP provides the CCAP Core with the ability to remotely manage a set of objects, such as channels, ports, performance variables, etc. The information carried in RCP is formatted into TLV tuples. A single CCAP Core serves as the single point of configuration for a set of resources (e.g., RF ports and channels) on a given RPD; multiple CCAP Cores may configure different sets of resources. The CCAP Core processes its configuration, which can include references to RPDs. Once the RPD bootstrap process has been completed, the CCAP Core translates applicable physical layer and RPD-specific configuration to RCP objects. Then, the CCAP Core uses GCP to communicate these configuration objects, specified as RCP TLVs, to the relevant RPDs. The RPD completes configuration with a Principal CCAP Core before allowing configuration from Auxiliary CCAP Cores. The RPD accepts configuration from only one Principal CCAP Core. There are several RPD attributes that are persisted within the RPD itself. This specification defines the CCAP Core Configuration Information Models which model a CCAP Core's operational configuration data store. The RPD Configuration Information Models, which model RPD operational configuration data sent over GCP, are specified in Annex B of [R-PHY].

6.2 CCAP Configuration and Transport Protocol Requirements

6.2.1 Configuration Object Datastore The CCAP Core supporting the Remote PHY architecture MUST implement the standard configuration objects defined by this specification unless otherwise specified. The CCAP Core supporting the Remote PHY architecture MUST implement the standard configuration objects defined by [CCAP-OSSIv4.0], except where specified differently in this specification. The CCAP Core supporting the Remote PHY architecture SHOULD support the published YANG model specified by [CCAP-CORE-CONFIG-YANG].

 09/03/21 CableLabs 35 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.2.2 Dynamic Management of RPDs When the CCAP Core configuration based on the YANG model contains information on a new RPD, the CCAP Core MUST provide the derived RPD configuration information via GCP to the new RPD. When the CCAP Core configuration based on the YANG model contains information which modifies the configuration of a given RPD, the CCAP Core MUST utilize GCP to modify the RPD's configuration. The CCAP Core SHOULD modify the RPD's configuration in such a way as to minimize the impact of the change on other unchanged channels, ports, and functions on the RPD.

6.3 CCAP UML Configuration Information Model Overview

6.3.1 CCAP UML Configuration Object Model Overview For DOCSIS 3.0, 3.1, and DPoE, the CCAP UML configuration object model, as well as the data models based on that information model, are divided into eight distinct groupings: • CCAP: The Ccap object is the container of all CCAP configuration objects. • Chassis: Consists of objects for configuring the hardware components of the CCAP. • Video: Consists of those objects that are related to the EQAM functions of the CCAP, including ERM, encryption and decryption objects. • DOCSIS: Consists of the DOCSIS configuration objects that are needed for configuring DOCSIS MAC Domains and services such as DSG. • Network: Consists of objects related to configuring the core services for things like integrated servers, access lists, Syslog, HTTP, FTP, SSH, and other related network services. • Interfaces: Consists of the objects needed to configure interfaces within the CCAP. • Management: Consists of objects used to configure SNMP and Fault Management for the CCAP. • EPON: Consists of the objects that are related to the DPoE configuration of the CCAP. This specification modifies existing CCAP groupings to support the Remote PHY architecture and adds the following new groupings: • RPD: Consists of objects that are related to the configuration of RPDs managed by the CCAP. • SCTE 55-1 OOB: Consists of objects that are related to the configuration of SCTE 55-1 out-of-band interfaces. • R-DTI: Consists of objects that are related to the configuration of Remote DOCSIS Timing Interface. The CCAP supports the RPD-related configuration objects defined in Section 6.5 via implementation of the CCAP YANG model via NETCONF configuration or other supported configuration protocols. The CCAP configuration object model described in [CCAP-OSSIv4.0] has been modified in this specification for the Remote PHY architecture; those changes are described here. Objects not defined here are unchanged and detailed in [CCAP-OSSIv4.0].

6.3.1.1 Default Values and Mandatory Configuration of Attributes in the Configuration Object Model In the configuration object model attribute tables in the following sections, a default value is defined in the Default table column for some object attributes. In cases where a default value is defined for an element, the CCAP will use the specified default value if the YANG model does not include the attribute. In cases where the Default column reads "vendor-specific", the CCAP provides a default value of the vendor's choosing for the attribute in the implementation. In cases where the vendor is defining the default value, the operator need not include these attributes in the YANG model.

36 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attributes explicitly required in the YANG model are marked "Yes" in the Required Attribute column; these attributes do not have a default value. In these cases the operator needs to provide a value for these attributes in the YANG model when an object containing those attributes is being configured. In cases where the Required Attribute column reads "No", either a default value is provided in the table or the CCAP will provide a vendor-specific value.

6.3.1.2 Enumeration Values in the Configuration Object Model In the configuration object model attribute tables in the following sections, enumerated lists are all intended to begin at a value of "1"; in most cases, the first value will be other ("other(1)"). Since this specification borrows objects from existing MIBs, there will be cases where the enumeration values specified here do not match those of the MIB on which the object attribute was based. CCAP vendors are expected to properly translate values provided in the YANG model into the correct values needed for SNMP reporting via the standard MIB objects. Note that integers are specified for each enumeration in the UML configuration object model. When the UML is translated into other formats (JSON, YANG, SNMP, etc.), the enumeration labels and/or integers are included in these outputs as appropriate. For YANG, enumeration labels will be included.

6.3.1.3 Use of Interface Names in Configuration Several configuration objects defined in this specification are identified with keys in the form of a text string name. In general, these configuration objects are modeled after interfaces that have equivalent representation in SNMP (ifTable). While this specification does not impose formal requirements on the format of interface names, CCAP vendors are expected to implement consistent conventions for assigning textual names to interfaces and disclose the rules on which such conventions are based. The CCAP typically rejects a configuration that includes an interface name that does not follow the vendor's naming conventions.

6.3.1.4 Unconstrained Strings in the Configuration Object Model For object attributes with a data type of String, there are cases where this specification does not provide a length constraint. For these attributes, the CCAP can impose a vendor-specific length constraint. If a value in the YANG model exceeds this vendor-specific length constraint, the CCAP typically truncates the text string to that limit and logs an error.

6.3.2 Vendor-Specific Extensions A CCAP is expected to implement vendor-proprietary configuration objects beyond those defined in this specification. Standard objects are those that have been defined in the configuration UML object model, defined in the following sections. Vendor-proprietary configuration objects consist of both new configuration objects not represented in the CCAP configuration UML object model and new or modified attributes of configuration objects that exist in the CCAP configuration UML object model. The CCAP's configuration object model can be extended via the creation of vendor-proprietary YANG modules. Vendor extensions can be performed in YANG.

6.4 Data Type Definitions

This section includes the data types defined for the Configuration Information Model.

 09/03/21 CableLabs 37 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 2 - Data Types

Data Type Name Base Permitted Reference Type Values DtiModeType Enum other(1), slave(2), master(3) , slaveHybrid(4) EvPriorityType Enum emergency(1), [RFC 4639] alert(2), critical(3), error(4), warning(5), notice(6), information(7), debug(8) RpdEvReportingType EnumBits localLog(0), gcpNotification(1) SyncEQLType Enum other(1), [SYNC] prc(2), ssuA(3), ssuB(4), eec1(5), dnu(6), prs(7), stu(8), st2(9), tnc(10), st3e(11), eec2(12), dus(13) RfmStatusType Enum other(1), gcpCfg(2), localCfgNvRam(3), localCfgDefault(4), unknown(5)

6.4.1 DtiModeType This data type defines the PTP DOCSIS Timing Interface Mode.

6.4.2 EvPriorityType This data type defines an event priority level. These are ordered from most (emergency) to least (debug) critical. Each event has a particular priority level associated with it (as defined by the vendor). Reference: [RFC 4639], docsDevEvControlTable, docsDevEvPriority

6.4.3 RpdEvReportingType This data type defines the action to be taken on occurrence of this event class. Implementations may not necessarily support all options for all event classes but at a minimum they have to allow gcpNotification to be disabled. The enum values are defined as follows: localLog – Events will be logged into the RPD local log. gcpNotification – Events will be sent as GCP notifications to the CCAP Core.

38 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.4.4 SyncEQLType This data type defines the SyncE EQL Type. Reference: [SYNC] Annex C, SyncE section

6.4.5 RfmStatusType This data type defines the reported status for DS and US gain; see TLVs 161.1.3 and 161.1.5 for more information.

6.5 CCAP Core Configuration Information Model

The CCAP Core configuration object model has been modified for the Remote PHY architecture; those changes are described in the following subsections. Objects not defined here are unchanged and are detailed in [CCAP- OSSIv4.0]. Figure 4 represents a common scenario where a CCAP Core is a specialization of a CCAP. The RPHY architecture provides another set of scenarios, for example, a standalone CCAP Core which provides RPD control functions. There are other scenarios (e.g., SCTE 55-2 functions) where a CCAP Core may provide unique functions not defined in a CCAP Core.

Figure 4 - CCAP Core Configuration Information Model

6.5.1 CcapCore The CcapCore object serves as the root of the CCAP configuration data and is a specialization of the Ccap object. The Ccap object is defined in [CCAP-OSSIv4.0], and is extended via the CcapCore specialization with several new objects and changes beneath the Chassis object. All other objects are unmodified from [CCAP-OSSIv4.0] and are described fully there.

 09/03/21 CableLabs 39 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 3 - CcapCore Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name RpdCfg Directed composition to RpdCfg 0..1 Oob551Cfg Directed composition to 0..1 Oob551Cfg RdtiCfg Directed composition to RdtiCfg 0..1

6.5.1.1 RpdCfg This configuration object is included in Figure 4 for reference. The RpdCfg object is defined in Section 6.5.5.1.

6.5.1.2 Oob551Cfg This configuration object is included in Figure 4 for reference. The Oob551Cfg object is defined in Section 6.5.7.

6.5.1.3 RdtiCfg This configuration object is included in Figure 4 for reference. The RdtiCfg object is defined in Section 6.5.8.

6.5.2 CCAP Chassis Configuration Information Model The Chassis configuration Information Model has been modified for the Remote PHY architecture; those changes are described in the following subsections. Objects not defined here are unchanged and are detailed in Figure 5.

Figure 5 - CCAP Chassis Configuration Information Model

40 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.2.1 Chassis The Chassis object is defined in [CCAP-OSSIv4.0]. The new associations for the Chassis are listed in Table 4. Table 4 - New Chassis Object Associations

Associated Object Type Near-end Far-end Multiplicity Label Name Multiplicity Oob551DsChan Directed composition to 0..* Oob551DsChan Oob551VirtArpd Directed composition to 0..* Oob551VirtArpd

6.5.2.2 Oob551DsChan This configuration object is included in Figure 5 for reference. The Oob551DsChan object is defined in Section 6.5.7.4.

6.5.2.3 Oob551VirtArpd This configuration object is included in Figure 5 for reference. The Oob551VirtArpd object is defined in Section 6.5.7.6.

6.5.2.4 RphyLineCard This object holds the configuration data for an R-PHY line card in a CCAP; it is based on the CCAP RfLineCard object, removing the CCAP RF ports while adding upstream and downstream MAC-channel resource groups. Both RphyLineCards for R-PHY and RfLineCards for local PHY are permitted in the same chassis, although simultaneous support of both types is not required. The RfLineCard object as defined in [CCAP-OSSIv4.0] is unchanged. An RphyLineCard can contain zero or more UsRfChanResourceGrp and DsRfChanResourceGrp objects which on a CCAP Core represent pools of MAC-layer channels that can be assigned to sets of US and DS RF ports on RPDs. Assigning an upstream MAC-Layer channel to multiple RPD US RF ports is known as virtual combining; such assignment duplicates the effect of physical combiners of nodes in the network, replacing those physical combiners with logical ones inside of the CCAP core. Assigning a downstream MAC-Layer channel to multiple RPD DS RF ports is known as virtual splitting; such assignment duplicates the effect of physical splitters of nodes in the network, replacing those physical splitters with logical ones inside of the CCAP core. This definition allows the flexibility for an RphyLineCard to support either 1) UsRfChanResourceGrps, 2) DsRfChanResourceGrps, or 3) both UsRfChanResourceGrps and DsRfChanResourceGrps. Additionally, an RphyLineCard can optionally support Ethernet ports used for communication between the RphyLineCard and the RPD. The associations for the R-PHY RfLineCard are listed in Table 5. The Encryptor, EnetPort, and StatisUdpMapEncryption objects associated with the RphyLineCard are identical to those associated with the RfLineCard object in [CCAP-OSSIv4.0]. Table 5 - RphyLineCard Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity LineCard Specialization of LineCard Encryptor Directed composition to 1 0..* Encryptor EnetPort Directed composition to 1 0..* EnetPort StaticUdpMapEncryption Directed aggregation to 1 0..* EnableEncryptionIndex StaticUdpMapEncryption

 09/03/21 CableLabs 41 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity UsRfChanResourceGrp Directed composition to 1 0..* UsRfChanResourceGrp DsRfChanResourceGrp Directed composition to 1 0..* DsRfChanResourceGrp

There are no specific attributes other than what is inherited from the above associations.

6.5.2.5 Port The Port object is an abstract class from which all physical port objects on CCAP line cards are derived. There are no Port objects instantiated per se in a configuration based on the YANG model; only the derived physical port objects are instantiated. All physical port objects that derive from Port contain the attributes of a Port which are defined in [CCAP-OSSIv4.0].

6.5.2.6 UsRfChanResourceGrp This object allows for the configuration of upstream MAC-layer channel resources on an RF line card that may be assigned to sets of US RF ports on one or more RPDs. Two types of upstream MAC-layer channel resource groups are defined - one for US SC-QAM DOCSIS channels and one for US OFDMA channels. Channels of each type of US MAC-layer channel resource may be placed in a single, large group, or they may be placed into multiple groups to better match the physical or logical architecture of the physical or virtual line card. Table 6 - UsRfChanResourceGrp Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints ResourceId UnsignedInt Yes (key) The UsRfChanResourceGrp has the following associations.

Table 7 - UsRfChanResourceGrp Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity UpstreamPhysicalChannel Directed composition to 1 0..* UpstreamPhysicalChannel UsOfdmaChannelCfg Directed composition to 1 0..* UsOfdmaChannelCfg

6.5.2.6.1 ResourceId This attribute identifies the upstream RF channel resource group.

6.5.2.7 DsRfChanResourceGrp This object allows for the configuration of downstream MAC-layer channel resources on an RF line card that may be assigned to sets of DS RF ports on one or more RPDs. Two types of downstream MAC-layer channel resource groups are defined - one for DS SC-QAM channels and one for DS OFDM channels. Channels of each type of DS MAC-layer channel resource may be placed in a single, large group, or they may be placed into multiple groups to better match the physical or logical architecture of the physical or virtual line card.

42 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 8 - DsRfChanResourceGrp Object Attributes

Attribute Name Type Required Type Constraints Units Default Value Attribute ResourceId UnsignedInt Yes (key)

The UsRfChanResourceGrp has the following associations.

Table 9 - DsRfChanResourceGrp Object Associations

Associated Object Name Type Near-end Far-end Multiplicity Label Multiplicity DownChannel Directed composition to 1 0..* DownChannel DsOfdmChannel Directed composition to 1 0..* DsOfdmChannel

6.5.2.7.1 ResourceId This attribute identifies the downstream RF channel resource group.

6.5.2.8 FiberNodeCfg The FiberNodeCfg object defines the cable hybrid fiber/coax system (HFC) plant Fiber Nodes reached by RF ports on RPDs. FiberNode attributes are defined in [CCAP-OSSIv4.0]. On RphyLinecards, the fiber node has directed aggregation associations to objects named RpdDsRfPort and RpdUsRfPort, but, unlike for CCAP, these RF port objects are actually contained by an RPD, not by RF line cards on the CCAP itself. So, the fiber node configuration actually has both an RPD unique ID and an RF port number to identify each associated RPD RF port. On RfLineCards, the CCAP directed aggregation associations to DsRfPort and UsRfPort are unchanged from [CCAP-OSSIv4.0]. A single instance of a fiber node has either RpdDsRfPort and RpdUsRfPort aggregations, or DsRfPort and UsRfPort aggregations, but not a mix of both. Note: While [CCAP-OSSIv4.0] defines this object in the CCAP Chassis Information Model, including the FDX- related attribute FdxAllocatedSpectrum, the data model representation of this new FDX related attribute is contained in the RPHY data model [CCAP-CORE-CONFIG-YANG].

6.5.3 DOCSIS Upstream Interface Configuration The DOCSIS Upstream Interface configuration objects are shown in the following diagram. Only the objects included in this section have changes for R-PHY. Any object not covered explicitly in this section is used as defined in [CCAP-OSSIv4.0]. Configuration of Differentiated Services Code Point (DSCP) used to communicate to and from an RPD is vendor-specific.

 09/03/21 CableLabs 43 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Figure 6 - DOCSIS Upstream Interface Configuration Information Model

6.5.3.1 RPDUsAssocList This object allows for the configuration of a set of RPD US RF ports comprising the PHY layer of one or more US MAC channels in the R-PHY core. If virtual combining is being used, this list would contain two or more RPD US RF ports. If virtual combining is not being used, then the port list would contain a single RPD US RF port. Table 10 - RpdUsAssocList Object Attributes

Attribute Name Type Required Type Constraints Units Default Value Attribute Index UnsignedInt Yes (key) The RpdUsAssocList has the following associations.

Table 11 - RpdUsAssocList Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name RpdUsPortRef Directed composition to 1 1..* RpdUsPortRef

6.5.3.1.1 Index This attribute identifies the upstream RPD RF port association list.

44 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.3.2 RpdUsPortRef This object configures one upstream RPD RF port in an RpdUsAssocList. An RPD upstream association list is composed of at least one RPD US RF port. Table 12 - RpdUsPortRef Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value RpdUniqueId MacAddress Yes (key) RpdUsRfPortNum UnsignedInt Yes (key)

6.5.3.2.1 RpdUniqueId This attribute identifies the RPD.

6.5.3.2.2 RpdUsRfPortNum This attribute identifies an upstream RF port on the RPD.

6.5.3.3 UpstreamPhysicalChannel The UpstreamPhysicalChannel object represents SC-QAM operation on a single upstream center frequency at a particular channel width. UpstreamPhysicalChannel associations and attributes are defined in [CCAP-OSSIv4.0]; these are unchanged for the R-PHY UpstreamPhysicalChannel object. There is one new association for R-PHY, the RpdUsAssocList. Each upstream physical channel is associated with exactly one RpdUsAssocList object. For UpstreamPhysicalChannel objects on RphyLineCards, the CCAP Core MUST configure each upstream physical channel to be associated with exactly one RpdUsAssocList object. For UpstreamPhysicalChannel objects on an RfLineCard, this new association is meaningless. Table 13 - New UpstreamPhysicalChannel Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdUsAssocList Directed association to 0..* 1 RpdUsAssocList.Index RpdUsAssocList

6.5.3.4 UsOfdmaChannelCfg This object specifies the upstream OFDMA Parameters for a single upstream OFDMA channel. UsOfdmaChannelCfg associations and attributes are defined in [CCAP-OSSIv4.0]; these are unchanged for the R- PHY UsOfdmaChannelCfg object. There is one new association for R-PHY, the RpdUsAssocList. Each upstream OFDMA channel is associated with exactly one RpdUsAssocList object. For UsOfdmaChannelCfg objects on RphyLineCards, the CCAP Core MUST configure each upstream physical channel to be associated with exactly one RpdUsAssocList object. For UsOfdmaChannelCfg objects on an RfLineCard, this new association is meaningless. Table 14 - New UsOfdmaChannelCfg Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdUsAssocList Directed association to 0..* 1 RpdUsAssocList.Index RpdUsAssocList

6.5.3.5 DocsIfCfg The DocsIfCfg object is the container for the DOCSIS 3.0 upstream interface configuration objects. This specification updates the DocsIfCfg Object association as shown in Table 15.

 09/03/21 CableLabs 45 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 15 - DocsIfCfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity ModulationProfile Directed composition to 1..* ModulationProfile ConfigPreamble Directed composition to 0..* ConfigPreamble

6.5.3.6 ConfigPreamble A ConfigPreamble object configures a preamble superstring for UCD messages to an RPD instead of using a preamble superstring determined by CCAP Core software. This can enable interoperation with an RPD that contains a BurstReceiver component not supported by the CCAP Core software release. Note that separate ConfigPreamble objects can be needed for combinations of RPD BurstReceiver and plant impairment level. A CCAP Core MUST support configuration of a minimum of 8 ConfigPreamble object instances. Table 16 - ConfigPreamble Object Attributes

Attribute Name Type Required Type Constraints Units Default Value Attribute Index UnsignedByte yes (key) 1..255 Superstring HexBinary yes SIZE(1..192) octets Descr AdminString No characters

6.5.3.6.1 Index This key attribute identifies the ConfigPreamble object globally on a CCAP Core chassis.

6.5.3.6.2 Superstring This required attribute defines a sequence of up to 192 octets. The first 128 bytes are encoded in the PreamblePattern TLV of a UCD and any remaining bytes are in the ExtendedPreamblePattern TLV of a UCD. The CCAP Core is not required to validate the value of the Superstring attribute.

6.5.3.6.3 Descr This optional attribute describes the purpose of the ConfigPreamble object, e.g., identifying the RPD model for which it is intended.

6.5.3.7 IntervalUsageCode This specification extends the attributes of the IntervalUsageCode object. Reference: [CCAP-OSSIv4.0] “IntervalUsageCode” The CCAP Core MUST extend the IntervalUsageCode object to add a ConfigPreambleOffset attribute. The SCDMA attributes specified in [CCAP-OSSIv4.0] are considered out of scope for RPHY OSS. The following table extends the IntervalUsageCode Object Attributes table of [CCAP-OSSIv4.0].

46 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 17 - New IntervalUsageCode Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value ConfigPreambleOffset UnsignedShort No 0

6.5.3.7.1 ConfigPreambleOffset This optional attribute specifies the bit position in a configured superstring at which the preamble for a particular interval starts. The value of this attribute is ignored when the ModulationProfile does not refer to a ConfigPreamble object.

6.5.3.8 ModulationProfile This section extends requirements in the “ModulationProfile” section of [CCAP-OSSIv4.0]. Reference: “ModulationProfile” section of [CCAP-OSSIv4.0]. The CCAP Core MUST support configuration of a ModulationProfile with or without a reference to a ConfigPreamble instance. This reference is added to the “ModulationProfile Object Associations” table of [CCAP- OSSIv4.0], which is replaced as shown in Table 18. In object model implementations, a valid reference can be represented with a nonzero ConfigPreambleIndex value that matches the Index key of a ConfigPreamble object, while the lack of a reference can be represented with a zero ConfigPreambleIndex value. Table 18 - ModulationProfile Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity IntervalUsageCode Directed composition to 1..14 IntervalUsageCode ConfigPreamble Optional association with 0..* 0..1 ConfigPreambleIndex ConfigPreamble When a CCAP Core configuration contains a ModulationProfile that references a ConfigPreamble, it directs the CCAP Core to select the referenced ConfigPreamble superstring for UCDs describing bursts of the Modulation Profile. When a ModulationProfile refers to ConfigPreamble, the CCAP Core MUST transmit UCDs for the upstream channel using that Modulation Profile with: • PreamblePattern and ExtendedPreamblePattern UCD TLVs that concatenate to be the ConfigPreamble's superstring; and • Burst descriptors that have a PreambleValueOffset UCD burst sub-TLV that matches the "ConfigPreambleOffset" attribute of the IntervalUsageCode object corresponding to that burst. Note that the particular UsBurstReceiver for an RPD upstream channel specifically restricts the valid preamble bit sequences for particular bursts. The CCAP Core is not required to verify that the combination of ConfigPreamble and ConfigPreambleOffset satisfies any such restrictions. It is expected that RPD or CCAP Core vendors provide sufficient documentation to operators (e.g., example configurations) to satisfy the restrictions. When a ModulationProfile does not reference a ConfigPreamble, the CCAP Core selects the UCD preamble superstring in a vendor-specific manner, as was the case prior to this specification. A CCAP Core MAY instantiate at startup any number of “factory” ModulationProfile object instances with vendor- specific restrictions concerning their modification or deletion.

6.5.3.9 UsOfdmaInitialRangingIuc The CCAP Core MUST extend the UsOfdmaInitialRangingIuc object to add attributes for ConfigPreambleOffset and ConfigPreambleLength. These new attributes are in addition to those described in [CCAP-OSSIv4.0] and are summarized in Table 19. This section describes the new attributes in UsOfdmaInitialRangingIuc added for this specification.

 09/03/21 CableLabs 47 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 19 - New UsOfdmaInitialRangingIuc Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value ConfigPreambleOffset UnsignedShort No 0..1536 bits 0 ConfigPreambleLength UnsignedShort No 0..512, see text bits 0

6.5.3.9.1 ConfigPreambleOffset When the UsOfdmaModulationTemplate containing this UsOfdmaInitialRangingIuc references a ConfigPreamble, this attribute configures the 0-based bit position within the superstring of the ConfigPreamble at which the preamble for the Initial Ranging interval begins. This attribute is ignored when the UsOfdmaModulationTemplate does not reference a ConfigPreamble.

6.5.3.9.2 ConfigPreambleLength When the UsOfdmaModulationTemplate containing this UsOfdmaInitialRangingIuc references a ConfigPreamble, this attribute configures the number of bits in the preamble of the Initial Ranging interval, which is required by [MULPIv4.0] to be a multiple of 1..8 times the value of the NumCarriers attribute of UsOfdmaInitialRangingIuc. Reference [MULPIv4.0] This attribute is ignored when the UsOfdmaModulationTemplate does not reference a ConfigPreamble. The value of 0 is valid only when there is no reference to a ConfigPreamble.

6.5.3.10 UsOfdmaFineRangingIuc The CCAP Core MUST extend the UsOfdmaFineRangingIuc object to add attributes for ConfigPreambleOffset and ConfigPreambleLength. These new attributes are in addition to those described in [CCAP-OSSIv4.0] and are summarized in Table 20. This section describes the new attributes in UsOfdmaFineRangingIuc added for this specification. Table 20 - New UsOfdmaFineRangingIuc Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value ConfigPreambleOffset UnsignedShort No 0..1536 bits 0 ConfigPreambleLength UnsignedShort No 0..512, see text bits 0

6.5.3.10.1 ConfigPreambleOffset When the UsOfdmaModulationTemplate containing this UsOfdmaFineRangingIuc references a ConfigPreamble, this attribute configures the 0-based bit position within the superstring of the ConfigPreamble at which the preamble for the Fine Ranging interval begins. This attribute is ignored when the UsOfdmaModulationTemplate does not reference a ConfigPreamble.

6.5.3.10.2 ConfigPreambleLength When the UsOfdmaModulationTemplate containing this UsOfdmaFineRangingIuc references a ConfigPreamble, this attribute configures the number of bits in the preamble of the Fine Ranging interval, which is required by [MULPIv4.0] to be a multiple of 1..8 times the value of the NumCarriers attribute of UsOfdmaFineRangingIuc. This attribute is ignored when the UsOfdmaModulationTemplate does not reference a ConfigPreamble. The value of 0 is valid only when there is no reference to a ConfigPreamble.

6.5.3.11 UsOfdmaModulationTemplate In addition to the associations shown in [CCAP-OSSIv4.0] for a UsOfdmaModulationTemplate, this specification adds an additional association as shown in Table 21. The CCAP Core MUST support configuration of a UsOfdmaModulationTemplate with or without a reference to a ConfigPreamble instance. In object model implementations, a valid reference can be represented with a nonzero

48 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

ConfigPreambleIndex value that matches the Index key of a ConfigPreamble object, while the lack of a reference can be represented with a zero ConfigPreambleIndex value. Table 21 - New UsOfdmaModulationTemplate Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity ConfigPreamble Directed Association to 0..* 0..1 ConfigPreamble Index ConfigPreamble

When a UsOfdmaModulationTemplate refers to a ConfigPreamble instance, the CCAP Core MUST transmit UCDs for upstream OFDMA channels using that template with: PreamblePattern and ExtendedPreamblePattern UCD TLVs that concatenate to be the ConfigPreamble's superstring; IUC 3 burst descriptors that have a PreambleValueOffset sub-TLV that matches the ConfigPreambleOffset attribute and a PreambleLength sub-TLV that matches the ConfigPreambleLength attribute of the template’s UsOfdmaInitialRangingIuc object; and IUC 4 burst descriptors that have a PreambleValueOffset sub-TLV that matches the ConfigPreambleOffset attribute and a PreambleLength sub-TLV that matches the ConfigPreambleLength attribute of the template’s UsOfdmaFineRangingIuc object.

6.5.4 Downstream DOCSIS and Video Channel Configuration Information Model The Downstream DOCSIS and Video Channel configuration objects are shown in the following diagram. Only the objects included in this section have changes for R-PHY. Any object not covered explicitly in this section is used as defined in [CCAP-OSSIv4.0].

Figure 7 - Downstream DOCSIS and Video Configuration Information Model

6.5.4.1 RpdDsAssocList This object allows for the configuration of a set of RPD DS RF ports comprising the PHY layer of one or more DS MAC channels in the R-PHY core. If virtual splitting is being used, this list would contain two or more RPD DS RF ports. If virtual splitting is not being used, then the port list would contain a single RPD DS RF port.

 09/03/21 CableLabs 49 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 22 - RpdDsAssocList Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value Index UnsignedInt Yes (key) AddrType InetAddressType Yes ipv4(1), ipv6(2) GrpIpAddress InetAddress No SIZE(4 | 16) SrcIpAddress InetAddress No SIZE(4 | 16) "" The RpdDsAssocList has the following associations. Table 23 - RpdDsAssocList Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name RpdDsPortRef Directed composition to 1 1..* RpdDsPortRef

6.5.4.1.1 Index This attribute identifies the downstream RPD RF port association list.

6.5.4.1.2 AddrType This attribute represents the IP address type of the Group IP and Source IP addresses. This value is of type InetAddressType, which is defined by [RFC 4001]. If both the GrpIpAddress attribute and the SrcIpAddress attribute are present, the CCAP Core MUST assign the same address type (IPv4 or IPv6) to both.

6.5.4.1.3 GrpIpAddress This attribute identifies the multicast IP address (IPv4 or IPv6) used to send data packets to this list of RPDs (i.e., it is the destination IP address for the multicast DEPI sessions used to transmit DS data packets to the destination RPD(s)). If there are two or more RpdDsPortRef objects associated with this DS RPD list, this attribute is required. If there is only one RpdDsPortRef object, it may be omitted, in which case unicast DEPI sessions are used to transmit the data packets to the RPD.

6.5.4.1.4 SrcIpAddress If the GrpIpAddress attribute is not present, this attribute is ignored. Otherwise, this attribute identifies the source IP address in SSM data packets sent to this list of RPDs Or, when the SrcIpAddres is set to a zero-length string, then the downstream L2TPv3 sessions are configured for ASM operation.

6.5.4.2 RpdDsPortRef This object configures one downstream RPD RF port in an RpdDsAssocList. An RPD downstream association list is composed of at least one RPD DS RF port. Table 24 - RpdDsPortRef Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value RpdUniqueId MacAddress Yes (key) RpdDsRfPortNum UnsignedInt Yes (key)

6.5.4.2.1 RpdUniqueId This attribute identifies the RPD.

50 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.4.2.2 RpdDsRfPortNum This attribute identifies a downstream RF port on the RPD.

6.5.4.3 DownChannel The DownChannel object represents SC-QAM operation on a single downstream center frequency at a particular channel width. DownChannel associations and attributes are defined in [CCAP-OSSIv4.0]; these are all used without change for the R-PHY DownChannel object. There is one new association for R-PHY, the RpdDsAssocList. Each DownChannel object on an RphyLineCard is associated with exactly one RpdDsAssocList object. For DownChannel objects on RphyLineCards, the CCAP Core MUST configure each DownChannel object to be associated with exactly one RpdDsAssocList object. For DownChannel objects on an RfLineCard, this new association is meaningless. Table 25 - New DownChannel Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdDsAssocList Directed association to 0..* 1 RpdDsAssocList.Index RpdDsAssocList

6.5.4.4 DocsisDownChannel Two attributes have also been added to the DocsisDownChannel object for Remote PHY support: ChannelOutputDerate and ChannelOutputBurstSize. These new attributes are meaningless for a DocsisDownchannel object on an RfLineCard. Table 26 - New DocsisDownChannel Object Attributes

Attribute Name Type Required Type Units Default Attribute Constraints Value ChannelOutputDerate UnsignedByte No 90..99 % 99% ChannelOutputBurstSize UnsignedInt No Bytes 0

6.5.4.4.1 ChannelOutputDerate The percentage of the maximum output rate for the aggregated traffic that is being sent though this Downstream interface to the Downstream channel associated with this DEPI session. Using a value lower than 99% of the Downstream channel's configured payload rate prevents the buildup of a queue delay when MPEG-TS nulls are added in the presence of jitter in the CIN.

6.5.4.4.2 ChannelOutputBurstSize The maximum burst size for the aggregate output rate of traffic that is being sent through this Downstream interface to the Downstream channel. A value of 0 indicates that the maximum burst size is three times the CCAP Core payload MTU size; this is the default value.

6.5.4.5 DsOfdmChannelCfg This object specifies the downstream OFDM parameters for a single downstream OFDM channel. DsOfdmChannelCfg associations and attributes are defined in [CCAP-OSSIv4.0]; these are all used without change for the R-PHY DsOfdmChannelCfg object. There is one new association for R-PHY, the RpdDsAssocList. Each DsOfdmChannelCfg object on an RphyLineCard is associated with exactly one RpdDsAssocList object. For DsOfdmChannelCfg objects on an RphyLinecard, the CCAP Core MUST configure each DsOfdmChannelCfg object to be associated with exactly one RpdDsAssocList object. Two attributes have also been added to the DsOfdmChannelCfg object for Remote PHY support: ChannelOutputDerate and ChannelOutputBurstSize. These new attributes and the new association are meaningless for a DsOfdmChannelCfg object on an RfLinecard.

 09/03/21 CableLabs 51 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 27 - New DsOfdmChannelCfg Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default Value ChannelOutputDerate UnsignedByte No 90..99 % 99% ChannelOutputBurstSize UnsignedInt No Bytes 0

Table 28 - New DsOfdmChannelCfg Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdDsAssocList Directed association to 0..* 1 RpdDsAssocList.Index RpdDsAssocList

6.5.4.5.1 ChannelOutputDerate The percentage of the maximum output rate for the aggregated traffic that is being sent though this Downstream interface to the Downstream channel associated with this DEPI session. Using a value lower than 99% of the Downstream channel's configured payload rate prevents the buildup of a queue delay when MPEG-TS nulls are added in the presence of jitter in the CIN.

6.5.4.5.2 ChannelOutputBurstSize The maximum burst size for the aggregate output rate of traffic that is being sent through this Downstream interface to the Downstream channel. A value of 0 indicates that the maximum burst size is three times the CCAP Core payload MTU size; this is the default value.

6.5.5 CCAP Core RPD Configuration Information Model The CCAP Core RPD configuration Information Model introduces new objects for the Remote PHY architecture as shown in Figure 8. These objects allow RPD-related configuration via a Principal CCAP Core.

52 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 8 - CCAP Core RPD Configuration Information Model

6.5.5.1 RpdCfg The RpdCfg object is a container that holds RemotePhyDevice instances and has the associations shown in Table 30. Table 29 - RpdCfg Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default Value GcpKeepAliveInterval UnsignedShort No 0..600 100ms 10 IpStackCtrl Enum No dualStack(0), dualStack ipv4Only(1), ipv6Only(2) EnableResourceAllocCheck Boolean No false

Table 30 - RpdCfg Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RemotePhyDevice Directed composition to 1 0..* RemotePhyDevice DefaultRpdEvThrottleCfg Directed composition to 1 1 DefaultRpdEvThrottleCfg DefaultRpdEvReportingCfg Directed composition to 1 8 DefaultRpdEvReportingCfg

 09/03/21 CableLabs 53 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Oob551DsSg Directed composition to 1 0..* Oob551DsSg Oob551UsSg Directed composition to 1 0..* Oob551UsSg VendorSpecificPreCfg Directed composition to 1 0..* VendorSpecificPreCfg DefaultCwTonesCfg Directed composition to 1 0..* DefaultCwTonesCfg DefaultRpdReconnectCfg Directed composition to 1 1 DefaultRpdReconnectCfg

6.5.5.1.1 GcpKeepAliveInterval This attribute defines how often the CCAP Core sends GCP KeepAlive messages to RPDs. A zero value disables the GCP KeepAlive process.

6.5.5.1.2 IpStackCtrl This attribute allows the Principal CCAP Core to configure the mode of operation of the RPD’s IP stacks. Upon reset, the RPD initializes in dual stack IP mode. This attribute is intended to provide a volatile one-time opportunity to disable one of the IP stacks in the RPD, i.e., the stack which the MSO does not intend to utilize in their deployment. The RPD is not required to support multiple runtime changes to the value of this attribute. The operator needs to reboot the RPD in order to switch between IP versions, or in order to regress the RPD to its default dual stack IP mode. The following modes of operation are supported: dualStack: IPv4 and IPv6 dual-stack IP mode operation ipPv4Only: IPv6 protocol stack in the RPD is disabled ipv6Only: IPv4 protocol stack in the RPD is disabled The default value is ‘dualStack’.

6.5.5.1.3 EnableResourceAllocCheck This attribute configures whether an RPD should implement resource allocation checks when a CCAP Core writes to an RPD variable.

6.5.5.2 DefaultRpdEvThrottleCfg This object configures the default event throttling parameters for RPDs. If an instance of RemotePhyDevice is configured without an EventThrottleCfg object, the configuration here applies. It is based on the EventThrottleCfg object defined in [CCAP-OSSIv4.0] and is used here without modification.

6.5.5.3 DefaultRpdEvReportingCfg This object configures the default event reporting parameters for RPDs to use. If an instance of RemotePhyDevice is configured without an RpdEvReportingCfg object, the configuration here applies. If neither DefaultRpdEvReportingCfg nor RpdEvReportingCfg has an instance for a priority, then no reporting of that event priority is done. Table 31 - DefaultRpdEvReportingCfg Object Attributes

Attribute Type Required Type Constraints Units Default Name Attribute Value Priority EvPriorityType Yes (key) Reporting RpdEvReportingType Yes

54 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.5.3.1 Priority This attribute is the priority of the event. It matches docsDevEvPriority in RFC 3649.

6.5.5.3.2 Reporting This attribute defines the ways that the RPD will report the event.

6.5.5.4 DefaultRpdReconnectCfg This configuration object configures the parameters that control the RPD reconnect process with the Core that is configuring this object. A Core can only configure this object for the reconnect action for itself. These defaults are applied to all RPDs serviced by this CCAP instance, but can be overridden by an RpdReconnectCfg instance configured for an individual RPD. Additional configuration attributes can be provided for vendor-proprietary recovery configuration. Table 32 - DefaultRpdReconnectCfg Object Attributes

Attribute Name Type Required Type Constraints Units Default TLV Attribute Value Type MaxGcpIdleTime UnsignedShort N 0..300 NA 0 15.2.2 GcpRecoveryAction Enum N other(1), NA 3 15.2.3 gcpWaitForActionFromCore(2), gcpReconnectToTheSameCore(3), gcpHandoverToBackupCore(4), waitAndReboot(5), gcpHandoverToBackupCoreAfterReconnect Fail(6) GcpRecoveryActionRetry UnsignedByte N 0..255 retries 3 15.2.4 GcpRecoveryActionDelay UnsignedShort N 0..600 seconds 0 15.2.5 GcpReconnectTimeout UnsignedShort N 5..120 seconds 30 15.2.6 GcpHandoverTimeout UnsignedShort N 5..120 seconds 30 15.2.7 CheckForDisconnectedCoresPeriod UnsignedShort N 0..3600 Seconds 300 15.2.8 AuxReconnectFailReset Boolean N NA See 15.2.9 attribute description

6.5.5.4.1 MaxGcpIdleTime This attribute configures the maximum amount of time the GCP control plane can be idle before the RPD can declare a GCP connection failure. Setting the value to 0 disables GCP connection monitoring for this Core.

6.5.5.4.2 GcpRecoveryAction This attribute configures the action to be taken by an RPD after the RPD declares the GCP connection lost. Neither the RPD nor the CCAP Core is required to support all of these recovery actions. Valid values are: other – The RPD does a vendor-specific action. gcpWaitForActionFromCore – The RPD waits for the CCAP Core to re-establish the GCP connection or request a handover to a Backup Core. gcpReconnectToTheSameCore – The RPD attempts to reconnect to the same CCAP Core. gcpHandoverToBackupCore – The RPD attempts to establish connection to a standby CCAP Core. waitAndReboot – The RPD waits for a period of time specified by GcpRecoveryActionRetry attribute before performing a reset (hardReset). Only the Principal CCAP Core is allowed to configure this action.

 09/03/21 CableLabs 55 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications gcpHandoverToBackupCoreAfterReconnectFail – The RPD attempts to reconnect to the same CCAP Core as for GcpReconnectToTheSameCore with the difference that if the reconnect fails, the RPD attempts to establish connection to a backup CCAP Core as for GcpHandoverToBackupCore.

6.5.5.4.3 GcpRecoveryActionRetry This attribute is used to configure the number of retries the RPD attempts the configured recovery action. Note that this attribute is not applicable when the GcpRecoveryAction is one of the following: • gcpWaitForActionFromCore • waitAndReboot

6.5.5.4.4 GcpRecoveryActionDelay This attribute configures the length of the interval for which the RPD waits, either before the configured recovery action is attempted or before performing a retry of the configured recovery action. Note that this attribute is not applicable when the GcpRecoveryAction option is waitAndReboot.

6.5.5.4.5 GcpReconnectTimeout This attribute configures the timeout value, in seconds, used by the RPD when attempting to reconnect to a CCAP Core. This is the maximum amount of time that the RPD can wait for the reconnection process to complete before declaring that an attempt has failed.

6.5.5.4.6 GcpHandoverTimeout This attribute configures the timeout value, in seconds, used by the RPD when attempting to handover to a backup CCAP Core. This is the maximum amount of time that the RPD can wait for the handover process to complete before declaring that an attempt has failed.

6.5.5.4.7 CheckForDisconnectedCoresPeriod This attribute configures the interval, in seconds, between RPD connection attempts to any disconnected Cores in the ConfiguredCoreTable.

6.5.5.4.8 AuxReconnectFailReset This attribute controls whether the RPD performs a reset when all reconnection attempts to the core as an Auxiliary core have failed. The default value of this attribute is the value from the DefaultAuxReconnectFailReset attribute of the RpdResetCtrl object.

6.5.5.5 RemotePhyDevice The RemotePhyDevice object allows the user to optionally configure attributes of the Remote PHY Devices for reporting purposes. Table 33 - RemotePhyDevice Object Attributes

Attribute Type Required Attribute Type Constraints Units Default Value Name UniqueId MacAddress Yes (key) Name AdminString No Description AdminString No

56 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 34 - RemotePhyDevice Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity EventThrottleCfg Directed composition to 1 0..1 EventThrottleCfg RpdEvReportingCfg Directed composition to 1 0..1 RpdEvReportingCfg RpdPtpClkCfg Directed composition to 1 0..1 RpdPtpClkCfg RpdUsRfPort Directed composition to 1 1..* RpdUsRfPort RpdDsRfPort Directed composition to 1 1..* RpdDsRfPort RpdReconnectCfg Directed composition to 1 0..1 RpdReconnectCfg RpdSyncECfg Directed composition to 1 0..1 RpdSyncECfg RpdClkCfg Directed composition to 1 0..1 RpdClkCfg RpdSyslogCfg Directed composition to 1 0..1 RpdSyslogCfg StreamingTelemetryCfg Directed composition to 1 0..1 StreamingTelemetryCfg

6.5.5.5.1 UniqueId This attribute configures the MAC Address with which an RPD originates GCP to this CCAP Core.

6.5.5.5.2 Name This attribute configures a human-readable short name intended to uniquely identify a RemotePhyDevice. While not a key, the Name of the RemotePhyDevice is intended to be unique on this CCAP Core. The use of this attribute is vendor-specific. The value of this attribute need not be the same as the value of DeviceAlias.

6.5.5.5.3 Description This attribute configures an informational description of the RemotePhyDevice.

6.5.5.6 EventThrottleCfg This object configures specific event throttling parameters for a RemotePhyDevice instance. It is defined in [CCAP- OSSIv4.0].

6.5.5.7 RpdEvReportingCfg This object configures specific event reporting parameters for a RemotePhyDevice instance to use. If no instance of this object exists for a priority, then the corresponding instance of DefaultRpdEvReportingCfg is used for the RPD. Table 35 - RpdEvReportingCfg Object Attributes

Attribute Type Required Attribute Type Constraints Units Default Name Value Priority EvPriorityType Yes(key) Reporting RpdEvReportingType Yes

6.5.5.7.1 Priority This attribute is the priority of the event. It matches docsDevEvPriority in RFC 3649.

 09/03/21 CableLabs 57 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.5.7.2 Reporting This attribute defines the ways that the RPD will report the event.

6.5.5.8 RpdDsRfPort This object allows for the configuration of a physical Downstream RF port on an RPD. The RpdDsRfPort is a type of the abstract class Port and inherits those common parameters. An RpdDsRfPort object contains the attributes in the following table. Table 36 - RpdDsRfPort Object Attributes

Attribute Name Type Required Type Constraints Units Default Value Attribute BaseChanPower TenthdBmV No TenthdBmV vendor-specific per 6 MHz RfMute Boolean No false Tilt TenthdB No 0..120 TenthdB TiltMaxFrequency UnsignedInt No Hz

Table 37 - RpdDsRfPort Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Port Specialization of Port DsNcpExclusionCfg Directed composition to 1 0..* DsNcpExclusionCfg DsOfdmExclusionCfg Directed composition to 1 0..* DsOfdmExclusionCfg CwTones Directed composition to CwTones 1 0..* The objects Port, DsNcpExclusionCfg, and DsOfdmExclusionCfg are the same as on an RfLineCard and are reused without change from [CCAP-OSSIv4.0].

6.5.5.8.1 BaseChanPower This attribute configures the power spectral density reference level for all downstream signals on an RF port. The value is expressed in units of TenthdBmV per 6 MHz. The default value is vendor-specific. Acceptable power ranges for this attribute dependent upon the type of physical layer technology used. References: [PHYv4.0], Power per Channel CMTS or EQAM section; [R-PHY], TLV 61.3 BasePower definition section

6.5.5.8.2 RfMute The attribute RfMute refers to a diagnostic state defined in the [PHYv4.0] Specification. Muting an RF port affects only the output power and does not impact the operational status of any channel on the port.

6.5.5.8.3 Tilt This attribute configures the Tilt value to be applied over the supported downstream spectrum (from the minimum downstream frequency to the Tilt Maximum Frequency) on this RpdDsRfPort. Note: The amount of Tilt supported by a given RPD is vendor-specific. The range provided here is not intended as a requirement on RPD implementations as many implementations support a lower maximum Tilt value than is specified here. References: [R-PHY], TLV 61.5 TiltValue definition section

58 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.5.8.4 TiltMaxFrequency This attribute configures the maximum frequency (aka tilt pivot point) where the Tilt value applies. References: [R-PHY], TLV 61.6 TiltMaximumFrequency definition section

6.5.5.9 CwTones This new R-PHY object allows operators to configure the CW tones that will be output on the DS RF port of an RPD. The CW tone is commonly used on downstream RF ports for automatic gain control (pilot tone), as an alignment carrier, for leakage detection, or for other purposes. Multiple CW tones can be configured. CW tones can be configured globally for all RPDs by configuring instances of the DefaultCwTonesCfg object contained by the RpdCfg object. This allows the same CW tone configuration to be shared by all RPDs associated with a CCAP Core. The CW tone configuration can also be overridden by configuring instances of the CwTones object contained by an instance of an RpdDsRfPort object. This allows individual RPDs to have unique CW tone configurations. When an instance of the CwTones object is configured for an RpdDsRfPort, none of the Default CwTonesCfg instances associated with the RpdCfg object will be applied to that RpdDsRfPort instance. Table 38 - CwTones Object Attributes

Attribute Name Type Required Attribute Type Units Default TLV Constraints Value Type Frequency UnsignedInt Yes (key) Hz 61.7.2 PowerAdjust Short Yes, see description TenthdB 61.7.3 UsesDedicatedGen Boolean Yes Description AdminString No "" FrequencyFraction TenthHz Yes Tenths of 0 61.7.5 a Hertz IsPersistent Boolean No false RfMute Boolean No true 61.7.4

6.5.5.9.1 Frequency This attribute is the RF frequency of this CW tone expressed as a whole number. This frequency value is increased by the FrequencyFraction attribute, if configured.

6.5.5.9.2 PowerAdjust This attribute represents the power gain for the CW tone relative to the BaseChanPower for this DsRfPort. It is expressed in TenthdB.

6.5.5.9.3 UsesDedicatedGen This attribute determines whether or not this tone is be provided by a dedicated tone generator in the RPD.

6.5.5.9.4 Description This optional attribute configures the human readable description for the use of the CW Tone.

6.5.5.9.5 FrequencyFraction This attribute is used to configure the fractional frequency of CW tone of the dedicated pilot tone generator in the RPD. It allows the CCAP Core to specify the frequency of the CW tone with a precision of 0.1 Hz. The value of FrequencyFraction is added to the value of the Frequency attribute.

 09/03/21 CableLabs 59 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.5.9.6 IsPersistent This attribute configures the persistence of CwTones across RPD reboots. If set to true, the CwTone is persisted across RPD reinitializations, except for nvReset and factoryReset operations (see RpdResetCtrl). If set to false, the CwTone is not persistent across RPD reinitializations.

6.5.5.9.7 RfMute This attribute, when set to 'true', turns off generation of the tone. Otherwise, when set to 'false', the tone is generated.

6.5.5.10 RpdUsRfPort An RpdUsRfPort object represents a physical upstream RF connector on an RPD. It is derived from the Port abstract class, and so inherits all attributes of that class, including its associations. This object has no attributes other than what has been inherited from the abstract class Port, but does have an association. Table 39 - RpdUsRfPort Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Port Specialization of Port UsOfdmaExclusion Directed composition to 1 0..* UsOfdmaExclusion The objects Port and UsOfdmaExclusion are the same as on an RfLineCard and are reused without change from [CCAP-OSSIv4.0].

6.5.5.11 Oob551DsSg The Oob551DsSg object defines a downstream service group of RPDs to receive a downstream channel. If there are no Oob551DsSgRpd objects defined for a Oob551DsSg object, then all RPDs are members of this SG. Table 40 - Oob551DsSg Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default DsSgIndex UnsignedShort Yes (Key) PwIpAddr Ipv4Address No Multicast IPv4 address 0.0.0.0

Table 41 - Oob551DsSg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Oob551DsSgRpd Directed composition to 0..* Oob551DsSgRpd

6.5.5.11.1 DsSgIndex This is the index for an instance of this Object.

6.5.5.11.2 PwIpAddr This is the multicast pseudo-wire address for this downstream service group. The address 0.0.0.0 means that the core CCAP will pick an unused multicast address for the multicast L2TPv3 session.

6.5.5.12 Oob551DsSgRpd The Oob551DsSgRpd object defines an RPD to receive a downstream channel. If there are no Oob551DsSgRfPort objects defined for a Oob551DsSgRpd object, then all DS RF ports on the RPD are members of the SG.

60 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 42 - Oob551DsSgRpd Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default RpdUniqueId MacAddress Yes (Key)

Table 43 - Oob551DsSgRpd Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Oob551DsSgRfPort Directed composition to 0..* Oob551DsSgRfPort

6.5.5.12.1 RpdUniqueId This is the index for an instance of an RPD in the DS SG.

6.5.5.13 Oob551DsSgRfPort The Oob551DsSgRfPort object defines the DS RF port on an RPD to receive a downstream channel. Table 44 - Oob551DsSgRfPort Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default RpdRfPort UnsignedByte Yes (Key)

6.5.5.13.1 RpdRfPort This is the index for a DS RF port in an RPD in the DS SG.

6.5.5.14 Oob551UsSg The Oob551UsSg object defines an upstream service group of RPDs as a source for an upstream channel. Table 45 - Oob551UsSg Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default UsSgIndex UnsignedShort Yes (Key)

Table 46 - Oob551UsSg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Oob551UsSgRpd Directed composition to 1..* Oob551UsSgRpd

6.5.5.14.1 UsSgIndex This is the index for an instance of this Object.

6.5.5.15 Oob551UsSgRpd The Oob551UsSgRpd object defines an RPD as a source for an upstream channel. If there are no Oob551UsSgRfPort objects defined for a Oob551UsSgRpd object, then all US RF ports on the RPD are members of the SG.

 09/03/21 CableLabs 61 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 47 - Oob551UsSgRpd Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default RpdUniqueId MacAddress Yes (Key)

Table 48 - Oob551UsSgRpd Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Oob551UsSgRfPort Directed composition to 0..* Oob551UsSgRfPort

6.5.5.15.1 RpdUniqueId This is the index for an instance of an RPD in the US SG.

6.5.5.16 Oob551UsSgRfPort The Oob551UsSgRfPort object defines the US RF port on an RPD as a source for an upstream channel. Table 49 - Oob551UsSgRfPort Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default RpdRfPort UnsignedByte Yes (Key)

6.5.5.16.1 RpdRfPort This is the index for an instance of a US RF port in an RPD in the US SG.

6.5.5.17 RpdPtpClkCfg The RpdPtpClkCfg is an instantiation of the abstract class PtpClkCfg and inherits those common attributes. The RpdPtpClkCfg object defines the PTP clock parameters in an RPD. An RPD MUST implement a PTP clock containing at least one RPD PTP Clock port. Table 50 - RpdPtpClkCfg Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity PtpClkCfg Specialization of PtpClkCfg RpdPtpPortCfg Directed Composition 1 1..4

6.5.5.18 RpdPtpPortCfg The RpdPtpPortCfg is an instantiation of the abstract class PtpPortCfg and inherits those common attributes. The RpdPtpPortCfg object defines the port-specific parameters for an RPD PTP clock port. Most of the parameters are specified by assigning a PtpTemplateCfg object to the PTP port. Table 51 - RpdPtpPortCfg Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints RpdEnetPortIndex UnsignedByte Key RpdPtpPortIndex UnsignedByte Key

62 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 52 - RpdPtpPortCfg Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity PtpPortCfg Specialization of PtpPortCfg

6.5.5.18.1 RpdEnetPortIndex This attribute contains the RPD's Ethernet port used for this PTP clock port. If not set, any RPD Ethernet port may be used for this PTP clock port.

6.5.5.18.2 RpdPtpPortIndex This attribute contains the RPD's PTP clock port index

6.5.5.19 VendorSpecificPreCfg The VendorSpecificPreCfg object defines instances that associate a Vendor Specific Pre-configuration (VSP) Setting with identifying capabilities of an RPD. When an attaching RPD identifies itself with capabilities that match an instance of this object, the CCAP Core sends as its first REX WRITE message the TLV string of the VSP Setting. The VSP Setting TLVs are opaque to the CCAP Core. An example application for a VSP Setting is to configure vendor-proprietary 'QAM Blocks' of adjacent SC-QAM down-channel numbers that require the same transmit power or interleave. A CCAP Core MUST support the configuration of at least 32 instances of the Vendor Specific Pre-configuration object. Table 53 - VendorSpecificPreCfg Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints VendorId UnsignedShort Key VspSelector AdminString Key SIZE(1..16) VspSetting HexBinary Yes SIZE(1..1024)

6.5.5.19.1 VendorId This attribute contains a 16-bit enterprise identifier that is matched with the 'VendorId' capability reported by an RPD in TLV 50.19.2.

6.5.5.19.2 VspSelector This attribute contains a textual string that is matched with the 'VspSelector' capability reported by an RPD in TLV 50.19.18. The RPD vendor is expected to specify the VspSelector string reported by its RPD based on hardware, software, and/or firmware capabilities.

6.5.5.19.3 VspSetting This attribute contains one or more fully formatted vendor specific extension TLVs of type 21. The VSP Setting contents are opaque to the CCAP Core. An RPD vendor is expected to communicate the VSP Setting octet string to operators as an ASCII hexadecimal string. The format of vendor specific extension TLV and the method for writing VspSetting to the RPD are described in [R-PHY].

6.5.5.20 RpdReconnectCfg This configuration object configures RPD-specific parameters that control the RPD reconnect process with the Core. If no instance of this object or attributes exist for an RPD, then the corresponding instance of DefaultRpdReconnectCfg is used for the RPD.

 09/03/21 CableLabs 63 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 54 - RpdReconnectCfg Object Attributes

Attribute Name Type Required Type Constraints Units Default TLV Attribute Value Type MaxGcpIdleTime UnsignedShort N 0..300 NA 0 15.2.2 GcpRecoveryAction Enum N other(1), NA 3 15.2.3 gcpWaitForActionFromCore(2), gcpReconnectToTheSameCore(3), gcpHandoverToBackupCore(4), waitAndReboot(5), gcpHandoverToBackupCoreAfterReconnect Fail(6) GcpRecoveryActionRetry UnsignedByte N 0..255 retries 3 15.2.4 GcpRecoveryActionDelay UnsignedShort N 0..600 seconds 0 15.2.5 GcpReconnectTimeout UnsignedShort N 5..120 seconds 30 15.2.6 GcpHandoverTimeout UnsignedShort N 5..120 seconds 30 15.2.7

6.5.5.20.1 MaxGcpIdleTime This attribute configures the maximum amount of time the GCP control plane can be idle before the RPD can declare a GCP connection failure. Setting the value to 0 disables GCP connection monitoring for this Core.

6.5.5.20.2 GcpRecoveryAction This attribute configures the action to be taken by an RPD after the RPD declares the GCP connection lost. Neither the RPD nor the CCAP Core is required to support all of these recovery actions. Valid values are: other – The RPD does a vendor-specific action. gcpWaitForActionFromCore – The RPD waits for the CCAP Core to re-establish the GCP connection or request a handover to a Backup Core. gcpReconnectToTheSameCore – The RPD attempts to reconnect to the same CCAP Core. gcpHandoverToBackupCore – The RPD attempts to establish connection to a standby CCAP Core. waitAndReboot – The RPD waits for a period of time specified by GcpRecoveryActionRetry attribute before performing a reset (hardReset). Only the Principal CCAP Core is allowed to configure this action. gcpHandoverToBackupCoreAfterReconnectFail – The RPD attempts to reconnect to the same CCAP Core as for GcpReconnectToTheSameCore with the difference that if the reconnect fails, the RPD attempts to establish connection to a backup CCAP Core as for GcpHandoverToBackupCore.

6.5.5.20.3 GcpRecoveryActionRetry This attribute is used to configure the number of retries the RPD attempts the configured recovery action. Note that this attribute is not applicable when the GcpRecoveryAction is one of the following: • gcpWaitForActionFromCore • waitAndReboot

6.5.5.20.4 GcpRecoveryActionDelay This attribute configures the length of the interval for which the RPD waits, either before the configured recovery action is attempted or before performing a retry of the configured recovery action. Note that this attribute is not applicable when the GcpRecoveryAction option is waitAndReboot.

64 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.5.20.5 GcpReconnectTimeout This attribute configures the timeout value, in seconds, used by the RPD when attempting to reconnect to a CCAP Core. This is the maximum amount of time that the RPD can wait for the reconnection process to complete before declaring that an attempt has failed.

6.5.5.20.6 GcpHandoverTimeout This attribute configures the timeout value, in seconds, used by the RPD when attempting to handover to a backup CCAP Core. This is the maximum amount of time that the RPD can wait for the handover process to complete before declaring that an attempt has failed.

6.5.5.21 DefaultCwTonesCfg This new R-PHY object allows operators to configure the CW tones that will be output on the DS RF port of an RPD. The CW tone is commonly used on downstream RF ports for automatic gain control (pilot tone), as an alignment carrier, for leakage detection, or for other purposes. Multiple CW tones can be configured. CW tones can be configured globally for all RPDs by configuring instances of the DefaultCwTonesCfg object contained by the RpdCfg object. This allows the same CW tone configuration to be shared by all RPDs associated with a CCAP Core. The CW tone configuration can also be overridden by configuring instances of the CwTones object contained by an instance of an RpdDsRfPort object. This allows individual RPDs to have unique CW tone configurations. When an instance of the CwTones object is configured for an RpdDsRfPort, none of the DefaultCwTonesCfg instances associated with the RpdCfg object will be applied to that RpdDsRfPort instance. Table 55 - DefaultCwTonesCfg Object Attributes

Attribute Name Type Required Type Units Default TLV Attribute Constraints Value Type Frequency UnsignedInt Yes (key) Hz 61.7.2 PowerAdjust UnsignedShort Yes, see description TenthdB 61.7.3 UsesDedicatedGen Boolean Yes Description AdminString No "" FrequencyFraction TenthHz Yes Tenths of a 0 61.7..5 Hertz IsPersistent Boolean No false RfMute Boolean No true 61.7.4

6.5.5.21.1 Frequency This attribute is the RF frequency of this CW tone expressed as a whole number. This frequency value is increased by the FrequencyFraction attribute, if configured.

6.5.5.21.2 PowerAdjust This attribute represents the power gain for the CW tone relative to the BaseChanPower for this DsRfPort. It is expressed in TenthdB.

6.5.5.21.3 UsesDedicatedGen This attribute determines whether or not this tone is be provided by a dedicated tone generator in the RPD.

6.5.5.21.4 Description This optional attribute configures the human-readable description for the use of the CW Tone.

 09/03/21 CableLabs 65 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.5.21.5 FrequencyFraction This attribute is used to configure the fractional frequency of CW tone of the dedicated pilot tone generator in the RPD. It allows the CCAP Core to specify the frequency of the CW tone with a precision of 0.1 Hz. The value of FrequencyFraction is added to the value of the Frequency attribute.

6.5.5.21.6 IsPersistent This attribute configures the persistence of CwTones across RPD reboots. If set to true, the CwTone is persisted across RPD reinitializations, except for nvReset and factoryReset operations (see RpdResetCtrl). If set to false, the CwTone is not persistent across RPD reinitializations.

6.5.5.21.7 RfMute This attribute, when set to 'true', turns off generation of the tone. Otherwise, when set to 'false', the tone is generated.

6.5.5.22 RpdSyncECfg The RpdSyncECfg object allows configuration of Synchronous Ethernet (SyncE) on the RPD. Attributes in this object apply to all Ethernet ports used for SyncE in the RPD. RPDs SHOULD support SyncE for timing. Support by the CCAP Core for SyncE is out of scope for this specification. The RpdSyncECfg TLV Type is 100.34. Table 56 - RpdSyncECfg Object Attributes

Attribute Name Type Required Type Units Default TLV TLV Value Field Attribute Constraints Value Type Length NetworkType Enum No eecOpt1(1), eecOpt2 100.34.1 1 eecOpt2(2) ClockSourceSelectionEnable Boolean No true 100.34.2 1 QualityLevelEnable Boolean No false 100.34.3 1

Table 57 - RpdSyncECfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity RpdSyncEPortCfg Directed composition to 1 1..* RpdSyncEPortCfg

6.5.5.22.1 NetworkType This attribute configures the network clock for EEC option-1 or EEC option-2 operation. Option 1 is for 2.048 MHz-based synchronization networks and option 2 is for 1.544 MHz-based networks. Reference: [G.8262] Section 1

6.5.5.22.2 ClockSourceSelectionEnable This attribute enables/disables the G.781-based network clock source selection algorithm. Reference: [G.781]

6.5.5.22.3 QualityLevelEnable When this attribute is enabled, SyncE includes quality level in the source selection process. When disabled, the source selection process is based on signal fail, priority, and commands.

6.5.5.23 RpdSyncEPortCfg The RpdSyncEPortCfg object allows configuration of SyncE on a specific Ethernet port on an RPD.

66 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The RpdSyncEPortCfg TLV Type is 100.35. Table 58 - RpdSyncEPortCfg Object Attributes

Attribute Name Type Required Type Units Default TLV TLV Value Attribute Constraints Value Type Field Length RpdEnetPortIndex UnsignedByte Key 100.35.1 1 SyncModeEnable Boolean No false 100.35.2 1 SourcePriority UnsignedByte No 1..4 4 100.35.3 1 RxSsm SyncEQLType No See Below 100.35.4 1 TxSsm SyncEQLType No See Below 100.35.5 1 HoldOff UnsignedShort No 300..1800 ms 600 100.35.6 2 WaitTimeToRestore UnsignedByte No 0..12 minutes 5 100.35.7 1 ForceSwitchEnable Boolean No false 100.35.8 1 ManualSwitchEnable Boolean No false 100.35.9 1 LockoutEnable Boolean No false 100.35.10 1

6.5.5.23.1 RpdEnetPortIndex This attribute contains the RPD's Ethernet port index for this SyncE clock.

6.5.5.23.2 SyncModeEnable This attribute enables/disables synchronous mode for the interface. This affects both transmit and receive sides of the interface. To use SyncE on a port, the SyncModeEnable attribute for that port in the RpdSyncEPortCfg is set to true.

6.5.5.23.3 SourcePriority This attribute contains a priority level for the interface that is used in the selection process. Priorities reflect a preference of one synchronization source over the other. Equal synchronization source priorities reflect that no preference exists between the synchronization sources. Priority one is the highest priority.

6.5.5.23.4 RxSsm This attribute configures an SSM value for a receive network interface that is used in the selection process. If configured, this value overrides the received SSM value. Only generation 1 SSM is supported. If the NetworkType attribute in the parent RpdSyncECfg object is set to ‘eecOpt1’, the default is ‘dnu’ and only the following values are valid for this attribute: • other • prc • ssuA • ssuB • eec1 • dnu If the NetworkType attribute in the parent RpdSyncECfg object is set to ‘eecOpt2’, the default is ‘dus’ and only the following values are valid for this attribute: • other • prs • stu

 09/03/21 CableLabs 67 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• st2 • tnc • st3e • eec2 • dus The CCAP Core MUST reject any invalid RxSsm value given the type of network configured.

6.5.5.23.5 TxSsm This attribute configures an SSM value for a transmit network interface. If the NetworkType attribute in the parent RpdSyncECfg object is set to ‘eecOpt1’, the default is ‘dnu’ and only the following values are legal for this attribute: • other • prc • ssuA • ssuB • eec1 • dnu If the NetworkType attribute in the parent RpdSyncECfg object is set to ‘eecOpt2’, the default is ‘dus’ and only the following values are legal for this attribute: • other • prs • stu • st2 • tnc • st3e • sec2 • dus The CCAP Core MUST reject any invalid TxSsm value given the type of network configured.

6.5.5.23.6 HoldOff This attribute configures the hold-off timer for the interface. Hold-off time ensures that short activations of signal fail are not passed to the selection process.

6.5.5.23.7 WaitTimeToRestore This attribute configures the wait-to-restore timer for the interface. Wait-to-restore time ensures that a previously failed synchronization source is only again considered as available by the selection process if it is fault-free for a certain time.

6.5.5.23.8 ForceSwitchEnable When enabled, overrides the currently selected synchronization source by the selection of this interface, assuming this interface is enabled and not locked out. When disabled, the forced selection of this interface is removed.

68 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.5.23.9 ManualSwitchEnable When enabled, overrides the currently selected synchronization source, assuming this interface is enabled, not locked out, not in signal fail condition, and has a Quality Level better than DNU/DUS. When disabled, the manual switch selection of this interface is removed.

6.5.5.23.10 LockoutEnable When enabled, this interface is no longer considered available by the selection process. When disabled, the interface is considered available again by the selection process.

6.5.5.24 RpdClkCfg This object sets the clock type for the RPD and defines the most stringent application using the clock. The latter helps determine what thresholds and other parameters to use for clock performance (e.g., excessive holdover). The exact meaning of the application type is left to the vendor. Table 59 - RpdClkCfg Object Attributes

Attribute Type Required Type Units Default Name Attribute Constraints Value ClkType Enum No ptp(1), ptp hybrid(2) ClkApplications EnumBits No other(0), docsis and leakageDetection docsis(1) leakageDetection(2), dtpClassA(3), dtpClassB(4), mbhFrequency(5)

6.5.5.24.1 ClkType This attribute configures the type of clock used in the RPD. The value ‘ptp’ means the clock is required to be synchronized to a grandmaster clock using PTP protocol. The value ‘hybrid’ means the clock is both required to be both synchronized to a grandmaster using PTP protocol and frequency locked using SyncE on some Ethernet port.

6.5.5.24.2 ClkApplications This attribute configures the type of clock application(s) supported by this RPD and determines the accuracy required for the clock; if more than one application is enabled, the most stringent thresholds across all configured applications are used. Leakage detection requires the RPD to have a higher frequency accuracy as specified in [R-DTI] to generate CW tones at specific frequencies and enable the detection of the leakage of RF signals from the operator's physical HFC plant. The latest generations of mobile technologies require frequency synchronization and stringent time and phase synchronization for mobile backhaul applications. PTP is used for time and phase synchronization and may be used for frequency synchronization. Physical layer clocks, using SyncE, can also be used for frequency synchronization and assist in faster and more stabilized phase synchronization. DTP provides a method for passing phase/ToD information over the DOCSIS network with little jitter and minimal asymmetry from network buffering. Two classes of clocks, DTP class A and the more accurate DTP class B, provide both phase and frequency synchronization in the mobile backhaul network, while the MBH frequency clock provides only frequency synchronization. These clocks are described in [SYNC].

6.5.5.25 RpdSyslogCfg One of the ways that event notifications can be configured in R-PHY is for the RPD to send event notifications directly to a Syslog server. The RpdSyslogCfg object and child objects allow Syslog notifications to be configured on the RPD by the CCAP Core. The RpdSyslogCfg object is a container object that allows Syslog from the RPD to be configured.

 09/03/21 CableLabs 69 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 60 - RpdSyslogCfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity RpdSyslogServerCfg Directed composition to 1 1..2 RpdSyslogServerCfg RpdSyslogNotificationCfg Directed composition to 1 1..8 RpdSyslogNotificationCfg RpdSyslogThrottleCfg Directed composition to 1 0..1 RpdSyslogThrottleCfg

6.5.5.26 RpdSyslogServerCfg This object allows the Principal CCAP Core to configure the Syslog servers to which the RPD sends Syslog events. The RPD supports two Syslog server instances. Table 61 - RpdSyslogServerCfg Object Attributes

Attribute Type Required Attribute Type Constraints Units Default Name Value Index UnsignedByte Yes(key) 0..1 AddrType InetAddressType Yes ipv4(1), ipv6(2), ipv4z(3), ipv6z(4) IpAddress InetAddress Yes SIZE(4 | 16) AdminStatus Enum No up(1), up(1) down(2)

6.5.5.26.1 Index This attribute provides a unique identifier for this Syslog server entry.

6.5.5.26.2 AddrType This attribute configures the IP address type for the Syslog server notification address.

6.5.5.26.3 IpAddress This attribute configures the IP address to which Syslog notifications will be sent.

6.5.5.26.4 AdminStatus This attribute controls the administrative status of the Syslog server connection. Possible values are: ‘up’ - The RPD sends Syslog notifications to this Syslog server address. ‘down’ - The RPD does not send Syslog notifications to this Syslog server address.

6.5.5.27 RpdSyslogNotificationCfg This object allows the Principal CCAP Core to configure which Syslog notification levels get sent from the RPD to the configured Syslog server instances. There is one instance of this object for each Syslog notification priority level.

70 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 62 - RpdSyslogNotificationCfg Object Attributes

Attribute Type Required Attribute Type Constraints Units Default Name Value Priority EvPriorityType Key ReportingEnabled Boolean No See description

6.5.5.27.1 Priority This attribute defines to which Syslog event priority level the SyslogReporting attribute applies. Values mirror the DOCSIS event levels defined in [RFC 4639].

6.5.5.27.2 ReportingEnabled This attribute controls whether Syslog notification is enabled for the corresponding Syslog priority level. A value of true enables Syslog notifications for this priority level. The default value is true for the following levels: • Emergency • Alert • Critical • Error The default value is false for the following levels: • Warning • Notice • Information • Debug

6.5.5.28 RpdSyslogThrottleCfg This object allows the Principal CCAP Core to configure how Syslog notifications are throttled. Table 63 - RpdSyslogThrottleCfg Object Attributes

Attribute Type Required Type Constraints Units Default Name Attribute Value AdminStatus Enum No unconstrained(1), unconstrained maintainBelowThreshold(2), stopAtThreshold(3), inhibited(4) Threshold UnsignedInt No events 10 Interval UnsignedInt No seconds 10

6.5.5.28.1 AdminStatus This attribute controls the transmission of Syslog messages with respect to the trap pacing threshold. Valid values are: • unconstrained – causes syslog notifications to be transmitted without regard to the threshold settings. • maintainBelowThreshold – causes Syslog notifications to be suppressed if the number of notifications would otherwise exceed the threshold.

 09/03/21 CableLabs 71 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• stopAtThreshold – causes Syslog notifications to cease at the threshold and not to resume until directed to do so. • inhibited – causes all Syslog notifications to be suppressed.

6.5.5.28.2 Threshold This attribute configures the number of Syslog notifications per interval permitted before throttling is applied.

6.5.5.28.3 Interval This attribute configures the interval over which the throttling applies.

6.5.5.29 StreamingTelemetryCfg This object allows configuration of the Remote PHY Streaming Telemetry functionality.

Figure 9 - Streaming Telemetry Configuration Information Model

Table 64 - StreamingTelemetryCfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity TelemetryClientAccessCfg Directed composition to 1 0..1 TelemetryClientAccessCfg

6.5.5.30 CcapCore This object serves as the root for RPD configuration. The CcapCore object is described in section 6.5.1.

72 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.5.31 RpdCfg This object is the container for RemotePhyDevice configuration objects. The RpdCfg object is described in Section 6.5.1.1.

6.5.5.32 RemotePhyDevice This object is the container for Streaming Telemetry configuration objects. The RemotePhyDevice object is described in section 6.5.5.5.

6.5.5.33 TelemetryClientAccessCfg This object is used by the Principal CCAP Core to configure RPD access to the Telemetry Client. The RPD rejects attempts by an Auxiliary Core to configure Telemetry Client Access. Reference: [R-PHY] TcAccessControl section.

Table 65 - TelemetryClientAccessCfg Object Attributes

Attribute Type Required Type Constraints Units Default TLV Name Attribute Value Type Mode Enum Yes dialInDisabled(0), dialIndisabled 15.11.1 unrestricted(1), explicitlyAuthorizedOnly(2)

Table 66 - TelemetryClientAccessCfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity TelemetryClientDialInAccessListCfg Directed composition to 1 0..* TelemetryClientDialInAccessListCfg TelemetryClientDialOutAccessListCfg Directed composition to 1 0..* TelemetryClientDialOutAccessListCfg TelemetryClientDialOutRetryCfg Directed composition to 1 1 TelemetryClientDialOutRetryCfg

6.5.5.33.1 Mode This attribute allows the Principal CCAP Core to control Telemetry Client access to the RPD. It permits the Principal CCAP Core to disable Telemetry Client access, enable access from any Telemetry Client, or restrict access to those Telemetry Clients whose IP addresses and TCP ports are configured by the Principal CCAP Core in the TcDialInAccessList and the TcDialOutAccessList objects. The following values are defined for the Mode attribute: • 'dialInDisabled': No Telemetry Client can dial in to the RPD. • 'explicitlyAuthorizedOnly': The RPD allows access from only those Telemetry Clients whose IP addresses and TCP ports are present in the TcDialInAccessList and TcDialOutAccessList objects. • 'unrestricted: Any Telemetry Client can dial in into the RPD.

6.5.5.34 TelemetryClientDialInAccessListCfg This object is used to configure the list Telemetry Clients allowed to dial in to the RPD. Reference: [R-PHY] TcDialInAccessList section

 09/03/21 CableLabs 73 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 67 - TelemetryClientDialInAccessListCfg Object Attributes

Attribute Type Required Type Constraints Units Default TLV Name Attribute Value Type Index UnsignedByte Yes (Key) 15.11.2.1 IpAddress IpAddress Yes 15.11.2.2 Port UnsignedShort Yes 15.11.2.3

6.5.5.34.1 Index This key attribute is the index to the Telemetry Client Dial-In Access List.

6.5.5.34.2 ClientIpAddress This attribute configures the IP address of a Telemetry Client explicitly authorized to dial in to, configure subscriptions on, and receive Streaming Telemetry data from the RPD.

6.5.5.34.3 Port This attribute configures the destination TCP port on which the RPD will accept a dial-in connection.

6.5.5.35 TelemetryClientDialOutAccessListCfg This object is used to configure a list of IP addresses and TCP ports of Telemetry Clients to which the RPD initiates a dial-out connection. Reference: [R-PHY] TcDialOutAccessList section.

Table 68 - TelemetryClientDialOutAccessListCfg Object Attributes

Attribute Type Required Type Constraints Units Default TLV Name Attribute Value Type Index UnsignedByte Yes (Key) 15.11.3.1 IpAddress IpAddress Yes 15.11.3.2 Port UnsignedShort Yes 15.11.3.3

6.5.5.35.1 Index This key attribute is the index to the Telemetry Client Dial Out Access List.

6.5.5.35.2 IpAddress This attribute configures the IP address of a Telemetry Client that the RPD dials out to and that is authorized to configure subscriptions on and receive Streaming Telemetry data from the RPD.

6.5.5.35.3 Port This attribute configures the destination TCP port to which the RPD dials out.

6.5.5.36 TelemetryClientDialOutRetryCfg This object is used to configure parameters used by the RPD to retry a failed dial-out connection to a Telemetry Client. Reference: [R-PHY] TcDialOutRetryControl section.

74 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 69 - TelemetryClientDialOutRetryCfg Object Attributes

Attribute Type Required Type Constraints Units Default TLV Name Attribute Value Type MaxRetries UnsignedByte Yes 255 15.11.4.1 InitialBackoff UnsignedShort Yes 0..300 seconds 1 15.11.4.2 MaxBackoff UnsignedShort Yes 0..3600 seconds 300 15.11.4.3

6.5.5.36.1 MaxRetries This attribute configures the number of times the RPD attempts to restore a failed dial-out connection. Value 0 indicates no retries (do not retry). Value 255 indicates retry forever. The default value is 255.

6.5.5.36.2 InitialBackoff This attribute configures the length in seconds of the interval for which the RPD waits before the first reconnection attempt. The default value is 1 second.

6.5.5.36.3 MaxBackoff This attribute configures the maximum length in seconds of the interval for which the RPD waits between reconnection attempts when performing the exponential backoff process. The default value is 300 seconds.

6.5.6 Network Configuration Information Model This section is a collection of configuration objects that are specific to the network configuration of the chassis.

Figure 10 - Network Configuration Information Model

 09/03/21 CableLabs 75 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.6.1 NetworkCfg The NetworkCfg object is the primary container of network configuration objects. It is largely defined in Annex B, but is extended for RPHY as described in this section. All other objects are unmodified from [CCAP-OSSIv4.0] and are described fully there. NetworkCfg object associations specific to the Remote PHY architecture are defined in Table 70. Table 70 - New NetworkCfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity DefaultRphySessionCinDsLatencyMeasCfg Directed composition to 0..1 DefaultRphySessionCinDsLatencyMeasCfg DepiMcast Directed composition to DepiMcast 1 OobNdEngine Directed composition to OobNdEngine 1

6.5.6.2 DefaultRphySessionCinDsLatencyMeasCfg This object controls how often the CCAP Core measures CIN downstream latency and the thresholds for when warning and critical events are triggered. These events are defined in Annex B. If this object is not configured, the defaults apply and CIN downstream latency measurement is disabled. Note that if the Interval attribute is set to 0, then no latency measurements are made and the SessionCinDsLatencyStats object, defined in Section 7.1.8.7, will not be populated. Table 71 - DefaultRphySessionCinDsLatencyMeasCfg Object Attributes

Attribute Name Type Required Type Constraints Units Default Attribute Value Interval UnsignedShort Yes 0 | 1..420 seconds 0 WarningThrshld UnsignedShort Yes 0 | 1..20000 microseconds 0 CriticalThrshld UnsignedShort Yes 0 | 1..40000 microseconds 0 ThrshldPeriod UnsignedShort Yes 0..420 seconds 0

6.5.6.2.1 Interval This attribute configures the time interval, in seconds, used to periodically measure the CIN downstream latency on each R-PHY session. Measurement of CIN latency applies to active sessions only. A value of 0 indicates that CIN latency measurements are not made.

6.5.6.2.2 WarningThrshld This attribute configures the CIN downstream latency threshold measured in microseconds to be reported as a warning event when exceeded. When exceeded, an event with event ID 66080200 is triggered. A value of 0 indicates that no warning events will be generated.

6.5.6.2.3 CriticalThrshld This attribute configures the CIN downstream latency threshold measured in microseconds to be reported as a critical event when exceeded. When exceeded, an event with event ID 66080201 is triggered. A value of 0 indicates that no critical events will be generated.

6.5.6.2.4 ThrshldPeriod This attribute configures the number of seconds that a given session exceeds a threshold before the event is triggered. Larger values can be sent to suppress events for latency issues of short durations. A value of 0 indicates that there is no minimum threshold period and events should always be generated if enabled.

76 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.6.3 DepiMcast This object provides a method for restricting the permit range of multicast session IDs as described in the Session Setup section of [R-DEPI]. Table 72 - DepiMcast Object Attributes

Attribute Name Type Required Type Constraints Units Default Value Attribute DynamicRangeSessionIdStart UnsignedInt Yes 0x80000001..0x8000FFFF 0x80000001 DynamicRangeNumSessions UnsignedShort Yes 0

6.5.6.3.1 DynamicRangeSessionIdStart This attribute configures the start of a range of dynamically assigned R-DEPI Multicast session IDs, within the range 0x80000001..0x8000FFFF.

6.5.6.3.2 DynamicRangeNumSessions This attribute configures the maximum number of dynamically assigned R-DEPI Multicast session IDs starting at DynamicRangeSessionIdStart. The default value is zero, i.e., dynamic multicast session assignment is not permitted by default. The range is 0..65534, i.e., not including 65535, because the DynamicRangeSessionIdStart starts with 1.

6.5.6.4 OobNdEngine This configuration object is included in Figure 10 for reference. The OobNdEngine object is defined in Section 6.5.9.1.

6.5.7 OOB 55-1 Configuration Information Model Figure 11 defines the RPHY configuration Information Model for [SCTE 55-1].

Figure 11 - OOB-551 Configuration Information Model

6.5.7.1 Oob551Cfg The Oob551Cfg object is a container that holds OOB Controller instances and has the associations shown in Table 73.

 09/03/21 CableLabs 77 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 73 - Oob551Cfg Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Oob551OmCtrlr Directed composition to Oob551OmCtrlr 1 0..* Oob551NtwkCtrlr Directed composition to Oob551NtwkCtrlr 1 0..*

6.5.7.2 Oob551Ctlrs The abstract object Oob551Ctlrs allows the user to define the common configuration elements for an OOB 55-1 controller. There are two types of OOB 55-1 controllers defined for the core CCAP: the upstream Network Controller and the downstream OM Controller. Table 74 - Oob551Ctlrs Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints OobCtlrIpAddr InetAddressIpv4 Yes (key) IPv4 host Description AdminString No AdminState AdminStateType No Down

6.5.7.2.1 OobCrlrIpAddr This object configures the IPv4 host address for an OOB 55-1 controller.

6.5.7.2.2 Description This object configures the description of an OOB 55-1 controller.

6.5.7.2.3 AdminState This object configures the administrative state of an OOB 55-1 controller.

6.5.7.3 Oob551OmCtrlr The Oob551OmCtrlr object, which is a specialization of the Oob551Ctlrs object, defines a downstream OOB 55-1 OM Controller object. Each Oob551OmCtrlr object needs to have at least one OOB 55-1 DS Channel associated with it.

6.5.7.4 Oob551DsChan The Oob551DsChan object defines the OOB 55-1 downstream channel attributes. The associated OOB 55-1 OM controller is the source of the MPEG packets for the downstream channel. The associated DS RPHY service group defines the set of RPDs to receive this downstream channel. The RPD transmits each DS OOB 55-1 packet on the primary frequency and, if the secondary frequency is configured and the RPD supports two DS OOB 55-1 frequencies, on the secondary frequency. Table 75 - Oob551DsChan Object Attributes

Attribute Name Type Required Type Units Default TLV Attribute Constraints Type DestIpAddr InetAddressIpv4 Yes (Key) DestUdpPort InetPortNum Yes (Key) CenterFreq unsignedInt No 71,000 to KHz 75,250 91.4 129,000, 50 KHz granularity PowerAdjust TenthdB No TenthdB 0 91.5 AdminState AdminStateType No down 91.1

78 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Required Type Units Default TLV Attribute Constraints Type RfMute Boolean No false 91.3 SecondCenterFreq unsignedInt No 0, 71,000 to KHz 0 91.6 129,000, 50 KHz granularity SfPowerAdjust TenthdB No TenthdB 0 91.7 SfAdminState AdminStateType No down 91.8 SfRfMute Boolean No false 91.9

Table 76 - Oob551DsChan Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Oob551OmCtrlr Directed association to 1..* 1 Om551IpAddr Oob551OmCtrlr Oob551DsSg Directed aggregation to 1..* 1 DsSgIndex Oob551DsSg

6.5.7.4.1 DestIpAddr This is an index for an instance of this Object. The IPv4 DestIpAddr plus the DestUdpPort uniquely identify an incoming downstream OOB 55-1 stream of MPEG packets. The DestIpAddr may be either unicast or multicast.

6.5.7.4.2 DestUdpPort This is an index for an instance of this Object. The DestIpAddr plus the DestUdpPort uniquely identify an incoming downstream OOB 55-1 stream of MPEG packets.

6.5.7.4.3 CenterFreq This attribute configures the center frequency of the 1.8 MHz wide DS OOB 55-1 primary channel. The modulation of the channel is QPSK (2 bits per symbol).

6.5.7.4.4 PowerAdjust This attribute represents the power gain for the primary channel in tenths of a dBmV.

6.5.7.4.5 AdminState This attribute represents the administrative status of the primary channel. Setting the value to down results in the channel being muted.

6.5.7.4.6 RfMute This attribute configures the mute state for the primary DS OOB 55-1 channel.

6.5.7.4.7 SecondCenterFreq This attribute configures the center frequency of the 1.8 MHz wide second DS OOB 55-1 channel. If set to zero, the OOB 55-1 DS packets are only transmitted on the primary channel frequency.

6.5.7.4.8 SfPowerAdjust This attribute represents the power gain for the secondary channel in tenths of a dBmV.

 09/03/21 CableLabs 79 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.7.4.9 SfAdminState This attribute represents the administrative status of the secondary channel. Setting the value to down results in the channel being muted.

6.5.7.4.10 SfRfMute This attribute configures the mute state for the secondary DS OOB 55-1 channel.

6.5.7.5 Oob551NtwkCtrlr The Oob551NtwkCtrlr object, which is a specialization of the Oob551Ctlrs object, defines an OOB 55-1 Network Controller object. Each Oob551NtwkCtrlr object needs to have at least one OOB 55-1 Virtual ARPD associated with it.

6.5.7.6 Oob551VirtArpd The Oob551VirtArpd object defines a Virtual ARPD for aggregating OOB 55-1 upstream channels. Table 77 - Oob551VirtArpd Object Attributes

Attribute Type Required Type Units Default TLV Name Attribute Constraints Type SrcIpAddr InetAddressIpv4 Yes (key) Host IPv4 address 92.4 CoreUdpPort InetPortNum Yes NcUdpPort InetPortNum Yes

Table 78 - Oob551VirtArpd Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Oob551VirtUsRfPort Directed composition to Oob551VirtUsRfPort 1..6 Oob551NtwkCtrlr Directed association to Oob551NtwkCtrlr 1..32 1 VirtArpdNcIp

6.5.7.6.1 SrcIpAddr The Core IPv4 host address used as the source IP when sending US 55-1 OOB packets to a Network Controller.

6.5.7.6.2 CoreUdpPort The Core IPv4 UDP port number used as the source UDP port when sending US 55-1 OOB packets to a Network Controller.

6.5.7.6.3 NcUdpPort The Network IPv4 UDP port number used as the destination UDP port when sending US 55-1 OOB packets to a Network Controller. The CCAP Core MUST ensure that the NcUdpPort be unique across all Virtual ARPDs on the core.

6.5.7.7 Oob551VirtUsRfPort The Oob551VirtUsRfPort object defines a virtual RF port on a virtual ARPD for aggregating OOB 55-1 upstream channels. The associated US RPHY service group defines the set of RPD US RF ports to be virtually combined for this US channel.

80 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 79 - Oob551VirtUsRfPort Object Attributes

Attribute Type Required Type Units Default TLV Name Attribute Constraints Type RfPort UnsignedByte Yes (key) 1..6 92.5

Table 80 - Oob551VirtUsRfPort Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Oob551UsSg Directed aggregation to 1..* 1 UsSgIndex Oob551UsSg Oob551VirtUsChan Directed composition to 1..3 Oob551VirtUsUsChan

6.5.7.7.1 RfPort The Virtual RF port index on a Virtual ARPD for aggregating OOB 55-1 upstream channels.

6.5.7.8 Oob551VirtUsChan The Oob551VirtUsChan object defines the OOB 55-1 upstream channel attributes. Table 81 - Oob551VirtUsChan Object Attributes

Attribute Type Required Type Units Default TLV Name Attribute Constraints Type DemodId UnsignedByte Yes (key) 1..3 92.6 CenterFreq UnsignedShort Yes 5216..64736, KHz 92.3 in 192 KHz steps AdminState AdminStateType No down 92.1 TargetRxPowerAdjust TenthdB No Normalized to 1.6 MHz 1/10 dB 0 92.7

6.5.7.8.1 DemodId This is the index for an instance of this Object.

6.5.7.8.2 CenterFreq This attribute configures the center frequency of the 192 KHz wide US OOB 55-1 channel. The modulation of the channel is QPSK (2 bits per symbol).

6.5.7.8.3 AdminState This attribute represents the administrative status of the channel. Setting the value to down results in the channel receiver(s) being turned off.

6.5.7.8.4 TargetRxPowerAdjust This attribute represents the adjustment to the base target receive power. The expected power density for 1.6 MHz, for an US SCTE 55-1 OOB channel is the sum of the Base Target Rx Power in TLV 98.3 plus the value of this attribute.

6.5.7.9 Oob551ThrshldGrp The Oob551ThrshldGrp object defines the OOB 55-1 global configurable items. These thresholds control when the Core sends OOB 55-1 events as defined in Table 301. .

 09/03/21 CableLabs 81 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 82 - Oob551ThrshldGrp Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default LowPwrThrshld Byte No -20..0, 127 dB 127 HighPwrThrshld Byte No 0..20, 127 dB 127 TotalCellThrshld UnsignedByte No Cells/minute 0 CorrectedCellThrshld UnsignedByte No Cells/minute 0 UncorrectableCellThrshld UnsignedByte No Cells/minute 0

6.5.7.9.1 LowPwrThrshld This attribute sets the threshold for sending an OOB 55-1 low power event for an RPD US channel. If any cell on an RPD’s US OOB 55-1 channel has a power level less than this threshold, the CCAP Core sends a low power event for that channel. A value of 127 turns off sending the low power event.

6.5.7.9.2 HighPwrThrshld This attribute sets the threshold for sending an OOB 55-1 high power event for an RPD US channel. If any cell on an RPD’s US OOB 55-1 channel has a power level more than this threshold, the CCAP Core sends a high power event for that channel. A value of 127 turns off sending the high power event.

6.5.7.9.3 TotalCellThrshld This attribute sets the threshold for sending an OOB 55-1 excessive cells event for an RPD US port. If the average count over the last five minutes of total cells sent on an RPD US channel exceeds the threshold, the CCAP Core sends an excessive cells event for this RPD’s US OOB 55-1 channel. A value of 0 turns off sending the total cell count event.

6.5.7.9.4 CorrectedCellThrshld This attribute sets the threshold for sending an OOB 55-1 excessive corrected cells event for an RPD US port. If the average count over the last five minutes of corrected cells sent on an RPD US channel exceeds the threshold, the CCAP Core sends an excessive corrected cells event for this RPD’s US OOB 55-1 channel. A value of 0 turns off sending the corrected cell count event.

6.5.7.9.5 UncorrectableCellThrshld This attribute sets the threshold for sending an OOB 55-1 excessive uncorrectable cells event for an RPD US port. If the average count over the last five minutes of uncorrectable cells sent on an RPD US channel exceeds the threshold, the CCAP Core sends an excessive uncorrectable cells event for this RPD’s US OOB 55-1 channel. A value of 0 turns off sending the uncorrectable cell count event.

6.5.8 R-DTI Configuration Information Model The R-DTI configuration objects are new for the Remote PHY architecture and are shown in Figure 12.

82 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 12 - CCAP Core R-DTI Configuration Information Model

6.5.8.1 PtpClkCfg The PtpClkCfg is an abstract class from which the CCAP PTP clock and RPD PTP clocks are derived. There are no PTP clock objects instantiated per-se in a configuration based on the YANG model; only the derived CCAP Core and RPD PTP port objects are instantiated. All CCAP Core and RPD PTP clock objects that derive from the abstract PTP clock contain the attributes of the PTP clock. The PtpClkCfg object defines the PTP clock parameters.

 09/03/21 CableLabs 83 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 83 - PtpClkCfg Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints PtpClkProfileId MacAddress No 00-19-A7-02-01-00 PtpClkProfileVersion HexBinary No SIZE(3) 00-02-01 for G.8275.1 profile. 00-01-00 for G.8275.2 profile. PtpClkPriority1 UnsignedByte No 128 PtpClkPriority2 UnsignedByte No 255 PtpClkDomain UnsignedByte No 24 for G.8275.1 profile. 44 for G.8275.2 profile.

6.5.8.1.1 PtpClkProfileId This attribute contains the profile identifier. The default profile corresponds to the G.8275.2 profile, which is the only profile that the RPD is required to support. The G.8275.2 profile is described in [ITU-T G.8275.2]. The PTP profile defined in [ITU-T G.8275.1] is identified by the value “00-19-A7-01-02-01”.

6.5.8.1.2 PtpClkProfileVersion This attribute contains the PtpClkProfileVersion, which consists of two octets for a major version number (4 characters) and one octet for a minor version number (two characters).

6.5.8.1.3 PtpClkPriority1 This attribute contains the IEEE 1588 priority 1 value. The default is the G.8275.2 profile default; the value is unused for the slave operation with G.8275.1 and G.8275.2 profiles and should never be changed for slave clocks using that profile.

6.5.8.1.4 PtpClkPriority2 This attribute contains the IEEE 1588 priority 2 value. The default is the only legal value for slave clocks using the G.8275.1 and G.8275.2 profiles.

6.5.8.1.5 PtpClkDomain This attribute contains the PTP clock administrative domain. The default is the G.8275.2 profile default. The G.8275.2 profile range is 44-63. G.8275.1 profile permits value range of 24-43. G.8275.1 profile defines a default value of 24.

6.5.8.2 PtpPortCfg The PtpPortCfg is an abstract class from which all CCAP Core and RPD PTP ports are derived. There are no PTP Port objects instantiated per se in a configuration based on the YANG model; only the derived CCAP Core and RPD PTP port objects are instantiated. All CCAP Core and RPD PTP port objects that derive from the abstract PTP Port contain the attributes of the PTP Port. PtpPortCfg defines the common port-specific parameters for a PTP clock port. Most of the parameters are specified by assigning a PtpTemplateCfg object to the RPD PTP port. Table 84 - PtpPortCfg Object Attributes

Attribute Name Type Required Type Units Default Attribute Constraints Value PtpPortAdminState AdminStateType No down PtpPortTemplateIndex UnsignedByte No 1..100 1

84 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Required Type Units Default Attribute Constraints Value PtpPortGatewayAddrType InetAddressType No ipv4(1), ipv6(2) PtpPortGatewayAddr InetAddress No SIZE(4 | 16)

Table 85 - PtpPortCfg Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity PtpTemplateCfg Directed Association 0..* 1 PtpTemplateIndex

6.5.8.2.1 PtpPortAdminState This attribute contains the administrative state of the PTP clock port.

6.5.8.2.2 PtpPortTemplateIndex This attribute contains the PTP template used for this clock port. Template 1 always exists.

6.5.8.2.3 PtpPortGatewayAddrType This attribute represents the IP address type of the gateway address. This value is of type InetAddressType, which is defined by [RFC 4001].

6.5.8.2.4 PtpPortGatewayAddr This attribute contains the gateway address (next hop address) for PTP packets. If not set, normal routing is used. PtpMasterGatewayAddr takes precedence if set.

6.5.8.3 PtpTemplateCfg The PtpTemplateCfg object defines a template for configuring a PTP clock port. A PTP template may be used in configuring either an RPD PTP clock port or a CCAP Core PTP clock port. The template with index 1 always exists; it may be modified but may not be deleted. It is the default template for both RPD and CCAP Core PTP clock ports. For each PTP template with PtpDtiMode set to slave, the CCAP Core MUST ensure that the template be associated with a list of Master Clocks through a master clock index. For templates with PtpDtiMode set to master, any configured master clock index is ignored. Table 86 - PtpTemplateCfg Object Attributes

Attribute Name Type Required Type Units Default TLV Attribute Constraints Value Type PtpTemplateIndex UnsignedByte Key 1..100 N/A N/A PtpDtiMode DtiModeType No slave PtpCos UnsignedByte No 0..7 6 97.8.8 PtpDscp UnsignedByte No 0..63 46 97.8.9 PtpLogSyncInterval Byte No -7..1 2N seconds 97.8.11 between messages PtpLogAnncInterval Byte No -3..0 2N seconds 97.8.12 between messages PtpLogDelayReqInterval Byte No -7..0 2N seconds 97.8.13 between messages

 09/03/21 CableLabs 85 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Required Type Units Default TLV Attribute Constraints Value Type PtpAnncReceiptTimeout UnsignedByte No 2..255 Announce 97.8.14 intervals PtpUnicastDuration UnsignedShort No 100..1000 seconds 300 97.8.15 PtpLocalPriority UnsignedByte No 1..255 128 97.8.10 PtpDescription AdminString No "" PtpTxMacAddress MacAddress No “01-80-C2-00- “01-80- 97.8.18 00-0E” | “01- C2-00- 1B-19-00-00- 00-0E” 00”

Table 87 - PtpTemplateCfg Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity PtpMasterClkCfg Directed Composition 0..* 0..5

6.5.8.3.1 PtpTemplateIndex This attribute contains the template index for this PTP template. There is always a template with index 1.

6.5.8.3.2 PtpDtiMode This attribute indicates whether this PTP clock port runs in slave mode, in master mode, or in a hybrid slave mode with a packet-based equipment clock and a SyncE physical layer clock.

6.5.8.3.3 PtpCos This attribute indicates the class of service for PTP packets on this DTI port. This is used in 802.1q VLAN tags. This attribute is only utilized with G.8275.2 profile.

6.5.8.3.4 PtpDscp This attribute contains the DSCP value used in IP headers for PTP packets. This attribute is only utilized with G.8275.2 profile.

6.5.8.3.5 PtpLogSyncInterval This attribute is the logarithm, to base 2, of the requested mean period, in seconds, for requesting unicast Sync messages. The IEEE 1588 range is -7 (128 per second) to 1 (one per second), with a default of -4 (16 per second). The G.8275.2 profile range is -7 to 0, with no modification to the default. This attribute is only utilized with G.8275.2 profile.

6.5.8.3.6 PtpLogAnncInterval This attribute is the logarithm, to base 2, of the requested mean period, in seconds, for requesting unicast announce messages. The IEEE 1588 range is -3 (8 per second) to 3 (one every 8 seconds), with a default of once per second. The G.8275.2 profile range is -3 to 0, with no modification to the default. This attribute has an allowed range of more than one value only with G.8275.2 profile. Therefore, this attribute is only utilized with G.8275.2 profile.

6.5.8.3.7 PtpLogDelayReqInterval This attribute is the logarithm, to base 2, of the requested mean period, in seconds, for requesting unicast Delay_Resp messages. The IEEE 1588 range is -7 (128 per second) to 6 (one every 64 seconds), with a default of -4 (16 per second). The G.8275.2 profile range is -7 to 0, with no modification to the default. This attribute has an allowed range of more than one value only with G.8275.2 profile. Therefore, this attribute is only utilized with G.8275.2 profile.

86 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.8.3.8 PtpAnncReceiptTimeout This attribute, as defined in IEEE 1588, is the number of announce intervals that pass before a session times out. This value is not defined in the G.8275.2 profile.

6.5.8.3.9 PtpUnicastDuration This attribute, as defined in IEEE 1588, is the interval in seconds for which a PTP port requests unicast service. The G.8275.2 profile range is 60 to 1000 seconds, with the same default. This attribute is only utilized with G.8275.2 profile.

6.5.8.3.10 PtpLocalPriority This attribute contains the G.8275.1 and G.8275.2s profile local priority value.

6.5.8.3.11 PtpDescription This attribute contains a textual description of the PTP Template.

6.5.8.3.12 PtpTxMacAddress This attribute is used to configure the destination MAC address of transmitted PTP messages from the selected PTP port to the remote PTP port. This attribute is only utilized when the RPD or the CCAP Core port is configured for G.8275.1 profile. The following values are valid: - "01-80-C2-00-00-0E" - non forwardable PTP MAC address - "01-1B-19-00-00-00" - forwardable PTP MAC address. The default value is non-forwardable PTP MAC address ("01-80-C2-00-00-0E").

6.5.8.4 PtpMasterClkCfg The PtpMasterClkCfg object defines a list of master clocks to use with a PTP slave port with G.8275.2 profile. Up to five master addresses can be created in a list, but only the top two priorities will be used if the list is part of a template assigned to an RPD. For RPDs, the two highest priority master objects with PtpMasterAdminState set to Up are sent to the RPD using TLVs 97.8.4 for the highest priority admin up master and 97.8.5 for the second highest priority admin up master. If set, PtpMasterGatewayAddr for the highest priority admin up master is sent using TLV 97.8.16 and PtpMasterGatewayAddr for the second highest priority admin up master is sent using TLV 97.8.17. Table 88 - PtpMasterClkCfg Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints PtpMasterPriority UnsignedByte Key 1..5 N/A N/A PtpMasterAddr Host Yes N/A N/A PtpMasterAdminState AdminStateType No Up PtpMasterAddrType InetAddressType Yes ipv4(1), ipv6(2) PtpMasterGatewayAddr InetAddress No SIZE(4 | 16)

6.5.8.4.1 PtpMasterPriority This attribute indicates the priority of a master clock in this master clock list. Lower numbers are higher priority.

6.5.8.4.2 PtpMasterAddr This attribute contains the host address of a master network clock (either a grandmaster or boundary clock) to be used by a slave port. The CCAP Core MUST enforce that all addresses of master clocks in the same master clock

 09/03/21 CableLabs 87 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

list have the same IP address type: IPv4, IPv6, or FQDN. Support for FQDN is optional. If there are two or more FQDN values that resolve via DNS to the same IP address, or if the same absolute IP address is configured for two priorities in the same master clock list, only one master address is considered for use, the one that is admin up with the highest priority.

6.5.8.4.3 PtpMasterAdminState This attribute contains the administrative state of a master clock in this master clock list. Master Clocks with admin state down are not used.

6.5.8.4.4 PtpMasterAddrType This attribute represents the IP address type of both the gateway address and the master address. This value is of type InetAddressType, which is defined by [RFC 4001].

6.5.8.4.5 PtpMasterGatewayAddr This attribute contains the gateway address (next hop address) for PTP packets. If not set, PtpPortGatewayAddr is used, if set.

6.5.8.5 CorePtpClkCfg The CorePtpClkCfg is an instantiation of the abstract class PtpClkCfg and inherits those common attributes. The CorePtpClkCfg object defines the PTP clock parameters for the CCAP Core. A CCAP Core PTP clock MUST have at least one core PTP Clock port. Table 89 - CorePtpClkCfg Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity PtpClkCfg Specialization of PtpClkCfg CorePtpPortCfg Directed Composition 1 1..*

6.5.8.6 CorePtpPortCfg The CorePtpPortCfg is an instantiation of the abstract class PtpPortCfg and inherits those common attributes. The CorePtpPortCfg object defines the port-specific parameters for a CCAP Core PTP clock port. Most of the parameters are specified by assigning a PtpTemplateCfg object to the PTP port. Table 90 - CorePtpPortCfg Object Attributes

Attribute Name Type Required Type Units Default Value Attribute Constraints CorePtpPortIndex UnsignedShort Key CoreSlotNumber UnsignedInt No CoreEnetPortIndex UnsignedInt No

Table 91 - CorePtpPortCfg Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity PtpPortCfg Specialization of PtpPortCfg

6.5.8.6.1 CorePtpPortIndex This attribute contains the Core’s PTP clock port index.

88 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.8.6.2 CoreSlotNumber This attribute contains the CCAP Core slot number for an Ethernet port to be associated with this PTP port. The CCAP Core MUST ensure that, if CoreSlotNumber is set, CoreEnetPortIndex also be set. If not set, then any CCAP Core Ethernet port may be used for this PTP clock port.

6.5.8.6.3 CoreEnetPortIndex The CCAP Core port number for an Ethernet port to be associated with this PTP port. The CCAP Core MUST ensure that, if CoreEnetPortIndex is set, CoreSlotNumber also be set. If not set, then any CCAP Core Ethernet port may be used for this PTP clock port.

6.5.9 OOB Narrowband Digital Configuration Information Model Figure 13 shows the network model for NDF/NDR using static L2TPv3 sessions, to an NDF/NDR network engine. The engine provides the NDF/NDR data plane, while the Core does the GCP TLV signaling to setup the static sessions. Only static L2TPv3 sessions are part of this model for NDF/NDR configuration. The communication of configuration between the Core and the NDF/NDR network engine is out-of-scope for this specification.

Figure 13 - OOB Narrowband Digital Configuration Network Diagram

 09/03/21 CableLabs 89 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Figure 14 defines the RPHY configuration Information Model for OOB Narrowband Digital.

Figure 14 - OOB Narrowband Digital Configuration Information Model

6.5.9.1 OobNdEngine This object defines the attributes for the OOB narrowband digital engine which provides the NDF/NDR data plane. The Core does the GCP TLV signaling to setup the static sessions between the engine and the RPDs using the configured engine IP address. Multiple engines can be configured for different sets of NDF and/or NDR channels, or a single engine can be used for all NDF/NDR channels. Table 92 - OobNdEngine Object Attributes

Required Type Attribute Name Type Units Default Value Attribute Constraints Index UnsignedInt Yes (Key) AddrType InetAddressType Yes ipv4(1), ipv6(2) IpAddress InetAddress Yes SIZE(4 | 16) Description AdminString No

6.5.9.1.1 Index This attribute identifies the OOB Narrowband Digital engine.

6.5.9.1.2 AddrType This attribute configures the IP address type for an OOB ND engine.

90 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.5.9.1.3 IpAddress This attribute configures the IP address (IPv4 or IPv6) for an OOB ND engine. This is the source address for unicast NDF channels and the destination address for NDR channels.

6.5.9.1.4 Description This attribute configures the description of an OOB ND engine.

6.5.9.2 OobNdfDsChan The OobNdfDsChan object defines the OOB NDF downstream channel attributes. The associated OOB ND engine is the source of the I/Q symbol packets for the downstream channel. In the downstream direction the OOB ND engine connects to the RPD(s) via a static session directly to the RPD(s). When applicable, the MulticastSessionId identifies the associated static L2TPv3 broadcast session. The associated RpdDsAssocList defines the set of downstream RPD RF ports to receive this downstream channel as well as any multicast IP address to use for a multicast L2TPv3 session and, if using source-specific multicast, the source address of the multicast. If the L2TPv3 DEPI session is unicast, then no address is configured for the RpdDsAssocList, which results in one of the unicast IP addresses for the RPD being used for the session. The RPD transmits each OOB NDF packet on the RF channel defined by the center frequency and channel width. The CCAP Core MAY allow multiple instances of the OobNdfDsChan object to be configured, even with exactly the same parameters (other than the index). Because the L2TPv3 session carrying the data for the NDF channel is static, the Core cannot keep any data plane counts for that channel. For that reason, the core is not required to place the NDF channel into its ifTable. However, the Core MAY place NDF channels using static sessions into its ifTable (for example to control admin state in a common way for every channel type). If the core does place NDF channels using static sessions into its ifTable, the packet and octet counts will always be zero. Table 93 - OobNdfDsChan Object Attributes

Required Type Attribute Name Type Units Default Value Attribute Constraints Index UnsignedInt Yes (Key) AdminState AdminStateType No up/down Down RfMute Boolean No False CenterFreq UnsignedInt Yes 50,000 to KHz 1,000,000, 25KHz granularity ChanWidth UnsignedInt Yes 80, 160, 320, KHz 640, 1,280, 2,560, 5,120, 25,600 PowerAdjust TenthdB No Normalized to TenthdB 0 1.6 MHz

Table 94 - OobNdfDsChan Object Associations

Associated Object Near-end Far-end Type Label Name Multiplicity Multiplicity OobNdEngine Directed aggregation to 1..* 1 EngineIndex OobNdEngine RpdDsAssocList Directed aggregation to 1..* 1 AssocListIndex RpdDsAssocList OobNdfDsSession Directed composition to 1 1 OobNdfDsSession

 09/03/21 CableLabs 91 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.5.9.2.1 Index This attribute identifies the OOB NDF downstream channel. The CCAP Core MAY use the ifIndex from the ifTable as the NDF DS channel index if it puts such channels into its ifTable.

6.5.9.2.2 AdminState This attribute represents the administrative status of the channel.

6.5.9.2.3 RfMute This attribute represents whether or not the channel is muted.

6.5.9.2.4 CenterFreq This attribute configures the center frequency of the OOB NDF DS channel.

6.5.9.2.5 ChanWidth This attribute configures the channel width of the OOB NDF DS channel.

6.5.9.2.6 PowerAdjust This attribute configures power level adjustment for the OOB NDF DS channel relative to the base power level configured for the DS RF port in units of tenth dB. The total power of the NDF channel is the sum of the base port power, any configured tilt adjustment, and the PowerAdjust value.

6.5.9.3 OobNdrDsSession This object contains the configurable parameters for a multicast L2TPv3 DEPI session. Table 95 - OobNdrDsSession Object Attributes

Required Attribute Name Type Type Constraints Units Default Value Attribute Mtu UnsignedShort No 1280..2000 1982 Dscp UnsignedByte No 0 MulticastSessionId UnsignedInt No 0x80000001..0x8000ffff 0

6.5.9.3.1 Mtu This attribute configures the MTU (Maximum Transmission Unit) size supported by the OOB Narrowband Digital Engine for this NDF channel. The MTU is the Layer 3 payload of a Layer 2 frame.

6.5.9.3.2 Dscp This attribute configures the 6-bit DSCP with which the RPD transmits L2TPv3 data packets on the selected return direction static pseudowire for this NDF channel. This attribute configures information equivalent to the PHBID field of the Upstream Flow AVP.

6.5.9.3.3 MulticastSessionId This attribute configures the multicast L2TPv3 session ID when the NDF channel is being multicast. The CCAP Core MUST configure the MulticastSessionId to be used by the RPD if an NDF channel is being sent on a multicast pseudowire. If the NDF channel is being unicast, this attribute is ignored. The value of this attribute is taken from the multicast session ID range.

6.5.9.4 OobNdrUsChan The OobNdrUsChan object defines the OOB NDR upstream channel attributes. The associated OOB NDR US engine is the destination of the I/Q symbol packets for the upstream channel. In the upstream direction the RPD

92 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

connects to the OOS ND engine via a static session (directly from the RPD(s) to the controller). The associated RpdUsAssocList defines the set of RPD RF ports as a source of this upstream channel. The source address of the NDR L2TPv3 session is the RPD transmitting the packets, while the destination address is the associated OobNdEngine's IP address. The RPD generates each OOB NDR packet from the RF channel defined by the center frequency and channel width. Multiple instances of the OobNdrUsChan object MAY be configured by the CCAP Core, even with exactly the same parameters, provided no two instances with overlapping spectrum are assigned to RpdUsAssocLists having a common RPD US RF port. Because the L2TPv3 session carrying the data for the NDR channel is static, the Core cannot keep any data plane counts for that channel. For that reason, the core is not required to place the NDR channel into its ifTable. However, the CCAP Core MAY place NDR channels using static sessions into its ifTable (for example to control admin state in a common way for every channel type). When the core does place NDR channels using static sessions into its ifTable, the packet and octet counts will always be zero. Table 96 - OobNdrUsChan Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default Value Index UnsignedInt Yes (Key) AdminState AdminStateType No up/down Down CenterFreq UnsignedInt Yes 5,000 to 42,000, 25KHz KHz granularity ChanWidth UnsignedInt Yes 80, 160, 320, 640, 1,280, 2,560, KHz 5,120 TargetRxPwrAdj TenthdB No TenthdB 0

Table 97 - OobNdrUsChan Object Associations

Associated Object Near-end Far-end Type Label Name Multiplicity Multiplicity OobNdEngine Directed aggregation to 0..* 1 EngineIndex OobNdEngine RpdUsAssocList Directed aggregation to 0..* 1 AssocListIndex RpdUsAssocList OobNdrUsSession Directed composition to OobNdrUsSession

6.5.9.4.1 Index This attribute identifies the OOB NDR upstream channel. The CCAP Core MAY use the ifIndex from the ifTable as the NDR US channel index if it puts such channels into its ifTable.

6.5.9.4.2 AdminState This attribute represents the administrative status of the channel.

6.5.9.4.3 CenterFreq This attribute configures the center frequency of the OOB NDR US channel.

6.5.9.4.4 ChanWidth This attribute configures the channel width of the OOB NDR US channel.

6.5.9.4.5 TargetRxPwrAdj This attribute configures the desired target receive power level for the OOB NDR US channel from the base target power reference level specified for the corresponding US RF port. The value represents power spectral density and

 09/03/21 CableLabs 93 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

is specified in units of tenth dB. The target receive power for the channel is computed by adding the value of this attribute to the value of base target power reference level for the corresponding RF port.

6.5.9.5 OobNdrUsSession This object contains the configurable parameters for the unicast L2TPv3 UEPI session. Table 98 - OobNdrUsSession Object Attributes

Attribute Name Type Required Attribute Type Constraints Units Default Value Mtu UnsignedShort No 1280..2000 1982 Dscp UnsignedByte No 0

6.5.9.5.1 Mtu This attribute configures the MTU (Maximum Transmission Unit) size supported by the OOB Narrowband Digital Engine for this NDR channel. The MTU is the Layer 3 payload of a Layer 2 frame.

6.5.9.5.2 Dscp This attribute configures the 6-bit DSCP with which the RPD transmits L2TPv3 data packets on the selected return direction static pseudowire for this NDR channel. This attribute configures information equivalent to the PHBID field of the Upstream Flow AVP.

6.6 CCAP Core Control Information Model

These objects allow direct control of different aspects of a specific RPD from the Principal CCAP Core via RCP.

6.6.1 CCAP Core RPD Control Information Model These objects allow direct control of different aspects of a specific RPD via GCP communication from the Principal CCAP Core. Control objects are not required to be persisted across CCAP Core reinitializations. Figure 15 defines the RPD control information model.

Figure 15 - CCAP Core RPD Control Information Model

94 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.6.1.1 RpdCtrl The RpdCtrl object is the primary container of RPD Control objects. It has the following attributes and associations: Table 99 - RpdCtrl Object Attributes

Attribute Type Access Type Constraints Units Default TLV Type Name Value UniqueId MacAddress Key 50.19.4

Table 100 - RpdCtrl Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdResetCtrl Directed composition to RpdResetCtrl 1 1 RpdLogCtrl Directed composition to RpdLogCtrl 1 1 RpdSsdCtrl Directed composition to RpdSsdCtrl 1 1 RpdCrashDataFileCtrl Directed composition to RpdCrashDataFileCtrl 1 1 RpdCrashDataServerCtrl Directed composition to RpdCrashDataServerCtrl 1 1 RpdInitProvCtrl Directed composition to RpdInitProvCtrl 1 1

6.6.1.1.1 UniqueId This attribute specifies a globally unique 6-byte identifier for the RPD to which the command is being sent.

6.6.1.2 RpdResetCtrl The Principal CCAP Core provides support for controlling resets of RPDs. This control object allows an RPD to be reset remotely via GCP from the Principal CCAP Core. The RpdResetCtrl TLV is 40.1 Table 101 - RpdResetCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Value Type Reset Enum Read-write softReset(1), softReset 40.1.1 hardReset(2), nvReset(3), factoryReset(4) SoftResetAttemptEnabled Boolean Read-write true 40.1.2 SoftResetAttemptPending Boolean Read-only 40.1.3 SoftResetAttemptControl Boolean Read-write 40.1.4 DefaultAuxReconnectFailReset Boolean Read-write false 15.10

6.6.1.2.1 Reset This attribute allows a reset of the RPD to be commanded. Reading this attribute always returns a value of softReset. The following reset states are supported: softReset: The device performs a soft reset and clears the volatile downloaded configuration. The RPD that does not support softReset will perform a hard reset when commanded to do a soft reset. Refer to [R-PHY] for more information. hardReset: The device performs a power-on reset and clears the volatile downloaded configuration. nvReset: The device clears most non-volatile configuration and performs a hard reset. Refer to [R-PHY] for details on which configuration attributes are cleared.

 09/03/21 CableLabs 95 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

factoryReset: The device restores the factory configuration and performs a hard reset. Refer to [R-PHY] for details.

6.6.1.2.2 SoftResetAttemptEnabled This attribute is a non-volatile configuration of the initial value of SoftResetAttemptPending after a hard reset. Refer to SoftResetAttempts section in [R-PHY] for details.

6.6.1.2.3 SoftResetAttemptPending This attribute is a Boolean flag that reports how the RPD is configured to handle the requirement to "perform a SoftResetAttempt". Refer to the SoftResetAttempts section in [R-PHY] for details.

6.6.1.2.4 SoftResetAttemptControl This attribute permits a Principal Core to overwrite the value of SoftResetAttemptPending. Refer to the SoftResetAttempts section in [R-PHY] for details.

6.6.1.2.5 DefaultAuxReconnectFailReset This attribute sets the default value of the AuxReconnectFailReset object in a GcpConnVerification row. Only the Principal Core is permitted to change the value of this attribute with GCP.

6.6.1.3 RpdLogCtrl This control object provides RPD log management functions. The RpdLogCtrl TLV is 40.2. Table 102 - RpdLogCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default Value TLV Type ResetLog BITS Read-write localEventLog(0), 40.2.1 eventPendingQueue(1)

6.6.1.3.1 ResetLog This attribute controls resetting an RPD's local event log and/or the pending event queue. Reading this value returns the value zero. Setting an individual bit to 1 resets the corresponding RPD log or queue. Note that the GCP TLV definition conveys the ResetLog control information to the RPD through two individual values. Setting both bits in ResetLog attribute requires setting two instances of TLV 40.2.1 value, one for each bit.

6.6.1.4 RpdSsdCtrl The CCAP Core is responsible for facilitating secure updates to software running on RPDs. The RPD Secure Software Download process is described in the Secure Software Download section of [R-PHY]. Table 103 summarizes the CCAP Core objects used for RPD SSD management. The RpdSsdCtrl TLV Type is 90. Table 103 - RpdSsdCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Value Type SsdServerAddressType InetAddressType Read-write ipv4(1), N/A ipv6(2) SsdServerAddress InetAddress Read-write SIZE(4 | 16) 90.1 SsdTransport Enum Read-write tftp(1), http(2) 90.2 SsdFilename AdminString Read-write 90.3 SsdManufCvcChain HexBinary Read-write 90.6

96 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units Default TLV Value Type SsdCosignerCvcChain HexBinary Read-write 90.7 SsdAdminControl Enum Read-write other(1), other 90.5 startSsd(2), abortSsd(3), activateImage(4) SsdStatus Enum Read-only other(1), 90.4 idle(2), inProgress(3), cvcVerified(4), cvcRejected(5), codeFileVerified(6), codeFileRejected(7) activateRejected(8) SwImageIndex UnsignedByte Read-write 0..3 90.8 SsdStatusInfo AdminString Read-only 90.9

6.6.1.4.1 SsdServerAddressType This attribute represents the IP address type of the server. This value is of type InetAddressType, which is defined by [RFC 4001].

6.6.1.4.2 SsdServerAddress This attribute identifies the SSD server in the form of IPv4 or IPv6 address.

6.6.1.4.3 SsdTransport This attribute communicates the type of transport for the RPD download of the software file. The supported transports are TFTP and HTTP.

6.6.1.4.4 SsdFilename This attribute contains one of the following: • The filename of the software image to be downloaded via TFTP, or • The path-absolute of the software image URL for HTTP download. These attributes are identical to the Cable Modem SSD; however, the description and reference has been updated. Reference: [RFC 3986]

6.6.1.4.5 SsdManufCvcChain This attribute is used to communicate the certificate chain from the new PKI that contains both the Manufacturer Code Verification Certificate and the certification authority (CA) certificate that issued the Manufacturer Code Verification Certificate for Secure Software Download. The Manufacturer CVC Chain TLV (M-CVC-C) is used to enable the RPD to download the code file from the download server.

6.6.1.4.6 SsdCosignerCvcChain This attribute is used to communicate the certificate chain from the new PKI that contains both the Co-signer Code Verification Certificate and the certification authority (CA) certificate that issued the Co-signer Code Verification Certificate for Secure Software Download. The Co-signer CVC Chain TLV (C-CVC-C) is used to enable the RPD to download the code file from the download server.

 09/03/21 CableLabs 97 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

6.6.1.4.7 SsdAdminControl This attribute allows the CCAP Core to maintain control over the SSD process. When read, this attribute returns other. Reference: [R-PHY] Support for Multiple Software Images section.

6.6.1.4.8 SsdStatus This attribute reports the status of the SSD process in the RPD. Upon successful completion of the SSD operation, depending on the software image which has been updated, the RPD could reboot and become operational with the new software image. After reboot, the RPD always reports a value of idle for this attribute. The Identification and ExtendedSwSupport objects provide status information on the last successful SSD operation. If enabled, RPD events are generated to report the status of SSD operations. This applies to software image download and activation. Reference: [R-PHY] RPD Software Upgrade Procedure section

6.6.1.4.9 SwImageIndex This attribute identifies the software image that is the target of secure software download or software image activation. The CCAP Core can select the Main Software Image (MSI) or any other image that the RPD reports as upgradeable by SSD.

6.6.1.4.10 SsdStatusInfo This attribute contains a human readable text string containing helpful information to describe the current status of SSD process. This applies to software image download and activation.

6.6.1.5 RpdCrashDataFileCtrl This object provides CCAP Core control attributes needed to initiate an RPD upload of a crash analysis file to the Server. There is an instance of this object for each file that is available for upload from the device. Each instance of this object corresponds to an instance of RpdCrashDataFileStatus. The RpdCrashDataFileCtrl TLV is 40.3. Table 104 - RpdCrashDataFileCtrl Object Attributes

Attribute Type Access Type Constraints Units Default TLV Name Type Index UnsignedByte Key 1..255 40.3.1 FileControl Enum Read-write other(1), 40.3.2 upload(2), cancelUpload(3), deleteFile(4), uploadAndDelete(5)

6.6.1.5.1 Index This key attribute uniquely identifies a particular device crash analysis file.

6.6.1.5.2 FileControl This attribute controls the action taken by the device regarding the file selected by Index attribute. When a value is written to this attribute for a given instance of the RpdCrashDataFileCtrl object, the device is required to take that action on the associated crash data file. The possible actions are: other(1) - This value is returned when the attribute is read. This value is not writeable. upload(2) - If the FileControl attribute of the RpdCrashDataFileCtrl object is set to 'upload', the CCAP Core MUST signal the RPD to initiate an upload to the server with the parameters specified in the 'DestIpAddr', 'DestIpAddrType', 'Protocol', 'HttpFilenameKeyword', and 'DestPath' attributes of the RpdCrashDataServerCtrl object.

98 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

cancelUpload(3) - If the FileControl attribute of the RpdCrashDataFileCtrl object is set to 'cancelUpload', the CCAP Core MUST signal the RPD to cancel a pending upload. deleteFile(4) - If the FileControl attribute of the RpdCrashDataFileCtrl object is set to 'deleteFile', the CCAP Core MUST signal the RPD to delete the file from its memory. uploadAndDelete(5) - If the FileControl attribute of the RpdCrashDataFileCtrl object is set to 'uploadAndDelete', the CCAP Core MUST signal the RPD to upload the selected file and upon successful completion of the upload, delete the file from its memory.

6.6.1.6 RpdCrashDataServerCtrl This object provides the CCAP Core control attributes needed by the RPD to describe the upload server for crash analysis files. The RpdCrashDataFileCtrl TLV is 40.4. Table 105 - RpdCrashDataServerCtrl Object Attributes

Attribute Name Type Access Type Units Default TLV Type Constraints DestIpAddrType InetAddressType Read-write ipv4(1), N/A ipv6(2) DestIpAddr InetAddress Read-write SIZE(4 | 16) 40.4.1 DestPath AdminString Read-write zero length 40.4.2 string Protocol Enum Read-write other(1), tftp(2) 40.4.3 tftp(2), http(3) HttpFilenameKeyword AdminString Read-write 40.4.4

6.6.1.6.1 DestIpAddrType This attribute represents the IP address type of the server. This value is of type InetAddressType, which is defined by [RFC 4001]. A successful connection depends on the value of this attribute being set to an IP version provisioned on the device. For example, if this value is set to IPv6 and the device is provisioned for IPv4-only operation, a successful upload will not be possible. In this case the FileStatus attribute in the RpdCrashDataFileStatus object would reflect the error.

6.6.1.6.2 DestIpAddr This attribute represents the IP address of the server to which the crash analysis file is to be sent. This attribute is further defined by the DestIpAddrType attribute.

6.6.1.6.3 DestPath This attribute represents the path, excluding the filename, at the server to which the crash analysis file is to be sent via TFTP. This attribute is not used when uploading files via HTTP. By default, the value of this attribute is an empty string. If used, this value includes all expected delimiters. The following examples, excluding the quotes, are valid values: '/Directory1/directory2/' '/crash/'

6.6.1.6.4 Protocol This attribute represents the protocol used during the upload. When the Protocol is set to 'http(3)', the RPD performs HTTP POST with URL 'http://DestIpAddr:80'.

 09/03/21 CableLabs 99 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

POST /test/demo_form.php HTTP/1.1 Host: //DestIpAddr:80 PostFilenameKword='crashDataFilename'

6.6.1.6.5 HttpFilenameKeyword This attribute represents HTTP POST keyword which is used by the HTTP server to convey the crash data filename.

6.6.1.7 RpdInitProvCtrl This object allows the asset ID, device alias, and location of the RPD to be updated by the operator once an RPD is authenticated to the CCAP Core. Generally, the values of these attributes are provisioned on the RPD as part of the staging or installation process. However, there could be occasions when an operator needs to update these values on an RPD that is already in service. Table 106 - RpdInitProvCtrl Object Attributes

Attribute Name Type Access Type Units Default TLV Type Constraints Value AssetId AdminString Read-write SIZE(0..32) 50.19.17 DeviceAlias AdminString Read-write 50.19.8 LocationDescription AdminString Read-write 50.24.1 GeoLocationLatitude AdminString Read-write SIZE(9) 50.24.2 GeoLocationLongitude AdminString Read-write SIZE(10) 50.24.3

6.6.1.7.1 AssetId This attribute is modeled after entPhysicalAssetID object defined in RFC 6933. AssetId is used to communicate the asset tracking identifier as assigned by a network manager. When this attribute is written, the RPD stores its value in its non-volatile configuration.

6.6.1.7.2 DeviceAlias This attribute communicates a device name assigned by the operator via management interface. This attribute is an 'alias' name for the device as specified by a network manager and provides a non-volatile 'handle' for the RPD. When this attribute is written, the RPD stores its value in its non-volatile configuration.

6.6.1.7.3 LocationDescription This attribute allows a short text description to be written to the RPD describing where the RPD has been installed, such as a street address. The format is specific to the operator. When this attribute is written, the RPD stores its value in its non-volatile configuration.

6.6.1.7.4 GeoLocationLatitude This attribute allows the latitude portion of the RPD’s geographic location to be written to the RPD. It consists of a 9-byte string formatted as specified in [ISO 6709]. The RPD uses ‘6-digit notation’ in the format: deg, min, sec, ±DDMMSS.S (for example: -750015.1). A value of ‘+000000.0’ indicates that the latitude is not set. When this attribute is written, the RPD stores its value in its non-volatile configuration.

6.6.1.7.5 GeoLocationLongitude This attribute allows the longitude portion of the RPD’s geographic location to be written to the RPD. It consists of a 10-byte long string formatted as specified in [ISO 6709]. The RPD uses ‘7-digit notation’ in the format: deg, min, sec, ±DDDMMSS.S (for example: -0100015.1). A value of+0000000.0’ indicates that the longitude is not set. When this attribute is written, the RPD stores its value in its non-volatile configuration.

100 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.7 RPD Information Model

This section defines configuration and control objects specific to an RPD. Typically, normative requirements are assigned to data models, such as MIB objects or schemas, derived from information models and not to information models themselves. However, for the case of RPD-specific configuration and control objects defined in this section, data models are not defined, so normative requirements are assigned to the information model to indicate the RPD is required or recommended to implement the objects and their attributes as defined in this specification, with the condition that vendor-specific management interfaces such as a command line interface are provided to manage such objects.

6.7.1 RPD Configuration Information Model These objects allow direct configuration of different aspects of a specific RPD. These objects are generally static and configured when a Remote PHY device is installed in the field (or prior to that installation as a pre-provisioning step).

Figure 16 - RPD Configuration Information Model

While not defined in Figure 16 - RPD Configuration Information Model, the RPD MAY support configuration of the Ethernet Interface Alias and Description via vendor-proprietary methods.

6.7.1.1 RemotePhyDevice The RemotePhyDevice object serves as the root of the RPD configuration data. The RPD MUST implement the RemotePhyDevice object. Table 107 - RemotePhyDevice Object Attributes

Attribute Name Type Access Type Constraints Units Default Value DeviceAlias AdminString Read-write “” AssetId AdminString Read-write “”

 09/03/21 CableLabs 101 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 108 - RemotePhyDevice Object Associations

Associated Object Name Type Near-end Multiplicity Far-end Multiplicity Label Location Directed composition to Location 1 1

6.7.1.1.1 DeviceAlias This attribute configures the device name assigned by the operator and represents a "handle" for the RPD. If the DeviceAlias is not set, this attribute will report a zero-length string.

6.7.1.1.2 AssedId This attribute configures an asset tracking identifier for the physical entity and provides non-volatile storage of this information. If the AssetId string associated with the physical component is not set, this attribute will report a zero- length string.

6.7.1.2 Location The Location object allows configuration of an RPD’s location data. The RPD MUST implement the Location object. Table 109 - Location Object Attributes

Attribute Name Type Access Type Constraints Units Default Value LocationDescription AdminString Read-write SIZE(1..255) Latitude AdminString Read-write SIZE(9) Longitude AdminString Read-write SIZE(10)

6.7.1.2.1 LocationDescription This attribute configures a short text description of where the RPD has been installed, such as a street address. The format is specific to the operator.

6.7.1.2.2 Latitude This attribute configures the latitudinal coordinate of the RPD location, expressed as a 9-byte long string as described in [ISO 6709] (6 digit degrees, minutes, seconds: ±DDMMSS.S). For example: -750015.1. This value could be provided by a GPS receiver within the module.

6.7.1.2.3 Longitude This attribute configures the longitudinal coordinate of the RPD location, expressed as a 10-byte long string as described in [ISO 6709] (7 digit degrees, minutes, seconds: ±DDDMMSS.S). For example: -0100015.1. This value could be provided by a GPS receiver within the module.

6.7.1.3 Mutual Authentication The configuration object provides enable and disable functions for mutual authentication on the connection between the RPD and the CCAP Core. The RPD MUST implement the MutualAuthentication object. The RPD persists values of this object across reboots. Table 110 - MutualAuthentication Object Attributes

Attribute Name Type Access Type Constraints Units Default Value IsRequired Boolean Read-write true

6.7.1.3.1 IsRequired This attribute controls the enabling or disabling of mutual authentication and hence, IP security on the connection between RPD and the CCAP Core. The RPD is configured for Mutual Authentication by setting this attribute to

102 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

True (initiate authentication) or False (do not initiate authentication). This attribute is accessible only via RPD command line interface.

6.7.1.4 IpAcquisition This configuration object allows for the configuration of IP acquisition behaviors, such as fault handling. The RPD MUST implement the IpAcquisition Object. The RPD persists values of this object across reboots. Table 111 - IpAcquisition Object Attributes

Attribute Name Type Access Type Constraints Units Default Value WaitTime UnsignedInt Read-write 0..86400 seconds 1800

6.7.1.4.1 WaitTime This attribute configures a timer which starts when IP acquisition is initiated on the RPD's interfaces. The attribute is global to the RPD and establishes the timeout period, in seconds, before the RPD declares a failure to acquire an IP address on any of its active interfaces. Refer to [R-PHY] for details on the IP acquisition timer operation and behavior. Setting a value of zero will disable the timer.

6.7.2 RPD Control Information Model These objects allow direct control of different aspects of a specific RPD. The RebootDisableCtrl object has TLVs defined but they are not exposed over the OSS interface. The objects in this model are resident on the RPD and are used via SSH. Use of these attributes is vendor-specific.

Figure 17 - RPD Control Information Model

6.7.2.1 RemotePhyDevice The RemotePhyDevice object serves as the root of the RPD control data and is defined in this section. The attributes in the RemotePhyDevice can only be modified via the RPD Configuration model.

 09/03/21 CableLabs 103 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 112 - RemotePhyDevice Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RebootDisableCtrl Directed composition to RebootDisableCtrl 1 1 ResetCtrl Directed composition to ResetCtrl 1 1 LogCtrl Directed composition to LogCtrl 1 1 CrashDataFileCtrl Directed composition to CrashDataFile Ctrl 1 1 CrashDataServerCtrl Directed composition to CrashDataServerCtrl 1 1 SsdCtrl Directed composition to SsdCtrl 1 1

6.7.2.2 RebootDisableCtrl This control object disables automatic reboot of the RPD for a specified period of time to allow remote connection to an RPD that is uninterrupted by an automatic reboot. The RPD reboots automatically if it is not able to successfully complete the initialization process defined in [R-PHY]. If an RPD is unable to initialize and is stuck in a cycle of automatic reboots, this object allows the automatic reboot to be disabled so that the debugging process is not interrupted by automatic RPD reboot. The reboot disable automatically times out so that an RPD is not accidentally kept from rebooting in the future. The RPD MUST implement the RebootDisableCtrl object. The RebootDisableCtrl TLV is 40.5 and is not exposed over the OSS interface. Table 113 - RebootDisableCtrl Object Attributes

Attribute Name Type Access Type Units Default TLV Type Constraints Value RebootDisable Boolean Read-write false 40.5.1 DisableTimeout UnsignedInt Read-write 1..360 Seconds 360 40.5.2

6.7.2.2.1 RebootDisable The value of this attribute sets whether the automatic reboot should be delayed or not. If set to true, the RPD will not reboot until the value in the DisableTimeout attribute has elapsed. If reboot has been disabled, setting this value to false allows the RPD to automatically reboot. If the RPD had failed to initialize, it could reboot when the value is set to false. This value resets to false on reinitialization.

6.7.2.2.2 DisableTimeout When RebootDisable is set to true, this attribute controls how long the RPD should wait until it reboots and begins the initialization process again. The timer countdown begins when RebootDisable is set to true. This value resets to the default on reinitialization.

6.7.2.3 ResetCtrl This control object allows an RPD to be reset remotely. The RPD MUST implement the ResetCtrl object. Table 114 - ResetCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default Value Reset Enum Read-write softReset(1), softReset hardReset(2), nvReset(3), factoryReset(4)

6.7.2.3.1 Reset This attribute allows a reset of the RPD to be commanded by writing an enumeration option. The following reset states are supported: • softReset: The RPD performs a soft reset.

104 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

• hardReset: The RPD performs a power-on reset. • nvReset: The RPD clears most non-volatile configuration and performs a hard reset. Refer to [RPHY] for details on which configuration attributes are cleared. • factoryReset: The RPD restores the factory configuration and performs a hard reset.

6.7.2.4 LogCtrl This control object provides RPD log management functions. The RPD MUST implement the LogCtrl object. Table 115 - RpdLogCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default Value ResetLog EnumBits Read-write localEventLog(0), 0x00 eventPendingQueue(1)

6.7.2.4.1 ResetLog This attribute controls resetting an RPD's local event log and/or the pending event queue. Reading this value returns the value zero. Setting an individual bit to 1 resets the corresponding RPD log or queue.

6.7.2.5 CrashDataFileCtrl This object provides control attributes needed for the device to upload a crash analysis file to the Server. There is an instance of this object for each file that is available for upload from the device. Each instance of this object corresponds to an instance of CrashDataFileStatus. The RPD MUST implement the CrashDataFileCtrl object. Table 116 - CrashDataFileCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default Index UnsignedByte Key 1..255 FileControl Enum Read-write other(1), upload(2), cancelUpload(3), deleteFile(4), uploadAndDelete(5)

6.7.2.5.1 Index This key attribute uniquely identifies a particular device crash analysis file.

6.7.2.5.2 FileControl This attribute controls the action taken by the device regarding the file selected by Index attribute. When a value is written to this attribute for a given instance of the CrashDataFileCtrl object, the device is required to take that action on the associated crash data file. The possible actions are: • other(1) - This value is returned when the attribute is read. This value is not writeable. • upload(2) - If the FileControl attribute of the CrashDataFileCtrl object is set to 'upload', the RPD MUST initiate an upload to the server with the parameters specified in the 'DestIpAddr', 'DestIpAddrType', 'Protocol', 'HttpFilenameKeyword', and 'DestPath' attributes of the CrashDataServerCtrl object. This action will change the value of the FileStatus attribute to 'uploadInProgress' while the transfer is ongoing. This attribute can only be set to 'upload' when the value of the 'FileStatus' attribute is not set to a value of 'uploadInProgress' for this instance or any instance of CrashDataFileCtrl. This limits the upload process to one upload at a time. This attribute will return 'inconsistentValue' for this case. • cancelUpload(3) - If the FileControl attribute of the CrashDataFileCtrl object is set to 'cancelUpload', the RPD MUST cancel a pending upload. The value of the FileStatus attribute will be changed to 'uploadCancelled'.

 09/03/21 CableLabs 105 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• deleteFile(4) - If the FileControl attribute of the CrashDataFileCtrl object is set to 'deleteFile', the RPD MUST delete the file from its memory and delete this instance of CrashDataFileCtrl. The RPD MUST reject the attempt to set the FileControl attribute of the CrashDataFileCtrl object to deleteFile(4) while an upload is in progress. • uploadAndDelete(5) - If the FileControl attribute of the CrashDataFileCtrl object is set to 'uploadAndDelete', the RPD MUST first upload the selected file. If the FileControl attribute of the CrashDataFileCtrl object is set to 'uploadAndDelete', when the upload successfully completes, the RPD MUST delete the file from its memory and delete this instance of CrashDataFileCtrl.

6.7.2.6 CrashDataServerCtrl This object provides the control attributes needed by the RPD to describe the upload server for crash analysis files. The RPD MUST implement the CrashDataServerCtrl object. Table 117 - CrashDataServerCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default DestIpAddrType InetAddressType Read- ipv4(1) write ipv6(2) DestIpAddr InetAddress Read- SIZE(4 | 16) write DestPath AdminString Read- zero length write field Protocol Enum Read- other(1) tftp(2) write tftp(2) http(3) HttpFilenameKeyword AdminString Read- write

6.7.2.6.1 DestIpAddrType A successful connection depends on the value of this attribute being set to an IP version provisioned on the device. For example, if this value is set to IPv6 and the device is provisioned for IPv4-only operation, a successful upload will not be possible. In this case the FileStatus attribute in the CrashDataFileStatus object would reflect the error.

6.7.2.6.2 DestIpAddr This attribute represents the IP address of the server to which the crash analysis file is to be sent. This attribute is further defined by the DestIpAddrType attribute.

6.7.2.6.3 DestPath This attribute represents the path, excluding the filename, at the server to which the crash analysis file is to be sent via TFTP. This attribute is not used when uploading files via HTTP. By default, the value of this attribute is an empty string. If used, this value includes all expected delimiters. The following examples, excluding the quotes, are valid values: '/Directory1/directory2/' '/crash/'

6.7.2.6.4 Protocol This attribute represents the protocol used during the upload. When the Protocol is set to 'http(3)', the RPD performs HTTP POST with URL 'http://DestIpAddr:80'.

POST /test/demo_form.php HTTP/1.1 Host: //DestIpAddr:80 PostFilenameKword='crashDataFilename'

106 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

6.7.2.6.5 HttpFilenameKeyword This attribute represents HTTP POST keyword which is used by the HTTP server to convey the crash data filename.

6.7.2.7 SsdCtrl The RPD Secure Software Download (SSD) process is described in the Secure Software Download section of [R- PHY]. Table 118 summarizes the attributes implemented and maintained by the RPD to enable the management of the SSD process. The RPD MUST implement the SsdCtrl object. Table 118 - SsdCtrl Object Attributes

Attribute Name Type Access Type Constraints Units Default Value SsdServerAddressType InetAddressType Read- ipv4(1) write ipv6(2) SsdServerAddress InetAddress Read- SIZE(4 | 16) write SsdTransport Enum Read- tftp(1), write http(2) SsdFilename AdminString Read- write SsdManufCvcChain HexBinary Read- write SsdCosignerCvcChain HexBinary Read- write SsdAdminControl Enum Read- other(1), other write startSsd(2), abortSsd(3), activateImage(4) SsdStatus Enum Read- other(1), only idle(2), inProgress(3), cvcVerified(4), cvcRejected(5), codeFileVerified(6), codeFileRejected(7), activateRejected(8) SwImageIndex UnsignedByte Read- 0..3 0 write SsdStatusInfo AdminString Read- only

6.7.2.7.1 SsdServerAddressType This attribute represents the IP address type of the server. This value is of type InetAddressType, which is defined by [RFC 4001].

6.7.2.7.2 SsdServerAddress This attribute identifies the SSD server in the form of IPv4 or IPv6 address.

6.7.2.7.3 SsdTransport This attribute identifies the type of transport for the RPD transfer of the software file. The supported transports are TFTP and HTTP.

6.7.2.7.4 SsdFilename This attribute contains one of the following:

 09/03/21 CableLabs 107 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• The filename of the software image to be downloaded via TFTP, or • The path-absolute of the software image URL for HTTP download. These attributes are identical to the Cable Modem SSD; however, the description and reference has been updated. Reference: [RFC 3986]

6.7.2.7.5 SsdManufCvcChain This attribute is used to communicate the certificate chain from the new PKI that contains both the Manufacturer Code Verification Certificate and the certification authority (CA) certificate that issued the Manufacturer Code Verification Certificate for Secure Software Download. The Manufacturer CVC Chain TLV (M-CVC-C) is used to enable the RPD to download the code file from the download server.

6.7.2.7.6 SsdCosignerCvcChain This attribute is used to communicate the certificate chain from the new PKI that contains both the Co-signer Code Verification Certificate and the certification authority (CA) certificate that issued the Co-signer Code Verification Certificate for Secure Software Download. The Co-signer CVC Chain TLV (C-CVC-C) is used to enable the RPD to download the code file from the download server.

6.7.2.7.7 SsdAdminControl This attribute allows the RPD to maintain control over the SSD process. When this attribute is read, the RPD returns a value of "other." Reference: [R-PHY] Support for Multiple Software Images section.

6.7.2.7.8 SsdStatus This attribute reports the status of the SSD process in the RPD. This includes software image download and activation.

6.7.2.7.9 SwImageIndex This attribute identifies the software image that is the target of Secure Software Download or software image activation.

6.7.2.7.10 SsdStatusInfo This attribute contains a human readable text string containing helpful information to describe the current status of SSD process. This applies to software image download and activation.

108 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7 PERFORMANCE MANAGEMENT

This section defines CCAP Core and RPD requirements for performance management functions.

7.1 Performance Management UML Information Model

The following sections define the CCAP Core and RPD UML Information Models for status and statistics reporting. TLVs defined in Annex B of [R-PHY] realize the data model derived from the Performance Management information model defined in this section, for the General Control Protocol (GCP) and required for the RPD. MIB objects listed in Section A.1 realize the Performance Management data model mandated for the CCAP Core.

7.1.1 Data Type Definitions This section includes the data types defined for the Performance Management Information Model. Table 119 - Data Types

Data Type Name Base Type Permitted Values Reference RphyChannelType Enum other(0), dsScQam(1), dsOfdm(2), ndf(3), scte551Fwd(4), usAtdma(5), usOfdma(6), reserved(7), ndr(8), scte551Ret(9), dsScte55d2(10), usScte55d2(11)

7.1.1.1 RphyChannelType This data type indicates a type of RPHY channel. Reference: [R-PHY] RfChannelType TLV.

7.1.2 General Attribute Requirements This section describes requirements or behavioral information related to attributes used throughout the Performance Management Information Model.

7.1.2.1 DiscontinuityTime DiscontinuityTime attributes are used to indicate the last time there was a discontinuity in a set of counters. If no discontinuity has occurred, these attributes contain the boot time. For counts kept by the core, the DiscontinuityTime attribute is normally of type Timestamp (e.g., ifCounterDiscontinuityTime). If no discontinuities have occurred, this type of DiscontinuityTime attribute contains zero. The time of any discontinuity is then just the current value of sysUpTime. For counts kept by the RPD and forwarded to the core, the DiscontinuityTime attribute is of type DateTime. The RPD reports the timestamp for a counter discontinuity with a DateTime timestamp based on its time-of-day at the time of the event. If the RPD cannot determine absolute time of day, it assigns midnight, Jan 1, 1970 UTC as the initial values for all discontinuity times. If there then is a real discontinuity in some counter while absolute time of day is still unknown, the RPD calculates a new timestamp by converting sysUpTime to months, days, hours, minutes, seconds, and deciseconds, then adds those to midnight, Jan 1, 1970 UTC, which becomes the new discontinuity time value for that counter. Even after establishing time-of-day, an RPD that hasn't otherwise cleared counters is permitted to report a counter's initial discontinuity with the default initial timestamp of midnight, Jan 1, 1970 UTC.

 09/03/21 CableLabs 109 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The Core SHOULD convert a discontinuity dateTime reported by the RPD that is earlier than 1972 into a delta of timeTicks (0.01 seconds) that have passed since midnight, Jan 1, 1970 UTC, by subtracting that from the RPD's current sysUpTime, subtracting this intermediate number from the Core's current dateTime converted to timeTicks, converting the result back into dateTime, and using that for the discontinuity time stored in the MIB variable. This intermediate result represents the number of ticks since RPD boot time when the discontinuity occurred. Since this number is kept as unsigned integer, it cannot be negative. DiscontinuityTime values from an RPD between Jan 1, 1972 and December 31, 2017 UTC, are considered invalid; the Core MUST store Jan 1, 1970 UTC as the CounterDiscontinuityTime in the DiscontinuityTime MIB variable in place of such an invalid dateTime.

7.1.3 RPD Device Information Model These objects provide reporting of RPD device-level information via communication from the CCAP Core. Figure 18 defines the RPD device level information model reported via the CCAP Core.

110 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 18 - RPD Device Information Model

7.1.3.1 CcapCore The CcapCore object serves as the root of the RPD Device Information Model. The CcapCore object is defined in Section 6.5.1 and referenced here.

 09/03/21 CableLabs 111 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 120 - CcapCore Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdInfo Directed composition to RpdInfo 1 0..* RpdShelfInfo Directed composition to RpdShelfInfo 1 0..*

7.1.3.2 RpdInfo This object identifies the RPD for which the details and statistics are being provided. The RpdInfo object is read from the GCP complex TLV Type 100. The attributes defined in the RpdInfo object are read from the GCP complex TLV Type 100.1. Table 121 - RpdInfo Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length RpdUniqueId MacAddress Key N/A 50.19.4 See [R-PHY] RpdSysUpTime TimeStamp Read-only Hundredths of a 100.1.1 4 second NumCrashFilesAvail UnsignedByte Read-only N/A 100.1.2 1 PrincipalCoreStatus Enum Read-only connected(1), 87.1 1 waitOperational(2), operational(3)

Table 122 - RpdInfo Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity Identification Directed composition to Identification 1 1 CoresConnected Directed composition to CoresConnected 1 1 DsUsRfPortAlloc Directed composition to DsUsRfPortAlloc 1 1 RpdL2tpSessionInfo Directed composition to RpdL2tpSessionInfo 1 0..* DepiMcastSession Directed composition to DepiMcastSession 1 1 DiagnosticStatus Directed composition to DiagnosticStatus 1 1 Oob551UsChanStatus Directed composition to Oob551UsChanStatus 1 1 CrashDataFileStatus Directed composition to CrashDataFileStatus 1 1 HostResources Directed composition to HostResources 1 1 CandidateBackupCores Directed composition to CandidateBackupCores 1 1 RpdShelfInfo Association to RpdShelfInfo 1 0 ResetHistory Directed composition to ResetHistory 1 0..* ChanBcastGroupStatus Directed composition to ChanBcastGroupStatus 1 0..* RpdTrfStats Directed composition to RpdTrfStats 1 0..1 RpdLcceStats Directed composition to RpdLcceStats 1 0..* RpdCurrentControlConnections Directed composition to 1 0..* RpdCurrentControlConnections Location Directed composition to Location 1 1

112 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.3.2.1 RpdUniqueId This attribute specifies a globally unique 6-byte identifier for the RPD. By convention, an RPD SHOULD use the MAC address of the lowest numbered Ethernet port facing the CIN.

7.1.3.2.2 RpdSysUpTime The time (in hundredths of a second) since the RPD was last re-initialized. This value is reported by the RPD.

7.1.3.2.3 NumCrashFilesAvail This attribute reports the number of crash analysis files available.

7.1.3.2.4 PrincipalCoreStatus This attribute reports the RPD status with respect to the Principal Core initialization. 'connected' – The RPD is connected to the Principal Core and in the process of being configured 'waitOperational' – The Principal Core has set 'configuration complete' to true, but has not made the RPD operational 'operational' – The Principal Core has made the RPD operational The reported values correspond to values 5..7 of the RCP/GCP attribute TopLevelRpdstate (TLV 87.1) for the index assigned by the RPD to the Principal CCAP Core.

7.1.3.3 Identification This object provides data that uniquely identifies the RPD. The Identification TLV Type is 50.19. Table 123 - Identification Object Attributes

Attribute Name Type Access Type Units TLV Type Constraints VendorName AdminString Read-only 50.19.1 VendorId UnsignedShort Read-only 50.19.2 ModelNumber AdminString Read-only 50.19.3 SerialNumber AdminString Read-only SIZE(0..16) 50.19.9 DeviceAlias AdminString Read-only 50.19.8 DeviceDescription AdminString Read-only 50.19.7 CurrentSwVersion AdminString Read-only 50.19.5 BootRomVersion AdminString Read-only 50.19.6 HwRevision AdminString Read-only 50.19.16 UsBurstReceiverVendorId UnsignedShort Read-only 50.19.10 UsBurstReceiverModelNumber AdminString Read-only SIZE(3..16) 50.19.11 UsBurstReceiverDriverVersion AdminString Read-only SIZE(3..16) 50.19.12 UsBurstReceiverSerialNumber AdminString Read-only SIZE(5..16) 50.19.13 RpdRcpProtocolVersion AdminString Read-only SIZE(3..32) 50.19.14 RpdRcpSchemaVersion AdminString Read-only SIZE(5..32) 50.19.15 CurrentSwImageLastUpdate DateTime Read-only 50.19.19 CurrentSwImageName AdminString Read-only 50.19.20 CurrentSwImageServerType InetAddressType Read-only ipv4(1), N/A ipv6(2) CurrentSwImageServerAddress InetAddress Read-only SIZE(4 | 16) 50.19.21 CurrentSwImageIndex UnsignedByte Read-only 0..3 50.19.22

 09/03/21 CableLabs 113 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Units TLV Type Constraints VspSelector AdminString Read-only SIZE(0..16) 50.19.18

Table 124 - Identification Object Associations

Associated Type Near-end Far-end Label Object Name Multiplicity Multiplicity ExtSwImageSupport Directed composition to ExtSwImageSupport 1 1

7.1.3.3.1 VendorName This attribute reports the RPD manufacturer. The format is vendor proprietary.

7.1.3.3.2 VendorId This attribute reports the IANA-assigned SMI Network Management Private Enterprise Code of the vendor, as specified in [RFC 5612].

7.1.3.3.3 ModelNumber This attribute reports the model name and number used by the vendor to identify the RPD. The format is vendor proprietary.

7.1.3.3.4 SerialNumber This attribute reports the serial number of the RPD. The format is vendor proprietary.

7.1.3.3.5 DeviceAlias This attribute reports the device name assigned by the operator and represents a "handle" for the RPD.

7.1.3.3.6 DeviceDescription This attribute reports a short text description of the RPD provided by the RPD manufacturer.

7.1.3.3.7 CurrentSWVersion This attribute reports the version number of the software currently running on the RPD. The format is vendor proprietary.

7.1.3.3.8 BootRomVersion This attribute reports the version number of the boot ROM currently installed on the RPD. The format is vendor proprietary.

7.1.3.3.9 HwRevision This attribute reports the revision number of the RPD hardware. The format is vendor proprietary.

7.1.3.3.10 UsBurstReceiverVendorId This attribute reports the IANA-assigned SMI Network Management Private Enterprise Code of the RPD's US burst receiver manufacturer, as specified in [RFC 5612].

7.1.3.3.11 UsBurstReceiverModelNumber This attribute reports the model number used by the vendor to identify the RPD's US burst receiver. The format is vendor proprietary.

114 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.3.3.12 UsBurstReceiverDriverVersion This attribute reports the driver version of the RPD's US burst receiver. The format is vendor proprietary.

7.1.3.3.13 UsBurstReceiverSerialNumber This attribute reports the serial number of the RPD's US burst receiver. The format is vendor proprietary.

7.1.3.3.14 RpdRcpProtocolVersion This attribute reports the version of the RCP protocol supported by the RPD. The RPD MUST report the RCP protocol version as '1.0'.

7.1.3.3.15 RpdRcpSchemaVersion This attribute reports the version of the RCP schema supported by the RPD. The RPD MUST report the RCP schema protocol version as '1.0.X', where X is a number selected by the RPD manufacturer.

7.1.3.3.16 CurrentSwImageLastUpdate This attribute reports the most recent date and time the software image currently running on the RPD was updated. The RPD preserves the value of this attribute across reboots for a given software image.

7.1.3.3.17 CurrentSwImageName This attribute reports the name of the software image currently running on the RPD. The RPD preserves the value of this attribute across reboots for a given software image.

7.1.3.3.18 CurrentSwImageServerType This attribute reports the server internet address type of the software image currently running on the RPD. The RPD preserves the value of this attribute across reboots for a given software image.

7.1.3.3.19 CurrentSwImageServerAddress This attribute reports the Internet address of the server from which the software image currently running on the RPD was downloaded. The RPD preserves the value of this attribute across reboots.

7.1.3.3.20 CurrentSwImageIndex This attribute reports which software image is currently running on the RPD.

7.1.3.3.21 VspSelector This attribute contains the Vendor-Specific Pre-configuration (VSP) Selector advertised by the RPD, defined as a human-readable string. This attribute is used by the Principal CCAP Core to match the RPD to VSP configuration maintained on the CCAP Core and to deliver VSP configuration to the RPD during initialization. If the RPD does not support VSP, the RPD communicates VSP as a zero-length string.

7.1.3.4 Location This object provides location details for the RPD. The values are populated via a management interface or other automatic mechanisms (e.g., GPS). The Location TLV Type is 50.24. Table 125 - Location Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type LocationDescription AdminString Read-only SIZE(1..255) 50.24.1 Latitude AdminString Read-only SIZE(9) 50.24.2

 09/03/21 CableLabs 115 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Constraints Units TLV Type Longitude AdminString Read-only SIZE(10) 50.24.3

7.1.3.4.1 LocationDescription This attribute reports a short text description of where the RPD has been installed, such as a street address. The format is specific to the operator.

7.1.3.4.2 Latitude This attribute reports the latitudinal coordinate of the RPD location, expressed as a 9-byte long string as described in [ISO 6709] (6 digit degrees, minutes, seconds: DDMMSS.S). For example: -750015.1. This value could be provided by a GPS receiver within the module.

7.1.3.4.3 Longitude This attribute reports the longitudinal coordinate of the RPD location, expressed as a 10-byte long string as described in [ISO 6709] (7 digit degrees, minutes, seconds: DDDMMSS.S). For example: -0100015.1. This value could be provided by a GPS receiver within the module.

7.1.3.5 CoresConnected This object provides a list of CCAP Cores to which the RPD is authenticated, including the CCAP Core on which this object is polled. For each CCAP Core instance, the RPD indicates if that CCAP Core is the principal Core. These values are provided by the CCAP Core on initialization. The CoresConnected TLV Type is 60. Table 126 - CoresConnected Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type Index UnsignedByte Key 60.1 CoreId HexBinary Read-only SIZE(6) 60.2 AddressType InetAddressType Read-only ipv4(1), N/A ipv6(2) Address InetAddress Read-only SIZE(4 | 16) 60.3 IsPrincipal Boolean Read-only 60.4 CoreName AdminString Read-only 60.5 VendorId UnsignedShort Read-only 60.6 CoreMode Enum Read-only active(1), 60.7 backup(2), notActing(3), decisionPending(4), outOfService(5), contactPending(6), deprecated(7), redirect(8) InitialConfigurationComplete Boolean Read-only 60.8 CoreFunction EnumBits Read-only principal(0), 60.10 docsis(1), broadcastVideo(2), narrowcastVideo(3), scte55d1Oob(4), scte55d2Oob(5), ndf(6), ndr(7), monitoring(8)

116 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type AuxCoreRpdState Enum Read-only other(0), 87.4.4 authenticateToCore(1), gcpConfig(2), waitForRcpIraReq(3), waitForConfigRexReq(4), waitOperationalAuxCore(5), operationalAuxCore(6), outOfService(7) ResourceSetIndex UnsignedByte Read-only 60.11 GcpBackupConnectionConfig Boolean Read-only 60.13 GcpConnectionStatus Enum Read-only inactive(1), 105.3 connecting(2), connected(3), reconnecting(4) GcpBackupCoreStatus Enum Read-only waitForCoreMode(1), 107.3 active(2), backup(3), coreNotActing(4), handover(5) AuthenticationStatus Enum Read-only other(0) 105.4 authenticated(1), authFailed(2), authNotPerformed(3)

7.1.3.5.1 Index This key attribute uniquely identifies an instance of the CoresConnected object.

7.1.3.5.2 CoreId This attribute reports the unique identifier, for example a MAC address, of the CCAP Core identified in the row entry.

7.1.3.5.3 AddressType This attribute represents the IP address type of the CCAP Core. This value is of type InetAddressType, which is defined by [RFC 4001].

7.1.3.5.4 Address This attribute reports the IPv4 or IPv6 address of the CCAP Core.

7.1.3.5.5 IsPrincipal This attribute reports whether the CCAP Core is a principal core. A value of true indicates this CCAP Core is the principal core. A value of false indicates this CCAP Core is not a principal core.

7.1.3.5.6 CoreName This attribute reports the name of the CCAP Core as conveyed to the RPD.

7.1.3.5.7 VendorId This attribute reports the IANA-assigned SMI Network Management Private Enterprise Code of the vendor, as specified in [RFC 5612].

 09/03/21 CableLabs 117 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.5.8 CoreMode This attribute indicates the role in which the CCAP Core is currently acting for the RPD. It also identifies two intermediate states ('decisionPending' and 'contactPending') in which the role of the CCAP Core is still to be determined. 'active' – The CCAP Core is actively providing service(s) to the RPD as a Principal or Auxiliary CCAP Core. 'backup' – The CCAP Core is configured to provide backup service for an active CCAP Core. 'notActing' – The CCAP Core is not prepared to act as an active or backup CCAP Core. 'decisionPending' – The CCAP Core requires further information to make a decision on acting for the RPD or redirecting the RPD. 'outOfService' – An error occurred during the initialization process with the CCAP Core or the RPD has been instructed to place the CCAP Core in Out-Of-Service mode. 'contactPending' – The initial state after configuring the CCAP Core. The CCAP Core has not yet been contacted by the RPD. 'deprecated' – Reserved 'redirect' – A CCAP Core wishing to redirect an RPD does this by sending an IRA message with the CoreMode set to 'redirect'. This is the mode for the CCAP Core after it has instructed the RPD to redirect to an alternate CCAP Core.

7.1.3.5.9 InitialConfigurationComplete This attribute reports whether the Core has indicated that its initial configuration of the RPD is complete.

7.1.3.5.10 CoreFunction This attribute reports the operational functions that this Core provides. 'principal' – Core operates as a Principal Core 'docsis' – Core provides DOCSIS services 'broadcastVideo' – Core provides broadcast video services 'narrowcastVideo' – Core provides narrowcast video services 'scte55d1Oob' – Core provides SCTE 55-1 OOB services 'scte55d2Oob' – Core provides SCTE 55-2 OOB services 'ndf' – Core provides narrowband digital forward services 'ndr' – Core provides narrowband digital return services 'monitoring' – Core provides monitoring functions

7.1.3.5.11 AuxCoreRpdState This attribute identifies the current operational status with this Auxiliary CCAP Core. If the attribute IsPrincipal contains a value of ‘true’, this attribute has no meaning since it only applies to Auxiliary Cores. 'other' – This value is reported in cases not defined below 'authenticateToCore' – The RPD is in the process of authenticating to the Auxiliary Core 'gcpConfig' – The RPD is in the process of being configured by the Auxiliary Core 'waitForRcpIraReq' – The RPD is waiting for the IRA message from the Auxiliary Core 'waitForConfigRexReq' – The RPD is waiting for the first REX message from the Auxiliary Core 'waitOperationalAuxCore' – The RPD is waiting for the Auxiliary Core to make it operational

118 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

'operationalAuxCore' – The RPD is operational with this Auxiliary Core 'outOfService' – The Auxiliary Core has reported to the RPD that it is out of service Note that the indexing of the RPD’s AuxCoreState table (TLV 87.4) and the CoresConnected object can differ. To correctly report the AuxCoreRpdState, the CCAP Core needs to read the AuxCoreState table and match the obtained results to the CoresConnected object entries by comparing the AuxCoreId (TLV 87.4.2) to the CoreId attribute.

7.1.3.5.12 ResourceSetIndex This attribute reports the resource set index used by the core.

7.1.3.5.13 GcpBackupConnectionConfig This attribute reports whether a GCP control connection is maintained to the Core when it is acting as a Backup Core.

7.1.3.5.14 GcpConnectionStatus This attribute reports the status of the GCP connection to the Core as seen by the RPD.

7.1.3.5.15 GcpBackupCoreStatus This attribute reports the operating mode of the Core as seen by the RPD.

7.1.3.5.16 AuthenticationStatus This attribute reports the authentication status of the selected CCAP Core. other(0) – This value is reported in cases not defined below. authenticated(1) - The RPD is authenticated with the selected CCAP Core. authFailed(2) - RPD authentication with the selected CCAP Core has failed. authNotPerformed(3) - RPD authentication with the selected CCAP Core has not been performed.

7.1.3.6 CandidateBackupCores This object provides a list of IP addresses of those CCAP Cores which are to be contacted by the RPD as potential backups to the selected Core. Table 127 - CandidateBackupCores Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type ConnectedCoreIndex UnsignedByte Key 60.1 BackupCoreIpAddrIndex UnsignedByte Key N/A 60.14.1 BackupCoreAddrType InetAddressType Read-only ipv4(1), N/A N/A ipv6(2) BackupCoreAddr InetAddress Read-only SIZE(4 | 16) N/A 60.14.2

7.1.3.6.1 ConnectedCoreIndex This key attribute uniquely identifies a row in CoresConnected table.

7.1.3.6.2 BackupCoreIpAddrIndex This key attribute identifies a row in CandidateBackupCores table.

 09/03/21 CableLabs 119 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.6.3 BackupCoreAddrType This attribute represents the IP address type of the potential backup CCAP Core. This value is of type InetAddressType, which is defined by [RFC 4001].

7.1.3.6.4 BackupCoreAddr This attribute reports the IPv4 or IPv6 address of the CCAP Core that the RPD needs to contact as a potential backup.

7.1.3.7 DsUsRfPortAlloc This object provides the allocation status for the downstream channel resources on the RPD on a per DS RF port basis as well as for the upstream channel resources on a per US RF port basis. The DsUsRfPortAlloc TLV Type is 50.22 (DS) and 50.23 (US). Table 128 - DsUsRfPortAlloc Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type RfPortIndex UnsignedByte Key N/A 50.22.1 50.23.1 Direction IfDirection Key N/A AllocScQamChannels UnsignedShort Read-only N/A 50.22.3 50.23.3 AllocOfdmChannels UnsignedShort Read-only N/A 50.22.2 50.23.2 AllocOob551Channels UnsignedShort Read-only N/A 50.22.4 50.23.4 AllocNdChannels UnsignedShort Read-only N/A 50.22.6 50.23.6 AllocBdrs UnsignedShort Read-only N/A 50.22.7 ConfiguredBcgs UnsignedShort Read-only N/A 50.22.8

7.1.3.7.1 RfPortIndex This key attribute reports the index of the downstream or upstream RF port for which resource allocation is being reported.

7.1.3.7.2 Direction This key attribute indicates the direction to which the RF port allocation is applied.

7.1.3.7.3 AllocScQamChannels This attribute reports the number of allocated SC-QAM channels on this RF port.

7.1.3.7.4 AllocOfdmChannels This attribute reports the number of allocated DOCSIS 3.1 channels on this RF port.

7.1.3.7.5 AllocOob551Channels This attribute reports the number of allocated SCTE 55-1 channels on this RF port.

7.1.3.7.6 AllocNdChannels This attribute reports the number of allocated narrowband digital forward channels (when Direction indicates downstream) or narrowband digital return channels (when Direction indicates upstream) on this RF port.

120 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.3.7.7 AllocBdrs This attribute reports how many BDRs have been allocated on the RPD. This attribute is not applicable for US channels and always reports zero.

7.1.3.7.8 ConfiguredBcgs This attribute reports how many BCGs have been configured on the RPD. This attribute is not applicable for US channels and always reports zero.

7.1.3.8 RpdL2tpSessionInfo The RpdL2tpSessionInfo object provides information about each tunnel session between the RPD and each CCAP Core with which it is associated from the RPD's point of view. An instance is created for every session the RPD terminates. There may be instances for sessions with different CCAP Cores if the RPD is connected with one or more auxiliary cores. The RpdL2tpSessionInfo object inherits the attributes of the abstract SessionInfo object. The CCAP Core MUST instantiate the RpdL2tpSessionInfo object and RpdSessionStats object with each DEPI, UEPI, OOB, NDF, NDR, EC, and ZBL pseudowire that is established on each RPD with which it is associated. If the RPD supports SNMP, the RPD SHOULD instantiate the RpdL2tpSessionInfo object with each DEPI, UEPI, OOB, NDF, NDR, EC, and ZBL pseudowire it has established with CCAP Cores. In the case where there are multiple CCAP Cores, all sessions are reported, regardless of the CCAP Core fulfilling the object query. If the RPD supports SNMP, it instantiates this object for each L2TPv3 tunnel (session) established with each CCAP Core to which it is connected. The RpdL2tpSessionInfo object is read from the GCP complex TLV Type 100.2. Table 129 - RpdL2tpSessionInfo Object Associations

Associated Object Type Near-end Far-end Multiplicity Label Name Multiplicity SessionInfo Specialization of SessionInfo 1 1 RpdSessionStats Directed composition to RpdSessionStats 1 1

7.1.3.9 RpdSessionStats This object reports performance statistics for an RpdL2tpSessionInfo object. The RpdSessionStats object is based on the docsIfMCmtsDepiSessionStats object defined in the DOCS-IF-M-CMTS-MIB and has been extended for Remote PHY. The RPD MUST instantiate the RpdSessionStats object with each DEPI, UEPI, OOB, NDF, NDR, EC, and ZBL pseudowire it has established with CCAP Cores. The RpdSessionStats attributes are read with GCP Complex TLV type 100.2.21. Table 130 - RpdSessionStats Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length OutOfSequencePackets Counter32 Read-only Packets 100.2.21.1 4 InPackets Counter64 Read-only Packets 100.2.21.2 8 InDiscards Counter64 Read-only Packets 100.2.21.3 8 OutPackets Counter64 Read-only Packets 100.2.21.4 8 OutErrors Counter64 Read-only Packets 100.2.21.5 8 CounterDiscontinuityTime DateTime Read-only 100.2.21.6 8 or 11

 09/03/21 CableLabs 121 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.9.1 OutOfSequencePackets This attribute reports the count of session packets that were received out of sequence from the point of view of the RPD. It is vendor-dependent the resequencing of packets. Implementations that do not re-sequence packets also increase the value of ifInDiscards for the respective entry.

7.1.3.9.2 InPackets This attribute counts the number of received packets accepted for processing above the L2TPv3 protocol layer. The InPackets attribute count excludes packets dropped by the L2TPv3 protocol layer itself (e.g., OutOfSequencePackets and InDiscards).

7.1.3.9.3 InDiscards This attribute counts the number of received packets discarded by the L2TPv3 protocol layer itself, including those discarded because they were out of sequence. The InDiscards attribute count includes packets unable to be forwarded to a higher layer for processing. Interpretation of what discards are counted in this attribute is vendor- specific.

7.1.3.9.4 OutPackets This attribute counts the number of packets conceptually attempted to be transmitted from above the L2TPv3 protocol layer. The OutPackets attribute counts packets discarded by the L2TPv3 protocol layer itself (i.e., as counted by OutErrors).

7.1.3.9.5 OutErrors This attribute counts the number of packets attempted to be transmitted from above the L2TPv3 protocol layer that could not be transmitted below the L2TPv3 protocol layer itself. Interpretation of what errors are counted in this attribute is vendor-specific.

7.1.3.9.6 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.3.10 DiagnosticStatus This object reports information about an RPD's diagnostic self test results. This object returns one instance indicating pass or failure for the diagnostic self test result. If multiple error conditions are detected by the RPD, the highest severity level instance is created in this object. If multiple error conditions of the same severity level are detected by the RPD, the first occurring error is reported in this object. When a diagnostic self test detects a failure condition, the RPD MUST log an event with Event ID 66070118. If multiple error conditions are detected by the RPD, the RPD logs an event for each error condition. The CCAP Core reads DiagnosticStatus attributes with GCP complex TLV Type 100.4. Table 131 - DiagnosticStatus Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length ProbableCause AdminString Read-only N/A 100.4.1 0..255 AdditionalText AdminString Read-only N/A 100.4.2 0..255 SeverityLevel EvPriorityType Read-only N/A 100.4.3 1

122 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.3.10.1 ProbableCause This attribute reports the probable cause of the diagnostic test error condition. Probable causes may be related to: • Communications error • Quality of Service error • Processing error • Equipment error • Environmental error The format for values returned is vendor-specific. When the self test result is a pass, this attribute returns "Self Test Passed".

7.1.3.10.2 AdditionalText This attribute reports a free form text description of the diagnostic test error condition. This provides supplemental information for the ProbableCause. When the self test result is a pass, this attribute returns "No errors found".

7.1.3.10.3 SeverityLevel This attribute reports the severity level for the diagnostic test error condition. Severity levels are based on the DOCSIS event priority levels. When the self test result is a pass, this attribute returns information.

7.1.3.11 DepiMcastSession This object reports the DEPI IP multicast sessions currently joined by an RPD. An instance of this object represents one DEPI IP Multicast session replicated to one RPD. The indexing provides the RPD unique identifier and the (S,G) IP address pair that uniquely identifies an IP multicast session. The CCAP Core creates an instance when it confirms an RPD has joined a DEPI IP multicast session. The CCAP Core deletes the instance when it confirms an RPD has left the DEPI IP multicast session or disconnects its GCP session with the CCAP Core. The CCAP Core reads DepiMcastSession attributes with GCP complex TLV Type 100.5. Table 132 - DepiMcastSession Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length IpAddrType InetAddressType Key ipv4(1), N/A N/A ipv6(2) GroupIpAddr InetAddress Key SIZE(4 | 16) N/A 100.5.2 4 or 16 SrcIpAddr InetAddress Key SIZE(4 | 16) N/A 100.5.3 4 or 16 L2tpSessionId UnsignedInt Key 0x80000001..0x8000FFFF N/A 100.5.6 4 RpdLcceIpAddr InetAddress Read-only SIZE(4 | 16) N/A 100.5.4 4 or 16 CcapLcceIpAddr InetAddress Read-only SIZE(4 | 16) N/A 100.5.5 4 or 16 JoinTime DateTime Read-only N/A 100.5.7 8 or 11

7.1.3.11.1 IpAddrType This key attribute reports whether the IP addresses provided in GroupIpAddr, SrcIpAddr, RpdLcceIpAddr and CcapLcceIpAddr are IPv4 or IPv6.

 09/03/21 CableLabs 123 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.11.2 GroupIpAddr This key attribute reports the group (destination) address of an IP multicast session transmitted via DEPI multicast.

7.1.3.11.3 SrcIpAddr For Source Specific Multicast (SSM), this key attribute reports the source IP address of an IP multicast session transmitted via DEPI multicast. For Any-Source Multicast (ASM) sessions, this attribute reports the all-0's IP address.

7.1.3.11.4 L2tpSessionId This key attribute reports the L2TPv3 Session ID assigned by the CCAP Core to the DEPI IP multicast session. The value is assigned according to the referenced specification in the range 0x80000001 through 0x8000FFFF.

7.1.3.11.5 RpdLcceIpAddr This attribute reports the RPD local LCCE IP address of the L2TPv3 DEPI control session that instructed the RPD to join the IP multicast session. In the case of static Multicast sessions, this attribute reports RPD IP Address associated with the Ethernet Port on which the static Multicast session has been configured.

7.1.3.11.6 CcapLcceIpAddr This attribute reports the RPD remote LCCE IP address (i.e. on the CCAP Core) of the L2TPv3 control session that instructed the RPD to join the IP multicast session. In the case of static Multicast sessions, this attribute reports a zero value.

7.1.3.11.7 JoinTime This attribute reports the last time the RPD has joined this session.

7.1.3.12 Oob551UsChanStatus This object provides per-RPD counts of upstream SCTE 55-1 cells sent to a Network Controller. These counts are updated by the CCAP Core, which parses each upstream SCTE 55-1 packet and uses the power level and packet status (which are really cell status) bits in those packets to determine how to update the counters. The only exception is the OperStatus attribute, which is read from the RPD using TLV 80.1. The CCAP Core MUST compute the per-RPD power level (i.e., PwrLevel, MaxPwrLevel, MinPwrLevel) values in the Oob551UsChanStatus object over a sliding 15-minute window. The sliding window method for calculating the power level values is left to vendor implementations. This object uses the virtual port and virtual channel ID as the keys because it is impossible to determine the physical port and channel number for an SCTE 55-1 US data packet. Only the virtual port number and virtual demodulator ID are in the packet. It is also very difficult, if it is even possible for the RPD to keep such counts per physical port and channel for reporting using GCP TLVs. If an operator wants counts by physical port and physical demodulator ID (channel number), one way is to have a different virtual port for each physical port and a different virtual demodulator ID for each of the OOB 55-1 US channels on a port. Table 133 - Oob551UsChanStatus Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type RfPort UnsignedByte Key 0..255 N/A ChannelId UnsignedByte Key 0..2 N/A NcIpAddr Host Read-only N/A ArpdSrcIpAddr Host Read-only N/A PerfectCellsRcvd Counter64 Read-only Cells N/A CorrectedCellsRcvd Counter64 Read-only Cells N/A UncorrectableCellsRcvd Counter64 Read-only Cells N/A

124 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type TotalCellsRcvd Counter64 Read-only Cells N/A PwrLevel Short Read-only -160..155 TenthdB N/A MaxPwrLevel Short Read-only -160..155 TenthdB N/A MinPwrLevel Short Read-only -160..155 TenthdB N/A CounterDiscontinuityTime DateTime Read-only N/A OperStatus OperStatusType Read-only up(1), 80.1 down(2)

7.1.3.12.1 RfPort This attribute reports the RPD RF virtual port number carrying this SCTE 55-1 US channel.

7.1.3.12.2 ChannelId This attribute reports the virtual demodulator ID (channel number) for this SCTE 55-1 US channel.

7.1.3.12.3 NcIpAddr This attribute reports the IP host address of the Network Controller receiving the cells on this SCTE 55-1 US channel.

7.1.3.12.4 ArpdSrcIpAddr This attribute reports the virtual ARPD source IP host address used when sending cells to the Network Controller.

7.1.3.12.5 PerfectCellsRcvd This attribute reports the number of perfect cells received by the demodulator for this SCTE 55-1 US channel. Perfect cells have status 0 in the US SCTE 55-1 OOB packet.

7.1.3.12.6 CorrectedCellsRcvd This attribute reports the number of errored cells received by the demodulator for this SCTE 55-1 US channel that were successfully corrected. Corrected cells have status 1 in the US SCTE 55-1 OOB packet.

7.1.3.12.7 UncorrectableCellsRcvd This attribute reports the number of errored cells received by the demodulator for this SCTE 55-1 US channel that could not be corrected. Uncorrectable cells have status 3 in the US SCTE 55-1 OOB packet.

7.1.3.12.8 TotalCellsRcvd This attribute reports the total of all cells received for this SCTE 55-1 US channel.

7.1.3.12.9 PwrLevel This attribute reports the arithmetic mean power level from nominal of all received MAC Cells by the demodulator for this upstream SCTE 55-1 channel in tenths of a dB. The six power level bits 1 in the US SCTE 55-1 OOB packet report the nominal power per cell in units of 0.5 dB.

7.1.3.12.10 MaxPwrLevel This attribute reports the maximum power level from nominal of all received MAC Cells by the demodulator for this upstream SCTE 55-1 channel in tenths of a dB.

 09/03/21 CableLabs 125 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.12.11 MinPwrLevel This attribute reports the minimum power level from nominal of all received MAC Cells by the demodulator for this upstream SCTE 55-1 channel in tenths of a dB.

7.1.3.12.12 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero.

7.1.3.12.13 OperStatus This attribute reports the operational status of the selected channel.

7.1.3.13 CrashDataFileStatus This object provides status information for the crash analysis data files. The RPD MUST generate a crash analysis file when it encounters an unrecoverable software or hardware error. The RPD MAY generate a crash analysis file when encountering other types of errors. The intent is to record in a file all necessary information useful for postmortem analysis of the crash/error. The format of the crash analysis file and the location of the file within the RPD filesystem are determined by the RPD manufacturer. The RPD MUST be capable of storing at minimum two instances of the crash analysis file. The RPD MUST support transferring of the crash analysis file to a remote server via TFTP and HTTP. There will be an instance of this object for each file that is available in the device for upload or for which an upload is in progress. The RPD MUST create an instance of the CrashDataFileStatus object for each crash analysis file that is available for upload. The device could have limited resources to save captured crash analysis files. Therefore, if the number of generated files exceeds the supported number for the device, newly-created instances can overwrite/replace existing instances as new data files become available. The RPD SHOULD implement an overwrite algorithm which preserves the oldest crash analysis file from being overwritten. The RPD MUST report the instances of CrashDataFileStatus object in the order from the oldest to the most recent. The CrashDataFileStatus TLV Type is 100.20. Table 134 - CrashDataFileStatus Object Attributes

Attribute Type Access Type Constraints Units Default TLV TLV Name Type Value Field Length Index UnsignedByte Key 1..255 100.20.1 1 Filename AdminString Read-only SIZE(1..255) 100.20.2 1-255 FileStatus Enum Read-only other(1), 100.20.3 1 availableForUpload(2), uploadInProgress(3), uploadCompleted(4), uploadPending(5), uploadCancelled(6), error(7)

7.1.3.13.1 Index This key attribute uniquely identifies a crash analysis file.

7.1.3.13.2 Filename This attribute contains the name of the crash analysis file, stored in the device that is available to be uploaded to the server. Filenames are defined by the application that creates them. The RPD SHOULD generate crash analysis files with names which include RPD's unique id and a timestamp. The timestamp indicates the time when the crash has occurred with granularity of one second. The RPD SHOULD

126 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

format the crash data file timestamp in the form 'Unix time', which is defined as the number of seconds that have elapsed since midnight Coordinated Universal Time (UTC), Thursday, 1 January 1970. For example, a crash file name “RPD_crash_dump_id_00000187ADF_time_1403405123” indicates that the file was generated by RPD with Unique ID of 00.00.00.18.7A.DF on Sunday 22nd June 2014 02:45:23 AM.

7.1.3.13.3 FileStatus This attribute reflects the status of the crash 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. The file is not available for another upload in this state. uploadCompleted(4) - The file was successfully uploaded. The file is available for another upload. 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. uploadPending status can also indicate a situation where the RPD is waiting to retry the upload after the initial attempt(s) has failed. The file is not available for another upload in this state. uploadCancelled(6) - An upload was cancelled before it completed. The file is available for another upload. error(7) - An error occurred and the file was not successfully uploaded. The file is available for another upload.

7.1.3.14 RpdUsSignalQuality With virtual combining, upstream signal quality measurements from multiple RPDs are combined in the reported values of docsIfSignalQualityTable of [RFC 4546] and docsIf3SignalQualityExtTable of [DOCS-IF3-MIB]. This object is intended to provide individual values for a single RPD. A CCAP Core that supports virtual combining MUST support the RpdUsSignalQuality object. Table 135 - RpdUsSignalQuality Object Attributes

Attribute Name Type Access Type Constraints Units RfPort UnsignedByte Key ChannelIfIndex InterfaceIndex Key Interface Index of logical upstream channel RxMer TenthdB Read-Only -2147483648..2147483647 TenthdB RxMerSamples UnsignedInt Read-Only Unerroreds Counter64 Read-Only codewords Correcteds Counter64 Read-Only codewords Uncorrectables Counter64 Read-Only codewords

7.1.3.14.1 RfPort This attribute reports the RPD RF port number carrying this US channel. This corresponds to the attribute RpdUsRfPortNum of the RpdUsRfPortRef object in the configuration Information Model.

7.1.3.14.2 ChannelIfIndex This attribute corresponds to the ifIndex of the logical upstream channel (ifType docsCableUpstreamChannel(205)) of the CCAP Core for this US channel. Note that with upstream virtual combining, this attribute corresponds to the same CCAP Core ifIndex for different RPD unique Ids.

 09/03/21 CableLabs 127 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.14.3 RxMer This attribute reports an in-channel received average Modulation Error Ratio (MER). An RxMER sample is defined as an estimate, provided by the demodulator, of the ratio: (average constellation energy with equally likely symbols) / (average squared magnitude of error vector) RxMER is measured just prior to FEC (trellis/Reed-Solomon) decoding. RxMER includes the effects of the HFC channel as well as implementation effects of the modulator and demodulator. Error vector estimation may vary among demodulator implementations. The CCAP Core RxMER is averaged over a given number of bursts at the burst receiver, which may correspond to transmissions from multiple users.

7.1.3.14.4 RxMerSamples This attribute reports RxMerSamples which is a statistically significant number of bursts for the CCAP Core, processed to arrive at the RxMER value. For the CCAP Core, the MER measurement includes only valid bursts that are not in contention regions.

7.1.3.14.5 Unerroreds This attribute reports the count of codewords received on this channel without error. This includes all codewords, whether or not they were part of frames destined for this device.

7.1.3.14.6 Correcteds This attribute reports the count of codewords received on this channel with correctable errors. This includes all codewords, whether or not they were part of frames destined for this device.

7.1.3.14.7 Uncorrectables This attribute reports the count of codewords received on this channel with uncorrectable errors. This includes all codewords, whether or not they were part of frames destined for this device.

7.1.3.15 Host Resources This object is the container for host resources objects. Table 136 - HostResources Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity HostResourcesSystem Directed composition to HostResourcesSystem 1 1..* HostResourcesStorage Directed composition to HostResourcesStorage 1 1..* HostResourcesSwRun Directed composition to HostResourcesSwRun 1 1..*

7.1.3.16 HostResourcesSystem This object is the container for RPD system attributes. The HostResourcesSystem TLV Type is 100.21. Table 137 - HostResourcesSystem Object Attributes

Attribute Type Access Type Units TLV Type TLV Value Name Constraints Field Length Date DateTime Read-only N/A 100.21.1 8 or 11

7.1.3.16.1 Date This attribute reports the RPD's notion of the current local date and time of day.

128 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.3.17 HostResourcesStorage This object reports information about logical storage areas on the host at the time when the values are read. An object is associated with each logical storage area that is allocated and that has constrained resources. This object represents logical storage areas (file systems, disk partitions, etc.), as seen by applications, rather than physical storage resources seen by the operating system. The RPD MUST log event 66070522 when a memory storage threshold condition is detected. Configuration of memory utilization thresholds are left to vendor implementations. For example, a vendor might provide a default (non-configurable) threshold of 80% utilization as triggering a threshold exceeded condition. A vendor might also report a threshold value in bytes utilized. Additional troubleshooting can be performed by reading the HostResourcesStorage object for the Index reported in event 66070522. The RPD MUST log event 66070523 when a memory storage threshold condition is cleared. A clear condition generally occurs when the memory utilization falls below the defined threshold. The HostResourcesStorage TLV Type is 100.22. Table 138 - HostResourcesStorage Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length Index UnsignedInt Key 0..4294967295 N/A 100.22.1 4 Type Enum Read-only other(1), N/A 100.22.2 1 ram(2), virtualMemory(3), fixedDisk(4), removableDisk(5), floppyDisk(6), compactDisc(7), ramDisk(8), flashMemory(9), networkDisk(10) AllocationUnits UnsignedInt Read-only 0..4294967295 Bytes 100.22.3 4 AllocationFailures Counter64 Read-only N/A 100.22.4 8 Size UnsignedInt Read-write 0..4294967295 Bytes 100.22.5 4 Used UnsignedInt Read-only 0..4294967295 N/A 100.22.6 4 Descr AdminString Read-only N/A 100.22.7 1..255

7.1.3.17.1 Index This attribute contains a unique value for each logical storage area contained by the host.

7.1.3.17.2 Type This attribute contains the type of storage represented by this object. The following storage types are supported. other: The storage type identifier used when no other defined type is appropriate. ram: The storage type identifier used for RAM. virtualMemory: The storage type identifier used for virtual memory, temporary storage of swapped or paged memory. fixedDisk: The storage type identifier used for non-removable rigid rotating magnetic storage devices. removableDisk: The storage type identifier used for removable rigid rotating magnetic storage devices. floppyDisk: The storage type identifier used for non-rigid rotating magnetic storage devices. compactDisc: The storage type identifier used for read-only rotating optical storage devices. ramDisk: The storage type identifier used for a file system that is stored in RAM.

 09/03/21 CableLabs 129 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

flashMemory: The storage type identifier used for flash memory. networkDisk: The storage type identifier used for a networked file system. Reference: [RFC 2790] HOST-RESOURCES-TYPES MIB.

7.1.3.17.3 AllocationUnits This attribute contains the size, in bytes, of the data objects allocated from this pool. If this object is monitoring sectors, blocks, buffers, or packets, for example, this number will commonly be greater than one. Otherwise this number will typically be one.

7.1.3.17.4 AllocationFailures This attribute contains the number of requests for storage represented by this entry that could not be honored due to not enough storage.

7.1.3.17.5 Size This attribute contains the size of the storage represented by this object, in units of AllocationUnits. This attribute is writable to allow remote configuration of the size of the storage area in those cases where the operation makes sense and is possible on the underlying system.

7.1.3.17.6 Used This attribute contains the amount of the storage represented by this object that is allocated, in units of AllocationUnits.

7.1.3.17.7 Descr This attribute contains a description of the type and instance of the storage described by this object.

7.1.3.18 HostResourcesSwRun Instances of this object represent each distinct process (i.e., piece of software) that is running or loaded into physical or virtual memory in preparation for running at the time when the values are read. This includes the host's operating system, device drivers, and applications. The HostResourcesSwRun object does not contain processor resource information, such as CPU information or metrics. However, certain DOCSIS defined events are defined for performance monitoring of RPD processors. The RPD MUST log event 66070520 when a processor overload condition is detected. Configuration of processor utilization thresholds (percentages) are left to vendor implementations. For example, a vendor might provide a default (non-configurable) threshold of 80% utilization as triggering an overload condition. The RPD MUST log event 66070521 when a processor overload condition is cleared. A clear condition generally occurs when the processor utilization falls below the overload threshold over a certain period of time. The HostResourcesSwRun TLV Type is 100.23. Table 139 - HostResourcesSwRun Object Attributes

Attribute Type Access Type Units TLV Type TLV Value Name Constraints Field Length Index UnsignedInt Key 0..4294967295 N/A 100.23.1 4 Type Enum Read-only unknown(1), N/A 100.23.2 1 operatingSystem(2), deviceDriver(3), application(4) Status Enum Read-only running(1), N/A 100.23.3 1 runnable(2), notRunnable(3), invalid(4)

130 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Type Access Type Units TLV Type TLV Value Name Constraints Field Length PerfCpu UnsignedInt Read-only 0..4294967295 N/A 100.23.4 4 PerfMem UnsignedInt Read-only 0..4294967295 KBytes 100.23.5 4 Name AdminString Read-only N/A 100.23.6 1..64

7.1.3.18.1 Index This attribute contains a unique value for each piece of software running on the host.

7.1.3.18.2 Type This attribute contains the type of the software piece running on the host.

7.1.3.18.3 Status This attribute contains the status of the software piece running on the host.

7.1.3.18.4 PerfCpu This attribute contains the number of centi-seconds of the total system's CPU resources consumed by this process.

7.1.3.18.5 PerfMem This attribute contains the total amount of real system memory allocated to this process.

7.1.3.18.6 Name This attribute contains a textual description of this running piece of software, including the manufacturer, revision, and the name by which it is commonly known.

7.1.3.19 ExtSwImageSupport This object provides information about the Main Software Image and the additional optional software images that can be maintained by the RPD. The ExtSwImageSupport TLV Type is 100.25. Table 140 - ExtSwImageSupport Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length SwImageIndex UnsignedByte Key 0..3 N/A 100.25.1 1 SwImageLastUpdate DateTime Read-only N/A 100.25.2 8 or 11 SwImageName AdminString Read-only SIZE (1..255) N/A 100.25.3 1..255 SwImageDescr AdminString Read-only N/A 100.25.4 0..255 SwImageServerType InetAddressType Read-only ipv4(1), N/A N/A N/A ipv6(2) SwImageServerAddress InetAddress Read-only SIZE(4 | 16) N/A 100.25.5 4 or 16

7.1.3.19.1 SwImageIndex This key attribute is used in selecting a software image maintained by the RPD. The value of zero is reserved for the Main Software Image (MSI). The maximum value of SwImageIndex supported by an RPD is communicated via the RPD Capabilities object.

 09/03/21 CableLabs 131 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.19.2 SwImageLastUpdate This attribute reports the most recent date and time when the selected RPD’s software image was updated. The RPD preserves the value of this attribute across reboots.

7.1.3.19.3 SwImageName This attribute reports the name of the RPD’s software image. The RPD preserves the value of this attribute across reboots.

7.1.3.19.4 SwImageDescr This attribute reports human-readable description of the SW image running at the selected index. For example, it can report that the selected index points to a Fallback software image. The RPD preserves the value of this attribute across reboots.

7.1.3.19.5 SwImageServerType This attribute reports the server Internet address type of the server from which the RPD’s selected software image was downloaded. The RPD preserves the value of this attribute across reboots.

7.1.3.19.6 SwImageServerAddress This attribute reports the Internet address of the server from which the RPD’s selected software image was downloaded. The RPD preserves the value of this attribute across reboots.

7.1.3.20 ResetHistory This object provides a record of the occurrences of a reset of an RPD. The RPD can reset for many reasons, including loss of Principal Core, loss of IP connection, power failure, hardware or software failure, or reset command from CCAP Core or CLI. This object provides details of the conditions that caused the RPD to reset to assist operators with understanding why a service interruption occurred. This object also provides details on how much time it took for the RPD to boot its software stack and to become operational with the Principal Core. The RPD MUST store a record of each reset occurrence in non-volatile storage when the RPD resets/reboots for any reason. The RPD MUST make its reset occurrences available to a CCAP Core via the TLVs defined in the ResetHistory object. The RPD MUST also report its reset occurrences through the vendor-proprietary command-line interface. Once the RPD is operational, the RPD MUST include the most recent reset instance in the reset occurrences it provides via the ResetHistory TLVs and vendor-proprietary command-line interface. When the ResetHistory TLVs are read by the CCAP Core, the RPD MUST return at least the last 50 reset events, with the lowest index being the most recent reset event. The RPD MUST maintain the ResetHistory across an nvReset, softReset, and hardReset. The RPD MUST clear the ResetHistory as a result of factoryReset. The RPD MUST create a new entry in ResetHistory upon coming back online from a factoryReset. The ResetHistory TLV type is 100.31. Table 141 - ResetHistory Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length Index UnsignedShort Key 100.31.1 2 ResetTimestamp DateTime Read-only Date and time 100.31.2 8 or 11 Type Enum Read-only softReset(1), 100.31.3 1 hardReset(2), nvReset(3), factoryReset(4) Reason AdminString Read-only SIZE(1..255) 100.31.4 1-255

132 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length EventIdRef UnsignedInt Read-only 100.31.5 4 EventDescription AdminString Read-only 100.31.6 0-255 RecoveryTime UnsignedInt Read-only Seconds 100.31.7 4 PrincipalOperationalTimestamp DateTime Read-only Date and time 100.31.8 8 or 11

7.1.3.20.1 Index This attribute is a key and provides an index into the table. Indexes are consecutively ordered from 0..N-1 where N is the maximum number of reset history events supported by an RPD as reported by the ResetHistorySize attribute of the ResetCapabilities object. This attribute corresponds to the order in which reset events occurred. The most recent reset event index has a value of zero.

7.1.3.20.2 ResetTimestamp This attribute provides the time at which the reset occurred. If the RPD does not know what time the RPD reset occurred, the RPD MAY report a value of midnight, Jan 1, 1970 UTC in the ResetTimestamp attribute.

7.1.3.20.3 Type This attribute identifies the type of reset that the RPD is recording. The possible values match those of the Type TLV (TLV 40.1.1, sub-TLV of ResetCtrl) and values are as follows: 1. The RPD performed a softReset (softReset). 2. The RPD performed a power-on reset or equivalent reset (hardReset). 3. The RPD cleared most non-volatile configuration and performed a hard reset (nvReset). 4. The RPD set all settings back to original factory settings and performed a hard reset (factoryReset).

7.1.3.20.4 Reason This attribute provides a vendor-specific string with a detailed explanation of why the RPD was reset. Vendors are expected to add additional details, including diagnostic information, whether this was a normal hard reset vs. a vendor-specific type of hard reset, the RPD was disconnected from the node, etc.

7.1.3.20.5 EventIdRef If the reset was related to an event that was captured in a standardized DOCSIS event, this attribute provides the event ID of the corresponding event. If the RPD does not generate a DOCSIS event corresponding to the reset occurrence, this attribute will have a value of 0.

7.1.3.20.6 EventDescription If the reset was related to an event that was captured in a standardized DOCSIS event, this attribute provides the standardized description of the corresponding event. If the reset does not have a corresponding event, this attribute’s value will be null.

7.1.3.20.7 RecoveryTime This attribute provides the number of seconds that have elapsed between the time the reset event started and the completion of the local RPD initialization stage, defined in [R-PHY]. The calculation of the number of seconds in this period is vendor-specific. The RPD might not always be able to record the timestamp of the most recent reset event. In addition, the RPD might not be able to determine the time of the completion of “the local RPD init stage”. For example, after a reset event, the RPD could reset again before being able to obtain the current time from ToD.

 09/03/21 CableLabs 133 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

In such cases in which the RPD cannot determine the value of RecoveryTime, the RPD MAY report a value of 0 (zero).

7.1.3.20.8 PrincipalOperationalTimestamp This attribute provides the time at which the RPD was moved to operational by the Principal Core. If the RPD is unable to acquire the time of day by the time the RPD is moved to operational by the Principal Core, the RPD MUST provide the date and time when the RPD was moved to operational. If the RPD is not moved to operational by the Principal Core before another reset event, the RPD MAY set the value of PrincipalOperationalTimestamp to midnight, Jan 1, 1970 UTC.

7.1.3.21 RpdShelfInfo This object identifies an RPD shelf and each RPD in the shelf. The CCAP Core MUST create an RpdShelfInfo object for each RPD reporting a chassis entity with EntityIndex equal one and Class equal ‘chassis’. RpdShelfInfo objects are derived from RPD Entity Objects where the Entity with EntityIndex equal one has a Class value of ‘chassis’. Table 142 - RpdShelfInfo Object Attributes

Attribute Name Type Access Type Units Constraints ShelfId AdminString Key N/A RpdUniqueId MacAddress Key N/A RpdSlot UnsignedByte Read-only N/A

7.1.3.21.1 ShelfId This attribute specifies the SerialNum of the RPD Entity with EntityIndex equal one and class equal ‘chassis’. All RPDs reporting the same SerialNum for the chassis entity are in the same shelf.

7.1.3.21.2 RpdUniqueId This attribute specifies a globally unique 6-byte identifier for the RPD in a shelf.

7.1.3.21.3 RpdSlot This attribute reports the slot number or, for RPDs not in a slot, the location number for an RPD in a shelf. If the main RPD module is in a container (i.e., has ContainedIn set to an EntityIndex of class equal ‘container’) in the shelf chassis, this attribute equals the ParentRelPos for the container for the main RPD module. If the main RPD module is contained directly in the shelf chassis (i.e., has ContainedIn for the main module Entity with value one), this equals the ParentRelPos of the main RPD module Entity. RPDs that are not field replaceable may not be in slots and would instead be directly contained in the chassis.

7.1.3.22 ChanBcastGroupStatus This object indicates whether a downstream SC-QAM channel on an RPD is part of a BCG. Downstream SC-QAM channels on same RPD with the same channel selector channel index that have the BcastChanGroup (TLV 62.17) attribute set to “True” are in the same BCG; see the Broadcast Channel Groups section in [R-PHY] for more details. The CCAP Core SHOULD maintain a ChanBcastGroupStatus object for every downstream SC-QAM channel that has either been configured in a Broadcast Channel Group by the CCAP Core by sending TLV 62.17 for the channel with a value of “True” or has been determined to be in a BCG by reading a value of “True” using TLV 62.17 for the channel. Support for BCGs is optional, so support for the ChanBcastGroupStatus object is also optional.

134 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 143 - ChanBcastGroupStatus Object Attributes

Attribute Type Access Type Constraints Units Default TLV Name Type RfPortIndex UnsignedByte Key 12.1 ScQamIndex UnsignedByte Key 12.3 GroupMember Boolean Read-only 62.17

7.1.3.22.1 RfPortIndex This key attribute is the RF port number from the channel selector for this DS SC-QAM channel. This is part of a channel selector.

7.1.3.22.2 ScQamIndex This key attribute is the channel index from the channel selector for this DS SC-QAM channel. This is part of a channel selector.

7.1.3.22.3 GroupMember This attribute indicates whether or not this RPD’s DS SC-QAM channel is part of a BCG.

7.1.3.23 RpdTrfStats This object is supported by an RPD that implements TRF and is used to report on the TRF activity by the RPD. Table 144 - RpdTrfStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length TunnelReplacements Counter32 Read-only N/A 100.32.1 4 TunnelReplacementFailures Counter32 Read-only N/A 100.32.2 4 TunnelHandovers Counter32 Read-only N/A 100.32.3 4 TunnelHandoverFailures Counter32 Read-only N/A 100.32.4 4

7.1.3.23.1 TunnelReplacements This attribute counts the number of tunnels successfully replaced by the RPD due to reception of an SCCRQ containing a DEPI Replaced Tunnel ID AVP identifying the tunnel to be replaced.

7.1.3.23.2 TunnelReplacementFailures This attribute counts the number of tunnel replacement attempts due to reception of an SCCRQ containing a DEPI Replaced Tunnel ID AVP by the RPD that failed.

7.1.3.23.3 TunnelHandovers This attribute counts the number of tunnels successfully transitioned from Standby to InService HA state by the RPD due to reception of a DTU message.

7.1.3.23.4 TunnelHandoverFailures This attribute counts the number of tunnel handover attempts by the RPD that failed to transition from Standby to InService HA state following reception of a DTU message.

7.1.3.24 RpdLcceStats This object is reported by the CCAP Core on behalf of the RPD and is used to report on the DEPI L2TPv3 control connection activity between the RPD and all the CCAP Cores with which the RPD has control connections.

 09/03/21 CableLabs 135 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The CCAP Core reads the RpdLcceStats object from the GCP complex TLV Type 100.33.1. Table 145 - RpdLcceStats Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Constraints Value Field Length LcceIpAddrType InetAddressType Key ipv4(1), N/A N/A N/A ipv6(2) CcapLcceIpAddress InetAddress Key SIZE(4 | 16) N/A 100.33.1.1 4 or 16 RpdLcceIpAddr InetAddress Key SIZE(4 | 16) N/A 100.33.1.2 4 or 16 ControlConnectionsEstablished Counter32 Read-only N/A 100.33.1.3 4 ControlConnectionEstablishmentFailures Counter32 Read-only N/A 100.33.1.4 4 ControlConnectionFailures Counter32 Read-only N/A 100.33.1.5 4 CurrentControlConnections UnsignedShort Read-only N/A 100.33.1.6 2

7.1.3.24.1 LcceIpAddrType This key attribute indicates whether the IP address provided in the CcapLcceIpAddress and RpdLcceIpAddr attributes are IPv4 or IPv6.

7.1.3.24.2 CcapLcceIpAddress This key attribute provides the LCCE IP address on the CCAP Core detailed in the instance.

7.1.3.24.3 RpdLcceIpAddr This key attribute reports the RPD LCCE IP address detailed in the instance.

7.1.3.24.4 ControlConnectionsEstablished This attribute counts the number of DEPI control connections successfully established between the RPD and CCAP Core LCCEs.

7.1.3.24.5 ControlConnectionEstablishmentFailures This attribute counts the number of DEPI control connections that failed during establishment between the RPD and CCAP Core LCCEs.

7.1.3.24.6 ControlConnectionFailures This attribute counts the number of DEPI control connections between the RPD and CCAP Core LCCEs in which a failure was detected (after successful tunnel establishment) that led to the connection being closed.

7.1.3.24.7 CurrentControlConnections This attribute counts the number of DEPI control connections that are currently operational between the RPD and CCAP Core LCCEs (i.e., connections that are in an InService or Standby state). Connections that have been removed are not included in the count.

7.1.3.25 RpdCurrentControlConnections This object is reported by the CCAP Core on behalf of the RPD and is used to report on the currently active DEPI L2TPv3 control connections on the RPD. The CCAP Core reads the RpdCurrentControlConnections object from the GCP complex TLV Type 100.33.2.

136 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 146 - RpdCurrentControlConnections Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Field Constraints Length LcceIpAddrType InetAddressType Key ipv4(1), N/A N/A N/A ipv6(2) CcapLcceIpAddress InetAddress Key SIZE(4 | 16) N/A 100.33.2.1 4 or 16 RpdLcceIpAddr InetAddress Key SIZE(4 | 16) N/A 100.33.2.2 4 or 16 RpdConnCtrlId UnsignedInt Key N/A 100. 33.2.3 4 CoreConnCtrlId UnsignedInt Read-only N/A 100. 33.2.4 4 CoreId HexBinary Read-only SIZE(6) N/A 100. 33.2.5 6 UdpPort InetPortNumber Read-only N/A 100. 33.2.6 2 HaState Enum Read-only other(0), N/A 100. 33.2.7 1 inService(1), standby(2) SessionEstablishmentFailures Counter32 Read-only N/A 100. 33.2.8 4 SessionsFailed Counter32 Read-only N/A 100. 33.2.9 4 CurrentSessions UnsignedShort Read-only N/A 100. 33.2.10 2

7.1.3.25.1 LcceIpAddrType This key attribute indicates whether the IP address provided in the CcapLcceIpAddress and RpdLcceIpAddr attributes are IPv4 or IPv6.

7.1.3.25.2 CcapLcceIpAddress This key attribute provides the LCCE IP address on the CCAP Core of the control connection detailed in the instance.

7.1.3.25.3 RpdLcceIpAddr This key attribute reports the RPD LCCE IP address of the control connection detailed in the instance.

7.1.3.25.4 RpdConnCtrlId This key attribute reports the RPD control connection identifier (CCID) for this control connection.

7.1.3.25.5 CoreConnCtrlId This attribute reports the Core control connection identifier (CCID) for this control connection.

7.1.3.25.6 CoreId This attribute reports the unique identifier of the CCAP Core with which this control connection terminates.

7.1.3.25.7 UdpPort This attribute reports the UDP Port reported by the RPD when the DEPI control connection uses L2TPv3 Header Over UDP. This attribute reports a value of 0 when the control connection is running with the L2TPv3 Session IP Header.

7.1.3.25.8 HaState This attribute indicates the current HaState of the tunnel for which this DEPI control connection provides the signaling, as described in the TRF section of [R-DEPI]. If TRF is not supported by either the Core or the RPD then HaState is reported as inService.

 09/03/21 CableLabs 137 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.3.25.9 SessionEstablishmentFailures This attribute counts the number of DEPI sessions that failed during establishment using this control connection.

7.1.3.25.10 SessionsFailed This attribute counts the number of DEPI sessions in which a failure was detected (after successful tunnel establishment) that led to the session being closed using this control connection.

7.1.3.25.11 CurrentSessions This attribute counts the number of current DEPI sessions using this control connection (i.e., sessions that are in an inService or Standby state). Sessions that have been removed are not included in the count.

7.1.4 RPD Capabilities Information Model These objects provide reporting of RPD capabilities via communication from the CCAP Core. Figure 19 defines the RPD Capabilities information model reported via the CCAP Core.

138 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 19 - RPD Capabilities Information Model

 09/03/21 CableLabs 139 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.1 RpdInfo The RpdInfo object serves as the root on the RPD Capabilities Information Model. The RpdInfo object is defined in Section 7.1.3.2 and referenced here. Table 147 - RpdInfo Object Associations

Associated Object Type Near-end Far-end Multiplicity Label Name Multiplicity CapabilitiesGrp Directed composition to 1 1 CapabilitiesGrp

7.1.4.2 CapabilitiesGrp The CapabilitiesGrp object is the container for all RPD capabilities objects. The CapabilitiesGrp TLV Type is 50. Table 148 - CapabilitiesGrp Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity UsCapabilitiesGrp Directed association to 1 1 UsCapabilitiesGrp DsCapabilitiesGrp Directed association to 1 1 DsCapabilitiesGrp StaticPwCapabilities Directed association to 1 0..1 StaticPwCapabilities ChannelReachability Directed association to 1 0..* ChannelReachability BufferMonitoringCapabilities Directed association to 1 1 BufferMonitoringCapabilities SwImageCapabilities Directed association to 1 1 SwImageCapabilities MiscellaneousCapabilities Directed association to 1 1 MiscellaneousCapabilities GcpCapabilities Directed association to 1 1 GcpCapabilities RpdCoreRedundancyCapabilities Directed association to 1 1 RpdCoreRedundancyCapabilities InitializationCapabilities Directed association to 1 1 InitializationCapabilities ResetCapabilities Directed association to 1 1 ResetCapabilities PnmCapabilities Directed association to 1 1 PnmCapabilities FdxCapabilities Directed association to 1 1 FdxCapabilities PmtudCapabilities Directed association to 1 1 PmtudCapabilities RdtiCapabilities Directed association to 1 1 RdtiCapabilities SpectrumCaptureCapabilities Directed association to 1 1 SpectrumCaptureCapabilities LogCapabilities Directed association to 1 1 LogCapabilities NetworkingCapabilities Directed association to 1 1 NetworkingCapabilities

140 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity RfmCapabilities Directed association to 1 1 RfmCapabilities TelemetryCapabilities Directed association to 1 1 TelemetryCapabilities

7.1.4.3 UsCapabilitiesGrp The UsCapabilitiesGrp object is the container for RPD upstream channel capabilities. Table 149 - UsCapabilitiesGrp Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity UsCapabilities Directed association to UsCapabilities 1 1 UsPowerCapabilities Directed association to UsPowerCapabilities 1 1 OfdmaCfgCapabilities Directed association to OfdmaCfgCapabilities 1 1

7.1.4.4 UsCapabilities The UsCapabilities object reports the RPD’s upstream channel capabilities. The UsCapabilities TLV Type is 50.61. Table 150 - UsCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type MaxUsFrequency UnsignedInt Read-only N/A 50.61.1 MinUsFrequency UnsignedInt Read-only N/A 50.61.2 MaxUnicastSids UnsignedShort Read-only N/A 50.61.3 NumUsRfPorts UnsignedShort Read-only N/A 50.3 NumUsScQamChannels UnsignedShort Read-only N/A 50.8 NumUsOob55d1Channels UnsignedShort Read-only N/A 50.11 NumUsOob55d2Demods UnsignedShort Read-only N/A 50.13 NumNdrChannels UnsignedShort Read-only N/A 50.15 NumUsPspFlowsPerChan UnsignedByte Read-only N/A 50.18 SupportsFlowTags Boolean Read-only N/A 50.26 RpdUcdProcessingTime UnsignedShort Read-only 1500..50000 µsec 50.31 RpdUcdChangeNullGrantTime UnsignedShort Read-only 0..4000 µsec 50.32 MultiSectionTimingMerReporting Enum Read-only notSupported(0), N/A 50.33 supportType1(1), supportType2(2) SupportsUsProfileQuery Boolean Read-only N/A 50.58 SupportsFlowTagIncrement Boolean Read-only N/A 50.63

7.1.4.4.1 MaxUsFrequency This attribute reports the maximum frequency of any upstream signal that the RPD supports on a US RF port. This attribute defines the highest frequency of the encompassed spectrum of the highest frequency upstream channel or OOB signal.

 09/03/21 CableLabs 141 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.4.2 MinUsFrequency This attribute reports the minimum frequency of any upstream signal that the RPD supports on a US RF port. This attribute defines the lowest frequency of the encompassed spectrum of the lowest frequency upstream channel or OOB signal.

7.1.4.4.3 MaxUnicastSids This attribute reports the maximum number of unicast SIDs concurrently supported by the RPD on any upstream channel.

7.1.4.4.4 NumUsRfPorts This attribute reports the number of upstream unidirectional RF ports available on the RPD.

7.1.4.4.5 NumUsScQamChannels This attribute reports the number of upstream SC-QAM channels supported per upstream RF port.

7.1.4.4.6 NumUsOob55d1Channels This attribute reports the number of upstream SCTE 55-1 channels supported per upstream RF port.

7.1.4.4.7 NumUsOob55d2Demods This attribute reports the number of upstream demodulators per SCTE 55-2 modules supported.

7.1.4.4.8 NumNdrChannels This attribute reports the number of narrowband digital return channels supported per upstream RF port.

7.1.4.4.9 NumUsPspFlowsPerChan This attribute reports the number of distinct PSP flows supported by the RPD on upstream data pseudowires.

7.1.4.4.10 SupportsFlowTags This attribute reports whether the RPD supports Flow Tags capability. A Flow Tag is a 32-bit identifier of a MAC hardware resource (typically a Service Flow). The Flow Tag can be assigned to the scheduled SID by the CCAP Core. The RPD provides Flow Tags in UEPI headers for OFDMA channels. The RPD reports a value of false(0) if it does not support Flow Tags on OFDMA channels. The RPD reports a value of true(1) if it supports Flow Tags on OFDMA channels.

7.1.4.4.11 RpdUcdProcessingTime This attribute reports the minimum interval the RPD needs to process a UCD message received via GCP. This interval is equivalent to CM UCD processing time defined in [MULPIv4.0], but its duration can be longer. The maximum value of the RPD UCD Processing time is 50000 usec. The minimum value RPD UCD Processing time is equal to CM UCD processing time (1500 usec for each changed SC-QAM channel or 2000 usec for each changed upstream OFDMA channel) defined in [MULPIv4.0].

7.1.4.4.12 RpdUcdChangeNullGrantTime This attribute reports the minimum Null grant interval the RPD needs in the first MAP with incremented UCD change count. The RPD uses the Null grant in the first MAP message to programs registers of its burst receiver during this interval. The maximum value of the RPD UCD Change Null Grant Time is 4000 usec for each changed channel. The minimum value of the RPD UCD Change Null Grant Time is defined in [MULPIv4.0].

142 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.4.13 MultiSectionTimingMerReporting This attribute reports whether the RPD supports Multi-Section Timing and MER reporting as opposed to just reporting a single average Timing and MER. More detail is documented in the UEPI Probe Pseudowire format of [R-UEPI]. The RPD reports notSupported(0) if the RPD does not support Multi-Section Timing and MER Reporting. The RPD reports supportType1(1) if the RPD supports equally spaced non-overlapping sections. The RPD reports supportType2(2) if the RPD supports fully flexible sections and spacing of non-overlapping sections.

7.1.4.4.14 SupportsUsProfileQuery This attribute reports whether the RPD supports UsScQamProfileQuery (TLV 150) and UsOfdmaConfigQuery (TLV 151) via UsScQamProfileResponse (TLV 152) and UsOfdmaConfigResponse (TLV 153). These TLVs allow the RPD to report various unique upstream burst receiver parameters to the CCAP Core. The RPD reports a value of false(0) when it does not support the upstream profile query TLVs. The RPD reports a value of true(1) when it supports the upstream profile query TLVs.

7.1.4.4.15 SupportsFlowTagIncrement This attribute reports whether the RPD supports the FlowTagIncrement TLV. The RPD reports a value of false(0) when it does not support the FlowTagIncrement TLV and will always set the flow tag of all SIDs in a SidQos TLV to the same value. The RPD reports a value of true(1) when it supports the FlowTagIncrement TLV.

7.1.4.5 UsPowerCapabilities The UsPowerCapabilities object reports the RPD capabilities related to upstream channel power management. The UsPowerCapabilities TLV Type is 50.49. Table 151 - UsPowerCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type MinBaseUsPowerTargetLevel Short Read-only TenthdBmV 50.49.1 MaxBaseUsPowerTargetLevel Short Read-only TenthdBmV 50.49.2 MinTargetRxPowerAdjustScqam Short Read-only TenthdB 50.49.3 MaxTargetRxPowerAdjustScqam Short Read-only TenthdB 50.49.4 MinTargetRxPowerAdjustOfdma Short Read-only TenthdB 50.49.5 MaxTargetRxPowerAdjustOfdma Short Read-only TenthdB 50.49.6 MinTargetRxPowerAdjustNdr Short Read-only TenthdB 50.49.7 MaxTargetRxPowerAdjustNdr Short Read-only TenthdB 50.49.8 MinTargetRxPowerAdjust55d2 Short Read-only TenthdB 50.49.9 MaxTargetRxPowerAdjust55d2 Short Read-only TenthdB 50.49.10

7.1.4.5.1 MinBaseUsPowerTargetLevel This attribute reports the minimum value of the base target power reference level for upstream signals received on all upstream channels on an RPD RF port.

7.1.4.5.2 MaxBaseUsPowerTargetLevel This attribute reports the maximum value of the base target power reference level for upstream signals received on all upstream channels on an RPD RF port.

 09/03/21 CableLabs 143 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.5.3 MinTargetRxPowerAdjustScqam This attribute reports the minimum power adjustment to the base target power level that the RPD supports for SC- QAM channels.

7.1.4.5.4 MaxTargetRxPowerAdjustScqam This attribute reports the maximum power adjustment to the base target power level that the RPD supports for SC- QAM channels.

7.1.4.5.5 MinTargetRxPowerAdjustOfdma This attribute reports the minimum power adjustment to the base target power level that the RPD supports for OFDMA channels.

7.1.4.5.6 MaxTargetRxPowerAdjustOfdma This attribute reports the maximum power adjustment to the base target power level that the RPD supports for OFDMA channels.

7.1.4.5.7 MinTargetRxPowerAdjustNdr This attribute reports the minimum power adjustment to the base target power level that the RPD supports for NDR channels.

7.1.4.5.8 MaxTargetRxPowerAdjustNdr This attribute reports the maximum power adjustment to the base target power level that the RPD supports for NDR channels.

7.1.4.5.9 MinTargetRxPowerAdjust55d2 This attribute reports the minimum value of the TargetRxPowerAdjust attribute that the RPD supports for SCTE 55- 2 upstream channels.

7.1.4.5.10 MaxTargetRxPowerAdjust55d2 This attribute reports the maximum value of the TargetRxPowerAdjust attribute that the RPD supports for SCTE 55- 2 upstream channels.

7.1.4.6 OfdmaCfgCapabilities The OfdmaCfgCapabilities object reports the RPD OFDMA upstream channel configuration capabilities. Table 152 - OfdmaCfgCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type OfdmaModulationOptions EnumBits Read-only modOrder2048Qam(0), N/A 50.54.6 modOrder4096Qam(1) NumUsOfdmaChannels UnsignedShort Read-only ReqOfdmaImDurationCfg Boolean Read-only N/A 50.4 MaxNumPmapIes UnsignedByte Read-only 32..128 N/A 50.54.3.1 ProbePowerControl Boolean Read-only N/A 50.54.3.2

7.1.4.6.1 OfdmaModulationOptions This attribute reports whether the RPD supports optional OFDMA modulation orders defined in [PHYv4.0]. The RPD reports ‘0’ for the bit corresponding to an OFDMA modulation order not supported by the RPD. The RPD reports ‘1’ for the bit corresponding to an OFDMA modulation order supported by the RPD.

144 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.6.2 NumUsOfdmaChannels This attribute reports the number of upstream DOCSIS 3.1 channels supported per upstream RF port.

7.1.4.6.3 ReqOfdmaImDurationCfg This attribute is a Boolean value that reports the RPD’s need to explicitly configure IM grant duration for OFDMA channels. The RPD reports a value of false(0) if the RPD does not require configuration of the IM grant duration. The RPD reports a value of true(1) if the RPD requires explicit configurations IM grant duration.

7.1.4.6.4 MaxNumPmapIes This attribute reports the maximum number of P-IEs per P-MAP supported by the RPD.

7.1.4.6.5 ProbePowerControl This attribute reports whether the RPD support Power Control (P) bit in P-MAP messages. The RPD reports a value of false(0) if the RPD does not support P-bit in P-MAP messages. The RPD reports a value of true(1) if the RPD supports P-bit in P-MAP messages.

7.1.4.7 DsCapabilitiesGrp The DsCapabilitiesGrp object is the container for RPD OFDM downstream channel capabilities. Table 153 - DsCapabilitiesGrp Object Associations

Associated Object Type Near-end Far-end Multiplicity Label Name Multiplicity DsCapabilities Directed association to 1 1 DsCapabilities DsPowerCapabilities Directed association to 1 1 DsPowerCapabilities ToneCapabilities Directed association to 1 1 ToneCapabilities OfdmCfgCapabilities Directed association to 1 1 OfdmCfgCapabilities

7.1.4.8 DsCapabilities The DsCapabilities object reports the RPD's OFDM downstream channel capabilities. The DsCapabilities TLV Type is 50.51.

 09/03/21 CableLabs 145 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 154 - DsCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type ScQamInterleaverSupport EnumBits Read-only reserved(0), N/A 50.51.1 taps8Increment16(1), taps16Increment8(2), taps32Increment4(3), taps64Increment2(4), taps128Increment1(5), taps12Increment17(6), taps128Increment2(7), taps128Increment3(8), taps128Increment4(9), taps128Increment5(10), taps128Increment6(11), taps128Increment7(12), taps128Increment8(13) MaxDocsisScQamChannels UnsignedShort Read-only N/A 50.51.2 MaxMultipleScQamPspSessions UnsignedShort Read-only 8..79 N/A 50.51.3 MaxNumBdrs UnsignedShort Read-only N/A 50.51.4 MaxNumBcgs UnsignedShort Read-only N/A 50.51.5 SupportsDsScQamModulationQam128 Boolean Read-only N/A 50.51.6 NumDsRfPorts UnsignedShort Read-only N/A 50.2 NumDsScQamChannels UnsignedShort Read-only N/A 50.6 NumDsOob55d1Channels UnsignedShort Read-only 0..2 N/A 50.10 NumDsOob55d2Modules UnsignedShort Read-only N/A 50.12 NumNdfChannels UnsignedShort Read-only N/A 50.14 NumDsPspFlowsPerChan UnsignedByte Read-only N/A 50.17 NumAsynchVideoChannels UnsignedByte Read-only N/A 50.25 MaxDsFrequency UnsignedInt Read-only Hertz 50.41 MinDsFrequency UnsignedInt Read-only Hertz 50.42

7.1.4.8.1 ScQamInterleaverSupport This attribute reports the RPD’s support for interleaver settings for downstream SC-QAM channels. The value is a bitmask specifying which of 13 downstream SC-QAM interleaver settings the RPD is capable of supporting. The RPD reports ‘0’ for the bit corresponding to an interleaver setting if the RPD does not support the interleaver setting. The RPD reports ‘1’ for the bit corresponding to an interleaver setting if the RPD supports the interleaver setting.

7.1.4.8.2 MaxDocsisScQamChannels This attribute reports the maximum number of downstream DOCSIS SC-QAM channels the RPD can be configured to support on each downstream RF port. A downstream DOCSIS SC-QAM channel is one configured with OperationalMode (TLV 62.6) set to Docsis(value 2). This value is equal to or lower than the reported capability NumDsScQamChannels, which is the number of supported SC-QAM channels whether or not they are configured for DOCSIS operation.

7.1.4.8.3 MaxMultipleScQamPspSessions This attribute reports the maximum number of PSP sessions with more than one SC-QAM channel that the RPD can support per downstream RF port. Currently, multiple-channel PSP sessions are specified for only DOCSIS SC-QAM channels [R-DEPI].

146 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

An RPD supports at least 8 PSP sessions per port with multiple DOCSIS SC-QAM channels (DEPI). This is the lowest permitted value of the capability. The maximum value is when all NumDsScQamChannels (TLV 50.6) are in two-channel PSP sessions.

7.1.4.8.4 MaxNumBdrs This attribute reports the maximum number of BDRs supported by the RPD.

7.1.4.8.5 MaxNumBcgs This attribute reports the maximum number of BCGs supported by the RPD.

7.1.4.8.6 SupportsDsScQamModulationQam128 This attribute reports whether the RPD supports QAM128 modulation for DS SC-QAM video channels. When the value of this attribute is reported as ‘true’, the RPD supports QAM128 modulation for DS SC-QAM channels. When the value of this attribute is reported as ‘false’, the RPD does not support QAM128 modulation for DS SC- QAM channels.

7.1.4.8.7 NumDsRfPorts This attribute reports the number of downstream unidirectional RF ports available on the RPD.

7.1.4.8.8 NumDsScQamChannels This attribute reports the number of downstream SC-QAM channels supported per downstream RF port.

7.1.4.8.9 NumDsOob55d1Channels This attribute represents the number of SCTE-55-1 forward (downstream) channels per DS RF port supported by the RPD. The RPD reports a value of ‘1’ when it supports a single SCTE 55-1 forward channel per DS RF port. The RPD reports a value of ‘2’ when it supports two SCTE 55-1 forward channels per DS RF port.

7.1.4.8.10 NumDsOob55d2Modules This attribute reports the number of SCTE 55-2 modules supported.

7.1.4.8.11 NumNdfChannels This attribute reports the number of narrowband digital forward channels supported per downstream RF port.

7.1.4.8.12 NumDsPspFlowsPerChan This attribute reports the number of distinct PSP flows supported by the RPD on downstream data pseudowires.

7.1.4.8.13 NumAsyncVideoChannels This attribute reports the number of asynchronous MPEG video channels supported per downstream RF port.

7.1.4.8.14 MaxDsFrequency This attribute reports the maximum frequency of any downstream signal that the RPD supports on its DS RF port. This is the highest frequency of the encompassed spectrum of the highest frequency downstream channel or OOB signal.

 09/03/21 CableLabs 147 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.8.15 MinDsFrequency This attribute reports the minimum frequency of any downstream signal that the RPD supports on its DS RF port. This is the lowest frequency of the encompassed spectrum of the lowest frequency downstream channel or OOB signal.

7.1.4.9 DsPowerCapabilities The DsPowerCapabilities object reports the RPD capabilities related to downstream channel power management. Table 155 - DsPowerCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SupportsFrequencyTilt Boolean Read-only N/A 50.27 MaxTiltValue UnsignedShort Read-only TenthdB 50.28 MaxBasePower UnsignedShort Read-only TenthdBmV per 6 MHz 50.43 MinTiltValue Short Read-only TenthdB 50.44 MinPowerAdjustScQam Short Read-only TenthdB 50.45 MaxPowerAdjustScQam UnsignedShort Read-only TenthdB 50.46 MinPowerAdjustOfdm Short Read-only TenthdB 50.47 MaxPowerAdjustOfdm UnsignedShort Read-only TenthdB 50.48 MinBasePower UnsignedShort Read-only TenthdBmV per 6 MHz 50.66

7.1.4.9.1 SupportsFrequencyTilt This attribute reports whether the RPD supports Frequency Tilt capability. The RPD reports a value of false(0) if it does not support Frequency Tilt settings on downstream RF ports. The RPD reports a value of true(1) if it supports Frequency Tilt settings on downstream RF ports.

7.1.4.9.2 MaxTiltValue This attribute indicates the maximum value of tilt settings that the RPD supports.

7.1.4.9.3 MaxBasePower This attribute reports the maximum power level setting that the RPD supports for downstream RF port. The value is expressed in units of TenthdBmV per 6 MHz.

7.1.4.9.4 MinTiltValue This attribute reports the minimum value of the tilt setting that the RPD supports. Note that the RPD can report this value as a negative number.

7.1.4.9.5 MinPowerAdjustScQam This attribute reports the minimum power adjustment value that the RPD supports for downstream SC-QAM channels.

7.1.4.9.6 MaxPowerAdjustScQam This attribute reports the maximum power adjustment that the RPD supports for downstream SC-QAM channels.

7.1.4.9.7 MinPowerAdjustOfdm This attribute reports the minimum power adjustment value that the RPD supports for downstream OFDM channels.

148 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.9.8 MaxPowerAdjustOfdm This attribute reports the maximum power adjustment that the RPD supports for downstream OFDM channels.

7.1.4.9.9 MinBasePower This attribute reports the minimum power level setting that the RPD supports for a downstream RF port. The value is expressed in units of TenthdBmV per 6 MHz.

7.1.4.10 ToneCapabilities The ToneCapabilities object reports the RPD’s downstream Continuous Wave tone generation capabilities. Table 156 - ToneCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NumCwToneGenerators UnsignedByte Read-only N/A 50.21.1 LowestCwToneFreq UnsignedInt Read-only Hz 50.21.2 HighestCwToneFreq UnsignedInt Read-only Hz 50.21.3 MaxPowerDedCwTone UnsignedShort Read-only TenthdB 50.21.4 QamAsPilot Boolean Read-only N/A 50.21.5 MinPowerDedCwTone Short Read-only TenthdB 50.21.6 MaxPowerQamCwTone UnsignedShort Read-only TenthdB 50.21.7 MinPowerQamCwTone Short Read-only TenthdB 50.21.8

7.1.4.10.1 NumCwToneGenerators This attribute reports the number of CW tone generators supported per downstream RF port.

7.1.4.10.2 LowestCwToneFreq This attribute reports the lowest frequency supported by the CW tone generators.

7.1.4.10.3 HighestCwToneFreq This attribute reports the highest frequency supported by the CW tone generators.

7.1.4.10.4 MaxPowerDedCwTone The attribute allows the RPD to inform the CCAP Core what is the maximum power level relative to the RF Port’s BasePower that is supported by its dedicated CW tone generators.

7.1.4.10.5 QamAsPilot This attribute indicates if a QAM channel can be configured as a CW tone. The RPD reports a value of false(0) if a QAM channel cannot be configured as a CW tone. The RPD reports a value of true(1) if a QAM channel can be configured as a CW tone.

7.1.4.10.6 MinPowerDedCwTone The attribute reports the RPD’s minimum power level relative to the RF Port’s BasePower that is supported by its dedicated CW tone generators.

7.1.4.10.7 MaxPowerQamCwTone The attribute reports the RPD’s maximum power level setting relative to the RF Port’s BasePower that is supported by its QAM channels operating as CW tone generators.

 09/03/21 CableLabs 149 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.10.8 MinPowerQamCwTone The attribute reports the RPD’s minimum power level setting relative to the RF Port’s BasePower that is supported by its QAM channels operating as CW tone generators.

7.1.4.11 OfdmCfgCapabilities OfdmConfigurationCapabilities object reports RPD capabilities related to OFDM channel configuration capabilities. The OfdmCfgCapabilities TLV Type is 50.54. Table 157 - OfdmCfgCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SupportedPilotPatterns EnumBits Read-only pilotPatternNum5(0), N/A 50.54.2 pilotPatternNum6(1), pilotPatternNum7(2), pilotPatternNum12(3), pilotPatternNum13(4), pilotPatternNum14(5), NumDsOfdmProfiles UnsignedByte Read-only 4..16 N/A 50.54.4 OptionalOfdmModulations EnumBits Read-only modOrder8192Qam(0), N/A 50.54.5 modOrder16384Qam(1) NumDsOfdmChannels UnsignedShort Read-only N/A 50.7

7.1.4.11.1 SupportedPilotPatterns This attribute reports the set of supported OFDMA optional pilot patterns for an RPD. The RPD reports ‘0’ for the bit corresponding to a pilot pattern not supported by the RPD. The RPD reports ‘1’ for the bit corresponding to a pilot pattern supported by the RPD.

7.1.4.11.2 NumDsOfdmProfiles This attribute reports how many OFDM profiles are supported by the RPD.

7.1.4.11.3 OptionalOfdmModulations This attribute reports whether the RPD supports optional OFDM modulation orders defined in [PHYv4.0]. The RPD reports ‘0’ for the bit corresponding to an OFDM modulation order not supported by the RPD. The RPD reports ‘1’ for the bit corresponding to an OFDM modulation order supported by the RPD.

7.1.4.11.4 NumDsOfdmChannels This attribute reports the number of downstream OFDM channels supported per downstream RF port.

7.1.4.12 StaticPwCapabilities This object provides information about the static Pseudowire capabilities and constraints of the RPD. The StaticPwCapabilities TLV Type is 50.50. Table 158 - StaticPwCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type MaxFwdStaticPws UnsignedShort Read-only N/A 50.50.1 MaxRetStaticPws UnsignedShort Read-only N/A 50.50.2 SupportsStaticMptDepiPw Boolean Read-only N/A 50.50.3

150 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type SupportsStaticMpt55d1RetPw Boolean Read-only N/A 50.50.4 SupportsStaticPspNdfMcastPw Boolean Read-only N/A 50.50.5 SupportsStaticPspNdrPw Boolean Read-only N/A 50.50.6 MaxUcastFwdStaticPws UnsignedShort Read-only N/A 50.50.7 SupportsStaticPspNdfUcastPw Boolean Read-only N/A 50.50.8 SupportsStaticPspPnmPw Boolean Read-only N/A 50.50.9 SupportsStaticPspSpecmanPw Boolean Read-only N/A 50.50.10 SupportsDepiPspMultichanPw Boolean Read-only N/A 50.50.11 SupportsUepiPws Boolean Read-only N/A 50.50.12 SupportsDtpPw Boolean Read-only N/A 50.50.13

7.1.4.12.1 MaxFwdStaticPws This attribute reports the maximum number of (multicast and unicast) forward static pseudowires supported by the RPD.

7.1.4.12.2 MaxRetStaticPws This attribute reports the maximum number of return pseudowires supported by the RPD. An RPD which does not support return static pseudowires reports zero.

7.1.4.12.3 SupportsStaticMptDepiPw This attribute reports whether the RPD supports configuration of static pseudowires of DEPI MPT (MPT-DEPI-PW) subtype. The RPD reports a value of false(0) if it does not support configuration of DEPI MPT static pseudowires. The RPD reports a value of true(1) if it supports configuration of DEPI MPT static pseudowires.

7.1.4.12.4 SupportsStaticMpt55d1RetPw This attribute reports whether the RPD supports configuration of static pseudowires of SCTE 55-1 return (MPT-55- 1-RET) subtype. The RPD reports a value of false(0) if it does not support configuration of SCTE 55-1 return static pseudowires. The RPD reports a value of true(1) if it supports configuration of SCTE 55-1 return static pseudowires.

7.1.4.12.5 SupportsStaticPspNdfMcastPw This attribute reports whether the RPD supports configuration of multicast static pseudowires of PSP NDF (PSP- NDF) subtype. The RPD reports a value of false(0) if it does not support configuration of multicast PSP-NDF static pseudowires. The RPD reports a value of true(1) if it supports configuration of multicast PSP-NDF static pseudowires.

7.1.4.12.6 SupportsStaticPspNdrPw This attribute reports whether the RPD supports configuration of static pseudowires of PSP NDR (PSP-NDR) subtype. The RPD reports a value of false(0) if it does not support configuration of PSP-NDR static pseudowires. The RPD reports a value of true(1) if it supports configuration of PSP-NDR static pseudowires.

 09/03/21 CableLabs 151 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.12.7 MaxUcastFwdStaticPws This attribute is used to report the maximum number of unicast forward static pseudowires supported by the RPD. An RPD which does not support unicast forward static pseudowires reports zero.

7.1.4.12.8 SupportsStaticPspNdfUcastPw This attribute reports whether the RPD supports configuration of unicast forward static pseudowires of PSP NDF (PSP-NDF) subtype. The RPD reports a value of false(0) if it does not support unicast PSP-NDF static pseudowires. The RPD reports a value of true(1) if it supports unicast PSP-NDF static pseudowires.

7.1.4.12.9 SupportsStaticPspPnmPw This attribute reports whether the RPD supports configuration of static pseudowires of PSP-PNM subtype. The RPD reports a value of false(0) if it does not support PSP-PNM static pseudowires. The RPD reports a value of true(1) if it supports PSP-PNM static pseudowires.

7.1.4.12.10 SupportsStaticPspSpecmanPw This attribute reports whether the RPD supports configuration of static pseudowires of PSP-SPECMAN subtype. The RPD reports a value of false(0) if it does not support PSP-SPECMAN static pseudowires. The RPD reports a value of true(1) if it supports PSP-SPECMAN static pseudowires.

7.1.4.12.11 SupportsDepiPspMultichanPw This attribute reports whether the RPD supports configuration of static pseudowires of subtype PSP-MULTICHAN- PW. The RPD reports a value of false(0) if is does not support PSP-MULTICHAN-PW static pseudowires. The RPD reports a value of true(1) if is supports PSP-MULTICHAN-PW static pseudowires.

7.1.4.12.12 SupportsUepiPws This attribute reports whether the RPD supports configuration of UEPI static pseudowires. A single capability indicates support for the pseudowire subtypes listed below. The RPD reports a value of false(0) if it does not support UEPI static pseudowires. The RPD reports a value of true(1) if it supports UEPI static pseudowires. • PSP-UEPI-SCQ • PSP-UEPI-OFDMA • PSP-BW-REQ-SCQ • PSP-BW-REQ-OFDMA • PSP-PROBE • PSP-RNG-REQ-SCQ • PSP-RNG-REQ-OFDMA • PSP-MAP-SCQ • PSP-MAP-OFDMA

152 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.12.13 SupportsDtpPw This attribute reports whether the RPD supports configuration of static pseudowires for DOCSIS Time Protocol (DTP) operation. The RPD reports a value of false(0) if it does not support static pseudowires for DTP operation. The RPD reports a value of true(1) if it supports UEPI static pseudowires for DTP operation.

7.1.4.13 ChannelReachability In some RPD implementations, an Ethernet interface might not have connectivity to all channels on a port of the RPD. This object allows the RPD to communicate those constraints. This object is only populated if reachability constraints exist on the RPD. The ChannelReachability TLV Type is 50.20. Table 159 - ChannelReachability Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type EnetPortIndex UnsignedByte Key N/A 50.20.1 RfPortIndex UnsignedByte Key N/A 50.20.3 ChannelType RphyChannelType Key N/A 50.20.2 StartChanIndex UnsignedByte Key N/A 50.20.4 EndChanIndex UnsignedByte Read-only N/A 50.20.5

7.1.4.13.1 EnetPortIndex This key attribute reports the Ethernet port on the RPD that has the connectivity constraint.

7.1.4.13.2 RfPortIndex This key attribute reports the RF port with which the Ethernet port has a connectivity constraint.

7.1.4.13.3 ChannelType This key attribute reports the type of channel that is supported within the specified channel index range on this RF port from the specified Ethernet interface. A row entry will be created for each channel type with a constraint. Absence of a row for a channel type means there is no constraint for that channel type.

7.1.4.13.4 StartChanIndex This key attribute reports the first channel of the specified channel type in the range of channels that does not have connectivity to the specified Ethernet port.

7.1.4.13.5 EndChanIndex This attribute reports the last channel of the specified channel type in the range of channels that does not have connectivity to the specified Ethernet port.

7.1.4.14 BufferMonitoringCapabilities This object reports buffer monitoring capabilities supported by the RPD.

 09/03/21 CableLabs 153 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 160 - BufferMonitoringCapabilities

Attribute Name Type Access Type Constraints Units TLV Type BufferDepthMonitorAlertSupport EnumBits Read-only ofdmChannels(0), N/A 50.29 scQamDocsisChannels(1), scQamVideoChannels(2), ndfChannels(3), scte551Channels(4), scte552Channels(5) BufferDepthConfigurationSupport EnumBits Read-only ofdmChannels(0), N/A 50.30 scQamDocsisChannels(1). ndfChannels(2)

7.1.4.14.1 BufferDepthMonitorAlertSupport This attribute reports the buffer depth monitoring alerts the RPD supports. For each bit set to 1, the RPD is capable of monitoring buffer depth on the corresponding types of downstream channels. The RPD reports ‘0’ for the bit corresponding to a downstream channel type if the RPD is not capable of monitoring the buffer depth of the channel type. The RPD reports ‘1’ for the bit corresponding to a downstream channel type if the RPD is capable of monitoring the buffer depth of the channel type.

7.1.4.14.2 BufferDepthConfigurationSupport This attribute reports the configuration of the output buffer depth supported by the RPD. This capability is only applicable to DOCSIS downstream channels. For each bit set to 1, the RPD is capable of configuring output buffer depth of the corresponding types of downstream channels. The RPD reports ‘0’ for the bit corresponding to a downstream channel type if the RPD is not capable of configuring the output buffer depth of the channel type. The RPD reports ‘1’ for the bit corresponding to a downstream channel type if the RPD is capable of configuring the output buffer depth of the channel type.

7.1.4.15 SwImageCapabilities The SwImageCapabilities object reports the RPD’s multiple software images capabilities. The SwImageCapabilities TLV Type is 50.53. Table 161 - SwImageCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NumSwImages UnsignedByte Read-only 1..4 N/A 50.53.1 ImageUpgradeability EnumBits Read-only image1Upgradeable(0), N/A 50.53.2 image2Upgradeable(1), image3Upgradeable(2), image4Upgradeable(3)

7.1.4.15.1 NumSwImages This attribute reports the number of software images that the RPD supports.

154 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.15.2 ImageUpgradeability This attribute reports which SW images in the RPD can be upgraded via SSD. An unsigned byte value with bitmask indicate whether the RPD supports secure software download of the corresponding software image. For example, bit 0 corresponds to software image with index 1, bit 1 corresponds to software image with index 2, etc. The RPD reports ‘0’ for the bit corresponding to a software image if the software image cannot be upgraded via SSD. The RPD reports ‘1’ for the bit corresponding to a software image if the software image can be upgraded via SSD.

7.1.4.16 MiscellaneousCapabilities The MiscellaneousCapabilities object reports RPDs capabilities not covered by other capabilities classes. Table 162 - MiscellaneousCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SupportsOpticalNodeRf Boolean Read-only N/A 50.40 NumCoresSupported UnsignedByte Read-only N/A 50.67

7.1.4.16.1 SupportsOpticalNodeRf This attribute reports whether the RPD supports the RF technology for an optical node. The RPD reports ‘false’ if it complies with the main section of the [DRFI] specification and the main section of the [PHYv4.0] specification. In this case the RPD does not support optical node technology (i.e., RPD is a Remote PHY Shelf). The RPD reports ‘true’ if it complies with Annex E and Annex F of [R-PHY] and [DRFI] specification Annex D. In this case the RPD supports optical node RF technology (i.e., RPD is a Remote PHY Node).

7.1.4.16.2 NumCoresSupported This attribute reports the number of CCAP Cores supported by the RPD.

7.1.4.17 GcpCapabilities The GcpCapabilities object reports the RPD’s capabilities related to GCP protocol. The GcpCapabilities TLV Type is 50.52. Table 163 - GcpCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type GcpKaResponseTime UnsignedShort Read-only 10..100 milliseconds 50.52.1

7.1.4.17.1 GcpKaResponseTime This attribute reports how quickly the RPD can respond to GCP KA messages.

7.1.4.18 RpdCoreRedundancyCapabilities RpdCoreRedundancyCapabilities object reports RPD capabilities for supporting redundant control connections to the CCAP Cores. The RpdCoreRedundancyCapabilities TLV Type is 50.56.

 09/03/21 CableLabs 155 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 164 - RpdCoreRedundancyCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Value Type SupportsRedundancy EnumBits Read-only handoverSupport(0), 50.56.1 connectionStatusSupport(1), 50.56.2 ccapCoreReconnectSupport(2) 50.56.3 SupportsAuxReconnectFailReset Boolean Read-only true 50.55.5 SupportsL2tpv3Trf Boolean Read-only false 50.68 MaxStandbyTunnels UnsignedByte Read-only 50.69

7.1.4.18.1 SupportsRedundancy This attribute is a bit mask indicating whether the RPD supports HandoverToBackup, ConnectionStatus, and/or ReconnectFromCore features as indicated below. The RPD reports ‘0’ for the bit corresponding to a CCAP Core redundancy capability if the RPD does not support the redundancy capability. The RPD reports ‘1’ for the bit corresponding to a CCAP Core redundancy capability if the RPD supports the redundancy capability.

7.1.4.18.2 SupportsAuxReconnectFailReset This attribute reports that the RPD implements the requirements in [R-PHY] section 7.2.2 Failure Scenarios for controlling RPD reset after reconnection to an auxiliary core fails. It indicates support for both the AuxReconnectFailReset and DefaultAuxReconnectFailReset objects. This attribute is specified in [R-PHY] to always report value ‘true’.

7.1.4.18.3 SupportsL2tpv3Trf This attribute reports whether the RPD supports L2TPv3 Tunnel Recovery and Failover. The value ‘false’ indicates the RPD does not support TRF. The value ‘true’ indicates the RPD supports TRF.

7.1.4.18.4 MaxStandbyTunnels This attribute reports the maximum number of Standby tunnels that the RPD supports.

7.1.4.19 InitializationCapabilities The InitializationCapabilities object reports the RPD capabilities for initialization. The InitializationCapabilities TLV Type is 50.65. Table 165 - InitializationCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type PerCoreInitTimers Boolean Read-only N/A 50.65.1 StagingConfigurableInitTimers Boolean Read-only N/A 50.65.2

7.1.4.19.1 PerCoreInitTimers

This attribute reports whether the RPD supports per Core initialization timers. The RPD reports a value of false(0) if it does not support per Core initialization timers. The RPD reports a value of true(1) if it supports per Core initialization timers.

7.1.4.19.2 StagingConfigurableInitTimers This attribute reports whether the RPD supports setting initialization timers during staging.

156 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The RPD reports a value of false(0) if it does not support setting of timers during staging. The RPD reports a value of true(1) if it supports setting of timers during staging.

7.1.4.20 ResetCapabilities ResetCapabilities object reports the RPD’s capabilities to support various types of RPD reset. The ResetCapabilities TLV Type is 50.55. Table 166 - ResetCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Type Value SupportsReset EnumBits Read-only softResetSupport(0), N/A 50.55.1 nvResetSupport(1), 50.55.2 factoryResetSupport(2) 50.55.3 auxReconnectFailResetSupport(3), 50.55.5 softResetAttemptSupport(4) 50.55.6 ResetHistorySize UnsignedShort Read-only N/A 50.55.4

7.1.4.20.1 SupportsReset This attribute is a bitmask indicating whether the RPD supports SoftReset, NvReset, FactoryReset, AuxReconnectFailReset, or SoftResetAttempt as indicated below: The RPD reports ‘0’ for the bit corresponding to a reset type if the RPD does not support the reset type. If the RPD does not respond to the capability TLV for a bit, that bit is also set to zero in this object. The RPD reports ‘1’ for the bit corresponding to a reset type if the RPD supports the reset type. TLVs 50.55.5 and 50.55.6 always report true (1) if these TLVs are supported by the RPD.

7.1.4.20.2 ResetHistorySize This attribute provides the maximum number of entries for the ResetHistory object. The RPD is required to support a minimum of 50 entries in the ResetHistory object.

7.1.4.21 PnmCapabilities The PnmCapabilities object reports the RPD capabilities for PNM test functionality. The PnmCapabilities TLV Type is 50.64. An RPD that implements PNM functions implements the DOCSIS PNM MIB module to enable control and reporting of PNM functions [DOCS-PNM-MIB]. Table 167 - PnmCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SupportedPnmTests EnumBits Read-only usCapActiveAndQuietProbes(0), N/A 50.64.1 usRxMer(1), usImpNoiseStatistics(2), dsSymCap(3), usHist(4)

 09/03/21 CableLabs 157 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 168 - PnmCapabilities Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity UpcCapabilities Directed composition to 1 1 UpcCapabilities

7.1.4.21.1 SupportedPnmTests The SupportedPnmTests attribute allows an RPD to communicate which PNM tests it supports. SupportedPnmTests is represented as a bitmask with each assigned bit representing an individual PNM test. The Upstream Triggered Spectrum Capture (UTSC) test is not represented in the bitmask since UTSC capabilities are defined separately via SpectrumCaptureCapabilities object (TLV Type 50.59). The RPD reports bit 0 as ‘1’ if it supports Upstream Capture of Active and Quiet Probes test. The RPD reports bit 1 as ‘1’ if it supports Upstream Receive MER test. The RPD reports bit 2 as ‘1’ if it supports Upstream Impulse Noise Statistics test. The RPD reports bit 3 as ‘1’ if it supports Downstream Symbol Capture test. The RPD reports bit 4 as ‘1’ if it supports Upstream Histogram test. The RPD reports all other bits as ‘0’.

7.1.4.22 UpcCapabilities The UpcCapabilities object reports the RPD capabilities for Upstream Probe Capture PNM tests. The UpcCapabilities TLV Type is 50.64.2. Table 169 - UpcCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type MinNumSymbols25Khz UnsignedByte Read-only 1..MaxNumPmapIes (TLV 50.54.3.1) N/A 50.64.2.1 MaxNumSymbols25Khz UnsignedByte Read-only MinNumSymbols25Khz..MaxNumPmap N/A 50.64.2.2 Ies (TLV 50.54.3.1) MinNumSymbols50Khz UnsignedByte Read-only 1..MaxNumPmapIes (TLV 50.54.3.1) N/A 50.64.2.3 MaxNumSymbols50Khz UnsignedByte Read-only MinNumSymbols50Khz..MaxNumPmap N/A 50.64.2.4 Ies (TLV 50.54.3.1) SupportsStaggeredPies Boolean Read-only N/A 50.64.2.5 SupportsDedicatedPwUpcRxMer Boolean Read-only N/A 50.64.2.6 SupportsFreqDomainSamples Boolean Read-only N/A 50.64.2.7

7.1.4.22.1 MinNumSymbols25Khz This attribute reports the minimum number of probe symbols that can be captured by the RPD in one test when an OFDMA channel is configured for 25 kHz subcarrier spacing.

7.1.4.22.2 MaxNumSymbols25Khz This attribute reports the maximum number of probe symbols that can be captured by the RPD in one test when an OFDMA channel is configured for 25 kHz subcarrier spacing.

7.1.4.22.3 MinNumSymbols50Khz This attribute reports the minimum number of probe symbols that can be captured by the RPD in one test when an OFDMA channel is configured for 50 kHz subcarrier spacing.

158 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.22.4 MaxNumSymbols50Khz This attribute reports the maximum number of probe symbols that can be captured by the RPD in one test when an OFDMA channel is configured for 50 kHz subcarrier spacing.

7.1.4.22.5 SupportsStaggeredPies This attribute reports whether the RPD supports UPC PNM test with staggered Probe Information Elements (P-IE), i.e., the RPD supports the use of a P-IE that specifies a staggered probe as the indicator for triggering the start of the capture and capturing consecutive symbols as defined by the P-IE subject to the RPD capability of the maximum number of symbols. The RPD reports a value of false(0) if it does not support UPC test with staggered P-IEs. The RPD reports a value of true(1) if it supports UPC test with staggered P-IEs.

7.1.4.22.6 SupportsDedicatedPwUpcRxMer This attribute reports whether the RPD supports dedicated pseudowires for UPC and RxMER PNM tests. The RPD reports a value of false(0) if it does not support dedicated pseudowires for UPC and RxMER tests. The RPD only supports a shared pseudowire for UPC and RxMER tests. The RPD reports a value of true(1) if it supports dedicated pseudowires for UPC and RxMER tests.

7.1.4.22.7 SupportsFreqDomainSamples This attribute reports whether the RPD supports UPC test with samples represented in frequency domain. The RPD reports a value of false(0) if it does not support samples represented in frequency domain. The RPD reports a value of true(1) if it supports samples represented in frequency domain.

7.1.4.23 FdxCapabilities FdxCapabilities object reports RPD support for various FDX-related functions. The FdxCapabilities TLV Type is 50.57. Table 170 - FdxCapabilities Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type SupportsFdx Boolean Read-only N/A 50.57.1 SupportsZblInsertion Boolean Read-only N/A 50.57.2 ZblInsMsgLeadTime UnsignedShort Read-only milliseconds 50.57.3

Table 171 - FdxCapabilities Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity EchoCancellerCapabilities Directed composition to 1 1 EchoCancellerCapabilities

7.1.4.23.1 SupportsFdx This attribute reports the RPD’s capability to support FDX operation. The RPD reports a value of false(0) if the RPD does not support FDX operation. The RPD reports a value of true(1) if the RPD supports FDX operation.

 09/03/21 CableLabs 159 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.23.2 SupportsZblInsertion This attribute reports the RPD’s capability to receive the Zero Bit Loading (ZBL) Insertion message and insert ZBL as directed by the message. The RPD reports a value of false(0) if the RPD does not support ZBL insertion. The RPD reports a value of true(1) if the RPD supports ZBL insertion.

7.1.4.23.3 ZblInsMsgLeadTime This attribute reports the minimum lead time required by the RPD to receive the ZBL Insertion message ahead of the starting timestamp.

7.1.4.24 EchoCancellerCapabilities EchoCancellerCapabilities object reports RPD support for various FDX Node Echo Canceller functions. The EchoCancellerCapabilities TLV Type is 50.57.4. Table 172 - EchoCancellerCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type EctMethod Enum Read-only other(1), N/A 50.57.4.1 autoEcTraining(2), scheduledEcTraining(3) MaxEctChannels UnsignedByte Read-only N/A 50.57.4.2 MinEctPeriod UnsignedShort Read-only 0 | 20..65535 milliseconds 50.57.4.3 MaxEctPeriod UnsignedShort Read-only 0..500 milliseconds 50.57.4.4 MinEctoDuration UnsignedShort Read-only OFDMA 50.57.4.5 symbols MaxEctoDuration UnsignedShort Read-only OFDMA 50.57.4.6 symbols PerSubbandControl Boolean Read-only 50.57.4.7 ErdDuration UnsignedShort Read-only microseconds 50.57.4.8 InitialEcTrainingTime UnsignedShort Read-only milliseconds 50.57.4.9

7.1.4.24.1 EctMethod This attribute reports which EC training method is supported by the RPD. other - The EC training method supported by the RPD is not covered by this specification. autoEcTraining - The RPD supports Autonomous EC Training. scheduledEcTraining - The RPD supports Scheduled EC Training.

7.1.4.24.2 MaxEctChannels This attribute reports the maximum number of FDX OFDMA channels on which the RPD can train simultaneously.

7.1.4.24.3 MinEctPeriod This attribute reports the minimum EC acceptable training opportunity period for this RPD. A value of zero means that the RPD does not require periodic EC Training Opportunities.

7.1.4.24.4 MaxEctPeriod This attribute reports the maximum EC acceptable training opportunity period for this RPD.

160 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.24.5 MinEctoDuration This attribute reports the minimum ECTO duration specified in OFDMA symbols.

7.1.4.24.6 MaxEctoDuration This attribute reports the maximum ECTO duration specified in OFDMA symbols.

7.1.4.24.7 PerSubbandControl This attribute reports whether the EcEnable TLV 66.23.2 controls EC operation per FDX sub-band. When the value of this attribute is reported as ‘true’, the RPD EC operation can be enabled or disabled per sub-band. In this case, when a CCAP Core enables/disables EC for one of the channels of an FDX sub-band, the EC is also enabled/disabled for the other channel of the sub-band. When the value of this attribute is reported as ‘false’, the RPD only supports per channel EC control.

7.1.4.24.8 ErdDuration This attribute reports the RPD EC Re-convergence Delay (ERD).

7.1.4.24.9 InitialEcTrainingTime This attribute reports how much quiet time the RPD Echo Canceller requires to train after channel initialization.

7.1.4.25 PmtudCapabilities The PmtudCapabilities object reports the RPD capabilities for Path MTU Discovery support for control plane connections. The PmtudCapabilities TLV Type is 50.62. Table 173 - PmtudCapabilities Object Attributes

Attribute Name Type Access Type Units TLV Type Constraints SupportsIcmpBasedPmtud Boolean Read-only N/A 50.62.1 SupportsPacketizationBasedPmtud Boolean Read-only N/A 50.62.2

7.1.4.25.1 SupportsIcmpBasedPmtud This attribute reports the RPD’s support of PMTUD based on [RFC 1191] and [RFC 8201]. The RPD reports a value of false(0) if it does not support PMTUD based on [RFC 1191] and [RFC 8201]. The RPD reports a value of true(1) if it supports PMTUD based on [RFC 1191] and [RFC 8201].

7.1.4.25.2 SupportsPacketizationBasedPmtud This attribute reports the RPD’s support of PMTUD based on [RFC 4821]. The RPD reports a value of false(0) if it does not support PMTUD based on [RFC 4821]. The RPD reports a value of true(1) if it supports PMTUD based on [RFC 4821].

7.1.4.26 RdtiCapabilities RdtiCapabilities object reports the RPD’s capabilities related to time synchronization. The RdtiCapabilities TLV Type is 50.34.

 09/03/21 CableLabs 161 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 174 - RdtiCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NumPtpPortsPerEnetPort UnsignedByte Read-only N/A 50.34.1 SupportsSyncE Boolean Read-only N/A 50.34.2 SupportsG8275d1 Boolean Read-only N/A 50.34.3

7.1.4.26.1 NumPtpPortsPerEnetPort This attribute reports how many PTP ports the RPD supports per CIN-facing Ethernet port. If the RPD does not support PTP port configuration from the CCAP Core, as it can be in the case of PHY Shelf device, the RPD reports zero.

7.1.4.26.2 SupportsSyncE This attribute reports whether the RPD supports synchronous Ethernet (SyncE). When the value of this attribute is reported as ‘true’, the RPD supports SyncE. When the value of this attribute is reported as ‘false’, the RPD does not support SyncE.

7.1.4.26.3 SupportsG8275d1 This attribute is used to advertise RPD’s capability to support G.8275.1 PTP profile. When the value of this attribute is reported as ‘true’, the RPD supports G.8275.1 profile. When the value of this attribute is reported as ‘false’, the RPD does not support G.8275.1 profile.

7.1.4.27 SpectrumCaptureCapabilities SpectrumCaptureCapabilities object reports RPD capabilities for Upstream Triggered Spectrum Capture Proactive Network Management functionality. The SpectrumCaptureCapabilities TLV Type is 50.59. Table 175 - SpectrumCaptureCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NumSacs UnsignedByte Read-only N/A 50.59.1

Table 176 - SpectrumCaptureCapabilities Object Associations

Associated Object Type Near-end Far-end Multiplicity Label Name Multiplicity SacCapabilities Directed composition to SacCapabilities 1 1

7.1.4.27.1 NumSacs This attribute reports the number of Spectrum Analysis Circuits (SACs) the RPD supports.

7.1.4.28 SacCapabilities The SacCapabilities object reports the capabilities of each Spectrum Analysis Circuit implemented in the RPD. The SacCapabilities TLV Type is 50.59.2. Table 177 - SacCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SacIndex UnsignedByte key N/A 50.59.2.1

162 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type SacDescription AdminString Read-only SIZE(0..64) N/A 50.59.2.2 MaxCaptureSpan UnsignedInt Read-only Hz 50.59.2.3 MinimumCaptureFrequency UnsignedInt Read-only Hz 50.59.2.4 MaximumCaptureFrequency UnsignedInt Read-only Hz 50.59.2.5 SupportedTriggerModes EnumBits Read-only freeRunning(0), N/A 50.59.2.6 miniSlotCount(1), sid(2), notUsed(3), quietProbeSymbol(4), burstIuc(5), timestamp(6), activeProbe(7) SupportedOutputFormats EnumBits Read-only timeIQ(0), N/A 50.59.2.7 fftPower(1), rawAdc(2), fftIQ(3), fftAmplitude(4), fftDb(5) SupportedWindowFormats EnumBits Read-only rectangular(0), N/A 50.59.2.8 hann(1), blackmanHarris(2), hamming(3), flattop(4), gaussian(5), chebyshev(6) SupportsAveraging Boolean Read-only N/A 50.59.2.9 SupportedAggregationMethods EnumBits Read-only maxHold(0) N/A 50.59.2.10 SupportsSpectrumQualification Boolean Read-only N/A 50.59.2.11 MaxNumBins UnsignedShort Read-only N/A 50.59.2.12 MinNumBins UnsignedShort Read-only N/A 50.59.2.13 MinRepeatPeriod UnsignedInt Read-only microseconds 50.59.2.14 SupportedTrigChanTypes EnumBits Read-only scQamChannel(0), N/A 50.59.2.15 ofdmaChannel(1) PwType EnumBits Read-only pnmPw(0), N/A 50.59.2.16 specManPw(1) LowestCapturePort UnsignedByte Read-only N/A 50.59.2.17 HighestCapturePort UnsignedByte Read-only N/A 50.59.2.18 SupportsScanningCapture Boolean Read-only N/A 50.59.2.19 MinScanningRepeatPeriod UnsignedInt Read-only microseconds 50.59.2.20

7.1.4.28.1 SacIndex This attribute uniquely identifies a SAC in an RPD.

7.1.4.28.2 SacDescription This attribute is a human readable description of a SAC, for example, “Wideband Spectrum Analysis Circuit, frequency range 5-85 MHz”.

7.1.4.28.3 MaxCaptureSpan This attribute reports the maximum value of the frequency span supported by the SAC.

7.1.4.28.4 MinCaptureFreq This attribute reports the lowest limit of the spectrum that can be captured by the SAC.

 09/03/21 CableLabs 163 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.28.5 MaxCaptureFreq This attribute reports the upper limit of the spectrum that can be captured by the SAC.

7.1.4.28.6 SupportedTriggerModes This attribute reports the Triggered Spectrum Capture trigger modes the RPD SAC supports. The value is a bitmask specifying which of 7 spectrum capture trigger modes the SAC is capable of supporting. The RPD reports ‘0’ for the bit corresponding to a trigger mode if the SAC does not support the trigger mode. The RPD reports ‘1’ for the bit corresponding to a trigger mode if the SAC supports the trigger mode.

7.1.4.28.7 SupportedOutputFormats This attribute reports the Triggered Spectrum Capture output data file formats the RPD SAC supports. The value is a bitmask specifying which of 6 output data file formats the SAC is capable of supporting. The RPD reports ‘0’ for the bit corresponding to an output data file format if the SAC does not support the output file format. The RPD reports ‘1’ for the bit corresponding to an output data file format if the SAC supports the output file format.

7.1.4.28.8 SupportedWindowFormats This attribute reports the Triggered Spectrum Capture data sample window functions the RPD SAC supports. The value is a bitmask specifying which of 7 window functions or formats the SAC is capable of supporting. The RPD reports ‘0’ for the bit corresponding to a window function if the SAC does not support the window function. The RPD reports ‘1’ for the bit corresponding to a window function if the SAC supports the window function.

7.1.4.28.9 SupportsAveraging This attribute reports the RPD SAC’s capability to support Triggered Spectrum Capture data averaging. The RPD reports a value of false(0) if the SAC does not support the data averaging function. The RPD reports a value of true(1) if the SAC supports the data averaging function.

7.1.4.28.10 SupportedAggregationMethods This attribute reports the Triggered Spectrum Capture data aggregation methods the RPD SAC supports. The value is a bitmask specifying which aggregation method the SAC is capable of supporting. The RPD reports ‘0’ for the bit corresponding to the aggregation method if the SAC does not support the aggregation method. The RPD reports ‘1’ for the bit corresponding to the aggregation method if the SAC supports the aggregation method.

7.1.4.28.11 SupportsSpectrumQualification This attribute reports the SAC’s capability to support Triggered Spectrum Capture spectrum qualification. The RPD reports a value of false(0) if the SAC does not support spectrum qualification. The RPD reports a value of true(1) if the SAC supports spectrum qualification.

7.1.4.28.12 MaxNumBins This attribute reports the maximum number of Fast Fourier Transform (FFT) bins the RPD’s SAC supports for Triggered Spectrum Capture.

164 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.28.13 MinNumBins This attribute reports the minimum number of Fast Fourier Transform (FFT) bins the RPD’s SAC supports for Triggered Spectrum Capture.

7.1.4.28.14 MinRepeatPeriod This attribute reports the minimum duration of the RepeatPeriod supported by the SAC.

7.1.4.28.15 SupportedTrigChanTypes This attribute reports all supported channel types that can be used for triggers by the SAC. The value is a bitmask specifying which channel types the SAC is capable of supporting as triggers. The RPD reports ‘0’ for the bit corresponding to a channel type if the SAC does not support the channel type as a trigger. The RPD reports ‘1’ for the bit corresponding to a channel type if the SAC supports the channel type as a trigger.

7.1.4.28.16 PwType This attribute reports which pseudowire (PW) types the SAC is capable of using. The value is a bitmask specifying which PW types the SAC is capable of using. The RPD reports ‘0’ for the bit corresponding to a pseudowire type if the SAC cannot use that pseudowire type. The RPD reports ‘1’ for the bit corresponding to a pseudowire type if the SAC can use that pseudowire type.

7.1.4.28.17 LowestCapturePort This attribute reports the lowest upstream RF port index on which the SAC can operate.

7.1.4.28.18 HighestCapturePort This attribute reports the highest upstream RF port index on which the SAC can operate.

7.1.4.28.19 SupportsScanningCapture This attribute indicates whether the SAC supports Port Scanning Capture. Port Scanning Capture is a method of operation in free-running mode in which the SAC sequentially captures spectrum from two or more US RF ports. The RPD reports a value of false(0) if the SAC does not support Port Scanning Capture. The RPD reports a value of true(1) if the SAC supports Port Scanning Capture.

7.1.4.28.20 MinScanningRepeatPeriod This attribute reports the minimum duration of the RepeatPeriod the SAC supports when it is operating in Port Scanning Capture.

7.1.4.29 LogCapabilities The LogCapabilities object reports the RPD’s event logging capabilities. Table 178 - LogCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type RpdPendingEvQueueSize UnsignedShort Read-only N/A 50.38 RpdLocalEventLogSize UnsignedInt Read-only N/A 50.39

 09/03/21 CableLabs 165 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.29.1 RpdPendingEvQueueSize This attribute reports the number of events in the RPD’s Pending Event Report Queue.

7.1.4.29.2 RpdLocalEventLogSize This attribute reports the number of events in the RPD’s Local Event Log.

7.1.4.30 NetworkingCapabilities The NetworkingCapabilities object reports the RPD’s data networking capabilities. Table 179 - NetworkingCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NumTenGeNsPorts UnsignedShort Read-only N/A 50.4 NumOneGeNsPorts UnsignedShort Read-only N/A 50.5 NumHundredGeNsPorts UnsignedShort Read-only N/A NumFortyGeNsPorts UnsignedShort Read-only N/A NumTwentyFiveGeNsPorts UnsignedShort Read-only N/A SupportsUdpEncap Boolean Read-only N/A 50.16 MaxDsPspSegCount UnsignedByte Read-only 10..255 N/A 50.35 DirectDsFlowQueueMapping Boolean Read-only N/A 50.36 DsSchedulerPhbldList HexBinary Read-only N/A 50.37

7.1.4.30.1 NumTenGeNsPorts This attribute reports the number of 10 gigabit Ethernet ports supported by the RPD.

7.1.4.30.2 NumOneGeNsPorts This attribute reports the number of 1 gigabit Ethernet ports supported by the RPD.

7.1.4.30.3 NumHundredGeNsPorts This attribute reports the number of 100 gigabit Ethernet ports supported by the RPD.

7.1.4.30.4 NumFortyGeNsPorts This attribute reports the number of 40 gigabit Ethernet ports supported by the RPD.

7.1.4.30.5 NumTwentyFiveGeNsPorts This attribute reports the number of 25 gigabit Ethernet ports supported by the RPD.

7.1.4.30.6 SupportsUdpEncap This attribute reports whether the RPD supports UDP encapsulation on L2TPv3 pseudowires. The RPD reports a value of false(0) if it does not support UDP encapsulation on L2TPv3 pseudowires. The RPD reports a value of true(1) if it supports UDP encapsulation on L2TPv3 pseudowires.

7.1.4.30.7 MaxDsPspSegCount This attribute reports how many PSP segments the RPD can support in a packet received on downstream PSP pseudowires.

166 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.30.8 DirectDsFlowQueueMapping This attribute reports whether the RPD supports direct mapping of downstream PSP flows to strict priority queues. [R-DEPI] provides more detailed information about direct mapping of downstream PSP flows to strict priority queues. The RPD reports a value of false(0) when it does not support direct mapping of downstream PSP flows to strict priority queues. The RPD reports a value of true(1) when it supports direct mapping of downstream PSP flows to strict priority queues.

7.1.4.30.9 DsSchedulerPhbIdList This attribute reports the list of PHB-IDs supported by the RPD’s downstream scheduler. [R-DEPI] provides more detailed information about PHB-IDs for the RPD’s downstream scheduler. The value of this attribute is a hexadecimal string in which six LSBs of each byte contain a single PHB-ID that is supported by the RPD’s scheduler.

7.1.4.31 RfmCapabilities RfmCapabilities object allows an RPD designed to operate in an optical node to communicate its capabilities for configuration and status reporting for features and functions of the RF Module (RFM). The RfmCapabilities TLV Type is 50.60. Table 180 - RfmCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type SupportsRfmManagement Boolean Read-only N/A 50.60.1 NumNodeRfPorts UnsignedShort Read-only N/A 50.60.2 SupportsDsCfgRfmGain Boolean Read-only N/A 50.60.3 MinDsCfgRfmGain Short Read-only TenthdB 50.60.4 MaxDsCfgRfmGain Short Read-only TenthdB 50.60.5 SupportsUsCfgRfmGain Boolean Read-only N/A 50.60.6 MinUsCfgRfmGain Short Read-only TenthdB 50.60.7 MaxUsCfgRfmGain Short Read-only TenthdB 50.60.8 SupportsRfmDsTiltConfig Boolean Read-only N/A 50.60.9 MinRfmDsTilt Short Read-only TenthdB 50.60.10 MaxRfmDsTilt Short Read-only TenthdB 50.60.11 MaxDsPowerGainFunctions UnsignedShort Read-only N/A 50.60.12 MaxUsPowerGainFunctions UnsignedShort Read-only N/A 50.60.13 MaxDsTiltCtrlFunctions UnsignedShort Read-only N/A 50.60.14 MinRfmDsFreq UnsignedInt Read-only Hz 50.60.15 MaxRfmDsFreq UnsignedInt Read-only Hz 50.60.16

 09/03/21 CableLabs 167 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 181 - RfmCapabilities Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity NodeRfPortCapabilities Directed composition to 1 1 NodeRfPortCapabilities

7.1.4.31.1 SupportsRfmManagement This attribute reports whether the RPD supports management of the RFM. The RPD reports a value of false(0) if it does not support RFM management. The RPD reports a value of true(1) if it supports RFM management.

7.1.4.31.2 NumNodeRfPorts This attribute reports how many node RF ports the RPD supports.

7.1.4.31.3 SupportsDsCfgRfmGain This attribute reports whether the RPD supports configuration of the RFM downstream power gain via GCP. The RPD reports a value of false(0) if it does not support GCP configuration of the DS RFM power gain. The RPD reports a value of true(1) if it supports GCP configuration of the DS RFM power gain.

7.1.4.31.4 MinDsCfgRfmGain This attribute reports the RPD’s minimum supported value of the RFM DS power gain configuration.

7.1.4.31.5 MaxDsCfgRfmGain This attribute reports the RPD’s maximum supported value of the RFM DS power gain configuration.

7.1.4.31.6 SupportsUsCfgRfmGain This attribute reports whether the RPD supports configuration of the RFM upstream power gain via GCP. The RPD reports a value of false(0) if it does not support GCP configuration of the US RFM gain. The RPD reports a value of true(1) if it supports GCP configuration of the US RFM gain.

7.1.4.31.7 MinUsCfgRfmGain This attribute reports the RPD’s minimum supported value of the RFM US power gain configuration.

7.1.4.31.8 MaxUsCfgRfmGain This attribute reports the RPD’s maximum supported value of the RFM US power gain configuration.

7.1.4.31.9 SupportsRfmDsTiltConfig This attribute reports whether the RPD supports configuration of the RFM downstream tilt via GCP. The RPD reports a value of false(0) if it does not support GCP configuration of the RFM DS tilt. The RPD reports a value of true(1) if it supports GCP configuration of the RFM DS tilt.

7.1.4.31.10 MinRfmDsTilt This attribute reports the RPD’s minimum supported value of the RFM DS tilt configuration.

168 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.4.31.11 MaxRfmDsTilt This attribute reports the RPD’s maximum supported value of the RFM DS tilt configuration.

7.1.4.31.12 MaxDsPowerGainFunctions This attribute reports how many distinct DS power control functions (i.e., typically amplifiers) the RPD supports in the RFM.

7.1.4.31.13 MaxUsPowerGainFunctions This attribute reports how many distinct US power control functions (i.e., typically attenuators) the RPD supports in the RFM.

7.1.4.31.14 MaxDsTiltCtrlFunctions This attribute reports how many distinct DS tilt control functions the RPD supports in the RFM.

7.1.4.31.15 MinRfmDsFreq This attribute reports the RPD’s minimum DS frequency supported by the RFM through MinRfmDsFreq attribute.

7.1.4.31.16 MaxRfmDsFreq This attribute reports the RPD’s maximum DS frequency supported by the RFM through MaxRfmDsFreq attribute.

7.1.4.32 NodeRfPortCapabilities The NodeRfPortCapabilities object reports the RPD configuration capabilities of the RFM Node RF ports. The NodeRfPortCapabilities TLV Type is 50.60.17. Table 182 - NodeRfPortCapabilities Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type NodeRfPortIndex UnsignedByte key N/A 50.60.17.1 NodeRfPortVendorDesc AdminString Read-only SIZE(0..64) N/A 50.60.17.2 RpdUsRfPortMap UnsignedByte Read-only N/A 50.60.17.3 RpdDsRfPortMap UnsignedByte Read-only N/A 50.60.17.4 RfmUsGainCtrlIndex UnsignedByte Read-only N/A 50.60.17.5 RfmDsGainCtrlIndex UnsignedByte Read-only N/A 50.60.17.6 RfmDsTiltCtrlIndex UnsignedByte Read-only N/A 50.60.17.7 NodeRfPortOperatorLabel AdminString Read-only SIZE(0..64) N/A 50.60.17.8

7.1.4.32.1 NodeRfPortIndex This attribute is used to identify a node RF port in the RFM. For the purpose of GCP management, node RF ports are numbered from 0 to N-1, where N is the number reported by the RPD through NumNodePorts attribute.

7.1.4.32.2 NodeRfPortVendorDesc This attribute reports the RPD’s human readable description of the node RF Port.

7.1.4.32.3 RpdUsRfPortMap This attribute reports the index association of the node RF port to the US RF Port in the RPD Module. If an RPD supports configurable mapping between node RF ports and the US RF port, then this attribute reports the current mapping.

 09/03/21 CableLabs 169 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.4.32.4 RpdDsRfPortMap This attribute reports the index association of the node RF port to the DS RF Port in the RPD Module. If an RPD supports configurable mapping between node RF ports and the DS RF ports, then this attribute reports the current mapping.

7.1.4.32.5 RfmUsGainCtrlIndex This attribute reports the RPD’s index association of the node RF port with US gain control function in the RFM.

7.1.4.32.6 RfmDsGainCtrlIndex This attribute reports the RPD’s index association of the node RF port with DS gain control function in the RFM.

7.1.4.32.7 RfmDsTiltCtrlIndex This attribute reports the RPD’s index association of the node RF port with DS tilt control function in the RFM.

7.1.4.32.8 NodeRfPortOperatorLabel This attribute reports the RPD’s operator label of the node RF Port. The default value is the zero-length string.

7.1.4.33 TelemetryCapabilities The TelemetryCapabilities object reports RPD capabilities for collecting and reporting network operational data including Streaming Telemetry as described in [R-PHY] section 17, RPHY Streaming Telemetry. The TelemetryCapabilities TLV Type is 50.70. Table 183 - TelemetryCapabilities Object Attributes

Attribute Name Type Access Type Units Default TLV Type Constraints Value SupportsStreamingTelemetry Boolean Read-only 50.70.1 NumTelemetryClientsSupported UnsignedByte Read-only 50.70.2

7.1.4.33.1 SupportsStreamingTelemetry This attribute reports the RPD’s support for Streaming Telemetry as defined in [R-PHY]. The value 'false' indicates the RPD does not support Streaming Telemetry. The value 'true' indicates the RPD supports Streaming Telemetry.

7.1.4.33.2 NumTelemetryClientsSupported This attribute reports the number of Telemetry Clients supported by the RPD.

7.1.5 RPD Interface Information Model These objects provide reporting of RPD entity and interface information via communication from the CCAP Core. Figure 20 defines the RPD entity and interface information model reported via the CCAP Core.

170 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 20 - RPD Interface Information Model

7.1.5.1 RpdInfo The RpdInfo object serves as the root on the RPD Capabilities Information Model. The RpdInfo object is defined in Section 7.1.3.2 and referenced here. Table 184 - RpdInfo Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name Entity Directed composition to 1 1..* Entity IfEnet Directed composition to 1 1..* IfEnet RfmStatus Directed composition to 1 0..* RfmStatus

7.1.5.2 Entity The Entity object reports entities that exist within each Remote PHY Node that is communicating with the CCAP Core. Because the entities exist within the Remote PHY Nodes and not the CCAP Core, the RPDs communicate this

 09/03/21 CableLabs 171 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

information to the CCAP Core via GCP. This object is based on the entPhysicalTable object specified in the ENTITY-MIB [RFC 6933]. An RPD in a shelf MUST report the Entity with EntityIndex one as having a Class value of ‘chassis’. This represents the shelf which contains the RPDs. An RPD in a shelf MUST report an Entity with Class value of ‘chassis’ with a ContainedIn value of zero and a ParentRelPos value of zero. An RPD not in a shelf (i.e., an RPD in a node) MAY report an Entity with EntityIndex one as having a Class value of ‘chassis’. If an RPD not in a shelf reports an Entity with EntityIndex one as having a Class value of ‘chassis’, the CCAP Core SHOULD treat that RPD as an RPD in a one-RPD shelf. The CCAP Core MUST treat an RPD with an Entity with EntityIndex one that does not have a Class value of ‘chassis’ as an RPD in a node and not create an instance in the RpdShelfInfo object for that RPD. All RPDs in the same shelf need to report the same chassis SerialNum for the chassis Entity with EntityIndex one so that the CCAP Core can populate the RpdShelfInfo object properly. The RPD MUST report at least one Entity for the RPD module itself with a Class value of 'module'. For one of the RPD module Entities reported by the RPD with a Class value of 'module', the RPD MUST report attributes to match the same values as RpdIdentification attributes per Table 185 - RPD Module Entity Attributes. The RPD MUST report the Uuid for the module entity with attributes matching the same values as RpdIdentification attributes per Table 185 - RPD Module Entity Attributes such that the node value of the Uuid contains the RPD's unique identifier as the last 6 bytes and all other octets contain zero. The RPD MAY report other entities, including other Entities with a Class value of 'module', e.g., for its Ethernet interfaces. If the RPD has other modules than the main RPD module, the RPD MUST NOT report the RPD’s unique identifier in the other (non-main) modules’ UUID. Only one module is permitted to include the RPD’s unique ID as its UUID. The Uuid is used to determine which of possibly several Entity modules is the main RPD module. If RPDs are removable from a shelf, each RPD in a shelf MUST report Entity objects such that at least one Entity with a Class value of ‘container’ represents the slot containing the RPD main module (i.e., the module with a Uuid for that Entity such that the node value of the Uuid contains the RPD unique identifier and all other octets contain zero). If the RPD is field replaceable in a shelf, then the RPD MUST report Entity objects such that its main module, i.e., the module with UUID equal to the RPD's unique ID, has a parent that is a container, and that container's parent is the chassis at index 1. The ContainedIn value for the Entity with a Class value of ‘container’ that contains an RPD main module in a shelf is required to be one, indicating that this is a container (i.e., a slot) in the shelf chassis, and its ParentRelPos is set to the slot number of the RPD (e.g., 0, 1, 2, etc., for slot numbers starting with zero, or 1,2,3, etc., for slot numbers starting with one). The RPD in a shelf MUST report Entity objects such that its main module Entity has a ContainedIn value equal to the EntityIndex of the container corresponding to an RPD slot and a ParentRelPos value of zero. The RPD MAY report other Entities with a Class value of ‘container’ that also have a ContainedIn value of one if there are slots for other elements in the shelf. Examples of other types of containers in the shelf chassis might be a shelf controller, fan units, and power supplies. Table 185 - RPD Module Entity Attributes

RPD Module Entity Must match RpdIdentification Attribute RpdIdentification Attribute GCP TLV Descr DeviceDescription 50.19.7 HardwareRev HwRevision 50.19.16 FirmwareRev BootRomVersion 50.19.6 SoftwareRev CurrentSwVersion 50.19.5 SerialNum SerialNumber 50.19.9 MfgName VendorName 50.19.1 ModelName ModelNumber 50.19.3 Alias DeviceAlias 50.19.8

The CCAP Core MUST implement an instance of the Entity object for each entity reported by the RPD. The RPD MUST report the unique component serial number, via the SerialNum attribute, contained within the instance of the Entity object for the enclosure, RPD module, and each Field Replaceable Unit (FRU) that has a serial number in the system. Example FRUs with serial numbers include, but are not limited to, Ethernet cards, RF

172 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903 amplifiers, and RPD modules. If the RPD supports environmental sensors, the RPD MUST report instances of the Entity object for such sensors with a Class value of "sensor". The CCAP Core reads all attributes of an Entity Object with GCP complex TLV Type 100.6. The RPD MUST NOT report RF ports, channels or pseudowires in the Entity object. Table 186 - Entity Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length EntityIndex UnsignedInt Key 1..2147483647 N/A 100.6.1 4 Descr AdminString Read-Only N/A 100.6.2 0..255 VendorType AdminString Read-Only N/A 100.6.3 0..255 ContainedIn PhysicalIndexorZero Read-Only N/A 100.6.4 4 Class Enum Read-Only other(1), N/A 100.6.5 1 unknown(2), chassis(3), backplane(4), container(5), powerSupply(6), fan(7), sensor(8), module(9), port(10), stack(11), cpu(12) ParentRelPos Int Read-Only -1..2147483647 N/A 100.6.6 4 Name AdminString Read-Only N/A 100.6.7 0..255 HardwareRev AdminString Read-Only N/A 100.6.8 0..255 FirmwareRev AdminString Read-Only N/A 100.6.9 0..255 SoftwareRev AdminString Read-Only N/A 100.6.10 0..255 SerialNum AdminString Read-Only SIZE(0..32) N/A 100.6.11 0..255 MfgName AdminString Read-Only N/A 100.6.12 0..255 ModelName AdminString Read-Only N/A 100.6.13 0..255 Alias AdminString Read-Only SIZE(0..32) N/A 100.6.14 0..255 AssetId AdminString Read-Only SIZE(0..32) N/A 100.6.15 0..255 IsFRU Boolean Read-Only N/A 100.6.16 1 MfgDate DateTime Read-Only N/A 100.6.17 8 or 11 Uris HexBinary Read-Only SIZE(2) N/A 100.6.18 2 Uuid UUIDorZero Read-Only N/A 100.6.20 0 or 16

Table 187 - Entity Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Sensor Directed composition to Sensor 1 1

7.1.5.2.1 EntityIndex This key attribute reports an arbitrary value that uniquely identifies the physical entity. Index values for different physical entities are not necessarily contiguous.

 09/03/21 CableLabs 173 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.5.2.2 Descr This attribute reports a textual description of the physical entity. This object contains a string that identifies the manufacturer's name for the physical entity and is set to a distinct value for each version or model of the physical entity.

7.1.5.2.3 VendorType This attribute reports an indication of the vendor-specific hardware type of the physical entity. Note that this is different from the definition of MIB-II's sysObjectID. An agent sets this attribute to an enterprise-specific registration identifier value indicating the specific equipment type in detail. The associated instance of Class is used to indicate the general type of hardware device. If no vendor-specific registration identifier exists for this physical entity, or the value is unknown by this agent, then an empty string is returned.

7.1.5.2.4 ContainedIn This attribute reports the value of the Index for the physical entity that 'contains' this physical entity. A value of zero indicates this physical entity is not contained in any other physical entity. Note that the set of 'containment' relationships defines a strict hierarchy; that is, recursion is not allowed. In the event that a physical entity is contained by more than one physical entity (e.g., double-wide modules), this attribute identifies the containing entity with the lowest value of Index.

7.1.5.2.5 Class This attribute reports an indication of the general hardware type of the physical entity. An agent sets this attribute to the standard enumeration value that most accurately indicates the general class of the physical entity, or the primary class if there is more than one entity. If no appropriate standard registration identifier exists for this physical entity, then the value 'other(1)' is returned. If the value is unknown by this agent, then the value 'unknown(2)' is returned.

7.1.5.2.6 ParentRelPos This attribute reports an indication of the relative position of this 'child' component among all its 'sibling' components. Sibling components are defined as entries that share the same instance values of each of the ContainedIn and Class objects. An NMS can use this object to identify the relative ordering for all sibling components of a particular parent (identified by the ContainedIn instance in each sibling entry). If possible, this value should match any external labeling of the physical component. For example, for a container (e.g., card slot) labeled as 'slot #3', ParentRelPos should have the value '3'. Note that the entry for the module plugged in slot 3 should have a ParentRelPos value of '1'. If the physical position of this component does not match any external numbering or clearly visible ordering, then user documentation or other external reference material should be used to determine the parent-relative position. If this is not possible, then the agent should assign a consistent (but possibly arbitrary) ordering to a given set of 'sibling' components, perhaps based on internal representation of the components. If the agent cannot determine the parent-relative position for some reason, or if the associated value of ContainedIn is '0', then the value '-1' is returned. Otherwise, a non-negative integer is returned, indicating the parent-relative position of this physical entity. Parent-relative ordering normally starts from '1' and continues to 'N', where 'N' represents the highest positioned child entity. However, if the physical entities (e.g., slots) are labeled from a starting position of zero, then the first sibling should be associated with a ParentRelPos value of '0'. Note that this ordering may be sparse or dense, depending on agent implementation.

174 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The actual values returned are not globally meaningful, as each 'parent' component may use different numbering algorithms. The ordering is only meaningful among siblings of the same parent component. The agent should retain parent-relative position values across reboots, either through algorithmic assignment or use of non-volatile storage.

7.1.5.2.7 Name This attribute reports the textual name of the physical entity. The value of this attribute is the name of the component as assigned by the local device and will be suitable for use in commands entered at the device's `console'. This might be a text name (e.g., `console') or a simple component number (e.g., port or module number, such as `1'), depending on the physical component naming syntax of the device. If there is no local name, or if this object is otherwise not applicable, then this attribute reports a zero-length string. Note that the value of entPhysicalName for two physical entities will be the same in the event that the console interface does not distinguish between them, e.g., slot-1 and the card in slot-1.

7.1.5.2.8 HardwareRev This attribute reports the vendor-specific hardware revision string for the physical entity. The preferred value is the hardware revision identifier actually printed on the component itself (if present). Note that if revision information is stored internally in a non-printable (e.g., binary) format, then the agent converts such information to a printable format, in an implementation-specific manner. If no specific hardware revision string is associated with the physical component, or if this information is unknown to the agent, then this attribute will report a zero-length string.

7.1.5.2.9 FirmwareRev This attribute reports the vendor-specific firmware revision string for the physical entity. Note that if revision information is stored internally in a non-printable (e.g., binary) format, then the agent converts such information to a printable format, in an implementation-specific manner. If no specific firmware programs are associated with the physical component, or if this information is unknown to the agent, then this attribute will report a zero-length string.

7.1.5.2.10 SoftwareRev This attribute reports the vendor-specific software revision string for the physical entity. Note that if revision information is stored internally in a non-printable (e.g., binary) format, then the agent is required to convert such information to a printable format, in an implementation-specific manner. If no specific software programs are associated with the physical component, or if this information is unknown to the agent, then this attribute will report a zero-length string.

7.1.5.2.11 SerialNum This attribute reports the vendor-specific serial number string for the physical entity. The preferred value is the serial number string actually printed on the component itself (if present). Not every physical component will have a serial number, or even need one. Physical entities for which the associated value of the IsFRU object is equal to 'false' do not need their own unique serial number. An agent may return a zero-length string. Example FRUs that might not have serial numbers yet are expected to be represented in the Entity object, include flash cards and power supply modules. The RPD SHOULD report the unique component serial number, via the SerialNum attribute, contained for each FRU that is a pluggable optical module such as an SFP, SFP+, QSFP, XFP, CXP.

 09/03/21 CableLabs 175 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The RPD SHOULD report the unique component serial number, via the SerialNum attribute, contained within the instance of the Entity object for every FRU that is capable of causing and/or generating an event, message, log, or alarm.

7.1.5.2.12 MfgName This attribute reports the name of the manufacturer of this physical component. The preferred value is the manufacturer name string actually printed on the component itself (if present). If the manufacturer name string associated with the physical component is unknown to the agent, then this attribute will report a zero-length string.

7.1.5.2.13 ModelName This attribute reports the vendor-specific model name identifier string associated with this physical component. The preferred value is the customer-visible part number, which may be printed on the component itself. If the model name string associated with the physical component is unknown to the agent, then this attribute will report a zero-length string.

7.1.5.2.14 Alias This attribute reports an 'alias' name for the physical entity, as specified by a network manager, and provides a non- volatile 'handle' for the physical entity. If the Alias string associated with the physical component is not set, then this attribute will report a zero-length string. For the RPD main module Entity, the RPD MUST report the same value as the 'DeviceAlias' object reported with GCP TLV 50.19.8.

7.1.5.2.15 AssetId This attribute reports an NMS-assigned asset tracking identifier for the physical entity, and provides non-volatile storage of this information. If the AssetId string associated with the physical component is not set, then this attribute will report a zero-length string.

7.1.5.2.16 IsFRU This attribute reports whether or not this physical entity is considered a 'field replaceable unit' by the vendor. If this attribute reports the value 'true(1)' then this entry identifies a field replaceable unit. For all entries that represent components permanently contained within a field replaceable unit, the value 'false' is returned for this attribute.

7.1.5.2.17 MfgDate This attribute reports the date of manufacturing of the managed entity. If the manufacturing date is unknown or not supported, the attribute is not instantiated. The special value '0000000000000000'H may also be returned in this case.

7.1.5.2.18 Uris This attribute reports additional identification information about the physical entity. The attribute contains URIs and, therefore, the syntax of this object conforms to [RFC 3986], section 2. Multiple URIs may be present and are separated by white space characters. Leading and trailing white space characters are ignored. If no additional identification information is known about the physical entity or supported, the attribute is not instantiated. A zero length octet string may also be returned in this case.

176 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.2.19 Uuid This attribute contains identification information about the physical entity. The object contains a Universally Unique Identifier; the syntax of this attribute, if UUID information is known, will usually conform to [RFC 4122], Section 4.1. An exception is that the syntax of the UUID for the module entity with attributes matching the same values as RpdIdentification attributes per Table 185 - RPD Module Entity Attributes does not conform to [RFC 4122], Section 4.1, but rather contains just the RPD unique ID in the last six bytes, with zeros in the other bytes. A zero-length octet string is returned if no UUID information is known.

7.1.5.3 Sensor This object contains one instance per physical sensor represented by an associated instance of the Entity object. An instance of this object describes the present reading of a sensor, the measurement units and scale, and sensor operational status. The CCAP Core SHOULD create an instance for each physical sensor at the same time as the associated Entity object instance. The CCAP Core SHOULD delete an instance for each physical sensor if the associated Entity object instance is deleted. This object is based on the entPhySensorTable object specified in the ENTITY-SENSOR-MIB [RFC 3433]. Annex B defines several specific environmental condition Event IDs via sensor readings (e.g., temperature, humidity, power). Annex B also defines a generic sensor event, Event ID 66070508, which can be used to report any type of sensor-based event condition. Event ID 66070508 does not have an assigned event priority since the priority can vary based on the type of sensor event being logged. Vendors assign one of the standard DOCSIS priorities. While Event ID 66070508 conveys the sensor reading, sensor type, scale and description, the RPD EntityIndex is included, which allows additional information about the sensor to be obtained and correlated via the Sensor object values. The use of this event is vendor-dependent. The CCAP Core reads the attributes of an RPD's Sensor object with GCP complex TLV Type 100.7. Table 188 - Sensor Object Attributes

Attribute Type Access Type Constraints Units TLV Type TLV Value Name Field Length EntityIndex UnsignedInt Key N/A 100.7.1 4 SensorType Enum Read-Only other(1), N/A 100.7.2 1 unknown(2), voltsAC(3), voltsDC(4), amperes(5), watts(6), hertz(7), celsius(8), percentRH(9), rpm(10), cmm(11), truthvalue(12)

 09/03/21 CableLabs 177 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Type Access Type Constraints Units TLV Type TLV Value Name Field Length Scale Enum Read-Only yocto(1), N/A 100.7.3 1 zepto(2), atto(3), femto(4), pico(5), nano(6), micro(7), milli(8), units(9), kilo(10), mega(11), giga(12), tera(13), exa(14), peta(15), zetta(16), yotta(17) Precision Int Read-Only -8..9 N/A 100.7.4 4 Value Int Read-Only -1000000000..1000000000 N/A 100.7.5 4 OperStatus Enum Read-Only ok(1), N/A 100.7.6 1 unavailable(2), nonoperational(3) UnitsDisplay AdminString Read-Only N/A 100.7.7 0..255 ValueTimeStamp TimeStamp Read-Only N/A 100.7.8 4 ValueUpdateRate UnsignedInt Read-Only milliseconds 100.7.9 4

7.1.5.3.1 EntityIndex This key attribute reports an arbitrary value that uniquely identifies the physical entity. Index values for different physical entities are not necessarily contiguous.

7.1.5.3.2 SensorType This attribute reports the type of data returned by the associated Value attribute. The CCAP Core SHOULD set the value for SensorType during Sensor instance creation. The CCAP Core SHOULD NOT change the value for SensorType during Sensor operation. A value of 'other' indicates a measure other than those listed below. A value of 'unknown' indicates an unknown measurement, or arbitrary, relative numbers. A value of 'voltsAC' indicates an electric potential. A value of 'voltsDC' indicates an electric potential. A value of 'amperes' indicates electric current. A value of 'watts' indicates power. A value of 'hertz' indicates frequency. A value of 'celsius' indicates temperature. A value of 'percentRH' indicates percent relative humidity. A value of 'rpm' indicates shaft revolutions per minute. A value of 'cmm' indicates cubic meters per minute (airflow). A value of 'truthvalue' indicates value returns true(1) or false(2).

178 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.3.3 Scale This attribute reports a data scaling factor, represented with an International System of Units (SI) prefix. The actual data units are determined by examining this attribute together with the associated SensorType attribute. This attribute is defined together with SensorType and Precision. Together, these three attributes are used to identify the semantics of the Value attribute.

7.1.5.3.4 Precision This attribute reports the number of decimal places of precision in fixed-point sensor values returned by the associated Value attribute. This attribute is set to '0' when the associated SensorType value is not a fixed-point type: e.g., 'percentRH(9)', 'rpm(10)', 'cmm(11)', or 'truthvalue(12)'. The data type for this attribute is defined as Int because the TEXTUAL-CONVENTION EntitySensorPrecision is defined with syntax Integer32 in [RFC 3433].

7.1.5.3.5 Value This attribute reports the most recent measurement obtained by the RPD for this sensor.

7.1.5.3.6 OperStatus The operational status of the sensor.

7.1.5.3.7 UnitsDisplay This attribute reports a textual description of the data units used in the display of Value.

7.1.5.3.8 ValueTimeStamp This attribute reports the value of RpdSysUpTime at the time the status and/or value of this sensor was last obtained by the RPD.

7.1.5.3.9 ValueUpdateRate This attribute reports an indication of the frequency that the CCAP Core updates the associated Value object, represented in milliseconds. A value zero indicates: • the sensor value is updated on demand, • the sensor value is updated when the sensor value changes (event-driven), • the RPD does not know the update rate.

7.1.5.4 IfEnet This object provides details about the Ethernet interfaces on the RPD. The attributes of this object are based on the ifTable/ifXTable specified in [RFC 2863]. The CCAP Core MUST create an instance of the IfEnet object for every Ethernet interface on the RPD. The CCAP Core reads the IfEnet object with GCP TLV Type 100.8. Table 189 - IfEnet Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length EnetPortIndex UnsignedByte Key N/A 100.8.1 1 87.2.1 Name AdminString Read-Only N/A 100.8.2 0..255

 09/03/21 CableLabs 179 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length Descr AdminString Read-Only N/A 100.8.3 0..255 Type IANAifType Read-Only N/A 100.8.4 2 Alias AdminString Read-Only SIZE(0..64) N/A 100.8.5 0..64 Mtu Int Read-Only N/A 100.8.6 4 PhysAddress MacAddress Read-Only N/A 100.8.7 6 AdminStatus Enum Read-Only up(1), N/A 100.8.8 1 down(2), testing(3) OperStatus Enum Read-Only up(1), N/A 100.8.9 1 down(2), testing(3), unknown(4), dormant(5), notPresent(6), lowerLayerDown(7) LastChange TimeStamp Read-Only N/A 100.8.10 4 HighSpeed Gauge32 Read-Only mbps 100.8.11 4 LinkUpDownTrapE Boolean Read-Only N/A 100.8.12 1 nable PromiscuousMode Boolean Read-Only N/A 100.8.13 1 ConnectorPresent Boolean Read-Only N/A 100.8.14 1 NetworkAuthStatus Enum Read-Only other(0) N/A 87.2.2 1 waitForEapReq(1), execute802dot1x(2), sleepAfterFailure(3), operationalAuthenticated(4), operationalNotAuthenticated(5)

7.1.5.4.1 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface. This attribute is mapped to two RCP TLVs. TLV 87.2.1 is used when reading NetworkAuthStatus (TLV 87.2.2) from the RPD. In all other cases, this attribute maps to TLV 100.8.1.

7.1.5.4.2 Name This attribute reports a textual string representing a name that describes the interface. The CCAP Core MUST populate the Name attribute of the IfEnet object with the ID that is used in GCP for this port.

7.1.5.4.3 Descr This attribute reports a textual string containing information about the Ethernet interface. This string includes the name of the manufacturer, the product name and the version of the interface hardware/software.

7.1.5.4.4 Type This attribute reports the type of interface. Additional values for Type are assigned by the Internet Assigned Numbers Authority (IANA), through updating the syntax of the IANAifType textual convention. The types are defined in the IANAifType-MIB. The value reported by this attribute is ethernetCsmacd.

7.1.5.4.5 Alias This attribute reports an Alias for the interface. On the first instantiation of an interface, the value of Alias associated with that interface is the zero-length string. As and when a value is written into an instance of Alias through a network management operation, then the RPD retains the supplied value in the Alias instance associated with the

180 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903 same interface for as long as that interface remains instantiated, including across all re-initializations/reboots of the network management system, including those which result in a change of the interface's EnetPortIndex value.

7.1.5.4.6 MTU This attribute reports the size of the largest packet that can be sent/received on the interface, specified in octets. For interfaces that are used for transmitting network datagrams, this is the size of the largest network datagram that can be sent on the interface.

7.1.5.4.7 PhysAddress This attribute reports the interface's address at its protocol sub-layer. For example, for an 802.x interface, this attribute normally contains a MAC address. The interface's media-specific MIB defines the bit and byte ordering and the format of the value of this attribute. For interfaces that do not have such an address (e.g., a serial line), this attribute reports an octet string of zero length.

7.1.5.4.8 AdminStatus This attribute reports the state of the interface. The testing(3) state indicates that no operational packets can be passed. When a managed system initializes, all interfaces start with AdminStatus in the down(2) state. As a result of either explicit management action or per configuration information retained by the managed system, AdminStatus is then changed to either the up(1) or testing(3) states (or remains in the down(2) state).

7.1.5.4.9 OperStatus This attribute reports the current operational state of the interface. The testing(3) state indicates that no operational packets can be passed. If AdminStatus is down(2) then OperStatus should be down(2). If AdminStatus is changed to up(1), then OperStatus should change to up(1) if the interface is ready to transmit and receive network traffic; it should change to dormant(5) if the interface is waiting for external actions (such as a serial line waiting for an incoming connection); it should remain in the down(2) state if and only if there is a fault that prevents it from going to the up(1) state; it should remain in the notPresent(6) state if the interface has missing (typically, hardware) components.

7.1.5.4.10 LastChange This attribute reports the value of RpdSysUpTime at the time the interface entered its current operational state. If the current state was entered prior to the last re-initialization of the local network management subsystem, then this attribute reports a zero value.

7.1.5.4.11 HighSpeed This attribute reports an estimate of the interface's current bandwidth in units of 1,000,000 bits per second. If this attribute reports a value of 'n' then the speed of the interface is somewhere in the range of 'n-500,000' to 'n+499,999'. For interfaces that do not vary in bandwidth or for those where no accurate estimation can be made, this attribute reports the nominal bandwidth.

7.1.5.4.12 LinkUpDownTrapEnable This attribute reports whether linkup/linkdown traps are generated for this interface. A value of '1' indicates that traps are enabled. A value of '2' indicates that traps are disabled.

7.1.5.4.13 PromiscuousMode This attribute reports a value of '2' (false) if this interface only accepts packets/frames that are addressed to this interface. This attribute reports a value of '1' (true) when the station accepts all packets/frames transmitted on the media.

 09/03/21 CableLabs 181 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The value of PromiscuousMode does not affect the reception of broadcast and multicast packets/frames by the interface.

7.1.5.4.14 ConnectorPresent This attribute reports the value 'true' if the interface sublayer has a physical connector and the value 'false' otherwise.

7.1.5.4.15 NetworkAuthStatus This attribute reports the network authentication status of this interface. ‘other’ – The interface is in a state not listed below. 'waitForEapReq' – The interface is waiting for a reply to its EAP request. 'execute802.1x' – The interface is in the process of completing 802.1x network authentication. 'sleepAfterFailure' – 802.1x authentication failed on this interface and the interface is down. 'operationalAuthenticated' – The interface is operational and authenticated to the network. 'operationalNotAuthenticated' – The interface is operational, but not authenticated to the network (i.e., 802.1x was not required on the network).

7.1.5.5 IfEnetStats This object reports statistics for the Ethernet interfaces on the RPD. The attributes of this object are based on the ifTable/ifXTable specified in [RFC 2863]. The CCAP Core MUST create an instance of the IfEnetStats object for every IfEnet object instance. Discontinuities in the value of these counters can occur at reinitialization of the managed system, and at other times as indicated by the value of CounterDiscontinuityTime. The CCAP Core reads the attributes of an IfEnetStats object with the complex TLV Type 100.9. Table 190 - IfEnetStats Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length EnetPortIndex UnsignedByte Key N/A 100.9.1 1 InOctets Counter64 Read-Only octets 100.9.2 8 InFrames Counter64 Read-Only frames 100.9.6 8 InUnicastFrames Counter64 Read-Only frames 100.9.7 8 InMulticastFrames Counter64 Read-Only frames 100.9.8 8 InBroadcastFrames Counter64 Read-Only frames 100.9.9 8 InDiscards Counter64 Read-Only frames 100.9.10 8 InErrors Counter64 Read-Only frames 100.9.11 8 InUnknownProtos Counter64 Read-Only frames 100.9.12 8 OutOctets Counter64 Read-Only octets 100.9.13 8 OutFrames Counter64 Read-Only frames 100.9.17 8 OutUnicastFrames Counter64 Read-Only frames 100.9.18 8 OutMulticastFrames Counter64 Read-Only frames 100.9.19 8 OutBroadcastFrames Counter64 Read-Only frames 100.9.20 8 OutDiscards Counter64 Read-Only frames 100.9.21 8 OutErrors Counter64 Read-Only frames 100.9.22 8 CounterDiscontinuityTime DateTime Read-Only N/A 100.9.23 8 or 11

182 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.5.1 InOctets This attribute is the count of all octets received by the RPD on this Ethernet interface.

7.1.5.5.2 InFrames This attribute is the count of all frames received by the RPD on this Ethernet interface.

7.1.5.5.3 InUnicastFrames This attribute is the count of all unicast frames received by the RPD on this Ethernet interface.

7.1.5.5.4 InMulticastFrames This attribute is the count of all multicast frames received by the RPD on this Ethernet interface.

7.1.5.5.5 InBroadcastFrames This attribute is the count of all broadcast frames received by the RPD on this Ethernet interface.

7.1.5.5.6 InDiscards This attribute is the number of inbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.

7.1.5.5.7 InErrors For packet-oriented interfaces, this attribute reports the number of inbound packets that contained errors preventing them from being deliverable to a higher-layer protocol. For character-oriented or fixed-length interfaces, this attribute reports the number of inbound transmission units that contained errors preventing them from being deliverable to a higher-layer protocol.

7.1.5.5.8 InUnknownProtos For packet-oriented interfaces, this attribute reports the number of packets received via the interface that were discarded because of an unknown or unsupported protocol. For character-oriented or fixed-length interfaces that support protocol multiplexing the number of transmission units received via the interface which were discarded because of an unknown or unsupported protocol. For any interface that does not support protocol multiplexing, this attribute will always report 0.

7.1.5.5.9 OutOctets This attribute is the count of all octets transmitted by the RPD on this Ethernet interface.

7.1.5.5.10 OutFrames This attribute is the count of all frames transmitted by the RPD on this Ethernet interface.

7.1.5.5.11 OutUnicastFrames This attribute is the count of all unicast frames transmitted by the RPD on this Ethernet interface.

7.1.5.5.12 OutMulticastFrames This attribute is the count of all multicast frames transmitted by the RPD on this Ethernet interface.

7.1.5.5.13 OutBroadcastFrames This attribute is the count of all broadcast frames transmitted by the RPD on this Ethernet interface.

 09/03/21 CableLabs 183 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.5.5.14 OutDiscards This attribute is the number of outbound packets that were chosen to be discarded even though no errors had been detected to prevent their being deliverable to a higher-layer protocol. One possible reason for discarding such a packet could be to free up buffer space.

7.1.5.5.15 OutErrors For packet-oriented interfaces, this attribute reports the number of outbound packets that could not be transmitted because of errors. For character-oriented or fixed-length interfaces, this attribute reports the number of outbound transmission units that could not be transmitted because of errors.

7.1.5.5.16 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.5.6 SfpPlusStatus This object provides detailed information about the SFP+ pluggable transceivers on the RPD Ethernet Interfaces. This object is intended to convey information available from Digital Diagnostic Memory Map of the transceiver as defined in [SFF 8472]. The CCAP Core MUST create an instance of the SfpPlusStatus object for every Ethernet interface on the RPD. The CCAP Core reads the SfpPlusStatus object with GCP TLV Type 100.18. Table 191 - SfpPlusStatus Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length EnetPortIndex UnsignedByte Key 100.18.1 1 Status EnumBits Read-Only unknown(0), N/A 100.18.2 2 notInstalled(1), installed(2), faulty(3), operational(4), enabled(5), disabled(6), invalidCcBase(7), invalidCcExt(8) Identifier Enum Read-Only unknown(0), N/A 100.18.3 1 gbic(1), sff(2), sfpOrSfpPlus(3), sbi(4), xenpack(5), xfp(6), xff(7), xfpE(8), xPak(9), x2(10), dwdmSfp(11), qsfp(12), vendorSpecific(128-255) ExtendedIdentifier HexBinary Read-Only SIZE(1) N/A 100.18.4 1

184 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length ConnectorType Enum Read-Only unknown(0), N/A 100.18.5 1 sc(1), fcscc1(2), fcscc2(3), bnctnc(4), fcch(5), fiberJack(6), lc(7), mtrj(8), mu(9), sg(10), opticalPigtail(11), mpoParallel(12), hssdc2(32), copperPigtail(33), rj45(34), vendorSpecific(128-255) TransceiverComplianceCo HexBinary Read-Only SIZE(8) N/A 100.18.6 8 des TransceiverComplianceCo HexBinary Read-Only SIZE(1) N/A 100.18.7 1 de36 Encoding Enum Read-Only unspecified(0), N/A 100.18.8 1 eightTenB(1), fourFiveB(2), nrz(3). manchester(4), sonetScrambled(5), sixtyFourSixtySixB(6) BitRateNominal UnsignedByte Read-Only 100 MBd 100.18.9 1

 09/03/21 CableLabs 185 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length RateIdentifier Enum Read-Only unspecified(0), N/A 100.18.10 2 sff8079(1), sff8431Rx(2), unspecified3(3), sff8431Tx(4), unspecified5(5), sff8431indepRxTx(6), unspecified7(7), fcpi5Rx(8), unspecified9(9), fcpi5Tx(10), unspecified11(11), fcpi6(12), unspecified13(13), rxTx10_8g(14), unspecified15(15), fcpi7(16), unspecified17(17), reserved18(18), reserved19(19), reserved20(20), reserved21(21), reserved22(22), reserved23(23), reserved24(24), reserved25(25), reserved26(26), reserved27(27), reserved28(28), reserved29(29), reserved30(30), reserved31(31), pmdRateSelect(32) LengthKm UnsignedByte Read-Only km 100.18.11 1 Length100M UnsignedByte Read-Only 100s of 100.18.12 1 meters Length50Mi10M UnsignedByte Read-Only 10s of meters 100.18.13 1 Length62Pt5Mi10M UnsignedByte Read-Only 10s of meters 100.18.14 1 LengthCopperM UnsignedByte Read-Only meters 100.18.15 1 Length50MiOm3 UnsignedByte Read-Only 10s of meters 100.18.16 1 VendorName AdminString Read-Only SIZE(16) N/A 100.18.17 16 VendorOui HexBinary Read-Only SIZE(3) N/A 100.18.18 3 VendorPartNum AdminString Read-Only SIZE(16) N/A 100.18.19 16 VendorSerialNum AdminString Read-Only SIZE(16) N/A 100.18.20 16 VendorRev AdminString Read-Only SIZE(4) N/A 100.18.21 4 LaserWavelength UnsignedShort Read-Only Nanometers 100.18.22 2

186 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length Options EnumBits Read-Only unallocated0(0), N/A 100.18.23 2 rxlosNormal(1), rxlosInverted(2) txFault(3), txDisable(4), rateSelect(5), unallocated6(6), unallocated7(7), linearOutput(8), powerLevel(9), cooledTransceiver(10) BitRateMax UnsignedByte Read-Only percent 100.18.24 1 BitRateMin UnsignedByte Read-Only percent 100.18.25 1 VendorDate AdminString Read-Only SIZE(6) N/A 100.18.26 6 VendorSpecificLotCode AdminString Read-Only SIZE(2) N/A 100.18.27 2 DiagMonitorType EnumBits Read-Only unallocated0(0), N/A 100.18.28 1 unallocated1(1), addrChangeReq(2) recPwrMeasType(3), externCalibrated(4), internCalibrated(5), digDiagImpl(6), legacyImpl(7) EnhancedOptions EnumBits Read-Only unknown(0), N/A 100.18.29 1 rateCtrlImpl(1), appSelCtrlImpl(2), rateSelectCtrlImpl(3), rxLosMonImpl(4), txFaultMonImpl(5), txDisableMonImpl(6), allAlarmsImpl(7) Sff8472Compliance UnsignedByte Read-Only N/A 100.18.30 1 VendorSpecificData HexBinary Read-Only SIZE(32) N/A 100.18.31 32 MeasuredTxOutputPwr UnsignedShort Read-Only 0.1 µWatt 100.18.32 2 MeasuredRxInputPwr UnsignedShort Read-Only 0.1 µWatt 100.18.33 2 DigitalDiagA2Info HexBinary Read-Only SIZE(256) N/A 100.18.34 256 MeasuredTxBiasCurrent UnsignedShort Read-Only 2 µAmp 100.18.35 2 MeasuredTemperature Short Read-Only 1/256 degree 100.18.36 2 Celsius MeasuredSupplyVoltage UnsignedShort Read-Only 100 µVolt 100.18.37 2

7.1.5.6.1 EnetPortIndex This key attribute reports a unique index for the Ethernet port interface.

7.1.5.6.2 Status This attribute reports the current state of the SFP+ transceiver. The following state information can be reported: unknown: The state is unknown. notInstalled: The SFP+ transceiver is not installed.

 09/03/21 CableLabs 187 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

installed: The SFP+ transceiver has been installed. faulty: The SFP+ transceiver is faulty. operational: The SFP+ transceiver is working properly. enabled: The SFP+ transceiver has been enabled. disabled: The SFP+ transceiver has been disabled. invalidCcBase: indicates that the first 64 bytes of serial information in the SFP+ transceiver is invalid. The check is done by comparing the 64th byte with the sum of the contents of the first 63 bytes (bytes 0 to 62, inclusive). invalidCcExt: indicates that the first 32 bytes of the extended serial information in the SFP+ transceiver is invalid. The check is done by comparing the 95th byte with the sum of the contents of the first 32 bytes (bytes 64 to 94, inclusive).

7.1.5.6.3 Identifier This attribute is used to report the type of the serial transceiver. The following identifier types can be reported: unknown: unknown identifier gbic: Gigabit Interface Converter sff: Module soldered to motherboard sfpOrSfpPlus: small form factor pluggable or SFP+ sbi: 300 pin XBI xenpack: 10 gigabit Ethernet transceiver package xfp: 10 G form factor pluggable xff: obsolete xfpE: 10 G small form factor pluggable extended xPak: 10 G form factor pluggable transceiver package x2: 10 G form factor pluggable dwdmSfp: Dense Wavelength Division Multiplexing SFP qsfp: quad small form factor pluggable vendorSpecific: vendor specific identifier Reference: [SFF 8024].

7.1.5.6.4 ExtendedIdentifier This attribute reports the extended identifier of the type of serial transceiver.

7.1.5.6.5 ConnectorType

This attribute reports the code for connector type of the transceiver per Table 3.4 of [SFF 8472].

7.1.5.6.6 TransceiverComplianceCodes This attribute reports bit significant indicators which define the electronic or optical interfaces that are supported by the transceiver. Reference: [SFF 8472].

188 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.6.7 TransceiverComplianceCode36 This attribute reports the code for electronic or optical compatibility. Reference: [SFF 8472], Transceiver Compliance Codes table.

7.1.5.6.8 Encoding This attribute reports the code for high speed serial encoding algorithm. Reference: [SFF 8024].

7.1.5.6.9 BitRateNominal This attribute reports nominal signaling rate in units of 100s of Mega Baud.

7.1.5.6.10 RateIdentifier This attribute refers to several (optional) industry standard definitions of Rate Select or Application Select control behaviors, intended to manage transceiver optimization for multiple operating rates. The following rate identifier types can be reported: unspecified: unspecified rate identifier type sff8079: SFF-8079 (4/2/1G rate select and AS0/AS1) sff8431Rx: SFF-8431 (8/4/2G receive rate select only) unspecified3: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. sff8431Tx: SFF-8431 (8/4/2G transmit rate select only) unspecified5: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. sff8431indepRxTx: SFF-8431 (8/4/2G Independent receive and transmit rate select) unspecified7: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. fcpi5Rx: FC-PI-5 (16/8/4G receive rate select only) High=16G only, Low=8G/4G. unspecified9: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. fcpi5Tx: FC-PI-5 (16/8/4G Independent receive, transmit rate select) High=16G only, Low=8G/4G unspecified11: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. fcpi6: FC-PI-6 (32/16/8G Independent receive, transmit rate select). High=32G only, Low = 16G/8G. unspecified13: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. rxTx10_8g: 10/8G Rx and Tx Rate_Select controlling the operation or locking modes of the internal signal conditioner, retimer or CDR, according to the logic table defined in Table 10-2, High Bit Rate (10G) =9.95-11.3 Gb/s; Low Bit Rate (8G) = 8.5 Gb/s. In this mode, the default value of bit 110.3 (Soft Rate Select RS(0), Table 9-16 ) and of bit 118.3 (Soft Rate Select RS(1), Table 10-1) is 1.

 09/03/21 CableLabs 189 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

unspecified15: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. fcpi7: FC-PI-7 (64/32/16G Independent receive, transmit rate select) High = 32GFC and 64GFC. Low = 16GFC. unspecified17: unspecified rate identifier type. To support legacy, the LSB is reserved for Unspecified or INF-8074 (value = 0) or 4/2/1G selection per SFF-8079 (value = 1). Other rate selection functionalities are not allowed to depend on the LSB. reserved18: rate identifier type reserved by [SFF 8472] reserved19: rate identifier type reserved by [SFF 8472] reserved20: rate identifier type reserved by [SFF 8472] reserved21: rate identifier type reserved by [SFF 8472] reserved22: rate identifier type reserved by [SFF 8472] reserved23: rate identifier type reserved by [SFF 8472] reserved24: rate identifier type reserved by [SFF 8472] reserved25: rate identifier type reserved by [SFF 8472] reserved26: rate identifier type reserved by [SFF 8472] reserved27: rate identifier type reserved by [SFF 8472] reserved28: rate identifier type reserved by [SFF 8472] reserved29: rate identifier type reserved by [SFF 8472] reserved30: rate identifier type reserved by [SFF 8472] reserved31: rate identifier type reserved by [SFF 8472] pmdRateSelect: Rate select based on PMDs as defined by A0h, byte 36 and A2h, byte 67 (receive, transmit rate select). High = A0h, Byte 36 PMD, Low = A2h, Byte 67 PMD. Reference: [SFF 8079], [SFF 8431], [SFF 8472].

7.1.5.6.11 LengthKm This attribute reports the link length that is supported by the transceiver while operating in compliance with the applicable standards using single mode fiber. The value is in units of kilometers. A value of 255 means that the transceiver supports a link length greater than 254 km. A value of zero means that the transceiver does not support single mode fiber or that the length information has to be determined from the transceiver technology.

7.1.5.6.12 Length100M This attribute reports the link length that is supported by the transceiver while operating in compliance with the applicable standards using single mode fiber. The value is in units of 100s of meters. A value of 255 means that the transceiver supports a link length greater than 25.4 km. A value of zero means that the transceiver does not support single mode fiber or that the length information has to be determined from the transceiver technology.

7.1.5.6.13 Length50Mi10M This attribute reports link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM2 [500 MHz*km at 850nm] fiber. The value is in units of 10 meters. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information has to be determined from the transceiver technology.

190 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.6.14 Length62Pt5Mi10M This attribute reports link length that is supported by the transceiver while operating in compliance with applicable standards using 62.5 micron multimode OM1 [200 MHz*km at 850nm, 500 MHz*km at 1310nm] fiber. The value is in units of 10 meters. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 62.5 micron multimode fiber or that the length information needs to be determined from the transceiver technology.

7.1.5.6.15 LengthCopperM This attribute reports minimum link length supported by the transceiver while operating in compliance with applicable standards using copper cable. For active cable, this value represents actual length. The value is in units of 1 meter. A value of 255 means the transceiver supports a link length greater than 254 meters. A value of zero means the transceiver does not support copper or active cables or the length information has to be determined from transceiver technology.

7.1.5.6.16 Length50MiOm3 This attribute reports link length that is supported by the transceiver while operating in compliance with applicable standards using 50 micron multimode OM3 [2000 MHz*km] fiber. The value is in units of 10 meters. A value of 255 means that the transceiver supports a link length greater than 2.54 km. A value of zero means that the transceiver does not support 50 micron multimode fiber or that the length information has to be determined from the transceiver technology.

7.1.5.6.17 VendorName The vendor name is a 16 character string that contains ASCII characters, left-aligned and padded on the right with ASCII spaces (0x20).

7.1.5.6.18 VendorOui The vendor organizationally unique identifier (vendor OUI) is a 3-byte hexbinary string that contains the IEEE Company Identifier for the vendor. A value of all zero in the 3-byte string indicates that the Vendor OUI is unspecified.

7.1.5.6.19 VendorPartNum The vendor part number is a 16-byte ASCII string, left-aligned and padded on the right with ASCII spaces (0x20), defining the vendor part number or product name. A value of all zero in the 16-byte field indicates that the vendor part number is unspecified.

7.1.5.6.20 VendorSerialNum The vendor serial number is a 16 character ASCII string, left-aligned and padded on the right with ASCII spaces (0x20), defining the vendor's serial number for the transceiver. A value of all zero in the 16-byte field indicates that the vendor serial number is unspecified.

7.1.5.6.21 VendorRev The vendor revision number is a 4-byte ASCII string, left-aligned and padded on the right with ASCII spaces (0x20), defining the vendor's product revision number. A value of all zero in the 4-byte field indicates that the vendor revision is unspecified.

7.1.5.6.22 LaserWavelength For optical variants, as defined by TransceiverComplianceCodes attribute, this attribute denotes nominal transmitter output wavelength at room temperature. Additional details are defined in [SFF 8472].

 09/03/21 CableLabs 191 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.5.6.23 Options This attribute reports options implemented in the transceiver as described in the Options Values table of [SFF 8472]. The following rate identifier types can be reported: unallocated: unallocated options value rxlosNormal: Loss of Signal implemented, behavior as defined in [SFF 8419] (often called Rx_LOS). rxlosInverted: Loss of Signal implemented, signal inverted from standard definition in SFP MSA (often called Signal Detect). txFault: TX_FAULT signal implemented. Reference: [SFF 8419]. txDisable: TX_DISABLE is implemented and disables the high speed serial output. rateSelect: RATE_SELECT functionality is implemented. unallocated6: unallocated options value unallocated7: unallocated options value powerLevel: Power Level Declaration. Value of zero identifies Power Level 1 (or unspecified) requirements. Value of one identifies Power Level 2 requirement. See [SFF 8472] I/O Timing for Soft Control and Status Functions table and Extended Module Control/Status Bytes table for control, status, timing. See [SFF 8472] Option Values table Address A0h byte 64, Bit 5 for Power Level 3 declaration. See [SFF 8472] Option Values table Address A0h byte 64, Bit 6 for Power Level 4 declaration. Reference: [SFF 8431]. cooledTransceiver: Cooled Transceiver Declaration. Value of zero identifies a conventional uncooled (or unspecified) laser implementation. Value of one identifies a cooled laser transmitter implementation. Reference: [SFF 8431]. Reference: [SFF 8472]

7.1.5.6.24 BitRateMax This attribute reports the upper bit rate limit at which the transceiver will still meet its specifications. This attribute is specified in units of 1% above the nominal bit rate. A value of zero indicates that this field is not specified.

7.1.5.6.25 BitRateMin This attribute reports the lower bit rate limit at which the transceiver will still meet its specifications and is specified in units of 1% below the nominal bit rate. A value of zero indicates that this field is not specified.

7.1.5.6.26 VendorDate This attribute is a 6-byte field that contains the vendor’s date code in ASCII characters. The date code is specified in the following format: Bytes 0, 1 - ASCII code, two low order digits of year. (00 = 2000). Bytes 2, 3 - ASCII code, digits of month (01 = Jan through 12 = Dec) Bytes 4, 5 - ASCII code, day of month (01 - 31)

7.1.5.6.27 VendorSpecificLotCode This attribute reports a vendor specific lot code.

7.1.5.6.28 DiagMonitorType This attribute reports how diagnostic monitoring is implemented in the selected transceiver. The following diagnostic monitoring types can be reported: unallocated: unallocated diagnostic monitoring type

192 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

unallocated1: unallocated diagnostic monitoring type addrChangeReq: Address change required recPwrMeasType: Received power measurement type. 0 = OMA, 1 = average power. externCalibrated: externally calibrated internCalibrated: internally calibrated digDiagImpl: digital diagnostic monitoring implemented legacyImpl: Reserved for legacy diagnostic implementations. Must be '0' for compliance with [SFF 8472]. Reference: [SFF 8472]

7.1.5.6.29 EnhancedOptions This attribute reports the optional digital diagnostic features implemented in the transceiver. The following enhanced options types can be reported: unknown: unknown enhanced option type rateCtrlImpl: Soft Rate Select control implemented per [SFF 8431]. appSelCtrlImpl: Application Select control implemented per [SFF 8079]. rateSelectCtrlImpl: Soft RATE_SELECT control and monitoring implemented. rxLosMonImpl: Soft RX_LOS monitoring implemented. txFaultMonImpl: Soft TX_FAULT monitoring implemented. txDisableMonImpl: Soft TX_DISABLE control and monitoring implemented. allAlarmsImpl: Alarm/warning flags implemented for all monitored quantities. Reference: [SFF 8472]

7.1.5.6.30 Sff8472Compliance This attribute reports which feature set(s) are implemented in the transceiver. The details are defined in [SFF 8472].

7.1.5.6.31 VendorSpecificData This attribute reports a 32 byte long hexbinary string with content of Vendor Specific EEPROM (address 0xA0, bytes 96-127).

7.1.5.6.32 MeasuredTxOutputPwr This attribute, which is optional for SFP+ pluggable transceivers, reports measured transmit output power in units of 0.1 micro Watts. If this attribute is not supported by the RPD’s transceivers, the RPD will return a value of zero.

7.1.5.6.33 MeasuredRxInputPwr This attribute, which is optional for SFP+ pluggable transceivers, reports measured received optical power in units of 0.1 micro Watts. The reported value can represent either average received power or OMA (Optical Modulation Amplitude) depending upon how bit recPwrMeasType of DiagMonitorType is reported. When recPwrMeasType is '0' than the measured received optical power is reported as OMA, otherwise it is reported as average received power. If this attribute is not supported by the RPD’s transceivers, the RPD will return a value of zero.

7.1.5.6.34 DigitalDiagA2Info This attribute reports diagnostics data fields from Address 0xA2 of the transceiver's two wire serial bus. The data is provided undecoded.

 09/03/21 CableLabs 193 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.5.6.35 MeasuredTxBiasCurrent This attribute, which is optional for SFP+ pluggable transceivers, reports measured transmit bias current in units of 2 micro Amps. If this attribute is not supported by the RPD’s transceivers, the RPD will return a value of zero.

7.1.5.6.36 MeasuredTemperature This attribute, which is optional for SFP+ pluggable transceivers, reports internally measured transceiver temperature as a signed two's complement value in increments of 1/256 degrees Celsius. If this attribute is not supported by the RPD’s transceivers, the RPD will return a value of zero.

7.1.5.6.37 MeasuredSupplyVoltage This attribute, which is optional for SFP+ pluggable transceivers, reports internally measured transceiver supply voltage in units of 100 micro Volts. If this attribute is not supported by the RPD’s transceivers, the RPD will return a value of zero.

7.1.5.7 RpdEnetToCoreEntityMap If the RPD implements an Entity for an Ethernet port (which is optional), this object provides the mapping between the RPD's EnetPortIndex as signaled in GCP and the corresponding EntityIndex attribute of the Entity object assigned by the CCAP Core to report that entity. The CCAP Core reads RpdEnetToCoreEntityMap attributes with complex GCP TLV Type 100.10. Table 192 - RpdEnetToCoreEntityMap Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length EnetPortIndex UnsignedByte Key N/A 100.10.1 1 EntityIndex UnsignedInt Read-only N/A 100.10.2 4

7.1.5.7.1 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface.

7.1.5.7.2 EntityIndex The value of this attribute matches the value of the EntityIndex for the instance of Entity that reports the RPD Ethernet port signaled in GCP with EnetPortIndex.

7.1.5.8 CoreToRpdMap This object maps certain CCAP Core ifTable interfaces identified with an ifIndex to an RPD interface identified in GCP. An instance of this object exists for each RPD interface directly represented in the CCAP ifTable. The IfIndex corresponds to a CCAP Core ifIndex for one of the following interface types implemented on an RPD: • docsCableDownstream(128) • docsCableUpstreamChannel(205) • docsCableUpstreamRfPort(256) • docsCableDownstreamRfPort(257) • docsCableDownstreamOfdm(277) • docsCableUpstreamOfdma(278) • mpegTransport(214) • docsCableScte55d1FwdOob(283)

194 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

• docsCableScte55d1RetOob(284) • docsCableScte55d2DsOob(285) • docsCableScte55d2UsOob(286) • docsCableNdf(287) • docsCableNdr(288) Note that this object does not contain an instance for ifType ethernetCsmacd(6) because the Ethernet ports of the RPD are considered internal to a logical CCAP and are not reported in the CCAP ifTable. Table 193 - CoreToRpdMap Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type CoreIfIndex InterfaceIndex Key N/A N/A RpdUniqueId MacAddress Key N/A N/A RpdRfPortDirection IfDirection Key N/A N/A RpdRfPortIndex UnsignedByte Key 0..253 N/A N/A RpdRfChannelType RphyChannelType Read-only N/A N/A RpdRfChannelIndex UnsignedByte Read-only N/A N/A

7.1.5.8.1 CoreIfIndex This key attribute selects the CCAP Core IfIndex for the RPD Interface identified in GCP.

7.1.5.8.2 RpdUniqueId This key attribute is the MAC address selecting a particular CIN facing Ethernet port. The value of this attribute matches the value of the RpdUniqueId attribute of the RpdInfo object.

7.1.5.8.3 RpdRfPortDirection This key attribute selects the direction of an RF port, which together with RpdRfPortIndex uniquely identifies an RF port on the RPD. The RF port direction is signaled in the GCP 'RfPortType' TLV 13.2 for an RF port interface or implied by the value of the GCP 'RfChannelType' TLV 12.2 for an RF channel interface.

7.1.5.8.4 RpdRfPortIndex This key attribute selects a specific RF port on an RPD, which together with RpdRfPortDirection uniquely identifies an RF port on the RPD. The value matches the value signaled in GCP 'RfPortIndex' TLV 12.1 or the GCP 'RfPortIndex1' TLV 13.1. Values 254 and 255 are reserved for future use.

7.1.5.8.5 RpdRfChannelType For RF channel interfaces, this attribute reports the type of the channel as signaled in the GCP 'RfChannelType" TLV 12.2. For RF port interfaces, this attribute is set to other(0). Each value of this attribute corresponds to a separate sequence of channel indices.

7.1.5.8.6 RpdRfChannelIndex For interfaces corresponding to RF channels, this attribute reports the channel of the type specified in RpdRfChannelType, and matches the value signaled in the GCP 'RfChannelIndex' TLV 12.3. For RF port interfaces, this attribute reports 0.

7.1.5.9 RpdToCoreMap This object maps certain RPD interfaces identified via GCP integers to an ifIndex reported by the CCAP Core. This object conveys the same information as the CoreToRpdMap object, but with different indexing than that object.

 09/03/21 CableLabs 195 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

An instance of this object exists for each RPD interface directly represented in the CCAP ifTable. The 'CoreIfIndex' attribute corresponds to a CCAP core ifIndex for one of the following interface types implemented on an RPD: • docsCableDownstream(128) • docsCableUpstreamChannel(205) • docsCableUpstreamRfPort(256) • docsCableDownstreamRfPort(257) • docsCableDownstreamOfdm(277) • docsCableUpstreamOfdma(278) • mpegTransport(214) • docsCableScte55d1FwdOob(283) • docsCableScte55d1RetOob(284) • docsCableScte55d2DsOob(285) • docsCableScte55d2UsOob(286) • docsCableNdf(287) • docsCableNdr(288) Note that this object does not contain an instance for ifType ethernetCsmacd(6) because the Ethernet ports of the RPD are considered internal to a logical CCAP and are not reported in the CCAP ifTable. Table 194 - RpdToCoreMap Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type RpdUniqueId MacAddress Key N/A N/A RpdRfPortDirection IfDirection Key N/A N/A RpdRfPortIndex UnsignedByte Key N/A N/A RpdRfChannelType RphyChannelType Key N/A N/A RpdRfChannelIndex UnsignedByte Key N/A N/A CoreIfIndex InterfaceIndex Read-only N/A N/A

7.1.5.9.1 RpdUniqueId This key attribute specifies the MAC address associated with the lowest numbered CIN facing Ethernet port.

7.1.5.9.2 RpdRfPortDirection This key attribute reports the direction of an RF port, which together with RpdRfPortIndex uniquely identifies an RF port on the RPD. The RF port direction is signaled in the GCP 'RfPortType' TLV 13.2 for an RF port interface or implied by the value of the GCP 'RfChannelType' TLV 12.2 for an RF channel interface.

7.1.5.9.3 RpdRfPortIndex This key attribute reports the Index of an RF port on an RPD, which together with RpdRfPortDirection uniquely identifies an RF port on the RPD. The value matches the value signaled in GCP 'RfPortIndex' TLV 12.1 or the GCP 'RfPortIndex1' TLV 13.1.

196 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.9.4 RpdRfChannelType For RF channel interfaces, this key attribute reports the type of the channel as signaled in the GCP 'RfChannelType" TLV 12.2. For RF port interfaces, this attribute is set to other(0). Each value of this attribute corresponds to a separate sequence of channel indices.

7.1.5.9.5 RpdRfChannelIndex

For interfaces corresponding to RF channels, this key attribute reports the channel of the type specified in RpdRfChannelType, and matches the value signaled in the GCP 'RfChannelIndex' TLV 12.3. For RF port interfaces, this attribute reports 0.

7.1.5.9.6 CoreIfIndex This attribute reports the CCAP Core IfIndex for the RPD Interface identified in GCP.

7.1.5.10 SyncEPortStatus The SyncEPortStatus provides the status of one RPD Ethernet port being used for SyncE. The CCAP Core MUST create an instance of the SyncEPortStatus object for every IfEnet object instance that has SyncE enabled (i.e., SyncModeEnable in the RpdSyncEPortCfg object for the Ethernet port is set to true). The SyncEPortStatus TLV Type is 100.36. Table 195 - SyncEPortStatus Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length RpdEnetPortIndex UnsignedByte Key 100.36.1 1 SignalQualified Boolean Read-only 100.36.2 1 ReceivedSsm SyncEQLType Read-only 100.36.3 1

7.1.5.10.1 RpdEnetPortIndex This attribute contains the RPD's Ethernet port index.

7.1.5.10.2 SignalQualified This attribute is true if the signal on this Ethernet port is qualified for SyncE. It is false otherwise.

7.1.5.10.3 ReceivedSsm This attribute contains the SSM value received for the interface.

7.1.5.11 RfmStatus The RfmStatus object provides the status of one RPD RF module (RFM) of an optical node-based RPD. Shelf RPDs do not have RF modules. See the “Remote PHY Node Architecture” section of [R-PHY] for more information about RFM. Table 196 - RfmStatus Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type NodePortIndex UnsignedByte Key N/A 161.1.1 ReportedDsGain Short Read- TenthdB 161.1.2 only ReportedDsGainStatus RfmStatusType Read- N/A 161.1.3 only

 09/03/21 CableLabs 197 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Units TLV Constraints Type ReportedUsGain Short Read- TenthdB 161.1.4 only ReportedUsGainStatus RfmStatusType Read- N/A 161.1.5 only ReportedRfmDsTilt UnsignedShort Read- TenthdB 161.1.6 only ReportedRfmDsTiltStatus RfmStatusType Read- N/A 161.1.7 only DsOutputPower UnsignedShort Read- TenthdBmV 161.1.8 only per 6 MHz of occupied spectrum UsExpectedRxPower Short Read- TenthdBmV 161.1.9 only per 1.6 MHz of occupied spectrum TotalDsTilt UnsignedShort Read- TenthdB 161.1.10 only

7.1.5.11.1 NodePortIndex This attribute contains the RPD's RF module index (i.e., the node RF port). Numbers range from 0 to N-1, where N is the number reported by the RPD through the NumNodeRfPorts (TLV 50.60.2) attribute.

7.1.5.11.2 ReportedDsGain This attribute is used to report DS gain in the RFM. RPDs with locally configured downstream gain (i.e., physical pads) can report the gain though this attribute when the RPD has information how the pads are configured. This attribute needs to be used in conjunction with ReportedDsGainStatus (TLV 161.1.3) attribute which reports additional information about the reported value. RPDs with unknown DS RFM gain report a value of 0.

7.1.5.11.3 ReportedDsGainStatus This attribute is used to report additional qualifying information about the value reported through ReportedDsGain (TLV 161.1.2) attribute.

7.1.5.11.4 ReportedUsGain This attribute is used to report upstream gain in the RFM. RPDs with locally configured upstream gain (i.e., physical pads) can report the gain though this attribute when the RPD has information how the pads are configured. This attribute needs to be used in conjunction with ReportedUsGainStatus (TLV 161.1.5) attribute which reports additional qualifying information about the reported value. RPDs with unknown US RFM gain report a value of 0.

7.1.5.11.5 ReportedUsGainStatus This attribute is used to report addition qualifying information about the value reported through ReportedUsGain (TLV 161.1.4) attribute.ReportedRfmDsTilt This attribute is used to report DS tilt in the RFM. RPDs with locally configured downstream tilt (i.e., physical pads) report the tilt though this attribute when the RPD has information how the pads are configured. This attribute needs to be used in conjunction with ReportedRfmTiltStatus (TLV 161.1.7) attribute which reports additional qualifying information about the reported value. RPDs with unknown DS RFM tilt report a value of 0.

198 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.5.11.6 ReportedRfmDsTiltStatus This attribute is used to report addition qualifying information about the value reported through ReportedRfmDsTilt (TLV 161.1.6) attribute.

7.1.5.11.7 DsOutputPower This attribute is used to report the output power for the selected node RF port of the RFM. RPDs with unknown DS RFM output power report a value of 0.

7.1.5.11.8 UsExpectedRxPower This attribute is used to report the expected input power for the selected node RF port of the RFM. RPDs with unknown upstream receive power level report a value of 0.

7.1.5.11.9 TotalDsTilt This attribute is used to report the combined tilt value for the selected node RF port of the RFM. RPDs with unknown DS RFM tilt report a value of 0.

7.1.6 RPD IP Information Model These objects provide reporting of RPD IP information via communication from the CCAP Core. Figure 21 defines the RPD IP information model reported via the CCAP Core. A subset of MIB objects from the IP-MIB [RFC 4293] are required for reporting on the IP interfaces on the RPD. The objects in the following sub-sections are from [RFC 4293] and used here with modifications.

Figure 21 - RPD IP Information Model

7.1.6.1 RpdInfo The RpdInfo object serves as the root on the RPD IP Information Model. The RpdInfo object is defined in Section 7.1.3.2 and referenced here.

 09/03/21 CableLabs 199 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 197 - RpdInfo Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity IpNetToPhysical Directed composition to IpNetToPhysical 1 1..* IpIfStats Directed composition to IpIfStats 1 1..* IpAddress Directed composition to IpAddress 1 1..* IpInterfaceGrp Directed composition to IpInterfaceGrp 1 0..*

7.1.6.2 IpInterfaceGrp This object is a collection of attributes that describe IP forwarding versions supported and provide status details. The attributes of the IpInterfaceGrp object are read with complex GCP TLV Type 100.11. Table 198 - IpInterfaceGrp Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length Ipv4InterfaceTableLastChange TimeStamp Read-only N/A 100.11.1 4 Ipv6InterfaceTableLastChange TimeStamp Read-only N/A 100.11.2 4 IpIfStatsTableLastChange TimeStamp Read-only N/A 100.11.3 4 Ipv4DefaultTTL UnsignedByte Read-only 1..255 N/A 100.11.5 1 Ipv6DefaultHopLimit UnsignedByte Read-only 0..255 N/A 100.11.8 1

Table 199 - IpInterfaceGrp Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity Ipv4Interface Directed composition to Ipv4Interface 1 0..* Ipv6Interface Directed composition to Ipv6Interface 1 0..* IpDefaultRouter Directed composition to IpDefaultRouter 1 0..* IcmpMsgStats Directed composition to IcmpMsgStats 1 0..*

7.1.6.2.1 Ipv4InterfaceTableLastChange This attribute reports the value of RpdSysUpTime on the most recent occasion at which an instance of the Ipv4Interface object was added or deleted, or when a ReasmMaxSize or an EnableStatus attribute of the Ipv4Interface object was modified.

7.1.6.2.2 Ipv6InterfaceTableLastChange This attribute reports the value of RpdSysUpTime on the most recent occasion at which an instance of the Ipv6Interface object was added or deleted or when a ReasmMaxSize, InterfaceIdentifier, EnableStatus, ReachableTime, RetransmitTime, or Forwarding attribute of the Ipv6Interface object was modified.

7.1.6.2.3 IpIfStatsTableLastChange This attribute reports the value of RpdSysUpTime on the most recent occasion at which an instance of the ipIfStats object was added or deleted.

7.1.6.2.4 Ipv4DefaultTTL This attribute reports the default value inserted into the Time-To-Live field of the IPv4 header of datagrams originated at this entity, whenever a TTL value is not supplied by the transport layer protocol.

200 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.6.2.5 Ipv6IpDefaultHopLimit This attribute reports the default value inserted into the Hop Limit field of the IPv6 header of datagrams originated at this entity whenever a Hop Limit value is not supplied by the transport layer protocol.

7.1.6.3 IpInterface This abstract object controls overall operation of the IPv4 and IPv6 protocol on an RPD Ethernet port. It is modeled after the ipv4InterfaceTable and ipv6InterfaceTable specified in [RFC 4293]. The Ipv4Interface and Ipv6Interface concrete objects inherit the attributes from this abstract object. The CCAP Core reads the attributes of the Ipv4Interface object in the complex GCP TLV 100.12 and the attributes of an IPv6Interface object in GCP TLV 100.13. Table 200 - IpInterface Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length EnetPortIndex UnsignedByte Key N/A 100.12.1 1 100.13.1 EnableStatus Enum Read-only up(1), N/A 100.12.3 1 down(2) 100.13.3 RetransmitTime UnsignedInt Read-only milliseconds 100.12.4 4 100.13.4

7.1.6.3.1 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface.

7.1.6.3.2 EnableStatus This attribute reports whether IPv4 or IPv6 is enabled (up) or disabled (down) on this interface. '1' indicates that IPv4 or IPv6 is enabled. '2' indicates that IPv4 or IPv6 is disabled.

7.1.6.3.3 RetransmitTime This attribute reports the time between retransmissions of ARP requests to a neighbor when resolving the address or when probing the reachability of a neighbor.

7.1.6.4 Ipv4Interface This object provides details on the IPv4 interfaces on the RPD. The object inherits attributes from the IpInterface abstract object. The Ipv4Interface object does not define any IPv4-specific attributes beyond what is inherited. The CCAP Core reads the attributes of an Ipv4Interface object in complex GCP TLV Type 100.12.

7.1.6.5 Ipv6Interface This object provides details on the IPv6 interfaces on the RPD. The object inherits attributes from the IpInterface abstract object. The Ipv6Interface object defines the following IPv6-specific attributes beyond what is inherited. The CCAP Core reads all attributes of an Ipv6Interface object in complex GCP TLV Type is 100.13. Table 201 - Ipv6Interface Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length InterfaceIdentifier HexBinary Read-only SIZE(0..8) N/A 100.13.5 0..8 ReachableTime UnsignedInt Read-only milliseconds 100.13.6 4

 09/03/21 CableLabs 201 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.6.5.1 InterfaceIdentifier This attribute reports the Interface Identifier for this interface. The Interface Identifier is combined with an address prefix to form an interface address. By default, the Interface Identifier is auto-configured according to the rules of the link type to which this interface is attached. A zero length identifier may be used where appropriate.

7.1.6.5.2 ReachableTime This attribute reports the time a neighbor is considered reachable after receiving a reachability confirmation.

7.1.6.6 IpIfStats This object provides statistics for IP Packets sent or received by an RPD's own IP Address. It is modeled after the IP-MIB IpIfStatsTable described in [RFC 4293] ; however, all counters are 64 bit. Discontinuities in the value of these counters can occur at re-initialization of the management system, and at other times as indicated by the value of the DiscontinuityTime attribute in this object. The CCAP Core reads all attributes of an IpIfStats object with complex GCP TLV Type 100.14. Table 202 - IpIfStats Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length IpVersion InetVersion Key N/A 100.14.1 1 EnetPortIndex UnsignedByte Key N/A 100.14.2 1 InReceives Counter64 Read-only datagrams 100.14.3 8 InOctets Counter64 Read-only octets 100.14.4 8 InHdrErrors Counter64 Read-only datagrams 100.14.5 8 InNoRoutes Counter64 Read-only datagrams 100.14.6 8 InAddrErrors Counter64 Read-only datagrams 100.14.7 8 InUnknownProtos Counter64 Read-only datagrams 100.14.8 8 InTruncatedPkts Counter64 Read-only datagrams 100.14.9 8 InDiscards Counter64 Read-only datagrams 100.14.14 8 InDelivers Counter64 Read-only datagrams 100.14.15 8 OutRequests Counter64 Read-only datagrams 100.14.16 8 OutDiscards Counter64 Read-only datagrams 100.14.18 8 OutTransmits Counter64 Read-only datagrams 100.14.23 8 OutOctets Counter64 Read-only octets 100.14.24 8 InMcastPkts Counter64 Read-only datagrams 100.14.25 8 InMcastOctets Counter64 Read-only octets 100.14.26 8 OutMcastPkts Counter64 Read-only datagrams 100.14.27 8 OutMcastOctets Counter64 Read-only octets 100.14.28 8 DiscontinuityTime DateTime Read-only N/A 100.14.31 8 or 11 RefreshRate UnsignedInt Read-only milliseconds 100.14.32 4

7.1.6.6.1 IpVersion This key attribute reports the IP version of this object instance.

7.1.6.6.2 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface.

202 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.6.6.3 InReceives This attribute reports the total number of input IP datagrams received, including those received in error.

7.1.6.6.4 InOctets This attribute reports the total number of octets received in input IP datagrams, including those received in error.

7.1.6.6.5 InHdrErrors This attribute reports the number of input IP datagrams discarded due to errors in their IP headers, including version number mismatch, other format errors, hop count exceeded, errors discovered in processing their IP options, etc.

7.1.6.6.6 InNoRoutes This attribute reports the number of input IP datagrams discarded because no route could be found to transmit them to their destination.

7.1.6.6.7 InAddrErrors This attribute reports the number of input IP datagrams discarded because the IP address in their IP header's destination field was not a valid address to be received at this entity. This count includes invalid addresses (e.g., ::0). For entities that are not IP routers and therefore do not forward datagrams, this counter includes datagrams discarded because the destination address was not a local address.

7.1.6.6.8 InUnknownProtos This attribute reports the number of locally-addressed IP datagrams received successfully but discarded because of an unknown or unsupported protocol. When tracking interface statistics, the counter of the interface to which these datagrams were addressed is incremented. This interface might not be the same as the input interface for some of the datagrams.

7.1.6.6.9 InTruncatedPkts This attribute reports the number of input IP datagrams discarded because the datagram frame didn't carry enough data.

7.1.6.6.10 InDiscards This attribute reports the number of input IP datagrams for which no problems were encountered to prevent their continued processing, but were discarded (e.g., for lack of buffer space). The RPD discards all packets requiring reassembly and those packets are also counted here.

7.1.6.6.11 InDelivers This attribute reports the total number of datagrams successfully delivered to IPuser-protocols (including ICMP). When tracking interface statistics, the counter of the interface to which these datagrams were addressed is incremented. This interface might not be the same as the input interface for some of the datagrams.

7.1.6.6.12 OutRequests This attribute reports the total number of IP datagrams that local IP user-protocols (including ICMP) supplied to IP in requests for transmission.

7.1.6.6.13 OutDiscards This attribute reports the number of output IP datagrams for which no problem was encountered to prevent their transmission to their destination, but were discarded (e.g., for lack of buffer space). Note that this counter would include datagrams that required fragmentation.

 09/03/21 CableLabs 203 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.6.6.14 OutTransmits This attribute reports the total number of IP datagrams that this entity supplied to the lower layers for transmission.

7.1.6.6.15 OutOctets This attribute reports the total number of octets in IP datagrams delivered to the lower layers for transmission. Octets from datagrams counted in the OutTransmits object are required to be counted here.

7.1.6.6.16 InMcastPkts This attribute reports the number of IP multicast datagrams received.

7.1.6.6.17 InMcastOctets This attribute reports the total number of octets received in IP multicast datagrams. Octets from datagrams counted in the McastPkts object are required to be counted here.

7.1.6.6.18 OutMcastPkts This attribute reports the number of IP multicast datagrams transmitted.

7.1.6.6.19 OutMcastOctets This attribute reports the total number of octets transmitted in IP multicast datagrams. Octets from datagrams counted in the OutMcastPkts object are required to be counted here.

7.1.6.6.20 DiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.6.6.21 RefreshRate This attribute reports the minimum reasonable polling interval for this entry. This attribute provides an indication of the minimum amount of time required to update the counters in this entry.

7.1.6.7 IpAddress This object contains addressing information relevant to the RPD's interfaces. This object does not contain multicast address information. Note: When instantiating IPv6 link-local addresses for this object, the instance uses an InetAddressType of 'ipv6z' and GCP TLV 100.15.2 with value field length of 20 in order to differentiate between the possible interfaces. This object is based on the ipAddressTable object specified in [RFC 4293]. The CCAP Core reads all attributes of an IpAddress object with complex GCP TLV Type 100.15. Table 203 - IpAddress Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length AddrType InetAddressType Key ipv4(1), N/A N/A ipv6(2) IpAddress InetAddress Key SIZE(4 | 16) N/A 100.15.2 4 or 16 EnetPortIndex UnsignedByte Read-Only N/A 100.15.3 1 Type Enum Read-Only unicast(1), N/A 100.15.4 1 anycast(2), broadcast(3)

204 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length PrefixLen InetAddressPrefixLength Read-Only N/A 100.15.5 2 Origin Enum Read-Only other(1), N/A 100.15.6 1 manual(2), dhcp(4), linkLayer(5) random(6) Status Enum Read-Only preferred(1), N/A 100.15.7 1 deprecated(2), invalid(3), inaccessible(4), unknown(5), tentative(6), duplicate(7), optimistic(8) Created TimeStamp Read-Only N/A 100.15.8 4 LastChanged TimeStamp Read-Only N/A 100.15.9 4

Table 204 - IpAddress Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity EnetIf Directed association to EnetIf 0..* 0..1 EnetPortIndex

7.1.6.7.1 AddrType This key attribute reports the IP address type of the IpAddress attribute.

7.1.6.7.2 IpAddress This key attribute reports the IP address to which this entry's addressing information pertains. The address type is specified in the AddrType attribute.

7.1.6.7.3 EnetPortIndex This attribute reports a unique index for this Ethernet port interface.

7.1.6.7.4 Type This attribute reports the type of traffic for which the address can be used. The value '1' indicates the address type is unicast. The value '2' indicates the address type is anycast. The value '3' indication the address type is broadcast. This is not a valid value for IPv6 addresses.

7.1.6.7.5 PrefixLen This attribute reports the prefix length associated with this address.

7.1.6.7.6 Origin This attribute reports the origin of this IP address. 'manual' indicates an IP address that was manually configured. 'dhcp' indicates an IP address that was assigned by a DHCP server. 'linklayer' indicates an address created by IPv6 stateless auto-configuration.

 09/03/21 CableLabs 205 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

'random' indicates an address chosen by the system at random, e.g., an IPv4 address within 169.254/16, or an RFC 3041 privacy address. 'other' indicates an origin not covered by the options here.

7.1.6.7.7 Status This attribute reports the status of an address. Most of the states correspond to states from the IPv6 Stateless Address Autoconfiguration protocol. The value 'preferred' indicates that this is a valid address that can appear as the destination or source address of a packet. The value 'deprecated' indicates that this is a valid but deprecated address that should no longer be used as a source address in new communications, but packets addressed to such an address are processed as expected. The value 'invalid' indicates that this isn't a valid address and it shouldn't appear as the destination or source address of a packet. The value 'inaccessible' indicates that the address is not accessible because the interface to which this address is assigned is not operational. The value 'unknown' indicates that the status cannot be determined for some reason. The value 'tentative' indicates that the uniqueness of the address on the link is being verified. Addresses in this state should not be used for general communication and should only be used to determine the uniqueness of the address. The value 'duplicate' indicates the address has been determined to be non-unique on the link and so cannot be used. The value 'optimistic' indicates the address is available for use, subject to restrictions, while its uniqueness on a link is being verified. In the absence of other information, an IPv4 address is always 'preferred'.

7.1.6.7.8 Created This attribute reports the value of RpdSysUpTime at the time this entry was created. If this entry was created prior to the last re-initialization of the local network management subsystem, then this attribute contains a zero value.

7.1.6.7.9 LastChanged This attribute reports the value of RpdSysUpTime at the time this entry was last updated. If this entry was updated prior to the last re-initialization of the local network management subsystem, then this attribute contains a zero value.

7.1.6.8 IpNetToPhysical The IpNetToPhysical object used for mapping from IP addresses to physical addresses. The IpNetToPhysical object contains the IP address to 'physical' address equivalences. While many protocols may be used to populate this object, ARP and Neighbor Discovery are the most likely options. This object is based on the ipNetToPhysicalTable object specified in [RFC 4293]. The CCAP Core reads all attributes of an IpNetToPhysical object with complex GCP TLV Type 100.16.

206 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 205 - IpNetToPhysical Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Constraints Value Field Length EnetPortIndex UnsignedByte Key N/A 100.16.1 1 AddrType InetAddressType Key ipv4(1), N/A N/A ipv6(2) IpAddress InetAddress Key SIZE(4 | 16) N/A 100.16.3 4 or 16 PhysAddress PhysAddress Read-Only N/A 100.16.4 6 LastUpdated TimeStamp Read-Only N/A 100.16.5 4 Type Enum Read-Only other(1), N/A 100.16.6 1 invalid(2), dynamic(3), static(4), local(5) State Enum Read-Only reachable(1), N/A 100.16.7 1 stale(2), delay(3), probe(4), invalid(5), unknown(6) incomplete(7)

7.1.6.8.1 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface.

7.1.6.8.2 AddrType This key attribute reports the type of IP address in the IpAddress attribute.

7.1.6.8.3 IpAddress This key attribute reports the IP address corresponding to the media-dependent 'physical' address. The address type is specified in the AddrType attribute.

7.1.6.8.4 PhysAddress This attribute reports the media-dependent 'physical' address.

7.1.6.8.5 LastUpdated This attribute reports the value of RpdSysUpTime at the time this entry was last updated. If this entry was updated prior to the last re-initialization of the local network management subsystem, then this attribute contains a zero value.

7.1.6.8.6 Type This attribute reports the type of mapping. It is an implementation-specific matter as to whether the agent removes an invalidated entry from the table. Accordingly, management stations have to be prepared to receive tabular information from agents that corresponds to entries not currently in use. Proper interpretation of such entries requires examination of the relevant Type object. The value 'invalid' indicates that this is an invalidated mapping. The value 'dynamic' indicates that the IP address to physical addresses mapping has been dynamically resolved using a protocol such as IPv4 ARP or the IPv6 Neighbor Discovery protocol.

 09/03/21 CableLabs 207 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The value 'static' indicates that the mapping has been statically configured. Both of these refer to entries that provide mappings for other entities addresses. The value 'local' indicates that the mapping is provided for an entity's own interface address. The value 'other' indicates that none of these defined types applies to this mapping.

7.1.6.8.7 State This attribute reports the Neighbor Unreachability Detection state for the interface when the address mapping in this entry is used. If Neighbor Unreachability Detection is not in use (e.g., for IPv4), this object is always unknown(6). The value 'reachable' indicates confirmed reachability. The value 'stale' indicates unconfirmed reachability. The value 'delay' indicates that the protocol is waiting for reachability confirmation before entering the probe state. The value 'probe' indicates active probing. The value 'invalid' indicates an invalidated mapping. The value 'unknown' indicates the state cannot be determined for some reason. The value 'incomplete' indicates that address resolution is being performed.

7.1.6.9 IpDefaultRouter This object is used to describe the default routers known to the RPD. It is based on the ipDefaultRouterTable object specified in [RFC 4293]. The CCAP Core reads all attributes of an IpDefaultRouter object with complex GCP TLV Type 100.17. Table 206 - IpDefaultRouter Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length AddrType InetAddressType Key ipv4(1), N/A N/A ipv6(2) IpAddress InetAddress Key SIZE(4 | 16) N/A 100.17.2 4 or 16 EnetPortIndex UnsignedByte Key N/A 100.17.3 1 Lifetime UnsignedShort Read-Only seconds 100.17.4 2 Preference Enum Read-Only reserved(-2), N/A 100.17.5 1 low(-1), medium(0), high(1)

7.1.6.9.1 AddrType This key attribute reports the type of IP address in the IpAddress attribute.

7.1.6.9.2 IpAddress This key attribute reports the IP address of the default router represented by this instance. The address type is specified in the AddrType attribute.

7.1.6.9.3 EnetPortIndex This key attribute reports a unique index for this Ethernet port interface

208 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.6.9.4 Lifetime This attribute reports the remaining length of time, in seconds, that this router will continue to be useful as a default router. A value of zero indicates that it is no longer useful as a default router. It is left to the implementer of the MIB as to whether a router with a lifetime of zero is removed from the list. For IPv6, this value should be extracted from the router advertisement messages.

7.1.6.9.5 Preference This attribute reports an indication of preference given to this router as a default router as described in the Default Router Preferences document. Treating the value as a 2-bit signed integer allows for simple arithmetic comparisons. For IPv4 routers or IPv6 routers that are not using the updated router advertisement format, this attribute is set to medium (0). The value '-2' is reserved. The value '-1' indicates low preference. The value '0' indicates medium preference. The value '1' indicates high preference.

7.1.6.10 IcmpMsgStats This object provides system-wide per-version, per-message type ICMP counters. It is based on the icmpMsgStatsTable object specified in [RFC 4293]. The system should track each ICMP type value, even if that ICMP type is not supported by the system. However, a given instance need not be instantiated unless a message of that type has been processed, i.e., the instance for Type=X may be instantiated before but is required to be instantiated after the first message with Type=X is received or transmitted. After receiving or transmitting any succeeding messages with Type=X, the relevant counter is incremented. The CCAP Core reads all attributes of an IcmpMsgStats object with complex GCP TLV 100.19. Table 207 - IcmpMsgStats Object Attributes

Attribute Type Access Type Units TLV Type TLV Value Name Constraints Field Length IpVersion InetVersion Key N/A 100.19.1 1 Type UnsignedByte Key N/A 100.19.2 1 InPkts Counter64 Read-Only N/A 100.19.3 8 OutPkts Counter64 Read-Only N/A 100.19.4 8

7.1.6.10.1 IpVersion This key attribute reports the IP version of the statistics. Statistics are provided for each IP version supported.

7.1.6.10.2 Type This key attribute reports the ICMP type field of the message type being counted by this instance. Note that ICMP message types are scoped by the address type in use.

7.1.6.10.3 InPkts This attribute reports the number of input packets for this AF and type.

7.1.6.10.4 OutPkts This attribute reports the number of output packets for this AF and type.

 09/03/21 CableLabs 209 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.7 RPD PTP Status Information Model These objects provide reporting of RPD PTP information via communication from the CCAP Core. Figure 22 defines the RPD PTP Status information model reported via the CCAP Core. Classes shown collapsed are defined in the CCAP Core PTP Status Information Model.

Figure 22 - RPD PTP Status Information Model

7.1.7.1 RpdInfo The RpdInfo object serves as the root of the RPD PTP Status Information Model. It also is the root for the SyncE Clock Status Information object. The attributes in the RpdInfo object are defined in detail in Section 7.1.3.2. Table 208 - RpdInfo Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name RpdPtpStatus Directed composition to 1 1 RpdPtpStatus RpdSyncEClockStatus Directed composition to 1 0..1 RpdSyncEClockStatus

7.1.7.2 RpdPtpStatus RpdPtpStatus has associations to the PtpCurrentDataset, PtpClockStatus, and PtpPortDataset, objects, which are common between RpdPtpStatus and CcapPtpStatus. RPD PTP configuration values are only available via the RDP PTP configuration objects specified in Section 6.5.5.17. The RpdPtpStatus TLV is 100.24.

210 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 209 - RpdPtpStatus Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity PtpCurrentDataset Directed composition to PtpCurrentDataset 1 1 PtpClockstatus Directed composition to PtpClockstatus 1 1 PtpPortDataset Directed composition to PtpPortDataset 1 1..* RpdPtpPortStatus Directed composition to RpdPtpPortStatus 1 1..*

7.1.7.3 RpdPtpPortStatus RpdPtpPortStatus is an instantiation of the abstract class PtpPortStatus and inherits those common attributes. The RpdPtpPortStatus TLV is 100.24.4. Table 210 - RpdPtpPortStatus Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length RpdEnetPortIndex UnsignedByte Key 100.24.4.1 1 RpdPtpPortIndex UnsignedByte Key 100.24.4.2 1

Table 211 - RpdPtpPortStatus Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity RpdPtpPortStatus Specialization of PtpPortStatus PtpPortMasterClockStatus Directed composition to PtpPortMasterClockStatus 1 0..* Only slave ports have an association with the PtpPortMasterClockStatus object, which is the same object associated with CorePtpPortStatus.

7.1.7.3.1 RpdEnetPortIndex This key attribute is the RPD’s Ethernet port used for this PTP clock port. If not set, any RPD Ethernet port may be used for this PTP clock port.

7.1.7.3.2 RpdPtpPortIndex This key attribute is the port number of the local clock port.

7.1.7.4 RpdSyncEClockStatus The RpdSyncEClockStatus provides status of the overall SyncE clock in an RPD, if SyncE is enabled. The RpdSyncEClockStatus TLV Type is 100.37. Table 212 - RpdSyncEClockStatus Object Attributes

Attribute Name Type Access Type Units TLV TLV Value Constraints Type Field Length ClockMode Enum Read-only locked(1), 100.37.1 1 acquiring(2), holdover(3), freeRun(4) ActivePortIndex UnsignedByte Read-only 100.37.2 1 LastModeChange TimeStamp Read-only 100.37.3 4 ExcessiveHoldover Boolean Read-only 100.37.4 1

 09/03/21 CableLabs 211 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.7.4.1.1 ClockMode This attribute is the current mode of the SyncE clock.

7.1.7.4.1.2 ActivePortIndex This attribute is the active receive RPD Ethernet port index for the SyncE clock.

7.1.7.4.1.3 LastModeChange This attribute is the time when the active SyncE port last changed.

7.1.7.4.1.4 ExcessiveHoldover This attribute indicates whether the SyncE block is currently experiencing excessive holdover.

7.1.8 CCAP Core General Information Model Figure 23 defines the CCAP Core general information model.

Figure 23 - CCAP Core General Information Model

212 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.8.1 CcapCore This object is only supported by the CCAP Core and is used to report on the active sessions on the CCAP Core. The CcapCore object is defined in Section 6.5.1 and referenced here. Table 213 - CcapCore Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity CcapL2tpSessionInfo Directed composition to 1 0..* CcapL2tpSessionInfo CwToneStatus Directed composition to CwToneStatus 1 0..* CcapTrfStats Directed composition to CcapTrfStats 1 0..1 CcapLcceStats Directed composition to CcapLcceStats 1 0..* CcapCurrentControlConnections Directed composition to 1 0..* CcapCurrentControlConnections

7.1.8.2 CcapL2tpSessionInfo This object provides details for every session that terminates at the CCAP Core from the CCAP Core's point of view. There will be multiple sessions for each RPD with which the CCAP Core is associated. An instance of this object is created for every session the CCAP Core terminates. The CCAP Core MUST instantiate the CcapL2tpSessionInfo object with each DEPI, UEPI, OOB, NDF, NDR, EC, and ZBL pseudowire that it terminates. Table 214 - CcapL2tpSessionInfo Object Attributes

Attribute Name Type Access Type Constraints Units IncludeDocsisMsgs Boolean Read-only N/A

Table 215 - CcapL2tpSessionInfo Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity SessionInfo Specialization of SessionInfo CcapL2tpSessionFlow Directed composition to CcapL2tpSessionFlow 1 1..*

7.1.8.2.1 IncludeDocsisMsgs This attribute reports true if the CCAP Core includes DOCSIS MAP messages and other MAC Management messages in the interface entry associated with this control entry. The CCAP Core determines whether the interface includes DOCSIS messages as part of the payload.

7.1.8.3 SessionInfo This object is based on the docsIfMCmtsDepiSessionInfo object defined in the DOCS-IF-M-CMTS-MIB and the PW3 MIB definition in [RFC 5601]. They have been extended for Remote PHY. The attributes in this abstract class are used to create an instance for each L2TPv3 tunnel (session) terminated at an R-PHY entity (either RPD or CCAP Core). The sessions terminated in the RPD are provided in the RpdL2tpSessionInfo object; the sessions terminated in the CCAP Core are provided in the CcapL2tpSessionInfo object. The SessionInfo TLV, applicable to the RpdL2tpSessionInfo object, is 100.2. The TLV Types are not applicable to the CcapL2tpSessionInfo object.

 09/03/21 CableLabs 213 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 216 - SessionInfo Object Attributes

Attribute Name Type Access Type Constraints Units TLV TLV Value Type Field Length SessionIpAddrType InetAddressType Key ipv4(1), ipv6(2) N/A N/A N/A CcapLcceIpAddress InetAddress Key SIZE(4 | 16) N/A 100.2.2 4 or 16 RpdLcceIpAddr InetAddress Key SIZE(4 | 16) N/A 100.2.3 4 or 16 Direction Enum Key forward(0), N/A 100.2.4 1 return(1) L2tpSessionId UnsignedInt Key N/A 100.2.5 4 CoreId HexBinary Read-only SIZE(6) N/A 100.2.6 6 ConnCtrlId UnsignedInt Read-only N/A 100.2.7 4 UdpPort InetPortNumber Read-only N/A 100.2.8 2 Description AdminString Read-only N/A 100.2.9 0..255 SessionType Enum Read-only psp(1), N/A 100.2.10 1 mpt(2) SessionSubType Enum Read-only mptLegacy(1), 100.2.11 1 pspLegacy(2), mcm(3), pspDepiMultichannel(4), pspUepiScQam(5), pspUepiOfdma(6), pspBwReqScQam(7), pspBwReqOfdma(8), pspProbe(9), pspRngReqScQam(10), pspRngReqOfdma(11), pspMapScQam(12), pspMapOfdma(13), pspSpecman(14), pspPnm(15), psp551Fwd(16), psp551Ret(17), psp552Fwd(18), psp552Ret(19), pspNdf(20), pspNdr(21) pspEc(22) pspZbl(23) MaxPayload UnsignedInt Read-only 100.2.12 4 PathPayload UnsignedInt Read-only 100.2.13 4 RpdIfMtu UnsignedInt Read-only N/A 100.2.14 4 CoreIfMtu UnsignedInt Read-only N/A 100.2.15 4 ErrorCode Enum Read-only none(1), 100.2.16 1 invalidMACInterfaceValue(2), invalidInterfaceValue(3), noResourcesForInterfaceIndex(4), l2tpv3Error(5), ifAdminStatusSetToDown(6) CreationTime TimeStamp Read-only N/A 100.2.17 4 OperStatus OperStatusType Read-only N/A 100.2.18 1 LocalStatus EnumBits Read-only other(0), N/A 100.2.19 1 pwNotForwarding(1), servicePwRxFault(2), servicePwTxFault(3), psnPwRxFault(4), psnPwTxFault(5) LastChange TimeStamp Read-only N/A 100.2.20 4 ExtendedRemoteEndId OctetString Read-only N/A 100.2.22 0..1023

214 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV TLV Value Type Field Length NOTE: TLV Type 100.2.21 is reserved for RpdSessionStats attributes. Refer to Table 130 - RpdSessionStats Object Attributes.

7.1.8.3.1 SessionIpAddrType This key attribute indicates whether the IP address provided in the CcapLcceIpAddress and RemoteLcceIpAddr attributes are IPv4 or IPv6.

7.1.8.3.2 CcapLcceIpAddress This key attribute provides the LCCE IP address on the CCAP Core of the session detailed in the instance. As reported by the RPD for a static multicast session, this attribute is zero for an any source multicast and the source IP for Source Specific Multicast (SSM).

7.1.8.3.3 RpdLcceIpAddr This key attribute reports the RPD LCCE IP address of the session detailed in the instance.

7.1.8.3.4 Direction This key attribute reports the direction of the session detailed in the instance. Valid values include: ‘forward’ – Forward (downstream) direction toward the RPD. ‘return’ – Return (upstream) direction toward the CCAP Core.

7.1.8.3.5 L2tpSessionId This key attribute reports the value of the L2TPv3 session ID transmitted or received on the session.

7.1.8.3.6 CoreId This attribute reports the unique identifier, for example a MAC address, of the CCAP Core with which this session terminates. The CCAP Core sends its unique identifier to the RPD periodically via the DOCSIS SYNC MAC Message in the Source Address field.

7.1.8.3.7 ConnCtrlId This attribute reports the control connection identifier (CCID) for this session. This attribute is zero for static sessions, since static sessions are not part of an L2TPv3 tunnel. Zero is not a legal CCID for established tunnels, so a non-zero value means this is a dynamic session.

7.1.8.3.8 UdpPort This attribute reports the UDP Port reported by the RPD when the DEPI session uses L2TPv3 Header Over UDP. This attribute reports a value of 0 when the session is running with the L2TPv3 Session IP Header. This port number is negotiated between the CCAP Core and the RPD according to [RFC 3931].

7.1.8.3.9 Description This attribute provides an ASCII string constructed with the form: RemoteEndId=(pp:mmm:ccc),... { repeated for multiple channels } where pp is the zero-based port number signaled in the RemoteEndId AVP mmm is the channel-type Enum value from the RemoteEndId AVP ccc is the channel number from the RemoteEndId AVP

 09/03/21 CableLabs 215 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

In cases when the complete length of the Description attribute of SessionInfo object exceeds 255 characters, the RPD MUST truncate the length to 255.

7.1.8.3.10 SessionType This attribute reports whether the session is an MPT session or PSP session.

7.1.8.3.11 SessionSubType This attribute reports the type of DEPI MPT or DEPI PSP session.

7.1.8.3.12 MaxPayload This attribute reports the maximum MTU negotiated between the CCAP Core and the RPD during the session establishment process. The MTU is the layer 3 payload of a layer 2 frame.

7.1.8.3.13 PathPayload This attribute reports the maximum MTU traversing the CIN from CCAP Core to the RPD. This is calculated by the CCAP Core by procedures such as MTU discovery as described in the [R-PHY] specification.

7.1.8.3.14 RpdIfMtu This attribute reports the RPD's CIN interface MTU and is read as the value of the following L2TPV3 AVP transmitted by the RPD during session setup: Table 217 - RpdIfMtu Values

DEPI Downstream PW UEPI Upstream PW DEPI Remote MTU AVP (ICRP) UEPI Remote MTU AVP (ICRP)

7.1.8.3.15 CoreIfMtu This attribute reports the CCAP Core's CIN interface MTU and is read as the value of the following L2TPv3 AVP as received by the device during session setup: Table 218 - CoreIfMtu Values

DEPI Downstream PW UEPI Upstream PW DEPI Local MTU AVP (ICRQ) UEPI Local MTU AVP (ICRQ)

7.1.8.3.16 ErrorCode This attribute reports the error Code raised when the session is in error state. 'invalidMACInterfaceValue' indicates wrong assignment of the CCAP Core MAC interface ifIndex. 'invalidInterfaceValue' indicates wrong assignment of the CCAP Core Downstream interface ifIndex. 'noResourcesForInterfaceIfIndex' indicates the CCAP Core has no more resources to assign a session to this entry. 'l2tpv3Error' indicates an L2TPv3 StopCCN or CDN message was issued.

7.1.8.3.17 CreationTime This attribute represents the local sysUptime when the entry was turned active.

7.1.8.3.18 OperStatus This attribute reports the current status of the pseudowire from the point of view of the specific reporting entity (either CCAP Core or RPD). Values are as follows:

216 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

'other' indicates a vendor-specific operational status. 'up' indicates that the pseudowire is ready to pass packets. 'down' indicates that pseudowire signaling is not yet finished, or indications available at the service level indicate that the pseudowire is not passing packets. 'testing' indicates that AdminStatus at the pseudowire level is set to test. 'dormant' indicates that the pseudowire is not in a condition to pass packets but is in a 'pending' state, waiting for some external event. 'notPresent' indicates that some component is missing to accomplish the setup of the pseudowire. It can be a configuration error, incomplete configuration, or a missing H/W component. 'lowerLayerDown' indicates one or more of the lower-layer interfaces responsible for running the underlying PSN is not in OperStatus 'up' state. For static pseudowires, the only values that the RPD can report are ‘up’ and ‘down’. These values are conveyed to the Core via the RpdCircuitStatus TLV (TLV 59.1.3).

7.1.8.3.19 LocalStatus This attribute reports the status of the pseudowire in the local node. If the 'other' bit is set, it indicates that an additional vendor-specific status is reported. If none of the bits are set, it indicates no faults are reported.

7.1.8.3.20 LastChange This attribute reports the value of sysUpTime when the session entered its current OperStatus state from the point of view of the specific reporting entity (either CCAP Core or RPD).

7.1.8.3.21 ExtendedRemoteEndId This attribute provides an ASCII string constructed with the form: RemoteEndId=(pp:mmm:ccc),... { repeated for multiple channels } where pp is the zero-based port number signaled in the RemoteEndId AVP mmm is the channel-type Enum value from the RemoteEndId AVP ccc is the channel number from the RemoteEndId AVP This attribute conveys largely the same information as the Description attribute. Its longer length, however, permits communication of the complete RemoteEndId description, even when the length of the string exceeds 255 octets.

7.1.8.4 CcapL2tpSessionFlow This object represents a PSP Flow of L2TP session, or for those sessions which do not have PSP Flows, represents entire session. In the latter case the PSP Flow Id by convention is zero. Table 219 - CcapL2tpSessionFlow Object Attributes

Attribute Name Type Access Type Constraints Units PspFlowId UnsignedByte Key 0..7 N/A PhbId UnsignedByte Read-only

Table 220 - CcapL2tpSessionFlow Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CinDsLatency Directed composition to CinDsLatency 1 0..1 SessionCinDsLatencyStats Directed composition to SessionCinDsLatencyStats 1 0..1

 09/03/21 CableLabs 217 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CcapSessionStats Directed composition to CcapSessionStats 1 1

7.1.8.4.1 PspFlowId This key attribute identifies a PSP Flow within the session. For MPT sessions and for PSP sessions which do not support multiple PSP Flows, this attribute is zero.

7.1.8.4.2 PhbId This attribute reports the Per Hop Behavior Identifier that equals the 6-bit DSCP with which the CCAP Core transmits downstream L2TPv3 data packets for the flow or which is signaled to the RPD for insertion in upstream L2TPv3 data packets transmitted by the RPD.

7.1.8.5 CcapSessionStats This object reports performance statistics for the referenced session. The CcapSessionStats object is based on the docsIfMCmtsDepiSessionStats object defined in the DOCS-IF-M-CMTS-MIB and has been extended for Remote PHY. The CCAP Core MUST instantiate the CcapSessionStats object with each DEPI, UEPI, OOB, NDF, and NDR pseudowire that is established on each RPD with which it is connected. Table 221 - CcapSessionStats Object Attributes

Attribute Name Type Access Type Constraints Units OutOfSequencePackets Counter32 Read-only Packets InPackets Counter64 Read-only Packets InDiscards Counter64 Read-only Packets OutPackets Counter64 Read-only Packets OutErrors Counter64 Read-only Packets

7.1.8.5.1 OutOfSequencePackets This attribute reports the count of session packets that were received out of sequence from the point of view of the reporting entity. It is vendor-dependent the resequencing of packets. Implementations that do not re-sequence packets also increase the value of ifInDiscards for the respective entry.

7.1.8.5.2 InPackets This attribute counts the number of received packets accepted for processing above the L2TPv3 protocol layer. The InPackets attribute count excludes packets dropped by the L2TPv3 protocol layer itself (e.g., OutOfSequence packets and InDiscards).

7.1.8.5.3 InDiscards This attribute counts the number of received packets discarded by the L2TPv3 protocol layer itself, including those discarded because they were out of sequence. The InDiscards attribute count includes packets unable to be forwarded to a higher layer for processing (e.g., unknown L2TPv3 session Id). Interpretation of what discards are counted in this attribute is vendor-specific.

7.1.8.5.4 OutPackets This attribute counts the number of packets conceptually attempted to be transmitted from above the L2TPv3 protocol layer. The OutPackets attribute counts packets discarded by the L2TPv3 protocol layer itself (i.e., as counted by OutErrors).

218 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.8.5.5 OutErrors This attribute counts the number of packets attempted to be transmitted from above the L2TPv3 protocol layer that could not be transmitted below the L2TPv3 protocol layer itself. Interpretation of what errors are counted in this attribute is vendor-specific.

7.1.8.6 CinDsLatency This object provides a measurement on the latency on the CIN link for that session as measured by the CCAP Core. These measurements are based on the DEPI latency measurement, specified in [R-DEPI]. Table 222 - CinDsLatency Object Attributes

Attribute Name Type Access Type Constraints Units LastValue UnsignedInt Read-only Master clock ticks LastValueTime TimeStamp Read-only Interval UnsignedInt Read-only seconds

7.1.8.6.1 LastValue This attribute reports the latest latency measurement on this session.

7.1.8.6.2 LastValueTime This attribute reports the sysUpTime value of the last time the LastValue attribute was updated.

7.1.8.6.3 Interval This attribute reports the time interval used to measure periodically the CIN latency per DEPI session. Active measurement of CIN latency applies to active DEPI sessions only. This attribute is constrained to 420 seconds to prevent Master Clock counter overruns. A value zero indicates no CIN latency measurements are configured to be performed.

7.1.8.7 SessionCinDsLatencyStats This object provides the sequence of recent measurements of the CIN latency on the network as measured by the CCAP Core. When the object is full, the oldest measurement is replaced with a new one. The SessionCinDsLatencyStats object is based on the docsIfMCmtsDepiSessionCinLatencyPerfTable object defined in the DOCS-IF-M-CMTS-MIB and has been extended for Remote PHY. The CCAP Core MUST report at least 10 values of the most recent intervals for Session CinDsLatencyStats. Table 223 - SessionCinDsLatencyStats Object Attributes

Attribute Name Type Access Type Constraints Units IntervalSeq UnsignedInt Key Value UnsignedInt Read-only MeasTime TimeStamp Read-only

7.1.8.7.1 IntervalSeq This key attribute reports the interval sequence where the CIN latency measurement was taken. It is valid in an implementation that overrides the oldest sequence number entry with the most recent measurement.

7.1.8.7.2 Value This attribute reports the CIN latency value measured for the session referenced by this instance.

 09/03/21 CableLabs 219 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.8.7.3 MeasTime This attribute reports the sysUpTime value the last time this latency measurement was updated.

7.1.8.8 CwToneStatus This object has one instance for each CW tone configured on a downstream RF port on an RPD. The status of the tone depends on whether the tone has been successfully configured on that parent RPD and the state of the RPD. For an Out-Of-Service RPD, the RPD MUST report the status of all CW tones as 'down'. Table 224 - CwToneStatus Object Attributes

Attribute Type Access Type Constraints Units Default Name RpdUniqueId MacAddress Key N/A RfPort UnsignedByte Key N/A Frequency UnsignedInt Key N/A Status Enum Read-only up(1), N/A down down(2), configFailure(3)

7.1.8.8.1 RpdUniqueId This attribute specifies a globally unique 6-byte identifier for the RPD.

7.1.8.8.2 RfPort This attribute identifies the RF port for the CW tone.

7.1.8.8.3 Frequency This attribute identifies the CW tone on an RF port on the RPD, as found either in the CwTonesCfg object, if present for this RPD, or in DefaultCwTonesCfg Object.

7.1.8.8.4 Status This attribute provides the status of the tone on the parent RPD. If the RPD is not connected, or it is connected, but tone configuration has not been done yet, the tone status is 'down'. If configuration of the tone was unsuccessful, either because one or more of the GCP configuration TLVs for the tone resulted in an error response or no response, or because more tones were configured than are supported by the parent RPD, and this is one of the extra tones, the tone status is 'configFailure'. If the tone configuration was successful, the tone status is 'up'.

7.1.8.9 CcapTrfStats This object is supported by a Core that implements TRF and is used to report on the TRF activity by the Core. Table 225 - CcapTrfStats Object Attributes

Attribute Name Type Access Type Constraints Units TunnelReplacements Counter32 Read- N/A only TunnelReplacementFailures Counter32 Read- N/A only TunnelHandovers Counter32 Read- N/A only

220 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.8.9.1 TunnelReplacements This attribute counts the number of tunnels successfully replaced by the CCAP Core as a result of the transmission of an SCCRQ containing a DEPI Replaced Tunnel ID AVP identifying the tunnel to be replaced.

7.1.8.9.2 TunnelReplacementFailures This attribute counts the number of tunnel replacement attempts, following the transmission of an SCCRQ containing a DEPI Replaced Tunnel ID AVP by the CCAP Core, that failed.

7.1.8.9.3 TunnelHandovers This attribute counts the number of tunnels transitioned from Standby to InService HA state as a result of the transmission of a DTU message by the CCAP Core.

7.1.8.10 CcapLcceStats This object is supported by the CCAP Core and is used to report on the DEPI L2TPv3 control connection activity between the Core and all the RPDs with which the Core has control connections. The table has an entry for each pair of RPD and CCAP Core LCCEs used for DEPI L2TPv3 control connections. Table 226 - CcapLcceStats Object Attributes

Attribute Name Type Access Type Constraints Units LcceIpAddrType InetAddressType Key ipv4(1), ipv6(2) N/A CcapLcceIpAddress InetAddress Key SIZE(4 | 16) N/A RpdLcceIpAddr InetAddress Key SIZE(4 | 16) N/A CoreId HexBinary Read- SIZE(6) N/A only ControlConnectionsEstablished Counter32 Read- N/A only ControlConnectionEstablishmentFailures Counter32 Read- N/A only ControlConnectionFailures Counter32 Read- N/A only CurrentControlConnections UnsignedShort Read- N/A only

7.1.8.10.1 LcceIpAddrType This key attribute indicates whether the IP address provided in the CcapLcceIpAddress and RpdLcceIpAddr attributes are IPv4 or IPv6.

7.1.8.10.2 CcapLcceIpAddress This key attribute provides the LCCE IP address on the CCAP Core detailed in the instance.

7.1.8.10.3 RpdLcceIpAddr This key attribute reports the RPD LCCE IP address detailed in the instance.

7.1.8.10.4 CoreId This attribute reports the unique identifier of the CCAP Core.

 09/03/21 CableLabs 221 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.8.10.5 ControlConnectionsEstablished This attribute counts the number of DEPI control connections successfully established between the RPD and CCAP Core LCCEs.

7.1.8.10.6 ControlConnectionEstablishmentFailures This attribute counts the number of DEPI control connections that failed during establishment between the RPD and CCAP Core LCCEs.

7.1.8.10.7 ControlConnectionFailures This attribute counts the number of DEPI control connections between the RPD and CCAP Core LCCEs in which a failure was detected (after successful connection establishment) that led to the connection being closed.

7.1.8.10.8 CurrentControlConnections This attribute counts the number of DEPI control connections that are currently operational between the RPD and CCAP Core LCCEs (i.e., connections that are in an InService or Standby state). Connections that have been removed are not included in the count.

7.1.8.11 CcapCurrentControlConnections This object is supported by the CCAP Core and is used to report on the currently operational DEPI L2TPv3 control connections on the CCAP Core. Table 227 - CcapCurrentControlConnections Object Attributes

Attribute Name Type Access Type Constraints Units LcceIpAddrType InetAddressType Key ipv4(1), ipv6(2) N/A CcapLcceIpAddress InetAddress Key SIZE(4 | 16) N/A RpdLcceIpAddr InetAddress Key SIZE(4 | 16) N/A CoreConnCtrlId UnsignedInt Key N/A RpdConnCtrlId UnsignedInt Read-only N/A CoreId HexBinary Read-only SIZE(6) N/A UdpPort InetPortNumber Read-only N/A HaState Enum Read-only other(0), N/A inService(1), standby(2) SessionEstablishmentFailures Counter32 Read-only N/A SessionsFailed Counter32 Read-only N/A CurrentSessions UnsignedShort Read-only N/A

7.1.8.11.1 LcceIpAddrType This key attribute indicates whether the IP address provided in the CcapLcceIpAddress and RpdLcceIpAddr attributes are IPv4 or IPv6.

7.1.8.11.2 CcapLcceIpAddress This key attribute provides the LCCE IP address on the CCAP Core of the control connection detailed in the instance.

7.1.8.11.3 RpdLcceIpAddr This key attribute reports the RPD LCCE IP address of the control connection detailed in the instance.

222 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.8.11.4 CoreConnCtrlId This key attribute reports the Core control connection identifier (CCID) for this control connection.

7.1.8.11.5 RpdConnCtrlId This attribute reports the RPD control connection identifier (CCID) for this control connection.

7.1.8.11.6 CoreId This attribute reports the unique identifier of the CCAP Core with which this control connection terminates.

7.1.8.11.7 UdpPort This attribute reports the UDP Port reported by the RPD when the DEPI control connection uses L2TPv3 Header Over UDP. This attribute reports a value of 0 when the control connection is running with the L2TPv3 Session IP Header.

7.1.8.11.8 HaState This attribute indicates the current HaState of the tunnel for which this DEPI control connection provides the signaling, as described in the TRF section of [R-DEPI]. If TRF is not supported by either the Core or the RPD then HaState is reported as InService.

7.1.8.11.9 SessionEstablishmentFailures This attribute counts the number of DEPI sessions that failed during establishment using this control connection.

7.1.8.11.10 SessionsFailed This attribute counts the number of DEPI sessions in which a failure was detected (after successful tunnel establishment) that led to the session being closed using this control connection.

7.1.8.11.11 CurrentSessions This attribute counts the number of current DEPI sessions using this control connection (i.e., sessions that are in an InService or Standby state). Sessions that have been removed are not included in the count.

7.1.9 CCAP Core PTP Status Information Model Figure 24 defines the CCAP Core PTP Status Information Model.

 09/03/21 CableLabs 223 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Figure 24 - CCAP Core PTP Status Information Model

7.1.9.1 CcapCore The CCAP Core has the following associations to report on the CCAP Core PTP status. The CcapCore object is defined in Section 6.5.1 and referenced here. Table 228 - CcapCore Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CcapPtpStatus Directed composition to CcapPtpStatus 1 1

7.1.9.2 CcapPtpStatus The use of the term PTP port is an unfortunate overlap with how it’s commonly used (e.g., NSI port, UDP/TCP port). A PTP port is a logical entity that is associated with a device clock (a real-time clock within the PTP node) and a PTP time domain. A PTP port represents a clock interface configuration that provides a common PTP signaling operation for one or more PTP sessions. The PTP node executes a unique state machine for each of its PTP

224 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

ports and maintains data sets that define the attributes of each of its clocks and PTP ports. More than one PTP port can connect to the network via a single physical interface. A PTP node has multiple data sets providing different kinds of status, as follows: • The Default Data Set contains attributes of the local clock. • The Current Data Set contains calculated attributes used for synchronizing the local Slave clock to an external Master clock. • The Parent Data Set contains attributes describing the parent clock (external Master or local oscillator) to which the local Slave clock (RTC) is synchronized. If the local clock is synchronized to external clock, this data set also includes attributes on the grandmaster (the clock at the root of the Master−Slave hierarchy). The information is obtained from the Announce messages received from the Master clock (or from the defaultDS when in free run mode). • The Time Properties Data Set contains attributes of the grand master clock timescale. This information is obtained from the Announce messages received from the external Master clock. • The Port Data Set (one data set per PTP port associated with the Ordinary or Boundary clock) contains attributes that drive the PTP protocol decisions for the PTP port. In addition to the data sets, there are two types of statistics objects, one for the local clock statistics (PtpClockStatus) and one per PTP port for the port statistics. Note that configurable attributes are not found in the PTP status objects, but are only in the configuration objects. Table 229 - CcapPtpStatus Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity PtpDefaultDataset Directed composition to PtpDefaultDataset 1 1 PtpCurrentDataset Directed composition to PtpCurrentDataset 1 1 PtpParentDataset Directed composition to PtpParentDataset 1 1 PtpTimeProperties Directed composition to PtpTimeProperties 1 1 PtpPortDataset Directed composition to PtpPortDataset 1 1..* PtpClockStatus Directed composition to PtpClockStatus 1 1 CorePtpPortStatus Directed composition to CorePtpPortStatus 1 1..*

7.1.9.3 PtpDefaultDataset See section 8.2.1 in [IEEE 1588] for details of the 1588 default dataset. Table 230 - PtpDefaultDataset Object Attributes

Attribute Name Type Access Type Constraints Units TwoStepFlag Boolean Read-only ClockIdentity HexBinary Read-only SIZE(8) Priority1 UnsignedByte Read-only Priority2 UnsignedByte Read-only SlaveOnly Boolean Read-only QualityClass UnsignedByte Read-only Table 5 in [IEEE 1588] QualityAccuracy UnsignedByte Read-only Table 6 in [IEEE 1588] QualityOffset UnsignedShort Read-only

7.1.9.3.1 TwoStepFlag This attribute specifies whether the Two Step process is used (i.e., the clock is a two-step clock).

 09/03/21 CableLabs 225 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.9.3.2 ClockIdentity This attribute specifies the default Dataset clock identity.

7.1.9.3.3 Priority1 This attribute specifies the default Dataset clock Priority1. Lower values take precedence.

7.1.9.3.4 Priority2 This attribute specifies the default Dataset clock Priority2. Lower values take precedence.

7.1.9.3.5 SlaveOnly This attribute specifies whether the SlaveOnly flag is set.

7.1.9.3.6 QualityClass This attribute of an ordinary or boundary clock denotes the traceability of the time or frequency distributed by the grandmaster clock. See section 7.6.2.4 in [IEEE 1588].

7.1.9.3.7 QualityAccuracy This attribute characterizes a clock for the purpose of the best master clock (BMC) algorithm. See section 7.6.2.5 in [IEEE 1588].

7.1.9.3.8 QualifyOffset This attribute is the offset, scaled, logarithmic representation of the clock variance. See Section 7.6.3.5 in [IEEE 1588].

7.1.9.4 PtpCurrentDataset See section 8.2.2 in [IEEE 1588] for details of the 1588 Current dataset. The PtpCurrentDataset TLV is 100.24.1. Table 231 - PtpCurrentDataset Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length StepsRemoved UnsignedInt Read-only steps 100.24.1.1 4 OffsetFromMaster Long Read-only Nanoseconds 100.24.1.2 8 MeanPathDelay UnsignedInt Read-only Nanoseconds 100.24.1.3 4

7.1.9.4.1 StepsRemoved This attribute is the number of communication paths traversed between the local clock and the grandmaster clock. The initialization value is 0.

7.1.9.4.2 OffsetFromMaster This attribute is an implementation-specific representation of the current value of the time difference between a master and a slave as computed by the slave; i.e., = ─ .

7.1.9.4.3 MeanPathDelay This attribute is an implementation-specific representation of the current value of the mean propagation time between a master and slave clock as computed by the slave. Zero means that the path delay is unavailable.

226 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.9.5 PtpParentDataset See section 8.2.3 in [IEEE 1588] for details of the 1588 parent dataset. Table 232 - PtpParentDataset Object Attributes

Attribute Name Type Access Type Constraints Units ParentClockId HexBinary Read-only SIZE(8) ParentPortNumber UnsignedShort Read-only ParentStats Boolean Read-only ClockOffset Int Read-only Nanoseconds PhaseChangeRate Int Read-only Nanoseconds GmClockIdentity HexBinary Read-only SIZE(8) GmPriority1 UnsignedByte Read-only GmPriority2 UnsignedByte Read-only GmQualityClass UnsignedByte Read-only Table 5 in [IEEE 1588] GmQualityAccuracy UnsignedByte Read-only Table 6 in [IEEE 1588] GmQualityOffset UnsignedShort Read-only

7.1.9.5.1 ParentClockId This attribute is the clock identifier of the clock port on the master that issues the Sync messages used in synchronizing this clock.

7.1.9.5.2 ParentPortNumber This attribute is the port number of the clock port on the master that issues the Sync messages used in synchronizing this clock.

7.1.9.5.3 ParentStats This attribute is set to True if the clock has a port in the slave state and the clock has computed statistically valid estimates of the ClockOffset Scaled Log Variance and the Clock PhaseChangeRate. If either the ClockOffset Scaled Log Variance or the Clock PhaseChangeRate attribute of the PtpParentDataset object is not computed, then the CCAP Core MUST set the value of ParentStats to false.

7.1.9.5.4 ClockOffset This attribute represents the value of the observed Parent Offset Scaled Log Variance, which is an estimate of the parent clock’s PTP variance as observed by the slave clock. The computation of this value is optional, but if not computed, the value of parentStats is FALSE. The initialization value of ClockOffset is 0xFFFF.

7.1.9.5.5 PhaseChangeRate This attribute represents the value of Phase Change Rate, which is an estimate of the parent clock’s phase change rate as observed by the slave clock. If the estimate exceeds the capacity of its data type, this value is set to 0x7FFF FFFF. A positive sign indicates that the parent clock’s phase change rate is greater than the rate of the slave clock. The computation of this value is optional, but if not computed, the value of parentStats is FALSE.

7.1.9.5.6 GmClockIdentity This attribute represents the clock Identity of the grandmaster clock.

7.1.9.5.7 GmPriority1 This attribute represents the priority1 of the grandmaster clock. Lower values take precedence.

 09/03/21 CableLabs 227 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.9.5.8 GmPriority2 This attribute represents the priority2 of the grandmaster clock. Lower values take precedence.

7.1.9.5.9 GmQualityClass This attribute is the clock class for the grandmaster clock. The clock class attribute of an ordinary or boundary clock denotes the traceability of the time or frequency distributed by the grandmaster clock. See section 7.6.2.4 in [IEEE 1588].

7.1.9.5.10 GmQualityAccuracy This attribute characterizes the grandmaster clock for the purpose of the best master clock (BMC) algorithm. See section 7.6.2.5 in [IEEE 1588].

7.1.9.5.11 GmQualityOffset This attribute represents the offset, scaled, logarithmic representation of the grandmaster clock variance. See Section 7.6.3.5 in [IEEE 1588].

7.1.9.6 PtpTimeProperties See section 8.2.4 in [IEEE 1588] for details of the 1588 time properties dataset. Table 233 - PtpTimeProperties Object Attributes

Attribute Name Type Access Type Constraints Units CurrentUtcOffsetValid Boolean Read-only CurrentUtcOffset Int Read-only Seconds Leap59 Boolean Read-only Leap61 Boolean Read-only TimeTraceable Boolean Read-only FreqTraceable Boolean Read-only PtpTimescale Boolean Read-only TRUE TimeSource UnsignedByte Read-only Table 7 in [IEEE 1588]

7.1.9.6.1 CurrentUtcOffsetValid This attribute represents the value of currentUtcOffsetValid is TRUE if the currentUtcOffset is known to be correct.

7.1.9.6.2 CurrentUtcOffset This attribute represents the offset between International Atomic Time (TAI) and Universal Coordinated Time (UTC).

7.1.9.6.3 Leap59 This attribute represents whether or not there are 59 seconds in the last minute of the current UTC day for PTP systems whose epoch is the PTP epoch; a TRUE value for Leap59 indicates that the last minute of the current UTC day contains 59 seconds.

7.1.9.6.4 Leap61 This attribute represents whether or not there are 61 seconds in the last minute of the current UTC day for PTP systems whose epoch is the PTP epoch; a TRUE value for Leap61 indicates that the last minute of the current UTC day contains 61 seconds.

228 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.9.6.5 TimeTraceable This attribute represents whether the timescale and the value of currentUtcOffset are traceable to a primary reference. TimeTraceable is TRUE if the timescale and the value of currentUtcOffset are traceable to a primary reference; otherwise, the value is FALSE.

7.1.9.6.6 FreqTraceable This attribute represents whether the frequency determining the timescale is traceable to a primary reference. The value of FrequencyTraceable is TRUE if the frequency determining the timescale is traceable to a primary reference; otherwise, the value is FALSE.

7.1.9.6.7 PtpTimescale This attribute is always true for grandmaster clocks with a clock timescale of PTP.

7.1.9.6.8 TimeSource This attribute represents the source of time used by the grandmaster clock. See Table 7 in [IEEE 1588]. If the time source of the grandmaster clock is unknown at the time of initialization, the CCAP Core MUST set the TimeSource value of PtpTimeProperties to INTERNAL_OSCILLATOR (0xA0).

7.1.9.7 PtpPortDataset See section 8.2.5 in [IEEE 1588] for details of the 1588 port dataset. The PtpPortDataset TLV is 100.24.3. Table 234 - PtpPortDataset Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length PortNumber UnsignedShort Key 100.24.3.1 2 PortState Enum Read-only initializing(1), 100.24.3.2 1 faulty(2), disabled(3), listening(4), preMaster(5), master(6), passive(7), uncalibrated(8), slave(9) MeanPathDelay Int Read-only Nanoseconds 100.24.3.3 4

7.1.9.7.1 PortNumber This key attribute is the port number of the local clock port. Port numbers 0 and 65,535 are reserved and cannot be used for real clock ports. See [IEEE 1588] for more information. When a PTP clock has N ports, the CCAP Core MUST set the port number to a value in the interval 1..N.

7.1.9.7.2 PortState This attribute is the state of this PTP clock port. States come from Table 8 in [IEEE 1588].

7.1.9.7.3 MeanPathDelay This attribute is an implementation-specific representation of the current value of the mean propagation time between a master and slave clock as computed by the slave. Zero means that the path delay is unavailable.

7.1.9.8 PtpClockStatus The PtpClockStatus provides state information and packet counts for RpdPtpClkCfg and CorePtpClkCfg objects.

 09/03/21 CableLabs 229 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The PtpClockStatus TLV is 100.24.2. Table 235 - PtpClockStatus Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length ClockState Enum Read-only freerun(1), 100.24.2.1 1 holdover(2), acquiring(3), freqLocked(4), phaseAligned(5) LastStateChange TimeStamp Read-only 100.24.2.2 4 PacketsSent Counter64 Read-only Packets 100.24.2.3 8 PacketsReceived Counter64 Read-only Packets 100.24.2.4 8 CounterDiscontinuityTime DateTime Read-only 100.24.2.6 8 or 11 ExcessiveHoldover Boolean Read-only 100.24.2.7 1

7.1.9.8.1 ClockState This attribute represents the current state of the clock. The ClockState is PhaseAligned when the RPD PTP port state is ‘synchronized’; see the [R-PHY] PTP Process after softReset section. PTP port state values of ‘free running’ and ‘acquiring’ equal the ClockState freerun and acquiring, respectively. The ClockState is holdover when the PTP port state is either ‘holdover out of spec’ or holdover within spec’; see the ExcessiveHolder attribute for more information about these two PTP port states. The ClockState value freqLocked is unused for now, since the RPD does not currently support that PTP port state.

7.1.9.8.2 LastStateChange This attribute represents the value when the clock state last changed.

7.1.9.8.3 PacketsSent This attribute represents the number of PTP packets sent for this clock.

7.1.9.8.4 PacketsReceived This attribute represents the number of PTP packets received for this clock.

7.1.9.8.5 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.9.8.6 ExcessiveHoldover This attribute is false and the ClockState equals holdover when the PTP port state is ‘holdover with spec’ as defined in [R-PHY]. This attribute is true and ClockState is holdover when the PTP port state is ‘holdover out of spec’ as defined in [R-PHY]. This attribute has no meaning unless the ClockState attribute is set to ‘holdover’.

7.1.9.9 PtpPortStatus The PtpPortStatus is an abstract class from which RpdPtpPortStatus and CorePtpPortStatus are derived. This object provides counts of packets sent and received on a PTP port. The PtpPortStatus TLV, applicable to the RpdPtpPortStatus object, is 100.24.4. The TLV Types are not applicable to the CorePtpPortStatus object.

230 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 236 - PtpPortStatus Object Attributes

Attribute Name Type Access Type Units TLV TLV Constraints Type Value Field Length PacketsSent Counter64 Read- Packets 100.24.4.3 8 only PacketsReceived Counter64 Read- Packets 100.24.4.4 8 only CounterDiscontinuityTime DateTime Read- 100.24.4.5 8 or 11 only CurrentClockSourceAddrType InetAddressType Read- ipv4(1), 97.8.19 only ipv6(2) CurrentClockSourceAddr InetAddress Read- SIZE(4 | 16) 97.8.19 4 or 16 only

7.1.9.9.1 PacketsSent This attribute represents the number of PTP packets sent for this clock port.

7.1.9.9.2 PacketsReceived This attribute represents the number of PTP packets received for this clock port.

7.1.9.9.3 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.9.9.4 CurrentClockSourceAddrType This attribute reports the IP address type of the PTP Master clock source currently being used. This attribute is only used with the G.8275.2 profile.

7.1.9.9.5 CurrentClockSourceAddr This attribute reports the IP address of the PTP Master clock source currently being used. This attribute is only used with the G.8275.2 profile.

7.1.9.10 CorePtpPortStatus CorePtpPortStatus is an instantiation of the abstract class PtpPortStatus and inherits those common attributes. Table 237 - CorePtpPortStatus Object Attributes

Attribute Name Type Access Type Constraints Units PortNumber UnsignedShort Key

Table 238 - CorePtpPortStatus Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CorePtpPortStatus Specialization of PtpPortStatus PtpPortMasterClockStatus Directed composition to PtpPortMasterClockStatus 1 0..* Only slave ports have an association with the PtpPortMasterClockStatus object.

 09/03/21 CableLabs 231 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.9.10.1 PortNumber This key attribute is the port number of the local clock port.

7.1.9.11 PtpPortMasterClockStatus The PtpPortMasterClockStatus TLV is 100.24.4.6. Table 239 - PtpPortMasterClockStatus Object Attributes

Attribute Name Type Access Type Units TLV Type TLV Value Constraints Field Length MasterPriority UnsignedByte Key 1..5 100.24.4.6.1 1 PacketsSent Counter64 Read-only Packets 100.24.4.6.2 8 PacketsReceived Counter64 Read-only Packets 100.24.4.6.3 8 MasterClockId HexBinary Read-only SIZE(8) 100.24.4.6.4 8 MasterClockPortNumber UnsignedShort Read-only 100.24.4.6.5 2 TwoStepFlag Boolean Read-only 100.24.4.6.6 1 IsBmc Boolean Read-only 100.24.4.6.7 1 IsMasterConnected Boolean Read-only 100.24.4.6.8 1 StatusDomain UnsignedInt Read-only 100.24.4.6.9 4 FreqOffset UnsignedInt Read-only Last 60 second PPM 100.24.4.6.10 4 interval CounterDiscontinuityTime DateTime Read-only 100.24.4.6.11 8 or 11 GmClockIdentity HexBinary Read-only SIZE(8) 100.24.4.6.12 8 GmPriority1 UnsignedByte Read-only 100.24.4.6.13 1 GmPriority2 UnsignedByte Read-only 100.24.4.6.14 1 GmQualityClass UnsignedByte Read-only Table 5 in [IEEE 100.24.4.6.15 1 1588] GmQualityAccuracy UnsignedByte Read-only Table 6 in [IEEE 100.24.4.6.16 1 1588] GmQualityOffset UnsignedShort Read-only 100.24.4.6.17 2 GmStepsRemoved UnsignedInt Read-only 100.24.4.6.18 4 FreqOffsetPpt Int Read-Only Last 60 second Parts 100.24.4.6.19 4 interval per trillion

7.1.9.11.1 MasterPriority This key attribute is the priority of the master clock configured for the PTP template assigned to this PTP clock port. Low numbers are higher priority.

7.1.9.11.2 PacketsSent This attribute represents the number of PTP packets sent to this master for this slave clock port.

7.1.9.11.3 PacketsReceived This attribute represents the number of PTP packets received from this master for this slave clock port.

7.1.9.11.4 MasterClockId This attribute specifies the clock identifier of this master clock. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to ClockIdentity from the PtpDefaultDataset Object if no announce messages have been received.

232 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.9.11.5 MasterClockPortNumber This attribute specifies master clock’s port number.

7.1.9.11.6 TwoStepFlag This attribute specifies whether the Two Step process is used (i.e., the clock is a two-step clock).

7.1.9.11.7 IsBmc This attribute represents whether or not this master is the current Best Master Clock (i.e., the master clock currently in use for this slave clock).

7.1.9.11.8 IsMasterConnected This attribute is set to TRUE if a signaling session with the master is successfully established. When a slave node receives an announce and a sync message from the master, the CCAP Core SHOULD consider the session to be successfully established.

7.1.9.11.9 StatusDomain This attribute is the PTP master domain.

7.1.9.11.10 FreqOffset This attribute is deprecated and replaced with attribute FreqOffsetPpt.

7.1.9.11.11 CounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.9.11.12 GmClockIdentity This attribute represents the clock Identity of the grandmaster clock. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to ClockIdentity from the PtpDefaultDataset Object if no announce messages have been received.

7.1.9.11.13 GmPriority1 This attribute represents the priority1 of the grandmaster clock. Lower values take precedence. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to Priority1 from the PtpDefaultDataset Object if no announce messages have been received.

7.1.9.11.14 GmPriority2 This attribute represents the priority2 of the grandmaster clock. Lower values take precedence. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to Priority2 from the PtpDefaultDataset Object if no announce messages have been received.

7.1.9.11.15 GmQualityClass This attribute is the clock class for the grandmaster clock. The clock class attribute of an ordinary or boundary clock denotes the traceability of the time or frequency distributed by the grandmaster clock. See section 7.6.2.4 in [IEEE 1588]. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to QualityClass from the PtpDefaultDataset Object if no announce messages have been received.

 09/03/21 CableLabs 233 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.9.11.16 GmQualityAccuracy This attribute characterizes the grandmaster clock for the purpose of the best master clock (BMC) algorithm. See section 7.6.2.5 in [IEEE 1588]. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to QualityAccuracy from the PtpDefaultDataset Object if no announce messages have been received.

7.1.9.11.17 GmQualityOffset This attribute represents the offset, scaled, logarithmic representation of the grandmaster clock variance. See Section 7.6.3.5 in [IEEE 1588]. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to QualityOffset from the PtpDefaultDataset Object if no announce messages have been received.

7.1.9.11.18 GmStepsRemoved This attribute is the number of communication paths traversed between the local clock and the grandmaster clock. This value is used in Best Master Clock algorithm and is populated from the Announce message received from the master clock. This value is set to zero if no announce messages have been received.

7.1.9.11.19 FreqOffsetPpt This attribute specifies the frequency offset that the locking algorithm computed per master in the last 60-second interval as a signed 32-bit integer in units of parts per trillion. The maximum permitted offset value of 2147483647 (0x7FFFFFFF) means the offset is unknown. This attribute replaces the deprecated attribute FreqOffset.

7.1.10 CMTS CM Status Information Model Figure 25 defines the CMTS CM Status Information Model for RPHY. Section 7.2.2.2, CMTS CM Status specified on [CCAP-OSSIv4.0] is extended here due to SMIv2 rules for augmenting an augmenting table. Namely, an augmenting table may not also be a base table. Objects and attributes not defined here are unchanged and are detailed in [CCAP-OSSIv4.0].

234 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 25 - CMTS CM Status Information Model

7.1.10.1 CmtsCmRegStatus This object defines attributes that represent the CM's registration status as tracked by the CMTS. This section is an extension to section 7.2.2.2, CMTS CM Status specified on [CCAP-OSSIv4.0]. With the exception of the attribute described here, all other attributes and objects defined on [CCAP-OSSIv4.0] are not re- defined here. The current Information Model restricts the mapping of a CM to a single RPD. Table 240 - New CmtsCmRegStatus Object Attributes

Attribute Name Type Access Type Constraints Units RpdUniqueId MacAddress Read-only N/A

Table 241 - New CmtsCmRegStatus Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CcapRpdToCmMapStatus Directed association to CcapRpdToCmMapStatus 1 0..1

 09/03/21 CableLabs 235 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.10.1.1 RpdUniqueId This attribute specifies a globally unique 6-byte identifier for the RPD attached to the CM specified by the Id index.

7.1.10.2 CcapRpdToCmMapStatus This object defines a mapping between an RPD Unique Identifier and the corresponding CCAP Core assigned CM Id (CmtsCmRegStatusId). This provides lookup capabilities for CMs connected to an RPD (or vice versa) and the associated US and DS RF Ports on the RPD. Table 242 - CcapRpdToCmMapStatus Object Attributes

Attribute Name Type Access Type Constraints Units RpdUniqueId MacAddress Read-only N/A CmId UnsignedInt Read-only 1..4294967295 N/A RpdUsRfPortNum UnsignedInt Read-only N/A RpdDsRfPortNum UnsignedInt Read-only N/A

7.1.10.2.1 RpdUniqueId This key attribute specifies a globally unique 6-byte identifier for the RPD attached to the CM specified by the CmId index.

7.1.10.2.2 CmId This key attribute is the CCAP Core generated unique identifier of a CM for status report purposes. Reference: [CCAP-OSSIv4.0] CmtsCmRegStatus object, Id attribute

7.1.10.2.3 RpdUsRfPortNum This attribute identifies the upstream RF port on the RPD, for the RPD attached to the CM specified by the CmId index.

7.1.10.2.4 RpdDsRfPortNum This attribute identifies the downstream RF port on the RPD, for the RPD attached to the CM specified by the CmId index.

7.1.11 RPD Statistics Information Model These objects provide reporting of RPD interface statistics information via communication from the CCAP Core. Figure 26 defines the RPD device level statistics information model reported via the CCAP Core. The CCAP Core reports RPD channel statistics for the operation of each channel on each RPD, even if the contents of the channel are virtually split/combined among multiple RF ports. The CCAP Core uniquely identifies channel statistics with at least three key attributes: • An RpdUniqueId key of an RpdInfo object; • A CoreIfIndex assigned by a reporting CCAP Core to the contents of an RF channel; and • An RfPortIndex assigned by an RPD to an RF port operating in one direction. OOB channels can include an additional key attribute. The CoreIfndex identifies a set of RPD channel contents that is unique with a reporting CCAP core. When the CoreIfIndex identifies channel contents appearing on different ports of the same RPD, the RfPortIndex key distinguishes the particular RF port on that RPD. Note that a reporting core (e.g., the Principal Core) is permitted to report RPD statistics for channels created by a different core than the core providing service on the channel (e.g., an Aux Core). In this case, the reporting core creates an IfTable row and assigns a local CoreIfIndex solely for the purpose of reporting the RPD statistics of the

236 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

owning core’s channel. The reporting core sets the ifType for the row as appropriate for the channel type (as described in Section 10.3.2). All other fields of the reported IfTable row for the owning core’s channel (e.g., ifOperStatus) are vendor-specific. In particular, the reporting core is not required to report ifTable counters (e.g., ifOutOctets) for the channel if that core does not provide the service on that channel.

Figure 26 - RPD Statistics Information Model

When the CCAP Core is requested to return an RPD statistics attribute value via the management interface, the CCAP Core MUST read and return the current value from the RPD. If the CCAP Core is unable to read the RPD’s TLV for a statistics model object, the CCAP Core MUST indicate that it was unable to obtain the value (e.g., for an SNMP get request, genErr is returned).

7.1.11.1 RpdInfo The RpdInfo object serves as the root of the RPD Statistics Information Model. The attributes in the RpdInfo object are defined in detail in Section 7.1.3.2. Table 243 - RpdInfo Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity DsScQamPerfStats Directed composition to DsScQamPerfStats 1 0..* DsOfdmPerfStats Directed composition to DsOfdmPerfStats 1 0..*

 09/03/21 CableLabs 237 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity DsOob551PerfStats Directed composition to DsOob551PerfStats 1 0..* DsOob552PerfStats Directed composition to DsOob552PerfStats 1 0..* NdfPerfStats Directed composition to NdfPerfStats 1 0..* UsScQamChanPerfStats Directed composition to UsScQamChanPerfStats 1 0..* UsOfdmaChanPerfStats Directed composition to UsOfdmaChanPerfStats 1 0..* UsOob552PerfStats Directed composition to UsOob552PerfStats 1 0..* UsNdrPerfStats Directed composition to UsNdrPerfStats 1 0..*

7.1.11.2 RpdDsInterfaceStats The abstract object RpdDsInterfaceStats allows the user to define the common statistical elements for an RPD Downstream Interface. There are five types of RPD Downstream Interfaces defined for the CCAP Core: DsScQam, DsOfdm, DsOob551, DsOob552, and NDF. Note that when the system operates with virtual splitting, then the statistical objects derived from RpdDsInterfaceStats support reporting of individual counter sets for each replica of a virtually split channel. The TLV Type assignments are defined for those classes which are specializations of RpdDsInterfaceStats (defined in the following sections). Table 244 - RpdDsInterfaceStats Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type OutDiscards Counter64 Read-only 72.1 73.1 73.6.1 74.1 75.1 76.1 OutErrors Counter64 Read-only 72.2 73.2 73.6.2 74.2 75.2 76.2 OutPackets Counter64 Read-only 72.3 73.4 73.6.3 74.3 75.3 76.3 RpdDsCounterDiscontinuityTime DateTime Read-only 72.4 73.5 73.6.4 74.4 75.4 76.4 OperStatus OperStatusType Read-only up(1), 72.5 down(2) 73.7 74.5 75.5 76.1

7.1.11.2.1 OutDiscards This attribute reports the number of outbound packets which were internally discarded before transmission (e.g., due to lack of buffering).

238 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.11.2.2 OutErrors This attribute reports the number of outbound packets that could not be transmitted because of errors.

7.1.11.2.3 OutPackets This attribute reports the number of outbound packets successfully transmitted on the channel.

7.1.11.2.4 RpdDsCounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.11.2.5 OperStatus This attribute reports the operational status of the channel.

7.1.11.3 DsScQamPerfStats The DsScQamPerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for a downstream SC-QAM channel. The DsScQamPerfStats TLV Type is 72. Table 245 - DsScQamPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units CoreIfIndex InterfaceIndex Key DsRfPortIndex UnsignedByte Key 0..253

7.1.11.3.1 CoreIfIndex This key attribute uniquely identifies the selected SC-QAM channel on the reporting core.

7.1.11.3.2 DsRfPortIndex This key attribute uniquely identifies a downstream RF port of the RPD on which the channel is being transmitted. Values 254 and 255 are reserved for future use.

7.1.11.4 DsOfdmPerfStats The DsOfdmPerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for a downstream OFDM channel. The DsOfdmPerfStats TLV Type is 73. Table 246 - DsOfdmPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type CoreIfIndex InterfaceIndex Key DsRfPortIndex UnsignedByte Key 0..253 DiscardedZblInsertionMsgs UnsignedLong Read-only 73.10

Table 247 - DsOfdmPerfStats Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity DsOfdmPlcPerfStats Directed composition to DsOfdmPlcPerfStats 1 1 DsOfdmProfilePerfStats Directed composition to DsOfdmProfilePerfStats 1 0..16

 09/03/21 CableLabs 239 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.11.4.1 CoreIfIndex This key attribute uniquely identifies the selected OFDM channel on the reporting core.

7.1.11.4.2 DsRfPortIndex This key attribute uniquely identifies a downstream RF port of the RPD on which the channel is being transmitted. Values 254 and 255 are reserved for future use.

7.1.11.4.3 DiscardedZblInsertionMsgs This attribute reports a count of Zero Bit Loading (ZBL) Insertion Messages discarded by the RPD. This attribute is mandatory if Full Duplex DOCSIS (FDX) is supported by the RPD. FDX support is optional for the RPD.

7.1.11.5 DsOfdmPlcPerfStats The DsOfdmPlcPerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for the PLC sub-channel of a downstream OFDM channel. The DsOfdmPerfStats TLV Type is 73.6.

7.1.11.6 DsOfdmProfilePerfStats The DsOfdmProfilePerfStats object reports statistical counters for profiles for a downstream OFDM channel. The DsOfdmProfilePerfStats TLV Type is 73.3. Table 248 - DsOfdmProfilePerfStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type ProfileIndex UnsignedByte Key 0..15 73.3.1 OutCodewords Counter64 Read-only 73.3.2

7.1.11.6.1 ProfileIndex This key attribute uniquely identifies a profile on the selected OFDM channel.

7.1.11.6.2 OutCodewords This attribute reports the number of transmitted LDPC codewords for the profile.

7.1.11.7 DsOob551PerfStats The DsOob551PerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for a downstream channel with DEPI channel type "SCTE-55-1-FWD". The DsOob551PerfStats TLV Type is 74. Table 249 - DsOob551PerfStats Object Attributes

Attribute Name Type Access Type Constraints Units CoreIfIndex InterfaceIndex Key DsRfPortIndex UnsignedByte Key 0..253 FreqIndex UnsignedByte Key 0 | 1

7.1.11.7.1 CoreIfIndex This key attribute uniquely identifies the selected SCTE-55-1 forward channel on the reporting core.

240 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.11.7.2 DsRfPortIndex This key attribute uniquely identifies a downstream RF port of the RPD on which the channel is being transmitted. Values 254 and 255 are reserved for future use.

7.1.11.7.3 FreqIndex This key attribute uniquely identifies the selected SCTE 55-1 FWD channel. A value of 0 identifies the first SCTE 55-1 downstream channel. A value of ‘1’ identifies the second SCTE 55-1 downstream channel.

7.1.11.8 DsOob552PerfStats The DsOob552PerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for a downstream channel with DEPI channel type "SCTE-55-2-FWD". Note that all three defined counters, i.e., OutDiscards, OutErrors, and OutPackets, account for non-idle ATM cells. The DsOob552PerfStats TLV Type is 75. Table 250 - DsOob552PerfStats Object Attributes

Attribute Name Type Access Type Constraints Units CoreIfIndex InterfaceIndex Key ModuleIndex UnsignedByte Key DsRfPortIndex UnsignedByte Key 0..253

7.1.11.8.1 CoreIfIndex This key attribute uniquely identifies the selected SCTE 55-2 forward channel on the reporting core.

7.1.11.8.2 ModuleIndex This key attribute uniquely identifies the selected SCTE 55-2 module.

7.1.11.8.3 DsRfPortIndex This key attribute uniquely identifies a downstream RF port of the RPD on which the channel is being transmitted. Values 254 and 255 are reserved for future use.

7.1.11.9 DsNdfPerfStats The DsNdfPerfStats object, which is a specialization of the RpdDsInterfaceStats object, reports statistical counters for a downstream channel with DEPI channel type "NDF" per the RPD Channel Selector table in [R-DEPI]. The DsNdfPerfStats TLV Type is 76. Table 251 - DsNdfPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units CoreIfIndex InterfaceIndex Key DsRfPortIndex UnsignedByte Key 0..253

7.1.11.9.1 CoreIfIndex This key attribute uniquely identifies the selected NDF channel on the reporting core.

7.1.11.9.2 DsRfPortIndex This key attribute uniquely identifies a downstream RF port of the RPD on which the channel is being transmitted. Values 254 and 255 are reserved for future use.

 09/03/21 CableLabs 241 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.11.10 RpdUsInterfaceStats The abstract object RpdUsInterfaceStats allows the user to define the common statistical elements for an RPD Upstream Interface. There are two types of RPD Upstream Interfaces defined for the CCAP Core: UsScQam and UsOfdma. The TLV Type assignments are defined for those classes which are specializations of RpdUsInterfaceStats (defined in the following sections). Table 252 - RpdUsInterfaceStats Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type HcsErrors Counter64 Read-only 78.3 79.3 LateMaps Counter64 Read-only 78.4 79.4 IllegalMaps Counter64 Read-only 78.5 79.5 DiscardedRequests Counter64 Read-only 78.6 79.6 RpdUsCounterDiscontinuityTime DateTime Read-only 78.8 79.8 OperStatus OperStatusType Read-only up(1), 78.9 down(2) 79.9 LateMinislots Counter64 Read-only 78.11 79.11 IllegalMinislots Counter64 Read-only 78.12 79.12

7.1.11.10.1 HcsErrors This attribute reports the number of bursts with detected HCS error in the DOCSIS header for the selected channel.

7.1.11.10.2 LateMaps This attribute reports the number of late MAP messages for the selected channel.

7.1.11.10.3 IllegalMaps This attribute reports the number of MAP messages with detected errors, other than late error for the selected channel.

7.1.11.10.4 DiscardedRequests This attribute reports the number of bandwidth requests that were discarded by the RPD for the selected channel.

7.1.11.10.5 RpdUsCounterDiscontinuityTime This attribute reports the date and time at which any one or more of the counters in this group were created or last reset to zero. If the RPD does not acquire time of day, it can report an initial CounterDiscontinuityTime of Jan 1 1970. See Section 7.1.2.1 for more information.

7.1.11.10.6 OperStatus This attribute reports the operational status of the selected channel.

7.1.11.10.7 LateMinislots This attribute reports the number of late MAP minislots for the selected channel.

242 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.11.10.8 IllegalMinislots The attribute reports the number minislots in MAP grants that the RPD discarded due to detected errors, other than being late error. The CCAP Core can also report through this attribute the count of minislots in MAP grants discarded by the RPD due to internal processing errors.

7.1.11.11 UsScQamChanPerfStats The UsScQamChanPerfStats object, which is a specialization of the RpdUsInterfaceStats object, reports statistical counters for an upstream SC-QAM channel. The UsScQamChanPerfStats TLV Type is 78. Table 253 - UsScQamChanPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Type CoreIfIndex InterfaceIndex Key UsRfPortIndex UnsignedByte Key 0..253 ChannelSnr UnsignedShort Read-only TenthdB 78.7

Table 254 - UsScQamChanPerfStats Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity UsScQamLowIucPerfStats Directed composition to UsScQamLowIucPerfStats 1 1 UsScQamHighIucPerfStats Directed composition to UsScQamHighIucPerfStats 1 1

7.1.11.11.1 CoreIfIndex This key attribute uniquely identifies the selected SC-QAM channel on the reporting core.

7.1.11.11.2 UsRfPortIndex This key attribute uniquely identifies an upstream RF port of the RPD on which the channel is being received. Values 254 and 255 are reserved for future use.

7.1.11.11.3 ChannelSnr This attribute reports the average SNR for the selected SC-QAM channel.

7.1.11.12 UsOfdmaChanPerfStats The UsOfdmaChanPerfStats object, which is a specialization of the RpdUsInterfaceStats object, reports statistical counters for an upstream OFDMA channel. The UsOfdmaChanPerfStats TLV Type is 79. Table 255 - UsOfdmaChanPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Type CoreIfIndex InterfaceIndex Key UsRfPortIndex UnsignedByte Key 0..253 ProbeGrants Counter64 Read-only 79.7

 09/03/21 CableLabs 243 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 256 - UsOfdmaChanPerfStats Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity UsOfdmaLowIucPerfStats Directed composition to UsOfdmaLowIucPerfStats 1 1 UsOfdmaHighIucPerfStats Directed composition to UsOfdmaHighIucPerfStats 1 1 UsOfdmaEcStatus Directed composition to UsOfdmaEcStatus 1 0, 1

7.1.11.12.1 CoreIfIndex This key attribute uniquely identifies the selected OFDMA channel of the reporting core.

7.1.11.12.2 UsRfPortIndex This key attribute uniquely identifies an upstream RF port of the RPD on which the channel is being received. Values 254 and 255 are reserved for future use.

7.1.11.12.3 ProbeGrants This attribute reports the number of Probe Grants on the channel.

7.1.11.13 RpdUsInterfaceLowIucStats The abstract object RpdUsInterfaceLowIucStats allows the user to define the common statistical elements for an RPD Upstream Low IUC. There are two types of RPD Upstream Low IUCs defined for the CCAP Core: SC-QAM and OFDMA. The TLV Type assignments are defined for those classes which are specializations of RpdUsInterfaceLowIucStats (defined in the following sections). Table 257 - RpdUsInterfaceLowIucStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type UsIuc UnsignedByte Key 78.1.1 79.1.1 UnicastOpportunities Counter64 Read-only 78.1.2 79.1.2 UnicastOpCollisions Counter64 Read-only 78.1.3 79.1.3 UnicastOpNoEnergy Counter64 Read-only 78.1.4 79.1.4 UnicastOpErrors Counter64 Read-only 78.1.5 79.1.5 MulticastOpportunities Counter64 Read-only 78.1.6 79.1.6 McastOpCollisions Counter64 Read-only 78.1.7 79.1.7 McastOpNoEnergy Counter64 Read-only 78.1.8 79.1.8 McastOpErrors Counter64 Read-only 78.1.9 79.1.9

7.1.11.13.1 UsIuc This key attribute provides an index in the form of the IUC for which the statistical counters will be stored.

7.1.11.13.2 UnicastOpportunities This attribute reports the total number of unicast transmission opportunities for the selected IUC. Unicast opportunities are counted for SIDs in range 0x0001-0x3dff.

244 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.11.13.3 UnicastOpCollisions This attribute reports the total number of detected collisions on unicast transmission opportunities for the selected IUC.

7.1.11.13.4 UnicastOpNoEnergy This attribute reports the number of unicast transmission opportunities with no energy for the selected IUC.

7.1.11.13.5 UnicastOpErrors This attribute reports the number of unicast transmission opportunities with detected PHY errors for the selected IUC.

7.1.11.13.6 MulticastOpportunities This attribute reports the total number of multicast transmission opportunities for the selected IUC. Multicast opportunities are counted for SIDs in range 00x3e00 - 0x3fff.

7.1.11.13.7 McastOpCollisions This attribute reports the number of detected collisions on multicast transmission opportunities for the selected IUC.

7.1.11.13.8 McastOpNoEnergy This attribute reports the number of multicast transmission opportunities with no energy for the selected IUC.

7.1.11.13.9 McastOpErrors This attribute reports the number of multicast transmission opportunities with detected PHY errors for the selected IUC.

7.1.11.14 RpdUsInterfaceHighIucStats The abstract object RpdUsInterfaceHighIucStats allows the user to define the common statistical elements for an RPD Upstream High IUC. There are two types of RPD Upstream High IUCs defined for the CCAP Core: SC-QAM and OFDMA. The TLV Type assignments are defined for those classes which are specializations of RpdUsInterfaceHighIucStats (defined in the following sections). Table 258 - RpdUsInterfaceHighIucStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type UsIuc UnsignedByte Key 78.2.1 79.2.1 ScheduledGrants Counter64 Read-only 78.2.2 79.2.2 NoEnergyBursts Counter64 Read-only 78.2.3 79.2.3 NoPreambleBursts Counter64 Read-only 78.2.4 79.2.4 ErrorBursts Counter64 Read-only 78.2.5 79.2.5

7.1.11.14.1 UsIuc This key attribute provides an index in the form of the IUC for which the statistical counters will be stored.

 09/03/21 CableLabs 245 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.11.14.2 ScheduledGrants This attribute reports the number of scheduled grants for the selected IUC.

7.1.11.14.3 NoEnergyBursts This attribute reports the number of bursts with no energy detected for the selected IUC.

7.1.11.14.4 NoPreambleBursts This attribute reports the number of bursts with no preamble detected for the selected IUC.

7.1.11.14.5 ErrorBursts This attribute reports the number of bursts received with errors other than “no energy” or “no preamble” for the selected IUC.

7.1.11.15 UsOfdmaEcStatus This object is used to report FDX echo canceler statistics and status information obtained from the RPD. This object is instantiated for an FDX OFDMA channel on FDX RPDs. Additional information about RPD FDX echo canceler can be found in [R-PHY]. The UsOfdmaEcStatus TLV Type is 79.11. Table 259 - UsOfdmaEcStatus Object Attributes

Attribute Name Type Access Type Units TLV Constraints Type LastRequestEctPeriod UnsignedShort Read-only msec 79.11.1 LastRequestEctoDuration UnsignedShort Read-only OFDMA symbols 79.11.2 NumRxEctos Counter64 Read-only 79.11.3 NumTxEcReqBlocks Counter64 Read-only 79.11.4 NumTxEcReqBlocksNoConv Counter64 Read-only 79.11.5

7.1.11.15.1 LastRequestEctPeriod This attribute reports the most recent value of echo canceler training period requested by the RPD. The RPD reports zero if no ECT request has been transmitted.

7.1.11.15.2 LastRequestEctoDuration This attribute reports the most recent value of echo canceler training opportunity duration requested by the RPD. The RPD reports zero if no ECT request has been transmitted.

7.1.11.15.3 NumRxEctos This attribute reports the number of echo canceler training opportunities received by the RPD for the selected OFDMA channel.

7.1.11.15.4 NumTxEcReqBlocks This attribute reports the number of echo canceler request blocks transmitted by the RPD for the selected OFDMA channel.

7.1.11.15.5 NumTxEcReqBlocksNoConv This attribute reports the number of echo canceler request blocks transmitted by the RPD for the selected OFDMA channel with indication of loss of echo canceler convergence.

246 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.11.16 RpdUsScQamIucStats The abstract object RpdUsScQamIucStats allows the user to define the common statistical elements for an RPD Upstream SC-QAM IUC. There are two types of RPD Upstream SC-QAM IUCs defined for the CCAP Core: High and Low. The TLV Type assignments are defined for those classes which are specializations of RpdUsScQamIucStats (defined in the following sections). Table 260 - RpdUsScQamIucStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type GoodFecCw Counter64 Read-only 78.1.10 78.2.6 CorrectedFecCw Counter64 Read-only 78.1.11 78.2.7 UncorrectedFecCw Counter64 Read-only 78.1.12 78.2.8

7.1.11.16.1 GoodFecCw This attribute reports the number of good FEC codewords for the selected IUC.

7.1.11.16.2 CorrectedFecCw This attribute reports the number of corrected FEC codewords for the selected IUC.

7.1.11.16.3 UncorrectedFecCw This attribute reports the number of uncorrected FEC codewords for the selected IUC.

7.1.11.17 UsScQamLowIucPerfStats The UsScQamLowIucPerfStats object, which is a specialization of the RpdUsScQamIucStats object and a specialization of the RpdUsInterfaceLowIucStats object, reports statistical counters for IUCs 1, 2 and 3 of an upstream SC-QAM channel. The UsScQamLowIucPerfStats TLV Type is 78.1.

7.1.11.18 UsScQamHighIucPerfStats The UsScQamHighIucPerfStats object, which is a specialization of the RpdUsScQamIucStats and a specialization of the RpdUsInterfaceHighIucStats object, reports statistical counters for IUCs 4, 5, 6, 9, 10 and 11 of an upstream SC- QAM channel. The UsScQamHighIucPerfStats TLV Type is 78.2.

7.1.11.19 RpdUsOfdmaIucStats The abstract object RpdUsOfdmaIucStats allows the user to define the common statistical elements for an RPD Upstream OFDMA IUC. There are two types of RPD Upstream OFDMA IUCs defined for the CCAP Core: High and Low. The TLV Type assignments are defined for those classes which are specializations of RpdUsOfdmaIucStats (defined in the following sections).

 09/03/21 CableLabs 247 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 261 - RpdUsOfdmaIucStats Object Attributes

Attribute Name Type Required Type Units TLV Attribute Constraints Type NumPredecodePass Counter64 No 79.1.10 79.2.6 NumPostdecodePass Counter64 No 79.1.11 79.2.7 NumPostdecodeFail Counter64 No 79.1.12 79.2.8

7.1.11.19.1 NumPredecodePass This attribute reports the number of LDPC codewords for the selected IUC that passed pre-decode syndrome check.

7.1.11.19.2 NumPostdecodePass This attribute reports the number of LDPC codewords for the selected IUC that passed post-decode syndrome check.

7.1.11.19.3 NumPostdecodeFail This attribute reports the number of received LDPC codewords for the selected IUC that failed post-decode syndrome check.

7.1.11.20 UsOfdmaLowIucPerfStats The UsOfdmaLowIucPerfStats object, which is a specialization of the RpdUsOfdmaIucStats object and a specialization of the RpdUsInterfaceLowIucStats object, reports statistical counters for IUCs 1, 2 and 3 of an upstream OFDMA channel. The UsOfdmaLowIucPerfStats TLV Type is 79.1.

7.1.11.21 UsOfdmaHighIucPerfStats The UsOfdmaHighIucPerfStats object, which is a specialization of the RpdUsOfdmaIucStats object and a specialization of the RpdUsInterfaceHighIucStats object, reports the statistical counters for IUCs 4, 5, 6, 9, 10, 11, 12 and 13 of an OFDMA channel. The UsOfdmaHighIucPerfStats TLV Type is 79.2. Table 262 - UsOfdmaHighIucPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Type AverageMer UnsignedShort Read-only TenthdB 79.2.9

7.1.11.21.1 AverageMer This attribute reports the average MER value for the selected IUC.

7.1.11.22 UsOob552PerfStats The UsOob552PerfStats object reports statistical counters for an SCTE 55-2 OOB upstream channel. The UsOob552PerfStats TLV Type is 81. Table 263 - UsOob552PerfStats Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type CoreIfIndex InterfaceIndex Key ModuleIndex UnsignedByte Key 12.4 UsRfPortIndex UnsignedByte Key 0..253 12.1

248 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Attribute Name Type Access Type Constraints Units TLV Type RcvdCells Counter64 Read- 81.2 only RcvdBytes Counter64 Read- 81.3 only Uncorrectables Counter64 Read- 81.4 only DiscontinuityTime DateAndTime Read- 81.5 only DemodIndex UnsignedByte Read- 12.5 only OperStatus OperStatusType Read- up(1), 81.1 only down(2)

7.1.11.22.1 CoreIfIndex This key attribute uniquely identifies the selected SCTE 55-2 return channel on the reporting core.

7.1.11.22.2 ModuleIndex This key attribute uniquely identifies the selected SCTE 55-2 module. This is part of a channel selector.

7.1.11.22.3 UsRfPortIndex This key attribute uniquely identifies an upstream RF port of the RPD on which the channel is being received. Values 254 and 255 are reserved for future use. This is part of a channel selector.

7.1.11.22.4 RcvdCells This attribute reports the total number of received ATM cells on the selected channel. The value of this attribute accounts for good, corrected and uncorrectable ATM cells.

7.1.11.22.5 RcvdBytes This attribute reports the total number of received bytes on the selected channel. It accounts for the payload of 53- byte long ATM cells. Under normal circumstance, the value reported by this attribute is a multiple of 53-bytes. The value of this attribute accounts for bytes from good, corrected and uncorrectable ATM cells.

7.1.11.22.6 Uncorrectables This attribute allows the CCAP Core to read the total number of received slots with uncorrectable FEC errors on the selected channel.

7.1.11.22.7 DiscontinuityTime This attribute repots the 8 or 11 octet UTC DateAndTime per RFC2579 at which the UsOob552PerfStats counters were reset to 0.

7.1.11.22.8 DemodIndex This attribute uniquely identifies the SCTE 55-2 demodulator in the module.

7.1.11.22.9 OperStatus This attribute reports the operational status of the selected channel.

7.1.11.23 UsNdrPerfStats The UsNdrPerfStats object reports statistical counters for an upstream Narrowband Digital Return (NDR) OOB channel.

 09/03/21 CableLabs 249 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The UsNdrPerfStats TLV Type is 82. Table 264 - UsNdrPerfStats Object Attributes

Attribute Name Type Access Type Constraints Units Default TLV Type CoreIfIndex InterfaceIndex Key UsRfPortIndex UnsignedByte Key 0..253 OperStatus OperStatusType Read-only up(1), 82.1 down(2)

7.1.11.23.1 CoreIfIndex This key attribute uniquely identifies the selected NDR channel on the reporting core.

7.1.11.23.2 UsRfPortIndex This key attribute uniquely identifies an upstream RF port of the RPD on which the channel is being received. Values 254 and 255 are reserved for future use.

7.1.11.23.3 OperStatus This attribute reports the operational status of the selected channel.

7.1.12 Upstream OFDMA Status Information Model Figure 27 defines the upstream OFDMA status Information Model for RPHY. Section 7.2.2.7, Upstream OFDMA Status Information Model specified in [CCAP-OSSIv4.0], is extended here with the addition of a new RPHY object. Objects and attributes not defined here are unchanged and are detailed in [CCAP-OSSIv4.0].

Figure 27 - Upstream OFDMA Status Information Model

250 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

7.1.12.1 UsOfdmaChannelStatus This object provides information on the CCAP's upstream OFDMA channels. The object is carried from [CCAP- OSSIv4.0] without changes except for a new association with CCAP Core FDX echo canceler training status object CcapUsOfdmaFdxEcStatus. Table 265 - UsOfdmaChannelStatus New Object Association

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity CcapUsOfdmaFdxEcStatus Directed Composition to 0..1 CcapUsOfdmaFdxEcStatus

7.1.12.2 CcapUsOfdmaFdxEcStatus This object provides status information about CCAP Core’s support for RPD echo canceler training protocol. A CCAP Core supports an instance of this object for every FDX OFDMA channel. Table 266 - CcapUsOfdmaFdxEcStatus Object Attributes

Attribute Name Type Access Type Constraints Units CurrentEctPeriod UnsignedShort Read-only milliseconds CurrentEctoDuration UnsignedShort Read-only OFDMA symbols LastRequestEctPeriod UnsignedShort Read-only LastRequestEctoDuration UnsignedShort Read-only NumTxEctos Counter64 Read-only NumRxEcReqBlocks Counter64 Read-only NumRxEcReqBlockNoConv Counter64 Read-only

7.1.12.2.1 CurrentEctPeriod This attribute reports the current echo cancelation training period for the channel. The CCAP Core reports zero if no ECTO has been scheduled yet.

7.1.12.2.2 CurrentEctoDuration This attribute reports the current echo cancelation training opportunity duration for the channel. The CCAP Core reports zero if no ECTO has been scheduled yet.

7.1.12.2.3 LastRequestEctPeriod This attribute reports the last cancelation training period requested by the RPD for the channel. The CCAP Core reports zero if no ECT request has been received yet.

7.1.12.2.4 LastRequestEctoDuration This attribute reports the last cancelation training opportunity duration requested by the RPD for the channel. The CCAP Core reports zero if no ECT request has been received yet.

7.1.12.2.5 NumTxEctos This attribute reports the number of transmitted echo canceler training opportunities for the channel.

7.1.12.2.6 NumRxEcReqBlocks This attribute reports the number of received echo canceler request blocks for the channel.

 09/03/21 CableLabs 251 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

7.1.12.2.7 NumRxEcReqBlockNoConv This attribute reports the number of received echo canceler request blocks with indication of loss of EC convergence for the channel.

7.1.13 Streaming Telemetry Status Information Model Figure 28 describes the Remote PHY Streaming Telemetry Information Model. This model reports status and performance management information for Streaming Telemetry. Reference: [R-PHY] StreamingTelemetryPerf section.

Figure 28 - Streaming Telemetry Status Information Model

7.1.13.1 CcapCore This object is the root of the RPD Device Information Model. The CcapCore object is described in section 6.5.1.

7.1.13.2 RpdInfo This object is the container for Streaming Telemetry Status information. The RpdInfo object is described in Section 7.1.3.2.

7.1.13.3 StreamingTelemetryStatus This object is the container for Telemetry Client Connection Status information.

252 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 267 - StreamingTelemetryStatus Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity TelemetryClientConnectionStatus Directed Composition to 1 0..* TelemetryClientStatus

7.1.13.4 TelemetryClientConnectionStatus This object reports the status of Telemetry Clients connected to, or in the process of connecting to, the RPD. Reference: [R-PHY] TcConnectionList section.

Table 268 - TelemetryClientConnectionStatus Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type TLV Value Field Length Index UnsignedByte Read-only 89.1.1 1 ClientIpAddress IpAddress Read-only 89.1.2 4 or 16 RpdServerIpAddress IpAddress Read-only 89.1.3 4 or 16 ClientPort UnsignedShort Read-only 89.1.4 2 RpdServerPort UnsignedShort Read-only 89.1.5 2 DialDirection Enum Read-only dialIn(0), 89.1.6 1 dialOut(1) State Enum Read-only other(0), 89.1.7 1 connecting(1), retryWaiting(2), dialOutRetriesExhausted(3), connected(4)

7.1.13.4.1 Index This key attribute is the index to the Telemetry Client Connection Status list.

7.1.13.4.2 ClientIpAddress This attribute reports the IP address of the remote Telemetry Client connected to the RPD.

7.1.13.4.3 RpdServerIpAddress This attribute reports the IP address of the RPD streaming Telemetry Server for the connection.

7.1.13.4.4 ClientPort This attribute reports the TCP port of the remote Telemetry Client connected to the RPD.

7.1.13.4.5 RpdServerPort This attribute reports the TCP port of the RPD streaming Telemetry Server for the connection.

7.1.13.4.6 DialDirection This attribute reports the Telemetry Client connection establishment method. The following values are defined: • dialIn(0): The Telemetry Client originated the TCP session to a TCP server socket on the RPD.

 09/03/21 CableLabs 253 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• dialOut(1): The RPD originated the TCP session to a TCP server socket on the Telemetry Client.

7.1.13.4.7 State This attribute reports the state of the Streaming Telemetry connection between the RPD and the Telemetry Client. The following values are defined: • other: The state of the Streaming Telemetry connection between the RPD and the Telemetry Client is other than the currently defined states. • connecting: The Streaming Telemetry connection is in the process of becoming established between the RPD and the Telemetry Client. • retryWaiting: The originating source of the Streaming Telemetry connection is waiting to retry establishing a connection after an unsuccessful attempt. • dialOutRetriesExhausted: The RPD exhausted the configured maximum number of attempts to establish the Streaming Telemetry connection with the Telemetry Client. • connected: The Streaming Telemetry connection is established between the RPD and the Telemetry Client.

254 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

8 ACCOUNTING MANAGEMENT

There are no additional accounting management requirements to support MHAv2.

 09/03/21 CableLabs 255 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

9 FAULT MANAGEMENT AND REPORTING REQUIREMENTS

9.1 Fault Management Requirements and Transport Protocols

This section defines requirements for remote monitoring/detection, diagnosis, reporting, and correction of problems. The CCAP Core supporting the Remote PHY architecture MUST implement the fault management and reporting requirements defined by [CCAP-OSSIv4.0], except where specified differently in this specification.

9.2 Event Reporting

The CCAP Core MUST log events using standard mechanisms defined in section 9 of [CCAP-OSSIv4.0]. Refer to Section 9.2.2 for RPD event reporting. Annex B lists all DOCSIS event definitions specific to the Remote PHY architecture.

9.2.1 CCAP Core Event Notification The CCAP Core generates asynchronous events that indicate malfunction situations and notify the operator about important events. The Principal CCAP Core receives event notifications from connected RPDs. The methods for reporting events are defined below: 1. Stored in Local Log where the CCAP Core supports two event logs (docsDevEventTable [RFC 4639] and RPD Event Log Table [DOCS-RPHY-MIB]). Locally generated events are stored in the docsDevEventTable while events received from an RPD are stored in the RPD Event Log Table [DOCS-RPHY-MIB]. In addition to storing events received from the RPD in the RPD Event Log Table, the CCAP Core MAY also store them in the docsDevEventTable. 2. Reported to SNMP entities as an SNMP notification. 3. Sent as a message to a Syslog server. 4. Optionally reported to NETCONF clients as a NETCONF notification. This specification defines the support of DOCSIS specific events (see Annex B) and IETF events. If the CCAP Core stores events received from the RPD in its docsDevEventTable, the CCAP Core MUST record events for each RPD separately in its docsDevEventTable (i.e., if the same event occurs on two or more different RPDs, two unique events are logged). The CCAP Core MUST only apply docsDevEvCount to events from the same RPD (e.g., two events from the same RPD with the same event ID). The CCAP Core MUST use the RPD reported event time when storing events received from the RPD. Refer to [CCAP-EVENTS-YANG][CCAP-EVENTS-YANG] for the DOCSIS CCAP events YANG module.

9.2.2 RPD Event Reporting An RPD is required to log events and generate asynchronous notifications that indicate malfunction situations and notify the operator about important events. The R-PHY specification defines four mechanisms for the purpose of RPD event reporting. 1. The primary method for delivery of event reports is by the RPD via RCP/GCP Notify messages. The Principal CCAP Core can configure the RPD to send event reports to the Principal CCAP Core for selected severity levels. This provides operational behavior where it is the responsibility of the RPD to notify the CCAP Core of events during run-time operation (via a push approach). The RPD MUST report all events for which the severity levels are enabled. The RPD MUST NOT report any event for which the severity level is disabled. 2. When the RPD is configured to send event reports to the CCAP Core but does not have connectivity to the Principal CCAP Core or when the RPD is not enabled to send event reports via Notify messages, then the RPD stores new event reports in the Pending Event Report Queue. The Pending Event Report Queue is intended to operate as a temporary storage for event reports intended for the CCAP Core when Notify message transport is not available or when it is temporarily disabled. The CCAP Core can read the Pending Event Report Queue or

256 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

flush it. This method provides operational behavior where it is the responsibility of the CCAP Core to synchronize events from the RPD Pending Event Report Queue during the RPD's initialization process (via a pull approach). 3. The Principal CCAP Core can configure the RPD to record events in RPD's Local Event Log. The CCAP Core supports the capability to directly read the RPD's Local Event Log. This provides a mechanism for the Principal CCAP Core to present RPD's Local Event Log on behalf of the RPD. The Principal CCAP Core has also the ability to clear the RPD's Local Event Log. 4. The Principal CCAP Core can configure the RPD to send events directly to a Syslog server. This method allows an operator to collect detailed event and log details from the RPD without burdening the Principal CCAP Core with receiving or reading these events from the RPD. Additional information about the Event Reporting can be found in the [R-PHY] specification. The Principal Core maintains the responsibility of reporting events originating from the RPD by methods defined in Section 9.2.1 of this specification or through vendor-proprietary methods such as the Command Line Interface.

9.2.2.1 Format of Events Annex B lists all DOCSIS events applicable to an RPD. The following sections explain in detail how to report these events via the local event logging mechanism and Syslog.

9.2.2.1.1 Local Event Logging An RPD MUST maintain Local Log events, defined in Annex B, in both local volatile storage and local non-volatile storage. An RPD MAY retain in local non-volatile storage events designated for local volatile storage. An RPD MAY retain in local volatile storage events designated for local non-volatile storage. An RPD MUST implement its Local Log as a cyclic buffer. The minimum number of entries the RPD is required to support in a Local Log is specified in [R-PHY], RpdLocalEventLogSize (TLV 50.39) section. The RPD Local Log non-volatile storage events MUST persist across reboots. The RPD MUST persist undelivered event reports across reboots. Aside from the procedures defined in this document, event recording conforms to the requirements of [RFC 4639]. Event descriptions are defined in English. An RPD MUST limit Event Message fields to no longer than 255 characters. This is the maximum event descriptor length defined for SnmpAdminString [RFC 3411]. Events are considered identical if the EventId is the same AND the event arguments are the same. For identical events occurring consecutively, the RPD MAY choose to store only a single event. If an RPD stores as a single event multiple identical events that occur consecutively, the RPD MUST reflect in the event description the most recent event. The RPD MUST clear both the local volatile and local non-volatile event logs when an event log reset is initiated through GCP.

9.2.2.1.2 Standard DOCSIS Events for RPD The EventId digit is a 32-bit unsigned integer. EventIds ranging [RFC 4639] from 0 to (231 - 1) are reserved by DOCSIS. The RPD MUST report an EventId as a 32-bit unsigned integer and comply with the DOCSIS EventIds defined in Annex B. The DOCS-CABLE-DEVICE-MIB [RFC 4639] defines 8 priority levels and a corresponding reporting mechanism for each level. Emergency event (priority 1) Reserved for vendor-specific 'fatal' hardware or software errors that prevent normal system operation and cause the reporting system to reboot. Every vendor may define their own set of emergency events. Examples of such events might be 'no memory buffers available', 'memory test failure', etc.

 09/03/21 CableLabs 257 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Alert event (priority 2) A serious failure, which causes the reporting system to reboot, but it is not caused by hardware or software malfunctioning. Critical event (priority 3) A serious failure that requires attention and prevents the device from transmitting data, but could be recovered without rebooting the system. Examples of such events might be the inability to get an IP address from the DHCP server. Error event (priority 4) A failure occurred that could interrupt the normal data flow, but will not cause the RPD to re-initialize. Error events could be reported in real time by using GCP. Warning event (priority 5) A failure occurred that could interrupt the normal data flow, but will not cause the RPD to re-initialize. Notice event (priority 6) The event is important, but is not a failure and could be reported in real time by using GCP. For an RPD, an example of a Notice event is any event from 'SW UPGRADE SUCCESS' group. Informational event (priority 7) The event is of marginal importance, and is not failure, but could be helpful for tracing the normal operation. Debug event (priority 8) Reserved for vendor-specific non-critical events. During RPD initialization or reinitialization, the RPD MUST persist event reporting configuration in its non-volatile memory. After an RPD factory reset, the RPD MUST support the default event reporting mechanism shown in Table 269 - RPD Default Event Reporting Mechanism Versus Priority. The reporting mechanism for each priority could be changed from the default reporting mechanism by using GCP. Table 269 - RPD Default Event Reporting Mechanism Versus Priority

Event Priority Local Event Log Notify Emergency Yes No Alert Yes No Critical Yes No Error Yes No Warning No No Notice No No Informational No No Debug No No

The RPD MUST format notifications that it generates for standard DOCSIS events as specified in Annex B.

9.2.2.1.3 Vendor-Specific Events An RPD MUST implement EventIds ranging from 231 to (232 - 1) as vendor-specific EventIds using the following format: • Bit 31 is set to indicate vendor-specific event • Bits 30-16 contain the lower 15 bits of the vendor's SNMP enterprise number • Bits 15-0 are used by the vendor to number events

258 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

9.2.2.1.3.1 Event Priorities and Vendor-Specific Events This specification defines events that make use of a sub-set of the Event Priority Levels. Vendor-specific events can be defined for any Event Priority Level. Table 270 summarizes those considerations. A CCAP Core MUST assign DOCSIS and vendor-specific events as indicated in Table 270 - Event Priorities Assignment. An RPD MUST assign DOCSIS and vendor-specific events as indicated in Table 270 - Event Priorities Assignment. Table 270 - Event Priorities Assignment

Event Priority CCAP Core and RPD Event Assignment Emergency Vendor-specific Alert CCAP Core and RPD and Vendor-specific (optional*) Critical CCAP Core and RPD and Vendor-specific (optional*) Error CCAP Core and RPD and Vendor-specific (optional*) Warning CCAP Core and RPD and Vendor-specific (optional*) Notice CCAP Core and RPD and Vendor-specific (optional*) Information CCAP Core and RPD and Vendor-specific (optional*) Debug Vendor-specific * Vendor-specific optional event definitions are recommended only where the CCAP Core or RPD allows for sufficient storage of such events.

9.2.2.1.4 RPD Syslog Message Format The RPD can be configured to send Syslog notifications directly to one or more Syslog servers. This section specifies the format of those notification messages. The RPD sends Syslog messages compatible with [RFC 3164]. Although an updated version of the Syslog protocol was described in [RFC 5424], the latter format is incompatible with widely deployed log analyzers for the original Syslog protocol defined in [RFC 3164] and at the time of this specification is not widely supported in public domain source code libraries. The required structure of the Syslog notification is a profile of [RFC 3164] and is defined as follows: “<”+PRI+“>”+TIMESTAMP+space+HOSTNAME+space+MSG+space+TAG where: PRI = an ASCII decimal value determined by multiplying the facility code by 8 and adding the Syslog priority level. • For kernel messages, the facility code = 0; for RPD “user” messages, the facility code = 1. Note that 0- based Syslog-Severity is used only for calculating PRI-VALUE. The 0-based Syslog-Priority is one less than the 1-based Docsis-Priority value (i.e., Emergency = 0 and Debug = 7). • For example, for an RPD user message with a priority of Error: PRI = 1 * 8 + 3 = 11 • Note that there is no space between final “>” and the beginning of the TIMESTAMP. TIMESTAMP = "Mmm dd hh:mm:ss” (i.e., Jun 24 13:01:37)

HOSTNAME = RPD DeviceAlias (TLV 50.19.8) if set. If the value of this TLV is not set, a vendor- specific value is provided, such as “NONE”.

MSG = PROCESS+space+CONTENT+“;”

PROCESS = alphanumeric string 1..32 chars with the process name terminated by the first non-

 09/03/21 CableLabs 259 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

alphanumeric character (e.g., a colon).

CONTENT = a string of printable characters; see [RFC3164] for details on rules about the format of the CONTENT. For DOCSIS events, the CONTENT includes the event number followed by the event message. See the RPD Syslog Message Format section for an example.

TAG = suffix composed of “RPD-ID:”+space+UNIQUE-RPD-ID

UNIQUE-RPD-ID = a lower-case hexadecimal value (i.e. “12:34:56:78:ab:cd”), representing the MAC address (TLV 50.19.4) of the RPD sending the Syslog notification. Example: <13>Jun 24 13:01:37 BSHPGATE06 dulcmgrd: Example message; RPD-ID: 00:11:22:33:ab:cd

9.2.3 RPD Clearing of Previously Reported Conditions Certain events defined in Annex B represent conditions that might exist for a specific duration while a condition exists. For example, Event ID 66070501 represents a normal operating temperature exceeded condition. The RPD might report a corresponding event defined which represents the state where the condition no longer exists or has been removed. In the example for Event ID 66070501, this condition is removed when the device’s operating temperature falls within the normal operation parameters or temperature range. Annex B defines corresponding “clearing” events which can be used in these scenarios. In the example for Event ID 66070501, Event ID 66070511 provides the ability for the RPD to clear the previously logged or alarmed condition. This event can be correlated to the previously logged or alarmed event through the parameter values carried in the event message. When the RPD reports clearing events is vendor-specific.

9.3 Fault Management UML Information Model

This section defines the UML Information Model for CCAP Core and RPD fault management reporting functions.

9.3.1 CCAP Core Event Notification Objects The objects for CCAP Core Event Notification are derived from the docsDevEventTable in [RFC 4639] and are used without modification.

9.3.2 RPD Event Notification Information Model The objects for RPD Event Notification, as managed by the CCAP Core, are shown in Figure 29.

260 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 29 - RPD Fault Management Reporting Information Model

9.3.2.1 RpdInfo The RpdInfo object serves as the root on the RPD Fault Management Reporting Information Model. The RpdInfo object is defined in Section 7.1.3.2 and referenced here. Table 271 - RpdInfo Object Associations

Associated Object Type Near-end Multiplicity Far-end Multiplicity Label Name NotifiedEvent Directed composition to 1 0..* NotifiedEvent LocalEvent Directed composition to 1 0..* LocalEvent

9.3.2.2 Event The Event object is an abstract class which defines attributes for RPD events and alarms. Events may be of interest in fault isolation and troubleshooting. Table 272 - Event Object Attributes

Attribute Name Type Access Type Constraints Units TLV Type Index UnsignedInt Key N/A FirstTime DateTime Read-only N/A 85.3 LastTime DateTime Read-only N/A 85.4 Counts Counter32 Read-only events 85.5 Level EvPriorityType Read-only N/A 85.6 Id UnsignedInt Read-only Refer to Annex B Event N/A 85.7 ID definitions Text AdminString Read-only Refer to Annex B Event N/A 85.8 Message definitions

 09/03/21 CableLabs 261 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

9.3.2.2.1 Index This key attribute provides relative ordering of the events in the event log. This attribute will always increase except when (a) the log is reset (b) the device reboots and does not implement non-volatile storage for this log, or (c) it reaches the value 2^31. The next entry for all the above cases is 1.

9.3.2.2.2 FirstTime This attribute provides the local RPD time when this event was created.

9.3.2.2.3 LastTime When an event reports only one event occurrence, this attribute will have the same value as the corresponding instance of FirstTime. When an event reports multiple event occurrences, this attribute will record the local RPD time when the most recent occurrence for this event occurred.

9.3.2.2.4 Counts This attribute provides the number of consecutive event occurrences reported by this event. This starts at 1 with the creation of this event occurrence and increments by 1 for each subsequent duplicate event occurrence.

9.3.2.2.5 Level This attribute provides the priority level of this event, as defined by Annex B. These are ordered from most serious (emergency) to least serious (debug).

9.3.2.2.6 Id This attribute provides the identifier of this event, as defined by Annex B.

9.3.2.2.7 Text This attribute provides the message text of this event, as defined by Annex B.

9.3.2.3 NotifiedEvent The NotifiedEvent object is a realization of the Event abstract class and contains RPD events logged as configured for notification to the CCAP Core. NotifiedEvent defines its own number space for the Index key.

9.3.2.4 LocalEvent The LocalEvent object is a realization of the Event abstract class and contains events logged in the RPD Local Log. LocalEvent defines its own number space for the Index key.

9.4 RPD Diagnostic LED Indicators

This section includes recommendations for LED indicators and their behavior for the RPD. Diagnostic LEDs do not replace detailed remote management and monitoring tools, but merely provide a coarse-grained indication of device connectivity to field technicians during their installation or repair of the RPD. The RPD MAY implement diagnostic LEDs which denote that a connection has been established with the CCAP Core and indicate the status of the upstream and downstream RF interfaces. Additional LEDs might be implemented in the RPD which convey vendor-specific meanings, including power levels, status checks for the various legs of the HFC using addressable elements (such as amplifiers and taps), etc.

262 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

9.4.1 System LED Indicator The RPD will have a single LED labeled with "System" or "Sys". The System LED will commence flashing at a 2 Hz "slow" rate as soon as the RPD receives power and the RPD CPU has booted. The slow flash rate denotes that the RPD is attempting to communicate across the CIN interface. The LED will begin to flash at the 4 Hz "fast" rate when the RPD has completed IP address acquisition through DHCP and is in the process of IEEE 1588 synchronization and/or being configured by the CCAP Core. At this point, the RPD will be able to accept a remote terminal session (over SSHv2) to perform debugging operations, if necessary. Finally, when the RPD completes provisioning and reaches a fully functional state with respect to the principal CCAP Core, the System LED will steadily illuminate. In addition to the two flash rates and a solid illumination pattern, the LED provides a color pattern to indicate categories of faults. See Table 273 for more details. Table 273 - System LED Operation

LED Pattern or Color State Indicated Notes Green - 2 Hz Flash Pattern Power-on - Initializing Required - Indicates power good Green - 4 Hz Flash Pattern IP acquired via DHCP, synchronizing and Required - Indicates remote SSHv2 session possible acquiring configuration Green - Steady System status good - Connections good No faults detected Red - 2 Hz Flash Pattern Connection fault - No physical connection to Loose connection, connector faults, water ingress at CIN or RF interfaces connector, wavelength mismatch, etc. Red - 4 Hz Flash Pattern Configuration fault - Failed synchronization Wrong DHCP configuration, unreachable hosts, or failed to receive configuration from failed authentication with CCAP Core, etc. Principal CCAP Core Red - Steady System fault - Device cannot initialize Indicates hardware fault, always indicated by a steadily illuminated LED. Amber - Various Warning - RPD operational but operation is Vendor-defined LED behavior. May indicate high imperfect error rates in CIN or RF ports, marginal operating conditions, etc.

9.4.2 CIN LED Indicators The RPD will have one LED for each of the interfaces that comprise the CIN. Individual Ethernet ports are identified with "Eth" appended with the numbers 0-n. The LED for an inactive Ethernet interface will not be illuminated. An inactive interface could be in this state either because the device has been administratively disabled or because it has failed; in both instances, the inactive state of the interface will be indicated by its associated LED remaining unilluminated. The LED flash pattern conforms with [IEEE 802.3x]. See Table 274 for more details. Table 274 - CIN LED Operation

LED Pattern State Indicated Notes Flash Pattern Per [IEEE 802.3x] Indicates connection state Unilluminated Ethernet port failure or port administratively Indicates possible port failure or a port which has been disabled configured to be disabled

9.4.3 RF LED Indicators Regardless of the number of physical ports implemented, the RPD implements one LED for the Upstream RF interface labelled "U-RF" and one LED for the Downstream RF interface labelled "D-RF". The D-RF LED will flash at the 2 Hz rate as soon as the RPD is powered up and the downstream RF output becomes active with at least one pilot tone and/or alignment tone. The D-RF LED will flash at the 4 Hz rate as soon as any configured channel becomes active, and until the RPD receives and applies its complete downstream channel set configuration. Once the downstream channel set configuration has been obtained by the RPD, the D-RF LED will steadily illuminate, indicating the channels are operational. The indication that the downstream channel set configuration is completed is given to the RPD by the principal CCAP Core. Refer to Table 275 for more details.

 09/03/21 CableLabs 263 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 275 - D-RF LEDs

D-RF LED Pattern State Indicated Notes 2 Hz Flash Pattern Power-on - Downstream RF initializing At least one pilot and/or alignment tone active 4 Hz Flash Pattern Channel or channels activated Awaiting downstream channel set configuration Steadily Illuminated Downstream channel set configuration obtained Downstream channels operational Unilluminated RF port fault or RF port mute Fault detected in RF port or RF port muted by CCAP Core

The U-RF LED will flash at the 2 Hz rate, indicating that the RPD has received and applied its upstream channel set configuration. The RPD's U-RF LED will start flashing at the 4 Hz rate as soon as the RPD recognizes the first upstream transmission. The U-RF LED will steadily illuminate when at least one CM completes ranging with the CCAP Core as indicated to the RPD by the CCAP Core. Refer to Table 276 for more details.

Table 276 - U-RF LED Operation

U-RF LED Pattern State Indicated Notes 2 Hz Flash Pattern At least one upstream channel is operational Indicates that the RPD considers at least one channel is operationally 'up' (OperStatus = 'up') 4 Hz Flash Pattern First upstream transmission recognized Indicates at least one CM's burst transmission has been received Steadily Illuminated Upstream deemed operational Unilluminated Upstream RF port fault or no configuration Fault detected in US RF port or no configuration received.

9.5 Proactive Network Maintenance (PNM)

There are no additional Proactive Network Maintenance (PNM) requirements to support MHAv2. Refer to [CCAP- OSSIv4.0] for details on DOCSIS Proactive Network Maintenance requirements. In the case of MHAv2, the RF Ports are located on the RPD as opposed to an I-CMTS. For example, the PNM Upstream Triggered Spectrum Capture test utilizes the ifIndex corresponding to an RF port on the RPD. The mapping between OSSI-defined PNM attributes and RCP/GCP TLVs is left to CCAP Core vendors’ implementation choices. Refer to [R-PHY] for detailed RCP/GCP TLV definitions.

264 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

10 SNMP AND MIB REQUIREMENTS

Most CCAP Core MIB objects are used in a read-only mode for status and performance monitoring. The CCAP Core requires a very small set of read-create or read-write MIB objects used by operators for operational control, automation or testing tasks, but since the RPD is bootstrapped and configured via the CCAP Core, it does not. The RPD is not required to support SNMP or any MIB objects directly - RPD SNMP data is reported through the CCAP Core and conveyed from the RPD via GCP. To the polling entity, an RPD appears to be part of a CCAP Core, similar to the way that a linecard is presented in an integrated CCAP.

10.1 Protocol and Agent Requirements

The CCAP Core MUST meet the SNMP and MIB requirements specified in [CCAP-OSSIv4.0], except where specified differently in this specification. The CCAP Core MUST support all mandatory MIB objects specified in the Detailed MIB Requirements (Normative) annex of [CCAP-OSSIv3.1], except where specified differently in this specification. The CCAP Core MUST support all mandatory MIB objects specified in Table 295 - CCAP Core MIB Object Details. The RPD MAY support the SNMPv2c protocol. If the RPD supports SNMP, the RPD MUST support only read-only access. If the RPD supports SNMP, the RPD MAY support the SNMPv3 protocol. If the RPD supports SNMP, the RPD MUST meet the SNMP requirements specified in [CCAP-OSSIv4.0], except where specified differently in this specification. If the RPD supports SNMP, the RPD MAY augment the required MIBs with objects from other standard or vendor- specific MIBs where appropriate.

10.2 CableLabs MIBs

Table 277 - CableLabs R-PHY MIBs

Reference MIB Module Applicable Device [DOCS-RPHY-MIB] DOCSIS Remote PHY MIB: DOCS-RPHY-MIB CCAP Core [DOCS-RPHY-CTRL-MIB] DOCSIS Remote PHY Control MIB: DOCS-RPHY-CTRL-MIB CCAP Core [DOCS-RPHY-PTP-MIB] DOCSIS Remote PHY PTP MIB: DOCS-RPHY-PTP-MIB CCAP Core [DOCS-RPHY-SEC-MIB] DOCSIS Remote PHY Security MIB: DOCS-RPHY-SEC-MIB CCAP Core [DOCS-RPHY-STATS-MIB] DOCSIS Remote PHY Statistics MIB: DOCS-RPHY-STATS-MIB CCAP Core

10.3 Specific MIB Object Implementation Requirements

10.3.1 Requirements for SNMPv2 MIB (RFC 3418) The CCAP Core implements the System Group of [RFC 3418] as specified in [CCAP-OSSIv4.0]. System and device objects on the RPD are reported by the CCAP Core in the DOCSIS Remote PHY MIB, as defined in Section 7.1.3.

10.3.2 Requirements for Interfaces Group MIB (RFC 2863) The CCAP Core MUST implement the IF-MIB [RFC 2863]. Ethernet Interfaces on the RPD are reported by the CCAP Core in the DOCSIS Remote PHY MIB, as defined in Section 7.1.5.

 09/03/21 CableLabs 265 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

10.3.2.1 Theory of Operation The CCAP Core creates IF-MIB interfaces for RF ports, RF channels and MAC layers in the same manner as an integrated CCAP [CCAP-OSSIv4.0] would do, but instead corresponding to the RF ports and channels of remote RPDs. The following summarizes the theory of operation for this process: • Each RF channel IF-MIB interface corresponds to a particular set of pseudowires that carries the data or control information for the channel. • The IF-MIB interface of an upstream SCQAM RF channel aggregates the three R-UEPI pseudowires UEPI-PSP-SCQAM, PSP-BW-REQ-SCQ, and PSP-RNG-REQ-SCQ. • The IF-MIB interface of an upstream OFDMA RF channel aggregates the three pseudowires UEPI-PSP- OFDMA, PSP-BW-REQ-OFDMA, and PSP-RNG-REQ-OFDMA. • The IF-MIB interface of a downstream SCQAM RF channel corresponds to all or part of the traffic sent to a downstream data pseudowire of type MPT-DEPI-PW, PSP-LEGACY-PW, MCM-PW, or PSP- MULTICHAN-PW. For MCM-PW or PSP-MULTICHAN-PW, several RF downstream IF-MIB interfaces may transmit to the same pseudowire. • An upstream RF channel interface is considered to deliver a sequence of PSP segments from one RF channel to the MAC Layer interface. • The MAC Layer reassembles the PSP segments into DOCSIS MMM PDUs, Data PDUs, and bandwidth requests. • The MAC layer conceptually transmits downstream DOCSIS MMM and Data PDUs to an RF downstream channel interface and individual PDUs. • The downstream RF channel interface is considered to concatenate and fragment a sequence of MMM or Data PDUs into L2TPv3 payloads of a single CIN packet. For D-MPT encapsulation, the interface produces MPEG frames; for PSP encapsulation, the interface produces PSP segments.

10.3.2.2 New IF-MIB Interface Types In addition to the ifTypes defined in [CCAP-OSSIv4.0], the following ifTypes and enumerated values have been added for R-PHY: • Cable SCTE 55-1 OOB Forward Channel: docsCableScte55d1FwdOob (283) • Cable SCTE 55-1 OOB Return Channel: docsCableScte55d1RetOob (284) • Cable SCTE 55-2 OOB Downstream Channel: docsCableScte55d2DsOob (285) • Cable SCTE 55-2 OOB Upstream Channel: docsCableScte55d2UsOob (286) • Cable Narrowband Digital Forward: docsCableNdf (287) • Cable Narrowband Digital Return: docsCableNdr (288) Configuration and status monitoring for Cable SCTE 55-2 OOB channels is out of scope of this specification.

10.3.2.3 CCAP Core Interfaces This section describes the requirements for implementing ifTable rows corresponding to CCAP OSSI configuration objects, i.e., the traditional DOCSIS interfaces of an Integrated CCAP. The CCAP Core creates rows in the ifTable of the IF-MIB corresponding to configured objects for RPD RF ports and RPD RF channels. The CCAP Core MUST create ifTable rows corresponding to RPD configuration objects when those objects are created. The CCAP Core MUST remove ifTable rows corresponding to RPD configuration objects when those objects are deleted. The CCAP Core MUST maintain ifTable rows corresponding to RPD configuration objects while the RPD is not attached via GCP.

266 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The following statements define the RPD interface-numbering scheme requirements: While it maintains configuration for an RPD downstream RF port ('DsRfPort') object, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 257 (cableDownstreamRfPort) corresponding to it. While it maintains configuration for a VideoDownChannel on an RPD's Downstream RF Port, the CCAP Core MUST implement a single row entry in the ifTable with an ifType value of 214 (mpegTransport) corresponding to it. While it maintains configuration for a DocsisDownChannel on an RPD's Downstream RF Port, the CCAP Core MUST implement a single row entry in the ifTable with an ifType value of 128 (docsCableDownstream) corresponding to it. While it maintains configuration for a DOCSIS DsOfdmChannelCfg on an RPD's Downstream RF Port, the CCAP Core MUST implement a single row entry in the ifTable with an ifType value of 277 (docsOfdmDownstream) corresponding to it. While it maintains configuration for an Oob551DsChan on an RPD's Downstream RF port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 283 (docsCableScte55d1FwdOob) corresponding to it. While it maintains configuration of a Cable Narrowband Digital Forward channel on an RPD's Downstream RF port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 287 (docsCableNdf) corresponding to it. While it maintains configuration of an upstream RF port ('UsRfPort') object, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 256 (docsCableUpstreamRfPort) corresponding to it. While it maintains configuration of a DOCSIS UpstreamPhysicalChannel on an RPD's Upstream RF Port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 129 (docsCableUpstream) corresponding to it. While it maintains configuration of a DOCSIS UsOfdmaChannel on an RPD's Upstream RF Port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 278 (docsOfdmaUpstream) corresponding to it. Whiles it maintains configuration of a DOCSIS UpstreamLogicalChannel on an RPD's Upstream Physical Channel, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 205 (docsCableUpstreamChannel) corresponding to it. While it maintains configuration of an Oob551VirtArpd on an RPD's Upstream RF port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 284 (docsCableScte55d1RetOob) corresponding to it. While it maintains configuration of a Cable Narrowband Digital Return channel on an RPD's Upstream RF port, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 288 (docsCableNdr) corresponding to it. While it maintains configuration of a MAC Domain that references any configured RF channel of an RPD, the CCAP Core MUST implement a row entry in the ifTable with an ifType value of 127 (docsCableMacLayer) corresponding to it. For each row entry created in the ifTable, the CCAP Core MUST create a corresponding row entry in the ifXTable. The CCAP Core SHOULD maintain the same ifIndex value for configured interfaces across reboots if there have been no configuration changes. The interfaces to be persisted across reboots include those interfaces specified in the RPD configuration UML object model.

10.3.2.4 Virtual Splitting and Combining The CCAP Core may transmit the content of a configured downstream DOCSIS data channel to cable modems to multiple RPD downstream RF Ports via DEPI multicast in a technique called “virtual splitting” that is analogous to the physical splitting of a downstream RF signal to multiple fiber nodes. Likewise, with a technique called “virtual combining,” the CCAP Core may treat the content received from cable modems from multiple RPD upstream RF ports as a single configured upstream RF channel object. With virtual splitting, the CCAP Core creates only a single ifTable row for a configured downstream RF channel, even though its contents are transmitted on multiple RPDs. With virtual combining, the CCAP Core creates only a

 09/03/21 CableLabs 267 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications single ifTable row for a configured upstream RF channel, even though it represents the reception of upstream content from multiple RPDs. Unless otherwise specified in this section, the CCAP Core continues to meet all requirements for MIB objects involving RF channel interfaces using the ifIndex of the single configured channel that is virtually split or combined. Note that with virtual splitting or combining, the CCAP Core still implements a separate ifTable row for each of the RPD RF ports that contain channels that are virtually split or combined. TLV 71.1 operStatusDsRfPort reports the operational status for the downstream RF port which is placed into IfOperStatus for the corresponding row for that downstream RF port. TLV 77.1 operStatusUsRfPort reports the operational status for the upstream RF port which is placed into IfOperStatus for the corresponding row for that upstream RF port. Normative requirements regarding Interface MIB operation with virtual combining or splitting are detailed as follows: The CCAP Core MUST indicate in docsRphyCmtsCmRegStatusTable, an extension to the docsIf31CmtsCmRegStatusTable, the particular RPD to which a CM is attached. When a CCAP Core implements virtual combining of an upstream SCQAM channel, the CCAP Core MUST implement a row in docsRphyRpdUsSignalQualityTable for each RPD upstream channel that is virtually combined. When the CCAP Core implements one or more docsRphyRpdUsSignalQualityTable rows for a virtually combined upstream RF channel, the CCAP Core MUST continue to implement the docsIfSignalQualityTable and report docsIf3SignalQualityTable rows counters as the sum of the upstream channel counters reported in docsRphyRpdUsSignalQualityTable. When a CCAP Core implements virtual combining of an upstream channel, the CCAP Core MUST implement rows in the ifStackTable that show that channel's ifIndex as higher than each of the ifIndexes of the RPD upstream RF ports from which the channel is combined. When a CCAP Core implements virtual splitting or combining, and the ifAdminStatus object of the mac-level channel is set to 'down', the CCAP Core MUST signal via GCP to set the adminState objects of each individual phy-level channel to 'down'. When a CCAP Core implements virtual splitting or combining, and the ifAdminStatus object of the mac-level channel is set to 'up', the CCAP Core MAY delay setting via GCP the individual adminState objects of the phy- level channels to 'up', e.g., because the particular RPD has not yet achieved R-DTI synchronization at initialization. With virtual splitting or combining, the CCAP Core MUST report the ifOperStatus of a split/combined mac- level channel interface as 'up' when any of the RPDs report via GCP that their individual phy-level channel is up. With virtual splitting or combining, the CCAP Core MUST report the ifOperStatus of a split/combined mac- level channel interface as 'down' only when all of the RPDs report via GCP that their individual phy-level channel is 'down'.

10.3.2.5 ifAdminStatus and ifOperStatus The ifAdminStatus of a DOCSIS interface (RF port, channel, mac-domain) is an operator configuration object that permits objects to be configured without becoming “operational”. While ifAdminStatus represents the desired state of an interface (via administrative configuration commands), ifOperStatus reports the current operational state of an interface within the CCAP Core or RPD. A CCAP Core MUST support setting ifAdminStatus of an interface corresponding to an RPD RF port/channel to ‘up’ or ‘down’. A CCAP Core MAY support setting ifAdminStatus of an interface corresponding to an RPD RF port/channel to values other than ‘up’ or ‘down’ (e.g., “testing”), but such operation is vendor-specific and not specified. The CCAP Core sets via RCP/GCP an “ifAdminState” object of each RPD for each of its RF ports and channels. Having ifAdminStatus as ‘up’ is one of several conditions - different for each interface - required to “permit” the interface to become operational. If any permit condition is unsatisfied (e.g., the ifAdminStatus as anything other than ‘up’) the interface is said to become non-operational. Each RPD reports its local OperStatus for an RF port/channel with a GCP monitoring object. An RPD reports its local OperStatus with only the values “up” or “down”. When the contents of a configured RF channel at the CCAP

268 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Core are configured for a single RPD (i.e., without "virtual combining"), the CCAP Core MUST report the RPD's channel OperStatus as the "ifOperStatus" value for the channel. A CCAP Core MUST report only the values of ‘up’ or ‘down’ for ifOperStatus of an interface corresponding to an RPD RF port/channel. The CCAP Core SHOULD reject upstream channel content from any upstream channel with an "ifOperStatus" of 'down'. The CCAP Core SHOULD reject sending downstream channel content to any RF channel with an "ifOperStatus" of 'down'. In addition to “ifAdminStatus,” this document specifies certain other “permit” conditions for DOCSIS interface operation. The CCAP Core always reports “ifOperStatus” of an operational interface as ‘up’, and of a non-operational interface as ‘down’. An RPD always reports the operational status of its RF port as read via RCP/GCP in the CCAP Core's ifTable. The reporting of individual RPD channel operational status as read via RCP/GCP is vendor specific. See also Section 10.3.2.4 for more information about reporting operational status in the ifTable for RPD channels. The operStatus for RPD Ethernet ports read using RCP/GCP is reported via the IfEnet object OperStatus attribute. This document introduces the following new requirements concerning “operational” status of DOCSIS interfaces: The CCAP Core MUST require an RPD RF port to have successfully completed GCP configuration in order to permit the IF-MIB interface for the RF port to be considered "operational". The CCAP Core MUST require L2TPv3 session setup for all corresponding data pseudowire to successfully complete setup per [R-DEPI] in order to permit the "per-port" IF-MIB interface for that channel to be considered "operational". The CCAP Core MUST require at least one downstream and one upstream RF channel interface referenced by a DOCSIS MAC Domain to be considered as "operational" in order to permit the IF-MIB interface for the docsMacLayer to be considered as "operational". A CCAP Core does not require 100% of GCP initial configuration of the RPD or all L2TPv3 pseudowire setup to complete in order to permit an RF port or MAC Layer interface to be considered as “operational.” The CCAP Core MAY require vendor-specific conditions in order to consider a DOCSIS interface to be considered to be "operational", e.g., for the CCAP Core and RPD to complete R-DTI timing synchronization.

10.3.2.6 SNMP Notification Control Requirements If a multi-layer interface model is present in the device, each sub-layer for which there is an entry in the ifTable can generate linkUp/Down traps. Since interface state changes would tend to propagate through the interface stack (from top to bottom, or bottom to top), it is likely that several traps would be generated for each linkUp/Down occurrence. The ifLinkUpDownTrapEnable object allows managers to control SNMP notification generation, and configure only the interface sub-layers of interest. If the RPD supports SNMP, the RPD MUST NOT transmit link notifications for RF channel interfaces. If configured by the CCAP Core, the RPD reports link notifications for Ethernet interfaces. Unless specifically enabled by the CCAP Core, the RPD MUST NOT send linkup/down notifications for the Ethernet ports.

10.3.2.7 ifTable and ifXTable Counters Figure 30 is derived from [RFC 3635] and depicts the relationship between the packets and byte counters of the CCAP Core MAC Domain and the IF-MIB interfaces for RPD RF channels. Upstream and downstream processing are depicted as vertical lines. A PDU that discontinues processing is depicted as an arrow leaving the vertical line. An increment to a counter is depicted as a dashed line intersecting the vertical processing line. The CCAP Core reports packets and bytes for the set of counters for an RPD RF channel or MAC Layer interface as depicted in Figure 30. In Figure 30 and this section, the notation such as “if(HC)InOctets” means both the ifTable counter “ifInOctets” and the ifXTable counter “ifHCInOctets”. Some of the relationships depicted in Figure 30 are in common for both the docsCableMacLayer, RF downstream, and RF upstream interface counters:

 09/03/21 CableLabs 269 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

• Upstream PDUs from a lower layer that are rejected for processing are counted as ifInErrors and do not affect if(HC)InOctets or any of the if(HC)In*Pkts counters. • If not rejected as ifInErrors, all octets from upstream PDUs accepted from the lower layer are counted as if(HC)InOctets, regardless of whether the PDUs are discarded or consumed in the current layer. • In particular, the octets of MMMs are counted in if(HC)InOctets of the docsCableMacLayer, even though the MMM packets are not counted in any of the if(HC)In*Pkts counters. • Upstream packets discarded for ifInUnknownProtos are not counted as ifInDiscards or any of the if(HC)In*Pkts counters. • Upstream Packets discarded for ifInDiscards are not counted as any of the if(HC)In*Pkts counters. • Downstream packets received from a high layer are counted as one of the if(HC)Out*Pkts counters, regardless of whether they are consumed, stored, or rejected in the current layer. • For example, each individual MMM or data PDU is counted as an if(HC)Out*Pkt counter of the RF downstream interface layer, even though the layer may buffer and concatenate multiple such PDUs into an L2TPV3 packet for a downstream pseudowire. • Downstream packets rejected for transmission by a layer due to format errors from a higher layer are counted as ifOutDiscards, and are not counted in ifOutErrors or ifHCOutOctets. • Downstream packets not accepted for transmission by a lower layer (e.g. due to buffering) are counted as ifOutDiscards, and their octets are counted in if(HC)OutOctets.

270 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 30 - RPD DOCSIS IF-MIB Counter Model

As depicted in Figure 30, the L2TPv3 protocol layer is considered as a layer “below” the RF upstream channel and RF downstream channel interfaces. The L2TPv3 protocol layer delivers the L2TPv3 payload of one upstream channel burst (R-UEPI header, data, and trailer segments) for a particular UEPI DEPI pseudo-wire “up” to an RF upstream channel interface. An RF downstream channel interface for a particular pseudowire delivers an L2TPv3

 09/03/21 CableLabs 271 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

payload (a sequence of MPEG frames for D-MPT or PSP sub-layer and segments for PSP in one CIN Ethernet packet) “down” to the L2TPv3 protocol layer. Note that the RF port interfaces are not depicted in Figure 30. The CCAP Core SHOULD report as zero all counters for the upstream RF port (ifType 256) and downstream RF port (ifType 257). The following requirements are introduced with this specification regarding the ifTable/IfXtable counters of an RPD RF upstream channel: The CCAP Core SHOULD count L2TPv3 PDUs of the upstream data pseudowire (PSP-UEPI-SCQAM/PSP-UEPI- OFDMA), range request pseudowire (TBD mnemonics), and bandwidth request pseudowire (TBD mnemonics) of an uncombined upstream RPD RF channel or all virtually combined upstream RPD RF channels into a single IF- MIB RF upstream channel interface. The CCAP Core SHOULD count as ifInErrors for an upstream RF channel interface any L2TPv3 payload discarded because that fails parsing of the PSP sublayer header or parsing into R-UEPI PSP segments [R-UEPI]. The CCAP Core SHOULD implement the input octet counters (ifInOctets, ifHCInOctets) for upstream RF data channel interfaces (ifTypes 129,205,278) by counting the octets of the R-UEPI data segments of UEPI data pseudowires (pw-type PSP-UEPI-SCQAM and PSP-UEPI-OFDMA) not otherwise rejected as ifInErrors. Note that these CCAP Core counters will differ from an integrated CCAP by omitting octets of the bursts for BW-REQ MMMs. The instantiation of separate IF-MIB interfaces for pseudowire type (e.g., BW-REQ, MAP, SpecMan, and PNM) is for further study. The CCAP Core SHOULD increment by one ifInUnknownProtos on an upstream RF channel data interface an L2TPv3 payload (i.e., an R-UEPI PSP sublayer header and segments) with an R-UEPI header version unsupported by the CCAP Core. The CCAP Core SHOULD increment by one ifInDiscards on an upstream RF channel data interface any R-UEPI L2TPv3 payload discarded as specified in [R-UEPI] not otherwise counted as ifInErrors or ifInUnknownProtos. These include, but are not limited to, the following conditions The burst lacks an R-UEPI payload segment (whether or not this lack is signaled in the R-UEPI header); The IUC field in the UEPI header segment is unrecognized or not supported for the scheduled SID; The scheduled SID in the UEPI header segment is not currently assigned to a service flow assigned to the upstream channel; The minislot time in the UEPI header is rejected for PDU reassembly by the MAC Layer as either old (in the past) or too far into the future; The R-UEPI trailer 'Status’ field indicates an internal PHY error; The R-UEPI trailer 'Status' field indicates FEC block counts are valid and the Uncorrectable FEC error count is nonzero; Any field of an OFDMA trailer forces the CCAP to discard the payload, e.g., for an unknown Flow Tag; Any other vendor-specific reason that prevents the L2TPv3 payload segment from attempting to be reassembled. Reassembly errors per se are counted at the MAC Layer. This specification modifies the requirements of [CCAP-OSSIv4.0] for downstream RF data channel interfaces (ifTypes 128, 214, 277) as follows: The CCAP Core SHOULD count as an output packet (if(HC)OutUcastPkts, if(HC)OutMulticasPkts, or if(HC)OutBroadcastPkts) on a downstream RF channel interface each single DOCSIS MMM or Data PDU attempted to be transmitted by an internal MAC Domain layer onto a channel. The interpretation of “attempted” and “internal MAC Domain layer” is vendor-specific, but note the requirements below concerning “ifOutErrors” that affect this interpretation. The CCAP Core SHOULD select the unicast, broadcast, or multicast output counters based on the destination Ethernet address of the MMM or Data PDU attempted to be sent.

272 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

The CCAP Core SHOULD count as the if(HC)OutOctets of an RF downstream channel interface only the bytes of a DOCSIS MMM or Data PDU (from the start of an DOCSIS header the last byte of its CRC) that was counted as an output packet of the interface. The CCAP Core SHOULD increment ifOutErrors of an RF downstream channel interface all DOCSIS MMM/Data PDUs that were counted as output packets of the interface but for which downstream transmission of the L2TPv3 payload containing the final segment of the PDU was rejected by an internal L2TPv3 protocol layer. The definition of “internal L2TPv3 protocol layer” is vendor-specific. A CCAP Core SHOULD interpret the following internal error conditions as an ifOutError of a downstream RF interface: Teardown of the L2TPv3 session ID (e.g., an internal "unknown session ID" error); Teardown of the IP socket to which the L2TPv3 payload was to be transmitted (e.g., for loss of a route or interface); Failure to transmit on an IP socket (e.g., due to kernel or driver insufficient transmit buffers). CIN Ethernet transmission errors are not expected to be counted as ifOutErrors. This specification modifies the requirements in [CCAP-OSSIv4.0] and [RFC 4546] for DOCSIS MAC Layer interfaces (ifType 127) as follows: The CCAP Core SHOULD count as ifInErrors of a MAC Layer interface any of the following conditions: A partially received DOCSIS MMM and Data PDU including one that was started but never completed and one that was continued and/or completed burst but never started; A reassembled MMM or Data PDU with an invalid DOCSIS Header, including but not limited to HCS errors, length mismatch, unknown EHDR type, and EHDR length mismatch; A reassembled MMM or Data PDU with an invalid Ethernet CRC; A reassembled Data PDU that cannot be decrypted with BPI; A partially received multiple segment MMM. The CCAP Core SHOULD count as if(HC)InOctets of a MAC Layer interface only the bytes of DOCSIS MMM and Data PDUs successfully reassembled, even if such packets are later discarded as ifInUnknownProtos or ifInDiscards. The CCAP Core SHOULD count as ifInUnknownProtos of a MAC Layer interface a reassembled upstream Data PDU (but not MMM PDU) that cannot be forwarded by its MAC Domain forwarding model (L2 or L3) either to the NSI port or to a local protocol entity due to an unknown “packet type”. A packet type means any field that demultiplexes to different packet processing algorithms. Such demultiplexing fields occur at layer 2 (e.g., EtherType), layer 3 (e.g., IP protocol type, ARP message type), and layer 4 (e.g., UDP/TCP port). The CCAP Core SHOULD count as ifInUnknownProtos of the MAC Layer interface an MMM with an unknown MAC message type. The CCAP Core SHOULD count as ifInDiscards any reassembled upstream Data PDU that cannot be forwarded to the NSI port or a local protocol entity for any reason not counted as ifInUnknownProtos, e.g., lack of internal buffers.

10.3.2.8 CCAP Core ifStack Table Shown below is an example of how the ifStack table might look for RF interfaces on the RPD. The values used for the ifIndexes are for example purposes only. The relationships are consistent with those defined in [CCAP- OSSIv4.0].

 09/03/21 CableLabs 273 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Figure 31 - CCAP Core Interface Stack Relationship Object Diagram

Table 278 - CCAP Core ifStack Table Representation

ifStackHigherLayer ifStackLowerLayer 0 2 0 10 0 64 0 65 0 77 0 78 2 12 2 13 2 32 2 33 2 41 7 201 10 101 12 101 13 101 32 7 33 7 41 201 64 101 65 201 77 101 78 201 10 102 77 102 78 202

274 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

10.3.2.9 IF-MIB Detailed Requirements Table 279 summarizes the differences in certain MIB objects of ifTable/ifXTable when applied to CCAP Core interfaces corresponding to RPD RF ports or channels. All other MIB objects of ifTable/ifXTable operate the same as specified in [CCAP-OSSIv4.0]. Table 279 - ifTable/ifXTable for RF and DOCSIS Interfaces

MIB Objects CCAP- CCAP CCAP CCAP- CCAP- CCAP CCAP CCAP CCAP MAC VideoDownChannel DocsisDownChannel Upstream Upstream DsRfPort UsRfPort DsOfdm UsOfdmaChannel Physical Logical Channel Channel Channel ifTable ifAdminStatus: up(1), up(1), up(1), up(1), up(1), up(1), up(1), up(1), up(1), down(2) down(2) down(2) down(2) down(2) down(2) down(2) down(2) down(2) ifOperStatus up(1), up(1), up(1), up(1), up(1) up(1), up(1), up(1), up(1), down(2) down(2) down(2) down(2) down(2) down(2) down(2) down(2) down(2)

 09/03/21 CableLabs 275 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Table 280 details the specific ifTable and ifXTable MIB values that are expected for the new RF interfaces on the RPD as reported by the CCAP Core. All other interfaces are as specified in [CCAP-OSSIv4.0]. Table 280 - IfTable/IfXTable for RPHY Interfaces

MIB Objects CATV 55-1 CATV 55-1 CATV NDF CATV NDR Forward Return ifTable ifIndex (n) (n) (n) (n) ifDescr Vendor-specific Vendor-specific Vendor-specific Vendor-specific ifType 283 284 287 288 ifMtu 1015 1024 N/A N/A ifSpeed 2048000 256000 20 bits*channel width 20 bits*channel width in Hz in Bps in Hz in Bps ifPhysAddress Empty-string Empty-string Empty-string Empty-string ifAdminStatus up(1), up(1), up(1), up(1), Refer to 10.3.2.5 down(2) down(2) down(2) down(2) ifOperStatus up(1), up(1), up(1), up(1), Refer to 10.3.2.5 down(2) down(2) down(2) down(2) ifLastChange ifXTable ifName Vendor-specific Vendor-specific Vendor-specific Vendor-specific ifLinkUpDownTrapEnable disabled(2) disabled(2) disabled(2) disabled(2) Refer to 10.3.2.6 ifHighSpeed 2 0 20 bits*channel width 20 bits*channel width in Hz in Mbps in Hz in Mbps ifPromiscuousMode false true false true ifConnectorPresent false false false false ifAlias Configurable String Configurable String Configurable String Configurable String ifCounterDiscontinuityTime

10.3.3 Requirements for Entity-MIB (RFC 6933) The CCAP Core MUST implement the ENTITY-MIB [RFC 6933]. Entities on the RPD are reported by the CCAP Core in the DOCSIS Remote PHY MIB, as defined in Section 7.1.5. For each row entry created in the SNMPv2-MIB ifTable that can be mapped to an entity represented in the R-PHY- MIB Entity Table, the CCAP Core MUST create a corresponding row entry in the entAliasMappingTable.

10.3.3.1 Guidelines for the implementation of the Entity MIB The Entity MIB [RFC 6933] provides a physical component layer applicable to managed objects defined for DOCSIS devices. In particular for the entPhysicalTable MIB objects, not all the physical components listed need to instantiate all the object's attributes in entPhysicalTable (the Maximum Access is as defined in [RFC 6933]). The following table represents high level constraints for any instance of entPhysicalTable. Table 281 - entPhysicalTable Requirements

MIB object Value

entPhysicalIndex n entPhysicalDescr Text Description entPhysicalVendorType Enterprise-specific OID or zeroDotZero entPhysicalContainedIn 0..n

276 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

MIB object Value

entPhysicalClass Physical Class per [RFC 6933] entPhysicalParentRelPos -1..n per [RFC 6933] entPhysicalName Physical element name In case of a component mapped to an interface Index ifName can be reported, otherwise zero-length string entPhysicalHardwareRev Hardware revision or zero-length string entPhysicalFirmwareRev Firmware revision or zero-length string entPhysicalSoftwareRev Software revision or zero-length string entPhysicalSerialNum Serial Number or zero-length string entPhysicalMfgName Manufacturer Name or zero-length string entPhysicalModelName Model Name or zero-length string entPhysicalAlias Physical element operator defined alias In case of a component mapped to an interface Index ifAlias can be reported and implemented as read-only, otherwise zero-length string entPhysicalAssetID User defined Asset ID or zero-length string entPhysicalIsFRU 'true' or 'false' entPhysicalMfgDate Manufacturer data or all zeros '0000000000000000'H entPhysicalUris URI or zero-length string entPhysicalUUID UUID or zero-length string

10.3.4 Requirements for Entity Sensor MIB (RFC 3433) The CCAP Core optionally implements the ENTITY-SENSOR-MIB for temperature sensors in the CCAP Core chassis, as specified in [CCAP-OSSIv4.0]. Sensor entities on the RPD are reported by the CCAP Core in the DOCSIS Remote PHY MIB, as defined in Section 7.1.5.

10.3.5 Requirements for Internet Protocol MIB (RFC 4293) The CCAP Core implements this MIB for the interfaces that are native to the core as specified in [CCAP-OSSIv4.0]. IP interfaces on the RPD are reported by the CCAP Core in the DOCSIS Remote PHY MIB, as defined in Section 7.1.6.

10.3.6 Requirements for DOCSIS Remote PHY MIB (DOCS-RPHY-MIB) The DOCSIS Remote PHY MIB provides details about each RPD to which a CCAP Core is attached. The MIB provides information about the identity and capability of the RPD, the sessions established between the CCAP Core and each RPD, and the interfaces and entities that are contained within each RPD. It also provides the sessions that are available on the CCAP Core. Not all tables are mandatory for the CCAP Core and RPD. The CCAP Core MUST implement the DOCS-RPHY- MIB as described in Section 7 and Section A.2.

10.3.7 Requirements for DOCSIS Remote PHY Control MIB (DOCS-RPHY-CTRL-MIB) The DOCSIS Remote PHY Control MIB provides mechanisms for a CCAP Core to control various aspects of an attached RPD. The MIB provides mechanisms to upgrade the software on an RPD, manage and upload crash files on an RPD, reboot an RPD, clear an RPD’s log and pre-provision certain parameters on an RPD. The CCAP Core MUST implement the DOCS-RPHY-CTRL-MIB as described in Section 10.3.7 and Section A.3.

10.3.8 Requirements for DOCSIS Remote PHY PTP MIB (DOCS-RPHY-PTP-MIB) The DOCSIS Remote PHY PTP MIB provides mechanisms for a CCAP Core to report the status of PTP, including RPD PTP status information.

 09/03/21 CableLabs 277 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The CCAP Core MUST implement the DOCS-RPHY-PTP-MIB as described in Section 7.1.9 and Section A.4.

10.3.9 Requirements for DOCSIS Remote PHY Statistics MIB (DOCS-RPHY-STATS-MIB) The DOCSIS Remote PHY Statistics MIB provides mechanisms for a CCAP Core to report RPD statistics information. The CCAP Core MUST implement the DOCS-RPHY-STATS-MIB as described in Section 7.1.11 and Section A.5.

10.3.10 Requirements for DOCSIS Baseline Privacy Plus MIB (RFC 4131) The CCAP Core implements the DOCS-IETF-BPI2-MIB [RFC 4131] for security management functions as specified in [CCAP-OSSIv4.0]. The CCAP Core MUST implement the extensions to [RFC 4131] listed in Section 11.3.

10.3.11 Requirements for DOCSIS IF MIBs This document uses the term “DOCSIS IF MIBs” to comprise the DOCS-IF-MIB [RFC 4546] DOCS-IF3-MIB [DOCS-IF3-MIB], and DOCS-IF31-MIB [DOCS-IF31-MIB]. The CCAP Core MUST report DOCSIS IF MIB objects only for attached and fully-initialized RPDs. An Auxiliary or Principal CCAP Core MAY limit reported DOCSIS IF MIB objects to only channels managed by the CCAP Core. Some DOCSIS IF MIB values correspond to values written by a CCAP Core via GCP to an RPD. A value specified as “set with” a GCP TLV value means the last value successfully written via GCP to the RPD. If a CCAP Core reports a DOCSIS IF MIB value that may be validly set via GCP by a different CCAP Core, the CCAP Core MUST report the current value read from the RPD via GCP. Note that the CCAP Core “docsRphyRpdIfMapTable” of [DOCS-RPHY-MIB] provides the GCP keys that refer to the CCAP Core’s interfaces.

10.3.11.1 Requirements for DOCS-IF-MIB (RFC 4546) The CCAP Core MUST implement the selected objects of DOCS-IF-MIB [RFC 4546] as specified in Table 282 - DOCS-IF-MIB Reporting Requirements. All other objects of the DOCS-IF-MIB are deprecated for R-PHY operation. Table 282 - DOCS-IF-MIB Reporting Requirements

Object Reporting Requirements docsIfDownstreamChannelEntry One row per RPD interface of ifType docsCableDownstream(128) or docsOfdmDownstream(277). docsIfDownChannelId As specified in [RFC 4546]. docsIfDownChannelFrequency As set with GCP TLV 62.5. docsIfDownChannelWidth As corresponding to the Annex set with GCP TLV 62.9 docsIfDownChannelModulation As corresponding Modulation set with GCP TLV 62.7 docsIfDownChannelInterleave As corresponding to the interleave set with GCP TLV 62.8 docsIfDownChannelPower The sum of the downstream RF port base channel power as set by the principal core with GCP TLV 61.3 and the power adjustment set with GCP 62.16. Note that this value does not incorporate any configured tilt. docsIfDownChannelAnnex As set with GCP TLV 62.9 docsIfDownChannelStorageType other(2) Object docsIfUpstreamChannelTable docsIfUpstreamChannelEntry One row per RPD interface of ifType docsCableUpstreamChannel(205) and docsOfdmaUpstream (278). docsIfUpChannelId As specified in [RFC 4546] docsIfUpChannelFrequency For SCQAM upstream channels (ifType205), as set with GCP TLV 65.4; for OFDMA upstream channels (ifType 278): 0.

278 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object Reporting Requirements docsIfUpChannelWidth For SCQAM: as set with GCP TLV 65.5; for OFDMA: 0. docsIfUpChannelModulationProfile For SCQAM, as specified in [RFC 4546]; for OFDMA: 0. docsIfUpChannelSlotSize For SCQAM, as set with GCP TLV 65.6; for OFDMA: 0. docsIfUpChannelTxTimingOffset For SCQAM, the maximum value received by the CCAP core in the “Timing Offset” field of an R-UEPI trailer segment; for OFDMA: 0. docsIfUpChannelRangingBackoffStart As configured for SCQAM or OFDMA channel object RangingBackoffStart in [CCAP- OSSIv4.0] docsIfUpChannelRangingBackoffEnd As configured for SCQAM or OFDMA channel object RangingBackoffStart in [CCAP- OSSIv4.0] docsIfUpChannelTxBackoffStart As configured for SCQAM or OFDMA channel object TxBackoffStart in [CCAP-OSSIv4.0] docsIfUpChannelTxBackoffEnd As configured for SCQAM or OFDMA channel object TxBackoffEnd in [CCAP-OSSIv4.0] docsIfUpChannelType SCQAM: as configured in [CCAP-OSSIv4.0]; OFDMA: 0. docsIfUpChannelCloneFrom NA, read as 0 docsIfUpChannelUpdate NA, read as false(2) docsIfUpChannelStatus NA, read as ‘active(1)’ docsIfUpChannelPreEqEnable As configured for ‘PreEqEnable’ object in [CCAP-OSSIv4.0] Object docsIfSignalQualityTable docsIfSignalQualityEntry One row per RPD interface of ifType docsCableUpstreamChannel(205) and docsOfdmaUpstream (278). docsIfSigQIncludesContention False(2) docsIfSigQUnerroreds Sum of “Unerrored FEC” counts as obtained directly from the RPD via GCP or from R-UEPI trailers of bursts in non-contention intervals. With virtual combining, the sum of the docsRphyRpdUsSignalQUnerroreds counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels. docsIfSigQCorrecteds Sum of “Corrected FEC” counts as obtained directly from the RPD via GCP or from R-UEPI trailers of bursts in non-contention intervals. With virtual combining, the sum of the docsRphyRpdUsSignalQCorrecteds counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels. docsIfSigQUncorrectables Sum of “Uncorrectable FEC” counts as obtained directly from the RPD via GCP or from R- UEPI trailers of bursts in non-contention intervals. With virtual combining, the sum of the docsRphyRpdUsSignalQUncorrectables counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels. docsIfSigQSignalNoise Vendor-specific estimate of channel Signal-to-Noise ratio as obtained from RPD or via the ‘SNR’ fields of R-UEPI trailers of bursts in non-contention intervals. The method of reporting with virtual combining is vendor-specific. docsIfSigQMicroreflections Must be 0. docsIfSigQEqualizationData Not instantiated. docsIfSigQExtUnerroreds Sum of “Uncorrectable FEC” blocks in non-contention intervals, obtained either directly from the RPD with GCP or by adding the counts of Unerrored FEC blocks in UEPI trailers. With virtual combining, the sum of the docsRphyRpdUsSignalQUnerroreds counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels. docsIfSigQExtCorrecteds Sum of “Corrected FEC” blocks, obtained either directly from the RPD via GCP or by adding the counts from R-UEPI trailers of bursts in non-contention intervals. With virtual combining, the sum of the docsRphyRpdUsSignalQCorrecteds counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels. docsIfSigQExtUncorrectables Sum of ‘Uncorrected FEC” blocks, obtained either directly from the RPD via GCP or by adding the counts from R-UEPI trailers of bursts. With virtual combining, sum of the docsRphyRpdUsSignalQUncorrectables counts for each combined RPD port. See Section 10.3.11.4 for OFDMA channels.

 09/03/21 CableLabs 279 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

10.3.11.2 Requirements for (DOCS-IF3-MIB) The CCAP Core MUST implement the selected objects of [DOCS-IF3-MIB] as specified in Table 283 - DOCS-IF3- MIB Reporting Requirements. All other objects of the DOCS-IF3-MIB are deprecated for R-PHY operation. Table 283 - DOCS-IF3-MIB Reporting Requirements

Object Reporting Requirements docsIf3SignalQualityExtRxMER As obtained from the RPD with GCP docsIf3SignalQualityExtRxMerSamples As obtained from the RPD with GCP docsIf3CmtsSignalQualityExtCNIR As obtained from the RPD with GCP docsIf3CmtsSignalQualityExtExpectedRxSignalPower As configured on the CCAP Core Object docsIf3CmtsSpectrumAnalysisMeasAmplitudeData Deprecated docsIf3CmtsSpectrumAnalysisMeasTimeInterval Deprecated Object docsIf3CmtsCmUsStatusModulationType As selected by CCAP Core. docsIf3CmtsCmUsStatusRxPower Average upstream channel of the power, as reported by the RPD or as derived from UEPI trailers. docsIf3CmtsCmUsStatusSignalNoise Average upstream channel Signal to Noise ratio, as reported by the RPD or as derived from UEPI trailers. docsIf3CmtsCmUsStatusMicroreflections Always 0 docsIf3CmtsCmUsStatusEqData The last received Equalization data block from the CM. docsIf3CmtsCmUsStatusUnerroreds The count of unerrored FEC blocks from the CM, as accumulated by the CCAP core from R-UEPI trailers or as read from the RPD. See Section 10.3.11.4 for OFDMA channels. docsIf3CmtsCmUsStatusCorrecteds The count of corrected FEC blocks from the CM, as accumulated by the CCAP core from R-UEPI trailers or as read from the RPD. See Section 10.3.11.4 for OFDMA channels. docsIf3CmtsCmUsStatusUncorrectables The count of uncorrectable FEC blocks from the CM, as accumulated by the CCAP core from R-UEPI trailers or as read from the RPD. See Section 10.3.11.4 for OFDMA channels. docsIf3CmtsCmUsStatusHighResolutionTimingOffset Per [DOCS-IF3-MIB] docsIf3CmtsCmUsStatusIsMuted Per [DOCS-IF3-MIB] docsIf3CmtsCmUsStatusRangingStatus Per [DOCS-IF3-MIB] Object docsIf3CmtsCmCtrlCmdMacAddr Per [DOCS-IF3-MIB] docsIf3CmtsCmCtrlCmdMuteUsChId Per [DOCS-IF3-MIB] docsIf3CmtsCmCtrlCmdMuteInterval Per [DOCS-IF3-MIB] docsIf3CmtsCmCtrlCmdDisableForwarding Per [DOCS-IF3-MIB] docsIf3CmtsCmCtrlCmdCommit Per [DOCS-IF3-MIB]

10.3.11.3 Requirements for (DOCS-IF31-MIB) The CCAP Core MUST implement the selected objects of [DOCS-IF31-MIB] as specified in Table 284 - DOCS- IF31-MIB Reporting Requirements. Table 284 - DOCS-IF31-MIB Reporting Requirements

Object Reporting Requirements docsIf31DocsisBaseCapability Per [DOCS-IF31-MIB] docsIf31RxChStatusPrimaryDsIndicator Per [DOCS-IF31-MIB] docsIf31RxChStatusOfdmProfiles Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusAssignedEmIds Per [DOCS-IF31-MIB]

280 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object Reporting Requirements docsIf31CmtsCmRegStatusDsProfileIdList Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusUsProfileIucList Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusTcsPhigh Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusTcsDrwTop Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusMinUsableDsFreq Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusMaxUsableDsFreq Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusMaxUsableUsFreq Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusPartialSvcState Per [DOCS-IF31-MIB] docsIf31CmtsCmRegStatusPartialChanState Per [DOCS-IF31-MIB] Object docsIf31CmtsCmUsOfdmaChannelRxPower Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelMeanRxMer As computed from RxMER PDUs for R-UEPI PNM. docsIf31CmtsCmUsOfdmaChannelStdDevRxMer As computed from RxMER PDUs for R-UEPI PNM. docsIf31CmtsCmUsOfdmaChannelRxMerThreshold As configured per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelThresholdRxMerValue Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelThresholdRxMerHighestFreq Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelMicroreflections Always 0 docsIf31CmtsCmUsOfdmaChannelHighResolutionTimingOffset Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelIsMuted Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelRangingStatus Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelCurPartialSvcReasonCode Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelLastPartialSvcTime Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelLastPartialSvcReasonCode Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaChannelNumPartialSvcIncidents Per [DOCS-IF31-MIB] docsIf31CmtsCmUsOfdmaProfileTotalCodewords As accumulated from OFDMA trailers or as read from the RPD. See 10.3.11.4. docsIf31CmtsCmUsOfdmaProfileCorrectedCodewords As accumulated from OFDMA trailers or as read from the RPD. See 10.3.11.4. docsIf31CmtsCmUsOfdmaProfileUnreliableCodewords As accumulated from OFDMA trailers or as read from the RPD. See 10.3.11.4. Object docsIf31CmtsCmDsOfdmChannelCurPartialSvcReasonCode Per [DOCS-IF31-MIB] for each CM docsIf31CmtsCmDsOfdmChannelLastPartialSvcTime Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmChannelLastPartialSvcReasonCode Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmChannelNumPartialSvcIncidents Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmChannelNumPartialChanIncidents Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmProfilePartialChanReasonCode Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmProfileLastPartialChanTime Per [DOCS-IF31-MIB] docsIf31CmtsCmDsOfdmProfileLastPartialChanReasonCode Per [DOCS-IF31-MIB] Object docsIf31CmtsCmEmStatsEm1x1ModeTotalDuration Per [DOCS-IF31-MIB] for each CM docsIf31CmtsCmEmStatsDlsModeTotalDuration Per [DOCS-IF31-MIB] docsIf31CmtsCmEmStatsLastDlsTime Per [DOCS-IF31-MIB] docsIf31CmtsCmEmStatsDlsWakeupEvents Per [DOCS-IF31-MIB] Object docsIf31CmtsDsOfdmChanChannelId Per CCAP Core configuration, as specified in [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanLowerBdryFreq Per [DOCS-IF31-MIB]

 09/03/21 CableLabs 281 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object Reporting Requirements docsIf31CmtsDsOfdmChanUpperBdryFreq Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanLowerBdryEncompSpectrum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanUpperBdryEncompSpectrum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanLowerBdryEncompSpectrum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanUpperBdryEncompSpectrum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanPlcFreq Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanSubcarrierZeroFreq Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanFirstActiveSubcarrierNum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanLastActiveSubcarrierNum Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanNumActiveSubcarriers Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanSubcarrierSpacing Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanLowerGuardbandWidth Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanUpperGuardbandWidth Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanCyclicPrefix Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanRollOffPeriod Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanTimeInterleaverDepth Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanNumPilots Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanPilotScaleFactor Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanNcpModulation Per [DOCS-IF31-MIB] Object docsIf31CmtsDsOfdmChanUtilization Statistics per profile ID, as sent by Core or read from RPD. docsIf31CmtsDsOfdmProfileStatsConfigChangeCt Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsFullChannelSpeed Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutOctets Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutUnicastOctets Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutMulticastOctets Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutFrames Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutUnicastFrames Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsOutMulticastFrames Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsCtrDiscontinuityTime Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmProfileStatsAssignedCmCt Per [DOCS-IF31-MIB] Object docsIf31CmtsDsOfdmSubcarrierStatusEndId As configured on CCAP Core docsIf31CmtsDsOfdmSubcarrierStatusMainModulation Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmSubcarrierStatusSkip Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmSubcarrierStatusSkipModulation Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanPowerCenterFrequency Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmChanPowerTxPower Configured channel power, used by all per-RPD ports on virtual splitting. Object docsIf31CmtsUsOfdmaChanTemplateIndex As configured on CCAP Core docsIf31CmtsUsOfdmaChanConfigChangeCt Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanTargetRxPower Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanLowerBdryFreq Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanUpperBdryFreq Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanSubcarrierSpacing Per [DOCS-IF31-MIB]

282 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object Reporting Requirements docsIf31CmtsUsOfdmaChanCyclicPrefix Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanNumSymbolsPerFrame Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanRollOffPeriod Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanPreEqEnable Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngGuardband Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngNumSubcarriers Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngPreambleLen Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanInitRngGuardband Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanInitRngNumSubcarriers Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanInitRngPreambleLen Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanProvAttribMask Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanTxBackoffStart Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanTxBackoffEnd Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanRangingBackoffStart Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanRangingBackoffEnd Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanUtilization As computed either from received OFDMA bursts or via reading RPD. docsIf31CmtsUsOfdmaChanId Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucStatsMinislotPilotPattern Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucStatsMinislotModulation Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucStatsTotalCodewords As accumulated from OFDMA burst trailers or as read from the RPD. See Section 10.3.11.4. docsIf31CmtsUsOfdmaDataIucStatsCorrectedCodewords As accumulated from OFDMA burst trailers or as read from the RPD. See Section 10.3.11.4. docsIf31CmtsUsOfdmaDataIucStatsUnreliableCodewords As accumulated from OFDMA burst trailers or as read from the RPD. See Section 10.3.11.4. docsIf31CmtsUsOfdmaDataIucStatsInOctets Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucStatsCtrDiscontinuityTime Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucStatsAssignedCmCt Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucDetailStatusUpperFreq Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucDetailStatusMinislotPilotPattern Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaDataIucDetailStatusMinislotModulation Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaRangingIucStatusGuardband Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaRangingIucStatusNumSubcarriers Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmSubcarrierTypeEndSubcarrierId Per [DOCS-IF31-MIB] docsIf31CmtsDsOfdmSubcarrierTypeSubcarrierType Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaSubcarrierTypeEndSubcarrierId Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaSubcarrierTypeSubcarrierType Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanTemplateIndex Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanConfigChangeCt Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanTargetRxPower Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanLowerBdryFreq Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanUpperBdryFreq Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanSubcarrierSpacing Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanCyclicPrefix Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanNumSymbolsPerFrame Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanRollOffPeriod Per [DOCS-IF31-MIB]

 09/03/21 CableLabs 283 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object Reporting Requirements docsIf31CmtsUsOfdmaChanPreEqEnable Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngGuardband Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngNumSubcarriers Per [DOCS-IF31-MIB] docsIf31CmtsUsOfdmaChanFineRngPreambleLen Per [DOCS-IF31-MIB]

10.3.11.4 OFDMA FEC Error Reporting For clarification purposes, this section explains how to calculate DOCSIS IF MIB objects for “Unerrored”, “Corrected”, and “Uncorrectable” FEC blocks from an OFDMA burst trailer as specified in [R-UEPI]. • The sum of OFDMA “Post Syndrome Pass” counts for long, medium, and short FEC codewords is reported as a “Corrected” FEC block count or a “Corrected” code word count. • The sum of OFDMA “Post Syndrome Fail” counts for long, medium, and short FEC codewords is reported as an “Uncorrectable” FEC block count or an “Unreliable” code word count. • The sum of all OFDMA FEC codewords of long, medium, and short length is reported as “Total Codewords”. • The “Total Codewords” count minus the sum of “Corrected” and “Uncorrectable” FEC counts is reported as an “Unerrored” FEC block count.

10.3.12 Requirements for DOCSIS Remote PHY Security (DOCS-RPHY-SEC-MIB) The DOCSIS Remote PHY Security MIB provides security management mechanisms for a CCAP Core and RPD including certificate management. The CCAP Core MUST implement the [DOCS-RPHY-SEC-MIB] as described in Section 11.4 and Section A.6.

284 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

11 SECURITY MANAGEMENT

This section defines CCAP Core and RPD requirements for security management functions.

11.1 Secure Shell Requirements

During normal operation, the RPD is managed through the CCAP Core. However, it is anticipated that operators will require secure remote access to the RPD for activities such as set-up prior to installation, maintenance, and troubleshooting. The RPD provides a Secure Shell (SSH) server that allows secure remote access and interaction with the RPD via vendor-specific command line interface. The RPD MUST start an SSHv2 server listening on any networking ports that receive an IP address configuration. The RPD MUST restart the RPD initialization procedure [R-PHY], if the RPD is unable or fails to start an SSHv2 server. When the RPD is unable or fails to start an SSHv2 server, the RPD MUST log event id 66070803. The RPD MUST support SSH version 2 as defined in [RFC 4250], [RFC 4251], [RFC 4252], [RFC 4253], [RFC 4254], and [RFC 6668]. In addition to the ciphers specified in the SSH RFCs, the RPD MUST support AES-128 as specified in [FIPS-197]. The RPD SHOULD support the following ciphers: • AES-192 as specified in [FIPS-197] • AES-256 as specified in [FIPS-197] • Three-key 3DES in CBC mode as specified in [FIPS-46-3] In addition to the MAC algorithms specified in the SSH RFCs, the RPD SHOULD support hmac-sha2-256, specified in [FIPS-180-4]. Since an RPD may be installed in an untrusted part of the MSO's network, secure access to the RPD is required. If MACsec is not being used between the RPD and the Network Access Device (NAD), then to avoid the threat of a Man-in-the-Middle (MITM) attack, it is strongly recommended mutual authentication is used within SSH between the RPD and the NMS. If MACsec is used between the RPD and the NAD, then threat for a MITM attack is avoided. In this case, it is not necessary for the NMS SSH client to authenticate the RPD. In either case, the RPD SSH server is always required to authenticate the NMS client. An RPD may be shipped to an operator with less secure local and remote access than needed for deployment in an Outside Plant (OSP). Therefore, it is important that an RPD prior to deployment is properly secured, before installation in the OSP. The steps taken prior to the RPD's deployment include accessing the RPD's vendor-specific command line interface using one of the less secure access methods, configuring the SSH authorization list with at least one NMS client public key, and disabling all less secure access methods. Optionally, the RPD's public key could be obtained and installed on the NMS client for use during mutual SSH authentication. This is all captured by the following requirements. The RPD MUST support mutual authentication between an SSH client operated by the user and the RPD SSH server. Note that an operator may choose not to support SSH client (e.g., NMS) authentication of RPDs. The RPD's SSH server MUST authenticate an NMS client's public key during establishment of an SSH session with the NMS. It is strongly recommended that each NMS SSH client authenticates the RPD's public key during establishment of an SSH session with the RPD. The RPD MUST provide a method to store an NMS client public key into the RPD's authorization list in preparation for its deployment in the access network. The RPD MUST be capable of storing a minimum of 16 NMS public keys.

 09/03/21 CableLabs 285 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

The RPD MUST provide a method to retrieve its public key (derived from the RPD's X.509 Device Certificate) in preparation for its deployment in the access network. An RPD vendor could also provide a list of RPD public keys to an operator for all RPDs shipped to the operator. In this case, the operator would install the public keys of all RPDs into the NMS authorization list used for SSH authentication of RPDs. The RPD SHOULD log event id 66070102 when an SSH client is successfully authenticated. When the RPD detects an SSH authentication error from a client attempting access to the RPD, the RPD SHOULD log event id 66070103.

11.2 Local Management Access

An RPD might have one or more management access ports to facilitate local management activities such as an installation technician physically connecting a laptop or external test device to the RPD via a cable connection to such port. The RPD MUST log event 66070507 when an external connection is made to one of the local management access ports. In this instance, the RPD may detect a cable connection to the management port via passive or active signals on the port. The RPD MUST log event 66070517 when an external connection to one of the local management access ports is removed. In this instance, the RPD may detect a cable disconnection from the management port via passive or active signals removed from the port. The RPD MUST log event 66070518 when an unsuccessful login is attempting from one of the local management access ports. The RPD MUST log event 66070519 when a successful login is completed from one of the local management access ports.

11.3 Certificate Management

The CMTS in the CCAP Core has certificate MIBs used to control and view certificate validation functions of Cable Modems. These are defined in docsBpi2CmtsCertObjects of DOCS-IETF-BPI2-MIB [RFC 4131]. The CCAP Core MUST support the docsBpi2CmtsCACertTable of DOCS-IETF-BPI2-MIB [RFC 4131] for RPD certificate validation functions. The CCAP Core MUST support docsBpi2CmtsProvisionedCmCertTable with entries for managed RPDs.

11.4 Security Management UML Information Model

This section defines the UML Information Model for CCAP Core and RPD security management functions.

11.4.1 CCAP Core Security Management Information Model The CCAP Core objects for Security Management are shown in Figure 32.

286 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Figure 32 - CCAP Core Security Management Information Model

11.4.1.1 CcapCore The CcapCore object serves as the root of the CCAP Core Security Management Information Model. The CcapCore object is defined in Section 6.5.1 and referenced here. Table 285 - CcapCore Object Associations

Associated Object Type Near-end Far-end Label Name Multiplicity Multiplicity CaCert Directed composition to CaCert 1 1..* ServerCert Directed composition to ServerCert 1 1 ProvisionedDeviceCertTrust Directed composition to 1 0..* ProvisionedDeviceCertTrust

11.4.1.2 CaCert This object describes the set of known Certificate Authority certificates acquired by the CCAP Core. Reference: Certificate Hierarchy and Profiles section of [R-PHY], docsBpi2CmtsCACertTable [RFC 4131]. Table 286 - CaCert Object Attributes

Attribute Name Type Access Type Constraints Units Index UnsignedInt Key 1.. 4294967295 N/A Subject AdminString Read-only SIZE(1..64) N/A Issuer AdminString Read-only N/A SerialNumber HexBinary Read-only SIZE(1..32) N/A Trust Enum Read-only trusted(1), N/A untrusted(2), chained(3), root(4) Source Enum Read-only snmp(1), N/A configurationFile(2), externalDatabase(3), other(4), authentInfo(5), compiledIntoCode(6) Cert DocsX509ASN1DEREncodedCertificate Read-only N/A

 09/03/21 CableLabs 287 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Attribute Name Type Access Type Constraints Units CertThumbprint HexBinary Read-only SIZE(20) N/A

11.4.1.2.1 Index This key attribute represents the index for an instance of this object.

11.4.1.2.2 Subject This attribute represents the subject name exactly as it is encoded in the X509 certificate. The organizationName portion of the certificate's subject name is to be present. All other fields are optional. Any optional field present is to be prepended with (carriage return, U+000D) (line feed, U+000A). Ordering of fields present is to conform to the following: organizationName countryName stateOrProvinceName localityName organizationalUnitName organizationalUnitName= commonName

11.4.1.2.3 Issuer This attribute represents the issuer name exactly as it is encoded in the X509 certificate. The commonName portion of the certificate's issuer name is to be present. All other fields are optional. Any optional field present is to be prepended with (carriage return, U+000D) (line feed, U+000A). Ordering of fields present is to conform to the following: commonName countryName stateOrProvinceName localityName organizationalUnitName organizationalUnitName=

11.4.1.2.4 SerialNumber This attribute represents the CA certificate's serial number, represented as an octet string.

11.4.1.2.5 Trust This attribute reports the trust status of this certificate. Root CA certificates are to be given root(4) trust; intermediate CA certificates are not to be given root(4) trust. Trust on root certificates is not to change.

11.4.1.2.6 Source This attribute indicates how the certificate reached the CCAP Core. Other (4) means that it originated from a source not identified above.

11.4.1.2.7 Cert This attribute represents the X509 DER-encoded Certificate Authority certificate. To help identify certificates, either this attribute or the CertThumbprint attribute is to be returned by a CCAP Core for self-signed CA certificates. Note: The zero-length OCTET STRING is to be returned, on reads, if the entire certificate is not retained in the CCAP Core.

288 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

11.4.1.2.8 CertThumbprint This attribute represents the SHA-1 hash of a CA certificate. To help identify certificates, either this attribute or the Cert attribute is to be returned by a CCAP Core for self-signed CA certificates. Note: The zero-length OCTET STRING is to be returned, on reads, if the CA certificate thumb print is not retained in the CCAP Core.

11.4.1.3 ServerCert This object reports information on the CCAP Core Certificate. Reference: Certificate Hierarchy and Profiles section of [R-PHY], CCAP Core Group Objects [DOCS-RPHY-SEC- MIB]. Table 287 - ServerCert Object Attributes

Attribute Name Type Access Type Constraints Units Subject AdminString Read-only SIZE(1..64) N/A Issuer AdminString Read-only N/A SerialNumber HexBinary Read-only SIZE (1..32) N/A Source Enum Read-only snmp(1), N/A configurationFile(2), externalDatabase(3), other(4), authentInfo(5), compiledIntoCode(6) Cert DocsX509ASN1DEREncodedCertificate Read-only N/A CertThumbprint HexBinary Read-only SIZE (20) N/A

11.4.1.3.1 Subject This attribute represents the subject name exactly as it is encoded in the X509 certificate. The organizationName portion of the certificate's subject name is to be present. All other fields are optional. Any optional field present is to be prepended with (carriage return, U+000D) (line feed, U+000A). Ordering of fields present is to conform to the following: organizationName countryName stateOrProvinceName localityName organizationalUnitName organizationalUnitName= commonName

11.4.1.3.2 Issuer This attribute represents the issuer name exactly as it is encoded in the X509 certificate. The commonName portion of the certificate's issuer name is to be present. All other fields are optional. Any optional field present is to be prepended with (carriage return, U+000D) (line feed, U+000A). Ordering of fields present is to conform to the following: commonName countryName stateOrProvinceName localityName organizationalUnitName organizationalUnitName=

 09/03/21 CableLabs 289 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

11.4.1.3.3 SerialNumber This attribute represents the certificate's serial number, represented as an octet string.

11.4.1.3.4 Source This attribute indicates how the certificate reached the CCAP Core. Other (4) means that it originated from a source not identified above.

11.4.1.3.5 Cert This attribute represents an X509 DER-encoded CCAP Core certificate.

11.4.1.3.6 CertThumbprint This attribute represents the SHA-1 hash of the CCAP Core certificate.

11.4.1.4 ProvisionedDeviceCertTrust This object provides trust states for RPD device certificates as provisioned at the CCAP Core. This object supports the creation and deletion of multiple instances. Reference: docsBpi2CmtsProvisionedCmCertTable [RFC 4131]. Table 288 - ProvisionedDeviceCertTrust Object Attributes

Attribute Name Type Access Type Constraints Units DeviceMacAddress MacAddress Key N/A Trust Enum Read-create trusted(1), N/A untrusted(2) Source Enum Read-only snmp(1), N/A configurationFile(2), externalDatabase(3), other(4) DeviceCert DocsX509ASN1DEREncodedCertificate Read-create N/A DeviceType Enum Read-only cm(1), rpd(2)

11.4.1.4.1 DeviceMacAddress This key attribute represents the RpdUniqueId.

11.4.1.4.2 Trust This attribute configures the trust state for the provisioned RPD certificate entry.

11.4.1.4.3 Source This attribute indicates how the certificate reached the CCAP Core. Other (4) means that it originated from a source not identified above.

11.4.1.4.4 DeviceCert This attribute configures an X509 DER-encoded Certificate Authority certificate for the RPD Device Certificate. Note: The zero-length OCTET STRING is to be returned, on reads, if the entire certificate is not retained in the CCAP Core.

11.4.1.4.5 DeviceType This attribute indicates the device type for the provisioned certificate.

290 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

11.4.2 CCAP Core RPD Security Management Information Model The RPD objects for Security Management, as managed by the CCAP Core, are shown in Figure 33.

Figure 33 - CCAP Core RPD Security Management Information Model

11.4.2.1 RpdInfo The RpdInfo object serves as the root of the CCAP Core RPD Security Management Information Model. The attributes in the RpdInfo object are defined in detail in Section 7.1.3.2. Table 289 - RpdInfo Object Associations

Associated Object Name Type Near-end Far-end Label Multiplicity Multiplicity RpdCert Directed composition to RpdCert 1 1 TrustAnchorCert Directed composition to TrustAnchorCert 1 1..* Ieee8021xPaeSupplicantStatus Directed composition to 1 1 Ieee8021xPaeSupplicantStatus

11.4.2.2 RpdCert This object describes the set of known Certificate Authority certificates acquired by the RPD. The RpdCert TLV Type is 100.26. Reference: Certificate Hierarchy and Profiles section of [R-PHY]. Table 290 - RpdCert Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length DeviceCert DocsX509ASN1DEREncodedCertificate Read-only N/A 100.26.1 4096 SigningCaCert DocsX509ASN1DEREncodedCertificate Read-only N/A 100.26.2 4096

11.4.2.2.1 DeviceCert This attribute represents the X509 DER-encoded RPD device certificate.

11.4.2.2.2 SigningCaCert This attribute represents the X509 DER-encoded CA certificate that signed the RPD device certificate.

 09/03/21 CableLabs 291 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

11.4.2.3 TrustAnchorCert This object describes the set of known Certificate Authority certificates used to validate certificates. The TrustAnchorCert TLV Type is 100.27. Reference: Certificate Hierarchy and Profiles section of [R-PHY]. Table 291 - TrustAnchorCert Object Attributes

Attribute Type Access Type Units TLV TLV Value Name Constraints Type Field Length Index UnsignedInt Key 1..4294967295 N/A 100.27.1 4 CaCert DocsX509ASN1DEREncodedCertificate Read-only N/A 100.27.2 4096

11.4.2.3.1 Index This key attribute uniquely identifies the trust anchor Certification Authority certificate.

11.4.2.3.2 CaCert This attribute represents the X509 DER-encoded trust anchor CA certificate used to validate certificates received from the CCAP Core or AAA server.

11.4.2.4 Ieee8021xPaeSupplicantStatus This object reports status information for the IEEE 802.1x PAE RPD supplicant. The Ieee8021xPaeSupplicantStatus TLV Type is 100.30.

References: [IEEE 802.1x], [R-PHY] Table 292 - Ieee8021xPaeSupplicantStatus Object Attributes

Attribute Type Access Type Units TLV Type TLV Value Field Name Constraints Length PortNumber UnsignedByte Key N/A 100.30.1 1 Authenticated Boolean Read-only N/A 100.30.2 1 Failed Boolean Read-only N/A 100.30.3 1 RetryCount Gauge32 Read-only “times” 100.30.4 4

11.4.2.4.1 PortNumber This attribute reports the zero-based index on the RPD of an ethernet port operating as a supplicant PAE.

11.4.2.4.2 Authenticated This attribute will be set 'true' by PACP if the PAE supplicant currently authenticated, and 'false' if the authentication fails or is revoked.

11.4.2.4.3 Failed This attribute will be set 'true' by PACP if the authentication has failed or has been terminated. The cause could be a failure returned by EAP, either immediately or following a reauthentication, an excessive number of attempts to authenticate (either immediately or upon reauthentication). The PACP will set the attribute Authenticated false as well as setting this attribute 'true'.

11.4.2.4.4 RetryCount This attribute reports the count of the number of authentication attempts.

292 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Annex A Detailed MIB Requirements (Normative) This Annex defines the SNMP MIB modules and MIB objects required for CCAP Core and RPD devices. Refer to Section 2.1 for the associated MIB module files. Table 293 - MIB Implementation Support

Requirement Type Table Notation Description Deprecated D Deprecated objects are optional. If a vendor chooses to implement the object, the object is expected to be implemented correctly according to the MIB definition. If a vendor chooses not to implement the object, an agent is expected to respond with the appropriate error/exception condition (e.g., 'noSuchObject' for SNMPv2c). Mandatory M The object is expected to be implemented correctly according to the MIB definition. Not Applicable NA Not applicable to the device. Not Supported N-Sup An agent is expected to respond with the appropriate error/exception condition (e.g., 'noSuchObject' for SNMPv2c). Optional O A vendor can choose to implement or not implement the object. If a vendor chooses to implement the object, the object is expected to be implemented correctly according to the MIB definition. If a vendor chooses not to implement the object, an agent is expected to respond with the appropriate error/exception condition (e.g., 'noSuchObject' for SNMPv2c). Obsolete Ob In SNMP convention, obsolete objects should not be implemented. This specification allows vendors to implement or not implement obsolete objects. If a vendor chooses to implement an obsoleted object, the object is expected to be implemented correctly according to the MIB definition. If a vendor chooses not to implement the obsoleted object, the SNMP agent is expected to respond with the appropriate error/exception condition (e.g., 'noSuchObject' for SNMPv2c).

Table 294 - SNMP Access Requirements

SNMP Access Type Table Notation Description Not Accessible N-Acc The object is not accessible and is usually an index in a table Read Create RC The access of the object is implemented as Read-Create Read Write RW The access of the object is implemented as Read-Write Read Only RO The access of the object is implemented as Read-Only Read Create or RC/RO The access of the object is implemented as either Read-Create or Read-Only as Read Only described in the MIB definition Read Create or RC/RW The access of the object is implemented as either Read-Create or Read-Write as Read Write described in the MIB definition Read Write or RW/RO The access of the object is implemented as either Read-Write or Read-Only as Read Only described in the MIB definition Accessible for SNMP Acc-FN These objects are used for SNMP Notifications by the CCAP Core SNMP Agent Notifications

A.1 CCAP Core MIB Object Details The CCAP Core is required to support the MIBs detailed in [CCAP-OSSIv4.0]. In addition, the CCAP Core will support the MIBs as detailed in Table 295. Table 295 - CCAP Core MIB Object Details

BFD-STD-MIB Object CCAP Core Access Additional Details in future version of specification

 09/03/21 CableLabs 293 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

A.2 DOCS-RPHY-MIB Object Details Table 296 provides the DOCSIS RPHY MIB object requirements for a CCAP Core. Table 296 - DOCS-RPHY-MIB CCAP Core Object Details

Object CCAP Core Access docsRphyRpdDevInfoTable M N-Acc docsRphyRpdDevInfoEntry M N-Acc docsRphyRpdDevInfoUniqueId M N-Acc docsRphyRpdDevInfoSysUpTime M RO docsRphyRpdDevInfoNumCrashFilesAvail M RO docsRphyRpdDevInfoPrincipalCoreStatus M RO docsRphyRpdDevIdentificationTable M N-Acc docsRphyRpdDevIdentificationEntry M N-Acc docsRphyRpdDevIdVendorName M RO docsRphyRpdDevIdVendorId M RO docsRphyRpdDevIdModelNum M RO docsRphyRpdDevIdSerialNum M RO docsRphyRpdDevIdDeviceAlias M RO docsRphyRpdDevIdDeviceDescr M RO docsRphyRpdDevIdHwRev M RO docsRphyRpdDevIdCurrSwVer M RO docsRphyRpdDevIdBootRomVer M RO docsRphyRpdDevIdUsBurstRcvrVendorId M RO docsRphyRpdDevIdUsBurstRcvrModelNum M RO docsRphyRpdDevIdUsBurstRcvrDrivVer M RO docsRphyRpdDevIdUsBurstRcvrSerialNum M RO docsRphyRpdDevIdRpdRcpProtocolVer M RO docsRphyRpdDevIdRpdRcpSchemaVer M RO docsRphyRpdDevIdCurrSwImageLastUpdate M RO docsRphyRpdDevIdCurrSwImageName M RO docsRphyRpdDevIdCurrSwImageServerType M RO docsRphyRpdDevIdCurrSwImageServerAddress M RO docsRphyRpdDevIdCurrSwImageIndex M RO docsRphyRpdDevIdVspSelector M RO docsRphyRpdDevLocationTable M N-Acc docsRphyRpdDevLocationEntry M N-Acc docsRphyRpdDevLocationDescr M RO docsRphyRpdDevLocationLatitude M RO docsRphyRpdDevLocationLongitude M RO docsRphyRpdDevCoresConnectedTable M N-Acc docsRphyRpdDevCoresConnectedEntry M N-Acc docsRphyRpdDevCoresConnectedIndex M N-Acc docsRphyRpdDevCoresConnectedCoreId M RO docsRphyRpdDevCoresConnectedAddressType M RO docsRphyRpdDevCoresConnectedAddress M RO docsRphyRpdDevCoresConnectedIsPrincipal M RO docsRphyRpdDevCoresConnectedName M RO

294 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdDevCoresConnectedVendorId M RO docsRphyRpdDevCoresConnectedCoreMode M RO docsRphyRpdDevCoresConnectedInitConfigComplete M RO docsRphyRpdDevCoresConnectedCoreFunction M RO docsRphyRpdDevCoresConnectedAuxCoreRpdState M RO docsRphyRpdDevCoresConnectedResourceSetIndex M RO docsRphyRpdDevCoresConnectedGcpBackupConnectionConfig M RO docsRphyRpdDevCoresConnectedAuxCoreGcpConnectionStatus D RO docsRphyRpdDevCoresConnectedGcpConnectionStatus M RO docsRphyRpdDevCoresConnectedGcpBackupCoreStatus M RO docsRphyRpdDevCoresConnectedAuthenticationStatus M RO docsRphyRpdDevCapabilitiesTable M N-Acc docsRphyRpdDevCapabilitiesEntry M N-Acc docsRphyRpdDevCapabNumDsPorts M RO docsRphyRpdDevCapabNumUsPorts M RO docsRphyRpdDevCapabNumTenGeNsPorts M RO docsRphyRpdDevCapabNumOneGeNsPorts M RO docsRphyRpdDevCapabNumDsScQamChans M RO docsRphyRpdDevCapabNumDsOfdmChans M RO docsRphyRpdDevCapabNumUsScQamChans M RO docsRphyRpdDevCapabNumUsOfdmaChans M RO docsRphyRpdDevCapabNumDsOob55d1Chans M RO docsRphyRpdDevCapabNumUsOob55d1Chans M RO docsRphyRpdDevCapabNumDsOob55d2Modules M RO docsRphyRpdDevCapabNumUsOob55d2Demods M RO docsRphyRpdDevCapabNumNdfChans M RO docsRphyRpdDevCapabNumNdrChans M RO docsRphyRpdDevCapabSupportsUdpEncap M RO docsRphyRpdDevCapabNumDsPspFlowsPerChan M RO docsRphyRpdDevCapabNumUsPspFlowsPerChan M RO docsRphyRpdDevCapabNumAsynchVideoChans M RO docsRphyRpdDevCapabNumCwToneGens M RO docsRphyRpdDevCapabLowestCwToneFreq M RO docsRphyRpdDevCapabHighestCwToneFreq M RO docsRphyRpdDevCapabMaxPwrDedCwTone M RO docsRphyRpdDevCapabQamAsPilot M RO docsRphyRpdDevCapabSupportsFlowTags M RO docsRphyRpdDevCapabSupportsFreqTilt M RO docsRphyRpdDevCapabMaxTiltValue M RO docsRphyRpdDevCapabBufferDepthMonAlertSupp M RO docsRphyRpdDevCapabBufferDepthCfgSupp M RO docsRphyRpdDevCapabRpdUcdProcTime M RO docsRphyRpdDevCapabRpdUcdChgNullGrtTime M RO docsRphyRpdDevCapabMultiSectionTimingMerRep M RO docsRphyRpdDevCapabMinPwrDedCwTone M RO docsRphyRpdDevCapabMaxPwrQamCwTone M RO

 09/03/21 CableLabs 295 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdDevCapabMinPwrQamCwTone M RO docsRphyRpdDevCapabSupportsOpticalNodeRf M RO docsRphyRpdDevCapabMaxDsFrequency M RO docsRphyRpdDevCapabMinDsFrequency M RO docsRphyRpdDevCapabMaxBasePwr M RO docsRphyRpdDevCapabMinTiltValue M RO docsRphyRpdDevCapabMinPwrAdjustScQam M RO docsRphyRpdDevCapabMaxPwrAdjustScQam M RO docsRphyRpdDevCapabMinPwrAdjustOfdm M RO docsRphyRpdDevCapabMaxPwrAdjustOfdm M RO docsRphyRpdDevCapabVspSelector D RO docsRphyRpdDevCapabMinBaseUsPowerTarLevel M RO docsRphyRpdDevCapabMaxBaseUsPowerTarLevel M RO docsRphyRpdDevCapabMinTarRxPowerAdjustScqam M RO docsRphyRpdDevCapabMaxTarRxPowerAdjustScqam M RO docsRphyRpdDevCapabMinTarRxPowerAdjustOfdma M RO docsRphyRpdDevCapabMaxTarRxPowerAdjustOfdma M RO docsRphyRpdDevCapabMinTarRxPowerAdjustNdr M RO docsRphyRpdDevCapabMaxTarRxPowerAdjustNdr M RO docsRphyRpdDevCapabDsPspSegCount M RO docsRphyRpdDevCapabDirectDsFlowQueueMapping M RO docsRphyRpdDevCapabDsSchedulerPhbIdList M RO docsRphyRpdDevCapabRpdPendingEvRepQueueSize M RO docsRphyRpdDevCapabRpdLocalEventLogSize M RO docsRphyRpdDevCapabSupportsUsProfileQuery M RO docsRphyRpdDevCapabSupportsFlowTagIncrement M RO docsRphyRpdDevCapabMinBasePwr M RO docsRphyRpdDevCapabNumCoresSupported M RO docsRphyRpdDevChanReachabilityTable M N-Acc docsRphyRpdDevChanReachabilityEntry M N-Acc docsRphyRpdDevChanReachabilityEnetPortIndex M N-Acc docsRphyRpdDevChanReachabilityRfPortIndex M N-Acc docsRphyRpdDevChanReachabilityChanType M N-Acc docsRphyRpdDevChanReachabilityStartChanIndex M N-Acc docsRphyRpdDevChanReachabilityEndChanIndex M RO docsRphyRpdDevDsUsRfPortAllocTable M N-Acc docsRphyRpdDevDsUsRfPortAllocEntry M N-Acc docsRphyRpdDevDsUsRfPortAllocIndex M N-Acc docsRphyRpdDevDsUsRfPortAllocDirection M N-Acc docsRphyRpdDevDsUsRfPortAllocScQamChans M RO docsRphyRpdDevDsUsRfPortAllocOfdmChans M RO docsRphyRpdDevDsUsRfPortAllocOob551Chans M RO docsRphyRpdDevDsUsRfPortAllocNdChans M RO docsRphyRpdDevDsUsRfPortAllocBdrs M RO docsRphyRpdDevDsUsRfPortAllocConfiguredBcgs M RO docsRphyRpdDevL2tpSessionInfoTable M N-Acc

296 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdDevL2tpSessionInfoEntry M N-Acc docsRphyRpdDevL2tpSessionInfoSessionIpAddrType M N-Acc docsRphyRpdDevL2tpSessionInfoCcapLcceIpAddr M N-Acc docsRphyRpdDevL2tpSessionInfoRpdLcceIpAddr M N-Acc docsRphyRpdDevL2tpSessionInfoDirection M N-Acc docsRphyRpdDevL2tpSessionInfoL2tpSessionId M N-Acc docsRphyRpdDevL2tpSessionInfoCoreId M RO docsRphyRpdDevL2tpSessionInfoConnCtrlID M RO docsRphyRpdDevL2tpSessionInfoUdpPort M RO docsRphyRpdDevL2tpSessionInfoDescr M RO docsRphyRpdDevL2tpSessionInfoSessionType M RO docsRphyRpdDevL2tpSessionInfoSessionSubType M RO docsRphyRpdDevL2tpSessionInfoMaxPayload M RO docsRphyRpdDevL2tpSessionInfoPathPayload M RO docsRphyRpdDevL2tpSessionInfoRpdIfMtu M RO docsRphyRpdDevL2tpSessionInfoCoreIfMtu M RO docsRphyRpdDevL2tpSessionInfoErrorCode M RO docsRphyRpdDevL2tpSessionInfoCreationTime M RO docsRphyRpdDevL2tpSessionInfoOperStatus M RO docsRphyRpdDevL2tpSessionInfoLocalStatus M RO docsRphyRpdDevL2tpSessionInfoLastChange M RO docsRphyRpdDevL2tpSessionInfoExtendedRemoteEndId M RO docsRphyRpdDevL2tpSessionStatsTable M N-Acc docsRphyRpdDevL2tpSessionStatsEntry M N-Acc docsRphyRpdDevL2tpSessionStatsOutOfSeqPkts M RO docsRphyRpdDevL2tpSessionStatsInPkts M RO docsRphyRpdDevL2tpSessionStatsInDiscards M RO docsRphyRpdDevL2tpSessionStatsOutPkts M RO docsRphyRpdDevL2tpSessionStatsOutErrors M RO docsRphyRpdDevL2tpSessionStatsCounterDiscontinuityTime M RO docsRphyRpdDevDiagStatusTable M N-Acc docsRphyRpdDevDiagStatusEntry M N-Acc docsRphyRpdDevDiagStatusProbableCause M RO docsRphyRpdDevDiagStatusAdditionalText M RO docsRphyRpdDevDiagStatusSeverityLevel M RO docsRphyRpdDevDepiMcastSessionTable M N-Acc docsRphyRpdDevDepiMcastSessionEntry M N-Acc docsRphyRpdDevDepiMcastSessionIpAddrType M N-Acc docsRphyRpdDevDepiMcastSessionGrpIpAddr M N-Acc docsRphyRpdDevDepiMcastSessionSrcIpAddr M N-Acc docsRphyRpdDevDepiMcastSessionL2tpSessionId M N-Acc docsRphyRpdDevDepiMcastSessionRpdLcceIpAddr M RO docsRphyRpdDevDepiMcastSessionCcapLcceIpAddr M RO docsRphyRpdDevDepiMcastSessionJoinTime M RO docsRphyRpdDevEventLogTable M N-Acc docsRphyRpdDevEventLogEntry M N-Acc

 09/03/21 CableLabs 297 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdDevEventLogIndex M N-Acc docsRphyRpdDevEventLogFirstTime M RO docsRphyRpdDevEventLogLastTime M RO docsRphyRpdDevEventLogCounts M RO docsRphyRpdDevEventLogLevel M RO docsRphyRpdDevEventLogId M RO docsRphyRpdDevEventLogText M RO docsRphyRpdDevOob551UsChanStatusTable M N-Acc docsRphyRpdDevOob551UsChanStatusEntry M N-Acc docsRphyRpdDevOob551UsChanStatusRfPort M N-Acc docsRphyRpdDevOob551UsChanStatusChannelId M N-Acc docsRphyRpdDevOob551UsChanStatusNcIpAddr M RO docsRphyRpdDevOob551UsChanStatusArpdSrcIpAddr M RO docsRphyRpdDevOob551UsChanStatusPerfectCellsRcvd M RO docsRphyRpdDevOob551UsChanStatusCorrectedCellsRcvd M RO docsRphyRpdDevOob551UsChanStatusUncorrectableCellsRcvd M RO docsRphyRpdDevOob551UsChanStatusTotalCellsRcvd M RO docsRphyRpdDevOob551UsChanStatusPwrLevel M RO docsRphyRpdDevOob551UsChanStatusMaxPwrLevel M RO docsRphyRpdDevOob551UsChanStatusMinPwrLevel M RO docsRphyRpdDevOob551UsChanStatusCounterDiscontinuityTime M RO docsRphyRpdDevCrashDataFileStatusTable M N-Acc docsRphyRpdDevCrashDataFileStatusEntry M N-Acc docsRphyRpdDevCrashDataFileStatusIndex M N-Acc docsRphyRpdDevCrashDataFileStatusFilename M RO docsRphyRpdDevCrashDataFileStatusFileStatus M RO docsRphyRpdDevUsSignalQualityTable M N-Acc docsRphyRpdDevUsSignalQualityEntry M N-Acc docsRphyRpdDevUsSignalQualityRfPort M N-Acc docsRphyRpdDevUsSignalQualityChannelIfIndex M N-Acc docsRphyRpdDevUsSignalQualityRxMer M RO docsRphyRpdDevUsSignalQualityRxMerSamples M RO docsRphyRpdDevUsSignalQualityUnerroreds M RO docsRphyRpdDevUsSignalQualityCorrecteds M RO docsRphyRpdDevUsSignalQualityUncorrectables M RO docsRphyRpdDevHostResSysTable M N-Acc docsRphyRpdDevHostResSysEntry M N-Acc docsRphyRpdDevHostResSysDate M RO docsRphyRpdDevHostResStorTable M N-Acc docsRphyRpdDevHostResStorEntry M N-Acc docsRphyRpdDevHostResStorIndex M N-Acc docsRphyRpdDevHostResStorType M RO docsRphyRpdDevHostResStorAllocationUnits M RO docsRphyRpdDevHostResStorAllocationFailures M RO docsRphyRpdDevHostResStorSize M RW docsRphyRpdDevHostResStorUsed M RO

298 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdDevHostResStorDescr M RO docsRphyRpdDevHostResSwRunTable M N-Acc docsRphyRpdDevHostResSwRunEntry M N-Acc docsRphyRpdDevHostResSwRunIndex M N-Acc docsRphyRpdDevHostResSwRunType M RO docsRphyRpdDevHostResSwRunStatus M RO docsRphyRpdDevHostResSwRunPerfCpu M RO docsRphyRpdDevHostResSwRunPerfMem M RO docsRphyRpdDevHostResSwRunName M RO docsRphyRpdDevStaticPwCapTable M N-Acc docsRphyRpdDevStaticPwCapEntry M N-Acc docsRphyRpdDevStaticPwCapMaxFwdStaticPws M RO docsRphyRpdDevStaticPwCapMaxRetStaticPws M RO docsRphyRpdDevStaticPwCapSupportsStaticMptDepiPw M RO docsRphyRpdDevStaticPwCapSupportsStaticMpt55d1RetPw M RO docsRphyRpdDevStaticPwCapSupportsStaticPspNdfPw M RO docsRphyRpdDevStaticPwCapSupportsStaticPspNdrPw M RO docsRphyRpdDevStaticPwCapMaxUcastFwdStaticPws M RO docsRphyRpdDevStaticPwCapSupportsStaticPspNdfUcastPw M RO docsRphyRpdDevStaticPwCapSupportsStaticPspPnmPw M RO docsRphyRpdDevStaticPwCapSupportsStaticPspSpecmanPw M RO docsRphyRpdDevExtSwImageSupportTable M N-Acc docsRphyRpdDevExtSwImageSupportEntry M N-Acc docsRphyRpdDevExtSwImageSupportSwImageIndex M N-Acc docsRphyRpdDevExtSwImageSupportSwImageLastUpdate M RO docsRphyRpdDevExtSwImageSupportSwImageName M RO docsRphyRpdDevExtSwImageSupportSwImageDescr M RO docsRphyRpdDevExtSwImageSupportSwImageServerType M RO docsRphyRpdDevExtSwImageSupportSwImageServerAddress M RO docsRphyRpdDevSwImageCapTable M N-Acc docsRphyRpdDevSwImageCapEntry M N-Acc docsRphyRpdDevSwImageCapNumSwImages M RO docsRphyRpdDevSwImageCapImageUpgradeability M RO docsRphyRpdDevGcpCapTable M N-Acc docsRphyRpdDevGcpCapEntry M N-Acc docsRphyRpdDevGcpCapGcpKaResponseTime M RO docsRphyRpdDevOfdmCfgCapTable M N-Acc docsRphyRpdDevOfdmCfgCapEntry M N-Acc docsRphyRpdDevOfdmCfgCapReqOfdmaImDurationCfg M RO docsRphyRpdDevOfdmCfgCapSupportedPilotPatterns M RO docsRphyRpdDevOfdmCfgCapNumDsOfdmProfiles M RO docsRphyRpdDevOfdmCfgCapOptionalOfdmModulations M RO docsRphyRpdDevOfdmCfgCapOptionalOfdmaModulations M RO docsRphyRpdDevCoreRedundancyCapTable M N-Acc docsRphyRpdDevCoreRedundancyCapEntry M N-Acc docsRphyRpdDevCoreRedundancyCapSupportsRedundancy M RO

 09/03/21 CableLabs 299 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdDevResetCapTable M N-Acc docsRphyRpdDevResetCapEntry M N-Acc docsRphyRpdDevResetCapSupportsReset M RO docsRphyRpdDevResetCapResetHistorySize M RO docsRphyRpdDevFdxCapTable M N-Acc docsRphyRpdDevFdxCapEntry M N-Acc docsRphyRpdDevFdxCapSupportsFdx M RO docsRphyRpdDevFdxCapSupportsZblInsertion M RO docsRphyRpdDevFdxCapZblInsMsgLeadTime M RO docsRphyRpdDevRdtiCapTable M N-Acc docsRphyRpdDevRdtiCapEntry M N-Acc docsRphyRpdDevRdtiCapNumPtpPortsPerEnetPort M RO docsRphyRpdDevRdtiCapSupportsSynce M RO docsRphyRpdDevDsCapTable M N-Acc docsRphyRpdDevDsCapEntry M N-Acc docsRphyRpdDevDsCapScQamInterleaverSupport M RO docsRphyRpdDevDsCapMaxDocsisScQamChannels M RO docsRphyRpdDevDsCapMaxMultipleScQamPspSessions M RO docsRphyRpdDevDsCapMaxNumBdrs M RO docsRphyRpdDevDsCapMaxNumBcgs M RO docsRphyRpdDevDsCapSupportsDsScQamModulationQam128 M RO docsRphyRpdDevSpecCaptureCapTable M N-Acc docsRphyRpdDevSpecCaptureCapEntry M N-Acc docsRphyRpdDevSpecCaptureCapNumSacs M RO docsRphyRpdDevSacCapTable M N-Acc docsRphyRpdDevSacCapEntry M N-Acc docsRphyRpdDevSacCapSacIndex M N-Acc docsRphyRpdDevSacCapSacDescription M RO docsRphyRpdDevSacCapMaxCaptureSpan M RO docsRphyRpdDevSacCapMinCaptureFreq M RO docsRphyRpdDevSacCapMaxCaptureFreq M RO docsRphyRpdDevSacCapSuppTriggerModes M RO docsRphyRpdDevSacCapSuppOutputFormats M RO docsRphyRpdDevSacCapSuppWindowFormats M RO docsRphyRpdDevSacCapSuppAveraging M RO docsRphyRpdDevSacCapSuppAggrMethods M RO docsRphyRpdDevSacCapSuppSpecQual M RO docsRphyRpdDevSacCapMaxNumBins M RO docsRphyRpdDevSacCapMinNumBins M RO docsRphyRpdDevSacCapMinRepeatPeriod M RO docsRphyRpdDevSacCapSuppTrigChanTypes M RO docsRphyRpdDevSacCapPwType M RO docsRphyRpdDevSacCapLowestCapturePort M RO docsRphyRpdDevSacCapHighestCapturePort M RO docsRphyRpdDevSacCapSuppScanCapture M RO docsRphyRpdDevSacCapMinScanRepeatPeriod M RO

300 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdDevCandidateBackupCoresTable M N-Acc docsRphyRpdDevCandidateBackupCoresEntry M N-Acc docsRphyRpdDevCandidateBackupCoresBackupCoreIpAddrIndex M N-Acc docsRphyRpdDevCandidateBackupCoresBackupCoreAddrType M RO docsRphyRpdDevCandidateBackupCoresBackupCoreAddr M RO docsRphyRpdDevShelfInfoTable M N-Acc docsRphyRpdDevShelfInfoEntry M N-Acc docsRphyRpdDevShelfInfoShelfId M N-Acc docsRphyRpdDevShelfInfoRpdSlot M RO docsRphyRpdDevPmapCapTable M N-Acc docsRphyRpdDevPmapCapEntry M N-Acc docsRphyRpdDevPmapCapMaxNumPmaples M RO docsRphyRpdDevPmapCapProbePowerControl M RO docsRphyRpdDevEchoCanCapTable M N-Acc docsRphyRpdDevEchoCanCapEntry M N-Acc docsRphyRpdDevEchoCanCapEctMethod M RO docsRphyRpdDevEchoCanCapMaxEctChannels M RO docsRphyRpdDevEchoCanCapMinEctPeriod M RO docsRphyRpdDevEchoCanCapMaxEctPeriod M RO docsRphyRpdDevEchoCanCapMinEctoDuration M RO docsRphyRpdDevEchoCanCapMaxEctoDuration M RO docsRphyRpdDevEchoCanCapPerSubbandCtrl M RO docsRphyRpdDevEchoCanCapErdDuration M RO docsRphyRpdDevEchoCanCapInitialEcTrainingTime M RO docsRphyRpdDevRfmCapTable M N-Acc docsRphyRpdDevRfmCapEntry M N-Acc docsRphyRpdDevRfmCapSupportsRfmMgmt M RO docsRphyRpdDevRfmCapNumNodeRfPorts M RO docsRphyRpdDevRfmCapSupportsDsCfgRfmGain M RO docsRphyRpdDevRfmCapMinDsCfgRfmGain M RO docsRphyRpdDevRfmCapMaxDsCfgRfmGain M RO docsRphyRpdDevRfmCapSupportsUsCfgRfmGain M RO docsRphyRpdDevRfmCapMinUsCfgRfmGain M RO docsRphyRpdDevRfmCapMaxUsCfgRfmGain M RO docsRphyRpdDevRfmCapSupportsRfmDsTiltConfig M RO docsRphyRpdDevRfmCapMinRfmDsTilt M RO docsRphyRpdDevRfmCapMaxRfmDsTilt M RO docsRphyRpdDevRfmCapMaxDsPowerGainFunctions M RO docsRphyRpdDevRfmCapMaxUsPowerGainFunctions M RO docsRphyRpdDevRfmCapMaxDsTiltCtrlFunctions M RO docsRphyRpdDevRfmCapMinRfmDsFreq M RO docsRphyRpdDevRfmCapMaxRfmDsFreq M RO docsRphyRpdDevNodeRfPortCapTable M N-Acc docsRphyRpdDevNodeRfPortCapEntry M N-Acc docsRphyRpdDevNodeRfPortCapNodeRfPortIndex M N-Acc docsRphyRpdDevNodeRfPortCapNodeRfPortVendorDesc M RO

 09/03/21 CableLabs 301 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdDevNodeRfPortCapRpdUsRfPortMap M RO docsRphyRpdDevNodeRfPortCapRpdDsRfPortMap M RO docsRphyRpdDevNodeRfPortCapRfmUsGainCtrlIndex M RO docsRphyRpdDevNodeRfPortCapRfmDsGainCtrlIndex M RO docsRphyRpdDevNodeRfPortCapRfmDsTiltCtrlIndex M RO docsRphyRpdDevNodeRfPortCapNodeRfPortOpLabel M RO docsRphyRpdDevResetHistoryTable M N-Acc docsRphyRpdDevResetHistoryEntry M N-Acc docsRphyRpdDevResetHistoryIndex M N-Acc docsRphyRpdDevResetHistoryResetTimestamp M RO docsRphyRpdDevResetHistoryType M RO docsRphyRpdDevResetHistoryReason M RO docsRphyRpdDevResetHistoryEventIdRef M RO docsRphyRpdDevResetHistoryEventDescription M RO docsRphyRpdDevResetHistoryRecoveryTime M RO docsRphyRpdDevResetHistoryPrincipalOpTimestamp M RO docsRphyRpdDevChanBcastGroupStatusTable M N-Acc docsRphyRpdDevChanBcastGroupStatusEntry M N-Acc docsRphyRpdDevChanBcastGroupStatusRfPortIndex M N-Acc docsRphyRpdDevChanBcastGroupStatusScQamIndex M N-Acc docsRphyRpdDevChanBcastGroupStatusGroupMember M RO docsRphyRpdDevUsCapTable M N-Acc docsRphyRpdDevUsCapEntry M N-Acc docsRphyRpdDevUsCapMaxUsFrequency M RO docsRphyRpdDevUsCapMinUsFrequency M RO docsRphyRpdDevUsCapMaxUnicastSids M RO docsRphyRpdDevPmtudCapTable M N-Acc docsRphyRpdDevPmtudCapEntry M N-Acc docsRphyRpdDevPmtdudCapSupportsIcmpBasedPmtud M RO docsRphyRpdDevPmtdudCapSupportsPacketizationBasedPmtud M RO docsRphyRpdDevPnmCapTable M N-Acc docsRphyRpdDevPnmCapEntry M N-Acc docsRphyRpdDevPnmCapSupportedPnmTests M RO docsRphyRpdDevInitCapTable M N-Acc docsRphyRpdDevInitCapEntry M N-Acc docsRphyRpdDevInitCapPerCoreInitTimers M RO docsRphyRpdDevInitCapStagingConfigInitTimers M RO docsRphyRpdDevUsPowerCapTable M N-Acc docsRphyRpdDevUsPowerCapEntry M N-Acc docsRphyRpdDevUsPowerCapMinTarRxPowerAdjust55d2 M RO docsRphyRpdDevUsPowerCapMaxTarRxPowerAdjust55d2 M RO docsRphyRpdDevUpcCapTable M N-Acc docsRphyRpdDevUpcCapEntry M N-Acc docsRphyRpdDevUpcCapMinNumSymbols25Khz M RO docsRphyRpdDevUpcCapMaxNumSymbols25Khz M RO docsRphyRpdDevUpcCapMinNumSymbols50Khz M RO

302 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdDevUpcCapMaxNumSymbols50Khz M RO docsRphyRpdDevUpcCapSupportsStaggeredPies M RO docsRphyRpdDevUpcCapSupportsDedicatedPwUpcRxMer M RO docsRphyRpdDevUpcCapSupportsFreqDomainSamples M RO docsRphyRpdIfPhysEntityTable M N-Acc docsRphyRpdIfPhysEntityEntry M N-Acc docsRphyRpdIfPhysEntityIndex M N-Acc docsRphyRpdIfPhysEntityDescr M RO docsRphyRpdIfPhysEntityVendorType M RO docsRphyRpdIfPhysEntityContainedIn M RO docsRphyRpdIfPhysEntityClass M RO docsRphyRpdIfPhysEntityParentRelPos M RO docsRphyRpdIfPhysEntityName M RO docsRphyRpdIfPhysEntityHardwareRev M RO docsRphyRpdIfPhysEntityFirmwareRev M RO docsRphyRpdIfPhysEntitySoftwareRev M RO docsRphyRpdIfPhysEntitySerialNum M RO docsRphyRpdIfPhysEntityMfgName M RO docsRphyRpdIfPhysEntityModelName M RO docsRphyRpdIfPhysEntityAlias M RO docsRphyRpdIfPhysEntityAssetID M RO docsRphyRpdIfPhysEntityIsFRU M RO docsRphyRpdIfPhysEntityMfgDate M RO docsRphyRpdIfPhysEntityUris M RO docsRphyRpdIfPhysEntityUUID M RO docsRphyRpdIfPhysEntSensorTable M N-Acc docsRphyRpdIfPhysEntSensorEntry M N-Acc docsRphyRpdIfPhysEntSensorType M RO docsRphyRpdIfPhysEntSensorScale M RO docsRphyRpdIfPhysEntSensorPrecision M RO docsRphyRpdIfPhysEntSensorValue M RO docsRphyRpdIfPhysEntSensorOperStatus M RO docsRphyRpdIfPhysEntSensorUnitsDisplay M RO docsRphyRpdIfPhysEntSensorValueTimeStamp M RO docsRphyRpdIfPhysEntSensorValueUpdateRate M RO docsRphyRpdIfEnetTable M N-Acc docsRphyRpdIfEnetEntry M N-Acc docsRphyRpdIfEnetPortIndex M N-Acc docsRphyRpdIfEnetDescr M RO docsRphyRpdIfEnetName M RO docsRphyRpdIfEnetAlias M RO docsRphyRpdIfEnetType M RO docsRphyRpdIfEnetMtu M RO docsRphyRpdIfEnetPhysAddress M RO docsRphyRpdIfEnetAdminStatus M RO docsRphyRpdIfEnetOperStatus M RO

 09/03/21 CableLabs 303 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdIfEnetLastChange M RO docsRphyRpdIfEnetLinkUpDownTrapEnable M RO docsRphyRpdIfEnetHighSpeed M RO docsRphyRpdIfEnetPromiscuousMode M RO docsRphyRpdIfEnetConnectorPresent M RO docsRphyRpdIfEnetNetworkAuthStatus M RO docsRphyRpdIfEnetStatsTable M N-Acc docsRphyRpdIfEnetStatsEntry M N-Acc docsRphyRpdIfEnetStatsInOctets M RO docsRphyRpdIfEnetStatsOutOctets M RO docsRphyRpdIfEnetStatsInFrames M RO docsRphyRpdIfEnetStatsOutFrames M RO docsRphyRpdIfEnetStatsInUnicastOctets D RO docsRphyRpdIfEnetStatsOutUnicastOctets D RO docsRphyRpdIfEnetStatsInUnicastFrames M RO docsRphyRpdIfEnetStatsOutUnicastFrames M RO docsRphyRpdIfEnetStatsInMulticastOctets D RO docsRphyRpdIfEnetStatsOutMulticastOctets D RO docsRphyRpdIfEnetStatsInMulticastFrames M RO docsRphyRpdIfEnetStatsOutMulticastFrames M RO docsRphyRpdIfEnetStatsInBroadcastOctets D RO docsRphyRpdIfEnetStatsOutBroadcastOctets D RO docsRphyRpdIfEnetStatsInBroadcastFrames M RO docsRphyRpdIfEnetStatsOutBroadcastFrames M RO docsRphyRpdIfEnetStatsInDiscards M RO docsRphyRpdIfEnetStatsOutDiscards M RO docsRphyRpdIfEnetStatsInErrors M RO docsRphyRpdIfEnetStatsOutErrors M RO docsRphyRpdIfEnetStatsInUnknownProtos M RO docsRphyRpdIfEnetStatsCounterDiscontinuityTime M RO docsRphyRpdIfRpdEnetToCoreEntityMapTable M N-Acc docsRphyRpdIfRpdEnetToCoreEntityMapEntry M N-Acc docsRphyRpdIfRpdEnetToCoreEntityMapEntityIndex M RO docsRphyRpdIfCoreToRpdMapTable M N-Acc docsRphyRpdIfCoreToRpdMapEntry M N-Acc docsRphyRpdIfCoreToRpdMapRpdCoreIndex M N-Acc docsRphyRpdIfCoreToRpdMapRpdUniqueId M N-Acc docsRphyRpdIfCoreToRpdMapRpdRfPortDirection M N-Acc docsRphyRpdIfCoreToRpdMapRpdRfPortIndex M N-Acc docsRphyRpdIfCoreToRpdMapRpdRfChanType M RO docsRphyRpdIfCoreToRpdMapRpdRfChanIndex M RO docsRphyRpdIfRpdToCoreMapTable M N-Acc docsRphyRpdIfRpdToCoreMapEntry M N-Acc docsRphyRpdIfRpdToCoreMapRpdRfPortDirection M N-Acc docsRphyRpdIfRpdToCoreMapRpdRfPortIndex M N-Acc docsRphyRpdIfRpdToCoreMapRpdRfChanType M N-Acc

304 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdIfRpdToCoreMapRpdRfChanIndex M N-Acc docsRphyRpdIfRpdToCoreMapCoreIfIndex M RO docsRphyRpdIfEnetSfpPlusStatusTable M N-Acc docsRphyRpdIfEnetSfpPlusStatusEntry M N-Acc docsRphyRpdIfEnetSfpPlusStatusStatus M RO docsRphyRpdIfEnetSfpPlusStatusIdentifier M RO docsRphyRpdIfEnetSfpPlusStatusExtendedIdentifier M RO docsRphyRpdIfEnetSfpPlusStatusConnectorType M RO docsRphyRpdIfEnetSfpPlusStatusTransceiverComplianceCodes M RO docsRphyRpdIfEnetSfpPlusStatusTransceiverComplianceCode36 M RO docsRphyRpdIfEnetSfpPlusStatusEncoding M RO docsRphyRpdIfEnetSfpPlusStatusBitRateNominal M RO docsRphyRpdIfEnetSfpPlusStatusRateIdentifier M RO docsRphyRpdIfEnetSfpPlusStatusLengthKm M RO docsRphyRpdIfEnetSfpPlusStatusLength100M M RO docsRphyRpdIfEnetSfpPlusStatusLength50Mi10M M RO docsRphyRpdIfEnetSfpPlusStatusLength62Pt5Mi10M M RO docsRphyRpdIfEnetSfpPlusStatusLengthCopperM M RO docsRphyRpdIfEnetSfpPlusStatusLength50MiOm3 M RO docsRphyRpdIfEnetSfpPlusStatusVendorName M RO docsRphyRpdIfEnetSfpPlusStatusVendorOui M RO docsRphyRpdIfEnetSfpPlusStatusVendorPartNum M RO docsRphyRpdIfEnetSfpPlusStatusVendorSerialNum M RO docsRphyRpdIfEnetSfpPlusStatusVendorRev M RO docsRphyRpdIfEnetSfpPlusStatusLaserWavelength M RO docsRphyRpdIfEnetSfpPlusStatusOptions M RO docsRphyRpdIfEnetSfpPlusStatusBitRateMax M RO docsRphyRpdIfEnetSfpPlusStatusBitRateMin M RO docsRphyRpdIfEnetSfpPlusStatusVendorDate M RO docsRphyRpdIfEnetSfpPlusStatusVendorSpecificLotCode M RO docsRphyRpdIfEnetSfpPlusStatusDiagMonitorType M RO docsRphyRpdIfEnetSfpPlusStatusEnhancedOptions M RO docsRphyRpdIfEnetSfpPlusStatusSff8472Compliance M RO docsRphyRpdIfEnetSfpPlusStatusVendorSpecificData M RO docsRphyRpdIfEnetSfpPlusStatusMeasuredTxOutputPwr M RO docsRphyRpdIfEnetSfpPlusStatusMeasuredRxInputPwr M RO docsRphyRpdIfEnetSfpPlusStatusDigitalDiagA2Info M RO docsRphyRpdIfEnetSfpPlusStatusMeasuredTxBiasCurrent M RO docsRphyRpdIfEnetSfpPlusStatusMeasuredTemperature M RO docsRphyRpdIfEnetSfpPlusStatusMeasuredSupplyVoltage M RO docsRphyRpdIfEnetSyncEPortStatusTable O N-Acc docsRphyRpdIfEnetSyncEPortStatusEntry O N-Acc docsRphyRpdIfEnetSyncEPortStatusSignalQualified O RO docsRphyRpdIfEnetSyncEPortStatusReceivedSsm O RO docsRphyRpdIfRfmStatusTable M N-Acc docsRphyRpdIfRfmStatusEntry M N-Acc

 09/03/21 CableLabs 305 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyRpdIfRfmStatusReportedDsGain M RO docsRphyRpdIfRfmStatusReportedDsGainStatus M RO docsRphyRpdIfRfmStatusReportedUsGain M RO docsRphyRpdIfRfmStatusReportedUsGainStatus M RO docsRphyRpdIfRfmStatusReportedRfmDsTilt M RO docsRphyRpdIfRfmStatusReportedRfmDsTiltStatus M RO docsRphyRpdIfRfmStatusDsOutputPower M RO docsRphyRpdIfRfmStatusUsExpectedRxPower M RO docsRphyRpdIfRfmStatusTotalDsTilt M RO docsRphyRpdIpv4GrpTable O N-Acc docsRphyRpdIpv4GrpEntry O N-Acc docsRphyRpdIpv4GrpDefaultTTL O RO docsRphyRpdIpv4GrpInterfaceTableLastChange O RO docsRphyRpdIpv6GrpTable O N-Acc docsRphyRpdIpv6GrpEntry O N-Acc docsRphyRpdIpv6GrpIpDefaultHopLimit O RO docsRphyRpdIpv6GrpInterfaceTableLastChange O RO docsRphyRpdIpv6GrpIfStatsTableLastChange O RO docsRphyRpdIpv4InterfaceTable O N-Acc docsRphyRpdIpv4InterfaceEntry O N-Acc docsRphyRpdIpv4InterfaceEnableStatus O RO docsRphyRpdIpv4InterfaceRetransmitTime O RO docsRphyRpdIpv6InterfaceTable O N-Acc docsRphyRpdIpv6InterfaceEntry O N-Acc docsRphyRpdIpv6InterfaceIdentifier O RO docsRphyRpdIpv6InterfaceEnableStatus O RO docsRphyRpdIpv6InterfaceReachableTime O RO docsRphyRpdIpv6InterfaceRetransmitTime O RO docsRphyRpdIpIfStatsTable M N-Acc docsRphyRpdIpIfStatsEntry M N-Acc docsRphyRpdIpIfStatsIPVersion M N-Acc docsRphyRpdIpIfStatsInReceives M RO docsRphyRpdIpIfStatsInOctets M RO docsRphyRpdIpIfStatsInHdrErrors M RO docsRphyRpdIpIfStatsInNoRoutes M RO docsRphyRpdIpIfStatsInAddrErrors M RO docsRphyRpdIpIfStatsInUnknownProtos M RO docsRphyRpdIpIfStatsInTruncatedPkts M RO docsRphyRpdIpIfStatsInDiscards M RO docsRphyRpdIpIfStatsInDelivers M RO docsRphyRpdIpIfStatsOutRequests M RO docsRphyRpdIpIfStatsOutDiscards M RO docsRphyRpdIpIfStatsOutTransmits M RO docsRphyRpdIpIfStatsOutOctets M RO docsRphyRpdIpIfStatsInMcastPkts M RO docsRphyRpdIpIfStatsInMcastOctets M RO

306 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyRpdIpIfStatsOutMcastPkts M RO docsRphyRpdIpIfStatsOutMcastOctets M RO docsRphyRpdIpIfStatsDiscontinuityTime M RO docsRphyRpdIpIfStatsRefreshRate M RO docsRphyRpdIpAddressTable M N-Acc docsRphyRpdIpAddressEntry M N-Acc docsRphyRpdIpAddressAddrType M N-Acc docsRphyRpdIpAddressAddr M N-Acc docsRphyRpdIpAddressEnetPortIndex M RC docsRphyRpdIpAddressType M RC docsRphyRpdIpAddressPrefixLen M RO docsRphyRpdIpAddressOrigin M RO docsRphyRpdIpAddressStatus M RC docsRphyRpdIpAddressCreated M RO docsRphyRpdIpAddressLastChanged M RO docsRphyRpdIpNetToPhysicalTable M N-Acc docsRphyRpdIpNetToPhysicalEntry M N-Acc docsRphyRpdIpNetToPhysicalNetAddressType M N-Acc docsRphyRpdIpNetToPhysicalNetAddress M N-Acc docsRphyRpdIpNetToPhysicalPhysAddress M RC docsRphyRpdIpNetToPhysicalLastUpdated M RO docsRphyRpdIpNetToPhysicalType M RC docsRphyRpdIpNetToPhysicalState M RO docsRphyRpdIpDefaultRouterTable O N-Acc docsRphyRpdIpDefaultRouterEntry O N-Acc docsRphyRpdIpDefaultRouterAddressType O N-Acc docsRphyRpdIpDefaultRouterAddress O N-Acc docsRphyRpdIpDefaultRouterLifetime O RO docsRphyRpdIpDefaultRouterPreference O RO docsRphyRpdIpIcmpMsgStatsTable O N-Acc docsRphyRpdIpIcmpMsgStatsEntry O N-Acc docsRphyRpdIpIcmpMsgStatsIPVersion O N-Acc docsRphyRpdIpIcmpMsgStatsType O N-Acc docsRphyRpdIpIcmpMsgStatsInPkts O RO docsRphyRpdIpIcmpMsgStatsOutPkts O RO docsRphyCcapL2tpSessionInfoTable M N-Acc docsRphyCcapL2tpSessionInfoEntry M N-Acc docsRphyCcapL2tpSessionInfoSessionIpAddrType M N-Acc docsRphyCcapL2tpSessionInfoCcapLcceIpAddr M N-Acc docsRphyCcapL2tpSessionInfoRpdLcceIpAddr M N-Acc docsRphyCcapL2tpSessionInfoDirection M N-Acc docsRphyCcapL2tpSessionInfoL2tpSessionId M N-Acc docsRphyCcapL2tpSessionInfoCoreId M RO docsRphyCcapL2tpSessionInfoConnCtrlID M RO docsRphyCcapL2tpSessionInfoUdpPort M RO docsRphyCcapL2tpSessionInfoDescr M RO

 09/03/21 CableLabs 307 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyCcapL2tpSessionInfoSessionType M RO docsRphyCcapL2tpSessionInfoSessionSubType M RO docsRphyCcapL2tpSessionInfoMaxPayload M RO docsRphyCcapL2tpSessionInfoPathPayload M RO docsRphyCcapL2tpSessionInfoRpdIfMtu M RO docsRphyCcapL2tpSessionInfoCoreIfMtu M RO docsRphyCcapL2tpSessionInfoIncludeDOCSISMsgs M RO docsRphyCcapL2tpSessionInfoErrorCode M RO docsRphyCcapL2tpSessionInfoCreationTime M RO docsRphyCcapL2tpSessionInfoOperStatus M RO docsRphyCcapL2tpSessionInfoLocalStatus M RO docsRphyCcapL2tpSessionInfoLastChange M RO docsRphyCcapL2tpSessionInfoExtendedRemoteEndId M RO docsRphyCcapL2tpSessionFlowTable M N-Acc docsRphyCcapL2tpSessionFlowEntry M N-Acc docsRphyCcapL2tpSessionFlowPspFlowId M N-Acc docsRphyCcapL2tpSessionFlowPhbId M RO docsRphyCcapL2tpSessionStatsTable M N-Acc docsRphyCcapL2tpSessionStatsEntry M N-Acc docsRphyCcapL2tpSessionStatsOutOfSeqPkts M RO docsRphyCcapL2tpSessionStatsInPkts M RO docsRphyCcapL2tpSessionStatsInDiscards M RO docsRphyCcapL2tpSessionStatsOutPkts M RO docsRphyCcapL2tpSessionStatsOutErrors M RO docsRphyCcapCinDsLatencyTable O N-Acc docsRphyCcapCinDsLatencyEntry O N-Acc docsRphyCcapCinDsLatencyLastVal O RO docsRphyCcapCinDsLatencyLastValTime O RO docsRphyCcapCinDsLatencyInterval O RO docsRphyCcapSessionCinDsLatencyStatsTable O N-Acc docsRphyCcapSessionCinDsLatencyStatsEntry O N-Acc docsRphyCcapSessionCinDsLatencyStatsIntervalSeq O N-Acc docsRphyCcapSessionCinDsLatencyStatsVal O RO docsRphyCcapSessionCinDsLatencyStatsValTime O RO docsRphyCcapCwToneStatusTable M N-Acc docsRphyCcapCwToneStatusEntry M N-Acc docsRphyCcapCwToneStatusRfPort M N-Acc docsRphyCcapCwToneStatusFrequency M N-Acc docsRphyCcapCwToneStatusStatus M RO docsRphyCcapUsOfdmaFdxEcStatusTable M N-Acc docsRphyCcapUsOfdmaFdxEcStatusEntry M N-Acc docsRphyCcapUsOfdmaFdxEcStatusCurrentEctPeriod M RO docsRphyCcapUsOfdmaFdxEcStatusCurrentEctoDuration M RO docsRphyCcapUsOfdmaFdxEcStatusLastRequestEctPeriod M RO docsRphyCcapUsOfdmaFdxEcStatusLastRequestEctoDuration M RO docsRphyCcapUsOfdmaFdxEcStatusNumTxEctos M RO

308 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyCcapUsOfdmaFdxEcStatusNumRxEcRequestBlocks M RO docsRphyCcapUsOfdmaFdxEcStatusNumRxEcRequestBlocksNoConv M RO docsRphyCmtsCmRegStatusTable M N-Acc docsRphyCmtsCmRegStatusEntry M N-Acc docsRphyCmtsCmRegStatusRpdUniqueId M RO docsRphyCcapRpdToCmMapStatusTable M N-Acc docsRphyCcapRpdToCmMapStatusEntry M N-Acc docsRphyCcapRpdToCmMapStatusRpdUsRfPortNum M RO docsRphyCcapRpdToCmMapStatusRpdDsRfPortNum M RO

A.3 DOCS-RPHY-CTRL-MIB Object Details Table 297 - DOCS-RPHY-CTRL-MIB Object Details

Object CCAP Core Access docsRphyCtrlRpdResetCtrlTable M N-Acc docsRphyCtrlRpdResetCtrlEntry M N-Acc docsRphyCtrlRpdResetCtrlReset M RW docsRphyCtrlRpdLogCtrlTable M N-Acc docsRphyCtrlRpdLogCtrlEntry M N-Acc docsRphyCtrlRpdResetLog M RW docsRphyCtrlRpdSsdCtrlTable M N-Acc docsRphyCtrlRpdSsdCtrlEntry M N-Acc docsRphyCtrlRpdSsdCtrlServerAddressType M RW docsRphyCtrlRpdSsdCtrlServerAddress M RW docsRphyCtrlRpdSsdCtrlTransport M RW docsRphyCtrlRpdSsdCtrlFilename M RW docsRphyCtrlRpdSsdCtrlManufCvcChain M RW docsRphyCtrlRpdSsdCtrlCosignerCvcChain M RW docsRphyCtrlRpdSsdCtrlAdminControl M RW docsRphyCtrlRpdSsdCtrlStatus M RO docsRphyCtrlRpdSsdCtrlSwImageIndex M RW docsRphyCtrlRpdSsdCtrlSsdStatusInfo M RO docsRphyCtrlRpdCrashDataFileCtrlTable M N-Acc docsRphyCtrlRpdCrashDataFileCtrlEntry M N-Acc docsRphyCtrlRpdCrashDataFileCtrlIndex M N-Acc docsRphyCtrlRpdCrashDataFileCtrlFileControl M RW docsRphyCtrlRpdCrashDataServerCtrlTable M N-Acc docsRphyCtrlRpdCrashDataServerCtrlEntry M N-Acc docsRphyCtrlRpdCrashDataServerCtrlDestIpAddrType M RW docsRphyCtrlRpdCrashDataServerCtrlDestIpAddr M RW docsRphyCtrlRpdCrashDataServerCtrlDestPath M RW docsRphyCtrlRpdCrashDataServerCtrlProtocol M RW docsRphyCtrlRpdCrashDataServerCtrlHttpFilenameKeyword M RW docsRphyCtrlRpdInitProvCtrlTable M N-Acc docsRphyCtrlRpdInitProvCtrlEntry M N-Acc docsRphyCtrlRpdInitProvCtrlAssetId M RW

 09/03/21 CableLabs 309 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyCtrlRpdInitProvCtrlDeviceAlias M RW docsRphyCtrlRpdInitProvCtrlLocationDescription M RW docsRphyCtrlRpdInitProvCtrlGeoLocationLatitude M RW docsRphyCtrlRpdInitProvCtrlGeoLocationLongitude M RW

A.4 DOCS-RPHY-PTP-MIB Object Details Table 298 - DOCS-RPHY-PTP-MIB Object Details

Object CCAP Core Access docsRphyPtpRpdCurrentDataSetTable M N-Acc docsRphyPtpRpdCurrentDataSetEntry M N-Acc docsRphyPtpRpdCurrentDataSetStepsRemoved M RO docsRphyPtpRpdCurrentDataSetOffsetFromMaster M RO docsRphyPtpRpdCurrentDataSetMeanPathDelay M RO docsRphyPtpRpdClockStatusTable M N-Acc docsRphyPtpRpdClockStatusEntry M N-Acc docsRphyPtpRpdClockStatusClockState M RO docsRphyPtpRpdClockStatusLastStateChange M RO docsRphyPtpRpdClockStatusPacketsSent M RO docsRphyPtpRpdClockStatusPacketsReceived M RO docsRphyPtpRpdClockStatusCounterDiscontinuityTime M RO docsRphyPtpRpdPortDataSetTable M N-Acc docsRphyPtpRpdPortDataSetEntry M N-Acc docsRphyPtpRpdPortDataSetPortNumber M N-Acc docsRphyPtpRpdPortDataSetPortState M RO docsRphyPtpRpdPortDataSetMeanPathDelay M RO docsRphyPtpRpdPtpPortStatusTable M N-Acc docsRphyPtpRpdPtpPortStatusEntry M N-Acc docsRphyPtpRpdPtpPortStatusRpdEnetPortIndex M N-Acc docsRphyPtpRpdPtpPortStatusRpdPtpPortIndex M N-Acc docsRphyPtpRpdPtpPortStatusPacketsSent M RO docsRphyPtpRpdPtpPortStatusPacketsReceived M RO docsRphyPtpRpdPtpPortStatusCounterDiscontinuityTime M RO docsRphyPtpRpdPortMasterClockStatusTable M N-Acc docsRphyPtpRpdPortMasterClockStatusEntry M N-Acc docsRphyPtpRpdPortMasterClockStatusMasterPriority M N-Acc docsRphyPtpRpdPortMasterClockStatusPacketsSent M RO docsRphyPtpRpdPortMasterClockStatusPacketsReceived M RO docsRphyPtpRpdPortMasterClockStatusMasterClockId M RO docsRphyPtpRpdPortMasterClockStatusMasterClockPortNumber M RO docsRphyPtpRpdPortMasterClockStatusTwoStepFlag M RO docsRphyPtpRpdPortMasterClockStatusIsBmc M RO docsRphyPtpRpdPortMasterClockStatusIsMasterConnected M RO docsRphyPtpRpdPortMasterClockStatusStatusDomain M RO docsRphyPtpRpdPortMasterClockStatusFreqOffset D RO docsRphyPtpRpdPortMasterClockStatusCounterDiscontinuityTime M RO

310 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyPtpRpdPortMasterClockStatusGmClockIdentity M RO docsRphyPtpRpdPortMasterClockStatusGmPriority1 M RO docsRphyPtpRpdPortMasterClockStatusGmPriority2 M RO docsRphyPtpRpdPortMasterClockStatusGmQualityClass M RO docsRphyPtpRpdPortMasterClockStatusGmQualityAccuracy M RO docsRphyPtpRpdPortMasterClockStatusGmQualityOffset M RO docsRphyPtpRpdPortMasterClockStatusGmStepsRemoved M RO docsRphyPtpRpdPortMasterClockStatusFreqOffsetPpt M RO docsRphyPtpRpdSyncEClockStatusTable O N-Acc docsRphyPtpRpdSyncEClockStatusEntry O N-Acc docsRphyPtpRpdSyncEClockStatusClockMode O RO docsRphyPtpRpdSyncEClockStatusActivePortIndex O RO docsRphyPtpRpdSyncEClockStatusLastModeChange O RO docsRphyPtpRpdSyncEClockStatusExcessiveHoldover O RO docsRphyPtpCcapDefaultDataSet docsRphyPtpCcapDefaultDataSetTwoStepFlag M RO docsRphyPtpCcapDefaultDataSetClockIdentity M RO docsRphyPtpCcapDefaultDataSetPriority1 M RO docsRphyPtpCcapDefaultDataSetPriority2 M RO docsRphyPtpCcapDefaultDataSetSlaveOnly M RO docsRphyPtpCcapDefaultDataSetQualityClass M RO docsRphyPtpCcapDefaultDataSetQualityAccuracy M RO docsRphyPtpCcapDefaultDataSetQualityOffset M RO docsRphyPtpCcapCurrentDataSet docsRphyPtpCcapCurrentDataSetStepsRemoved M RO docsRphyPtpCcapCurrentDataSetOffsetFromMaster M RO docsRphyPtpCcapCurrentDataSetMeanPathDelay M RO docsRphyPtpCcapParentDataSet docsRphyPtpCcapParentDataSetParentClockId M RO docsRphyPtpCcapParentDataSetParentPortNumber M RO docsRphyPtpCcapParentDataSetParentStats M RO docsRphyPtpCcapParentDataSetClockOffset M RO docsRphyPtpCcapParentDataSetPhaseChangeRate M RO docsRphyPtpCcapParentDataSetGmClockIdentity M RO docsRphyPtpCcapParentDataSetGmPriority1 M RO docsRphyPtpCcapParentDataSetGmPriority2 M RO docsRphyPtpCcapParentDataSetGmQualityClass M RO docsRphyPtpCcapParentDataSetGmQualityAccuracy M RO docsRphyPtpCcapParentDataSetGmQualityOffset M RO docsRphyPtpCcapTimeProperties docsRphyPtpCcapTimePropertiesCurrentUtcOffsetValid M RO docsRphyPtpCcapTimePropertiesCurrentUtcOffset M RO docsRphyPtpCcapTimePropertiesLeap59 M RO docsRphyPtpCcapTimePropertiesLeap61 M RO docsRphyPtpCcapTimePropertiesTimeTraceable M RO docsRphyPtpCcapTimePropertiesFreqTraceable M RO

 09/03/21 CableLabs 311 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyPtpCcapTimePropertiesPtpTimescale M RO docsRphyPtpCcapTimePropertiesTimeSource M RO docsRphyPtpCcapPortDataSetTable M N-Acc docsRphyPtpCcapPortDataSetEntry M N-Acc docsRphyPtpCcapPortDataSetPortNumber M N-Acc docsRphyPtpCcapPortDataSetPortState M RO docsRphyPtpCcapPortDataSetMeanPathDelay M RO docsRphyPtpCcapClockStatus docsRphyPtpCcapClockStatusClockState M RO docsRphyPtpCcapClockStatusLastStateChange M RO docsRphyPtpCcapClockStatusPacketsSent M RO docsRphyPtpCcapClockStatusPacketsReceived M RO docsRphyPtpCcapClockStatusCounterDiscontinuityTime M RO docsRphyPtpCcapClockStatusExcessiveHoldover M RO docsRphyPtpCcapCorePtpPortStatusTable M N-Acc docsRphyPtpCcapCorePtpPortStatusEntry M N-Acc docsRphyPtpCcapCorePtpPortStatusPortNumber M N-Acc docsRphyPtpCcapCorePtpPortStatusPacketsSent M RO docsRphyPtpCcapCorePtpPortStatusPacketsReceived M RO docsRphyPtpCcapCorePtpPortStatusCounterDiscontinuityTime M RO docsRphyPtpCcapPortMasterClockStatusTable M N-Acc docsRphyPtpCcapPortMasterClockStatusEntry M N-Acc docsRphyPtpCcapPortMasterClockStatusMasterPriority M N-Acc docsRphyPtpCcapPortMasterClockStatusPacketsSent M RO docsRphyPtpCcapPortMasterClockStatusPacketsReceived M RO docsRphyPtpCcapPortMasterClockStatusMasterClockId M RO docsRphyPtpCcapPortMasterClockStatusMasterClockPortNumber M RO docsRphyPtpCcapPortMasterClockStatusTwoStepFlag M RO docsRphyPtpCcapPortMasterClockStatusIsBmc M RO docsRphyPtpCcapPortMasterClockStatusIsMasterConnected M RO docsRphyPtpCcapPortMasterClockStatusStatusDomain M RO docsRphyPtpCcapPortMasterClockStatusFreqOffset D RO docsRphyPtpCcapPortMasterClockStatusCounterDiscontinuityTime M RO docsRphyPtpCcapPortMasterClockStatusGmClockIdentity M RO docsRphyPtpCcapPortMasterClockStatusGmPriority1 M RO docsRphyPtpCcapPortMasterClockStatusGmPriority2 M RO docsRphyPtpCcapPortMasterClockStatusGmQualityClass M RO docsRphyPtpCcapPortMasterClockStatusGmQualityAccuracy M RO docsRphyPtpCcapPortMasterClockStatusGmQualityOffset M RO docsRphyPtpCcapPortMasterClockStatusGmStepsRemoved M RO docsRphyPtpCcapPortMasterClockStatusFreqOffsetPpt M RO docsRphyPtpRpdSyncEClockStatusTable M N-Acc docsRphyPtpRpdSyncEClockStatusEntry M N-Acc docsRphyPtpRpdSyncEClockStatusClockMode M RO docsRphyPtpRpdSyncEClockStatusActivePortIndex M RO docsRphyPtpRpdSyncEClockStatusLastModeChange M RO

312 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyPtpRpdSyncEClockStatusExcessiveHoldover M RO

A.5 DOCS-RPHY-STATS-MIB Object Details Table 299 - DOCS-RPHY-STATS-MIB Object Details

Object CCAP Core Access docsRphyStatsRpdDsScQamPerfStatsTable M N-Acc docsRphyStatsRpdDsScQamPerfStatsEntry M N-Acc docsRphyStatsRpdDsScQamPerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdDsScQamPerfStatsDsRfPortIndex M N-Acc docsRphyStatsRpdDsScQamPerfStatsOutDiscards M RO docsRphyStatsRpdDsScQamPerfStatsOutErrors M RO docsRphyStatsRpdDsScQamPerfStatsOutPackets M RO docsRphyStatsRpdDsScQamPerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsOfdmPerfStatsTable M N-Acc docsRphyStatsRpdDsOfdmPerfStatsEntry M N-Acc docsRphyStatsRpdDsOfdmPerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdDsOfdmPerfStatsDsRfPortIndex M N-Acc docsRphyStatsRpdDsOfdmPerfStatsOutDiscards M RO docsRphyStatsRpdDsOfdmPerfStatsOutErrors M RO docsRphyStatsRpdDsOfdmPerfStatsOutPackets M RO docsRphyStatsRpdDsOfdmPerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsOob551PerfStatsTable M N-Acc docsRphyStatsRpdDsOob551PerfStatsEntry M N-Acc docsRphyStatsRpdDsOob551PerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdDsOob551PerfStatsDsRfPortIndex M N-Acc docsRphyStatsRpdDsOob551PerfStatsFreqIndex M N-Acc docsRphyStatsRpdDsOob551PerfStatsOutDiscards M RO docsRphyStatsRpdDsOob551PerfStatsOutErrors M RO docsRphyStatsRpdDsOob551PerfStatsOutPackets M RO docsRphyStatsRpdDsOob551PerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsOob552PerfStatsTable M N-Acc docsRphyStatsRpdDsOob552PerfStatsEntry M N-Acc docsRphyStatsRpdDsOob552PerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdDsOob552PerfStatsModuleIndex M N-Acc docsRphyStatsRpdDsOob552PerfStatsDsRfPortIndex M N-Acc docsRphyStatsRpdDsOob552PerfStatsOutDiscards M RO docsRphyStatsRpdDsOob552PerfStatsOutErrors M RO docsRphyStatsRpdDsOob552PerfStatsOutPackets M RO docsRphyStatsRpdDsOob552PerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsNdfPerfStatsTable M N-Acc docsRphyStatsRpdDsNdfPerfStatsEntry M N-Acc docsRphyStatsRpdDsNdfPerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdDsNdfPerfStatsDsRfPortIndex M N-Acc docsRphyStatsRpdDsNdfPerfStatsOutDiscards M RO docsRphyStatsRpdDsNdfPerfStatsOutErrors M RO

 09/03/21 CableLabs 313 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyStatsRpdDsNdfPerfStatsOutPackets M RO docsRphyStatsRpdDsNdfPerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsOfdmPlcPerfStatsTable M N-Acc docsRphyStatsRpdDsOfdmPlcPerfStatsEntry M N-Acc docsRphyStatsRpdDsOfdmPlcPerfStatsOutDiscards M RO docsRphyStatsRpdDsOfdmPlcPerfStatsOutErrors M RO docsRphyStatsRpdDsOfdmPlcPerfStatsOutPackets M RO docsRphyStatsRpdDsOfdmPlcPerfStatsRpdDsCounterDiscTime M RO docsRphyStatsRpdDsOfdmProfilePerfStatsTable M N-Acc docsRphyStatsRpdDsOfdmProfilePerfStatsEntry M N-Acc docsRphyStatsRpdDsOfdmProfilePerfStatsProfileIndex M N-Acc docsRphyStatsRpdDsOfdmProfilePerfStatsOutCodewords M RO docsRphyStatsRpdUsOfdmaChanPerfStatsTable M N-Acc docsRphyStatsRpdUsOfdmaChanPerfStatsEntry M N-Acc docsRphyStatsRpdUsOfdmaChanPerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdUsOfdmaChanPerfStatsUsRfPortIndex M N-Acc docsRphyStatsRpdUsOfdmaChanPerfStatsProbeGrants M RO docsRphyStatsRpdUsOfdmaChanPerfStatsHcsErrors M RO docsRphyStatsRpdUsOfdmaChanPerfStatsLateMaps M RO docsRphyStatsRpdUsOfdmaChanPerfStatsIllegalMaps M RO docsRphyStatsRpdUsOfdmaChanPerfStatsDiscardedRequests M RO docsRphyStatsRpdUsOfdmaChanPerfStatsRpdUsCounterDiscTime M RO docsRphyStatsRpdUsScQamChanPerfStatsTable M N-Acc docsRphyStatsRpdUsScQamChanPerfStatsEntry M N-Acc docsRphyStatsRpdUsScQamChanPerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdUsScQamChanPerfStatsUsRfPortIndex M N-Acc docsRphyStatsRpdUsScQamChanPerfStatsChanSnr M RO docsRphyStatsRpdUsScQamChanPerfStatsHcsErrors M RO docsRphyStatsRpdUsScQamChanPerfStatsLateMaps M RO docsRphyStatsRpdUsScQamChanPerfStatsIllegalMaps M RO docsRphyStatsRpdUsScQamChanPerfStatsDiscardedRequests M RO docsRphyStatsRpdUsScQamChanPerfStatsRpdUsCounterDiscTime M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsTable M N-Acc docsRphyStatsRpdUsOfdmaLowIucPerfStatsEntry M N-Acc docsRphyStatsRpdUsOfdmaLowIucPerfStatsUsIuc M N-Acc docsRphyStatsRpdUsOfdmaLowIucPerfStatsNumPredecodePass M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsNumPostdecodePass M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsNumPostdecodeFail M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsUnicastOpportunities M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsUnicastOpCollisions M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsUnicastOpNoEnergy M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsUnicastOpErrors M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsMulticastOpportunities M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsMulticastOpCollisions M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsMulticastOpNoEnergy M RO docsRphyStatsRpdUsOfdmaLowIucPerfStatsMulticastOpErrors M RO

314 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Object CCAP Core Access docsRphyStatsRpdUsOfdmaHighIucPerfStatsTable M N-Acc docsRphyStatsRpdUsOfdmaHighIucPerfStatsEntry M N-Acc docsRphyStatsRpdUsOfdmaHighIucPerfStatsUsIuc M N-Acc docsRphyStatsRpdUsOfdmaHighIucPerfStatsAverageMer M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsNumPredecodePass M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsNumPostdecodePass M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsNumPostdecodeFail M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsScheduledGrants M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsNoEnergyBursts M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsNoPreambleBursts M RO docsRphyStatsRpdUsOfdmaHighIucPerfStatsErrorBursts M RO docsRphyStatsRpdUsScQamLowIucPerfStatsTable M N-Acc docsRphyStatsRpdUsScQamLowIucPerfStatsEntry M N-Acc docsRphyStatsRpdUsScQamLowIucPerfStatsUsIuc M N-Acc docsRphyStatsRpdUsScQamLowIucPerfStatsGoodFecCw M RO docsRphyStatsRpdUsScQamLowIucPerfStatsCorrectedFecCw M RO docsRphyStatsRpdUsScQamLowIucPerfStatsUncorrectedFecCw M RO docsRphyStatsRpdUsScQamLowIucPerfStatsUnicastOpportunities M RO docsRphyStatsRpdUsScQamLowIucPerfStatsUnicastOpCollisions M RO docsRphyStatsRpdUsScQamLowIucPerfStatsUnicastOpNoEnergy M RO docsRphyStatsRpdUsScQamLowIucPerfStatsUnicastOpErrors M RO docsRphyStatsRpdUsScQamLowIucPerfStatsMulticastOpportunities M RO docsRphyStatsRpdUsScQamLowIucPerfStatsMulticastOpCollisions M RO docsRphyStatsRpdUsScQamLowIucPerfStatsMulticastOpNoEnergy M RO docsRphyStatsRpdUsScQamLowIucPerfStatsMulticastOpErrors M RO docsRphyStatsRpdUsScQamHighIucPerfStatsTable M N-Acc docsRphyStatsRpdUsScQamHighIucPerfStatsEntry M N-Acc docsRphyStatsRpdUsScQamHighIucPerfStatsUsIuc M N-Acc docsRphyStatsRpdUsScQamHighIucPerfStatsGoodFecCw M RO docsRphyStatsRpdUsScQamHighIucPerfStatsCorrectedFecCw M RO docsRphyStatsRpdUsScQamHighIucPerfStatsUncorrectedFecCw M RO docsRphyStatsRpdUsScQamHighIucPerfStatsScheduledGrants M RO docsRphyStatsRpdUsScQamHighIucPerfStatsNoEnergyBursts M RO docsRphyStatsRpdUsScQamHighIucPerfStatsNoPreambleBursts M RO docsRphyStatsRpdUsScQamHighIucPerfStatsErrorBursts M RO docsRphyStatsRpdUsOob552PerfStatsTable M N-Acc docsRphyStatsRpdUsOob552PerfStatsEntry M N-Acc docsRphyStatsRpdUsOob552PerfStatsCoreIfIndex M N-Acc docsRphyStatsRpdUsOob552PerfStatsModuleIndex M N-Acc docsRphyStatsRpdUsOob552PerfStatsUsRfPortIndex M N-Acc docsRphyStatsRpdUsOob552PerfStatsRcvdCells M RO docsRphyStatsRpdUsOob552PerfStatsRcvdBytes M RO docsRphyStatsRpdUsOob552PerfStatsUncorrectables M RO docsRphyStatsRpdUsOob552PerfStatsCounterDiscTime M RO docsRphyStatsRpdUsOfdmaEcStatusTable M N-Acc docsRphyStatsRpdUsOfdmaEcStatusEntry M N-Acc

 09/03/21 CableLabs 315 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Object CCAP Core Access docsRphyStatsRpdUsOfdmaEcStatusLastRequestEctPeriod M RO docsRphyStatsRpdUsOfdmaEcStatusLastRequestEctoDuration M RO docsRphyStatsRpdUsOfdmaEcStatusNumRxEctos M RO docsRphyStatsRpdUsOfdmaEcStatusNumTxEcReqBlocks M RO docsRphyStatsRpdUsOfdmaEcStatusNumTxEcReqBlocksNoConv M RO

A.6 DOCS-RPHY-SEC-MIB Object Details Table 300 - DOCS-RPHY-SEC-MIB Object Details

Object CCAP Core Access docsRphySecRpdIee8021xPaeSupplicantStatusTable M N-Acc docsRphySecRpdIee8021xPaeSupplicantStatusEntry M N-Acc docsRphySecRpdIee8021xPaeSupplicantStatusPortNumber M N-Acc docsRphySecRpdIee8021xPaeSupplicantStatusAuthenticated M RO docsRphySecRpdIee8021xPaeSupplicantStatusFailed M RO docsRphySecRpdIee8021xPaeSupplicantStatusRetryCount M RO docsRphySecRpdCertTable M N-Acc docsRphySecRpdCertEntry M N-Acc docsRphySecRpdCertDeviceCert M RO docsRphySecRpdCertSigningCaCert M RO docsRphySecRpdTrustAnchorCertTable M N-Acc docsRphySecRpdTrustAnchorCertEntry M N-Acc docsRphySecRpdTrustAnchorCertIndex M N-Acc docsRphySecRpdTrustAnchorCertCaCert M RO docsRphySecRpdAaaServerAuthTable D N-Acc docsRphySecRpdAaaServerAuthEntry D N-Acc docsRphySecRpdAaaServerAuthStatus D RO docsRphySecRpdCcapCoreAuthTable D N-Acc docsRphySecRpdCcapCoreAuthEntry D N-Acc docsRphySecRpdCcapCoreAuthStatus D RO Object CCAP Core Access docsRphySecCcapServerCertSubject M RO docsRphySecCcapServerCertIssuer M RO docsRphySecCcapServerCertSerialNumber M RO docsRphySecCcapServerCertSource M RO docsRphySecCcapServerCertCert M RO docsRphySecCcapServerCertCertThumbprint M RO

316 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Annex B Format and Content for Event, SYSLOG, and SNMP Notification (Normative) Table 301 in this Annex summarizes the format and content for event, syslog, and SNMP notifications required for a DOCSIS RPHY-compliant CCAP Core. Each row specifies a possible event that may appear in the CCAP Core. These events are to be reported by a cable device through local event logging, and may be accompanied by syslog or SNMP notification. The "Process" and "Sub-Process" columns indicate in which stage the event happens. The "CCAP Core Priority" column indicates the priority the event is assigned in the CCAP Core. These priorities are the same as is reported in the docsDevEvLevel object in the cable device MIB [RFC 4639] and in the LEVEL field of the syslog. The "Event Message" column specifies the event text, which is reported in the docsDevEvText object of the cable device MIB and the text field of the syslog. See also Section 9.2.2. The "Message Notes And Detail" column provides additional information about the event text in the "Event Message" column. Some of the text fields include variable information, which are often specified as key-value pairs. The variables are explained in the "Message Notes And Detail" column. For events where the "Event Message" or "Message Notes and Detail" column includes either , or , there is a colon and single space between the value as defined by , or and the preceding key text. The key-value parameters are thus formatted as: [key]: [value]. Key value pairs are delimited by a semi-colon followed by a single space, as the following example indicates: [key 1]: [value 1]; [key 2]: [value 2]; [key n]: [value n] The “Event Message” field structure is defined as follows: ; [key 1]: [value 1]; [key 2]: [value 2]; [key n]: [value n]; ; Keys which contain values which represent strings can enclose those strings within double-quotations to prevent confusion if those string values contain a delimiter (colon or semicolon). Key strings should capitalize each word (e.g., “Sensor Unit”)If a key’s value is not present, the key is present but the value is omitted (using a single space). For example: key 1: ; It is recommended that string does not contain a semicolon since this is used as a delimiter. The string follows a normal sentence capitalization scheme where the first word is capitalized as well as any defined terms and acronyms. Refer to Section B.2 for examples. This specification defines the following keywords as part of the "Event Message" column: "" (without the quotes) corresponds to: For the CCAP Core (without the quotes):"" Where:

: Unique identifier for the CCAP Core; Format*: "CCAP-CORE-ID: xx:xx:xx:xx:xx:xx" For the RPD (without the quotes):"" Where:

: RPD MAC Address associated with the lowest numbered CIN facing Ethernet port; Format*: "RPD-ID: xx:xx:xx:xx:xx:xx" (*) without the quotes The CCAP Core MUST support all events defined in Annex D of [CCAP-OSSIv4.0]. The CCAP Core MUST support all mandatory events as defined in Table 301 - CCAP Core Event Format and Content.

 09/03/21 CableLabs 317 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

in this Annex summarizes the format and content for event notifications required for a DOCSIS RPHY-compliant RPD. The RPD MUST support all events defined in Table 302 - RPD Event Format and Content. RPD events are fully constructed by the RPD including the header. The CCAP Core is not required to modify the contents of the event. The CCAP Core MAY append additional vendor-specific text to the end of the event text reported in the docsDevEvText object and the syslog text field. The RPD MAY append additional vendor-specific text to the end of the event text reported in the docsDevEvText object and the syslog text field. The "Error Code Set" column specifies the error code. The "Event ID" column indicates a unique identification number for the event, which is assigned to the docsDevEvId object in the cable device MIB and the field of the syslog. Refer to [CANN] for the rules to generate unique Event IDs from the Error Code Set. The "Notification Name" column specifies the SNMP notification, which notifies this event to an SNMP notification receiver.

318 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Table 301 - CCAP Core Event Format and Content

Process Sub-Process CCAP Core Event Message Notes Error Event Notification Priority Message and Detail Code Set ID Name Authentication and Encryption RPD Init IKE Mutual Error Mutual Authentication error; RPD- P1 = RPD IPv4 or IPv6 B800.00 66080000 docsDevCmtsEventNotif Authentication IP: ; Reason: ; Address ; P2 = a string indicating a reason. Vendor can define their own strings. Examples: P2 = {“Certificate Revoked”, “Certificate Validation Failed”} Connectivity Connectivity RPD Error RPD connection refused; RPD-IP: P1 = RPD IPv4 or IPv6 B801.00 66080100 docsDevCmtsEventNotif ; Reason: ; ; Address P2 = text string indicating reason Connectivity RPD Warning GCP connection to second P1 = RPD ID B801.01 66080101 docsDevCmtsEventNotif Principal Core closed: RPD P2 = IP Address of Second detected multiple active Principal Principal Core Cores; RPD-ID: ; Second P3 = CCAP Core ID of Principal Core IP Address: ; Second Principal Core Second Principal Core Id: ; ; Connectivity RPD Error RPD connection lost; RPD-ID: P1 = RPD ID B801.02 66080102 docsDevCmtsEventNotif ; ; Connectivity RPD Warning RPD connection lost: reconnect P1 = RPD ID B801.03 66080103 docsDevCmtsEventNotif attempted; RPD-ID: ; ; Connectivity RPD Notice Successfully reconnected to RPD; P1 = RPD ID B801.04 66080104 docsDevCmtsEventNotif RPD-ID: ; ; Connectivity RPD Error RPD reconnect rejected; RPD-ID: P1 = RPD ID B801.05 66080105 docsDevCmtsEventNotif ; Reason: ; ; P2 = Reason reconnect request was rejected

 09/03/21 CableLabs 319 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process CCAP Core Event Message Notes Error Event Notification Priority Message and Detail Code Set ID Name CIN Latency Session Latency Pseudowire Warning Session latency threshold of P1 = CIN latency warning B802.00 66080200 docsDevCmtsEventNotif Status exceeded; RPD-ID: ; Session threshold ID: ; Measured Latency: P2 = RPD ID microseconds; ; P3 = RPD Session ID of the session that exceeded the latency threshold P4: The latency measured on this session Session Latency Pseudowire Critical Session latency threshold of P1 = CIN latency critical B802.01 66080201 docsDevCmtsEventNotif Status exceeded; RPD-ID: ; Session threshold ID: ; Measured Latency: P2 = RPD ID microseconds; ; P3 = Session ID of the session that exceeded the latency threshold P4: The latency measured on this session Timing PTP Synchronization Notice Core PTP clock synchronized to P1 = Master Clock IP B803.00 66080300 docsDevCmtsEventNotif State master; Clock IP: ; ; address PTP Synchronization Warning Core PTP clock lost P1 = Master Clock IP B803.01 66080301 docsDevCmtsEventNotif State synchronization to master; Clock address IP: ; ; PTP Synchronization Error Core PTP clock excessive P1 = Master Clock IP B803.02 66080302 docsDevCmtsEventNotif State holdover to master; Clock IP: address ; ; PTP Synchronization Error Core PTP clock failure to master; P1 = Master Clock IP B803.03 66080303 docsDevCmtsEventNotif State Clock IP: ; ; address PTP Synchronization Error Excessive Time Offset; Measured P1 = Measured delay B803.04 66080304 docsDevCmtsEventNotif Verification delay: microseconds; RPD- P2 = RPD ID ID: ; ; RCP/GCP Communication Communication RCP/GCP Notice RCP/GCP communication error; P1 = Error Code per [R- B804.00 66080400 docsDevCmtsEventNotif Error Code: ; Probable PHY] Cause: ; Additional Text: P2 = Probable ; ; Cause/Event Mnemonic per [R-PHY] P3 = Additional Text/Error Message

320 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process CCAP Core Event Message Notes Error Event Notification Priority Message and Detail Code Set ID Name Communication TCP Error Timeout: No TCP connect from P1 = RPD IPv4 or IPv6 B804.01 66080401 docsDevCmtsEventNotif RPD after Mutual Auth; RPD-IP: Address ; ; Communication GCP Error Timeout: No GCP Notify from P1 = RPD IPv4 or IPv6 B804.02 66080402 docsDevCmtsEventNotif RPD; RPD-IP: ; ; Address OOB Channels 55-1 Upstream RF Power Warning OOB 55-1 US low power cell; Port: P1 = RPD IPv4 or IPv6 B805.00 66080500 docsDevCmtsEventNotif ; Ch Center Freq: ; Address Power: ; ; P2 = RfPort P3 = Channel Center Frequency P4 = Current Power Level 55-1 Upstream RF Power Warning OOB 55-1 US high power cell; P1 = RPD IPv4 or IPv6 B805.01 66080501 docsDevCmtsEventNotif Port: ; Ch Center Freq: Address ; Power: ; ; P2 = RfPort P3 = Channel Center Frequency P4 = Current Power Level 55-1 Upstream Cell Quality Warning OOB 55-1 US excessive corrected P1 = RPD IPv4 or IPv6 B805.02 66080502 docsDevCmtsEventNotif cells; Port: ; Ch Center Freq: Address ; Cell Count: ; ; P2 = RfPort P3 = Channel Center Frequency P4 = Current Cell Count 55-1 Upstream Cell Quality Warning OOB 55-1 US excessive P1 = RPD IPv4 or IPv6 B805.03 66080503 docsDevCmtsEventNotif uncorrectable cells; Port: ; Address Ch Center Freq: ; Cell Count: P2 = RfPort ; ; P3 = Channel Center Frequency P4 = Current Cell Count 55-1 Upstream Cell Quality Warning OOB 55-1 US excessive total P1 = RPD IPv4 or IPv6 B805.04 66080504 docsDevCmtsEventNotif cells; Port: ; Ch Center Freq: Address ; Cell Count: ; ; P2 = RfPort P3 = Channel Center Frequency P4 = Current Cell Count

 09/03/21 CableLabs 321 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process CCAP Core Event Message Notes Error Event Notification Priority Message and Detail Code Set ID Name 55-1 Upstream Cell Quality Notice OOB 55-1 US excessive corrected P1 = RPD IPv4 or IPv6 B805.05 66080505 docsDevCmtsEventNotif cells ended; Port: ; Ch Address Center Freq: ; Cell Count: P2 = RfPort ; ; P3 = Channel Center Frequency P4 = Current Cell Count 55-1 Upstream Cell Quality Notice OOB 55-1 US excessive P1 = RPD IPv4 or IPv6 B805.06 66080506 docsDevCmtsEventNotif uncorrectable cells ended; Port: Address ; Ch Center Freq: ; Cell P2 = RfPort Count: ; ; P3 = Channel Center Frequency P4 = Current Cell Count 55-1 Upstream Cell Quality Notice OOB 55-1 US excessive total cells P1 = RPD IPv4 or IPv6 B805.07 66080507 docsDevCmtsEventNotif ended; Port: ; Ch Center Address Freq: ; Cell Count: ; P2 = RfPort ; P3 = Channel Center Frequency P4 = Current Cell Count

Table 302 - RPD Event Format and Content

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Authentication and Encryption Init Network Error Network Authentication error; Descr: ; P1 = Authentication error B701.00 66070100 Authentication Port: ; ; description P2 = Ethernet port number Init Network Notice Network Authentication success; Port: P1 = Ethernet port number B701.04 66070104 Authentication ; ; Init Network Error EAP request timeout; Port: ; ; P1 = Ethernet port number B701.06 66070106 Authentication Init Network Information Re-authentication with Authenticator P1 = Authenticator MAC B701.07 66070107 Authentication completed successfully; Auth MAC Addr: address ; Port: ; ; P2 = Ethernet port number Init Network Error Re-authentication with Authenticator failed; P1 = Authenticator MAC B701.08 66070108 Authentication Auth MAC Addr: ; Port: ; address ; P2 = Ethernet port number

322 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Init Mutual Authentication Error Mutual Authentication error; Descr: ; P1 is one of the following pre- B701.01 66070101 Core IP: ; ; defined strings: P1 = {Certificate Revoked, Certificate Failed, No IKE Response Received, Other} P2 = IP address of the Core to which mutual authentication failed Init Mutual Authentication Notice Successfully completed Mutual P1 = IP address of the Core to B701.05 66070105 Authentication to Core; Core IP: ; which mutual authentication ; succeeded Authentication SSH Notice SSH authentication successful from client; P1 = IP Address of SSH client B701.02 66070102 Client IP: ; User: ; ; P2 = user id of SSH client Authentication SSH Warning SSH authentication error from client; Client P1 = IP Address of SSH client B701.03 66070103 IP: ; User: ; ; P2 = user id of SSH client Initialization Init Initialization Critical Failure occurred during local RPD P1 is optional B708.00 66070800 initialization process. RPD reset; Descr: P1 = Vendor Specific Event or ; ; Text Init Initialization Error Unable to apply non-volatile configuration P1 is optional B708.01 66070801 settings during local RPD initialization; P1 = Vendor Specific Event or Descr: ; ; Text Init Initialization Notice Local RPD initialization process passed; P1 is optional B708.02 66070802 Descr: ; ; P1 = Vendor Specific Event or Text Connectivity Connectivity CCAP Core Error Connection lost - Auxiliary CCAP Core; P1 = Auxiliary CCAP Core ID to B702.00 66070200 Core ID: ; ; which the connection was lost. Connectivity CCAP Core Warning Connection lost - Auxiliary CCAP Core. P1 = Auxiliary CCAP Core ID to B702.20 66070220 Reconnect attempted; Core ID: ; which the connection was lost. ; Connectivity CCAP Core Critical Connection lost - Principal CCAP Core; P1 = Principal CCAP Core ID to B702.01 66070201 Core ID: ; ; which the connection was lost. Connectivity CCAP Core Warning Connection lost - Principal CCAP Core. P1 = Principal CCAP Core ID to B702.21 66070221 Reconnect attempted; Core ID: ; which the connection was lost. ; Connectivity CCAP Core Error Principal Core not found; DHCP Server IP: P1 = IP address of DHCP B702.02 66070202 ; ; Server.

 09/03/21 CableLabs 323 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Connectivity CCAP Core Warning Multiple active Principal Cores found; Core P1 = Principal CCAP Core ID of B702.03 66070203 ID: ; ; the extra active principal core. Connectivity CCAP Core Notice Successfully connected to Core; Core ID: P1 = CCAP Core ID to which B702.19 66070219 ; ; the connection was completed Connectivity CCAP Core Notice Successfully reconnected to Core; Core ID: P1 = CCAP Core ID to which B702.22 66070222 ; ; the connection was completed Connectivity CCAP Core Error Redirect fault; Core ID: ; Core IP:; P1 = CCAP Core ID of Core B702.41 66070241 ; that incorrectly included its IP address in the Redirect IRA P2 = IP address of CCAP Core that incorrectly included its IP address in Redirect IRA Connectivity CCAP Core Notice CCAP Core inactive; CoreMode set to P1 = CCAP Core IP address B702.42 66070242 OutOfService mode; CCAP Core IP: ; P2 = CCAP Core ID CCAP Core ID: ; ; Connectivity GCP Error GCP connection failure; Descr: ; Core P1 = Additional Event Text B702.04 66070204 IP: ; ; describing error condition; P1 can be a null string if no additional text. P2 = CCAP Core IP address from which the connection was lost or cannot be established. Connectivity GCP Warning GCP keepalive failure; CCAP Core IP: P1 = CCAP Core IP address B702.23 66070223 ; CCAP Core ID: ; ; P2 = CCAP Core ID Connectivity GCP Error TCP failure; CCAP Core IP: ; CCAP P1 = CCAP Core IP address B702.24 66070224 Core ID: ; ; P2 = CCAP Core ID (if known) Connectivity GCP Error No IRA after Notify retries exceeded; CCAP P1 = CCAP Core IP address B702.38 66070238 Core IP: ; ; Connectivity GCP Error RPD timeout waiting for a Configuration P1 = CCAP Core IP address B702.39 66070239 message following IRA; CCAP Core IP: P2 = CCAP Core ID ; CCAP Core ID: ; ; Connectivity GCP Error Duplicate Core ID write operation attempted P1 = CCAP Core IP address B702.40 66070240 in CcapCoreIdentification Table; CCAP Core (failed write operation) IP: ; CCAP Core ID: ; ; P2 = CCAP Core ID Connectivity GCP Error Timeout: Initial Configuration Complete P1 = CCAP Core IP Address B702.43 66070243 retries exceeded from RPD; CCAP Core P2 = CCAP Core ID IP:; CCAP Core ID: ; ;

324 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Connectivity High Availability Warning Failover to backup error; Surrendering Core P1 = CCAP Core ID of the B702.10 66070210 ID: ; Acquiring Core ID: ; failed/surrendering CCAP Core. ; P2 = CCAP Core ID of the acquiring Core. Connectivity High Availability Warning Failback to active Core; Surrendering Core P1 = CCAP Core ID of the B702.11 66070211 ID: ; Acquiring Core ID: ; surrendering CCAP Core. ; P2 = CCAP Core ID of the acquiring Core. Init Reboot Notice Reboot; Type: ; Reason: ; Next P1 = {softReset, hardReset, B702.12 66070212 SW Image Index: ; ; nvReset, factoryReset} P2 = Text string indicating reason P3 = CurrentSwImageIndex of the Identification object after completing re-initialization Connectivity Ethernet Interface Error Ethernet link down; Port: ; ; P1 = Ethernet port number B702.13 66070213 Connectivity Ethernet Interface Notice Ethernet link up; Port: ; ; P1 = Ethernet port number B702.14 66070214 Connectivity Ethernet Interface Error CIN link timeout; Port: ; ; P1 = Ethernet port number B702.31 66070231 Connectivity Pseudowire Interface Error Pseudowire connection down; Session ID: P1 = RPD PW Session ID B702.15 66070215 ; CCAP Core ID: ; ; P2 = CCAP Core ID Connectivity Pseudowire Interface Notice Pseudowire connection up; Session ID: P1 = RPD PW Session ID B702.16 66070216 ; CCAP Core ID: ; ; P2 = CCAP Core ID Connectivity System Failure Error System failure reboot; Time: ; P1 = System Time of Failure B702.17 66070217 Filename: ; ; (value of HostResourcesSystem Date attribute at time of failure) P2 = System Failure Log Filename Connectivity Diagnostic Self Test Error Diagnostic self test failure; Cause: ; P1 = Probable Cause B702.18 66070218 Descr: ; Severity: ; ; P2 = Additional Text P3 = Severity Level Connectivity Handover Notice Auxiliary handover started; Failed Core IP: P1 = IP address of Failed Core B702.29 66070229 ; Backup Core IP: ; ; P2 = IP address of Backup Core Connectivity Handover Notice Principal handover started; Failed Core IP: P1 = IP address of Failed Core B702.30 66070230 ; Backup Core IP: ; ; P2 = IP address of Backup Core Connectivity Handover Error No backup Core found; Failed Core IP: P1 = IP address of Failed Core B702.32 66070232 ; ; Connectivity Handover Error Connection to backup failed; Failed Core IP: P1 = IP address of Failed Core B702.33 66070233 ; Backup Core IP: ; ; P2 = IP address of Backup Core

 09/03/21 CableLabs 325 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Connectivity Handover Error Backup request rejected; Failed Core IP: P1 = IP address of Failed Core B702.34 66070234 ; Backup Core IP: ; ; P2 = IP address of Backup Core Connectivity Handover Error Handover failed; Failed Core IP: ; P1 = IP address of Failed Core B702.35 66070235 Backup Core IP: ; ; P2 = IP address of Backup Core Connectivity Handover Notice Core initiated handover; Failed Core IP: P1 = IP address of Failed Core B702.36 66070236 ; Backup Core IP: ; Requesting P2 = IP address of Backup Core Core IP: ; ; P3 = IP address of Core sending handover request Connectivity Reconnect Error Auxiliary reconnect abandoned; Failed Core P1 = IP address of Failed Core B702.25 66070225 IP: ; Backup Core IP: ; P2 = IP address of Backup Core Requesting Core IP: ; ; P3 = IP address of Core sending handover request Connectivity Reconnect Error Principal reconnect abandoned; CCAP Core P1 = CCAP Core ID B702.26 66070226 ID: ; CCAP Core IP: ; ; P2 = CCAP Core IP address Connectivity Reconnect Notice Principal reconnect started; CCAP Core ID: P1 = CCAP Core ID B702.27 66070227 ; CCAP Core IP: ; ; P2 = CCAP Core IP address Connectivity Reconnect Notice Auxiliary reconnect started; CCAP Core ID: P1 = CCAP Core ID B702.28 66070228 ; CCAP Core IP:; ; P2 = CCAP Core IP address Connectivity Echo Cancellation Error Duration of ECTO outside permissible P1 = Received ECTO Duration B702.37 66070237 range; received ECTO duration: ; ; Connectivity L2TPv3 Error L2TPv3 connection failure; Descr: ; P1 = Additional Event Text B702.09 66070209 CCAP Core ID: ; Core IP: ; RPD describing error condition; P1 IP: ; Core CCID: ; RPD CCID: can be a null string if no ; ; additional text. P2 = CCAP Core ID P3 = LCCE IP address of the CCAP Core to which the connection failed P4 = LCCE IP address of the RPD to which the connection failed P5 = Control Connection Id used for Core originated messages P6 = Control Connection Id used for RPD originated messages

326 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Connectivity L2TPv3 Error DEPI control message with unknown P1 = LCCE IP address of the B702.44 66070244 CoreId; Core LCCE IP: ; CCAP Core CCAP Core that sent the control ID: ; ; message. P2 = CCAP Core ID that caused the ownership error Connectivity L2TPv3 Error DEPI resource ownership problem; Core P1 = LCCE IP address of the B702.45 66070245 LCCE IP: ; CCAP Core ID: ; CCAP Core that sent the control ; message. P2 = CCAP Core ID that caused the ownership error Connectivity L2TPv3 Error L2TPv3 session failure; Descr: ; Core P1 = Additional Event Text B702.46 66070246 IP: ; RPD IP: ; Core Sess Id: describing error condition; P1 ; RPD Sess Id: ; ; can be a null string if no additional text. P2 = LCCE IP address of the CCAP Core to which the session failed P3 = LCCE IP address of the RPD to which the session failed P4 = Core Session Id of failed session P5 = RPD Session Id of failed session Connectivity L2TPv3 Error Duplicate UTID rcvd1; Core IP: ; RPD P1 = LCCE IP address of the B702.47 66070247 IP: ; UTID: ; ; CCAP Core that sent the UTID. P2 = LCCE IP address of the RPD receiving UTID. P3 = Duplicate UTID Connectivity L2TPv3 Warning Unknown UTID rcvd; Core IP: ; RPD P1 = LCCE IP address of the B702.48 66070248 IP: ; Core CCID: ; RPD CCID: CCAP Core that sent the UTID. ; UTID: ; ; P2 = LCCE IP address of the RPD receiving UTID. P3 = Control Connection Id used for Core originated messages P4 = Control Connection Id used for RPD originated messages P5 = Unknown UTID

 09/03/21 CableLabs 327 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Connectivity L2TPv3 Error Bad DTU rcvd; Core IP address: ; RPD P1 = LCCE IP address of the B702.49 66070249 IP: ; Core CCID: ; RPD CCID: CCAP Core that sent the DTU. ; ; P2 = LCCE IP address of the RPD receiving DTU P3 = Control Connection Id used for Core originated messages P4 = Control Connection Id used for RPD originated messages Connectivity L2TPv3 Error Bad SCCRQ rcvd; Core IP: ; RPD IP: P1 = LCCE IP address of the B702.50 66070250 ; ; CCAP Core that sent the SCCRQ. P2 = LCCE IP address of the RPD receiving SCCRQ Connectivity L2TPv3 Error Too many InService tunnels; Core IP: ; P1 = LCCE IP address of the B702.51 66070251 RPD IP: ; Max: ; ; CCAP Core that sent the SCCRQ. P2 = LCCE IP address of the RPD receiving SCCRQ P3 = Maximum number of concurrent InService tunnels Connectivity L2TPv3 Error Too many Standby tunnels; Core IP: ; P1 = LCCE IP address of the B702.52 66070252 RPD IP: ; Max: ; ; CCAP Core that sent the SCCRQ. P2 = LCCE IP address of the RPD receiving SCCRQ P3 = Maximum number of concurrent Standby tunnels DHCP, TOD DHCP Error DHCP RENEW sent - No response; IP Ver: P1= IPv4 or IPv6 B703.00 66070300 ; Port: ; ; P2 = Ethernet port number DHCP Error DHCP REBIND sent - No response; IP Ver: P1=IPv4 or IPv6 B703.01 66070301 ; Port: ; ; P2 = Ethernet port number DHCP Error DHCP RENEW WARNING - Field invalid in P1=IPv4 or IPv6 B703.02 66070302 response; IP Ver: ; Port: ; P2 = Ethernet port number ; DHCP Critical DHCP RENEW FAILED - Critical field P1 = IPv4 or IPv6 B703.03 66070303 invalid in response; IP Ver: ; Port: P2 = Ethernet port number ; ;

328 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID DHCP Error DHCP REBIND WARNING - Field invalid in P1 = IPv4 or IPv6 B703.04 66070304 response; IP ver: ; Port: ; P2 = Ethernet port number ; DHCP Critical DHCP REBIND FAILED - Critical field P1 = IPv4 or IPv6 B703.05 66070305 invalid in response; IP ver: ; Port: P2 = Ethernet port number ; ; DHCP Notice DHCP Reconfigure received; DHCP Server P1 = IP address of DHCP B703.06 66070306 IP: ; Port: ; ; server sending Reconfigure P2 = Ethernet port number DHCP Notice DHCP Renew; lease parameters modified: P1 = list of params that B703.07 66070307 ; Port: ; ; changed at renew P2 = Ethernet port number DHCP Critical DHCP Failed - CCAP Core list missing; P1 = DHCP server IP address B703.09 66070309 DHCP Server IP: ; Port: ; P2 = Ethernet port number ; Init DHCP Critical DHCP FAILED - Discover sent, no offer P1 = DHCP server IP address B703.10 66070310 received; DHCP Server IP: ; Port: P2 = Ethernet port number ; ; Init DHCP Critical DHCP FAILED - Request sent, No P1 = DHCP server IP address B703.11 66070311 response; DHCP Server IP: ; Port: P2 = Ethernet port number ; ; Init DHCP Warning DHCP WARNING - Non-critical field invalid P1 = DHCP server IP address B703.12 66070312 in response; DHCP Server IP: ; Port: P2 = Ethernet port number ; ; Init DHCP Critical DHCP FAILED - Critical field invalid in P1 = DHCP server IP address B703.13 66070313 response; DHCP Server IP: ; Port: P2 = Ethernet port number ; ; Init DHCP Critical DHCP failed - RS sent, no RA received; P1 = DHCP server IP address B703.14 66070314 DHCP Server IP: ; Port: ; P2 = Ethernet port number ; Init DHCP Critical DHCP Failed - Invalid RA; DHCP Server IP: P1 = DHCP server IP address B703.15 66070315 ; Port: ; ; P2 = Ethernet port number Init DHCP Critical DHCP failed - DHCP Solicit sent, No DHCP P1 = DHCP server IP address B703.16 66070316 Advertise received; DHCP Server IP: ; P2 = Ethernet port number Port: ; ; Init DHCP Critical DHCP failed - DHCP Request sent, No P1 = DHCP server IP address B703.17 66070317 DHCP REPLY received; DHCP Server IP: P2 = Ethernet port number ; Port: ; ;

 09/03/21 CableLabs 329 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Init IPv6 Address Critical Link-Local failure - Link-Local address failed P1 = DHCP server IP address B703.20 66070320 Acquisition DAD; DHCP Server IP: ; Port: ; P2 = Ethernet port number ; Init IPv6 Address Critical DHCP lease failure - DHCP assigned P1 = DHCP server IP address B703.21 66070321 Acquisition address failed DAD; DHCP Server IP: ; P2 = Ethernet port number Port: ; ; Init IPv4 Address Notice Successfully obtained IPv4 address; B703.24 66070324 Acquisition ; Init IPv6 Address Notice Successfully obtained IPv6 address; B703.25 66070325 Acquisition ; Init TOD Error ToD failed - ToD request sent - No response P1 = ToD server IP address B703.22 66070322 received; ToD Server IP: ; Port: ; P2 = Ethernet port number ; Init TOD Error ToD failed - Response received - Invalid P1 = ToD server IP address B703.23 66070323 data format; ToD Server IP: ; Port: P2 = Ethernet port number ; ; Init TOD Notice Successfully obtained ToD; ; B703.26 66070326 Init Config Error Received unknown RCP message from P1 = CCAP Core ID B703.27 66070327 Core; Core ID: ; Descr: ; Core IP: P2 = Error description ; ; P3 = CCAP Core IP address Init Config Error Received RCP message from Core, not P1 = RCP message B703.28 66070328 allowed in current state; Message: ; P2 = CCAP Core ID Core ID: ; State: ; Core IP: ; P3 = Current ; TopLevelRPDState P4 = CCAP Core IP address Init Config Notice Backup Principal Core found; Core ID: P1 = CCAP Core ID B703.31 66070331 ; ; Init Config Notice Backup Auxiliary Core found; Core ID: P1 = CCAP Core ID B703.32 66070332 ; ; Init Config Warning Core not acting in any role for RPD - Neither P1 = CCAP Core ID B703.33 66070333 active nor backup CCAP Core; Core ID: ; ; Init Config Error Principal Core retries exhausted; Core ID: P1 = CCAP Core ID B703.34 66070334 ; ; Init Config Warning Move to operational timeout; Core ID: ; P1 = CCAP Core ID B703.35 66070335 ; Init Config Notice Upgrade IRA; Core ID: ; ; P1 = CCAP Core ID B703.36 66070336

330 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID Init Config Notice Redirect IRA; Core IP: ; Core ID: P1 = CCAP Core IP address B703.37 66070337 ; ; P2 = CCAP Core ID Init Config Notice Pending IRAs; Core ID: ; ; P1 = CCAP Core ID B703.38 66070338 Init Config Error Multiple IRAs; Core ID: ; ; P1 = CCAP Core ID B703.39 66070339 Init IRA Error No IRA received after Notify message to P1 = CCAP Core IP address B703.29 66070329 Core; Core IP: ; ; Init IRA Error No REX received after IRA from Core; Core P1 = CCAP Core ID B703.30 66070330 ID: ; Core IP: ; ; P2 = CCAP Core IP address Secure Software Download SW Upgrade SW UPGRADE INIT Notice SW download INIT - via RPD CLI; Filename: P1 = SW file name B704.00 66070400 ; Server IP: ; Image Index: ; P2 = SW Download server IP ; address P3 = SwImageIndex of the SsdCtrl object SW Upgrade SW UPGRADE INIT Notice SW download INIT - via GCP; Filename: P1 = SW file name B704.01 66070401 ; Server IP: ; Image Index: ; P2 = SW Download server IP ; address P3 = SwImageIndex of the RpdSsdCtrl object SW Upgrade SW UPGRADE Error SW upgrade failed during download - max P1 = SW file name B704.02 66070402 GENERAL FAILURE retry exceed (3); Filename: ; Server IP: P2 = SW Download server IP ; ; address SW Upgrade SW UPGRADE Error SW upgrade failed before download - server P1 = SW file name B704.03 66070403 GENERAL FAILURE not present; Filename: ; Server IP: P2 = SW Download server IP ; ; address SW Upgrade SW UPGRADE Error SW upgrade failed before download - file not P1 = SW file name B704.04 66070404 GENERAL FAILURE present; Filename: ; Server IP: ; P2 = SW Download server IP ; address SW Upgrade SW UPGRADE Error SW upgrade failed before download - max P1 = SW file name B704.05 66070405 GENERAL FAILURE download retry exceeded; Filename: ; P2 = SW Download server IP Server IP: ; ; address SW Upgrade SW UPGRADE Error SW upgrade failed after download - P1 = SW file name B704.06 66070406 GENERAL FAILURE incompatible SW file; Filename: ; P2 = SW Download server IP Server IP: ; ; address SW Upgrade SW UPGRADE Error SW upgrade failed after download - SW file P1 = SW file name B704.07 66070407 GENERAL FAILURE corruption; Filename: ; Server IP: P2 = SW Download server IP ; ; address

 09/03/21 CableLabs 331 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Process Sub-Process RPD Event Message Notes Error Event Priority Message and Detail Code Set ID SW Upgrade SW UPGRADE Error Disruption during SW download - power P1 = SW file name B704.08 66070408 GENERAL FAILURE failure; Filename: ; Server IP: ; P2 = SW Download server IP ; address SW Upgrade SW UPGRADE Notice SW download successful - via RPD CLI; P1 = SW file name B704.10 66070410 SUCCESS Filename: ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade SW UPGRADE Notice SW download successful - via GCP; P1 = SW file name B704.11 66070411 SUCCESS Filename: ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade SW UPGRADE Error Improper code file controls; Filename: ; P1 = SW file name B704.12 66070412 GENERAL FAILURE Server IP: ; ; P2 = SW Download server IP address SW Upgrade SW UPGRADE Error Code file manufacturer CVC validation P1 = SW file name B704.13 66070413 GENERAL FAILURE failure; Filename: ; Server IP: ; P2 = SW Download server IP ; address SW Upgrade SW UPGRADE Error Code file manufacturer CVS validation P1 = SW file name B704.14 66070414 GENERAL FAILURE failure; Filename: ; Server IP: ; P2 = SW Download server IP ; address SW Upgrade SW UPGRADE Error Code file co-signer CVC validation failure; P1 = SW file name B704.15 66070415 GENERAL FAILURE Filename: ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade SW UPGRADE Error Code file co-signer CVS validation failure; P1 = SW file name B704.16 66070416 GENERAL FAILURE Filename: ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade VERIFICATION OF Error Improper GCP CVC format; Filename: P1 = SW file name B704.17 66070417 CVC ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade VERIFICATION OF Error GCP CVC validation failure; Filename: P1 = SW file name B704.18 66070418 CVC ; Server IP: ; ; P2 = SW Download server IP address SW Upgrade SW ACTIVATION Notice SW activation successful; Software Image: P1 = SwImageIndex B704.19 66070419 ; ; SW Upgrade SW ACTIVATION Warning SW activation failure; Software Image: P1 = SwImageIndex B704.20 66070420 ; ; SW Upgrade SW UPGRADE Notice SW upgrade aborted; Software Image: P1 = SwImageIndex B704.21 66070421 ; ;

332 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Physical and Environmental Environmental Temperature Critical High temperature threshold exceeded; P1 = EntityIndex of temperature B705.00 66070500 Sensor Unit: ; Reading: ; Time: sensor ; ; P2 = Sensor reading (Celsius Temperature) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Temperature Notice High temperature threshold exceeded P1 = EntityIndex of temperature B705.10 66070510 condition cleared; Sensor Unit: ; sensor Reading: ; Time: ; ; P2 = Sensor reading (Celsius Temperature) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Temperature Warning Normal operating temperature exceeded; P1 = EntityIndex of temperature B705.01 66070501 Sensor Unit: ; Reading: ; Time: sensor ; ; P2 = Sensor reading (Celsius Temperature) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Temperature Notice Normal operating temperature exceeded P1 = EntityIndex of temperature B705.11 66070511 condition cleared; Sensor Unit: ; sensor Reading: ; Time: ; ; P2 = Sensor reading (Celsius Temperature) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Physical Power Critical Excessive input current; Power Supply Unit: P1 = EntityIndex of B705.02 66070502 ; Reading: ; Time: ; powerSupply ; P2 = Sensor reading (Amperes) P3 = value of HostResourcesSystem Date attribute at time of sensor reading

 09/03/21 CableLabs 333 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Physical Power Notice Excessive input current condition cleared; P1 = EntityIndex of B705.12 66070512 Power Supply Unit: ; Reading: ; powerSupply Time: ; ; P2 = Sensor reading (Amperes) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Physical Power Critical Improper input voltage; Power Supply Unit: P1 = EntityIndex of B705.03 66070503 ; Reading: ; Time: ; powerSupply ; P2 = Sensor reading (Volts) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Physical Power Notice Improper input voltage condition cleared; P1 = EntityIndex of B705.13 66070513 Power Supply Unit: ; Reading: ; powerSupply Time: ; ; P2 = Sensor reading (Volts) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Security Warning Enclosure door opened; Time: ; P1 = value of B705.04 66070504 ; HostResourcesSystem Date attribute at time of sensor reading Environmental Security Notice Enclosure door opened condition cleared; P1 = value of B705.14 66070514 Time: ; ; HostResourcesSystem Date attribute at time of sensor reading Environmental Humidity Error High humidity threshold exceeded; Sensor P1 = EntityIndex of humidity B705.05 66070505 Unit: ; Reading: ; Time: ; sensor ; P2 = Sensor reading (percent relative humidity) P3 = value of HostResourcesSystem Date attribute at time of sensor reading

334 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Environmental Humidity Notice High humidity threshold exceeded condition P1 = EntityIndex of humidity B705.15 66070515 cleared; Sensor Unit: ; Reading: ; sensor Time: ; ; P2 = Sensor reading (percent relative humidity) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Humidity Warning Normal operating humidity exceeded; P1 = EntityIndex of humidity B705.06 66070506 Sensor Unit: ; Reading: ; Time: sensor ; ; P2 = Sensor reading (percent relative humidity) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Humidity Notice Normal operating humidity exceeded P1 = EntityIndex of humidity B705.16 66070516 condition cleared; Sensor Unit: ; sensor Reading: ; Time: ; ; P2 = Sensor reading (percent relative humidity) P3 = value of HostResourcesSystem Date attribute at time of sensor reading Environmental Security Warning Local management interface port activated; P1 = Management port identifier B705.07 66070507 Port: ; ; Environmental Security Notice Local management interface port P1 = Management port identifier B705.17 66070517 deactivated; Port: ; ; Environmental Security Warning Unsuccessful login on local management P1 = Management port identifier B705.18 66070518 interface port; Port: ; ; Environmental Security Notice Successful login on local management P1 = Management port identifier B705.19 66070519 interface port; Port: ; ; Environmental Sensor Assigned by Vendor Sensor event; Sensor Unit: ; Type: P1 = RPD EntityIndex of sensor B705.08 66070508 ; Scale: ; Reading: ; Descr: P2 = SensorType ; ; P3 = Scale P4 = Sensor reading (Value) P5 = Entity Descr Environmental Sensor Notice Sensor event condition cleared; Sensor P1 = RPD EntityIndex of sensor B705.09 66070509 Unit: ; Type: ; Scale: ; P2 = SensorType Reading: ; Descr: ; ; P3 = Scale P4 = Sensor reading (Value) P5 = Entity Descr

 09/03/21 CableLabs 335 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Environmental Processor Error Processor overload threshold exceeded; P1 = Processor identifier B705.20 66070520 Processor: ; Reading: ; Time: (vendor specific) ; ; P2 = Processor utilization reading (percent) P3 = value of HostResourcesSystem Date attribute at time of detected overload condition Environmental Processor Notice Processor overload threshold exceeded P1 = Processor identifier B705.21 66070521 condition cleared; Processor: ; (vendor specific) Reading: ; Time: ; ; P2 = Processor utilization reading (percent) P3 = value of HostResourcesSystem Date attribute at time of detected overload cleared condition Environmental Storage Error Memory utilization threshold exceeded; P1 = HostResourcesStorage B705.22 66070522 Storage: ; Reading: ; Time: ; Index of RPD local storage ; P2 = Memory utilization reading (vendor specific) P3 = value of HostResourcesSystem Date attribute at time of detected threshold exceeded condition Environmental Storage Notice Memory utilization threshold exceeded P1 = HostResourcesStorage B705.23 66070523 condition cleared; Storage: ; Reading: Index of RPD local storage ; Time: ; ; P2 = Memory utilization reading (vendor specific) P3 = value of HostResourcesSystem Date attribute at time of detected threshold exceeded condition Physical Optical Power Warning Transmit optical power maximum threshold P1 = Optical Interface Identifier B705.24 66070524 exceeded; Interface: ; ; Physical Optical Power Notice Transmit optical power maximum threshold P1 = Optical Interface Identifier B705.25 66070525 exceeded condition cleared; Interface: ; ; Physical Optical Power Warning Transmit optical power minimum threshold P1 = Optical Interface Identifier B705.26 66070526 exceeded; Interface: ; ; Physical Optical Power Notice Transmit optical power minimum threshold P1 = Optical Interface Identifier B705.27 66070527 exceeded condition cleared; Interface: ; ; Physical Optical Power Warning Receive optical power maximum threshold P1 = Optical Interface Identifier B705.28 66070528 exceeded; Interface: ; ;

336 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Physical Optical Power Notice Receive optical power maximum threshold P1 = Optical Interface Identifier B705.29 66070529 exceeded condition cleared; Interface: ; ; Physical Optical Power Warning Receive optical power minimum threshold P1 = Optical Interface Identifier B705.30 66070530 exceeded; Interface: ; ; Physical Optical Power Notice Receive optical power minimum threshold P1 = Optical Interface Identifier B705.31 66070531 exceeded condition cleared; Interface: ; ; Timing PTP Synchronization State Notice PTP clock synchronized to master; Clock IP: P1 = Master Clock IP address B707.00 66070700 ; ; PTP Synchronization State Warning PTP clock lost synchronization to master; P1 = Master Clock IP address B707.01 66070701 Clock IP: ; ; PTP Synchronization State Error PTP clock excessive holdover to master; P1 = Master Clock IP address B707.02 66070702 Clock IP: ; ; PTP Synchronization State Error PTP failure to master; Clock IP: ; P1 = Master Clock IP address B707.03 66070703 ; SyncE Synchronization State Notice SyncE clock lock achieved; ENET port: P1 = ENET port number that is B707.06 66070706 ; ; locked SyncE Synchronization State Error SyncE clock initial lock failure; ; B707.07 66070707 SyncE Synchronization State Warning SyncE clock lost lock; ENET port: ; P1 = ENET port number that is B707.08 66070708 ; locked SyncE Synchronization State Notice SyncE port signal qualified; ENET port: P1 = ENET port number that B707.09 66070709 ; ; has a qualified signal SyncE Synchronization State Error SyncE clock excessive holdover; ENET port: P1 = ENET port number that is B707.10 66070710 ; ; locked SyncE Synchronization State Warning SyncE clock reference port change; Old P1 = old SyncE ENET port B707.11 66070711 ENET port: ; New ENET port: ; number ; P2 = new SyncE ENET port number QoS Quality of Buffer Threshold Alert Notice Buffer Threshold Exceeded; RF Port: ; P1 = RfPort B709.00 6670900 Service Channel Type: ; Frequency: ; P2 = Channel Type ; P3 = Channel Frequency PNM PNM Upstream Probe Warning Failure initiating Upstream Probe Capture P1 = US RF Port Index B710.00 6671000 Capture PNM test; US RF Port: ; OFDMA P2 = OFDMA Channel Index Channel Index: ; Error: ; P3 = Error Message ; See [R-PHY] for Error Message details.

 09/03/21 CableLabs 337 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

PNM Downstream OFDM Warning Failure initiating Downstream OFDM Symbol P1 = DS RF Port Index B710.01 6671001 Symbol Capture Capture PNM test; DS RF Port: ; P2 = OFDM Channel Index OFDM Channel Index: ; Error: ; P3 = Error Message ; See [R-PHY] for Error Message details. Streaming Telemetry Streaming Streaming Telemetry Notice Connection between Telemetry Client and P1 = IP address of the B711.00 6671100 Telemetry Connection Server successfully established; Telemetry Streaming Telemetry Client Client IP: ; Telemetry Server IP: ; P2 = IP address of the Source TCP port: ; Destination TCP Streaming Telemetry Server port: ; ; P3 = Source TCP port P4 = Destination TCP port Streaming Streaming Telemetry Error Dial-in connection attempt from Telemetry P1 = IP address of the B711.01 6671101 Telemetry Dial-In Client rejected; Telemetry Client IP: ; Streaming Telemetry Client Telemetry Server IP: ; Source TCP P2 = IP address of the port ; Destination TCP port: ; Streaming Telemetry Server Reason: ; ; P3 = Source TCP port P4 = Destination TCP port P5 = Vendor-specific text string indicating reason

P5 inclusion is optional. Streaming Streaming Telemetry Error Dial-in connection from Telemetry Client P1 = IP address of the B711.02 6671102 Telemetry Dial-In failed; Telemetry Client IP: ; Telemetry Streaming Telemetry Client Server IP: ; Source TCP port: ; P2 = IP address of the Destination TCP port: ; Reason: ; Streaming Telemetry Server ; P3 = Source TCP port P4 = Destination TCP port P5 = Vendor-specific text string indicating reason

P5 inclusion is optional Streaming Streaming Telemetry Error Dial-out connection from Telemetry Server P1 = IP address of the B711.03 6671103 Telemetry Dial-Out failed; Telemetry Server IP: ; Streaming Telemetry Server Telemetry Client IP: ; Source TCP port: P2 = IP address of the ; Destination TCP port: ; Reason: Streaming Telemetry Client ; ; P3 = Source TCP port P4 = Destination TCP port P5 = Vendor-specific text string indicating reason

P5 inclusion is optional

338 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Streaming Streaming Telemetry Error Dial-In Security Association failure during P1 = IP address of the B711.04 6671104 Telemetry Dial-In TLS negotiation; Telemetry Server IP: ; Streaming Telemetry Server Telemetry Client IP: ; Source TCP port: P2 = IP address of the ; Destination TCP port: ; Reason: Streaming Telemetry Client ; ; P3 = Source TCP port P4 = Destination TCP port P5 = Vendor-specific text string indicating reason

P5 inclusion is optional Streaming Streaming Telemetry Error Dial-Out Security Association failure during P1 = IP address of the B711.05 6671105 Telemetry Dial-Out TLS negotiation; Telemetry Client IP: ; Streaming Telemetry Client Telemetry Server IP: : Source TCP P2 = IP address of the port: ; Destination TCP port: : Streaming Telemetry Server Reason: ; ; P3 = Source TCP port P4 = Destination TCP port P5 = Vendor-specific text string indicating reason

P5 inclusion is optional

Notes 1. Refer to [R-DEPI] for description of UTID.

 09/03/21 CableLabs 339 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

B.1 Deprecated Events Table 303 in this annex lists deprecated events, including any associated syslog and SNMP trap notifications for the events, for a DOCSIS 3.1-compliant CCAP Core or RPD. Implementation of deprecated events is optional. Table 303 - Deprecated Events

Process Sub-Process Priority Event Message Error Event Notification Message Notes Code ID Name and Detail Set Connectivity Synchronization Error Loss of Clock B702.5 66070205 Sync Connectivity Synchronization Notice Clock Sync B702.6 66070206 Reestablished Connectivity Synchronization Warning Loss of Clock B702.7 66070207 Slave Connectivity Synchronization Notice Clock Slave B702.8 66070208 Reestablished DHCP Error Primary lease failed, B703.8 66070308 IPv4 fallback initiated Init DHCP Error Primary address B703.18 66070318 acquired, secondary failed Init DHCP Error Primary address failed, B703.19 66070319 secondary active SW Upgrade SW UPGRADE Error Disruption during SW Other than Local B704.9 66070409 GENERAL download - RF removed Log, append: FAILURE SW file: - SW server: < P2>

P1 = SW file name P2 = SW Download server IP address 55-1 RF Power Warning OOB 55-1 US low power P1 = RfPort B706.00 66070600 Upstream cell; Port: ; Ch P2 = Channel Center Freq: ; Center Power: ; ; Frequency P3 = Current Power Level 55-1 RF Power Warning OOB 55-1 US high P1 = RfPort B706.01 66070601 Upstream power cell; Port: ; P2 = Channel Ch Center Freq: ; Center Power: ; ; Frequency P3 = Current Power Level 55-1 Cell Quality Warning OOB 55-1 US excessive P1 = RfPort B706.02 66070602 Upstream corrected cells; Port: P2 = Channel ; Ch Center Freq: Center ; Cell Count: ; Frequency ; P3 = Current Cell Count 55-1 Cell Quality Warning OOB 55-1 US excessive P1 = RfPort B706.03 66070603 Upstream uncorrectable cells; Port: P2 = Channel ; Ch Center Freq: Center ; Cell Count: ; Frequency ; P3 = Current Cell Count

340 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Process Sub-Process Priority Event Message Error Event Notification Message Notes Code ID Name and Detail Set 55-1 Cell Quality Warning OOB 55-1 US excessive P1 = RfPort B706.04 66070604 Upstream total cells; Port: ; P2 = Channel Ch Center Freq: ; Center Cell Count: ; Frequency ; P3 = Current Cell Count 55-1 Cell Quality Notice OOB 55-1 US excessive P1 = RfPort B706.06 66070606 Upstream corrected cells ended; P2 = Channel Port: ; Ch Center Center Freq: ; Cell Count: Frequency ; ; P3 = Current Cell Count 55-1 Cell Quality Notice OOB 55-1 US excessive P1 = RfPort B706.07 66070607 Upstream uncorrectable cells P2 = Channel ended; Port: ; Ch Center Center Freq: ; Cell Frequency Count: ; ; P3 = Current Cell Count 55-1 Cell Quality Notice OOB 55-1 US excessive P1 = RfPort B706.08 66070608 Upstream total cells ended; Port: P2 = Channel ; Ch Center Freq: Center ; Cell Count: ; Frequency ; P3 = Current Cell Count PTP Synchronization Notice Slave found; Clock IP: P1 = Slave B707.04 66070704 PTP State ; ; Clock IP address PTP Synchronization Error Loss of slave; Clock IP: P1 = Slave B707.05 66070705 PTP State ; ; Clock IP address Connectivity RPD Error GCP connect timeout; P1 = RPD ID B801.06 66080106 docsDevCmts RPD-ID: ; ; EventNotif Connectivity RPD Error GCP Notify timeout; P1 = RPD ID B801.07 66080107 docsDevCmts RPD-ID: ; EventNotif ;

B.2 Example CCAP Core SNMP Notification and Syslog Event Message (Informative) The following are two examples SNMP Notification and Syslog message "Event Message" text strings for Event ID 66070401:

SW download INIT - via GCP; Filename: RPD-image-20181231-full-features.tar; Server IP: 10.102.33.15; Image Index: 1; RPD-ID: 00:11:22:33:44:55; and for Event ID 66080000:

Mutual Authentication error; RPD-IP: 192.162.33.15; Reason: Certificate Validation Failed; CCAP-CORE-ID: 00:AA:BB:CC:DD:EE;

B.3 Example RPD Syslog Event Message (Informative) The following is an examples of a Syslog message "Event Message" text strings for Event ID 66070401: <13>Jun 24 13:01:37 BSHPGATE06 dulcmgrd: 66070401 SW download INIT - via GCP; Filename: RPD-image- 20181231-full-features.tar; Server IP: 10.102.33.15; Image Index: 1; RPD-ID: 00:11:22:33:ab:cd

 09/03/21 CableLabs 341 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Annex C Data Type Definitions (Normative)

C.1 Overview This section includes the data type definitions for the Information Models defined for use in the CCAP Core. UML is used for modeling the management requirements. The data types defined in this section are mapped for use with SNMP MIBs, IPDR XML schemas, and YANG modules.

C.1.1 Data Types Mapping XML is one standard for data definition models and their encodings. With XML, data transformations can be done with or without a model (DTD or Schema definition). DTDs and XML schemas provide additional data validation layer to the applications exchanging XML data. There are several models to map formal notation constructs like ASN.1 to XML [ITU-T X.692], UML to XML, YANG to XML, or XML by itself can be used for modeling purposes. Each area of data information interest approaches XML and defines data models and/or data containment structures and data types. Similarly, SNMP took and modified a subset of ASN.1 for defining the Structured Management Information SMIv1 and SMIv2. Due to the lack of a unified data model and data types for Network Management, a neutral model would be appropriate to allow capturing specific requirements and methodologies from existing protocols and allow forward or reverse engineering of those standards like SNMP to the general object model and vice versa.

C.1.2 Data Types Requirements and Classification The Information Model has to provide seamless translation for SMIv2 requirements, in particular when creating MIB modules based on the Information Model. This specification needs to provide full support of [RFC 2578], [RFC 2579], and the clarifications and recommendations of [RFC 4181]. The Information Model has to provide seamless translation for YANG modeling requirements, in particular when creating YANG modules based on the Information Model. Thus, there are two data type groups defined for modeling purposes and mapping to protocol data notation roundtrip. • General data types Required data types to cover all the management syntax and semantic requirement for all OSSI supported data models. In this category are data types defined in SNMP SMIv2 [RFC 2578], and YANG common data types [RFC 6991]. • Extended data types Management protocols specialization based on frequent usage or special semantics. Required data types to cover all the syntax requirement for all OSSI supported data models. In this category are SNMP TEXTUAL-CONVENTION clauses [RFC 2579] of mandatory or recommended usage by [RFC 2579] and [RFC 4181] when modeling for SNMP MIB modules.

C.1.3 Data Type Mapping Methodology The specification "XML Schema Part 2: Data types Second Edition" is based on [ISO 11404], which provides language-independent data types (see XML Schema reference). The mapping proposed below uses a subset of the XML schema data types to cover both SNMP forward and reverse engineering, and IPDR types. Any additional protocol being added should be feasible to provide the particular mappings. SMIv2 has an extensive experience of data types for management purposes; for illustration consider Counter32 and Counter64 SMIv2 types [RFC 2578]. The XML schema data types makes no distinction of derived 'decimal' types and the semantics that are associated to counters, e.g., counters do not necessarily start at 0.

342 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Most of the SNMP information associated to data types are reduced to size and range constraints and specialized enumerations.

C.1.4 General Data Types (SNMP Mapping) Table 304 represents the mapping between the OSSI Information Model General Types and their equivalent representation for SNMP MIB Modules and IPDR Service Definitions. The permitted values for the data types are indicated in terms of value ranges and string length when applicable. The Information Model Data Type column includes the data types to map to SNMP, using the appropriated type in the corresponding protocol if applicable or available. The SNMP Mapping references to SNMP data types are defined in [RFC 2578] or as described below. Note that SNMP does not provide float, double or long XML-Schema data types. Also, SNMP might map a type to an SNMP subtyped value. For example, UnsignedByte data type maps to Unsigned32 subtyped to the appropriate range indicated by the Permitted Values (0..255 in this case). Other data types are mapped to SNMP TEXTUAL- CONVENTIONS as indicated by the references. Table 304 - General Data Types

UML Data Type XML-Schema Permitted Values SNMP Mapping data type AdminStateType enumeration other(1), up(2), down(3), testing(4) INTEGER Boolean Boolean true = 1 TruthValue false = 0 [RFC 2579] Byte byte -128..127 Integer32 Counter32 unsignedInt Counter32 Counter64 unsignedLong Counter64 DateTime dateTime SIZE (8 or 11) DateAndTime DateTimeMsec unsignedLong CounterBasedGauge64 [RFC 2856] Enum int -2147483648..2147483647 INTEGER EnumBits hexBinary BITS Gauge32 unsignedInt Gauge32 HexBinary hexBinary A sequence of octets. OCTET STRING InetAddress string SIZE (0..255) InetAddress [RFC 4001] (Deprecated) InetAddressIpv4 hexBinary SIZE (4) Octet string per [RFC 4001] (Deprecated) InetAddressIpv6 hexBinary SIZE (16) Octet string per [RFC 4001] (Deprecated) InetAddressType enumeration unknown(0), ipv4(1), ipv6(2), ipv4z(3), InetAddressType [RFC 4001] (Deprecated) ipv6z(4), dns(16) Int int -2147483648..2147483647 Integer32 IpAddress string IPv4 Address or IPv6 Address InetAddress + InetAddressType [RFC 4001] Ipv4Address string IPv4 Address InetAddressIPv4 [RFC 4001] Ipv6Address string IPv6 Address InetAddressIPv6 [RFC 4001] Long long -9223372036854775808..- N/A 9223372036854775807 MacAddress hexBinary SIZE (6) MacAddress Opaque hexBinary Opaque

 09/03/21 CableLabs 343 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

UML Data Type XML-Schema Permitted Values SNMP Mapping data type OperStatusType enumeration other(0), INTEGER up(1), down(2), testing(3), dormant(4), notPresent(5), lowerLayerDown(6) Short short -32768..32767 Integer32 String string Recommendation is to include an OCTET STRING upper bound on size of String. Note: SNMP usage should bound this type with an upper limit. Refer to SnmpAdminString [RFC 3411] description for possible values. UnsignedByte unsignedByte 0..255 Unsigned32 UnsignedInt unsignedInt 0..4294967295 Unsigned32 UnsignedLong unsignedLong 0..18446744073709551615 CounterBasedGauge64 [RFC 2856] UnsignedShort unsignedShort 0..65535 Unsigned32 Uuid hexBinary OCTET STRING UUIDorZero hexBinary OCTET STRING (SIZE (0|16)) [RFC 6933]

C.1.5 Primitive Data Types (YANG Mapping) Table 305 represents the mapping between the CCAP Core primitive data types and their equivalent representation in YANG. The permitted values for the data types are indicated in terms of value ranges and string length when applicable. The UML Primitive Data Type column includes the data types to map to YANG, using the appropriate type in YANG. The YANG Built-In Data Type Mapping references YANG data types defined in [RFC 6991] or as described below. Table 305 - Primitive Data Types

UML Primitive Data Type YANG Data Type Mapping Permitted Values AdminString String Length constrained to 0..255 Boolean Boolean true, false Byte int8 -128..127 Enum enumeration -2147483648..2147483647 EnumBits bits HexBinary ccap-octet-data-type ([0-9a-fA-F]{2})* Int int32 -2147483648..2147483647 Long int64 -9223372036854775808..9223372036854775807 Short int16 -32768..32767 String string UnsignedByte uint8 0..255 UnsignedInt uint32 0..4294967295 UnsignedLong uint64 0..18446744073709551615 UnsignedShort uint16 0..65535

C.1.6 Extended Data Types (SNMP Mapping) There are two sources of Extended Data Types: Protocol specific data types, and OSSI data types. SNMP derived types are defined in SNMP MIB Modules. The most important are in [RFC 2579], which is part of SNMP STD 58, and are considered in many aspects part of the SNMP protocol. Other MIB modules TEXTUAL-

344 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

CONVENTION definitions have been adopted and recommended (e.g., [RFC 4181]) for re-usability and semantics considerations in order to unify management concepts; some relevant RFCs that include commonly used textual conventions are [RFC 4001], [RFC 2863], [RFC 3411], and [RFC 3419] among others (see [RFC 4181]). Table 306 includes the most relevant data types taken from SNMP to provide a direct mapping of the OSSI Information Model to SNMP MIB modules. For example, TagList comes from [RFC 3413] SnmpTaglist and preserves its semantics; AdminString comes from [RFC 3411] SnmpAdminString. In general, when an OSSI Information Model needs to reference an existing SNMP textual convention for the purpose of round trip design from UML to SNMP, these textual conventions can be added to this list. Other sources of textual conventions not listed here are from MIB modules specific to DOCSIS, either as RFCs or Annex documents in this specification. Some of those sources are [RFC 4546] and Annex A. OSSI data types are also defined in this specification in the Data Type section of OSSI annexes; for example, Annex A. Table 306 - Extended Data Types

UML Data Type XML-Schema Permitted Values SNMP Mapping data type AdminString string SIZE (0..255) SnmpAdminString [RFC 3411] DocsEqualizerData hexBinary DocsEqualizerData [RFC 4546] DocsisQosVersion int DocsisQosVersion [RFC 4546] DocsisUpstreamType int DocsisUpstreamType [RFC 4546] Duration unsignedInt 0..2147483647 TimeInterval InetAddressPrefixLength unsignedInt 0..2040 InetAddressPrefixLength [RFC 4001] InetPortNumber unsignedInt 0..65535 Unsigned32 PhysicalIndexOrZero unsignedInt 0..2147483647 Integer32 RowStatus int RowStatus StorageType int StorageType TagList string SIZE (0..255) SnmpTaglist TenthdB int TenthdB [RFC 4546] TenthdBmV int TenthdBmV [RFC 4546] TimeStamp unsignedInt TimeStamp

C.1.7 Derived Data Types (YANG Mapping) Table 307 represents the mapping between the CCAP Core derived data types and their equivalent representation in YANG. The permitted values for the data types are indicated in terms of value ranges and string length when applicable. The UML Derived Data Type column includes the data types to map to YANG, using the appropriate type in YANG. The YANG Derived Data Type Mapping references YANG data types defined in [RFC 6991] or as described below. Table 307 - Derived Data Types

UML Derived Data Type YANG Derived Data Type Mapping Permitted Values AdminStateType admin-state-type other(1), up(2), down(3), testing(4) Counter32 counter32 Counter64 counter64 Gauge32 gauge32 IpAddress ip-address IPv4 Address or IPv6 Address Ipv4Address ipv4-address Ipv6Address ipv6-address InetAddressPrefixLength address-prefix-len-type 0..2040 InetIpv4Prefix ipv4-prefix IPv4 Address "/" IPv4 Prefix Length

 09/03/21 CableLabs 345 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

UML Derived Data Type YANG Derived Data Type Mapping Permitted Values InetIpv6Prefix ipv6-prefix IPv6 Address "/" IPv6 Prefix Length InetPortNumber port-number 0..65535 MacAddress mac-address e.g., 01:23:45:67:89:ab TagList snmp-tag-list-type String(SIZE(0..255)) TenthHz uint8 0..9 TimeStamp timestamp Uri uri

C.2 Remote PHY Common Data Type Definitions There are no additional data types created specifically to support the Remote PHY Information Models. Refer to the CCAP Data Type Definitions section of [CCAP-OSSIv4.0] for common data type definitions that may be used in the Remote PHY Information Models.

C.3 Common Terms Shortened The following table lists common terms which have been shortened to allow shorter SNMP MIB names. These shortened names are desired to be used consistently throughout the object models, SNMP MIBs and IPDR schemas. However, in some cases it might not be possible to maintain parity with pre-3.0 DOCSIS requirements. Table 308 - Shortened Common Terms

Original Word Shortened Word Address Addr Aggregate Agg Algorithm Alg Allocation Alloc Application App Attribute Attr Authorization Auth Channel Ch Command Cmd Config* Cfg Control Ctrl Default Def Destination Dest Direction Dir Downstream Ds Encryption Encrypt Equalization Eq Group Grp Length Len Maximum Max Minimum Min Multicast Mcast Provision* Prov Receive Rx Registration Reg Replication Repl

346 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Original Word Shortened Word Request Req Resequence Reseq Resequencing Reseq Response Rsp Segment Sgmt Sequence Seq Service Svc ServiceFlow Sf Session(s) Sess Source Src Threshold Thrshld Total Tot Transmit Tx Upstream Us * indicates a wildcard

C.3.1 Exceptions Data types and managed objects do not consistently use the shortened names. Also, the term ServiceFlowId remains unchanged. Service and ServiceFlow are often not shortened to retain backward compatibility with QoS-managed objects.

 09/03/21 CableLabs 347 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Appendix I Acknowledgments (Informative)

On behalf of the cable industry and our member companies, CableLabs would like to thank the following individuals for their contributions to the development of this specification.

Contributor Company Affiliation Tom Ferreira Commscope Mark Lynch Commscope Rei Brockket Commscope Victor Hou Broadcom Niki Pantelias Broadcom Nikhil Tayal CableLabs Gerry White CableLabs Dave Fox Casa Systems Pankaj Singh Casa Systems Philip Anderson Charter Pawel Sowinski Cisco Joe Solomon Comcast John Bevilacqua Comcast Albert Higashi Cox Andrew Sundelin Dial in the Sun, LLC Michael Cookish Harmonic, Inc. Michael Patrick Harmonic, Inc. Kirk Erichsen OAM Technology Consulting, LLC Brian Hedstrom OAM Technology Consulting, LLC Kevin Luehrs OAM Technology Consulting, LLC

348 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Appendix II Revision History

Engineering Changes incorporated into CM-SP-R-OSSI-I02-160121

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-15.1378-1 10/14/2015 New control objects for R-PHY Solomon R-OSSI-N-15.1407-1 12/16/2015 Section 11 SNMP MIB requirements and Annex A Tayal updates R-OSSI-N-15.1411-3 12/16/2015 Section 8.1 Secure Shell Requirements Ferreira R-OSSI-N-15.1412-4 12/16/2015 Section 11 SNMP MIB requirements, R-PHY MIB, and Solomon Annex A updates

Engineering Changes incorporated into CM-SP-R-OSSI-I03-160512

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-15.1409-2 1/27/2016 Updates to RPD Secure Software Download for R-OSSI Sowinski R-OSSI-N-16.1429-1 3/2/2016 ifType and Annex A N-ACC corrections Hedstrom R-OSSI-N-16.1436-1 3/10/2016 Move section 6 to Appendix/Annex Hedstrom R-OSSI-N-16.1442-1 3/24/2016 Move section 11.3.7 info model to section 8 Hedstrom R-OSSI-N-16.1443-2 3/24/2016 Updates to Session Reporting Solomon R-OSSI-N-16.1446-2 3/24/2016 Event Definitions for CCAP Core Hedstrom R-OSSI-N-16.1448-2 4/14/2016 Event Definitions and Mechanism for RPD Hedstrom R-OSSI-N-16.1454-1 4/14/2016 Align CCAP Core Configuration of CW Tones with other Sowinski specifications R-OSSI-N-16.1461-3 4/21/2016 Addition of DOCS-RPHY-MIB Hedstrom R-OSSI-N-16.1465-2 4/21/2016 R-PHY security certificates Hedstrom R-OSSI-N-16.1466-1 4/21/2016 RPHY OSSI YANG and XSD Modules Hedstrom R-OSSI-N-16.1469-1 4/21/2016 Clarification of RPD Control Address Hedstrom R-OSSI-N-16.1475-2 4/21/2016 Correction from previous ECNs and updates to section Kim 10 R-OSSI-N-16.1494-1 4/21/2016 Move SSH requirements to Section 12 Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I04-160923

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-16.1589-2 9/1/2016 Updates to RPHY YANG/XML data model Hedstrom R-OSSI-N-16.1587-3 9/1/2016 Annex A updates Hedstrom R-OSSI-N-16.1585-4 9/1/2016 Updates to RPHY Monitoring Model and TLV mappings Hedstrom R-OSSI-N-16.1579-1 9/1/2016 OOB SCTE 55-1 Configuration Information Model Hedstrom R-OSSI-N-16.1578-3 9/1/2016 RPD Fault Management Info Model Hedstrom R-OSSI-N-16.1559-2 9/1/2016 New RPD Event Definitions Hedstrom R-OSSI-N-16.1542-1 7/7/2016 Corrections to SessionInfo Hedstrom R-OSSI-N-16.1540-2 7/28/2016 Update ChannelOutputDerate range Solomon R-OSSI-N-16.1530-1 7/7/2016 Updates to Network Configuration for CIN latency Solomon R-OSSI-N-16.1524-2 6/9/2016 CCAP Core Control Info Model Hedstrom R-OSSI-N-16.1521-1 6/2/2016 I02 ECN Corrections Hedstrom R-OSSI-N-16.1512-2 8/18/2016 CCAP Annex A updates for DOCS-BPI2EXT-MIB Hedstrom

 09/03/21 CableLabs 349 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

Engineering Changes incorporated into CM-SP-R-OSSI-I05-170111

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-16.1597-1 9/29/2016 Expansion of RPD Event Definitions Hedstrom R-OSSI-N-16.1598-1 9/29/2016 Update CCAP Chassis Class Diagram Hedstrom R-OSSI-N-16.1599-2 12/15/2016 Updates to RPD Fault Management Info Model and Hedstrom Scenarios R-OSSI-N-16.1600-5 12/1/2016 Updates to RPD IF Monitoring Info Model Hedstrom R-OSSI-N-16.1607-1 10/20/2016 Create RPD Management Architecture Model Hedstrom R-OSSI-N-16.1608-3 12/1/2016 Updates to RPD IP Monitoring Info Model Hedstrom R-OSSI-N-16.1626-1 11/3/2016 Add Normative language for LEDs on RPD/RMD Hedstrom devices R-OSSI-N-16.1627-1 11/3/2016 Additional R-PHY SNMP and MIB Requirements Clean Hedstrom Up R-OSSI-N-16.1628-3 12/1/2016 Updates to CCAP Core General Monitoring Info Model Hedstrom R-OSSI-N-16.1639-1 11/10/2016 RPHY Remove Normative Keywords from Tables Hedstrom R-OSSI-N-16.1642-3 12/15/2016 Annex A MIB Object Requirement Updates Hedstrom R-OSSI-N-16.1648-1 11/23/2016 Organization of Document Section 1.5 missing sections Hedstrom R-OSSI-N-16.1653-4 12/15/2016 R-DTI Configuration Information Model Hedstrom R-OSSI-N-16.1659-2 12/15/2016 YANG and XML data model updates for R-DTI Hedstrom configuration R-OSSI-N-16.1660-2 12/15/2016 Sample CCAP XML Configuration Hedstrom R-OSSI-N-16.1661-2 12/15/2016 Clarify RpdCfg and Control sections Hedstrom R-OSSI-N-16.1681-3 12/15/2016 Introduction of standard interface types for RPHY Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I06-170524

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-16.1689-5 4/13/2017 Updates to the RPD Information Models Solomon R-OSSI-N-17.1691-4 4/13/2017 CCAP Core Network Configuration Info Model updates Hedstrom R-OSSI-N-17.1693-5 4/13/2017 Updates to CCAP Core RPD Device Info Model Hedstrom R-OSSI-N-17.1696-1 4/13/2017 CCAP R-DTI Configuration Information Model Updates Hedstrom R-OSSI-N-17.1700-4 4/13/2017 Update to ANNEX A DOCS-RPHY-MIB Object Details Hedstrom R-OSSI-N-17.1702-3 4/13/2017 RPHY OSS Omnibus EC Hedstrom R-OSSI-N-17.1703-3 4/13/2017 CCAP Core RPD Control Information Model Updates Hedstrom R-OSSI-N-17.1707-2 4/13/2017 New DOCSIS RPHY Control MIB Hedstrom R-OSSI-N-17.1714-1 4/13/2017 Updates to Sample CCAP Core XML Configuration Hedstrom R-OSSI-N-17.1721-3 4/13/2017 New CCAP Core PTP Status Information Model section Hedstrom R-OSSI-N-17.1724-3 4/13/2017 Add Support for Virtual Combining and Splitting Hedstrom R-OSSI-N-17.1725-1 4/13/2017 XML Schema and YANG data model updates Hedstrom R-OSSI-N-17.1726-3 4/13/2017 New Security Information Model Hedstrom R-OSSI-N-17.1728-4 4/13/2017 Major updates to Section 10 Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I07-170908

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-17.1739-2 6/8/2017 Add new attribute to CwTones Hedstrom R-OSSI-N-17.1745-2 6/22/2017 Capabilities TLV has been updated in the System Spec. Hedstrom

350 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-17.1746-3 7/13/2017 Update Config Information Model for OOB SCTE 55-1 Hedstrom R-OSSI-N-17.1747-1 6/29/2017 Clarify RPD Reset options Hedstrom R-OSSI-N-17.1749-2 7/13/2017 Add missing Control object GCP TLVs Hedstrom R-OSSI-N-17.1757-1 7/13/2017 ENTITY-MIB RFC 4133 is obsoleted by RFC 6933 Hedstrom R-OSSI-N-17.1758-1 7/13/2017 PNM Addition for RPHY Hedstrom R-OSSI-N-17.1759-1 7/13/2017 docsRphyCcapL2tpSessionFlowTable missing Phbid Hedstrom R-OSSI-N-17.1762-2 7/27/2017 Move RPD PTP Classes to their own class diagram Hedstrom R-OSSI-N-17.1769-1 7/27/2017 Add Host Resources Managed Objects and TLVs for Hedstrom RPD R-OSSI-N-17.1770-3 8/10/2017 Need to define status info model for events for BMCA Hedstrom (Best Master Clock Algorithm) R-OSSI-N-17.1772-1 8/10/2017 Define OperStatus data type and replace AdminState Hedstrom with AdminStateType R-OSSI-N-17.1773-1 8/10/2017 Need a CCAP/CMTS MIB object to determine to which Hedstrom RPD a CM is connected R-OSSI-N-17.1774-1 8/10/2017 Replace all occurrences of TimeTicks with TimeStamp Hedstrom R-OSSI-N-17.1775-1 8/10/2017 Need to clarify how ifStackTable works for virtual Hedstrom splitting and combining R-OSSI-N-17.1779-1 8/10/2017 Update YANG files for I07 Hedstrom R-OSSI-N-17.1786-3 8/10/2017 Clarify RPD 'SSD Complete' status Hedstrom R-OSSI-N-17.1787-2 8/10/2017 Clarification of normative requirement statements Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I08-171220

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-17.1795-1 8/24/2017 Update CW Tones object Hedstrom R-OSSI-N-17.1796-1 8/31/2017 Add RPD VspSelector attribute to Capabilities object Hedstrom R-OSSI-N-17.1797-1 8/31/2017 Incorporate OSS Event Definitions for new RPHY Event Hedstrom Codes R-OSSI-N-17.1799-2 9/21/2017 Add SSD control object to the RPD's Control Info Model Hedstrom R-OSSI-N-17.1808-2 11/2/2017 RegStatus and CwTone updates Hedstrom R-OSSI-N-17.1811-4 11/16/2017 GCP objects for L2TPv3 session traffic Hedstrom R-OSSI-N-17.1825-1 11/16/2017 A configuration variable to disable mutual authentication Hedstrom at GCP connection startup R-OSSI-N-17.1826-1 11/16/2017 Clarify SSD status when SSD failed Hedstrom R-OSSI-N-17.1828-2 11/16/2017 CCAP Core XML Configuration File Updates for new Hedstrom YANG Module R-OSSI-N-17.1831-2 11/16/2017 YANG updates for I08 Release Hedstrom R-OSSI-N-17.1833-1 11/16/2017 Add CCAP Core GCP KA configuration Hedstrom R-OSSI-N-17.1837-4 11/16/2017 R-OSSI updates to implement recent RPD Init additions Hedstrom R-OSSI-N-17.1848-5 11/16/2017 Additional RPD error counters Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I09-180509

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-17.1850-2 2/1/2018 Update Appendix I UML Info Model notation Hedstrom R-OSSI-N-17.1852-1 1/4/2018 RpdEvReportingCfg and DefaultRpdEvReportingCfg Hedstrom object issues

 09/03/21 CableLabs 351 CM-SP-R-OSSI-I16-210903 Data-Over-Cable Service Interface Specifications

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-17.1853-3 3/8/2018 Update Annex B TAGS for CCAP ID and RPD ID Hedstrom R-OSSI-N-17.1857-1 1/18/2018 Update RPD abbreviations Hedstrom R-OSSI-N-17.1858-1 1/18/2018 Update to Figure 20 RPD Fault Management Reporting Hedstrom Information Model R-OSSI-N-17.1859-1 1/18/2018 GcpKeepAliveInterval should permit a zero value Hedstrom R-OSSI-N-17.1860-1 1/18/2018 CwTones::Frequency clarification Hedstrom R-OSSI-N-18.1861-5 4/12/2018 Issues with Annex B Hedstrom R-OSSI-N-18.1869-2 3/15/2018 Add support for Multiple Software Images on the RPD Hedstrom R-OSSI-N-18.1870-1 3/1/2018 DepiMcastSession class: SessionId should be a Key Hedstrom R-OSSI-N-18.1871-2 3/15/2018 Need GCP TLVs for Figure 16 - RPD PTP Status Hedstrom Information Model R-OSSI-N-18.1880-1 3/15/2018 Add IpAcquisition configuration support Hedstrom R-OSSI-N-18.1883-2 4/5/2018 Configurable Preambles Patrick R-OSSI-N-18.1884-1 4/5/2018 Add UML Use Case section to Appendix I Hedstrom R-OSSI-N-18.1898-2 4/12/2018 I08 Omnibus Hedstrom R-OSSI-N-18.1904-1 4/12/2018 YANG Module updates for I09 Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I10-180926

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-18.1933-4 7/26/2018 Updated RPD Device Information Model with separate Hedstrom RPD Capabilities information model R-OSSI-N-18.1934-3 7/26/2018 Add indexing to RPD Interface and RPD Statistics info Hedstrom models to enable channel splitting and combining from a single RPD R-OSSI-N-18.1945-3 8/30/2018 RPHY OSS I10 Compilation EC Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I11-190121

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-18.1960-1 10/18/2018 New DOCS-RPHY-SEC-MIB for RPHY OSS I10 Hedstrom Release R-OSSI-N-18.1961-1 10/18/2018 Annex A updates for MIB changes for RPHY OSS I10 Hedstrom Release R-OSSI-N-18.1963-1 10/25/2018 YANG Module updates for I10 Hedstrom R-OSSI-N-18.1977-2 12/13/2018 RPHY OSS I10 Compilation EC Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I12-190510

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-18.1988-2 1/24/2019 Annex A updates for MIB changes for RPHY OSS I11 Hedstrom Release R-OSSI-N-19.2013-2 5/2/2019 RPHY OSSI I12 Compilation EC Hedstrom

352 CableLabs® 09/03/21 Remote PHY OSS Interface Specification CM-SP-R-OSSI-I16-210903

Engineering Changes incorporated into CM-SP-R-OSSI-I13-190828

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-19.2029-1 7/3/2019 Remote PHY YANG module update for RPHY OSSI Lynch I12 specification release R-OSSI-N-19.2038-4 8/8/2019 Remote PHY OSSI I13 Compilation Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I14-200421

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-19.2053-2 9/26/2019 Annex A MIB Object Details updates for MIB changes Hedstrom for RPHY OSS I13 release R-OSSI-N-19.2055-1 10/3/2019 Remote PHY YANG module update for RPHY OSSI Hedstrom I13 specification release R-OSSI-N-19.2059-1 11/27/2019 Remove extension points from Remote PHY YANG Hedstrom module R-OSSI-N-20.2089-1 4/9/2020 Remote PHY OSSI I14 Compilation Hedstrom

Engineering Changes incorporated into CM-SP-R-OSSI-I15-210301

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-20.2090-1 5/7/2020 Remote PHY OSSI I15 compilation Burroughs R-OSSI-N-20.2100-1 5/28/20 Annex A - MIB Object Details updates to RPHY OSS Burroughs I14 issued specification R-OSSI-N-21.2144-2 2/4/2021 RPHY YANG module updates for Remote PHY OSSI Hedstrom I14

Engineering Change incorporated into CM-SP-R-OSSI-I16-210903

ECN Identifier Accepted Date Title of EC Author R-OSSI-N-21.2185-2 8/19/2021 Remote PHY OSSI I16 compilation Hedstrom

✽ ✽ ✽

 09/03/21 CableLabs 353