docs/user-guide.rst

   1 .. _netconf-user-guide:
   2
   3 .. |ss| raw:: html
   4
   5    <strike>
   6
   7 .. |se| raw:: html
   8
   9    </strike>
  10
  11 NETCONF User Guide
  12 ==================
  13
  14 Overview
  15 --------
  16
  17 NETCONF is an XML-based protocol used for configuration and monitoring
  18 devices in the network. The base NETCONF protocol is described in
  19 `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__.
  20
  21 **NETCONF in OpenDaylight:.**
  22
  23 OpenDaylight supports the NETCONF protocol as a northbound server as
  24 well as a southbound plugin. It also includes a set of test tools for
  25 simulating NETCONF devices and clients.
  26
  27 Southbound (netconf-connector)
  28 ------------------------------
  29
  30 The NETCONF southbound plugin is capable of connecting to remote NETCONF
  31 devices and exposing their configuration/operational datastores, RPCs
  32 and notifications as MD-SAL mount points. These mount points allow
  33 applications and remote users (over RESTCONF) to interact with the
  34 mounted devices.
  35
  36 In terms of RFCs, the connector supports:
  37
  38 -  `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__
  39
  40 -  `RFC-5277 <https://tools.ietf.org/html/rfc5277>`__
  41
  42 -  `RFC-6022 <https://tools.ietf.org/html/rfc6022>`__
  43
  44 -  `RFC-7895 <https://tools.ietf.org/html/rfc7895>`__
  45
  46 **Netconf-connector is fully model-driven (utilizing the YANG modeling
  47 language) so in addition to the above RFCs, it supports any
  48 data/RPC/notifications described by a YANG model that is implemented by
  49 the device.**
  50
  51 .. tip::
  52
  53     NETCONF southbound can be activated by installing
  54     ``odl-netconf-connector-all`` Karaf feature.
  55
  56 Netconf-connector configuration
  57 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  58
  59 NETCONF connectors are configured directly through the usage of the
  60 network-topology model. You can configure new NETCONF connectors both
  61 through the NETCONF server for MD-SAL (port 2830) or RESTCONF. This guide
  62 focuses on RESTCONF.
  63
  64 .. important::
  65
  66     Since 2022.09 Chlorine there is only one RESTCONF endpoint:
  67
  68     - | ``http://localhost:8181/rests`` is related to `RFC-8040 <https://tools.ietf.org/html/rfc8040>`__,
  69       | can be activated by installing ``odl-restconf-nb``
  70        Karaf feature.
  71
  72     | Resources for configuration and operational datastores start
  73      ``/rests/data/``,
  74     | e. g. GET
  75      http://localhost:8181/rests/data/network-topology:network-topology
  76      with response of both datastores. It's allowed to use query
  77      parameters to distinguish between them.
  78     | e. g. GET
  79      http://localhost:8181/rests/data/network-topology:network-topology?content=config
  80      for configuration datastore
  81     | and GET
  82      http://localhost:8181/rests/data/network-topology:network-topology?content=nonconfig
  83      for operational datastore.
  84
  85     | Also if a data node in the path expression is a YANG leaf-list or list
  86      node, the path segment has to be constructed by having leaf-list or
  87      list node name, followed by an "=" character, then followed by the
  88      leaf-list or list value. Any reserved characters must be
  89      percent-encoded.
  90     | e. g. GET
  91      http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf?content=config
  92      for retrieving data from configuration datastore for
  93      topology-netconf value of topology list.
  94
  95 Preconditions
  96 ^^^^^^^^^^^^^
  97
  98 1. OpenDaylight is running
  99
 100 2. In Karaf, you must have the ``odl-netconf-topology`` or
 101    ``odl-netconf-clustered-topology`` feature installed.
 102
 103 3. Feature ``odl-restconf-nb`` must be installed
 104
 105 Spawning new NETCONF connectors
 106 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 107
 108 To create a new NETCONF connector you need to send the following PUT request
 109 to RESTCONF:
 110
 111 .. list-table::
 112    :widths: 1 5
 113
 114    * - rfc8040
 115      - http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=new-netconf-device
 116
 117 You could use the same body to create the new  NETCONF connector with a POST
 118 without specifying the node in the URL:
 119
 120 .. list-table::
 121    :widths: 1 5
 122
 123    * - rfc8040
 124      - http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf
 125
 126 Payload:
 127
 128 .. tabs::
 129
 130    .. tab:: XML
 131
 132       **Content-type:** ``application/xml``
 133
 134       **Accept:** ``application/xml``
 135
 136       **Authentication:** ``admin:admin``
 137
 138       .. code-block:: xml
 139
 140          <node xmlns="urn:TBD:params:xml:ns:yang:network-topology">
 141            <node-id>new-netconf-device</node-id>
 142            <host xmlns="urn:opendaylight:netconf-node-topology">127.0.0.1</host>
 143            <port xmlns="urn:opendaylight:netconf-node-topology">17830</port>
 144            <username xmlns="urn:opendaylight:netconf-node-topology">admin</username>
 145            <password xmlns="urn:opendaylight:netconf-node-topology">admin</password>
 146            <tcp-only xmlns="urn:opendaylight:netconf-node-topology">false</tcp-only>
 147            <!-- non-mandatory fields with default values, you can safely remove these if you do not wish to override any of these values-->
 148            <reconnect-on-changed-schema xmlns="urn:opendaylight:netconf-node-topology">false</reconnect-on-changed-schema>
 149            <connection-timeout-millis xmlns="urn:opendaylight:netconf-node-topology">20000</connection-timeout-millis>
 150            <max-connection-attempts xmlns="urn:opendaylight:netconf-node-topology">0</max-connection-attempts>
 151            <between-attempts-timeout-millis xmlns="urn:opendaylight:netconf-node-topology">2000</between-attempts-timeout-millis>
 152            <sleep-factor xmlns="urn:opendaylight:netconf-node-topology">1.5</sleep-factor>
 153            <!-- keepalive-delay set to 0 turns off keepalives-->
 154            <keepalive-delay xmlns="urn:opendaylight:netconf-node-topology">120</keepalive-delay>
 155          </node>
 156
 157    .. tab:: JSON
 158
 159       **Content-type:** ``application/json``
 160
 161       **Accept:** ``application/json``
 162
 163       **Authentication:** ``admin:admin``
 164
 165       .. code-block:: json
 166
 167          {
 168              "node": [
 169                  {
 170                      "node-id": "new-netconf-device",
 171                      "netconf-node-topology:port": 17830,
 172                      "netconf-node-topology:reconnect-on-changed-schema": false,
 173                      "netconf-node-topology:connection-timeout-millis": 20000,
 174                      "netconf-node-topology:tcp-only": false,
 175                      "netconf-node-topology:max-connection-attempts": 0,
 176                      "netconf-node-topology:username": "admin",
 177                      "netconf-node-topology:password": "admin",
 178                      "netconf-node-topology:sleep-factor": 1.5,
 179                      "netconf-node-topology:host": "127.0.0.1",
 180                      "netconf-node-topology:between-attempts-timeout-millis": 2000,
 181                      "netconf-node-topology:keepalive-delay": 120
 182                  }
 183              ]
 184          }
 185
 186 Note that the device name in <node-id> element must match the last
 187 element of the restconf URL.
 188
 189 Reconfiguring an existing connector
 190 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 191
 192 The steps to reconfigure an existing connector are exactly the same as
 193 when spawning a new connector. The old connection will be disconnected
 194 and a new connector with the new configuration will be created. This needs
 195 to be done with a PUT request because the node already exists. A POST
 196 request will fail for that reason.
 197
 198 Additionally, a PATCH request can be used to modify an existing
 199 configuration. Currently, only yang-patch (`RFC-8072 <https://tools.ietf.org/html/rfc8072>`__)
 200 is supported. The URL would be the same as the above PUT examples.
 201 Using JSON for the body, the headers needed for the request would
 202 be:
 203
 204 Headers:
 205
 206 -  Accept: application/yang-data+json
 207
 208 -  Content-Type: application/yang-patch+json
 209
 210 Example JSON payload to modify the password entry:
 211
 212 ::
 213
 214     {
 215       "ietf-restconf:yang-patch" : {
 216         "patch-id" : "0",
 217         "edit" : [
 218           {
 219             "edit-id" : "edit1",
 220             "operation" : "merge",
 221             "target" : "",
 222             "value" : {
 223              "node": [
 224                 {
 225                  "node-id": "new-netconf-device",
 226                  "netconf-node-topology:password" : "newpassword"
 227                 }
 228              ]
 229             }
 230          }
 231         ]
 232       }
 233     }
 234
 235 Deleting an existing connector
 236 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 237
 238 To remove an already configured NETCONF connector you need to send a
 239 DELETE request to the same PUT request URL that was used to create the
 240 device:
 241
 242 .. list-table::
 243    :widths: 1 5
 244
 245    * - rfc8040
 246      - http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=new-netconf-device
 247
 248 .. note::
 249
 250     No body is needed to delete the node/device
 251
 252 Connecting to a device not supporting NETCONF monitoring
 253 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 254
 255 The netconf-connector in OpenDaylight relies on ietf-netconf-monitoring
 256 support when connecting to remote NETCONF device. The
 257 ietf-netconf-monitoring support allows netconf-connector to list and
 258 download all YANG schemas that are used by the device. NETCONF connector
 259 can only communicate with a device if it knows the set of used schemas
 260 (or at least a subset). However, some devices use YANG models internally
 261 but do not support NETCONF monitoring. Netconf-connector can also
 262 communicate with these devices, but you have to side load the necessary
 263 yang models into OpenDaylight’s YANG model cache for netconf-connector.
 264 In general there are 2 situations you might encounter:
 265
 266 **1. NETCONF device does not support ietf-netconf-monitoring but it does
 267 list all its YANG models as capabilities in HELLO message**
 268
 269 This could be a device that internally uses only ietf-inet-types YANG
 270 model with revision 2010-09-24. In the HELLO message that is sent from
 271 this device there is this capability reported:
 272
 273 ::
 274
 275     urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&revision=2010-09-24
 276
 277 **For such devices you only need to put the schema into folder
 278 cache/schema inside your Karaf distribution.**
 279
 280 .. important::
 281
 282     The file with YANG schema for ietf-inet-types has to be called
 283     ietf-inet-types@2010-09-24.yang. It is the required naming format of
 284     the cache.
 285
 286 **2. NETCONF device does not support ietf-netconf-monitoring and it does
 287 NOT list its YANG models as capabilities in HELLO message**
 288
 289 Compared to device that lists its YANG models in HELLO message, in this
 290 case there would be no capability with ietf-inet-types in the HELLO
 291 message. This type of device basically provides no information about the
 292 YANG schemas it uses so its up to the user of OpenDaylight to properly
 293 configure netconf-connector for this device.
 294
 295 Netconf-connector has an optional configuration attribute called
 296 yang-module-capabilities and this attribute can contain a list of "YANG
 297 module based" capabilities. So by setting this configuration attribute,
 298 it is possible to override the "yang-module-based" capabilities reported
 299 in HELLO message of the device. To do this, we need to modify the
 300 configuration of netconf-connector like in the example below:
 301
 302 .. tabs::
 303
 304    .. tab:: XML
 305
 306       **Content-type:** ``application/xml``
 307
 308       **Accept:** ``application/xml``
 309
 310       **Authentication:** ``admin:admin``
 311
 312       .. code-block:: xml
 313
 314          <node xmlns="urn:TBD:params:xml:ns:yang:network-topology">
 315            <node-id>r5</node-id>
 316            <host xmlns="urn:opendaylight:netconf-node-topology">127.0.0.1</host>
 317            <port xmlns="urn:opendaylight:netconf-node-topology">8305</port>
 318            <username xmlns="urn:opendaylight:netconf-node-topology">root</username>
 319            <password xmlns="urn:opendaylight:netconf-node-topology">root</password>
 320            <tcp-only xmlns="urn:opendaylight:netconf-node-topology">false</tcp-only>
 321            <keepalive-delay xmlns="urn:opendaylight:netconf-node-topology">30</keepalive-delay>
 322            <yang-module-capabilities xmlns="urn:opendaylight:netconf-node-topology">
 323              <override>true</override>
 324              <capability xmlns="urn:opendaylight:netconf-node-topology">
 325                urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&amp;revision=2013-07-15
 326              </capability>
 327            </yang-module-capabilities>
 328          </node>
 329
 330    .. tab:: JSON
 331
 332       **Content-type:** ``application/json``
 333
 334       **Accept:** ``application/json``
 335
 336       **Authentication:** ``admin:admin``
 337
 338       .. code-block:: json
 339
 340          {
 341              "node": [
 342                  {
 343                      "node-id": "device",
 344                      "netconf-node-topology:host": "127.0.0.1",
 345                      "netconf-node-topology:password": "root",
 346                      "netconf-node-topology:username": "root",
 347                      "netconf-node-topology:yang-module-capabilities": {
 348                          "override": true,
 349                          "capability": [
 350                              "urn:ietf:params:xml:ns:yang:ietf-inet-types?module=ietf-inet-types&revision=2013-07-15"
 351                          ]
 352                      },
 353                      "netconf-node-topology:port": 8305,
 354                      "netconf-node-topology:tcp-only": false,
 355                      "netconf-node-topology:keepalive-delay": 30
 356                  }
 357              ]
 358          }
 359
 360 **Remember to also put the YANG schemas into the cache folder.**
 361
 362 .. note::
 363
 364     For putting multiple capabilities, you just need to replicate the
 365     capability element inside yang-module-capability element.
 366     Capability element is modeled as a leaf-list. With this
 367     configuration, we would make the remote device report usage of
 368     ietf-inet-types in the eyes of netconf-connector.
 369
 370 Connecting to a device supporting only NETCONF 1.0
 371 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 372
 373 OpenDaylight is schema-based distribution and heavily depends on YANG
 374 models. However some legacy NETCONF devices are not schema-based and
 375 implement just RFC 4741. This type of device does not utilize YANG
 376 models internally and OpenDaylight does not know how to communicate
 377 with such devices, how to validate data, or what the semantics of data
 378 are.
 379
 380 NETCONF connector can communicate also with these devices, but the
 381 trade-offs are worsened possibilities in utilization of NETCONF
 382 mountpoints. Using RESTCONF with such devices is not suported. Also
 383 communicating with schemaless devices from application code is slightly
 384 different.
 385
 386 To connect to schemaless device, there is a optional configuration option
 387 in netconf-node-topology model called schemaless. You have to set this
 388 option to true.
 389
 390 Clustered NETCONF connector
 391 ~~~~~~~~~~~~~~~~~~~~~~~~~~~
 392
 393 To spawn NETCONF connectors that are cluster-aware you need to install
 394 the ``odl-netconf-clustered-topology`` karaf feature.
 395
 396 .. warning::
 397
 398     The ``odl-netconf-topology`` and ``odl-netconf-clustered-topology``
 399     features are considered **INCOMPATIBLE**. They both manage the same
 400     space in the datastore and would issue conflicting writes if
 401     installed together.
 402
 403 Configuration of clustered NETCONF connectors works the same as the
 404 configuration through the topology model in the previous section.
 405
 406 When a new clustered connector is configured the configuration gets
 407 distributed among the member nodes and a NETCONF connector is spawned on
 408 each node. From these nodes a master is chosen which handles the schema
 409 download from the device and all the communication with the device. You
 410 will be able to read/write to/from the device from all slave nodes due
 411 to the proxy data brokers implemented.
 412
 413 You can use the ``odl-netconf-clustered-topology`` feature in a single
 414 node scenario as well but the code that uses akka will be used, so for a
 415 scenario where only a single node is used, ``odl-netconf-topology``
 416 might be preferred.
 417
 418 Netconf-connector utilization
 419 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 420
 421 Once the connector is up and running, users can utilize the new mount
 422 point instance. By using RESTCONF or from their application code. This
 423 chapter deals with using RESTCONF and more information for app
 424 developers can be found in the developers guide or in the official
 425 tutorial application **ncmount** that can be found in the coretutorials
 426 project:
 427
 428 -  https://github.com/opendaylight/coretutorials/tree/master/ncmount
 429
 430 Reading data from the device
 431 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 432
 433 Just invoke (no body needed):
 434
 435 GET
 436 http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=new-netconf-device/yang-ext:mount?content=nonconfig
 437
 438 This will return the entire content of operation datastore from the
 439 device. To view just the configuration datastore, change **nonconfig**
 440 in this URL to **config**.
 441
 442 Writing configuration data to the device
 443 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 444
 445 In general, you cannot simply write any data you want to the device. The
 446 data have to conform to the YANG models implemented by the device. In
 447 this example we are adding a new interface-configuration to the mounted
 448 device (assuming the device supports Cisco-IOS-XR-ifmgr-cfg YANG model).
 449 In fact this request comes from the tutorial dedicated to the
 450 **ncmount** tutorial app.
 451
 452 POST
 453 http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=new-netconf-device/yang-ext:mount/Cisco-IOS-XR-ifmgr-cfg:interface-configurations
 454
 455 ::
 456
 457     <interface-configuration xmlns="http://cisco.com/ns/yang/Cisco-IOS-XR-ifmgr-cfg">
 458         <active>act</active>
 459         <interface-name>mpls</interface-name>
 460         <description>Interface description</description>
 461         <bandwidth>32</bandwidth>
 462         <link-status></link-status>
 463     </interface-configuration>
 464
 465 Should return 200 response code with no body.
 466
 467 .. tip::
 468
 469     This call is transformed into a couple of NETCONF RPCs. Resulting
 470     NETCONF RPCs that go directly to the device can be found in the
 471     OpenDaylight logs after invoking ``log:set TRACE
 472     org.opendaylight.controller.sal.connect.netconf`` in the Karaf
 473     shell. Seeing the NETCONF RPCs might help with debugging.
 474
 475 This request is very similar to the one where we spawned a new netconf
 476 device. That’s because we used the loopback netconf-connector to write
 477 configuration data into config-subsystem datastore and config-subsystem
 478 picked it up from there.
 479
 480 Invoking custom RPC
 481 ^^^^^^^^^^^^^^^^^^^
 482
 483 Devices can implement any additional RPC and as long as it provides YANG
 484 models for it, it can be invoked from OpenDaylight. Following example
 485 shows how to invoke the get-schema RPC (get-schema is quite common among
 486 netconf devices). Invoke:
 487
 488 POST
 489 http://localhost:8181/rests/operations/network-topology:network-topology/topology=topology-netconf/node=new-netconf-device/yang-ext:mount/ietf-netconf-monitoring:get-schema
 490
 491 ::
 492
 493     <input xmlns="urn:ietf:params:xml:ns:yang:ietf-netconf-monitoring">
 494       <identifier>ietf-yang-types</identifier>
 495       <version>2013-07-15</version>
 496     </input>
 497
 498 This call should fetch the source for ietf-yang-types YANG model from
 499 the mounted device.
 500
 501 Netconf-connector + Netopeer
 502 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 503
 504 `Netopeer <https://github.com/cesnet/netopeer>`__ (an open-source
 505 NETCONF server) can be used for testing/exploring NETCONF southbound in
 506 OpenDaylight.
 507
 508 Netopeer installation
 509 ^^^^^^^^^^^^^^^^^^^^^
 510
 511 A `Docker <https://www.docker.com/>`__ container with netopeer will be
 512 used in this guide. To install Docker and start the `netopeer
 513 image <https://hub.docker.com/r/sysrepo/sysrepo-netopeer2>`__ perform
 514 following steps:
 515
 516 1. Install docker http://docs.docker.com/linux/step_one/
 517
 518 2. Start the netopeer image:
 519
 520    ::
 521
 522        docker run -it --name sysrepo -p 830:830 --rm sysrepo/sysrepo-netopeer2:latest
 523
 524 3. Verify netopeer is running by invoking (netopeer should send its
 525    HELLO message right away:
 526
 527    ::
 528
 529        ssh root@localhost -p 830 -s netconf
 530        (password root)
 531
 532 Mounting netopeer NETCONF server
 533 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 534
 535 Preconditions:
 536
 537 -  OpenDaylight is started with features ``odl-restconf-all`` and
 538    ``odl-netconf-connector-all``.
 539
 540 -  Netopeer is up and running in docker
 541
 542 Now just follow the section: `Spawning new NETCONF connectors`_.
 543 In the payload change the:
 544
 545 -  name, e.g., to netopeer
 546
 547 -  username/password to your system credentials
 548
 549 -  ip to localhost
 550
 551 -  port to 1831.
 552
 553 After netopeer is mounted successfully, its configuration can be read
 554 using RESTCONF by invoking:
 555
 556 GET
 557 http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=netopeer/yang-ext:mount?content:config
 558
 559 Northbound (NETCONF servers)
 560 ----------------------------
 561
 562 OpenDaylight provides 2 types of NETCONF servers:
 563
 564 -  **NETCONF server for config-subsystem (listening by default on port
 565    1830)**
 566
 567    -  Serves as a default interface for config-subsystem and allows
 568       users to spawn/reconfigure/destroy modules (or applications) in
 569       OpenDaylight
 570
 571 -  **NETCONF server for MD-SAL (listening by default on port 2830)**
 572
 573    -  Serves as an alternative interface for MD-SAL (besides RESTCONF)
 574       and allows users to read/write data from MD-SAL’s datastore and to
 575       invoke its rpcs (NETCONF notifications are not available in the
 576       Boron release of OpenDaylight)
 577
 578 .. note::
 579
 580     The reason for having 2 NETCONF servers is that config-subsystem and
 581     MD-SAL are 2 different components of OpenDaylight and require
 582     different approach for NETCONF message handling and data
 583     translation. These 2 components will probably merge in the future.
 584
 585 .. note::
 586
 587     Since Nitrogen release, there is performance regression in NETCONF
 588     servers accepting SSH connections. While opening a connection takes
 589     less than 10 seconds on Carbon, on Nitrogen time can increase up to
 590     60 seconds. Please see https://bugs.opendaylight.org/show_bug.cgi?id=9020
 591
 592 NETCONF server for config-subsystem
 593 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 594
 595 This NETCONF server is the primary interface for config-subsystem. It
 596 allows the users to interact with config-subsystem in a standardized
 597 NETCONF manner.
 598
 599 In terms of RFCs, these are supported:
 600
 601 -  `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__
 602
 603 -  `RFC-5277 <https://tools.ietf.org/html/rfc5277>`__
 604
 605 -  `RFC-6470 <https://tools.ietf.org/html/rfc6470>`__
 606
 607    -  (partially, only the schema-change notification is available in
 608       Boron release)
 609
 610 -  `RFC-6022 <https://tools.ietf.org/html/rfc6022>`__
 611
 612 For regular users it is recommended to use RESTCONF + the
 613 controller-config loopback mountpoint instead of using pure NETCONF. How
 614 to do that is spesific for each component/module/application in
 615 OpenDaylight and can be found in their dedicated user guides.
 616
 617 NETCONF server for MD-SAL
 618 ~~~~~~~~~~~~~~~~~~~~~~~~~
 619
 620 This NETCONF server is just a generic interface to MD-SAL in
 621 OpenDaylight. It uses the stadard MD-SAL APIs and serves as an
 622 alternative to RESTCONF. It is fully model driven and supports any data
 623 and rpcs that are supported by MD-SAL.
 624
 625 In terms of RFCs, these are supported:
 626
 627 -  `RFC-6241 <http://tools.ietf.org/html/rfc6241>`__
 628
 629 -  `RFC-6022 <https://tools.ietf.org/html/rfc6022>`__
 630
 631 -  `RFC-7895 <https://tools.ietf.org/html/rfc7895>`__
 632
 633 Notifications over NETCONF are not supported in the Boron release.
 634
 635 .. tip::
 636
 637     Install NETCONF northbound for MD-SAL by installing feature:
 638     ``odl-netconf-mdsal`` in karaf. Default binding port is **2830**.
 639
 640 Configuration
 641 ^^^^^^^^^^^^^
 642
 643 The default configuration can be found in file: *08-netconf-mdsal.xml*.
 644 The file contains the configuration for all necessary dependencies and a
 645 single SSH endpoint starting on port 2830. There is also a (by default
 646 disabled) TCP endpoint. It is possible to start multiple endpoints at
 647 the same time either in the initial configuration file or while
 648 OpenDaylight is running.
 649
 650 The credentials for SSH endpoint can also be configured here, the
 651 defaults are admin/admin. Credentials in the SSH endpoint are not yet
 652 managed by the centralized AAA component and have to be configured
 653 separately.
 654
 655 Verifying MD-SAL’s NETCONF server
 656 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 657
 658 After the NETCONF server is available it can be examined by a command
 659 line ssh tool:
 660
 661 ::
 662
 663     ssh admin@localhost -p 2830 -s netconf
 664
 665 The server will respond by sending its HELLO message and can be used as
 666 a regular NETCONF server from then on.
 667
 668 Mounting the MD-SAL’s NETCONF server
 669 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 670
 671 To perform this operation, just spawn a new netconf-connector as
 672 described in `Spawning new NETCONF connectors`_. Just change the ip to
 673 "127.0.0.1" port to "2830" and its name to "controller-mdsal".
 674
 675 Now the MD-SAL’s datastore can be read over RESTCONF via NETCONF by
 676 invoking:
 677
 678 GET
 679 http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=controller-mdsal/yang-ext:mount?content:nonconfig
 680
 681 .. note::
 682
 683     This might not seem very useful, since MD-SAL can be accessed
 684     directly from RESTCONF or from Application code, but the same method
 685     can be used to mount and control other OpenDaylight instances by the
 686     "master OpenDaylight".
 687
 688 NETCONF stress/performance measuring tool
 689 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 690
 691 This is basically a NETCONF client that puts NETCONF servers under heavy
 692 load of NETCONF RPCs and measures the time until a configurable amount
 693 of them is processed.
 694
 695 RESTCONF stress-performance measuring tool
 696 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 697
 698 Very similar to NETCONF stress tool with the difference of using
 699 RESTCONF protocol instead of NETCONF.
 700
 701 YANGLIB remote repository
 702 -------------------------
 703
 704 There are scenarios in NETCONF deployment, that require for a centralized
 705 YANG models repository. YANGLIB plugin provides such remote repository.
 706
 707 To start this plugin, you have to install odl-yanglib feature. Then you
 708 have to configure YANGLIB either through RESTCONF or NETCONF. We will
 709 show how to configure YANGLIB through RESTCONF.
 710
 711 YANGLIB configuration through RESTCONF
 712 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 713
 714 You have to specify what local YANG modules directory you want to provide.
 715 Then you have to specify address and port whre you want to provide YANG
 716 sources. For example, we want to serve yang sources from folder /sources
 717 on localhost:8181 adress. The configuration for this scenario will be
 718 as follows:
 719
 720 ::
 721
 722     PUT  http://localhost:8181/rests/data/yanglib:yanglib-config
 723
 724 Headers:
 725
 726 -  Accept: application/xml
 727
 728 -  Content-Type: application/xml
 729
 730 Payload:
 731
 732 ::
 733
 734     <yanglib-config xmlns="urn:opendaylight:params:xml:ns:yang:controller:yanglib:impl">
 735         <cache-folder>cache/newSchema</cache-folder>
 736         <binding-addr>localhost</binding-addr>
 737         <binding-port>8181</binding-port>
 738     </yanglib-config>
 739
 740 This should result in a 2xx response and new YANGLIB instance should be
 741 created. This YANGLIB takes all YANG sources from /sources folder and
 742 for each generates URL in form:
 743
 744 ::
 745
 746     http://localhost:8181/yanglib/schemas/{modelName}/{revision}
 747
 748 On this URL will be hosted YANG source for particular module.
 749
 750 YANGLIB instance also write this URL along with source identifier to
 751 ietf-netconf-yang-library/modules-state/module list.
 752
 753 Netconf-connector with YANG library as fallback
 754 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 755
 756 There is an optional configuration in netconf-connector called
 757 yang-library. You can specify YANG library to be plugged as additional
 758 source provider into the mount's schema repository. Since YANGLIB
 759 plugin is advertising provided modules through yang-library model, we
 760 can use it in mount point's configuration as YANG library.  To do this,
 761 we need to modify the configuration of netconf-connector by adding this
 762 XML
 763
 764 ::
 765
 766     <yang-library xmlns="urn:opendaylight:netconf-node-topology">
 767       <yang-library-url xmlns="urn:opendaylight:netconf-node-topology">http://localhost:8181/rests/data/ietf-yang-library:modules-state</yang-library-url>
 768       <username xmlns="urn:opendaylight:netconf-node-topology">admin</username>
 769       <password xmlns="urn:opendaylight:netconf-node-topology">admin</password>
 770     </yang-library>
 771
 772 This will register YANGLIB provided sources as a fallback schemas for
 773 particular mount point.
 774
 775 NETCONF Call Home
 776 -----------------
 777
 778 Call Home Installation
 779 ~~~~~~~~~~~~~~~~~~~~~~
 780
 781 ODL Call-Home server is installed in Karaf by installing karaf feature
 782 ``odl-netconf-callhome-ssh``. RESTCONF feature is recommended for
 783 configuring Call Home & testing its functionality.
 784
 785 ::
 786
 787   feature:install odl-netconf-callhome-ssh
 788
 789
 790 .. note::
 791
 792     In order to test Call Home functionality we recommend Netopeer or
 793     Netopeer2. See `Netopeer Call Home <https://github.com/CESNET/netopeer/wiki/CallHome>`__
 794     or `Netopeer2 <https://github.com/CESNET/netopeer2>`__ to learn how to
 795     enable call-home on Netopeer.
 796
 797 Northbound Call-Home API
 798 ~~~~~~~~~~~~~~~~~~~~~~~~
 799
 800 The northbound Call Home API is used for administering the Call-Home Server. The
 801 following describes this configuration.
 802
 803 Global Configuration
 804 ^^^^^^^^^^^^^^^^^^^^
 805
 806 .. important::
 807   The global configuration is not a part of the `RFC 8071
 808   <https://tools.ietf.org/html/rfc8071>`__ and, therefore, subject to change.
 809
 810 Configuring global credentials
 811 ''''''''''''''''''''''''''''''
 812
 813 ODL Call-Home server allows user to configure global credentials, which will be
 814 used for connected over SSH transport protocol devices which does not have
 815 device-specific credentials configured.
 816
 817 This is done by creating
 818 ``/odl-netconf-callhome-server:netconf-callhome-server/global/credentials``
 819 with username and passwords specified.
 820
 821 *Configuring global username & passwords to try*
 822
 823 .. code-block::
 824
 825     PUT HTTP/1.1
 826     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/global/credentials
 827     Content-Type: application/json
 828     Accept: application/json
 829
 830 .. code-block:: json
 831
 832     {
 833       "credentials":
 834       {
 835         "username": "example",
 836         "passwords": [ "first-password-to-try", "second-password-to-try" ]
 837       }
 838     }
 839
 840 Configuring to accept any ssh server key using global credentials
 841 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 842
 843 By default Netconf Call-Home Server accepts only incoming connections
 844 from allowed devices
 845 ``/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices``,
 846 if user desire to allow all incoming connections, it is possible to set
 847 ``accept-all-ssh-keys`` to ``true`` in
 848 ``/odl-netconf-callhome-server:netconf-callhome-server/global``.
 849
 850 The name of this devices in ``netconf-topology`` will be in format
 851 ``ip-address:port``. For naming devices see Device-Specific
 852 Configuration.
 853
 854 *Allowing unknown devices to connect*
 855
 856 This is a debug feature and should not be used in production. Besides being an obvious
 857 security issue, this also causes the Call-Home Server to drastically increase its output
 858 to the log.
 859
 860 .. code-block::
 861
 862     PUT HTTP/1.1
 863     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/global/accept-all-ssh-keys
 864     Content-Type: application/json
 865     Accept: application/json
 866
 867 .. code-block:: json
 868
 869     {
 870         "accept-all-ssh-keys": "true"
 871     }
 872
 873 Device-Specific Configuration
 874 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 875
 876 Netconf Call Home server supports both of the secure transports used
 877 by the Network Configuration Protocol (NETCONF) - Secure Shell (SSH),
 878 and Transport Layer Security (TLS).
 879
 880 Configure device to connect over SSH protocol
 881 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 882
 883 Netconf Call Home Server uses device provided SSH server key (host key)
 884 to identify device. The pairing of name and server key is configured in
 885 ``/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices``.
 886 This list is colloquially called a allowlist.
 887
 888 If the Call-Home Server finds the SSH host key in the allowlist, it continues
 889 to negotiate a NETCONF connection over an SSH session. If the SSH host key is
 890 not found, the connection between the Call Home server and the device is dropped
 891 immediately. In either case, the device that connects to the Call home server
 892 leaves a record of its presence in the operational store.
 893
 894 Configuring Device with Device-specific Credentials
 895 '''''''''''''''''''''''''''''''''''''''''''''''''''
 896
 897 Adding specific device to the allowed list is done by creating
 898 ``/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device={device}``
 899 with device-id and connection parameters inside the ssh-client-params container.
 900
 901 *Configuring Device with Credentials*
 902
 903 .. code-block::
 904
 905     PUT HTTP/1.1
 906     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device=example
 907     Content-Type: application/json
 908     Accept: application/json
 909
 910 .. code-block:: json
 911
 912     {
 913       "device": {
 914         "unique-id": "example",
 915         "ssh-client-params": {
 916           "credentials": {
 917             "username": "example",
 918             "passwords": [ "password" ]
 919           },
 920           "host-key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDHoH1jMjltOJnCt999uaSfc48ySutaD3ISJ9fSECe1Spdq9o9mxj0kBTTTq+2V8hPspuW75DNgN+V/rgJeoUewWwCAasRx9X4eTcRrJrwOQKzb5Fk+UKgQmenZ5uhLAefi2qXX/agFCtZi99vw+jHXZStfHm9TZCAf2zi+HIBzoVksSNJD0VvPo66EAvLn5qKWQD4AdpQQbKqXRf5/W8diPySbYdvOP2/7HFhDukW8yV/7ZtcywFUIu3gdXsrzwMnTqnATSLPPuckoi0V2jd8dQvEcu1DY+rRqmqu0tEkFBurlRZDf1yhNzq5xWY3OXcjgDGN+RxwuWQK3cRimcosH"
 921         }
 922       }
 923     }
 924
 925 Configuring Device with Global Credentials
 926 '''''''''''''''''''''''''''''''''''''''''''''''''''
 927
 928 It is possible to omit ``username`` and ``password`` for ssh-client-params,
 929 in such case values from global credentials will be used.
 930
 931 *Example of configuring device*
 932
 933 .. code-block::
 934
 935     PUT HTTP/1.1
 936     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device=example
 937     Content-Type: application/json
 938     Accept: application/json
 939
 940 .. code-block:: json
 941
 942     {
 943       "device": {
 944         "unique-id": "example",
 945         "ssh-client-params": {
 946           "host-key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDHoH1jMjltOJnCt999uaSfc48ySutaD3ISJ9fSECe1Spdq9o9mxj0kBTTTq+2V8hPspuW75DNgN+V/rgJeoUewWwCAasRx9X4eTcRrJrwOQKzb5Fk+UKgQmenZ5uhLAefi2qXX/agFCtZi99vw+jHXZStfHm9TZCAf2zi+HIBzoVksSNJD0VvPo66EAvLn5qKWQD4AdpQQbKqXRf5/W8diPySbYdvOP2/7HFhDukW8yV/7ZtcywFUIu3gdXsrzwMnTqnATSLPPuckoi0V2jd8dQvEcu1DY+rRqmqu0tEkFBurlRZDf1yhNzq5xWY3OXcjgDGN+RxwuWQK3cRimcosH"
 947         }
 948       }
 949     }
 950
 951 Deprecated configuration models for devices accessed with SSH protocol
 952 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 953
 954 With `RFC 8071 <https://tools.ietf.org/html/rfc8071>`__ alignment and adding
 955 support for TLS transport following configuration models has been marked
 956 deprecated.
 957
 958 Configuring Device with Global Credentials
 959 '''''''''''''''''''''''''''''''''''''''''''''''''''
 960
 961 *Example of configuring device*
 962
 963 .. code-block::
 964
 965     PUT HTTP/1.1
 966     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device=example
 967     Content-Type: application/json
 968     Accept: application/json
 969
 970 .. code-block:: json
 971
 972     {
 973       "device": {
 974         "unique-id": "example",
 975         "ssh-host-key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDHoH1jMjltOJnCt999uaSfc48ySutaD3ISJ9fSECe1Spdq9o9mxj0kBTTTq+2V8hPspuW75DNgN+V/rgJeoUewWwCAasRx9X4eTcRrJrwOQKzb5Fk+UKgQmenZ5uhLAefi2qXX/agFCtZi99vw+jHXZStfHm9TZCAf2zi+HIBzoVksSNJD0VvPo66EAvLn5qKWQD4AdpQQbKqXRf5/W8diPySbYdvOP2/7HFhDukW8yV/7ZtcywFUIu3gdXsrzwMnTqnATSLPPuckoi0V2jd8dQvEcu1DY+rRqmqu0tEkFBurlRZDf1yhNzq5xWY3OXcjgDGN+RxwuWQK3cRimcosH"
 976       }
 977     }
 978
 979 Configuring Device with Device-specific Credentials
 980 '''''''''''''''''''''''''''''''''''''''''''''''''''
 981
 982 Call Home Server also allows to configure credentials per device basis,
 983 this is done by introducing ``credentials`` container into
 984 device-specific configuration. Format is same as in global credentials.
 985
 986 *Configuring Device with Credentials*
 987
 988 .. code-block::
 989
 990     PUT HTTP/1.1
 991     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device=example
 992     Content-Type: application/json
 993     Accept: application/json
 994
 995 .. code-block:: json
 996
 997     {
 998       "device": {
 999         "unique-id": "example",
1000         "credentials": {
1001           "username": "example",
1002           "passwords": [ "password" ]
1003         },
1004         "ssh-host-key": "AAAAB3NzaC1yc2EAAAADAQABAAABAQDHoH1jMjltOJnCt999uaSfc48ySutaD3ISJ9fSECe1Spdq9o9mxj0kBTTTq+2V8hPspuW75DNgN+V/rgJeoUewWwCAasRx9X4eTcRrJrwOQKzb5Fk+UKgQmenZ5uhLAefi2qXX/agFCtZi99vw+jHXZStfHm9TZCAf2zi+HIBzoVksSNJD0VvPo66EAvLn5qKWQD4AdpQQbKqXRf5/W8diPySbYdvOP2/7HFhDukW8yV/7ZtcywFUIu3gdXsrzwMnTqnATSLPPuckoi0V2jd8dQvEcu1DY+rRqmqu0tEkFBurlRZDf1yhNzq5xWY3OXcjgDGN+RxwuWQK3cRimcosH"
1005       }
1006     }
1007
1008 Configure device to connect over TLS protocol
1009 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1010
1011 Netconf Call Home Server allows devices to use TLS transport protocol to
1012 establish a connection towards the NETCONF device. This communication
1013 requires proper setup to make two-way TLS authentication possible for client
1014 and server.
1015
1016 The initial step is to configure certificates and keys for two-way TLS by
1017 storing them within the netconf-keystore.
1018
1019 *Adding a client private key credential to the netconf-keystore*
1020
1021 .. code-block::
1022
1023     POST HTTP/1.1
1024     /rests/operations/netconf-keystore:add-keystore-entry
1025     Content-Type: application/json
1026     Accept: application/json
1027
1028 .. code-block:: json
1029
1030   {
1031     "input": {
1032       "key-credential": [
1033         {
1034           "key-id": "example-client-key-id",
1035           "private-key": "base64encoded-private-key",
1036           "passphrase": "passphrase"
1037         }
1038       ]
1039     }
1040   }
1041
1042 *Associate a private key with a client and CA certificates chain*
1043
1044 .. code-block::
1045
1046     POST HTTP/1.1
1047     /rests/operations/netconf-keystore:add-private-key
1048     Content-Type: application/json
1049     Accept: application/json
1050
1051 .. code-block:: json
1052
1053   {
1054     "input": {
1055       "private-key": [
1056         {
1057           "name": "example-client-key-id",
1058           "data": "key-data",
1059           "certificate-chain": [
1060             "certificate-data"
1061           ]
1062         }
1063       ]
1064     }
1065   }
1066
1067 *Add a list of trusted CA and server certificates*
1068
1069 .. code-block::
1070
1071     POST HTTP/1.1
1072     /rests/operations/netconf-keystore:add-trusted-certificate
1073     Content-Type: application/json
1074     Accept: application/json
1075
1076 .. code-block:: json
1077
1078   {
1079     "input": {
1080       "trusted-certificate": [
1081         {
1082           "name": "example-ca-certificate",
1083           "certificate": "ca-certificate-data"
1084         },
1085         {
1086           "name": "example-server-certificate",
1087           "certificate": "server-certificate-data"
1088         }
1089       ]
1090     }
1091   }
1092
1093 In a second step, it is required to create an allowed device associated with
1094 a server certificate and client key. The server certificate will be used to
1095 identify and pin the NETCONF device during SSL handshake and should be unique
1096 among the allowed devices.
1097
1098 *Add device configuration for TLS protocol to allowed devices list*
1099
1100 .. code-block::
1101
1102     PUT HTTP/1.1
1103     /rests/data/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices/device=example-device
1104     Content-Type: application/json
1105     Accept: application/json
1106
1107 .. code-block:: json
1108
1109   {
1110     "device": {
1111       "unique-id": "example-device",
1112       "tls-client-params": {
1113         "key-id": "example-client-key-id",
1114         "certificate-id": "example-server-certificate"
1115       }
1116     }
1117   }
1118
1119 Operational Status
1120 ^^^^^^^^^^^^^^^^^^
1121
1122 Once an entry is made into the config side of "allowed-devices", the Call-Home Server will
1123 populate an corresponding operational device that is the same as the config device but
1124 has an additional status. By default, this status is *DISCONNECTED*. Once a device calls
1125 home, this status will change to one of:
1126
1127 *CONNECTED* — The device is currently connected and the NETCONF mount is available for network
1128 management.
1129
1130 *FAILED_AUTH_FAILURE* — The last attempted connection was unsuccessful because the Call-Home
1131 Server was unable to provide the acceptable credentials of the device. The device is also
1132 disconnected and not available for network management.
1133
1134 *FAILED_NOT_ALLOWED* — The last attempted connection was unsuccessful because the device was
1135 not recognized as an acceptable device. The device is also disconnected and not available for
1136 network management.
1137
1138 *FAILED* — The last attempted connection was unsuccessful for a reason other than not
1139 allowed to connect or incorrect client credentials. The device is also disconnected and not
1140 available for network management.
1141
1142 *DISCONNECTED* — The device is currently disconnected.
1143
1144 Rogue Devices
1145 '''''''''''''
1146
1147 Devices which are not on the allowlist might try to connect to the Call-Home Server. In
1148 these cases, the server will keep a record by instantiating an operational device. There
1149 will be no corresponding config device for these rogues. They can be identified readily
1150 because their device id, rather than being user-supplied, will be of the form
1151 "address:port". Note that if a device calls back multiple times, there will only be
1152 a single operatinal entry (even if the port changes); these devices are recognized by
1153 their unique host key.
1154
1155 Southbound Call-Home API
1156 ~~~~~~~~~~~~~~~~~~~~~~~~
1157
1158 The Call-Home Server listens for incoming TCP connections and assumes that the other side of
1159 the connection is a device calling home via a NETCONF connection with SSH for
1160 management. The server uses port 4334 by default and this can be configured via a
1161 blueprint configuration file.
1162
1163 The device **must** initiate the connection and the server will not try to re-establish the
1164 connection in case of a drop. By requirement, the server cannot assume it has connectivity
1165 to the device due to NAT or firewalls among others.
1166
1167 Reading data with selected fields
1168 ---------------------------------
1169
1170 Overview
1171 ~~~~~~~~
1172
1173 If user would like to read only selected fields from NETCONF device, it is possible to use
1174 fields query parameter that is described by RFC-8040. RESTCONF parses content of query
1175 parameter into format that is accepted by NETCONF subtree filtering - filtering of data is done
1176 on NETCONF server, not on NETCONF client side. This approach optimizes network traffic load,
1177 because data in which user doesn't have interest, is not transferred over network.
1178
1179 Next advantages:
1180
1181 * using single RESTCONF request and single NETCONF RPC for reading multiple subtrees
1182 * possibility to read only selected fields under list node across multiple hierarchies
1183   (it cannot be done without proper selection API)
1184
1185 .. note::
1186
1187   More information about fields query parameter: `RFC 8071 <https://tools.ietf.org/html/rfc8040#section-4.8.3>`__
1188
1189 Preparation of data
1190 ~~~~~~~~~~~~~~~~~~~
1191
1192 For demonstration, we will define next YANG model:
1193
1194 ::
1195
1196     module test-module {
1197         yang-version 1.1;
1198         namespace "urn:opendaylight:test-module";
1199         prefix "tm";
1200         revision "2023-02-16";
1201
1202         container root {
1203             container simple-root {
1204                 leaf leaf-a {
1205                     type string;
1206                 }
1207                 leaf leaf-b {
1208                     type string;
1209                 }
1210                 leaf-list ll {
1211                     type string;
1212                 }
1213                 container nested {
1214                     leaf sample-x {
1215                         type boolean;
1216                     }
1217                     leaf sample-y {
1218                         type boolean;
1219                     }
1220                 }
1221             }
1222
1223             container list-root {
1224                 leaf branch-ab {
1225                     type int32;
1226                 }
1227                 list top-list {
1228                     key "key-1 key-2";
1229                     ordered-by user;
1230                     leaf key-1 {
1231                         type string;
1232                     }
1233                     leaf key-2 {
1234                         type string;
1235                     }
1236                     container next-data {
1237                         leaf switch-1 {
1238                             type empty;
1239                         }
1240                         leaf switch-2 {
1241                             type empty;
1242                         }
1243                     }
1244                     list nested-list {
1245                         key "identifier";
1246                         leaf identifier {
1247                             type string;
1248                         }
1249                         leaf foo {
1250                             type int32;
1251                         }
1252                     }
1253                 }
1254             }
1255         }
1256     }
1257
1258 Follow the :doc:`testtool` instructions to save this schema and run it with testtool.
1259
1260 Mounting NETCONF device that runs on NETCONF testtool:
1261
1262 .. code-block:: bash
1263
1264   curl --location --request PUT 'http://127.0.0.1:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=testtool' \
1265   --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
1266   --header 'Content-Type: application/json' \
1267   --data-raw '{
1268       "node": [
1269           {
1270               "node-id": "testtool",
1271               "netconf-node-topology:host": "127.0.0.1",
1272               "netconf-node-topology:port": 17830,
1273               "netconf-node-topology:keepalive-delay": 100,
1274               "netconf-node-topology:tcp-only": false,
1275               "netconf-node-topology:username": "admin",
1276               "netconf-node-topology:password": "admin"
1277           }
1278       ]
1279   }'
1280
1281 Setting initial configuration on NETCONF device:
1282
1283 .. code-block:: bash
1284
1285   curl --location --request PUT 'http://127.0.0.1:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=testtool/yang-ext:mount/test-module:root' \
1286   --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
1287   --header 'Content-Type: application/json' \
1288   --data-raw '{
1289       "root": {
1290           "simple-root": {
1291               "leaf-a": "asddhg",
1292               "leaf-b": "ffffff",
1293               "ll": [
1294                   "str1",
1295                   "str2",
1296                   "str3"
1297               ],
1298               "nested": {
1299                   "sample-x": true,
1300                   "sample-y": false
1301               }
1302           },
1303           "list-root": {
1304               "branch-ab": 5,
1305               "top-list": [
1306                   {
1307                       "key-1": "ka",
1308                       "key-2": "kb",
1309                       "next-data": {
1310                           "switch-1": [
1311                               null
1312                           ],
1313                           "switch-2": [
1314                               null
1315                           ]
1316                       },
1317                       "nested-list": [
1318                           {
1319                               "identifier": "f1",
1320                               "foo": 1
1321                           },
1322                           {
1323                               "identifier": "f2",
1324                               "foo": 10
1325                           },
1326                           {
1327                               "identifier": "f3",
1328                               "foo": 20
1329                           }
1330                       ]
1331                   },
1332                   {
1333                       "key-1": "kb",
1334                       "key-2": "ka",
1335                       "next-data": {
1336                           "switch-1": [
1337                               null
1338                           ]
1339                       },
1340                       "nested-list": [
1341                           {
1342                               "identifier": "e1",
1343                               "foo": 1
1344                           },
1345                           {
1346                               "identifier": "e2",
1347                               "foo": 2
1348                           },
1349                           {
1350                               "identifier": "e3",
1351                               "foo": 3
1352                           }
1353                       ]
1354                   },
1355                   {
1356                       "key-1": "kc",
1357                       "key-2": "ke",
1358                       "next-data": {
1359                           "switch-2": [
1360                               null
1361                           ]
1362                       },
1363                       "nested-list": [
1364                           {
1365                               "identifier": "q1",
1366                               "foo": 13
1367                           },
1368                           {
1369                               "identifier": "q2",
1370                               "foo": 14
1371                           },
1372                           {
1373                               "identifier": "q3",
1374                               "foo": 15
1375                           }
1376                       ]
1377                   }
1378               ]
1379           }
1380       }
1381   }'
1382
1383 Examples
1384 --------
1385
1386 1. Reading whole leaf-list 'll' and leaf 'nested/sample-x' under 'simple-root' container.
1387
1388 RESTCONF request:
1389
1390 .. code-block:: bash
1391
1392     curl --location --request GET 'http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=testtool/yang-ext:mount/test-module:root/simple-root?content=config&fields=ll;nested/sample-x' \
1393     --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
1394     --header 'Cookie: JSESSIONID=node01h4w82eorc1k61866b71qjgj503.node0'
1395
1396 Generated NETCONF RPC request:
1397
1398 .. code-block:: xml
1399
1400     <rpc message-id="m-18" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1401         <get-config>
1402             <source>
1403                 <running/>
1404             </source>
1405             <filter xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0" ns0:type="subtree">
1406                 <root xmlns="urn:ietf:params:xml:ns:yang:test-model">
1407                     <simple-root>
1408                         <ll/>
1409                         <nested>
1410                             <sample-x/>
1411                         </nested>
1412                     </simple-root>
1413                 </root>
1414             </filter>
1415         </get-config>
1416     </rpc>
1417
1418 .. note::
1419
1420     Using fields query parameter it is also possible to read whole leaf-list or list without
1421     necessity to specify value / key predicate (without reading parent entity). Such scenario
1422     is not permitted in RFC-8040 paths alone - fields query parameter can be used as
1423     workaround for this case.
1424
1425 RESTCONF response:
1426
1427 .. code-block:: json
1428
1429     {
1430         "test-module:simple-root": {
1431             "ll": [
1432                 "str3",
1433                 "str1",
1434                 "str2"
1435             ],
1436             "nested": {
1437                 "sample-x": true
1438             }
1439         }
1440     }
1441
1442 2. Reading all identifiers of 'nested-list' under all elements of 'top-list'.
1443
1444 RESTCONF request:
1445
1446 .. code-block:: bash
1447
1448     curl --location --request GET 'http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=testtool/yang-ext:mount/test-module:root/list-root?content=config&fields=top-list(nested-list/identifier)' \
1449     --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
1450     --header 'Cookie: JSESSIONID=node01h4w82eorc1k61866b71qjgj503.node0'
1451
1452 Generated NETCONF RPC request:
1453
1454 .. code-block:: xml
1455
1456     <rpc message-id="m-27" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1457         <get-config>
1458             <source>
1459                 <running/>
1460             </source>
1461             <filter xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0" ns0:type="subtree">
1462                 <root xmlns="urn:ietf:params:xml:ns:yang:test-model">
1463                     <list-root>
1464                         <top-list>
1465                             <nested-list>
1466                                 <identifier/>
1467                             </nested-list>
1468                             <key-1/>
1469                             <key-2/>
1470                         </top-list>
1471                     </list-root>
1472                 </root>
1473             </filter>
1474         </get-config>
1475     </rpc>
1476
1477 .. note::
1478
1479     NETCONF client automatically fetches values of list keys since they are required for correct
1480     deserialization of NETCONF response and at the end serialization of response to RESTCONF
1481     response (JSON/XML).
1482
1483 RESTCONF response:
1484
1485 .. code-block:: json
1486
1487     {
1488         "test-module:list-root": {
1489             "top-list": [
1490                 {
1491                     "key-1": "ka",
1492                     "key-2": "kb",
1493                     "nested-list": [
1494                         {
1495                             "identifier": "f3"
1496                         },
1497                         {
1498                             "identifier": "f2"
1499                         },
1500                         {
1501                             "identifier": "f1"
1502                         }
1503                     ]
1504                 },
1505                 {
1506                     "key-1": "kb",
1507                     "key-2": "ka",
1508                     "nested-list": [
1509                         {
1510                             "identifier": "e3"
1511                         },
1512                         {
1513                             "identifier": "e2"
1514                         },
1515                         {
1516                             "identifier": "e1"
1517                         }
1518                     ]
1519                 },
1520                 {
1521                     "key-1": "kc",
1522                     "key-2": "ke",
1523                     "nested-list": [
1524                         {
1525                             "identifier": "q3"
1526                         },
1527                         {
1528                             "identifier": "q2"
1529                         },
1530                         {
1531                             "identifier": "q1"
1532                         }
1533                     ]
1534                 }
1535             ]
1536         }
1537     }
1538
1539 3. Reading value of leaf 'branch-ab' and all values of leaves 'switch-1' that are placed
1540    under 'top-list' list elements.
1541
1542 RESTCONF request:
1543
1544 .. code-block:: bash
1545
1546     curl --location --request GET 'http://localhost:8181/rests/data/network-topology:network-topology/topology=topology-netconf/node=testtool/yang-ext:mount/test-module:root/list-root?content=config&fields=branch-ab;top-list/next-data/switch-1' \
1547     --header 'Authorization: Basic YWRtaW46YWRtaW4=' \
1548     --header 'Cookie: JSESSIONID=node01jx6o5thwae9t1ft7c2zau5zbz4.node0'
1549
1550 Generated NETCONF RPC request:
1551
1552 .. code-block:: xml
1553
1554     <rpc message-id="m-42" xmlns="urn:ietf:params:xml:ns:netconf:base:1.0">
1555         <get-config>
1556             <source>
1557                 <running/>
1558             </source>
1559             <filter xmlns:ns0="urn:ietf:params:xml:ns:netconf:base:1.0" ns0:type="subtree">
1560                 <root xmlns="urn:ietf:params:xml:ns:yang:test-model">
1561                     <list-root>
1562                         <branch-ab/>
1563                         <top-list>
1564                             <next-data>
1565                                 <switch-1/>
1566                             </next-data>
1567                             <key-1/>
1568                             <key-2/>
1569                         </top-list>
1570                     </list-root>
1571                 </root>
1572             </filter>
1573         </get-config>
1574     </rpc>
1575
1576 RESTCONF response:
1577
1578 .. code-block:: json
1579
1580     {
1581         "test-module:list-root": {
1582             "branch-ab": 5,
1583             "top-list": [
1584                 {
1585                     "key-1": "ka",
1586                     "key-2": "kb",
1587                     "next-data": {
1588                         "switch-1": [
1589                             null
1590                         ]
1591                     }
1592                 },
1593                 {
1594                     "key-1": "kb",
1595                     "key-2": "ka",
1596                     "next-data": {
1597                         "switch-1": [
1598                             null
1599                         ]
1600                     }
1601                 },
1602                 {
1603                     "key-1": "kc",
1604                     "key-2": "ke"
1605                 }
1606             ]
1607         }
1608     }