summaryrefslogtreecommitdiff
path: root/docs/configuration/vrf/index.rst
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-05-22 09:19:05 +0200
committerChristian Breunig <christian@breunig.cc>2023-05-22 09:19:05 +0200
commit38e576b16b6ad4cad1075a6c496f098ac34f285f (patch)
tree42a073e301c4d839c6bb376d62c5fe2786091eb1 /docs/configuration/vrf/index.rst
parentc417c7c6b6b7fd5e90b80f970c32611cc32f60ad (diff)
downloadvyos-documentation-38e576b16b6ad4cad1075a6c496f098ac34f285f.tar.gz
vyos-documentation-38e576b16b6ad4cad1075a6c496f098ac34f285f.zip
vrf: T5234: Add bash identifier for given VRF instance
Diffstat (limited to 'docs/configuration/vrf/index.rst')
-rw-r--r--docs/configuration/vrf/index.rst15
1 files changed, 13 insertions, 2 deletions
diff --git a/docs/configuration/vrf/index.rst b/docs/configuration/vrf/index.rst
index f8139a0d..c4d8d067 100644
--- a/docs/configuration/vrf/index.rst
+++ b/docs/configuration/vrf/index.rst
@@ -194,8 +194,8 @@ For VRF maintenance the following operational commands are in place.
the round-trip time of these packets is used in calculating the minimum/
average/maximum round-trip time numbers.
- Ping command can be interrupted at any given time using `<Ctrl>+c`- A brief
- statistic is shown afterwards.
+ .. note:: Ping command can be interrupted at any given time using ``<Ctrl>+c``.
+ A brief statistic is shown afterwards.
.. code-block:: none
@@ -215,6 +215,17 @@ For VRF maintenance the following operational commands are in place.
route packets taken to the given hosts IP address family. This option is
useful when the host is specified as a hostname rather than an IP address.
+.. opcmd:: force vrf <name>
+
+ Join a given VRF. This will open a new subshell within the specified VRF.
+
+ The prompt is adjusted to reflect this change in both config and op-mode.
+
+ .. code-block:: none
+
+ vyos@vyos:~$ force vrf blue
+ vyos@vyos:blue:~$
+
.. _vrf example:
Example