]> git.proxmox.com Git - mirror_frr.git/blame - fpm/fpm.proto
Merge pull request #13649 from donaldsharp/unlock_the_node_or_else
[mirror_frr.git] / fpm / fpm.proto
CommitLineData
47a3a827 1// SPDX-License-Identifier: ISC
93c7bed1
AS
2//
3// fpm.proto
4//
5// @copyright Copyright (C) 2016 Sproute Networks, Inc.
6//
7// @author Avneesh Sachdev <avneesh@sproute.com>
8//
93c7bed1
AS
9// Permission to use, copy, modify, and/or distribute this software
10// for any purpose with or without fee is hereby granted, provided
11// that the above copyright notice and this permission notice appear
12// in all copies.
13//
14// THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL
15// WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED
16// WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE
17// AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR
18// CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS
19// OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
20// NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN
21// CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
22//
23
a805d3bb
DL
24syntax = "proto2";
25
93c7bed1
AS
26//
27// Protobuf definitions pertaining to the Forwarding Plane Manager component.
28//
29
30package fpm;
31
32import "qpb/qpb.proto";
33
34//
35// A Nexthop for a route. It indicates how packets to a given prefix
36// should be forwarded (for instance, send them out of a specified
37// interface to a specified address).
38//
39message Nexthop {
40 optional qpb.IfIdentifier if_id = 2;
41 optional qpb.L3Address address = 3;
42}
43
44message RouteKey {
45 optional qpb.L3Prefix prefix = 1;
46}
47
48message DeleteRoute {
49 required uint32 vrf_id = 1;
50 required qpb.AddressFamily address_family = 2;
51 required qpb.SubAddressFamily sub_address_family = 3;
52 required RouteKey key = 4;
53}
54
55enum RouteType {
56 UNKNOWN = 0;
57 NORMAL = 1;
58 UNREACHABLE = 2;
59 BLACKHOLE = 3;
60}
61
62message AddRoute {
63 required uint32 vrf_id = 1;
64 required qpb.AddressFamily address_family = 2;
65 required qpb.SubAddressFamily sub_address_family = 3;
66 required RouteKey key = 4;
67
68 optional RouteType route_type = 5;
69
70 required qpb.Protocol protocol = 6;
71
72 required int32 metric = 8;
73
74 repeated Nexthop nexthops = 9;
75}
76
77//
78// Any message from the FPM.
79//
80message Message {
81 enum Type {
82 UNKNOWN_MSG = 0;
83 ADD_ROUTE = 1;
84 DELETE_ROUTE = 2;
85 };
86
87 optional Type type = 1;
88
89 optional AddRoute add_route = 2;
90 optional DeleteRoute delete_route = 3;
91}