SOL005NSPerformanceManagementNotification_def.yaml 6.83 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
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
definitions:
  PerformanceInformationAvailableNotification:
    description: >
      This notification informs the receiver that performance information is available.
    type: object
    required:
      - id
      - notificationType
      - subscriptionId
      - timeStamp
      - objectInstanceId
      - _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: "../../definitions/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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date and time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      objectInstanceId:
        description: >
          Identifier that identifies a NS instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      _links:
        description: >
          Links to resources related to this notification.
        type: object
        required:
          - subscription
          - pmJob
          - performanceReport
        properties:
          subscription:
            description: >
              Link to the related subscription.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
          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: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
          pmJob:
            description: >
              Link to the resource that represents the PM job
              for which performance information is available.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
          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.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"

  ThresholdCrossedNotification:
    description: >
      This type represents a notification that is sent when a threshold has been crossed.
81
82
83
      NOTE:	The timing of sending this notification is determined by the capability of 
      the producing entity to evaluate the threshold crossing condition.
      The notification shall be triggered by the NFVO when a threshold has been crossed.
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
    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: "../../definitions/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: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date and time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      thresholdId:
        description: >
          Identifier of the threshold which has been crossed.
        $ref: "../../definitions/SOL005_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 NS instance.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      performanceMetric:
        description: >
          Performance metric associated with the threshold.
          This attribute shall contain the related "Measurement Name" value
          as defined in clause 7.2 of ETSI GS NFV-IFA 027.
        type: string
      performanceValue:
        description: >
          Value of the metric that resulted in threshold crossing.
          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
      _links:
        description: >
          Links to resources related to this notification.
        type: object
        required:
          - subscription
          - objectInstance
          - threshold
        properties:
          subscription:
            description: >
              Link to the related subscription.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
          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: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
          threshold:
            description: >
              Link to the resource that represents the
              threshold that was crossed.
            $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"

  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