idnits 2.17.1 draft-sharma-netmod-fault-model-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 -- The document date (July 6, 2016) is 2844 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) == Unused Reference: 'RFC6020' is defined on line 448, but no explicit reference was found in the text Summary: 0 errors (**), 0 flaws (~~), 2 warnings (==), 1 comment (--). Run idnits with the --verbose option for more detailed information about the items above. -------------------------------------------------------------------------------- 2 NETMOD Working Group A. Sharma 3 Internet-Draft R. Rao 4 Intended status: Standards Track Infinera Corp 5 Expires: January 7, 2017 X. Zhang 6 Huawei Technologies 7 July 6, 2016 9 Fault YANG Model 10 draft-sharma-netmod-fault-model-00 12 Abstract 14 This document describes the Fault YANG data model for modeling and 15 reporting standing alarm conditions. 17 Status of this Memo 19 This Internet-Draft is submitted in full conformance with the 20 provisions of BCP 78 and BCP 79. 22 Internet-Drafts are working documents of the Internet Engineering 23 Task Force (IETF). Note that other groups may also distribute 24 working documents as Internet-Drafts. The list of current Internet- 25 Drafts is at http://datatracker.ietf.org/drafts/current/. 27 Internet-Drafts are draft documents valid for a maximum of six months 28 and may be updated, replaced, or obsoleted by other documents at any 29 time. It is inappropriate to use Internet-Drafts as reference 30 material or to cite them other than as "work in progress." 32 This Internet-Draft will expire on January 7, 2017. 34 Copyright Notice 36 Copyright (c) 2016 IETF Trust and the persons identified as the 37 document authors. All rights reserved. 39 This document is subject to BCP 78 and the IETF Trust's Legal 40 Provisions Relating to IETF Documents 41 (http://trustee.ietf.org/license-info) in effect on the date of 42 publication of this document. Please review these documents 43 carefully, as they describe your rights and restrictions with respect 44 to this document. Code Components extracted from this document must 45 include Simplified BSD License text as described in Section 4.e of 46 the Trust Legal Provisions and are provided without warranty as 47 described in the Simplified BSD License. 49 Table of Contents 51 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 52 2. Fault YANG Data Model . . . . . . . . . . . . . . . . . . . . 3 53 2.1. YANG Tree . . . . . . . . . . . . . . . . . . . . . . . . 4 54 2.2. Fault YANG Model . . . . . . . . . . . . . . . . . . . . . 4 55 2.3. Fault Types YANG Model . . . . . . . . . . . . . . . . . . 8 56 3. Security Considerations . . . . . . . . . . . . . . . . . . . 11 57 4. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 58 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 11 59 6. Normative References . . . . . . . . . . . . . . . . . . . . . 11 60 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 11 62 1. Introduction 64 Network devices, controllers, orchestrators, and applications 65 generate faults indicating active alarm state on entities. These 66 faults are reported to the northbound systems, which can diagnose and 67 take corrective actions to fix these faults. 69 Faults raised by various entities in the system are present in the 70 fault model in the operational datastore. New faults are reported to 71 the clients using notifications. On system re-start, faults are 72 rediscovered, and the fault model is re-populated in the operational 73 datastore. In some systems, faults once cleared, may get moved to 74 historical fault log, which is outside the scope of this document. 76 The fault definition is based on existing standards [X.733] [RFC3877] 77 and is widely adopted for alarm reporting. This document provides 78 the YANG model for Faults described in the existing standards [X.733] 79 [RFC3877]. 81 2. Fault YANG Data Model 83 Note: The Fault YANG Data Model contains the most widely used 84 attributes from [X.733]. It is being discussed if this YANG model 85 should contain all attributes as defined in [X.733] and [RFC3877]. 87 The ietf-fault-types YANG model does not currently include all 88 probable causes as defined in X.733. The full list of probable 89 causes will be added in the next version of the document. 91 New network architectures that include controllers, orchestrators, 92 PCE, applications, etc., require new fault types and probable causes 93 to be defined. These new fault types and probable causes will be 94 defined in the next version of the model. 96 2.1. YANG Tree 98 module: ietf-fault 99 +--ro faults 100 +--ro fault* [fault-id] 101 +--ro fault-id inet:uri 102 +--ro (entity-type)? 103 | +--:(id) 104 | | +--ro entity-id inet:uri 105 | +--:(name) 106 | +--ro entity-name string 107 +--ro fault-type identityref 108 +--ro probable-cause identityref 109 +--ro fault-time yang:date-and-time 110 +--ro fault-severity enumeration 111 +--ro service-affecting? boolean 112 +--ro additional-text? string 113 notifications: 114 +---n fault-event 115 +--ro fault-id inet:uri 116 +--ro (entity-type)? 117 | +--:(id) 118 | | +--ro entity-id inet:uri 119 | +--:(name) 120 | +--ro entity-name string 121 +--ro fault-type identityref 122 +--ro probable-cause identityref 123 +--ro fault-time yang:date-and-time 124 +--ro fault-severity enumeration 125 +--ro service-affecting? boolean 126 +--ro additional-text? string 128 2.2. Fault YANG Model 130 file "ietf-fault@2016-06-22.yang" 132 module ietf-fault { 133 namespace "urn:ietf:params:xml:ns:yang:ietf-fault"; 134 prefix flt; 136 import ietf-inet-types { prefix "inet"; } 137 import ietf-yang-types { prefix "yang"; } 138 import ietf-fault-types { prefix "flt-types"; } 140 organization 141 "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; 143 contact 144 "WG Web: 145 WG List: 147 Editor: Anurag Sharma 148 150 Editor: Rajan Rao 151 153 Editor: Xian Zhang 154 "; 156 description 157 "Fault YANG Data Model for Network Topology and Services."; 159 revision 2016-06-22 { 160 description 161 "Initial revision."; 162 reference 163 "TBD"; 164 } 166 grouping fault-entity { 167 description 168 "Reference to the entity for which the fault is reported."; 169 choice entity-type { 170 description 171 "Entity reference type."; 172 case id { 173 leaf entity-id { 174 type inet:uri; 175 mandatory true; 176 description 177 "An identifier for the entity on which the fault 178 is raised. This entity can be in the device, 179 domain controllers, element management systems, 180 or northbound orchestrators. "; 181 } 182 } 183 case name { 184 leaf entity-name { 185 type string; 186 mandatory true; 187 description 188 "Name for the entity on which the fault is 189 raised. This entity can be in the device, 190 domain controllers, element management systems, 191 or northbound orchestrators. "; 193 } 194 } 195 } 196 } 198 grouping fault-info-attributes { 199 description 200 "Fault Info attributes."; 201 leaf fault-id { 202 type inet:uri; 203 mandatory true; 204 description 205 "An identifier for the fault. This identifier should be 206 chosen such that same fault will always be identified 207 using the same identifier."; 208 } 210 uses fault-entity; 212 leaf fault-type { 213 type identityref { 214 base flt-types:fault-type; 215 } 216 mandatory true; 217 description 218 "This parameter categorizes the fault."; 219 } 221 leaf probable-cause { 222 type identityref { 223 base flt-types:probable-cause-type; 224 } 225 mandatory true; 226 description 227 "This parameter defines further qualification as to the 228 probable cause of the alarm."; 229 } 231 leaf fault-time { 232 type yang:date-and-time; 233 mandatory true; 234 description 235 "Time that the fault was raised / reported."; 236 } 238 leaf fault-severity { 239 type enumeration { 240 enum Critical { 241 description 242 "The Critical severity level indicates that a 243 service affecting condition has occurred and an 244 immediate corrective action is required."; 245 } 246 enum Major { 247 description 248 "The Major severity level indicates that a 249 service affecting condition has developed and 250 an urgent corrective action is required."; 251 } 252 enum Minor { 253 description 254 "The Minor severity level indicates the 255 existence of a non-service affecting fault 256 condition and that corrective action should 257 be taken in order to prevent a more serious 258 (for example, service affecting) fault."; 259 } 260 enum Warning { 261 description 262 "The Warning severity level indicates the 263 detection of a potential or impending service 264 affecting fault, before any significant 265 effects have been felt."; 266 } 267 enum Cleared { 268 description 269 "The Cleared severity level indicates the 270 clearing of one or more previously reported 271 alarms."; 272 } 273 enum Indeterminate { 274 description 275 "The Indeterminate severity level indicates 276 that the severity level cannot be 277 determined."; 278 } 279 } 280 mandatory true; 281 description 282 "This parameter indicates the perceived severity level of 283 the fault."; 284 } 286 leaf service-affecting { 287 type boolean; 288 description 289 "This parameter indicates if the fault impacts an active 290 service. If the fault is service affecting then the value 291 is true. If the fault does not affect the service then 292 the value is false."; 293 } 295 leaf additional-text { 296 type string; 297 description 298 "This parameter, when present, allows a free form text 299 description to be reported."; 300 } 301 } 303 container faults { 304 description 305 "Serves as top-level container for list of faults."; 306 config "false"; 307 list fault { 308 key "fault-id"; 309 uses fault-info-attributes; 310 description 311 "Describes a fault."; 312 reference 313 "ITU Recommendation X.733"; 314 } 315 } 317 notification fault-event { 318 description 319 "Fault Notification."; 320 uses fault-info-attributes; 321 } 322 } 324 326 2.3. Fault Types YANG Model 328 file "ietf-fault-types@2016-06-22.yang" 330 module ietf-fault-types { 331 yang-version 1; 332 namespace "urn:ietf:params:xml:ns:yang:ietf-fault-types"; 333 prefix flt-types; 335 organization 336 "IETF NETMOD (NETCONF Data Modeling Language) Working Group"; 338 contact 339 "WG Web: 340 WG List: 342 Editor: Anurag Sharma 343 345 Editor: Rajan Rao 346 348 Editor: Xian Zhang 349 "; 351 description 352 "This module contains Fault data type definitions."; 354 revision 2016-06-22 { 355 description 356 "Initial revision."; 357 reference 358 "TBD"; 359 } 361 identity probable-cause-type { 362 description 363 "Base identity from which specific probable cause types 364 are derived."; 365 } 367 identity LOS { 368 base probable-cause-type; 369 description 370 "Loss of Signal."; 371 } 373 identity LOF { 374 base probable-cause-type; 375 description 376 "Loss of Frame."; 377 } 379 identity framing-error { 380 base probable-cause-type; 381 description 382 "Framing error probable fault cause."; 383 } 384 identity fault-type { 385 description 386 "Base identity from which specific fault types are 387 derived."; 388 } 390 identity communication-fault-type { 391 base fault-type; 392 description 393 "A fault of this type is principally associated with the 394 procedures and/or processes required to convey 395 information from one point to another."; 396 reference "ITU Recommendation X.733"; 397 } 399 identity QoS-fault-type { 400 base fault-type; 401 description 402 "A fault of this type is principally associated with a 403 degradation in the quality of a service."; 404 reference "ITU Recommendation X.733"; 405 } 407 identity processing-fault-type { 408 base fault-type; 409 description 410 "A fault of this type is principally associated with a 411 software or processing fault."; 412 reference "ITU Recommendation X.733"; 413 } 415 identity equipment-fault-type { 416 base fault-type; 417 description 418 "A fault of this type is principally associated with an 419 equipment fault."; 420 } 422 identity environmental-fault-type { 423 base fault-type; 424 description 425 "A fault of this type is principally associated with a 426 condition relating to an enclosure in which the 427 equipment resides."; 428 } 429 } 431 432 3. Security Considerations 434 TBD 436 4. IANA Considerations 438 TBD 440 5. Acknowledgements 442 6. Normative References 444 [RFC3877] Chisholm, S. and D. Romascanu, "Alarm Management 445 Information Base (MIB)", RFC 3877, DOI 10.17487/RFC3877, 446 September 2004, . 448 [RFC6020] Bjorklund, M., Ed., "YANG - A Data Modeling Language for 449 the Network Configuration Protocol (NETCONF)", RFC 6020, 450 DOI 10.17487/RFC6020, October 2010, 451 . 453 [X.733] ITU, ""ITU Recommendation X.733, Information Technology - 454 Open Systems Interconnection - System Management: Alarm 455 Reporting Function"", 1992. 457 Authors' Addresses 459 Anurag Sharma 460 Infinera Corp 461 169 Java Drive 462 Sunnyvale, CA 94089 463 USA 465 Phone: +1-408-572-5365 466 Email: AnSharma@infinera.com 467 Rajan Rao 468 Infinera Corp 469 169 Java Drive 470 Sunnyvale, CA 94089 471 USA 473 Phone: +1-408-543-7755 474 Email: rrao@infinera.com 476 Xian Zhang 477 Huawei Technologies 478 F3-5-B R&D Center, Huawei Industrial Base, Bantian, Longgang District 479 Shenzhen, Guangdong 518129 480 P.R.China 482 Email: zhang.xian@huawei.com