doc/manpages/ospfclient.rst

   1 **********
   2 OSPFCLIENT
   3 **********
   4
   5 .. include:: defines.rst
   6
   7 SYNOPSIS
   8 ========
   9 ospfclient <ospfd> <lsatype> <opaquetype> <opaqueid> <ifaddr> <areaid>
  10
  11 DESCRIPTION
  12 ===========
  13 ospfclient is an example ospf-api client to test the ospfd daemon.
  14
  15 OPTIONS
  16 =======
  17
  18 .. option:: ospfd
  19
  20    A router where the API-enabled OSPF daemon is running.
  21
  22 .. option:: lsatype
  23
  24    The value has to be either "9", "10", or "11", depending on the flooding scope.
  25
  26 .. option:: opaquetype
  27
  28    The value has to be in the range of 0-255 (for example, experimental applications might use opaquetype larger than 128).
  29
  30 .. option:: opaqueid
  31
  32    Arbitrary application instance (24 bits).
  33
  34 .. option:: ifaddr
  35
  36    Interface IP address for type 9, otherwise it will be ignored.
  37
  38 .. option:: areaid
  39
  40    Area in the IP address format for type 10, otherwise it will be ignored.
  41
  42
  43 .. include:: epilogue.rst