draft-ietf-netconf-system-notifications-02.txt   draft-ietf-netconf-system-notifications-03.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Brocade Internet-Draft Brocade
Intended status: Standards Track November 15, 2010 Intended status: Standards Track March 9, 2011
Expires: May 19, 2011 Expires: September 10, 2011
Network Configuration Protocol Notification Events Network Configuration Protocol System Notifications
draft-ietf-netconf-system-notifications-02 draft-ietf-netconf-system-notifications-03
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 events such as a change in NETCONF capabilities, which may common NETCONF system events such as a change in NETCONF
impact management applications. Standard mechanisms are needed to capabilities, which may impact management applications. Standard
support the monitoring of the events within the NETCONF server. This mechanisms are needed to support the monitoring of the NETCONF system
document defines a YANG module which allows a NETCONF client to events within the NETCONF server. This document defines a YANG
receive notifications for some common events. module which allows a NETCONF client to 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 May 19, 2011. This Internet-Draft will expire on September 10, 2011.
Copyright Notice Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the Copyright (c) 2011 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 Notifications . . . . . . . . . . . . . . . . 3 2. YANG Module for NETCONF System Notifications . . . . . . . . . 3
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.1.1. Notifications . . . . . . . . . . . . . . . . . . . . 3 2.1.1. Notifications . . . . . . . . . . . . . . . . . . . . 4
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 . . . . . . . . . . . . . . . . . . . . . 12 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 12
A.1. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.1. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 12
A.2. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.2. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
A.3. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.3. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 12 A.4. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 13
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 13
1. Introduction 1. Introduction
The NETCONF protocol [I-D.ietf-netconf-4741bis] provides mechanisms The NETCONF protocol [I-D.ietf-netconf-4741bis] provides mechanisms
to manipulate configuration datastores. However, client applications to manipulate configuration datastores. However, client applications
often need to be aware of common events such as a change in NETCONF often need to be aware of common NETCONF system events such as a
capabilities, which may impact management applications. Standard change in NETCONF capabilities, which may impact management
mechanisms are needed to support the monitoring of the events within applications. Standard mechanisms are needed to support the
the NETCONF server. This document defines a YANG module [RFC6020] monitoring of the NETCONF system events within the NETCONF server.
which allows a NETCONF client to receive notifications for some This document defines a YANG module [RFC6020] which allows a NETCONF
common events. client to receive notifications for some 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 [I-D.ietf-netconf-4741bis]: The following terms are defined in [I-D.ietf-netconf-4741bis]:
o client o client
o datastore o datastore
skipping to change at page 3, line 36 skipping to change at page 3, line 36
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 Notifications 2. YANG Module for NETCONF System 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].
These notifications pertain to the NETCONF portion of the managed
system, not the entire system.
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 events for the 'NETCONF' stream to notify a This module defines some events for the 'NETCONF' stream to notify a
client application that the NETCONF server state has changed. client application that the NETCONF server state has changed.
o netconf-config-change: Generated when the NETCONF server detects o netconf-config-change: Generated when the NETCONF server detects
that the <running> or <startup> configuration datastore has that the <running> or <startup> configuration datastore has
changed. Summarizes each edit being reported. changed. Summarizes each edit being reported.
o netconf-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 netconf-session-start: Generated when a NETCONF session is o netconf-session-start: Generated when a NETCONF session is
started. Indicates the identity of the user that started the started. Indicates the identity of the user that started the
session. session.
o netconf-session-end: Generated when a NETCONF server detects that o netconf-session-end: Generated when a NETCONF server detects that
skipping to change at page 4, line 23 skipping to change at page 4, line 27
session. session.
o netconf-session-end: Generated when a NETCONF server detects that o netconf-session-end: Generated when a NETCONF server detects that
a session has terminated. Indicates the identity of the user that a session has terminated. Indicates the identity of the user that
owned the session, and why the session was terminated. owned the session, and why the session was terminated.
o netconf-confirmed-commit: Generated when a NETCONF confirmed- o netconf-confirmed-commit: Generated when a NETCONF confirmed-
commit event occurs. Indicates the current state of the commit event occurs. Indicates the current state of the
confirmed-commit operation in progress. confirmed-commit operation in progress.
2.2. Definitions 2.2. Definitions
<CODE BEGINS> file="ietf-netconf-events@2010-11-15.yang" <CODE BEGINS> file="ietf-netconf-system-notifications@2011-03-08.yang"
module ietf-netconf-events { module ietf-netconf-system-notifications {
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-events"; "urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications";
prefix nce; prefix ncsys;
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 8 skipping to change at page 5, line 11
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 events. receive common NETCONF system notification events.
Copyright (c) 2010 IETF Trust and the persons identified as Copyright (c) 2011 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-02.txt // draft-ietf-netconf-system-notifications-03.txt
revision 2010-11-15 { revision 2011-03-08 {
description description
"Initial version."; "Initial version.";
reference reference
"RFC XXXX: NETCONF Notification Events"; "RFC XXXX: NETCONF System Notifications";
} }
// 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 common-session-parms { grouping common-session-parms {
leaf username {
leaf user-name {
description description
"Name of the user for the session."; "Name of the user for the session.";
type string; type string;
mandatory true;
} }
leaf session-id { leaf session-id {
description "Identifier of the session."; description
"Identifier of the session.
A non-NETCONF session will be identified by the value zero.";
type nc:session-id-or-zero-type; type nc:session-id-or-zero-type;
mandatory true; mandatory true;
} }
leaf remote-host { leaf source-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
the name, remote host address, and session ID the name, remote host address, and session ID
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 {
mandatory true;
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 common-session-parms; uses common-session-parms;
} }
} // choice server-or-user } // choice server-or-user
} // container changed-by-parms; } // container changed-by-parms;
} }
notification netconf-config-change { notification netconf-config-change {
description description
"Generated when the <running> or <startup> configuration "Generated when the NETCONF server detects that the
database is changed."; <running> or <startup> configuration datastore has changed.";
uses changed-by-parms; uses changed-by-parms;
leaf target-database { leaf target-datastore {
type enumeration { type enumeration {
enum running { enum running {
description "The running database has changed."; description "The running datastore has changed.";
} }
enum startup { enum startup {
description "The startup database has changed"; description "The startup datastore has changed";
} }
} }
description description
"Indicates which configuration database has changed."; "Indicates which configuration datastore has changed.";
default "running"; 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 datastore.";
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 datastore 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 MUST 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 datastore.";
} }
} // list edit } // list edit
} // notification netconf-config-change } // notification netconf-config-change
notification netconf-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;
skipping to change at page 8, line 14 skipping to change at page 8, line 20
"List of capabilities that have just been deleted."; "List of capabilities that have just been deleted.";
} }
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.
The new modified value of the complete URI is returned.";
} }
} // notification netconf-capability-change } // notification netconf-capability-change
notification netconf-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 common-session-parms; uses common-session-parms;
} // notification netconf-session-start } // notification netconf-session-start
notification netconf-session-end { notification netconf-session-end {
skipping to change at page 9, line 44 skipping to change at page 10, line 4
} }
} // notification netconf-session-end } // notification netconf-session-end
notification netconf-confirmed-commit { notification netconf-confirmed-commit {
description description
"Generated when a confirmed-commit event occurs."; "Generated when a confirmed-commit event occurs.";
reference reference
"I-D draft-ietf-netconf-4741bis section 8.4"; "I-D draft-ietf-netconf-4741bis section 8.4";
uses common-session-parms { uses common-session-parms {
refine session-id { when "../confirm-event != 'timeout'";
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.";
skipping to change at page 11, line 14 skipping to change at page 11, line 19
} }
<CODE ENDS> <CODE ENDS>
3. IANA Considerations 3. IANA Considerations
This document registers one XML namespace URN in the 'IETF XML This document registers one XML namespace URN in the 'IETF XML
registry', following the format defined in [RFC3688]. registry', following the format defined in [RFC3688].
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-events URI: urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The NETCONF WG of the IETF.
XML: N/A, the requested URI is an XML namespace. XML: N/A, the requested URI is an XML namespace.
This document registers one module name in the 'YANG Module Names' This document registers one module name in the 'YANG Module Names'
registry, defined in [RFC6020] . registry, defined in [RFC6020] .
name: ietf-netconf-events name: ietf-netconf-system-notifications
prefix: nce prefix: ncsys
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-events namespace:
urn:ietf:params:xml:ns:yang:ietf-netconf-system-notifications
RFC: XXXX // RFC Ed.: replace XXXX and remove this comment 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.
skipping to change at page 12, line 13 skipping to change at page 12, line 21
[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] [I-D.ietf-netconf-4741bis]
Enns, R., Bjorklund, M., Schoenwaelder, J., and A. Enns, R., Bjorklund, M., Schoenwaelder, J., and A.
Bierman, "Network Configuration Protocol (NETCONF)", Bierman, "Network Configuration Protocol (NETCONF)",
draft-ietf-netconf-4741bis-06 (work in progress), draft-ietf-netconf-4741bis-09 (work in progress),
October 2010. February 2011.
Appendix A. Change Log Appendix A. Change Log
-- RFC Ed.: remove this section before publication. -- RFC Ed.: remove this section before publication.
A.1. 01-02 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.
A.2. 01-02
Renamed module NETCONF Events instead of NETCONF system Renamed module NETCONF Events instead of NETCONF system
notifications. Note that ietf-netconf-notfications is being reserved notifications. Note that ietf-netconf-notifications is being
for the XML content defined in RFC 5277. reserved for the XML content defined in RFC 5277.
Made changes based on mailing list comments and latest WG consensus. Made changes based on mailing list comments and latest WG consensus.
Filled in IANA section. Filled in IANA section.
A.2. 00-01 A.3. 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.3. 00 A.4. 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. 43 change blocks. 
62 lines changed or deleted 94 lines changed or added

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