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