This is an archive of the ONOS 1.4 wiki. For the current ONOS wiki, look here.

This section describes how to use the network configuration service to configure network elements and ONOS’ network view.



The network configuration service enables applications and operators to configure the network and ONOS’ network view using a uniform syntax, currently JSON. Examples include:

  • Device and device port types and names
  • Device location, owner, hardware and software versions
  • Wether components are allowed or denied inclusion in the network model

This service doesn’t limit configuration to the network elements that ONOS has knowledge of - configurations can also refer to yet-discovered elements, or those that cannot be discovered by conventional means.



subject key describes the category of network element, e.g. links, devices, hosts, etc. Each network element is associated with a unique identifier (a subject) and one or more attributes, associated with some value, grouped into configs. The configs themselves are classified by config keys.

The JSON file used with the service then takes on the following format:

    subject key : {                   # element category, e.g. "devices", "links", etc.
        subject : {                   # unique string, e.g. a device ID
            config key 1 : {          # config class of config, e.g. "basic"
                attr1 : value1,       # attribute : value pairs associated with a config
                attr2 : value2,

Sample configuration files may be found in ${ONOS_ROOT}/tools/test/configs/ .


Loading Network Configurations



The NetworkConfigWebResource implements the REST calls for the network configuration subsystem. Its functionalities will eventually replace that of ConfigWebResource.

The following example uses the REST API to upload a configuration file:


curl --user onos:rocks -X POST -H "Content-Type: application/json" -d @/tmp/cfg.json


The above assumes a running instance at, and a configuration file at /tmp/cfg.json. These should be replaced with appropriate values.

Likewise, the user:password combination might differ with your setup; Other common values are karaf:karaf and onos:onos.

onos-netcfg shell script

There is a shell script that wraps the REST API to provide a more convenient mechanism to upload configuration from the command line (i.e. from outside ONOS).

For example, the same configuration above can be uploaded using:

onos-netcfg /tmp/cfg.json

The script also accepts a third argument that allows you to upload smaller chunks of config identified by subject_key/subject/config_key:

onos-netcfg $OC1 /tmp/basic.json /devices/of:0000000000000001/basic

Here the /tmp/basic.json script would just contain the payload of the basic config key, for example:

   "driver" : "softrouter"



Network Configuration Loader

The NetworkConfigLoader reads JSON files from a known location and attempts to load them as network configurations at system startup.

Currently, a file named network-cfg.json is picked up from ${ONOS_ROOT}/tools/package/config/ and placed in ${KARAF_ROOT}../config/ at deployment. The filename and paths are currently fixed. When the remote instance boots, its network configuration loader runtime will read this file.

The Network Configuration Loader is implemented as a listener for Network Configuration events (NetworkConfigEvents). It attempts to use the known Configs in order to generate or update entities in the network model once it is notified that the Configs are available.

  • No labels