Skip to content
GitLab
Switch branch/tag
Find file Normal viewHistoryPermalink
SOL005NSDescriptorManagementNotification_def.yaml 11.5 KB
Newer Older
moscatelli's avatar
SOl005: Notification interfaces added  
moscatelli committed
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 
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
  NsdOnBoardingNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingNotification" for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
      This type represents an NSD management notification, which informs
      the receiver of the successful on-boarding of an NSD. It shall comply with
      the provisions defined in Table 5.5.2.9-1. The support of this notification
      is mandatory. The notification shall be triggered by the NFVO when the "
      nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".

  NsdOnBoardingFailureNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdInfoId
      - onboardingFailureDetails
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingFailureNotification" for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      onboardingFailureDetails:
moscatelli's avatar
SOL005_41 -> SOL005_45: NSD management datatypes updated    
moscatelli committed
70
71
72 
        description: >
          Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
          for the details of "ProblemDetails" structure.
moscatelli's avatar
SOl005: Notification interfaces added  
moscatelli committed
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 
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
      This type represents an NSD management notification, which informs
      the receiver of the failure of on-boarding an NSD. It shall comply with the
      provisions defined in Table 5.5.2.10-1. The support of this notification is
      mandatory. The notification shall be triggered by the NFVO when the on-boarding
      of an NSD has failed.

  NsdChangeNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - nsdOperationalState
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "NsdChangeNotification" for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdOperationalState:
        $ref: "../../NSDManagement/definitions/SOL005NSDescriptorManagement_def.yaml#/definitions/NsdOperationalStateType"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
      This type represents an NSD management notification, which informs
      the receiver of a change of the "nsdOperationalState" attribute of an on-boarded
      NSD. Changes in the value of the "nsdUsageState" and "nsdOnboardingState"
      attributes are not reported. The notification shall comply with the provisions
      defined in Table 5.5.2.11-1. The support of this notification is mandatory.
      The notification shall be triggered by the NFVO when the value of the "nsdOperationalState"
      attribute has changed, and the "nsdOperationalState" attribute has the value
      "ONBOARDED".

  NsdDeletionNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "NsdDeletionNotification " for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      nsdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      nsdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
      This type represents an NSD management notification, which informs
      the receiver of the deletion of an on-boarded NSD. The notification shall
      comply with the provisions defined in Table 5.5.2.12-1. The support of this
      notification is mandatory. The notification shall be triggered by the NFVO
      when it has deleted an on-boarded NSD.

  PnfdOnBoardingNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingNotification" for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
      This type represents a PNFD management notification, which informs
      the receiver of the successful on-boarding of aPNFD. It shall comply with
      the provisions defined in Table 5.5.2.13-1. The support of this notification
      is mandatory. The notification is triggered when a new PNFD is on-boarded.

  PnfdOnBoardingFailureNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - onboardingFailureDetails
      - pnfdInfoId
      - timeStamp
    properties:
      id:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingFailureNotification" for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      onboardingFailureDetails:
moscatelli's avatar
SOL005_41 -> SOL005_45: NSD management datatypes updated    
moscatelli committed
228
229
230 
        description: >
          Failure details of current onboarding procedure. See clause 6.3 of ETSI GS NFV-SOL 013
          for the details of "ProblemDetails" structure.
moscatelli's avatar
SOl005: Notification interfaces added  
moscatelli committed
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 
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
      This type represents a PNFD management notification, which informs
      the receiver of the failure of on-boarding a PNFD. It shall comply with
      the provisions defined in Table 5.5.2.14-1. The support of this notification
      is mandatory. The notification is triggered when the on-boarding of a PNFD
      fails.

  PnfdDeletionNotification:
    type: object
    required:
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
    properties:
      id:
        type: string
        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.
      notificationType:
        type: string
        description: >
          Discriminator for the different notification types. Shall be
          set to "PnfdDeletionNotification " for this notification type.
      subscriptionId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      timeStamp:
        description: >
          Date-time of the generation of the notification.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
      pnfdInfoId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
      This type represents a PNFD management notification, which informs
      the receiver of the deletion of an on-boarded PNFD. The notification shall
      comply with the provisions defined in Table 5.5.2.15-1. The support of this
      notification is mandatory. The notification is triggered when an on-boarded
      PNFD is deleted.

  NsdmLinks:
    type: object
    required:
      - nsdInfo
      - subscription
    properties:
      nsdInfo:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
      subscription:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
    description: >
      This type represents the links to resources that an NSD management
      notification can contain.

  PnfdmLinks:
    type: object
    required:
      - pnfdInfo
      - subscription
    properties:
      pnfdInfo:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
      subscription:
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
    description: >
      This type represents the links to resources that a PNFD management
      notification can contain.