vyos/vyos-documentation
1
0
Fork 0
mirror of https://github.com/vyos/vyos-documentation.git synced 2025-10-26 08:41:46 +01:00
Code Issues Packages Projects Releases Wiki Activity

bgp-policies.rst deletted, and its content was divided in as-path-list.rst, community-list.rst, extcommunity-list.rst and larg-community-list.rst; Examples sections on every files removed; examples-rst changed, ir order to have the list of example on left menu

Browse Source
This commit is contained in:
Nicolas Fort 2021-07-26 16:13:24 -03:00
parent dbddfe85ad
commit fb2225147e
11 changed files with 157 additions and 160 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docs/configuration/policy/access-list.rst
View File

@ -33,7 +33,7 @@ Access Lists
<destination|source> <any|host|inverse-mask|network> <destination|source> <any|host|inverse-mask|network>
This command defines matching parameters for access list rule. Matching This command defines matching parameters for access list rule. Matching
criteria could be applied to destinarion or source parameters: criteria could be applied to destination or source parameters:
* any: any IP address to match. * any: any IP address to match.
* host: single host IP address to match. * host: single host IP address to match.
@ -68,10 +68,3 @@ Basic filtering could also be applied to IPv6 traffic.
* exact-match: exact match of the network prefixes. * exact-match: exact match of the network prefixes.
* network: network/netmask to match (requires inverse-match be defined) BUG, * network: network/netmask to match (requires inverse-match be defined) BUG,
NO invert-match option in access-list6 NO invert-match option in access-list6
********
Examples
********
Examples would be uploaded soon.

33
docs/configuration/policy/as-path-list.rst Normal file
View File

@ -0,0 +1,33 @@
####################
BGP - AS Path Policy
####################
VyOS provides policies commands exclusively for BGP traffic filtering and
manipulation: **as-path-list** is one of them.
*************
Configuration
*************
policy as-path-list
===================
.. cfgcmd:: set policy as-path-list <text>
Create as-path-policy identified by name <text>.
.. cfgcmd:: set policy as-path-list <text> description <text>
Set description for as-path-list policy.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> action <permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> description <text>
Set description for rule.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> regex <text>
Regular expression to match against an AS path. For example "64501 64502".

124
docs/configuration/policy/bgp-policies.rst
View File

@ -1,124 +0,0 @@
####################
BGP Related Policies
####################
VyOS provides policies commands exclusively for BGP traffic filtering and
manipulation. In this section, all those commands are covered.
*************
Configuration
*************
policy as-path-list
===================
.. cfgcmd:: set policy as-path-list <text>
Create as-path-policy identified by name <text>.
.. cfgcmd:: set policy as-path-list <text> description <text>
Set description for as-path-list policy.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> action <permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> description <text>
Set description for rule.
.. cfgcmd:: set policy as-path-list <text> rule <1-65535> regex <text>
Regular expression to match against an AS path. For example "64501 64502".
policy community-list
=====================
.. cfgcmd:: set policy community-list <text>
Creat community-list policy identified by name <text>.
.. cfgcmd:: set policy community-list <text> description <text>
Set description for community-list policy.
.. cfgcmd:: set policy community-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy community-list <text> rule <1-65535> description <text>
Set description for rule.
.. cfgcmd:: set policy community-list <text> rule <1-65535> regex
<aa:nn|local-AS|no-advertise|no-export|internet|additive>
Regular expression to match against a community-list.
policy extcommunity-list
========================
.. cfgcmd:: set policy extcommunity-list <text>
Creat extcommunity-list policy identified by name <text>.
.. cfgcmd:: set policy extcommunity-list <text> description <text>
Set description for extcommunity-list policy.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> description
<text>
Set description for rule.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> regex <text>
Regular expression to match against an extended community list, where text
could be:
* <aa:nn:nn>: Extended community list regular expression.
* <rt aa:nn:nn>: Route Target regular expression.
* <soo aa:nn:nn>: Site of Origin regular expression.
policy large-community-list
===========================
.. cfgcmd:: set policy large-community-list <text>
Creat large-community-list policy identified by name <text>.
.. cfgcmd:: set policy large-community-list <text> description <text>
Set description for large-community-list policy.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> description
<text>
Set description for rule.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> regex
<aa:nn:nn>
Regular expression to match against a large community list.
********
Examples
********
Examples would be uploaded soon.

35
docs/configuration/policy/community-list.rst Normal file
View File

@ -0,0 +1,35 @@
####################
BGP - Community List
####################
VyOS provides policies commands exclusively for BGP traffic filtering and
manipulation: **community-list** is one of them.
*************
Configuration
*************
policy community-list
=====================
.. cfgcmd:: set policy community-list <text>
Creat community-list policy identified by name <text>.
.. cfgcmd:: set policy community-list <text> description <text>
Set description for community-list policy.
.. cfgcmd:: set policy community-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy community-list <text> rule <1-65535> description <text>
Set description for rule.
.. cfgcmd:: set policy community-list <text> rule <1-65535> regex
<aa:nn|local-AS|no-advertise|no-export|internet|additive>
Regular expression to match against a community-list.

13
docs/configuration/policy/examples.rst
View File

@ -1,5 +1,6 @@
###########
BGP Example BGP Example
=========== ###########
**Policy definition:** **Policy definition:**
@ -50,9 +51,9 @@ neighbor.
You now see the longer AS path. You now see the longer AS path.
#################
Transparent Proxy Transparent Proxy
================= #################
The following example will show how VyOS can be used to redirect web The following example will show how VyOS can be used to redirect web
traffic to an external transparent proxy: traffic to an external transparent proxy:
@ -84,9 +85,9 @@ interface, we use:
set interfaces ethernet eth1 policy route FILTER-WEB set interfaces ethernet eth1 policy route FILTER-WEB
################
Multiple Uplinks Multiple Uplinks
================ ################
VyOS Policy-Based Routing (PBR) works by matching source IP address VyOS Policy-Based Routing (PBR) works by matching source IP address
ranges and forwarding the traffic using different routing tables. ranges and forwarding the traffic using different routing tables.
@ -146,7 +147,7 @@ These commands allow the VLAN10 and VLAN20 hosts to communicate with
each other using the main routing table. each other using the main routing table.
Local route Local route
----------- ===========
The following example allows VyOS to use :abbr:`PBR (Policy-Based Routing)` The following example allows VyOS to use :abbr:`PBR (Policy-Based Routing)`
for traffic, which originated from the router itself. That solution for multiple for traffic, which originated from the router itself. That solution for multiple

40
docs/configuration/policy/extcommunity-list.rst Normal file
View File

@ -0,0 +1,40 @@
#############################
BGP - Extended Community List
#############################
VyOS provides policies commands exclusively for BGP traffic filtering and
manipulation: **extcommunity-list** is one of them.
*************
Configuration
*************
policy extcommunity-list
========================
.. cfgcmd:: set policy extcommunity-list <text>
Creat extcommunity-list policy identified by name <text>.
.. cfgcmd:: set policy extcommunity-list <text> description <text>
Set description for extcommunity-list policy.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> description
<text>
Set description for rule.
.. cfgcmd:: set policy extcommunity-list <text> rule <1-65535> regex <text>
Regular expression to match against an extended community list, where text
could be:
* <aa:nn:nn>: Extended community list regular expression.
* <rt aa:nn:nn>: Route Target regular expression.
* <soo aa:nn:nn>: Site of Origin regular expression.

5
docs/configuration/policy/index.rst
View File

@ -35,8 +35,11 @@ Policy Sections
prefix-list prefix-list
route route
route-map route-map
bgp-policies
local-route local-route
as-path-list
community-list
extcommunity-list
large-community-list
******** ********
Examples Examples

36
docs/configuration/policy/large-community-list.rst Normal file
View File

@ -0,0 +1,36 @@
##########################
BGP - Large Community List
##########################
VyOS provides policies commands exclusively for BGP traffic filtering and
manipulation: **large-community-list** is one of them.
*************
Configuration
*************
policy large-community-list
===========================
.. cfgcmd:: set policy large-community-list <text>
Creat large-community-list policy identified by name <text>.
.. cfgcmd:: set policy large-community-list <text> description <text>
Set description for large-community-list policy.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> action
<permit|deny>
Set action to take on entries matching this rule.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> description
<text>
Set description for rule.
.. cfgcmd:: set policy large-community-list <text> rule <1-65535> regex
<aa:nn:nn>
Regular expression to match against a large community list.

7
docs/configuration/policy/prefix-list.rst
View File

@ -78,10 +78,3 @@ IPv6 Prefix Lists
.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> le <0-128> .. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> le <0-128>
Netmask less than lenght Netmask less than lenght
********
Examples
********
Examples would be uploaded soon.

6
docs/configuration/policy/route-map.rst
View File

@ -254,9 +254,3 @@ Route Map
<0-4294967295> <0-4294967295>
Set BGP weight attribute Set BGP weight attribute
********
Examples
********
Examples would be uploaded soon.

7
docs/configuration/policy/route.rst
View File

@ -419,10 +419,3 @@ IPv6 Route
Weekdays to match rule on. Format for weekdays: Mon,Thu,Sat. To negate add ! Weekdays to match rule on. Format for weekdays: Mon,Thu,Sat. To negate add !
at the front eg. !Mon,Thu,Sat. at the front eg. !Mon,Thu,Sat.
********
Examples
********
Examples would be uploaded soon.