diff options
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/firewall/index.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/interfaces/openvpn.rst | 4 | ||||
| -rw-r--r-- | docs/configuration/protocols/bgp.rst | 1 | ||||
| -rw-r--r-- | docs/configuration/protocols/igmp.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/protocols/ospf.rst | 11 | ||||
| -rw-r--r-- | docs/configuration/service/dhcp-relay.rst | 8 | ||||
| -rw-r--r-- | docs/configuration/service/dhcp-server.rst | 12 | ||||
| -rw-r--r-- | docs/configuration/service/dns.rst | 4 | ||||
| -rw-r--r-- | docs/configuration/service/snmp.rst | 2 | ||||
| -rw-r--r-- | docs/configuration/system/name-server.rst | 1 | ||||
| -rw-r--r-- | docs/configuration/trafficpolicy/index.rst | 1 | ||||
| -rw-r--r-- | docs/configuration/vpn/dmvpn.rst | 2 |
12 files changed, 49 insertions, 1 deletions
diff --git a/docs/configuration/firewall/index.rst b/docs/configuration/firewall/index.rst index 02cfc7d1..667a4653 100644 --- a/docs/configuration/firewall/index.rst +++ b/docs/configuration/firewall/index.rst @@ -830,6 +830,8 @@ IPv6 Use this command to set the maximum segment size for IPv6 transit packets on a specific interface (1280-1492 bytes). +.. _firewall:ipv6_example: + Example ------- diff --git a/docs/configuration/interfaces/openvpn.rst b/docs/configuration/interfaces/openvpn.rst index 8b32743f..a30a0b81 100644 --- a/docs/configuration/interfaces/openvpn.rst +++ b/docs/configuration/interfaces/openvpn.rst @@ -481,6 +481,8 @@ and another VyOS router acting as OpenVPN client. The Server also pushes a static client IP address to the OpenVPN client. Remember, clients are identified using their CN attribute in the SSL certificate. +.. _openvpn:client_server: + Server ------ @@ -505,6 +507,8 @@ Server set interfaces openvpn vtun10 tls key-file '/config/auth/server.key' set interfaces openvpn vtun10 use-lzo-compression +.. _openvpn:client_client: + Client ------ diff --git a/docs/configuration/protocols/bgp.rst b/docs/configuration/protocols/bgp.rst index f1f15f38..25ec3038 100644 --- a/docs/configuration/protocols/bgp.rst +++ b/docs/configuration/protocols/bgp.rst @@ -222,6 +222,7 @@ Defining Peers Specify the IPv4 source address to use for the BGP session to this neighbor, may be specified as either an IPv4 address directly or as an interface name. +.. _bgp_capability_negotiation: Capability Negotiation ^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/configuration/protocols/igmp.rst b/docs/configuration/protocols/igmp.rst index 7109deb6..233e9828 100644 --- a/docs/configuration/protocols/igmp.rst +++ b/docs/configuration/protocols/igmp.rst @@ -225,6 +225,8 @@ Configuration Disable this service. +.. _igmp:proxy_example: + Example ------- diff --git a/docs/configuration/protocols/ospf.rst b/docs/configuration/protocols/ospf.rst index 76727517..64d7a893 100644 --- a/docs/configuration/protocols/ospf.rst +++ b/docs/configuration/protocols/ospf.rst @@ -743,9 +743,13 @@ address and the node 1 sending the default route: OSPFv3 (IPv6) ************* +.. _ospf:v3_configuration: + Configuration ============= +.. _ospf:v3_general: + General ------- @@ -768,6 +772,8 @@ process starts when the first ospf enabled interface is configured. configured with the same router-ID! +.. _ospf:v3_optional: + Optional -------- @@ -783,6 +789,7 @@ Optional distance values for external routes, inter-area routes and intra-area routes respectively. The distance range is 1 to 255. +.. _ospf:v3_area_configuration: Area Configuration ------------------ @@ -799,6 +806,7 @@ Area Configuration intra area paths from this range are not advertised into other areas. This command makes sense in ABR only. +.. _ospf:v3_interface_config: Interface Configuration ----------------------- @@ -869,6 +877,7 @@ Interface Configuration synchronizing process of the router's database with all neighbors. The default value is 1 seconds. The interval range is 3 to 65535. +.. _ospf:v3_redistribution_config: Redistribution Configuration ---------------------------- @@ -885,6 +894,7 @@ Redistribution Configuration given route source. There are five modes available for route source: bgp, connected, kernel, ripng, static. +.. _ospf:v3_op_cmd: Operational Mode Commands ------------------------- @@ -932,6 +942,7 @@ Operational Mode Commands This command displays external information redistributed into OSPFv3 +.. _ospf:v3_config_example: Configuration Example --------------------- diff --git a/docs/configuration/service/dhcp-relay.rst b/docs/configuration/service/dhcp-relay.rst index 5355a0fd..c0394dff 100644 --- a/docs/configuration/service/dhcp-relay.rst +++ b/docs/configuration/service/dhcp-relay.rst @@ -99,6 +99,8 @@ Operation IPv6 relay ********** +.. _dhcp-relay:ipv6_configuration: + Configuration ============= @@ -114,6 +116,8 @@ Configuration Specifies an upstream network `<interface>` from which replies from `<server>` and other relay agents will be accepted. +.. _dhcp-relay:ipv6_options: + Options ------- @@ -126,6 +130,8 @@ Options If this is set the relay agent will insert the interface ID. This option is set automatically if more than one listening interfaces are in use. +.. _dhcp-relay:ipv6_example: + Example ======= @@ -151,6 +157,8 @@ The generated configuration will look like: address 2001:db8::4 } +.. _dhcp-relay:ipv6_op_cmd: + Operation ========= diff --git a/docs/configuration/service/dhcp-server.rst b/docs/configuration/service/dhcp-server.rst index 3f435605..a6f64aa4 100644 --- a/docs/configuration/service/dhcp-server.rst +++ b/docs/configuration/service/dhcp-server.rst @@ -317,6 +317,8 @@ Example Please see the :ref:`dhcp-dns-quick-start` configuration. +.. _dhcp-server:v4_example_failover: + Failover -------- @@ -357,6 +359,7 @@ Common configuration, valid for both primary and secondary node. set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 failover peer-address '192.168.189.252' set service dhcp-server shared-network-name NET-VYOS subnet 192.0.2.0/24 failover status 'primary' +.. _dhcp-server:v4_example_raw: Raw Parameters -------------- @@ -377,7 +380,8 @@ Raw Parameters Option 43 for UniFI ------------------- -* These parameters need to be part of the DHCP global options. They stay unchanged. +* These parameters need to be part of the DHCP global options. + They stay unchanged. .. code-block:: none @@ -456,6 +460,8 @@ IPv6 server VyOS also provides DHCPv6 server functionality which is described in this section. +.. _dhcp-server:v6_config: + Configuration ============= @@ -557,6 +563,8 @@ The configuration will look as follows: } } +.. _dhcp-server:v6_static_mapping: + Static mappings --------------- @@ -603,6 +611,8 @@ The configuration will look as follows: .. start_vyoslinter +.. _dhcp-server:v6_op_cmd: + Operation Mode ============== diff --git a/docs/configuration/service/dns.rst b/docs/configuration/service/dns.rst index 5ee17490..ccf5a7d0 100644 --- a/docs/configuration/service/dns.rst +++ b/docs/configuration/service/dns.rst @@ -177,6 +177,8 @@ one involves a third party service, like DynDNS.com or any other similar website. This method uses HTTP requests to transmit the new IP address. You can configure both in VyOS. +.. _dns:dynmaic_config: + Configuration ============= @@ -218,6 +220,8 @@ Configuration Configure optional TTL value on the given resource record. This defaults to 600 seconds. +.. _dns:dynmaic_example: + Example ^^^^^^^ diff --git a/docs/configuration/service/snmp.rst b/docs/configuration/service/snmp.rst index 4a5a2780..36dc1787 100644 --- a/docs/configuration/service/snmp.rst +++ b/docs/configuration/service/snmp.rst @@ -139,6 +139,8 @@ The securityapproach in v3 targets: * Authentication – to verify that the message is from a valid source. +.. _snmp:v3_example: + Example ^^^^^^^ diff --git a/docs/configuration/system/name-server.rst b/docs/configuration/system/name-server.rst index c105c712..f18cb5a3 100644 --- a/docs/configuration/system/name-server.rst +++ b/docs/configuration/system/name-server.rst @@ -57,6 +57,7 @@ list can be defined which will be used for domain searches. .. note:: Domain names can include letters, numbers, hyphens and periods with a maximum length of 253 characters. +.. _name-server:domain-search-order_example: Example ------- diff --git a/docs/configuration/trafficpolicy/index.rst b/docs/configuration/trafficpolicy/index.rst index f3e498d4..b008a8d9 100644 --- a/docs/configuration/trafficpolicy/index.rst +++ b/docs/configuration/trafficpolicy/index.rst @@ -1114,6 +1114,7 @@ parameters. available and get suddenly dropped when other classes start using their assigned *bandwidth* share. +.. _traffic_policy:shaper_example: Example ^^^^^^^ diff --git a/docs/configuration/vpn/dmvpn.rst b/docs/configuration/vpn/dmvpn.rst index f902c388..f2c7b162 100644 --- a/docs/configuration/vpn/dmvpn.rst +++ b/docs/configuration/vpn/dmvpn.rst @@ -176,6 +176,8 @@ The below referenced IP address `192.0.2.1` is used as example address representing a global unicast address under which the HUB can be contacted by each and every individual spoke. +.. _dmvpn:example_configuration: + Configuration ============= |