aboutsummaryrefslogtreecommitdiffstats
path: root/ctrl/sysrepo-plugins/yang/hicn/hicn.yang
blob: 0514a7a2a9ae0209ee94ce174a61462a88e4d0dc (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
module hicn {
    namespace "urn:sysrepo:hicn";
    prefix hcn;

    import ietf-inet-types {
        prefix inet;
    }

    revision 2020-04-29{
        description "revised revision focus on telemetry.";
    }

    /* new data types and grouping definition to forward the remote request toward hicn controler--to-->hicn */

    typedef float {
        type decimal64 {
            fraction-digits 2;
        }
    }

    grouping states-reply {

        leaf pkts_processed {
                description "ICN packets processed.";
                type uint64;
            }

        leaf pkts_interest_count {
                description "PIT maximum size, otherwise -1 to assign default value.";
                type uint64;
            }

        leaf pkts_data_count {
                description "CS maximum size, otherwise -1 to assign default value.";
                type uint64;
            }

        leaf pkts_from_cache_count {
                description "Portion of CS reserved to application, otherwise -1 to assign default value.";
                type uint64;
            }

        leaf pkts_no_pit_count {
                description "Default PIT entry lifetime, otherwise -1 to assign default value.";
                type uint64;
            }

        leaf pit_expired_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value.";
                type uint64;
            }

        leaf cs_expired_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf cs_lru_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf pkts_drop_no_buf {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf interests_aggregated {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf interests_retx {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf interests_hash_collision {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf pit_entries_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf cs_entries_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

        leaf cs_entries_ntw_count {
                description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                type uint64;
            }

    }

    grouping face-stats-reply {
        list face{
            key faceid;
            leaf faceid {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint32;
                }

            leaf intfc {
                    description "This is the idx number of the faceid.";
                    type uint32;
                }

            leaf irx_packets {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }

            leaf irx_bytes {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }

            leaf itx_packets {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }

            leaf itx_bytes {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }


            leaf drx_packets {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }

            leaf drx_bytes {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }

            leaf dtx_packets {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }


            leaf dtx_bytes {
                    description "Upper bound on PIT entry lifetime, otherwise -1 to assign default value .";
                    type uint64;
                }
        }
    }

    grouping route-reply {

    list route{
        key routeid;
        leaf routeid {
                    description "the unique key for each item.";
                    type uint32;
        }
        leaf prefix {
                description "IP address.";
                type string;

        }
        leaf strategy_id {
                description "compile-time plugin features.";
                type uint32;
        }
    }
    }

    grouping strategies-reply {
        leaf n_strategies {
                description "Enable / disable ICN forwarder in VPP.";
                type uint8;
            }
        leaf strategy_id {
                description "Enable / disable ICN forwarder in VPP.";
                type uint32;
            }

    }

    typedef hicn-prefix {
        description "hICN prefix.";
        type inet:ip-prefix;
    }


    /* Hicn operational data */

    container hicn-state {

        config false;
        description "operational data container for the hicn.";
        container faces{
            uses face-stats-reply;
        }
        container states{
            uses states-reply;
        }
        container routes{
            uses route-reply;
        }
    }


    /* RPC Definitions */

    rpc  strategies-get {
            description "Operation to get hicn strategies.";
    }

    rpc  face-params-get {
            description "Operation to del hicn route.";
        input {
            leaf faceid {
                description "Face to be retrieved .";
                type uint32;
            }
        }
    }

    rpc  hicn-enable {
        description "Enable hicn on a gie prefix.";
        input {
            leaf prefix {
                type hicn-prefix;
            }
        }
    }

    rpc  hicn-disable {
        description "Disable hicn on a gie prefix.";
        input {
            leaf prefix {
                type hicn-prefix;
            }
        }
    }

}