Netconf stack by default locks the data store before issuing
[netconf.git] / netconf / sal-netconf-connector / src / main / yang / netconf-node-optional.yang
1 module netconf-node-optional {
2     namespace "urn:opendaylight:netconf-node-optional";
3     prefix "netnopt";
4
5     import network-topology { prefix nt; revision-date 2013-10-21; }
6
7     revision "2019-06-14" {
8         description "Initial revision of Node Locking model";
9     }
10
11     container netconf-node-fields-optional {
12         description "Allows to create node's optional value with the path mapping according to
13             the network-topology -> topology -> node";
14         list topology {
15             key topology-id;
16             leaf topology-id {
17                 type nt:topology-id;
18                 description "The name of node's topology";
19             }
20             list node {
21                 key node-id;
22                 leaf node-id {
23                     type nt:node-id;
24                     description "The identifier of a node in the topology";
25                 }
26                 // Containers allow to create specific data-change-listener directly on a node's optional value.
27                 // In the future, it'll be easy to extend the node by optional node fields in this way. Do not create
28                 // direct leafs here, please.
29                 container datastore-lock {
30                     description "Allows to ignore lock/unlock node's datastare.";
31                     leaf datastore-lock-allowed {
32                         type boolean;
33                         default true;
34                         description "The operation allows the client to lock the entire configuration datastore
35                             system of a device.
36                             WARNING - With blocking the lock/unlock operations, the user is coming to operate
37                             in a manner which is not supported. It must not exist any concurrent access to
38                             the data store - it may interfere with data consistency.";
39                     }
40                 }
41             }
42         }
43     }
44 }