| NETCONF | A.B. Bierman |
| Internet-Draft | Brocade |
| Intended status: Standards Track | August 07, 2011 |
| Expires: February 08, 2012 |
Network Configuration Protocol (NETCONF) Base Notifications
draft-ietf-netconf-system-notifications-05
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.
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 February 08, 2012.
Copyright (c) 2011 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.
The NETCONF protocol [RFC6241] 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 [RFC6020] that allows a NETCONF client to receive notifications for some common system events.
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 [RFC2119].
The following terms are defined in [RFC6241]:
The following terms are defined in [RFC5277]:
The following term is defined in [RFC6020]:
The YANG module defined within this document specifies a small number of event notification messages for use within the 'NETCONF' stream, and accessible to clients via the subscription mechanism in [RFC5277].
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.
This module defines the following notifications for the 'NETCONF' stream to notify a client application that the NETCONF server state has changed:
<CODE BEGINS> file="ietf-netconf-notifications@2011-08-07.yang"
module ietf-netconf-notifications {
namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications";
prefix ncn;
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 event notifications.
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-05.txt
revision 2011-08-07 {
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 identify 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 NETCONF session MUST be identified by a non-zero value.
A non-NETCONF session MAY 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.
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.";
uses changed-by-parms;
leaf 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. The manner in which a server
capability is changed is outside the scope of this
document.";
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' and .";
type nc:session-id-type;
description
"The ID of the session that directly caused this session
to be abnormally terminated. If this session was abnormally
terminated by a non-NETCONF session unknown to the server,
then this leaf will not be present.";
}
leaf termination-reason {
type enumeration {
enum "closed" {
description
"The session was terminated by the client in normal
fashion, e.g., by the NETCONF <close-session>
protocol operation.";
}
enum "killed" {
description
"The session was terminated in abnormal
fashion, e.g., by the NETCONF <kill-session>
protocol operation.";
}
enum "dropped" {
description
"The session was terminated because the transport layer
connection was unexpectedly closed.";
}
enum "timeout" {
description
"The session was terminated because of inactivity,
e.g., waiting for the <hello> message or <rpc>
messages.";
}
enum "bad-hello" {
description
"The client's <hello> message was invalid.";
}
enum "other" {
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 procedure in progress.";
reference
"RFC 6241, 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>
This document registers one XML namespace URN in the 'IETF XML registry', following the format defined in [RFC3688].
Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace.
This document registers one module name in the 'YANG Module Names' registry, defined in [RFC6020] .
The YANG module defined in this memo is designed to be accessed via the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the secure transport layer and the mandatory-to-implement secure transport is SSH, defined in [RFC6242].
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:
Thanks to Martin Bjorklund, Juergen Schoenwaelder, Kent Watsen, and many other members of the NETCONF WG for providing important input to this document.
| [RFC2119] | Bradner, S., "Key words for use in RFCs to Indicate Requirement Levels", BCP 14, RFC 2119, March 1997. |
| [RFC3688] | Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, January 2004. |
| [RFC5277] | Chisholm, S. and H. Trevino, "NETCONF Event Notifications", RFC 5277, July 2008. |
| [RFC6020] | Bjorklund, M., "YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)", RFC 6020, October 2010. |
| [RFC6021] | Schoenwaelder, J., "Common YANG Data Types", RFC 6021, October 2010. |
| [RFC6241] | Enns, R., Bjorklund, M., Schoenwaelder, J. and A. Bierman, "Network Configuration Protocol (NETCONF)", RFC 6241, June 2011. |
| [RFC6242] | Wasserman, M., "Using the NETCONF Protocol over Secure Shell (SSH)", RFC 6242, June 2011. |
-- RFC Ed.: remove this section before publication.
The module is now ietf-netconf-notifications. The namespace and prefix are now changed as well.
The target-datastore has been renamed to datastore.
Clarified behavior for non-NETCONF sessions.
Minor editorial comments from WG Last Call.
Renamed module to NETCONF Base Notifications. The module is now ietf-netconf-base-notifications. The namespace and prefix are now changed as well.
Changed notifications so a server can report non-NETCONF initiated events.
Replaced security considerations, according to template in RFC 6087.
Added Acknowledgements section.
Renamed module back to NETCONF system notifications. The module is now ietf-netconf-system-notifications. The namespace and prefix are now changed as well.
Leaf user-name is now username, and is now mandatory, to be consistent with netconf monitoring module.
Leaf remote-host is now source-host to be consistent with netconf monitoring module.
The changed-by choice (server-or-user) is now mandatory.
The netconf-config-change description was updated and leaf target-database is now named target-datastore.
Term 'database' changed to term 'datastore' in text.
netconf-confirmed-commit: changed uses common-session-parms to use when-stmt not refine-stmt.
netconf-capability-change: updated description text.
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.
Made changes based on mailing list comments and latest WG consensus.
Filled in IANA section.
Removed sys-startup notification.
Make changed-by into a grouping, and added usage to sys-config-change notification.
Added target-database leaf to sys-config-change to distinguish between running and startup changes.
Removed 'bad-start' from termination-reason leaf in sys-session-end notification.
Initial version, based on draft-bierman-netconf-system-monitoring-00.txt.