summaryrefslogtreecommitdiff
path: root/docs/routing
diff options
context:
space:
mode:
Diffstat (limited to 'docs/routing')
-rw-r--r--docs/routing/ip-commands.rst63
1 files changed, 22 insertions, 41 deletions
diff --git a/docs/routing/ip-commands.rst b/docs/routing/ip-commands.rst
index fbfe2d24..eba4fd90 100644
--- a/docs/routing/ip-commands.rst
+++ b/docs/routing/ip-commands.rst
@@ -1,9 +1,8 @@
.. _ip-commands:
-***********
+###########
IP commands
-***********
-
+###########
IPv4
====
@@ -11,18 +10,15 @@ 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.
@@ -31,13 +27,12 @@ System configuration commands
Operational commands
--------------------
-
show commands
^^^^^^^^^^^^^
See below the different parameters available for the IPv4 **show** command:
-.. code-block::
+.. code-block:: none
vyos@vyos:~$ show ip
Possible completions:
@@ -62,23 +57,22 @@ See below the different parameters available for the IPv4 **show** command:
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::
+.. code-block:: none
- vyos@vyos:~$ reset ip
+ 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
====
@@ -91,61 +85,52 @@ System configuration commands
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.
-
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
+ vyos@vyos:~$ show ipv6 route
Possible completions:
<Enter> Execute the current command
<X:X::X:X> Show IPv6 routes of given address or prefix
@@ -162,7 +147,7 @@ Show commands
summary Show IPv6 routes summary
table Show IP routes in policy table
vrf Show IPv6 routes in VRF
-
+
.. opcmd:: show ipv6 prefix-list
@@ -172,13 +157,13 @@ Show commands
.. code-block:: none
- vyos@vyos:~$ show ipv6 prefix-list
+ 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
@@ -187,12 +172,10 @@ Show commands
.. code-block:: none
- vyos@vyos:~$ show ipv6 access-list
+ vyos@vyos:~$ show ipv6 access-list
Possible completions:
<Enter> Execute the current command
<text> Show specified IPv6 access-list
-
-
.. opcmd:: show ipv6 bgp
@@ -203,8 +186,8 @@ Show commands
information:
.. code-block:: none
-
- vyos@vyos:~$ show ipv6 bgp
+
+ vyos@vyos:~$ show ipv6 bgp
Possible completions:
<Enter> Execute the current command
<X:X::X:X> Show BGP information for given address or prefix
@@ -221,7 +204,7 @@ Show commands
regexp Show routes matching the AS path regular expression
route-map Show BGP routes matching the specified route map
summary Show summary of BGP neighbor status
-
+
.. opcmd:: show ipv6 ospfv3
@@ -229,10 +212,10 @@ Show commands
You can get more specific OSPFv3 information by using the parameters
shown below:
-
- .. code-block::
-
- vyos@vyos:~$ show ipv6 ospfv3
+
+ .. code-block:: none
+
+ vyos@vyos:~$ show ipv6 ospfv3
Possible completions:
<Enter> Execute the current command
area Show OSPFv3 spf-tree information
@@ -244,7 +227,7 @@ Show commands
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
@@ -254,7 +237,6 @@ Show commands
Use this command to show the status of the RIPNG protocol
-
Reset commands
^^^^^^^^^^^^^^
@@ -266,12 +248,11 @@ Reset commands
.. opcmd:: reset ipv6 neighbors <address | interface>
- Use this command to reset IPv6 Neighbor Discovery Protocol cache for
+ 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.
-
+ An address can be added to flush it only for that route.