Network Working Group M. Scott Internet-Draft S. Chisholm Intended status: Standards Track Nortel Expires: July 18, 2008 January 15, 2008 NETCONF Monitoring Schema draft-ietf-netconf-monitoring-00.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 other groups may also distribute working documents as Internet- Drafts. 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." 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 July 18, 2008. Copyright Notice Copyright (C) The IETF Trust (2008). Scott & Chisholm Expires July 18, 2008 [Page 1]
Internet-Draft NETCONF Monitoring Schema January 2008 Abstract This document defines Netconf content via XML Schema to be used to monitor the Netconf protocol. It provides information about Netconf sessions and subscriptions. The proposed schema is intended to provide sufficient information to facilitate Netconf session and subscription management. It does not intend to provide detailed statistical session information. Though primarily intended to monitor Netconf protocol the schema also provides information for non-Netconf sessions. In particular for session management purposes. Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 3 1.1. Definition of Terms . . . . . . . . . . . . . . . . . . . 3 1.2. XML Schema to Monitor Netconf . . . . . . . . . . . . . . 4 2. Security Considerations . . . . . . . . . . . . . . . . . . . 10 3. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 11 4. Normative References . . . . . . . . . . . . . . . . . . . . . 12 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 13 Intellectual Property and Copyright Statements . . . . . . . . . . 14 Scott & Chisholm Expires July 18, 2008 [Page 2]
Internet-Draft NETCONF Monitoring Schema January 2008 1. Introduction [NETCONF]can be conceptually partitioned into four layers: Layer Example +-------------+ +----------------------------------------+ | Content | | Configuration data | +-------------+ +----------------------------------------+ | | +-------------+ +-------------------------------------------+ | Operations | | <get-config>, <edit-config> <notification>| +-------------+ +-------------------------------------------+ | | | +-------------+ +-----------------------------+ | | RPC | | <rpc>, <rpc-reply> | | +-------------+ +-----------------------------+ | | | | +-------------+ +------------------------------------------+ | Transport | | BEEP, SSH, SSL, console | | Protocol | | | +-------------+ +------------------------------------------+ This document defines Netconf content via[XML Schema]to be used to monitor the Netconf protocol. It provides information Netconf sessions and subscriptions. 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[RFC2119]. Element: An[XML]Element. Managed Object: A collection of one of more Elements that define an abstract thing of interest. Subscription: A concept related to the delivery of notifications (if any to send) involving destination and selection of notifications. It is bound to the lifetime of a session. Operation: This term is used to refer to NETCONF protocol operations. Specifically within this document, operation refers to NETCONF protocol operations defined in support of NETCONF notifications. Scott & Chisholm Expires July 18, 2008 [Page 3]
Internet-Draft NETCONF Monitoring Schema January 2008 1.2. XML Schema to Monitor Netconf <xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema" xmlns="urn:ietf:params:xml:ns:netconf:state:1.0" xmlns:netconf="urn:ietf:params:xml:ns:netconf:base:1.0" targetNamespace="urn:ietf:params:xml:ns:netconf:state:1.0" elementFormDefault="qualified" attributeFormDefault="unqualified"> <xs:annotation> <xs:documentation xml:lang="en"> NetConf Monitoring Schema. All elements in this Schema are read-only. </xs:documentation> </xs:annotation> <xs:import namespace="urn:ietf:params:xml:ns:netconf:base:1.0" schemaLocation="urn:ietf:params:xml:ns:netconf:base:1.0"/> <xs:import namespace="urn:ietf:params:xml:ns:netconf:notification:1.0" schemaLocation="urn:ietf:params:xml:ns:netconf:notification:1.0"/> <xs:element name="netconfState"> <xs:complexType> <xs:sequence> <xs:element name="capabilities"> <xs:annotation> <xs:documentation xml:lang="en"> List of NETCONF capabilities supported by this device. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="capability" type="xs:anyURI" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="sessions"> <xs:annotation> <xs:documentation xml:lang="en"> List of NETCONF or other sessions currently active on this device. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> Scott & Chisholm Expires July 18, 2008 [Page 4]
Internet-Draft NETCONF Monitoring Schema January 2008 <xs:element name="session" type="ManagementSessionInfo" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="configurations"> <xs:annotation> <xs:documentation xml:lang="en"> List of NETCONF configuration datastores (e.g. running, startup, candidate) supported on this device and related information. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="config" type="ConfigurationDatastoreInfo" minOccurs="1" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> <xs:element name="subscriptions"> <xs:annotation> <xs:documentation xml:lang="en"> List of NETCONF notification subscriptions active on this device and related information. </xs:documentation> </xs:annotation> <xs:complexType> <xs:sequence> <xs:element name="subscription" type="NetconfSubscriptionInfo" minOccurs="0" maxOccurs="unbounded"/> </xs:sequence> </xs:complexType> </xs:element> </xs:sequence> </xs:complexType> </xs:element> <!-- Complex Types --> <xs:complexType name="ManagementSessionInfo"> <xs:sequence> <xs:element name="sessionId" Scott & Chisholm Expires July 18, 2008 [Page 5]
Internet-Draft NETCONF Monitoring Schema January 2008 type="netconf:SessionId" minOccurs="1"/> <xs:element name="transport" type="transportType" minOccurs="1"/> <xs:element name="protocol" type="sessionType" minOccurs="1"/> <xs:element name="username" type="xs:string" minOccurs="1"/> <xs:element name="sourceIdentifier" type="srcIdentifier" minOccurs="1"/> <xs:element name="loginTime" type="xs:dateTime" minOccurs="1"/> </xs:sequence> </xs:complexType> <xs:complexType name="ConfigurationDatastoreInfo"> <xs:sequence> <xs:element name="name" type="xs:string"/> <xs:element name="type" type="netconf:configNameType"/> <xs:element name="lockStatus" type="LockStatus"/> </xs:sequence> </xs:complexType> <xs:complexType name="LockStatus"> <xs:annotation> <xs:documentation> An indication of whether a resource is locked or unlocked. If locked, additional information about the locking such as user and time stamp is provided. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="lock-state"> <xs:simpleType> <xs:restriction base="xs:string"> <xs:enumeration value="locked"/> <xs:enumeration value="unlocked"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="lockedBySession" type="netconf:SessionId" minOccurs="0"> <xs:annotation> <xs:documentation> The session ID of the session that has locked this resource. </xs:documentation> Scott & Chisholm Expires July 18, 2008 [Page 6]
Internet-Draft NETCONF Monitoring Schema January 2008 </xs:annotation> </xs:element> <xs:element name="lockedTime" type="xs:dateTime" minOccurs="0"> <xs:annotation> <xs:documentation> The date and time of when the resource was locked. If the resource is currently unlocked, this element will not be present. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> <xs:complexType name="NetconfSubscriptionInfo"> <xs:annotation> <xs:documentation> Information about Netconf Notification Subscriptions. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="session-id" type="netconf:SessionId"> <xs:annotation> <xs:documentation xml:lang="en"> The session id associated with this subscription. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="stream" type="xs:string" minOccurs="0"> <xs:annotation> <xs:documentation xml:lang="en"> The stream associated with this subscription. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="filter" type="netconf:filterInlineType" minOccurs="0"> <xs:annotation> <xs:documentation xml:lang="en"> The filters associated with this subscription. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="associatedNamedProfile" minOccurs="0"> Scott & Chisholm Expires July 18, 2008 [Page 7]
Internet-Draft NETCONF Monitoring Schema January 2008 <xs:annotation> <xs:documentation xml:lang="en"> The named profile associated with this subscription. Note that the contents of the named profile may have changed since it was last applied. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="lastModified" type="xs:dateTime"> <xs:annotation> <xs:documentation xml:lang="en"> The last time this subscription was modified. If it has not been modified since creation, this is the time of subscription creation. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="messagesSent" type="xs:unsignedInt" minOccurs="0"> <xs:annotation> <xs:documentation xml:lang="en"> A count of event notifications sent along this connection since the subscription was created. </xs:documentation> </xs:annotation> </xs:element> <xs:element name="key"> <xs:key name="uniqueSubscription"> <xs:selector xpath=".//subscription"/> <xs:field xpath="sessionId"/> </xs:key> </xs:element> </xs:sequence> </xs:complexType> <xs:simpleType name="transportType"> <xs:restriction base="xs:string"> <xs:enumeration value="console"/> <xs:enumeration value="tcp"/> <xs:enumeration value="ssh"/> <xs:enumeration value="ssl"/> </xs:restriction> </xs:simpleType> <xs:simpleType name="sessionType"> <xs:restriction base="xs:string"> Scott & Chisholm Expires July 18, 2008 [Page 8]
Internet-Draft NETCONF Monitoring Schema January 2008 <xs:enumeration value="cli"/> <xs:enumeration value="netconf"/> <xs:enumeration value="webui"/> </xs:restriction> </xs:simpleType> <xs:complexType name="srcIdentifier"> <xs:annotation> <xs:documentation> Information about source of the session. </xs:documentation> </xs:annotation> <xs:sequence> <xs:element name="ipAddressTypev4"> <xs:simpleType> <xs:annotation> <xs:documentation> An IP Address that matches the following form: xxx.xxx.xxx.xxx </xs:documentation> </xs:annotation> <xs:restriction base="xs:string"> <xs:pattern value="[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}\.[0-9]{1,3}"/> </xs:restriction> </xs:simpleType> </xs:element> <xs:element name="nodeName"> <xs:annotation> <xs:documentation> Name of the node. </xs:documentation> </xs:annotation> </xs:element> </xs:sequence> </xs:complexType> </xs:schema> Scott & Chisholm Expires July 18, 2008 [Page 9]
Internet-Draft NETCONF Monitoring Schema January 2008 2. Security Considerations The information in this Schema provides information about Netconf system that could be used to aid an attack on that system. Care should be taken to restrict access to this information as appropriate. Scott & Chisholm Expires July 18, 2008 [Page 10]
Internet-Draft NETCONF Monitoring Schema January 2008 3. Acknowledgements Thanks to the Netconf working group for an earlier draft of Schema to manage Netconf and Netconf Notifications and for ongoing contributions reflected in this draft. Scott & Chisholm Expires July 18, 2008 [Page 11]
Internet-Draft NETCONF Monitoring Schema January 2008 4. Normative References [NETCONF] Enns, R., "NETCONF Configuration Protocol", RFC 4741, February 2006. [NETCONF-EVENT] Chisholm, S. and H. Trevino, "NETCONF Event Notifications", ID draft-ietf-netconf-notifications-06, February 2007. [RFC2026] Bradner, S., "The Internet Standards Process -- Revision 3", RFC 2026, BCP 9, October 1996. [RFC2119] Bradner, s., "Key words for RFCs to Indicate Requirements Levels", RFC 2119, March 1997. [RFC2223] Postel, J. and J. Reynolds, "Instructions to RFC Authors", RFC 2223, October 1997. [XML] World Wide Web Consortium, "Extensible Markup Language (XML) 1.0", W3C XML, February 1998, <http://www.w3.org/TR/1998/REC-xml-19980210>. [XML Schema] Fallside, D. and P. Walmsley, "XML Schema Part 0: Primer Second Edition", W3C XML Schema, October 2004. Scott & Chisholm Expires July 18, 2008 [Page 12]
Internet-Draft NETCONF Monitoring Schema January 2008 Authors' Addresses Mark Scott Nortel 3500 Carling Ave Nepean, Ontario K2H 8E9 Canada Email: markscot@nortel.com Sharon Chisholm Nortel 3500 Carling Ave Nepean, Ontario K2H 8E9 Canada Email: schishol@nortel.com Scott & Chisholm Expires July 18, 2008 [Page 13]
Internet-Draft NETCONF Monitoring Schema January 2008 Full Copyright Statement Copyright (C) The IETF Trust (2008). This document is subject to the rights, licenses and restrictions contained in BCP 78, and except as set forth therein, the authors retain all their rights. This document and the information contained herein are provided on an "AS IS" basis and THE CONTRIBUTOR, THE ORGANIZATION HE/SHE REPRESENTS OR IS SPONSORED BY (IF ANY), THE INTERNET SOCIETY, THE IETF TRUST AND THE INTERNET ENGINEERING TASK FORCE DISCLAIM ALL WARRANTIES, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTY THAT THE USE OF THE INFORMATION HEREIN WILL NOT INFRINGE ANY RIGHTS OR ANY IMPLIED WARRANTIES OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Intellectual Property 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. Copies of IPR disclosures made to the IETF Secretariat and any assurances of licenses to be made available, or the result of an attempt made to obtain a general license or permission for the use of such proprietary rights by implementers or users of this specification can be obtained from the IETF on-line IPR repository at http://www.ietf.org/ipr. The IETF invites any interested party to bring to its attention any copyrights, patents or patent applications, or other proprietary rights that may cover technology that may be required to implement this standard. Please address the information to the IETF at ietf-ipr@ietf.org. Acknowledgment Funding for the RFC Editor function is provided by the IETF Administrative Support Activity (IASA). Scott & Chisholm Expires July 18, 2008 [Page 14]