summaryrefslogtreecommitdiff
path: root/docs/_include/interface-address-with-dhcp.txt
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-10 20:26:15 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-10 20:26:15 +0100
commitbe6c3c1624174c5762a1349e31111d34db642767 (patch)
tree8bc6d89b6e4a6a971cab13b87b8acbc113340e25 /docs/_include/interface-address-with-dhcp.txt
parent0d8451f1dd3ba31e9c39ebafd2dc32f25d5f582d (diff)
downloadvyos-documentation-be6c3c1624174c5762a1349e31111d34db642767.tar.gz
vyos-documentation-be6c3c1624174c5762a1349e31111d34db642767.zip
interfaces: add common description include file
Diffstat (limited to 'docs/_include/interface-address-with-dhcp.txt')
-rw-r--r--docs/_include/interface-address-with-dhcp.txt20
1 files changed, 20 insertions, 0 deletions
diff --git a/docs/_include/interface-address-with-dhcp.txt b/docs/_include/interface-address-with-dhcp.txt
new file mode 100644
index 00000000..28968bea
--- /dev/null
+++ b/docs/_include/interface-address-with-dhcp.txt
@@ -0,0 +1,20 @@
+.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address | dhcp |
+ dhcpv6>
+
+ 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
+ * **dhcp** interface address is received by DHCP from a DHCP server
+ on this segment.
+ * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6
+ server on this segment.
+
+ Example:
+
+ .. code-block:: none
+
+ set interfaces {{ var0 }} {{ var1 }} address 192.0.2.1/24
+ set interfaces {{ var0 }} {{ var1 }} address 2001:db8::1/64
+ set interfaces {{ var0 }} {{ var1 }} dhcp
+ set interfaces {{ var0 }} {{ var1 }} dhcpv6 \ No newline at end of file