SOL005NSLifecycleManagement_def.yaml 261 KB
Newer Older
1
# Copyright (c) ETSI 2017.
2
3
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
4
5
6

  HealNsRequest:
    description: >
7
8
9
10
      This type represents request parameters for the "Heal NS" operation. This operation supports the healing of an NS
      instance, either by healing the complete NS instance or by healing one of more of the VNF instances that are part of this
      NS. It shall comply with the provisions defined in Table 6.5.2.13-1.
      Either the parameter healNsData or the parameter healVnfData, but not both shall be provided.
11
    type: object
12
13
14
15
16
    oneOf:
      - required:
          - healNsData
      - required:
          - healVnfData
17
18
19
    properties:
      healNsData:
        description: >
20
          Provides the information needed to heal an NS. See note
21
22
23
        $ref: "#/definitions/HealNsData"
      healVnfData:
        description: >
24
          Provides the information needed to heal a VNF. See note.
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
        type: array
        items:
          $ref: "#/definitions/HealVnfData"

  CancelMode:
    description: >
      This type represents a parameter to select the mode of canceling an ongoing NS LCM operation occurrence. 
      It shall comply with the provisions defined in Table 6.5.2.16-1.
    type: object
    required:
      - cancelMode
    properties:
      cancelMode:
        description: >
          Cancellation mode to apply.
        $ref: "#/definitions/CancelModeType"

  HealNsData:
    description: >
      This type represents the information used to heal a NS. 
      It shall comply with the provisions defined in Table 6.5.3.43-1.
    type: object
    required:
      - degreeHealing
49
50
51
52
53
    oneOf:
      - required:
          - actionsHealing
      - required:
          - healScript
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
    properties:
      degreeHealing:
        description: >
          Indicates the degree of healing. Possible values
          include:
          - HEAL_RESTORE: Complete the healing of
          the NS restoring the state of the NS before
          the failure occurred
          - HEAL_QOS: Complete the healing of the NS
          based on the newest QoS values
          - HEAL_RESET: Complete the healing of the
          NS resetting to the original instantiation state of the NS
          - PARTIAL_HEALING
        type: string
        enum:
          - HEAL_RESTORE
          - HEAL_QOS
          - HEAL_RESET
          - PARTIAL_HEALING
      actionsHealing:
        description: >
          Used to specify dedicated healing actions in a
          particular order (e.g. as a script). The actionsHealing
          attribute can be used to provide a specific script whose
          content and actions might only be possible to be
          derived during runtime.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/String"
      healScript:
        description: >
          Reference to a script from the NSD that shall be used
          to execute dedicated healing actions in a particular
          order. The healScript, since it refers to a script in the
          NSD, can be used to execute healing actions which
          are defined during NS design time.
90
        $ref: "#/definitions/IdentifierInNsd"
91
92
93
94
95
96
97
98
99
      additionalParamsforNs:
        description: >
          Allows the OSS/BSS to provide additional
          parameter(s) to the healing process at the NS level.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  HealVnfData:
    description: >
      This type represents the information to heal a VNF that is part of an NS. 
100
      The NFVO shall then invoke the Heal VNF operation towards the appropriate VNFM.
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
      It shall comply with the provisions defined in Table 6.5.3.44-1.
    type: object
    required:
      - vnfInstanceId
    properties:
      vnfInstanceId:
        description: >
          Identifies the VNF instance, part of the NS, requiring a
          healing action.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
      cause:
        description: >
          Indicates the reason why a healing procedure is required.
        type: string
      additionalParams:
        description: >
          Additional parameters passed by the NFVO as input to
          the healing process, specific to the VNF being healed.
          EXAMPLE: Input parameters to VNF-specific healing procedures.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"

  TerminateNsRequest:
    description: >
      This type represents a NS termination request. 
      It shall comply with the provisions defined in Table 6.5.2.15-1.
    type: object
    properties:
      terminationTime:
        description: >
          Timestamp indicating the end time of the NS, i.e. the NS
          will be terminated automatically at this timestamp.
          Cardinality "0" indicates the NS termination takes place immediately
        $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
      terminateNsData:
        description: >
          Provides additional parameters to the termination process at the NS level.
          Information needed for terminating specific VNF instances shall only be specified
          in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
        $ref: "#/definitions/TerminateNsData"
      terminateVnfData:
        description: >
          Provides the information to terminate VNF instance(s).
          Information needed for terminating specific VNF instances
          shall only be specified in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
          VNF instance(s) part of this NS instance is(are) terminated as part of Terminate NS operation
          only if the instance(s) is(are) not used by any other NS instance.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
150

151
152
153
154
155
156
157
158
159
160
161
  CreateNsRequest:
    type: object
    required:
      - nsdId
      - nsName
      - nsDescription
    properties:
      nsdId:
        description: >
          Identifier of the NSD that defines the NS instance to be
          created.
162
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
163
164
165
166
167
168
169
170
      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
171

172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
  CancelModeType:
    description: >
      Cancellation mode.

      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, and shall wait for the ongoing VNF lifecycle management
      and resource management operations in the underlying system, typically the VNFM
      and VIM, to finish execution or to time out. After that, the NFVO shall put the
      operation occurrence into the FAILED_TEMP state.

      The NFVO shall not start any new VNF lifecycle management and resource
      management operation, shall cancel the ongoing VNF lifecycle management and
      resource management operations in the underlying system, typically the VNFM and
      VIM, and shall wait for the cancellation to finish or to time out. After that, the NFVO
      shall put the operation occurrence into the FAILED_TEMP state.
    type: string
    enum:
      - GRACEFUL
      - FORCEFUL

192
193
194
195
196
197
198
199
200
201
202
203
  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
204
      - _links
205
206
207
208
    properties:
      id:
        description: >
          Identifier of the NS instance.
209
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
210
211
212
213
214
215
216
217
218
219
      nsInstanceName:
        description: >
          Human readable name of the NS instance.
        type: string
      nsInstanceDescription:
        description: >
          Human readable description of the NS instance.
        type: string
      nsdId:
        description: >
220
          Identifier of the NSD on which the NS instance is based. The value is copied from the NSD.
221
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
222
223
224
      nsdInfoId:
        description: >
          Identifier of the NSD information object on which the
225
          NS instance is based. This identifier has been allocated by the NFVO.
226
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
227
228
229
230
231
      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.
232
        $ref: "#/definitions/IdentifierInNsd"
233
234
235
236
237
      vnfInstance:
        description: >
          Information on constituent VNF(s) of the NS instance.
        type: array
        items:
238
          $ref: "#/definitions/VnfInstance"
239
240
241
242
243
      pnfInfo:
        description: >
          Information on the PNF(s) that are part of the NS instance.
        type: array
        items:
244
          $ref: "#/definitions/PnfInfo"
245
246
247
248
249
250
251
252
      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:
253
          $ref: "#/definitions/NsVirtualLinkInfo"
254
255
256
257
258
      vnffgInfo:
        description: >
          Information on the VNFFG(s) of the NS instance.
        type: array
        items:
259
          $ref: "#/definitions/VnffgInfo"
260
261
262
263
      sapInfo:
        description: >
          Information on the SAP(s) of the NS instance.
        type: array
264
        items:
265
266
267
268
269
          $ref: "#/definitions/SapInfo"
      nestedNsInstanceId:
        description: >
          Identifier of the nested NS(s) of the NS instance.
        type: array
270
        items:
271
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
272
273
274
275
276
277
      vnfSnapshotInfoIds:
        description: >
          Identifier of information on VNF snapshots of VNF instances that are part of this NS instance.
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
278
279
280
281
282
283
284
285
      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
286
        enum:
287
          - NOT_INSTANTIATED
288
          - INSTANTIATED
289
290
291
292
293
294
295
296
      monitoringParameter:
        description: >
          Performance metrics tracked by the NFVO (e.g. for
          auto-scaling purposes) as identified by the NS
          designer in the NSD.
        type: array
        items:
          $ref: "#/definitions/NsMonitoringParameter"
297
298
299
300
301
302
      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
303
          value is INSTANTIATED.
304
305
        type: array
        items:
306
          $ref: "#/definitions/NsScaleInfo"
307
308
309
310
311
312
      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
313
        items:
314
          $ref: "#/definitions/AffinityOrAntiAffinityRule"
315
316
317
318
319
320
      wanConnectionInfo:
        description: >
          Information about WAN related connectivity enabling multi-site VLs.
        type: array
        items:
          $ref: "#/definitions/WanConnectionInfo"
321
322
      _links:
        type: object
323
        description: Links to resources related to this resource.
324
325
326
327
328
329
        required:
          - self
        properties:
          self:
            description: >
              URI of this resource.
330
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
331
332
333
334
335
          nestedNsInstances:
            description: >
              Links to resources related to this notification.
            type: array
            items:
336
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
337
338
339
340
341
342
          vnfSnapshotInfos:
            description: >
              Links to the VNF snapshots associated to VNF instances which are part of this NS instance.
            type: array
            items:
              $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
343
344
345
346
347
348
          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).
349
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
350
351
352
353
354
355
          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).
356
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
357
358
359
360
361
362
          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).
363
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
364
365
366
367
368
369
370
          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).
371
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
372
373
374
375
376
377
378
          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).
379
            $ref: "../../definitions/SOL005_def.yaml#/definitions/Link"
380

381
382
383
  VnfInstance:
    description: >
      This type represents a VNF instance.
384
385
386
      Clause B.3.2 of ETSI GS NFV-SOL 003 [4] provides examples illustrating the relationship among the
      different run-time information elements (CP, VL and link ports) used to represent the connectivity of a
      VNF.
387
388
389
390
391
392
393
394
395
396
397
398
399
400
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
401
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
402
403
404
      vnfInstanceName:
        description: >
          Name of the VNF instance.
405
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
406
407
408
409
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
410
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
411
412
413
414
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
415
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
416
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
417
418
419
420
421
422
423
424
425
426
427
      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.
428
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
429
430
431
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
432
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
433
434
      vnfPkgId:
        description: >
435
436
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
437
          based. This identifier has been allocated by the NFVO.
438
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
439
440
      vnfConfigurableProperties:
        description: >
441
442
443
444
445
446
447
448
449
450
451
452
          Additional VNF-specific attributes that provide the current values
          of the configurable properties of the VNF instance.

          These attributes represent values that are stored persistently in the
          VnfInstance structure and that correspond to configuration parameters
          of the VNF instance.
          Modifying these attributes affects the configuration of the VNF instance
          either directly(if the VNF instance is in INSTANTIATED state at the time
          of the modification) or as part of the subsequent VNF instantiation operation
          (if the VNF instance is in NOT_INSTANTIATED state at the time of the modification).

          Configurable properties referred in these attributes are declared in
453
          the VNFD.
454

455
456
457
458
459
460
461
462
463
464
465
466
467
          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: 
468
469
470
471
472
473
474
            - 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.

475
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
476
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
477
478
479
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
480
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
      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
496
          - extCpInfo
497
498
499
500
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavor applied to this VNF instance.
501
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
502
503
504
505
506
507
508
509
510
511
512
          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"
513
514
515
516
517
518
519
520
521
          maxScaleLevels:
            description: >
              Maximum allowed scale levels of the VNF, one
              entry per aspect.
              This attribute shall be present if the VNF
              supports scaling.
            type: array
            items:
              $ref: "#/definitions/VnfScaleInfo"
522
523
524
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
525
526
527
              When trunking is enabled, the list of entries includes both,
              external CPs corresponding to parent ports of a trunk, and external
              CPs associated to sub-ports of a trunk.
528
529
530
            type: array
            minItems: 1
            items:
531
              $ref: "#/definitions/VnfExtCpInfo"
532
533
534
535
536
537
538
539
540
541
          vipCpInfo:
            description: >
              VIP CPs that are part of the VNF instance.
              Shall be present when that particular VIP CP
              of the VNFC instance is associated to an external
              CP of the VNF instance.
              May be present otherwise.
            type: array
            items:
              $ref: "#/definitions/VipCpInfo"
542
543
544
545
546
547
548
549
550
          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.
551
552
553
554
              It is possible to have several ExtManagedVirtualLinkInfo for the same VNF internal VL in case of a multi-site
              VNF spanning several VIMs. The set of ExtManagedVirtualLinkInfo corresponding to the same VNF internal VL
              shall indicate so by referencing to the same VnfVirtualLinkDesc and externally-managed multi-site VL instance
              (refer to clause 6.5.3.59).
555
556
              Even though externally-managed internal VLs are also used for VNF-internal connectivity, they shall not be
              listed in the "vnfVirtualLinkResourceInfo" attribute as this would be redundant.
557
558
559
560
561
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
562
563
564
              Performance metrics tracked by the VNFM (e.g. for 
              auto-scaling purposes) as identified by the VNF 
              provider in the VNFD.
565
566
            type: array
            items:
567
              $ref: "#/definitions/VnfMonitoringParameter"
568
569
570
571
572
573
574
575
576
577
          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: >
578
579
              Information about the virtualised compute and storage resources used
              by the VNFCs of the VNF instance.
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
            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: >
598
599
600
601
602
603
604
605
606
607
608
609
          Additional VNF-specific attributes that provide
          metadata describing the VNF instance.
          These attributes represent values that are
          stored persistently in the VnfInstance structure
          for consumption by functional blocks that
          invoke the VNF lifecycle management
          interface. They are not consumed by the
          VNFM, or the lifecycle management scripts.
          Modifying the values of these attributes has no
          effect on the VNF instance, it only affects the
          information represented in the VnfInstance
          structure.
610
611
          Metadata that the VNF provider foresees are expected to be declared in the VNFD.
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
612
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
613
614
      extensions:
        description: >
615
616
617
618
619
620
621
          Additional VNF-specific attributes that affect the lifecycle management of this VNF instance.
          These attributes represent values that are stored persistently in the VnfInstance structure
          for consumption by the VNFM, or by the lifecycle management scripts.  during the execution
          of VNF lifecycle management operations.
          Modifying the values of these attributes has no direct effect on the VNF instance; however,
          the modified attribute values can be considered during subsequent VNF lifecycle management
          operations, which means that the modified values can indirectly affect the configuration of the VNF instance.
622
623
          Extensions that are allowed for the VNF are declared in the VNFD.
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
624
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
625

626
627
  LccnLinks:
    type: object
628
    required:
629
      - nsInstance
630
    properties:
631
632
633
634
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
635
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
636
637
638
      subscription:
        description: >
          Link to the subscription that triggered this notification.
639
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
640
      nslcmOpOcc:
641
642
643
644
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
645
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
646

647
648
649
650
651
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
652

653
654
655
656
657
658
659
660
661
  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
662
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
663
664
665
666
667
668
      vnfdId:
        description: >
          Identifier of the VNFD.
          Shall be present in case the value differs from the vnfdId attribute of the VnfInstance (e.g. during a "Change
          current VNF package" operation or due to its final failure).
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
      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.
690
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
691
692
693
694
695
696
697
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
698
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
699
700
701
702
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
703
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
704
705
706
707
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
708
        $ref: "#/definitions/IdentifierInNsd"
709
710
711
712
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"
713

714
715
716
717
718
719
720
721
722
723
724
725
726
  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.
727
        $ref: "#/definitions/IdentifierInPnf"
728
729
730
731
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
732
        $ref: "#/definitions/IdentifierInNsd"
733
734
735
736
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
737
        items:
738
          $ref: "#/definitions/CpProtocolData"
739

740
741
742
743
744
745
746
747
748
  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
749
      - nsVirtualLinkProfileId
750
751
752
753
    properties:
      id:
        description: >
          Identifier of the VL instance.
754
        $ref: "#/definitions/IdentifierInNs"
755
756
757
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
758
        $ref: "#/definitions/IdentifierInNsd"
759
760
761
      nsVirtualLinkProfileId:
        description: >
          Identifier of the VL profile in the NSD.
762
        $ref: "#/definitions/IdentifierInNsd"
763
764
      resourceHandle:
        description: >
765
766
767
768
769
770
771
          Identifier(s) of the virtualised network resource(s) and/or multi-site connectivity service(s)
          realizing the VL instance.
          As an NS can include NFs deployed in NFVI PoPs under the control of several different VIMs, therefore deploying
          an NS VL can involve several VIMs, each allocating different virtualised network resources, as well as WIMs
          handling the connectivity in between the NFVI-PoPs in the form of multi-site connectivity services. When this
          NsVirtualLink is provided as an ExtVirtualLink as input of a VNF LCM operation, the id of the ExtVirtualLink
          shall be the same as the corresponding NsVirtualLink.
772
        type: array
773
        items:
774
          $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
775
776
777
778
779
780
      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
781
        items:
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
          $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.
797
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
798
799
800
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
801
        $ref: "#/definitions/IdentifierInNsd"
802
803
804
805
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
806
        items:
807
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
808
809
810
811
812
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
813
        items:
814
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
815
816
817
818
819
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
820
        items:
821
          $ref: "#/definitions/IdentifierInNs"
822
823
824
825
826
      nsCpHandle:
        description: >
          Identifiers of the CP instances attached to the
          constituent VNFs and PNFs or the SAP instances of the
          VNFFG. See note.
Giacomo Bernini's avatar
Giacomo Bernini committed
827
        $ref: "#/definitions/NsCpHandle"
828

829
830
831
832
833
834
835
836
837
838
839
840
841
  NfpInfo:
    description: >
      This type represents an NFP instance. It shall comply with 
      the provisions defined in Table 6.5.3.66-1.
    type: object
    required:
      - id
      - nfpRule
      - nfpState
    properties:
      id:
        description: >
          Identifier of this NFP instance.
842
        $ref: "#/definitions/IdentifierInNs"
843
844
845
846
847
      nfpdId:
        description: >
          Identifier of the NFPD used to instantiate this NFP
          instance. It shall be present if the NFP instance is
          instantiated from the NFPD.
848
        $ref: "#/definitions/IdentifierInNsd"
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
      nfpName:
        description: >
          Human readable name for the NFP instance.
        type: string
      description:
        description: >
          Human readable description for the NFP instance.
        type: string
      cpGroup:
        description: >
          Group(s) of CPs and/or SAPs which the NFP passes through.
          When multiple identifiers are included, the position of 
          the identifier in the CpGroup data type specifies the 
          position of the group in the path.
        type: array
        minItems: 1
        items:
Giacomo Bernini's avatar
Giacomo Bernini committed
866
          $ref: "#/definitions/CpGroupInfo"
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
      totalCp:
        description: >
          Total number of CP and SAP instances in this NFP instance.
        type: integer
      nfpRule:
        description: >
          NFP classification and selection rule.
        $ref: "#/definitions/NfpRule"
      nfpState:
        description: >
          The state of the NFP instance.
          Permitted values:
          * ENABLED: The NFP instance is enabled.
          * DISABLED: The NFP instance is disabled.
        type: string
        enum:
          - ENABLED
          - DISABLED

886
887
888
889
890
  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.
891
    type: object
892
893
894
895
896
897
898
899
900
901
    oneOf:
      - required:
          - vnfInstanceId
          - vnfExtCpInstanceId
      - required:
          - pnfInfoId
          - pnfExtCpInstanceId
      - required:
          - nsInstanceId
          - nsSapInstanceId
902
903
904
905
906
    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.
907
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
908
909
910
911
912
      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.
913
        $ref: "#/definitions/IdentifierInVnf"
914
915
916
917
918
      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.          
919
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
920
921
922
923
924
      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.
925
        $ref: "#/definitions/IdentifierInPnf"
926
927
928
929
930
      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.           
931
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
932
933
934
935
936
      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.           
937
        $ref: "#/definitions/IdentifierInNs"
938

939
940
941
942
943
944
945
946
947
948
949
950
951
  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.
952
        $ref: "#/definitions/IdentifierInNs"
953
954
955
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
956
        $ref: "#/definitions/IdentifierInNsd"
957
958
959
960
961
962
963
964
965
966
967
968
      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
969
        items:
970
          $ref: "#/definitions/CpProtocolInfo"
971

972
973
974
975
976
977
978
979
980
981
982
983
  NsMonitoringParameter:
    description: >
      This type represents a monitoring parameter that is tracked by the NFVO, for example, 
      for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.68-1.
    type: object
    required:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the NSD.
984
        $ref: "#/definitions/IdentifierInNsd"
985
986
987
988
989
990
991
992
993
994
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the NSD.
        type: string
      performanceMetric:
        description: >
          Performance metric that is monitored. This attribute shall contain the related 
          "Measurement Name" value as defined in clause 7.2 of ETSI GS NFV-IFA 027.
        type: string

995
996
997
998
999
1000
  VnfMonitoringParameter:
    description: >
      This type represents a monitoring parameter that is tracked by the VNFM, for example, 
      for auto-scaling purposes. It shall comply with the provisions defined in Table 6.5.3.69-1.
    type: object
    required:
For faster browsing, not all history is shown. View entire blame