diff options
| author | Grant <github@firefishy.com> | 2025-12-30 13:06:07 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2025-12-30 13:06:07 +0000 |
| commit | 2a03cb0c2e5204d20decb1f7d050beeab1505b97 (patch) | |
| tree | 4129f8c7eb0d95e8ac9b247015edd96fcf9bb33e /docs/configuration | |
| parent | d7b0a1e7bd3b4696fc1ca992953d19bfb01e8ebb (diff) | |
| download | vyos-documentation-2a03cb0c2e5204d20decb1f7d050beeab1505b97.tar.gz vyos-documentation-2a03cb0c2e5204d20decb1f7d050beeab1505b97.zip | |
DOC: Copyedit policy local-route, correct and add missing params (#1729)
* Fix: destination -> destination address
* Fix: source -> source address
* Add: destination port
* Add: source port
* Add: protocol
* Add: fwmark
* Improve wording for clarity
Diffstat (limited to 'docs/configuration')
| -rw-r--r-- | docs/configuration/policy/examples.rst | 10 | ||||
| -rw-r--r-- | docs/configuration/policy/local-route.rst | 66 |
2 files changed, 58 insertions, 18 deletions
diff --git a/docs/configuration/policy/examples.rst b/docs/configuration/policy/examples.rst index 7c7b9c46..d822d839 100644 --- a/docs/configuration/policy/examples.rst +++ b/docs/configuration/policy/examples.rst @@ -167,9 +167,9 @@ provider, and the second through another. .. code-block:: none set policy local-route rule 101 set table '10' - set policy local-route rule 101 source '203.0.113.254' + set policy local-route rule 101 source address '203.0.113.254' set policy local-route rule 102 set table '11' - set policy local-route rule 102 source '192.0.2.254' + set policy local-route rule 102 source address '192.0.2.254' set protocols static table 10 route 0.0.0.0/0 next-hop '203.0.113.1' set protocols static table 11 route 0.0.0.0/0 next-hop '192.0.2.2' @@ -178,9 +178,9 @@ Add multiple source IP in one rule with same priority .. code-block:: none set policy local-route rule 101 set table '10' - set policy local-route rule 101 source '203.0.113.254' - set policy local-route rule 101 source '203.0.113.253' - set policy local-route rule 101 source '198.51.100.0/24' + set policy local-route rule 101 source address '203.0.113.254' + set policy local-route rule 101 source address '203.0.113.253' + set policy local-route rule 101 source address '198.51.100.0/24' ########################### Clamp MSS for a specific IP diff --git a/docs/configuration/policy/local-route.rst b/docs/configuration/policy/local-route.rst index e24d61d0..a3e42816 100644 --- a/docs/configuration/policy/local-route.rst +++ b/docs/configuration/policy/local-route.rst @@ -13,35 +13,75 @@ Local Route IPv4 .. cfgcmd:: set policy local-route rule <1-32765> set table <1-200|main> - Set routing table to forward packet to. + Set the routing table to use for forwarding matching packets. -.. cfgcmd:: set policy local-route rule <1-32765> source <x.x.x.x|x.x.x.x/x> +.. cfgcmd:: set policy local-route rule <1-32765> set vrf <vrf|default> - Set source address or prefix to match. + Set the VRF to use for forwarding matching packets. -.. cfgcmd:: set policy local-route rule <1-32765> destination <x.x.x.x|x.x.x.x/x> +.. cfgcmd:: set policy local-route rule <1-32765> protocol <protocol> - Set destination address or prefix to match. + Match specified protocol (name or number). + +.. cfgcmd:: set policy local-route rule <1-32765> fwmark <1-2147483647> + + Match specified firewall mark (fwmark). + +.. cfgcmd:: set policy local-route rule <1-32765> source address <x.x.x.x|x.x.x.x/x> + + Match specified source address or prefix. + +.. cfgcmd:: set policy local-route rule <1-32765> source port <1-65535> + + Match specified source port. + +.. cfgcmd:: set policy local-route rule <1-32765> destination address <x.x.x.x|x.x.x.x/x> + + Match specified destination address or prefix. + +.. cfgcmd:: set policy local-route rule <1-32765> destination port <1-65535> + + Match specified destination port. .. cfgcmd:: set policy local-route rule <1-32765> inbound-interface <interface> - Set inbound interface to match. - + Match specified inbound interface. + Local Route IPv6 ================ .. cfgcmd:: set policy local-route6 rule <1-32765> set table <1-200|main> - Set routing table to forward packet to. + Set the routing table to use for forwarding matching packets. + +.. cfgcmd:: set policy local-route6 rule <1-32765> set vrf <vrf|default> + + Set the VRF to use for forwarding matching packets. + +.. cfgcmd:: set policy local-route6 rule <1-32765> protocol <protocol> + + Match specified protocol (name or number). + +.. cfgcmd:: set policy local-route6 rule <1-32765> fwmark <1-2147483647> + + Match specified firewall mark (fwmark). + +.. cfgcmd:: set policy local-route6 rule <1-32765> source address <h:h:h:h:h:h:h:h|h:h:h:h:h:h:h:h/x> + + Match specified source address or prefix. + +.. cfgcmd:: set policy local-route6 rule <1-32765> source port <1-65535> + + Match specified source port. -.. cfgcmd:: set policy local-route6 rule <1-32765> source <h:h:h:h:h:h:h:h | h:h:h:h:h:h:h:h/x> +.. cfgcmd:: set policy local-route6 rule <1-32765> destination address <h:h:h:h:h:h:h:h|h:h:h:h:h:h:h:h/x> - Set source address or prefix to match. + Match specified destination address or prefix. -.. cfgcmd:: set policy local-route6 rule <1-32765> destination <h:h:h:h:h:h:h:h | h:h:h:h:h:h:h:h/x> +.. cfgcmd:: set policy local-route6 rule <1-32765> destination port <1-65535> - Set destination address or prefix to match. + Match specified destination port. .. cfgcmd:: set policy local-route6 rule <1-32765> inbound-interface <interface> - Set inbound interface to match.
\ No newline at end of file + Match specified inbound interface.
\ No newline at end of file |
