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