docs/mediator.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. SPDX-License-Identifier: CC-BY-4.0
   3 .. Copyright (C) 2020 highstreet technologies and others
   4
   5 .. contents::
   6    :depth: 3
   7 ..
   8
   9 Mediator
  10 ========
  11
  12 A 'Mediator' provides an external -  to the physical network function -
  13 OAM interface.
  14
  15 Some physical network function manufactures use the
  16 `generic mediator
  17 framework <https://github.com/Melacon/NetConf2SNMP>`__. Such mediators
  18 offer a management API to control mediator function.
  19
  20 New mediator servers can be added via the '+' button. Afterward, a
  21 server can be selected to view all available mediator instances.
  22
  23 A mediator instance can be started, stopped and deleted using the
  24 available actions. Additionally, its details can be viewed. The '+'
  25 button allows the user to add a new instance. During the creation, at
  26 least one 'ODL auto connect' configuration must be added.