tailf-netconf-query

This module introduces five new rpc operations to run advanced search queries. The operation 'start-query' starts a query, with...

  • Version: 2017-01-06

    tailf-netconf-query@2017-01-06


    
      module tailf-netconf-query {
    
        yang-version 1;
    
        namespace
          "http://tail-f.com/ns/netconf/query";
    
        prefix tfncq;
    
        import tailf-common {
          prefix tailf;
        }
        import tailf-common-query {
          prefix tfcq;
        }
    
        organization "Tail-f Systems";
    
        description
          "This module introduces five new rpc operations to run
         advanced search queries.
    
         The operation 'start-query' starts a query, with some search
         conditions and control parameters for how to return the results.
         This operation returns a query handle, to be used in subsequent
         operations.
    
         The operation 'fetch-query-result' is repeatedly to get result
         chunks from the query evaluation.
    
         The operation 'immediate-query' is used to start a new query, and return
         the entire result.
    
         The operation 'reset-query' can be used to restart the query.
    
         Finally 'stop-query' is used to clean up query resources on the
         server.
    
         Copyright 2019 Cisco Systems, Inc.
         All rights reserved.
         Permission is hereby granted to redistribute this file without
         modification.";
    
        revision "2017-01-06" {
          description
            "Released as part of ConfD-6.5.2.1 / NCS-4.5.3.
    
           Added 'immediate-query' function.";
        }
    
        revision "2014-11-13" {
          description "Initial revision.";
        }
    
        tailf:export "netconf";
    
        rpc start-query {
          input {
            uses tfcq:start-query-parameters;
          }
    
          output {
            uses tfcq:query-handle;
          }
        }  // rpc start-query
    
        rpc fetch-query-result {
          input {
            uses tfcq:query-handle;
          }
    
          output {
            container query-result {
              uses tfcq:query-result;
            }  // container query-result
          }
        }  // rpc fetch-query-result
    
        rpc immediate-query {
          input {
            uses tfcq:start-query-parameters;
          }
    
          output {
            container query-result {
              uses tfcq:query-result;
            }  // container query-result
          }
        }  // rpc immediate-query
    
        rpc reset-query {
          input {
            uses tfcq:reset-query-parameters;
          }
        }  // rpc reset-query
    
        rpc stop-query {
          input {
            uses tfcq:query-handle;
          }
        }  // rpc stop-query
      }  // module tailf-netconf-query
    

© 2023 YumaWorks, Inc. All rights reserved.