summaryrefslogtreecommitdiff
path: root/doc/bird.sgml
diff options
context:
space:
mode:
authorJan Moskyto Matejka <mq@ucw.cz>2017-03-13 13:50:32 +0100
committerJan Moskyto Matejka <mq@ucw.cz>2017-03-13 13:51:20 +0100
commit8c9986d310c58b26c000375be00be0deb9c2e360 (patch)
tree9e3dba54bc82bb2bb9e0b6a25591eb471b107550 /doc/bird.sgml
parent54334b5667158d4b0af55201f327faeb80c05e0e (diff)
Filters: VPN Route Distinguishers, Prefix Type, Docs Update
Diffstat (limited to 'doc/bird.sgml')
-rw-r--r--doc/bird.sgml24
1 files changed, 21 insertions, 3 deletions
diff --git a/doc/bird.sgml b/doc/bird.sgml
index 2f8f18f3..e85ebf18 100644
--- a/doc/bird.sgml
+++ b/doc/bird.sgml
@@ -1193,13 +1193,31 @@ foot).
<cf/1.2.3.4.mask(8) = 1.0.0.0/ is true.
<tag><label id="type-prefix">prefix</tag>
- This type can hold a network prefix consisting of IP address and prefix
- length. Prefix literals are written as <cf><m/ipaddress//<m/pxlen/</cf>,
+ This type can hold a network prefix consisting of IP address, prefix
+ length and several other values. This is the key in route tables.
+
+ Prefices may be of several types, which can be determined by the special
+ operator <cf/.type/ of type <m/enum/. The type may be:
+
+ <cf/NET_IP4/ and <cf/NET_IP6/ prefices hold an IP prefix. The literals are
+ written as <cf><m/ipaddress//<m/pxlen/</cf>,
or <cf><m>ipaddress</m>/<m>netmask</m></cf>. There are two special
- operators on prefixes: <cf/.ip/ which extracts the IP address from the
+ operators on IP prefices: <cf/.ip/ which extracts the IP address from the
pair, and <cf/.len/, which separates prefix length from the pair.
So <cf>1.2.0.0/16.len = 16</cf> is true.
+ <cf/NET_VPN4/ and <cf/NET_VPN6/ prefices hold an IP prefix with
+ VPN Route Distinguisher (<rfc id="4364">). They support the same special
+ operators as IP prefices, and also <cf/.rd/ which extracts the Route Distinguisher.
+ Their literals are written as <cf><m/vpnrd/ <m/ipprefix/</cf>
+
+ <cf/NET_ROA4/ and <cf/NET_ROA6/ prefices hold an IP prefix range together
+ with an ASN. They support the same special operators as IP prefices, and also
+ <cf/.maxlen/ which extracts maximal prefix length, and <cf/.asn/ which extracts the ASN.
+
+ <cf/NET_FLOW4/ and <cf/NET_FLOW6/ hold an IP prefix together with
+ a flowspec rule. Filters currently don't support flowspec parsing.
+
<tag><label id="type-ec">ec</tag>
This is a specialized type used to represent BGP extended community
values. It is essentially a 64bit value, literals of this type are