tailf-netconf-extensions

This module contains Tail-f specific optional augments and RPC:s. Extends the 'lock' RPC with a parameter 'wait-time'. The RPC...

  • Version: 2019-04-09

    tailf-netconf-extensions@2019-04-09


    
      module tailf-netconf-extensions {
    
        yang-version 1.1;
    
        namespace
          "http://tail-f.com/ns/netconf/extensions";
    
        prefix tfnce;
    
        import ietf-netconf {
          prefix nc;
        }
        import tailf-common {
          prefix tailf;
        }
    
        organization "Tail-f Systems";
    
        description
          "This module contains Tail-f specific optional augments and RPC:s.
    
         Extends the 'lock' RPC with a parameter 'wait-time'.
    
         The RPC 'has-children' provides the means for a client to prune
         the data-model when traversing the database.
    
         The RPC 'get-attributes' retrieves attributes for a single data
         node in an efficient manner.
    
         Copyright 2019 Cisco Systems, Inc.
         All rights reserved.
         Permission is hereby granted to redistribute this file without
         modification.";
    
        revision "2019-04-09" {
          description
            "Released as part of ConfD-7.1
    
           Added 'wait-time' support to the 'lock' RPC.";
        }
    
        revision "2015-06-16" {
          description "Initial revision.";
        }
    
        tailf:export "netconf";
    
        augment /nc:lock/nc:input {
          leaf wait-time {
            type union {
              type uint32;
              type enumeration {
                enum "infinity" {
                  value 0;
                }
              }
            }
            units "seconds";
            description
              "If this parameter is given, and the lock is already held by
             some other session, the server waits for the specified amount
             of seconds for the lock to be released. If the lock cannot be
             granted within the specified amount of time, a 'lock-denied'
             error is returned.";
          }
        }
    
        rpc has-children {
          description
            "Used to find out whether a container or list instance is empty or
           not.  Returns false if and only if the sub-tree is guaranteed to not
           contain any configuration data, otherwise 'maybe'.";
          input {
            leaf path {
              type instance-identifier;
            }
          }
    
          output {
            leaf result {
              type enumeration {
                enum "maybe" {
                  value 0;
                  description
                    "Data may exist below <path>.";
                }
                enum "false" {
                  value 1;
                  description
                    "No data exists below <path>.";
                }
              }
            }
          }
        }  // rpc has-children
    
        rpc get-attributes {
          description
            "Retrieves the meta-data attributes for a data node.
           The attributes are returned as XML attributes
           in the <result> leaf.";
          input {
            leaf path {
              type instance-identifier;
            }
          }
    
          output {
            leaf result {
              type enumeration {
                enum "ok" {
                  value 0;
                  description
                    "Attribute list in meta-data of this node.";
                }
                enum "not_found" {
                  value 1;
                  description
                    "Data node not found.";
                }
              }
            }
          }
        }  // rpc get-attributes
      }  // module tailf-netconf-extensions
    

© 2023 YumaWorks, Inc. All rights reserved.