SOL005NSLifecycleManagement_def.yaml 269 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
      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.
piscione's avatar
piscione committed
126
127
128
129
130
131

      NOTE 1:	Information needed for terminating specific VNF instances shall only be
      specified in the "terminateVnfData" attribute, and not in the "terminateNsData" attribute.
      NOTE 2: 	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.

132
133
134
135
136
137
138
139
    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"
140
141
142
      terminateNsData:
        description: >
          Provides additional parameters to the termination process at the NS level.
piscione's avatar
piscione committed
143
          See note 1.
144
145
146
147
        $ref: "#/definitions/TerminateNsData"
      terminateVnfData:
        description: >
          Provides the information to terminate VNF instance(s).
piscione's avatar
piscione committed
148
          See note 1 and 2.
149
150
151
        type: array
        items:
          $ref: "../../definitions/SOL005_def.yaml#/definitions/DateTime"
152

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

174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
  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

194
195
196
197
  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.
piscione's avatar
piscione committed
198
199
200

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

388
389
  VnfInstance:
    description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
      This type represents a VNF instance. It shall comply with the provisions defined in table 6.5.3.57-1.
      
      NOTE: Clause B.3.2 of ETSI GS NFV-SOL 003 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.

      NOTE 1: Modifying the value of this attribute shall not be performed when conflicts exist between the 
              previous and the newly referred VNF package, i.e. when the new VNFD is changed with respect to 
              the previous VNFD in other aspects than merely referencing to other VNF software images. 
              In order to avoid misalignment of the VnfInstance with the current VNF's on-boarded VNF Package, 
              the values of attributes in the VnfInstance that have corresponding attributes in the VNFD shall 
              be kept in sync with the values in the VNFD.
      NOTE 2: ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD based on TOSCA specifications.
      NOTE 3: 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.
      NOTE 4: 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).
      NOTE 5: 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.
414
415
416
417
418
419
420
421
422
423
424
425
426
427
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
428
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
429
430
431
      vnfInstanceName:
        description: >
          Name of the VNF instance.
432
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
433
434
435
436
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
437
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
438
439
440
441
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
442
443
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure. 
          See note 1.
444
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
445
446
447
448
449
450
451
452
453
454
455
      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.
456
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
457
458
459
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
460
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
461
462
      vnfPkgId:
        description: >
463
464
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
465
          based. This identifier has been allocated by the NFVO.
466
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
467
468
      vnfConfigurableProperties:
        description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
          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 the VNFD 
          (see note 2 and note 3).
          
          These configurable properties include the following standard attributes, which are 
          eclared 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.
            
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
492
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
493
494
495
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
496
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
497
498
499
      instantiationState:
        description: >
          The instantiation state of the VNF.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
500
501
502
503

          Permitted values:
          - NOT_INSTANTIATED: The VNF instance is terminated or not instantiated.
          - INSTANTIATED: The VNF instance is instantiated.
504
505
506
507
508
509
510
511
512
513
514
515
        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
516
          - extCpInfo
517
518
519
520
        properties:
          flavourId:
            description: >
              Identifier of the VNF deployment flavor applied to this VNF instance.
521
            $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
522
523
          vnfState:
            description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
524
              State of the VNF instance.
525
526
527
528
529
530
531
532
            $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"
533
534
535
536
537
538
539
540
541
          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"
542
543
544
          extCpInfo:
            description: >
              Information about the external CPs exposed by the VNF instance.
545
546
547
              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.
548
549
550
            type: array
            minItems: 1
            items:
551
              $ref: "#/definitions/VnfExtCpInfo"
552
553
554
555
556
557
558
559
560
561
          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"
562
563
564
565
566
567
568
569
          extVirtualLinkInfo:
            description: >
              Information about the external VLs the VNF instance is connected to.
            type: array
            items:
              $ref: "#/definitions/ExtVirtualLinkInfo"
          extManagedVirtualLinkInfo:
            description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
570
571
              Information about the externally-managed internal VLs of the VNF instance. 
              See note 4 and note 5.
572
573
574
575
576
            type: array
            items:
              $ref: "#/definitions/ExtManagedVirtualLinkInfo"
          monitoringParameters:
            description: >
577
578
579
              Performance metrics tracked by the VNFM (e.g. for 
              auto-scaling purposes) as identified by the VNF 
              provider in the VNFD.
580
581
            type: array
            items:
582
              $ref: "#/definitions/VnfMonitoringParameter"
583
584
585
586
587
588
589
590
591
592
          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: >
593
594
              Information about the virtualised compute and storage resources used
              by the VNFCs of the VNF instance.
595
596
597
            type: array
            items:
              $ref: "#/definitions/VnfcResourceInfo"
Francesca Moscatelli's avatar
Francesca Moscatelli committed
598
          vnfVirtualLinkResourceInfo:
599
600
601
            description: >
              Information about the virtualised network resources used by the VLs
              of the VNF instance.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
602
              See note 5.
603
604
605
606
607
608
609
610
611
612
613
            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: >
614
615
616
617
618
619
620
621
622
623
624
625
          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.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
626
          Metadata that the VNF provider foresees are expected to be declared in the VNFD (see note 2).
627
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
628
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
629
630
      extensions:
        description: >
631
632
633
634
635
636
637
          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.
638
639
          Extensions that are allowed for the VNF are declared in the VNFD.
          Modifications to these attributes can be requested using the "ModifyVnfInfoData" structure.
640
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
641

642
643
  LccnLinks:
    type: object
644
    required:
645
      - nsInstance
646
    properties:
647
648
649
650
      nsInstance:
        description: >
          Link to the resource representing the NS instance to
          which the notified change applies..
651
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
652
653
654
      subscription:
        description: >
          Link to the subscription that triggered this notification.
655
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
656
      nslcmOpOcc:
657
658
659
660
        description: >
          Link to the lifecycle operation occurrence that this
          notification is related to. Shall be present if there is a
          related lifecycle operation occurrence
661
        $ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
662

663
664
665
666
667
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
668

669
670
671
672
673
674
675
676
677
  VnfScaleInfo:
    required:
      - aspectId
      - scaleLevel
    type: object
    properties:
      aspectId:
        description: >
          Identifier of the scaling aspect.
678
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
679
680
681
682
683
684
      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"
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
      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.
706
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
707
708
709
710
711
712
713
      pnfName:
        description: >
          Name of the PNF.
        type: string
      pnfdId:
        description: >
          Identifier of the PNFD on which the PNF is based.
714
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
715
716
717
718
      pnfdInfoId:
        description: >
          Identifier of the PNFD information onject related to this
          PNF. This identifier is allocated by the NFVO
719
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
720
721
722
723
      pnfProfileId:
        description: >
          Identifier of the related PnfProfile in the NSD on which
          the PNF is based.
724
        $ref: "#/definitions/IdentifierInNsd"
725
726
727
728
      cpInfo:
        description: >
          Information on the external CP of the PNF.
        $ref: "#/definitions/PnfExtCpInfo"
729

730
731
732
733
734
735
736
737
738
739
740
741
742
  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.
743
        $ref: "#/definitions/IdentifierInPnf"
744
745
746
747
      cpdId:
        description: >
          Identifier of (reference to) the Connection Point
          Descriptor (CPD) for this CP.
748
        $ref: "#/definitions/IdentifierInNsd"
749
750
751
752
      cpProtocolData:
        description: >
          Parameters for configuring the network protocols on the CP.
        type: array
753
        items:
754
          $ref: "#/definitions/CpProtocolData"
755

756
757
758
759
760
761
762
763
764
  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
765
      - nsVirtualLinkProfileId
766
767
768
769
    properties:
      id:
        description: >
          Identifier of the VL instance.
770
        $ref: "#/definitions/IdentifierInNs"
771
772
773
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
774
        $ref: "#/definitions/IdentifierInNsd"
775
776
777
      nsVirtualLinkProfileId:
        description: >
          Identifier of the VL profile in the NSD.
778
        $ref: "#/definitions/IdentifierInNsd"
779
780
      resourceHandle:
        description: >
781
782
783
784
785
786
787
          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.
788
        type: array
789
        items:
790
          $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
791
792
793
794
795
796
      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
797
        items:
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
          $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.
813
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
814
815
816
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
817
        $ref: "#/definitions/IdentifierInNsd"
818
819
820
821
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
822
        items:
823
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
824
825
826
827
828
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
829
        items:
830
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
831
832
833
834
835
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
836
        items:
837
          $ref: "#/definitions/IdentifierInNs"
838
839
840
841
842
      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
843
        $ref: "#/definitions/NsCpHandle"
844

845
846
847
848
849
850
851
852
853
854
855
856
857
  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.
858
        $ref: "#/definitions/IdentifierInNs"
859
860
861
862
863
      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.
864
        $ref: "#/definitions/IdentifierInNsd"
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
      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
882
          $ref: "#/definitions/CpGroupInfo"
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
      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

902
903
904
905
906
  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.
907
    type: object
908
909
910
911
912
913
914
915
916
917
    oneOf:
      - required:
          - vnfInstanceId
          - vnfExtCpInstanceId
      - required:
          - pnfInfoId
          - pnfExtCpInstanceId
      - required:
          - nsInstanceId
          - nsSapInstanceId
918
919
920
921
922
    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.
923
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
924
925
926
927
928
      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.
929
        $ref: "#/definitions/IdentifierInVnf"
930
931
932
933
934
      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.          
935
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
936
937
938
939
940
      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.
941
        $ref: "#/definitions/IdentifierInPnf"
942
943
944
945
946
      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.           
947
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
948
949
950
951
952
      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.           
953
        $ref: "#/definitions/IdentifierInNs"
954

955
956
957
958
959
960
961
962
963
964
965
966
967
  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.
968
        $ref: "#/definitions/IdentifierInNs"
969
970
971
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
972
        $ref: "#/definitions/IdentifierInNsd"
973
974
975
976
977
978
979
980
981
982
983
984
      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
985
        items:
986
          $ref: "#/definitions/CpProtocolInfo"
987

988
989
990
991
992
993
994
995
996
997
998
999
  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.
1000
        $ref: "#/definitions/IdentifierInNsd"
For faster browsing, not all history is shown. View entire blame