doc: add rpki monitor API

Signed-off-by: FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp>
rastislavs · Jan 19, 2016 · 8bb7747 · 8bb7747
1 parent e45dbfa
commit 8bb7747
Showing 1 changed file with 28 additions and 2 deletions.
diff --git a/docs/sources/rpki.md b/docs/sources/rpki.md
@@ -12,6 +12,8 @@ Assume you finished [Getting Started](https://github.com/osrg/gobgp/blob/master/
 - [Configuration](#section0)
 - [Validation](#section1)
 - [Policy with validation results](#section2)
+- [Force Re-validation](#section3)
+- [Monitoring validation](#section4)
 
 ## <a name="section0"> Configuration
 
@@ -52,8 +54,8 @@ following way:
 
 ```bash
 $ gobgp rpki server
-Session            State  Uptime     #IPv4/IPv6 records
-210.173.170.254    Up     00:03:06   14823/2168
+Session                State  Uptime     #IPv4/IPv6 records
+210.173.170.254:323    Up     00:03:06   14823/2168
 ```
 
 ```bash
@@ -172,3 +174,27 @@ $ gobgp neighbor 10.0.255.2 local
     V*> 2.0.0.0/12       10.0.255.1           3215                 00:00:21   [{Origin: i}]
     N*> 192.168.1.0/24   10.0.255.1           65001                00:00:21   [{Origin: i}]
 ```
+
+## <a name="section3"> Force Re-validation
+
+Validation is executed every time bgp update messages arrive. The
+changes of ROAs doesn't trigger off validation. The following command
+enables you to validate all the routes.
+
+```bash
+$ gobgp rpki validate
+```
+
+## <a name="section4"> Monitoring validation
+
+You can monitor the validation results in real-time.
+
+```bash
+$ gobgp monitor rpki
+[VALIDATION] Reason: Update, Peer: 10.0.255.1, Timestamp: 2016-01-18 06:47:33 -0800 PST, Prefix:217.196.16.0/20, OriginAS:24651, ASPath:24651, Old:NONE, New:INVALID, ROAs: [Source: 210.173.170.254:323, AS: 6453, Prefix: 217.196.16.0, Prefixlen: 20, Maxlen: 20], [Source: 210.173.170.254:323, AS: 6854, Prefix: 217.196.16.0, Prefixlen: 20, Maxlen: 20], [Source: 210.173.170.254:323, AS: 41798, Prefix: 217.196.16.0, Prefixlen: 20, Maxlen: 20], [Source: 210.173.170.254:323, AS: 43994, Prefix: 217.196.16.0, Prefixlen: 20, Maxlen: 20]
+[VALIDATION] Reason: PeerDown, Peer: 10.0.255.3, Timestamp: 2016-01-18 06:47:33 -0800 PST, Prefix:223.27.80.0/24, OriginAS:65003, ASPath:65003, Old:INVALID, New:INVALID
+```
+
+Notification is sent when the validation result of a route changes to
+invalid or non-invalid. Notification is also sent when an invalid
+route is withdrawn.