Network Working Group M. Scott Internet-Draft S. Chisholm Intended status: Standards Track Nortel Expires: May 7, 2009 M. Bjorklund Tail-f Systems November 3, 2008 NETCONF Monitoring Schema draft-ietf-netconf-monitoring-03 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 May 7, 2009. Copyright Notice Copyright (C) The IETF Trust (2008). Scott, et al. Expires May 7, 2009 [Page 1] Internet-Draft NETCONF Monitoring Schema November 2008 Abstract This document defines NETCONF content via XML Schema to be used to monitor the NETCONF protocol. The monitoring data model includes information about NETCONF sessions, locks, and subscriptions and is intended to facilitate management of a NETCONF server. In addition this monitoring data provides clients with standardized content to describe supported schema. Today, NETCONF capabilities exchange is the only standardized method a client can use to discover the functionality supported by a NETCONF server. This works well for static protocol capabilities but is not well suited for capabilities which could change during a session. Considerations such as different schema formats, feature optionality and access controls can all impact the applicability and level of detail the NETCONF server sends to a client during session setup. Through updated monitoring data NETCONF clients can adjust their capabilities throughout a session. Specifically the details returned can be used by a client to determine whether retrieval of new schema information is required and includes the information required to facilitate the retrieval. A new RPC (get-schema) is also defined to support explicit schema retrieval via NETCONF. Scott, et al. Expires May 7, 2009 [Page 2] Internet-Draft NETCONF Monitoring Schema November 2008 Table of Contents 1. Introduction . . . . . . . . . . . . . . . . . . . . . . . . . 4 1.1. Definition of Terms . . . . . . . . . . . . . . . . . . . 4 2. XML Schema to Monitor NETCONF . . . . . . . . . . . . . . . . 5 2.1. netconf . . . . . . . . . . . . . . . . . . . . . . . . . 5 2.1.1. capabilities . . . . . . . . . . . . . . . . . . . . . 6 2.1.2. configurations . . . . . . . . . . . . . . . . . . . . 6 2.1.3. schemas . . . . . . . . . . . . . . . . . . . . . . . 6 2.1.4. sessions . . . . . . . . . . . . . . . . . . . . . . . 7 2.1.5. subscriptions . . . . . . . . . . . . . . . . . . . . 8 2.1.6. statistics . . . . . . . . . . . . . . . . . . . . . . 9 3. Schema Specific Operations . . . . . . . . . . . . . . . . . . 11 3.1. New NETCONF RPC, . . . . . . . . . . . . . . 11 3.2. NETCONF Schema List Retrieval ( monitoring data) . . 11 4. Examples . . . . . . . . . . . . . . . . . . . . . . . . . . . 13 4.1. Retrieving schema list via . . . . . . . . . . . . . 13 4.2. Retrieving schema instances . . . . . . . . . . . . . . . 15 5. XSD Schema . . . . . . . . . . . . . . . . . . . . . . . . . . 17 5.1. NETCONF Monitoring Schema . . . . . . . . . . . . . . . . 17 5.2. inet:host schema . . . . . . . . . . . . . . . . . . . . . 28 6. Security Considerations . . . . . . . . . . . . . . . . . . . 31 7. Acknowledgements . . . . . . . . . . . . . . . . . . . . . . . 32 8. IANA Considerations . . . . . . . . . . . . . . . . . . . . . 33 9. Normative References . . . . . . . . . . . . . . . . . . . . . 34 Appendix A. YANG module (non-normative) . . . . . . . . . . . . . 35 Authors' Addresses . . . . . . . . . . . . . . . . . . . . . . . . 43 Intellectual Property and Copyright Statements . . . . . . . . . . 44 Scott, et al. Expires May 7, 2009 [Page 3] Internet-Draft NETCONF Monitoring Schema November 2008 1. Introduction This document defines NETCONF content via [XMLSchema] to be used to monitor the NETCONF protocol. It provides information about NETCONF sessions and subscriptions. 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]. 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 monitoring. Schema: This term is used to refer to a data model fragment, independent of which data modeling language is used in the data model. 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. XML Schema: The W3C XML Schema [XMLSchema] data modeling language. YANG: YANG is a data modeling language used to model configuration and state data manipulated by the NETCONF protocol, NETCONF remote procedure calls, and NETCONF notifications. Scott, et al. Expires May 7, 2009 [Page 4] Internet-Draft NETCONF Monitoring Schema November 2008 2. XML Schema to Monitor NETCONF The following data allows a NETCONF client to monitor both the NETCONF server itself and the associated network device operational data. The specific monitoring data defined in this draft which MUST be present follows. 2.1. netconf Root of the monitoring data model. Acts as container for the other monitored data. netconf |_capabilities |_configurations |_schemas |_sessions |_subscriptions |_statistics capabilities (type: xs:anyURI) List of NETCONF capabilities supported by the server. configurations (type: ConfigurationDatastore) List of NETCONF datastores on the server. Includes all supported datastore types (running, candidate, startup) schemas (type: SchemaEntry) List of schemas supported on the server. Includes all the information required to identify the schema and to support its retrieval. sessions (type: ManagementSession) List of all active sessions on the device including NETCONF and other sessions (eg: CLI). subscriptions (type: NetconfSubscription) List of all NETCONF notification subscriptions active on the server. statistics (type: ManagementStatistics) Contains management stats for the NETCONF server including performance and error related counters. Scott, et al. Expires May 7, 2009 [Page 5] Internet-Draft NETCONF Monitoring Schema November 2008 2.1.1. capabilities The list of capabilities supported by the NETCONF server. The list MUST include all capabilities exchanged during session setup still applicable at the time of the request. This ensures consistency with the initial capabilities exchanged while allowing for potential modifications during a session. 2.1.2. configurations Configuration data pertaining to the NETCONF server. configuration (type: ConfigurationDataStore) |_name |_locks name (type: NETCONFDatastoreType) Enumeration of supported datastores; candidate, running, startup. locks (type: ManagementSessionLock) Contains current lock information for the datastores. Global and partial locks are supported as either a single global lock or multiple partial locks per datastore. Both a global lock and a partial lock MUST contain the sessionId and time the lock was acquired. The lockedNodes is the list of actual nodes which were locked at the the selection was evaluated. This is provided for completeness noting that the list of nodes returned by the selection may differ over time. Additionally partial lock items will contain both the selection and the list of lockedNodes. The selection is the xpath expression which was used to evaluate the list of nodes to lock. 2.1.3. schemas Scott, et al. Expires May 7, 2009 [Page 6] Internet-Draft NETCONF Monitoring Schema November 2008 The list of supported schema for the NETCONF server. schema |_identifier (key) |_version (key) |_format (key) |_namespace |_location The elements identifier, version, and format are used as a key in the schema list. They are also used in the RPC. identifier (type: xs:string) Identifier for the schema list entry. Typically the module name or filename of the schema. It is also used in the RPC and may be used for other means. version (type: xs:string) Version of the schema supported. Multiple versions MAY be supported simultaneously by a NETCONF server. Each MUST be reported individually in the schema list, i.e. with same identifier, possibly different location, but different version. format (type: SchemaFormat) The data modeling language of the file/module. Current selection of XSD, YANG, and RNG. namespace(type: xs:anyURI) The XML namespace defined by the data model. location (union type: xs:string, xs:anyURI) A location from which this specific schema, format, and version can be retrieved. At least one schema entry SHOULD be available to support retrieval. A schema entry may be located on a network device (eg: xs:anyURI), (eg: xs:string reference to file system for ftp retrieval) or available explicitly via NETCONF (xs:string value 'NETCONF') for NETCONF servers which support the schema-retrieval capability via . 2.1.4. sessions Scott, et al. Expires May 7, 2009 [Page 7] Internet-Draft NETCONF Monitoring Schema November 2008 Session data pertaining to the NETCONF server. Includes data for NETCONF and non-NETCONF management sessions. sessions (type: ManagementSessionInfo): session |_sessionId |_transport |_protocol |_username |_sourceHost |_loginTime sessionId (type: SessionId) Unique identifier for the session. transport (type: TransportType) Idenfities transport for each session, e.g. "Console", "SSH". protocol (type: ProtocolType) Identifies the protocol being used for each session, e.g.: "NETCONF", "CLI", "WebUI". username (type: xs:string) Session owner. sourceHost (type: inet:host) Host identifier (IP + name) for the client. See section 5.2 for definition. loginTime (type: xs:dateTime) Time at which the session was established. 2.1.5. subscriptions Scott, et al. Expires May 7, 2009 [Page 8] Internet-Draft NETCONF Monitoring Schema November 2008 subscriptions: NetconfSubscription complex type. List of notifications subscriptions for all active sessions. subscription |_sessionId |_stream |_filter |_startTime |_stopTime |_messagesSent sessionId (type: SessionId) Unique identifier for the notifications. MUST return the same value as returned in 'sessions' to allow correlation. stream (netconf notification type: streamNameType) Specific event notifications subscribed by session. Unique identifier mappable to event subscriptions. filter ( netconf notification type: FilterType) Filter being applied to the notification stream. startTime (xs:dateTime) Optional startTime parameter given in the request. stopTime (xs:dateTime) Optional stopTime parameter given in the request. messagesSent (xs:unsignedInt) Total messages sent for this subscription. 2.1.6. statistics Scott, et al. Expires May 7, 2009 [Page 9] Internet-Draft NETCONF Monitoring Schema November 2008 Statistical data pertaining to the NETCONF server. managementStatistics(type: ManagementPerformanceStatistics): Contains management session related performance data for the NETCONF server. netconfStartTime (type: xs:dateTime) Date and time at which the NETCONF server process was started. Allows for calculation of simple time interval for reported metrics. Ie: current time - startTime defines the collection interval for the metrics allowing for calculations such as averages. More complex calculations would require multiple collection intervals with both start and stop times defined per interval. inSessions (type: xs:unsignedInt) The total number of NETCONF sessions started towards the NETCONF peer. inXMLParseErrors (type: xs:unsignedInt) The total number of messages that were unparsable and thus ignored. This covers both unparsable and messages. inBadHellos (type: xs:unsignedInt) The total number of sessions silently dropped because an invalid message was received. This includes messages with a "session-id" attribute, bad namespace, and bad capability declarations. inRpcs (type: xs:unsignedInt) The total number of rpc requests received. inBadRpcs (type: xs:unsignedInt) The total number of rpcs which were parsed correctly, but couldn't be serviced because they contained non-conformant XML, e.g. missing a mandatory parameter. inNotSupportedRpcs (type: xs:unsignedInt) The total number of rpcs which were parsed correctly, but couldn't be serviced because they were not supported by the agent. outRpcReplies (type: xs:unsignedInt) The total number of messages sent. outRpcErrors (type: xs:unsignedInt) The total number of messages with sent. outNotifications (type: xs:unsignedInt) The total number of messages sent. Scott, et al. Expires May 7, 2009 [Page 10] Internet-Draft NETCONF Monitoring Schema November 2008 3. Schema Specific Operations 3.1. New NETCONF RPC, Description: When the schema is available on the device and the client wishes to have it returned via NETCONF this new RPC operation is used. Parameters: identifier (type: xs:string): Identifier for the schema list entry. Typically the module name or filename of the schema. version (type: xs:string): Version of the schema supported. format (type: SchemaFormat): The data modeling language of the file/ module. Example: Query a specific schema on device using operation foo v1 XSD The NETCONF server returns the XML schema (XSD). ]]> 3.2. NETCONF Schema List Retrieval ( monitoring data) A NETCONF client retrieves the list of supported XML Schema from a NETCONF server using the RPC request. The list of available XML Schema is retrieved by requesting the subtree via a operation. Available schema for the requesting session are Scott, et al. Expires May 7, 2009 [Page 11] Internet-Draft NETCONF Monitoring Schema November 2008 returned in the reply containing the , and elements. Since the same schema may be supported in multiple locations and/or have multiple versions and/or multiple formats no particular attribute is unique. An empty reply is returned if there are no available schema. The response data can be used to determine the available schema and their versions. The schema itself (ie. schema content) is not returned in the response. The details returned in the list SHOULD facilitate retrieval from a network location via a URL using a supported mechanism on the device such as ftp or http.i Additionally the ability to retrieve a schema via NETCONF SHOULD be supported. When a schema is available on the device and the schema- retrieval capability is supported by the NETCONF server a location value of 'NETCONF' MUST be used to indicate that it can be retrieved via NETCONF using the RPC described in section 3.1. Scott, et al. Expires May 7, 2009 [Page 12] Internet-Draft NETCONF Monitoring Schema November 2008 4. Examples 4.1. Retrieving schema list via The NETCONF server returns a list of data models available for retrieval. Scott, et al. Expires May 7, 2009 [Page 13] Internet-Draft NETCONF Monitoring Schema November 2008 foo 1.0 XSD http://example.com/foo ftp://ftp.example.com/schemas/foo_1.0.xsd http://www.example.com/schema/foo_1.0.xsd NETCONF foo 1.1 XSD http://example.com/foo ftp://ftp.example.com/schemas/foo_1.1.xsd http://www.example.com/schema/foo_1.1.xsd NETCONF bar 2008-06-01 YANG http://example.com/bar http://example.com/schema/bar-2008-06-01.yang NETCONF bar-types 2008-06-01 YANG http://example.com/bar http://example.com/schema/bar-types-2008-06-01.yang NETCONF Scott, et al. Expires May 7, 2009 [Page 14] Internet-Draft NETCONF Monitoring Schema November 2008 4.2. Retrieving schema instances Given the reply in the previous section, the following examples illustrate the availability of 'foo', 'bar', and 'bar-types' schema at multiple locations, with multiple formats, and in multiple locations. 1. foo, version 1.0 in XSD format: a. Via FTP using location ftp://ftp.example.com/schemas/foo_1.0.xsd b. Via HTTP using location http://www.example.com/schema/foo/1.0.xsd c. Via using identifier, version, and format parameters. foo 1.0 XSD 2. bar, version 2008-06-01 in YANG format: a. Via HTTP using location http://example.com/schema/bar-2008-06-01.yang b. Via using identifer, version, and format parameters: bar 2008-06-01 YANG 3. bar-types, version 2008-06-01 in YANG format: Scott, et al. Expires May 7, 2009 [Page 15] Internet-Draft NETCONF Monitoring Schema November 2008 a. Via using identifer, version, and format parameters: bar-types 2008-06-01 YANG Scott, et al. Expires May 7, 2009 [Page 16] Internet-Draft NETCONF Monitoring Schema November 2008 5. XSD Schema 5.1. NETCONF Monitoring Schema The data model described in this memo is defined in the following XSD. The list of currently provided NETCONF capabilities. This may be different than those exchanged during session setup (i.e. hello). Scott, et al. Expires May 7, 2009 [Page 17] Internet-Draft NETCONF Monitoring Schema November 2008 Contains the NETCONF configurations data storesavailable on the device. Contains the list of supported schemas on the device. I.e. NETCONF data models, interface descriptions, etc. Contains the details on active sessions on the device. Covers both NETCONF and non-NETCONF management sessions. Contains the details on active event stream Scott, et al. Expires May 7, 2009 [Page 18] Internet-Draft NETCONF Monitoring Schema November 2008 subscriptions. Includes active replay streams, if supported. Contains management metrics for the NETCONF server. Contains information on the datastores available on the NETCONF server including locks. enumeration of supported datastores; candidate, running, startup An indication of whether a resource is locked or unlocked. If locked, additional information about the locking such as user an time stamp is provided. Scott, et al. Expires May 7, 2009 [Page 19] Internet-Draft NETCONF Monitoring Schema November 2008 Present if a global lock is set. Present if at least one partial lock is set. Contains the information used to describe the schema. Identifier to uniquely reference the schema. Version of the schema supported. Multiple versions can be supported simultaneously. Scott, et al. Expires May 7, 2009 [Page 20] Internet-Draft NETCONF Monitoring Schema November 2008 Schema language for the file/module. Eg: XSD, YANG, RNG. The XML namespace defined by the data model. A location from which the schema can be retrieved. Can be either on the network device retrievable explicitly via the get-schema netconf operation (denoted by the value 'NETCONF') or some network location (i.e. URL). Contains information related to managment sessions on the device. Scott, et al. Expires May 7, 2009 [Page 21] Internet-Draft NETCONF Monitoring Schema November 2008 Unique identifier for the session instance. Identifies the transport for each session, e.g. "Console", "SSH". Identifies the protocol being used for each session, e.g. "NETCONF", "CLI", "WebUI". Session owner. Client for the session. Time at which the session was established. Scott, et al. Expires May 7, 2009 [Page 22] Internet-Draft NETCONF Monitoring Schema November 2008 Contains information on the active subscriptions on the NETCONF server. Subscriptions which have ended are not reported. Contains management statistics for the NETCONF server. Date and time at which the NETCONF server process was started. Allows for calculation of time interval for reported metrics. The total number of NETCONF sessions started towards the NETCONF peer. inSessions - inBadHellos = 'number of correctly started netconf sessions' Scott, et al. Expires May 7, 2009 [Page 23] Internet-Draft NETCONF Monitoring Schema November 2008 The total number of messages that were unparsable and thus ignored. This covers both unparsable 'hello' and 'rpc' messages. The total number of sessions silently dropped because an invalid 'hello' message was received. This includes hello messages with a 'session-id' attribute, bad namespace, and bad capability declarations. The total number of rpc requests received. The total number of rpcs which were parsed correctly, but couldn't be serviced because they contained non-conformant XML, e.g. missing a mandatory parameter. The total number of rpcs which were parsed correctly, but couldn't be serviced because they were not supported by the agent. The total number of 'rpc-reply' messages sent. Scott, et al. Expires May 7, 2009 [Page 24] Internet-Draft NETCONF Monitoring Schema November 2008 The total number of 'rpc-reply' messages with 'rpc-error' sent. The total number of 'notification' messages sent. Enumeration of possible NETCONF datastore types. The session Id which holds the lock. Date and Time the lock was acquired. Scott, et al. Expires May 7, 2009 [Page 25] Internet-Draft NETCONF Monitoring Schema November 2008 For a partial lock this provides the lock id. The session Id which holds the lock. Date and Time the lock was acquired. The xpath expression which was used to request the lock. The list of instance-identifiers (i.e. the locked nodes). Scott, et al. Expires May 7, 2009 [Page 26] Internet-Draft NETCONF Monitoring Schema November 2008 Format of the schema. Transport choices. Protocol choices. RPC definition: <get-schema> Scott, et al. Expires May 7, 2009 [Page 27] Internet-Draft NETCONF Monitoring Schema November 2008 5.2. inet:host schema The complex type ManagementSession contains element sourceHost of type inet:host. The following schema defines the referenced type. The ipAddress type represents an IP address and is IP version neutral. The format of the textual representations implies the IP version. Scott, et al. Expires May 7, 2009 [Page 28] Internet-Draft NETCONF Monitoring Schema November 2008 The ipv4Address type represents an IPv4 address in dotted-quad notation. The IPv4 address may include a zone index, separated by a % sign. The ipv6Address type represents an IPv6 address in full, mixed, shortened and shortened mixed notation. The IPv6 address may include a zone index, separated by a % sign. Scott, et al. Expires May 7, 2009 [Page 29] Internet-Draft NETCONF Monitoring Schema November 2008 The domainName type represents a DNS domain name. The name SHOULD be fully qualified whenever possible. The description clause of objects using the domainName type MUST describe how (and when) these names are resolved to IP addresses. Note that the resolution of a domainName value may require to query multiple DNS records (e.g., A for IPv4 and AAAA for IPv6). The order of the resolution process and which DNS record takes precedence depends on the configuration of the resolver. The host type represents either an IP address or a DNS domain name. Scott, et al. Expires May 7, 2009 [Page 30] Internet-Draft NETCONF Monitoring Schema November 2008 6. Security Considerations The NETCONF monitoring schema as defined in this document provides information about a 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, et al. Expires May 7, 2009 [Page 31] Internet-Draft NETCONF Monitoring Schema November 2008 7. Acknowledgements Thanks to the NETCONF working group for providing a much earlier draft of Schema to manage NETCONF and NETCONF Notifications that were cannibalized to produce this draft. Scott, et al. Expires May 7, 2009 [Page 32] Internet-Draft NETCONF Monitoring Schema November 2008 8. IANA Considerations This document will require new URIs for the NETCONF XML namespace in the IETF XML registry [RFC3688]. Following the format in RFC 3688, the following registrations require consideration. +----------------------+----------------------------------------------+ | Index | Capability Identifier | +----------------------+----------------------------------------------+ | :netconf-monitoring | urn:ietf:params:netconf:capability: | | | netconf-monitoring:1.0 | | | | | :schema-retrieval | urn:ietf:params:netconf:capability: | | | schema-retrieval:1.0 | +----------------------+----------------------------------------------+ Note, the proposed capability URNs are also compliant to section 10.3 of NETCONF [RFC4741]. Scott, et al. Expires May 7, 2009 [Page 33] Internet-Draft NETCONF Monitoring Schema November 2008 9. 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-notification-14, June 2008. [RFC2119] Bradner, s., "Key words for RFCs to Indicate Requirements Levels", RFC 2119, March 1997. [XML] World Wide Web Consortium, "Extensible Markup Language (XML) 1.0", W3C XML, February 1998, . [XMLSchema] Fallside, D. and P. Walmsley, "XML Schema Part 0: Primer Second Edition", W3C XML Schema, October 2004. [draft-ietf-netconf-partial-lock-04] Lengyel, Balazs., "Partial Lock RPC for NETCONF", October 2008. Scott, et al. Expires May 7, 2009 [Page 34] Internet-Draft NETCONF Monitoring Schema November 2008 Appendix A. YANG module (non-normative) The following YANG module is included as a reference only. It is based on YANG definition at the time of publishing and is subject to change as a result of netmod work underway to refine YANG. Further details on YANG and updated non-normative reference to this model are available at: http://www.yang-central.org/twiki/bin/view/Main/YangExamples. module netconf-state { namespace "urn:ietf:params:xml:ns:netconf:state"; prefix "ns"; import yang-types { prefix yang; } import inet-types { prefix inet; } organization "IETF"; description "NETCONF Monitoring Module. All elements in this module are read-only."; revision "2008-11-03" { description "Initial revision."; } typedef SessionId { type uint32 { range "1..max"; } reference "rfc4741"; } grouping NETCONFDatastoreType { description "Enumeration of possible NETCONF datastore types."; reference "rfc4741"; choice datastore { mandatory true; leaf running { type empty; } leaf candidate { type empty; } Scott, et al. Expires May 7, 2009 [Page 35] Internet-Draft NETCONF Monitoring Schema November 2008 leaf startup { type empty; } } } typedef TransportType { type enumeration { enum "SSH"; enum "SSL"; enum "Console"; enum "HTTP"; enum "HTTPS"; } } typedef ProtocolType { type enumeration { enum "CLI"; enum "NETCONF"; enum "WebUI"; } } typedef SchemaFormat { type enumeration { enum "XSD" { reference "W3C REC REC-xmlschema-1-20041028"; } enum "YANG" { reference "draft-ietf-netmod-yang"; } enum "RNG" { reference "ISO/IEC 19757-2"; } } } container netconf { config false; container capabilities { description "The list of currently provided NETCONF capabilities. This may be different than those exchanged during session setup (i.e. hello)."; leaf-list capability { type inet:uri; Scott, et al. Expires May 7, 2009 [Page 36] Internet-Draft NETCONF Monitoring Schema November 2008 min-elements 1; } } container configurations { description "List of NETCONF configuration datastores (e.g. running, startup, candidate) supported on this device and related information."; list configuration { container name { uses NETCONFDatastoreType; } container locks { description "An indication of whether a resource is locked or unlocked. If locked, additional information about the locking such as user an time stamp is provided."; grouping LockInfo { leaf lockedBySession { type SessionId; description "The session ID of the session that has locked this resource."; } leaf lockedTime { type yang:date-and-time; description "The date and time of when the resource was locked."; } } choice lockType { container globalLock { description "Present if the global lock is set."; uses LockInfo; } list partialLocks { key lockId; description "Present if at least one partial lock is set."; leaf lockId { type uint32; } Scott, et al. Expires May 7, 2009 [Page 37] Internet-Draft NETCONF Monitoring Schema November 2008 uses LockInfo; leaf-list select { type string; min-elements 1; description "The xpath expression which was used to request the lock."; } leaf-list lockedNodes { type instance-identifier; description "The list of instance-identifiers (i.e. the locked nodes)."; } } } } } } container schemas { list schema { key "identifier format version"; leaf identifier { type string; description "Identifier to uniquely reference the schema"; } leaf version { type string; description "Version of the schema supported. Multiple versions can be supported simultaneously."; } leaf format { type SchemaFormat; description "Schema language for the file/module."; } leaf namespace { type inet:uri; description "The XML namespace defined by the data model."; } leaf location { type union { type enumeration { enum "NETCONF"; Scott, et al. Expires May 7, 2009 [Page 38] Internet-Draft NETCONF Monitoring Schema November 2008 } type inet:uri; } description "A location from which the schema can be retrieved. Can be either on the network device retrievable explicitly via the get-schema netconf operation (denoted by the value 'NETCONF') or some network location (i.e. URL)."; } } } container sessions { description "List of NETCONF sessions currently active on this device."; list session { key sessionId; leaf sessionId { type SessionId; } leaf transport { type TransportType; } leaf protocol { type ProtocolType; } leaf username { type string; } leaf sourceHost { type inet:host; } leaf loginTime { type yang:date-and-time; description "Time at which the session was established."; } } } container subscriptions { description "Contains information on the active subscriptions on the NETCONF server. Subscriptions which have ended are not reported."; list subscription { key sessionId; description Scott, et al. Expires May 7, 2009 [Page 39] Internet-Draft NETCONF Monitoring Schema November 2008 "Information about Netconf Notification Subscriptions."; leaf sessionId { type SessionId; description "The session id associated with this subscription."; } leaf stream { type string; description "The stream associated with this subscription."; } anyxml filter { description "The filters associated with this subscription."; } leaf startTime { type yang:date-and-time; description "The startTime parameter from the create-subscription invokation, if it was present."; } leaf stopTime { type yang:date-and-time; description "The stopTime parameter from the create-subscription invokation, if it was present."; } leaf messagesSent { type yang:zero-based-counter32; description "A count of event notifications sent along this connection since the subscription was created."; } } } container statistics { leaf netconfStartTime { type yang:date-and-time; description "Date and time at which the NETCONF server process was started. Allows for calculation of time interval for reported metrics."; } leaf inSessions { type yang:zero-based-counter32; description Scott, et al. Expires May 7, 2009 [Page 40] Internet-Draft NETCONF Monitoring Schema November 2008 "The total number of NETCONF sessions started towards the NETCONF peer. inSessions - inBadHellos = 'number of correctly started netconf sessions'"; } leaf inXMLParseErrors { type yang:zero-based-counter32; description "The total number of messages that were unparsable and thus ignored. This covers both unparsable 'hello' and 'rpc' messages."; } leaf inBadHellos { type yang:zero-based-counter32; description "The total number of sessions silently dropped because an invalid 'hello' message was received. This includes hello messages with a 'session-id' attribute, bad namespace, and bad capability declarations."; } leaf inRpcs { type yang:zero-based-counter32; description "The total number of rpc requests received."; } leaf inBadRpcs { type yang:zero-based-counter32; description "The total number of rpcs which were parsed correctly, but couldn't be serviced because they contained non-conformant XML, e.g. missing a mandatory parameter."; } leaf inNotSupportedRpcs { type yang:zero-based-counter32; description "The total number of rpcs which were parsed correctly, but couldn't be serviced because they were not supported by the agent."; } leaf outRpcReplies { type yang:zero-based-counter32; description "The total number of 'rpc-reply' messages sent."; } leaf outRpcErrors { type yang:zero-based-counter32; description Scott, et al. Expires May 7, 2009 [Page 41] Internet-Draft NETCONF Monitoring Schema November 2008 "The total number of 'rpc-reply' messages with 'rpc-error' sent."; } leaf outNotifications { type yang:zero-based-counter32; description "The total number of 'notifications' messages sent."; } } } rpc get-schema { input { leaf identifier { type string; mandatory true; } leaf version { type string; mandatory true; } leaf format { type SchemaFormat; mandatory true; } } output { anyxml data { description "Contains the schema content."; } } } } Scott, et al. Expires May 7, 2009 [Page 42] Internet-Draft NETCONF Monitoring Schema November 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 Martin Bjorklund Tail-f Systems Klara Norra Kyrkogata 31 SE-111 22 Stockholm, Sweden Email: mbj@tail-f.com Scott, et al. Expires May 7, 2009 [Page 43] Internet-Draft NETCONF Monitoring Schema November 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, et al. Expires May 7, 2009 [Page 44]