--- 1/draft-ietf-netconf-notification-01.txt 2006-06-23 01:14:11.000000000 +0200 +++ 2/draft-ietf-netconf-notification-02.txt 2006-06-23 01:14:11.000000000 +0200 @@ -1,20 +1,20 @@ Network Working Group S. Chisholm Internet-Draft K. Curran -Expires: October 30, 2006 Nortel +Expires: December 23, 2006 Nortel H. Trevino Cisco - April 28, 2006 + June 21, 2006 NETCONF Event Notifications - draft-ietf-netconf-notification-01.txt + draft-ietf-netconf-notification-02.txt Status of this Memo By submitting this Internet-Draft, each author represents that any applicable patent or other IPR claims of which he or she is aware have been or will be disclosed, and any of which he or she becomes aware will be disclosed, in accordance with Section 6 of BCP 79. Internet-Drafts are working documents of the Internet Engineering Task Force (IETF), its areas, and its working groups. Note that @@ -25,103 +25,109 @@ 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." The list of current Internet-Drafts can be accessed at http://www.ietf.org/ietf/1id-abstracts.txt. The list of Internet-Draft Shadow Directories can be accessed at http://www.ietf.org/shadow.html. - This Internet-Draft will expire on October 30, 2006. + This Internet-Draft will expire on December 23, 2006. Copyright Notice Copyright (C) The Internet Society (2006). Abstract This memo defines a framework for sending asynchronous messages, or event notifications in NETCONF. It defines both the operations necessary to support this concept, and also discusses implications - for the mapping to application protocols. + for the mapping to transport protocols. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1 Definition of Terms . . . . . . . . . . . . . . . . . . . 4 1.2 Event Notifications in NETCONF . . . . . . . . . . . . . . 5 - 2. Event-Related Operations . . . . . . . . . . . . . . . . . . . 6 - 2.1 Subscribing to receive Events . . . . . . . . . . . . . . 6 - 2.1.1 create-subscription . . . . . . . . . . . . . . . . . 6 - 2.2 Sending Event Notifications . . . . . . . . . . . . . . . 7 - 2.2.1 Event Notification . . . . . . . . . . . . . . . . . . 7 - 2.3 Changing the Subscription . . . . . . . . . . . . . . . . 8 - 2.3.1 modify-subscription . . . . . . . . . . . . . . . . . 9 - 2.4 Terminating the Subscription . . . . . . . . . . . . . . . 10 - 2.4.1 cancel-subscription . . . . . . . . . . . . . . . . . 10 - 3. Supporting Concepts . . . . . . . . . . . . . . . . . . . . . 11 - 3.1 Capabilities Exchange . . . . . . . . . . . . . . . . . . 11 - 3.2 Querying Subscription Properties . . . . . . . . . . . . . 11 - 3.3 One-way Notification Messages . . . . . . . . . . . . . . 16 - 3.4 Filter Dependencies . . . . . . . . . . . . . . . . . . . 16 - 3.4.1 Named Profiles . . . . . . . . . . . . . . . . . . . . 17 - 3.4.2 Filtering . . . . . . . . . . . . . . . . . . . . . . 17 - 3.5 Event Classes . . . . . . . . . . . . . . . . . . . . . . 17 - 3.6 Defining Event Notifications . . . . . . . . . . . . . . . 18 - 3.7 Interleaving Messages . . . . . . . . . . . . . . . . . . 18 - 4. XML Schema for Event Notifications . . . . . . . . . . . . . . 20 - 5. Mapping to Application Protocols . . . . . . . . . . . . . . . 24 - 5.1 SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . 24 - 5.2 BEEP . . . . . . . . . . . . . . . . . . . . . . . . . . . 25 - 5.2.1 One-way Notification Messages in Beep . . . . . . . . 25 - 5.3 SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . 26 - 5.3.1 A NETCONF over Soap over HTTP Example . . . . . . . . 26 - 6. Filtering examples . . . . . . . . . . . . . . . . . . . . . . 29 - 6.1 Event Classes . . . . . . . . . . . . . . . . . . . . . . 29 - 6.2 Subtree Filtering . . . . . . . . . . . . . . . . . . . . 29 - 6.3 XPATH filters . . . . . . . . . . . . . . . . . . . . . . 31 - 7. Additional Capabilities . . . . . . . . . . . . . . . . . . . 33 - 7.1 Call-Home Notifications . . . . . . . . . . . . . . . . . 33 - 7.1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . 33 - 7.1.2 Dependencies . . . . . . . . . . . . . . . . . . . . . 34 - 7.1.3 Capability Identifier . . . . . . . . . . . . . . . . 34 - 8. Security Considerations . . . . . . . . . . . . . . . . . . . 37 - 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 38 - 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 39 - 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 39 - Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 40 - A. Design Alternatives . . . . . . . . . . . . . . . . . . . . . 41 - A.1 Suspend And Resume . . . . . . . . . . . . . . . . . . . . 41 - A.2 Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . 41 - B. Event Notifications and Syslog . . . . . . . . . . . . . . . . 42 - B.1 Leveraging Syslog Field Definitions . . . . . . . . . . . 42 - B.1.1 Field Mapping . . . . . . . . . . . . . . . . . . . . 43 - B.1.2 Severity Mapping . . . . . . . . . . . . . . . . . . . 44 - B.2 Syslog within NETCONF Events . . . . . . . . . . . . . . . 44 - B.2.1 Motivation . . . . . . . . . . . . . . . . . . . . . . 44 - B.2.2 Embedding syslog messages in a NETCONF Event . . . . . 44 - B.2.3 Supported Forwarding Options . . . . . . . . . . . . . 45 - C. Example Configuration Notifications . . . . . . . . . . . . . 47 - C.1 Types of Configuration Events . . . . . . . . . . . . . . 47 - C.2 Config Event Notification Structure . . . . . . . . . . . 48 - C.3 Configuration Event Content . . . . . . . . . . . . . . . 50 - C.3.1 Target Datastore . . . . . . . . . . . . . . . . . . . 50 - C.3.2 User Info . . . . . . . . . . . . . . . . . . . . . . 50 - C.3.3 Data Source . . . . . . . . . . . . . . . . . . . . . 50 - C.3.4 Operation . . . . . . . . . . . . . . . . . . . . . . 50 - C.3.5 Context . . . . . . . . . . . . . . . . . . . . . . . 50 - C.3.6 Entered Command . . . . . . . . . . . . . . . . . . . 51 - C.3.7 New Config . . . . . . . . . . . . . . . . . . . . . . 51 - C.3.8 Old Config . . . . . . . . . . . . . . . . . . . . . . 51 - C.3.9 Non-netconf commands in configuration notifications . 51 - Intellectual Property and Copyright Statements . . . . . . . . 52 + 1.3 Motivation . . . . . . . . . . . . . . . . . . . . . . . . 5 + 1.4 Requirements . . . . . . . . . . . . . . . . . . . . . . . 5 + 1.5 Architecture . . . . . . . . . . . . . . . . . . . . . . . 7 + 2. Event-Related Operations . . . . . . . . . . . . . . . . . . . 8 + 2.1 Subscribing to receive Events . . . . . . . . . . . . . . 8 + 2.1.1 create-subscription . . . . . . . . . . . . . . . . . 8 + 2.2 Sending Event Notifications . . . . . . . . . . . . . . . 9 + 2.2.1 Event Notification . . . . . . . . . . . . . . . . . . 9 + 2.3 Changing the Subscription . . . . . . . . . . . . . . . . 10 + 2.3.1 modify-subscription . . . . . . . . . . . . . . . . . 10 + 2.4 Terminating the Subscription . . . . . . . . . . . . . . . 11 + 2.4.1 cancel-subscription . . . . . . . . . . . . . . . . . 12 + 3. Supporting Concepts . . . . . . . . . . . . . . . . . . . . . 13 + 3.1 Capabilities Exchange . . . . . . . . . . . . . . . . . . 13 + 3.2 Subscriptions and Datastores . . . . . . . . . . . . . . . 13 + 3.3 Querying Subscription Properties . . . . . . . . . . . . . 13 + 3.4 One-way Notification Messages . . . . . . . . . . . . . . 18 + 3.5 Filter Dependencies . . . . . . . . . . . . . . . . . . . 19 + 3.5.1 Named Profiles . . . . . . . . . . . . . . . . . . . . 19 + 3.5.2 Filtering . . . . . . . . . . . . . . . . . . . . . . 19 + 3.6 Event Classes . . . . . . . . . . . . . . . . . . . . . . 19 + 3.6.1 Initial Set of Event Classes . . . . . . . . . . . . . 20 + 3.7 Defining Event Notifications . . . . . . . . . . . . . . . 21 + 3.8 Interleaving Messages . . . . . . . . . . . . . . . . . . 21 + 4. XML Schema for Event Notifications . . . . . . . . . . . . . . 23 + 5. Mapping to Transport Protocols . . . . . . . . . . . . . . . . 27 + 5.1 SSH . . . . . . . . . . . . . . . . . . . . . . . . . . . 27 + 5.2 BEEP . . . . . . . . . . . . . . . . . . . . . . . . . . . 28 + 5.2.1 One-way Notification Messages in Beep . . . . . . . . 28 + 5.3 SOAP . . . . . . . . . . . . . . . . . . . . . . . . . . . 29 + 5.3.1 A NETCONF over Soap over HTTP Example . . . . . . . . 29 + 6. Filtering examples . . . . . . . . . . . . . . . . . . . . . . 32 + 6.1 Event Classes . . . . . . . . . . . . . . . . . . . . . . 32 + 6.2 Subtree Filtering . . . . . . . . . . . . . . . . . . . . 32 + 6.3 XPATH filters . . . . . . . . . . . . . . . . . . . . . . 34 + 7. Additional Capabilities . . . . . . . . . . . . . . . . . . . 36 + 7.1 Call-Home Notifications . . . . . . . . . . . . . . . . . 36 + 7.1.1 Overview . . . . . . . . . . . . . . . . . . . . . . . 36 + 7.1.2 Dependencies . . . . . . . . . . . . . . . . . . . . . 37 + 7.1.3 Capability Identifier . . . . . . . . . . . . . . . . 37 + 8. Security Considerations . . . . . . . . . . . . . . . . . . . 41 + 9. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 42 + 10. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . 43 + 11. References . . . . . . . . . . . . . . . . . . . . . . . . . 43 + Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . 44 + A. Design Alternatives . . . . . . . . . . . . . . . . . . . . . 45 + A.1 Suspend And Resume . . . . . . . . . . . . . . . . . . . . 45 + A.2 Lifecycle . . . . . . . . . . . . . . . . . . . . . . . . 45 + B. Event Notifications and Syslog . . . . . . . . . . . . . . . . 46 + B.1 Leveraging Syslog Field Definitions . . . . . . . . . . . 46 + B.1.1 Field Mapping . . . . . . . . . . . . . . . . . . . . 47 + B.1.2 Severity Mapping . . . . . . . . . . . . . . . . . . . 48 + B.2 Syslog within NETCONF Events . . . . . . . . . . . . . . . 48 + B.2.1 Motivation . . . . . . . . . . . . . . . . . . . . . . 48 + B.2.2 Embedding syslog messages in a NETCONF Event . . . . . 48 + B.2.3 Supported Forwarding Options . . . . . . . . . . . . . 49 + C. Example Configuration Notifications . . . . . . . . . . . . . 51 + C.1 Types of Configuration Events . . . . . . . . . . . . . . 51 + C.2 Config Event Notification Structure . . . . . . . . . . . 52 + C.3 Configuration Event Content . . . . . . . . . . . . . . . 54 + C.3.1 Target Datastore . . . . . . . . . . . . . . . . . . . 54 + C.3.2 User Info . . . . . . . . . . . . . . . . . . . . . . 54 + C.3.3 Data Source . . . . . . . . . . . . . . . . . . . . . 54 + C.3.4 Operation . . . . . . . . . . . . . . . . . . . . . . 54 + C.3.5 Context . . . . . . . . . . . . . . . . . . . . . . . 54 + C.3.6 Entered Command . . . . . . . . . . . . . . . . . . . 55 + C.3.7 New Config . . . . . . . . . . . . . . . . . . . . . . 55 + C.3.8 Old Config . . . . . . . . . . . . . . . . . . . . . . 55 + C.3.9 Non-netconf commands in configuration notifications . 55 + D. IP Address Schema . . . . . . . . . . . . . . . . . . . . . . 56 + Intellectual Property and Copyright Statements . . . . . . . . 58 1. Introduction NETCONF [NETCONF-PROTO] can be conceptually partitioned into four layers: Layer Example +-------------+ +----------------------------------------+ | Content | | Configuration data | +-------------+ +----------------------------------------+ @@ -135,33 +141,33 @@ +-------------+ +-----------------------------+ | | | | +-------------+ +------------------------------------------+ | Application | | BEEP, SSH, SSL, console | | Protocol | | | +-------------+ +------------------------------------------+ This document defines a framework for sending asynchronous messages, or event notifications in NETCONF. It defines both the operations necessary to support this concept, and also discusses implications - for the mapping to application protocols. + for the mapping to transport protocols. Figure 1 1.1 Definition of Terms 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 RFC 2119 [3]. Element: An XML Element[XML]. - Managed Entity: A node, which supports NETCONF[NETCONF] and has + Managed Entity: A node, which supports NETCONF[NETCONF-PROTO] and has access to management instrumentation. This is also known as the NETCONF server. Managed Object: A collection of one of more Elements that define an abstract thing of interest. 1.2 Event Notifications in NETCONF An event is something that happens which may be of interest - a configuration change, a fault, a change in status, crossing a @@ -177,20 +183,138 @@ successful and, if it was successful, begins sending the event notifications to the NETCONF client as the events occur within the system. These event notifications will continue to be sent until either the NETCONF session is terminated or an explicit command to cancel the subscription is sent. The event notification subscription allows a number of options to enable the NETCONF client to specify which events are of interest. These are specified when the subscription is created, but can be modified later using a modify subscription command. +1.3 Motivation + + The motivation for this work is to enable the sending of asynchronous + messages that are consistent with the data model (content) and + security model used within a Netconf implementation. + +1.4 Requirements + + The requirements for this solution are as follows: + + o Initial release should ensure it supports notification in support + of configuration operations + + o Data content must be use the same data model as used in + configuration + + o solution should support structured hierarchical data + + o solution should be able to carry configuration fragments + + o solution should support a reasonable message size limit (syslog + and SNMP are rather constrained in terms of message sizes) + + o solution should provide reliable delivery of notifications + o solution should support preconfigured notification destinations + + o solution should support agent initiated connections + + o solution should provide a subscription mechanism + + o solution should support multiple subscriptions + + o solution should provide a filtering mechanism + + o solution should support notification names + + o solution should support notification timestamps + + o solution should support notification classes + + o solution should support notification info + + o solution should provide the ability to specify the content of + notifications to ensure predictability + + o solution should send sufficient information in a notification so + that it can be analyzed independent of the transport mechanism + + o solution should allow notifications to refer to prior + configuration change RPCs + + o solution should not bind subscriptions to a connection + + o channels for configuration change notifications should share fate + with a session that includes a configuration channel + + o solution should support replay of locally logged notifications + + o solution should support message chunking capability in cases + channels carry mixed RPCs + + o solution should scale to 30.000-100.000 nodes which may emit + notifications + + o solution should scale to order 30.000-100.000 nodes to send + notifications [BL] + + See also the external website tracking requirements at + http://www.eecs.iu-bremen.de/wiki/index.php/Netconf_notifications + +1.5 Architecture + + [Editor's Note: add pointers to the various architecture discussions + in the document and identify what people view to be gaps in + architecture discussion. The following may not be what people were + looking for in this section, but should at least give people + something to discuss] + + The following figure illustrates that the netconf implementation + leverages protocol-neutral event management software within the box + rather then re-invent everything in Netconf specific methods. The + netconf client understands which notifications are of interest to it + and creates a subscription that meets its requirements. The network + elements accepts the subscription requests and creates a temporary + subscription to meet those needs. + + ---------------------------------------------- + | Network Element | + | ------------ | + | | Alarm | | + | | Management | -------------- | -------------- + | ------------ |--->|Netconf Stack |<---------->| Netconf | + | | | | | | | | + | | | -------------- | --->| Client | + | V | | | -------------- + | ------------ | | | + | | Event |--->| ------------------ | | + | | Management | | |Other Protocols | | | + | ------------ |--->| | | | + | ------------------ | | + |--------------------------------------------- | + | + ---------------------------------------------- | + | Network Element | | + | ------------ | | + | | Alarm | | | + | | Management | -------------- | | + | ------------ |--->|Netconf Stack |<-------| + | | | | | | + | | | -------------- | + | V | | + | ------------ | | + | | Event |--->| ------------------ | + | | Management | | |Other Protocols | | + | ------------ |--->| | | + | ------------------ | + |-------------------------------------------- + 2. Event-Related Operations 2.1 Subscribing to receive Events The event notification subscription is initiated by the NETCONF client and responded to by the NETCONF server. When the event notification subscription is created, the events of interest are specified. It is possible to create more than one event notification @@ -200,21 +324,21 @@ Content for an event notification subscription can be selected by specifying which event classes are of interest and /or by applying user-specified filters. 2.1.1 create-subscription Description: - This command initiates an event notification subscription which + This operation initiates an event notification subscription which will send asynchronous event notifications to the initiator of the command until the command is sent. Parameters: Event Classes: An optional parameter that indicates which event classes are of interest. If not present, events of all classes will be sent. @@ -224,34 +348,36 @@ possible events are of interest. The format of this parameter is the same as that of the filter parameter in the NETCONF protocol operations. If not present, all events not precluded by other parameters will be sent. These filter parameters can only be modified using the modify-subscription command. Named Profile An optional parameter that points to a separately defined filter profile. The contents of the profile are specified in the provided XML Schema. If not present, no additional - filtering will be applied. If the separate definition of these - filters is updated, then these changes will be reflected in the - filtered events on this subscription. + filtering will be applied. Note that changes to the profile + after the subscription has been created will have no effect + unless a modify subscription command is issued. Positive Response: If the NETCONF server can satisfy the request, the server sends an element containing a element containing the subscription ID. Negative Response: An element is included within the if the - request cannot be completed for any reason. + request cannot be completed for any reason. Subscription requests + will fail if a filter with invalid syntax is provided or if the + name of a non-existent profile is provided. 2.2 Sending Event Notifications Once the subscription has been set up, the NETCONF server sends the event notifications asynchronously along the connection. Notifications are tagged with event classes, subscription ID, sequence number, and date and time. 2.2.1 Event Notification @@ -279,46 +405,39 @@ A sequentially increasing number to uniquely identify event notifications for this subscription. It starts at 0, always increases by just one and rolls back to 0 after its maximum value is reached. Date and Time: The date and time that the event notification was sent by the NETCONF server. + Data: + + Contains event class and notification-specific tagged content. + Positive Response: No response. Negative Response: No response. -2.2.1.1 Event Notification - - The NETCONF Event notification structure is shown in the following - figure. - - ___________________________________________________________________ - || Notification Header || Data | - ||__________________________________________________________||______| - || subscriptionId| eventClasses| sequenceNumber| dateAndTime|| | - ||_______________|_____________|_______________|____________||______| - 2.3 Changing the Subscription After an event notification subscription has been established, the NETCONF client can initiate a request to change properties of the event notification subscription. This prevents loss of event notifications that might otherwise occur during a cancelling and - recreation of the event notification subscription. This command is + recreation of the event notification subscription. This operation is responded to by the NETCONF server 2.3.1 modify-subscription Description: Change properties of the event notification subscription. @@ -340,42 +459,44 @@ filter used for other NETCONF commands. If not present, all events not precluded by other parameters will be sent. These filter parameters can only be modified using the modify- subscription command. Named Profile: An optional parameter that points to separately defined filter profile. The contents of the profile are specified in provided XML Schema. If not present, no additional filtering will be - applied. If the separate definition of these filters is - updated, then these changes will be reflected in the events - seen on this subscription. + applied. Note that changes to the profile after the + subscription has been created will have no effect unless a + modify subscription command is issued. Positive Response: If the NETCONF server was able to satisfy the request, an is sent that includes an element. Negative Response: An element is included within the if the - request cannot be completed for any reason. + request cannot be completed for any reason. Subscription requests + will fail if a filter with invalid syntax is provided or if the + name of a non-existent profile is provided. 2.4 Terminating the Subscription Closing of the event notification subscription is initiated by the NETCONF client. The specific subscription to be closed is specified using a subscription ID. The NETCONF server responds. Note that the NETCONF session may also be torn down for other reasons and this will also result in the subscription being cancelled, but is not subjected - to the behaviour of this command. + to the behaviour of this operation. 2.4.1 cancel-subscription Description: Stop and delete the event notification subscription. Parameters: @@ -413,42 +534,48 @@ urn:ietf:params:xml:ns:netconf:capability:startup:1.0 urn:ietf:params:xml:ns:netconf:notification:1.0 4 -3.2 Querying Subscription Properties +3.2 Subscriptions and Datastores + + Subscriptions are like Netconf sessions in that they don't exist + Netconf datastores. The two exceptions to this are named profiles + and the optional call-home notification feature. + +3.3 Querying Subscription Properties The following Schema can be used to retrieve information about active event notification subscriptions Schema for reporting on Event Subscriptions - NetConfStateSchema + NetconfNotificationSchema 2006-04-30T09:30:47-05:00 IETF A schema that can be used to learn about current NetConf Event subscriptions and creating named profiles @@ -648,135 +774,170 @@ -3.3 One-way Notification Messages +3.4 One-way Notification Messages In order to support the concept that each individual event notification is a well-defined XML-document that can be processed without waiting for all events to come in, it makes sense to define events, not as an endless reply to a subscription command, but as independent messages that originate from the NETCONF server. In order to support this model, this memo introduces the concept of notifications, which are one-way messages. A one-way message is similar to the two-way RPC message, except that no response is expected to the command. In the case of event notification, this message will originate from the NETCONF server, and not the NETCONF client. -3.4 Filter Dependencies +3.5 Filter Dependencies Note that when multiple filters are specified (Event Class, in-line Filter, Named Profiles), they are applied collectively, so event notifications needs to pass all specified filters in order to be sent to the subscriber. If a filter is specified to look for data of a particular value, and the data item is not present within a particular event notification for its value to be checked against, it will be filtered out. For example, if one were to check for 'severity=critical' in a configuration event notification where this field was not supported, then the notification would be filtered out. -3.4.1 Named Profiles +3.5.1 Named Profiles A named profile is a filter that is created ahead of time and applied at the time an event notification subscription is created or modified. Note that changes to the profile after the subscription has been created will have no effect unless a modify subscription command is issued. Since named profiles exist outside of the subscription, they persist after the subscription has been cancelled. -3.4.2 Filtering +3.5.2 Filtering Just-in-time filtering is explicitly stated when the event notification subscription is created. These filters can only be changed using the modify subscription command. This is specified via the Filter parameter. Filters only exist as parameters to the subscription. -3.5 Event Classes +3.6 Event Classes - Events can be broadly classified into one more event classes. Each - event class identifies a set of event notifications which share - important characteristics, such being generated from similar events - or sharing much of the same content. + Events can be classified into one more event classes. Each event + class identifies a set of event notifications which - The initial set of event classes is fault, configuration, state, + share similar content + + are generated from similar events + + The initial set of event classes is configuration, fault, state, audit, data, maintenance, metrics, security, information, heartbeat - and syslog. + and syslogTunnel. See the IANA Considerations section for + information on defining new event classes. + + All events shall carry the following data: list of event class, + timestamp and sequence number of the notification. They may also + carry additional data. + + ___________________________________________________________________ + || Notification Header || Data | + ||__________________________________________________________||______| + || subscriptionId| eventClasses| sequenceNumber| dateAndTime|| | + ||_______________|_____________|_______________|____________||______| + +3.6.1 Initial Set of Event Classes + + A configuration event, alternatively known as an inventory event, is + used to indicate that hardware, software, or a service has been + added, changed or removed. In keeping aligned with NETCONF protocol + operations, configuration events may included copy configuration + event, delete configuration event, or the edit configuration event + (create, delete, merge, replace). As configuration notifications + could potentially carry huge amounts of data in order to properly + support functions such as security audit logs, so it is expected that + netconf clients will engineer their subscriptions to meet their needs + and to not overwhelm their capacity to process and store event + notifications. Examples include hardware board removed, software + module loaded or DNS server reconfigured. Changes are reported to + all subscribed clients, not just to those clients whose actions + triggered the changes. A fault event notification is generated when a fault condition (error or warning) occurs. A fault event may result in an alarm. Examples of fault events could be a communications alarm, environmental alarm, equipment alarm, processing error alarm, quality of service alarm, or a threshold crossing event. See RFC3877 and RFC2819 for more + information. The fault notification should carry the following data: + severity, event source, probable cause, specific problem, additional information. - A configuration event, alternatively known as an inventory event, is - used to notify that hardware, software, or a service has been added/ - changed/removed. In keeping aligned with NETCONF protocol - operations, configuration events may included copy configuration - event, delete configuration event, or the edit configuration event - (create, delete, merge, replace). - A state event indicates a change from one state to another, where a state is a condition or stage in the existence of a managed entity. State change events are seen in many specifications. For Entity - state changes, see [Entity-State-MIB] for more information. + state changes, see [Entity-State-MIB] for more information. The + notification shall identify the object who's state changed and the + new state. Internal states of a node are important for supervision + purposes and also effect how a node can be configured. Audit events provide event of very specific actions within a managed device. In isolation an audit events provides very limited data. A collection of audit information forms an audit trail. A data dump event is an asynchronous event containing information about a system, its configuration, state, etc. A maintenance event signals the beginning, process or end of an action either generated by a manual or automated maintenance action. + If the maintenance event is a direct result of a configuration + management operation on this Netconf session then an rpc-reply + notification should be used. This event class is intended instead + for reporting on scheduled maintenance activities. Expected data + includes a description of the maintenance process, the stage the + process has reached, the manual action, automatic process that + triggered the notification. Examples include automatic backup + completed. A metrics event contains a metric or a collection of metrics. This includes performance metrics. A heart beat event is sent periodically to enable testing that the communications channel is still functional. It behaves much like the other event classes, with the exception that implementations may not want to include an event log, if supported. Although widely used throughout the industry, no current corresponding work within the IETF. However, other standards bodies such as the TeleManagement Forum have similar definitions. An Information event is something that happens of interest which is within the expected operational behaviour and not otherwise covered by another class. - The syslog event class is used to indicate tunneled syslog content. - The content and format of the message will be compliant to syslog - standards. + syslogTunnel event is when syslog content is sent, unmodified, within + a Netconf event Notification. See appendix X.X for more + information.. -3.6 Defining Event Notifications +3.7 Defining Event Notifications Event Notifications are defined ahead of time by defining an XML element and assigning it to particular event classes. This will be done using an "eventClasses" attribute. -3.7 Interleaving Messages +3.8 Interleaving Messages While each NETCONF message must be a complete XML document, the design of the event system allows for the interleaving of complete asynchronous event notifications with complete synchronous messages. - It is possible to still send command-response type messages such as while events are being generated. The only restriction is that each message must be complete The following sequence diagram demonstrates an example NETCONF session where after basic session establishment and capability exchange, NETCONF client (C), subscribes to receive event notifications. The NETCONF server (S), starts sending event notifications as events of interest happen within the system. The NETCONF client decides to change the characteristics of their event @@ -962,47 +1123,42 @@ - - - - - + + + + - The date and time that the event notification was - sent by the netconf server. + The date and time that the notification was sent + by the netconf server. - - -5. Mapping to Application Protocols +5. Mapping to Transport Protocols Currently, the NETCONF family of specification allows for running - NETCONF over a number of application protocols, some of which support + NETCONF over a number of transport protocols, some of which support multiple configurations. Some of these options will be better suited for supporting event notifications then others. 5.1 SSH Session establishment and two-way messages are based on the NETCONF over SSH transport mapping [NETCONF-SSH] One-way event messages are supported as follows: Once the session has been established and capabilities have been exchanged, the server @@ -1020,23 +1176,23 @@ The NETCONF over SSH session to receive an event notification might look like the following. Note the event notification contents (delimited by tags) are not defined in this document and are provided herein simply for illustration purposes: 123456 - - 2 - 2000-01-12T12:13:14Z + + 2 + 2000-01-12T12:13:14Z Fred Flinstone @@ -1142,21 +1298,21 @@ S: Content-Type: application/soap+xml; charset=utf-8 S: Content-Length: 917 S: S: S: S: S: S: 123456 - S: + S: S: 2 S: 2000-01-12T12:13:14Z S: S: Fred Flinstone S: S: S: S: S: S: @@ -1178,21 +1334,21 @@ The following section provides examples to illustrate the various methods of filtering content on an event notification subscription. 6.1 Event Classes The following example illustrates selecting all event notifications for EventClasses fault, state or config + xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> 6.2 Subtree Filtering @@ -1204,27 +1360,28 @@ Nevertheless, it may be used for defining simple notification forwarding filters as shown below. The following example illustrates selecting fault EventClass which have severities of critical, major, or minor. The filtering criteria evaluation is as follows: ((fault) & ((severity=critical) | (severity=major) | (severity = minor))) + xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> - + critical major minor @@ -1233,29 +1390,30 @@ The following example illustrates selecting fault, state, config EventClasses which have severities of critical, major, or minor and come from card Ethernet0. The filtering criteria evaluation is as follows: ((fault | state | config) & ((fault & severity=critical) | (fault & severity=major) | (fault & severity = minor) | (card=Ethernet0))) + xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> - + fault critical fault major fault @@ -1271,21 +1429,21 @@ 6.3 XPATH filters The following example illustrates selecting fault EventClass which have severities of critical, major, or minor. The filtering criteria evaluation is as follows: ((fault) & ((severity=critical) | (severity=major) | (severity = minor))) + xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> (/event[eventClasses/fault] and (/event[severity="critical"] or /event[severity="major"] or /event[severity="minor"])) @@ -1293,21 +1451,21 @@ The following example illustrates selecting fault, state, config EventClasses which have severities of critical, major, or minor and come from card Ethernet0. The filtering criteria evaluation is as follows: ((fault | state | config) & ((fault & severity=critical) | (fault & severity=major) | (fault & severity = minor) | (card=Ethernet0))) + xmlns="urn:ietf:params:xml:ns:netconf:notification:1.0"> ((/event[eventClasses/fault] or /event[eventClasses/state] or /event[eventClasses/config]) and @@ -1343,20 +1501,26 @@ association with a Netconf client. Unlike normal subscriptions, which only exist when they are active, these subscriptions live while both dormant and active. When an event of interest happens on the managed resource, the Netconf server checks the list of dormant subscriptions and if the filtering parameters in the subscription indicate interest in the Notification resulting from the event, then the Netconf server initiates the connection to the specific Netconf client and sends the Notification. When the Notification has been sent, the connection is terminated. + A subscription is active when it is currently session between the + Netconf client and server related to this subscription on which + Notifications can be sent. A subscription is dormant when there is + currently no session set up between the Netconf client and server + related to this notification subscription. + 7.1.1.1 Session Lifecycle In order to avoid situations in which a sessions is continuously setup and torn down, an inactivity timer is configured on the server. The timeout interval value is the same for all sessions (i.e. system wide) and each session has its own timer. Upon expiration of the inactivity timer, the connection is terminated, otherwise if activity is detected, the timer is reset. [Editor's note: alternatives here were to either create and tear down @@ -1357,34 +1521,35 @@ The timeout interval value is the same for all sessions (i.e. system wide) and each session has its own timer. Upon expiration of the inactivity timer, the connection is terminated, otherwise if activity is detected, the timer is reset. [Editor's note: alternatives here were to either create and tear down the session for each notification received or to have the server somehow figure out that there are more notifications coming soon after it has sent a notification and therefore keeps the connection up.] - The session establishment procedure is as follows: - 1) The NETCONF server initiates a session using a recognized - application protocol (SSH, Beep, SOAP, etc). In order to "activate" - this reverse behaviour a new SSH subsystem may need to be defined. + 1) The NETCONF server checks to ensure there isn't already a suitable + notification session open. + 2) The NETCONF server initiates a session using a recognized + transport protocol (SSH, Beep, SOAP, etc). In order to "activate" + this reverse behavior a new SSH subsystem may need to be defined. This is for further study. In addition, the NE hosting the NETCONF server must support both client and server modes in the case of SSH. - 2) Client and server are authenticated according to the underlying - application protocol (e.g. SSH, BEEP) + 3) Client and server are authenticated according to the underlying + transport protocol (e.g. SSH, BEEP) - 3) If using BEEP, as described in [NETCONF-BEEP] either party may + 4) If using BEEP, as described in [NETCONF-BEEP] either party may initiate the BEEP session. Once this occurs, the assumption is that both parties know their roles. At this point, the NETCONF client, initiates NETCONF session establishment whether running SSH or BEEP. 7.1.2 Dependencies This feature is dependant on the named profiles concept from the normal subscription method as well as the definition of . @@ -1397,21 +1562,21 @@ 7.1.3.1 New Operations 7.1.3.1.1 New Data Model Schema for reporting on dormant Call-Home Notification Subscriptions - + - This needs to be replaced with a more - prescriptive data type + The Netconf client that is subscribed to + receive these notifications as part of + the call-home subscription. + + + + + + - The named profile associated with this subscription. Note that the contents of the named profile may have changed since it was last applied @@ -1510,28 +1682,46 @@ To be determined once specific aspects of this solution are better understood. In particular, the access control framework and the choice of transport will have a major impact on the security of the solution 9. IANA Considerations Event Classes will likely be an IANA-managed resource. The initial set of values is defined in this specification. + In order for new event classes to be allocated, the following + requirements must be met: + + o There must be working group consensus to add the new class + + o A detailed description of its purpose in the netconf protocol must + be provided + + o A detailed description of all manager and agent implementation + requirements associated with the event class must be provided + + o The description must make clear to developers how to determine + when it is appropriate to choose this event classification for a + new notification type + + list + 10. Acknowledgements Thanks to Gilbert Gagnon and Greg Wilbur for providing their input into the early work on this document. In addition, the editors would like to acknowledge input at the Vancouver editing session from the following people: Orly Nicklass, James Bakstrieve, Yoshifumi Atarashi, Glenn Waters, Alexander Clemm, Dave Harrington, Dave - Partain, Ray Atarashi and Dave Perkins. + Partain, Ray Atarashi and Dave Perkins. In addition, they would like + to thank Balazs Lengyel his contributions to the event class text. 11. References [NETCONF] Enns, R., "NETCONF Configuration Protocol", ID draft-ietf-netconf-prot-12, February 2006. [NETCONF BEEP] Lear, E. and K. Crozier, "Using the NETCONF Protocol over Blocks Extensible Exchange Protocol (BEEP)", ID draft-ietf-netconf-beep-10, March 2006. @@ -2047,20 +2237,70 @@ in which it wants the NETCONF server to issue the event notifications at subscription time by specifying the appropriate namespace under the Filter parameter in the operation. An example is provided below: +Appendix D. IP Address Schema + + + + + + + + + An IP version 4 address in dotted notation decimal. + Example: 15.13.120.22 + + + + + + + + + + + An IP version 6 address in colon separated 2 byte + block hexadecimal notation. + Example: FEDC:AB19:12FE:0234:98EF:1178:8891:CAFF + + + + + + + + + + + + + + + + Intellectual Property Statement The IETF takes no position regarding the validity or scope of any Intellectual Property Rights or other rights that might be claimed to pertain to the implementation or use of the technology described in this document or the extent to which any license under such rights might or might not be available; nor does it represent that it has made any independent effort to identify any such rights. Information on the procedures with respect to rights in RFC documents can be found in BCP 78 and BCP 79.