summaryrefslogtreecommitdiffhomepage
path: root/docs/sources
diff options
context:
space:
mode:
authorFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-09-15 10:34:46 +0900
committerFUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>2015-09-15 10:34:46 +0900
commit7d16e3e1db32f3af524f8bc3eb26859a109b6586 (patch)
tree937d894a13e8b81e8b39d2587c1f2d2f8b6644fa /docs/sources
parent7a5c1c11c4034c121fd1c2b35c704678ca011a73 (diff)
add BMP document
Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
Diffstat (limited to 'docs/sources')
-rw-r--r--docs/sources/bmp.md51
1 files changed, 51 insertions, 0 deletions
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"}
+```