summaryrefslogtreecommitdiffstats
path: root/doc/developer/zebra.rst
blob: 74a8605bf2cd14cf9fb2e783afbda1465310a13b (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
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
.. _zebra:

*****
Zebra
*****

.. _zebra-protocol:

Overview of the Zebra Protocol
==============================

The Zebra protocol is used by protocol daemons to communicate with the
**zebra** daemon.

Each protocol daemon may request and send information to and from the **zebra**
daemon such as interface states, routing state, nexthop-validation, and so on.
Protocol daemons may also install routes with **zebra**. The **zebra** daemon
manages which routes are installed into the forwarding table with the kernel.

The Zebra protocol is a streaming protocol, with a common header. Version 0
lacks a version field and is implicitly versioned. Version 1 and all subsequent
versions have a version field.  Version 0 can be distinguished from all other
versions by examining the 3rd byte of the header, which contains a marker value
of 255 (in Quagga) or 254 (in FRR) for all versions except version 0. The
marker byte corresponds to the command field in version 0, and the marker value
is a reserved command in version 0.

Version History
---------------

- Version 0

  Used by all versions of GNU Zebra and all version of Quagga up to and
  including Quagga 0.98. This version has no ``version`` field, and so is
  implicitly versioned as version 0.

- Version 1

  Added ``marker`` and ``version`` fields, increased ``command`` field to 16
  bits. Used by Quagga versions 0.99.3 through 0.99.20.

- Version 2

  Used by Quagga versions 0.99.21 through 0.99.23.

- Version 3

  Added ``vrf_id`` field. Used by Quagga versions 0.99.23 until FRR fork.

- Version 4

  Change marker value to 254 to prevent people mixing and matching Quagga and
  FRR daemon binaries. Used by FRR versions 2.0 through 3.0.3.

- Version 5

  Increased VRF identifier field from 16 to 32 bits. Used by FRR versions 4.0
  through 5.0.1.

- Version 6

  Removed the following commands:

  * ZEBRA_IPV4_ROUTE_ADD
  * ZEBRA_IPV4_ROUTE_DELETE
  * ZEBRA_IPV6_ROUTE_ADD
  * ZEBRA_IPV6_ROUTE_DELETE

  Used since FRR version 6.0.


Zebra Protocol Definition
=========================

Zebra Protocol Header Field Definitions
---------------------------------------

Length
   Total packet length including this header.

Marker
   Static marker. The marker value, when it exists, is 255 in all versions of
   Quagga. It is 254 in all versions of FRR. This is to allow version 0 headers
   (which do not include version explicitly) to be distinguished from versioned
   headers.

Version
   Zebra protocol version number. Clients should not continue processing
   messages past the version field for versions they do not recognise.

Command
   The Zebra protocol command.


Current Version
^^^^^^^^^^^^^^^

::

   Version 5, 6

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |             Length            |     Marker    |    Version    |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |                             VRF ID                            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |            Command            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


Past Versions
^^^^^^^^^^^^^

::

   Version 0

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |             Length            |    Command    |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+

::

   Version 1, 2

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |             Length            |     Marker    |    Version    |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |            Command            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


::

   Version 3, 4

    0                   1                   2                   3
    0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1 2 3 4 5 6 7 8 9 0 1
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |             Length            |     Marker    |    Version    |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+
   |             VRF ID            |            Command            |
   +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+


Zebra Protocol Commands
-----------------------

+------------------------------------+-------+
| Command                            | Value |
+====================================+=======+
| ZEBRA_INTERFACE_ADD                | 0     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_DELETE             | 1     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_ADDRESS_ADD        | 2     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_ADDRESS_DELETE     | 3     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_UP                 | 4     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_DOWN               | 5     |
+------------------------------------+-------+
| ZEBRA_INTERFACE_SET_MASTER         | 6     |
+------------------------------------+-------+
| ZEBRA_ROUTE_ADD                    | 7     |
+------------------------------------+-------+
| ZEBRA_ROUTE_DELETE                 | 8     |
+------------------------------------+-------+
| ZEBRA_ROUTE_NOTIFY_OWNER           | 9     |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_ADD             | 10    |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_DELETE          | 11    |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_DEFAULT_ADD     | 12    |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_DEFAULT_DELETE  | 13    |
+------------------------------------+-------+
| ZEBRA_ROUTER_ID_ADD                | 14    |
+------------------------------------+-------+
| ZEBRA_ROUTER_ID_DELETE             | 15    |
+------------------------------------+-------+
| ZEBRA_ROUTER_ID_UPDATE             | 16    |
+------------------------------------+-------+
| ZEBRA_HELLO                        | 17    |
+------------------------------------+-------+
| ZEBRA_CAPABILITIES                 | 18    |
+------------------------------------+-------+
| ZEBRA_NEXTHOP_REGISTER             | 19    |
+------------------------------------+-------+
| ZEBRA_NEXTHOP_UNREGISTER           | 20    |
+------------------------------------+-------+
| ZEBRA_NEXTHOP_UPDATE               | 21    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_NBR_ADDRESS_ADD    | 22    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_NBR_ADDRESS_DELETE | 23    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_BFD_DEST_UPDATE    | 24    |
+------------------------------------+-------+
| ZEBRA_IMPORT_ROUTE_REGISTER        | 25    |
+------------------------------------+-------+
| ZEBRA_IMPORT_ROUTE_UNREGISTER      | 26    |
+------------------------------------+-------+
| ZEBRA_IMPORT_CHECK_UPDATE          | 27    |
+------------------------------------+-------+
| ZEBRA_BFD_DEST_REGISTER            | 28    |
+------------------------------------+-------+
| ZEBRA_BFD_DEST_DEREGISTER          | 29    |
+------------------------------------+-------+
| ZEBRA_BFD_DEST_UPDATE              | 30    |
+------------------------------------+-------+
| ZEBRA_BFD_DEST_REPLAY              | 31    |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_ROUTE_ADD       | 32    |
+------------------------------------+-------+
| ZEBRA_REDISTRIBUTE_ROUTE_DEL       | 33    |
+------------------------------------+-------+
| ZEBRA_VRF_UNREGISTER               | 34    |
+------------------------------------+-------+
| ZEBRA_VRF_ADD                      | 35    |
+------------------------------------+-------+
| ZEBRA_VRF_DELETE                   | 36    |
+------------------------------------+-------+
| ZEBRA_VRF_LABEL                    | 37    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_VRF_UPDATE         | 38    |
+------------------------------------+-------+
| ZEBRA_BFD_CLIENT_REGISTER          | 39    |
+------------------------------------+-------+
| ZEBRA_BFD_CLIENT_DEREGISTER        | 40    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_ENABLE_RADV        | 41    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_DISABLE_RADV       | 42    |
+------------------------------------+-------+
| ZEBRA_IPV3_NEXTHOP_LOOKUP_MRIB     | 43    |
+------------------------------------+-------+
| ZEBRA_INTERFACE_LINK_PARAMS        | 44    |
+------------------------------------+-------+
| ZEBRA_MPLS_LABELS_ADD              | 45    |
+------------------------------------+-------+
| ZEBRA_MPLS_LABELS_DELETE           | 46    |
+------------------------------------+-------+
| ZEBRA_IPMR_ROUTE_STATS             | 47    |
+------------------------------------+-------+
| ZEBRA_LABEL_MANAGER_CONNECT        | 48    |
+------------------------------------+-------+
| ZEBRA_LABEL_MANAGER_CONNECT_ASYNC  | 49    |
+------------------------------------+-------+
| ZEBRA_GET_LABEL_CHUNK              | 50    |
+------------------------------------+-------+
| ZEBRA_RELEASE_LABEL_CHUNK          | 51    |
+------------------------------------+-------+
| ZEBRA_FEC_REGISTER                 | 52    |
+------------------------------------+-------+
| ZEBRA_FEC_UNREGISTER               | 53    |
+------------------------------------+-------+
| ZEBRA_FEC_UPDATE                   | 54    |
+------------------------------------+-------+
| ZEBRA_ADVERTISE_DEFAULT_GW         | 55    |
+------------------------------------+-------+
| ZEBRA_ADVERTISE_SUBNET             | 56    |
+------------------------------------+-------+
| ZEBRA_ADVERTISE_ALL_VNI            | 57    |
+------------------------------------+-------+
| ZEBRA_LOCAL_ES_ADD                 | 58    |
+------------------------------------+-------+
| ZEBRA_LOCAL_ES_DEL                 | 59    |
+------------------------------------+-------+
| ZEBRA_VNI_ADD                      | 60    |
+------------------------------------+-------+
| ZEBRA_VNI_DEL                      | 61    |
+------------------------------------+-------+
| ZEBRA_L3VNI_ADD                    | 62    |
+------------------------------------+-------+
| ZEBRA_L3VNI_DEL                    | 63    |
+------------------------------------+-------+
| ZEBRA_REMOTE_VTEP_ADD              | 64    |
+------------------------------------+-------+
| ZEBRA_REMOTE_VTEP_DEL              | 65    |
+------------------------------------+-------+
| ZEBRA_MACIP_ADD                    | 66    |
+------------------------------------+-------+
| ZEBRA_MACIP_DEL                    | 67    |
+------------------------------------+-------+
| ZEBRA_IP_PREFIX_ROUTE_ADD          | 68    |
+------------------------------------+-------+
| ZEBRA_IP_PREFIX_ROUTE_DEL          | 69    |
+------------------------------------+-------+
| ZEBRA_REMOTE_MACIP_ADD             | 70    |
+------------------------------------+-------+
| ZEBRA_REMOTE_MACIP_DEL             | 71    |
+------------------------------------+-------+
| ZEBRA_PW_ADD                       | 72    |
+------------------------------------+-------+
| ZEBRA_PW_DELETE                    | 73    |
+------------------------------------+-------+
| ZEBRA_PW_SET                       | 74    |
+------------------------------------+-------+
| ZEBRA_PW_UNSET                     | 75    |
+------------------------------------+-------+
| ZEBRA_PW_STATUS_UPDATE             | 76    |
+------------------------------------+-------+
| ZEBRA_RULE_ADD                     | 77    |
+------------------------------------+-------+
| ZEBRA_RULE_DELETE                  | 78    |
+------------------------------------+-------+
| ZEBRA_RULE_NOTIFY_OWNER            | 79    |
+------------------------------------+-------+
| ZEBRA_TABLE_MANAGER_CONNECT        | 80    |
+------------------------------------+-------+
| ZEBRA_GET_TABLE_CHUNK              | 81    |
+------------------------------------+-------+
| ZEBRA_RELEASE_TABLE_CHUNK          | 82    |
+------------------------------------+-------+
| ZEBRA_IPSET_CREATE                 | 83    |
+------------------------------------+-------+
| ZEBRA_IPSET_DESTROY                | 84    |
+------------------------------------+-------+
| ZEBRA_IPSET_ENTRY_ADD              | 85    |
+------------------------------------+-------+
| ZEBRA_IPSET_ENTRY_DELETE           | 86    |
+------------------------------------+-------+
| ZEBRA_IPSET_NOTIFY_OWNER           | 87    |
+------------------------------------+-------+
| ZEBRA_IPSET_ENTRY_NOTIFY_OWNER     | 88    |
+------------------------------------+-------+
| ZEBRA_IPTABLE_ADD                  | 89    |
+------------------------------------+-------+
| ZEBRA_IPTABLE_DELETE               | 90    |
+------------------------------------+-------+
| ZEBRA_IPTABLE_NOTIFY_OWNER         | 91    |
+------------------------------------+-------+
| ZEBRA_VXLAN_FLOOD_CONTROL          | 92    |
+------------------------------------+-------+