]> git.proxmox.com Git - mirror_frr.git/blob - doc/user/ospf6d.rst
Merge pull request #13649 from donaldsharp/unlock_the_node_or_else
[mirror_frr.git] / doc / user / ospf6d.rst
1 .. _ospfv3:
2
3 ******
4 OSPFv3
5 ******
6
7 *ospf6d* is a daemon support OSPF version 3 for IPv6 network. OSPF for IPv6 is
8 described in :rfc:`2740`.
9
10 .. _ospf6-router:
11
12 OSPF6 router
13 ============
14
15 .. index:: router ospf6
16 .. clicmd:: router ospf6
17
18 .. index:: router-id A.B.C.D
19 .. clicmd:: router-id A.B.C.D
20
21 Set router's Router-ID.
22
23 .. index:: interface IFNAME area AREA
24 .. clicmd:: interface IFNAME area AREA
25
26 Bind interface to specified area, and start sending OSPF packets. `area` can
27 be specified as 0.
28
29 .. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
30 .. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME
31
32 .. index:: no timers throttle spf
33 .. clicmd:: no timers throttle spf
34
35 This command sets the initial `delay`, the `initial-holdtime`
36 and the `maximum-holdtime` between when SPF is calculated and the
37 event which triggered the calculation. The times are specified in
38 milliseconds and must be in the range of 0 to 600000 milliseconds.
39
40 The `delay` specifies the minimum amount of time to delay SPF
41 calculation (hence it affects how long SPF calculation is delayed after
42 an event which occurs outside of the holdtime of any previous SPF
43 calculation, and also serves as a minimum holdtime).
44
45 Consecutive SPF calculations will always be separated by at least
46 'hold-time' milliseconds. The hold-time is adaptive and initially is
47 set to the `initial-holdtime` configured with the above command.
48 Events which occur within the holdtime of the previous SPF calculation
49 will cause the holdtime to be increased by `initial-holdtime`, bounded
50 by the `maximum-holdtime` configured with this command. If the adaptive
51 hold-time elapses without any SPF-triggering event occurring then
52 the current holdtime is reset to the `initial-holdtime`.
53
54 .. code-block:: frr
55
56 router ospf6
57 timers throttle spf 200 400 10000
58
59
60 In this example, the `delay` is set to 200ms, the initial holdtime is set
61 to 400ms and the `maximum holdtime` to 10s. Hence there will always be at
62 least 200ms between an event which requires SPF calculation and the actual
63 SPF calculation. Further consecutive SPF calculations will always be
64 separated by between 400ms to 10s, the hold-time increasing by 400ms each
65 time an SPF-triggering event occurs within the hold-time of the previous
66 SPF calculation.
67
68 .. index:: auto-cost reference-bandwidth COST
69 .. clicmd:: auto-cost reference-bandwidth COST
70
71 .. index:: no auto-cost reference-bandwidth
72 .. clicmd:: no auto-cost reference-bandwidth
73
74 This sets the reference bandwidth for cost calculations, where this
75 bandwidth is considered equivalent to an OSPF cost of 1, specified in
76 Mbits/s. The default is 100Mbit/s (i.e. a link of bandwidth 100Mbit/s
77 or higher will have a cost of 1. Cost of lower bandwidth links will be
78 scaled with reference to this cost).
79
80 This configuration setting MUST be consistent across all routers
81 within the OSPF domain.
82
83 .. _ospf6-area:
84
85 OSPF6 area
86 ==========
87
88 Area support for OSPFv3 is not yet implemented.
89
90 .. _ospf6-interface:
91
92 OSPF6 interface
93 ===============
94
95 .. index:: ipv6 ospf6 cost COST
96 .. clicmd:: ipv6 ospf6 cost COST
97
98 Sets interface's output cost. Default value depends on the interface
99 bandwidth and on the auto-cost reference bandwidth.
100
101 .. index:: ipv6 ospf6 hello-interval HELLOINTERVAL
102 .. clicmd:: ipv6 ospf6 hello-interval HELLOINTERVAL
103
104 Sets interface's Hello Interval. Default 10
105
106 .. index:: ipv6 ospf6 dead-interval DEADINTERVAL
107 .. clicmd:: ipv6 ospf6 dead-interval DEADINTERVAL
108
109 Sets interface's Router Dead Interval. Default value is 40.
110
111 .. index:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
112 .. clicmd:: ipv6 ospf6 retransmit-interval RETRANSMITINTERVAL
113
114 Sets interface's Rxmt Interval. Default value is 5.
115
116 .. index:: ipv6 ospf6 priority PRIORITY
117 .. clicmd:: ipv6 ospf6 priority PRIORITY
118
119 Sets interface's Router Priority. Default value is 1.
120
121 .. index:: ipv6 ospf6 transmit-delay TRANSMITDELAY
122 .. clicmd:: ipv6 ospf6 transmit-delay TRANSMITDELAY
123
124 Sets interface's Inf-Trans-Delay. Default value is 1.
125
126 .. index:: ipv6 ospf6 network (broadcast|point-to-point)
127 .. clicmd:: ipv6 ospf6 network (broadcast|point-to-point)
128
129 Set explicitly network type for specified interface.
130
131 .. _redistribute-routes-to-ospf6:
132
133 Redistribute routes to OSPF6
134 ============================
135
136 .. index:: redistribute static
137 .. clicmd:: redistribute static
138
139 .. index:: redistribute connected
140 .. clicmd:: redistribute connected
141
142 .. index:: redistribute ripng
143 .. clicmd:: redistribute ripng
144
145
146 .. _showing-ospf6-information:
147
148 Showing OSPF6 information
149 =========================
150
151 .. index:: show ipv6 ospf6 [INSTANCE_ID]
152 .. clicmd:: show ipv6 ospf6 [INSTANCE_ID]
153
154 INSTANCE_ID is an optional OSPF instance ID. To see router ID and OSPF
155 instance ID, simply type "show ipv6 ospf6 <cr>".
156
157 .. index:: show ipv6 ospf6 database
158 .. clicmd:: show ipv6 ospf6 database
159
160 This command shows LSA database summary. You can specify the type of LSA.
161
162 .. index:: show ipv6 ospf6 interface
163 .. clicmd:: show ipv6 ospf6 interface
164
165 To see OSPF interface configuration like costs.
166
167 .. index:: show ipv6 ospf6 neighbor
168 .. clicmd:: show ipv6 ospf6 neighbor
169
170 Shows state and chosen (Backup) DR of neighbor.
171
172 .. index:: show ipv6 ospf6 request-list A.B.C.D
173 .. clicmd:: show ipv6 ospf6 request-list A.B.C.D
174
175 Shows requestlist of neighbor.
176
177 .. index:: show ipv6 route ospf6
178 .. clicmd:: show ipv6 route ospf6
179
180 This command shows internal routing table.
181
182 .. index:: show ipv6 ospf6 zebra
183 .. clicmd:: show ipv6 ospf6 zebra
184
185 Shows state about what is being redistributed between zebra and OSPF6
186
187 OSPF6 Configuration Examples
188 ============================
189
190 Example of ospf6d configured on one interface and area:
191
192 .. code-block:: frr
193
194 interface eth0
195 ipv6 ospf6 instance-id 0
196 !
197 router ospf6
198 router-id 212.17.55.53
199 area 0.0.0.0 range 2001:770:105:2::/64
200 interface eth0 area 0.0.0.0
201 !