From: Tomek Mrugalski Date: Wed, 10 Aug 2016 16:58:51 +0000 (+0200) Subject: [4271] User's Guide updated. X-Git-Tag: trac4631_base~25^2~8 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=0fea47e1b93d2c5b5801c1826eba9032dfae7288;p=thirdparty%2Fkea.git [4271] User's Guide updated. --- diff --git a/doc/guide/classify.xml b/doc/guide/classify.xml index 322cb46797..3b8f45037e 100644 --- a/doc/guide/classify.xml +++ b/doc/guide/classify.xml @@ -291,6 +291,88 @@ The value of the transaction id in the DHCPv6 packet. + + + Vendor option existence (any vendor) + vendor[*].exist + true + Returns whether a vendor option from any vendor + is present ('true') or absent ('false'). + + + Vendor option existence (specific vendor) + vendor[4491].exists + true + Returns whether a vendor option from specified + vendor (determined by its enterprise-id) + is present ('true') or absent ('false'). + + + Enterprise-id from vendor option + vendor.enterprise + 0x0000118b + If the vendor option is present, it returns the + value of the enterprise-id field padded to 4 + bytes. Returns '' otherwise. + + + Vendor sub-option existence + vendor[4491].option[1].exists + true + Returns 'true' if there is vendor option with + specified enterprise-id and given sub-option is present. + Returns 'false' otherwise. + + + Vendor sub-option content + vendor[4491].option[1].hex + docsis3.0 + Returns content of the specified sub-option of + a vendor option with specified enterprise id. Returns + '' if no such option or sub-option is present. + + + + + Vendor class option existence (any vendor) + vendor-class[*].exist + true + Returns whether a vendor class option from any vendor + is present ('true') or absent ('false'). + + + Vendor class option existence (specific vendor) + vendor-class[4491].exists + true + Returns whether a vendor class option from specified + vendor (determined by its enterprise-id) + is present ('true') or absent ('false'). + + + Enterprise-id from vendor class option + vendor-class.enterprise + 0x0000118b + If the vendor option is present, it returns the + value of the enterprise-id field padded to 4 + bytes. Returns '' otherwise. + + + First data chunk from vendor class option + vendor-class[4491].data + true + Returns content of the first data chunk from + the vendor class option with specified enterprise-id. + Returns '' if missing. + + + Specific data chunk from vendor class option + vendor-class[4491].data[3] + docsis3.0 + Returns content of the specified data chunk of + a vendor class option with specified enterprise id. Returns + '' if no such option or data chunk is present. + + @@ -362,6 +444,22 @@ "0x00000001" or simply 1 as in "pkt6.msgtype == 1". + + Vendor option means Vendor-Identifying Vendor-specific Information + option (code 125, see Section 4 of RFC3925) in DHCPv4 and + Vendor-specific Information Option (code 17, defined in Section 22.17 of + RFC3315) in DHCPv6. Vendor class option means Vendor-Identifying Vendor + Class Option (code 124, see Section 3 of RFC3925) in DHCPv4 and Vendor + Class Option (code 16, see Section 22.16 of RFC3315). Vendor options may + have sub-options that are referenced by their codes. Vendor class + options do not have sub-options, but rather data chunks, which are + referenced by index value. Index 0 means the first data chunk, Index 1 + is for the second data chunk (if present), etc. + + + Asterisk (*) or 0 can be used to specify wildcard enterprise-id + value, i.e. it will match any enterprise-id value. + List of Classification Expressions @@ -382,7 +480,8 @@ And ('foo' == 'bar') and ('bar' == 'foo')Logical andOr ('foo' == 'bar') or ('bar' == 'foo')Logical orSubstringsubstring('foobar',0,3)Return the requested substring -Concatconcat('foo','bar')Return the concatenation of the strings +Concatconcat('foo','bar')Return the +concatenation of the strings