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 @deffn {OSPF6 Command} {auto-cost reference-bandwidth @var{cost}} {}
  70 @deffnx {OSPF6 Command} {no auto-cost reference-bandwidth} {}
  71 This sets the reference bandwidth for cost calculations, where this
  72 bandwidth is considered equivalent to an OSPF cost of 1, specified in
  73 Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s
  74 or higher will have a cost of 1. Cost of lower bandwidth links will be
  75 scaled with reference to this cost).
  76
  77 This configuration setting MUST be consistent across all routers
  78 within the OSPF domain.
  79 @end deffn
  80
  81 @node OSPF6 area
  82 @section OSPF6 area
  83
  84 Area support for OSPFv3 is not yet implemented.
  85
  86 @node OSPF6 interface
  87 @section OSPF6 interface
  88
  89 @deffn {Interface Command} {ipv6 ospf6 cost COST} {}
  90 Sets interface's output cost.  Default value depends on the interface
  91 bandwidth and on the auto-cost reference bandwidth.
  92 @end deffn
  93
  94 @deffn {Interface Command} {ipv6 ospf6 hello-interval HELLOINTERVAL} {}
  95 Sets interface's Hello Interval.  Default 40
  96 @end deffn
  97
  98 @deffn {Interface Command} {ipv6 ospf6 dead-interval DEADINTERVAL} {}
  99 Sets interface's Router Dead Interval.  Default value is 40.
 100 @end deffn
 101
 102 @deffn {Interface Command} {ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL} {}
 103 Sets interface's Rxmt Interval.  Default value is 5.
 104 @end deffn
 105
 106 @deffn {Interface Command} {ipv6 ospf6 priority PRIORITY} {}
 107 Sets interface's Router Priority.  Default value is 1.
 108 @end deffn
 109
 110 @deffn {Interface Command} {ipv6 ospf6 transmit-delay TRANSMITDELAY} {}
 111 Sets interface's Inf-Trans-Delay.  Default value is 1.
 112 @end deffn
 113
 114 @deffn {Interface Command} {ipv6 ospf6 network (broadcast|point-to-point)} {}
 115 Set explicitly network type for specifed interface.
 116 @end deffn
 117
 118 @node Redistribute routes to OSPF6
 119 @section Redistribute routes to OSPF6
 120
 121 @deffn {OSPF6 Command} {redistribute static} {}
 122 @deffnx {OSPF6 Command} {redistribute connected} {}
 123 @deffnx {OSPF6 Command} {redistribute ripng} {}
 124 @end deffn
 125
 126 @node Showing OSPF6 information
 127 @section Showing OSPF6 information
 128
 129 @deffn {Command} {show ipv6 ospf6 [INSTANCE_ID]} {}
 130 INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
 131 instance ID, simply type "show ipv6 ospf6 <cr>".
 132 @end deffn
 133
 134 @deffn {Command} {show ipv6 ospf6 database} {}
 135 This command shows LSA database summary.  You can specify the type of LSA.
 136 @end deffn
 137
 138 @deffn {Command} {show ipv6 ospf6 interface} {}
 139 To see OSPF interface configuration like costs.
 140 @end deffn
 141
 142 @deffn {Command} {show ipv6 ospf6 neighbor} {}
 143 Shows state and chosen (Backup) DR of neighbor.
 144 @end deffn
 145
 146 @deffn {Command} {show ipv6 ospf6 request-list A.B.C.D} {}
 147 Shows requestlist of neighbor.
 148 @end deffn
 149
 150 @deffn {Command} {show ipv6 route ospf6} {}
 151 This command shows internal routing table.
 152 @end deffn
 153
 154 @node OSPF6 Configuration Examples
 155 @section OSPF6 Configuration Examples
 156
 157 Example of ospf6d configured on one interface and area:
 158
 159 @example
 160 interface eth0
 161  ipv6 ospf6 instance-id 0
 162 !
 163 router ospf6
 164  router-id 212.17.55.53
 165  area 0.0.0.0 range 2001:770:105:2::/64
 166  interface eth0 area 0.0.0.0
 167 !
 168 @end example