idnits 2.17.1 draft-jiang-tictoc-syncphy-yang-00.txt: Checking boilerplate required by RFC 5378 and the IETF Trust (see https://trustee.ietf.org/license-info): ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/1id-guidelines.txt: ---------------------------------------------------------------------------- No issues found here. Checking nits according to https://www.ietf.org/id-info/checklist : ---------------------------------------------------------------------------- No issues found here. Miscellaneous warnings: ---------------------------------------------------------------------------- == The copyright year in the IETF Trust and authors Copyright Line does not match the current year == Line 142 has weird spacing: '...enabled boole...' == Line 143 has weird spacing: '...enabled boole...' == Line 147 has weird spacing: '...rw name if:i...' == Line 148 has weird spacing: '...rt-type port...' == Line 149 has weird spacing: '...enabled boole...' == (4 more instances...) == The document doesn't use any RFC 2119 keywords, yet seems to have RFC 2119 boilerplate text. -- The document date (March 9, 2020) is 1503 days in the past. Is this intentional? Checking references for intended status: Proposed Standard ---------------------------------------------------------------------------- (See RFCs 3967 and 4897 for information about using normative references to lower-maturity documents in RFCs) == Missing Reference: 'ITU783' is mentioned on line 88, but not defined == Missing Reference: 'ITU705' is mentioned on line 88, but not defined == Unused Reference: 'RFC6991' is defined on line 626, but no explicit reference was found in the text == Unused Reference: 'RFC7950' is defined on line 629, but no explicit reference was found in the text == Unused Reference: 'RFC7384' is defined on line 650, but no explicit reference was found in the text -- Possible downref: Non-RFC (?) normative reference: ref. 'ITU781' -- Possible downref: Non-RFC (?) normative reference: ref. 'ITU8264' Summary: 0 errors (**), 0 flaws (~~), 13 warnings (==), 3 comments (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 1 Internet Working Group Y. Jiang 2 J. Lv 3 Internet-Draft Huawei 4 L. Han 5 Intended status: Standards Track China Mobile 7 Expires: September 2020 March 9, 2020 9 YANG Data Model for Sync PHY 10 draft-jiang-tictoc-syncphy-yang-00 12 Abstract 14 This document defines a YANG data model for the configuration of 15 physical layer synchronization including SyncE and SyncO. The YANG 16 module in this document conforms to the Network Management 17 Datastore Architecture (NMDA). 19 Status of this Memo 21 This Internet-Draft is submitted to IETF in full conformance with 22 the provisions of BCP 78 and BCP 79. 24 Internet-Drafts are working documents of the Internet Engineering 25 Task Force (IETF), its areas, and its working groups. Note that 26 other groups may also distribute working documents as Internet- 27 Drafts. 29 Internet-Drafts are draft documents valid for a maximum of six 30 months and may be updated, replaced, or obsoleted by other 31 documents at any time. It is inappropriate to use Internet-Drafts 32 as reference material or to cite them other than as "work in 33 progress." 35 The list of current Internet-Drafts can be accessed at 36 http://www.ietf.org/ietf/1id-abstracts.txt 38 The list of Internet-Draft Shadow Directories can be accessed at 39 http://www.ietf.org/shadow.html 41 This Internet-Draft will expire on September 9, 2020. 43 Copyright Notice 45 Copyright (c) 2020 IETF Trust and the persons identified as the 46 document authors. All rights reserved. 48 This document is subject to BCP 78 and the IETF Trust's Legal 49 Provisions Relating to IETF Documents 50 (http://trustee.ietf.org/license-info) in effect on the date of 51 publication of this document. Please review these documents 52 carefully, as they describe your rights and restrictions with 53 respect to this document. Code Components extracted from this 54 document must include Simplified BSD License text as described in 55 Section 4.e of the Trust Legal Provisions and are provided without 56 warranty as described in the Simplified BSD License. 58 Table of Contents 60 1. Introduction .............................................. 2 61 1.1. Conventions used in this document ...................... 3 62 1.2. Terminology ............................................ 3 63 2. Sync PHY YANG Model hierarchy ............................. 3 64 3. Sync PHY YANG Module ...................................... 5 65 4. Security Considerations .................................. 14 66 5. IANA Considerations ...................................... 14 67 6. References ............................................... 14 68 6.1. Normative References .................................. 14 69 6.2. Informative References ................................ 15 70 7. Acknowledgments .......................................... 15 72 1. Introduction 74 Frequency synchronization based on physical layer clock is widely 75 implemented in network elements and deployed in the networks. The 76 physical clock is delivered across the network over a physical link 77 such as PDH, SDH/SONET, OTN or IEEE 802.3. 79 This document defines a YANG data model for the configuration of 80 synchronization over physical layer (simplified as Sync PHY) such 81 as Sync Ethernet (SyncE) and Synchronous Optical Transport Network 82 (SyncO). The data model is constructed based on the management 83 attributes as specified in [ITU781] and reference source selection 84 architecture as described in [ITU8264]. The data model is targeted 85 at supporting generic Sync PHY for network elements and industrial 86 internet devices, the details on these physical layer 87 synchronization can refer to those ITU-T recommendations such as 88 [ITU783],[ITU705], [ITU705], [ITU8021], [ITU798] and is out of 89 scope of this document. 91 The YANG module in this document conforms to the Network Management 92 Datastore Architecture (NMDA) [RFC8342]. 94 1.1. Conventions used in this document 96 The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL 97 NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", 98 "MAY", and "OPTIONAL" in this document are to be interpreted as 99 described in BCP 14 [RFC2119] [RFC8174] when, and only when, they 100 appear in all capitals, as shown here. 102 1.2. Terminology 104 Most terminologies used in this document are extracted from ITU 105 recommendations. 107 OTN Optical Transport Network 109 SDH Synchronous Digital Hierarchy 111 SyncE Synchronous Ethernet 113 SyncO Synchronous Optical Transport Network 115 2. Sync PHY YANG Model hierarchy 117 This section describes the hierarchy of the Sync-PHY YANG module. 119 Query and configuration of Sync-PHY information include: 121 - sync-node includes all the sync-clock node wide attributes. 123 - port-list includes all the sync-clock port-specific attributes. 125 - system-clock includes all the system clock attributes. 127 - station-clock includes all the station clock attributes. 129 The readers are assumed to be familiar with the specific ITU-T 130 recommendations. This document only outlines each of them in the 131 YANG module. 133 A simplified YANG tree diagram [RFC8340] representing the data 134 model is typically used by YANG modules. This document uses the 135 same tree diagram syntax as described in [RFC8340]. 137 module: ietf-sync-phy 138 +--rw sync-phy 139 +--rw sync-node 140 | +--rw sync-network-option sync-network-option-enumeration 141 | +--ro local-quality-level quality-level-enumeration 142 | +--rw quality-level-enabled boolean 143 | +--rw revertive-enabled boolean 144 | +--rw wtr-time uint8 145 | +--rw holdoff-time uint16 146 +--rw port-list 147 | +--rw name if:interface-ref 148 | +--rw port-type port-type-enumeration 149 | +--rw sync-enabled boolean 150 | +--rw ql-overwrite-enabled boolean 151 | +--rw ql-overwrite-val quality-level-enumeration 152 | +--ro ql-in quality-level-enumeration 153 | +--ro ql-out quality-level-enumeration 154 | +--rw ssm-transmit-enabled boolean 155 +--rw system-clock 156 | +--rw port-list 157 | | +--rw name if:interface-ref 158 | | +--rw priority uint32 159 | +--ro selected-source if:interface-ref 160 | +--rw run-mode run-mode-enumeration 161 +--rw station-clock 162 +--rw port-list 163 | +--rw name if:interface-ref 164 | +--rw priority uint32 165 +--rw ql-min uint8 166 +--ro selected-source if:interface-ref 167 +--ro out-source if:interface-ref 169 3. Sync PHY YANG Module 171 This module imports typedef "interface-ref" from [RFC8343]. Most 172 attributes are based on the management information defined in 173 [ITU781], but their names are adapted to the YANG style of naming. 175 file "ietf-syncphy@2020-03-01.yang" 176 module ietf-syncphy { 177 yang-version 1.1; 178 namespace "urn:ietf:params:xml:ns:yang:ietf-syncphy"; 179 prefix "syncphy"; 181 import ietf-interfaces { 182 prefix if; 183 reference 184 "RFC8343: A YANG Data Model for Interface Management"; 185 } 187 organization "IETF TICTOC Working Group"; 188 contact 189 "WG Web: http://tools.ietf.org/wg/tictoc/ 190 WG List: 191 Author: Yuanlong Jiang 192 193 Author: Jingfei Lv 194 195 Author: Liuyan Han 196 "; 197 description 198 "This YANG module defines a data model for the configuration 199 and management of Sync PHY."; 201 revision "2020-03-01" { 202 description "Initial version"; 203 reference "draft-jiang-ntp-syncphy-yang: YANG Data Model for 204 Sync-PHY"; 205 } 207 typedef sync-network-option-enumeration { 208 type enumeration { 209 enum "OptionUnknown" { 210 value "1"; 211 } 212 enum "Option1" { 213 value "2"; 214 } 215 enum "Option2Gen1" { 216 value "3"; 217 } 218 enum "Option2Gen2" { 219 value "4"; 220 } 221 enum "Option3" { 222 value "5"; 223 } 224 enum "OptionInvalid" { 225 value "6"; 226 } 227 } 228 description 229 "The Network synchronization networking options. 230 Values for this enumeration are specified 231 in G.781."; 232 reference 233 "ITU-T G.781-2017: 5.3.1"; 234 } 236 typedef quality-level-enumeration { 237 type enumeration { 238 enum "QualityLevelNULL" { 239 value "1"; 240 } 241 enum "QualityLevelDNU" { 242 value "2"; 243 } 244 enum "QualityLevelDUS" { 245 value "3"; 246 } 247 enum "QualityLeveleEEC" { 248 value "4"; 249 } 250 enum "QualityLevelePRTC" { 251 value "5"; 252 } 253 enum "QualityLevelFAILED" { 254 value "6"; 255 } 256 enum "QualityLevelINV0" { 257 value "7"; 258 } 259 enum "QualityLevelINV1" { 260 value "8"; 261 } 262 enum "QualityLevelINV2" { 263 value "9"; 264 } 265 enum "QualityLevelINV3" { 266 value "10"; 267 } 268 enum "QualityLevelINV4" { 269 value "11"; 270 } 271 enum "QualityLevelINV5" { 272 value "12"; 273 } 274 enum "QualityLevelINV6" { 275 value "13"; 276 } 277 enum "QualityLevelINV7" { 278 value "14"; 279 } 280 enum "QualityLevelINV8" { 281 value "15"; 282 } 283 enum "QualityLevelINV9" { 284 value "16"; 285 } 286 enum "QualityLevelINV10" { 287 value "17"; 288 } 289 enum "QualityLevelINV11" { 290 value "18"; 291 } 292 enum "QualityLevelINV12" { 293 value "19"; 294 } 295 enum "QualityLevelINV13" { 296 value "20"; 297 } 298 enum "QualityLevelINV14" { 299 value "21"; 300 } 301 enum "QualityLevelINV15" { 302 value "22"; 303 } 304 enum "QualityLevelNSUPP" { 305 value "23"; 306 } 307 enum "QualityLevelPRC" { 308 value "24"; 309 } 310 enum "QualityLevelPROV" { 311 value "25"; 312 } 313 enum "QualityLevelPRS" { 314 value "26"; 315 } 316 enum "QualityLevelPRTC" { 317 value "27"; 318 } 319 enum "QualityLevelSEC" { 320 value "28"; 321 } 322 enum "QualityLevelSMC" { 323 value "29"; 324 } 325 enum "QualityLevelSSUA" { 326 value "30"; 327 } 328 enum "QualityLevelSSUB" { 329 value "31"; 330 } 331 enum "QualityLevelST2" { 332 value "32"; 333 } 334 enum "QualityLevelST3" { 335 value "33"; 336 } 337 enum "QualityLevelST3E" { 338 value "34"; 339 } 340 enum "QualityLevelST4" { 341 value "35"; 342 } 343 enum "QualityLevelSTU" { 344 value "36"; 345 } 346 enum "QualityLevelTNC" { 347 value "37"; 348 } 349 enum "QualityLevelUNC" { 350 value "38"; 351 } 352 enum "QualityLevelUNK" { 353 value "39"; 354 } 355 } 356 description 357 "Clock source QL (quality level) as defined in ITU-T G.781."; 358 reference 359 "ITU-T standard G.781 section 5.4"; 360 } 361 typedef port-type-enumeration { 362 type enumeration { 363 enum "IfTypeE1" { 364 value "1"; 365 } 366 enum "IfTypeT1" { 367 value "2"; 368 } 369 enum "IfType2Mhz" { 370 value "3"; 371 } 372 enum "IfType2Mbit" { 373 value "4"; 374 } 375 enum "IfTypeSDH" { 376 value "5"; 377 } 378 enum "IfTypeSONET" { 379 value "6"; 380 } 381 enum "IfTypeEthernet" { 382 value "7"; 383 } 384 enum "IfTypeOTN" { 385 value "8"; 386 } 387 } 388 description 389 "Sync clock source Interface type. 390 Values for this enumeration are specified 391 in G.781."; 392 reference 393 "ITU-T G.781-2017: 5.3.1"; 394 } 395 typedef run-mode-enumeration { 396 type enumeration { 397 enum "ModeFreeRun" { 398 value "1"; 399 } 400 enum "ModeHoldover" { 401 value "2"; 402 } 403 enum "ModeLocked" { 404 value "3"; 405 } 406 } 407 description 408 "The clock operation mode. 409 Values for this enumeration are specified in G.781."; 410 reference 411 "ITU-T G.781-2017: 6.3.1"; 412 } 413 container sync-phy { 414 description 415 "The sync-phy contains all attributes of Sync-PHY, 416 optional attributes can be augmented to this node."; 417 container sync-node { 418 description 419 "The sync-node contains all the node-level Sync-PHY 420 management attributes for an equipment."; 421 leaf sync-network-option { 422 type sync-network-option-enumeration; 423 description 424 "The Network synchronization networking options. 425 Values for this enumeration are specified 426 in G.781."; 427 reference 428 "ITU-T G.781-2017: 5.3.1"; 429 } 430 leaf local-quality-level { 431 type quality-level-enumeration; 432 config false; 433 description 434 "The local QL retrieved."; 435 } 436 leaf quality-level-enabled { 437 type boolean; 438 description 439 "Whether QL is enabled or not."; 440 } 441 leaf revertive-enabled { 442 type boolean; 443 description 444 "Whether revertive mode is enabled or not."; 445 } 446 leaf wtr-time { 447 type uint8 { 448 range "0..12"; 449 } 450 default "5"; 451 description 452 "The WTR time in the unit of minute for selection 453 processes in common."; 454 } 455 leaf holdoff-time { 456 type uint16 { 457 range "300..1800"; 458 } 459 description 460 "The Holdoff time in the unit of ms for selection 461 processes in common."; 462 } 463 } 464 list port-list { 465 key "name"; 466 description 467 "List of one or more PHY ports in the device (see G.871). 468 Each item of port-list represents port-level management 469 information for a physical port."; 471 leaf name { 472 type if:interface-ref; 473 description 474 "The interface name of the physical port."; 475 } 476 leaf port-type { 477 type port-type-enumeration; 478 description 479 "The interface type of the physical port."; 480 } 481 leaf sync-enabled { 482 type boolean; 483 description 484 "Whether sync mechanism is enabled or not."; 485 } 486 leaf ql-overwrite-enabled { 487 type boolean; 488 description 489 "Whether QL overwrite is enabled or not, if not enabled, 490 it means QL will pass through."; 491 } 492 leaf ql-overwrite-val { 493 type quality-level-enumeration; 494 description 495 "The quality level used if overwrite mode is enabled."; 496 } 497 leaf ql-in { 498 type quality-level-enumeration; 499 description 500 "After overwrite or pass through, the final QL fed into 501 the clock."; 502 } 503 leaf ql-out { 504 type quality-level-enumeration; 505 description 506 "The output QL for the physical port."; 507 } 508 leaf ssm-transmit-enabled { 509 type boolean; 510 description 511 "Whether SSM transmit is enabled or not."; 512 } 513 } 514 container system-clock { 515 description 516 "The system-clock contains all attributes on management of 517 the system clock in an equipment."; 519 list port-list { 520 key "name"; 521 description 522 "List of one or more source clock PHY ports for the 523 system clock (see G.871). 524 Each port-list item represents management information 525 on a clock source physical port used in the system 526 clock."; 527 leaf name { 528 type if:interface-ref; 529 description 530 "The interface name of the clock source physical port."; 531 } 532 leaf priority { 533 type uint32; 534 description 535 "The source priority of the physical port."; 536 } 537 } 538 leaf selected-source { 539 type if:interface-ref; 540 description 541 "The selected source clock physical port."; 542 } 543 leaf run-mode { 544 type run-mode-enumeration; 545 description 546 "The run mode of the system clock."; 547 } 548 } 549 container station-clock { 550 description 551 "The station-clock contains all attributes on management of 552 the station clock in an equipment."; 553 list port-list { 554 key "name"; 555 description 556 "List of one or more source clock PHY ports for the 557 station clock (see G.871). 558 Each port-list item represents management information 559 on a clock source physical port used in the station 560 clock."; 561 leaf name { 562 type if:interface-ref; 563 description 564 "The interface name of the clock source physical port."; 565 } 566 leaf priority { 567 type uint32; 568 description 569 "The source priority of the physical port."; 570 } 571 } 572 leaf ql-min { 573 type uint8; 574 description 575 "The minimum QL of the system clock."; 576 } 577 leaf selected-source { 578 type if:interface-ref; 579 description 580 "The current selected source of the station clock by 581 automatic process."; 582 } 583 leaf out-source { 584 type if:interface-ref; 585 description 586 "The final output source for the station clock."; 587 } 588 } 589 } 590 } 591 593 4. Security Considerations 595 TBD. 597 5. IANA Considerations 599 This document proposes the following URI in the "IETF XML registry" 600 [RFC3688]: 601 URI: urn:ietf:params:xml:ns:yang:ietf-syncphy 602 Registrant Contact: The IESG 603 XML: N/A; the requested URI is an XML namespace 605 This document proposes the following YANG module in the "YANG 606 Module Names" registry [RFC6020]: 607 Name: ietf-syncphy 608 Namespace: urn:ietf:params:xml:ns:yang:ietf-syncphy 609 Prefix: syncphy 610 Reference: this document 612 6. References 614 6.1. Normative References 616 [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate 617 Requirement Levels", BCP 14, RFC 2119, March 1997 619 [RFC3688] Mealling, M., "The IETF XML Registry", RFC 3688, 620 January 2004 622 [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the 623 Network Configuration Protocol (NETCONF) ", RFC 6020, 624 October 2010 626 [RFC6991] Schoenwaelder, J., "Common YANG Data Types", RFC 6991, 627 July 2013 629 [RFC7950] Bjorklund, M., "The YANG 1.1 Data Modeling Language", RFC 630 7950, August 2016 632 [RFC8174] Leiba, B., "Ambiguity of Uppercase vs Lowercase in RFC 633 2119 Key Words", BCP 14, RFC 8174, May 2017 635 [RFC8342] Bjorklund, M., Schoenwaelder, J., Shafer, P., Watsen, K., 636 and R. Wilton, "Network Management Datastore Architecture 637 (NMDA)", RFC 8342, March 2018 639 [RFC8343] Bjorklund, M., "A YANG Data Model for Interface 640 Management", RFC 8343, March 2018 642 [ITU781] ITU-T, "Synchronization layer functions", ITU-T G.781, 643 August 2017 645 [ITU8264] ITU-T, "Distribution of timing information through packet 646 networks", ITU-T G.8264 Amendment 1, March 2018 648 6.2. Informative References 650 [RFC7384] Mizrahi, T., "Security Requirements of Time Protocols in 651 Packet Switched Networks", RFC 7384, October 2014 653 [RFC8340] Bjorklund, M., and Berger, L., "YANG Tree Diagrams", RFC 654 8340, March 2018 656 [ITU798] ITU-T, "Characteristics of optical transport network 657 hierarchy equipment functional blocks", ITU-T G.798 658 Amendment 1, August 2018 660 [ITU8021] ITU-T, "Characteristics of Ethernet transport network 661 equipment functional blocks", ITU-T G.8021, June 2018 663 7. Acknowledgments 665 TBD. 667 Authors' Addresses 669 Yuanlong Jiang 670 Huawei Technologies Co., Ltd. 671 Bantian, Longgang district 672 Shenzhen 518129, China 673 Email: jiangyuanlong@huawei.com 675 Jingfei Lv 676 Huawei Technologies Co., Ltd. 677 lvjingfei@huawei.com 679 Liuyan Han 680 China Mobile 681 hanliuyan@chinamobile.com