SOL005NSLifecycleManagement_def.yaml 270 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
        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: >
piscione's avatar
piscione committed
44
      This type represents the information used to heal a NS.
45
      It shall comply with the provisions defined in Table 6.5.3.43-1.
piscione's avatar
piscione committed
46
47

      NOTE:	Either the actionsHealing or healScript attribute shall be present, not both attributes.
48
49
50
    type: object
    required:
      - degreeHealing
51
52
53
54
55
    oneOf:
      - required:
          - actionsHealing
      - required:
          - healScript
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
    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
piscione's avatar
piscione committed
81
          derived during runtime. See note.
82
83
84
85
86
87
88
89
90
        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
piscione's avatar
piscione committed
91
          are defined during NS design time. See note.
92
        $ref: "#/definitions/IdentifierInNsd"
93
94
95
96
97
98
99
100
101
      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. 
102
      The NFVO shall then invoke the Heal VNF operation towards the appropriate VNFM.
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
      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
128
129
130
131
132
133

      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.

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

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

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

196
197
198
199
  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
200
201
202

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

390
391
  VnfInstance:
    description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
      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.
416
417
418
419
420
421
422
423
424
425
426
427
428
429
    type: object
    required:
      - id
      - vnfdId
      - vnfProvider
      - vnfProductName
      - vnfSoftwareVersion
      - vnfdVersion
      - vnfPkgId
      - instantiationState
    properties:
      id:
        description: >
          Identifier of the VNF instance.
430
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
431
432
433
      vnfInstanceName:
        description: >
          Name of the VNF instance.
434
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
435
436
437
438
        type: string
      vnfInstanceDescription:
        description: >
          Human-readable description of the VNF instance.
439
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure.
440
441
442
443
        type: string
      vnfdId:
        description: >
          Identifier of the VNFD on which the VNF instance is based.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
444
445
          Modifications to this attribute can be requested using the "ModifyVnfInfoData" structure. 
          See note 1.
446
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
447
448
449
450
451
452
453
454
455
456
457
      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.
458
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
459
460
461
      vnfdVersion:
        description: >
          Identifies the version of the VNFD. The value is copied from the VNFD.
462
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Version"
463
464
      vnfPkgId:
        description: >
465
466
          Identifier of information held by the NFVO about
          the specific VNF package on which the VNF is
467
          based. This identifier has been allocated by the NFVO.
468
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
469
470
      vnfConfigurableProperties:
        description: >
Francesca Moscatelli's avatar
Francesca Moscatelli committed
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
          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.
piscione's avatar
piscione committed
494
495

          In addition, the provisions in clause 6.7 shall apply.
496
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
497
498
499
      vimId:
        description: >
          Identifier of a VIM that manages resources for the VNF instance.
500
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
501
502
503
      instantiationState:
        description: >
          The instantiation state of the VNF.
Francesca Moscatelli's avatar
Francesca Moscatelli committed
504
505
506
507

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

          In addition, the provisions in clause 6.7 shall apply.
646
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
647

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

669
670
671
672
673
  VnfOperationalStateType:
    type: string
    enum:
      - STARTED
      - STOPPED
674

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

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

762
763
764
  NsVirtualLinkInfo:
    description: >
      This type specifies the information about an NS VL instance. 
piscione's avatar
piscione committed
765
766
767
768
769
770
771
772
773
774
      It shall comply with the provisions defined in Table 6.5.3.53-1.

      NOTE:	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.
775
776
777
778
    type: object
    required:
      - id
      - nsVirtualLinkDescId
779
      - nsVirtualLinkProfileId
780
781
782
783
    properties:
      id:
        description: >
          Identifier of the VL instance.
784
        $ref: "#/definitions/IdentifierInNs"
785
786
787
      nsVirtualLinkDescId:
        description: >
          Identifier of the VLD in the NSD.
788
        $ref: "#/definitions/IdentifierInNsd"
789
790
791
      nsVirtualLinkProfileId:
        description: >
          Identifier of the VL profile in the NSD.
792
        $ref: "#/definitions/IdentifierInNsd"
793
794
      resourceHandle:
        description: >
795
796
          Identifier(s) of the virtualised network resource(s) and/or multi-site connectivity service(s)
          realizing the VL instance.
piscione's avatar
piscione committed
797
          See note.
798
        type: array
799
        items:
800
          $ref: "../../definitions/SOL005_def.yaml#/definitions/ResourceHandle"
801
802
803
804
805
806
      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
807
        items:
808
809
810
811
812
          $ref: "#/definitions/NsLinkPortInfo"

  VnffgInfo:
    description: >
      Information on the VNFFG(s) of the NS instance.
piscione's avatar
piscione committed
813
814
      NOTE:	It indicates an exhaustive list of all the
      CP instances and SAP instances of the VNFFG.
815
816
817
818
819
820
821
822
823
824
    type: object
    required:
      - id
      - vnffgdId
      - vnfInstanceId
      - pnfInfoId
    properties:
      id:
        description: >
          Identifier of this VNFFG instance.
825
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
826
827
828
      vnffgdId:
        description: >
          Identifier of the VNFFGD in the NSD.
829
        $ref: "#/definitions/IdentifierInNsd"
830
831
832
833
      vnfInstanceId:
        description: >
          Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
        type: array
834
        items:
835
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
836
837
838
839
840
      pnfdInfoId:
        description: >
          Identifier(s) of the constituent PNF instance(s) of this
          VNFFG instance.
        type: array
841
        items:
842
          $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
843
844
845
846
847
      nsVirtualLinkInfoId:
        description: >
          Identifier(s) of the constituent VL instance(s) of this
          VNFFG instance.
        type: array
848
        items:
849
          $ref: "#/definitions/IdentifierInNs"
850
851
852
853
854
      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
855
        $ref: "#/definitions/NsCpHandle"
856

857
858
859
860
  NfpInfo:
    description: >
      This type represents an NFP instance. It shall comply with 
      the provisions defined in Table 6.5.3.66-1.
piscione's avatar
piscione committed
861
862
863
      NOTE:	When multiple identifiers are included, the position
      of the identifier in the CpGroup data type specifies the
      position of the group in the path.
864
865
866
867
868
869
870
871
872
    type: object
    required:
      - id
      - nfpRule
      - nfpState
    properties:
      id:
        description: >
          Identifier of this NFP instance.
873
        $ref: "#/definitions/IdentifierInNs"
874
875
876
877
878
      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.
879
        $ref: "#/definitions/IdentifierInNsd"
880
881
882
883
884
885
886
887
888
889
890
      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.
piscione's avatar
piscione committed
891
          See note.
892
893
894
        type: array
        minItems: 1
        items:
Giacomo Bernini's avatar
Giacomo Bernini committed
895
          $ref: "#/definitions/CpGroupInfo"
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
      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

915
916
917
918
919
  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.
piscione's avatar
piscione committed
920
921
922
923
      NOTE 1:	For the VNF external CP instance, both vnfInstanceId and vnfExtCpInstanceId shall be present as a pair.
      NOTE 2:	For the PNF external CP instance, both pnfInfoId and PnfExtCpInstanceId shall be present as a pair.
      NOTE 3:	For the SAP instance, both nsInstanceId and nsSapInstanceId shall be present as a pair.
      NOTE 4:	One pair of identifiers (VNF external CP, PNF external CP or SAP) shall be present.
924
    type: object
925
926
927
928
929
930
931
932
933
934
    oneOf:
      - required:
          - vnfInstanceId
          - vnfExtCpInstanceId
      - required:
          - pnfInfoId
          - pnfExtCpInstanceId
      - required:
          - nsInstanceId
          - nsSapInstanceId
935
936
937
938
939
    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.
piscione's avatar
piscione committed
940
          See note 1 and note 4.
941
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
942
943
944
945
946
      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.
947
        $ref: "#/definitions/IdentifierInVnf"
948
949
950
951
952
      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.          
953
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
954
955
956
957
958
      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.
959
        $ref: "#/definitions/IdentifierInPnf"
960
961
962
963
964
      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.           
965
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
966
967
968
969
970
      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.           
971
        $ref: "#/definitions/IdentifierInNs"
972

973
974
975
976
977
978
979
980
981
982
983
984
985
  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.
986
        $ref: "#/definitions/IdentifierInNs"
987
988
989
      sapdId:
        description: >
          Identifier of the SAPD in the NSD.
990
        $ref: "#/definitions/IdentifierInNsd"
991
992
993
994
995
996
997
998
999
1000
1001
1002
      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
1003
        items:
1004
          $ref: "#/definitions/CpProtocolInfo"
1005

1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
  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.
1018
        $ref: "#/definitions/IdentifierInNsd"
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
      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

1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
  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:
      - id
      - performanceMetric
    properties:
      id:
        description: >
          Identifier of the monitoring parameter defined in the VNFD.
1041
        $ref: "#/definitions/IdentifierInNsd"
1042
1043
1044
1045
1046
1047
      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"
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
      name:
        description: >
          Human readable name of the monitoring parameter, as defined in the VNFD.
        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

1058
1059
1060
1061
  VnfExtCpInfo:
    description: >
      This type represents information about an external CP of a VNF. It shall comply 
      with the provisions defined in Table 6.5.3.70-1.
piscione's avatar
piscione committed
1062
1063
1064
1065
1066
      NOTE 1:	The attributes "associatedVnfcCpId", "associatedVipCpId" and
      "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present.
      NOTE 2:	An external CP instance is not associated to a link
      port in the cases indicated for the “extLinkPorts” attribute in clause 6.5.3.26.

1067
1068
1069
1070
    type: object
    required:
      - id
      - cpdId
1071
    oneOf:
1072
1073
1074
1075
      - required:
        - associatedVnfcCpId
      - required:
        - associatedVnfVirtualLinkId
1076
1077
1078
1079
    properties:
      id:
        description: >
          Identifier of the external CP instance and the related information instance.
1080
        $ref: "#/definitions/IdentifierInVnf"
1081
1082
1083
      cpdId:
        description: >
          Identifier of the external CPD, VnfExtCpd, in the VNFD.
1084
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
1096
      cpConfigId:
        description: >
          Identifier that references the applied "VnfExtCpConfig" entry in the "cpConfig"
          map of the "currentVnfExtCpData" in the "ExtVirtualLinkInfo" structure.
        $ref: "../../definitions/SOL005_def.yaml#/definitions/IdentifierInVnfd"
      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"
1097
1098
1099
1100
1101
1102
      cpProtocolInfo:
        description: >
          Network protocol information for this CP.
        type: array
        minItems: 1
        items:
1103
          $ref: "#/definitions/CpProtocolInfo"
1104
1105
1106
1107
      extLinkPortId:
        description: >
          Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo" 
          structure. Shall be present if the CP is associated to a link port.
piscione's avatar
piscione committed
1108
          See note 2.
1109
        $ref: "../../definitions/SOL005_def.yaml#/definitions/Identifier"
1110
1111
1112
      metadata:
        description: >
          Metadata about this external CP.
1113
        $ref: "../../definitions/SOL005_def.yaml#/definitions/KeyValuePairs"
1114
1115
      associatedVnfcCpId:
        description: >
1116
1117
1118
1119
1120
1121
1122
          Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure that
          represents the VNFC CP which is exposed by this external CP instance, either
          directly or via a floating IP address. Shall be present in case this CP instance
          maps to a VNFC CP.
          The attributes "associatedVnfcCpId", "associatedVipCpId" and "associatedVnfVirtualLinkId"
          are mutually exclusive. Exactly one shall be present.
        $ref: "#/definitions/IdentifierInVnf"
piscione's avatar
piscione committed
1123
1124
1125
1126
1127
1128
1129
      associatedVipCpId:
        description: >
          Identifier of the VIP CP instance that is exposed as this VnfExtCp instance, either
          directly or via a floating IP address, and the related "VipCpInfo" structure
          in "VnfInstance". Shall be present if the cpdId of this VnfExtCp has a vipCpd
          attribute. See note 1.
        $ref: "#/definitions/IdentifierInVnf"
1130
1131
1132
      associatedVnfVirtualLinkId:
        description: >
          Identifier of the "VnfVirtualLinkResourceInfo" structure that represents 
1133
1134
1135
1136
1137
1138
1139
          the internal VL or of the "ExtManagedVirtualLinkInfo" structure that represents
          the externally-managed internal VL, which is exposed by this external CP instance.
          Shall be present in case this CP instance maps to an internal VL (including
          externally-managed internal VL).
          The attributes "associatedVnfcCpId", "associatedVipCpId" and
          "associatedVnfVirtualLinkId" are mutually exclusive. Exactly one shall be present.
        $ref: "#/definitions/IdentifierInVnf"
1140

1141
1142
1143
1144
1145
  CpGroupInfo:
    description: >
      This type represents describes a group of CPs and/or SAPs pairs associated to 
      the same position in an NFP. It shall comply with the provisions defined in 
      Table 6.5.3.71-1.
piscione's avatar
piscione committed
1146
1147
1148
      NOTE:	All CP or SAP pairs in a group shall be instantiated from connection
      point descriptors or service access point descriptors referenced in the corresponding
      NfpPositionDesc.
1149
1150
1151
1152
1153
1154
1155
1156
    type: object
    properties:
      cpPairInfo:
        description: >
          One or more pair(s) of ingress and egress CPs or SAPs which the NFP passes by.
          All CP or SAP pairs in a group shall be instantiated from connection point 
          descriptors or service access point descriptors referenced in the corresponding 
          NfpPositionDesc.
piscione's avatar
piscione committed
1157
1158

          See note.
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
        type: array
        minItems: 1
        items:
          $ref: "#/definitions/CpPairInfo"
      forwardingBehaviour:
        description: >
          Identifies a rule to apply to forward traffic to the ingress CPs or SAPs of 
          the group.
          Permitted values:
          * ALL = Traffic flows shall be forwarded simultaneously to all CPs or SAPs 
          of the group.
          * LB = Traffic flows shall be forwarded to one CP or SAP of the group selected 
          based on a loadbalancing algorithm.
        type: string
        enum:
          - ALL
          - LB
      forwardingBehaviourInputParameters:
        description: >
          Provides input parameters to configure the forwarding behaviour (e.g. identifies 
          a load balancing algorithm and criteria).
        $ref: "#/definitions/ForwardingBehaviourInputParameters"

1182
  CpPairInfo:
1183
1184
1185
    description: >
      This type represents describes a pair of ingress and egress CPs or SAPs which 
      the NFP passes by. It shall comply with the provisions defined in Table 6.5.3.72-1.
piscione's avatar
piscione committed
1186
1187
1188

      NOTE 1:	The presence of a single vnfExpCpId, pnfExtCpId, or sapId occurrence indicates that the CP or SAP is used both as an ingress and egress port at a particular NFP position.
      NOTE 2:	Only one of these three attributes shall be present.
1189
1190
1191
1192
1193
    type: object
    properties:
      vnfExtCpIds:
        description: >
          Identifier(s) of the VNF CP(s) which form the pair.
piscione's avatar
piscione committed
1194
1195

          See note 1 and note 2.
1196
1197
1198
        type: array
        maxItems: 2
        items:
1199
          $ref: "#/definitions/IdentifierInVnf"
1200
1201
1202
      pnfExtCpIds:
        description: >
          Identifier(s) of the PNF CP(s) which form the pair.
piscione's avatar
piscione committed
1203
1204

          See note 1 and note 2.
1205
1206
1207
        type: array
        maxItems: 2
        items:
1208
          $ref: "#/definitions/IdentifierInPnf"
1209
1210
1211
      sapIds:
        description: >
          Identifier(s) of the SAP(s) which form the pair.
piscione's avatar
piscione committed
1212
1213

          See note 1 and note 2.
1214
1215
1216
        type: array
        maxItems: 2
        items:
1217
          $ref: "#/definitions/IdentifierInNs"
1218

1219
1220
1221
1222
  ForwardingBehaviourInputParameters:
    description: >
      This type represents provides input parameters to configure the forwarding behaviour. 
      It shall comply with the provisions defined in Table 6.5.3.73-1.
piscione's avatar
piscione committed
1223
1224
      NOTE 1:	If applicable to the algorithm but not provided, default values determined by the VIM or NFVI are expected to be used.
      NOTE 2:	Weight applies to the CP instances in the order they have been created.
1225
1226
1227
1228
1229
1230
1231
1232
1233
1234
1235
1236
1237
1238
1239
1240
1241
1242
1243
1244
1245
    type: object
    properties:
      algortihmName:
        description: >
          May be included if forwarding behaviour is equal to LB. Shall not be included otherwise.
          Permitted values:
          * ROUND_ROBIN
          * LEAST_CONNECTION
          * LEAST_TRAFFIC
          * LEAST_RESPONSE_TIME
          * CHAINED_FAILOVER
          * SOURCE_IP_HASH
          * SOURCE_MAC_HASH
        type: string
        enum:
          - ROUND_ROBIN
          - LEAST_CONNECTION
          - LEAST_TRAFFIC
          - LEAST_RESPONSE_TIME
          - CHAINED_FAILOVER
          - SOURCE_IP_HASH
1246
          - SOURCE_MAC_HASH
1247
1248
1249
1250
      algorithmWeights:
        description: >
          Percentage of messages sent to a CP instance. May be included if applicable to 
          the algorithm.
piscione's avatar
piscione committed
1251
          See note 1 and note 2.
1252
1253
1254
1255
        type: array
        items:
          type: integer

1256
1257
1258
1259
  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.
piscione's avatar
piscione committed
1260
1261
1262
      NOTE:	This attribute allows to signal the addition of further types of layer and
      protocol in future versions of the present document in a backwards-compatible way.
      In the current version of the present document, only IP over Ethernet is supported.
1263
1264
1265
1266
1267
1268
1269
1270
1271
    type: object
    required:
      - layerProtocol
      - ipOverEthernet
    properties:
      layerProtocol:
        description: >
          The identifier of layer(s) and protocol(s)
          associated to the network address information.
1272
1273
1274
1275
          Permitted values:
            - IP_OVER_ETHERNET

          See note.
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
        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:
1288
1289
    description: >
      This type represents information about a network address that has been assigned.
piscione's avatar
piscione committed
1290
1291
1292
1293
1294
1295
1296
1297
1298

      NOTE 1:	At least one of "macAddress" or "ipAddresses" shall be present.
      NOTE 2:	Exactly one of "addresses" or "addressRange" shall be present.
      NOTE 3:	If the Cp instance represents a subport in a trunk, "segmentationId" shall be present. Otherwise it shall not be present.
      NOTE 4:	Depending on the NFVI networking infrastructure, the "segmentationId" may indicate the actual network segment value
      (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier
      used between the application and the NFVI networking infrastructure to identify the network sub-interface
      of the trunk port in question. In the latter case the NFVI infrastructure will map this local
      "segmentationId" to whatever "segmentationId" is actually used by the NFVI's transport technology.
1299
    type: object
1300
1301
1302
1303
1304
    anyOf:
      - required:
        - macAddress
      - required:
        - ipAddresses
1305
1306
1307
1308
    properties:
      macAddress:
        description: >
          Assigned MAC address.
piscione's avatar
piscione committed
1309
1310

          See note 1.
1311
        $ref: "#/definitions/MacAddress"
1312
1313
1314
      segmentationId:
        description: >
          Identification of the network segment to which the Cp instance connects to.
piscione's avatar
piscione committed
1315
          See note 3 and note 4.
1316
        type: string
1317
1318
1319
1320
1321
      ipAddresses:
        description: >
          Addresses assigned to the CP instance. Each entry represents IP
          addresses assigned by fixed or dynamic IP address assignment per
          subnet.
piscione's avatar
piscione committed
1322
          See note 1.
1323
1324
1325
1326
1327
        type: array
        items:
          type: object
          required:
            - type
1328
1329
1330
1331
1332
          oneOf:
            - required:
                - addresses
            - required:
                - addressRange