SOL002SOL003VNFPerformanceManagement_def.yaml 23.2 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt

definitions:
  CreateThresholdRequest:
    description: >
      This type represents a request to create a threshold.
    type: object
    required:
      - objectInstanceId
      - criteria
12
    properties:
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
      objectInstanceId:
        description: >
          Identifier of the VNF instance associated with this threshold.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      criteria:
        description: >
          Criteria that define this threshold.
        $ref: "#/definitions/ThresholdCriteria"

  CreatePmJobRequest:
    description: >
      This type represents a request to create a PM job.
    type: object
    required:
      - criteria
    properties:
      objectInstanceIds:
        description: >
          Identifiers of the VNF instances for which performance information
          is requested to be collected.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      criteria:
        description: >
          Criteria of the collection of performance information.
        $ref: "#/definitions/PmJobCriteria"

  CrossingDirectionType:
    type: string
43
    enum:
44
45
46
47
48
49
50
51
52
      - UP
      - DOWN

  PerformanceInformationAvailableNotification:
    description: >
      This notification informs the receiver that performance information is
      available.
      The timing of sending this notification is determined by the capability
      of the producing entity to evaluate the threshold crossing condition.
53
54
      The notification shall be triggered by the VNFM when new performance
      information collected by a PM job is available.
55
    type: object
56
    required:
57
58
59
60
61
62
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - objectInstanceId
      - _links
63
64
    properties:
      id:
65
66
67
68
69
70
71
72
73
74
75
        description: >
          Identifier of this notification. If a notification is sent multiple
          times due to multiple subscriptions, the "id" attribute of all these
          notifications shall have the same value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be set to
          "PerformanceInformationAvailableNotification" for this notification
          type.
        type: string
76
        enum:
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
          - PerformanceInformationAvailableNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date and time of the generation of the notification.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      objectInstanceId:
        description: >
          Identifier that identifies a VNF instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links to resources related to this notification.
        type: object
94
        required:
95
96
97
98
99
100
101
          - subscription
          - pmJob
          - performanceReport
        properties:
          subscription:
            description: >
              Link to the related subscription.
102
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
103
104
105
106
107
          objectInstance:
            description: >
              Link to the resource representing the VNF instance to which the
              notified change applies. Shall be present if the VNF instance
              information is accessible as a resource.
108
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
109
110
111
112
          pmJob:
            description: >
              Link to the resource that represents the PM job for which
              performance information is available.
113
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
114
115
116
117
118
          performanceReport:
            description: >
              Link from which the available performance information of data
              type "PerformanceReport" can be obtained. This link should point
              to an "Individual performance report" resource.
119
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
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
  PerformanceReport:
    description: >
      This type defines the format of a performance report provided by the VNFM to the EM as a result
      of collecting performance information as part of a PM job.
      The type shall comply with the provisions defined in table 6.5.2.10-1.
    type: object
    properties:
      entries:
        description: >
          List of performance information entries. Each performance report
          entry is for a given metric of a given object (i.e. VNF instance),
          but can include multiple collected values.
        type: array
        items:
          type: object
          required:
            - objectType
            - objectInstanceId
            - performanceMetric
            - performanceValue
          properties:
            objectType:
              description: >
                Defines the object type for which performance information is
                reported (i.e. VNF type). The string value shall be set to the
                vnfdId of the VNF instance to which the performance
                information relates.
              type: string
            objectInstanceId:
              description: >
                The object instance (i.e. VNF instance) for which the
                performance metric is reported.
              $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
            subObjectInstanceId:
              description: >
                Identifier of the sub-object of the measured object (i.e. a VNFC instance)
                for which the performance metric is reported.
                Shall be present if this is required in the measurement specification.
                The sub-object allows to structure the measured object,
                but is not to be confused with sub-counters which allow to structure the measurement.
                EXAMPLE:
                  Measured object:  VnfInstanceXYZ
                  Sub-object:       VnfcInstance1
                  Measurement:      vCPU_utilization
                  Sub-counters:     vCPU utilization of each of the vCPUs of VnfcInstance1
                                    (vCPU_utilization.vCPU1, vCPU_utilization.vCPU2, etc.).
              $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
            performanceMetric:
              description: >
                Name of the metric collected. This attribute shall contain the related "Measurement Name"
                value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
              type: string
            performanceValues:
              description: >
                List of performance values with associated timestamp.
              type: array
              items:
                type: object
                required:
                  - timeStamp
                  - performanceValue
                properties:
                  timeStamp:
                    description: >
185
                      Time stamp indicating when the data has been collected.
186
187
188
189
190
191
192
                    $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
                  value:
                    description: >
                      Value of the metric collected.
                      The type of this attribute shall correspond to the related "Measurement Unit"
                      as defined in clause 7.2. of ETSI GS NFV-IFA 027.
                    type: object
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

  PmJob:
    description: >
      This type represents a PM job.
    type: object
    required:
      - id
      - objectInstanceIds
      - criteria
    properties:
      id:
        description: >
          Identifier of this PM job.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      objectInstanceIds:
        description: >
          Identifiers of the VNF instances for which performance information
          is collected.
        type: array
        items:
          $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      criteria:
        description: >
          Criteria of the collection of performance information.
        $ref: "#/definitions/PmJobCriteria"
      reports:
        description: >
          Information about available reports collected by this PM job.
        type: object
        required:
          - href
          - readyTime
          - _links
        properties:
          href:
            description: >
              The Uri where the report can be obtained.
            type: string
            format: url
          readyTime:
            description: >
              The time when the report was made available.
            $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
          expiryTime:
            description: >
              The time when the report will expire.
            $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
          fileSize:
            description: >
              The size of the report file in bytes, if known.
            type: integer
            # TODO: How to express unsigned int?
Gergely Csatari's avatar
Gergely Csatari committed
245
246
247
248
249
250
251
252
253
254
255
256
      _links:
        description: >
          Links for this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
          objects:
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
            description: >
              Links for this resource.
            type: object
            required:
              - self
            properties:
              self:
                description: >
                  URI of this resource.
                $ref: "SOL002SOL003_def.yaml#/definitions/Link"
              objects:
                description: >
                  Links to resources representing the VNF instances for which
                  performance information is collected. Shall be present if
                  the VNF instance information is accessible as a resource.
                type: array
273
                items:
274
275
276
277
278
279
280
281
282
283
284
285
                  $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  PmJobCriteria:
    description: >
      Criteria of the collection of performance information.
    type: object
    required:
      - collectionPeriod
      - reportingPeriod
    properties:
      performanceMetric:
        description: >
286
287
288
          This defines the types of performance metrics for the specified object instances.
          Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV-IFA 027.
          At least one of the two attributes (performance metric or group) shall be present.
289
        type: array
290
        items:
291
292
293
294
295
          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
296
297
          individual metrics. Valid values are specified as "Measurement Group"
          values in clause 7.2 of ETSI GS NFV-IFA 027.
298
299
300
          At least one of the two attributes (performance metric or group)
          shall be present.
        type: array
301
        items:
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
          type: string
      collectionPeriod:
        description: >
          Specifies the periodicity at which the producer will collect
          performance information. The unit shall be seconds.
          At the end of each reportingPeriod, the producer will inform the
          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.
        type: integer
        # TODO: How to express unsigned int?
      reportingPeriod:
        description: >
          Specifies the periodicity at which the producer will report to the
          consumer. about performance information. The unit shall be seconds.
          At the end of each reportingPeriod, the producer will inform the
          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.
        type: integer
        # TODO: How to express unsigned int?
      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: "SOL002SOL003_def.yaml#/definitions/DateTime"

  PmNotificationsFilter:
    description: >
      This type represents a filter that can be used to subscribe for
      notifications related to performance management events.
    type: object
341
    properties:
342
343
344
345
346
347
348
349
350
351
352
353
354
355
      vnfInstanceSubscriptionFilter:
        description: >
          Filter criteria to select VNF instances about which to notify.
        $ref: "SOL002SOL003_def.yaml#/definitions/VnfInstanceSubscriptionFilter"
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          * ThresholdCrossedNotification
          * PerformanceInformationAvailableNotification
          The permitted values of the "notificationTypes" attribute are
          spelled exactly as the names of the notification types to facilitate
          automated code generation systems.
        type: string
356
        enum:
357
358
359
360
361
362
363
          - ThresholdCrossedNotification
          - PerformanceInformationAvailableNotification

  PmSubscription:
    description: >
      This type represents a subscription.
    type: object
364
    required:
365
366
367
      - id
      - callbackUri
      - _links
368
    properties:
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
      id:
        description: >
          Identifier that identifies the subscription.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/PmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        type: string
        format: url
      _links:
        description: >
          Links to resources related to this resource.
        type: object
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"

  PmSubscriptionRequest:
    description: >
      This type represents a subscription request.
    type: object
401
    required:
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
      - callbackUri
    properties:
      filter:
        description: >
          Filter settings for this subscription, to define the subset of all
          notifications this subscription relates to. A particular
          notification is sent to the subscriber if the filter matches, or if
          there is no filter.
        $ref: "#/definitions/PmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
        type: string
        format: url
      authentication:
        description: >
418
419
420
          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.
421
422
423
424
425
426
        $ref: "SOL002SOL003_def.yaml#/definitions/SubscriptionAuthentication"

  Threshold:
    description: >
      This type represents a threshold.
    type: object
427
    required:
428
429
430
431
      - id
      - objectInstanceId
      - criteria
      - _links
432
    properties:
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
      id:
        description: >
          Identifier of this threshold resource.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      objectInstanceId:
        description: >
          Identifier of the VNF instance associated with the threshold.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      criteria:
        description: >
          Criteria that define this threshold.
        $ref: "#/definitions/ThresholdCriteria"
      _links:
        description: >
          Links for this resource.
        type: object
449
        required:
450
          - self
451
        properties:
452
453
454
455
          self:
            description: >
              URI of this resource.
            $ref: "SOL002SOL003_def.yaml#/definitions/Link"
456
          object:
457
458
459
460
461
462
463
464
465
            description: >
              Link to a resource representing the VNF instance for which
              performance information is collected. Shall be present if the
              VNF instance information is accessible as a resource.

  ThresholdCriteria:
    description: >
      This type represents criteria that define a threshold.
    type: object
466
    required:
467
468
      - performanceMetric
      - thresholdType
469
    properties:
470
471
      performanceMetric:
        description: >
472
473
          Defines the performance metric associated with the threshold.
          Valid values are specified as "Measurement Name" values in clause 7.2 of ETSI GS NFV-IFA 027.
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
        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
492
        required:
493
494
          - thresholdValue
          - hysteresis
495
        properties:
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
          thresholdValue:
            description: >
              The threshold value. Shall be represented as a floating point
              number.
            # TODO: This should be floating.             
            type: integer
          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).
            # TODO: This should be floating. 
            type: integer

  ThresholdCrossedNotification:
    description: >
      This type represents a notification that is sent when a threshold has
      been crossed.
523
524
      The notification shall be triggered by the VNFM when a threshold has
      been crossed.
525
    type: object
526
    required:
527
528
529
530
531
532
533
534
535
536
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - thresholdId
      - crossingDirection
      - objectInstanceId
      - performanceMetric
      - performanceValue
      - _links
537
538
    properties:
      id:
539
540
541
542
543
        description: >
          Identifier of this notification. If a notification is sent multiple
          times due to multiple subscriptions, the "id" attribute of all these
          notifications shall have the same value.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
544
      notificationType:
545
546
547
548
        description: >
          Discriminator for the different notification types. Shall be set to
          "ThresholdCrossedNotification" for this notification type.
        type: string
549
        enum:
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
          - ThresholdCrossedNotification
      subscriptionId:
        description: >
          Identifier of the subscription that this notification relates to.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date and time of the generation of the notification.
        $ref: "SOL002SOL003_def.yaml#/definitions/DateTime"
      thresholdId:
        description: >
          Identifier of the threshold which has been crossed.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
      crossingDirection:
        description: >
          An indication of whether the threshold was crossed in upward or
          downward direction.
        $ref: "#/definitions/CrossingDirectionType"
      objectInstanceId:
        description: >
          Identifier that identifies a VNF instance.
        $ref: "SOL002SOL003_def.yaml#/definitions/Identifier"
572
573
574
575
576
577
578
579
      subObjectInstanceId:
        description: >
          Identifier of the sub-object of the measured object (i.e. a VNFC instance)
          to which the measurement applies.
          Shall be present if this is required in an external measurement specification.
          The sub-object allows to structure the measured object, but is not to be confused
          with sub-counters which allow to structure the measurement.
        $ref: "SOL002SOL003_def.yaml#/definitions/IdentifierInVnf"
580
581
582
      performanceMetric:
        description: >
          Performance metric associated with the threshold.
583
584
          This attribute shall contain the related "Measurement Name"
          value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
585
586
587
588
        type: string
      performanceValue:
        description: >
          Value of the metric that resulted in threshold crossing.
589
590
          The type of this attribute shall correspond to the related
          "Measurement Unit" as defined in clause 7.2 of ETSI GS NFV-IFA 027.
591
592
593
594
595
        type: object
      _links:
        description: >
          Links to resources related to this notification.
        type: object
596
        required:
597
598
          - subscription
          - threshold
599
        properties:
600
601
602
          subscription:
            description: >
              Link to the related subscription.
603
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
604
605
606
607
608
          objectInstance:
            description: >
              Link to the resource representing the VNF instance to which the
              notified change applies. Shall be present if the VNF instance
              information is accessible as a resource.
609
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"
610
611
612
613
          threshold:
            description: >
              Link to the resource that represents the threshold that was
              crossed.
614
            $ref: "SOL002SOL003_def.yaml#/definitions/NotificationLink"