doc/ospf6d.texi

   1 @node OSPFv3
   2 @chapter OSPFv3
   3
   4 @command{ospf6d} is a daemon support OSPF version 3 for IPv6 network.
   5 OSPF for IPv6 is described in RFC2740.
   6
   7 @menu
   8 * OSPF6 router::
   9 * OSPF6 area::
  10 * OSPF6 interface::
  11 * Redistribute routes to OSPF6::
  12 * Showing OSPF6 information::
  13 * OSPF6 Configuration Examples::
  14 @end menu
  15
  16 @node OSPF6 router
  17 @section OSPF6 router
  18
  19 @deffn {Command} {router ospf6} {}
  20 @end deffn
  21
  22 @deffn {OSPF6 Command} {router-id @var{a.b.c.d}} {}
  23 Set router's Router-ID.
  24 @end deffn
  25
  26 @deffn {OSPF6 Command} {interface @var{ifname} area @var{area}} {}
  27 Bind interface to specified area, and start sending OSPF packets.  @var{area} can
  28 be specified as 0.
  29 @end deffn
  30
  31 @deffn {OSPF6 Command} {timers throttle spf @var{delay} @var{initial-holdtime} @var{max-holdtime}} {}
  32 @deffnx {OSPF6 Command} {no timers throttle spf} {}
  33 This command sets the initial @var{delay}, the @var{initial-holdtime}
  34 and the @var{maximum-holdtime} between when SPF is calculated and the
  35 event which triggered the calculation. The times are specified in
  36 milliseconds and must be in the range of 0 to 600000 milliseconds.
  37
  38 The @var{delay} specifies the minimum amount of time to delay SPF
  39 calculation (hence it affects how long SPF calculation is delayed after
  40 an event which occurs outside of the holdtime of any previous SPF
  41 calculation, and also serves as a minimum holdtime).
  42
  43 Consecutive SPF calculations will always be seperated by at least
  44 'hold-time' milliseconds. The hold-time is adaptive and initially is
  45 set to the @var{initial-holdtime} configured with the above command.
  46 Events which occur within the holdtime of the previous SPF calculation
  47 will cause the holdtime to be increased by @var{initial-holdtime}, bounded
  48 by the @var{maximum-holdtime} configured with this command. If the adaptive
  49 hold-time elapses without any SPF-triggering event occuring then
  50 the current holdtime is reset to the @var{initial-holdtime}.
  51
  52 @example
  53 @group
  54 router ospf6
  55  timers throttle spf 200 400 10000
  56 @end group
  57 @end example
  58
  59 In this example, the @var{delay} is set to 200ms, the @var{initial
  60 holdtime} is set to 400ms and the @var{maximum holdtime} to 10s. Hence
  61 there will always be at least 200ms between an event which requires SPF
  62 calculation and the actual SPF calculation. Further consecutive SPF
  63 calculations will always be seperated by between 400ms to 10s, the
  64 hold-time increasing by 400ms each time an SPF-triggering event occurs
  65 within the hold-time of the previous SPF calculation.
  66
  67 @end deffn
  68
  69 @node OSPF6 area
  70 @section OSPF6 area
  71
  72 Area support for OSPFv3 is not yet implemented.
  73
  74 @node OSPF6 interface
  75 @section OSPF6 interface
  76
  77 @deffn {Interface Command} {ipv6 ospf6 cost COST} {}
  78 Sets interface's output cost.  Default value is 1.
  79 @end deffn
  80
  81 @deffn {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {}
  82 Sets interface's Hello Interval.  Default 40
  83 @end deffn
  84
  85 @deffn {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {}
  86 Sets interface's Router Dead Interval.  Default value is 40.
  87 @end deffn
  88
  89 @deffn {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {}
  90 Sets interface's Rxmt Interval.  Default value is 5.
  91 @end deffn
  92
  93 @deffn {Interface Command} {ipv6 ospf6 priority PRIORITY} {}
  94 Sets interface's Router Priority.  Default value is 1.
  95 @end deffn
  96
  97 @deffn {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {}
  98 Sets interface's Inf-Trans-Delay.  Default value is 1.
  99 @end deffn
 100
 101 @deffn {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {}
 102 Set explicitly network type for specifed interface.
 103 @end deffn
 104
 105 @node Redistribute routes to OSPF6
 106 @section Redistribute routes to OSPF6
 107
 108 @deffn {OSPF6 Command} {redistribute static} {}
 109 @deffnx {OSPF6 Command} {redistribute connected} {}
 110 @deffnx {OSPF6 Command} {redistribute ripng} {}
 111 @end deffn
 112
 113 @node Showing OSPF6 information
 114 @section Showing OSPF6 information
 115
 116 @deffn {Command} {show ipv6 ospf6 [INSTANCE_ID]} {}
 117 INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
 118 instance ID, simply type "show ipv6 ospf6 <cr>".
 119 @end deffn
 120
 121 @deffn {Command} {show ipv6 ospf6 database} {}
 122 This command shows LSA database summary.  You can specify the type of LSA.
 123 @end deffn
 124
 125 @deffn {Command} {show ipv6 ospf6 interface} {}
 126 To see OSPF interface configuration like costs.
 127 @end deffn
 128
 129 @deffn {Command} {show ipv6 ospf6 neighbor} {}
 130 Shows state and chosen (Backup) DR of neighbor.
 131 @end deffn
 132
 133 @deffn {Command} {show ipv6 ospf6 request-list A.B.C.D} {}
 134 Shows requestlist of neighbor.
 135 @end deffn
 136
 137 @deffn {Command} {show ipv6 route ospf6} {}
 138 This command shows internal routing table.
 139 @end deffn
 140
 141 @node OSPF6 Configuration Examples
 142 @section OSPF6 Configuration Examples
 143
 144 Example of ospf6d configured on one interface and area:
 145
 146 @example
 147 interface eth0
 148  ipv6 ospf6 instance-id 0
 149 !
 150 router ospf6
 151  router-id 212.17.55.53
 152  area 0.0.0.0 range 2001:770:105:2::/64
 153  interface eth0 area 0.0.0.0
 154 !
 155 @end example