Skip to content

Commit

Permalink
Updated Network Routes definition
Browse files Browse the repository at this point in the history
  • Loading branch information
nemesifier committed Apr 25, 2015
1 parent d8ec21a commit 3b6754d
Showing 1 changed file with 8 additions and 5 deletions.
13 changes: 8 additions & 5 deletions README.rst
Expand Up @@ -134,10 +134,10 @@ The object should be composed of the following members:

.. _monitoring-data.json: https://github.com/interop-dev/network-device-schema/blob/master/examples/monitoring-data.json

Routing Protocol Routes
=======================
Network Routes
==============

**Definition**: routes representing a network topology or indicating the presence of a routing protocol running on a device (in a ``DeviceConfiguration`` object)
**Definition**: a list of routes of a dynamic routing protocol or statically configured on the device. May be contained in a ``DeviceConfiguration`` object.

**Example**: `network-routes.json`_

Expand All @@ -150,9 +150,12 @@ It must define the following members:

It might also define the optional member ``router_id``, which represent the ID of the router on which the protocol is running.

When representing a network topology, a ``Network Routes`` object must define the following members:
When contained in a ``DeviceConfiguration``, a ``Network Routes`` object indicates
either that a routing protocol is running on the device or that static routes have been set; in this case the member ``routes`` is required only for static routes.

* ``metric``: a string which indicates the name of main routing metric used by the routing protocol to determine the best routes when sending packets
When self contained, a ``Network Routes`` object represents a routing table and must define the following members:

* ``metric``: a string which indicates the name of main routing metric used by the routing protocol to determine the best routes when sending packets **it can be omitted when representing static routes**
* ``routes``: an array containing a list of routes

Each ``route`` object must define the following members:
Expand Down

0 comments on commit 3b6754d

Please sign in to comment.