draft-ietf-netconf-system-notifications-06.txt   draft-ietf-netconf-system-notifications-07.txt 
NETCONF A. Bierman NETCONF A. Bierman
Internet-Draft Brocade Internet-Draft Brocade
Intended status: Standards Track October 28, 2011 Intended status: Standards Track December 9, 2011
Expires: April 30, 2012 Expires: June 11, 2012
Network Configuration Protocol (NETCONF) Base Notifications Network Configuration Protocol (NETCONF) Base Notifications
draft-ietf-netconf-system-notifications-06 draft-ietf-netconf-system-notifications-07
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 April 30, 2012. This Internet-Draft will expire on June 11, 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. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.1. 06-07 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.2. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.2. 05-06 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.3. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.3. 04-05 . . . . . . . . . . . . . . . . . . . . . . . . . . 15
A.4. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 15 A.4. 03-04 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.5. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.5. 02-03 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.6. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.6. 01-02 . . . . . . . . . . . . . . . . . . . . . . . . . . 16
A.7. 00 . . . . . . . . . . . . . . . . . . . . . . . . . . . . 16 A.7. 00-01 . . . . . . . . . . . . . . . . . . . . . . . . . . 17
Author's Address . . . . . . . . . . . . . . . . . . . . . . . . . 16 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
skipping to change at page 3, line 43 skipping to change at page 3, line 43
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 in
[RFC5277]. [RFC5277]. This module imports data types from the 'ietf-netconf'
module defined in [RFC6241] and 'ietf-inet-types' module defined in
[RFC6021].
These notifications pertain to configuration and monitoring portion These notifications pertain to configuration and monitoring portion
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:
skipping to change at page 4, line 19 skipping to change at page 4, line 21
<startup> configuration datastore has changed. Summarizes the <startup> configuration datastore has changed. Summarizes the
edits that have been detected. 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. For example, a CLI-based session could be
started the session. detected and monitored by the server. Indicates the identity of
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 non-
NETCONF management sessions. Indicates the identity of the user NETCONF management sessions. For example, a CLI-based session
that owned the session, and why the session was terminated. could be detected and monitored by the server. Indicates the
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-10-28.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; }
skipping to change at page 5, line 36 skipping to change at page 5, line 40
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-06.txt // draft-ietf-netconf-system-notifications-07.txt
revision "2011-10-28" { revision "2011-12-09" {
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
skipping to change at page 7, line 7 skipping to change at page 7, line 12
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 NETCONF server detects that the "Generated when the NETCONF server detects that the
<running> or <startup> configuration datastore <running> or <startup> configuration datastore
has changed by a management session. has been changed by a management session.
The notification summarizes the edits that The notification summarizes the edits that
have been detected. have been detected.
The server MAY choose to also generate this The server MAY choose to also generate this
notification while loading a datastore during the notification while loading a datastore during the
boot process for the device."; boot process for the device.";
uses changed-by-parms; uses changed-by-parms;
leaf datastore { leaf datastore {
skipping to change at page 12, line 39 skipping to change at page 12, line 40
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. changed. This event could alert an attacker that specific
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
configuration change, if any. configuration change, if any.
/netconf-config-change/datastore: /netconf-config-change/datastore:
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. changed, and may be now be vulnerable to unspecified attacks. An
attacker will likely need to understand the content represented by
specific capability URI strings. For example, knowing that a
packet capture monitoring capability has been added to the system
might help an attacker identify the device for possible
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.
/netconf-capability-change/added-capability: /netconf-capability-change/added-capability:
Indicates the specific capability URIs that have been added. This Indicates the specific capability URIs that have been added. This
data could be used to determine if specific server vulnerabilities data could be used to determine if specific server vulnerabilities
may now be present. may now be present.
/netconf-capability-change/deleted-capability: /netconf-capability-change/deleted-capability:
skipping to change at page 13, line 34 skipping to change at page 13, line 43
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
taking advantage somehow of another session concurrently editing
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 and/or session may be finished altering the device configuration. This
state. event could alert an attacker that a datastore may have been
altered.
/netconf-session-end/username: /netconf-session-end/username:
Indicates the user name associated with the session. Indicates the user name associated with the session.
/netconf-session-end/source-host: /netconf-session-end/source-host:
Indicates the source host address associated with the session. Indicates the source host address associated with the session.
/netconf-confirmed-commit: /netconf-confirmed-commit:
Event type itself indicates that the <running> datastore may have Event type itself indicates that the <running> datastore may have
changed. changed. This event could alert an attacker that the device
behavior has changed.
/netconf-confirmed-commit/username: /netconf-confirmed-commit/username:
Indicates the user name associated with the session. Indicates the user name associated with the session.
/netconf-confirmed-commit/source-host: /netconf-confirmed-commit/source-host:
Indicates the source host address associated with the session. Indicates the source host address associated with the session.
/netconf-confirmed-commit/confirm-event: /netconf-confirmed-commit/confirm-event:
Indicates the specific confirmed-commit state change that Indicates the specific confirmed-commit state change that
occurred. A value of 'complete' probably indicates that the occurred. A value of 'complete' probably indicates that the
<running> datastore has changed. <running> datastore has changed.
/netconf-confirmed-commit/timeout: /netconf-confirmed-commit/timeout:
Indicates the number of seconds in the future when the <running> Indicates the number of seconds in the future when the <running>
skipping to change at page 15, line 9 skipping to change at page 15, line 20
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. 05-06 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. Changed YANG statements to canonical order.
Corrected when-stmt for killed-by leaf. Corrected when-stmt for killed-by leaf.
Corrected IANA Considerations text. Corrected IANA Considerations text.
Removed redundant value-stmts from confirm-event leaf. Removed redundant value-stmts from confirm-event leaf.
A.2. 04-05 A.3. 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.3. 03-04 A.4. 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.4. 02-03 A.5. 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 18 skipping to change at page 16, line 42
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.5. 01-02 A.6. 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.6. 00-01 A.7. 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.7. 00 A.8. 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. 26 change blocks. 
36 lines changed or deleted 60 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/