Gitiles
Code Review Sign In
gerrit.onosproject.org / onos / 148a3471f7c098a26d3d8e75dac5e4e7e34ed77c / . / apps / cfm / nbi / src / main / resources / definitions / LmCreate.json
blob: 7afeaedf6907960eadf4d7535162aacf00f1e431 [file] [log] [blame]
Sean Condon081290d2017-11-02 13:15:08 +0000[diff] [blame]1{
2 "type": "object",
3 "title": "lm",
4 "required": [
5 "lm"
6 ],
7 "properties": {
8 "lm": {
9 "type": "object",
10 "title": "lmprops",
11 "required": [
12 "remoteMepId",
13 "lmCfgType",
14 "version",
15 "priority"
16 ],
17 "properties": {
18 "remoteMepId": {
19 "type": "uint16",
20 "minimum": 1,
21 "maximum": 8191,
22 "description": "Remote MEP identifier",
23 "example": 20
24 },
25 "lmCfgType": {
26 "type": "string",
27 "enum": ["LMLMM","LMSLM", "LMCCM"],
28 "description": "The type of Loss Measurement to be performed",
29 "example": "LMLMM"
30 },
31 "version": {
32 "type": "string",
33 "enum": ["Y17312008","Y17312011"],
34 "description": "The version of Loss Measurement to be performed",
35 "example": "Y17312011"
36 },
37 "priority": {
38 "type": "string",
39 "enum": ["PRIO0","PRIO1","PRIO2","PRIO3","PRIO4","PRIO5","PRIO6","PRIO7"],
40 "description": "The Priority for the Delay Measurement",
41 "example": "PRIO3"
42 },
43 "countersEnabled": {
44 "type": "array" ,
45 "xml": {
46 "name": "countersEnabled",
47 "wrapped": true
48 },
49 "items": {
50 "type": "string",
51 "enum": [ "FORWARD_TRANSMITTED_FRAMES",
52 "FORWARD_RECEIVED_FRAMES","FORWARD_MIN_FLR","FORWARD_MAX_FLR","FORWARD_AVERAGE_FLR","BACKWARD_TRANSMITTED_FRAMES","BACKWARD_RECEIVED_FRAMES","BACKWARD_MIN_FLR","BACKWARD_MAX_FLR","BACKWARD_AVERAGE_FLR","SOAM_PDUS_SENT","SOAM_PDUS_RECEIVED","AVAILABILITY_FORWARD_HIGH_LOSS","AVAILABILITY_FORWARD_CONSECUTIVE_HIGH_LOSS","AVAILABILITY_FORWARD_AVAILABLE","AVAILABILITY_FORWARD_UNAVAILABLE","AVAILABILILITY_FORWARD_MIN_FLR","AVAILABILITY_FORWARD_MAX_FLR","AVAILABILITY_FORWARD_AVERAGE_FLR","AVAILABILITY_BACKWARD_HIGH_LOSS","AVAILABILITY_BACKWARD_CONSECUTIVE_HIGH_LOSS","AVAILABILITY_BACKWARD_AVAILABLE","AVAILABLE_BACKWARD_UNAVAILABLE","AVAILABLE_BACKWARD_MIN_FLR","AVAILABLE_BACKWARD_MAX_FLR","AVAILABLE_BACKWARD_AVERAGE_FLR","MEASURED_STATS_FORWARD_MEASURED_FLR","MEASURED_STATS_BACKWARD_MEASURED_FLR","MEASURED_STATS_AVAILABILITY_FORWARD_STATUS","MEASURED_STATS_AVAILABILITY_BACKWARD_STATUS"],
53 "description": "A vector of bits that indicates the type of SOAM LM counters that are enabled"
54 },
55 "example": ["FORWARD_RECEIVED_FRAMES","BACKWARD_RECEIVED_FRAMES","SOAM_PDUS_SENT","SOAM_PDUS_RECEIVED"]
56 },
57 "availabilityMeasurementIntervalMins": {
58 "type": "uint16",
59 "description": "The availability measurement interval in minutes",
60 "example": 15
61 },
62 "availabilityNumberConsecutiveFlrMeasurements": {
63 "type": "uint32",
64 "minimum": 10,
65 "maximum": 1000000,
66 "description": "configurable number of consecutive loss measurement PDUs",
67 "example": 100
68 },
69 "availabilityFlrThresholdPct": {
70 "type": "float",
71 "minimum": 0.0,
72 "maximum": 100.0,
73 "description": "configurable availability threshold to be used in evaluating the availability/unavailability status in percent",
74 "example": 50.0
75 },
76 "availabilityNumberConsecutiveIntervals": {
77 "type": "uint16",
78 "minimum": 0,
79 "maximum": 1000,
80 "description": "configurable number of consecutive availability indicators to be used to determine a change in the availability status",
81 "example": 10
82 },
83 "availabilityNumberConsecutiveHighFlr": {
84 "type": "uint16",
85 "minimum": 0,
86 "maximum": 1000,
87 "description": "configurable number of consecutive availability indicators to be used for assessing CHLI.",
88 "example": 10
89 },
90 "frameSize": {
91 "type": "uint16",
92 "minimum": 64,
93 "maximum": 9600,
94 "description": "Frame size",
95 "example": 64
96 },
97 "measurementIntervalMins": {
98 "type": "uint16",
99 "description": "Measurement Interval in minutes",
100 "example": 15
101 },
102 "alignMeasurementIntervals": {
103 "type": "boolean",
104 "description": "Defines if measurement intervals are aligned with a zero offset to real time"
105 },
106 "alignMeasurementOffsetMins": {
107 "type": "uint16",
108 "description": "The offset in minutes from the time of day value",
109 "example": 0
110 },
111 "messagePeriodMs": {
112 "type": "uint32",
113 "description": "Message period in milliseconds",
114 "example": 100
115 },
116 "thresholds": {
117 "type": "array" ,
118 "xml": {
119 "name": "thresholds",
120 "wrapped": true
121 },
122 "items": {
123 "type": "object",
124 "title": "thresholdProps",
125 "properties": {
126 "threshold": {
127 "type": "object",
128 "properties": {
129 "id": {
130 "type": "uint8",
131 "description": "The id of the threshold",
132 "example": 1
133 },
134 "thresholds": {
135 "type": "array",
136 "xml": {
137 "name": "thresholds",
138 "wrapped": true
139 },
140 "items": {
141 "type": "string",
142 "enum": [
143 "MEASURED_FLR_FORWARD",
144 "MAX_FLR_FORWARD",
145 "AVERAGE_FLR_FORWARD",
146 "MEASURED_FLR_BACKWARD",
147 "MAX_FLR_BACKWARD",
148 "AVERAGE_FLR_BACKWARD",
149 "FORWARD_HIGH_LOSS",
150 "FORWARD_CONSECUTIVE_HIGH_LOSS",
151 "BACKWARD_HIGH_LOSS",
152 "BACKWARD_CONSECUTIVE_HIGH_LOSS",
153 "FORWARD_UNAVAILABLE_COUNT",
154 "FORWARD_AVAILABLE_RATIO",
155 "BACKWARD_UNAVAILABLE_COUNT",
156 "BACKWARD_AVAILABLE_RATIO"
157 ],
158 "description": "A vector of bits that indicates the type of SOAM LM thresholds notifications that are enabled."
159 },
160 "example": [
161 "MEASURED_FLR_FORWARD",
162 "MAX_FLR_FORWARD",
163 "AVERAGE_FLR_FORWARD"
164 ]
165 },
166 "measuredFlrForward": {
167 "type": "uint32",
168 "description": "The measured forward frame loss ratio threshold value in milli Percent 1/100000",
169 "example": 15
170 },
171 "maxFlrForward": {
172 "type": "uint32",
173 "description": "The maximum forward frame loss ratio threshold value in milli Percent 1/100000",
174 "example": 15
175 },
176 "averageFlrForward": {
177 "type": "uint32",
178 "description": "The average forward frame loss ratio threshold value in milli Percent 1/100000",
179 "example": 15
180 },
181 "measuredFlrBackward": {
182 "type": "uint32",
183 "description": "The measured backward frame loss ratio threshold value in milli Percent 1/100000",
184 "example": 15
185 },
186 "maxFlrBackward": {
187 "type": "uint32",
188 "description": "The maximum backward frame loss ratio threshold value in milli Percent 1/100000",
189 "example": 15
190 },
191 "averageFlrBackward": {
192 "type": "uint32",
193 "description": "The average backward frame loss ratio threshold value in milli Percent 1/100000",
194 "example": 15
195 }
196 }
197 }
198 }
199 }
200 },
201 "binsPerFdInterval": {
202 "type": "uint8",
203 "minimum": 3,
204 "description": "The number of measurement bins per Measurement Interval for Frame Delay measurements",
205 "example": 4
206 },
207 "binsPerIfdvInterval": {
208 "type": "uint8",
209 "minimum": 3,
210 "description": "The number of measurement bins per Measurement Interval for IFDV measurements",
211 "example": 4
212 },
213 "ifdvSelectionOffset": {
214 "type": "uint8",
215 "minimum": 2,
216 "description": "selection offset for Inter-Frame Delay Variation measurements",
217 "example": 2
218 },
219 "binsPerFdrInterval": {
220 "type": "uint8",
221 "minimum": 3,
222 "description": "The number of measurement bins per Measurement Interval for Frame Delay Range measurements",
223 "example": 4
224 },
225 "startTime": {
226 "type": "object",
227 "title": "startTime",
228 "description": "only one needs to be specified",
229 "properties": {
230 "immediate": {
231 "type": "boolean",
232 "description": "Should always be true if specified",
233 "example": true
234 },
235 "absolute": {
236 "type": "object",
237 "description": "Will be ignored if immediate is specified",
238 "properties": {
239 "start-time": {
240 "type": "date-time",
241 "example": "2017-11-11T12:00:00"
242 }
243 }
244 },
245 "relative": {
246 "type": "object",
247 "description": "Will be ignored if immediate or absolute is specified",
248 "properties": {
249 "start-time": {
250 "type": "string",
251 "description": "A period of time written as a Java Duration",
252 "example": "PT10M"
253 }
254 }
255 }
256 },
257 "example": {"immediate": true}
258 },
259 "stopTime": {
260 "type": "object",
261 "title": "stopTime",
262 "description": "only one needs to be specified",
263 "properties": {
264 "none": {
265 "type": "boolean",
266 "description": "Should always be true if specified",
267 "example": true
268 },
269 "absolute": {
270 "type": "object",
271 "description": "Will be ignored if none is specified",
272 "properties": {
273 "start-time": {
274 "type": "date-time",
275 "example": "2017-11-11T12:00:00"
276 }
277 }
278 },
279 "relative": {
280 "type": "object",
281 "description": "Will be ignored if none or absolute is specified",
282 "properties": {
283 "start-time": {
284 "type": "string",
285 "description": "A period of time written as a Java Duration",
286 "example": "PT10M"
287 }
288 }
289 }
290 },
291 "example": {"none": true}
292 }
293 }
294 }
295 }
296}