YANG model
for NETCONF Event NotificationsINSA-LyonLyonFrancealex.huang-feng@insa-lyon.frINSA-LyonLyonFrancepierre.francois@insa-lyon.frSwisscomBinzring 17Zurich8045Switzerlandthomas.graf@swisscom.comHuaweibenoit.claise@huawei.comThis document defines the YANG model for NETCONF Event Notifications.
The definition of this YANG model allows the encoding of NETCONF Event
Notifications in YANG compatible encodings such as YANG-JSON and YANG-CBOR.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
when, and only when,
they appear in all capitals, as shown here.This document defines a YANG data model for NETCONF
Event Notifications . The notification structure defined
in uses a XML Schema
allowing to encode and validate the message in XML. Nevertheless,
when the notification message is encoded using other encodings such as
YANG-JSON or YANG-CBOR , a YANG model
to validate or encode the message is necessary. This document extends
, defining the NETCONF Event Notification structure in a YANG module.
proposes a
structure to send multiple notifications in a single message. Unlike
, this document defines
a YANG module to encode NETCONF Notifications with encodings other than XML, which is currently
not existing. The structure for NETCONF notifications is defined in using
a XSD, but there is no YANG module defining the structure of the notification message sent by a server
when the message is encoded in YANG-JSON or YANG-CBOR .
This YANG module adds a structure with one leaf for the datetime as defined in
section 2.2.1 of . The name of the leaf matches the
definition of the XSD element name defined in Section 4 of .
The YANG module uses the same namespace from the XML Schema
defined in Section 4 of allowing to use this YANG module
to also validate already implemented XML encoded NETCONF Event Notifications.
WG List:
Authors: Alex Huang Feng
Pierre Francois
Thomas Graf
Benoit Claise
";
description
"Defines NETCONF Event Notification structure as defined in RFC5277.
This YANG module uses the same namespace from the XML schema defined
in Section 4 of RFC5277 to be able to validate already implemented
XML encoded messages.
Copyright (c) 2023 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, is permitted pursuant to, and subject to the license
terms contained in, the Revised BSD License set forth in Section
4.c of the IETF Trust's Legal Provisions Relating to IETF Documents
(https://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see the RFC
itself for full legal notices.";
revision 2024-01-22 {
description
"First revision";
reference
"RFC XXXX: NETCONF Event Notification YANG";
}
sx:structure notification {
leaf eventTime {
type yang:date-and-time;
mandatory true;
description
"The date and time the event was generated by the event source.
This parameter is of type dateTime and compliant to [RFC3339].
Implementations must support time zones.
The leaf name in camel case matches the name of the XSD element
defined in Section 4 of RFC5277.";
}
}
}
]]>The security considerations for the NETCONF Event notifications
are described in . This documents adds
no additional security considerations.This document describes the URI used for the IETF XML Registry and
registers a new YANG module name.IANA is requested to add this document as a reference in the following
URI in the IETF XML Registry.This document registers the following YANG module in the YANG Module Names Registry, within the
"YANG Parameters" registry:IANA is requested to register a new ".sid" file in the "IETF YANG SID Registry":A ".sid" file is proposed in .The authors would like to thank Andy Bierman, Carsten Bormann, Tom Petch and
Jason Sterne for their review and valuable comments.Extensible Markup Language (XML) 1.0 (Second Edition)W3CThis non-normative section shows examples of how XML, YANG-JSON and YANG-CBOR are encoded.This is an example of a XML-encoded notification as defined in .2022-09-02T10:59:55.32Z1011eth0up
]]>This is an example of a YANG-JSON encoded notification.This is an example of YANG-CBOR encoded notification.
The figure shows the message using the CBOR
diagnostic notation as defined in section 3.1 of .This is an example of YANG-CBOR encoded notification using YANG SIDs . The figure shows
the message using the CBOR diagnostic notation as defined in section 3.1 of
.Note to the RFC-Editor: Please remove this section before publishing.For CBOR encoding using YANG-SIDs identifiers, a ".sid" file is requested
to IANA in .