diff options
Diffstat (limited to 'docs/_include')
25 files changed, 545 insertions, 333 deletions
diff --git a/docs/_include/interface-address-with-dhcp.txt b/docs/_include/interface-address-with-dhcp.txt index d454d051..101a4e6d 100644 --- a/docs/_include/interface-address-with-dhcp.txt +++ b/docs/_include/interface-address-with-dhcp.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} address <address | dhcp | dhcpv6> @@ -11,14 +14,15 @@ * **dhcpv6** interface address is received by DHCPv6 from a DHCPv6 server on this segment. - .. note:: When using DHCP to retrieve IPv4 address and if local - customizations are needed, they should be possible using the enter and - exit hooks provided. The hook dirs are: - - * ``/config/scripts/dhcp-client/pre-hooks.d/`` - * ``/config/scripts/dhcp-client/post-hooks.d/`` + :::{note} + When using DHCP to retrieve IPv4 address and if local + customizations are needed, they should be possible using the enter and + exit hooks provided. The hook dirs are: + * ``/config/scripts/dhcp-client/pre-hooks.d/`` + * ``/config/scripts/dhcp-client/post-hooks.d/`` + ::: Example: .. code-block:: none diff --git a/docs/_include/interface-address.txt b/docs/_include/interface-address.txt index 00a9ec09..90667dde 100644 --- a/docs/_include/interface-address.txt +++ b/docs/_include/interface-address.txt @@ -1,4 +1,6 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> address <address> +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> address \<address\> + +:::: Configure interface `<interface>` with one or more interface addresses. diff --git a/docs/_include/interface-common-with-dhcp.txt b/docs/_include/interface-common-with-dhcp.txt index 47b4796f..393706f1 100644 --- a/docs/_include/interface-common-with-dhcp.txt +++ b/docs/_include/interface-common-with-dhcp.txt @@ -1,21 +1,31 @@ -.. cmdinclude:: /_include/interface-address-with-dhcp.txt +```{cmdincludemd} /_include/interface-address-with-dhcp.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-common.txt +```{cmdincludemd} /_include/interface-common.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} **DHCP(v6)** -.. cmdinclude:: /_include/interface-dhcp-options.txt +```{cmdincludemd} /_include/interface-dhcp-options.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-dhcpv6-options.txt +```{cmdincludemd} /_include/interface-dhcpv6-options.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt +```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-common-without-dhcp.txt b/docs/_include/interface-common-without-dhcp.txt index 73d39dd0..260653e1 100644 --- a/docs/_include/interface-common-without-dhcp.txt +++ b/docs/_include/interface-common-without-dhcp.txt @@ -1,7 +1,11 @@ -.. cmdinclude:: /_include/interface-address.txt +```{cmdincludemd} /_include/interface-address.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-common.txt +```{cmdincludemd} /_include/interface-common.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-common-without-mac.txt b/docs/_include/interface-common-without-mac.txt index cc01db12..4803d4ca 100644 --- a/docs/_include/interface-common-without-mac.txt +++ b/docs/_include/interface-common-without-mac.txt @@ -1,31 +1,47 @@ -.. cmdinclude:: /_include/interface-description.txt +```{cmdincludemd} /_include/interface-description.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable.txt +```{cmdincludemd} /_include/interface-disable.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable-flow-control.txt +```{cmdincludemd} /_include/interface-disable-flow-control.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable-link-detect.txt +```{cmdincludemd} /_include/interface-disable-link-detect.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-mtu.txt +```{cmdincludemd} /_include/interface-mtu.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-ip.txt +```{cmdincludemd} /_include/interface-ip.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-ipv6.txt +```{cmdincludemd} /_include/interface-ipv6.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-vrf.txt +```{cmdincludemd} /_include/interface-vrf.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-common.txt b/docs/_include/interface-common.txt index 5a997482..45634cd8 100644 --- a/docs/_include/interface-common.txt +++ b/docs/_include/interface-common.txt @@ -1,35 +1,53 @@ -.. cmdinclude:: /_include/interface-description.txt +```{cmdincludemd} /_include/interface-description.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable.txt +```{cmdincludemd} /_include/interface-disable.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable-flow-control.txt +```{cmdincludemd} /_include/interface-disable-flow-control.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-disable-link-detect.txt +```{cmdincludemd} /_include/interface-disable-link-detect.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-mac.txt +```{cmdincludemd} /_include/interface-mac.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-mtu.txt +```{cmdincludemd} /_include/interface-mtu.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-ip.txt +```{cmdincludemd} /_include/interface-ip.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-ipv6.txt +```{cmdincludemd} /_include/interface-ipv6.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} -.. cmdinclude:: /_include/interface-vrf.txt +```{cmdincludemd} /_include/interface-vrf.txt +``` + :var0: {{ var0 }} :var1: {{ var1 }} diff --git a/docs/_include/interface-description.txt b/docs/_include/interface-description.txt index 064d9559..ac3cbbb0 100644 --- a/docs/_include/interface-description.txt +++ b/docs/_include/interface-description.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} description <description> Set a human readable, descriptive alias for this connection. Alias is used by diff --git a/docs/_include/interface-dhcp-options.txt b/docs/_include/interface-dhcp-options.txt index 27a80acd..1b25b9cb 100644 --- a/docs/_include/interface-dhcp-options.txt +++ b/docs/_include/interface-dhcp-options.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options client-id <description> :rfc:`2131` states: The client MAY choose to explicitly provide the identifier @@ -13,7 +16,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options client-id 'foo-bar' -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options host-name <hostname> Instead of sending the real system hostname to the DHCP server, overwrite the @@ -25,7 +31,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options host-name 'VyOS' -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options vendor-class-id <vendor-id> The vendor-class-id option can be used to request a specific class of vendor @@ -37,7 +46,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options vendor-class-id 'VyOS' -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options no-default-route Only request an address from the DHCP server but do not request a default @@ -49,7 +61,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options no-default-route -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options default-route-distance <distance> Set the distance for the default gateway sent by the DHCP server. @@ -60,7 +75,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcp-options default-route-distance 220 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcp-options reject <address> Reject DHCP leases from a given address or range. diff --git a/docs/_include/interface-dhcpv6-options.txt b/docs/_include/interface-dhcpv6-options.txt index a2361e11..4f6b9617 100644 --- a/docs/_include/interface-dhcpv6-options.txt +++ b/docs/_include/interface-dhcpv6-options.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options duid <duid> The DHCP unique identifier (DUID) is used by a client to get an IP address @@ -11,7 +14,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} duid '0e:00:00:01:00:01:27:71:db:f0:00:50:56:bf:c5:6d' -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options no-release When no-release is specified, dhcp6c will send a release message on client @@ -22,7 +28,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options no-release -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options parameters-only This statement specifies dhcp6c to only exchange informational configuration @@ -34,7 +43,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options parameters-only -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options rapid-commit When rapid-commit is specified, dhcp6c will include a rapid-commit option in @@ -44,7 +56,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options rapid-commit -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options temporary Request only a temporary address and not form an IA_NA (Identity Association diff --git a/docs/_include/interface-dhcpv6-prefix-delegation.txt b/docs/_include/interface-dhcpv6-prefix-delegation.txt index c6564092..1974ade0 100644 --- a/docs/_include/interface-dhcpv6-prefix-delegation.txt +++ b/docs/_include/interface-dhcpv6-prefix-delegation.txt @@ -4,7 +4,10 @@ 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> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options pd <id> length <length> Some ISPs by default only delegate a /64 prefix. To request for a specific @@ -20,7 +23,10 @@ networks. set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 length 56 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee> address <address> @@ -44,7 +50,10 @@ networks. set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} dhcpv6-options pd 0 interface eth8 address 65534 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} dhcpv6-options pd <id> interface <delegatee> sla-id <id> Specify the identifier value of the site-level aggregator (SLA) on the diff --git a/docs/_include/interface-disable-flow-control.txt b/docs/_include/interface-disable-flow-control.txt index 347f1145..88328c18 100644 --- a/docs/_include/interface-disable-flow-control.txt +++ b/docs/_include/interface-disable-flow-control.txt @@ -1,5 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} - disable-flow-control +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +disable-flow-control +:::: Ethernet flow control is a mechanism for temporarily stopping the transmission of data on Ethernet family computer networks. The goal of this mechanism is to diff --git a/docs/_include/interface-disable-link-detect.txt b/docs/_include/interface-disable-link-detect.txt index 1a766715..a8add7f7 100644 --- a/docs/_include/interface-disable-link-detect.txt +++ b/docs/_include/interface-disable-link-detect.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} disable-link-detect Use this command to direct an interface to not detect any physical state diff --git a/docs/_include/interface-disable.txt b/docs/_include/interface-disable.txt index 774c1cdd..8ceea73b 100644 --- a/docs/_include/interface-disable.txt +++ b/docs/_include/interface-disable.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} disable Disable given `<interface>`. It will be placed in administratively down diff --git a/docs/_include/interface-eapol.txt b/docs/_include/interface-eapol.txt index 640fc6e3..19edfaf6 100644 --- a/docs/_include/interface-eapol.txt +++ b/docs/_include/interface-eapol.txt @@ -6,7 +6,10 @@ resources. EAPoL comes with an identify option. We automatically use the interface MAC address as identity parameter. -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} eapol ca-certificate <name> Set the name of the SSL :abbr:`CA (Certificate Authority)` PKI entry used for @@ -23,7 +26,10 @@ address as identity parameter. set pki ca eapol-server-root-ca <Server root CA contents> set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} eapol ca-certificate eapol-server-intermediate-ca -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} eapol certificate <name> Set the name of the x509 client keypair used to authenticate against the diff --git a/docs/_include/interface-evpn-uplink.txt b/docs/_include/interface-evpn-uplink.txt index 3495361d..ff319799 100644 --- a/docs/_include/interface-evpn-uplink.txt +++ b/docs/_include/interface-evpn-uplink.txt @@ -1,4 +1,6 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> evpn uplink +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> evpn uplink + +:::: When all the underlay links go down the PE no longer has access to the VxLAN +overlay. To prevent blackholing of traffic the diff --git a/docs/_include/interface-ip.txt b/docs/_include/interface-ip.txt index 6359aceb..2b8e9a00 100644 --- a/docs/_include/interface-ip.txt +++ b/docs/_include/interface-ip.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip adjust-mss <mss | clamp-mss-to-pmtu> As Internet wide PMTU discovery rarely works, we sometimes need to clamp our @@ -6,16 +9,23 @@ a SYN packet. By setting the MSS value, you are telling the remote side unequivocally 'do not try to send me packets bigger than this value'. - .. note:: This command was introduced in VyOS 1.4 - it was previously called: - ``set firewall options interface <name> adjust-mss <value>`` + :::{note} + This command was introduced in VyOS 1.4 - it was previously called: - .. hint:: MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in - 1452 bytes on a 1492 byte MTU. + ``set firewall options interface <name> adjust-mss <value>`` + ::: + :::{hint} + MSS value = MTU - 20 (IP header) - 20 (TCP header), resulting in + 1452 bytes on a 1492 byte MTU. + ::: Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to automatically set the proper value. -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip arp-cache-timeout Once a neighbor has been found, the entry is considered to be valid for at @@ -30,7 +40,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip arp-cache-timeout 180 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip disable-arp-filter If set the kernel can respond to arp requests with addresses from other @@ -53,7 +66,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip disable-arp-filter -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip disable-forwarding Configure interface-specific Host/Router behaviour. If set, the interface will @@ -63,7 +79,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip disable-forwarding -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip enable-directed-broadcast Define different modes for IP directed broadcast forwarding as described in @@ -79,7 +98,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-directed-broadcast -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip enable-arp-accept Define behavior for gratuitous ARP frames who's IP is not already present in @@ -95,7 +117,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-accept -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip enable-arp-announce Define different restriction levels for announcing the local source IP address @@ -115,7 +140,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-announce -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip enable-arp-ignore Define different modes for sending replies in response to received ARP @@ -131,7 +159,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-arp-ignore -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip enable-proxy-arp Use this command to enable proxy Address Resolution Protocol (ARP) on this @@ -147,7 +178,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ip enable-proxy-arp -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip proxy-arp-pvlan Private VLAN proxy arp. Basically allow proxy arp replies back to the same @@ -159,8 +193,9 @@ possible to allow these hosts to communicate through the upstream router by proxy_arp'ing. - .. note:: Does not need to be used together with proxy_arp. - + :::{note} + Does not need to be used together with proxy_arp. + ::: This technology is known by different names: - In :rfc:`3069` it is called VLAN Aggregation @@ -171,7 +206,10 @@ - Ericsson call it MAC-Forced Forwarding (RFC Draft) -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ip source-validation <strict | loose | disable> Enable policy for source validation by reversed path, as specified in diff --git a/docs/_include/interface-ipv6.txt b/docs/_include/interface-ipv6.txt index 0c222d80..1d3b741b 100644 --- a/docs/_include/interface-ipv6.txt +++ b/docs/_include/interface-ipv6.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 address autoconf :abbr:`SLAAC (Stateless Address Autoconfiguration)` :rfc:`4862`. IPv6 hosts @@ -9,9 +12,11 @@ its configuration parameters; routers respond to such a request with a router advertisement packet that contains Internet Layer configuration parameters. - .. note:: This method automatically disables IPv6 traffic forwarding on the - interface in question. + :::{note} + This method automatically disables IPv6 traffic forwarding on the + interface in question. + ::: Example: .. code-block:: none @@ -19,7 +24,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address autoconf -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 address eui64 <prefix> :abbr:`EUI-64 (64-Bit Extended Unique Identifier)` as specified in @@ -31,7 +39,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address eui64 2001:db8:beef::/64 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 address no-default-link-local Do not assign a link-local IPv6 address to this interface. @@ -42,7 +53,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 address no-default-link-local -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 disable-forwarding Configure interface-specific Host/Router behaviour. If set, the interface will @@ -54,7 +68,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 disable-forwarding -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 adjust-mss <mss | clamp-mss-to-pmtu> As Internet wide PMTU discovery rarely works, we sometimes need to clamp our @@ -62,16 +79,23 @@ a SYN packet. By setting the MSS value, you are telling the remote side unequivocally 'do not try to send me packets bigger than this value'. - .. note:: This command was introduced in VyOS 1.4 - it was previously called: - ``set firewall options interface <name> adjust-mss6 <value>`` + :::{note} + This command was introduced in VyOS 1.4 - it was previously called: - .. hint:: MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in - 1432 bytes on a 1492 byte MTU. + ``set firewall options interface <name> adjust-mss6 <value>`` + ::: + :::{hint} + MSS value = MTU - 40 (IPv6 header) - 20 (TCP header), resulting in + 1432 bytes on a 1492 byte MTU. + ::: Instead of a numerical MSS value `clamp-mss-to-pmtu` can be used to automatically set the proper value. -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 accept-dad <1-3> Whether to accept DAD (Duplicate Address Detection). @@ -86,7 +110,10 @@ set interfaces {{ var0 }} {{ var1 }} {{ var2 }} {{ var4 }} {{ var5 }} {{ var7 }} ipv6 accept-dad 2 -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} ipv6 dup-addr-detect-transmits <n> The amount of Duplicate Address Detection probes to send. diff --git a/docs/_include/interface-mac.txt b/docs/_include/interface-mac.txt index 03aa6106..d81ce660 100644 --- a/docs/_include/interface-mac.txt +++ b/docs/_include/interface-mac.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} mac <xx:xx:xx:xx:xx:xx> Configure user defined :abbr:`MAC (Media Access Control)` address on given diff --git a/docs/_include/interface-mirror.txt b/docs/_include/interface-mirror.txt index 66d63248..3e2a7bed 100644 --- a/docs/_include/interface-mirror.txt +++ b/docs/_include/interface-mirror.txt @@ -10,28 +10,31 @@ VyOS uses the `mirror` option to configure port mirroring. The configuration is divided into 2 different directions. Destination ports should be configured for different traffic directions. -.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror - ingress <monitor-interface> - - Configure port mirroring for `interface` inbound traffic and copy the - traffic to `monitor-interface` - - Example: Mirror the inbound traffic of `{{ var1 }}` port to `{{ var2 }}` - - .. code-block:: none - - set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} - -.. cfgcmd:: set interfaces {{ var0 }} <interface> mirror egress - <monitor-interface> - - Configure port mirroring for `interface` outbound traffic and copy the - traffic to `monitor-interface` - - Example: Mirror the outbound traffic of `{{ var1 }}` port to `{{ var2 }}` - - .. code-block:: none - - set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} - - +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> mirror + +ingress <monitor-interface> + +Configure port mirroring for `interface` inbound traffic and copy the +traffic to `monitor-interface` + +Example: Mirror the inbound traffic of `{{ var1 }}` port to `{{ var2 }}` + +```none + +``` + set interfaces {{ var0 }} {{ var1 }} mirror ingress {{ var2 }} +:::: +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> mirror egress + +<monitor-interface> + +Configure port mirroring for `interface` outbound traffic and copy the +traffic to `monitor-interface` + +Example: Mirror the outbound traffic of `{{ var1 }}` port to `{{ var2 }}` + +```none + +``` + set interfaces {{ var0 }} {{ var1 }} mirror egress {{ var2 }} +:::: diff --git a/docs/_include/interface-mtu.txt b/docs/_include/interface-mtu.txt index f3666179..01bf102e 100644 --- a/docs/_include/interface-mtu.txt +++ b/docs/_include/interface-mtu.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} mtu <mtu> Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It diff --git a/docs/_include/interface-per-client-thread.txt b/docs/_include/interface-per-client-thread.txt index 877be591..bc662ff5 100644 --- a/docs/_include/interface-per-client-thread.txt +++ b/docs/_include/interface-per-client-thread.txt @@ -1,4 +1,7 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} per-client-thread Provides a per-device control to enable/disable the threaded mode for diff --git a/docs/_include/interface-vlan-8021ad.txt b/docs/_include/interface-vlan-8021ad.txt index 0a1722dc..ad808880 100644 --- a/docs/_include/interface-vlan-8021ad.txt +++ b/docs/_include/interface-vlan-8021ad.txt @@ -28,126 +28,138 @@ tag is the one closer/closest to the Ethernet header, its name is S-TAG (service tag with Ethernet Type = 0x88a8). -.. cmdinclude:: /_include/interface-address-with-dhcp.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-description.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-disable.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-disable-link-detect.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-mac.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-mtu.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-ip.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-ipv6.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-vrf.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 +```{cmdincludemd} /_include/interface-address-with-dhcp.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-description.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-disable.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-disable-link-detect.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-mac.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-mtu.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-ip.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-ipv6.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-vrf.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` **DHCP(v6)** -.. cmdinclude:: /_include/interface-dhcp-options.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-dhcpv6-options.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 - -.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif-s - :var3: <vlan-id> - :var4: 1000 - :var5: vif-c - :var6: <vlan-id> - :var7: 20 +```{cmdincludemd} /_include/interface-dhcp-options.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-dhcpv6-options.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` + +```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif-s +:var3: <vlan-id> +:var4: 1000 +:var5: vif-c +:var6: <vlan-id> +:var7: 20 +``` .. include:: /_include/common-references.txt diff --git a/docs/_include/interface-vlan-8021q.txt b/docs/_include/interface-vlan-8021q.txt index 1a527590..70e017c4 100644 --- a/docs/_include/interface-vlan-8021q.txt +++ b/docs/_include/interface-vlan-8021q.txt @@ -21,7 +21,9 @@ revisions is 802.1Q-2014 which incorporated IEEE 802.1aq 802.1q VLAN interfaces are represented as virtual sub-interfaces in VyOS. The term used for this is ``vif``. -.. cfgcmd:: set interfaces {{ var0 }} <interface> vif <vlan-id> +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> vif \<vlan-id\> + +:::: Create a new VLAN interface on interface `<interface>` using the VLAN number provided via `<vlan-id>`. @@ -29,92 +31,106 @@ term used for this is ``vif``. You can create multiple VLAN interfaces on a physical interface. The VLAN ID range is from 0 to 4094. - .. note:: Only 802.1Q-tagged packets are accepted on Ethernet vifs. - -.. cmdinclude:: /_include/interface-address-with-dhcp.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-description.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-disable.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-disable-link-detect.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-mac.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-mtu.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-ip.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-ipv6.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 - -.. cmdinclude:: /_include/interface-vrf.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 + :::{note} + Only 802.1Q-tagged packets are accepted on Ethernet vifs. + ::: + +```{cmdincludemd} /_include/interface-address-with-dhcp.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-description.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-disable.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-disable-link-detect.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-mac.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-mtu.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-ip.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-ipv6.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-vrf.txt +:var0: {{ var0 }} +: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 - -.. cmdinclude:: /_include/interface-dhcpv6-prefix-delegation.txt - :var0: {{ var0 }} - :var1: {{ var1 }} - :var2: vif - :var3: <vlan-id> - :var4: 10 +```{cmdincludemd} /_include/interface-dhcp-options.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-dhcpv6-options.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` + +```{cmdincludemd} /_include/interface-dhcpv6-prefix-delegation.txt +:var0: {{ var0 }} +:var1: {{ var1 }} +:var2: vif +:var3: <vlan-id> +:var4: 10 +``` .. include:: /_include/common-references.txt diff --git a/docs/_include/interface-vrf.txt b/docs/_include/interface-vrf.txt index 1fa94f9f..ab98c2d3 100644 --- a/docs/_include/interface-vrf.txt +++ b/docs/_include/interface-vrf.txt @@ -1,11 +1,16 @@ -.. cfgcmd:: set interfaces {{ var0 }} <interface> {{ var2 }} {{ var3 }} +::::{cfgcmd} set interfaces {{ var0 }} \<interface\> {{ var2 }} {{ var3 }} + +:::: + {{ var5 }} {{ var6 }} vrf <vrf> Place interface in given VRF instance. - .. seealso:: There is an entire chapter about how to configure a :ref:`vrf`, - please check this for additional information. + :::{seealso} + There is an entire chapter about how to configure a :ref:`vrf`, + please check this for additional information. + ::: Example: .. code-block:: none diff --git a/docs/_include/need_improvement.txt b/docs/_include/need_improvement.txt index 1ce50685..3404c7e1 100644 --- a/docs/_include/need_improvement.txt +++ b/docs/_include/need_improvement.txt @@ -1,21 +1,8 @@ -.. raw:: latex - - \iffalse - -.. raw:: html - - <div class="admonition error"> - <p class="admonition-title">Call for Contributions</p> - +:::{error} Call for Contributions This section needs improvements, examples and explanations. Please take a look at the Contributing Guide for our :ref:`documentation`. - -.. raw:: html - - </div> - -.. raw:: latex +::: \fi
\ No newline at end of file |