Newer
Older
rameshnaraya
committed
definitions:
CreatePmJobRequest:
description: >
This type represents a request to create a PM job.
It shall comply with the provisions defined in Table 7.5.2.6-1.
type: object
required:
- objectInstanceIds
moscatelli
committed
- criteria
rameshnaraya
committed
properties:
objectInstanceIds:
description: >
Identifiers of the NS instances for which
performance information is requested to be collected.
type: "array"
moscatelli
committed
items:
rameshnaraya
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
criteria:
description: >
Criteria of the collection of performance information.
$ref: "#/definitions/PmJobCriteria"
moscatelli
committed
rameshnaraya
committed
PmJobCriteria:
description: >
This type represents collection criteria for PM jobs.
It shall comply with the provisions defined in Table 7.5.3.3-1.
type: object
required:
- collectionPeriod
moscatelli
committed
- reportingPeriod
rameshnaraya
committed
properties:
performanceMetric:
description: >
This defines the types of performance metrics
for the specified object instances. At least one
of the two attributes (performance metric or
group) shall be present.
type: "array"
moscatelli
committed
items:
rameshnaraya
committed
$ref: "SOL005_def.yaml#/definitions/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. At least one of the two
attributes (performance metric or group) shall
be present.
rameshnaraya
committed
type: "array"
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/String"
rameshnaraya
committed
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.
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: integer
minimum: 0
moscatelli
committed
default: 0
rameshnaraya
committed
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.
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: integer
minimum: 0
moscatelli
committed
default: 0
rameshnaraya
committed
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: "SOL005_def.yaml#/definitions/DateTime"
PmJob:
description: >
This type represents a PM job.
type: object
required:
- id
- objectInstanceIds
moscatelli
committed
- criteria
rameshnaraya
committed
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
properties:
id:
description: >
Identifier of this PM job.
$ref: "SOL005_def.yaml#/definitions/Identifier"
objectInstanceIds:
description: >
Identifiers of the NS instances for which
performance information is collected.
type: array
items:
$ref: "SOL005_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.
$ref: "SOL005_def.yaml#/definitions/Uri"
readyTime:
description: >
The time when the report was made available.
$ref: "SOL005_def.yaml#/definitions/DateTime"
expiryTime:
description: >
The time when the report will expire.
$ref: "SOL005_def.yaml#/definitions/DateTime"
fileSize:
description: >
The size of the report file in bytes, if known.
moscatelli
committed
type: integer
rameshnaraya
committed
_links:
description: >
Links for this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
objects:
description: >
Links to resources representing the NS
instances for which performance information is
collected. Shall be present if the NS instance
information is accessible as a resource.
rameshnaraya
committed
type: array
moscatelli
committed
items:
rameshnaraya
committed
$ref: "SOL005_def.yaml#/definitions/Link"
moscatelli
committed
rameshnaraya
committed
CreateThresholdRequest:
description: >
This type represents a request to create a threshold.
type: object
required:
- objectInstanceId
- criteria
moscatelli
committed
properties:
rameshnaraya
committed
objectInstanceId:
description: >
Identifier of the NS instance associated with this threshold.
rameshnaraya
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/definitions/ThresholdCriteria"
moscatelli
committed
rameshnaraya
committed
Threshold:
description: >
This type represents a threshold.
type: object
moscatelli
committed
required:
rameshnaraya
committed
- id
- objectInstanceId
- criteria
- _links
moscatelli
committed
properties:
rameshnaraya
committed
id:
description: >
Identifier of this threshold resource.
$ref: "SOL005_def.yaml#/definitions/Identifier"
objectInstanceId:
description: >
Identifier of the NS instance associated with the threshold.
rameshnaraya
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
criteria:
description: >
Criteria that define this threshold.
$ref: "#/definitions/ThresholdCriteria"
_links:
description: >
Links for this resource.
type: object
moscatelli
committed
required:
rameshnaraya
committed
- self
moscatelli
committed
properties:
rameshnaraya
committed
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
moscatelli
committed
object:
rameshnaraya
committed
description: >
Link to a resource representing the NS instance for
which performance information is collected. Shall be
present if the NS instance information is accessible as
a resource.
moscatelli
committed
rameshnaraya
committed
ThresholdCriteria:
description: >
This type represents criteria that define a threshold.
type: object
moscatelli
committed
required:
rameshnaraya
committed
- performanceMetric
- thresholdType
moscatelli
committed
properties:
rameshnaraya
committed
performanceMetric:
description: >
Defines the performance metric associated with the
threshold, as specified in ETSI GS NFV-IFA 027).
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
moscatelli
committed
required:
rameshnaraya
committed
- thresholdValue
- hysteresis
moscatelli
committed
properties:
rameshnaraya
committed
thresholdValue:
description: >
The threshold value. Shall be represented as a floating point
rameshnaraya
committed
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).
type: integer
moscatelli
committed
rameshnaraya
committed
PmSubscriptionRequest:
description: >
This type represents a subscription request.
type: object
moscatelli
committed
required:
rameshnaraya
committed
- 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.
$ref: "SOL005_def.yaml#/definitions/Uri"
authentication:
description: >
Authentication parameters to conFigure the use of
Authorization when sending notifications corresponding
to this subscription, as defined in clause 4.5.3.4.
This attribute shall only be present if the subscriber
requires authorization of notifications..
$ref: "SOL005_def.yaml#/definitions/SubscriptionAuthentication"
moscatelli
committed
rameshnaraya
committed
PmNotificationsFilter:
description: >
This type represents a filter that can be used to subscribe for
notifications related to performance management events. It
shall comply with the provisions defined in Table 7.5.3.2-1.
At a particular nesting level in the filter structure, the following applies:
All attributes shall match in order for the filter
to match (logical "and" between different filter attributes).
If an attribute is an array, the attribute shall match if at least
one of the values in the array matches (logical "or" between the values of one filter attribute).
type: object
moscatelli
committed
properties:
rameshnaraya
committed
nsInstanceSubscriptionFilter:
description: >
Filter criteria to select NS instances about which to notify.
$ref: "SOL005_def.yaml#/definitions/NSInstanceSubscriptionFilter"
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- ThresholdCrossedNotification
- PerformanceInformationAvailableNotification
rameshnaraya
committed
The permitted values of the "notificationTypes" attribute are
spelled exactly as the names of the notification types to facilitate
automated code generation systems.
type: array
items:
type: string
enum:
- ThresholdCrossedNotification
- PerformanceInformationAvailableNotification
PmSubscription:
description: >
This type represents a subscription.
type: object
moscatelli
committed
required:
rameshnaraya
committed
- id
- callbackUri
- _links
moscatelli
committed
properties:
rameshnaraya
committed
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
id:
description: >
Identifier that identifies the subscription.
$ref: "SOL005_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.
$ref: "SOL005_def.yaml#/definitions/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
moscatelli
committed
rameshnaraya
committed
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
Version:
description: >
Software version of the VNF. This is
changed when there is any change to the
software included in the VNF package.
This information is copied from the VNFD.
It shall be present after the VNF package
content has been on-boarded and absent otherwise.
type: string
Checksum:
description: >
This type represents the checksum of a VNF package or an artifact file.
required:
- algorithm
- hash
type: object
properties:
algorithm:
description: >
Name of the algorithm used to generate the checksum,
as defined in ETSI GS NFV-SOL 004 [5]. For example, SHA-256, SHA-512.
type: string
hash:
description: >
The hexadecimal value of the checksum.
type: string
Link:
type: "object"
moscatelli
committed
rameshnaraya
committed
PerformanceInformationAvailableNotification:
description: >
This notification informs the receiver that performance information is available.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
rameshnaraya
committed
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
- _links
properties:
id:
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: "SOL005_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types.
Shall be set to
"PerformanceInformationAvailableNotification"
for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "SOL005_def.yaml#/definitions/DateTime"
objectInstanceId:
description: >
Identifier that identifies a NS instance.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
rameshnaraya
committed
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
_links:
description: >
Links to resources related to this notification.
type: object
required:
- subscription
- pmJob
- performanceReport
properties:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
objectInstance:
description: >
Link to the resource representing the NS
instance to which the notified change applies.
Shall be present if the NS instance information
is accessible as a resource.
$ref: "SOL005_def.yaml#/definitions/Link"
pmJob:
description: >
Link to the resource that represents the PM job
for which performance information is available.
$ref: "SOL005_def.yaml#/definitions/Link"
performanceReport:
description: >
Link from which the available performance
information of data type "PerformanceReport"
(see clause 7.5.2.10) can be obtained.
This link should point to an "Individual
performance report" resource as defined in
clause 6.4.3a.
rameshnaraya
committed
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
504
505
506
$ref: "SOL005_def.yaml#/definitions/Link"
ThresholdCrossedNotification:
description: >
This type represents a notification that is sent when a threshold has been crossed.
type: object
required:
- id
- notificationType
- subscriptionId
- timeStamp
- thresholdId
- crossingDirection
- objectInstanceId
- performanceMetric
- performanceValue
- _links
properties:
id:
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: "SOL005_def.yaml#/definitions/Identifier"
notificationType:
description: >
Discriminator for the different notification types.
Shall be set to "ThresholdCrossedNotification "
for this notification type.
type: string
subscriptionId:
description: >
Identifier of the subscription that this notification relates to.
$ref: "SOL005_def.yaml#/definitions/Identifier"
timeStamp:
description: >
Date and time of the generation of the notification.
$ref: "SOL005_def.yaml#/definitions/DateTime"
thresholdId:
description: >
Identifier of the threshold which has been crossed.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
rameshnaraya
committed
crossingDirection:
description: >
An indication of whether the threshold was crossed in upward or downward direction.
moscatelli
committed
$ref: "#/definitions/CrossingDirectionType"
rameshnaraya
committed
objectInstanceId:
description: >
Identifier that identifies a NS instance.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
rameshnaraya
committed
performanceMetric:
description: >
Performance metric associated with the threshold.
type: string
performanceValue:
description: >
Value of the metric that resulted in threshold crossing. See note.
moscatelli
committed
type: object
rameshnaraya
committed
_links:
description: >
Links to resources related to this notification.
type: object
required:
- subscription
- objectInstance
- threshold
properties:
subscription:
description: >
Link to the related subscription.
$ref: "SOL005_def.yaml#/definitions/Link"
objectInstance:
description: >
Link to the resource representing the NS
instance to which the notified change applies.
Shall be present if the NS instance information
is accessible as a resource..
$ref: "SOL005_def.yaml#/definitions/Link"
threshold:
description: >
Link to the resource that represents the
threshold that was crossed.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Link"
rameshnaraya
committed
CrossingDirectionType:
description: >
The enumeration CrossingDirectionType shall comply with the provisions.
Acceptable Values are:
UP - The threshold was crossed in upward direction.
DOWN - The threshold was crossed in downward direction.
type: string
enum:
- UP
- DOWN