SOL005NSDescriptorManagement_def.yaml 33.7 KB
Newer Older
1
2
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
3
4
definitions:
  NsdInfo:
5
    type: object
6
    required:
7
8
9
10
      - id
      - nsdOnboardingState
      - nsdOperationalState
      - nsdUsageState
11
      - _links
12
13
14
15
16
    properties:
      id:
        description: >
          Identifier of the on boarded individual NS descriptor
          resource. This identifier is allocated by the NFVO.
17
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
18
19
20
21
22
23
      nsdId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies the NSD in a globally unique
          way. It is copied from the NSD content and shall be
          present after the NSD content is on-boarded.
24
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
25
      nsdName:
26
        type: string
27
        description: >
28
29
          Name of the on boarded NSD. This information is copied from the
          NSD content and shall be present after the NSD content is on-boarded.
30
31
32
33
34
      nsdVersion:
        description: >
          Version of the on-boarded NSD. This information is
          copied from the NSD content and shall be present
          after the NSD content is on-boarded.
35
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
36
      nsdDesigner:
37
        type: string
38
        description: >
39
40
          Designer of the on-boarded NSD. This information is copied
          from the NSD content and shall be present after the NSD content is on-boarded.
41
42
43
44
45
46
47
      nsdInvariantId:
        description: >
          This identifier, which is allocated by the NSD
          designer, identifies an NSD in a version independent
          manner. This information is copied from the NSD
          content and shall be present after the NSD content is
          on-boarded.
48
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
49
50
51
52
53
54
      vnfPkgIds:
        description: >
          Identifies the VNF package for the VNFD referenced
          by the on-boarded NS descriptor resource.
        type: array
        items:
55
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
56
57
58
59
60
61
62
      pnfdInfoIds:
        description: >
          Identifies the PnfdInfo element for the PNFD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
63
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
64
65
66
67
68
69
70
      nestedNsdInfoIds:
        description: >
          Identifies the NsdInfo element for the nested NSD
          referenced by the on-boarded NS descriptor
          resource.
        type: array
        items:
71
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
72
73
74
75
76
77
78
79
80
81
82
83
      nsdOnboardingState:
        description: >
          On boarding state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on boarding procedure. See
          clause 4.3.5.3 for the details of "ProblemDetails"
          structure.
          It shall be present when the "nsdOnboardingState"
          attribute is CREATED and the uploading or
          processing fails in NFVO.
84
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
      nsdOperationalState:
        description: >
          Operational state of the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
        $ref: "#/definitions/NsdOperationalStateType"
      nsdUsageState:
        description: >
          Usage state of the individual NS descriptor resource.
        $ref: "#/definitions/NsdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual NS descriptor
          resource. This attribute can be modified with the
          PATCH method.
100
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
101
      _links:
102
        type: object
103
        required:
104
105
          - self
          - nsd_content
106
        description: >
107
          Links to resources related to this resource.
108
109
110
        properties:
          self:
            description: >
111
              URI of this resource.
112
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
113
114
          nsd_content:
            description: >
115
              Link to the NSD content resource.
116
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
117
    description: >
118
      This type represents a response for the query NSD operation.
119
120

  NsdInfoModifications:
121
    type: object
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
    description: >
      This type represents attribute modifications for an individual NS
      descriptor resource based on the NsdInfo data type. The attributes of
      NsdInfo that can be modified are included in the NsdInfoModifications
      data type.NOTE: At least one of the attributes - nsdOperationalState and
      userDefinedData - shall be present.
    properties:
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      userDefinedData:
        description: >
          Modifications of the userDefinedData attribute in NsdInfo
          data type. See note. If present, these modifications shall be applied
          according to the rules of JSON Merge PATCH (see IETF RFC 7396 [25]).
          NOTE- At least one of the attributes - nsdOperationalState and userDefinedData - shall be present.
137
        type: array
138
        items:
139
          $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
140

141
  NsdOperationalState:
142
    description: >
143
      New value of the "nsdOperationalState" attribute in "NsdInfo"
144
      data type. See note.Permitted values:
145
146
      ENABLED, DISABLED.
    type: array
147
148
149
150
    items:
      $ref: "#/definitions/NsdInfoModifications"

  NsdmSubscription:
151
    type: object
152
    required:
153
154
155
      - id
      - callbackUri
      - _links
156
157
158
159
    properties:
      id:
        description: >
          Identifier of this subscription resource.
160
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
161
162
163
164
165
166
167
168
169
170
      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/NsdmNotificationsFilter"
      callbackUri:
        description: >
          The URI of the endpoint to send the notification to.
171
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
172
      _links:
173
        type: object
174
175
176
177
        description: >
          Links to resources related to this resource.
        properties:
          self:
178
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
179
180
181
182
    description: >
      This type represents a subscription related to notifications about NSD management.

  NsdmSubscriptionRequest:
183
    type: object
184
    required:
185
      - callbackUri
186
187
188
189
    properties:
      filter:
        $ref: "#/definitions/NsdmNotificationsFilter"
      callbackUri:
190
        type: string
191
192
193
194
195
196
197
        description: >
          The URI of the endpoint to send the notification to.
      authentication:
        $ref: "#/definitions/SubscriptionAuthentication"
    description: >
      This type represents a subscription request related to notifications
      about NSD management.
198

199
  NsdmNotificationsFilter:
200
    type: object
201
    description: >
202
      This type represents a subscription filter related to notifications
203
204
205
206
207
      about NSD management. It shall comply with the provisions defined in Table
      5.5.3.2-1 of GS NFV-SOL 005. 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
208
      array matches (logical "or" between the values of one filter attribute).
209
210
211
    properties:
      notificationTypes:
        description: >
212
          Match particular notification types. Permitted values: NsdOnBoardingNotification,
213
214
215
216
          NsdOnboardingFailureNotification, NsdChangeNotification, NsdDeletionNotification
          PnfdOnBoardingNotification, PnfdOnBoardingFailureNotification, PnfdDeletionNotification.
          The permitted values of the "notificationTypes" ] attribute are spelled
          exactly as the names of the notification types to facilitate automated
217
          code generation systems.
218
219
220
221
        type: array
        items:
          type: string
          enum:
222
223
224
225
226
227
228
            - NsdOnBoardingNotification
            - NsdOnboardingFailureNotification
            - NsdChangeNotification
            - NsdDeletionNotification
            - PnfdOnBoardingNotification
            - PnfdOnBoardingFailureNotification
            - PnfdDeletionNotification
229
230
231
232
233
      nsdInfoId:
        description: >
          Match the NsdInfo identifier which is allocated by the NFVO.
        type: array
        items:
234
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
235
236
237
238
239
      nsdId:
        description: >
          Match the NSD identifier, which is allocated by the NSD designer.
        type: array
        items:
240
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
241
242
243
244
245
      nsdName:
        description: >
          Match the name of the on boarded NSD.
        type: array
        items:
246
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
247
248
249
250
251
      nsdVersion:
        description: >
          Match the NSD version listed as part of this attribute.
        type: array
        items:
252
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
253
254
      nsdDesigner:
        description: >
255
          Match the NSD designer of the on-boarded NSD.
256
257
        type: array
        items:
258
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
259
260
261
262
263
264
265
      nsdInvariantId:
        description: >
          Match the NSD invariant identifier which is allocated
          by the NSD designer and identifies an NSD in a
          version independent manner.
        type: array
        items:
266
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
267
268
269
270
271
272
      vnfPkgIds:
        description: >
          Match VNF packages with a package identifier listed
          in the attribute.
        type: array
        items:
273
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
274
275
276
277
278
279
      pnfdInfoIds:
        description: >
          Match the PnfdInfo identifier for the PNFD
          referenced by the on-boarded NSD.
        type: array
        items:
280
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
281
282
283
284
285
286
      nestedNsdInfoIds:
        description: >
          Match the NsdInfo identifier for the nested NSD
          referenced by the on-boarded NSD.
        type: array
        items:
287
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
288
289
290
291
292
      nsdOnboardingState:
        description: >
          Match particular on-boarding state of the NSD.
        type: array
        items:
293
          $ref: "#/definitions/NsdOnboardingStateType"
294
295
296
297
298
      nsdOperationalState:
        description: >
          Match particular operational state of the on-boarded NSD.
        type: array
        items:
299
          $ref: "#/definitions/NsdOperationalStateType"
300
301
302
303
304
      nsdUsageState:
        description: >
          Match particular usage state of the on-boarded NSD.
        type: array
        items:
305
          $ref: "#/definitions/NsdUsageStateType"
306
307
308
309
310
      pnfdId:
        description: >
          Match the PNFD identifier which is copied from the PNFD content.
        type: array
        items:
311
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
312
313
314
315
316
      pnfdName:
        description: >
          Match the name of the on-boarded PNFD.
        type: array
        items:
317
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
318
319
320
321
322
      pnfdVersion:
        description: >
          Match the PNFD designer of the on-boarded PNFD.
        type: array
        items:
323
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
324
325
326
327
328
      pnfdProvider:
        description: >
          Match the provider of the on-boarded PNFD.
        type: array
        items:
329
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
330
331
332
333
334
      pnfdInvariantId:
        description: >
          Match the PNFD in a version independent manner.
        type: array
        items:
335
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
336
337
338
339
340
341
342
343
344
345
346
347
      pnfdOnboardingState:
        description: >
          Match particular on-boarding state of the PNFD.
        type: array
        items:
          $ref: "#/definitions/PnfdOnboardingStateType"
      pnfdUsageState:
        description: >
          Match the usage state of the individual PNF descriptor resource.
        type: array
        items:
          $ref: "#/definitions/PnfdUsageStateType"
348

349
350
351
352
353
354
355
356
357
358
  SubscriptionAuthentication:
    description: >
      The procedure defined in clause 4.5.2 allows an API consumer to
      obtain authorization to perform API requests towards
      the API producer, including subscription requests.
      For sending the actual notifications matching a subscription, the API
      producer needs to obtain separate authorization to actually send the notification to the API consumer.
      If an API consumer requires the API producer to authorize for sending notifications to that API consumer, it shall
      include in the subscription request a data structure that defines the authorization requirements, as defined in
      Table 4.5.3.4-1.
359
    type: object
360
    required:
361
      - authType
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
    properties:
      authType:
        description: >
          Defines the types of Authentication
          Authorization the API consumer is willing to
          accept when receiving a notification.

          Permitted values:

          BASIC: In every HTTP request to the
          notification endpoint, use HTTP Basic
          authentication with the client credentials.

          OAUTH2_CLIENT_CREDENTIALS: In every
          HTTP request to the notification endpoint, use
          an OAuth 2.0 Bearer token, obtained using the
          client credentials grant type.
379

380
381
382
383
384
385
386
387
388
389
390
391
          TLS_CERT: Every HTTP request to the
          notification endpoint is sent over a mutually
          authenticated TLS session. i.e. not only server
          is authenticated, but also the client is
          authenticated during the TLS tunnel setup

        type: string
        enum:
          - BASIC
          - OAUTH2_CLIENT_CREDENTIALS
          - TLS_CERT
      paramsBasic:
392
        type: object
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
        description: >
          Parameters for authentication/authorization using BASIC.
          Shall be present if authType is "BASIC" and
          the contained information has not been
          provisioned out of band. Shall be absent otherwise.
        properties:
          userName:
            description: >
              Username to be used in HTTP Basic authentication.
              Shall be present if it has not been provisioned out of band.
            type: string
          password:
            description: >
              Password to be used in HTTP Basic authentication.
              Shall be present if it has not been provisioned out of band.
            type: string
      paramsOauth2ClientCredentials:
410
        type: object
411
412
413
414
        description: >
          Parameters for authentication/authorization using OAUTH2_CLIENT_CREDENTIALS.
          Shall be present if authType is "OAUTH2_CLIENT_CREDENTIALS" and the
          contained information has not been provisioned out of band.
415
          Shall be absent otherwise.
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
        properties:
          clientId:
            description: >
              Client identifier to be used in the access token
              request of the OAuth 2.0 client credentials
              grant type. Shall be present if it has not been
              provisioned out of band.
            type: string
          clientPassword:
            description: >
              Client password to be used in the access
              token request of the OAuth 2.0 client
              credentials grant type. Shall be present if it
              has not been provisioned out of band.
            type: string
          tokenEndpoint:
            description: >
              The token endpoint from which the access
              token can be obtained. Shall be present if it
              has not been provisioned out of band.
436
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Uri"
437
438

  NsdOperationalStateType:
439
    type: string
440
    description: >
441
      The enumeration NsdOperationalStateType shall comply with the provisions
442
443
444
      defined in Table 5.5.4.3-1 of GS NFV_SOL 005. It indicates the operational
      state of the resource.
      ENABLED = The operational state of the resource is enabled.
445
      DISABLED = The operational state of the resource is disabled.
446
    enum:
447
448
449
      - ENABLED
      - DISABLED

450
  NsdOnboardingStateType:
451
    type: string
452
    description: >
453
      The enumeration NsdOnboardingStateType shall comply with the provisions
454
455
456
457
458
      defined in Table 5.5.4.5-1 of GS NFV-SOL 005. It indicates the on-boarding
      state of the NSD.
      CREATED = The NSD information object is created.
      UPLOADING = The associated NSD content is being uploaded.
      PROCESSING = The associated NSD content is being processed, e.g. validation.
459
      ONBOARDED = The associated NSD content is on-boarded.
460
    enum:
461
462
463
464
465
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDED

466
  NsdUsageStateType:
467
    type: string
468
    description: >
469
      The enumeration NsdUsageStateType shall comply with the provisions
470
471
      defined in Table 5.5.4.4-1 of GS NFV-SOL 005. It indicates the usage state
      of the resource.IN_USE = The resource is in use.NOT_IN_USE = The resource
472
      is not-in-use.
473
    enum:
474
475
476
      - IN_USE
      - NOT_IN_USE

477
  CreateNsdInfoRequest:
478
    type: object
479
480
    properties:
      userDefinedData:
481
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
482
    description: >
483
484
      This type creates a completely new NS descriptor resource.

485
  PnfdInfoModifications:
486
    type: object
487
    required:
488
      - userDefinedData
489
490
    properties:
      userDefinedData:
491
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
492
    description: >
493
      This type represents attribute modifications for an individual PNF
494
495
      descriptor resource based on the "PnfdInfo" data type. The attributes of
      "PnfdInfo" that can be modified are included in the "PnfdInfoModifications"
496
      data type.
497

498
  PnfdInfo:
499
    type: object
500
    required:
501
502
503
504
      - id
      - pnfdOnboardingState
      - pnfdUsageState
      - _links
505
506
507
508
509
510
    properties:
      id:
        description: >
          Identifier of the on-boarded individual PNF
          descriptor resource. This identifier is allocated by
          the NFVO.
511
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
512
513
514
515
516
517
      pnfdId:
        description: >
          This identifier, which is managed by the PNFD
          designer, identifies the PNFD in a globally unique way.
          It is copied from the PNFD content and shall
          be present after the PNFD content is on-boarded.
518
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
519
520
521
522
523
      pnfdName:
        description: >
          Name of the on-boarded PNFD. This information
          is copied from the PNFD content and shall be
          present after the PNFD content is on-boarded.
524
        type: string
525
      pnfdersion:
526
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
527
528
      pnfdProvider:
        description: >
529
530
          Provider of the on-boarded PNFD. This information is copied from
          the PNFD content and shall be present after the PNFD content is on-boarded.
531
        type: string
532
533
534
535
536
      pnfdInvariantId:
        description: >
          Identifies a PNFD in a version independent
          manner. This attribute is invariant across versions
          of PNFD.
537
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
538
539
540
541
542
543
544
545
546
547
      pnfdOnboardingState:
        description: >
          On-boarding state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdOnboardingStateType"
      onboardingFailureDetails:
        description: >
          Failure details of current on-boarding procedure.
          It shall be present when the
          pnfdOnboardingState attribute is CREATED
          and the uploading or processing fails in the NFVO.
548
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
549
550
551
552
553
554
555
556
      pnfdUsageState:
        description: >
          Usage state of the individual PNF descriptor resource.
        $ref: "#/definitions/PnfdUsageStateType"
      userDefinedData:
        description: >
          User defined data for the individual PNF descriptor resource.
          This attribute can be modified with the PATCH method.
557
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
558
559
      _links:
        required:
560
561
562
          - pnfd_content
          - self
        type: object
563
        description: >
564
          Links to resources related to this resource.
565
566
        properties:
          self:
567
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
568
          pnfd_content:
569
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
570
    description: >
571
      This type represents a response for the query PNFD operation.
572

573
  PnfdOnboardingStateType:
574
    type: string
575
576
577
578
579
580
581
582
583
    description: >
      The enumeration PnfdOnboardingStateType shall comply with the provisions
      defined in Table 5.5.4.6-1 of GS-NFV SOL005. It indicates the on-boarding state
      of the individual PNF descriptor resource.
      CREATED = The PNF descriptor resource is created.
      UPLOADING = The associated PNFD content is being uploaded.
      PROCESSING = The associated PNFD content is being processed, e.g. validation.
      ONBOARDED = The associated PNFD content is on-boarded.
    enum:
584
585
586
587
588
      - CREATED
      - UPLOADING
      - PROCESSING
      - ONBOARDING

589
  PnfdUsageStateType:
590
    type: string
591
    description: >
592
      The enumeration PnfdUsageStateType shall comply with the provisions
593
594
      defined in Table 5.5.4.7-1 of GS NFV-SOL005. It indicates the usage state
      of the resource.IN-USE = The resource is in use.NOT_IN_USE = The resource
595
      is not-in-use.
596
    enum:
597
598
599
      - IN_USE
      - NOT_IN_USE
      -
600
  CreatePnfdInfoRequest:
601
    type: object
602
603
    properties:
      userDefinedData:
604
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
605
606
607
608
    description: >
      User-defined data for the PNF descriptor resource to be created.
      It shall be present when the user defined data is set for
      the individual PNF descriptor resource to be created.
609

610
  NsdmLinks:
611
    type: object
612
    required:
613
614
      - nsdInfo
      - subscription
615
616
    properties:
      nsdInfo:
617
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
618
      subscription:
619
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
620
    description: >
621
622
623
      This type represents the links to resources that an NSD management
      notification can contain.

624
  PnfdmLinks:
625
    type: object
626
    required:
627
628
      - pnfdInfo
      - subscription
629
630
    properties:
      pnfdInfo:
631
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
632
      subscription:
633
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
634
    description: >
635
636
637
      This type represents the links to resources that a PNFD management
      notification can contain.

638
  NsdOnBoardingNotification:
639
    type: object
640
    required:
641
642
643
644
645
646
647
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
648
649
    properties:
      id:
650
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
651
      notificationType:
652
        type: string
653
        description: >
654
655
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingNotification" for this notification type.
656
      subscriptionId:
657
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
658
659
660
      timeStamp:
        description: >
          Date-time of the generation of the notification.
661
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
662
      nsdInfoId:
663
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
664
      nsdId:
665
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
666
667
668
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
669
      This type represents an NSD management notification, which informs
670
671
672
      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 "
673
674
      nsdOnboardingState" attribute of a new NSD has changed to "ONBOARDED".

675
  NsdOnBoardingFailureNotification:
676
    type: object
677
    required:
678
679
680
681
682
683
684
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdInfoId
      - onboardingFailureDetails
      - timeStamp
685
686
    properties:
      id:
687
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
688
      notificationType:
689
        type: string
690
        description: >
691
692
          Discriminator for the different notification types. Shall be
          set to "NsdOnboardingFailureNotification" for this notification type.
693
      subscriptionId:
694
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
695
696
697
      timeStamp:
        description: >
          Date-time of the generation of the notification.
698
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
699
      nsdInfoId:
700
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
701
      nsdId:
702
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
703
      onboardingFailureDetails:
704
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
705
706
707
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
708
      This type represents an NSD management notification, which informs
709
710
711
      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
712
713
      of an NSD has failed.

714
  NsdChangeNotification:
715
    type: object
716
    required:
717
718
719
720
721
722
723
724
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - nsdOperationalState
      - timeStamp
725
726
    properties:
      id:
727
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
728
      notificationType:
729
        type: string
730
        description: >
731
732
          Discriminator for the different notification types. Shall be
          set to "NsdChangeNotification" for this notification type.
733
      subscriptionId:
734
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
735
736
737
      timeStamp:
        description: >
          Date-time of the generation of the notification.
738
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
739
      nsdInfoId:
740
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
741
      nsdId:
742
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
743
744
745
746
747
      nsdOperationalState:
        $ref: "#/definitions/NsdOperationalStateType"
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
748
      This type represents an NSD management notification, which informs
749
750
751
752
753
754
      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
755
756
      "ONBOARDED".

757
  NsdDeletionNotification:
758
    type: object
759
    required:
760
761
762
763
764
765
766
      - _links
      - id
      - notificationType
      - subscriptionId
      - nsdId
      - nsdInfoId
      - timeStamp
767
768
    properties:
      id:
769
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
770
      notificationType:
771
        type: string
772
        description: >
773
774
          Discriminator for the different notification types. Shall be
          set to "NsdDeletionNotification " for this notification type.
775
      subscriptionId:
776
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
777
778
779
      timeStamp:
        description: >
          Date-time of the generation of the notification.
780
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
781
      nsdInfoId:
782
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
783
      nsdId:
784
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
785
786
787
      _links:
        $ref: "#/definitions/NsdmLinks"
    description: >
788
      This type represents an NSD management notification, which informs
789
790
791
      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
792
793
      when it has deleted an on-boarded NSD.

794
  PnfdOnBoardingNotification:
795
    type: object
796
    required:
797
798
799
800
801
802
803
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
804
805
    properties:
      id:
806
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
807
      notificationType:
808
        type: string
809
        description: >
810
811
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingNotification" for this notification type.
812
      subscriptionId:
813
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
814
815
816
      timeStamp:
        description: >
          Date-time of the generation of the notification.
817
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
818
      pnfdInfoId:
819
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
820
      pnfdId:
821
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
822
823
824
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
825
      This type represents a PNFD management notification, which informs
826
827
      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
828
829
      is mandatory. The notification is triggered when a new PNFD is on-boarded.

830
  PnfdOnBoardingFailureNotification:
831
    type: object
832
    required:
833
834
835
836
837
838
839
      - _links
      - id
      - notificationType
      - subscriptionId
      - onboardingFailureDetails
      - pnfdInfoId
      - timeStamp
840
841
    properties:
      id:
842
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
843
      notificationType:
844
        type: string
845
        description: >
846
847
          Discriminator for the different notification types. Shall be
          set to "PnfdOnboardingFailureNotification" for this notification type.
848
      subscriptionId:
849
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
850
851
852
      timeStamp:
        description: >
          Date-time of the generation of the notification.
853
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
854
      pnfdInfoId:
855
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
856
      pnfdId:
857
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
858
      onboardingFailureDetails:
859
        $ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
860
861
862
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
863
      This type represents a PNFD management notification, which informs
864
865
866
      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
867
868
      fails.

869
  PnfdDeletionNotification:
870
    type: object
871
    required:
872
873
874
875
876
877
878
      - _links
      - id
      - notificationType
      - subscriptionId
      - pnfdId
      - pnfdInfoId
      - timeStamp
879
880
    properties:
      id:
881
        type: string
882
        description: >
883
          Identifier of this notification. If a notification is sent multiple
884
          times due to multiple subscriptions, the "id" attribute of all these
885
          notifications shall have the same value.
886
      notificationType:
887
        type: string
888
        description: >
889
890
          Discriminator for the different notification types. Shall be
          set to "PnfdDeletionNotification " for this notification type.
891
      subscriptionId:
892
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
893
894
895
      timeStamp:
        description: >
          Date-time of the generation of the notification.
896
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
897
      pnfdInfoId:
898
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
899
      pnfdId:
900
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
901
902
903
      _links:
        $ref: "#/definitions/PnfdmLinks"
    description: >
904
      This type represents a PNFD management notification, which informs
905
906
907
      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
908
      PNFD is deleted.