gRPC Network Management Interface (gNMI)
draft-openconfig-rtgwg-gnmi-spec-01

Document Type Active Internet-Draft (individual)
Last updated 2018-03-05
Stream (None)
Intended RFC status (None)
Formats plain text pdf html bibtex
Stream Stream state (No stream defined)
Consensus Boilerplate Unknown
RFC Editor Note (None)
IESG IESG state I-D Exists
Telechat date
Responsible AD (None)
Send notices to (None)
Network Working Group                                          R. Shakir
Internet-Draft                                                 A. Shaikh
Intended status: Informational                                 P. Borman
Expires: September 6, 2018                                      M. Hines
                                                              C. Lebsack
                                                               C. Morrow
                                                                  Google
                                                           March 5, 2018

                gRPC Network Management Interface (gNMI)
                  draft-openconfig-rtgwg-gnmi-spec-01

Abstract

   This document describes the gRPC Network Management Interface (gNMI),
   a network management protocol based on the gRPC framework.  gNMI
   supports retrieval and manipulation of state from network elements
   where the data is represented by a tree structure, and addressable by
   paths.  The gNMI service defines operations for configuration
   management, operational state retrieval, and bulk data collection via
   streaming telemetry.  The authoritative gNMI specification is
   maintained at [GNMI-SPEC].

Status of This Memo

   This Internet-Draft is submitted in full conformance with the
   provisions of BCP 78 and BCP 79.

   Internet-Drafts are working documents of the Internet Engineering
   Task Force (IETF).  Note that other groups may also distribute
   working documents as Internet-Drafts.  The list of current Internet-
   Drafts is at http://datatracker.ietf.org/drafts/current/.

   Internet-Drafts are draft documents valid for a maximum of six months
   and may be updated, replaced, or obsoleted by other documents at any
   time.  It is inappropriate to use Internet-Drafts as reference
   material or to cite them other than as "work in progress."

   This Internet-Draft will expire on September 6, 2018.

Copyright Notice

   Copyright (c) 2018 IETF Trust and the persons identified as the
   document authors.  All rights reserved.

   This document is subject to BCP 78 and the IETF Trust's Legal
   Provisions Relating to IETF Documents

Shakir, et al.          Expires September 6, 2018               [Page 1]
Internet-Draft             gNMI specification                 March 2018

   (http://trustee.ietf.org/license-info) in effect on the date of
   publication of this document.  Please review these documents
   carefully, as they describe your rights and restrictions with respect
   to this document.  Code Components extracted from this document must
   include Simplified BSD License text as described in Section 4.e of
   the Trust Legal Provisions and are provided without warranty as
   described in the Simplified BSD License.

Table of Contents

   1.  Introduction  . . . . . . . . . . . . . . . . . . . . . . . .   2
   2.  Terminology . . . . . . . . . . . . . . . . . . . . . . . . .   3
   3.  Protocol overview . . . . . . . . . . . . . . . . . . . . . .   3
     3.1.  Data payloads and paths . . . . . . . . . . . . . . . . .   3
     3.2.  gNMI RPCs . . . . . . . . . . . . . . . . . . . . . . . .   4
       3.2.1.  Capabilities  . . . . . . . . . . . . . . . . . . . .   4
       3.2.2.  Subscribe . . . . . . . . . . . . . . . . . . . . . .   5
       3.2.3.  Set . . . . . . . . . . . . . . . . . . . . . . . . .   5
       3.2.4.  Get . . . . . . . . . . . . . . . . . . . . . . . . .   5
   4.  Additional operations . . . . . . . . . . . . . . . . . . . .   5
     4.1.  Error handling  . . . . . . . . . . . . . . . . . . . . .   6
     4.2.  gNMI Extensions . . . . . . . . . . . . . . . . . . . . .   6
   5.  Security Considerations . . . . . . . . . . . . . . . . . . .   6
   6.  IANA Considerations . . . . . . . . . . . . . . . . . . . . .   6
   7.  References  . . . . . . . . . . . . . . . . . . . . . . . . .   6
     7.1.  Normative references  . . . . . . . . . . . . . . . . . .   6
     7.2.  Informative references  . . . . . . . . . . . . . . . . .   6
   Appendix A.  Change summary . . . . . . . . . . . . . . . . . . .   7
     A.1.  Changes between revisions -00 and -01 . . . . . . . . . .   7
   Authors' Addresses  . . . . . . . . . . . . . . . . . . . . . . .   8

1.  Introduction

   This document provides an overview of gNMI, a gRPC-based protocol for
   state management on network elements [GRPC].The gRPC Network
   Management Interface (gNMI) supports modification and retrieval of
   configuration, as well as control and transmission telemetry streams
   from a network element to a data collection system.This allows a
   single implementation on the network element, as well as a single NMS
   element to interact with the device via telemetry and configuration
   RPCs.

   All messages within the gRPC service definition are defined as
   protocol buffers (specifically proto3) [PROTO].gRPC service
   definitions are described using the relevant features of the protobuf
Show full document text