1 module ietf-netconf-monitoring {
3 namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring";
6 import ietf-yang-types { prefix yang; }
7 import ietf-inet-types { prefix inet; }
10 "IETF NETCONF (Network Configuration) Working Group";
13 "WG Web: <http://tools.ietf.org/wg/netconf/>
14 WG List: <mailto:netconf@ietf.org>
16 WG Chair: Mehmet Ersue
17 <mailto:mehmet.ersue@nsn.com>
20 <mailto:bertietf@bwijnen.net>
23 <mailto:mark.scott@ericsson.com>
25 Editor: Martin Bjorklund
26 <mailto:mbj@tail-f.com>";
29 "NETCONF Monitoring Module.
30 All elements in this module are read-only.
32 Copyright (c) 2010 IETF Trust and the persons identified as
33 authors of the code. All rights reserved.
35 Redistribution and use in source and binary forms, with or
36 without modification, is permitted pursuant to, and subject
37 to the license terms contained in, the Simplified BSD
38 License set forth in Section 4.c of the IETF Trust's
39 Legal Provisions Relating to IETF Documents
40 (http://trustee.ietf.org/license-info).
42 This version of this YANG module is part of RFC 6022; see
43 the RFC itself for full legal notices.";
49 "RFC 6022: YANG Module for NETCONF Monitoring";
52 typedef netconf-datastore-type {
59 "Enumeration of possible NETCONF datastore types.";
61 "RFC 4741: NETCONF Configuration Protocol";
66 "Base identity for NETCONF transport types.";
69 identity netconf-ssh {
72 "NETCONF over Secure Shell (SSH).";
74 "RFC 4742: Using the NETCONF Configuration Protocol
75 over Secure SHell (SSH)";
78 identity netconf-soap-over-beep {
81 "NETCONF over Simple Object Access Protocol (SOAP) over
82 Blocks Extensible Exchange Protocol (BEEP).";
84 "RFC 4743: Using NETCONF over the Simple Object
85 Access Protocol (SOAP)";
88 identity netconf-soap-over-https {
91 "NETCONF over Simple Object Access Protocol (SOAP)
92 over Hypertext Transfer Protocol Secure (HTTPS).";
94 "RFC 4743: Using NETCONF over the Simple Object
95 Access Protocol (SOAP)";
98 identity netconf-beep {
101 "NETCONF over Blocks Extensible Exchange Protocol (BEEP).";
103 "RFC 4744: Using the NETCONF Protocol over the
104 Blocks Extensible Exchange Protocol (BEEP)";
107 identity netconf-tls {
110 "NETCONF over Transport Layer Security (TLS).";
112 "RFC 5539: NETCONF over Transport Layer Security (TLS)";
115 identity schema-format {
117 "Base identity for data model schema languages.";
123 "W3C XML Schema Definition.";
125 "W3C REC REC-xmlschema-1-20041028:
126 XML Schema Part 1: Structures";
132 "The YANG data modeling language for NETCONF.";
134 "RFC 6020: YANG - A Data Modeling Language for the
135 Network Configuration Protocol (NETCONF)";
141 "The YIN syntax for YANG.";
143 "RFC 6020: YANG - A Data Modeling Language for the
144 Network Configuration Protocol (NETCONF)";
150 "Regular Language for XML Next Generation (RELAX NG).";
152 "ISO/IEC 19757-2:2008: RELAX NG";
158 "Relax NG Compact Syntax";
160 "ISO/IEC 19757-2:2008: RELAX NG";
163 grouping common-counters {
165 "Counters that exist both per session, and also globally,
166 accumulated from all sessions.";
169 type yang:zero-based-counter32;
171 "Number of correct <rpc> messages received.";
174 type yang:zero-based-counter32;
176 "Number of messages received when an <rpc> message was expected,
177 that were not correct <rpc> messages. This includes XML parse
178 errors and errors on the rpc layer.";
180 leaf out-rpc-errors {
181 type yang:zero-based-counter32;
183 "Number of <rpc-reply> messages sent that contained an
184 <rpc-error> element.";
186 leaf out-notifications {
187 type yang:zero-based-counter32;
189 "Number of <notification> messages sent.";
193 container netconf-state {
196 "The netconf-state container is the root of the monitoring
199 container capabilities {
201 "Contains the list of NETCONF capabilities supported by the
204 leaf-list capability {
207 "List of NETCONF capabilities supported by the server.";
211 container datastores {
213 "Contains the list of NETCONF configuration datastores.";
218 "List of NETCONF configuration datastores supported by
219 the NETCONF server and related information.";
222 type netconf-datastore-type;
224 "Name of the datastore associated with this list entry.";
228 "This container is present only if the datastore
231 "The NETCONF <lock> and <partial-lock> operations allow
232 a client to lock specific resources in a datastore. The
233 NETCONF server will prevent changes to the locked
234 resources by all sessions except the one that acquired
237 Monitoring information is provided for each datastore
238 entry including details such as the session that acquired
239 the lock, the type of lock (global or partial) and the
240 list of locked resources. Multiple locks per datastore
245 "Lock related parameters, common to both global and
248 leaf locked-by-session {
252 "The session ID of the session that has locked
253 this resource. Both a global lock and a partial
254 lock MUST contain the NETCONF session-id.
256 If the lock is held by a session that is not managed
257 by the NETCONF server (e.g., a CLI session), a session
258 id of 0 (zero) is reported.";
260 "RFC 4741: NETCONF Configuration Protocol";
263 type yang:date-and-time;
266 "The date and time of when the resource was
273 "Indicates if a global lock or a set of partial locks
276 container global-lock {
278 "Present if the global lock is set.";
285 "List of partial locks.";
287 "RFC 5717: Partial Lock Remote Procedure Call (RPC) for
293 "This is the lock id returned in the <partial-lock>
301 "The xpath expression that was used to request
302 the lock. The select expression indicates the
303 original intended scope of the lock.";
305 leaf-list locked-node {
306 type instance-identifier;
308 "The list of instance-identifiers (i.e., the
311 The scope of the partial lock is defined by the list
322 "Contains the list of data model schemas supported by the
326 key "identifier version format";
329 "List of data model schemas supported by the server.";
334 "Identifier to uniquely reference the schema. The
335 identifier is used in the <get-schema> operation and may
336 be used for other purposes such as file retrieval.
338 For modeling languages that support or require a data
339 model name (e.g., YANG module name) the identifier MUST
340 match that name. For YANG data models, the identifier is
341 the name of the module or submodule. In other cases, an
342 identifier such as a filename MAY be used instead.";
347 "Version of the schema supported. Multiple versions MAY be
348 supported simultaneously by a NETCONF server. Each
349 version MUST be reported individually in the schema list,
350 i.e., with same identifier, possibly different location,
351 but different version.
353 For YANG data models, version is the value of the most
354 recent YANG 'revision' statement in the module or
355 submodule, or the empty string if no 'revision' statement
363 "The data modeling language the schema is written
364 in (currently xsd, yang, yin, rng, or rnc).
365 For YANG data models, 'yang' format MUST be supported and
366 'yin' format MAY also be provided.";
372 "The XML namespace defined by the data model.
374 For YANG data models, this is the module's namespace.
375 If the list entry describes a submodule, this field
376 contains the namespace of the module to which the
387 "One or more locations from which the schema can be
388 retrieved. This list SHOULD contain at least one
391 A schema entry may be located on a remote file system
392 (e.g., reference to file system for ftp retrieval) or
393 retrieved directly from a server supporting the
394 <get-schema> operation (denoted by the value 'NETCONF').";
401 "The sessions container includes session-specific data for
402 NETCONF management sessions. The session list MUST include
403 all currently active NETCONF sessions.";
408 "All NETCONF sessions managed by the NETCONF server
409 MUST be reported in this list.";
416 "Unique identifier for the session. This value is the
417 NETCONF session identifier, as defined in RFC 4741.";
419 "RFC 4741: NETCONF Configuration Protocol";
427 "Identifies the transport for each session, e.g.,
428 'netconf-ssh', 'netconf-soap', etc.";
434 "The username is the client identity that was authenticated
435 by the NETCONF transport protocol. The algorithm used to
436 derive the username is NETCONF transport protocol specific
437 and in addition specific to the authentication mechanism
438 used by the NETCONF transport protocol.";
443 "Host identifier of the NETCONF client. The value
444 returned is implementation specific (e.g., hostname,
445 IPv4 address, IPv6 address)";
448 type yang:date-and-time;
451 "Time at the server at which the session was established.";
453 uses common-counters {
455 "Per-session counters. Zero based with following reset
457 - at start of a session
458 - when max value is reached";
463 container statistics {
465 "Statistical data pertaining to the NETCONF server.";
467 leaf netconf-start-time {
468 type yang:date-and-time;
470 "Date and time at which the management subsystem was
474 type yang:zero-based-counter32;
476 "Number of sessions silently dropped because an
477 invalid <hello> message was received. This includes <hello>
478 messages with a 'session-id' attribute, bad namespace, and
479 bad capability declarations.";
482 type yang:zero-based-counter32;
484 "Number of sessions started. This counter is incremented
485 when a <hello> message with a <session-id> is sent.
487 'in-sessions' - 'in-bad-hellos' =
488 'number of correctly started netconf sessions'";
490 leaf dropped-sessions {
491 type yang:zero-based-counter32;
493 "Number of sessions that were abnormally terminated, e.g.,
494 due to idle timeout or transport close. This counter is not
495 incremented when a session is properly closed by a
496 <close-session> operation, or killed by a <kill-session>
499 uses common-counters {
501 "Global counters, accumulated from all sessions.
502 Zero based with following reset behaviour:
503 - re-initialization of NETCONF server
504 - when max value is reached";
511 "This operation is used to retrieve a schema from the
515 The NETCONF server returns the requested schema.
518 If requested schema does not exist, the <error-tag> is
521 If more than one schema matches the requested parameters, the
522 <error-tag> is 'operation-failed', and <error-app-tag> is
530 "Identifier for the schema list entry.";
535 "Version of the schema requested. If this parameter is not
536 present, and more than one version of the schema exists on
537 the server, a 'data-not-unique' error is returned, as
545 "The data modeling language of the schema. If this
546 parameter is not present, and more than one formats of
547 the schema exists on the server, a 'data-not-unique' error
548 is returned, as described above.";
554 "Contains the schema content.";