01eae862da7b9cdaaf9bccca64a0cf191ca687a4
[honeycomb.git] / v3po / api / src / main / yang / vpp-classifier-context.yang
1 module vpp-classifier-context {
2   yang-version 1;
3   namespace "urn:opendaylight:params:xml:ns:yang:vpp:classifier";
4   prefix "vpp-classifier-context";
5
6   description
7     "This module contains vpp classfier metadata definition";
8
9   revision "2016-09-09" {
10     description
11       "Initial revision.";
12   }
13
14   container vpp-classifier-context {
15
16     config "false";
17
18     description
19       "Classify tables and sessions contain relative node indexes. Management agent like Honeycomb,
20        needs to use node names instead (indexes might change after vpp restart).
21        VPP does not provide relative index to node name conversion (https://jira.fd.io/browse/VPP-219),
22        also finding base node that is needed to perform the conversion
23        is not allways possible (https://jira.fd.io/browse/VPP-220).
24
25        Therefore Honeycomb needs to provide relative node to index mapping.
26        ";
27
28     list classify-table-context {
29       key "name";
30       unique "index";
31
32       leaf name {
33         type string;
34         description
35           "Name of the classify table.";
36       }
37
38       leaf index {
39         type int32;
40         description
41           "Classify table index used by VPP.";
42       }
43
44       leaf classifier-node-name {
45         type string;
46         description
47           "Name of VPP node the table is defined for.";
48       }
49
50       list node-context {
51         key "name";
52         unique "index";
53
54         leaf name {
55           type string;
56           description
57             "Name of vpp node (neighbour of classifier-node-name)";
58         }
59
60         leaf index {
61           type int32;
62           description
63             "Inted of the vpp node relative to classifier-node-name";
64         }
65       }
66     }
67   }
68 }