Revision 178a197a doc/bird.sgml

View differences:

doc/bird.sgml
2288 2288
<code>
2289 2289
protocol ospf &lt;name&gt; {
2290 2290
	rfc1583compat &lt;switch&gt;;
2291
	instance id &lt;num&gt;;
2291 2292
	stub router &lt;switch&gt;;
2292 2293
	tick &lt;num&gt;;
2293 2294
	ecmp &lt;switch&gt; [limit &lt;num&gt;];
......
2375 2376
	RFC 1583 <htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc1583.txt">.
2376 2377
	Default	value is no.
2377 2378

  
2379
	<tag>instance id <m/num/</tag>
2380
	When multiple OSPF protocol instances are active on the same links, they
2381
	should use different instance IDs to distinguish their packets. Although
2382
	it could be done on per-interface basis, it is often preferred to set
2383
	one instance ID to whole OSPF domain/topology (e.g., when multiple
2384
	instances are used to represent separate logical topologies on the same
2385
	physical network). This option specifies the default instance ID for all
2386
	interfaces of the OSPF instance. Note that this option, if used, must
2387
	precede interface definitions. Default value is 0.
2388

  
2378 2389
	<tag>stub router <M>switch</M></tag>
2379 2390
	This option configures the router to be a stub router, i.e., a router
2380 2391
	that participates in the OSPF topology but does not allow transit
2381 2392
	traffic. In OSPFv2, this is implemented by advertising maximum metric
2382
	for outgoing links, as suggested by
2383
	RFC 3137 <htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc3137.txt">.
2384
	In OSPFv3, the stub router behavior is announced by clearing the R-bit
2385
	in the router LSA. Default value is no.
2393
	for outgoing links. In OSPFv3, the stub router behavior is announced by
2394
	clearing the R-bit in the router LSA. See RFC 6987
2395
	<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc6987.txt"> for
2396
	details. Default value is no.
2386 2397

  
2387 2398
	<tag>tick <M>num</M></tag>
2388 2399
	The routing table calculation and clean-up of areas' databases is not
......
2484 2495
	prefix. When option <cf/summary/ is used, also default stub networks
2485 2496
	that are subnetworks of given stub network are suppressed. This might be
2486 2497
	used, for example, to aggregate generated stub networks.
2487
	 
2498

  
2488 2499
	<tag>interface <M>pattern</M> [instance <m/num/]</tag>
2489 2500
	Defines that the specified interfaces belong to the area being defined.
2490 2501
	See <ref id="dsc-iface" name="interface"> common option for detailed
2491 2502
	description. In OSPFv2, extended interface clauses are used, because
2492
	OSPFv2 handles each network prefix as a separate virtual interface. In
2493
	OSPFv3, you can specify instance ID for that interface description, so
2494
	it is possible to have several instances of that interface with
2495
	different options or even in different areas.
2503
	each network prefix is handled as a separate virtual interface.
2504

  
2505
	You can specify alternative instance ID for the interface definition,
2506
	therefore it is possible to have several instances of that interface
2507
	with different options or even in different areas. For OSPFv2,
2508
	instance ID support is an extension (RFC 6549
2509
	<htmlurl url="ftp://ftp.rfc-editor.org/in-notes/rfc6549.txt">) and is
2510
	supposed to be set per-protocol. For OSPFv3, it is an integral feature.
2496 2511

  
2497 2512
	<tag>virtual link <M>id</M> [instance <m/num/]</tag>
2498 2513
	Virtual link to router with the router id. Virtual link acts as a
2499 2514
	point-to-point interface belonging to backbone. The actual area is used
2500
	as transport area. This item cannot be in the backbone. In OSPFv3, you
2501
	could also use several virtual links to one destination with different
2502
	instance IDs.
2515
	as a transport area. This item cannot be in the backbone. Like with
2516
	<cf/interface/ option, you could also use several virtual links to one
2517
	destination with different instance IDs.
2503 2518

  
2504 2519
	<tag>cost <M>num</M></tag>
2505 2520
	Specifies output cost (metric) of an interface. Default value is 10.
......
2530 2545

  
2531 2546
	<tag>wait <M>num</M></tag>
2532 2547
	After start, router waits for the specified number of seconds between
2533
	starting election and building adjacency. Default value is 40.
2534
	 
2548
	starting election and building adjacency. Default value is 4*<m/hello/.
2549

  
2535 2550
	<tag>dead count <M>num</M></tag>
2536 2551
	When the router does not receive any messages from a neighbor in
2537 2552
	<m/dead count/*<m/hello/ seconds, it will consider the neighbor down.

Also available in: Unified diff