mirror of
https://github.com/vyos/vyos-documentation.git
synced 2025-10-26 08:41:46 +01:00
interfaces: vlan: remove wrong arg in cmd headline
This commit is contained in:
Christian Poessinger
parent
45ddcdc813
commit
cdb3550aaf
@ -1,4 +1,4 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} address <address | dhcp |
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} address <address | dhcp |
|
||||
dhcpv6>
|
||||
|
||||
Configure interface `<interface>` with one or more interface addresses.
|
||||
|
||||
@ -1,4 +1,4 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} description <description>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} description <description>
|
||||
|
||||
Set a human readable, descriptive alias for this connection. Alias is used by
|
||||
e.g. the :opcmd:`show interfaces` command or SNMP based monitoring tools.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options client-id <description>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcp-options client-id <description>
|
||||
|
||||
:rfc:`2131` states: The client MAY choose to explicitly provide the identifier
|
||||
through the 'client identifier' option. If the client supplies a 'client
|
||||
@ -10,9 +11,10 @@
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcp-options client-id 'foo-bar'
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcp-options client-id 'foo-bar'
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options host-name <hostname>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcp-options host-name <hostname>
|
||||
|
||||
Instead of sending the real system hostname to the DHCP server, overwrite the
|
||||
host-name with this given-value.
|
||||
@ -21,20 +23,22 @@
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcp-options host-name 'VyOS'
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcp-options host-name 'VyOS'
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options vendor-class-id <vendor-id>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcp-options vendor-class-id <vendor-id>
|
||||
|
||||
The vendor-class-id option can be used to request a specific class of vendor
|
||||
options from the server.
|
||||
|
||||
Example
|
||||
Example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcp-options vendor-class-id 'VyOS'
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcp-options vendor-class-id 'VyOS'
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcp-options no-default-route
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcp-options no-default-route
|
||||
|
||||
Only request an address from the DHCP server but do not request a default
|
||||
gateway.
|
||||
@ -43,4 +47,4 @@
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcp-options no-default-route
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcp-options no-default-route
|
||||
|
||||
@ -1,38 +1,38 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options parameters-only
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-options parameters-only
|
||||
|
||||
This statement specifies dhcp6c to only exchange informational configuration
|
||||
parameters with servers. A list of DNS server addresses is an example of such
|
||||
parameters. This statement is useful when the client does not need stateful
|
||||
configuration parameters such as IPv6 addresses or prefixes.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-options parameters-only
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-options parameters-only
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options rapid-commit
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-options rapid-commit
|
||||
|
||||
When rapid-commit is specified, dhcp6c will include a rapid-commit option in
|
||||
solicit messages and wait for an immediate reply instead of advertisements.
|
||||
|
||||
Example:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-options rapid-commit
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-options rapid-commit
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options temporary
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-options temporary
|
||||
|
||||
Request only a temporary address and not form an IA_NA (Identity Association
|
||||
for Non-temporary Addresses) partnership.
|
||||
|
||||
Example
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-options temporary
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-options temporary
|
||||
|
||||
.. cmdinclude:: ../_include/interface-dhcpv6-prefix-delegation.txt
|
||||
:var0: {{ var0 }}
|
||||
:var1: {{ var1 }}
|
||||
:var2: {{ var2 }}
|
||||
:var3: {{ var3 }}
|
||||
:var4: {{ var4 }}
|
||||
|
||||
@ -3,52 +3,53 @@
|
||||
VyOS 1.3 (equuleus) supports DHCPv6-PD (:rfc:`3633`). DHCPv6 Prefix Delegation
|
||||
is supported by most ISPs who provide native IPv6 for consumers on fixed networks.
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-option pd <id> length <length>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-option pd <id> length <length>
|
||||
|
||||
Some ISPs by default only delegate a /64 prefix. To request for a specific
|
||||
prefix size use this option to request for a bigger delegation for this pd
|
||||
`<id>`. This value is in the range from 32 - 64 so you could request up to a
|
||||
/32 prefix (if your ISP allows this) down to a /64 delegation.
|
||||
Some ISPs by default only delegate a /64 prefix. To request for a specific
|
||||
prefix size use this option to request for a bigger delegation for this pd
|
||||
`<id>`. This value is in the range from 32 - 64 so you could request up to a
|
||||
/32 prefix (if your ISP allows this) down to a /64 delegation.
|
||||
|
||||
The default value corresponds to 64.
|
||||
|
||||
Example:
|
||||
The default value corresponds to 64.
|
||||
|
||||
To request a /56 prefix from your ISP use:
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-options pd 0 length 56
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-options pd 0 length 56
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-option pd <id> interface <delegatee> address <address>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-option pd <id> interface <delegatee> address <address>
|
||||
|
||||
Specify the interface address used locally on the interfcae where the prefix
|
||||
has been delegated to. ID must be a decimal integer.
|
||||
Specify the interface address used locally on the interfcae where the prefix
|
||||
has been delegated to. ID must be a decimal integer.
|
||||
|
||||
It will be combined with the delegated prefix and the sla-id to form a
|
||||
complete interface address. The default is to use the EUI-64 address of the
|
||||
interface.
|
||||
It will be combined with the delegated prefix and the sla-id to form a
|
||||
complete interface address. The default is to use the EUI-64 address of the
|
||||
interface.
|
||||
|
||||
Example: Delegate a /64 prefix to interface eth0.10 which will use a local
|
||||
address on this router of ``<prefix>::ffff``, as the address 65534 will
|
||||
correspond to ``ffff`` in hexadecimal notation.
|
||||
Example: Delegate a /64 prefix to interface eth8 which will use a local
|
||||
address on this router of ``<prefix>::ffff``, as the address 65534 will
|
||||
correspond to ``ffff`` in hexadecimal notation.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-option pd 0 interface eth0.10 address 65534
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-option pd 0 interface eth8 address 65534
|
||||
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-option pd <id> interface <delegatee> sla-id <id>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
dhcpv6-option pd <id> interface <delegatee> sla-id <id>
|
||||
|
||||
Specify the identifier value of the site-level aggregator (SLA) on the
|
||||
interface. ID must be a decimal number greater then 0 which fits in the
|
||||
length of SLA IDs (see below).
|
||||
Specify the identifier value of the site-level aggregator (SLA) on the
|
||||
interface. ID must be a decimal number greater then 0 which fits in the
|
||||
length of SLA IDs (see below).
|
||||
|
||||
Example: If ID is 1 and the client is delegated an IPv6 prefix
|
||||
2001:db8:ffff::/48, dhcp6c will combine the two values into a single IPv6
|
||||
prefix, 2001:db8:ffff:1::/64, and will configure the prefix on the specified
|
||||
interface.
|
||||
Example: If ID is 1 and the client is delegated an IPv6 prefix
|
||||
2001:db8:ffff::/48, dhcp6c will combine the two values into a single IPv6
|
||||
prefix, 2001:db8:ffff:1::/64, and will configure the prefix on the specified
|
||||
interface.
|
||||
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} dhcpv6-option pd 0 interface eth0.10 sla-id 1
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} dhcpv6-option pd 0 interface eth8 sla-id 1
|
||||
|
||||
|
||||
@ -1,12 +1,13 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} disable-link-detect
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
disable-link-detect
|
||||
|
||||
Use this command to direct an interface to not detect any physical state
|
||||
changes on a link, for example, when the cable is unplugged.
|
||||
|
||||
Default is to detects physical link state changes.
|
||||
|
||||
Example:
|
||||
Example:
|
||||
|
||||
.. code-block:: none
|
||||
.. code-block:: none
|
||||
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} disable-link-detect
|
||||
set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} disable-link-detect
|
||||
@ -1,4 +1,4 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} disable
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} disable
|
||||
|
||||
Disable given `<interface>`. It will be placed in administratively down
|
||||
(``A/D``) state.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} ipv6 address autoconf
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
ipv6 address autoconf
|
||||
|
||||
:abbr:`SLAAC (Stateless Address Autoconfiguration)` :rfc:`4862`. IPv6 hosts
|
||||
can configure themselves automatically when connected to an IPv6 network using
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} ipv6 address eui64 <prefix>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
ipv6 address eui64 <prefix>
|
||||
|
||||
:abbr:`EUI-64 (64-Bit Extended Unique Identifier)` as specified in
|
||||
:rfc:`4291` allows a host to assign iteslf a unique 64-Bit IPv6 address.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} mac <xx:xx:xx:xx:xx:xx>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
mac <xx:xx:xx:xx:xx:xx>
|
||||
|
||||
Configure user defined :abbr:`MAC (Media Access Control)` address on given
|
||||
`<interface>`.
|
||||
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} mtu <mtu>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
mtu <mtu>
|
||||
|
||||
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
|
||||
is the size (in bytes) of the largest ethernet frame sent on this link.
|
||||
|
||||
@ -91,3 +91,19 @@ term used for this is ``vif``.
|
||||
:var2: vif
|
||||
:var3: <vlan-id>
|
||||
:var4: 10
|
||||
|
||||
**DHCP(v6)**
|
||||
|
||||
.. cmdinclude:: ../_include/interface-dhcp-options.txt
|
||||
:var0: {{ var0 }}
|
||||
:var1: {{ var1 }}
|
||||
:var2: vif
|
||||
:var3: <vlan-id>
|
||||
:var4: 10
|
||||
|
||||
.. cmdinclude:: ../_include/interface-dhcpv6-options.txt
|
||||
:var0: {{ var0 }}
|
||||
:var1: {{ var1 }}
|
||||
:var2: vif
|
||||
:var3: <vlan-id>
|
||||
:var4: 10
|
||||
@ -1,4 +1,5 @@
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} {{ var4 }} vrf <vrf>
|
||||
.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }}
|
||||
vrf <vrf>
|
||||
|
||||
Place interface in given VRF instance.
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user