yumaworks-yp-gnmi

Package gNMI defines a service specification for the gRPC Network Management Interface. This interface is defined to be a standa...

  • Version: 2023-08-04

    yumaworks-yp-gnmi@2023-08-04


    
      module yumaworks-yp-gnmi {
    
        yang-version 1.1;
    
        namespace
          "http://yumaworks.com/ns/yumaworks-yp-gnmi";
    
        prefix ypgnmi;
    
        import ietf-yang-structure-ext {
          prefix sx;
        }
        import yumaworks-ycontrol {
          prefix yctl;
        }
        import yuma-types {
          prefix yt;
        }
    
        organization "YumaWorks, Inc.";
    
        contact
          "Support <support at yumaworks.com>";
    
        description
          "Package gNMI defines a service specification for the gRPC
           Network Management Interface. This interface is defined to
           be a standard interface via which a network management system
           ('client') can subscribe to state values, retrieve snapshots of
           state information, and manipulate the state of a data tree
           supported by a device ('target').
    
           This document references the gNMI Specification which can be
           found at:
           http://github.com/openconfig/reference/blob/master/rpc/gnmi
    
           Licensed under the Apache License, Version 2.0 (the 'License');
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at:
           http://www.apache.org/licenses/LICENSE-2.0
    
    
           YumaPro gNMI message definitions.
           Copyright (c) 2014 - 2023, YumaWorks, Inc. All rights reserved.
    
           Redistribution and use in source and binary forms, with or
           without modification, is permitted pursuant to, and subject
           to the license terms contained in, the BSD 3-Clause License
           http://opensource.org/licenses/BSD-3-Clause
           ";
    
        revision "2023-08-04" {
          description
            "22.10T-11: Change CLI container to sx:structure";
        }
    
        revision "2018-02-05" {
          description
            "Initial version for datastore access.";
        }
    
        sx:augment-structure "/yctl:ycontrol/yctl:message-payload/yctl:payload/yctl:payload";
    
        typedef supported-encoding {
          type enumeration {
            enum "json_val" {
              value 0;
              description
                "A JSON encoded string";
            }
            enum "bytes_val" {
              value 1;
              description
                "An arbitrary sequence of bytes";
            }
            enum "any_val" {
              value 2;
              description
                "A Protobuf encoded message using protobuf.any";
            }
            enum "ascii_val" {
              value 3;
              description
                "An ASCII encoded string representing text
                 formatted according to a target-defined convention";
            }
            enum "json_ietf_val" {
              value 4;
              description
                "A JSON encoded string using JSON encoding compatible
                 with [RFC 7951]";
            }
          }
        }
      }  // module yumaworks-yp-gnmi
    

© 2023 YumaWorks, Inc. All rights reserved.