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>
15 WG Chair: Mehmet Ersue
16 <mailto:mehmet.ersue@nsn.com>
18 <mailto:bertietf@bwijnen.net>
20 <mailto:mark.scott@ericsson.com>
21 Editor: Martin Bjorklund
22 <mailto:mbj@tail-f.com>";
25 "NETCONF Monitoring Module.
26 All elements in this module are read-only.
27 Copyright (c) 2010 IETF Trust and the persons identified as
28 authors of the code. All rights reserved.
29 Redistribution and use in source and binary forms, with or
30 without modification, is permitted pursuant to, and subject
31 to the license terms contained in, the Simplified BSD
32 License set forth in Section 4.c of the IETF Trust's
33 Legal Provisions Relating to IETF Documents
34 (http://trustee.ietf.org/license-info).
35 This version of this YANG module is part of RFC 6022; see
36 the RFC itself for full legal notices.";
42 "RFC 6022: YANG Module for NETCONF Monitoring";
45 typedef netconf-datastore-type {
52 "Enumeration of possible NETCONF datastore types.";
54 "RFC 4741: NETCONF Configuration Protocol";
59 "Base identity for NETCONF transport types.";
62 identity netconf-ssh {
65 "NETCONF over Secure Shell (SSH).";
67 "RFC 4742: Using the NETCONF Configuration Protocol
68 over Secure SHell (SSH)";
71 identity netconf-soap-over-beep {
74 "NETCONF over Simple Object Access Protocol (SOAP) over
75 Blocks Extensible Exchange Protocol (BEEP).";
78 "RFC 4743: Using NETCONF over the Simple Object
79 Access Protocol (SOAP)";
82 identity netconf-soap-over-https {
85 "NETCONF over Simple Object Access Protocol (SOAP)
86 over Hypertext Transfer Protocol Secure (HTTPS).";
88 "RFC 4743: Using NETCONF over the Simple Object
89 Access Protocol (SOAP)";
92 identity netconf-beep {
95 "NETCONF over Blocks Extensible Exchange Protocol (BEEP).";
97 "RFC 4744: Using the NETCONF Protocol over the
98 Blocks Extensible Exchange Protocol (BEEP)";
101 identity netconf-tls {
104 "NETCONF over Transport Layer Security (TLS).";
106 "RFC 5539: NETCONF over Transport Layer Security (TLS)";
109 identity schema-format {
111 "Base identity for data model schema languages.";
117 "W3C XML Schema Definition.";
119 "W3C REC REC-xmlschema-1-20041028:
120 XML Schema Part 1: Structures";
126 "The YANG data modeling language for NETCONF.";
128 "RFC 6020: YANG - A Data Modeling Language for the
129 Network Configuration Protocol (NETCONF)";
135 "The YIN syntax for YANG.";
137 "RFC 6020: YANG - A Data Modeling Language for the
138 Network Configuration Protocol (NETCONF)";
144 "Regular Language for XML Next Generation (RELAX NG).";
146 "ISO/IEC 19757-2:2008: RELAX NG";
152 "Relax NG Compact Syntax";
154 "ISO/IEC 19757-2:2008: RELAX NG";
157 grouping common-counters {
159 "Counters that exist both per session, and also globally,
160 accumulated from all sessions.";
163 type yang:zero-based-counter32;
165 "Number of correct <rpc> messages received.";
168 type yang:zero-based-counter32;
171 "Number of messages received when an <rpc> message was expected,
172 that were not correct <rpc> messages. This includes XML parse
173 errors and errors on the rpc layer.";
175 leaf out-rpc-errors {
176 type yang:zero-based-counter32;
178 "Number of <rpc-reply> messages sent that contained an
179 <rpc-error> element.";
181 leaf out-notifications {
182 type yang:zero-based-counter32;
184 "Number of <notification> messages sent.";
188 container netconf-state {
191 "The netconf-state container is the root of the monitoring
194 container capabilities {
196 "Contains the list of NETCONF capabilities supported by the
199 leaf-list capability {
202 "List of NETCONF capabilities supported by the server.";
206 container datastores {
208 "Contains the list of NETCONF configuration datastores.";
213 "List of NETCONF configuration datastores supported by
214 the NETCONF server and related information.";
217 type netconf-datastore-type;
219 "Name of the datastore associated with this list entry.";
223 "This container is present only if the datastore
226 "The NETCONF <lock> and <partial-lock> operations allow
227 a client to lock specific resources in a datastore. The
228 NETCONF server will prevent changes to the locked
229 resources by all sessions except the one that acquired
231 Monitoring information is provided for each datastore
232 entry including details such as the session that acquired
233 the lock, the type of lock (global or partial) and the
234 list of locked resources. Multiple locks per datastore
239 "Lock related parameters, common to both global and
242 leaf locked-by-session {
246 "The session ID of the session that has locked
247 this resource. Both a global lock and a partial
248 lock MUST contain the NETCONF session-id.
249 If the lock is held by a session that is not managed
250 by the NETCONF server (e.g., a CLI session), a session
251 id of 0 (zero) is reported.";
253 "RFC 4741: NETCONF Configuration Protocol";
256 type yang:date-and-time;
259 "The date and time of when the resource was
266 "Indicates if a global lock or a set of partial locks
269 container global-lock {
271 "Present if the global lock is set.";
278 "List of partial locks.";
280 "RFC 5717: Partial Lock Remote Procedure Call (RPC) for
286 "This is the lock id returned in the <partial-lock>
294 "The xpath expression that was used to request
295 the lock. The select expression indicates the
296 original intended scope of the lock.";
298 leaf-list locked-node {
299 type instance-identifier;
301 "The list of instance-identifiers (i.e., the
303 The scope of the partial lock is defined by the list
313 "Contains the list of data model schemas supported by the
317 key "identifier version format";
320 "List of data model schemas supported by the server.";
325 "Identifier to uniquely reference the schema. The
326 identifier is used in the <get-schema> operation and may
327 be used for other purposes such as file retrieval.
328 For modeling languages that support or require a data
329 model name (e.g., YANG module name) the identifier MUST
330 match that name. For YANG data models, the identifier is
331 the name of the module or submodule. In other cases, an
332 identifier such as a filename MAY be used instead.";
337 "Version of the schema supported. Multiple versions MAY be
338 supported simultaneously by a NETCONF server. Each
339 version MUST be reported individually in the schema list,
340 i.e., with same identifier, possibly different location,
341 but different version.
342 For YANG data models, version is the value of the most
343 recent YANG 'revision' statement in the module or
344 submodule, or the empty string if no 'revision' statement
352 "The data modeling language the schema is written
353 in (currently xsd, yang, yin, rng, or rnc).
354 For YANG data models, 'yang' format MUST be supported and
355 'yin' format MAY also be provided.";
361 "The XML namespace defined by the data model.
362 For YANG data models, this is the module's namespace.
363 If the list entry describes a submodule, this field
364 contains the namespace of the module to which the
375 "One or more locations from which the schema can be
376 retrieved. This list SHOULD contain at least one
378 A schema entry may be located on a remote file system
379 (e.g., reference to file system for ftp retrieval) or
380 retrieved directly from a server supporting the
381 <get-schema> operation (denoted by the value 'NETCONF').";
388 "The sessions container includes session-specific data for
389 NETCONF management sessions. The session list MUST include
390 all currently active NETCONF sessions.";
395 "All NETCONF sessions managed by the NETCONF server
396 MUST be reported in this list.";
403 "Unique identifier for the session. This value is the
404 NETCONF session identifier, as defined in RFC 4741.";
406 "RFC 4741: NETCONF Configuration Protocol";
414 "Identifies the transport for each session, e.g.,
415 'netconf-ssh', 'netconf-soap', etc.";
421 "The username is the client identity that was authenticated
422 by the NETCONF transport protocol. The algorithm used to
423 derive the username is NETCONF transport protocol specific
424 and in addition specific to the authentication mechanism
425 used by the NETCONF transport protocol.";
430 "Host identifier of the NETCONF client. The value
431 returned is implementation specific (e.g., hostname,
432 IPv4 address, IPv6 address)";
435 type yang:date-and-time;
438 "Time at the server at which the session was established.";
440 uses common-counters {
442 "Per-session counters. Zero based with following reset
444 - at start of a session
445 - when max value is reached";
450 container statistics {
452 "Statistical data pertaining to the NETCONF server.";
454 leaf netconf-start-time {
455 type yang:date-and-time;
457 "Date and time at which the management subsystem was
461 type yang:zero-based-counter32;
463 "Number of sessions silently dropped because an
464 invalid <hello> message was received. This includes <hello>
465 messages with a 'session-id' attribute, bad namespace, and
466 bad capability declarations.";
469 type yang:zero-based-counter32;
471 "Number of sessions started. This counter is incremented
472 when a <hello> message with a <session-id> is sent.
473 'in-sessions' - 'in-bad-hellos' =
474 'number of correctly started netconf sessions'";
476 leaf dropped-sessions {
477 type yang:zero-based-counter32;
480 "Number of sessions that were abnormally terminated, e.g.,
481 due to idle timeout or transport close. This counter is not
482 incremented when a session is properly closed by a
483 <close-session> operation, or killed by a <kill-session>
486 uses common-counters {
488 "Global counters, accumulated from all sessions.
489 Zero based with following reset behaviour:
490 - re-initialization of NETCONF server
491 - when max value is reached";
498 "This operation is used to retrieve a schema from the
501 The NETCONF server returns the requested schema.
503 If requested schema does not exist, the <error-tag> is
505 If more than one schema matches the requested parameters, the
506 <error-tag> is 'operation-failed', and <error-app-tag> is
514 "Identifier for the schema list entry.";
519 "Version of the schema requested. If this parameter is not
520 present, and more than one version of the schema exists on
521 the server, a 'data-not-unique' error is returned, as
529 "The data modeling language of the schema. If this
530 parameter is not present, and more than one formats of
531 the schema exists on the server, a 'data-not-unique' error
532 is returned, as described above.";
538 "Contains the schema content.";