summaryrefslogtreecommitdiffstats
path: root/doc/user/fabricd.rst
blob: 48d264f30e7b4214ab52d2cffd5ee33967489623 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
.. _fabricd:

**********
OpenFabric
**********

OpenFabric, specified in :t:`draft-white-openfabric-06.txt`, is a routing
protocol derived from IS-IS, providing link-state routing with efficient
flooding for topologies like spine-leaf networks.

FRR implements OpenFabric in a daemon called *fabricd*

.. _configuring-fabricd:

Configuring fabricd
===================

There are no *fabricd* specific options. Common options can be specified
(:ref:`common-invocation-options`) to *fabricd*. *fabricd* needs to acquire
interface information from *zebra* in order to function. Therefore *zebra* must
be running before invoking *fabricd*. Also, if *zebra* is restarted then *fabricd*
must be too.

Like other daemons, *fabricd* configuration is done in an OpenFabric specific
configuration file :file:`fabricd.conf`.

.. _openfabric-router:

OpenFabric router
=================

To enable the OpenFabric routing protocol, an OpenFabric router needs to be created
in the configuration:

.. clicmd:: router openfabric WORD

   Enable or disable the OpenFabric process by specifying the OpenFabric domain with
   'WORD'.

.. clicmd:: net XX.XXXX. ... .XXX.XX

   Set/Unset network entity title (NET) provided in ISO format.

.. clicmd:: domain-password [clear | md5] <password>

   Configure the authentication password for a domain, as clear text or md5 one.

.. clicmd:: attached-bit [receive ignore | send]

   Set attached bit for inter-area traffic:

   - receive
     If LSP received with attached bit set, create default route to neighbor
   - send
     If L1|L2 router, set attached bit in LSP sent to L1 router
   
.. clicmd:: log-adjacency-changes

   Log changes in adjacency state.
     
.. clicmd:: set-overload-bit

   Set overload bit to avoid any transit traffic.

.. clicmd:: purge-originator


   Enable or disable :rfc:`6232` purge originator identification.

.. clicmd:: fabric-tier (0-14)


   Configure a static tier number to advertise as location in the fabric

.. _openfabric-timer:

OpenFabric Timer
================

.. clicmd:: lsp-gen-interval (1-120)


   Set minimum interval in seconds between regenerating same LSP.

.. clicmd:: lsp-refresh-interval (1-65235)


   Set LSP refresh interval in seconds.

.. clicmd:: max-lsp-lifetime (360-65535)


   Set LSP maximum LSP lifetime in seconds.

.. clicmd:: spf-interval (1-120)


   Set minimum interval between consecutive SPF calculations in seconds.

.. _openfabric-interface:

OpenFabric interface
====================

.. clicmd:: ip router openfabric WORD


.. _ip-router-openfabric-word:

   Activate OpenFabric on this interface. Note that the name
   of OpenFabric instance must be the same as the one used to configure the
   routing process (see command :clicmd:`router openfabric WORD`).

.. clicmd:: openfabric csnp-interval (1-600)


   Set CSNP interval in seconds.

.. clicmd:: openfabric hello-interval (1-600)


   Set Hello interval in seconds.

.. clicmd:: openfabric hello-multiplier (2-100)


   Set multiplier for Hello holding time.

.. clicmd:: openfabric metric (0-16777215)


   Set interface metric value.

.. clicmd:: openfabric passive


   Configure the passive mode for this interface.

.. clicmd:: openfabric password [clear | md5] <password>


   Configure the authentication password (clear or encoded text) for the
   interface.

.. clicmd:: openfabric psnp-interval (1-120)


   Set PSNP interval in seconds.

.. _showing-openfabric-information:

Showing OpenFabric information
==============================

.. clicmd:: show openfabric summary

   Show summary information about OpenFabric.

.. clicmd:: show openfabric hostname

   Show which hostnames are associated with which OpenFabric system ids.

.. clicmd:: show openfabric interface

.. clicmd:: show openfabric interface detail

.. clicmd:: show openfabric interface <interface name>

   Show state and configuration of specified OpenFabric interface, or all interfaces
   if no interface is given with or without details.

.. clicmd:: show openfabric neighbor

.. clicmd:: show openfabric neighbor <System Id>

.. clicmd:: show openfabric neighbor detail

   Show state and information of specified OpenFabric neighbor, or all neighbors if
   no system id is given with or without details.

.. clicmd:: show openfabric database

.. clicmd:: show openfabric database [detail]

.. clicmd:: show openfabric database <LSP id> [detail]

.. clicmd:: show openfabric database detail <LSP id>

   Show the OpenFabric database globally, for a specific LSP id without or with
   details.

.. clicmd:: show openfabric topology

   Show calculated OpenFabric paths and associated topology information.

.. _debugging-openfabric:

Debugging OpenFabric
====================

.. clicmd:: debug openfabric adj-packets

   OpenFabric Adjacency related packets.

.. clicmd:: debug openfabric checksum-errors

   OpenFabric LSP checksum errors.

.. clicmd:: debug openfabric events

   OpenFabric Events.

.. clicmd:: debug openfabric local-updates

   OpenFabric local update packets.

.. clicmd:: debug openfabric lsp-gen

   Generation of own LSPs.

.. clicmd:: debug openfabric lsp-sched

   Debug scheduling of generation of own LSPs.

.. clicmd:: debug openfabric packet-dump

   OpenFabric packet dump.

.. clicmd:: debug openfabric protocol-errors

   OpenFabric LSP protocol errors.

.. clicmd:: debug openfabric route-events

   OpenFabric Route related events.

.. clicmd:: debug openfabric snp-packets

   OpenFabric CSNP/PSNP packets.

.. clicmd:: debug openfabric spf-events

.. clicmd:: debug openfabric spf-statistics

.. clicmd:: debug openfabric spf-triggers

   OpenFabric Shortest Path First Events, Timing and Statistic Data and
   triggering events.

.. clicmd:: debug openfabric update-packets

   Update-related packets.

.. clicmd:: show debugging openfabric

   Print which OpenFabric debug levels are active.

Sample configuration
====================

A simple example:

.. code-block:: frr

   !
   interface lo
    ip address 192.0.2.1/32
    ip router openfabric 1
    ipv6 address 2001:db8::1/128
    ipv6 router openfabric 1
   !
   interface eth0
    ip router openfabric 1
    ipv6 router openfabric 1
   !
   interface eth1
    ip router openfabric 1
    ipv6 router openfabric 1
   !
   router openfabric 1
    net 49.0000.0000.0001.00


Alternative example:

.. code-block:: frr

   hostname fabricd

   router openfabric DEAD
     net 47.0023.0000.0003.0300.0100.0102.0304.0506.00
     lsp-lifetime 65535

     hostname isisd-router
     domain-password foobar

   interface eth0
    ip router openfabric DEAD
    openfabric hello-interval 5
    openfabric lsp-interval 1000

   ! -- optional
   openfabric retransmit-interval 10
   openfabric retransmit-throttle-interval