NETCONF A. Bierman
Internet-Draft Brocade
Intended status: Standards Track March 9, 2011
Expires: September 10, 2011
Network Configuration Protocol System Notifications
draft-ietf-netconf-system-notifications-03
Abstract
The NETCONF protocol provides mechanisms to manipulate configuration
datastores. However, client applications often need to be aware of
common NETCONF system events such as a change in NETCONF
capabilities, which may impact management applications. Standard
mechanisms are needed to support the monitoring of the NETCONF system
events within the NETCONF server. This document defines a YANG
module which allows a NETCONF client to receive notifications for
some common events.
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 September 10, 2011.
Copyright Notice
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
Bierman Expires September 10, 2011 [Page 1]
Internet-Draft NETCONF System Notifications March 2011
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.
Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. YANG Module for NETCONF System Notifications . . . . . . . . . 3
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.1. Notifications . . . . . . . . . . . . . . . . . . . . 4
2.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
4. Security Considerations . . . . . . . . . . . . . . . . . . . 11
5. Normative References . . . . . . . . . . . . . . . . . . . . . 11
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
A.1. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
A.3. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
A.4. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 13
Bierman Expires September 10, 2011 [Page 2]
Internet-Draft NETCONF System Notifications March 2011
1. Introduction
The NETCONF protocol [I-D.ietf-netconf-4741bis] provides mechanisms
to manipulate configuration datastores. However, client applications
often need to be aware of common NETCONF system events such as a
change in NETCONF capabilities, which may impact management
applications. Standard mechanisms are needed to support the
monitoring of the NETCONF system events within the NETCONF server.
This document defines a YANG module [RFC6020] which allows a NETCONF
client to receive notifications for some common events.
1.1. Terminology
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 [I-D.ietf-netconf-4741bis]:
o client
o datastore
o operation
o server
The following terms are defined in [RFC5277]:
o event
o stream
o subscription
The following term is defined in [RFC6020]:
o data node
2. YANG Module for NETCONF System Notifications
2.1. Overview
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
[RFC5277].
These notifications pertain to the NETCONF portion of the managed
system, not the entire system.
The YANG language is defined in [RFC6020].
Bierman Expires September 10, 2011 [Page 3]
Internet-Draft NETCONF System Notifications March 2011
2.1.1. Notifications
This module defines some events for the 'NETCONF' stream to notify a
client application that the NETCONF server state has changed.
o netconf-config-change: Generated when the NETCONF server detects
that the <running> or <startup> configuration datastore has
changed. Summarizes each edit being reported.
o netconf-capability-change: Generated when the NETCONF server
capabilities are changed. Indicates which capabilities have been
added, deleted, and/or modified.
o netconf-session-start: Generated when a NETCONF session is
started. Indicates the identity of the user that started the
session.
o netconf-session-end: Generated when a NETCONF server detects that
a session has terminated. Indicates the identity of the user that
owned the session, and why the session was terminated.
o netconf-confirmed-commit: Generated when a NETCONF confirmed-
commit event occurs. Indicates the current state of the
confirmed-commit operation in progress.
2.2. Definitions
<CODE BEGINS> file="ietf-netconf-system-notifications@2011-03-08.yang"
module ietf-netconf-system-notifications {
namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications";
prefix ncsys;
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>
Bierman Expires September 10, 2011 [Page 4]
Internet-Draft NETCONF System Notifications March 2011
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 system 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-03.txt
revision 2011-03-08 {
description
"Initial version.";
reference
"RFC XXXX: NETCONF System Notifications";
}
// RFC Ed.: replace XXXX with actual
// RFC number and remove this note
grouping common-session-parms {
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.";
Bierman Expires September 10, 2011 [Page 5]
Internet-Draft NETCONF System Notifications March 2011
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 {
container changed-by {
description
"Indicates who caused this 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.";
uses changed-by-parms;
leaf target-datastore {
type enumeration {
enum running {
Bierman Expires September 10, 2011 [Page 6]
Internet-Draft NETCONF System Notifications March 2011
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 will be present for each distinct
edit operation on the target datastore.";
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 which 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 a <capability> is added, deleted,
or modified.";
uses changed-by-parms;
leaf-list added-capability {
type inet:uri;
description
Bierman Expires September 10, 2011 [Page 7]
Internet-Draft NETCONF System Notifications March 2011
"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 new NETCONF session is started.";
uses common-session-parms;
} // notification netconf-session-start
notification netconf-session-end {
description
"Generated when a NETCONF session is terminated.";
uses common-session-parms;
leaf killed-by {
when "../termination-reason = 'killed'";
type nc:session-id-type;
description
"Session ID that issued the <kill-session>
if the session was terminated by this operation.";
}
leaf termination-reason {
type enumeration {
enum "closed" {
value 0;
description
Bierman Expires September 10, 2011 [Page 8]
Internet-Draft NETCONF System Notifications March 2011
"The session was terminated with
the NETCONF <close-session> operation.";
}
enum "killed" {
value 1;
description
"The session was terminated with
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, either waiting for
the <hello> 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 confirmed-commit event occurs.";
reference
"I-D draft-ietf-netconf-4741bis section 8.4";
uses common-session-parms {
Bierman Expires September 10, 2011 [Page 9]
Internet-Draft NETCONF System Notifications March 2011
when "../confirm-event != 'timeout'";
}
leaf confirm-event {
description
"Indicates the event that caused the notification.";
type enumeration {
enum "start" {
value 0;
description
"The confirm-commit procedure has started.";
}
enum "cancel" {
value 1;
description
"The confirm-commit procedure has been canceled,
due to the session being terminated, or an
explicit <cancel-commit> operation.";
}
enum "timeout" {
value 2;
description
"The confirm-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 confirm-commit timeout has been extended.";
}
enum "complete" {
value 4;
description
"The confirm-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
Bierman Expires September 10, 2011 [Page 10]
Internet-Draft NETCONF System Notifications March 2011
time when the 'timeout' event might occur.";
units "seconds";
type uint32;
}
} // notification netconf-confirmed-commit
}
<CODE ENDS>
3. IANA Considerations
This document registers one XML namespace URN in the 'IETF XML
registry', following the format defined in [RFC3688].
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications
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] .
name: ietf-netconf-system-notifications
prefix: ncsys
namespace:
urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications
RFC: XXXX // RFC Ed.: replace XXXX and remove this comment
4. Security Considerations
This document defines a YANG module for reporting of particular
system events. Although unlikely, it is possible that data obtained
from this module could be used in an attack of some kind, although no
specific information in this module is considered sensitive.
TBD: follow Security Consideration guidelines from new template text.
5. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997.
Bierman Expires September 10, 2011 [Page 11]
Internet-Draft NETCONF System Notifications March 2011
[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.
[I-D.ietf-netconf-4741bis]
Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "Network Configuration Protocol (NETCONF)",
draft-ietf-netconf-4741bis-09 (work in progress),
February 2011.
Appendix A. Change Log
-- RFC Ed.: remove this section before publication.
A.1. 02-03
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.
Bierman Expires September 10, 2011 [Page 12]
Internet-Draft NETCONF System Notifications March 2011
A.2. 01-02
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.
A.3. 00-01
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.
A.4. 00
Initial version, based on
draft-bierman-netconf-system-monitoring-00.txt.
Author's Address
Andy Bierman
Brocade
Email: andy.bierman@brocade.com
Bierman Expires September 10, 2011 [Page 13]
