7 OpenFabric, specified in :t:`draft-white-openfabric-06.txt`, is a routing
8 protocol derived from IS-IS, providing link-state routing with efficient
9 flooding for topologies like spine-leaf networks.
11 FRR implements OpenFabric in a daemon called *fabricd*
13 .. _configuring-fabricd:
18 There are no *fabricd* specific options. Common options can be specified
19 (:ref:`common-invocation-options`) to *fabricd*. *fabricd* needs to acquire
20 interface information from *zebra* in order to function. Therefore *zebra* must
21 be running before invoking *fabricd*. Also, if *zebra* is restarted then *fabricd*
24 Like other daemons, *fabricd* configuration is done in an OpenFabric specific
25 configuration file :file:`fabricd.conf`.
27 .. _openfabric-router:
32 To enable the OpenFabric routing protocol, an OpenFabric router needs to be created
35 .. index:: router openfabric WORD
36 .. clicmd:: router openfabric WORD
38 .. index:: no router openfabric WORD
39 .. clicmd:: no router openfabric WORD
41 Enable or disable the OpenFabric process by specifying the OpenFabric domain with
44 .. index:: net XX.XXXX. ... .XXX.XX
45 .. clicmd:: net XX.XXXX. ... .XXX.XX
47 .. index:: no net XX.XXXX. ... .XXX.XX
48 .. clicmd:: no net XX.XXXX. ... .XXX.XX
50 Set/Unset network entity title (NET) provided in ISO format.
52 .. index:: domain-password [clear | md5] <password>
53 .. clicmd:: domain-password [clear | md5] <password>
55 .. index:: no domain-password
56 .. clicmd:: no domain-password
58 Configure the authentication password for a domain, as clear text or md5 one.
60 .. index:: log-adjacency-changes
61 .. clicmd:: log-adjacency-changes
63 .. index:: no log-adjacency-changes
64 .. clicmd:: no log-adjacency-changes
66 Log changes in adjacency state.
68 .. index:: set-overload-bit
69 .. clicmd:: set-overload-bit
71 .. index:: no set-overload-bit
72 .. clicmd:: no set-overload-bit
74 Set overload bit to avoid any transit traffic.
76 .. index:: purge-originator
77 .. clicmd:: purge-originator
79 .. index:: no purge-originator
80 .. clicmd:: no purge-originator
82 Enable or disable :rfc:`6232` purge originator identification.
84 .. index:: fabric-tier (0-14)
85 .. clicmd:: fabric-tier (0-14)
87 .. index:: no fabric-tier
88 .. clicmd:: no fabric-tier
90 Configure a static tier number to advertise as location in the fabric
97 .. index:: lsp-gen-interval (1-120)
98 .. clicmd:: lsp-gen-interval (1-120)
100 .. index:: no lsp-gen-interval
101 .. clicmd:: no lsp-gen-interval
103 Set minimum interval in seconds between regenerating same LSP.
105 .. index:: lsp-refresh-interval (1-65235)
106 .. clicmd:: lsp-refresh-interval (1-65235)
108 .. index:: no lsp-refresh-interval
109 .. clicmd:: no lsp-refresh-interval
111 Set LSP refresh interval in seconds.
113 .. index:: max-lsp-lifetime (360-65535)
114 .. clicmd:: max-lsp-lifetime (360-65535)
116 .. index:: no max-lsp-lifetime
117 .. clicmd:: no max-lsp-lifetime
119 Set LSP maximum LSP lifetime in seconds.
121 .. index:: spf-interval (1-120)
122 .. clicmd:: spf-interval (1-120)
124 .. index:: no spf-interval
125 .. clicmd:: no spf-interval
127 Set minimum interval between consecutive SPF calculations in seconds.
129 .. _openfabric-interface:
134 .. index:: ip router openfabric WORD
135 .. clicmd:: ip router openfabric WORD
137 .. index:: no ip router openfabric WORD
138 .. clicmd:: no ip router openfabric WORD
140 .. _ip-router-openfabric-word:
142 Activate OpenFabric on this interface. Note that the name
143 of OpenFabric instance must be the same as the one used to configure the
144 routing process (see command :clicmd:`router openfabric WORD`).
146 .. index:: openfabric csnp-interval (1-600)
147 .. clicmd:: openfabric csnp-interval (1-600)
149 .. index:: no openfabric csnp-interval
150 .. clicmd:: no openfabric csnp-interval
152 Set CSNP interval in seconds.
154 .. index:: openfabric hello-interval (1-600)
155 .. clicmd:: openfabric hello-interval (1-600)
157 .. index:: no openfabric hello-interval
158 .. clicmd:: no openfabric hello-interval
160 Set Hello interval in seconds.
162 .. index:: openfabric hello-multiplier (2-100)
163 .. clicmd:: openfabric hello-multiplier (2-100)
165 .. index:: no openfabric hello-multiplier
166 .. clicmd:: no openfabric hello-multiplier
168 Set multiplier for Hello holding time.
170 .. index:: openfabric metric (0-16777215)
171 .. clicmd:: openfabric metric (0-16777215)
173 .. index:: no openfabric metric
174 .. clicmd:: no openfabric metric
176 Set interface metric value.
178 .. index:: openfabric passive
179 .. clicmd:: openfabric passive
181 .. index:: no openfabric passive
182 .. clicmd:: no openfabric passive
184 Configure the passive mode for this interface.
186 .. index:: openfabric password [clear | md5] <password>
187 .. clicmd:: openfabric password [clear | md5] <password>
189 .. index:: no openfabric password
190 .. clicmd:: no openfabric password
192 Configure the authentication password (clear or encoded text) for the
195 .. index:: openfabric psnp-interval (1-120)
196 .. clicmd:: openfabric psnp-interval (1-120)
198 .. index:: no openfabric psnp-interval
199 .. clicmd:: no openfabric psnp-interval
201 Set PSNP interval in seconds.
203 .. _showing-openfabric-information:
205 Showing OpenFabric information
206 ==============================
208 .. index:: show openfabric summary
209 .. clicmd:: show openfabric summary
211 Show summary information about OpenFabric.
213 .. index:: show openfabric hostname
214 .. clicmd:: show openfabric hostname
216 Show which hostnames are associated with which OpenFabric system ids.
218 .. index:: show openfabric interface
219 .. clicmd:: show openfabric interface
221 .. index:: show openfabric interface detail
222 .. clicmd:: show openfabric interface detail
224 .. index:: show openfabric interface <interface name>
225 .. clicmd:: show openfabric interface <interface name>
227 Show state and configuration of specified OpenFabric interface, or all interfaces
228 if no interface is given with or without details.
230 .. index:: show openfabric neighbor
231 .. clicmd:: show openfabric neighbor
233 .. index:: show openfabric neighbor <System Id>
234 .. clicmd:: show openfabric neighbor <System Id>
236 .. index:: show openfabric neighbor detail
237 .. clicmd:: show openfabric neighbor detail
239 Show state and information of specified OpenFabric neighbor, or all neighbors if
240 no system id is given with or without details.
242 .. index:: show openfabric database
243 .. clicmd:: show openfabric database
245 .. index:: show openfabric database [detail]
246 .. clicmd:: show openfabric database [detail]
248 .. index:: show openfabric database <LSP id> [detail]
249 .. clicmd:: show openfabric database <LSP id> [detail]
251 .. index:: show openfabric database detail <LSP id>
252 .. clicmd:: show openfabric database detail <LSP id>
254 Show the OpenFabric database globally, for a specific LSP id without or with
257 .. index:: show openfabric topology
258 .. clicmd:: show openfabric topology
260 Show calculated OpenFabric paths and associated topology information.
262 .. _debugging-openfabric:
267 .. index:: debug openfabric adj-packets
268 .. clicmd:: debug openfabric adj-packets
270 .. index:: no debug openfabric adj-packets
271 .. clicmd:: no debug openfabric adj-packets
273 OpenFabric Adjacency related packets.
275 .. index:: debug openfabric checksum-errors
276 .. clicmd:: debug openfabric checksum-errors
278 .. index:: no debug openfabric checksum-errors
279 .. clicmd:: no debug openfabric checksum-errors
281 OpenFabric LSP checksum errors.
283 .. index:: debug openfabric events
284 .. clicmd:: debug openfabric events
286 .. index:: no debug openfabric events
287 .. clicmd:: no debug openfabric events
291 .. index:: debug openfabric local-updates
292 .. clicmd:: debug openfabric local-updates
294 .. index:: no debug openfabric local-updates
295 .. clicmd:: no debug openfabric local-updates
297 OpenFabric local update packets.
299 .. index:: debug openfabric lsp-gen
300 .. clicmd:: debug openfabric lsp-gen
302 .. index:: no debug openfabric lsp-gen
303 .. clicmd:: no debug openfabric lsp-gen
305 Generation of own LSPs.
307 .. index:: debug openfabric lsp-sched
308 .. clicmd:: debug openfabric lsp-sched
310 .. index:: no debug openfabric lsp-sched
311 .. clicmd:: no debug openfabric lsp-sched
313 Debug scheduling of generation of own LSPs.
315 .. index:: debug openfabric packet-dump
316 .. clicmd:: debug openfabric packet-dump
318 .. index:: no debug openfabric packet-dump
319 .. clicmd:: no debug openfabric packet-dump
321 OpenFabric packet dump.
323 .. index:: debug openfabric protocol-errors
324 .. clicmd:: debug openfabric protocol-errors
326 .. index:: no debug openfabric protocol-errors
327 .. clicmd:: no debug openfabric protocol-errors
329 OpenFabric LSP protocol errors.
331 .. index:: debug openfabric route-events
332 .. clicmd:: debug openfabric route-events
334 .. index:: no debug openfabric route-events
335 .. clicmd:: no debug openfabric route-events
337 OpenFabric Route related events.
339 .. index:: debug openfabric snp-packets
340 .. clicmd:: debug openfabric snp-packets
342 .. index:: no debug openfabric snp-packets
343 .. clicmd:: no debug openfabric snp-packets
345 OpenFabric CSNP/PSNP packets.
347 .. index:: debug openfabric spf-events
348 .. clicmd:: debug openfabric spf-events
350 .. index:: debug openfabric spf-statistics
351 .. clicmd:: debug openfabric spf-statistics
353 .. index:: debug openfabric spf-triggers
354 .. clicmd:: debug openfabric spf-triggers
356 .. index:: no debug openfabric spf-events
357 .. clicmd:: no debug openfabric spf-events
359 .. index:: no debug openfabric spf-statistics
360 .. clicmd:: no debug openfabric spf-statistics
362 .. index:: no debug openfabric spf-triggers
363 .. clicmd:: no debug openfabric spf-triggers
365 OpenFabric Shortest Path First Events, Timing and Statistic Data and triggering
368 .. index:: debug openfabric update-packets
369 .. clicmd:: debug openfabric update-packets
371 .. index:: no debug openfabric update-packets
372 .. clicmd:: no debug openfabric update-packets
374 Update related packets.
376 .. index:: show debugging openfabric
377 .. clicmd:: show debugging openfabric
379 Print which OpenFabric debug levels are active.
381 OpenFabric configuration example
382 ================================
390 ip address 192.0.2.1/32
391 ip router openfabric 1
392 ipv6 address 2001:db8::1/128
393 ipv6 router openfabric 1
396 ip router openfabric 1
397 ipv6 router openfabric 1
400 ip router openfabric 1
401 ipv6 router openfabric 1
404 net 49.0000.0000.0001.00