Managing GoBGP with Your Favorite Language

This page explains how to managing GoBGP with your favorite Language. You can use any language supported by gRPC (10 languages are supported now). This page gives an example in Python and C++.

Prerequisite

We assumes that you have the relevant tools installed to generate the server and client interface for your favorite language from proto files. Please refer to the official docs of gRPC for details.

Python

Generating Interface

You need to generate the server and client interface from GoBGP proto files at first.

$ python -m grpc_tools.protoc -I./ --python_out=. --grpc_python_out=. *.proto
$ ls *.py
attribute_pb2.py  attribute_pb2_grpc.py  capability_pb2.py  capability_pb2_grpc.py  gobgp_pb2.py  gobgp_pb2_grpc.py

Adding Path

tools/grpc/python/add_path.py shows an example for adding a route. Let's run this script.

$ PYTHONPATH=$PYTHONPATH:. python add_path.py

See if the route was added to the global rib.

$ gobgp g r
   Network              Next Hop             AS_PATH              Age        Attrs
*> 10.0.0.0/24          1.1.1.1              100 200              00:08:02   [{Origin: ?}]

Adding BGP-SR policy

tools/grpc/python/sr_policy.py shows an example for adding a bgp-sr route. Let's run this script.

$ PYTHONPATH=$PYTHONPATH:. python sr_policy.py

Result of injecting the SR policy

Once the sr policy is injected, gobgp will advertise it to the peers with SR Policy enabled address family. Below is the output collect ed from Nokia SROS router with enabled SR policy address family.

A:R1# show router segment-routing sr-policies all color 100

===============================================================================
SR-Policies Path
===============================================================================
-------------------------------------------------------------------------------
Active          : Yes                   Owner           : bgp
Color           : 100
Head            : 0.0.0.0               Endpoint Addr   : 10.6.6.6
RD              : 2                     Preference      : 11
BSID            : 300004
TunnelId        : 917525                Age             : 7
Origin ASN      : 800                   Origin          : 10.100.1.201
NumReEval       : 0                     ReEvalReason    : none
NumActPathChange: 0                     Last Change     : 03/23/2022 11:05:48
Maintenance Policy: N/A

Path Segment Lists:
Segment-List    : 1                     Weight          : 12
S-BFD State     : Down                  S-BFD Transitio*: 0
Num Segments    : 2                     Last Change     : 03/22/2022 14:09:33
  Seg 1 Label   : 200002                State           : resolved-up
  Seg 2 Label   : 200006                State           : N/A

===============================================================================
* indicates that the corresponding row element may have been truncated.

C++

Generating Interface and Binary

Use tools/grpc/cpp/Makefile.

$ cd tools/grpc/cpp
$ make

The above to generate the server and client interface and the binary to add a route by using AddPath API, 'tools/grpc/cpp/add_path.cc'.

Adding Path

Let's run the binary.

$ ./add_path

See if he route was added to the global rib.

$ gobgp g r
   Network              Next Hop             AS_PATH              Age        Attrs
*> 10.0.0.0/24          1.1.1.1                                   00:13:26   [{Origin: i} {Communities: 0:100}]

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!