summaryrefslogtreecommitdiff
path: root/docs/configuration/policy/prefix-list.rst
diff options
context:
space:
mode:
authorRobert Göhler <github@ghlr.de>2021-07-26 21:32:29 +0200
committerGitHub <noreply@github.com>2021-07-26 21:32:29 +0200
commitcb36772d25be42815a133d037a23899ca08f624a (patch)
tree6f3b3ebbee2269f49bb6dc61d4aafd2bc9b46bba /docs/configuration/policy/prefix-list.rst
parent9397b4fba4461a7a856a862d39f0dc7844888dd3 (diff)
parentfb2225147ee1cb822bafda1f4da7e2969c3a6379 (diff)
downloadvyos-documentation-cb36772d25be42815a133d037a23899ca08f624a.tar.gz
vyos-documentation-cb36772d25be42815a133d037a23899ca08f624a.zip
Merge pull request #578 from yocasquito/policy_docs_redo
Policy file updated/recreated. Added commands and descriptions. From …
Diffstat (limited to 'docs/configuration/policy/prefix-list.rst')
-rw-r--r--docs/configuration/policy/prefix-list.rst80
1 files changed, 80 insertions, 0 deletions
diff --git a/docs/configuration/policy/prefix-list.rst b/docs/configuration/policy/prefix-list.rst
new file mode 100644
index 00000000..63b6510e
--- /dev/null
+++ b/docs/configuration/policy/prefix-list.rst
@@ -0,0 +1,80 @@
+##################
+Prefix List Policy
+##################
+
+Prefix lists provides the most powerful prefix based filtering mechanism. In
+addition to access-list functionality, ip prefix-list has prefix length range
+specification.
+
+If no ip prefix list is specified, it acts as permit. If ip prefix list is
+defined, and no match is found, default deny is applied.
+
+Prefix filtering can be done using prefix-list and prefix-list6.
+
+*************
+Configuration
+*************
+
+Prefix Lists
+============
+
+.. cfgcmd:: set policy prefix-list <text>
+
+ This command creates the new prefix-list policy, identified by <text>.
+
+.. cfgcmd:: set policy prefix-list <text> description <text>
+
+ Set description for the prefix-list policy.
+
+.. cfgcmd:: set policy prefix-list <text> rule <1-65535> action <permit|deny>
+
+ This command creates a new rule in the prefix-list and defines an action.
+
+.. cfgcmd:: set policy prefix-list <text> rule <1-65535> description <text>
+
+ Set description for rule in the prefix-list.
+
+.. cfgcmd:: set policy prefix-list <text> rule <1-65535> prefix <x.x.x.x/x>
+
+ Prefix to match against.
+
+.. cfgcmd:: set policy prefix-list <text> rule <1-65535> ge <0-32>
+
+ Netmask greater than length.
+
+.. cfgcmd:: set policy prefix-list <text> rule <1-65535> le <0-32>
+
+ Netmask less than lenght
+
+IPv6 Prefix Lists
+=================
+
+.. cfgcmd:: set policy prefix-list6 <text>
+
+ This command creates the new IPv6 prefix-list policy, identified by <text>.
+
+.. cfgcmd:: set policy prefix-list6 <text> description <text>
+
+ Set description for the IPv6 prefix-list policy.
+
+.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> action <permit|deny>
+
+ This command creates a new rule in the IPv6 prefix-list and defines an
+ action.
+
+.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> description <text>
+
+ Set description for rule in IPv6 prefix-list.
+
+.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> prefix
+ <h:h:h:h:h:h:h:h/x>
+
+ IPv6 prefix.
+
+.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> ge <0-128>
+
+ Netmask greater than length.
+
+.. cfgcmd:: set policy prefix-list6 <text> rule <1-65535> le <0-128>
+
+ Netmask less than lenght