summaryrefslogtreecommitdiff
path: root/docs/configuration/policy/bgp-policies.rst
diff options
context:
space:
mode:
authorNicolas Fort <yocasquito@gmail.com>2021-07-23 11:17:55 -0300
committerNicolas Fort <yocasquito@gmail.com>2021-07-23 11:17:55 -0300
commitdbddfe85adaa70552607b38706b39238b465ac4e (patch)
tree055d0ec7f3018eb008e759c4c6f48a7a540d7ad3 /docs/configuration/policy/bgp-policies.rst
parent1fb2465d8cb7197a18daeb46270c3d42e64e3dbe (diff)
downloadvyos-documentation-dbddfe85adaa70552607b38706b39238b465ac4e.tar.gz
vyos-documentation-dbddfe85adaa70552607b38706b39238b465ac4e.zip
Index file updated and splitted into new files. Indent and lenght on every file was verified
Diffstat (limited to 'docs/configuration/policy/bgp-policies.rst')
-rw-r--r--docs/configuration/policy/bgp-policies.rst124
1 files changed, 124 insertions, 0 deletions
diff --git a/docs/configuration/policy/bgp-policies.rst b/docs/configuration/policy/bgp-policies.rst
new file mode 100644
index 00000000..72b612cb
--- /dev/null
+++ b/docs/configuration/policy/bgp-policies.rst
@@ -0,0 +1,124 @@
+####################
+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. \ No newline at end of file