summaryrefslogtreecommitdiffhomepage
path: root/docs/sources/cli-command-syntax.md
blob: 1c5a9ed9a7d278290fdeede3582978e1026e8f19 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
# CLI command syntax

This page explains gobgp client command syntax.



## basic command pattern
gobgp \<subcommand> \<object>  opts...

gobgp has three subcommands.
- global
- neighbor
- policy

Note: Currently gobgp supports only **global** and **neighbor** subcommand.



## global subcommand

### Operations for Global-Rib - add/del/show -
```shell
# add Route
% gobgp global rib add <prefix> -a <address family>
# delete a specific Route
% gobgp global rib del <prefix> -a <address family>
# show all Route information
% gobgp global rib -a <address family>
```

<br>


## neighbor subcommand
### Show Neighbor Status
```shell
# show neighbor's status as list
% gobgp neighbor

# show status of a specific neighbor
% gobgp neighbor <neighbor address>
```

### Operations for neighbor - shutdown/reset/softreset/enable/disable -
```shell
% gobgp neighbor <neighbor address> shutdown
% gobgp neighbor <neighbor address> reset
% gobgp neighbor <neighbor address> softreset -a <address family>
% gobgp neighbor <neighbor address> softresetin -a <address family>
% gobgp neighbor <neighbor address> softresetout -a <address family>
% gobgp neighbor <neighbor address> enable
% gobgp neighbor <neighbor address> disable
```

### Show Rib - local-rib/adj-rib-in/adj-rib-out -
```shell
% gobgp neighbor <neighbor address> local -a <address family>
% gobgp neighbor <neighbor address> adj-in -a <address family>
% gobgp neighbor <neighbor address> adj-out -a <address family>
```

### Operations for Policy  - add/del/show -
```shell
# add policy to import-policy configuration
% gobgp neighbor <neighbor address> policy add import <import policy name> <default import policy>
# add policy to export-policy configuration
% gobgp neighbor <neighbor address> policy add export <export policy name> <default export policy>
# delete import-policy configuration from specific neighbor
% gobgp neighbor <neighbor address> policy del import
# delete export-policy configuration from specific neighbor
% gobgp neighbor <neighbor address> policy del export
# show a specific policy information
% gobgp neighbor <neighbor address> policy
```

### Operations for Static Route - add/del/show -
```shell
# add Route
% gobgp neighbor <neighbor address> route add <prefix> -a <address family>
# delete all Route
% gobgp neighbor <neighbor address> route del -a <address family>
# delete a specific Route
% gobgp neighbor <neighbor address> route del <prefix> -a <address family>
# show all Route information
% gobgp neighbor <neighbor address> route -a <address family>
```

<br>

## policy subcommand
### Operations for PrefixSet - add/del/show -
```shell
# add PrefixSet
% gobgp policy prefix add <prefix set name> <prefix>
# delete all PrefixSet
% gobgp policy prefix del all
# delete a specific PrefixSet
% gobgp policy prefix del <prefix set name>
% gobgp policy prefix del <prefix set name> <prefix> <mask length range>
# show all PrefixSet information
% gobgp policy prefix
# show a specific PrefixSet
% gobgp policy prefix <prefix set name>
```
### Operations for NeighborSet - add/del/show -
```shell
# add NeighborSet
% gobgp policy neighbor add <neighbor set name> <neighbor address>
# delete all NeighborSet
% gobgp policy neighbor del all
# delete a specific NeighborSet
% gobgp policy neighbor del <neighbor set name>
% gobgp policy neighbor del <neighbor set name> <address>
# show all NeighborSet information
% gobgp policy neighbor
# show a specific NeighborSet information
% gobgp policy neighbor <neighbor set name>
```
### Operations for RoutePolicy - add/del/show -
```shell
# add conditions to RoutePolicy
% gobgp policy routepoilcy add <route policy name> <statement name> condition <condtion>
# add actions to RoutePolicy
% gobgp policy routepoilcy add <route policy name> <statement name> action <aciton>
# delete all RoutePolicy
% gobgp policy routepoilcy del all
# delete a specific RoutePolicy
% gobgp policy routepoilcy del <route policy name>
% gobgp policy routepoilcy del <route policy name> <statement name>
# show all RoutePolicy information
% gobgp policy routepoilcy
# show a specific RoutePolicy information
% gobgp policy routepoilcy <route policy name>
```