draft-ietf-netconf-system-notifications-07.txt   rfc6470.txt 
NETCONF A. Bierman Internet Engineering Task Force (IETF) A. Bierman
Internet-Draft Brocade Request for Comments: 6470 Brocade
Intended status: Standards Track December 9, 2011 Category: Standards Track February 2012
Expires: June 11, 2012 ISSN: 2070-1721
Network Configuration Protocol (NETCONF) Base Notifications Network Configuration Protocol (NETCONF) Base Notifications
draft-ietf-netconf-system-notifications-07
Abstract Abstract
The NETCONF protocol provides mechanisms to manipulate configuration The Network Configuration Protocol (NETCONF) provides mechanisms to
datastores. However, client applications often need to be aware of manipulate configuration datastores. However, client applications
common events such as a change in NETCONF server capabilities, that often need to be aware of common events, such as a change in NETCONF
may impact management applications. Standard mechanisms are needed server capabilities, that may impact management applications.
to support the monitoring of the base system events within the Standard mechanisms are needed to support the monitoring of the base
NETCONF server. This document defines a YANG module that allows a system events within the NETCONF server. This document defines a
NETCONF client to receive notifications for some common system YANG module that allows a NETCONF client to receive notifications for
events. some common system events.
Status of this Memo
This Internet-Draft is submitted in full conformance with the Status of This Memo
provisions of BCP 78 and BCP 79.
Internet-Drafts are working documents of the Internet Engineering This is an Internet Standards Track document.
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 This document is a product of the Internet Engineering Task Force
and may be updated, replaced, or obsoleted by other documents at any (IETF). It represents the consensus of the IETF community. It has
time. It is inappropriate to use Internet-Drafts as reference received public review and has been approved for publication by the
material or to cite them other than as "work in progress." Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in Section 2 of RFC 5741.
This Internet-Draft will expire on June 11, 2012. Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
http://www.rfc-editor.org/info/rfc6470.
Copyright Notice Copyright Notice
Copyright (c) 2011 IETF Trust and the persons identified as the Copyright (c) 2012 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 ....................................................2
1.1. Terminology . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Terminology ................................................2
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 ............................................11
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
A.1. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.2. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.3. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.4. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.5. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.6. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.7. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 17
A.8. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 17
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
module [RFC6020] that allows a NETCONF client to receive module [RFC6020] that allows a NETCONF client to receive
notifications for some common system events. notifications for some common system 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
skipping to change at page 3, line 23 skipping to change at page 2, line 35
module [RFC6020] that allows a NETCONF client to receive module [RFC6020] that allows a NETCONF client to receive
notifications for some common system events. notifications for some common system 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 [RFC6241]: The following terms are defined in [RFC6241]:
o client o client
o datastore o datastore
o protocol operation o protocol 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 NETCONF Base Notifications 2. YANG Module for NETCONF Base 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 event notification messages for use within the 'NETCONF' stream, of event notification messages for use within the 'NETCONF' stream,
and accessible to clients via the subscription mechanism in and accessible to clients via the subscription mechanism described in
[RFC5277]. This module imports data types from the 'ietf-netconf' [RFC5277]. This module imports data types from the 'ietf-netconf'
module defined in [RFC6241] and 'ietf-inet-types' module defined in module defined in [RFC6241] and 'ietf-inet-types' module defined in
[RFC6021]. [RFC6021].
These notifications pertain to configuration and monitoring portion These notifications pertain to configuration and monitoring portions
of the managed system, not the entire system. A server MUST report of the managed system, not the entire system. A server MUST report
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 the <startup> configuration datastore has been changed by a management
edits that have been detected. session. The notification summarizes the 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. For example, a CLI-based session could be management sessions. Indicates the identity of the user that
detected and monitored by the server. Indicates the identity of started the session.
the user that started the session.
netconf-session-end: netconf-session-end:
Generated when a NETCONF server detects that a NETCONF session has Generated when a NETCONF server detects that a NETCONF session has
terminated. A server MAY optionally generate this event for non- terminated. A server MAY optionally generate this event for
NETCONF management sessions. For example, a CLI-based session non-NETCONF management sessions. Indicates the identity of the
could be detected and monitored by the server. Indicates the user that owned the session, and why the session was terminated.
identity of the user 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-12-09.yang" <CODE BEGINS> file="ietf-netconf-notifications@2011-12-09.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; }
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>
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@netconfcentral.org>";
description description
"This module defines a 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) 2012 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 6470; 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.: remove this note revision "2012-02-06" {
// Note: extracted from description
// draft-ietf-netconf-system-notifications-07.txt "Initial version.";
reference
"RFC 6470: NETCONF Base Notifications";
}
revision "2011-12-09" { grouping common-session-parms {
description description
"Initial version."; "Common session parameters to identify a
reference management session.";
"RFC XXXX: NETCONF Base Notifications";
}
// RFC Ed.: replace XXXX with actual
// RFC number and remove this note
grouping common-session-parms { leaf username {
description type string;
"Common session parameters to identify a mandatory true;
management session."; description
"Name of the user for the session.";
}
leaf username { leaf session-id {
type string; type nc:session-id-or-zero-type;
mandatory true; mandatory true;
description description
"Name of the user for the session."; "Identifier of the session.
} A NETCONF session MUST be identified by a non-zero value.
A non-NETCONF session MAY be identified by the value zero.";
}
leaf session-id { leaf source-host {
type nc:session-id-or-zero-type; type inet:ip-address;
mandatory true; description
description "Address of the remote host for the session.";
"Identifier of the session. }
A NETCONF session MUST be identified by a non-zero value.
A non-NETCONF session MAY be identified by the value zero.";
} }
grouping changed-by-parms {
leaf source-host {
type inet:ip-address;
description description
"Address of the remote host for the session."; "Common parameters to identify the source
} of a change event, such as a configuration
} or capability change.";
grouping changed-by-parms { container changed-by {
description description
"Common parameters to identify the source "Indicates the source of the change.
of a change event, such as a configuration If caused by internal action, then the
or capability change."; 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.";
}
container changed-by { case by-user {
description uses common-session-parms;
"Indicates the source of the change. }
If caused by internal action, then the } // choice server-or-user
empty leaf 'server' will be present. } // container changed-by-parms
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 { notification netconf-config-change {
uses common-session-parms; description
} "Generated when the NETCONF server detects that the
} // choice server-or-user <running> or <startup> configuration datastore
} // container changed-by-parms has been changed by a management session.
} The notification summarizes the edits that
have been detected.
notification netconf-config-change { The server MAY choose to also generate this
description notification while loading a datastore during the
"Generated when the NETCONF server detects that the boot process for the device.";
<running> or <startup> configuration datastore
has been changed by a management session.
The notification summarizes the edits that
have been detected.
The server MAY choose to also generate this uses changed-by-parms;
notification while loading a datastore during the leaf datastore {
boot process for the device."; type enumeration {
enum running {
description "The <running> datastore has changed.";
}
enum startup {
description "The <startup> datastore has changed";
}
}
default "running";
description
"Indicates which configuration datastore has changed.";
}
uses changed-by-parms; list edit {
description
"An edit record SHOULD be present for each distinct
edit operation that the server has detected on
the target datastore. This list MAY be omitted
if the detailed edit operations are not known.
The server MAY report entries in this list for
changes not made by a NETCONF session (e.g., CLI).";
leaf datastore { leaf target {
type enumeration { type instance-identifier;
enum running { description
description "The <running> datastore has changed."; "Topmost node associated with the configuration change.
A server SHOULD set this object to the node within
the datastore that is being altered. A server MAY
set this object to one of the ancestors of the actual
node that was changed, or omit this object, if the
exact node is not known.";
} }
enum startup {
description "The <startup> datastore has changed"; 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
default "running"; } // notification netconf-config-change
notification netconf-capability-change {
description description
"Indicates which configuration datastore has changed."; "Generated when the NETCONF server detects that
} the server capabilities have changed.
Indicates which capabilities have been added, deleted,
and/or modified. The manner in which a server
capability is changed is outside the scope of this
document.";
list edit { uses changed-by-parms;
description
"An edit record SHOULD be present for each distinct
edit operation that the server has detected on
the target datastore. This list MAY be omitted
if the detailed edit operations are not known.
The server MAY report entries in this list for
changes not made by a NETCONF session (e.g., CLI).";
leaf target { leaf-list added-capability {
type instance-identifier; type inet:uri;
description description
"Topmost node associated with the configuration change. "List of capabilities that have just been added.";
A server SHOULD set this object to the node within
the datastore that is being altered. A server MAY
set this object to one of the ancestors of the actual
node that was changed, or omit this object, if the
exact node is not known.";
} }
leaf operation { leaf-list deleted-capability {
type nc:edit-operation-type; type inet:uri;
description description
"Type of edit operation performed. "List of capabilities that have just been deleted.";
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 { leaf-list modified-capability {
description type inet:uri;
"Generated when the NETCONF server detects that description
the server capabilities have changed. "List of capabilities that have just been modified.
Indicates which capabilities have been added, deleted, A capability is considered to be modified if the
and/or modified. The manner in which a server base URI for the capability has not changed, but
capability is changed is outside the scope of this one or more of the parameters encoded at the end of
document."; the capability URI have changed.
The new modified value of the complete URI is returned.";
uses changed-by-parms; }
} // notification netconf-capability-change
leaf-list added-capability {
type inet:uri;
description
"List of capabilities that have just been added.";
}
leaf-list deleted-capability { notification netconf-session-start {
type inet:uri;
description description
"List of capabilities that have just been deleted."; "Generated when a NETCONF server detects that a
} NETCONF session has started. A server MAY generate
this event for non-NETCONF management sessions.
leaf-list modified-capability { Indicates the identity of the user that started
type inet:uri; the session.";
uses common-session-parms;
} // notification netconf-session-start
notification netconf-session-end {
description description
"List of capabilities that have just been modified. "Generated when a NETCONF server detects that a
A capability is considered to be modified if the NETCONF session has terminated.
base URI for the capability has not changed, but A server MAY optionally generate this event for
one or more of the parameters encoded at the end of non-NETCONF management sessions. Indicates the
the capability URI has changed. identity of the user that owned the session,
The new modified value of the complete URI is returned."; and why the session was terminated.";
}
} // notification netconf-capability-change
notification netconf-session-start {
description
"Generated when a NETCONF server detects that a
NETCONF session has started. A server MAY generate
this event for non-NETCONF management sessions.
Indicates the identity of the user that started
the session.";
uses common-session-parms;
} // notification netconf-session-start
notification netconf-session-end {
description
"Generated when a NETCONF server detects that a
NETCONF session has terminated.
A server MAY optionally generate this event for
non-NETCONF management sessions. Indicates the
identity of the user that owned the session,
and why the session was terminated.";
uses common-session-parms; uses common-session-parms;
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
"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 {
enum "closed" { enum "closed" {
description description
"The session was terminated by the client in normal "The session was terminated by the client in normal
fashion, e.g., by the NETCONF <close-session> fashion, e.g., by the NETCONF <close-session>
protocol operation."; protocol operation.";
} }
enum "killed" { enum "killed" {
description description
"The session was terminated in abnormal "The session was terminated in abnormal
fashion, e.g., by the NETCONF <kill-session> fashion, e.g., by the NETCONF <kill-session>
protocol operation."; protocol operation.";
} }
enum "dropped" { enum "dropped" {
description description
"The session was terminated because the transport layer "The session was terminated because the transport layer
connection was unexpectedly closed."; connection was unexpectedly closed.";
} }
enum "timeout" { enum "timeout" {
description description
"The session was terminated because of inactivity, "The session was terminated because of inactivity,
e.g., waiting for the <hello> message or <rpc> e.g., waiting for the <hello> message or <rpc>
messages."; messages.";
} }
enum "bad-hello" { enum "bad-hello" {
description description
"The client's <hello> message was invalid."; "The client's <hello> message was invalid.";
} }
enum "other" { enum "other" {
description description
"The session was terminated for some other reason."; "The session was terminated for some other reason.";
}
} }
mandatory true;
description
"Reason the session was terminated.";
} }
mandatory true; } // notification netconf-session-end
description
"Reason the session was terminated.";
}
} // notification netconf-session-end
notification netconf-confirmed-commit { notification netconf-confirmed-commit {
description description
"Generated when a NETCONF server detects that a confirmed-commit "Generated when a NETCONF server detects that a
event has occurred. Indicates the event and the current state confirmed-commit event has occurred. Indicates the event
of the confirmed-commit procedure in progress."; and the current state of the confirmed-commit procedure
reference in progress.";
"RFC 6241, section 8.4"; reference
"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 {
type enumeration { type enumeration {
enum "start" { enum "start" {
description description
"The confirmed-commit procedure has started."; "The confirmed-commit procedure has started.";
} }
enum "cancel" { enum "cancel" {
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" {
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" {
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" {
description description
"The confirmed-commit procedure has been completed."; "The confirmed-commit procedure has been completed.";
}
} }
mandatory true;
description
"Indicates the event that caused the notification.";
} }
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; type uint32;
units "seconds"; 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 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.";
} }
} // 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 IESG. 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: 6470
4. Security Considerations 4. Security Considerations
The YANG module defined in this memo is designed to be accessed via The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the the NETCONF protocol [RFC6241]. The lowest NETCONF layer is the
secure transport layer and the mandatory-to-implement secure secure transport layer and the mandatory-to-implement secure
transport is SSH, defined in [RFC6242]. transport is SSH, defined in [RFC6242].
Some of the readable data nodes in this YANG module may be considered Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via <get>, <get-config>, or important to control read access (e.g., via get, get-config, or
<notification>) to these data nodes. These are the subtrees and data notification) to these data nodes. These are the subtrees and data
nodes and their sensitivity/vulnerability: nodes and their sensitivity/vulnerability:
/netconf-config-change: /netconf-config-change:
Event type itself indicates that the system configuration has Event type itself indicates that the system configuration has
changed. This event could alert an attacker that specific changed. This event could alert an attacker that specific
configuration data nodes have been altered. configuration data nodes have been altered.
/netconf-config-change/changed-by: /netconf-config-change/changed-by:
Indicates whether the server or a specific user management session Indicates whether the server or a specific user management session
made the configuration change. Identifies the user name, made the configuration change. Identifies the user name,
session-id, and source host address associated with the session-id, and source host address associated with the
skipping to change at page 13, line 16 skipping to change at page 13, line 7
Indicates which datastore has been changed. This data can be used Indicates which datastore has been changed. This data can be used
to determine if the non-volatile startup configuration data has to determine if the non-volatile startup configuration data has
been changed. been changed.
/netconf-config-change/edit: /netconf-config-change/edit:
Identifies the specific edit operations and specific datastore Identifies the specific edit operations and specific datastore
subtree(s) that have changed. This data could be used to subtree(s) that have changed. This data could be used to
determine if specific server vulnerabilities may now be present. determine if specific server vulnerabilities may now be present.
/netconf-capability-change: /netconf-capability-change:
Event type itself indicates that the system capabilities have Event type itself indicates that the system capabilities have
changed, and may be now be vulnerable to unspecified attacks. An changed, and may now be vulnerable to unspecified attacks. An
attacker will likely need to understand the content represented by attacker will likely need to understand the content represented by
specific capability URI strings. For example, knowing that a specific capability URI strings. For example, knowing that a
packet capture monitoring capability has been added to the system packet capture monitoring capability has been added to the system
might help an attacker identify the device for possible might help an attacker identify the device for possible
unauthorized eavesdropping. unauthorized eavesdropping.
/netconf-capability-change/changed-by: /netconf-capability-change/changed-by:
Indicates whether the server or a specific user management session Indicates whether the server or a specific user management session
made the capability change. Identifies the user name, session-id, made the capability change. Identifies the user name, session-id,
and source host address associated with the capability change, if and source host address associated with the capability change, if
any. any.
skipping to change at page 13, line 43 skipping to change at page 13, line 34
This data could be used to determine if specific server This data could be used to determine if specific server
vulnerabilities may now be present. vulnerabilities may now be present.
/netconf-capability-change/modified-capability: /netconf-capability-change/modified-capability:
Indicates the specific capability URIs that have been modified. Indicates the specific capability URIs that have been modified.
This data could be used to determine if specific server This data could be used to determine if specific server
vulnerabilities may now be present. vulnerabilities may now be present.
/netconf-session-start: /netconf-session-start:
Event type itself indicates that a NETCONF or other management Event type itself indicates that a NETCONF or other management
session may start altering the device configuration and/or state. session may start altering the device configuration and/or state.
It may be possible for an attacker to alter the configuration, by It may be possible for an attacker to alter the configuration by
taking advantage somehow of another session concurrently editing somehow taking advantage of another session concurrently editing
an unlocked datastore. an unlocked datastore.
/netconf-session-start/username: /netconf-session-start/username:
Indicates the user name associated with the session. Indicates the user name associated with the session.
/netconf-session-start/source-host: /netconf-session-start/source-host:
Indicates the source host address associated with the session. Indicates the source host address associated with the session.
/netconf-session-end: /netconf-session-end:
Event type itself indicates that a NETCONF or other management Event type itself indicates that a NETCONF or other management
session may be finished altering the device configuration. This session may be finished altering the device configuration. This
event could alert an attacker that a datastore may have been event could alert an attacker that a datastore may have been
skipping to change at page 14, line 49 skipping to change at page 14, line 39
[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.
[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., Ed., "YANG - A Data Modeling Language for
Network Configuration Protocol (NETCONF)", RFC 6020, the Network Configuration Protocol (NETCONF)", RFC 6020,
October 2010. October 2010.
[RFC6021] Schoenwaelder, J., "Common YANG Data Types", RFC 6021, [RFC6021] Schoenwaelder, J., Ed., "Common YANG Data Types",
October 2010. RFC 6021, October 2010.
[RFC6241] Enns, R., Bjorklund, M., Schoenwaelder, J., and A. [RFC6241] Enns, R., Ed., Bjorklund, M., Ed., Schoenwaelder, J., Ed.,
Bierman, "Network Configuration Protocol (NETCONF)", and A. Bierman, Ed., "Network Configuration Protocol
RFC 6241, June 2011. (NETCONF)", 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
-- RFC Ed.: remove this section before publication.
A.1. 06-07
Add clarifications resulting from IESG review.
Add text mentioning that ietf-netconf and ietf-inet-types are
imported to reuse types, to resolve idnits for 'unused reference'
error.
A.2. 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.3. 04-05
The module is now ietf-netconf-notifications. The namespace and
prefix are now changed as well.
The target-datastore has been renamed to datastore.
Clarified behavior for non-NETCONF sessions.
Minor editorial comments from WG Last Call.
A.4. 03-04
Renamed module to NETCONF Base Notifications. The module is now
ietf-netconf-base-notifications. The namespace and prefix are now
changed as well.
Changed notifications so a server can report non-NETCONF initiated
events.
Replaced security considerations, according to template in RFC 6087.
Added Acknowledgements section.
A.5. 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.6. 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.7. 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.8. 00
Initial version, based on
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@netconfcentral.org
 End of changes. 83 change blocks. 
462 lines changed or deleted 346 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/