One document matched: draft-ietf-netconf-system-notifications-04.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE rfc SYSTEM "rfc2629.dtd" [
<!ENTITY rfc2119 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.2119.xml'>
<!ENTITY rfc3688 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.3688.xml'>
<!ENTITY rfc5277 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.5277.xml'>
<!ENTITY rfc6020 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6020.xml'>
<!ENTITY rfc6021 PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml/reference.RFC.6021.xml'>
<!ENTITY netconfspec PUBLIC ''
'http://xml.resource.org/public/rfc/bibxml3/reference.I-D.ietf-netconf-4741bis.xml'>
]>
<rfc
category="std"
docName="draft-ietf-netconf-system-notifications-04"
ipr="trust200902">
<?xml-stylesheet type='text/xsl' href='rfc2629.xslt' ?>
<?rfc strict="yes"?>
<?rfc comments="no" ?>
<?rfc inline="no" ?>
<?rfc editing="no" ?>
<?rfc toc="yes"?>
<?rfc tocompact="yes"?>
<?rfc tocdepth="4"?>
<?rfc symrefs="yes"?>
<?rfc sortrefs="no" ?>
<?rfc compact="yes"?>
<?rfc iprnotified="no"?>
<front>
<title abbrev="NETCONF Base Notifications">
Network Configuration Protocol Base Notifications
</title>
<author fullname="Andy Bierman"
initials="A.B."
surname="Bierman">
<organization>Brocade</organization>
<address>
<email>andy.bierman@brocade.com</email>
</address>
</author>
<date />
<area>OPS</area>
<workgroup>NETCONF</workgroup>
<keyword>notifications</keyword>
<keyword>XML</keyword>
<abstract>
<t>
The NETCONF protocol provides mechanisms to manipulate configuration
datastores. However, client applications often need to be aware
of common events such as a change in NETCONF server capabilities,
that may impact management applications.
Standard mechanisms are needed to support the monitoring of
the base system events within the NETCONF server.
This document defines a YANG module
that allows a NETCONF client to
receive notifications for some common system events.
</t>
</abstract>
</front>
<middle>
<section title="Introduction">
<t>
The NETCONF protocol <xref target="I-D.ietf-netconf-4741bis"/>
provides mechanisms to manipulate configuration
datastores. However, client applications often need to be aware
of common events such as a change in NETCONF server capabilities,
that may impact management applications.
Standard mechanisms are needed to support the monitoring of
the base system events within the NETCONF server.
This document defines a YANG module
<xref target="RFC6020"/>
that allows a NETCONF client to
receive notifications for some common system events.
</t>
<section title="Terminology">
<t>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL",
"SHALL NOT", "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY",
and "OPTIONAL" in this document are to be interpreted as
described in <xref target="RFC2119"/>.
</t>
<t>
The following terms are defined in
<xref target="I-D.ietf-netconf-4741bis"/>:
<list style="symbols">
<t>client</t>
<t>datastore</t>
<t>operation</t>
<t>server</t>
</list>
</t>
<t>
The following terms are defined in <xref target="RFC5277"/>:
<list style="symbols">
<t>event</t>
<t>stream</t>
<t>subscription</t>
</list>
</t>
<t>
The following term is defined in
<xref target="RFC6020"/>:
<list style="symbols">
<t>data node</t>
</list>
</t>
</section>
</section>
<section title="YANG Module for NETCONF Base Notifications">
<section title="Overview">
<t>
The YANG module defined within this document specifies
a small number of notification event messages
for use within the 'NETCONF' stream, and accessible to
clients via the subscription mechanism in
<xref target="RFC5277"/>.
</t>
<t>
These notifications pertain to configuration and
monitoring portion of the
managed system, not the entire system. A server
MUST report events
that are directly related to the NETCONF protocol.
A server MAY
report events for non-NETCONF management sessions,
using the 'session-id' value of zero.
</t>
<t>
The YANG language is defined in
<xref target="RFC6020"/>.
</t>
<section title="Notifications">
<t>
This module defines some events for the 'NETCONF' stream
to notify a client application that the
NETCONF server state has changed.
<vspace />
<list style="hanging">
<t hangText="netconf-config-change:">
<vspace />
Generated when the NETCONF
server detects that the <running>
or <startup> configuration datastore
has changed. Summarizes each edit being reported.
</t>
<t hangText="netconf-capability-change:">
<vspace />
Generated when the NETCONF server
detects that the server capabilities have changed.
Indicates which capabilities have been added, deleted,
and/or modified.
</t>
<t hangText="netconf-session-start:">
<vspace />
Generated when a NETCONF server
detects that a NETCONF session has started.
A server MAY generate this event for
non-NETCONF management sessions.
Indicates the identity of the user that started
the session.
</t>
<t hangText="netconf-session-end:">
<vspace />
Generated when a NETCONF server
detects that a NETCONF session has terminated.
A server MAY optionally generate this event for
non-NETCONF management sessions.
Indicates the identity of the user that owned
the session,
and why the session was terminated.
</t>
<t hangText="netconf-confirmed-commit:">
<vspace />
Generated when a NETCONF server detects
that a confirmed-commit event has occurred.
Indicates the event and the current state of the
confirmed-commit
operation in progress.
</t>
</list>
</t>
</section>
</section>
<section title="Definitions" anchor="YANGMOD">
<t>
<figure>
<artwork><![CDATA[
<CODE BEGINS> file="ietf-netconf-base-notifications@2011-06-13.yang"
module ietf-netconf-base-notifications {
namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-base-notifications";
prefix ncbase;
import ietf-inet-types { prefix inet; }
import ietf-netconf { prefix nc; }
organization
"IETF NETCONF (Network Configuration Protocol) Working Group";
contact
"WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org>
WG Chair: Bert Wijnen
<mailto:bertietf@bwijnen.net>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
Editor: Andy Bierman
<mailto:andy.bierman@brocade.com>";
description
"This module defines an YANG data model for use with the
NETCONF protocol that allows the NETCONF client to
receive common NETCONF base notification events.
Copyright (c) 2011 IETF Trust and the persons identified as
the document authors. 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 Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents
(http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note
// RFC Ed.: remove this note
// Note: extracted from
// draft-ietf-netconf-system-notifications-04.txt
revision 2011-06-13 {
description
"Initial version.";
reference
"RFC XXXX: NETCONF Base Notifications";
}
// RFC Ed.: replace XXXX with actual
// RFC number and remove this note
grouping common-session-parms {
description
"Common session parameters to identity a
management session.";
leaf username {
description
"Name of the user for the session.";
type string;
mandatory true;
}
leaf session-id {
description
"Identifier of the session.
A non-NETCONF session will be identified by the value zero.";
type nc:session-id-or-zero-type;
mandatory true;
}
leaf source-host {
description
"Address of the remote host for the session.";
type inet:ip-address;
}
}
grouping changed-by-parms {
description
"Common parameters to identify the source
of a change event, such as a configuration
or capability change.";
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;
leaf server {
type empty;
description
"If present, the change was caused
by the server.";
}
case by-user {
uses common-session-parms;
}
} // choice server-or-user
} // container changed-by-parms;
}
notification netconf-config-change {
description
"Generated when the NETCONF server detects that the
<running> or <startup> configuration datastore
has changed by a management session.
Summarizes each edit being reported.
The server MAY choose to also generate this
notification while loading a datastore during the
boot process for the device.";
uses changed-by-parms;
leaf target-datastore {
type enumeration {
enum running {
description "The <running> datastore has changed.";
}
enum startup {
description "The <startup> datastore has changed";
}
}
description
"Indicates which configuration datastore has changed.";
default "running";
}
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 instance-identifier;
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-config-change
notification netconf-capability-change {
description
"Generated when the NETCONF server detects that
the server capabilities have changed.
Indicates which capabilities have been added, deleted,
and/or modified.";
uses changed-by-parms;
leaf-list added-capability {
type inet:uri;
description
"List of capabilities that have just been added.";
}
leaf-list deleted-capability {
type inet:uri;
description
"List of capabilities that have just been deleted.";
}
leaf-list modified-capability {
type inet:uri;
description
"List of capabilities that have just been modified.
A capability is considered to be modified if the
base URI for the capability has not changed, but
one or more of the parameters encoded at the end of
the capability URI has changed.
The new modified value of the complete URI is returned.";
}
} // notification netconf-capability-change
notification netconf-session-start {
description
"Generated when a NETCONF server detects that a
NETCONF session has started. A server MAY generate
this event for non-NETCONF management sessions.
Indicates the identity of the user that started
the session.";
uses common-session-parms;
} // notification netconf-session-start
notification netconf-session-end {
description
"Generated when a NETCONF server detects that a
NETCONF session has terminated.
A server MAY optionally generate this event for
non-NETCONF management sessions. Indicates the
identity of the user that owned the session,
and why the session was terminated.";
uses common-session-parms;
leaf killed-by {
when "../termination-reason = 'killed'";
type nc:session-id-type;
description
"The session ID that issued the <kill-session>,
if the session was terminated by this operation.
If the session was abnormally terminated by a
non-NETCONF client operation, the value '0' will be
used instead.";
}
leaf termination-reason {
type enumeration {
enum "closed" {
value 0;
description
"The session was terminated by the client in normal
fashion, e.g., by the NETCONF <close-session>
operation.";
}
enum "killed" {
value 1;
description
"The session was terminated by the client in abnormal
fashion, e.g., by the NETCONF <kill-session>
operation.";
}
enum "dropped" {
value 2;
description
"The session was terminated because the transport layer
connection was unexpectedly closed.";
}
enum "timeout" {
value 3;
description
"The session was terminated because of inactivity,
e.g., waiting for the <hello> message or <rpc>
messages.";
}
enum "bad-hello" {
value 4;
description
"The client's <hello> message was invalid.";
}
enum "other" {
value 5;
description
"The session was terminated for some other reason.";
}
}
mandatory true;
description
"Reason the session was terminated.";
}
} // notification netconf-session-end
notification netconf-confirmed-commit {
description
"Generated when a NETCONF server detects that a confirmed-commit
event has occurred. Indicates the event and the current state
of the confirmed-commit operation in progress.";
reference
"I-D draft-ietf-netconf-4741bis section 8.4";
uses common-session-parms {
when "../confirm-event != 'timeout'";
}
leaf confirm-event {
description
"Indicates the event that caused the notification.";
type enumeration {
enum "start" {
value 0;
description
"The confirmed-commit procedure has started.";
}
enum "cancel" {
value 1;
description
"The confirmed-commit procedure has been canceled,
e.g., due to the session being terminated, or an
explicit <cancel-commit> operation.";
}
enum "timeout" {
value 2;
description
"The confirmed-commit procedure has been canceled,
due to the confirm-timeout interval expiring.
The common session parameters will not be present
in this sub-mode.";
}
enum "extend" {
value 3;
description
"The confirmed-commit timeout has been extended,
e.g., by a new <confirmed-commit> operation.";
}
enum "complete" {
value 4;
description
"The confirmed-commit procedure has been completed.";
}
}
mandatory true;
}
leaf timeout {
when
"../confirm-event = 'start' or ../confirm-event = 'extend'";
description
"The configured timeout value if the event type
is 'start' or 'extend'. This value represents the
the approximate number of seconds from the event
time when the 'timeout' event might occur.";
units "seconds";
type uint32;
}
} // notification netconf-confirmed-commit
}
<CODE ENDS>
]]></artwork>
</figure>
<vspace blankLines="1"/>
</t>
</section>
</section>
<section anchor="IANA" title="IANA Considerations">
<t>
This document registers one XML namespace URN
in the 'IETF XML registry', following the format
defined in <xref target="RFC3688"/>.
<vspace blankLines="1"/>
<list>
<t>URI: urn:ietf:params:xml:ns:yang:ietf-netconf-base-notifications</t>
</list>
<vspace blankLines="1"/>
Registrant Contact: The NETCONF WG of the IETF.
<vspace blankLines="1"/>
XML: N/A, the requested URI is an XML namespace.
</t>
<t>
This document registers one module name
in the 'YANG Module Names' registry,
defined in <xref target="RFC6020" /> .
<vspace blankLines="1"/>
<list>
<t>name: ietf-netconf-base-notifications</t>
<t>prefix: ncbase</t>
<t>namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-base-notifications</t>
<t>RFC: XXXX // RFC Ed.: replace XXXX and remove this comment</t>
</list>
</t>
</section>
<section anchor="Security" title="Security Considerations">
<t>
The YANG module defined in this memo is designed to be accessed
via the NETCONF protocol [RFC4741]. The lowest NETCONF
layer is
the secure transport layer and the mandatory-to-implement
secure transport is SSH [RFC4742].
</t>
<t>
Some of the readable data nodes in this YANG module may be
considered sensitive or vulnerable in some network
environments.
It is thus important to control read access (e.g., via
<get>, <get-config>, or <notification>)
to these data nodes. These are the
subtrees and data nodes and their sensitivity/vulnerability:
</t>
<t>
<list style="hanging">
<t hangText="/netconf-config-change:">
<vspace />
Event type itself indicates that the system configuration
has changed, and may be now be vulnerable to unspecified
attacks.
</t>
<t hangText="/netconf-config-change/changed-by:">
<vspace />
Indicates whether the server or a specific user management
session made the configuration change. Identifies the
user name, session-id, and source host address associated
with the configuration change, if any.
</t>
<t hangText="/netconf-config-change/datastore:">
<vspace />
Indicates which datastore has been changed.
This data can be used to determine if the
non-volatile startup configuration data has been
changed.
</t>
<t hangText="/netconf-config-change/edit:">
<vspace />
Identifies the specific edit operations and
specific datastore subtree(s) that have changed.
This data could be used to determine if specific
server vulnerabilities may now be present.
</t>
</list>
</t>
<t>
<list style="hanging">
<t hangText="/netconf-capability-change:">
<vspace />
Event type itself indicates that the system capabilities
have changed, and may be now be vulnerable to unspecified
attacks.
</t>
<t hangText="/netconf-capability-change/changed-by:">
<vspace />
Indicates whether the server or a specific user management
session made the capability change. Identifies the
user name, session-id, and source host address associated
with the capability change, if any.
</t>
<t hangText="/netconf-capability-change/added-capability:">
<vspace />
Indicates the specific capability URIs that have been
added.
This data could be used to determine if specific
server vulnerabilities may now be present.
</t>
<t hangText="/netconf-capability-change/deleted-capability:">
<vspace />
Indicates the specific capability URIs that have been
deleted.
This data could be used to determine if specific
server vulnerabilities may now be present.
</t>
<t hangText="/netconf-capability-change/modified-capability:">
<vspace />
Indicates the specific capability URIs that have been
modified.
This data could be used to determine if specific
server vulnerabilities may now be present.
</t>
</list>
</t>
<t>
<list style="hanging">
<t hangText="/netconf-session-start:">
<vspace />
Event type itself indicates that a NETCONF or other
management session may start altering the device
configuration and/or state.
</t>
<t hangText="/netconf-session-start/username:">
<vspace />
Indicates the user name associated with the session.
</t>
<t hangText="/netconf-session-start/source-host:">
<vspace />
Indicates the source host address associated with
the session.
</t>
</list>
</t>
<t>
<list style="hanging">
<t hangText="/netconf-session-end:">
<vspace />
Event type itself indicates that a NETCONF or other
management session may be finished altering the device
configuration and/or state.
</t>
<t hangText="/netconf-session-end/username:">
<vspace />
Indicates the user name associated with the session.
</t>
<t hangText="/netconf-session-end/source-host:">
<vspace />
Indicates the source host address associated with
the session.
</t>
</list>
</t>
<t>
<list style="hanging">
<t hangText="/netconf-confirmed-commit:">
<vspace />
Event type itself indicates that the <running>
datastore may have changed.
</t>
<t hangText="/netconf-confirmed-commit/username:">
<vspace />
Indicates the user name associated with the session.
</t>
<t hangText="/netconf-confirmed-commit/source-host:">
<vspace />
Indicates the source host address associated with
the session.
</t>
<t hangText="/netconf-confirmed-commit/confirm-event:">
<vspace />
Indicates the specific confirmed-commit state change that
occurred. A value of 'complete' probably indicates that the
<running> datastore has changed.
</t>
<t hangText="/netconf-confirmed-commit/timeout:">
<vspace />
Indicates the number of seconds in the future
when the <running> datastore may change,
due to the server reverting to an older configuration.
</t>
</list>
</t>
</section>
<section title="Acknowledgements">
<t>
Thanks to Martin Bjorklund, Juergen Schoenwaelder,
Kent Watsen, and many other members of the NETCONF WG
for providing important input to this document.
</t>
</section>
</middle>
<back>
<references title="Normative References">
&rfc2119;
&rfc3688;
&rfc5277;
&rfc6020;
&rfc6021;
&netconfspec;
</references>
<section title="Change Log">
<t>
-- RFC Ed.: remove this section before publication.
</t>
<section title="03-04">
<t>
Renamed module to NETCONF Base Notifications.
The module is now ietf-netconf-base-notifications.
The namespace and prefix are now changed as well.
</t>
<t>
Changed notifications so a server can report
non-NETCONF initiated events.
</t>
<t>
Replaced security considerations, according to
template in RFC 6087.
</t>
<t>
Added Acknowledgements section.
</t>
</section>
<section title="02-03">
<t>
Renamed module back to NETCONF system notifications.
The module is now ietf-netconf-system-notifications.
The namespace and prefix are now changed as well.
</t>
<t>
Leaf user-name is now username, and is now mandatory,
to be consistent with netconf monitoring module.
</t>
<t>
Leaf remote-host is now source-host
to be consistent with netconf monitoring module.
</t>
<t>
The changed-by choice (server-or-user) is now mandatory.
</t>
<t>
The netconf-config-change description was updated and leaf
target-database is now named target-datastore.
</t>
<t>
Term 'database' changed to term 'datastore' in text.
</t>
<t>
netconf-confirmed-commit: changed uses
common-session-parms to use when-stmt not refine-stmt.
</t>
<t>
netconf-capability-change: updated description text.
</t>
</section>
<section title="01-02">
<t>
Renamed module NETCONF Events instead of NETCONF
system notifications.
Note that ietf-netconf-notifications is being reserved
for the XML content
defined in RFC 5277.
</t>
<t>
Made changes based on mailing list comments and
latest WG consensus.
</t>
<t>
Filled in IANA section.
</t>
</section>
<section title="00-01">
<t>
Removed sys-startup notification.
</t>
<t>
Make changed-by into a grouping, and added usage
to sys-config-change notification.
</t>
<t>
Added target-database leaf to sys-config-change
to distinguish
between running and startup changes.
</t>
<t>
Removed 'bad-start' from termination-reason leaf
in sys-session-end
notification.
</t>
</section>
<section title="00">
<t>
Initial version, based on
draft-bierman-netconf-system-monitoring-00.txt.
</t>
</section>
</section>
</back>
</rfc>
| PAFTECH AB 2003-2026 | 2026-04-24 06:45:01 |