summaryrefslogtreecommitdiff
path: root/docs/interfaces/geneve.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-01-22 20:26:33 +0100
committerChristian Poessinger <christian@poessinger.com>2020-01-22 20:26:33 +0100
commit895d4ae1f5aedb869b2746ed310f78473770f7ff (patch)
tree1eae4f594e945ca66d8c64b64a52327c96ea600d /docs/interfaces/geneve.rst
parent63a14bcb14ed3c1b15a41534366df31cfeb24137 (diff)
downloadvyos-documentation-895d4ae1f5aedb869b2746ed310f78473770f7ff.tar.gz
vyos-documentation-895d4ae1f5aedb869b2746ed310f78473770f7ff.zip
geneve: remove examples from command definition
Diffstat (limited to 'docs/interfaces/geneve.rst')
-rw-r--r--docs/interfaces/geneve.rst22
1 files changed, 17 insertions, 5 deletions
diff --git a/docs/interfaces/geneve.rst b/docs/interfaces/geneve.rst
index b0bfde06..79637ecc 100644
--- a/docs/interfaces/geneve.rst
+++ b/docs/interfaces/geneve.rst
@@ -35,15 +35,27 @@ Geneve Header:
Configuration
=============
-.. cfgcmd:: set interfaces geneve gnv0 address '192.0.2.2/24'
+.. cfgcmd:: set interfaces geneve gnv0 address <address>
- Create GENEVE tunnel listening on local address `192.0.2.2/24`.
+ Configure interface `<interface>` with one or more interface addresses.
+
+ **address** can be specified multiple times as IPv4 and/or IPv6 address,
+ e.g. 192.0.2.1/24 and/or 2001:db8::1/64
+
+ Example:
+
+ .. code-block:: none
+
+ set interfaces geneve gnv0 address 192.0.2.1/24
+ set interfaces geneve gnv0 address 192.0.2.2/24
+ set interfaces geneve gnv0 address 2001:db8::ffff/64
+ set interfaces geneve gnv0 address 2001:db8:100::ffff/64
.. cfgcmd:: set interfaces geneve gnv0 remote '172.18.204.10'
- Specify the IP address of the other end of the tunnel.
+ Configure GENEVE tunnel far end/remote tunnel endpoint.
-.. cfgcmd:: set interfaces geneve gnv0 vni '1000'
+.. cfgcmd:: set interfaces geneve gnv0 vni <vni>
:abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique
element of a virtual network. In many situations this may represent an L2
@@ -53,6 +65,6 @@ Configuration
address spaces contained in the encapsulated packet when load balancing
across CPUs.
-.. cfgcmd:: set interfaces geneve gnv0 mtu
+.. cfgcmd:: set interfaces geneve gnv0 mtu <mtu>
Set interface :abbr:`MTU (Maximum Transfer Unit)` size.