1 module ietf-netconf-monitoring {
6 "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring";
10 import ietf-yang-types {
12 revision-date "2013-07-15";
15 import ietf-inet-types {
17 revision-date "2013-07-15";
21 "IETF NETCONF (Network Configuration) Working Group";
24 "WG Web: <http://tools.ietf.org/wg/netconf/>
25 WG List: <mailto:netconf@ietf.org>
27 WG Chair: Mehmet Ersue
28 <mailto:mehmet.ersue@nsn.com>
31 <mailto:bertietf@bwijnen.net>
34 <mailto:mark.scott@ericsson.com>
36 Editor: Martin Bjorklund
37 <mailto:mbj@tail-f.com>";
40 "NETCONF Monitoring Module.
41 All elements in this module are read-only.
43 Copyright (c) 2010 IETF Trust and the persons identified as
44 authors of the code. All rights reserved.
46 Redistribution and use in source and binary forms, with or
47 without modification, is permitted pursuant to, and subject
48 to the license terms contained in, the Simplified BSD
49 License set forth in Section 4.c of the IETF Trust's
50 Legal Provisions Relating to IETF Documents
51 (http://trustee.ietf.org/license-info).
53 This version of this YANG module is part of RFC 6022; see
54 the RFC itself for full legal notices.";
56 revision "2010-10-04" {
57 description "Initial revision.";
59 "RFC 6022: YANG Module for NETCONF Monitoring";
64 typedef netconf-datastore-type {
77 "Enumeration of possible NETCONF datastore types.";
79 "RFC 4741: NETCONF Configuration Protocol";
85 "Base identity for NETCONF transport types.";
88 identity netconf-ssh {
91 "NETCONF over Secure Shell (SSH).";
93 "RFC 4742: Using the NETCONF Configuration Protocol
94 over Secure SHell (SSH)";
98 identity netconf-soap-over-beep {
101 "NETCONF over Simple Object Access Protocol (SOAP) over
102 Blocks Extensible Exchange Protocol (BEEP).";
104 "RFC 4743: Using NETCONF over the Simple Object
105 Access Protocol (SOAP)";
109 identity netconf-soap-over-https {
112 "NETCONF over Simple Object Access Protocol (SOAP)
113 over Hypertext Transfer Protocol Secure (HTTPS).";
115 "RFC 4743: Using NETCONF over the Simple Object
116 Access Protocol (SOAP)";
120 identity netconf-beep {
123 "NETCONF over Blocks Extensible Exchange Protocol (BEEP).";
125 "RFC 4744: Using the NETCONF Protocol over the
126 Blocks Extensible Exchange Protocol (BEEP)";
130 identity netconf-tls {
133 "NETCONF over Transport Layer Security (TLS).";
135 "RFC 5539: NETCONF over Transport Layer Security (TLS)";
139 identity schema-format {
141 "Base identity for data model schema languages.";
147 "W3C XML Schema Definition.";
149 "W3C REC REC-xmlschema-1-20041028:
150 XML Schema Part 1: Structures";
157 "The YANG data modeling language for NETCONF.";
159 "RFC 6020: YANG - A Data Modeling Language for the
160 Network Configuration Protocol (NETCONF)";
166 description "The YIN syntax for YANG.";
168 "RFC 6020: YANG - A Data Modeling Language for the
169 Network Configuration Protocol (NETCONF)";
176 "Regular Language for XML Next Generation (RELAX NG).";
178 "ISO/IEC 19757-2:2008: RELAX NG";
184 description "Relax NG Compact Syntax";
186 "ISO/IEC 19757-2:2008: RELAX NG";
190 grouping common-counters {
192 "Counters that exist both per session, and also globally,
193 accumulated from all sessions.";
195 type yang:zero-based-counter32;
197 "Number of correct <rpc> messages received.";
201 type yang:zero-based-counter32;
203 "Number of messages received when an <rpc> message was expected,
204 that were not correct <rpc> messages. This includes XML parse
205 errors and errors on the rpc layer.";
208 leaf out-rpc-errors {
209 type yang:zero-based-counter32;
211 "Number of <rpc-reply> messages sent that contained an
212 <rpc-error> element.";
215 leaf out-notifications {
216 type yang:zero-based-counter32;
218 "Number of <notification> messages sent.";
220 } // grouping common-counters
222 container netconf-state {
225 "The netconf-state container is the root of the monitoring
227 container capabilities {
229 "Contains the list of NETCONF capabilities supported by the
231 leaf-list capability {
234 "List of NETCONF capabilities supported by the server.";
236 } // container capabilities
238 container datastores {
240 "Contains the list of NETCONF configuration datastores.";
244 "List of NETCONF configuration datastores supported by
245 the NETCONF server and related information.";
247 type netconf-datastore-type;
249 "Name of the datastore associated with this list entry.";
254 "This container is present only if the datastore
257 "The NETCONF <lock> and <partial-lock> operations allow
258 a client to lock specific resources in a datastore. The
259 NETCONF server will prevent changes to the locked
260 resources by all sessions except the one that acquired
263 Monitoring information is provided for each datastore
264 entry including details such as the session that acquired
265 the lock, the type of lock (global or partial) and the
266 list of locked resources. Multiple locks per datastore
270 "Lock related parameters, common to both global and
272 leaf locked-by-session {
276 "The session ID of the session that has locked
277 this resource. Both a global lock and a partial
278 lock MUST contain the NETCONF session-id.
280 If the lock is held by a session that is not managed
281 by the NETCONF server (e.g., a CLI session), a session
282 id of 0 (zero) is reported.";
284 "RFC 4741: NETCONF Configuration Protocol";
289 type yang:date-and-time;
292 "The date and time of when the resource was
295 } // grouping lock-info
298 "Indicates if a global lock or a set of partial locks
300 container global-lock {
302 "Present if the global lock is set.";
304 } // container global-lock
308 "List of partial locks.";
310 "RFC 5717: Partial Lock Remote Procedure Call (RPC) for
316 "This is the lock id returned in the <partial-lock>
326 "The xpath expression that was used to request
327 the lock. The select expression indicates the
328 original intended scope of the lock.";
331 leaf-list locked-node {
332 type instance-identifier;
334 "The list of instance-identifiers (i.e., the
337 The scope of the partial lock is defined by the list
340 } // list partial-lock
341 } // choice lock-type
344 } // container datastores
348 "Contains the list of data model schemas supported by the
351 key "identifier version format";
353 "List of data model schemas supported by the server.";
357 "Identifier to uniquely reference the schema. The
358 identifier is used in the <get-schema> operation and may
359 be used for other purposes such as file retrieval.
361 For modeling languages that support or require a data
362 model name (e.g., YANG module name) the identifier MUST
363 match that name. For YANG data models, the identifier is
364 the name of the module or submodule. In other cases, an
365 identifier such as a filename MAY be used instead.";
371 "Version of the schema supported. Multiple versions MAY be
372 supported simultaneously by a NETCONF server. Each
373 version MUST be reported individually in the schema list,
374 i.e., with same identifier, possibly different location,
375 but different version.
377 For YANG data models, version is the value of the most
378 recent YANG 'revision' statement in the module or
379 submodule, or the empty string if no 'revision' statement
388 "The data modeling language the schema is written
389 in (currently xsd, yang, yin, rng, or rnc).
390 For YANG data models, 'yang' format MUST be supported and
391 'yin' format MAY also be provided.";
398 "The XML namespace defined by the data model.
400 For YANG data models, this is the module's namespace.
401 If the list entry describes a submodule, this field
402 contains the namespace of the module to which the
416 "One or more locations from which the schema can be
417 retrieved. This list SHOULD contain at least one
420 A schema entry may be located on a remote file system
421 (e.g., reference to file system for ftp retrieval) or
422 retrieved directly from a server supporting the
423 <get-schema> operation (denoted by the value 'NETCONF').";
426 } // container schemas
430 "The sessions container includes session-specific data for
431 NETCONF management sessions. The session list MUST include
432 all currently active NETCONF sessions.";
436 "All NETCONF sessions managed by the NETCONF server
437 MUST be reported in this list.";
443 "Unique identifier for the session. This value is the
444 NETCONF session identifier, as defined in RFC 4741.";
446 "RFC 4741: NETCONF Configuration Protocol";
456 "Identifies the transport for each session, e.g.,
457 'netconf-ssh', 'netconf-soap', etc.";
464 "The username is the client identity that was authenticated
465 by the NETCONF transport protocol. The algorithm used to
466 derive the username is NETCONF transport protocol specific
467 and in addition specific to the authentication mechanism
468 used by the NETCONF transport protocol.";
474 "Host identifier of the NETCONF client. The value
475 returned is implementation specific (e.g., hostname,
476 IPv4 address, IPv6 address)";
480 type yang:date-and-time;
483 "Time at the server at which the session was established.";
486 uses common-counters {
488 "Per-session counters. Zero based with following reset
490 - at start of a session
491 - when max value is reached";
494 } // container sessions
496 container statistics {
498 "Statistical data pertaining to the NETCONF server.";
499 leaf netconf-start-time {
500 type yang:date-and-time;
502 "Date and time at which the management subsystem was
507 type yang:zero-based-counter32;
509 "Number of sessions silently dropped because an
510 invalid <hello> message was received. This includes <hello>
511 messages with a 'session-id' attribute, bad namespace, and
512 bad capability declarations.";
516 type yang:zero-based-counter32;
518 "Number of sessions started. This counter is incremented
519 when a <hello> message with a <session-id> is sent.
521 'in-sessions' - 'in-bad-hellos' =
522 'number of correctly started netconf sessions'";
525 leaf dropped-sessions {
526 type yang:zero-based-counter32;
528 "Number of sessions that were abnormally terminated, e.g.,
529 due to idle timeout or transport close. This counter is not
530 incremented when a session is properly closed by a
531 <close-session> operation, or killed by a <kill-session>
535 uses common-counters {
537 "Global counters, accumulated from all sessions.
538 Zero based with following reset behaviour:
539 - re-initialization of NETCONF server
540 - when max value is reached";
542 } // container statistics
543 } // container netconf-state
547 "This operation is used to retrieve a schema from the
551 The NETCONF server returns the requested schema.
554 If requested schema does not exist, the <error-tag> is
557 If more than one schema matches the requested parameters, the
558 <error-tag> is 'operation-failed', and <error-app-tag> is
565 "Identifier for the schema list entry.";
571 "Version of the schema requested. If this parameter is not
572 present, and more than one version of the schema exists on
573 the server, a 'data-not-unique' error is returned, as
582 "The data modeling language of the schema. If this
583 parameter is not present, and more than one formats of
584 the schema exists on the server, a 'data-not-unique' error
585 is returned, as described above.";
592 "Contains the schema content.";