From d060cd8f9c43d03ce28956efdfa33b7b1cb38023 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Tue, 11 Jan 2022 10:32:53 +0100 Subject: T4170: rename "policy ipv6-route" -> "policy route6" --- docs/configuration/policy/route.rst | 133 ++++++++++++++++++------------------ 1 file changed, 66 insertions(+), 67 deletions(-) diff --git a/docs/configuration/policy/route.rst b/docs/configuration/policy/route.rst index ffbe85b2..0aa43232 100644 --- a/docs/configuration/policy/route.rst +++ b/docs/configuration/policy/route.rst @@ -12,27 +12,27 @@ Configuration Route ===== -.. cfgcmd:: set policy route +.. cfgcmd:: set policy route This command creates a new route policy, identified by . -.. cfgcmd:: set policy route description +.. cfgcmd:: set policy route description Set description for the route policy. -.. cfgcmd:: set policy route enable-default-log +.. cfgcmd:: set policy route enable-default-log Option to log packets hitting default-action. -.. cfgcmd:: set policy route rule <1-9999> description +.. cfgcmd:: set policy route rule description Set description for rule in route policy. -.. cfgcmd:: set policy route rule <1-9999> action drop +.. cfgcmd:: set policy route rule action drop Set rule action to drop. -.. cfgcmd:: set policy route rule <1-9999> destination address +.. cfgcmd:: set policy route rule destination address Set match criteria based on destination address, where @@ -45,13 +45,13 @@ Route * !: Match everything except the specified subnet. * !-: Match everything except the specified range. -.. cfgcmd:: set policy route rule <1-9999> destination group +.. cfgcmd:: set policy route rule destination group Set destination match criteria based on groups, where would be the group name/identifier. -.. cfgcmd:: set policy route rule <1-9999> destination port +.. cfgcmd:: set policy route rule destination port Set match criteria based on destination port, where could @@ -65,11 +65,11 @@ Route whole list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005' -.. cfgcmd:: set policy route rule <1-9999> disable +.. cfgcmd:: set policy route rule disable Option to disable rule. -.. cfgcmd:: set policy route rule <1-9999> fragment +.. cfgcmd:: set policy route rule fragment Set IP fragment match, where: @@ -77,12 +77,12 @@ Route * match-frag: Second and further fragments of fragmented packets. * match-non-frag: Head fragments or unfragmented packets. -.. cfgcmd:: set policy route rule <1-9999> icmp +.. cfgcmd:: set policy route rule icmp Set ICMP match criterias, based on code and/or types. Types could be referenced by number or by name. -.. cfgcmd:: set policy route rule <1-9999> ipsec +.. cfgcmd:: set policy route rule ipsec Set IPSec inbound match criterias, where: @@ -90,54 +90,54 @@ Route * match-ipsec: match inbound IPsec packets. * match-none: match inbound non-IPsec packets. -.. cfgcmd:: set policy route rule <1-9999> limit burst <0-4294967295> +.. cfgcmd:: set policy route rule limit burst <0-4294967295> Set maximum number of packets to alow in excess of rate -.. cfgcmd:: set policy route rule <1-9999> limit rate +.. cfgcmd:: set policy route rule limit rate Set maximum average matching rate. Format for rate: integer/time_unit, where time_unit could be any one of second, minute, hour or day.For example 1/second implies rule to be matched at an average of once per second. -.. cfgcmd:: set policy route rule <1-9999> log +.. cfgcmd:: set policy route rule log Option to enable or disable log matching rule. -.. cfgcmd:: set policy route rule <1-9999> log +.. cfgcmd:: set policy route rule log Option to log matching rule. -.. cfgcmd:: set policy route rule <1-9999> protocol +.. cfgcmd:: set policy route rule protocol Set protocol to match. Protocol name in /etc/protocols or protocol number, or "tcp_udp" or "all". Also, protocol could be denied by using !. -.. cfgcmd:: set policy route rule <1-9999> recent +.. cfgcmd:: set policy route rule recent <1-255|0-4294967295> Set parameters for matching recently seen sources. This match could be used by seeting count (source address seen more than <1-255> times) and/or time (source address seen in the last <0-4294967295> seconds). -.. cfgcmd:: set policy route rule <1-9999> set dscp <0-63> +.. cfgcmd:: set policy route rule set dscp <0-63> Set packet modifications: Packet Differentiated Services Codepoint (DSCP) -.. cfgcmd:: set policy route rule <1-9999> set mark <1-2147483647> +.. cfgcmd:: set policy route rule set mark <1-2147483647> Set packet modifications: Packet marking -.. cfgcmd:: set policy route rule <1-9999> set table +.. cfgcmd:: set policy route rule set table Set packet modifications: Routing table to forward packet with. -.. cfgcmd:: set policy route rule <1-9999> set tcp-mss <500-1460> +.. cfgcmd:: set policy route rule set tcp-mss <500-1460> Set packet modifications: Explicitly set TCP Maximum segment size value. -.. cfgcmd:: set policy route rule <1-9999> source address +.. cfgcmd:: set policy route rule source address Set match criteria based on source address, where could be: @@ -149,13 +149,13 @@ Route * !: Match everything except the specified subnet. * !-: Match everything except the specified range. -.. cfgcmd:: set policy route rule <1-9999> source group +.. cfgcmd:: set policy route rule source group Set source match criteria based on groups, where would be the group name/identifier. -.. cfgcmd:: set policy route rule <1-9999> source port +.. cfgcmd:: set policy route rule source port Set match criteria based on source port, where could be: @@ -167,52 +167,52 @@ Route list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005' -.. cfgcmd:: set policy route rule <1-9999> state +.. cfgcmd:: set policy route rule state Set match criteria based on session state. -.. cfgcmd:: set policy route rule <1-9999> tcp flags +.. cfgcmd:: set policy route rule tcp flags Set match criteria based on tcp flags. Allowed values for TCP flags: SYN ACK FIN RST URG PSH ALL. When specifying more than one flag, flags should be comma-separated. For example : value of 'SYN,!ACK,!FIN,!RST' will only match packets with the SYN flag set, and the ACK, FIN and RST flags unset. -.. cfgcmd:: set policy route rule <1-9999> time monthdays +.. cfgcmd:: set policy route rule time monthdays Set monthdays to match rule on. Format for monthdays: 2,12,21. To negate add ! at the front eg. !2,12,21 -.. cfgcmd:: set policy route rule <1-9999> time startdate +.. cfgcmd:: set policy route rule time startdate Set date to start matching rule. Format for date: yyyy-mm-dd. To specify time of date with startdate, append 'T' to date followed by time in 24 hour notation hh:mm:ss. For eg startdate value of 2009-01-21T13:30:00 refers to 21st Jan 2009 with time 13:30:00. -.. cfgcmd:: set policy route rule <1-9999> time starttime +.. cfgcmd:: set policy route rule time starttime Set time of day to start matching rule. Format of time: hh:mm:ss using 24 hours notation. -.. cfgcmd:: set policy route rule <1-9999> time stopdate +.. cfgcmd:: set policy route rule time stopdate Set date to stop matching rule. Format for date: yyyy-mm-dd. To specify time of date with stopdate, append 'T' to date followed by time in 24 hour notation hh:mm:ss. For eg startdate value of 2009-01-21T13:30:00 refers to 21st Jan 2009 with time 13:30:00. -.. cfgcmd:: set policy route rule <1-9999> time stoptime +.. cfgcmd:: set policy route rule time stoptime Set time of day to stop matching rule. Format of time: hh:mm:ss using 24 hours notation. -.. cfgcmd:: set policy route rule <1-9999> time utc +.. cfgcmd:: set policy route rule time utc Interpret times for startdate, stopdate, starttime and stoptime to be UTC. -.. cfgcmd:: set policy route rule <1-9999> time weekdays +.. cfgcmd:: set policy route rule time weekdays Weekdays to match rule on. Format for weekdays: Mon,Thu,Sat. To negate add ! at the front eg. !Mon,Thu,Sat. @@ -221,27 +221,27 @@ Route IPv6 Route ========== -.. cfgcmd:: set policy ipv6-route +.. cfgcmd:: set policy route6 This command creates a new IPv6 route policy, identified by . -.. cfgcmd:: set policy ipv6-route description +.. cfgcmd:: set policy route6 description Set description for the IPv6 route policy. -.. cfgcmd:: set policy ipv6-route enable-default-log +.. cfgcmd:: set policy route6 enable-default-log Option to log packets hitting default-action. -.. cfgcmd:: set policy ipv6-route rule <1-9999> action drop +.. cfgcmd:: set policy route6 rule action drop Set rule action to drop. -.. cfgcmd:: set policy ipv6-route rule <1-9999> description +.. cfgcmd:: set policy route6 rule description Set description for rule in IPv6 route policy. -.. cfgcmd:: set policy ipv6-route rule <1-9999> destination address +.. cfgcmd:: set policy route6 rule destination address Set match criteria based on destination IPv6 address, where @@ -255,8 +255,7 @@ IPv6 Route * !-: Match everything except the specified range. -.. cfgcmd:: set policy ipv6-route rule <1-9999> destination port - +.. cfgcmd:: set policy route6 rule destination port Set match criteria based on destination port, where could be: @@ -269,15 +268,15 @@ IPv6 Route whole list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005'. -.. cfgcmd:: set policy ipv6-route rule <1-9999> disable +.. cfgcmd:: set policy route6 rule disable Option to disable rule. -.. cfgcmd:: set policy ipv6-route rule <1-9999> icmpv6 type +.. cfgcmd:: set policy route6 rule icmpv6 type Set ICMPv6 match criterias, based on ICMPv6 type/code name. -.. cfgcmd:: set policy ipv6-route rule <1-9999> ipsec +.. cfgcmd:: set policy route6 rule ipsec Set IPSec inbound match criterias, where: @@ -285,59 +284,59 @@ IPv6 Route * match-ipsec: match inbound IPsec packets. * match-none: match inbound non-IPsec packets. -.. cfgcmd:: set policy ipv6-route rule <1-9999> limit burst +.. cfgcmd:: set policy route6 rule limit burst <0-4294967295> Set maximum number of packets to alow in excess of rate -.. cfgcmd:: set policy ipv6-route rule <1-9999> limit rate +.. cfgcmd:: set policy route6 rule limit rate Set maximum average matching rate. Format for rate: integer/time_unit, where time_unit could be any one of second, minute, hour or day.For example 1/second implies rule to be matched at an average of once per second. -.. cfgcmd:: set policy ipv6-route rule <1-9999> log +.. cfgcmd:: set policy route6 rule log Option to enable or disable log matching rule. -.. cfgcmd:: set policy ipv6-route rule <1-9999> log +.. cfgcmd:: set policy route6 rule log Option to log matching rule. -.. cfgcmd:: set policy ipv6-route rule <1-9999> protocol +.. cfgcmd:: set policy route6 rule protocol Set IPv6 protocol to match. IPv6 protocol name from /etc/protocols or protocol number, or "tcp_udp" or "all". Also, protocol could be denied by using !. -.. cfgcmd:: set policy ipv6-route rule <1-9999> recent +.. cfgcmd:: set policy route6 rule recent <1-255|0-4294967295> Set parameters for matching recently seen sources. This match could be used by seeting count (source address seen more than <1-255> times) and/or time (source address seen in the last <0-4294967295> seconds). -.. cfgcmd:: set policy ipv6-route rule <1-9999> set dscp <0-63> +.. cfgcmd:: set policy route6 rule set dscp <0-63> Set packet modifications: Packet Differentiated Services Codepoint (DSCP) -.. cfgcmd:: set policy ipv6-route rule <1-9999> set mark <1-2147483647> +.. cfgcmd:: set policy route6 rule set mark <1-2147483647> Set packet modifications: Packet marking. -.. cfgcmd:: set policy ipv6-route rule <1-9999> set table +.. cfgcmd:: set policy route6 rule set table Set packet modifications: Routing table to forward packet with. -.. cfgcmd:: set policy ipv6-route rule <1-9999> set tcp-mss +.. cfgcmd:: set policy route6 rule set tcp-mss Set packet modifications: pmtu option automatically set to Path Maximum Transfer Unit minus 60 bytes. Otherwise, expliicitly set TCP MSS value from 500 to 1460. -.. cfgcmd:: set policy ipv6-route rule <1-9999> source address +.. cfgcmd:: set policy route6 rule source address Set match criteria based on IPv6 source address, where @@ -351,13 +350,13 @@ IPv6 Route * !-: Match everything except the specified range -.. cfgcmd:: set policy ipv6-route rule <1-9999> source mac-address +.. cfgcmd:: set policy route6 rule source mac-address Set source match criteria based on MAC address. Declare specific MAC address to match, or match everything except the specified MAC. -.. cfgcmd:: set policy ipv6-route rule <1-9999> source port +.. cfgcmd:: set policy route6 rule source port Set match criteria based on source port, where could be: @@ -370,52 +369,52 @@ IPv6 Route list can also be "negated" using '!'. For example: '!22,telnet,http,123,1001-1005'. -.. cfgcmd:: set policy ipv6-route rule <1-9999> state +.. cfgcmd:: set policy route6 rule state Set match criteria based on session state. -.. cfgcmd:: set policy ipv6-route rule <1-9999> tcp flags +.. cfgcmd:: set policy route6 rule tcp flags Set match criteria based on tcp flags. Allowed values for TCP flags: SYN ACK FIN RST URG PSH ALL. When specifying more than one flag, flags should be comma-separated. For example : value of 'SYN,!ACK,!FIN,!RST' will only match packets with the SYN flag set, and the ACK, FIN and RST flags unset. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time monthdays +.. cfgcmd:: set policy route6 rule time monthdays Set monthdays to match rule on. Format for monthdays: 2,12,21. To negate add ! at the front eg. !2,12,21 -.. cfgcmd:: set policy ipv6-route rule <1-9999> time startdate +.. cfgcmd:: set policy route6 rule time startdate Set date to start matching rule. Format for date: yyyy-mm-dd. To specify time of date with startdate, append 'T' to date followed by time in 24 hour notation hh:mm:ss. For eg startdate value of 2009-01-21T13:30:00 refers to 21st Jan 2009 with time 13:30:00. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time starttime +.. cfgcmd:: set policy route6 rule time starttime Set time of day to start matching rule. Format of time: hh:mm:ss using 24 hours notation. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time stopdate +.. cfgcmd:: set policy route6 rule time stopdate Set date to stop matching rule. Format for date: yyyy-mm-dd. To specify time of date with stopdate, append 'T' to date followed by time in 24 hour notation hh:mm:ss. For eg startdate value of 2009-01-21T13:30:00 refers to 21st Jan 2009 with time 13:30:00. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time stoptime +.. cfgcmd:: set policy route6 rule time stoptime Set time of day to stop matching rule. Format of time: hh:mm:ss using 24 hours notation. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time utc +.. cfgcmd:: set policy route6 rule time utc Interpret times for startdate, stopdate, starttime and stoptime to be UTC. -.. cfgcmd:: set policy ipv6-route rule <1-9999> time weekdays +.. cfgcmd:: set policy route6 rule time weekdays Weekdays to match rule on. Format for weekdays: Mon,Thu,Sat. To negate add ! at the front eg. !Mon,Thu,Sat. -- cgit v1.2.3