SOL005NSLifecycleManagement_def.yaml 125 KB
Newer Older
1
# Copyright (c) ETSI 2017.
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
70
71
72
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
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
  CreateNsRequest:
    type: object
    required:
      - nsdId
      - nsName
      - nsDescription
    properties:
      nsdId:
        description: >
          Identifier of the NSD that defines the NS instance to be
          created.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsName:
        description: >
          Human-readable name of the NS instance to be created.
        type: string
      nsDescription:
        description: >
          Human-readable description of the NS instance to be created.
        type: string
        
  NsInstance:
    description: >
      This type represents a response for Query NS operation. 
      It shall comply with the provisions defined in Table 6.5.2.10-1.
    type: object
    required:
      - id
      - nsInstanceName
      - nsInstanceDescription
      - nsdId
      - nsdInfoId
      - nsState
    properties:
      id:
        description: >
          Identifier of the NS instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsInstanceName:
        description: >
          Human readable name of the NS instance.
        type: string
      nsInstanceDescription:
        description: >
          Human readable description of the NS instance.
        type: string
      nsdId:
        description: >
          Identifier of the NSD on which the NS instance is based.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
          NS instance is based. This identifier was allocated by the NFVO.
        $ref: "SOL005_def.yaml#/definitions/Identifier"         
      flavourId:
        description: >
          Identifier of the NS deployment flavor applied to
          the NS instance. This attribute shall be present if the nsState attribute
          value is INSTANTIATED.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"         
      vnfInstance:
        description: >
          Information on constituent VNF(s) of the NS instance.
        type: array
        items:
          $ref: "#/definitions/VnfInstance"         
      pnfInfo:
        description: >
          Information on the PNF(s) that are part of the NS instance.
        type: array
        items:
          $ref: "#/definitions/PnfInfo" 
      virtualLinkInfo:
        description: >
          Information on the VL(s) of the NS instance.
          This attribute shall be present if the nsState attribute
          value is INSTANTIATED and if the NS instance has
          specified connectivity.
        type: array
        items:
          $ref: "#/definitions/NsVirtualLinkInfo" 
      vnffgInfo:
        description: >
          Information on the VNFFG(s) of the NS instance.
        type: array
        items:
          $ref: "#/definitions/VnffgInfo"        
      sapInfo:
        description: >
          Information on the SAP(s) of the NS instance.
        type: array
        items:           
          $ref: "#/definitions/SapInfo"
      nestedNsInstanceId:
        description: >
          Identifier of the nested NS(s) of the NS instance.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"        
      nsState:
        description: >
          The state of the NS instance.
          Permitted values:
          NOT_INSTANTIATED: The NS instance is
          terminated or not instantiated.
          INSTANTIATED: The NS instance is instantiated.
        type: string
        enum: 
          - NOT_INSTANTIATED
          - INSTANTIATED        
      nsScaleStatus:
        description: >
          Status of each NS scaling aspect declared in the
          applicable DF, how "big" the NS instance has been
          scaled w.r.t. that aspect.
          This attribute shall be present if the nsState attribute
121
          value is INSTANTIATED.
122
123
        type: array
        items:
124
          $ref: "#/definitions/NsScaleInfo"          
125
126
127
128
129
130
131
132
133
134
      additionalAffinityOrAntiAffinityRule:
        description: >
          Information on the additional affinity or anti-affinity
          rule from NS instantiation operation. Shall not
          conflict with rules already specified in the NSD.
        type: array
        items:           
          $ref: "#/definitions/AffinityOrAntiAffinityRule"
      _links:
        type: object
135
        description: Links to resources related to this resource.
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
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
            $ref: "SOL005_def.yaml#/definitions/Link"
          nestedNsInstances:
            description: >
              Links to resources related to this notification.
            type: array
            items:
              $ref: "SOL005_def.yaml#/definitions/Link"             
          instantiate:
            description: >
              Link to the "instantiate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance in
              NOT_INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          terminate:
            description: >
              Link to the "terminate" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          update:
            description: >
              Link to the "update" task resource, if the related
              operation is possible based on the current status of
              this NS instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          scale:
            description: >
              Link to the "scale" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
          heal:
            description: >
              Link to the "heal" task resource, if the related
              operation is supported for this NS instance, and is
              possible based on the current status of this NS
              instance resource (i.e. NS instance is in
              INSTANTIATED state).
            $ref: "SOL005_def.yaml#/definitions/Link"
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
228
229
230
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
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
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
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
393
394
395
396
397
398
399
400
401
402
403
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
431
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
460
461
462
463
464
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
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
  VnfInstance:
    description: >
      This type represents a VNF instance.
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfInstanceName:
        description: >
          Name of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
          This attribute can be modified with the PATCH method.
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfProvider:
        description: >
          Provider of the VNF and the VNFD. The value is copied from the VNFD.
        type: string
      vnfProductName:
        description: >
          Name to identify the VNF Product. The value is copied from the VNFD.
        type: string
      vnfSoftwareVersion:
        description: >
          Software version of the VNF. The value is copied from the VNFD.
        $ref: "#/definitions/Version"
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
        $ref: "#/definitions/Version"
      vnfPkgId:
        description: >
           Identifier of information held by the NFVO about
           the specific VNF package on which the VNF is
           based. This identifier was allocated by the NFVO.
           This attribute can be modified with the PATCH
           method.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfConfigurableProperties:
        description: >
          Current values of the configurable properties of the VNF instance. 
          Configurable properties referred in this attribute are declared in
          the VNFD.
          ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
          based on TOSCA specifications.
          VNF configurable properties are sometimes also referred to as
          configuration parameters applicable to a VNF. Some of these are set
          prior to instantiation and cannot be modified if the VNF is
          instantiated, some are set prior to instantiation (are part of
          initial configuration) and can be modified later, and others can be
          set only after instantiation. The applicability of certain
          configuration may depend on the VNF and the required operation of
          the VNF at a certain point in time.
          These configurable properties include the following standard
          attributes, which are declared in the VNFD if auto-scaling and/or
          auto-healing are supported by the VNF: 
          * isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
          set to true, auto-scaling is currently enabled. If set to false,
          auto-scaling is currently disabled. 
          * isAutohealEnabled: If present, the VNF supports auto-healing. If
          set to true, auto-healing is currently enabled. If set to false,
          auto-healing is currently disabled. 
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      instantiationState:
        description: >
          The instantiation state of the VNF.
        type: string
        enum:
          - NOT_INSTANTIATED
          - INSTANTIATED
      instantiatedVnfInfo:
        description: >
          Information specific to an instantiated VNF instance. This attribute
          shall be present if the instantiateState attribute value is INSTANTIATED.
        type: object
        required:
          - flavourId
          - vnfState
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavor applied to this VNF instance.
            $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
          vnfState:
            description: >
              The state of the VNF instance.
            $ref: "#/definitions/VnfOperationalStateType"
          scaleStatus:
            description: >
              Scale status of the VNF, one entry per aspect. Represents for every
              scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
            type: array
            items:
              $ref: "#/definitions/VnfScaleInfo"
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
            type: array
            minItems: 1
            items:
              type: object
              required:
                - id
                - cpdId
              properties:
                id:
                  description: >
                    Identifier of the external CP instance and the related information instance.
                  $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
                cpdId:
                  description: >
                    Identifier of the external CPD, VnfExtCpd, in the VNFD.
                  $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
                cpProtocolInfo:
                  description: >
                    Network protocol information for this CP.
                  type: array
                  items:
                    $ref: "#/definitions/CpProtocolInfo"
                extLinkPortId:
                  description: >
                    Identifier of the "extLinkPortInfo" structure inside the  the
                    "extVirtualLinkInfo" structure. Shall be present if the CP is
                    associated to a link port.
                  $ref: "SOL005_def.yaml#/definitions/Identifier"           

          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          extManagedVirtualLinkInfo:
            description: >
              External virtual links the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
              Active monitoring parameters.
            type: array
            items:
              $ref: "#/definitions/MonitoringParameter"
          localizationLanguage:
            description: >
              Information about localization language of the VNF (includes e.g.
              strings in the VNFD). The localization languages supported by a VNF
              can be declared in the VNFD, and localization language selection can
              take place at instantiation time.
              The value shall comply with the format defined in IETF RFC 5646.
            type: string
          vnfcResourceInfo:
            description: >
             Information about the virtualised compute and storage resources used
             by the VNFCs of the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VnfcResourceInfo"
          virtualLinkResourceInfo:
            description: >
              Information about the virtualised network resources used by the VLs
              of the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VnfVirtualLinkResourceInfo"
          virtualStorageResourceInfo:
            description: >
              Information on the virtualised storage resource(s) used as storage for the VNF instance.
            type: array
            items:
              $ref: "#/definitions/VirtualStorageResourceInfo"
      metadata:
        description: >
          Additional VNF-specific metadata describing the VNF instance.
          Metadata that are writeable are declared in the VNFD.
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      extensions:
        description: >
          VNF-specific attributes that affect the lifecycle management of this
          VNF instance by the VNFM, or the lifecycle management scripts.
          Extensions that are writeable are declared in the VNFD.
          This attribute can be modified with the PATCH method.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
        
  LccnLinks:
    description: >
      This type represents the links to resources that a notification can contain.
    type: object
    required: 
      - nsInstance
    properties: 
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
        $ref: "SOL005_def.yaml#/definitions/Link"
      subscription:
        description: >
          Link to the subscription that triggered this notification.
        $ref: "SOL005_def.yaml#/definitions/Link"
      lcOpOcc:
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
        $ref: "SOL005_def.yaml#/definitions/Link"
       
  Version:
    description: >
      A Version.
    type: string
  
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
      
  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      scaleLevel:
        description: >
          Indicates the scale level. The minimum value shall be 0 and the
          maximum value shall be <= maxScaleLevel as described in the VNFD.
        type: integer

  PnfInfo:
    description: >
      This type represents the information about a PNF that is part of an NS instance. 
      It shall comply with the provisions
      defined in Table 6.5.3.13-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfdInfoId
      - pnfProfileId
    properties:
      pnfId:
        description: >
          Identifier of the PNF. This identifier is allocated by the OSS/BSS.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"
      
  PnfExtCpInfo:
    description: >
      This type represents the information about the external CP of the PNF. 
      It shall comply with the provisions defined in
      Table 6.5.3.17-1.
    type: object
    required:
      - cpInstanceId
      - cpdId
    properties:
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
        items:            
          $ref: "SOL005_def.yaml#/definitions/CpProtocolData"
            
  NsVirtualLinkInfo:
    description: >
      This type specifies the information about an NS VL instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.53-1
    type: object
    required:
      - id
      - nsVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the VL instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      resourceHandle:
        description: >
          Identifier(s) of the virtualised network resource(s)
          realizing the VL instance. See note.
        type: array
        items:            
          $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      linkPort:
        description: >
          Link ports of the VL instance.
          Cardinality of zero indicates that no port has yet been
          created for the VL instance.
        type: array
        items: 
          $ref: "#/definitions/NsLinkPortInfo"

  VnffgInfo:
    description: >
      Information on the VNFFG(s) of the NS instance.
    type: object
    required:
      - id
      - vnffgdId
      - vnfInstanceId
      - pnfInfoId
    properties:
      id:
        description: >
          Identifier of this VNFFG instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
        items: 
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
        items:            
          $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      nsCpHandle:
        description: >
          Identifiers of the CP instances attached to the
          constituent VNFs and PNFs or the SAP instances of the
          VNFFG. See note.
        type: array
        items:            
          $ref: "#/definitions/NsCpHandle"

  NsCpHandle:
    description: >
      This type represents an identifier of the CP or SAP instance. 
      It shall comply with the provisions defined in
      Table 6.5.3.56-1.
    type: object     
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance associated to the CP instance.
          This attribute shall be present if the CP instance is VNF external CP.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfExtCpInstanceId:
        description: >
          Identifier of the VNF external CP instance in the scope
          of the VNF instance. This attribute shall be present if the CP instance is VNF
          external CP. See notes 1 and 4.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      pnfInfoId:
        description: >
          Identifier of the PNF instance associated to the CP
          instance. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.          
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfExtCpInstanceId:
        description: >
          Identifier of the PNF external CP instance in the scope
          of the PNF. This attribute shall be present if the CP instance is PNF
          external CP. See notes 2 and 4.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
      nsInstanceId:
        description: >
          Identifier of the NS instance associated to the SAP
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsSapInstanceId:
        description: >
          Identifier of the SAP instance in the scope of the NS
          instance. This attribute shall be present if the CP instance is NS
          SAP. See notes 3 and 4.           
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
         
  SapInfo:
    description: >
      This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.
    type: object
    required:
      - id
      - sapdId
      - sapName
      - sapProtocolInfo
    properties:
      id:
        description: >
          Identifier of the SAP instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      sapName:
        description: >
          Human readable name for the SAP instance.
        type: string
      description:
        description: >
          Human readable description for the SAP instance.
        type: string
      sapProtocolInfo:
        description: >
          Network protocol information for this SAP.
        type: array
        items:            
          $ref: "#/definitions/CpProtocolInfo"
         
  CpProtocolInfo:
    description: >
      This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
      addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
    type: object
    required:
      - layerProtocol
      - ipOverEthernet
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s)
          associated to the network address information.
          Permitted values: IP_OVER_ETHERNET See note.
        type: string
        enum:
          - IP_OVER_ETHERNET
      ipOverEthernet:
        description: >
          IP addresses over Ethernet to assign to the CP
          or SAP instance. Shall be present if
          layerProtocol is equal to "
          IP_OVER_ETHERNET", and shall be absent otherwise.
        $ref: "#/definitions/IpOverEthernetAddressInfo"

  IpOverEthernetAddressInfo:
     description: >
        This type represents information about a network address that has been assigned. 
        It shall comply with the provisions defined in Table 6.5.3.18-1.
     type: object
     required:
       - macAddress
       - ipAddresses
       - subnetId
       - addresses
       - addressRange
     properties:
       macAddress:
         description: >
           Assigned MAC address.
         $ref: "SOL005_def.yaml#/definitions/MacAddress"
       ipAddresses:
         description: >
           Addresses assigned to the CP instance. Each entry represents IP
           addresses assigned by fixed or dynamic IP address assignment per
           subnet.
         type: array
         items: 
           type: object
           required: 
             - type
           properties: 
             type:
               description: >
                 The type of the IP addresses.
                 Permitted values: IPV4, IPV6.
               type: string
               enum: 
                 - IPV4
                 - IPV6
             addresses:
               description: >
                 Fixed addresses assigned (from the subnet defined by
                 "subnetId" if provided).
               type: array
               items: 
                 $ref: "SOL005_def.yaml#/definitions/IpAddress"
             isDynamic:
               description: >
                 Indicates whether this set of addresses was assigned
                 dynamically (true) or based on address information provided as
                 input from the API consumer (false). Shall be present if
                 "addresses" is present and shall be absent otherwise.
               type: boolean
             addressRange:
               description: >
                 An IP address range used, e.g., in case of egress connections.
                 Exactly one of "addresses" or "addressRange" shall be present.
               type: object
               required: 
                 - minAddress
                 - maxAddress
               properties:
                 minAddress:
                   description: >
                     Lowest IP address belonging to the range.
                   $ref: "SOL005_def.yaml#/definitions/IpAddress"
                 maxAddress:
                   description: >
                     Highest IP address belonging to the range
                   $ref: "SOL005_def.yaml#/definitions/IpAddress"
             subnetId:
               description: >
                 Subnet defined by the identifier of the subnet resource in
                 the VIM.
                 In case this attribute is present, IP addresses are bound
                 to that subnet.
               $ref: "SOL005_def.yaml#/definitions/IdentifierInVim"
           
           
       type:
         description: >
           The type of the IP addresses
         type: string
         enum:
           - PV4
           - PV6
       addresses:
         description: >
            Fixed addresses assigned (from the subnet
            defined by "subnetId" if provided). See note.
         type: array
         items:            
         $ref: "SOL005_def.yaml#/definitions/IpAddress"
       isDynamic:
         description: >
            Indicates whether this set of addresses was
            assigned dynamically (true) or based on address
            information provided as input from the API
            consumer (false). Shall be present if "addresses"
            is present and shall be absent otherwise.
         type: boolean
       addressRange:
         description: >
            An IP address range used, e.g. in case of egress
            connections. See note.
         type: object
         required: 
           - minAddress
           - maxAddress
         properties:
           minAddress:
             description: >
               Lowest IP address belonging to the range.
             $ref: "SOL005_def.yaml#/definitions/IpAddress"
           maxAddress:
             description: >
               Highest IP address belonging to the range
             $ref: "SOL005_def.yaml#/definitions/IpAddress"
       minAddress:
         description: >
            Lowest IP address belonging to the range
         $ref: "SOL005_def.yaml#/definitions/IpAddress"
       maxAddress:
         description: >
            Highest IP address belonging to the range.      
         $ref: "SOL005_def.yaml#/definitions/IpAddress"     
       subnetId:
         description: >
           Subnet defined by the identifier of the subnet
           resource in the VIM.
           In case this attribute is present, IP addresses
           are bound to that subnet.           
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVim"
         
  ExtVirtualLinkInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
         description: >
           Identifier of the external VL and the related external VL
           information instance.
           The identifier is assigned by the NFV-MANO entity that manages this
           VL instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the resource realizing this VL.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      extLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/ExtLinkPortInfo"

  ExtLinkPortInfo:
    description: >
      This type represents information about a link port of an external VL,
      i.e. a port providing connectivity for the VNF to an NS VL. 
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has
          created the link port.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      resourceHandle:
        description: >
          Reference to the virtualised resource realizing this link port.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          Identifier of the external CP of the VNF connected to this link
          port. There shall be at most one link port associated with any
          external connection point instance. The value refers to an
          "extCpInfo" item in the VnfInstance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"

  ExtManagedVirtualLinkInfo:
    type: object
    required:
      - id
      - vnfVirtualLinkDescId
    properties:
      id:
        description: >
          Identifier of the externally-managed internal VL and the related
          externally-managed VL information instance.
          The identifier is assigned by the NFV-MANO entity that manages this
          VL instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfVirtualLinkDescId:
        description: >
          Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      networkResource:
        description: >
          Reference to the VirtualNetwork resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      vnfLinkPorts:
        description: >
          Link ports of this VL.
        type: array
        items:
          $ref: "#/definitions/VnfLinkPortInfo"

  VnfLinkPortInfo:
    type: object
    required:
      - id
      - resourceHandle
    properties:
      id:
        description: >
          Identifier of this link port as provided by the entity that has created the link port.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      resourceHandle:
        description: >
          Reference to the virtualised network resource realizing this link port.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      cpInstanceId:
        description: >
          When the link port is used for external connectivity by the VNF,
          this attribute represents the identifier of the external CP of the
          VNF to be connected to this link port.
          When the link port is used for internal connectivity in the VNF,
          this attribute represents the VNFC CP to be connected to this link
          port.
          Shall be present when the link port is used for external
          connectivity by the VNF.
          may be present if used to reference a VNFC CP instance.
          There shall be at most one link port associated with any external
          connection point instance or internal connection point
          (i.e. VNFC CP) instance.
          The value refers to an "extCpInfo" item in the VnfInstance or a
          "vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"

  MonitoringParameter:
    type: object
    required:
      - id
      - value
      - timeStamp
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        type: string
      value:
        description: >
          Value of the monitoring parameter known to the VNFM (e.g. obtained
951
          for auto-scaling purposes).
952
953
954
955
          The type of the "value" attribute (i.e. scalar, structure (Object in
          JSON), or array (of scalars, arrays or structures/Objects)) is
          assumed to be defined in an external measurement specification.
        type: object
956
957
958
959
960
961
      timeStamp:
        description: >
          Represents the point in time when the measurement has been performed,
          as known to the VNFM.
          Should be formatted according to ETF RFC 3339.
        type: string
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
1097
1098
1099
1100
1101
1102
1103
1104
1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
1205
1206
1207
1208
1209
1210
1211
1212
1213
1214
1215
1216
1217
1218
1219
1220
1221
1222
1223
1224
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
1246
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
1318
1319
1320
1321
1322
1323
1324
1325
1326
1327
1328
1329
1330
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
1371
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
1403
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
1434
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463

  VnfcResourceInfo:
    description: >
      This type represents the information on virtualised compute and storage
      resources used by a VNFC in a VNF instance.
    type: object
    required:
      - id
      - vduId
      - computeResource
    properties:
      id:
        description: >
          Identifier of this VnfcResourceInfo instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      vduId:
        description: >
          Reference to the applicable VDU in the VNFD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      computeResource:
        description: >
          Reference to the VirtualCompute resource.
        $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
      storageResourceIds:
        description: >
          References to the VirtualStorage resources. The value refers to a
          VirtualStorageResourceInfo item in the VnfInstance.
        type: array
        items:
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      reservationId:
        description: >
          The reservation identifier applicable to the resource. It shall be
          present when an applicable reservation exists.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfcCpInfo:
        description: >
          CPs of the VNFC instance.
          Shall be present when that particular CP of the VNFC instance is
          associated to an external CP of the VNF instance.
          May be present otherwise.
        type: array
        items:
          type: object
          required:
            - id
            - cpdId
          properties:
            id:
              description: >
                Identifier of this VNFC CP instance and the associated array
                entry.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
            cpdId:
              description: >
                Identifier of the VDU CPD, cpdId, in the VNFD.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
            vnfExtCpId:
              description: >
                When the VNFC CP is exposed as external CP of the VNF, the
                identifier of this external VNF CP.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
            cpProtocolInfo:
              description: >
                Network protocol information for this CP.
              type: array
              items:
                $ref: "#/definitions/CpProtocolInfo"
            vnfLinkPortId:
              description: >
                Identifier of the "vnfLinkPorts" structure in the
                "vnfVirtualLinkResourceInfo" structure. Shall be present if
                the CP is associated to a link port.
              $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
      metadata:
        description: >
          Metadata about this resource.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  VnfVirtualLinkResourceInfo:
     description: >
       This type represents the information that allows addressing a virtualised
       resource that is used by an internal VL instance in a VNF instance.
     type: object
     required:
       - id
       - vnfVirtualLinkDescId
       - networkResource
     properties:
       id:
         description: >
           Identifier of this VnfVirtualLinkResourceInfo instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
       vnfVirtualLinkDescId:
         description: >
           Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       networkResource:
         description: >
           Reference to the VirtualNetwork resource.
         $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
       reservationId:
         description: >
           The reservation identifier applicable to the resource. It shall be
           present when an applicable reservation exists.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       vnfLinkPorts:
         description: >
           Links ports of this VL.
           Shall be present when the linkPort is used for external connectivity
           by the VNF (refer to VnfLinkPortInfo).
           May be present otherwise.
         type: array
         items:
           $ref: "#/definitions/VnfLinkPortInfo"
       metadata:
         description: >
           Metadata about this resource.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  VirtualStorageResourceInfo:
     description: >
       This type represents the information that allows addressing a virtualised
       resource that is used by a VNF instance.
     type: object
     required:
       - id
       - virtualStorageDescId
       - storageResource
     properties:
       id:
         description: >
           Identifier of this VirtualStorageResourceInfo instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
       virtualStorageDescId:
         description: >
           Identifier of the VirtualStorageDesc in the VNFD.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       storageResource:
         description: >
           Reference to the VirtualStorage resource.
         $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
       reservationId:
         description: >
           The reservation identifier applicable to the resource. It shall be
           present when an applicable reservation exists.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       metadata:
         description: >
           Metadata about this resource.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  NsLinkPortInfo:
     description: >
        This type represents information about a link port of a VL instance. 
        It shall comply with the provisions defined in Table 6.5.3.55-1.
     type: object
     required:
       - id
       - resourceHandle
     properties:
       id:
         description: >
           Identifier of this link port as provided by the entity that
           has created the link port.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       resourceHandle:
         description: >
           Identifier of the virtualised network resource realizing
           this link port.
         $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
       nsCpHandle:
         description: >
            Identifier of the CP/SAP instance to be connected to this
            link port. The value refers to a vnfExtCpInfo item in the
            VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
            sapInfo item in the NS instance.
            There shall be at most one link port associated with any
            connection point instance.
         type: array
         items:           
           $ref: "#/definitions/NsCpHandle"
           
  AffinityOrAntiAffinityRule:
     description: >
        This type describes the additional affinity or anti-affinity rule 
        applicable between the VNF instances to be instantiated
        in the NS instantiation operation request or between the VNF instances 
        to be instantiated in the NS instantiation
        operation request and the existing VNF instances..
     type: object
     required:
       - affinityOrAntiAffiinty
       - scope 
     properties:
       vnfdId:
         description: >
            Reference to a VNFD.
            When the VNFD which is not used to instantiate VNF, it
            presents all VNF instances of this type as the subjects
            of the affinity or anti-affinity rule. The VNF instance
            which the VNFD presents is not necessary as a part of
            the NS to be instantiated.
         type: array
         items:            
           $ref: "SOL005_def.yaml#/definitions/Identifier"         
       vnfProfileId:
         description: >
           Reference to a vnfProfile defined in the NSD.
           At least one VnfProfile which is used to instantiate VNF
           for the NS to be instantiated as the subject of the affinity
           or anti-affinity rule shall be present. When the VnfProfile
           which is not used to instantiate VNF, it presents all VNF
           instances of this type as the subjects of the affinity or
           anti-affinity rule. The VNF instance which the VnfProfile
           presents is not necessary as a part of the NS to be instantiated.
         type: array
         items:            
           $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"          
       vnfInstanceId:
         description: >
           Reference to the existing VNF instance as the subject of
           the affinity or anti-affinity rule. The existing VNF instance
           is not necessary as a part of the NS to be instantiated.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/Identifier"
       affinityOrAntiAffiinty:
         description: >
           The type of the constraint.
           Permitted values:
           AFFINITY
           ANTI_AFFINITY.
         type: string
         enum: 
           - AFFINITY
           - ANTI_AFFINITY
       scope:
         description: >
           Specifies the scope of the rule where the placement
           constraint applies.
           Permitted values:
           NFVI_POP
           ZONE
           ZONE_GROUP
           NFVI_NODE.
         type: string
         enum: 
           - NFVI_POP
           - ZONE
           - ZONE_GROUP
           - NFVI_NODE         

  InstantiateNsRequest:
    type: object
    required:
      - nsFlavourId    
    properties:
      nsFlavourId:
        description: >
          Identifier of the NS deployment flavor to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      sapData:
        description: >
           Create data concerning the SAPs of this NS.
        type: array
        items:           
          $ref: "#/definitions/SapData" 
      addpnfData:
        description: >
          Information on the PNF(s) that are part of this NS.
        type: array
        items:           
          $ref: "#/definitions/AddPnfData"        
      vnfInstanceData:
        description: >
          Specify an existing VNF instance to be used in the NS.
          If needed, the VNF Profile to be used for this VNF
          instance is also provided.
        type: array
        items:           
          $ref: "#/definitions/VnfInstanceData"
      nestedNsInstanceId:
        description: >
          Specify an existing NS instance to be used as a nested
          NS within the NS.
        type: array
        items:                     
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      localizationLanguage:
        description: >
          Defines the location constraints for the VNF to be
          instantiated as part of the NS instantiation.
          An example can be a constraint for the VNF to be in a
          specific geographic location..
        type: array
        items:           
          $ref: "#/definitions/VnfLocationConstraint"        
      additionalParamsForNs:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          at the NS level (as opposed to the VNF level, which is
          covered in additionalParamsForVnf)..
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
      additionalParamsForVnf:
        description: >
          Allows the OSS/BSS to provide additional parameter(s)
          per VNF instance (as opposed to the NS level, which is
          covered in additionalParamsForNs). This is for VNFs
          that are to be created by the NFVO as part of the NS
          instantiation and not for existing VNF that are
          referenced for reuse..
        type: array
        items:           
          $ref: "#/definitions/ParamsForVnf"          
      startTime:
        description: >
          Timestamp indicating the earliest time to instantiate the NS. 
          Cardinality "0" indicates the NS instantiation takes place immediately.
        $ref: "SOL005_def.yaml#/definitions/DateTime"
      nsInstantiationLevelId:
        description: >
          Identifies one of the NS instantiation levels declared in
          the DF applicable to this NS instance. If not present, the
          default NS instantiation level as declared in the NSD
          shall be used.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"   
      additionalAffinityOrAntiAffiniityRule:
        description: >
            Specifies additional affinity or anti-affinity constraint for
            the VNF instances to be instantiated as part of the NS
            instantiation.
            Shall not conflict with rules already specified in the NSD.
        type: array
        items:           
          $ref: "#/definitions/AffinityOrAntiAffinityRule"

  ParamsForVnf:
     description: >
        This type defines the additional parameters for the VNF instance 
        to be created associated with an NS instance. 
        It shall comply with the provisions defined in Table 6.5.3.22-1.
     type: object
     required:
       - vnfProfileId
     properties:
       vnfProfileId:
         description: >
           Identifier of (reference to) a vnfProfile to which the
           additional parameters apply.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       additionalParams:
         description: >
           Additional parameters that are applied for the VNF
           instance to be created.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  LocationConstraints:
     description: >
       This type represents location constraints for a VNF to be instantiated. 
       The location constraints shall be presented as a
       country code, optionally followed by a civic address based on 
       the format defined by IETF RFC 4776 [13].
     type: object
     required:
       - countryCode
     properties:
       countryCode:
         description: >
           The two-letter ISO 3166 [29] country code in capital letters.
         type: string
       civicAddressElement:
         description: >
           Zero or more elements comprising the civic address.
         type: array
         items:
           type: object
           required:
             - caType
             - caValue        
           properties:
             caType:
               description: >
                 Describe the content type of caValue. The value of
                 caType shall comply with Section 3.4 of IETF
                 RFC 4776 [13].
               type: integer
             caValue:
               description: >
                 Content of civic address element corresponding to the
                 caType. The format caValue shall comply with
                 Section 3.4 of IETF RFC 4776 [13].
               type: string
         
  VnfLocationConstraint:
     description: >
       This type represents the association of location constraints to a VNF instance 
       to be created according to a specific VNF profile. 
       It shall comply with the provisions defined in Table 6.5.3.20-1.
     type: object
     required:
       - vnfProfileId
     properties:
       vnfProfileId:
         description: >
           Identifier of (reference to) a vnfProfile to which the
           additional parameters apply.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       locationConstraints:
         description: >
           Defines the location constraints for the VNF instance to
           be created based on the VNF profile.
         $ref: "#/definitions/LocationConstraints"

  VnfInstanceData:
     description: >
       This type specifies an existing VNF instance to be used in the NS instance and 
       if needed, the VNF Profile to use for this VNF instance. 
       It shall comply with the provisions defined in Table 6.5.3.19-1.
     type: object
     required:
       - vnfInstanceId
       - vnfProfileId       
     properties:
       vnfInstanceId:
         description: >
           Identifier of the existing VNF instance to be used in the NS.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       vnfProfileId:
         description: >
           Identifier of (Reference to) a vnfProfile defined in the
           NSD which the existing VNF instance shall be matched
           with. If not present, the NFVO will select the VnfProfile
           matching the information in the VNF instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
         
  SapData:
     description: >
        This type represents the information related to a SAP of a NS. 
        It shall comply with the provisions defined in Table 6.5.3.10-1.
     type: object
     required:
       - sapdId
       - sapName
       - description
     properties:
       sapdId:
         description: >
           Reference to the SAPD for this SAP.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       sapName:
         description: >
           Human readable name for the SAP.
         type: string
       description:
         description: >
           Human readable description for the SAP.
         type: string
       sapProtocolData:
        description: >
          Parameters for configuring the network protocols on the SAP.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/CpProtocolData" 

  ScaleNsRequest:
     description: >
       This type represents a request for the scale NS operation.       
     type: object
     required:
       - scaleType
     properties:
       scaleType:
         description: >
           Indicates the type of scaling to be performed.
           Possible values:
           - SCALE_NS
           - SCALE_VNF
         type: string
         enum: 
           - SCALE_NS
           - SCALE_VNF
       scaleNsData:
         description: >
           The necessary information to scale the referenced NS instance.
           It shall be present when scaleType = SCALE_NS.
         $ref: "#/definitions/ScaleNsData"
       scaleVnfData:
         description: >
           The necessary information to scale the referenced NS instance.
           It shall be present when scaleType = SCALE_VNF.
         type: array
         items:
           $ref: "#/definitions/ScaleVnfData"
       scaleTime:
         description: >
          Timestamp indicating the scale time of the NS, i.e. the
          NS will be scaled at this timestamp. Cardinality "0"
          indicates the NS scaling takes place immediately".
         $ref: "SOL005_def.yaml#/definitions/DateTime"
         
  UpdateNsRequest:
1464
    description: >
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
1503
1504
1505
1506
1507
1508
1509
1510
1511
1512
1513
1514
1515
1516
1517
1518
1519
1520
1521
1522
1523
1524
1525
1526
1527
1528
1529
1530
1531
1532
1533
1534
1535
1536
1537
1538
1539
1540
1541
1542
1543
1544
1545
1546
1547
1548
1549
1550
1551
1552
1553
1554
1555
1556
1557
1558
1559
1560
1561
1562
1563
1564
1565
1566
1567
1568
1569
1570
1571
1572
1573
1574
1575
1576
1577
1578
1579
1580
1581
1582
1583
1584
1585
1586
1587
1588
1589
1590
1591
1592
1593
1594
1595
1596
1597
1598
1599
1600
1601
1602
1603
1604
1605
1606
1607
1608
1609
1610
1611
1612
1613
1614
1615
1616
1617
1618
1619
1620
1621
1622
1623
1624
1625
1626
1627
1628
1629
1630
1631
1632
1633
1634
1635
1636
1637
1638
1639
1640
1641
1642
1643
1644
1645
1646
1647
1648
1649
1650
1651
1652
1653
1654
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
1691
1692
1693
1694
1695
1696
1697
1698
1699
1700
1701
1702
1703
1704
1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
1754
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
1777
1778
1779
1780
1781
1782
1783
1784
1785
1786
1787
1788
1789
1790
1791
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
1861
1862
1863
1864
1865
1866
1867
1868
1869
1870
1871
1872
1873
1874
1875
1876
1877
1878
1879
1880
1881
1882
1883
1884
1885
1886
1887
1888
1889
1890
1891
1892
1893
1894
1895
1896
1897
1898
1899
1900
1901
1902
1903
1904
1905
1906
1907
1908
1909
1910
1911
1912
1913
1914
1915
1916
1917
1918
1919
1920
1921
1922
1923
1924
1925
1926
1927
1928
1929
1930
1931
1932
1933
1934
1935
1936
1937
1938
1939
1940
1941
1942
1943
1944
1945
1946
1947
1948
1949
1950
1951
1952
1953
1954
1955
1956
1957
1958
1959
1960
1961
1962
1963
1964
1965
1966
1967
1968
1969
1970
1971
1972
1973
1974
1975
1976
1977
1978
1979
1980
1981
1982
1983
1984
1985
1986
1987
1988
1989
1990
1991
1992
1993
1994
1995
1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
2025
2026
2027
2028
2029
2030
2031
2032
2033
2034
2035
2036
2037
2038
2039
2040
2041
2042
2043
2044
2045
2046
2047
2048
2049
2050
2051
2052
2053
2054
2055
2056
2057
2058
2059
2060
2061
2062
2063
2064
2065
2066
2067
2068
2069
2070
2071
2072
2073
2074
2075
2076
2077
2078
2079
2080
2081
2082
2083
2084
2085
2086
2087
2088
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
2395
2396
2397
2398
2399
2400
2401
2402
2403
2404
2405
2406
2407
2408
2409
2410
2411
      This operation supports the update of a NS instance, 
      It shall comply with the provisions defined in Table 6.5.2.12-1.
    type: object
    required:
      - updateType
    properties:
      updateType:
        description: >
          The type of update. It determines also which one of the
          following parameters is present in the operation.
          Possible values include:
          * ADD_VNF: Adding existing VNF instance(s)
          * REMOVE_VNF: Removing VNF instance(s)
          * INSTANTIATE_VNF: Instantiating new VNF(s)
          * CHANGE_VNF_DF: Changing VNF DF
          * OPERATE_VNF: Changing VNF state,
          * MODIFY_VNF_INFORMATION: Modifying
          VNF information and/or the configurable
          properties of VNF instance(s)
          * CHANGE_EXTERNAL_VNF_CONNECTIVITY:
          Changing the external connectivity of VNF
          instance(s)ADD_SAP: Adding SAP(s)
          * REMOVE_SAP: Removing SAP(s)
          * ADD_NESTED_NS: Adding existing NS
          instance(s) as nested NS(s)
          * REMOVE_NESTED_NS: Removing existing
          nested NS instance(s)
          * ASSOC_NEW_NSD_VERSION: Associating a
          new NSD version to the NS instance
          * MOVE_VNF: Moving VNF instance(s) from one
          origin NS instance to another target NS
          instance
          * ADD_VNFFG: Adding VNFFG(s)
          * REMOVE_VNFFG: Removing VNFFG(s)
          * UPDATE_VNFFG: Updating VNFFG(s)
          * CHANGE_NS_DF: Changing NS DF
          * ADD_PNF: Adding PNF
          * MODIFY_PNF: Modifying PNF
          * REMOVE_PNF: Removing PNF
        type: string
        enum: 
          - ADD_VNF
          - REMOVE_VNF
          - INSTANTIATE_VNF
          - CHANGE_VNF_DF
          - OPERATE_VNF
          - MODIFY_VNF_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
          - REMOVE_SAP
          - ADD_NESTED_NS
          - REMOVE_NESTED_NS
          - ASSOC_NEW_NSD_VERSION
          - MOVE_VNF
          - ADD_VNFFG
          - REMOVE_VNFFG 
          - UPDATE_VNFFG 
          - CHANGE_NS_DF 
          - ADD_PNF 
          - MODIFY_PNF 
          - REMOVE_PNF            
      addVnfIstance:
        description: >
          Identifies an existing VNF instance to be added to the
          NS instance. It shall be present only if updateType = "ADD_VNF".         
        type: array
        items:           
          $ref: "#/definitions/VnfInstanceData"
      removeVnfInstanceId:
        description: >
          Identifies an existing VNF instance to be removed from
          the NS instance. It contains the identifier(s) of the VNF
          instances to be removed. It shall be present only if
          updateType = "REMOVE_VNF." Note: If a VNF instance
          is removed from a NS and this NS was the last one for
          which this VNF instance was a part, the VNF instance is
          terminated by the NFVO.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"           
      instantiateVnfData:
        description: >
          Identifies the new VNF to be instantiated. It can be used
          e.g. for the bottom-up NS creation. It shall be present
          only if updateType = "INSTANTIATE_VNF".
        type: array
        items:           
          $ref: "#/definitions/InstantiateVnfData"         
      changeVnfFlavourData:
        description: >
          Identifies the new DF of the VNF instance to be
          changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
        type: array
        items:           
          $ref: "#/definitions/ChangeVnfFlavourData"  
      operateVnfData:
        description: >
          Identifies the state of the VNF instance to be changed. 
          It shall be present only if updateType = "OPERATE_VNF".
        type: array
        items:           
          $ref: "#/definitions/OperateVnfData"      
      modifyVnfInfoData:
        description: >
          Identifies the VNF information parameters and/or the
          configurable properties of VNF instance to be modified.
          It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
        type: array
        items:           
          $ref: "#/definitions/ModifyVnfInfoData"
      changeExtVnfConnectivityData:
        description: >
          Specifies the new external connectivity data of the VNF
          instance to be changed. It shall be present only if
          updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
        type: array
        items:           
          $ref: "#/definitions/ChangeExtVnfConnectivityData" 
      addSap:
        description: >
          Identifies a new SAP to be added to the NS instance.
          It shall be present only if updateType = "ADD_SAP."
        type: array
        items:           
          $ref: "#/definitions/SapData" 
      removeSapId:
        description: >
          The identifier an existing SAP to be removed from the
          NS instance. It shall be present only if updateType = "REMOVE_SAP."
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      addNestedNsId:
        description: >
          The identifier of an existing nested NS instance to be
          added to (nested within) the NS instance. It shall be
          present only if updateType = "ADD_NESTED_NS".
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      removeNestedNsId:
         description: >
           The identifier of an existing nested NS instance to be
           removed from the NS instance. It shall be present only if
           updateType = "REMOVE_NESTED_NS".
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      assocNewNsdVersionData:
        description: >
          Specify the new NSD to be used for the NS instance. It
          shall be present only if updateType =
          ASSOC_NEW_NSD_VERSION".
        $ref: "#/definitions/AssocNewNsdVersionData"
      moveVnfInstanceData:
        description: >
          Specify existing VNF instance to be moved from one NS
          instance to another NS instance. It shall be present only
          if updateType = MOVE_VNF".
        type: array
        items:           
          $ref: "#/definitions/MoveVnfInstanceData" 
      addVnffg:
        description: >
          Specify the new VNFFG to be created to the NS
          Instance. It shall be present only if updateType =
          "ADD_VNFFG".
        type: array
        items:           
          $ref: "#/definitions/AddVnffgData" 
      removeVnffgId:
        description: >
          Identifier of an existing VNFFG to be removed from the
          NS Instance. It shall be present only if updateType =
          "REMOVE_VNFFG".
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier"
      updateVnffg:
        description: >
          Specify the new VNFFG Information data to be updated
          for a VNFFG of the NS Instance. It shall be present only
          if updateType = "UPDATE_VNFFG".
        type: array
        items:           
          $ref: "#/definitions/UpdateVnffgData" 
      changeNsFlavourData:
        description: >
          Specifies the new DF to be applied to the NS instance. It
          shall be present only if updateType =
          "CHANGE_NS_DF".
        $ref: "#/definitions/ChangeNsFlavourData" 
      addPnfData:
        description: >
          specifies the PNF to be added into the NS instance. 
          It shall be present only if updateType = "ADD_PNF".
        type: array
        items:           
          $ref: "#/definitions/AddPnfData" 
      modifyPnfData:
        description: >
          Specifies the PNF to be modified in the NS instance. 
          It shall be present only if updateType = "MODIFY_PNF".
        type: array
        items:           
          $ref: "#/definitions/ModifyPnfData" 
      removePnfId:
        description: >
          Identifier of the PNF to be deleted from the NS instance.
          It shall be present only if updateType = "REMOVE_PNF".
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/Identifier" 
      updateTime:
        description: >
          Timestamp indicating the update time of the NS, i.e. the
          NS will be updated at this timestamp. Cardinality "0"
          indicates the NS update takes place immediately.
        $ref: "SOL005_def.yaml#/definitions/DateTime"         
  InstantiateVnfData:
    description: >
      This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
      parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
      the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
      update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the
      provisions defined in Table 6.5.3.24-1.
    type: object
    required:
      - vnfdId
      - vnfFlavourId    
    properties:
      vnfdId:
        description: >
          Information sufficient to identify the VNFD which defines
          the VNF to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfFlavourId:
        description: >
          Identifier of the VNF deployment flavor to be instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
      vnfInstantiationLevelId:
        description: >
          Identifier of the instantiation level of the deployment
          flavor to be instantiated. If not present, the default
          instantiation level as declared in the VNFD is
          instantiated.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd" 
      vnfInstanceName:
        description: >
          Human-readable name of the VNF instance to be created.
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance to be created.
        type: string
      extVirtualLinks:
        description: >
          Information about external VLs to connect the VNF to.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
      extManagedVirtualLinks:
        description: >
          Information about internal VLs that are managed by other entities than the VNFM.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData"   
      localizationLanguage:
        description: >
          Localization language of the VNF to be instantiated.
          The value shall comply with the format defined in IETF RFC 5646 [16].
        type: string
      additionalParams:
        description: >
          Additional input parameters for the instantiation process,
          specific to the VNF being instantiated.
        $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  ChangeVnfFlavourData:
     description: >
       The type represents the information that is requested to be changed 
       deployment flavor for an existing VNF instance. 
       It shall comply with the provisions defined in Table 6.5.3.25-1.
     type: object
     required:
       - vnfInstanceId
       - newFlavourId
     properties:
       vnfInstanceId:
         description: >
           Identifier of the VNF instance to be modified.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       newFlavourId:
         description: >
           Identifier of the VNF deployment flavor to be instantiated.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       instantiationLevelId:
         description: >
           Identifier of the instantiation level of the deployment
           flavor to be instantiated. If not present, the default
           instantiation level as declared in the VNFD is
           instantiated.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       extVirtualLinks:
         description: >
           Information about external VLs to connect the VNF to.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData" 
       extManagedVirtualLinks:
         description: >
           information about internal VLs that are managed by NFVO.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData"
       additionalParams:
         description: >
           Additional input parameters for the flavor change
           process, specific to the VNF being modified, as declared
           in the VNFD as part of "ChangeVnfFlavourOpConfig".
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  OperateVnfData:
    description: >
      This type represents a VNF instance for which the operational state 
      needs to be changed and the requested new state. It
      shall comply with the provisions defined in Table 6.5.3.31-1.
    type: object
    required:
      - vnfInstanceId
      - changeStateTo
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      changeStateTo:
        description: >
          The desired operational state (i.e. started or stopped)
          to change the VNF to.
        $ref: "#/definitions/OperationalStates"
      stopType:
        description: >
          It signals whether forceful or graceful stop is requested.           
        $ref: "#/definitions/StopType"
      gracefulStopTimeout:
        description: >
          The time interval (in seconds) to wait for the VNF to be
          taken out of service during graceful stop, before
          stopping the VNF.
        type: integer
         
  OperationalStates:
     description: >
       STARTED - The VNF instance is up and running.
       STOPPED - The VNF instance has been shut down.
     type: string
     enum:
       - STARTED
       - STOPPED
  StopType:
     description: >
       * FORCEFUL: The VNFM will stop the VNF immediately after accepting the
         request.
       * GRACEFUL: The VNFM will first arrange to take the VNF out of service
         after accepting the request. Once that operation is successful or once
         the timer value specified in the "gracefulStopTimeout" attribute
         expires, the VNFM will stop the VNF.
     type: string
     enum:
       - FORCEFUL
       - GRACEFUL

  ModifyVnfInfoData:
     description: >
       This type represents the information that is requested to be modified for a VNF instance. The information to be
       modified shall comply with the associated NSD.
       EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
       matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
     type: object
     required:
       - vnfInstanceId
     properties:
       vnfInstanceId:
         description: >
           Identifier of the VNF instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       vnfInstanceName:
         description: >
           New value of the "vnfInstanceName" attribute in
           "VnfInstance", or "null" to remove the attribute.
         type: string
       vnfInstanceDescription:
         description: >
           New value of the "vnfInstanceDescription" attribute in "VnfInstance",
           or "null" to remove the attribute.
         type: string
       vnfPkgId:
         description: >
           New value of the "vnfPkgId" attribute in "VnfInstance".
           The value "null" is not permitted
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       vnfConfigurableProperties:
         description: >
           Modifications to entries in the
           "vnfConfigurableProperties" list, as defined below this Table.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
       Metadata:
         description: >
           Modifications to entries in the "metadata" list, as
           defined below this Table.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
       Extensions:
         description: >
           Modifications to entries in the "extensions" list, as
           defined below this Table.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  ChangeExtVnfConnectivityData:
     description: >
       This type describes the information invoked by the NFVO to change the external VNF connectivity information
       maintained by the VNFM. The types of changes that this operation supports are:
       1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
       external VL.
       2) Change the connectivity parameters of the existing external CPs, including changing addresses.
       NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP
       address assignment) might not be supported without deleting the resource and creating another one with
       the modified configuration.
       This type shall comply with the provisions defined in Table 6.5.3.33-1.
     type: object
     required:
       - vnfInstanceId
       - extVirtualLink
     properties:
       vnfInstanceId:
         description: >
           Identifier of the VNF instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       extVirtualLink:
         description: >
           Information about external VLs to change (e.g. connect the VNF to).
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
       additionalParams:
         description: >
           Additional parameters passed by the OSS as input to
           the external connectivity change process, specific to the
           VNF instance being changed.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  AssocNewNsdVersionData:
     description: >
       This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
       updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
       Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
       nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
       NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
       data type shall comply with the provisions defined in Table 6.5.3.34-1.
     type: object
     required:
       - newNsdId
     properties:
       newNsdId:
         description: >
           Identifier of the new NSD version that is to be
           associated to the NS instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       sync:
         description: >
           Specify whether the NS instance shall be automatically
           synchronized to the new NSD by the NFVO (in case of
           true value) or the NFVO shall not do any action (in case
           of a false value) and wait for further guidance from
           OSS/BSS (i.e. waiting for OSS/BSS to issue NS
           lifecycle management operation to explicitly add/remove
           VNFs and modify information of VNF instances
           according to the new NSD).
           The synchronization to the new NSD means e.g.
           instantiating/adding those VNFs whose VNFD is
           referenced by the new NSD version but not referenced
           by the old one, terminating/removing those VNFs whose
           VNFD is referenced by the old NSD version but not
           referenced by the new NSD version, modifying
           information of VNF instances to the new applicable
           VNFD provided in the new NSD version.
           A cardinality of 0 indicates that synchronization shall not be done.
         type: boolean
         
  MoveVnfInstanceData:
     description: >
       This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
       (destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
       NS instance is specified in this data type (referred to targetNsInstanceId). 
       It shall comply with the provisions defined in Table 6.5.3.35-1.
     type: object
     required:
       - targetNsInstanceId
     properties:
       targetNsInstanceId:
         description: >
           Specify the target NS instance where the VNF instances
           are moved to.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       vnfInstanceId:
         description: >
           Specify the VNF instance that is moved.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/Identifier"
           
  AddVnffgData:
     description: >
       This type specifies the parameters used for the creation of a new VNFFG instance. 
       It shall comply with the provisions defined in Table 6.5.3.36-1.
     type: object
     required:
       - vnffgdId
       - vnffgName
       - description       
     properties:
       targetNsInstanceId:
         description: >
           Identifier of the VNFFGD used to create this VNFFG
           instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       vnffgName:
         description: >
           Human readable name for the VNFFG.
         type: string
       description:
         description: >
           Human readable description for the VNFFG.
         type: string
         
  UpdateVnffgData:
     description: >
       This type specifies the parameters used for the update of an existing VNFFG instance. 
       It shall comply with the provisions defined in Table 6.5.3.37-1.
     type: object
     required:
       - vnffgInfoId
     properties:
       vnffgInfoId:
         description: >
           Identifier of an existing VNFFG to be updated for the NS Instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
       nfp:
         description: >
           Indicate the desired new NFP(s) for a given VNFFG
           after the operations of addition/removal of NS
           components (e.g. VNFs, VLs, etc.) have been
           completed, or indicate the updated or newly created
           NFP classification and selection rule which applied to an existing NFP.
         type: array
         items:           
           $ref: "#/definitions/NfpData"
       nfpInfoId:
         description: >
           Identifier(s) of the NFP to be deleted from a given VNFFG.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"

  NfpData:
     description: >
       This type contains information used to create or modify NFP instance parameters 
       for the update of an existing VNFFG instance. 
       It shall comply with the provisions defined in Table 6.5.3.38-1.
     type: object      
     properties:
       nfpInfoId:
         description: >
           Identifier of the NFP to be modified. It shall be present
           for modified NFPs and shall be absent for the new NFP.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
       nfpName:
         description: >
           Human readable name for the NFP. It shall be present
           for the new NFP, and it may be present otherwise.
         type: string
       description:
         description: >
           Human readable description for the NFP. It shall be
           present for the new NFP, and it may be present otherwise.
         type: string
       nsCpHandle:
         description: >
           Identifier(s) of the CPs and SAPs which the NFP passes by. 
           Cardinality can be 0 if only updated or newly created
           NFP classification and selection rule which applied to an
           existing NFP is provided.
         type: array
         items:           
           $ref: "#/definitions/NsCpHandle"
       nfpRule:
         description: >
           NFP classification and selection rule. See note 1.
         $ref: "#/definitions/NfpRule"

  NfpRule:
     description: >
       The NfpRule data type is an expression of the conditions that shall be met 
       in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and 
       it is met only if all the values expressed in the condition are matched
       by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
     type: object    
     properties:
       etherDestinationAddress:
         description: >
           Indicates a destination Mac address.
         $ref: "SOL005_def.yaml#/definitions/MacAddress"
       etherSourceAddress:
         description: >
           Indicates a source Mac address.
         $ref: "SOL005_def.yaml#/definitions/MacAddress"
       etherType:
         description: >
           Human readable description for the VNFFG.
         type: string
         enum: 
           - IPV4
           - IPV6
       vlanTag:
         description: >
           Indicates a VLAN identifier in an IEEE 802.1Q-2014 
           tag [6] Multiple tags can be included for QinQ stacking. See note.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/String"
       protocol:
         description: >
           Indicates the L4 protocol, For IPv4 [7] this
           corresponds to the field called "Protocol" to identify
           the next level protocol. For IPv6 [28] this
           corresponds to the field is called the "Next Header" field.
           Permitted values: Any keyword defined in the IANA
           protocol registry [1], e.g.:
           TCP
           UDP
           ICMP
         type: string
         enum: 
           - TCP
           - UDP
           - ICMP           
       dscp:
         description: >
           For IPv4 [7] a string of "0" and "1" digits that
           corresponds to the 6-bit Differentiated Services
           Code Point (DSCP) field of the IP header.
           For IPv6 [28] a string of "0" and "1" digits that
           corresponds to the 6 differentiated services bits of
           the traffic class header field
         type: string
       sourcePortRange:
         description: >
           Indicates a range of source ports
         $ref: "SOL005_def.yaml#/definitions/PortRange"
       destinationPortRange:
         description: >
           Indicates a range of destination ports.
         $ref: "SOL005_def.yaml#/definitions/PortRange"
       sourceIpAddressPrefix:
         description: >
           Indicates the source IP address range in CIDR format.
         $ref: "SOL005_def.yaml#/definitions/IpAddressPrefix"         
       destinationIpAddressPrefix:
         description: >
           Indicates the destination IP address range in CIDR format.
         $ref: "SOL005_def.yaml#/definitions/IpAddressPrefix"
       extendedCriteria:
         description: >
           Indicates values of specific bits in a frame.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/Mask"
           
  ChangeNsFlavourData:
     description: >
       This type specifies an existing NS instance for which the DF needs to be changed. 
       This specifies the new DF, the instantiationLevel of the new DF that may be used and 
       the additional parameters as input for the flavour change. 
       It shall comply with the provisions defined in Table 6.5.3.39-1.
     type: object
     required:
       - newNsFlavourId    
     properties:
       newNsFlavourId:
         description: >
           Identifier of an existing VNFFG to be updated for the NS Instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       instantiationLevelId:
         description: >
           Identifier of the instantiation level of the deployment flavour to be instantiated. 
           If not present, the default instantiation level as declared in the NSD is instantiated.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"

  AddPnfData:
     description: >
       This type specifies an PNF to be added to the NS instance and the PNF Profile 
       to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
     type: object
     required:
       - pnfId
       - pnfName
       - pnfdId  
       - pnfProfileId       
     properties:
       pnfId:
         description: >
           Identifier of the PNF. This identifier is allocated by the OSS/BSS.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       pnfName:
         description: >
           Name of the PNF
         type: string
       pnfdId:
         description: >
           Identifier of the PNFD on which the PNF is based.
         $ref: "SOL005_def.yaml#/definitions/Identifier" 
       pnfProfileId:
         description: >
           Identifier of related PnfProfile in the NSD on which the PNF is based.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd" 
       cpData:
         description: >
           Address assigned for the PNF external CP(s).
         type: array
         items:           
           $ref: "#/definitions/PnfExtCpData"
         
  PnfExtCpData:
     description: >
       This type represents the configuration data on the external CP of the PNF. 
       It shall comply with the provisions defined in
       Table 6.5.3.16-1.
     type: object
     required:
       - cpProtocolData
     properties:
       cpInstanceI16:
         description: >
           Identifier of the CP. Shall be present for existing CP. 
         $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
       cpdId:
         description: >
           Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       cpProtocolData:
         description: >
           Address assigned for this CP.
         type: array
         items:           
           $ref: "SOL005_def.yaml#/definitions/CpProtocolData"
           
  ModifyPnfData:
     description: >
       This type specifies an PNF to be modified in the NS instance. 
       It shall comply with the provisions defined in
       Table 6.5.3.15-1.
     type: object
     required:
       - pnfId
     properties:
       pnfId:
         description: >
           Identifier of the PNF. This identifier is allocated by the OSS/BSS. 
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       pnfName:
         description: >
           Name of the PNF.
         type: string
       cpData:
         description: >
           Address assigned for the PNF external CP(s).
         type: array
         items:           
           $ref: "#/definitions/PnfExtCpData"
           
  AffectedVirtualLink:
     description: >
       This type provides information about added, deleted, modified and
       temporary VLs.
     type: object
     required:
       - id
       - virtualLinkDescId
       - changeType
       - networkResource
     properties:
       id: 
         description: >
           Identifier of the virtual link instance, identifying the applicable
           "vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
       virtualLinkDescId:
         description: >
           Identifier of the related VLD in the VNFD.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       changeType:
         description: >
           Signals the type of change. Permitted values:
           * ADDED
           * REMOVED
           * MODIFIED
           * TEMPORARY
           * LINK_PORT_ADDED
           * LINK_PORT_REMOVED
           For a temporary resource, an AffectedVirtualLink structure exists as
           long as the temporary resource exists.
         type: string
         enum:
           - ADDED
           - REMOVED
           - MODIFIED
           - TEMPORARY
           - LINK_PORT_ADDED
           - LINK_PORT_REMOVED
       networkResource:
         description: >
           Reference to the VirtualNetwork resource. Detailed information is
           (for new and modified resources) or has been (for removed
           resources) available from the VIM.
         $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
       metadata:
         description: >
           Metadata about this resource.
           The content of this attribute shall be a copy of the content of the
           "metadata" attribute of the VnfVirtualLinkResourceInfo structure.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"

  AffectedVirtualStorage:
     description: >
       This type provides information about added, deleted, modified and
       temporary virtual storage resources.
     type: object
     required:
       - id
       - virtualStorageDescId
       - changeType
       - storageResource
     properties:
       id:
         description: >
           Identifier of the storage instance, identifying the applicable
           "virtualStorageResourceInfo" entry in the "VnfInstance" data type.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
       virtualStorageDescId:
         description: >
           Identifier of the related VirtualStorage descriptor in the VNFD.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
       changeType:
         description: >
           Signals the type of change. Permitted values:
           * ADDED
           * REMOVED
           * MODIFIED
           * TEMPORARY
           For a temporary resource, an AffectedVirtualStorage structure exists
           as long as the temporary resource exists.
         type: string
         enum:
           - ADDED
           - REMOVED
           - MODIFIED
           - TEMPORARY
       storageResource:
         description: >
           Reference to the VirtualStorage resource. Detailed information is 
           (for new and modified resources) or has been (for removed
           resources) available from the VIM.
         $ref: "SOL005_def.yaml#/definitions/ResourceHandle"
       metadata:
         description: >
           Metadata about this resource.
           The content of this attribute shall be a copy of the content of the
           "metadata" attribute of the VirtualStorageResourceInfo structure.
         $ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
         
  AffectedVnf:
    description: >
      This type provides information about added, deleted and modified VNFs. 
      It shall comply with the provisions in Table 6.5.3.2-1.
    type: object
    required:
      - vnfInstanceId
      - vnfdId
      - vnfProfileId    
    properties:
      vnfInstanceId:
        description: >
          Identifier of the VNF instance. 
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfdId:
        description: >
          Identifier of the VNFD of the VNF Instance.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      vnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vnfName:
        description: >
          Name of the VNF Instance.
        type: string
      changeType:
        description: >
          Signals the type of change
          Permitted values:
          - ADD
          - REMOVE
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
          - OPERATE
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
        type: string
        enum:
          - ADD
          - REMOVE 
          - INSTANTIATE
          - TERMINATE
          - SCALE
          - CHANGE_FLAVOUR
          - HEAL
          - OPERATE           
          - MODIFY_INFORMATION
          - CHANGE_EXTERNAL_VNF_CONNECTIVITY
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK 
          - FAILED
      changedInfo:
        description: >
          Information about the changed VNF instance
2412
2413
2414
2415
          information, including VNF configurable properties,if applicable.
          When the "changedInfo" attribute is present, 
          either the "changedVnfInfo" attribute or the
          "changedExtConnectivity" attribute or both shall be present.
2416
2417
2418
2419
        type: object
        required:
          - self
        properties:
2420
2421
2422
2423
2424
2425
2426
2427
2428
2429
2430
          changedVnfInfo:
            description: >
              Information about the changed VNF instance
              information, including configurable properties, 
              if applicable.
            $ref: "#/definitions/ModifyVnfInfoData"
          changedExtConnectivity:
            description: >
              Information about changed external connectivity,
              if applicable.
            $ref: "#/definitions/ExtVirtualLinkInfo"
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
2641
2642
2643
2644
2645
2646
2647
2648
2649
2650
2651
2652
2653
2654
2655
2656
2657
2658
2659
2660
2661
2662
2663
2664
2665
2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
2676
2677
2678
2679
2680
2681
2682
2683
2684
2685
2686
2687
2688
2689
2690
2691
2692
2693
2694
2695
2696
2697
2698
2699
2700
2701
2702
2703
2704
2705
2706
2707
2708
2709
2710
2711
2712
2713
2714
2715
2716
2717
2718
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
2753
2754
2755
2756
2757
2758
2759
2760
2761
2762
2763
2764
2765
2766
2767
2768
2769
2770
2771
2772
2773
2774
2775
2776
2777
2778
2779
2780
2781
2782
2783
2784
2785
2786
2787
2788
2789
2790
2791
2792
2793
2794
2795
2796
2797
2798
2799
2800
2801
2802
2803
2804
2805
2806
2807
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
2830
2831
2832
2833
2834
2835
2836
2837
2838
2839
2840
2841
2842
2843
2844
2845
2846
2847
2848
2849
2850
2851
2852
2853
2854
2855
2856
2857
2858
2859
2860
2861
2862
2863
2864
2865
2866
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
2892
2893
2894
2895
2896
2897
2898
2899
2900
2901
2902
2903
2904
2905
2906
2907
2908
2909
2910
2911
2912
2913
2914
2915
2916
2917

  AffectedPnf:
    description: >
      This type provides information about added, deleted and modified PNFs. 
      It shall comply with the provisions in Table 6.5.3.3-1.
    type: object
    required:
      - pnfId
      - pnfdId
      - pnfProfileId
      - cpInstanceId       
    properties:
      pnfId:
        description: >
          Identifier of the affected PNF. This identifier is
          allocated by the OSS/BSS.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      pnfProfileId:
        description: >
          Identifier of the VNF profile of the NSD.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      pnfName:
        description: >
          Name of the PNF.
        type: string
      cpInstanceId:
        description: >
          Identifier of the CP in the scope of the PNF.
        type: array
        items:           
          $ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"        
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - REMOVE
          - MODIFY
        type: string
        enum:
          - ADD
          - REMOVE 
          - MODIFY        
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK 
          - FAILED    
  
  AffectedVl:
    description: >
      This type provides information about added, deleted and modified VLs. 
      It shall comply with the provisions in Table 6.5.3.4-1.
    type: object
    required:
      - nsVirtualLinkInstanceId
      - nsVirtualLinkDescId
      - vlProfileId     
    properties:
      nsVirtualLinkInstanceId:
        description: >
          Identifier of the VL Instance.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD for this VL.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      vlProfileId:
        description: >
          Identifier of the VLD in the NSD for this VL.
        $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
      changeType:
        description: >
          Signals the type of change.
          Permitted values:
          - ADD
          - DELETE
          - MODIFY
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT
        type: string
        enum:
          - ADD
          - DELETE 
          - MODIFY 
          - ADD_LINK_PORT
          - REMOVE_LINK_PORT           
      changeResult:
        description: >
          Signals the result of change identified by the
          "changeType" attribute.
          Permitted values:
          - COMPLETED
          - ROLLED_BACK
          - FAILED
        type: string
        enum:
          - COMPLETED
          - ROLLED_BACK 
          - FAILED
          
  AffectedVnffg:
     description: >
       This type provides information about added, deleted and modified VNFFG instances. 
       It shall comply with the
       provisions in Table 6.5.3.5-1.
     type: object
     required:
       - vnffgInstanceId
       - vnffgdId   
     properties:
       vnffgInstanceId:
         description: >
            Identifier of the VNFFG instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
       vnffgdId:
         description: >
           Identifier of the VNFFGD of the VNFFG instance.
         $ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
       changeType:
         description: >
           Signals the type of change.
           Permitted values:
           - ADD
           - DELETE
           - MODIFY
         type: string
         enum:
           - ADD
           - DELETE 
           - MODIFY         
       changeResult:
         description: >
           Signals the result of change identified by the
           "changeType" attribute.
           Permitted values:
           - COMPLETED
           - ROLLED_BACK
           - FAILED
         type: string
         enum:
           - COMPLETED
           - ROLLED_BACK 
           - FAILED
           
  AffectedNs:
     description: >
       This type provides information about added, deleted and modified nested NSs. 
       It shall comply with the provisions in Table 6.5.3.6-1.
     type: object
     required:
       - nsInstanceId
       - nsdId   
     properties:
       nsInstanceId:
         description: >
            Identifier of the nested NS instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       nsdId:
         description: >
           Identifier of the NSD of the nested NS instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       changeType:
         description: >
           Signals the type of lifecycle change.
           Permitted values:
           - ADD
           - REMOVE
           - INSTANTIATE
           - SCALE
           - UPDATE
           - HEAL
           - TERMINATE
         type: string
         enum:
           - ADD
           - REMOVE 
           - INSTANTIATE         
           - SCALE
           - UPDATE
           - HEAL
           - TERMINATE           
       changeResult:
         description: >
           Signals the result of change identified by the
           "changeType" attribute.
           Permitted values:
           - COMPLETED
           - ROLLED_BACK
           - FAILED
           - PARTIALLY_COMPLETED           
         type: string
         enum:
           - COMPLETED
           - ROLLED_BACK 
           - FAILED 
           - PARTIALLY_COMPLETED

  AffectedSap:
     description: >
       This type provides information about added, deleted and modified SAP of a NS. 
       It shall comply with the provisions in Table 6.5.3.7-1.
     type: object
     required:
       - sapInstanceId
       - sapdId   
     properties:
       sapInstanceId:
         description: >
            Identifier of the nested NS instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       sapdId:
         description: >
           Identifier of the NSD of the nested NS instance.
         $ref: "SOL005_def.yaml#/definitions/Identifier"
       sapName:
         description: >
           Human readable name for the SAP.
         type: string
       changeType:
         description: >
           Signals the type of lifecycle change.
           Permitted values:
           - ADD
           - REMOVE
           - MODIFY
         type: string
         enum:
           - ADD
           - REMOVE 
           - MODIFY
       changeResult:
         description: >
           Signals the result of change identified by the
           "changeType" attribute.
           Permitted values:
           - COMPLETED
           - ROLLED_BACK
           - FAILED
         type: string
         enum:
           - COMPLETED
           - ROLLED_BACK 
           - FAILED
           
  NsLcmOperationStateType:
    description: >
      The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1.
      Value | Description
      ------|------------
      PROCESSING | The LCM operation is currently in execution.
      COMPLETED | The LCM operation has been completed successfully.
      PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
      FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed.
      FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed.
      OLLING_BACK | The LCM operation is currently being rolled back.
      ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.
    type: string
    enum:
      - PROCESSING
      - COMPLETED
      - FAILED_TEMP
      - FAILED
      - ROLLING_BACK
      - ROLLED_BACK       
  NsLcmOpType:
     description: >
       The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation
       occurrence notification.
       Value | Description
       ------|------------
       INSTANTIATE | Represents the "Instantiate NS" LCM operation.
       SCALE | Represents the "Scale NS" LCM operation.
       UPDATE | Represents the "Update NS" LCM operation.
       TERMINATE | Represents the "Terminate NS" LCM operation.
       HEAL | Represents the "Heal NS" LCM operation.
     type: string
     enum:
       - INSTANTIATE
       - SCALE
       - UPDATE
       - TERMINATE
       - HEAL       
  LccnSubscriptionRequest:
    description: >
      This type represents a subscription request related to notifications 
      about NS lifecycle changes. It shall comply with the
      provisions defined in Table 6.5.2.2-1..
    type: object
    required:
      - 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/LifecycleChangeNotificationsFilter"
      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"
        
  LccnSubscription:
    description: >
      This type represents a subscription related to notifications about NS lifecycle changes. 
      It shall comply with the provisions defined in Table 6.5.2.4-1.
    type: object
    required:
      - id
      - callbackUri
      - _links
    properties:
      id:
        description: >
          Identifier of this subscription resource.
        $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/LifecycleChangeNotificationsFilter"
      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" 
  LifecycleChangeNotificationsFilter:
    description: >
      This type represents a subscription filter related to notifications about 
      NS lifecycle changes. It shall comply with the
      provisions defined in Table 6.5.3.8-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
    properties:
      nsInstanceSubscriptionFilter:
        description: >
          Filter criteria to select NS instances about which to notify.
        $ref: "#/definitions/NsInstanceSubscriptionFilter"
      notificationTypes:
        description: >
          Match particular notification types.
          Permitted values:
          - NsLcmOperationOccurenceNotification
          - NsIdentifierCreationNotification
          - NsIdentifierDeletionNotification
          - NsChangeNotification
        type: array
        items:
          type: string
          enum:
            - NsLcmOperationOccurenceNotification
            - NsIdentifierCreationNotification
            - NsIdentifierDeletionNotification
            - NsChangeNotification             
      operationTypes:
        description: >
          Match particular NS lifecycle operation types
          for the notification of type
          NsLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsLcmOperationOccurrenceNotification", and
          shall be absent otherwise.
        type: array
        items: 
          $ref: "#/definitions/NsLcmOpType"
      operationStates:
        description: >
          Match particular LCM operation state values as
          reported in notifications of type
          NsLcmOperationOccurrenceNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsLcmOperationOccurrenceNotification", and
          shall be absent otherwise.
        type: array
        items: 
          $ref: "#/definitions/LcmOperationStateType"
      nsComponentTypes:
        description: >
          Match particular NS component types for the
          notification of type NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value "NsChang.
        type: array
        items: 
          $ref: "#/definitions/NsComponentType"
      lcmOpNameImpactingNsComponent:
        description: >
          Match particular LCM operation names for the
          notification of type NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsChangeNotification", and shall be absent otherwise.
        type: array
        items: 
          $ref: "#/definitions/LcmOpNameForChangeNotificationType"
      lcmOpOccStatusImpactingNsComponent:
        description: >
          Match particular LCM operation status values
          as reported in notifications of type
          NsChangeNotification.
          May be present if the "notificationTypes"
          attribute contains the value
          "NsChangeNotification", and shall be absent otherwise.
        type: array
        items: 
          $ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
          
  NsLcmOperationOccurrenceNotification:
    type: object
    required:
      - id
      - nsInstanceId
      - nsLcmOpOccId
      - subscriptionId      
    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"
      nsInstanceId:
        description: >
          The identifier of the NS instance affected.
        $ref: "SOL005_def.yaml#/definitions/Identifier"
      nsLcmOpOccId:
        description: >
          The identifier of the NS lifecycle operation occurrence
          associated to the notification.
        $ref: "SOL005_def.yaml#/definitions/Identifier"        
      operation:
        description: >
          The lifecycle operation.
        $ref: "#/definitions/NsLcmOpType"
      notificationType:
        description: >
          Discriminator for the different notification types. Shall be
          set to "NsLcmOperationOccurrenceNotification" 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-time of the generation of the notification.
2918
        $ref: "SOL005_def.yaml#/definitions/DateTime"
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
      notificationStatus:
        description: >
          Indicates whether this notification reports about the start
          of a NS lifecycle operation or the result of a NS lifecycle
          operation.
          Permitted values:
          - START: Informs about the start of the NS LCM
          operation occurrence.
          - RESULT: Informs about the final or intermediate
          result of the NS LCM operation occurrence.
        type: string
        enum:
          - START
          - RESULT 
      operationState:
        description: >
          The state of the NS lifecycle operation occurrence.
        $ref: "#/definitions/NsLcmOperationStateType"
      isAutomaticInvocation:
        description: >
          Set to true if this NS LCM operation occurrence has
          been automatically triggered by the NFVO. This occurs
          in case of auto-scaling, auto-healing and when a nested
          NS is modified as a result of an operation on its
          composite NS. Set to false otherwise.
        type: boolean
      affectedVnf:
        description: >
          Information about the VNF instances that were affected
          during the lifecycle operation.
2949
        $ref: "#/definitions/AffectedVnf"
2950
2951
2952
2953
2954
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
3006
3007
3008
3009
3010
      affectedPnf:
        description: >
          Information about the PNF instances that were affected
          during the lifecycle operation.
        $ref: "#/definitions/AffectedPnf"
      affectedVl:
        description: >
          Information about the VL instances that were affected
          during the lifecycle operation.
        type: array
        items:
          $ref: "#/definitions/AffectedVirtualLink"
      affectedVnffg:
        description: >
          Information about the VNFFG instances that were
          affected during the lifecycle operation.
        type: array
        items:
          $ref: "#/definitions/AffectedVnffg"
      affectedNs:
        description: >
          Information about the SAP instances that were affected
          during the lifecycle operation. See note.
        type: array
        items:
          $ref: "#/definitions/AffectedSap"
      affectedSap:
        description: >
          The lifecycle operation.
        $ref: "#/definitions/NsLcmOpType"
      error:
        description: >
          Details of the latest error, if one has occurred during
          executing the LCM operation (see clause 4.3.5). Shall
          be present if operationState is "FAILED_TEMP" or
          "FAILED", and shall be absent otherwise.
        $ref: "SOL005_def.yaml#/definitions/ProblemDetails"
      _links:
        description: >
          Links to resources related to this notification.
        $ref: "#/definitions/LccnLinks"
        
  NsIdentifierCreationNotification:
    type: object
    required:
      - subscriptionId
      - nsInstanceId     
    properties:
      notificationType:
        description: >
           Discriminator for the different notification types.
           Shall be set to "NsIdentifierDeletionNotification" 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-time of the generation of the notification.
3011
        $ref: "SOL005_def.yaml#/definitions/DateTime"
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
      nsInstanceId:
        description: >
           The created NS instance identifier
        $ref: "SOL005_def.yaml#/definitions/Identifier"        
      _links:
        description: >
          Links to resources related to this notification.
        $ref: "#/definitions/LccnLinks"       

  NsIdentifierDeletionNotification:
    type: object
    required:
      - subscriptionId
      - nsInstanceId  
    properties:
      notificationType:
        description: >
          Discriminator for the different notification types.
          Shall be set to "NsIdentifierDeletionNotification" 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-time of the generation of the notification.
3040
        $ref: "SOL005_def.yaml#/definitions/DateTime"
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
3054
3055
3056
3057
3058
3059
3060
3061
3062
3063
3064
3065
3066
3067
3068
3069
3070
3071
3072
3073
3074
3075
3076
3077
3078
3079
3080
3081
3082
3083
3084
3085
3086
3087
3088
3089
3090
3091
3092
3093
3094
3095
3096
3097
3098
3099
3100
3101
3102
3103
3104
3105
3106
3107
3108
3109
3110
3111
3112
3113
3114
3115
3116
3117
3118
3119
3120
3121
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
3157
3158
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
3190
3191
3192
3193
3194
3195
3196
3197
3198
3199
3200
3201
3202
3203
3204
3205
3206
3207
3208
3209
3210
3211
3212
3213
3214
3215
3216
3217
3218
3219
3220
3221
3222
3223
3224
3225
3226
3227
3228
3229
3230
3231