nokia-li-notifications

Description of the li notifications which are available in the system and can be sent out by the logger. Copyright 2016 Nokia. ...

  • Version: 2020-01-03

    nokia-li-notifications@2020-01-03


    
      module nokia-li-notifications {
    
        yang-version 1.1;
    
        namespace
          "urn:nokia.com:sros:ns:yang:sr:li-notifications";
    
        prefix li-notif;
    
        import ietf-inet-types {
          prefix inet;
        }
        import ietf-netconf {
          prefix nc;
        }
        import ietf-netconf-notifications {
          prefix ietf-ncn;
        }
        import nokia-sros-yang-extensions {
          prefix sros-ext;
        }
        import nokia-types-log {
          prefix types-log;
        }
        import nokia-types-sros {
          prefix types-sros;
        }
    
        organization "Nokia";
    
        contact
          "Nokia SR OS Support
             Web: <http://www.nokia.com>";
    
        description
          "Description of the li notifications which are available in the system and can be
             sent out by the logger.
    
             Copyright 2016 Nokia. All rights reserved. Reproduction of this document
             is authorized on the condition that the foregoing copyright notice is included.
    
             This nokia-li-notifications YANG module embodies Nokia's proprietary
             intellectual property. Nokia retains all title and ownership in the
             specification, including any revisions.
    
             Nokia grants all interested parties a non-exclusive license to use
             and distribute an unmodified copy of this specification in connection with
             management of Nokia products, and without fee, provided this
             copyright notice and license appear on all copies.
    
             This specification is supplied `as is', and Nokia makes no warranty,
             either express or implied, as to the use, operation, condition, or performance
             of the specification.";
    
        revision "2020-01-03";
        sros-ext:sros-major-release "rel24";
    
        notification sros-li-config-change-event {
          description
            "Generated when the li configuration of the system gets created,
                 modified or deleted.";
          leaf sequence-number {
            type uint64;
            description
              "A sequence number to indicate the ordering of log events in the log-id.
                     If the event is replayed, the sequence number is replayed as well.";
          }
    
          leaf severity {
            type types-log:severity-level;
            description
              "The severity level of the log event.";
          }
    
          leaf application {
            type types-log:application;
            description
              "The name of the application that reports the log event.";
          }
    
          leaf event-id {
            type uint32 {
              range "1..max";
            }
            description
              "The id the event that was generated.
                     Each log event type has a unique identifying number.  This number is
                     unique within a particular software application, such as IP, MPLS,
                     OSPF, etc.; but it is not necessarily unique across different software
                     applications.  That is MPLS event #1001 may be different from OSPF
                     event #1001.";
          }
    
          leaf event-name {
            type types-sros:named-item;
            description
              "The name of the log event that was generated.";
          }
    
          leaf router-name {
            type types-sros:named-item-or-empty;
            description
              "The router context name that generated the log event.";
          }
    
          leaf subject {
            type types-sros:named-item;
            description
              "The router context name that generated the log event.
                     The subject is the entity that originated the event, such as the Port ID.";
          }
    
          leaf message {
            type string {
              length "1..4100";
            }
            description "The log event message.";
          }
    
          anyxml event-params {
            description
              "The event specific data splitted in parameters.";
          }
        }  // notification sros-li-config-change-event
    
        notification sros-li-state-change-event {
          description
            "Generated on li state changes in the system.";
          leaf sequence-number {
            type uint64;
            description
              "A sequence number to indicate the ordering of log events in the log-id.
                     If the event is replayed, the sequence number is replayed as well.";
          }
    
          leaf severity {
            type types-log:severity-level;
            description
              "The severity level of the log event.";
          }
    
          leaf application {
            type types-log:application;
            description
              "The name of the application that reports the log event.";
          }
    
          leaf event-id {
            type uint32 {
              range "1..max";
            }
            description
              "The id the event that was generated.
                     Each log event type has a unique identifying number.  This number is
                     unique within a particular software application, such as IP, MPLS,
                     OSPF, etc.; but it is not necessarily unique across different software
                     applications.  That is MPLS event #1001 may be different from OSPF
                     event #1001.";
          }
    
          leaf event-name {
            type types-sros:named-item;
            description
              "The name of the log event that was generated.";
          }
    
          leaf router-name {
            type types-sros:named-item-or-empty;
            description
              "The router context name that generated the log event.";
          }
    
          leaf subject {
            type types-sros:named-item;
            description
              "The router context name that generated the log event.
                     The subject is the entity that originated the event, such as the Port ID.";
          }
    
          leaf message {
            type string {
              length "1..4100";
            }
            description "The log event message.";
          }
    
          anyxml event-params {
            description
              "The event specific data splitted in parameters.";
          }
        }  // notification sros-li-state-change-event
    
        notification sros-li-command-accounting-event {
          description
            "Generated when a user executes a li command on a management interface.";
          leaf sequence-number {
            type uint64;
            description
              "A sequence number to indicate the ordering of log events in the log-id.
                     If the event is replayed, the sequence number is replayed as well.";
          }
    
          leaf severity {
            type types-log:severity-level;
            description
              "The severity level of the log event.";
          }
    
          leaf application {
            type types-log:application;
            description
              "The name of the application that reports the log event.";
          }
    
          leaf event-id {
            type uint32 {
              range "1..max";
            }
            description
              "The id the event that was generated.
                     Each log event type has a unique identifying number.  This number is
                     unique within a particular software application, such as IP, MPLS,
                     OSPF, etc.; but it is not necessarily unique across different software
                     applications.  That is MPLS event #1001 may be different from OSPF
                     event #1001.";
          }
    
          leaf event-name {
            type types-sros:named-item;
            description
              "The name of the log event that was generated.";
          }
    
          leaf router-name {
            type types-sros:named-item-or-empty;
            description
              "The router context name that generated the log event.";
          }
    
          leaf subject {
            type types-sros:named-item;
            description
              "The router context name that generated the log event.
                     The subject is the entity that originated the event, such as the Port ID.";
          }
    
          leaf message {
            type string {
              length "1..4100";
            }
            description "The log event message.";
          }
    
          anyxml event-params {
            description
              "The event specific data splitted in parameters.";
          }
        }  // notification sros-li-command-accounting-event
    
        notification sros-li-md-rpc-accounting-event {
          description
            "Generated when a user executes a li RPC on a management interface.";
          leaf sequence-number {
            type uint64;
            description
              "A sequence number to indicate the ordering of log events in the log-id.
                     If the event is replayed, the sequence number is replayed as well.";
          }
    
          leaf severity {
            type types-log:severity-level;
            description
              "The severity level of the log event.";
          }
    
          leaf application {
            type types-log:application;
            description
              "The name of the application that reports the log event.";
          }
    
          leaf event-id {
            type uint32 {
              range "1..max";
            }
            description
              "The id the event that was generated.
                     Each log event type has a unique identifying number.  This number is
                     unique within a particular software application, such as IP, MPLS,
                     OSPF, etc.; but it is not necessarily unique across different software
                     applications.  That is MPLS event #1001 may be different from OSPF
                     event #1001.";
          }
    
          leaf event-name {
            type types-sros:named-item;
            description
              "The name of the log event that was generated.";
          }
    
          leaf router-name {
            type types-sros:named-item-or-empty;
            description
              "The router context name that generated the log event.";
          }
    
          leaf subject {
            type types-sros:named-item;
            description
              "The router context name that generated the log event.
                     The subject is the entity that originated the event, such as the Port ID.";
          }
    
          leaf message {
            type string {
              length "1..4100";
            }
            description "The log event message.";
          }
    
          anyxml event-params {
            description
              "The event specific data splitted in parameters.";
          }
        }  // notification sros-li-md-rpc-accounting-event
    
        notification sros-li-log-generic-event {
          description
            "Generated on any event that is generated in the system
                 that is not modeled by a more specific event.";
          leaf sequence-number {
            type uint64;
            description
              "A sequence number to indicate the ordering of log events in the log-id.
                     If the event is replayed, the sequence number is replayed as well.";
          }
    
          leaf severity {
            type types-log:severity-level;
            description
              "The severity level of the log event.";
          }
    
          leaf application {
            type types-log:application;
            description
              "The name of the application that reports the log event.";
          }
    
          leaf event-id {
            type uint32 {
              range "1..max";
            }
            description
              "The id the event that was generated.
                     Each log event type has a unique identifying number.  This number is
                     unique within a particular software application, such as IP, MPLS,
                     OSPF, etc.; but it is not necessarily unique across different software
                     applications.  That is MPLS event #1001 may be different from OSPF
                     event #1001.";
          }
    
          leaf event-name {
            type types-sros:named-item;
            description
              "The name of the log event that was generated.";
          }
    
          leaf router-name {
            type types-sros:named-item-or-empty;
            description
              "The router context name that generated the log event.";
          }
    
          leaf subject {
            type types-sros:named-item;
            description
              "The router context name that generated the log event.
                     The subject is the entity that originated the event, such as the Port ID.";
          }
    
          leaf message {
            type string {
              length "1..4100";
            }
            description "The log event message.";
          }
    
          anyxml event-params {
            description
              "The event specific data splitted in parameters.";
          }
        }  // notification sros-li-log-generic-event
    
        notification netconf-li-config-change {
          description
            "Generated when the NETCONF server detects that the
                 <running> or <startup> configuration datastore
                 has been changed for LI by a management session.
                 The notification summarizes the edits that
                 have been detected.
    
                 The server MAY choose to also generate this
                 notification while loading a datastore during the
                 boot process for the device.";
          leaf datastore {
            type enumeration {
              enum "running" {
                value 0;
                description
                  "The <running> datastore has changed.";
              }
              enum "startup" {
                value 1;
                description
                  "The <startup> datastore has changed";
              }
            }
            default "running";
            description
              "Indicates which configuration datastore has changed.";
          }
    
          container changed-by {
            description
              "Indicates the source of the change.
                     If caused by internal action, then the
                     empty leaf 'server' will be present.
                     If caused by a management session, then
                     the name, remote host address, and session ID
                     of the session that made the change will be reported.";
            choice server-or-user {
              mandatory true;
              case by-user {
                leaf username {
                  type string;
                  mandatory true;
                  description
                    "Name of the user for the session.";
                }
    
                leaf session-id {
                  type nc:session-id-or-zero-type;
                  mandatory true;
                  description
                    "Identifier of the session.
                                 A NETCONF session MUST be identified by a non-zero value.
                                 A non-NETCONF session MAY be identified by the value zero.";
                }
    
                leaf source-host {
                  type inet:ip-address;
                  description
                    "Address of the remote host for the session.";
                }
              }  // case by-user
              leaf server {
                type empty;
                description
                  "If present, the change was caused
                                 by the server.";
              }
            }  // choice server-or-user
          }  // container changed-by
    
          list edit {
            description
              "An edit record SHOULD be present for each distinct
                     edit operation that the server has detected on
                     the target datastore.  This list MAY be omitted
                     if the detailed edit operations are not known.
                     The server MAY report entries in this list for
                     changes not made by a NETCONF session (e.g., CLI).";
            leaf target {
              type string;
              description
                "Topmost node associated with the configuration change.
                         A server SHOULD set this object to the node within
                         the datastore that is being altered.  A server MAY
                         set this object to one of the ancestors of the actual
                         node that was changed, or omit this object, if the
                         exact node is not known.";
            }
    
            leaf operation {
              type nc:edit-operation-type;
              description
                "Type of edit operation performed.
                         A server MUST set this object to the NETCONF edit
                         operation performed on the target datastore.";
            }
          }  // list edit
        }  // notification netconf-li-config-change
      }  // module nokia-li-notifications
    

© 2023 YumaWorks, Inc. All rights reserved.