draft-ietf-netconf-system-notifications-01.txt   draft-ietf-netconf-system-notifications-02.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Brocade Internet-Draft Brocade
Intended status: Standards Track October 22, 2010 Intended status: Standards Track November 15, 2010
Expires: April 25, 2011 Expires: May 19, 2011
NETCONF System Notifications Network Configuration Protocol Notification Events
draft-ietf-netconf-system-notifications-01 draft-ietf-netconf-system-notifications-02
Abstract Abstract
The NETCONF protocol provides mechanisms to manipulate configuration The NETCONF protocol provides mechanisms to manipulate configuration
datastores. However, client applications often need to be aware of datastores. However, client applications often need to be aware of
common system events such as a change in system capabilities, which common events such as a change in NETCONF capabilities, which may
may impact management applications. Standard mechanisms are needed impact management applications. Standard mechanisms are needed to
to support the monitoring of the system events within the NETCONF support the monitoring of the events within the NETCONF server. This
server. This document defines a YANG module which allows a NETCONF document defines a YANG module which allows a NETCONF client to
client to receive notifications for some common system events. receive notifications for some common events.
Status of this Memo Status of this Memo
This Internet-Draft is submitted in full conformance with the This Internet-Draft is submitted in full conformance with the
provisions of BCP 78 and BCP 79. provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering Internet-Drafts are working documents of the Internet Engineering
Task Force (IETF). Note that other groups may also distribute Task Force (IETF). Note that other groups may also distribute
working documents as Internet-Drafts. The list of current Internet- working documents as Internet-Drafts. The list of current Internet-
Drafts is at http://datatracker.ietf.org/drafts/current/. Drafts is at http://datatracker.ietf.org/drafts/current/.
Internet-Drafts are draft documents valid for a maximum of six months Internet-Drafts are draft documents valid for a maximum of six months
and may be updated, replaced, or obsoleted by other documents at any and may be updated, replaced, or obsoleted by other documents at any
time. It is inappropriate to use Internet-Drafts as reference time. It is inappropriate to use Internet-Drafts as reference
material or to cite them other than as "work in progress." material or to cite them other than as "work in progress."
This Internet-Draft will expire on April 25, 2011. This Internet-Draft will expire on May 19, 2011.
Copyright Notice Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved. document authors. All rights reserved.
This document is subject to BCP 78 and the IETF Trust's Legal This document is subject to BCP 78 and the IETF Trust's Legal
Provisions Relating to IETF Documents Provisions Relating to IETF Documents
(http://trustee.ietf.org/license-info) in effect on the date of (http://trustee.ietf.org/license-info) in effect on the date of
publication of this document. Please review these documents publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License. described in the Simplified BSD License.
Table of Contents Table of Contents
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. YANG Module for System Notifications . . . . . . . . . . . . . 3 2. YANG Module for Notifications . . . . . . . . . . . . . . . . 3
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.1. Notifications . . . . . . . . . . . . . . . . . . . . 3 2.1.1. Notifications . . . . . . . . . . . . . . . . . . . . 3
2.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4 2.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 11
4. Security Considerations . . . . . . . . . . . . . . . . . . . 11 4. Security Considerations . . . . . . . . . . . . . . . . . . . 11
5. Normative References . . . . . . . . . . . . . . . . . . . . . 11 5. Normative References . . . . . . . . . . . . . . . . . . . . . 11
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 11 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
A.1. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.1. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.2. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 12
A.3. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 12 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 12
1. Introduction 1. Introduction
The NETCONF protocol [RFC4741] provides mechanisms to manipulate The NETCONF protocol [I-D.ietf-netconf-4741bis] provides mechanisms
configuration datastores. However, client applications often need to to manipulate configuration datastores. However, client applications
be aware of common system events such as a change in system often need to be aware of common events such as a change in NETCONF
capabilities, which may impact management applications. Standard capabilities, which may impact management applications. Standard
mechanisms are needed to support the monitoring of the system events mechanisms are needed to support the monitoring of the events within
within the NETCONF server. This document defines a YANG module the NETCONF server. This document defines a YANG module [RFC6020]
[RFC6020] which allows a NETCONF client to receive notifications for which allows a NETCONF client to receive notifications for some
some common system events. common events.
1.1. Terminology 1.1. Terminology
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT", The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this "SHOULD", "SHOULD NOT", "RECOMMENDED", "MAY", and "OPTIONAL" in this
document are to be interpreted as described in [RFC2119]. document are to be interpreted as described in [RFC2119].
The following terms are defined in [RFC4741]: The following terms are defined in [I-D.ietf-netconf-4741bis]:
o client o client
o datastore o datastore
o operation o operation
o server o server
The following terms are defined in [RFC5277]: The following terms are defined in [RFC5277]:
o event o event
o stream o stream
o subscription o subscription
The following term is defined in [RFC6020]: The following term is defined in [RFC6020]:
o data node o data node
2. YANG Module for System Notifications 2. YANG Module for Notifications
2.1. Overview 2.1. Overview
The YANG module defined within this document specifies a small number The YANG module defined within this document specifies a small number
of notification event messages for use within the 'NETCONF' stream, of notification event messages for use within the 'NETCONF' stream,
and accessible to clients via the subscription mechanism in and accessible to clients via the subscription mechanism in
[RFC5277]. [RFC5277].
The YANG language is defined in [RFC6020]. The YANG language is defined in [RFC6020].
2.1.1. Notifications 2.1.1. Notifications
This module defines some system events to notify a client application This module defines some events for the 'NETCONF' stream to notify a
that the system state has changed. client application that the NETCONF server state has changed.
o sys-config-change: Generated when the <running> or <startup> o netconf-config-change: Generated when the NETCONF server detects
configuration datastore is changed. Summarizes each edit being that the <running> or <startup> configuration datastore has
reported. changed. Summarizes each edit being reported.
o sys-capability-change: Generated when the NETCONF server o netconf-capability-change: Generated when the NETCONF server
capabilities are changed. Indicates which capabilities have been capabilities are changed. Indicates which capabilities have been
added, deleted, and/or modified. added, deleted, and/or modified.
o sys-session-start: Generated when the NETCONF session is started. o netconf-session-start: Generated when a NETCONF session is
Indicates the identity of the user that started the session. started. Indicates the identity of the user that started the
o sys-session-end: Generated when the NETCONF session is terminated. session.
Indicates the identity of the user that owned the session, and why o netconf-session-end: Generated when a NETCONF server detects that
the session was terminated. a session has terminated. Indicates the identity of the user that
o sys-conformed-commit: Generated when the NETCONF confirmed-commit owned the session, and why the session was terminated.
event occurs. Indicates the current state of the confirmed-commit o netconf-confirmed-commit: Generated when a NETCONF confirmed-
operation in progress. commit event occurs. Indicates the current state of the
confirmed-commit operation in progress.
2.2. Definitions 2.2. Definitions
<CODE BEGINS> file="ietf-netconf-system-notifications@2010-10-21.yang" <CODE BEGINS> file="ietf-netconf-events@2010-11-15.yang"
module ietf-netconf-system-notifications { module ietf-netconf-events {
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications"; "urn:ietf:params:xml:ns:yang:ietf-netconf-events";
prefix nc-sys-notif; prefix nce;
import ietf-inet-types { prefix inet; } import ietf-inet-types { prefix inet; }
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
organization organization
"IETF NETCONF (Network Configuration Protocol) Working Group"; "IETF NETCONF (Network Configuration Protocol) Working Group";
contact contact
"WG Web: <http://tools.ietf.org/wg/netconf/> "WG Web: <http://tools.ietf.org/wg/netconf/>
WG List: <mailto:netconf@ietf.org> WG List: <mailto:netconf@ietf.org>
skipping to change at page 5, line 6 skipping to change at page 5, line 8
WG Chair: Mehmet Ersue WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com> <mailto:mehmet.ersue@nsn.com>
Editor: Andy Bierman Editor: Andy Bierman
<mailto:andy.bierman@brocade.com>"; <mailto:andy.bierman@brocade.com>";
description description
"This module defines an YANG data model for use with the "This module defines an YANG data model for use with the
NETCONF protocol that allows the NETCONF client to NETCONF protocol that allows the NETCONF client to
receive common system events. receive common events.
Copyright (c) 2010 IETF Trust and the persons identified as Copyright (c) 2010 IETF Trust and the persons identified as
the document authors. All rights reserved. the document authors. All rights reserved.
Redistribution and use in source and binary forms, with or Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD License to the license terms contained in, the Simplified BSD License
set forth in Section 4.c of the IETF Trust's Legal Provisions set forth in Section 4.c of the IETF Trust's Legal Provisions
Relating to IETF Documents Relating to IETF Documents
(http://trustee.ietf.org/license-info). (http://trustee.ietf.org/license-info).
This version of this YANG module is part of RFC XXXX; see This version of this YANG module is part of RFC XXXX; see
the RFC itself for full legal notices."; the RFC itself for full legal notices.";
// RFC Ed.: replace XXXX with actual RFC number and remove this note // RFC Ed.: replace XXXX with actual RFC number and remove this note
// RFC Ed.: remove this note // RFC Ed.: remove this note
// Note: extracted from // Note: extracted from
// draft-ietf-netconf-system-notifications-01.txt // draft-ietf-netconf-system-notifications-02.txt
revision 2010-10-21 { revision 2010-11-15 {
description description
"Initial version."; "Initial version.";
reference reference
"RFC XXXX: NETCONF System Notifications"; "RFC XXXX: NETCONF Notification Events";
} }
// RFC Ed.: replace XXXX with actual // RFC Ed.: replace XXXX with actual
// RFC number and remove this note // RFC number and remove this note
grouping sys-common-session-parms { grouping common-session-parms {
leaf user-name { leaf user-name {
description description
"Name of the user for the session."; "Name of the user for the session.";
type string; type string;
} }
leaf session-id { leaf session-id {
description "Identifier of the session."; description "Identifier of the session.";
type nc:session-id-or-zero-type; type nc:session-id-or-zero-type;
mandatory true;
} }
leaf remote-host { leaf remote-host {
description description
"Address of the remote host for the session."; "Address of the remote host for the session.";
type inet:ip-address; type inet:ip-address;
} }
} }
grouping changed-by-parms { grouping changed-by-parms {
container changed-by { container changed-by {
description description
"Indicates who caused this change. "Indicates who caused this change.
If caused by internal action, then the If caused by internal action, then the
empty leaf 'server' will be present. empty leaf 'server' will be present.
If caused by a management session, then If caused by a management session, then
skipping to change at page 6, line 26 skipping to change at page 6, line 28
of the session that made the change will be reported."; of the session that made the change will be reported.";
choice server-or-user { choice server-or-user {
leaf server { leaf server {
type empty; type empty;
description description
"If present, the change was caused "If present, the change was caused
by the server."; by the server.";
} }
case by-user { case by-user {
uses sys-common-session-parms { uses common-session-parms;
refine session-id {
mandatory true;
}
}
} }
} // choice server-or-user } // choice server-or-user
} // container changed-by-parms; } // container changed-by-parms;
} }
notification sys-config-change { notification netconf-config-change {
description description
"Generated when the <running> or <startup> configuration "Generated when the <running> or <startup> configuration
database is changed."; database is changed.";
uses changed-by-parms; uses changed-by-parms;
leaf target-database {
type enumeration {
enum running {
description "The running database has changed.";
}
enum startup {
description "The startup database has changed";
}
}
description
"Indicates which configuration database has changed.";
default "running";
}
list edit { list edit {
description description
"An edit record will be present for each distinct "An edit record will be present for each distinct
edit operation on the target database."; edit operation on the target database.";
leaf target-database {
type enumeration {
enum running {
description "The running database has changed.";
}
enum startup {
description "The startup database has changed";
}
}
description
"Indicates which configuration database has changed.";
default "running";
}
leaf target { leaf target {
type instance-identifier; type instance-identifier;
description description
"Topmost node associated with the configuration change. "Topmost node associated with the configuration change.
A server SHOULD set this object to the node within A server SHOULD set this object to the node within
the database which is being altered. A server MAY the database which is being altered. A server MAY
set this object to one of the ancestors of the actual set this object to one of the ancestors of the actual
node that was changed, or omit this object, if the node that was changed, or omit this object, if the
exact node is not known."; exact node is not known.";
} }
leaf operation { leaf operation {
type nc:edit-operation-type; type nc:edit-operation-type;
description description
"Type of edit operation performed. "Type of edit operation performed.
A server SHOULD set this object to the NETCONF edit A server MUST set this object to the NETCONF edit
operation performed on the target database."; operation performed on the target database.";
} }
} // list edit } // list edit
} // notification sys-config-change } // notification netconf-config-change
notification sys-capability-change { notification netconf-capability-change {
description description
"Generated when a <capability> is added, deleted, "Generated when a <capability> is added, deleted,
or modified."; or modified.";
uses changed-by-parms; uses changed-by-parms;
leaf-list added-capability { leaf-list added-capability {
type inet:uri; type inet:uri;
description description
"List of capabilities that have just been added."; "List of capabilities that have just been added.";
skipping to change at page 8, line 16 skipping to change at page 8, line 16
leaf-list modified-capability { leaf-list modified-capability {
type inet:uri; type inet:uri;
description description
"List of capabilities that have just been modified. "List of capabilities that have just been modified.
A capability is considered to be modified if the A capability is considered to be modified if the
base URI for the capability has not changed, but base URI for the capability has not changed, but
one or more of the parameters encoded at the end of one or more of the parameters encoded at the end of
the capability URI has changed."; the capability URI has changed.";
} }
} // notification sys-capability-change } // notification netconf-capability-change
notification sys-session-start { notification netconf-session-start {
description description
"Generated when a new NETCONF session is started."; "Generated when a new NETCONF session is started.";
uses sys-common-session-parms { uses common-session-parms;
refine session-id { } // notification netconf-session-start
mandatory true;
}
}
} // notification sys-session-start
notification sys-session-end { notification netconf-session-end {
description description
"Generated when a NETCONF session is terminated."; "Generated when a NETCONF session is terminated.";
uses sys-common-session-parms { uses common-session-parms;
refine session-id {
mandatory true;
}
}
leaf killed-by { leaf killed-by {
when "../termination-reason = 'killed'"; when "../termination-reason = 'killed'";
type nc:session-id-type; type nc:session-id-type;
description description
"Session ID that issued the <kill-session> "Session ID that issued the <kill-session>
if the session was terminated by this operation."; if the session was terminated by this operation.";
} }
leaf termination-reason { leaf termination-reason {
type enumeration { type enumeration {
enum "closed" { enum "closed" {
value 0; value 0;
description description
"The session was terminated with "The session was terminated with
the <close-session> operation."; the NETCONF <close-session> operation.";
} }
enum "killed" { enum "killed" {
value 1; value 1;
description description
"The session was terminated with "The session was terminated with
the NETCONF <kill-session> operation."; the NETCONF <kill-session> operation.";
} }
enum "dropped" { enum "dropped" {
value 2; value 2;
description description
"The session was terminated because "The session was terminated because
the SSH session or TCP connection was the transport layer connection was
unexpectedly closed."; unexpectedly closed.";
} }
enum "timeout" { enum "timeout" {
value 3; value 3;
description description
"The session was terminated because "The session was terminated because
of inactivity, either waiting for of inactivity, either waiting for
the <hello> or <rpc> messages."; the <hello> or <rpc> messages.";
} }
enum "bad-hello" { enum "bad-hello" {
value 4; value 4;
description description
"The client's <hello> message was "The client's <hello> message was invalid.";
bad or never arrived.";
} }
enum "other" { enum "other" {
value 5; value 5;
description description
"The session was terminated for "The session was terminated for
some other reason."; some other reason.";
} }
} }
mandatory "true"; mandatory "true";
description "Reason the session was terminated."; description "Reason the session was terminated.";
} }
} // notification sys-session-end } // notification netconf-session-end
notification sys-confirmed-commit { notification netconf-confirmed-commit {
description description
"Generated when a confirmed-commit event occurs."; "Generated when a confirmed-commit event occurs.";
uses sys-common-session-parms; reference
"I-D draft-ietf-netconf-4741bis section 8.4";
uses common-session-parms {
refine session-id {
mandatory false;
}
}
leaf confirm-event { leaf confirm-event {
description description
"Indicates the event that caused the notification."; "Indicates the event that caused the notification.";
type enumeration { type enumeration {
enum "start" { enum "start" {
value 0; value 0;
description description
"The confirm-commit procedure has started."; "The confirm-commit procedure has started.";
} }
enum "cancel" { enum "cancel" {
value 1; value 1;
description description
"The confirm-commit procedure has been canceled, "The confirm-commit procedure has been canceled,
due to the session being terminated."; due to the session being terminated, or an
explicit <cancel-commit> operation.";
} }
enum "timeout" { enum "timeout" {
value 2; value 2;
description description
"The confirm-commit procedure has been canceled, "The confirm-commit procedure has been canceled,
due to the confirm-timeout interval expiring. due to the confirm-timeout interval expiring.
The common session parameters will not be present The common session parameters will not be present
in this sub-mode."; in this sub-mode.";
} }
enum "extend" { enum "extend" {
skipping to change at page 10, line 51 skipping to change at page 10, line 51
when when
"../confirm-event = 'start' or ../confirm-event = 'extend'"; "../confirm-event = 'start' or ../confirm-event = 'extend'";
description description
"The configured timeout value if the event type "The configured timeout value if the event type
is 'start' or 'extend'. This value represents the is 'start' or 'extend'. This value represents the
the approximate number of seconds from the event the approximate number of seconds from the event
time when the 'timeout' event might occur."; time when the 'timeout' event might occur.";
units "seconds"; units "seconds";
type uint32; type uint32;
} }
} // notification sys-confirmed-commit } // notification netconf-confirmed-commit
} }
<CODE ENDS> <CODE ENDS>
3. IANA Considerations 3. IANA Considerations
TBD 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-events
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-events
prefix: nce
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-events
RFC: XXXX // RFC Ed.: replace XXXX and remove this comment
4. Security Considerations 4. Security Considerations
This document defines a YANG module for reporting of particular This document defines a YANG module for reporting of particular
system events. Although unlikely, it is possible that data obtained system events. Although unlikely, it is possible that data obtained
from this module could be used in an attack of some kind, although no from this module could be used in an attack of some kind, although no
specific information in this module is considered sensitive. specific information in this module is considered sensitive.
TBD: follow Security Consideration guidelines from new template text. TBD: follow Security Consideration guidelines from new template text.
5. Normative References 5. Normative References
[RFC2119] Bradner, S., "Key words for use in RFCs to Indicate [RFC2119] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", BCP 14, RFC 2119, March 1997. Requirement Levels", BCP 14, RFC 2119, March 1997.
[RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688, [RFC3688] Mealling, M., "The IETF XML Registry", BCP 81, RFC 3688,
January 2004. January 2004.
[RFC4741] Enns, R., "NETCONF Configuration Protocol", RFC 4741,
December 2006.
[RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event [RFC5277] Chisholm, S. and H. Trevino, "NETCONF Event
Notifications", RFC 5277, July 2008. Notifications", RFC 5277, July 2008.
[RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the [RFC6020] Bjorklund, M., "YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)", RFC 6020, Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. October 2010.
[RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021, [RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021,
October 2010. October 2010.
[I-D.ietf-netconf-4741bis]
Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "Network Configuration Protocol (NETCONF)",
draft-ietf-netconf-4741bis-06 (work in progress),
October 2010.
Appendix A. Change Log Appendix A. Change Log
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
A.1. 00-01 A.1. 01-02
Renamed module NETCONF Events instead of NETCONF system
notifications. Note that ietf-netconf-notfications 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.2. 00-01
Removed sys-startup notification. Removed sys-startup notification.
Make changed-by into a grouping, and added usage to sys-config-change Make changed-by into a grouping, and added usage to sys-config-change
notification. notification.
Added target-database leaf to sys-config-change to distinguish Added target-database leaf to sys-config-change to distinguish
between running and startup changes. between running and startup changes.
Removed 'bad-start' from termination-reason leaf in sys-session-end Removed 'bad-start' from termination-reason leaf in sys-session-end
notification. notification.
A.2. 00 A.3. 00
Initial version, based on Initial version, based on
draft-bierman-netconf-system-monitoring-00.txt. draft-bierman-netconf-system-monitoring-00.txt.
Author's Address Author's Address
Andy Bierman Andy Bierman
Brocade Brocade
Email: andy.bierman@brocade.com Email: andy.bierman@brocade.com
 End of changes. 49 change blocks. 
99 lines changed or deleted 124 lines changed or added

This html diff was produced by rfcdiff 1.40. The latest version is available from http://tools.ietf.org/tools/rfcdiff/