Network Working Group Y. Jiang J. Lv Internet-Draft Huawei L. Han Intended status: Standards Track China Mobile Expires: January 2020 July 13, 2020 YANG Data Model for Sync PHY draft-jiang-ccamp-syncphy-yang-00 Abstract This document defines a YANG data model for the configuration of physical layer synchronization including SyncE and SyncO. The YANG module in this document conforms to the Network Management Datastore Architecture (NMDA). Status of this Memo This Internet-Draft is submitted in full conformance with the provisions of BCP 78 and BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF). Note that other groups may also distribute working documents as Internet-Drafts. The list of current Internet-Drafts is at https://datatracker.ietf.org/drafts/current/. Internet-Drafts are draft documents valid for a maximum of six months and may be updated, replaced, or obsoleted by other documents at any time. It is inappropriate to use Internet-Drafts as reference material or to cite them other than as "work in progress." This Internet-Draft will expire on January 13, 2019. Copyright Notice Copyright (c) 2020 IETF Trust and the persons identified as the document authors. All rights reserved. This document is subject to BCP 78 and the IETF Trust's Legal Provisions Relating to IETF Documents (http://trustee.ietf.org/license-info) in effect on the date of publication of this document. Please review these documents carefully, as they describe your rights and restrictions with respect to this document. Code Components extracted from this document must include Simplified BSD License text as described in Jiang, et al Expires January 13, 2021 [Page 1] Internet-Draft Sync PHY YANG Model July 2020 Section 4.e of the Trust Legal Provisions and are provided without warranty as described in the Simplified BSD License. Table of Contents 1. Introduction .............................................. 2 1.1. Conventions used in this document ...................... 3 1.2. Terminology ............................................ 3 2. Sync PHY YANG Model hierarchy ............................. 3 3. Sync PHY YANG Module ...................................... 5 4. Security Considerations .................................. 14 5. IANA Considerations ...................................... 14 6. References ............................................... 14 6.1. Normative References .................................. 14 6.2. Informative References ................................ 15 7. Acknowledgments .......................................... 15 1. Introduction Frequency synchronization based on physical layer clock is generally implemented in network elements and deployed widely in various networks. To achieve frequency synchronization, the physical clock is delivered from a PRTC to an end device across the network over a series of physical links such as PDH, SDH/SONET, OTN or IEEE 802.3. This document defines a YANG data model for the configuration of frequency synchronization over a single physical link (simplified as Sync PHY) such as Sync Ethernet (SyncE) or Synchronous Optical Transport Network (SyncO). The data model is constructed based on the management attributes as specified in [ITU781] and reference source selection architecture as described in [ITU8264]. The data model is targeted at supporting generic Sync PHY for network elements and industrial internet devices, the details on these physical layer synchronization can refer to those ITU-T recommendations such as [ITU783], [ITU8021], [ITU798] and are out of scope of this document. The YANG module in this document conforms to the Network Management Datastore Architecture (NMDA) [RFC8342]. Jiang, et al Expires January 13, 2021 [Page 2] Internet-Draft Sync PHY YANG Model July 2020 1.1. Conventions used in this document The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and "OPTIONAL" in this document are to be interpreted as described in BCP 14 [RFC2119] [RFC8174] when, and only when, they appear in all capitals, as shown here. 1.2. Terminology Most terminologies used in this document are extracted from ITU recommendations. OTN Optical Transport Network SDH Synchronous Digital Hierarchy SyncE Synchronous Ethernet SyncO Synchronous Optical Transport Network 2. Sync PHY YANG Model hierarchy This section describes the hierarchy of the Sync-PHY YANG module. Query and configuration of Sync-PHY information include: - sync-node includes all the sync-phy node wide attributes. - port-list includes all the sync-phy port-specific attributes. - system-clock includes all the system clock attributes. - station-clock includes all the station clock attributes. The readers are assumed to be familiar with the specific ITU-T recommendations. This document only outlines each of them in the YANG module. A simplified YANG tree diagram [RFC8340] representing the data model is typically used by YANG modules. This document uses the same tree diagram syntax as described in [RFC8340]. Jiang, et al Expires January 13, 2021 [Page 3] Internet-Draft Sync PHY YANG Model July 2020 module: ietf-sync-phy +--rw sync-phy +--rw sync-node | +--rw sync-network-option sync-network-option-enumeration | +--ro local-quality-level quality-level-enumeration | +--rw quality-level-enabled boolean | +--rw revertive-enabled boolean | +--rw wtr-time uint8 | +--rw holdoff-time uint16 +--rw port-list | +--rw name if:interface-ref | +--rw port-type port-type-enumeration | +--rw sync-enabled boolean | +--rw ql-overwrite-enabled boolean | +--rw ql-overwrite-val quality-level-enumeration | +--ro ql-in quality-level-enumeration | +--ro ql-out quality-level-enumeration | +--rw ssm-transmit-enabled boolean +--rw system-clock | +--rw port-list | | +--rw name if:interface-ref | | +--rw priority uint32 | +--ro selected-source if:interface-ref | +--rw run-mode run-mode-enumeration +--rw station-clock +--rw port-list | +--rw name if:interface-ref | +--rw priority uint32 +--rw ql-min uint8 +--ro selected-source if:interface-ref +--ro out-source if:interface-ref Jiang, et al Expires January 13, 2021 [Page 4] Internet-Draft Sync PHY YANG Model July 2020 3. Sync PHY YANG Module This module imports typedef "interface-ref" from [RFC8343]. Most attributes are based on the management information defined in [ITU781], but their names are adapted to the YANG style of naming. file "ietf-syncphy@2020-07-09.yang" module ietf-syncphy { yang-version 1.1; namespace "urn:ietf:params:xml:ns:yang:ietf-syncphy"; prefix "syncphy"; import ietf-interfaces { prefix if; reference "RFC8343: A YANG Data Model for Interface Management"; } organization "IETF CCAMP Working Group"; contact "WG Web: http://tools.ietf.org/wg/ccamp/ WG List: Author: Yuanlong Jiang Author: Jingfei Lv Author: Liuyan Han "; description "This YANG module defines a data model for the configuration and management of Sync PHY."; revision "2020-07-09" { description "Initial version"; reference "draft-jiang-ccamp-syncphy-yang: YANG Data Model for Sync PHY"; } typedef sync-network-option-enumeration { type enumeration { enum "OptionUnknown" { value "1"; } enum "Option1" { value "2"; } enum "Option2Gen1" { Jiang, et al Expires January 13, 2021 [Page 5] Internet-Draft Sync PHY YANG Model July 2020 value "3"; } enum "Option2Gen2" { value "4"; } enum "Option3" { value "5"; } enum "OptionInvalid" { value "6"; } } description "The Network synchronization networking options. Values for this enumeration are specified in G.781."; reference "ITU-T G.781-2017: 5.3.1"; } typedef quality-level-enumeration { type enumeration { enum "QualityLevelNULL" { value "1"; } enum "QualityLevelDNU" { value "2"; } enum "QualityLevelDUS" { value "3"; } enum "QualityLeveleEEC" { value "4"; } enum "QualityLevelePRTC" { value "5"; } enum "QualityLevelFAILED" { value "6"; } enum "QualityLevelINV0" { value "7"; } enum "QualityLevelINV1" { value "8"; } enum "QualityLevelINV2" { Jiang, et al Expires January 13, 2021 [Page 6] Internet-Draft Sync PHY YANG Model July 2020 value "9"; } enum "QualityLevelINV3" { value "10"; } enum "QualityLevelINV4" { value "11"; } enum "QualityLevelINV5" { value "12"; } enum "QualityLevelINV6" { value "13"; } enum "QualityLevelINV7" { value "14"; } enum "QualityLevelINV8" { value "15"; } enum "QualityLevelINV9" { value "16"; } enum "QualityLevelINV10" { value "17"; } enum "QualityLevelINV11" { value "18"; } enum "QualityLevelINV12" { value "19"; } enum "QualityLevelINV13" { value "20"; } enum "QualityLevelINV14" { value "21"; } enum "QualityLevelINV15" { value "22"; } enum "QualityLevelNSUPP" { value "23"; } enum "QualityLevelPRC" { value "24"; } Jiang, et al Expires January 13, 2021 [Page 7] Internet-Draft Sync PHY YANG Model July 2020 enum "QualityLevelPROV" { value "25"; } enum "QualityLevelPRS" { value "26"; } enum "QualityLevelPRTC" { value "27"; } enum "QualityLevelSEC" { value "28"; } enum "QualityLevelSMC" { value "29"; } enum "QualityLevelSSUA" { value "30"; } enum "QualityLevelSSUB" { value "31"; } enum "QualityLevelST2" { value "32"; } enum "QualityLevelST3" { value "33"; } enum "QualityLevelST3E" { value "34"; } enum "QualityLevelST4" { value "35"; } enum "QualityLevelSTU" { value "36"; } enum "QualityLevelTNC" { value "37"; } enum "QualityLevelUNC" { value "38"; } enum "QualityLevelUNK" { value "39"; } } description Jiang, et al Expires January 13, 2021 [Page 8] Internet-Draft Sync PHY YANG Model July 2020 "Clock source QL (quality level) as defined in ITU-T G.781."; reference "ITU-T standard G.781 section 5.4"; } typedef port-type-enumeration { type enumeration { enum "IfTypeE1" { value "1"; } enum "IfTypeT1" { value "2"; } enum "IfType2Mhz" { value "3"; } enum "IfType2Mbit" { value "4"; } enum "IfTypeSDH" { value "5"; } enum "IfTypeSONET" { value "6"; } enum "IfTypeEthernet" { value "7"; } enum "IfTypeOTN" { value "8"; } } description "Sync clock source Interface type. Values for this enumeration are specified in G.781."; reference "ITU-T G.781-2017: 5.3.1"; } typedef run-mode-enumeration { type enumeration { enum "ModeFreeRun" { value "1"; } enum "ModeHoldover" { value "2"; } enum "ModeLocked" { Jiang, et al Expires January 13, 2021 [Page 9] Internet-Draft Sync PHY YANG Model July 2020 value "3"; } } description "The clock operation mode. Values for this enumeration are specified in G.781."; reference "ITU-T G.781-2017: 6.3.1"; } container sync-phy { description "The sync-phy contains all attributes of Sync-PHY, optional attributes can be augmented to this node."; container sync-node { description "The sync-node contains all the node-level Sync-PHY management attributes for an equipment."; leaf sync-network-option { type sync-network-option-enumeration; description "The Network synchronization networking options. Values for this enumeration are specified in G.781."; reference "ITU-T G.781-2017: 5.3.1"; } leaf local-quality-level { type quality-level-enumeration; config false; description "The local QL retrieved."; } leaf quality-level-enabled { type boolean; description "Whether QL is enabled or not."; } leaf revertive-enabled { type boolean; description "Whether revertive mode is enabled or not."; } leaf wtr-time { type uint8 { range "0..12"; } default "5"; Jiang, et al Expires January 13, 2021 [Page 10] Internet-Draft Sync PHY YANG Model July 2020 description "The WTR time in the unit of minute for selection processes in common."; } leaf holdoff-time { type uint16 { range "300..1800"; } description "The Holdoff time in the unit of ms for selection processes in common."; } } list port-list { key "name"; description "List of one or more PHY ports in the device (see G.871). Each item of port-list represents port-level management information for a physical port."; leaf name { type if:interface-ref; description "The interface name of the physical port."; } leaf port-type { type port-type-enumeration; description "The interface type of the physical port."; } leaf sync-enabled { type boolean; description "Whether sync mechanism is enabled or not."; } leaf ql-overwrite-enabled { type boolean; description "Whether QL overwrite is enabled or not, if not enabled, it means QL will pass through."; } leaf ql-overwrite-val { type quality-level-enumeration; description "The quality level used if overwrite mode is enabled."; } leaf ql-in { Jiang, et al Expires January 13, 2021 [Page 11] Internet-Draft Sync PHY YANG Model July 2020 type quality-level-enumeration; description "After overwrite or pass through, the final QL fed into the clock."; } leaf ql-out { type quality-level-enumeration; description "The output QL for the physical port."; } leaf ssm-transmit-enabled { type boolean; description "Whether SSM transmit is enabled or not."; } } container system-clock { description "The system-clock contains all attributes on management of the system clock in an equipment."; list port-list { key "name"; description "List of one or more source clock PHY ports for the system clock (see G.871). Each port-list item represents management information on a clock source physical port used in the system clock."; leaf name { type if:interface-ref; description "The interface name of the clock source physical port."; } leaf priority { type uint32; description "The source priority of the physical port."; } } leaf selected-source { type if:interface-ref; description "The selected source clock physical port."; } leaf run-mode { type run-mode-enumeration; Jiang, et al Expires January 13, 2021 [Page 12] Internet-Draft Sync PHY YANG Model July 2020 description "The run mode of the system clock."; } } container station-clock { description "The station-clock contains all attributes on management of the station clock in an equipment."; list port-list { key "name"; description "List of one or more source clock PHY ports for the station clock (see G.871). Each port-list item represents management information on a clock source physical port used in the station clock."; leaf name { type if:interface-ref; description "The interface name of the clock source physical port."; } leaf priority { type uint32; description "The source priority of the physical port."; } } leaf ql-min { type uint8; description "The minimum QL of the system clock."; } leaf selected-source { type if:interface-ref; description "The current selected source of the station clock by automatic process."; } leaf out-source { type if:interface-ref; description "The final output source for the station clock."; } } } } Jiang, et al Expires January 13, 2021 [Page 13] Internet-Draft Sync PHY YANG Model July 2020 4. Security Considerations TBD. 5. IANA Considerations This document proposes the following URI in the "IETF XML registry" [RFC3688]: URI: urn:ietf:params:xml:ns:yang:ietf-syncphy Registrant Contact: The IESG XML: N/A; the requested URI is an XML namespace This document proposes the following YANG module in the "YANG Module Names" registry [RFC6020]: Name: ietf-syncphy Namespace: urn:ietf:params:xml:ns:yang:ietf-syncphy Prefix: syncphy Reference: this document 6. References 6.1. Normative References [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997 [RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688, January 2004 [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF) ", RFC 6020, October 2010 [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, July 2013 [RFC7950] Bjorklund, M., "The YANG 1.1 Data Modeling Language", RFC 7950, August 2016 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 2119 Key Words", BCP 14, RFC 8174, May 2017 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., and R. Wilton, "Network Management Datastore Architecture (NMDA)", RFC 8342, March 2018 Jiang, et al Expires January 13, 2021 [Page 14] Internet-Draft Sync PHY YANG Model July 2020 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface Management", RFC 8343, March 2018 [ITU781] ITU-T, "Synchronization layer functions", ITU-T G.781, August 2017 [ITU8264] ITU-T, "Distribution of timing information through packet networks", ITU-T G.8264 Amendment 1, March 2018 6.2. Informative References [RFC7384] Mizrahi, T., "Security Requirements of Time Protocols in Packet Switched Networks", RFC 7384, October 2014 [RFC8340] Bjorklund, M., and Berger, L., "YANG Tree Diagrams", RFC 8340, March 2018 [ITU783] ITU-T, "Characteristics of synchronous digital hierarchy (SDH) equipment functional blocks", ITU-T G.783, March 2006 [ITU798] ITU-T, "Characteristics of optical transport network hierarchy equipment functional blocks", ITU-T G.798 Amendment 1, August 2018 [ITU8021] ITU-T, "Characteristics of Ethernet transport network equipment functional blocks", ITU-T G.8021, June 2018 7. Acknowledgments TBD. Jiang, et al Expires January 13, 2021 [Page 15] Internet-Draft Sync PHY YANG Model July 2020 Authors' Addresses Yuanlong Jiang Huawei Technologies Co., Ltd. Bantian, Longgang district Shenzhen 518129, China Email: jiangyuanlong@huawei.com Jingfei Lv Huawei Technologies Co., Ltd. lvjingfei@huawei.com Liuyan Han China Mobile hanliuyan@chinamobile.com Jiang, et al Expires January 13, 2021 [Page 16]