summaryrefslogtreecommitdiffhomepage
diff options
context:
space:
mode:
-rw-r--r--README.md3
-rw-r--r--docs/sources/bmp.md51
2 files changed, 53 insertions, 1 deletions
diff --git a/README.md b/README.md
index d81893d7..c15e019c 100644
--- a/README.md
+++ b/README.md
@@ -28,8 +28,9 @@ No dependency hell (library, package, etc) thanks to Go.
* [Route Server](https://github.com/osrg/gobgp/blob/master/docs/sources/route-server.md)
* [Route Reflector](https://github.com/osrg/gobgp/blob/master/docs/sources/route-reflector.md)
* [Policy](https://github.com/osrg/gobgp/blob/master/docs/sources/policy.md)
- * [EVPN](https://github.com/osrg/gobgp/blob/master/docs/sources/evpn.md)
* [MRT](https://github.com/osrg/gobgp/blob/master/docs/sources/mrt.md)
+ * [BMP](https://github.com/osrg/gobgp/blob/master/docs/sources/bmp.md)
+ * [EVPN](https://github.com/osrg/gobgp/blob/master/docs/sources/evpn.md)
* [Flowspec](https://github.com/osrg/gobgp/blob/master/docs/sources/flowspec.md)
* [RPKI](https://github.com/osrg/gobgp/blob/master/docs/sources/rpki.md)
* [Managing GoBGP with your favorite language](https://github.com/osrg/gobgp/blob/master/docs/sources/grpc-client.md)
diff --git a/docs/sources/bmp.md b/docs/sources/bmp.md
new file mode 100644
index 00000000..d1515886
--- /dev/null
+++ b/docs/sources/bmp.md
@@ -0,0 +1,51 @@
+# BGP Monitoring Protocol
+
+GoBGP supports [BGP Monitoring Protocol](https://datatracker.ietf.org/doc/draft-ietf-grow-bmp/).
+
+## Prerequisites
+
+Assume you finished [Getting Started](https://github.com/osrg/gobgp/blob/master/docs/sources/getting-started.md).
+
+## Contents
+- [Configuration](#config)
+- [Verification](#verify)
+
+## <a name="config"> Configuration
+
+Add `[BmpServers]` section to enable BMP like below.
+
+```toml
+[Global]
+ [Global.GlobalConfig]
+ As = 64512
+ RouterId = "192.168.255.1"
+
+[BmpServers]
+ [[BmpServers.BmpServerList]]
+ [BmpServers.BmpServerList.BmpServerConfig]
+ Address = "127.0.0.1"
+ Port=11019
+```
+
+## <a name="verify"> Verification
+
+Let's check if BMP works with a bmp server. GoBGP also supports BMP server (currently, just shows received BMP messages in the json format).
+
+```bash
+$ go get github.com/osrg/gobgp/gobmpd
+$ gobmpd
+```
+
+Once the BMP server accepts a connection from gobgpd, then you see
+below on the BMP server side.
+
+```bash
+INFO[0013] Accepted a new connection from 127.0.0.1:33685
+{"Header":{"Version":3,"Length":6,"Type":4},"PeerHeader":{"PeerType":0,"IsPostPolicy":false,"PeerDistinguisher":0,"PeerAddress":"","PeerAS":0,"PeerBGPID":"","Timestamp":0},"Body":{"Info":null}}
+```
+
+You also see below on the BGP server side:
+
+```bash
+{"level":"info","msg":"bmp server is connected, 127.0.0.1:11019","time":"2015-09-15T10:29:03+09:00"}
+```