Remove this section after page migration is complete

Welcome to JSON-RPC2.0


Detailed Introduction and information about the project

The JSON RPC 2.0 aims to provide a binding for ODL Datastore, RPC and Notification operations and map them onto JSON RPC 2.0 calls over ZMQ and HTTP(S) transports. Other transports may be added as needed at a later date.

API agreement between ODL and the other JSON RPC endpoint is achieved by ensuring that they both use the same YANG model to describe all arguments in the RPC call. This includes core operations such as datastore access as well as any additional calls needed to implement service functions such as endpoint discovery, etc.

All data used in any of the JSON RPC 2.0 calls uses the same version of draft-json-netmod-yang as used in ODL (presently version 6). The project relies on existing Binding Independent APIs developed for netconf, does not require any changes in core ODL functionality and does not require any new APIs.

In addition to the ODL extension, the project also aims to provide a fully featured suite of libraries, bindings and tools for several languages to consume and produce data via JSON-RPC 2.0 in RFC 7951 as produced and consumed by ODL.

The specifics of using yang modeled data in JSON RPC 2.0 are described in detail in an IETF draft. The most up-to-date version is in draft-yang-json-rpc. This draft covers all applicable argument conventions. It does not cover various extensions necessary to achieve high performance when interfacing to opendaylight and other large scale systems. These are described in detail on the JSON-RPC2.0::AsynchronousJSONRPCExtension pages.

While RPC and data modeling in the context of extending ODL (and other yang based systems) are fairly straight-forward, there is a number of issues regarding the definitions of a transaction and integrity checking for off-ODL datastore operations. These are discussed in detail in: JSON-RPC2.0::TransactionSemantics. The rest of the datastore extension interface including data tree change notifications is covered in JSON-RPC2.0::ExtendingTheDataStore

Last, but not least an essential part of any extension of functionality via remote procedure calling is the mapping of a remote procedure endpoint to a transport endpoint as well as how all of these mappings join together to form a consistent picture. This is described in detail in JSON-RPC2.0::ConfigurationAndGovernance.

JSON-RPC2.0 Driven South-Bound

  • Openswitch API Exposure. OpenSwitch is another Linux foundation project which is building an OS for white box switches. It has work-in-progress JSON RPC2.0 Norhtbound (southbound relative to ODL) plugin
  • JSON RPC 2.0 Driven Option 82 DHCP Agent - this is a capability test/demo developed in the process of building the OpenSwitch DHCP Agent. It provides a fully featured DHCP Relay capable of inserting Option 82 on a standard Linux bridges.

Project Facts

Project Creation Date: April 21, 2016
Lifecycle State: Incubation
Primary Contact: Anton Ivanov (aivanov) <>
Project Lead:  Anton Ivanov (aivanov) <>
Committers:  This field will need to be maintained by the PTL.  LF is currently working on automating this in the future
Mailing List:
    Archives: mailing list archives
Meetings: See Community Meetings Ensure Meetings listed on central Meeting page
Repository: git clone
Jenkins: jenkins silo
Gerrit Patches: code patches/reviews

Feel free to edit this section as necessary


Link to ReadTheDocs Project documentation.  i.e.:

Getting Started for Users

Getting Started for Developers


Release Planning

Release Notes