draft-ietf-netconf-system-notifications-05.txt   draft-ietf-netconf-system-notifications-06.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Brocade Internet-Draft Brocade
Intended status: Standards Track August 7, 2011 Intended status: Standards Track October 28, 2011
Expires: February 8, 2012 Expires: April 30, 2012
Network Configuration Protocol (NETCONF) Base Notifications Network Configuration Protocol (NETCONF) Base Notifications
draft-ietf-netconf-system-notifications-05 draft-ietf-netconf-system-notifications-06
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 server capabilities, that common events such as a change in NETCONF server capabilities, that
may impact management applications. Standard mechanisms are needed may impact management applications. Standard mechanisms are needed
to support the monitoring of the base system events within the to support the monitoring of the base system events within the
NETCONF server. This document defines a YANG module that allows a NETCONF server. This document defines a YANG module that allows a
NETCONF client to receive notifications for some common system NETCONF client to receive notifications for some common system
skipping to change at page 1, line 37 skipping to change at page 1, line 37
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 February 8, 2012. This Internet-Draft will expire on April 30, 2012.
Copyright Notice Copyright Notice
Copyright (c) 2011 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
skipping to change at page 2, line 20 skipping to change at page 2, line 20
1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3
2. YANG Module for NETCONF Base Notifications . . . . . . . . . . 3 2. YANG Module for NETCONF Base Notifications . . . . . . . . . . 3
2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3 2.1. Overview . . . . . . . . . . . . . . . . . . . . . . . . . 3
2.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4 2.2. Definitions . . . . . . . . . . . . . . . . . . . . . . . 4
3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12 3. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 12
4. Security Considerations . . . . . . . . . . . . . . . . . . . 12 4. Security Considerations . . . . . . . . . . . . . . . . . . . 12
5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 14 5. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 14
6. Normative References . . . . . . . . . . . . . . . . . . . . . 14 6. Normative References . . . . . . . . . . . . . . . . . . . . . 14
Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 15 Appendix A. Change Log . . . . . . . . . . . . . . . . . . . . . 15
A.1. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.1. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.2. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.2. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.3. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.3. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.4. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.4. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.5. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.5. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.6. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.6. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.7. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 16 Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 16
1. Introduction 1. Introduction
The NETCONF protocol [RFC6241] provides mechanisms to manipulate The NETCONF protocol [RFC6241] provides mechanisms to manipulate
configuration datastores. However, client applications often need to configuration datastores. However, client applications often need to
be aware of common events such as a change in NETCONF server be aware of common events such as a change in NETCONF server
capabilities, that may impact management applications. Standard capabilities, that may impact management applications. Standard
mechanisms are needed to support the monitoring of the base system mechanisms are needed to support the monitoring of the base system
events within the NETCONF server. This document defines a YANG events within the NETCONF server. This document defines a YANG
skipping to change at page 4, line 9 skipping to change at page 4, line 9
events that are directly related to the NETCONF protocol. A server events that are directly related to the NETCONF protocol. A server
MAY report events for non-NETCONF management sessions, using the MAY report events for non-NETCONF management sessions, using the
'session-id' value of zero. 'session-id' value of zero.
This module defines the following notifications for the 'NETCONF' This module defines the following notifications for the 'NETCONF'
stream to notify a client application that the NETCONF server state stream to notify a client application that the NETCONF server state
has changed: has changed:
netconf-config-change: netconf-config-change:
Generated when the NETCONF server detects that the <running> or Generated when the NETCONF server detects that the <running> or
<startup> configuration datastore has changed. Summarizes each <startup> configuration datastore has changed. Summarizes the
edit being reported. edits that have been detected.
netconf-capability-change: netconf-capability-change:
Generated when the NETCONF server detects that the server Generated when the NETCONF server detects that the server
capabilities have changed. Indicates which capabilities have been capabilities have changed. Indicates which capabilities have been
added, deleted, and/or modified. The manner in which a server added, deleted, and/or modified. The manner in which a server
capability is changed is outside the scope of this document. capability is changed is outside the scope of this document.
netconf-session-start: netconf-session-start:
Generated when a NETCONF server detects that a NETCONF session has Generated when a NETCONF server detects that a NETCONF session has
started. A server MAY generate this event for non-NETCONF started. A server MAY generate this event for non-NETCONF
management sessions. Indicates the identity of the user that management sessions. Indicates the identity of the user that
started the session. started the session.
skipping to change at page 4, line 33 skipping to change at page 4, line 33
terminated. A server MAY optionally generate this event for non- terminated. A server MAY optionally generate this event for non-
NETCONF management sessions. Indicates the identity of the user NETCONF management sessions. Indicates the identity of the user
that owned the session, and why the session was terminated. that owned the session, and why the session was terminated.
netconf-confirmed-commit: netconf-confirmed-commit:
Generated when a NETCONF server detects that a confirmed-commit Generated when a NETCONF server detects that a confirmed-commit
event has occurred. Indicates the event and the current state of event has occurred. Indicates the event and the current state of
the confirmed-commit procedure in progress. the confirmed-commit procedure in progress.
2.2. Definitions 2.2. Definitions
<CODE BEGINS> file="ietf-netconf-notifications@2011-08-07.yang" <CODE BEGINS> file="ietf-netconf-notifications@2011-10-28.yang"
module ietf-netconf-notifications { module ietf-netconf-notifications {
namespace namespace
"urn:ietf:params:xml:ns:yang:ietf-netconf-notifications"; "urn:ietf:params:xml:ns:yang:ietf-netconf-notifications";
prefix ncn; prefix ncn;
import ietf-inet-types { prefix inet; } import ietf-inet-types { prefix inet; }
import ietf-netconf { prefix nc; } import ietf-netconf { prefix nc; }
skipping to change at page 5, line 16 skipping to change at page 5, line 16
WG Chair: Bert Wijnen WG Chair: Bert Wijnen
<mailto:bertietf@bwijnen.net> <mailto:bertietf@bwijnen.net>
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 a 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 NETCONF base event notifications. receive common NETCONF base event notifications.
Copyright (c) 2011 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-05.txt // draft-ietf-netconf-system-notifications-06.txt
revision 2011-08-07 { revision "2011-10-28" {
description description
"Initial version."; "Initial version.";
reference reference
"RFC XXXX: NETCONF Base Notifications"; "RFC XXXX: NETCONF Base 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 {
description description
"Common session parameters to identify a "Common session parameters to identify a
management session."; management session.";
leaf username { leaf username {
description
"Name of the user for the session.";
type string; type string;
mandatory true; mandatory true;
description
"Name of the user for the session.";
} }
leaf session-id { leaf session-id {
type nc:session-id-or-zero-type;
mandatory true;
description description
"Identifier of the session. "Identifier of the session.
A NETCONF session MUST be identified by a non-zero value. A NETCONF session MUST be identified by a non-zero value.
A non-NETCONF session MAY be identified by the value zero."; A non-NETCONF session MAY be identified by the value zero.";
type nc:session-id-or-zero-type;
mandatory true;
} }
leaf source-host { leaf source-host {
type inet:ip-address;
description description
"Address of the remote host for the session."; "Address of the remote host for the session.";
type inet:ip-address;
} }
} }
grouping changed-by-parms { grouping changed-by-parms {
description description
"Common parameters to identify the source "Common parameters to identify the source
of a change event, such as a configuration of a change event, such as a configuration
or capability change."; or capability change.";
container changed-by { container changed-by {
skipping to change at page 7, line 33 skipping to change at page 7, line 33
leaf datastore { leaf datastore {
type enumeration { type enumeration {
enum running { enum running {
description "The <running> datastore has changed."; description "The <running> datastore has changed.";
} }
enum startup { enum startup {
description "The <startup> datastore has changed"; description "The <startup> datastore has changed";
} }
} }
default "running";
description description
"Indicates which configuration datastore has changed."; "Indicates which configuration datastore has changed.";
default "running";
} }
list edit { list edit {
description description
"An edit record SHOULD be present for each distinct "An edit record SHOULD be present for each distinct
edit operation that the server has detected on edit operation that the server has detected on
the target datastore. This list MAY be omitted the target datastore. This list MAY be omitted
if the detailed edit operations are not known. if the detailed edit operations are not known.
The server MAY report entries in this list for The server MAY report entries in this list for
changes not made by a NETCONF session (e.g., CLI)."; changes not made by a NETCONF session (e.g., CLI).";
skipping to change at page 9, line 31 skipping to change at page 9, line 31
"Generated when a NETCONF server detects that a "Generated when a NETCONF server detects that a
NETCONF session has terminated. NETCONF session has terminated.
A server MAY optionally generate this event for A server MAY optionally generate this event for
non-NETCONF management sessions. Indicates the non-NETCONF management sessions. Indicates the
identity of the user that owned the session, identity of the user that owned the session,
and why the session was terminated."; and why the session was terminated.";
uses common-session-parms; uses common-session-parms;
leaf killed-by { leaf killed-by {
when "../termination-reason = 'killed' and ."; when "../termination-reason = 'killed'";
type nc:session-id-type; type nc:session-id-type;
description description
"The ID of the session that directly caused this session "The ID of the session that directly caused this session
to be abnormally terminated. If this session was abnormally to be abnormally terminated. If this session was abnormally
terminated by a non-NETCONF session unknown to the server, terminated by a non-NETCONF session unknown to the server,
then this leaf will not be present."; then this leaf will not be present.";
} }
leaf termination-reason { leaf termination-reason {
type enumeration { type enumeration {
skipping to change at page 10, line 47 skipping to change at page 10, line 47
event has occurred. Indicates the event and the current state event has occurred. Indicates the event and the current state
of the confirmed-commit procedure in progress."; of the confirmed-commit procedure in progress.";
reference reference
"RFC 6241, section 8.4"; "RFC 6241, section 8.4";
uses common-session-parms { uses common-session-parms {
when "../confirm-event != 'timeout'"; when "../confirm-event != 'timeout'";
} }
leaf confirm-event { leaf confirm-event {
description
"Indicates the event that caused the notification.";
type enumeration { type enumeration {
enum "start" { enum "start" {
value 0;
description description
"The confirmed-commit procedure has started."; "The confirmed-commit procedure has started.";
} }
enum "cancel" { enum "cancel" {
value 1;
description description
"The confirmed-commit procedure has been canceled, "The confirmed-commit procedure has been canceled,
e.g., due to the session being terminated, or an e.g., due to the session being terminated, or an
explicit <cancel-commit> operation."; explicit <cancel-commit> operation.";
} }
enum "timeout" { enum "timeout" {
value 2;
description description
"The confirmed-commit procedure has been canceled, "The confirmed-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" {
value 3;
description description
"The confirmed-commit timeout has been extended, "The confirmed-commit timeout has been extended,
e.g., by a new <confirmed-commit> operation."; e.g., by a new <confirmed-commit> operation.";
} }
enum "complete" { enum "complete" {
value 4;
description description
"The confirmed-commit procedure has been completed."; "The confirmed-commit procedure has been completed.";
} }
} }
mandatory true; mandatory true;
description
"Indicates the event that caused the notification.";
} }
leaf timeout { leaf timeout {
when when
"../confirm-event = 'start' or ../confirm-event = 'extend'"; "../confirm-event = 'start' or ../confirm-event = 'extend'";
type uint32;
units "seconds";
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";
type uint32;
} }
} // notification netconf-confirmed-commit } // notification netconf-confirmed-commit
} }
<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-notifications URI: urn:ietf:params:xml:ns:yang:ietf-netconf-notifications
Registrant Contact: The NETCONF WG of the IETF. Registrant Contact: The IESG.
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-notifications name: ietf-netconf-notifications
prefix: ncn prefix: ncn
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-notifications namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-notifications
RFC: XXXX // RFC Ed.: replace XXXX and remove this comment RFC: XXXX // RFC Ed.: replace XXXX and remove this comment
skipping to change at page 15, line 12 skipping to change at page 15, line 9
Bierman, "Network Configuration Protocol (NETCONF)", Bierman, "Network Configuration Protocol (NETCONF)",
RFC 6241, June 2011. RFC 6241, June 2011.
[RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure [RFC6242] Wasserman, M., "Using the NETCONF Protocol over Secure
Shell (SSH)", RFC 6242, June 2011. Shell (SSH)", RFC 6242, June 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. 04-05 A.1. 05-06
Changed YANG statements to canonical order.
Corrected when-stmt for killed-by leaf.
Corrected IANA Considerations text.
Removed redundant value-stmts from confirm-event leaf.
A.2. 04-05
The module is now ietf-netconf-notifications. The namespace and The module is now ietf-netconf-notifications. The namespace and
prefix are now changed as well. prefix are now changed as well.
The target-datastore has been renamed to datastore. The target-datastore has been renamed to datastore.
Clarified behavior for non-NETCONF sessions. Clarified behavior for non-NETCONF sessions.
Minor editorial comments from WG Last Call. Minor editorial comments from WG Last Call.
A.2. 03-04 A.3. 03-04
Renamed module to NETCONF Base Notifications. The module is now Renamed module to NETCONF Base Notifications. The module is now
ietf-netconf-base-notifications. The namespace and prefix are now ietf-netconf-base-notifications. The namespace and prefix are now
changed as well. changed as well.
Changed notifications so a server can report non-NETCONF initiated Changed notifications so a server can report non-NETCONF initiated
events. events.
Replaced security considerations, according to template in RFC 6087. Replaced security considerations, according to template in RFC 6087.
Added Acknowledgements section. Added Acknowledgements section.
A.3. 02-03 A.4. 02-03
Renamed module back to NETCONF system notifications. The module is Renamed module back to NETCONF system notifications. The module is
now ietf-netconf-system-notifications. The namespace and prefix are now ietf-netconf-system-notifications. The namespace and prefix are
now changed as well. now changed as well.
Leaf user-name is now username, and is now mandatory, to be Leaf user-name is now username, and is now mandatory, to be
consistent with netconf monitoring module. consistent with netconf monitoring module.
Leaf remote-host is now source-host to be consistent with netconf Leaf remote-host is now source-host to be consistent with netconf
monitoring module. monitoring module.
skipping to change at page 16, line 12 skipping to change at page 16, line 18
The netconf-config-change description was updated and leaf target- The netconf-config-change description was updated and leaf target-
database is now named target-datastore. database is now named target-datastore.
Term 'database' changed to term 'datastore' in text. Term 'database' changed to term 'datastore' in text.
netconf-confirmed-commit: changed uses common-session-parms to use netconf-confirmed-commit: changed uses common-session-parms to use
when-stmt not refine-stmt. when-stmt not refine-stmt.
netconf-capability-change: updated description text. netconf-capability-change: updated description text.
A.4. 01-02 A.5. 01-02
Renamed module NETCONF Events instead of NETCONF system Renamed module NETCONF Events instead of NETCONF system
notifications. Note that ietf-netconf-notifications is being notifications. Note that ietf-netconf-notifications is being
reserved 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.5. 00-01 A.6. 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.6. 00 A.7. 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. 36 change blocks. 
39 lines changed or deleted 47 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/