Newer
Older
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
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
components:
schemas:
CreatePmJobRequest:
description: >
This type represents a request to create a PM job.
type: object
required:
- objectType
- objectInstanceIds
- criteria
- callbackUri
properties:
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceIds:
description: >
Identifiers of the measured object instance for which performance information
is requested to be collected. This attribute shall contain the identifier of
the instance of the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
If more than one identifier is provided, values shall all refer to measured
object instances of the same type, for which the same criteria is then applicable.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
minItems: 1
subObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance for
which performance information is requested to be collected.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is present, the cardinality of the "objectInstanceIds"
attribute shall be 1.
If this attribute is absent and a sub-object is defined in clause 8.2 of
ETSI GS NFV-IFA 031 for the related measured object type, measurements will
be taken for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria of the collection of performance information.
$ref: "#/components/schemas/PmJobCriteria"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
PmJob:
description: >
This type represents a PM job.
type: object
required:
- id
- objectType
- objectInstanceIds
- criteria
- _links
- callbackUri
properties:
id:
description: >
Identifier of this PM job.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement is
defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceIds:
description: >
Identifiers of the measured object instance for which performance information
is collected. This attribute shall contain the identifier of the instance of
the measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
minItems: 1
subObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance for
which performance information is requested to be collected.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is present, the cardinality of the "objectInstanceIds"
attribute shall be 1.
If this attribute is absent and a sub-object is defined in clause 8.2 of
ETSI GS NFV-IFA 031 for the related measured object type, measurements will
be taken for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria of the collection of performance information.
$ref: "#/components/schemas/PmJobCriteria"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
reports:
description: >
Information about available reports collected by this PM job.
type: array
items:
type: object
properties:
href:
description: >
The Uri where the report can be obtained.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
readyTime:
description: >
The time when the report was made available.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime"
expiryTime:
description: >
The time when the report will expire.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime"
fileSize:
description: >
The size of the report file in bytes, if known.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/UnsignedInt"
required:
- href
- readyTime
_links:
description: >
Links for this resource.
type: object
properties:
self:
description: >
URI of this resource.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link"
objects:
description: >
Links to resources representing the measured object instances for which
performance information is collected. Shall be present if the measured
object instance information is accessible as a resource.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link"
required:
- self
CreateThresholdRequest :
description: >
This type represents a request to create a threshold.
type: object
required:
- objectType
- objectInstanceId
- criteria
- callbackUri
properties:
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
Identifier of the measured object instance associated with this threshold.
This attribute shall contain the identifier of the instance of the measure
object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subjObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance
associated with this threshold.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI
GS NFV-IFA 031 for the related measured object type, thresholds will be set
for all sub-object instances of the measured object instance.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/components/schemas/ThresholdCriteria"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 8.3.4 of ETSI GS NFV-SOL 013.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
Threshold:
description: >
This type represents a threshold.
type: object
required:
- id
- objectType
- objectInstanceId
- subjObjectInstanceIds
- criteria
- _links
- callbackUri
properties:
id:
description: >
Identifier of this threshold resource.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement
is defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
Identifier of the measured object instance associated with the threshold.
This attribute shall contain the identifier of the instance of the measure
object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Identifier"
subjObjectInstanceIds:
description: >
Identifiers of the sub-object instances of the measured object instance
associated with this threshold.
May be present if a sub-object is defined in clause 8.2 of ETSI GS NFV-IFA 031
for the related measured object type.
If this attribute is absent and a sub-object is defined in clause 8.2 of ETSI
GS NFV-IFA 031 for the related measured object type, thresholds are set for
all sub-object instances of the measured object instance.
type: array
items:
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/components/schemas/ThresholdCriteria"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
_links:
description: >
Links for this resource.
type: object
properties:
self:
description: >
URI for this resource.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link"
object:
description: >
Link to a resource representing the measured object instance for which performance
information is collected. Shall be present if the measured object instance information
is accessible as a resource.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Link"
required:
- self
PerformanceReport:
description: >
This type defines the format of a performance report provided by the NFV-MANO functional
entity to the API consumer as a result of collecting performance information as part
of a PM job.
type: object
required:
- entries
properties:
entries:
description: >
List of performance information entries. Each performance report entry is for a given
metric of a given object (i.e. measured object instance) corresponding to the related
measured object types, but can include multiple collected values.
type: array
items:
type: object
properties:
objectType:
description: >
Type of measured object. The applicable measured object type for a measurement is
defined in clause 8.2 of ETSI GS NFV-IFA 031.
type: string
objectInstanceId:
description: >
The object instance (i.e. measured object instance) for which the performance metric
is reported. This attribute shall contain the identifier of the instance of the
measure object according to their type.
See also definitions in clause 8.2 of ETSI GS NFV-IFA 031.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/ManoManagedObjectReference"
subObjectInstanceId:
description: >
Identifier of the sub-object instance of the measured object instance for which the
performance metric is reported. Shall be present if this is required in clause 8.2
of ETSI GS NFV-IFA 031 [1] for the related measured object type.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/IdentifierInManoEntity"
performanceMetric:
description: >
Name of the metric collected. This attribute shall contain the related
"Measurement Name" value as defined in clause 8.4 of ETSI GS NFV-IFA 031.
type: string
performanceValues:
description: >
List of performance values with associated timestamp.
type: array
items:
type: object
properties:
timeStamp:
description: >
Time stamp indicating when the data was collected.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime"
value:
description: >
Value of the metric collected. The type of this attribute shall correspond to
the related "Measurement Unit" as defined in clause 8.4 of ETSI GS NFV-IFA 031.
context:
description: >
Measurement context information related to the measured value. The set of
applicable keys is defined per measurement in clause 8.4 of ETSI GS NFV-IFA 031.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/KeyValuePairs"
required:
- timeStamp
- value
minItems: 1
required:
- objectType
- objectInstanceId
- performanceMetric
- performanceValues
minItems: 1
PmJobModifications:
description: >
This type represents modifications to a PM job.
* NOTE: At least one of the attributes defined in this type shall be present in request bodies.
type: object
properties:
callbackUri:
description: >
New value of the "callbackUri" attribute.The value "null" is not permitted. See note.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
New value of the "authentication" attribute, or "null" to remove the attribute.
If present in a request body, these modifications shall be applied according
to the rules of JSONMerge PATCH (see IETF RFC 7396).
This attribute shall not be present in response bodies. See note.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
ThresholdModifications:
description: >
This type represents modifications to a threshold.
* NOTE: At least one of the attributes defined in this type shall be present in request bodies.
type: object
properties:
callbackUri:
description: >
New value of the "callbackUri" attribute.The value "null" is not permitted. See note.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Uri"
authentication:
description: >
New value of the "authentication" attribute, or "null" to remove the attribute.
If present in a request body, these modifications shall be applied according
to the rules of JSONMerge PATCH (see IETF RFC 7396).
This attribute shall not be present in response bodies. See note.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/SubscriptionAuthentication"
#----------
PmJobCriteria:
description: >
This type represents collection criteria for PM jobs.
* NOTE 1: At the end of each reportingPeriod, the producer will inform the API consumer about availability
of the performance data collected for each completed collection period during this reportingPeriod.
The reportingPeriod should be equal to or a multiple of the collectionPeriod. In the latter case,
the performance data for the collection periods within one reporting period are reported together.
* NOTE 2: In particular when choosing short collection and reporting periods, the number of PM jobs that can
be supported depends on the capability of the producing entity.
type: object
required:
- collectionPeriod
- reportingPeriod
properties:
performanceMetric:
description: >
This defines the types of performance metrics for the specified measured
object(s). This attribute’s value shall contain the related "Measurement Name"
values as defined in clause 8.4 of ETSI GS NFV-IFA 031.
At least one of the two attributes (performance metric or group) shall be present.
type: array
items:
type: string
performanceMetricGroup:
description: >
Group of performance metrics.
A metric group is a pre-defined list of metrics, known to the producer that it
can decompose to individual metrics. This attribute’s value shall contain the
related "Measurement Group" values as defined in clause 8.4 of ETSI GS
NFV-IFA 031.
At least one of the two attributes (performance metric or group) shall be present.
type: array
items:
type: string
collectionPeriod:
description: >
Specifies the periodicity at which the producer will collect performance
information. The unit shall be seconds. See note 1 and note 2.
type: integer
reportingPeriod:
description: >
Specifies the periodicity at which the producer will report to the API consumer
about performance information. The unit shall be seconds. See note 1 and note 2.
type: integer
reportingBoundary:
description: >
Identifies a time boundary after which the reporting will stop.
The boundary shall allow a single reporting as well as periodic reporting up to
the boundary.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/DateTime"
ThresholdCriteria:
description: >
This type represents criteria that define a threshold.
* NOTE 1: In the present document, simple thresholds are defined. The definition of additional threshold
types is left for future specification.
* NOTE 2: The hysteresis is defined to prevent storms of threshold crossing notifications.
When processing a request to create a threshold, implementations should enforce a suitable minimum
value for this attribute (e.g. override the value or reject the request).
type: object
required:
- performanceMetric
- thresholdType
properties:
performanceMetric:
description: >
Defines the performance metric associated with the threshold.
This attribute’s value shall contain the related "Measurement Name" values
as defined in clause 8.4 of ETSI GS NFV-IFA 031
type: string
thresholdType:
description: >
Type of threshold. This attribute determines which other attributes are
present in the data structure.
Permitted values:
- SIMPLE: Single-valued static threshold
In the present document, simple thresholds are defined. The definition
of additional threshold types is left for future specification.
type: string
enum:
- SIMPLE
simpleThresholdDetails:
description: >
Details of a simple threshold. Shall be present if thresholdType="SIMPLE".
type: object
properties:
thresholdValue:
description: >
The threshold value. Shall be represented as a floating point number.
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Number"
hysteresis:
description: >
The hysteresis of the threshold.
Shall be represented as a non-negative floating point number.
A notification with crossing direction "UP" will be generated if the
measured value reaches or exceeds "thresholdValue" + "hysteresis".
A notification with crossing direction "DOWN" will be generated if
the measured value reaches or undercuts "thresholdValue" - "hysteresis".
The hysteresis is defined to prevent storms of threshold crossing notifications.
When processing a request to create a threshold, implementations should enforce
a suitable minimum value for this attribute (e.g. override the value or reject
the request).
$ref: "../../components/SOL009_schemas.yaml#/components/schemas/Number"
required:
- thresholdValue
- hysteresis
#----------------
# common types to SOL009
#----------------