Alarm YANG Model
draft-sharma-netmod-fault-model-01

Document Type Active Internet-Draft (individual)
Last updated 2016-10-27
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
NETMOD Working Group                                           A. Sharma
Internet-Draft                                                    R. Rao
Intended status: Standards Track                           Infinera Corp
Expires: April 30, 2017                                         X. Zhang
                                                     Huawei Technologies
                                                        October 27, 2016

                            Alarm YANG Model
                   draft-sharma-netmod-fault-model-01

Abstract

   This document describes the Alarm YANG data model for modeling and
   reporting standing alarm conditions.

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 http://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 April 30, 2017.

Copyright Notice

   Copyright (c) 2016 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 Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Sharma, et al.           Expires April 30, 2017                 [Page 1]
Internet-Draft              Alarm YANG Model                October 2016

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Alarm YANG Data Model . . . . . . . . . . . . . . . . . . . .   2
     2.1.  YANG Tree . . . . . . . . . . . . . . . . . . . . . . . .   3
     2.2.  Alarm YANG Model  . . . . . . . . . . . . . . . . . . . .   3
     2.3.  Alarm Types YANG Model  . . . . . . . . . . . . . . . . .   8
   3.  Security Considerations . . . . . . . . . . . . . . . . . . .  27
   4.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .  27
   5.  Acknowledgements  . . . . . . . . . . . . . . . . . . . . . .  27
   6.  Normative References  . . . . . . . . . . . . . . . . . . . .  27
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .  27

1.  Introduction

   Network devices, controllers, orchestrators, and applications
   generate alarms indicating active fault state on entities.  These
   alarms are reported to the northbound systems, which can diagnose and
   take corrective actions to fix these alarms.

   Alarms raised by various entities in the system are present in the
   alarm model in the operational datastore.  New alarms are reported to
   the clients using notifications.  On system re-start, alarms are
   rediscovered, and the alarm model is re-populated in the operational
   datastore.  In some systems, alarms once cleared, may get moved to
   historical alarm log, which is outside the scope of this document.

   The alarm definition is based on existing standards [X.733] [RFC3877]
   and is widely adopted for alarm reporting.  This document provides
   the YANG model for Alarms described in the existing standards [X.733]
   [RFC3877].

2.  Alarm YANG Data Model

   Note: The Alarm YANG Data Model contains the most widely used
   attributes from [X.733].  It is being discussed if this YANG model
   should contain all attributes as defined in [X.733] and [RFC3877].

   The ietf-alarm-types YANG model includes all probable causes as
   defined in [X.733] and [RFC3877].

   New network architectures that include controllers, orchestrators,
   PCE, applications, etc., require new alarm types and probable causes
   to be defined.  These new alarm types and probable causes will be
   defined in the next version of the model.

Sharma, et al.           Expires April 30, 2017                 [Page 2]
Internet-Draft              Alarm YANG Model                October 2016

2.1.  YANG Tree

   module: ietf-alarm
      +--ro alarms
Show full document text