summaryrefslogtreecommitdiff
path: root/docs/routing/ip-commands.rst
blob: 60eb582aa475db5816194275a8290a132a49032a (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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
.. _ip-commands:

***********
IP commands
***********


IPv4
====

System configuration commands
-----------------------------


.. cfgcmd:: set system ip disable-forwarding

   Use this command to disable IPv4 forwarding on all interfaces.


.. cfgcmd:: set system ip arp table-size <number>

   Use this command to define the maximum number of entries to keep in
   the ARP cache (1024, 2048, 4096, 8192, 16384, 32768).


.. cfgcmd:: set system ip multipath layer4-hashing

   Use this command to use Layer 4 information for IPv4 ECMP hashing.


Operational commands
--------------------


show commands
^^^^^^^^^^^^^

See below the different parameters available for the IPv4 **show** command:

.. code-block::

   vyos@vyos:~$ show ip
   Possible completions:
     access-list   Show all IP access-lists
     as-path-access-list
                   Show all as-path-access-lists
     bgp           Show Border Gateway Protocol (BGP) information
     community-list
                   Show IP community-lists
     extcommunity-list
                   Show extended IP community-lists
     forwarding    Show IP forwarding status
     groups        Show IP multicast group membership
     igmp          Show IGMP (Internet Group Management Protocol) information
     large-community-list
                   Show IP large-community-lists
     multicast     Show IP multicast
     ospf          Show IPv4 Open Shortest Path First (OSPF) routing information
     pim           Show PIM (Protocol Independent Multicast) information
     ports         Show IP ports in use by various system services
     prefix-list   Show all IP prefix-lists
     protocol      Show IP route-maps per protocol
     rip           Show Routing Information Protocol (RIP) information
     route         Show IP routes
   

reset commands
^^^^^^^^^^^^^^

And the different IPv4 **reset** commands available:

.. code-block::

   vyos@vyos:~$ reset ip 
   Possible completions:
     arp           Reset Address Resolution Protocol (ARP) cache
     bgp           Clear Border Gateway Protocol (BGP) statistics or status
     igmp          IGMP clear commands
     multicast     IP multicast routing table
     route         Reset IP route
   

IPv6
====

System configuration commands
-----------------------------

.. cfgcmd:: set system ipv6 disable

   Use this command to disable assignment of IPv6 addresses on all
   interfaces.


.. cfgcmd:: set system ipv6 disable-forwarding

   Use this command to disable IPv6 forwarding on all interfaces.


.. cfgcmd:: set system ipv6 neighbor table-size <number>

   Use this command to define the maximum number of entries to keep in
   the Neighbor cache (1024, 2048, 4096, 8192, 16384, 32768).


.. cfgcmd:: set system ipv6 strict-dad

   Use this command to disable IPv6 operation on interface when
   Duplicate Address Detection fails on Link-Local address.


.. cfgcmd:: set system ipv6 multipath layer4-hashing

   Use this command to user Layer 4 information for ECMP hashing.

.. cfgcmd:: set system ipv6 blacklist

   Use this command to prevent the IPv6 kernel module from being loaded.



Operational commands
--------------------

Show commands
^^^^^^^^^^^^^


.. opcmd:: show ipv6 neighbors

   Use this command to show IPv6 Neighbor Discovery Protocol information.


.. opcmd:: show ipv6 groups

   Use this command to show IPv6 multicast group membership.


.. opcmd:: show ipv6 forwarding
  
   Use this command to show IPv6 forwarding status.

.. opcmd:: show ipv6 route

   Use this command to show IPv6 routes.


   Check the many parameters available for the `show ipv6 route` command:

   .. code-block:: none

      vyos@vyos:~$ show ipv6 route 
      Possible completions:
        <Enter>       Execute the current command
        <X:X::X:X>    Show IPv6 routes of given address or prefix
        <X:X::X:X/M>
        bgp           Show IPv6 BGP routes
        cache         Show kernel IPv6 route cache
        connected     Show IPv6 connected routes
        forward       Show kernel IPv6 route table
        isis          Show IPv6 ISIS routes
        kernel        Show IPv6 kernel routes
        ospfv3        Show IPv6 OSPF6 routes
        ripng         Show IPv6 RIPNG routes
        static        Show IPv6 static routes
        summary       Show IPv6 routes summary
        table         Show IP routes in policy table
      

.. opcmd:: show ipv6 prefix-list

   Use this command to show all IPv6 prefix lists

   There are different parameters for getting prefix-list information:

   .. code-block:: none

      vyos@vyos:~$ show ipv6 prefix-list 
      Possible completions:
        <Enter>       Execute the current command
        <WORD>        Show specified IPv6 prefix-list
        detail        Show detail of IPv6 prefix-lists
        summary       Show summary of IPv6 prefix-lists
      
.. opcmd:: show ipv6 access-list

   Use this command to show all IPv6 access lists

   You can also specify which IPv6 access-list should be shown:

   .. code-block:: none

      vyos@vyos:~$ show ipv6 access-list 
      Possible completions:
        <Enter>       Execute the current command
        <text>        Show specified IPv6 access-list
      


.. opcmd:: show ipv6 bgp

   Use this command to show IPv6 Border Gateway Protocol information.


   In addition, you can specify many other parameters to get BGP
   information:

   .. code-block:: none
   
      vyos@vyos:~$ show ipv6 bgp 
      Possible completions:
        <Enter>       Execute the current command
        <X:X::X:X>    Show BGP information for given address or prefix
        <X:X::X:X/M>
        community     Show routes matching the communities
        community-list
                      Show routes matching the community-list
        filter-list   Show routes conforming to the filter-list
        large-community
                      Show routes matching the large-community-list
        large-community-list
        neighbors     Show detailed information on TCP and BGP neighbor connections
        prefix-list   Show routes matching the prefix-list
        regexp        Show routes matching the AS path regular expression
        summary       Show summary of BGP neighbor status
      
      

.. opcmd:: show ipv6 ospfv3

   Use this command to get information about OSPFv3.

   You can get more specific OSPFv3 information by using the parameters
   shown below:
   
   .. code-block:: none
   
      vyos@vyos:~$ show ipv6 ospfv3 
      Possible completions:
        <Enter>       Execute the current command
        area          Show OSPFv3 spf-tree information
        border-routers
                      Show OSPFv3 border-router (ABR and ASBR) information
        database      Show OSPFv3 Link state database information
        interface     Show OSPFv3 interface information
        linkstate     Show OSPFv3 linkstate routing information
        neighbor      Show OSPFv3 neighbor information
        redistribute  Show OSPFv3 redistribute External information
        route         Show OSPFv3 routing table information
      
.. opcmd:: show ipv6 ripng

   Use this command to get information about the RIPNG protocol

.. opcmd:: show ipv6 ripng status

   Use this command to show the status of the RIPNG protocol



Reset commands
^^^^^^^^^^^^^^

.. opcmd:: reset ipv6 bgp <address>

   Use this command to clear Border Gateway Protocol statistics or
   status.


.. opcmd:: reset ipv6 neighbors <address | interface>

   Use this command to reset IPv6 Neighbor Discovery Protocol cache for 
   an address or interface.

.. opcmd:: reset ipv6 route cache

   Use this command to flush the kernel IPv6 route cache.
   An address can be added to flush it only for that route.