1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 805 806 807 808 809 810 811 812 813 814 815 816 817 818 819 820 821 822 823 824 825 826 827 828 829 830 831 832 833 834 835 836 837 838 839 840 841 842 843 844 845 846 847 848 849 850 851 852 853 854 855 856 857 858 859 860 861 862 863 864 865 866 867 868 869 870 871 872 873 874 875 876 877 878 879 880 881 882 883 884 885 886 887 888 889 890 891 892 893 894 895 896 897 898 899 900 901 902 903 904 905 906 907 908 909 910 911 912 913 914 915 916 917 918 919 920 921 922 923 924 925 926 927 928 929 930 931 932 933 934 935 936 937 938 939 940 941 942 943 944 945 946 947 948 949 950 951 952 953 954 955 956 957 958 959 960 961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012 1013 1014 1015 1016 1017 1018 1019 1020 1021 1022 1023 1024 1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039 1040 1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065 1066 1067 1068 1069 1070 1071 1072 1073 1074 1075 1076 1077 1078 1079 1080 1081 1082 1083 1084 1085 1086 1087 1088 1089 1090 1091 1092 1093 1094 1095 1096 1097 1098 1099 1100 1101 1102 1103 1104 1105 1106 1107 1108 1109 1110 1111 1112 1113 1114 1115 1116 1117 1118 1119 1120 1121 1122 1123 1124 1125 1126 1127 1128 1129 1130 1131 1132 1133 1134 1135 1136 1137 1138 1139 1140 1141 1142 1143 1144 1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160 1161 1162 1163 1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274 1275 1276 1277 1278 1279 1280 1281 1282 1283 1284 1285 1286 1287 1288 1289 1290 1291 1292 1293 1294 1295 1296 1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313 1314 1315 1316 1317 1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 1333 1334 1335 1336 1337 1338 1339 1340 1341 1342 1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358 1359 1360 1361 1362 1363 1364 1365 1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380 1381 1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395 1396 1397 1398 1399 1400 1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417 1418 1419 1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431 1432 1433 1434 1435 1436 1437 1438 1439 1440 1441 1442 1443 1444 1445 1446 1447 1448 1449 1450 1451 1452 1453 1454 1455 1456 1457 1458 1459 1460 1461 1462 1463 1464 1465 1466 1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486 1487 1488 1489 1490 1491 1492 1493 1494 1495 1496 1497 1498 1499 1500 1501 1502 1503 1504 1505 1506 1507 1508 1509 1510 1511 1512 1513 1514 1515 1516 1517 1518 1519 1520 1521 1522 1523 1524 1525 1526 1527 1528 1529 1530 1531 1532 1533 1534 1535 1536 1537 1538 1539 1540 1541 1542 1543 1544 1545 1546 1547 1548 1549 1550 1551 1552 1553 1554 1555 1556 1557 1558 1559 1560 1561 1562 1563 1564 1565
|
<pre>Internet Engineering Task Force (IETF) M. Scott
Request for Comments: 6022 Ericsson
Category: Standards Track M. Bjorklund
ISSN: 2070-1721 Tail-f Systems
October 2010
<span class="h1">YANG Module for NETCONF Monitoring</span>
Abstract
This document defines a Network Configuration Protocol (NETCONF) data
model to be used to monitor the NETCONF protocol. The monitoring
data model includes information about NETCONF datastores, sessions,
locks, and statistics. This data facilitates the management of a
NETCONF server. This document also defines methods for NETCONF
clients to discover data models supported by a NETCONF server and
defines a new NETCONF <get-schema> operation to retrieve them.
Status of This Memo
This is an Internet Standards Track document.
This document is a product of the Internet Engineering Task Force
(IETF). It represents the consensus of the IETF community. It has
received public review and has been approved for publication by the
Internet Engineering Steering Group (IESG). Further information on
Internet Standards is available in <a href="./rfc5741#section-2">Section 2 of RFC 5741</a>.
Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
<a href="http://www.rfc-editor.org/info/rfc6022">http://www.rfc-editor.org/info/rfc6022</a>.
Copyright Notice
Copyright (c) 2010 IETF Trust and the persons identified as the
document authors. All rights reserved.
This document is subject to <a href="https://www.rfc-editor.org/bcp/bcp78">BCP 78</a> and the IETF Trust's Legal
Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>) in effect on the date of
publication of this document. Please review these documents
carefully, as they describe your rights and restrictions with respect
to this document. Code Components extracted from this document must
include Simplified BSD License text as described in Section 4.e of
the Trust Legal Provisions and are provided without warranty as
described in the Simplified BSD License.
<span class="grey">Scott & Bjorklund Standards Track [Page 1]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-2" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
This document may contain material from IETF Documents or IETF
Contributions published or made publicly available before November
10, 2008. The person(s) controlling the copyright in some of this
material may not have granted the IETF Trust the right to allow
modifications of such material outside the IETF Standards Process.
Without obtaining an adequate license from the person(s) controlling
the copyright in such materials, this document may not be modified
outside the IETF Standards Process, and derivative works of it may
not be created outside the IETF Standards Process, except to format
it for publication as an RFC or to translate it into languages other
than English.
Table of Contents
<a href="#section-1">1</a>. Introduction ....................................................<a href="#page-3">3</a>
<a href="#section-1.1">1.1</a>. Definition of Terms ........................................<a href="#page-3">3</a>
<a href="#section-2">2</a>. Data Model to Monitor NETCONF ...................................<a href="#page-3">3</a>
<a href="#section-2.1">2.1</a>. The /netconf-state Subtree .................................<a href="#page-3">3</a>
<a href="#section-2.1.1">2.1.1</a>. The /netconf-state/capabilities Subtree .............<a href="#page-4">4</a>
<a href="#section-2.1.2">2.1.2</a>. The /netconf-state/datastores Subtree ...............<a href="#page-4">4</a>
<a href="#section-2.1.3">2.1.3</a>. The /netconf-state/schemas Subtree ..................<a href="#page-5">5</a>
<a href="#section-2.1.4">2.1.4</a>. The /netconf-state/sessions Subtree .................<a href="#page-6">6</a>
<a href="#section-2.1.5">2.1.5</a>. The /netconf-state/statistics Subtree ...............<a href="#page-7">7</a>
<a href="#section-3">3</a>. Schema Specific Operations ......................................<a href="#page-8">8</a>
<a href="#section-3.1">3.1</a>. The <get-schema> Operation .................................<a href="#page-8">8</a>
<a href="#section-4">4</a>. Examples ........................................................<a href="#page-9">9</a>
<a href="#section-4.1">4.1</a>. Retrieving Schema List via <get> Operation .................<a href="#page-9">9</a>
<a href="#section-4.2">4.2</a>. Retrieving Schema Instances ...............................<a href="#page-11">11</a>
<a href="#section-5">5</a>. NETCONF Monitoring Data Model ..................................<a href="#page-13">13</a>
<a href="#section-6">6</a>. Security Considerations ........................................<a href="#page-25">25</a>
<a href="#section-7">7</a>. Acknowledgements ...............................................<a href="#page-26">26</a>
<a href="#section-8">8</a>. IANA Considerations ............................................<a href="#page-26">26</a>
<a href="#section-9">9</a>. References .....................................................<a href="#page-26">26</a>
<a href="#section-9.1">9.1</a>. Normative References ......................................<a href="#page-26">26</a>
<a href="#section-9.2">9.2</a>. Informative References ....................................<a href="#page-27">27</a>
<span class="grey">Scott & Bjorklund Standards Track [Page 2]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-3" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<span class="h2"><a class="selflink" id="section-1" href="#section-1">1</a>. Introduction</span>
This document defines a YANG [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>] model to be used to monitor
the NETCONF protocol. It provides information about NETCONF sessions
and supported schema as defined in [<a href="./rfc4741" title=""NETCONF Configuration Protocol"">RFC4741</a>].
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.
The methods defined in this document address the need for further
means to query and retrieve schema and NETCONF state information from
a NETCONF server. These are provided to complement existing base
NETCONF capabilities and operations and in no way affect existing
behaviour.
A new <get-schema> operation is also defined to support explicit
schema retrieval via NETCONF.
<span class="h3"><a class="selflink" id="section-1.1" href="#section-1.1">1.1</a>. Definition of Terms</span>
The key words "MUST", "MUST NOT", "REQUIRED", "SHALL", "SHALL NOT",
"SHOULD", "SHOULD NOT", "RECOMMENDED", "NOT RECOMMENDED", "MAY", and
"OPTIONAL" in this document are to be interpreted as described in <a href="https://www.rfc-editor.org/bcp/bcp14">BCP</a>
<a href="https://www.rfc-editor.org/bcp/bcp14">14</a> [<a href="./rfc2119" title=""Key words for use in RFCs to Indicate Requirement Levels"">RFC2119</a>].
<span class="h2"><a class="selflink" id="section-2" href="#section-2">2</a>. Data Model to Monitor NETCONF</span>
The NETCONF monitoring data model defined in this document provides
operational information on the NETCONF server. This includes details
specific to the NETCONF protocol (e.g., protocol-specific counters
such as 'in-sessions') as well as data related to schema retrieval
(e.g., schema list).
A server that implements the data model defined in this document
("urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring") MUST
advertise the capability URI as described in [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>].
This section presents an overview of the monitoring data model. For
detailed descriptions, refer to the normative YANG module provided in
this document (see <a href="#section-5">Section 5</a>).
<span class="h3"><a class="selflink" id="section-2.1" href="#section-2.1">2.1</a>. The /netconf-state Subtree</span>
The netconf-state container is the root of the monitoring data model.
<span class="grey">Scott & Bjorklund Standards Track [Page 3]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-4" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
netconf-state
/capabilities
/datastores
/schemas
/sessions
/statistics
capabilities
List of NETCONF capabilities supported by the server.
datastores
List of NETCONF configuration datastores (e.g., running, startup,
candidate) supported on this device and related information.
schemas
List of schemas supported on the server. Includes all the
information required to identify the schemas and to support their
retrieval.
sessions
List of all active NETCONF sessions on the device. Includes per-
session counters for all NETCONF sessions.
statistics
Includes global counters for the NETCONF server.
<span class="h4"><a class="selflink" id="section-2.1.1" href="#section-2.1.1">2.1.1</a>. The /netconf-state/capabilities Subtree</span>
The /netconf-state/capabilities subtree contains the capabilities
supported by the NETCONF server. The list MUST include all
capabilities exchanged during session setup still applicable at the
time of the request.
<span class="h4"><a class="selflink" id="section-2.1.2" href="#section-2.1.2">2.1.2</a>. The /netconf-state/datastores Subtree</span>
The /netconf-state/datastores subtree contains the list of available
datastores for the NETCONF server and includes information on their
lock state.
datastore
/name
/locks
name (leaf, netconf-datastore-type)
Enumeration of supported datastores; candidate, running, startup.
<span class="grey">Scott & Bjorklund Standards Track [Page 4]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-5" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
locks (grouping, lock-info)
List of locks for the datastore. Information is provided for both
global and partial locks [<a href="./rfc5717" title=""Partial Lock Remote Procedure Call (RPC) for NETCONF"">RFC5717</a>]. For partial locks, the list
of locked nodes and the select expressions originally used to
request the lock are returned.
<span class="h4"><a class="selflink" id="section-2.1.3" href="#section-2.1.3">2.1.3</a>. The /netconf-state/schemas Subtree</span>
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. These are used in the <get-schema> operation.
identifier (string)
Identifier for the schema list entry. The identifier is used in
the <get-schema> operation and may be used for other means such as
file retrieval.
version (string)
Version of the schema supported. Multiple versions MAY be
supported simultaneously by a NETCONF server. Each version MUST
be reported individually in the schema list, i.e., with same
identifier, possibly different location, but different version.
For YANG data models, version is the value of the most recent YANG
'revision' statement in the module or submodule, or the empty
string if no 'revision' statement is present.
format (identifyref, schema-format)
The data modeling language the schema is written in. The data
modeling language is represented as a YANG identity. This
document defines the identities "xsd", "yang", "yin", "rng", and
"rnc" (see <a href="#section-5">Section 5</a>).
namespace (inet:uri)
The Extensible Markup Language (XML) namespace [<a href="#ref-XML-NAMES">XML-NAMES</a>] defined
by the schema.
<span class="grey">Scott & Bjorklund Standards Track [Page 5]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-6" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
location (union: enum, inet:uri)
One or more locations from which this specific schema can be
retrieved. The list SHOULD contain at least one entry per schema.
<span class="h4"><a class="selflink" id="section-2.1.4" href="#section-2.1.4">2.1.4</a>. The /netconf-state/sessions Subtree</span>
Includes session-specific data for NETCONF management sessions. The
session list MUST include all currently active NETCONF sessions.
session
/session-id (key)
/transport
/username
/source-host
/login-time
/in-rpcs
/in-bad-rpcs
/out-rpc-errors
/out-notifications
session-id (uint32, 1..max)
Unique identifier for the session. This value is the NETCONF
session identifier, as defined in [<a href="./rfc4741" title=""NETCONF Configuration Protocol"">RFC4741</a>].
transport (identityref, transport)
Identifies the transport for each session. The transport is
represented as a YANG identity. This document defines the
identities "netconf-ssh", "netconf-soap-over-beep", "netconf-soap-
over-https", "netconf-beep", and "netconf-tls" (see <a href="#section-5">Section 5</a>).
username (string)
The username is the client identity that was authenticated by the
NETCONF transport protocol. The algorithm used to derive the
username is NETCONF transport protocol specific and in addition
specific to the authentication mechanism used by the NETCONF
transport protocol.
source-host (inet:host)
Host identifier (IP address or name) of the NETCONF client.
login-time (yang:date-and-time)
Time at the server at which the session was established.
in-rpcs (yang:zero-based-counter32)
Number of correct <rpc> messages received.
<span class="grey">Scott & Bjorklund Standards Track [Page 6]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-7" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
in-bad-rpcs (yang:zero-based-counter32)
Number of messages received when an <rpc> message was expected,
that were not correct <rpc> messages. This includes XML parse
errors and errors on the rpc layer.
out-rpc-errors (yang:zero-based-counter32)
Number of <rpc-reply> messages sent that contained an <rpc-error>
element.
out-notifications (yang:zero-based-counter32)
Number of <notification> messages sent.
<span class="h4"><a class="selflink" id="section-2.1.5" href="#section-2.1.5">2.1.5</a>. The /netconf-state/statistics Subtree</span>
Statistical data pertaining to the NETCONF server.
statistics
/netconf-start-time
/in-bad-hellos
/in-sessions
/dropped-sessions
/in-rpcs
/in-bad-rpcs
/out-rpc-errors
/out-notifications
statistics:
Contains management-session-related performance data for the
NETCONF server.
netconf-start-time (yang:date-and-time)
Date and time at which the management subsystem was started.
in-bad-hellos (yang:zero-based-counter32)
Number of sessions silently dropped because an invalid <hello>
message was received.
in-sessions (yang:zero-based-counter32)
Number of sessions started.
dropped-sessions (yang:zero-based-counter32)
Number of sessions that were abnormally terminated, e.g., due to
idle timeout or transport close.
in-rpcs (yang:zero-based-counter32)
Number of correct <rpc> messages received.
<span class="grey">Scott & Bjorklund Standards Track [Page 7]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-8" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
in-bad-rpcs (yang:zero-based-counter32)
Number of messages received when an <rpc> message was expected,
which were not correct <rpc> messages.
out-rpc-errors (yang:zero-based-counter32)
Number of <rpc-reply> messages sent that contained an <rpc-error>
element.
out-notifications (yang:zero-based-counter32)
Number of <notification> messages sent.
<span class="h2"><a class="selflink" id="section-3" href="#section-3">3</a>. Schema Specific Operations</span>
<span class="h3"><a class="selflink" id="section-3.1" href="#section-3.1">3.1</a>. The <get-schema> Operation</span>
Description:
This operation is used to retrieve a schema from the NETCONF
server.
Parameters:
identifier (string):
Identifier for the schema list entry.
Mandatory parameter.
version (string):
Version of the schema requested.
Optional parameter.
format (identityref, schema-format):
The data modeling language of the schema.
Default value is 'yang' when not specified.
Optional parameter.
Positive Response:
The NETCONF server returns the requested schema.
Negative Response:
If the requested schema does not exist, the <error-tag> is
'invalid-value'.
If more than one schema matches the requested parameters, the
<error-tag> is 'operation-failed', and <error-app-tag> is
'data-not-unique'.
<span class="grey">Scott & Bjorklund Standards Track [Page 8]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-9" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<span class="h2"><a class="selflink" id="section-4" href="#section-4">4</a>. Examples</span>
<span class="h3"><a class="selflink" id="section-4.1" href="#section-4.1">4.1</a>. Retrieving Schema List via <get> Operation</span>
A NETCONF client retrieves the list of supported schema from a
NETCONF server by retrieving the /netconf-state/schemas subtree via a
<get> operation.
Available schema for the requesting session are returned in the reply
containing the <identifier>, <version>, <format>, and <location>
elements.
The response data can be used to determine the available schema and
their versions. The schema itself (i.e., schema content) is not
returned in the response. The optional <location> element contains a
URI, which can be used to retrieve the schema by another protocol
such as ftp [<a href="./rfc0959" title=""File Transfer Protocol"">RFC0959</a>] or http(s) [<a href="./rfc2616" title=""Hypertext Transfer Protocol -- HTTP/1.1"">RFC2616</a>] [<a href="./rfc2818" title=""HTTP Over TLS"">RFC2818</a>], or the special
value 'NETCONF', which means that the schema can be retrieved from
the device via the <get-schema> operation.
Example:
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get>
<filter type="subtree">
<netconf-state xmlns=
"urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<schemas/>
</netconf-state>
</filter>
</get>
</rpc>
The NETCONF server returns a list of schema available for
retrieval.
<span class="grey">Scott & Bjorklund Standards Track [Page 9]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-10" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data>
<netconf-state
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<schemas>
<schema>
<identifier>foo</identifier>
<version>1.0</version>
<format>xsd</format>
<namespace>http://example.com/foo</namespace>
<location>ftp://ftp.example.com/schemas/foo_1.0.xsd</location>
<location>http://www.example.com/schema/foo_1.0.xsd</location>
<location>NETCONF</location>
</schema>
<schema>
<identifier>foo</identifier>
<version>1.1</version>
<format>xsd</format>
<namespace>http://example.com/foo</namespace>
<location>ftp://ftp.example.com/schemas/foo_1.1.xsd</location>
<location>http://www.example.com/schema/foo_1.1.xsd</location>
<location>NETCONF</location>
</schema>
<schema>
<identifier>bar</identifier>
<version>2008-06-01</version>
<format>yang</format>
<namespace>http://example.com/bar</namespace>
<location>
http://example.com/schema/bar@2008-06-01.yang
</location>
<location>NETCONF</location>
</schema>
<schema>
<identifier>bar-types</identifier>
<version>2008-06-01</version>
<format>yang</format>
<namespace>http://example.com/bar</namespace>
<location>
http://example.com/schema/bar-types@2008-06-01.yang
</location>
<location>NETCONF</location>
</schema>
</schemas>
</netconf-state>
</data>
</rpc-reply>
<span class="grey">Scott & Bjorklund Standards Track [Page 10]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-11" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<span class="h3"><a class="selflink" id="section-4.2" href="#section-4.2">4.2</a>. Retrieving Schema Instances</span>
Given the reply in the previous section, the following examples
illustrate the retrieval 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 <get-schema> using identifier, version, and
format parameters.
<rpc message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get-schema
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<identifier>foo</identifier>
<version>1.0</version>
<format>xsd</format>
</get-schema>
</rpc>
<rpc-reply message-id="101"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<xs:schema xmlns:xs="http://www.w3.org/2001/XMLSchema">
<!-- foo 1.0 xsd schema contents here -->
</xs:schema>
</data>
</rpc-reply>
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 <get-schema> using identifier and version
parameters:
<span class="grey">Scott & Bjorklund Standards Track [Page 11]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-12" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<rpc message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get-schema
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<identifer>bar</identifer>
<version>2008-06-01</version>
</get-schema>
</rpc>
<rpc-reply message-id="102"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
module bar {
//default format (yang) returned
//bar version 2008-06-01 yang module
//contents here ...
}
</data>
</rpc-reply>
3. bar-types, version 2008-06-01 in default YANG format:
a. Via <get-schema> using identifer parameter:
<rpc message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<get-schema
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
<identifer>bar-types</identifer>
</get-schema>
</rpc>
<rpc-reply message-id="103"
xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
<data
xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
module bar-types {
//default format (yang) returned
//latest revision returned
//is version 2008-06-01 yang module
//contents here ...
}
</data>
</rpc-reply>
<span class="grey">Scott & Bjorklund Standards Track [Page 12]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-13" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<span class="h2"><a class="selflink" id="section-5" href="#section-5">5</a>. NETCONF Monitoring Data Model</span>
The data model described in this memo is defined in the following
YANG module.
This YANG module imports typedefs from [<a href="./rfc6021" title=""Common YANG Data Types"">RFC6021</a>] and references
[<a href="./rfc4741" title=""NETCONF Configuration Protocol"">RFC4741</a>], [<a href="./rfc4742" title=""Using the NETCONF Configuration Protocol over Secure SHell (SSH)"">RFC4742</a>], [<a href="./rfc4743" title=""Using NETCONF over the Simple Object Access Protocol (SOAP)"">RFC4743</a>], [<a href="./rfc4744" title=""Using the NETCONF Protocol over the Blocks Extensible Exchange Protocol (BEEP)"">RFC4744</a>], [<a href="./rfc5539" title=""NETCONF over Transport Layer Security (TLS)"">RFC5539</a>], [<a href="#ref-xmlschema-1">xmlschema-1</a>],
[<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>], [ISO/IEC19757-2:2008], and [<a href="./rfc5717" title=""Partial Lock Remote Procedure Call (RPC) for NETCONF"">RFC5717</a>].
<CODE BEGINS> file "ietf-netconf-monitoring@2010-10-04.yang"
module ietf-netconf-monitoring {
namespace "urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring";
prefix "ncm";
import ietf-yang-types { prefix yang; }
import ietf-inet-types { prefix inet; }
organization
"IETF NETCONF (Network Configuration) Working Group";
contact
"WG Web: <<a href="http://tools.ietf.org/wg/netconf/">http://tools.ietf.org/wg/netconf/</a>>
WG List: <mailto:netconf@ietf.org>
WG Chair: Mehmet Ersue
<mailto:mehmet.ersue@nsn.com>
WG Chair: Bert Wijnen
<mailto:bertietf@bwijnen.net>
Editor: Mark Scott
<mailto:mark.scott@ericsson.com>
Editor: Martin Bjorklund
<mailto:mbj@tail-f.com>";
description
"NETCONF Monitoring Module.
All elements in this module are read-only.
Copyright (c) 2010 IETF Trust and the persons identified as
authors of the code. All rights reserved.
Redistribution and use in source and binary forms, with or
without modification, is permitted pursuant to, and subject
to the license terms contained in, the Simplified BSD
<span class="grey">Scott & Bjorklund Standards Track [Page 13]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-14" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
License set forth in <a href="#section-4">Section 4</a>.c of the IETF Trust's
Legal Provisions Relating to IETF Documents
(<a href="http://trustee.ietf.org/license-info">http://trustee.ietf.org/license-info</a>).
This version of this YANG module is part of <a href="./rfc6022">RFC 6022</a>; see
the RFC itself for full legal notices.";
revision 2010-10-04 {
description
"Initial revision.";
reference
"<a href="./rfc6022">RFC 6022</a>: YANG Module for NETCONF Monitoring";
}
typedef netconf-datastore-type {
type enumeration {
enum running;
enum candidate;
enum startup;
}
description
"Enumeration of possible NETCONF datastore types.";
reference
"<a href="./rfc4741">RFC 4741</a>: NETCONF Configuration Protocol";
}
identity transport {
description
"Base identity for NETCONF transport types.";
}
identity netconf-ssh {
base transport;
description
"NETCONF over Secure Shell (SSH).";
reference
"<a href="./rfc4742">RFC 4742</a>: Using the NETCONF Configuration Protocol
over Secure SHell (SSH)";
}
identity netconf-soap-over-beep {
base transport;
description
"NETCONF over Simple Object Access Protocol (SOAP) over
Blocks Extensible Exchange Protocol (BEEP).";
<span class="grey">Scott & Bjorklund Standards Track [Page 14]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-15" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
reference
"<a href="./rfc4743">RFC 4743</a>: Using NETCONF over the Simple Object
Access Protocol (SOAP)";
}
identity netconf-soap-over-https {
base transport;
description
"NETCONF over Simple Object Access Protocol (SOAP)
over Hypertext Transfer Protocol Secure (HTTPS).";
reference
"<a href="./rfc4743">RFC 4743</a>: Using NETCONF over the Simple Object
Access Protocol (SOAP)";
}
identity netconf-beep {
base transport;
description
"NETCONF over Blocks Extensible Exchange Protocol (BEEP).";
reference
"<a href="./rfc4744">RFC 4744</a>: Using the NETCONF Protocol over the
Blocks Extensible Exchange Protocol (BEEP)";
}
identity netconf-tls {
base transport;
description
"NETCONF over Transport Layer Security (TLS).";
reference
"<a href="./rfc5539">RFC 5539</a>: NETCONF over Transport Layer Security (TLS)";
}
identity schema-format {
description
"Base identity for data model schema languages.";
}
identity xsd {
base schema-format;
description
"W3C XML Schema Definition.";
reference
"W3C REC REC-xmlschema-1-20041028:
XML Schema Part 1: Structures";
}
<span class="grey">Scott & Bjorklund Standards Track [Page 15]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-16" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
identity yang {
base schema-format;
description
"The YANG data modeling language for NETCONF.";
reference
"<a href="./rfc6020">RFC 6020</a>: YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)";
}
identity yin {
base schema-format;
description
"The YIN syntax for YANG.";
reference
"<a href="./rfc6020">RFC 6020</a>: YANG - A Data Modeling Language for the
Network Configuration Protocol (NETCONF)";
}
identity rng {
base schema-format;
description
"Regular Language for XML Next Generation (RELAX NG).";
reference
"ISO/IEC 19757-2:2008: RELAX NG";
}
identity rnc {
base schema-format;
description
"Relax NG Compact Syntax";
reference
"ISO/IEC 19757-2:2008: RELAX NG";
}
grouping common-counters {
description
"Counters that exist both per session, and also globally,
accumulated from all sessions.";
leaf in-rpcs {
type yang:zero-based-counter32;
description
"Number of correct <rpc> messages received.";
}
leaf in-bad-rpcs {
type yang:zero-based-counter32;
<span class="grey">Scott & Bjorklund Standards Track [Page 16]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-17" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
description
"Number of messages received when an <rpc> message was expected,
that were not correct <rpc> messages. This includes XML parse
errors and errors on the rpc layer.";
}
leaf out-rpc-errors {
type yang:zero-based-counter32;
description
"Number of <rpc-reply> messages sent that contained an
<rpc-error> element.";
}
leaf out-notifications {
type yang:zero-based-counter32;
description
"Number of <notification> messages sent.";
}
}
container netconf-state {
config false;
description
"The netconf-state container is the root of the monitoring
data model.";
container capabilities {
description
"Contains the list of NETCONF capabilities supported by the
server.";
leaf-list capability {
type inet:uri;
description
"List of NETCONF capabilities supported by the server.";
}
}
container datastores {
description
"Contains the list of NETCONF configuration datastores.";
list datastore {
key name;
description
"List of NETCONF configuration datastores supported by
the NETCONF server and related information.";
leaf name {
type netconf-datastore-type;
<span class="grey">Scott & Bjorklund Standards Track [Page 17]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-18" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
description
"Name of the datastore associated with this list entry.";
}
container locks {
presence
"This container is present only if the datastore
is locked.";
description
"The NETCONF <lock> and <partial-lock> operations allow
a client to lock specific resources in a datastore. The
NETCONF server will prevent changes to the locked
resources by all sessions except the one that acquired
the lock(s).
Monitoring information is provided for each datastore
entry including details such as the session that acquired
the lock, the type of lock (global or partial) and the
list of locked resources. Multiple locks per datastore
are supported.";
grouping lock-info {
description
"Lock related parameters, common to both global and
partial locks.";
leaf locked-by-session {
type uint32;
mandatory true;
description
"The session ID of the session that has locked
this resource. Both a global lock and a partial
lock MUST contain the NETCONF session-id.
If the lock is held by a session that is not managed
by the NETCONF server (e.g., a CLI session), a session
id of 0 (zero) is reported.";
reference
"<a href="./rfc4741">RFC 4741</a>: NETCONF Configuration Protocol";
}
leaf locked-time {
type yang:date-and-time;
mandatory true;
description
"The date and time of when the resource was
locked.";
}
}
<span class="grey">Scott & Bjorklund Standards Track [Page 18]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-19" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
choice lock-type {
description
"Indicates if a global lock or a set of partial locks
are set.";
container global-lock {
description
"Present if the global lock is set.";
uses lock-info;
}
list partial-lock {
key lock-id;
description
"List of partial locks.";
reference
"<a href="./rfc5717">RFC 5717</a>: Partial Lock Remote Procedure Call (RPC) for
NETCONF";
leaf lock-id {
type uint32;
description
"This is the lock id returned in the <partial-lock>
response.";
}
uses lock-info;
leaf-list select {
type yang:xpath1.0;
min-elements 1;
description
"The xpath expression that was used to request
the lock. The select expression indicates the
original intended scope of the lock.";
}
leaf-list locked-node {
type instance-identifier;
description
"The list of instance-identifiers (i.e., the
locked nodes).
The scope of the partial lock is defined by the list
of locked nodes.";
}
}
}
}
}
}
<span class="grey">Scott & Bjorklund Standards Track [Page 19]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-20" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
container schemas {
description
"Contains the list of data model schemas supported by the
server.";
list schema {
key "identifier version format";
description
"List of data model schemas supported by the server.";
leaf identifier {
type string;
description
"Identifier to uniquely reference the schema. The
identifier is used in the <get-schema> operation and may
be used for other purposes such as file retrieval.
For modeling languages that support or require a data
model name (e.g., YANG module name) the identifier MUST
match that name. For YANG data models, the identifier is
the name of the module or submodule. In other cases, an
identifier such as a filename MAY be used instead.";
}
leaf version {
type string;
description
"Version of the schema supported. Multiple versions MAY be
supported simultaneously by a NETCONF server. Each
version MUST be reported individually in the schema list,
i.e., with same identifier, possibly different location,
but different version.
For YANG data models, version is the value of the most
recent YANG 'revision' statement in the module or
submodule, or the empty string if no 'revision' statement
is present.";
}
leaf format {
type identityref {
base schema-format;
}
description
"The data modeling language the schema is written
in (currently xsd, yang, yin, rng, or rnc).
<span class="grey">Scott & Bjorklund Standards Track [Page 20]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-21" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
For YANG data models, 'yang' format MUST be supported and
'yin' format MAY also be provided.";
}
leaf namespace {
type inet:uri;
mandatory true;
description
"The XML namespace defined by the data model.
For YANG data models, this is the module's namespace.
If the list entry describes a submodule, this field
contains the namespace of the module to which the
submodule belongs.";
}
leaf-list location {
type union {
type enumeration {
enum "NETCONF";
}
type inet:uri;
}
description
"One or more locations from which the schema can be
retrieved. This list SHOULD contain at least one
entry per schema.
A schema entry may be located on a remote file system
(e.g., reference to file system for ftp retrieval) or
retrieved directly from a server supporting the
<get-schema> operation (denoted by the value 'NETCONF').";
}
}
}
<span class="grey">Scott & Bjorklund Standards Track [Page 21]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-22" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
container sessions {
description
"The sessions container includes session-specific data for
NETCONF management sessions. The session list MUST include
all currently active NETCONF sessions.";
list session {
key session-id;
description
"All NETCONF sessions managed by the NETCONF server
MUST be reported in this list.";
leaf session-id {
type uint32 {
range "1..max";
}
description
"Unique identifier for the session. This value is the
NETCONF session identifier, as defined in <a href="./rfc4741">RFC 4741</a>.";
reference
"<a href="./rfc4741">RFC 4741</a>: NETCONF Configuration Protocol";
}
leaf transport {
type identityref {
base transport;
}
mandatory true;
description
"Identifies the transport for each session, e.g.,
'netconf-ssh', 'netconf-soap', etc.";
}
leaf username {
type string;
mandatory true;
description
"The username is the client identity that was authenticated
by the NETCONF transport protocol. The algorithm used to
derive the username is NETCONF transport protocol specific
and in addition specific to the authentication mechanism
used by the NETCONF transport protocol.";
}
leaf source-host {
type inet:host;
description
"Host identifier of the NETCONF client. The value
returned is implementation specific (e.g., hostname,
IPv4 address, IPv6 address)";
}
<span class="grey">Scott & Bjorklund Standards Track [Page 22]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-23" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
leaf login-time {
type yang:date-and-time;
mandatory true;
description
"Time at the server at which the session was established.";
}
uses common-counters {
description
"Per-session counters. Zero based with following reset
behaviour:
- at start of a session
- when max value is reached";
}
}
}
container statistics {
description
"Statistical data pertaining to the NETCONF server.";
leaf netconf-start-time {
type yang:date-and-time;
description
"Date and time at which the management subsystem was
started.";
}
leaf in-bad-hellos {
type yang:zero-based-counter32;
description
"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 in-sessions {
type yang:zero-based-counter32;
description
"Number of sessions started. This counter is incremented
when a <hello> message with a <session-id> is sent.
'in-sessions' - 'in-bad-hellos' =
'number of correctly started netconf sessions'";
}
leaf dropped-sessions {
type yang:zero-based-counter32;
<span class="grey">Scott & Bjorklund Standards Track [Page 23]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-24" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
description
"Number of sessions that were abnormally terminated, e.g.,
due to idle timeout or transport close. This counter is not
incremented when a session is properly closed by a
<close-session> operation, or killed by a <kill-session>
operation.";
}
uses common-counters {
description
"Global counters, accumulated from all sessions.
Zero based with following reset behaviour:
- re-initialization of NETCONF server
- when max value is reached";
}
}
}
rpc get-schema {
description
"This operation is used to retrieve a schema from the
NETCONF server.
Positive Response:
The NETCONF server returns the requested schema.
Negative Response:
If requested schema does not exist, the <error-tag> is
'invalid-value'.
If more than one schema matches the requested parameters, the
<error-tag> is 'operation-failed', and <error-app-tag> is
'data-not-unique'.";
input {
leaf identifier {
type string;
mandatory true;
description
"Identifier for the schema list entry.";
}
leaf version {
type string;
description
"Version of the schema requested. If this parameter is not
present, and more than one version of the schema exists on
the server, a 'data-not-unique' error is returned, as
described above.";
}
<span class="grey">Scott & Bjorklund Standards Track [Page 24]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-25" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
leaf format {
type identityref {
base schema-format;
}
description
"The data modeling language of the schema. If this
parameter is not present, and more than one formats of
the schema exists on the server, a 'data-not-unique' error
is returned, as described above.";
}
}
output {
anyxml data {
description
"Contains the schema content.";
}
}
}
}
<CODE ENDS>
<span class="h2"><a class="selflink" id="section-6" href="#section-6">6</a>. Security Considerations</span>
The YANG module defined in this memo is designed to be accessed via
the NETCONF protocol [<a href="./rfc4741" title=""NETCONF Configuration Protocol"">RFC4741</a>]. The lowest NETCONF layer is the
secure transport layer and the mandatory to implement secure
transport is SSH [<a href="./rfc4742" title=""Using the NETCONF Configuration Protocol over Secure SHell (SSH)"">RFC4742</a>].
Some of the readable data nodes in this YANG module may be considered
sensitive or vulnerable in some network environments. It is thus
important to control read access (e.g., via get, get-config, or
notification) to these data nodes.
These are the containers, list nodes, and data nodes with their
specific sensitivity/vulnerability:
/netconf-state/sessions/session/username: Contains identity
information that could be used in an attempt to authenticate with
the server.
This username is only meant for monitoring, and SHOULD NOT be used
for other purposes, such as access control, without a detailed
discussion of the limitations of this reported username. For
example, it is possible that server A and server B might report
the same username, but these might be for different persons.
<span class="grey">Scott & Bjorklund Standards Track [Page 25]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-26" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
<span class="h2"><a class="selflink" id="section-7" href="#section-7">7</a>. Acknowledgements</span>
The authors would like to thank Andy Bierman, Mehmet Ersue, Washam
Fan, David Harrington, Balazs Lengyel, Hideki Okita, Juergen
Schoenwaelder, Bert Wijnen, and many other members of the NETCONF WG
for providing important input to this document. The authors would
also like to specifically acknowledge Sharon Chisholm's work on
"NETCONF Monitoring Schema" [<a href="#ref-NETCONF" title=""NETCONF Monitoring Schema"">NETCONF</a>] and contribution to this
document.
<span class="h2"><a class="selflink" id="section-8" href="#section-8">8</a>. IANA Considerations</span>
This document registers one URI in "The IETF XML Registry".
Following the format in [<a href="./rfc3688" title=""The IETF XML Registry"">RFC3688</a>], the following has been registered.
URI: urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring
Registrant Contact: The IESG.
XML: N/A, the requested URI is an XML namespace.
This document registers one module in the "YANG Module Names"
registry. Following the format in [<a href="./rfc6020" title=""YANG - A Data Modeling Language for the Network Configuration Protocol (NETCONF)"">RFC6020</a>], the following has been
registered.
name: ietf-netconf-monitoring
namespace: urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring
prefix: ncm
reference: <a href="./rfc6022">RFC 6022</a>
<span class="h2"><a class="selflink" id="section-9" href="#section-9">9</a>. References</span>
<span class="h3"><a class="selflink" id="section-9.1" href="#section-9.1">9.1</a>. Normative References</span>
[ISO/IEC19757-2:2008]
ISO/IEC, "Document Schema Definition Language (DSDL) --
Part 2: Regular-grammar-based validation -- RELAX NG",
December 2008, <<a href="http://www.iso.org/iso/catalogue_detail.htm?csnumber=37605">http://www.iso.org/iso/</a>
<a href="http://www.iso.org/iso/catalogue_detail.htm?csnumber=37605">catalogue_detail.htm?csnumber=37605</a>>.
[<a id="ref-RFC2119">RFC2119</a>] Bradner, S., "Key words for use in RFCs to Indicate
Requirement Levels", <a href="https://www.rfc-editor.org/bcp/bcp14">BCP 14</a>, <a href="./rfc2119">RFC 2119</a>, March 1997.
[<a id="ref-RFC4741">RFC4741</a>] Enns, R., "NETCONF Configuration Protocol", <a href="./rfc4741">RFC 4741</a>,
December 2006.
<span class="grey">Scott & Bjorklund Standards Track [Page 26]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-27" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
[<a id="ref-RFC4742">RFC4742</a>] Wasserman, M. and T. Goddard, "Using the NETCONF
Configuration Protocol over Secure SHell (SSH)", <a href="./rfc4742">RFC 4742</a>,
December 2006.
[<a id="ref-RFC4743">RFC4743</a>] Goddard, T., "Using NETCONF over the Simple Object Access
Protocol (SOAP)", <a href="./rfc4743">RFC 4743</a>, December 2006.
[<a id="ref-RFC4744">RFC4744</a>] Lear, E. and K. Crozier, "Using the NETCONF Protocol over
the Blocks Extensible Exchange Protocol (BEEP)", <a href="./rfc4744">RFC 4744</a>,
December 2006.
[<a id="ref-RFC5539">RFC5539</a>] Badra, M., "NETCONF over Transport Layer Security (TLS)",
<a href="./rfc5539">RFC 5539</a>, May 2009.
[<a id="ref-RFC5717">RFC5717</a>] Lengyel, B. and M. Bjorklund, "Partial Lock Remote
Procedure Call (RPC) for NETCONF", <a href="./rfc5717">RFC 5717</a>,
December 2009.
[<a id="ref-RFC6020">RFC6020</a>] Bjorklund, M., Ed., "YANG - A Data Modeling Language for
the Network Configuration Protocol (NETCONF)",
October 2010.
[<a id="ref-RFC6021">RFC6021</a>] Schoenwaelder, J., Ed., "Common YANG Data Types",
October 2010.
[<a id="ref-XML-NAMES">XML-NAMES</a>]
Hollander, D., Tobin, R., Thompson, H., Bray, T., and A.
Layman, "Namespaces in XML 1.0 (Third Edition)", World
Wide Web Consortium Recommendation REC-xml-names-20091208,
December 2009,
<<a href="http://www.w3.org/TR/2009/REC-xml-names-20091208">http://www.w3.org/TR/2009/REC-xml-names-20091208</a>>.
[<a id="ref-xmlschema-1">xmlschema-1</a>]
Biron, Paul V. and Ashok. Malhotra, "XML Schema Part 1:
Structures Second Edition W3C Recommendation 28 October
2004", October 2004, <<a href="http://www.w3.org/TR/xmlschema-1">http://www.w3.org/TR/xmlschema-1</a>>.
<span class="h3"><a class="selflink" id="section-9.2" href="#section-9.2">9.2</a>. Informative References</span>
[<a id="ref-NETCONF">NETCONF</a>] Chisholm, S. and H. Trevino, "NETCONF
Monitoring Schema", Work in Progress, February 2007.
[<a id="ref-RFC0959">RFC0959</a>] Postel, J. and J. Reynolds, "File Transfer Protocol",
STD 9, <a href="./rfc959">RFC 959</a>, October 1985.
[<a id="ref-RFC2616">RFC2616</a>] Fielding, R., Gettys, J., Mogul, J., Frystyk, H.,
Masinter, L., Leach, P., and T. Berners-Lee, "Hypertext
Transfer Protocol -- HTTP/1.1", <a href="./rfc2616">RFC 2616</a>, June 1999.
<span class="grey">Scott & Bjorklund Standards Track [Page 27]</span></pre>
<hr class='noprint'/><!--NewPage--><pre class='newpage'><span id="page-28" ></span>
<span class="grey"><a href="./rfc6022">RFC 6022</a> YANG Module for NETCONF Monitoring October 2010</span>
[<a id="ref-RFC2818">RFC2818</a>] Rescorla, E., "HTTP Over TLS", <a href="./rfc2818">RFC 2818</a>, May 2000.
[<a id="ref-RFC3688">RFC3688</a>] Mealling, M., "The IETF XML Registry", <a href="https://www.rfc-editor.org/bcp/bcp81">BCP 81</a>, <a href="./rfc3688">RFC 3688</a>,
January 2004.
Authors' Addresses
Mark Scott
Ericsson
3500 Carling Ave
Nepean, Ontario K2H 8E9
Canada
EMail: mark.scott@ericsson.com
Martin Bjorklund
Tail-f Systems
Klara Norra Kyrkogata 31
SE-111 22 Stockholm,
Sweden
EMail: mbj@tail-f.com
Scott & Bjorklund Standards Track [Page 28]
</pre>
|