sdnr/model/yang/ietf-netconf-partial-lock@2009-10-19.yang

   1 module ietf-netconf-partial-lock {
   2
   3   namespace urn:ietf:params:xml:ns:netconf:partial-lock:1.0;
   4   prefix pl;
   5
   6   // needed to force data type of select string to be corect
   7   import ietf-yang-types { prefix yang; }
   8
   9   organization "IETF Network Configuration (netconf) Working Group";
  10
  11   contact
  12    "Netconf Working Group
  13     Mailing list: netconf@ietf.org
  14     Web: http://www.ietf.org/html.charters/netconf-charter.html
  15
  16     Balazs Lengyel
  17     Ericsson
  18     balazs.lengyel@ericsson.com";
  19
  20   description
  21    "This YANG module defines the <partial-lock> and
  22     <partial-unlock> operations.";
  23
  24   revision 2009-10-19 {
  25     description
  26      "Initial version, published as RFC 5717.";
  27   }
  28
  29   typedef lock-id-type {
  30     type uint32;
  31     description
  32      "A number identifying a specific partial-lock granted to a session.
  33       It is allocated by the system, and SHOULD be used in the
  34       partial-unlock operation.";
  35   }
  36
  37   rpc partial-lock {
  38     description
  39      "A NETCONF operation that locks parts of the running datastore.";
  40     input {
  41       leaf-list select {
  42         //type string;
  43         type yang:xpath1.0;
  44         min-elements 1;
  45         description
  46          "XPath expression that specifies the scope of the lock.
  47           An Instance Identifier expression MUST be used unless the
  48           :xpath capability is supported, in which case any XPath 1.0
  49           expression is allowed.";
  50       }
  51     }
  52     output {
  53       leaf lock-id {
  54         type lock-id-type;
  55         mandatory true;
  56         description
  57          "Identifies the lock, if granted.  The lock-id SHOULD be
  58           used in the partial-unlock rpc.";
  59       }
  60       leaf-list locked-node {
  61         type instance-identifier;
  62         min-elements 1;
  63         description
  64          "List of locked nodes in the running datastore";
  65       }
  66     }
  67   }
  68
  69   rpc partial-unlock {
  70     description
  71      "A NETCONF operation that releases a previously acquired
  72       partial-lock.";
  73     input {
  74       leaf lock-id {
  75         type lock-id-type;
  76         mandatory true;
  77         description
  78          "Identifies the lock to be released.  MUST be the value
  79           received in the response to a partial-lock operation.";
  80       }
  81     }
  82   }
  83 }