1 module vpp-classifier {
3 namespace "urn:opendaylight:params:xml:ns:yang:vpp:classifier";
4 prefix "vpp-classifier";
6 revision "2015-06-03" {
8 "Initial revision of model for VPP packet classifier.
9 The model can be used ony to implement ACLs.
10 Other classify table usages are not supported yet,
11 see https://jira.fd.io/browse/VPP-203 for details.";
13 "https://wiki.fd.io/view/VPP/Introduction_To_N-tuple_Classifiers";
16 import ietf-yang-types {
20 typedef classify-table-ref {
22 path "/vpp-classifier:vpp-classifier/classify-table/name";
25 "This type is used by data models that need to reference
26 configured classify tables.";
29 typedef packet-handling-action {
32 // by VPP convention, first neighbour node (at index 0) is a drop node
36 value -1; // indicates that the next node not set
43 // FIXME: enable after VPP-203 is fixed
44 // type string; // name of vpp-node neighbour, TODO: base node also needs to be defined
45 type packet-handling-action;
48 "Defines VPP node reference using relative node name or packet handling action.";
51 typedef opaque-index {
57 "Defines opaque-index type - metadata that can be attached to session-hit packets.
58 Vpp nodes can't be referenced by index, because node indexes might change after vpp restart.";
61 grouping classify-session-attributes {
63 "Defines classify session attributes that are mapped to classify_add_del_session
64 and classify_session_details messages parameters.";
70 "Vpp node to which packet will be send when it produces a match.";
79 "Nodes like ip4/6-classify use the parameter to \"consume\" networking layer.
80 Example: tunnel decapsulation.";
84 grouping classify-table-base-attributes {
86 "Defines classify table attributes that are mapped to classify_add_del_table message parameters.";
92 "Used by classifier hashing algorithm. It is not possible to resize the bucket array,
93 therefore suggested value is approximate number of expected entries.";
99 "Number of 16 byte vectors to be skipped before applying mask.";
102 type classify-table-ref;
104 "Reference to the next classify table. Required when multiple table chaining is used.";
110 "Vpp node to which packet will be send when it falis to produce a match";
113 type yang:hex-string;
116 "Defines match mask (multiple of 16 bytes)";
119 list classify-session {
123 type yang:hex-string;
125 "Defines actual value to be matched that is
126 a byte vector, which length is multiple of 16 bytes";
128 must "string-length(match) = string-length(../../mask)" {
130 "Match length is not equal to classify table mask length.";
132 "Match length must be equal to classify table mask length.";
136 uses classify-session-attributes;
140 grouping classify-table-config-attributes {
142 "Defines classify table config only attributes (present in classify_add_del_table message
143 but not in classify_table_info_reply).";
145 // FIXME move to classify-table-base-attributes
146 // after https://jira.fd.io/browse/VPP-208 is fixed
151 "Memory size for classify table and its entries.";
155 grouping classify-table-operational-attributes {
157 "Defines classify table operational attributes (present in classify_table_info_reply message
158 but not in classify_add_del_table).";
160 leaf active_sessions {
164 "Number of sessions defined for the classify table.";
168 container vpp-classifier {
169 list classify-table {
175 "Hides classify table identifier managed by vpp.";
178 uses classify-table-base-attributes;
179 uses classify-table-config-attributes;
183 container vpp-classifier-state {
186 list classify-table {
192 "Hides classify table identifier managed by vpp.";
195 uses classify-table-base-attributes;
196 uses classify-table-operational-attributes;