diff options
| author | ISHIDA Wataru <ishida.wataru@lab.ntt.co.jp> | 2015-08-13 11:21:51 +0900 |
|---|---|---|
| committer | FUJITA Tomonori <fujita.tomonori@lab.ntt.co.jp> | 2015-08-13 16:08:16 +0900 |
| commit | 69aceacaecde3adda0ed9627ecbff3922225433d (patch) | |
| tree | b38cfeecd9e04fa5093762a701cde62ce7c286df | |
| parent | 97aefa5089c71f15ef942538b200d03df035b8aa (diff) | |
docs: update cli syntax doc
Signed-off-by: ISHIDA Wataru <ishida.wataru@lab.ntt.co.jp>
| -rw-r--r-- | docs/sources/cli-command-syntax.md | 26 |
1 files changed, 13 insertions, 13 deletions
diff --git a/docs/sources/cli-command-syntax.md b/docs/sources/cli-command-syntax.md index e78e4062..43f3dd63 100644 --- a/docs/sources/cli-command-syntax.md +++ b/docs/sources/cli-command-syntax.md @@ -7,16 +7,16 @@ This page explains gobgp client command syntax. ## basic command pattern gobgp \<subcommand> \<object> opts... -gobgp has three subcommands. -- global -- neighbor -- policy -- vrf -- monitor -- mrt +gobgp has six subcommands. +- [global](#global) +- [neighbor](#neighbor) +- [policy](#policy) +- [vrf](#vrf) +- [monitor](#monitor) +- [mrt](#mrt) -## 1. global subcommand +## 1. <a name="global"> global subcommand ### 1.1. Operations for Global-Rib - add/del/show - #### - syntax ```shell @@ -49,7 +49,7 @@ The following options can be specified in the global subcommand: <br> -## 2. neighbor subcommand +## 2. <a name="neighbor"> neighbor subcommand ### 2.1. Show Neighbor Status #### - syntax ```shell @@ -132,7 +132,7 @@ You can specify multiple policy to neighbor separated by commas. <br> -## 3. policy subcommand +## 3. <a name="policy"> policy subcommand ### 3.1. Operations for PrefixSet - add/del/show - #### - syntax ```shell @@ -364,7 +364,7 @@ The following options can be specified in the policy subcommand: |- |a-med |specify the med operation of the route that match to the conditions | |- |a-asprepend |specify a combination of an AS number and repeat count(e.g. 65100,10) to prepend if the path matches conditions| -## 4. vrf subcommand +## 4. <a name="vrf"> vrf subcommand ### 4.1 Add/Delete/Show VRF #### Syntax ```shell @@ -412,7 +412,7 @@ The following options can be specified in the policy subcommand: % gobgp vrf vrf1 rib del 2001::/64 ``` -## 5. monitor subcommand +## 5. <a name="monitor"> monitor subcommand ### 5.1 monitor global rib #### Syntax ```shell @@ -455,7 +455,7 @@ The following options can be specified in the policy subcommand: % gobgp neighbor 192.168.10.2 enable ``` -## 6. mrt subcommand +## 6. <a name="mrt"> mrt subcommand ### 6.1 dump mrt records #### Syntax ```shell |