diff options
| author | Christian Poessinger <christian@poessinger.com> | 2020-11-23 21:19:44 +0100 | 
|---|---|---|
| committer | Christian Poessinger <christian@poessinger.com> | 2020-11-23 21:19:44 +0100 | 
| commit | cdb3550aaf1beb0d2069f33c5e66a232f7cbdee1 (patch) | |
| tree | b3419b21a2cd221101ea8d3ed23aed029adb2425 /docs/_include | |
| parent | 45ddcdc8132fd59032d4fb204f509e4aab8031f7 (diff) | |
| download | vyos-documentation-cdb3550aaf1beb0d2069f33c5e66a232f7cbdee1.tar.gz vyos-documentation-cdb3550aaf1beb0d2069f33c5e66a232f7cbdee1.zip | |
interfaces: vlan: remove wrong arg in cmd headline
Diffstat (limited to 'docs/_include')
| -rw-r--r-- | docs/_include/interface-address-with-dhcp.txt | 2 | ||||
| -rw-r--r-- | docs/_include/interface-description.txt | 2 | ||||
| -rw-r--r-- | docs/_include/interface-dhcp-options.txt | 22 | ||||
| -rw-r--r-- | docs/_include/interface-dhcpv6-options.txt | 24 | ||||
| -rw-r--r-- | docs/_include/interface-dhcpv6-prefix-delegation.txt | 57 | ||||
| -rw-r--r-- | docs/_include/interface-disable-link-detect.txt | 9 | ||||
| -rw-r--r-- | docs/_include/interface-disable.txt | 2 | ||||
| -rw-r--r-- | docs/_include/interface-ipv6-addr-autoconf.txt | 3 | ||||
| -rw-r--r-- | docs/_include/interface-ipv6-addr-eui64.txt | 3 | ||||
| -rw-r--r-- | docs/_include/interface-mac.txt | 3 | ||||
| -rw-r--r-- | docs/_include/interface-mtu.txt | 3 | ||||
| -rw-r--r-- | docs/_include/interface-vlan.txt | 16 | ||||
| -rw-r--r-- | docs/_include/interface-vrf.txt | 3 | 
13 files changed, 88 insertions, 61 deletions
| diff --git a/docs/_include/interface-address-with-dhcp.txt b/docs/_include/interface-address-with-dhcp.txt index 45bc9b03..20cd53ac 100644 --- a/docs/_include/interface-address-with-dhcp.txt +++ b/docs/_include/interface-address-with-dhcp.txt @@ -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. diff --git a/docs/_include/interface-description.txt b/docs/_include/interface-description.txt index 50c08d45..4347b837 100644 --- a/docs/_include/interface-description.txt +++ b/docs/_include/interface-description.txt @@ -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. diff --git a/docs/_include/interface-dhcp-options.txt b/docs/_include/interface-dhcp-options.txt index da1975fc..2bc23efc 100644 --- a/docs/_include/interface-dhcp-options.txt +++ b/docs/_include/interface-dhcp-options.txt @@ -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 diff --git a/docs/_include/interface-dhcpv6-options.txt b/docs/_include/interface-dhcpv6-options.txt index 94e80309..00b5e817 100644 --- a/docs/_include/interface-dhcpv6-options.txt +++ b/docs/_include/interface-dhcpv6-options.txt @@ -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 }} diff --git a/docs/_include/interface-dhcpv6-prefix-delegation.txt b/docs/_include/interface-dhcpv6-prefix-delegation.txt index 61e6aaa2..21721400 100644 --- a/docs/_include/interface-dhcpv6-prefix-delegation.txt +++ b/docs/_include/interface-dhcpv6-prefix-delegation.txt @@ -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 diff --git a/docs/_include/interface-disable-link-detect.txt b/docs/_include/interface-disable-link-detect.txt index 1cc97146..efd45e46 100644 --- a/docs/_include/interface-disable-link-detect.txt +++ b/docs/_include/interface-disable-link-detect.txt @@ -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
\ No newline at end of file +    set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} disable-link-detect
\ No newline at end of file diff --git a/docs/_include/interface-disable.txt b/docs/_include/interface-disable.txt index f0d22563..a9511d8e 100644 --- a/docs/_include/interface-disable.txt +++ b/docs/_include/interface-disable.txt @@ -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. diff --git a/docs/_include/interface-ipv6-addr-autoconf.txt b/docs/_include/interface-ipv6-addr-autoconf.txt index c0c5650d..e349a730 100644 --- a/docs/_include/interface-ipv6-addr-autoconf.txt +++ b/docs/_include/interface-ipv6-addr-autoconf.txt @@ -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 diff --git a/docs/_include/interface-ipv6-addr-eui64.txt b/docs/_include/interface-ipv6-addr-eui64.txt index 2e044b9d..10732bf3 100644 --- a/docs/_include/interface-ipv6-addr-eui64.txt +++ b/docs/_include/interface-ipv6-addr-eui64.txt @@ -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. diff --git a/docs/_include/interface-mac.txt b/docs/_include/interface-mac.txt index ca2b71e6..2daeaccf 100644 --- a/docs/_include/interface-mac.txt +++ b/docs/_include/interface-mac.txt @@ -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>`. diff --git a/docs/_include/interface-mtu.txt b/docs/_include/interface-mtu.txt index fd232f5d..8509779b 100644 --- a/docs/_include/interface-mtu.txt +++ b/docs/_include/interface-mtu.txt @@ -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. diff --git a/docs/_include/interface-vlan.txt b/docs/_include/interface-vlan.txt index 7b87c3eb..f1948e84 100644 --- a/docs/_include/interface-vlan.txt +++ b/docs/_include/interface-vlan.txt @@ -90,4 +90,20 @@ term used for this is ``vif``.     :var1: {{ var1 }}     :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
\ No newline at end of file diff --git a/docs/_include/interface-vrf.txt b/docs/_include/interface-vrf.txt index ca715fb2..450c82aa 100644 --- a/docs/_include/interface-vrf.txt +++ b/docs/_include/interface-vrf.txt @@ -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. | 
