Newer
Older
rameshnaraya
committed
# Copyright (c) ETSI 2017.
# https://forge.etsi.org/etsi-forge-copyright-notice.txt
definitions:
CreateNsRequest:
type: object
required:
- nsdId
- nsName
- nsDescription
properties:
nsdId:
description: >
Identifier of the NSD that defines the NS instance to be
created.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsName:
description: >
Human-readable name of the NS instance to be created.
type: string
nsDescription:
description: >
Human-readable description of the NS instance to be created.
type: string
moscatelli
committed
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
NsInstance:
description: >
This type represents a response for Query NS operation.
It shall comply with the provisions defined in Table 6.5.2.10-1.
type: object
required:
- id
- nsInstanceName
- nsInstanceDescription
- nsdId
- nsdInfoId
- nsState
properties:
id:
description: >
Identifier of the NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsInstanceName:
description: >
Human readable name of the NS instance.
type: string
nsInstanceDescription:
description: >
Human readable description of the NS instance.
type: string
nsdId:
description: >
Identifier of the NSD on which the NS instance is based.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsdInfoId:
description: >
Identifier of the NSD information object on which the
NS instance is based. This identifier was allocated by the NFVO.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
flavourId:
description: >
Identifier of the NS deployment flavor applied to
the NS instance. This attribute shall be present if the nsState attribute
value is INSTANTIATED.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfInstance:
description: >
Information on constituent VNF(s) of the NS instance.
type: array
items:
moscatelli
committed
$ref: "#/definitions/VnfInstance"
pnfInfo:
description: >
Information on the PNF(s) that are part of the NS instance.
type: array
items:
moscatelli
committed
$ref: "#/definitions/PnfInfo"
virtualLinkInfo:
description: >
Information on the VL(s) of the NS instance.
This attribute shall be present if the nsState attribute
value is INSTANTIATED and if the NS instance has
specified connectivity.
type: array
items:
moscatelli
committed
$ref: "#/definitions/NsVirtualLinkInfo"
vnffgInfo:
description: >
Information on the VNFFG(s) of the NS instance.
type: array
items:
moscatelli
committed
$ref: "#/definitions/VnffgInfo"
sapInfo:
description: >
Information on the SAP(s) of the NS instance.
type: array
moscatelli
committed
items:
$ref: "#/definitions/SapInfo"
nestedNsInstanceId:
description: >
Identifier of the nested NS(s) of the NS instance.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsState:
description: >
The state of the NS instance.
Permitted values:
NOT_INSTANTIATED: The NS instance is
terminated or not instantiated.
INSTANTIATED: The NS instance is instantiated.
type: string
moscatelli
committed
enum:
moscatelli
committed
- INSTANTIATED
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"
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
rameshnaraya
committed
value is INSTANTIATED.
moscatelli
committed
$ref: "#/definitions/NsScaleInfo"
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
moscatelli
committed
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
_links:
type: object
rameshnaraya
committed
description: Links to resources related to this resource.
required:
- self
properties:
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
nestedNsInstances:
description: >
Links to resources related to this notification.
type: array
items:
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Link"
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
instantiate:
description: >
Link to the "instantiate" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance in
NOT_INSTANTIATED state).
$ref: "SOL005_def.yaml#/definitions/Link"
terminate:
description: >
Link to the "terminate" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance is in
INSTANTIATED state).
$ref: "SOL005_def.yaml#/definitions/Link"
update:
description: >
Link to the "update" task resource, if the related
operation is possible based on the current status of
this NS instance resource (i.e. NS instance is in
INSTANTIATED state).
$ref: "SOL005_def.yaml#/definitions/Link"
scale:
description: >
Link to the "scale" task resource, if the related
operation is supported for this NS instance, and is
possible based on the current status of this NS
instance resource (i.e. NS instance is in
INSTANTIATED state).
$ref: "SOL005_def.yaml#/definitions/Link"
heal:
description: >
Link to the "heal" task resource, if the related
operation is supported for this NS instance, and is
possible based on the current status of this NS
instance resource (i.e. NS instance is in
INSTANTIATED state).
$ref: "SOL005_def.yaml#/definitions/Link"
moscatelli
committed
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
VnfInstance:
description: >
This type represents a VNF instance.
type: object
required:
- id
- vnfdId
- vnfProvider
- vnfProductName
- vnfSoftwareVersion
- vnfdVersion
- vnfPkgId
- instantiationState
properties:
id:
description: >
Identifier of the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfInstanceName:
description: >
Name of the VNF instance.
This attribute can be modified with the PATCH method.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance.
This attribute can be modified with the PATCH method.
type: string
vnfdId:
description: >
Identifier of the VNFD on which the VNF instance is based.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfProvider:
description: >
Provider of the VNF and the VNFD. The value is copied from the VNFD.
type: string
vnfProductName:
description: >
Name to identify the VNF Product. The value is copied from the VNFD.
type: string
vnfSoftwareVersion:
description: >
Software version of the VNF. The value is copied from the VNFD.
$ref: "#/definitions/Version"
vnfdVersion:
description: >
Identifies the version of the VNFD. The value is copied from the VNFD.
$ref: "#/definitions/Version"
vnfPkgId:
description: >
moscatelli
committed
Identifier of information held by the NFVO about
the specific VNF package on which the VNF is
based. This identifier was allocated by the NFVO.
This attribute can be modified with the PATCH
method.
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfConfigurableProperties:
description: >
Current values of the configurable properties of the VNF instance.
Configurable properties referred in this attribute are declared in
the VNFD.
ETSI GS NFV-SOL 001 specifies the structure and format of the VNFD
based on TOSCA specifications.
VNF configurable properties are sometimes also referred to as
configuration parameters applicable to a VNF. Some of these are set
prior to instantiation and cannot be modified if the VNF is
instantiated, some are set prior to instantiation (are part of
initial configuration) and can be modified later, and others can be
set only after instantiation. The applicability of certain
configuration may depend on the VNF and the required operation of
the VNF at a certain point in time.
These configurable properties include the following standard
attributes, which are declared in the VNFD if auto-scaling and/or
auto-healing are supported by the VNF:
* isAutoscaleEnabled: If present, the VNF supports auto-scaling. If
set to true, auto-scaling is currently enabled. If set to false,
auto-scaling is currently disabled.
* isAutohealEnabled: If present, the VNF supports auto-healing. If
set to true, auto-healing is currently enabled. If set to false,
auto-healing is currently disabled.
This attribute can be modified with the PATCH method.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
vimId:
description: >
Identifier of a VIM that manages resources for the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
instantiationState:
description: >
The instantiation state of the VNF.
type: string
enum:
- NOT_INSTANTIATED
- INSTANTIATED
instantiatedVnfInfo:
description: >
Information specific to an instantiated VNF instance. This attribute
shall be present if the instantiateState attribute value is INSTANTIATED.
type: object
required:
- flavourId
- vnfState
properties:
flavourId:
description: >
Identifier of the VNF deployment flavor applied to this VNF instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfState:
description: >
The state of the VNF instance.
$ref: "#/definitions/VnfOperationalStateType"
scaleStatus:
description: >
Scale status of the VNF, one entry per aspect. Represents for every
scaling aspect how "big" the VNF has been scaled w.r.t. that aspect.
type: array
items:
$ref: "#/definitions/VnfScaleInfo"
extCpInfo:
description: >
Information about the external CPs exposed by the VNF instance.
type: array
minItems: 1
items:
$ref: "#/definitions/VnfExtCpInfo"
extVirtualLinkInfo:
description: >
Information about the external VLs the VNF instance is connected to.
type: array
items:
$ref: "#/definitions/ExtVirtualLinkInfo"
extManagedVirtualLinkInfo:
description: >
External virtual links the VNF instance is connected to.
type: array
items:
$ref: "#/definitions/ExtManagedVirtualLinkInfo"
monitoringParameters:
description: >
Performance metrics tracked by the VNFM (e.g. for
auto-scaling purposes) as identified by the VNF
provider in the VNFD.
$ref: "#/definitions/VnfMonitoringParameter"
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: >
moscatelli
committed
Information about the virtualised compute and storage resources used
by the VNFCs of the VNF instance.
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
type: array
items:
$ref: "#/definitions/VnfcResourceInfo"
virtualLinkResourceInfo:
description: >
Information about the virtualised network resources used by the VLs
of the VNF instance.
type: array
items:
$ref: "#/definitions/VnfVirtualLinkResourceInfo"
virtualStorageResourceInfo:
description: >
Information on the virtualised storage resource(s) used as storage for the VNF instance.
type: array
items:
$ref: "#/definitions/VirtualStorageResourceInfo"
metadata:
description: >
Additional VNF-specific metadata describing the VNF instance.
Metadata that are writeable are declared in the VNFD.
This attribute can be modified with the PATCH method.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
extensions:
description: >
VNF-specific attributes that affect the lifecycle management of this
VNF instance by the VNFM, or the lifecycle management scripts.
Extensions that are writeable are declared in the VNFD.
This attribute can be modified with the PATCH method.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
LccnLinks:
description: >
This type represents the links to resources that a notification can contain.
type: object
moscatelli
committed
required:
moscatelli
committed
properties:
nsInstance:
description: >
Link to the resource representing the NS instance to
which the notified change applies..
$ref: "../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
subscription:
description: >
Link to the subscription that triggered this notification.
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
description: >
Link to the lifecycle operation occurrence that this
notification is related to. Shall be present if there is a
related lifecycle operation occurrence
$ref: ""../../definitions/SOL005_def.yaml#/definitions/NotificationLink"
moscatelli
committed
Version:
description: >
A Version.
type: string
moscatelli
committed
VnfOperationalStateType:
type: string
enum:
- STARTED
- STOPPED
moscatelli
committed
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
VnfScaleInfo:
required:
- aspectId
- scaleLevel
type: object
properties:
aspectId:
description: >
Identifier of the scaling aspect.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
scaleLevel:
description: >
Indicates the scale level. The minimum value shall be 0 and the
maximum value shall be <= maxScaleLevel as described in the VNFD.
type: integer
PnfInfo:
description: >
This type represents the information about a PNF that is part of an NS instance.
It shall comply with the provisions
defined in Table 6.5.3.13-1.
type: object
required:
- pnfId
- pnfdId
- pnfdInfoId
- pnfProfileId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfName:
description: >
Name of the PNF.
type: string
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfdInfoId:
description: >
Identifier of the PNFD information onject related to this
PNF. This identifier is allocated by the NFVO
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfProfileId:
description: >
Identifier of the related PnfProfile in the NSD on which
the PNF is based.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
cpInfo:
description: >
Information on the external CP of the PNF.
$ref: "#/definitions/PnfExtCpInfo"
moscatelli
committed
PnfExtCpInfo:
description: >
This type represents the information about the external CP of the PNF.
It shall comply with the provisions defined in
Table 6.5.3.17-1.
type: object
required:
- cpInstanceId
- cpdId
properties:
cpInstanceId:
description: >
Identifier of the CP in the scope of the PNF.
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
cpdId:
description: >
Identifier of (reference to) the Connection Point
Descriptor (CPD) for this CP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
cpProtocolData:
description: >
Parameters for configuring the network protocols on the CP.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/CpProtocolData"
moscatelli
committed
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
- nsVirtualLinkProfileId
properties:
id:
description: >
Identifier of the VL instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nsVirtualLinkDescId:
description: >
Identifier of the VLD in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
nsVirtualLinkProfileId:
description: >
Identifier of the VL profile in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
resourceHandle:
description: >
Identifier(s) of the virtualised network resource(s)
realizing the VL instance. See note.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
linkPort:
description: >
Link ports of the VL instance.
Cardinality of zero indicates that no port has yet been
created for the VL instance.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsLinkPortInfo"
VnffgInfo:
description: >
Information on the VNFFG(s) of the NS instance.
type: object
required:
- id
- vnffgdId
- vnfInstanceId
- pnfInfoId
properties:
id:
description: >
Identifier of this VNFFG instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnffgdId:
description: >
Identifier of the VNFFGD in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfInstanceId:
description: >
Identifier(s) of the constituent VNF instance(s) of this VNFFG instance.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfdInfoId:
description: >
Identifier(s) of the constituent PNF instance(s) of this
VNFFG instance.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsVirtualLinkInfoId:
description: >
Identifier(s) of the constituent VL instance(s) of this
VNFFG instance.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nsCpHandle:
description: >
Identifiers of the CP instances attached to the
constituent VNFs and PNFs or the SAP instances of the
VNFFG. See note.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsCpHandle"
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
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.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
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.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
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:
$ref: "#/definitions/NsCpHandle"
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
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.
moscatelli
committed
type: object
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance associated to the CP instance.
This attribute shall be present if the CP instance is VNF external CP.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfExtCpInstanceId:
description: >
Identifier of the VNF external CP instance in the scope
of the VNF instance. This attribute shall be present if the CP instance is VNF
external CP. See notes 1 and 4.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
pnfInfoId:
description: >
Identifier of the PNF instance associated to the CP
instance. This attribute shall be present if the CP instance is PNF
external CP. See notes 2 and 4.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfExtCpInstanceId:
description: >
Identifier of the PNF external CP instance in the scope
of the PNF. This attribute shall be present if the CP instance is PNF
external CP. See notes 2 and 4.
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
nsInstanceId:
description: >
Identifier of the NS instance associated to the SAP
instance. This attribute shall be present if the CP instance is NS
SAP. See notes 3 and 4.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsSapInstanceId:
description: >
Identifier of the SAP instance in the scope of the NS
instance. This attribute shall be present if the CP instance is NS
SAP. See notes 3 and 4.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
moscatelli
committed
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
SapInfo:
description: >
This type represents an SAP instance. It shall comply with the provisions defined in Table 6.5.3.67-1.
type: object
required:
- id
- sapdId
- sapName
- sapProtocolInfo
properties:
id:
description: >
Identifier of the SAP instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
sapdId:
description: >
Identifier of the SAPD in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
sapName:
description: >
Human readable name for the SAP instance.
type: string
description:
description: >
Human readable description for the SAP instance.
type: string
sapProtocolInfo:
description: >
Network protocol information for this SAP.
type: array
moscatelli
committed
items:
$ref: "#/definitions/CpProtocolInfo"
moscatelli
committed
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.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
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
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.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
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
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.
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of the external CP instance and the related information instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the external CPD, VnfExtCpd, in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
minItems: 1
items:
$ref: "#/definitions/CpProtocolInfo"
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
extLinkPortId:
description: >
Identifier of the "extLinkPortInfo" structure inside the "extVirtualLinkInfo"
structure. Shall be present if the CP is associated to a link port.
$ref: "#/definitions/CpProtocolInfo"
metadata:
description: >
Metadata about this external CP.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
associatedVnfcCpId:
description: >
Identifier of the "vnfcCpInfo" structure in "VnfcResourceInfo" structure
that represents the VNFC CP which is exposed by this external CP instance.
Shall be present in case this CP instance maps to a VNFC CP(s).
The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are
mutually exclusive. One and only one shall be present.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
associatedVnfVirtualLinkId:
description: >
Identifier of the "VnfVirtualLinkResourceInfo" structure that represents
the internal VL, which is exposed by this external CP instance. Shall be
present in case this CP instance maps to an internal VL.
The attributes "associatedVnfcCpId" and "associatedVnfVirtualLinkId" are
mutually exclusive. One and only one shall be present.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
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.
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.
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"
CpPairInfo:
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
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.
type: object
properties:
vnfExtCpIds:
description: >
Identifier(s) of the VNF CP(s) which form the pair.
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.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
pnfExtCpIds:
description: >
Identifier(s) of the PNF CP(s) which form the pair.
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.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
sapIds:
description: >
Identifier(s) of the SAP(s) which form the pair.
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.
type: array
maxItems: 2
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
Samir Medjiah
committed
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
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.
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
- SOURCE_MAC_HASH
algorithmWeights:
description: >
Percentage of messages sent to a CP instance. May be included if applicable to
the algorithm.
If applicable to the algorithm but not provided, default values determined by
the VIM or NFVI are expected to be used.
Weight applies to the CP instances in the order they have been created.
type: array
items:
type: integer
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
CpProtocolInfo:
description: >
This type describes the protocol layer(s) that a CP or SAP uses together with protocol-related information, like
addresses. It shall comply with the provisions defined in Table 6.5.3.58-1.
type: object
required:
- layerProtocol
- ipOverEthernet
properties:
layerProtocol:
description: >
The identifier of layer(s) and protocol(s)
associated to the network address information.
Permitted values: IP_OVER_ETHERNET See note.
type: string
enum:
- IP_OVER_ETHERNET
ipOverEthernet:
description: >
IP addresses over Ethernet to assign to the CP
or SAP instance. Shall be present if
layerProtocol is equal to "
IP_OVER_ETHERNET", and shall be absent otherwise.
$ref: "#/definitions/IpOverEthernetAddressInfo"
IpOverEthernetAddressInfo:
moscatelli
committed
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
1038
1039
1040
1041
1042
1043
1044
1045
1046
1047
1048
1049
1050
1051
1052
1053
1054
1055
1056
1057
1058
1059
1060
1061
1062
1063
1064
1065
1066
1067
1068
1069
1070
1071
1072
1073
1074
1075
1076
1077
1078
1079
1080
1081
1082
1083
1084
1085
1086
1087
1088
1089
1090
1091
1092
1093
1094
1095
description: >
This type represents information about a network address that has been assigned.
It shall comply with the provisions defined in Table 6.5.3.18-1.
type: object
required:
- macAddress
- ipAddresses
- subnetId
- addresses
- addressRange
properties:
macAddress:
description: >
Assigned MAC address.
$ref: "SOL005_def.yaml#/definitions/MacAddress"
ipAddresses:
description: >
Addresses assigned to the CP instance. Each entry represents IP
addresses assigned by fixed or dynamic IP address assignment per
subnet.
type: array
items:
type: object
required:
- type
properties:
type:
description: >
The type of the IP addresses.
Permitted values: IPV4, IPV6.
type: string
enum:
- IPV4
- IPV6
addresses:
description: >
Fixed addresses assigned (from the subnet defined by
"subnetId" if provided).
type: array
items:
$ref: "SOL005_def.yaml#/definitions/IpAddress"
isDynamic:
description: >
Indicates whether this set of addresses was assigned
dynamically (true) or based on address information provided as
input from the API consumer (false). Shall be present if
"addresses" is present and shall be absent otherwise.
type: boolean
addressRange:
description: >
An IP address range used, e.g., in case of egress connections.
Exactly one of "addresses" or "addressRange" shall be present.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "SOL005_def.yaml#/definitions/IpAddress"
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "SOL005_def.yaml#/definitions/IpAddress"
subnetId:
description: >
Subnet defined by the identifier of the subnet resource in
the VIM.
In case this attribute is present, IP addresses are bound
to that subnet.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVim"
type:
description: >
The type of the IP addresses
type: string
enum:
- PV4
- PV6
addresses:
description: >
Fixed addresses assigned (from the subnet
defined by "subnetId" if provided). See note.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/IpAddress"
isDynamic:
description: >
Indicates whether this set of addresses was
assigned dynamically (true) or based on address
information provided as input from the API
consumer (false). Shall be present if "addresses"
is present and shall be absent otherwise.
type: boolean
addressRange:
description: >
An IP address range used, e.g. in case of egress
connections. See note.
type: object
required:
- minAddress
- maxAddress
properties:
minAddress:
description: >
Lowest IP address belonging to the range.
$ref: "SOL005_def.yaml#/definitions/IpAddress"
maxAddress:
description: >
Highest IP address belonging to the range
$ref: "SOL005_def.yaml#/definitions/IpAddress"
minAddress:
description: >
Lowest IP address belonging to the range
$ref: "SOL005_def.yaml#/definitions/IpAddress"
maxAddress:
description: >
Highest IP address belonging to the range.
$ref: "SOL005_def.yaml#/definitions/IpAddress"
subnetId:
description: >
Subnet defined by the identifier of the subnet
resource in the VIM.
In case this attribute is present, IP addresses
are bound to that subnet.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVim"
ExtVirtualLinkInfo:
type: object
required:
- id
- resourceHandle
properties:
id:
moscatelli
committed
description: >
Identifier of the external VL and the related external VL
information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
1130
1131
1132
1133
1134
1135
1136
1137
1138
1139
1140
1141
1142
1143
1144
1145
1146
1147
1148
1149
1150
1151
1152
1153
1154
1155
1156
1157
1158
1159
1160
1161
1162
1163
1164
1165
1166
1167
1168
1169
1170
1171
1172
1173
1174
1175
1176
1177
1178
1179
1180
1181
1182
1183
1184
1185
1186
1187
1188
1189
1190
1191
1192
1193
1194
1195
1196
1197
1198
1199
1200
1201
1202
1203
1204
resourceHandle:
description: >
Reference to the resource realizing this VL.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
extLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/ExtLinkPortInfo"
ExtLinkPortInfo:
description: >
This type represents information about a link port of an external VL,
i.e. a port providing connectivity for the VNF to an NS VL.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has
created the link port.
$ref: "SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Reference to the virtualised resource realizing this link port.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
Identifier of the external CP of the VNF connected to this link
port. There shall be at most one link port associated with any
external connection point instance. The value refers to an
"extCpInfo" item in the VnfInstance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
ExtManagedVirtualLinkInfo:
type: object
required:
- id
- vnfVirtualLinkDescId
properties:
id:
description: >
Identifier of the externally-managed internal VL and the related
externally-managed VL information instance.
The identifier is assigned by the NFV-MANO entity that manages this
VL instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
networkResource:
description: >
Reference to the VirtualNetwork resource.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
vnfLinkPorts:
description: >
Link ports of this VL.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
VnfLinkPortInfo:
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that has created the link port.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
resourceHandle:
description: >
Reference to the virtualised network resource realizing this link port.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
cpInstanceId:
description: >
When the link port is used for external connectivity by the VNF,
this attribute represents the identifier of the external CP of the
VNF to be connected to this link port.
When the link port is used for internal connectivity in the VNF,
this attribute represents the VNFC CP to be connected to this link
port.
Shall be present when the link port is used for external
connectivity by the VNF.
may be present if used to reference a VNFC CP instance.
There shall be at most one link port associated with any external
connection point instance or internal connection point
(i.e. VNFC CP) instance.
The value refers to an "extCpInfo" item in the VnfInstance or a
"vnfcCpInfo" item of a "vnfcResouceInfo" item in the VnfInstance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpInstanceType:
description: >
Type of the CP instance that is identified by cpInstanceId.
Shall be present if "cpInstanceId" is present, and shall be
absent otherwise.
Permitted values:
* VNFC_CP: The link port is connected to a VNFC CP
* EXT_CP: The link port is associated to an external CP.
type: string
enum:
- VNFC_CP
- EXT_CP
MonitoringParameter:
type: object
required:
- id
- value
- timeStamp
properties:
id:
description: >
Identifier of the monitoring parameter defined in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
name:
description: >
Human readable name of the monitoring parameter, as defined in the VNFD.
type: string
value:
description: >
Value of the monitoring parameter known to the VNFM (e.g. obtained
rameshnaraya
committed
for auto-scaling purposes).
The type of the "value" attribute (i.e. scalar, structure (Object in
JSON), or array (of scalars, arrays or structures/Objects)) is
assumed to be defined in an external measurement specification.
type: object
rameshnaraya
committed
timeStamp:
description: >
Represents the point in time when the measurement has been performed,
as known to the VNFM.
Should be formatted according to ETF RFC 3339.
type: string
1247
1248
1249
1250
1251
1252
1253
1254
1255
1256
1257
1258
1259
1260
1261
1262
1263
1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
1274
1275
1276
1277
1278
1279
1280
1281
1282
1283
1284
1285
1286
1287
1288
1289
1290
1291
1292
1293
1294
1295
1296
1297
1298
1299
1300
1301
1302
1303
1304
1305
1306
1307
1308
1309
1310
1311
1312
1313
1314
1315
1316
1317
VnfcResourceInfo:
description: >
This type represents the information on virtualised compute and storage
resources used by a VNFC in a VNF instance.
type: object
required:
- id
- vduId
- computeResource
properties:
id:
description: >
Identifier of this VnfcResourceInfo instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
vduId:
description: >
Reference to the applicable VDU in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
computeResource:
description: >
Reference to the VirtualCompute resource.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
storageResourceIds:
description: >
References to the VirtualStorage resources. The value refers to a
VirtualStorageResourceInfo item in the VnfInstance.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfcCpInfo:
description: >
CPs of the VNFC instance.
Shall be present when that particular CP of the VNFC instance is
associated to an external CP of the VNF instance.
May be present otherwise.
type: array
items:
type: object
required:
- id
- cpdId
properties:
id:
description: >
Identifier of this VNFC CP instance and the associated array
entry.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpdId:
description: >
Identifier of the VDU CPD, cpdId, in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfExtCpId:
description: >
When the VNFC CP is exposed as external CP of the VNF, the
identifier of this external VNF CP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
cpProtocolInfo:
description: >
Network protocol information for this CP.
type: array
items:
$ref: "#/definitions/CpProtocolInfo"
vnfLinkPortId:
description: >
Identifier of the "vnfLinkPorts" structure in the
"VnfVirtualLinkResourceInfo" structure. Shall be present if
the CP is associated to a link port.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
metadata:
description: >
Metadata about this CP.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
metadata:
description: >
Metadata about this resource.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
VnfVirtualLinkResourceInfo:
moscatelli
committed
1331
1332
1333
1334
1335
1336
1337
1338
1339
1340
1341
1342
1343
1344
1345
1346
1347
1348
1349
1350
1351
1352
1353
1354
1355
1356
1357
1358
1359
1360
1361
1362
1363
1364
1365
1366
1367
1368
1369
1370
description: >
This type represents the information that allows addressing a virtualised
resource that is used by an internal VL instance in a VNF instance.
type: object
required:
- id
- vnfVirtualLinkDescId
- networkResource
properties:
id:
description: >
Identifier of this VnfVirtualLinkResourceInfo instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
vnfVirtualLinkDescId:
description: >
Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
networkResource:
description: >
Reference to the VirtualNetwork resource.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfLinkPorts:
description: >
Links ports of this VL.
Shall be present when the linkPort is used for external connectivity
by the VNF (refer to VnfLinkPortInfo).
May be present otherwise.
type: array
items:
$ref: "#/definitions/VnfLinkPortInfo"
metadata:
description: >
Metadata about this resource.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
VirtualStorageResourceInfo:
moscatelli
committed
1372
1373
1374
1375
1376
1377
1378
1379
1380
1381
1382
1383
1384
1385
1386
1387
1388
1389
1390
1391
1392
1393
1394
1395
1396
1397
1398
1399
1400
1401
1402
description: >
This type represents the information that allows addressing a virtualised
resource that is used by a VNF instance.
type: object
required:
- id
- virtualStorageDescId
- storageResource
properties:
id:
description: >
Identifier of this VirtualStorageResourceInfo instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
description: >
Identifier of the VirtualStorageDesc in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
storageResource:
description: >
Reference to the VirtualStorage resource.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
reservationId:
description: >
The reservation identifier applicable to the resource. It shall be
present when an applicable reservation exists.
$ref: "SOL005_def.yaml#/definitions/Identifier"
metadata:
description: >
Metadata about this resource.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
1404
1405
1406
1407
1408
1409
1410
1411
1412
1413
1414
1415
1416
1417
1418
1419
1420
1421
1422
1423
1424
1425
1426
1427
1428
1429
1430
1431
1432
1433
description: >
This type represents information about a link port of a VL instance.
It shall comply with the provisions defined in Table 6.5.3.55-1.
type: object
required:
- id
- resourceHandle
properties:
id:
description: >
Identifier of this link port as provided by the entity that
has created the link port.
$ref: "SOL005_def.yaml#/definitions/Identifier"
resourceHandle:
description: >
Identifier of the virtualised network resource realizing
this link port.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
nsCpHandle:
description: >
Identifier of the CP/SAP instance to be connected to this
link port. The value refers to a vnfExtCpInfo item in the
VnfInstance, or a pnfExtCpInfo item in the PnfInfo, or a
sapInfo item in the NS instance.
There shall be at most one link port associated with any
connection point instance.
type: array
items:
$ref: "#/definitions/NsCpHandle"
AffinityOrAntiAffinityRule:
moscatelli
committed
1435
1436
1437
1438
1439
1440
1441
1442
1443
1444
1445
1446
1447
1448
1449
1450
1451
1452
1453
1454
1455
1456
1457
1458
1459
1460
1461
1462
1463
1464
1465
1466
1467
1468
1469
1470
1471
1472
1473
1474
1475
1476
1477
1478
1479
1480
1481
1482
1483
1484
1485
1486
1487
1488
1489
1490
1491
1492
1493
1494
1495
1496
1497
1498
1499
1500
1501
1502
description: >
This type describes the additional affinity or anti-affinity rule
applicable between the VNF instances to be instantiated
in the NS instantiation operation request or between the VNF instances
to be instantiated in the NS instantiation
operation request and the existing VNF instances..
type: object
required:
- affinityOrAntiAffiinty
- scope
properties:
vnfdId:
description: >
Reference to a VNFD.
When the VNFD which is not used to instantiate VNF, it
presents all VNF instances of this type as the subjects
of the affinity or anti-affinity rule. The VNF instance
which the VNFD presents is not necessary as a part of
the NS to be instantiated.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfProfileId:
description: >
Reference to a vnfProfile defined in the NSD.
At least one VnfProfile which is used to instantiate VNF
for the NS to be instantiated as the subject of the affinity
or anti-affinity rule shall be present. When the VnfProfile
which is not used to instantiate VNF, it presents all VNF
instances of this type as the subjects of the affinity or
anti-affinity rule. The VNF instance which the VnfProfile
presents is not necessary as a part of the NS to be instantiated.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfInstanceId:
description: >
Reference to the existing VNF instance as the subject of
the affinity or anti-affinity rule. The existing VNF instance
is not necessary as a part of the NS to be instantiated.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
affinityOrAntiAffiinty:
description: >
The type of the constraint.
Permitted values:
AFFINITY
ANTI_AFFINITY.
type: string
enum:
- AFFINITY
- ANTI_AFFINITY
scope:
description: >
Specifies the scope of the rule where the placement
constraint applies.
Permitted values:
NFVI_POP
ZONE
ZONE_GROUP
NFVI_NODE.
type: string
enum:
- NFVI_POP
- ZONE
- ZONE_GROUP
- NFVI_NODE
InstantiateNsRequest:
type: object
required:
moscatelli
committed
- nsFlavourId
properties:
nsFlavourId:
description: >
Identifier of the NS deployment flavor to be instantiated.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
sapData:
description: >
moscatelli
committed
Create data concerning the SAPs of this NS.
moscatelli
committed
items:
$ref: "#/definitions/SapData"
addpnfData:
description: >
Information on the PNF(s) that are part of this NS.
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
vnfInstanceData:
description: >
Specify an existing VNF instance to be used in the NS.
If needed, the VNF Profile to be used for this VNF
instance is also provided.
The DF of the VNF instance shall match the VNF DF
present in the associated VNF Profile.
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
nestedNsInstanceData:
description: >
Specify an existing NS instance to be used as a nested
NS within the NS.
If needed, the NS Profile to be used for this nested NS
instance is also provided.
NOTE 2: The NS DF of each nested NS shall be one of the
allowed flavours in the associated NSD (as referenced in the
nestedNsd attribute of the NSD of the NS to be instantiated).
NOTE 3: The NSD of each referenced NSs (i.e. each
nestedInstanceId) shall match the one of the nested NSD in
the composite NSD.
moscatelli
committed
items:
$ref: "#/definitions/NestedNsInstanceData"
localizationLanguage:
description: >
Defines the location constraints for the VNF to be
instantiated as part of the NS instantiation.
An example can be a constraint for the VNF to be in a
specific geographic location..
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfLocationConstraint"
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
at the composite NS level (as opposed to the VNF level,
which is covered in additionalParamsForVnf), and as
opposed to the nested NS level, which is covered in
additionalParamForNestedNs.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
additionalParamForNestedNs:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per nested NS instance (as opposed to the composite NS
level, which is covered in additionalParamForNs, and as
opposed to the VNF level, which is covered in
additionalParamForVnf). This is for nested NS instances
that are to be created by the NFVO as part of the NS
instantiation and not for existing nested NS instances that
are referenced for reuse.
type: array
items:
$ref: "#/definitions/ParamsForNestedNs"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional parameter(s)
per VNF instance (as opposed to the composite NS level,
which is covered in additionalParamsForNs and as opposed
to the nested NS level, which is covered in
additionalParamForNestedNs). This is for VNFs that are
to be created by the NFVO as part of the NS instantiation
and not for existing VNF that are referenced for reuse.
moscatelli
committed
items:
$ref: "#/definitions/ParamsForVnf"
startTime:
description: >
Timestamp indicating the earliest time to instantiate the NS.
Cardinality "0" indicates the NS instantiation takes place immediately.
$ref: "SOL005_def.yaml#/definitions/DateTime"
nsInstantiationLevelId:
description: >
Identifies one of the NS instantiation levels declared in
the DF applicable to this NS instance. If not present, the
default NS instantiation level as declared in the NSD
shall be used.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalAffinityOrAntiAffinityRule:
moscatelli
committed
Specifies additional affinity or anti-affinity constraint for
the VNF instances to be instantiated as part of the NS
instantiation.
Shall not conflict with rules already specified in the NSD.
moscatelli
committed
items:
$ref: "#/definitions/AffinityOrAntiAffinityRule"
ParamsForNestedNs:
description: >
This type specifies additional parameters on a per-nested NS instance basis.
It shall comply with the provisions defined in Table 6.5.3.21a-1.
type: object
required:
- nsProfileId
properties:
nsProfileId:
description: >
Identifier of a NsProfile to which the additional parameters apply.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalParam:
description: >
Additional parameters that are to be applied on a per nested NS instance.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
description: >
This type defines the additional parameters for the VNF instance
to be created associated with an NS instance.
It shall comply with the provisions defined in Table 6.5.3.22-1.
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
additionalParams:
description: >
Additional parameters that are applied for the VNF
instance to be created.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
1655
1656
1657
1658
1659
1660
1661
1662
1663
1664
1665
1666
1667
1668
1669
1670
1671
1672
1673
1674
1675
1676
1677
1678
1679
1680
1681
1682
1683
1684
1685
1686
1687
1688
1689
1690
description: >
This type represents location constraints for a VNF to be instantiated.
The location constraints shall be presented as a
country code, optionally followed by a civic address based on
the format defined by IETF RFC 4776 [13].
type: object
required:
- countryCode
properties:
countryCode:
description: >
The two-letter ISO 3166 [29] country code in capital letters.
type: string
civicAddressElement:
description: >
Zero or more elements comprising the civic address.
type: array
items:
type: object
required:
- caType
- caValue
properties:
caType:
description: >
Describe the content type of caValue. The value of
caType shall comply with Section 3.4 of IETF
RFC 4776 [13].
type: integer
caValue:
description: >
Content of civic address element corresponding to the
caType. The format caValue shall comply with
Section 3.4 of IETF RFC 4776 [13].
type: string
moscatelli
committed
description: >
This type represents the association of location constraints to a VNF instance
to be created according to a specific VNF profile.
It shall comply with the provisions defined in Table 6.5.3.20-1.
type: object
required:
- vnfProfileId
properties:
vnfProfileId:
description: >
Identifier of (reference to) a vnfProfile to which the
additional parameters apply.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
locationConstraints:
description: >
Defines the location constraints for the VNF instance to
be created based on the VNF profile.
$ref: "#/definitions/LocationConstraints"
moscatelli
committed
1712
1713
1714
1715
1716
1717
1718
1719
1720
1721
1722
1723
1724
1725
1726
1727
1728
1729
1730
1731
1732
description: >
This type specifies an existing VNF instance to be used in the NS instance and
if needed, the VNF Profile to use for this VNF instance.
It shall comply with the provisions defined in Table 6.5.3.19-1.
type: object
required:
- vnfInstanceId
- vnfProfileId
properties:
vnfInstanceId:
description: >
Identifier of the existing VNF instance to be used in the NS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfProfileId:
description: >
Identifier of (Reference to) a vnfProfile defined in the
NSD which the existing VNF instance shall be matched
with. If not present, the NFVO will select the VnfProfile
matching the information in the VNF instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
1733
1734
1735
1736
1737
1738
1739
1740
1741
1742
1743
1744
1745
1746
1747
1748
1749
1750
1751
1752
1753
NestedNsInstanceData:
description: >
This type specifies an existing nested NS instance to be used in the NS instance
and if needed, the NsProfile to use for this nested NS instance.
It shall comply with the provisions defined in Table 6.5.3.19a-1.
type: object
required:
- nestedNsInstanceId
properties:
nestedNsInstanceId:
description: >
Identifier of the existing nested NS instance to be used in the NS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsProfileId:
description: >
Identifier of an NsProfile defined in the NSD which the existing
nested NS instance shall be matched with.
If not present, the NFVO will select the NsProfile matching the
information in the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
moscatelli
committed
1755
1756
1757
1758
1759
1760
1761
1762
1763
1764
1765
1766
1767
1768
1769
1770
1771
1772
1773
1774
1775
1776
description: >
This type represents the information related to a SAP of a NS.
It shall comply with the provisions defined in Table 6.5.3.10-1.
type: object
required:
- sapdId
- sapName
- description
properties:
sapdId:
description: >
Reference to the SAPD for this SAP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
sapName:
description: >
Human readable name for the SAP.
type: string
description:
description: >
Human readable description for the SAP.
type: string
sapProtocolData:
description: >
Parameters for configuring the network protocols on the SAP.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/CpProtocolData"
rameshnaraya
committed
description: >
moscatelli
committed
This type represents a request for the scale NS operation.
type: object
required:
moscatelli
committed
- scaleType
moscatelli
committed
scaleType:
moscatelli
committed
1792
1793
1794
1795
1796
1797
1798
1799
1800
1801
1802
1803
1804
1805
1806
1807
1808
1809
1810
1811
1812
1813
1814
1815
1816
1817
1818
1819
1820
1821
1822
1823
1824
1825
1826
1827
1828
1829
1830
1831
1832
Indicates the type of scaling to be performed.
Possible values:
- SCALE_NS
- SCALE_VNF
type: string
enum:
- SCALE_NS
- SCALE_VNF
scaleNsData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_NS.
$ref: "#/definitions/ScaleNsData"
scaleVnfData:
description: >
The necessary information to scale the referenced NS instance.
It shall be present when scaleType = SCALE_VNF.
type: array
items:
$ref: "#/definitions/ScaleVnfData"
scaleTime:
description: >
Timestamp indicating the scale time of the NS, i.e. the
NS will be scaled at this timestamp. Cardinality "0"
indicates the NS scaling takes place immediately".
$ref: "SOL005_def.yaml#/definitions/DateTime"
UpdateNsRequest:
description: >
This operation supports the update of a NS instance,
It shall comply with the provisions defined in Table 6.5.2.12-1.
type: object
required:
- updateType
properties:
updateType:
description: >
The type of update. It determines also which one of the
following parameters is present in the operation.
Possible values include:
* ADD_VNF: Adding existing VNF instance(s)
1833
1834
1835
1836
1837
1838
1839
1840
1841
1842
1843
1844
1845
1846
1847
1848
1849
1850
1851
1852
1853
1854
1855
1856
1857
1858
1859
1860
* REMOVE_VNF: Removing VNF instance(s)
* INSTANTIATE_VNF: Instantiating new VNF(s)
* CHANGE_VNF_DF: Changing VNF DF
* OPERATE_VNF: Changing VNF state,
* MODIFY_VNF_INFORMATION: Modifying
VNF information and/or the configurable
properties of VNF instance(s)
* CHANGE_EXTERNAL_VNF_CONNECTIVITY:
Changing the external connectivity of VNF
instance(s)ADD_SAP: Adding SAP(s)
* REMOVE_SAP: Removing SAP(s)
* ADD_NESTED_NS: Adding existing NS
instance(s) as nested NS(s)
* REMOVE_NESTED_NS: Removing existing
nested NS instance(s)
* ASSOC_NEW_NSD_VERSION: Associating a
new NSD version to the NS instance
* MOVE_VNF: Moving VNF instance(s) from one
origin NS instance to another target NS
instance
* ADD_VNFFG: Adding VNFFG(s)
* REMOVE_VNFFG: Removing VNFFG(s)
* UPDATE_VNFFG: Updating VNFFG(s)
* CHANGE_NS_DF: Changing NS DF
* ADD_PNF: Adding PNF
* MODIFY_PNF: Modifying PNF
* REMOVE_PNF: Removing PNF
type: string
moscatelli
committed
enum:
- ADD_VNF
- REMOVE_VNF
- INSTANTIATE_VNF
- CHANGE_VNF_DF
- OPERATE_VNF
- MODIFY_VNF_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
- REMOVE_SAP
- ADD_NESTED_NS
- REMOVE_NESTED_NS
- ASSOC_NEW_NSD_VERSION
- MOVE_VNF
- ADD_VNFFG
moscatelli
committed
- REMOVE_VNFFG
- UPDATE_VNFFG
- CHANGE_NS_DF
- ADD_PNF
- MODIFY_PNF
- REMOVE_PNF
addVnfIstance:
description: >
Identifies an existing VNF instance to be added to the
NS instance. It shall be present only if updateType = "ADD_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
removeVnfInstanceId:
description: >
Identifies an existing VNF instance to be removed from
the NS instance. It contains the identifier(s) of the VNF
instances to be removed. It shall be present only if
updateType = "REMOVE_VNF." Note: If a VNF instance
is removed from a NS and this NS was the last one for
which this VNF instance was a part, the VNF instance is
terminated by the NFVO.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
instantiateVnfData:
description: >
Identifies the new VNF to be instantiated. It can be used
e.g. for the bottom-up NS creation. It shall be present
only if updateType = "INSTANTIATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/InstantiateVnfData"
changeVnfFlavourData:
description: >
Identifies the new DF of the VNF instance to be
changed to. It shall be present only if updateType = "CHANGE_VNF_DF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeVnfFlavourData"
operateVnfData:
description: >
Identifies the state of the VNF instance to be changed.
It shall be present only if updateType = "OPERATE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/OperateVnfData"
modifyVnfInfoData:
description: >
Identifies the VNF information parameters and/or the
configurable properties of VNF instance to be modified.
It shall be present only if updateType = "MODIFY_VNF_INFORMATION".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyVnfInfoData"
changeExtVnfConnectivityData:
description: >
Specifies the new external connectivity data of the VNF
instance to be changed. It shall be present only if
updateType = "CHANGE_EXTERNAL_VNF_CONNECTIVITY".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ChangeExtVnfConnectivityData"
addSap:
description: >
Identifies a new SAP to be added to the NS instance.
It shall be present only if updateType = "ADD_SAP."
type: array
moscatelli
committed
items:
$ref: "#/definitions/SapData"
removeSapId:
description: >
The identifier an existing SAP to be removed from the
NS instance. It shall be present only if updateType = "REMOVE_SAP."
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
Samir Medjiah
committed
addNestedNsData:
description: >
The identifier of an existing nested NS instance to be
added to (nested within) the NS instance. It shall be
present only if updateType = "ADD_NESTED_NS".
type: array
moscatelli
committed
items:
Samir Medjiah
committed
$ref: "#/definitions/NestedNsInstanceData"
moscatelli
committed
description: >
The identifier of an existing nested NS instance to be
removed from the NS instance. It shall be present only if
updateType = "REMOVE_NESTED_NS".
type: array
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
assocNewNsdVersionData:
description: >
Specify the new NSD to be used for the NS instance. It
shall be present only if updateType =
ASSOC_NEW_NSD_VERSION".
$ref: "#/definitions/AssocNewNsdVersionData"
moveVnfInstanceData:
description: >
Specify existing VNF instance to be moved from one NS
instance to another NS instance. It shall be present only
if updateType = MOVE_VNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/MoveVnfInstanceData"
addVnffg:
description: >
Specify the new VNFFG to be created to the NS
Instance. It shall be present only if updateType =
"ADD_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddVnffgData"
removeVnffgId:
description: >
Identifier of an existing VNFFG to be removed from the
NS Instance. It shall be present only if updateType =
"REMOVE_VNFFG".
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
updateVnffg:
description: >
Specify the new VNFFG Information data to be updated
for a VNFFG of the NS Instance. It shall be present only
if updateType = "UPDATE_VNFFG".
type: array
moscatelli
committed
items:
$ref: "#/definitions/UpdateVnffgData"
changeNsFlavourData:
description: >
Specifies the new DF to be applied to the NS instance. It
shall be present only if updateType =
"CHANGE_NS_DF".
moscatelli
committed
$ref: "#/definitions/ChangeNsFlavourData"
addPnfData:
description: >
specifies the PNF to be added into the NS instance.
It shall be present only if updateType = "ADD_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/AddPnfData"
modifyPnfData:
description: >
Specifies the PNF to be modified in the NS instance.
It shall be present only if updateType = "MODIFY_PNF".
type: array
moscatelli
committed
items:
$ref: "#/definitions/ModifyPnfData"
removePnfId:
description: >
Identifier of the PNF to be deleted from the NS instance.
It shall be present only if updateType = "REMOVE_PNF".
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
updateTime:
description: >
Timestamp indicating the update time of the NS, i.e. the
NS will be updated at this timestamp. Cardinality "0"
indicates the NS update takes place immediately.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/DateTime"
InstantiateVnfData:
description: >
This type represents the information related to a SAP of a NS. The InstantiateVnfData data type specifies the
parameters that are needed for VNF instantiation. This information element is used for the bottom-up NS creation when
the OSS/BSS explicitly requests VNF instantiation for a given NS. When the NFVO invokes the Instantiate VNF
update operation, a set of these parameters are then passed by the NFVO to the VNFM. It shall comply with the
provisions defined in Table 6.5.3.24-1.
type: object
required:
- vnfdId
moscatelli
committed
- vnfFlavourId
properties:
vnfdId:
description: >
Information sufficient to identify the VNFD which defines
the VNF to be instantiated.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfInstantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfInstanceName:
description: >
Human-readable name of the VNF instance to be created.
type: string
vnfInstanceDescription:
description: >
Human-readable description of the VNF instance to be created.
type: string
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
Information about internal VLs that are managed by other entities than the VNFM.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData"
localizationLanguage:
description: >
moscatelli
committed
2089
2090
2091
2092
2093
2094
2095
2096
2097
2098
2099
2100
2101
2102
2103
2104
2105
2106
2107
2108
2109
2110
2111
2112
2113
2114
2115
2116
2117
2118
2119
2120
2121
2122
2123
2124
2125
2126
2127
2128
2129
2130
2131
2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
2145
2146
2147
2148
2149
2150
2151
2152
2153
2154
2155
2156
2157
2158
2159
2160
2161
2162
2163
2164
2165
2166
2167
2168
2169
2170
2171
2172
2173
2174
2175
2176
2177
2178
2179
2180
2181
2182
2183
2184
2185
2186
2187
2188
2189
2190
2191
2192
2193
2194
2195
2196
2197
2198
2199
2200
2201
2202
2203
2204
2205
2206
2207
2208
2209
2210
2211
2212
2213
2214
2215
2216
2217
2218
2219
2220
2221
2222
2223
2224
2225
2226
2227
2228
2229
2230
2231
2232
2233
2234
2235
2236
2237
2238
2239
2240
2241
2242
2243
2244
2245
2246
2247
2248
2249
2250
2251
2252
2253
2254
2255
2256
2257
2258
2259
2260
2261
2262
2263
2264
2265
2266
2267
2268
2269
2270
2271
2272
2273
2274
2275
2276
2277
2278
2279
2280
2281
2282
2283
2284
2285
2286
2287
2288
2289
2290
2291
2292
2293
2294
2295
2296
2297
2298
2299
2300
2301
2302
2303
2304
2305
2306
2307
2308
2309
2310
2311
2312
2313
2314
2315
2316
2317
2318
2319
2320
2321
2322
2323
2324
2325
2326
2327
2328
2329
2330
2331
2332
2333
2334
2335
2336
2337
2338
2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
2352
2353
2354
2355
2356
2357
2358
2359
2360
2361
2362
2363
2364
2365
2366
2367
2368
2369
2370
2371
2372
2373
2374
2375
2376
2377
2378
2379
2380
2381
2382
2383
2384
2385
2386
2387
2388
2389
2390
2391
2392
2393
2394
Localization language of the VNF to be instantiated.
The value shall comply with the format defined in IETF RFC 5646 [16].
type: string
additionalParams:
description: >
Additional input parameters for the instantiation process,
specific to the VNF being instantiated.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
ChangeVnfFlavourData:
description: >
The type represents the information that is requested to be changed
deployment flavor for an existing VNF instance.
It shall comply with the provisions defined in Table 6.5.3.25-1.
type: object
required:
- vnfInstanceId
- newFlavourId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance to be modified.
$ref: "SOL005_def.yaml#/definitions/Identifier"
newFlavourId:
description: >
Identifier of the VNF deployment flavor to be instantiated.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment
flavor to be instantiated. If not present, the default
instantiation level as declared in the VNFD is
instantiated.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
extVirtualLinks:
description: >
Information about external VLs to connect the VNF to.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
extManagedVirtualLinks:
description: >
information about internal VLs that are managed by NFVO.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/ExtManagedVirtualLinkData"
additionalParams:
description: >
Additional input parameters for the flavor change
process, specific to the VNF being modified, as declared
in the VNFD as part of "ChangeVnfFlavourOpConfig".
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
OperateVnfData:
description: >
This type represents a VNF instance for which the operational state
needs to be changed and the requested new state. It
shall comply with the provisions defined in Table 6.5.3.31-1.
type: object
required:
- vnfInstanceId
- changeStateTo
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
changeStateTo:
description: >
The desired operational state (i.e. started or stopped)
to change the VNF to.
$ref: "#/definitions/OperationalStates"
stopType:
description: >
It signals whether forceful or graceful stop is requested.
$ref: "#/definitions/StopType"
gracefulStopTimeout:
description: >
The time interval (in seconds) to wait for the VNF to be
taken out of service during graceful stop, before
stopping the VNF.
type: integer
OperationalStates:
description: >
STARTED - The VNF instance is up and running.
STOPPED - The VNF instance has been shut down.
type: string
enum:
- STARTED
- STOPPED
StopType:
description: >
* FORCEFUL: The VNFM will stop the VNF immediately after accepting the
request.
* GRACEFUL: The VNFM will first arrange to take the VNF out of service
after accepting the request. Once that operation is successful or once
the timer value specified in the "gracefulStopTimeout" attribute
expires, the VNFM will stop the VNF.
type: string
enum:
- FORCEFUL
- GRACEFUL
ModifyVnfInfoData:
description: >
This type represents the information that is requested to be modified for a VNF instance. The information to be
modified shall comply with the associated NSD.
EXAMPLE. The vnfPkgId attribute value for a particular VNF instance can only be updated with a value that
matches the identifier value of a VNF package whose vnfdId is present in the associated profile of the NSD.
type: object
required:
- vnfInstanceId
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfInstanceName:
description: >
New value of the "vnfInstanceName" attribute in
"VnfInstance", or "null" to remove the attribute.
type: string
vnfInstanceDescription:
description: >
New value of the "vnfInstanceDescription" attribute in "VnfInstance",
or "null" to remove the attribute.
type: string
vnfPkgId:
description: >
New value of the "vnfPkgId" attribute in "VnfInstance".
The value "null" is not permitted
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfConfigurableProperties:
description: >
Modifications to entries in the
"vnfConfigurableProperties" list, as defined below this Table.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
Metadata:
description: >
Modifications to entries in the "metadata" list, as
defined below this Table.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
Extensions:
description: >
Modifications to entries in the "extensions" list, as
defined below this Table.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
ChangeExtVnfConnectivityData:
description: >
This type describes the information invoked by the NFVO to change the external VNF connectivity information
maintained by the VNFM. The types of changes that this operation supports are:
1) Disconnect the external CPs that are connected to a particular external VL, and connect them to a different
external VL.
2) Change the connectivity parameters of the existing external CPs, including changing addresses.
NOTE: Depending on the capabilities of the underlying VIM resources, certain changes (e.g. modifying the IP
address assignment) might not be supported without deleting the resource and creating another one with
the modified configuration.
This type shall comply with the provisions defined in Table 6.5.3.33-1.
type: object
required:
- vnfInstanceId
- extVirtualLink
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
extVirtualLink:
description: >
Information about external VLs to change (e.g. connect the VNF to).
type: array
items:
$ref: "SOL005_def.yaml#/definitions/ExtVirtualLinkData"
additionalParams:
description: >
Additional parameters passed by the OSS as input to
the external connectivity change process, specific to the
VNF instance being changed.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
AssocNewNsdVersionData:
description: >
This type specifies a new NSD version that is associated to the NS instance. After issuing the Update NS operation with
updateType = "AssocNewNsdVersion", the NFVO shall use the referred NSD as a basis for the given NS instance.
Different versions of the same NSD have same nsdInvariantId, but different nsdId attributes, therefore if the
nsdInvariantId of the NSD version that is to be associated to this NS instance is different from the one used before, the
NFVO shall reject the request. Only new versions of the same NSD can be associated to an existing NS instance. This
data type shall comply with the provisions defined in Table 6.5.3.34-1.
type: object
required:
- newNsdId
properties:
newNsdId:
description: >
Identifier of the new NSD version that is to be
associated to the NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
sync:
description: >
Specify whether the NS instance shall be automatically
synchronized to the new NSD by the NFVO (in case of
true value) or the NFVO shall not do any action (in case
of a false value) and wait for further guidance from
OSS/BSS (i.e. waiting for OSS/BSS to issue NS
lifecycle management operation to explicitly add/remove
VNFs and modify information of VNF instances
according to the new NSD).
The synchronization to the new NSD means e.g.
instantiating/adding those VNFs whose VNFD is
referenced by the new NSD version but not referenced
by the old one, terminating/removing those VNFs whose
VNFD is referenced by the old NSD version but not
referenced by the new NSD version, modifying
information of VNF instances to the new applicable
VNFD provided in the new NSD version.
A cardinality of 0 indicates that synchronization shall not be done.
type: boolean
MoveVnfInstanceData:
description: >
This type specifies existing VNF instances to be moved from one NS instance (source) to another NS instance
(destination). The NS instance defined in the Update NS operation indicates the source NS instance and the destination
NS instance is specified in this data type (referred to targetNsInstanceId).
It shall comply with the provisions defined in Table 6.5.3.35-1.
type: object
required:
- targetNsInstanceId
properties:
targetNsInstanceId:
description: >
Specify the target NS instance where the VNF instances
are moved to.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfInstanceId:
description: >
Specify the VNF instance that is moved.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
AddVnffgData:
description: >
This type specifies the parameters used for the creation of a new VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.36-1.
type: object
required:
- vnffgdId
- vnffgName
- description
properties:
targetNsInstanceId:
description: >
Identifier of the VNFFGD used to create this VNFFG
instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vnffgName:
description: >
Human readable name for the VNFFG.
type: string
description:
description: >
Human readable description for the VNFFG.
type: string
UpdateVnffgData:
description: >
This type specifies the parameters used for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.37-1.
type: object
required:
- vnffgInfoId
properties:
vnffgInfoId:
description: >
Identifier of an existing VNFFG to be updated for the NS Instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nfp:
description: >
Indicate the desired new NFP(s) for a given VNFFG
after the operations of addition/removal of NS
components (e.g. VNFs, VLs, etc.) have been
completed, or indicate the updated or newly created
NFP classification and selection rule which applied to an existing NFP.
type: array
items:
$ref: "#/definitions/NfpData"
nfpInfoId:
description: >
Identifier(s) of the NFP to be deleted from a given VNFFG.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
NfpData:
description: >
This type contains information used to create or modify NFP instance parameters
for the update of an existing VNFFG instance.
It shall comply with the provisions defined in Table 6.5.3.38-1.
type: object
properties:
nfpInfoId:
description: >
Identifier of the NFP to be modified. It shall be present
for modified NFPs and shall be absent for the new NFP.
It shall be present for modified NFPs and shall be absent
for the new NFP.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nfpName:
description: >
Human readable name for the NFP. It shall be present
for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
moscatelli
committed
type: string
description:
description: >
Human readable description for the NFP. It shall be
present for the new NFP, and it may be present otherwise.
It shall be present for the new NFP, and it may be
present otherwise.
moscatelli
committed
type: string
moscatelli
committed
description: >
Group(s) of CPs and/or SAPs which the NFP passes by.
moscatelli
committed
Cardinality can be 0 if only updated or newly created
NFP classification and selection rule which applied to an
existing NFP is provided.
At least a CP or an nfpRule shall be present.
When multiple identifiers are included, the position of
the identifier in the cpGroup value specifies the position
of the group in the path.
moscatelli
committed
type: array
items:
$ref: "#/definitions/CpGroupInfo"
moscatelli
committed
2425
2426
2427
2428
2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
2444
2445
2446
2447
2448
2449
2450
2451
2452
2453
2454
2455
2456
2457
2458
2459
2460
2461
2462
2463
2464
2465
2466
2467
2468
2469
2470
2471
2472
2473
2474
2475
2476
2477
2478
2479
2480
2481
2482
2483
2484
2485
2486
2487
2488
2489
2490
2491
2492
2493
2494
2495
2496
2497
2498
2499
2500
2501
2502
2503
2504
2505
2506
2507
2508
2509
2510
2511
2512
2513
2514
2515
2516
2517
2518
2519
2520
2521
2522
2523
2524
2525
2526
2527
2528
2529
2530
2531
2532
2533
2534
2535
2536
2537
2538
2539
2540
2541
2542
2543
2544
2545
2546
2547
2548
2549
2550
2551
2552
2553
2554
2555
2556
2557
2558
2559
2560
2561
2562
2563
2564
2565
2566
2567
2568
2569
2570
2571
2572
2573
2574
2575
2576
2577
2578
2579
2580
2581
2582
2583
2584
2585
2586
2587
2588
2589
2590
2591
2592
2593
2594
2595
2596
2597
2598
2599
2600
2601
2602
2603
2604
2605
2606
2607
2608
2609
2610
2611
2612
2613
2614
2615
2616
2617
2618
2619
2620
2621
2622
2623
2624
2625
2626
2627
2628
2629
2630
2631
2632
2633
2634
2635
2636
2637
2638
2639
2640
nfpRule:
description: >
NFP classification and selection rule. See note 1.
$ref: "#/definitions/NfpRule"
NfpRule:
description: >
The NfpRule data type is an expression of the conditions that shall be met
in order for the NFP to be applicable to the packet. The condition acts as a flow classifier and
it is met only if all the values expressed in the condition are matched
by those in the packet. It shall comply with the provisions defined in Table 6.5.3.40-1.
type: object
properties:
etherDestinationAddress:
description: >
Indicates a destination Mac address.
$ref: "SOL005_def.yaml#/definitions/MacAddress"
etherSourceAddress:
description: >
Indicates a source Mac address.
$ref: "SOL005_def.yaml#/definitions/MacAddress"
etherType:
description: >
Human readable description for the VNFFG.
type: string
enum:
- IPV4
- IPV6
vlanTag:
description: >
Indicates a VLAN identifier in an IEEE 802.1Q-2014
tag [6] Multiple tags can be included for QinQ stacking. See note.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/String"
protocol:
description: >
Indicates the L4 protocol, For IPv4 [7] this
corresponds to the field called "Protocol" to identify
the next level protocol. For IPv6 [28] this
corresponds to the field is called the "Next Header" field.
Permitted values: Any keyword defined in the IANA
protocol registry [1], e.g.:
TCP
UDP
ICMP
type: string
enum:
- TCP
- UDP
- ICMP
dscp:
description: >
For IPv4 [7] a string of "0" and "1" digits that
corresponds to the 6-bit Differentiated Services
Code Point (DSCP) field of the IP header.
For IPv6 [28] a string of "0" and "1" digits that
corresponds to the 6 differentiated services bits of
the traffic class header field
type: string
sourcePortRange:
description: >
Indicates a range of source ports
$ref: "SOL005_def.yaml#/definitions/PortRange"
destinationPortRange:
description: >
Indicates a range of destination ports.
$ref: "SOL005_def.yaml#/definitions/PortRange"
sourceIpAddressPrefix:
description: >
Indicates the source IP address range in CIDR format.
$ref: "SOL005_def.yaml#/definitions/IpAddressPrefix"
destinationIpAddressPrefix:
description: >
Indicates the destination IP address range in CIDR format.
$ref: "SOL005_def.yaml#/definitions/IpAddressPrefix"
extendedCriteria:
description: >
Indicates values of specific bits in a frame.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/Mask"
ChangeNsFlavourData:
description: >
This type specifies an existing NS instance for which the DF needs to be changed.
This specifies the new DF, the instantiationLevel of the new DF that may be used and
the additional parameters as input for the flavour change.
It shall comply with the provisions defined in Table 6.5.3.39-1.
type: object
required:
- newNsFlavourId
properties:
newNsFlavourId:
description: >
Identifier of an existing VNFFG to be updated for the NS Instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
instantiationLevelId:
description: >
Identifier of the instantiation level of the deployment flavour to be instantiated.
If not present, the default instantiation level as declared in the NSD is instantiated.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
AddPnfData:
description: >
This type specifies an PNF to be added to the NS instance and the PNF Profile
to use for this PNF. It shall comply with the provisions defined in Table 6.5.3.14-1.
type: object
required:
- pnfId
- pnfName
- pnfdId
- pnfProfileId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfName:
description: >
Name of the PNF
type: string
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfProfileId:
description: >
Identifier of related PnfProfile in the NSD on which the PNF is based.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
cpData:
description: >
Address assigned for the PNF external CP(s).
type: array
items:
$ref: "#/definitions/PnfExtCpData"
PnfExtCpData:
description: >
This type represents the configuration data on the external CP of the PNF.
It shall comply with the provisions defined in
Table 6.5.3.16-1.
type: object
required:
- cpProtocolData
properties:
cpInstanceI16:
description: >
Identifier of the CP. Shall be present for existing CP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
cpdId:
description: >
Identifier of the Connection Point Descriptor (CPD) for this CP. Shall be present for new CP.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
cpProtocolData:
description: >
Address assigned for this CP.
type: array
items:
$ref: "SOL005_def.yaml#/definitions/CpProtocolData"
ModifyPnfData:
description: >
This type specifies an PNF to be modified in the NS instance.
It shall comply with the provisions defined in
Table 6.5.3.15-1.
type: object
required:
- pnfId
properties:
pnfId:
description: >
Identifier of the PNF. This identifier is allocated by the OSS/BSS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfName:
description: >
Name of the PNF.
type: string
cpData:
description: >
Address assigned for the PNF external CP(s).
type: array
items:
$ref: "#/definitions/PnfExtCpData"
AffectedVirtualLink:
description: >
This type provides information about added, deleted, modified and
temporary VLs.
type: object
required:
- id
- virtualLinkDescId
- changeType
- networkResource
properties:
id:
description: >
Identifier of the virtual link instance, identifying the applicable
"vnfVirtualLinkResourceInfo" entry in the "VnfInstance" data type.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
virtualLinkDescId:
description: >
Identifier of the related VLD in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
changeType:
description: >
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
* LINK_PORT_ADDED
* LINK_PORT_REMOVED
For a temporary resource, an AffectedVirtualLink structure exists as
long as the temporary resource exists.
moscatelli
committed
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
- LINK_PORT_ADDED
- LINK_PORT_REMOVED
networkResource:
moscatelli
committed
Reference to the VirtualNetwork resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
metadata:
description: >
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VnfVirtualLinkResourceInfo structure.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
moscatelli
committed
AffectedVirtualStorage:
moscatelli
committed
This type provides information about added, deleted, modified and
temporary virtual storage resources.
type: object
required:
moscatelli
committed
- id
- virtualStorageDescId
- changeType
- storageResource
moscatelli
committed
id:
moscatelli
committed
Identifier of the storage instance, identifying the applicable
"virtualStorageResourceInfo" entry in the "VnfInstance" data type.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnf"
virtualStorageDescId:
moscatelli
committed
Identifier of the related VirtualStorage descriptor in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
changeType:
moscatelli
committed
Signals the type of change. Permitted values:
* ADDED
* REMOVED
* MODIFIED
* TEMPORARY
For a temporary resource, an AffectedVirtualStorage structure exists
as long as the temporary resource exists.
type: string
enum:
- ADDED
- REMOVED
- MODIFIED
- TEMPORARY
storageResource:
description: >
Reference to the VirtualStorage resource. Detailed information is
(for new and modified resources) or has been (for removed
resources) available from the VIM.
$ref: "SOL005_def.yaml#/definitions/ResourceHandle"
metadata:
moscatelli
committed
Metadata about this resource.
The content of this attribute shall be a copy of the content of the
"metadata" attribute of the VirtualStorageResourceInfo structure.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
AffectedVnf:
description: >
This type provides information about added, deleted and modified VNFs.
It shall comply with the provisions in Table 6.5.3.2-1.
type: object
required:
- vnfInstanceId
- vnfdId
moscatelli
committed
- vnfProfileId
2719
2720
2721
2722
2723
2724
2725
2726
2727
2728
2729
2730
2731
2732
2733
2734
2735
2736
2737
2738
2739
2740
2741
2742
2743
2744
2745
2746
2747
2748
2749
2750
2751
2752
properties:
vnfInstanceId:
description: >
Identifier of the VNF instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfdId:
description: >
Identifier of the VNFD of the VNF Instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfProfileId:
description: >
Identifier of the VNF profile of the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vnfName:
description: >
Name of the VNF Instance.
type: string
changeType:
description: >
Signals the type of change
Permitted values:
- ADD
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
type: string
enum:
- ADD
moscatelli
committed
- REMOVE
- INSTANTIATE
- TERMINATE
- SCALE
- CHANGE_FLAVOUR
- HEAL
moscatelli
committed
- OPERATE
- MODIFY_INFORMATION
- CHANGE_EXTERNAL_VNF_CONNECTIVITY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
- FAILED
changedInfo:
description: >
Information about the changed VNF instance
rameshnaraya
committed
information, including VNF configurable properties,if applicable.
When the "changedInfo" attribute is present,
either the "changedVnfInfo" attribute or the
"changedExtConnectivity" attribute or both shall be present.
type: object
required:
- self
properties:
rameshnaraya
committed
changedVnfInfo:
description: >
Information about the changed VNF instance
information, including configurable properties,
if applicable.
$ref: "#/definitions/ModifyVnfInfoData"
changedExtConnectivity:
description: >
Information about changed external connectivity,
if applicable.
$ref: "#/definitions/ExtVirtualLinkInfo"
AffectedPnf:
description: >
This type provides information about added, deleted and modified PNFs.
It shall comply with the provisions in Table 6.5.3.3-1.
type: object
required:
- pnfId
- pnfdId
- pnfProfileId
moscatelli
committed
- cpInstanceId
2808
2809
2810
2811
2812
2813
2814
2815
2816
2817
2818
2819
2820
2821
2822
2823
2824
2825
2826
2827
2828
2829
properties:
pnfId:
description: >
Identifier of the affected PNF. This identifier is
allocated by the OSS/BSS.
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfdId:
description: >
Identifier of the PNFD on which the PNF is based.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
pnfProfileId:
description: >
Identifier of the VNF profile of the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
pnfName:
description: >
Name of the PNF.
type: string
cpInstanceId:
description: >
Identifier of the CP in the scope of the PNF.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/IdentifierInPnf"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- REMOVE
- MODIFY
type: string
enum:
- ADD
moscatelli
committed
- REMOVE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
- FAILED
AffectedVl:
description: >
This type provides information about added, deleted and modified VLs.
It shall comply with the provisions in Table 6.5.3.4-1.
type: object
required:
- nsVirtualLinkInstanceId
- nsVirtualLinkDescId
moscatelli
committed
- vlProfileId
2867
2868
2869
2870
2871
2872
2873
2874
2875
2876
2877
2878
2879
2880
2881
2882
2883
2884
2885
2886
2887
2888
2889
2890
2891
properties:
nsVirtualLinkInstanceId:
description: >
Identifier of the VL Instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
nsVirtualLinkDescId:
description: >
Identifier of the VLD in the NSD for this VL.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
vlProfileId:
description: >
Identifier of the VLD in the NSD for this VL.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- DELETE
- MODIFY
- ADD_LINK_PORT
- REMOVE_LINK_PORT
type: string
enum:
- ADD
moscatelli
committed
- DELETE
- MODIFY
moscatelli
committed
- REMOVE_LINK_PORT
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
moscatelli
committed
- ROLLED_BACK
moscatelli
committed
moscatelli
committed
2911
2912
2913
2914
2915
2916
2917
2918
2919
2920
2921
2922
2923
2924
2925
2926
2927
2928
2929
2930
2931
2932
2933
2934
2935
2936
2937
2938
2939
2940
2941
2942
2943
2944
2945
2946
2947
2948
2949
2950
2951
2952
2953
description: >
This type provides information about added, deleted and modified VNFFG instances.
It shall comply with the
provisions in Table 6.5.3.5-1.
type: object
required:
- vnffgInstanceId
- vnffgdId
properties:
vnffgInstanceId:
description: >
Identifier of the VNFFG instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNs"
vnffgdId:
description: >
Identifier of the VNFFGD of the VNFFG instance.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
changeType:
description: >
Signals the type of change.
Permitted values:
- ADD
- DELETE
- MODIFY
type: string
enum:
- ADD
- DELETE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
moscatelli
committed
2955
2956
2957
2958
2959
2960
2961
2962
2963
2964
2965
2966
2967
2968
2969
2970
2971
2972
2973
2974
2975
2976
2977
2978
2979
2980
2981
2982
2983
2984
2985
2986
2987
2988
2989
2990
2991
2992
2993
2994
2995
2996
2997
2998
2999
3000
3001
3002
3003
3004
3005
description: >
This type provides information about added, deleted and modified nested NSs.
It shall comply with the provisions in Table 6.5.3.6-1.
type: object
required:
- nsInstanceId
- nsdId
properties:
nsInstanceId:
description: >
Identifier of the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsdId:
description: >
Identifier of the NSD of the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
changeType:
description: >
Signals the type of lifecycle change.
Permitted values:
- ADD
- REMOVE
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
type: string
enum:
- ADD
- REMOVE
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
- PARTIALLY_COMPLETED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
- PARTIALLY_COMPLETED
moscatelli
committed
3008
3009
3010
3011
3012
3013
3014
3015
3016
3017
3018
3019
3020
3021
3022
3023
3024
3025
3026
3027
3028
3029
3030
3031
3032
3033
3034
3035
3036
3037
3038
3039
3040
3041
3042
3043
3044
3045
3046
3047
3048
3049
3050
3051
3052
3053
description: >
This type provides information about added, deleted and modified SAP of a NS.
It shall comply with the provisions in Table 6.5.3.7-1.
type: object
required:
- sapInstanceId
- sapdId
properties:
sapInstanceId:
description: >
Identifier of the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
sapdId:
description: >
Identifier of the NSD of the nested NS instance.
$ref: "SOL005_def.yaml#/definitions/Identifier"
sapName:
description: >
Human readable name for the SAP.
type: string
changeType:
description: >
Signals the type of lifecycle change.
Permitted values:
- ADD
- REMOVE
- MODIFY
type: string
enum:
- ADD
- REMOVE
- MODIFY
changeResult:
description: >
Signals the result of change identified by the
"changeType" attribute.
Permitted values:
- COMPLETED
- ROLLED_BACK
- FAILED
type: string
enum:
- COMPLETED
- ROLLED_BACK
- FAILED
NsLcmOperationStateType:
description: >
The enumeration NsLcmOperationStateType shall comply with the provisions defined in Table 6.5.4.4-1.
Value | Description
------|------------
PROCESSING | The LCM operation is currently in execution.
COMPLETED | The LCM operation has been completed successfully.
PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed.
FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action won't succeed.
OLLING_BACK | The LCM operation is currently being rolled back.
ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the VNF prior to the original operation invocation has been restored as closely as possible.
type: string
enum:
- PROCESSING
- COMPLETED
- FAILED_TEMP
- FAILED
- ROLLING_BACK
moscatelli
committed
- ROLLED_BACK
moscatelli
committed
description: >
The enumeration NsLcmOpType represents those lifecycle operations that trigger a NS lifecycle management operation
occurrence notification.
Value | Description
------|------------
INSTANTIATE | Represents the "Instantiate NS" LCM operation.
SCALE | Represents the "Scale NS" LCM operation.
UPDATE | Represents the "Update NS" LCM operation.
TERMINATE | Represents the "Terminate NS" LCM operation.
HEAL | Represents the "Heal NS" LCM operation.
type: string
enum:
- INSTANTIATE
- SCALE
- UPDATE
- TERMINATE
- HEAL
LccnSubscriptionRequest:
description: >
This type represents a subscription request related to notifications
about NS lifecycle changes. It shall comply with the
provisions defined in Table 6.5.2.2-1..
type: object
required:
- callbackUri
properties:
moscatelli
committed
filter:
moscatelli
committed
Filter settings for this subscription, to define the subset
of all notifications this subscription relates to. A
particular notification is sent to the subscriber if the filter
matches, or if there is no filter.
$ref: "#/definitions/LifecycleChangeNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "SOL005_def.yaml#/definitions/Uri"
authentication:
description: >
Authentication parameters to configure the use of Authorization when
sending notifications corresponding to this subscription, as defined
in clause 4.5.3.4.
This attribute shall only be present if the subscriber requires
authorization of notifications.
$ref: "SOL005_def.yaml#/definitions/SubscriptionAuthentication"
moscatelli
committed
3122
3123
3124
3125
3126
3127
3128
3129
3130
3131
3132
3133
3134
3135
3136
3137
3138
3139
3140
3141
3142
3143
3144
3145
3146
3147
3148
3149
3150
3151
3152
3153
3154
3155
3156
LccnSubscription:
description: >
This type represents a subscription related to notifications about NS lifecycle changes.
It shall comply with the provisions defined in Table 6.5.2.4-1.
type: object
required:
- id
- callbackUri
- _links
properties:
id:
description: >
Identifier of this subscription resource.
$ref: "SOL005_def.yaml#/definitions/Identifier"
filter:
description: >
Filter settings for this subscription, to define the subset of all
notifications this subscription relates to. A particular
notification is sent to the subscriber if the filter matches, or if
there is no filter.
$ref: "#/definitions/LifecycleChangeNotificationsFilter"
callbackUri:
description: >
The URI of the endpoint to send the notification to.
$ref: "SOL005_def.yaml#/definitions/Uri"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
properties:
self:
description: >
URI of this resource.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Link"
3159
3160
3161
3162
3163
3164
3165
3166
3167
3168
3169
3170
3171
3172
3173
3174
3175
3176
3177
3178
3179
3180
3181
3182
3183
3184
3185
3186
3187
3188
3189
LifecycleChangeNotificationsFilter:
description: >
This type represents a subscription filter related to notifications about
NS lifecycle changes. It shall comply with the
provisions defined in Table 6.5.3.8-1.
At a particular nesting level in the filter structure, the following applies:
All attributes shall match in order for the filter
to match (logical "and" between different filter attributes).
If an attribute is an array, the attribute shall match if at least
one of the values in the array matches (logical "or" between the values of one filter attribute).
type: object
properties:
nsInstanceSubscriptionFilter:
description: >
Filter criteria to select NS instances about which to notify.
$ref: "#/definitions/NsInstanceSubscriptionFilter"
notificationTypes:
description: >
Match particular notification types.
Permitted values:
- NsLcmOperationOccurenceNotification
- NsIdentifierCreationNotification
- NsIdentifierDeletionNotification
- NsChangeNotification
type: array
items:
type: string
enum:
- NsLcmOperationOccurenceNotification
- NsIdentifierCreationNotification
- NsIdentifierDeletionNotification
moscatelli
committed
- NsChangeNotification
operationTypes:
description: >
Match particular NS lifecycle operation types
for the notification of type
NsLcmOperationOccurrenceNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsLcmOperationOccurrenceNotification", and
shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsLcmOpType"
operationStates:
description: >
Match particular LCM operation state values as
reported in notifications of type
NsLcmOperationOccurrenceNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsLcmOperationOccurrenceNotification", and
shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOperationStateType"
nsComponentTypes:
description: >
Match particular NS component types for the
notification of type NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value "NsChang.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsComponentType"
lcmOpNameImpactingNsComponent:
description: >
Match particular LCM operation names for the
notification of type NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsChangeNotification", and shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOpNameForChangeNotificationType"
lcmOpOccStatusImpactingNsComponent:
description: >
Match particular LCM operation status values
as reported in notifications of type
NsChangeNotification.
May be present if the "notificationTypes"
attribute contains the value
"NsChangeNotification", and shall be absent otherwise.
type: array
moscatelli
committed
items:
$ref: "#/definitions/LcmOpOccStatusForChangeNotificationType"
moscatelli
committed
NsScaleInfo:
description: >
This type represents the target NS Scale level for each NS scaling aspect of the current deployment flavor.
type: object
required:
- nsScalingAspectId
- nsScaleLevelId
properties:
nsScalingAspectId:
description: >
Identifier of the NS scaling aspect.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
nsScaleLevelId:
description: >
Identifier of the NS scale level.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
ScaleNsData:
description: >
This type represents the information to scale a NS.
type: object
properties:
vnfInstanceToBeAdded:
description: >
An existing VNF instance to be added to the NS
instance as part of the scaling operation. If
needed, the VNF Profile to be used for this VNF
instance may also be provided.
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfInstanceData"
vnfInstanceToBeRemoved:
description: >
The VNF instance to be removed from the NS
instance as part of the scaling operation.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
scaleNsByStepsData:
description: >
The information used to scale an NS instance by
one or more scaling steps.
moscatelli
committed
$ref: "#/definitions/ScaleNsByStepsData"
scaleNsToLevelData:
description: >
The information used to scale an NS instance to a target size.
moscatelli
committed
$ref: "#/definitions/ScaleNsToLevelData"
additionalParamsForNs:
description: >
Allows the OSS/BSS to provide additional
parameter(s) at the NS level necessary for the
NS scaling (as opposed to the VNF level, which is
covered in additionalParamForVnf).
moscatelli
committed
$ref: "#/definitions/ParamsForVnf"
additionalParamsForVnf:
description: >
Allows the OSS/BSS to provide additional
parameter(s) per VNF instance (as opposed to
the NS level, which is covered in
additionalParamforNs). This is for VNFs that are
to be created by the NFVO as part of the NS
scaling and not for existing VNF that are covered
by the scaleVnfData.
type: array
moscatelli
committed
items:
$ref: "#/definitions/ParamsForVnf"
locationConstraints:
description: >
The location constraints for the VNF to be
instantiated as part of the NS scaling.
An example can be a constraint for the VNF to be
in a specific geographic location.
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfLocationConstraint"
ScaleVnfData:
description: >
This type represents defines the information to scale a VNF instance
to a given level, or to scale a VNF instance by steps.
type: object
required:
- vnfInstanceid
moscatelli
committed
- scaleVnfType
properties:
vnfInstanceid:
description: >
Identifier of the VNF instance being scaled.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/Identifier"
scaleVnfType:
description: >
Type of the scale VNF operation requested.
Allowed values are:
- SCALE_OUT
- SCALE_IN
- SCALE_TO_INSTANTIATION_LEVEL
- SCALE_TO_SCALE_LEVEL(S)
The set of types actually supported depends on the
capabilities of the VNF being managed.
type: string
moscatelli
committed
enum:
moscatelli
committed
- SCALE_IN
- SCALE_TO_INSTANTIATION_LEVEL
- SCALE_TO_SCALE_LEVEL(S)
scaleToLevelData:
description: >
The information used for scaling to a given level.
moscatelli
committed
$ref: "#/definitions/ScaleToLevelData"
scaleByStepData:
description: >
The information used for scaling by steps.
moscatelli
committed
$ref: "#/definitions/ScaleByStepData"
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
3381
3382
3383
3384
3385
3386
3387
3388
3389
3390
3391
3392
3393
3394
3395
3396
3397
3398
3399
3400
3401
3402
3403
3404
3405
3406
3407
3408
ScaleNsByStepsData:
description: >
This type represents the information used to scale an NS instance by one or more scaling steps, with respect to a
particular NS scaling aspect. Performing a scaling step means increasing/decreasing the capacity of an NS instance in a
discrete manner, i.e. moving from one NS scale level to another. The NS scaling aspects and their corresponding NS
scale levels applicable to the NS instance are declared in the NSD.
type: object
required:
- scalingDirection
- aspectId
properties:
scalingDirection:
description: >
The scaling direction. Possible values are:
- SCALE_IN
- SCALE_OUT.
type: string
enum:
- SCALE_IN
- SCALE_OUT
aspectId:
description: >
The aspect of the NS that is requested to be scaled, as
declared in the NSD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
numberOfSteps:
description: >
The number of scaling steps to be performed. Defaults to 1.
type: integer
default: 1
ScaleNsToLevelData:
description: >
This type represents the information used to scale an NS instance to a target size. The target size is either expressed as
an NS instantiation level or as a list of NS scale levels, one per NS scaling aspect, of the current DF. The NS
instantiation levels, the NS scaling aspects and their corresponding NS scale levels applicable to the NS instance are
declared in the NSD.
type: object
properties:
nsInstantiationLevel:
description: >
Identifier of the target NS instantiation level of the
current DF to which the NS instance is requested to be scaled.
$ref: "SOL005_def.yaml#/definitions/IdentifierInNsd"
nsScaleInfo:
description: >
For each NS scaling aspect of the current DF, defines
the target NS scale level to which the NS instance is to be scaled.
type: array
moscatelli
committed
items:
$ref: "#/definitions/NsScaleInfo"
moscatelli
committed
ScaleToLevelData:
description: >
This type describes the information used to scale a VNF instance to a target size. The target size is either expressed as
an instantiation level of that DF as defined in the VNFD, or given as a list of scale levels, one per scaling aspect of that
DF. Instantiation levels and scaling aspects are declared in the VNFD. The NFVO shall then invoke the
ScaleVnfToLevel operation towards the appropriate VNFM..
type: object
properties:
vnfInstantiationLevelId:
description: >
Identifier of the target instantiation level of the current
deployment flavor to which the VNF is requested to be scaled.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
vnfScaleInfo:
description: >
For each scaling aspect of the current deployment
flavor, indicates the target scale level to which the VNF
is to be scaled.
type: array
moscatelli
committed
items:
$ref: "#/definitions/VnfScaleInfo"
additionalParams:
description: >
Additional parameters passed by the NFVO as input to
the scaling process, specific to the VNF being scaled.
moscatelli
committed
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
3438
3439
3440
3441
3442
3443
3444
3445
3446
3447
3448
3449
3450
3451
3452
3453
3454
3455
3456
3457
3458
3459
3460
3461
ScaleByStepData:
description: >
This type describes the information to scale a VNF instance by steps.
The NFVO shall then invoke the Scale VNF
operation towards the appropriate VNFM.
type: object
required:
- aspectId
properties:
aspectId:
description: >
Identifier of (reference to) the aspect of the VNF that is
requested to be scaled, as declared in the VNFD.
$ref: "SOL005_def.yaml#/definitions/IdentifierInVnfd"
numberOfSteps:
description: >
Number of scaling steps. It shall be a positive number.
Defaults to 1.
The VNF provider defines in the VNFD whether or not a
particular VNF supports performing more than one step
at a time. Such a property in the VNFD applies for all
instances of a particular VNF.
type: integer
moscatelli
committed
default: 1
additionalParams:
description: >
Additional parameters passed by the NFVO as input to
the scaling process, specific to the VNF instance being scaled.
$ref: "SOL005_def.yaml#/definitions/KeyValuePairs"
NsInstanceSubscriptionFilter:
description: >
This type represents subscription filter criteria to match NS instances.
It shall comply with the provisions defined in
Table 4.4.1.5-1.
type: object
properties:
nsdIds:
description: >
If present, match NS instances that were created
based on a NSD identified by one of the nsdId
values listed in this attribute.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
vnfdIds:
description: >
If present, match NS instances that contain VNF
instances that were created based on a VNFD
identified by one of the vnfdId values listed in
this attribute.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
pnfdIds:
description: >
If present, match NS instances that contain
PNFs that are represented by a PNFD identified
by one of the pnfdId values listed in this attribute.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsInstanceIds:
description: >
If present, match NS instances with an instance
identifier listed in this attribute.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/Identifier"
nsInstanceNames:
description: >
If present, match NS instances with a NS
Instance Name listed in this attribute.
type: array
moscatelli
committed
items:
$ref: "SOL005_def.yaml#/definitions/String"
moscatelli
committed
LcmOperationStateType:
description: >
Value | Description
------|------------
PROCESSING | The LCM operation is currently in execution.
COMPLETED | The LCM operation has been completed successfully.
PARTIALLY_COMPLETED | The LCM operation has been partially completed with accepTable errors.
FAILED_TEMP | The LCM operation has failed and execution has stopped, but the execution of the operation is not considered to be closed.
FAILED | The LCM operation has failed and it cannot be retried or rolled back, as it is determined that such action will not succeed.
OLLING_BACK | The LCM operation is currently being rolled back.
ROLLED_BACK | The LCM operation has been successfully rolled back, i.e. The state of the NS prior to the original operation invocation has been restored as closely as possible.
type: string
enum:
- PROCESSING
- COMPLETED
- PARTIALLY_COMPLETED
- FAILED_TEMP
- FAILED
- ROLLING_BACK
- ROLLED_BACK
moscatelli
committed
NsComponentType:
description: >
The enumeration NsComponentType represents the NS component type. It shall comply with the provisions defined in Table 6.5.4.5-1.
Value | Description
------|------------
VNF | Represents the impacted NS component is a VNF.
PNF | Represents the impacted NS component is a PNF.
NS | Represents the impacted NS component is a nested NS.
type: string
enum:
- VNF
- PNF
moscatelli
committed
- NS
3550
3551
3552
3553
3554
3555
3556
3557
3558
3559
3560
3561
3562
3563
3564
3565
3566
3567
3568
3569
3570
3571
3572
LcmOpNameForChangeNotificationType:
description: >
The enumeration LcmOpNameForChangeNotificationType represents the name of the lifecycle operation that impacts the NS component and trigger an NS change notification. It shall comply with the provisions defined in Table 6.5.4.6-1.
Value | Description
------|------------
VNF_INSTANTIATE | Represents the "Instantiate VNF" LCM operation.
VNF_SCALE | Represents the "Scale VNF" LCM operation.
VNF_SCALE_TO_LEVEL | Represents the "Scale VNF to Level" LCM operation.
VNF_CHANGE_FLAVOUR | Represents the "Change VNF Flavor" LCM operation.
VNF_TERMINATE | Represents the "Terminate VNF" LCM operation.
VNF_HEAL | Represents the "Heal VNF" LCM operation.
VNF_OPERATE | Represents the "Operate VNF" LCM operation.
VNF_CHANGE_EXT_CONN | Represents the "Change external VNF connectivity" LCM operation.
VNF_MODIFY_INFO | Represents the "Modify VNF Information" LCM operation.
NS_INSTANTIATE | Represents the "Instantiate NS" LCM operation
NS_SCALE | Represents the "Scale NS" LCM operation.
NS_UPDATE | Represents the "Update NS" LCM operation.
NS_TERMINATE | Represents the "Terminate NS" LCM operation.
NS_HEAL | Represents the "Heal NS" LCM operation.
type: string
enum:
- VNF_INSTANTIATE
- VNF_SCALE
moscatelli
committed
- VNF_SCALE_TO_LEVEL
- VNF_CHANGE_FLAVOUR
- VNF_TERMINATE
- VNF_HEAL
- VNF_OPERATE
- VNF_CHANGE_EXT_CONN
- VNF_MODIFY_INFO
- NS_INSTANTIATE
- NS_SCALE
moscatelli
committed
- NS_UPDATE
- NS_TERMINATE
- NS_HEAL
LcmOpOccStatusForChangeNotificationType:
description: >
The enumeration LcmOpOccStatusForChangeNotificationType represents the status of the lifecycle management
operation occurrence that impacts the NS component and triggers an NS change notification. It shall comply with the
provisions defined in Table 6.5.4.7-1.
Value | Description
------|------------
START | The impact on the NS component is identified.
COMPLETED | The impact on the NS component stops and related lifecycle operation completes successfully.
PARTIALLY_COMPLETED | The impact on the NS component stops and related lifecycle operation partially completes. Inconsistency state may exist on the NS component.
FAILED | The impact on the NS component stops and related lifecycle operation fails. Inconsistency state may exist for the NS component.
ROLLED_BACK | The impact on the NS component stops and related lifecycle operation is rolled back.
type: string
enum:
- START
- COMPLETED
moscatelli
committed
- PARTIALLY_COMPLETED
3603
3604
3605
3606
3607
3608
3609
3610
3611
3612
3613
3614
3615
3616
3617
3618
3619
3620
3621
3622
3623
3624
3625
3626
3627
3628
3629
3630
3631
3632
3633
3634
3635
3636
3637
3638
3639
3640
3641
3642
3643
3644
3645
3646
3647
3648
3649
3650
3651
3652
3653
3654
3655
3656
3657
3658
3659
3660
3661
3662
3663
3664
3665
3666
3667
3668
3669
3670
3671
3672
3673
3674
3675
3676
3677
3678
3679
3680
3681
3682
3683
3684
3685
3686
3687
3688
3689
3690
3691
3692
3693
3694
3695
3696
3697
3698
- ROLLED_BACK
NsLcmOpOcc:
description: >
This type represents a request a NS lifecycle operation occurrence.
It shall comply with the provisions defined in Table 6.5.2.3-1.
type: object
required:
- id
- operationState
- stateEnteredTime
- nsInstanceId
- lcmOperationType
- startTime
- isAutomaticInvocation
- isCancelPending
- _links
properties:
id:
description: >
Identifier of this NS lifecycle operation occurrence.
$ref: "SOL005_def.yaml#/definitions/Identifier"
operationState:
description: >
The state of the NS LCM operation.
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOperationStateType"
stateEnteredTime:
description: >
Date-time when the current state was entered.
type: string
format: date-time
nsInstanceId:
description: >
Identifier of the NS instance to which the operation applies.
$ref: "SOL005_def.yaml#/definitions/Identifier"
lcmOperationType:
description: >
Type of the actual LCM operation represented by this
lcm operation occurrence.
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/NsLcmOpType"
startTime:
description: >
Date-time of the start of the operation.
type: string
format: date-time
isAutomaticInvocation:
description: >
Set to true if this NS LCM operation occurrence has
been automatically triggered by the NFVO. This occurs
in the case of auto-scaling, auto-healing and when a
nested NS is modified as a result of an operation on its
composite NS. Set to false otherwise.
type: boolean
operationParams:
description: >
Input parameters of the LCM operation. This attribute
shall be formatted according to the request data type of
the related LCM operation.
The following mapping between lcmOperationType and
the data type of this attribute shall apply:
- INSTANTIATE: InstantiateNsRequest
- SCALE: ScaleNsRequest
- UPDATE: UpdateNsRequest
- HEAL: HealNsRequest
- TERMINATE: TerminateNsRequest
This attribute shall be present if this data type is returned
in a response to reading an individual resource, and may
be present according to the chosen attribute selector
parameter if this data type is returned in a response to a
query of a container resource.
type: string
enum:
- INSTANTIATE
- SCALE
- UPDATE
- HEAL
- TERMINATE
isCancelPending:
description: >
If the LCM operation occurrence is in "PROCESSING"
or "ROLLING_BACK" state and the operation is being
cancelled, this attribute shall be set to true. Otherwise, it
shall be set to false.
type: boolean
cancelMode:
description: >
The mode of an ongoing cancellation. Shall be present
when isCancelPending=true, and shall be absent otherwise.
$ref: "#/definitions/CancelModeType"
error:
description: >
If "operationState" is "FAILED_TEMP" or "FAILED" or "operationState"
is "PROCESSING" or "ROLLING_BACK" and previous value of
"operationState" was "FAILED_TEMP", this attribute shall be present
and contain error information, unless it has been requested to be
excluded via an attribute selector.
$ref: "../../definitions/SOL005_def.yaml#/definitions/ProblemDetails"
3700
3701
3702
3703
3704
3705
3706
3707
3708
3709
3710
3711
3712
3713
3714
3715
3716
3717
3718
3719
3720
3721
3722
3723
3724
3725
3726
3727
3728
3729
3730
3731
3732
3733
3734
3735
3736
3737
3738
3739
3740
3741
3742
3743
3744
3745
3746
3747
3748
3749
3750
3751
3752
3753
3754
3755
3756
3757
3758
3759
3760
3761
3762
3763
3764
3765
3766
3767
3768
3769
3770
3771
3772
3773
3774
3775
3776
3777
3778
3779
3780
3781
3782
3783
3784
3785
3786
3787
3788
3789
3790
3791
3792
3793
3794
3795
3796
3797
3798
3799
3800
resourceChanges:
description: >
This attribute contains information about the cumulative
changes to virtualised resources that were performed so
far by the LCM operation since its start, if applicable
type: object
properties:
affectedVnfs:
description: >
Information about the VNF instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation.
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnf"
affectedPnfs:
description: >
Information about the PNF instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation.
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedPnf"
affectedVls:
description: >
Information about the VL instances that were affected
during the lifecycle operation, if this notification
represents the result of a lifecycle operation.
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVl"
affectedVnffgs:
description: >
Information about the VNFFG instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedVnffg"
affectedNss:
description: >
Information about the nested NS instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note.
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedNs"
affectedSaps:
description: >
Information about the nested NS instances that were
affected during the lifecycle operation, if this notification
represents the result of a lifecycle operation. See note.
type: array
items:
$ref: "SOL005NSLifecycleManagement_def.yaml#/definitions/AffectedSap"
_links:
description: >
Links to resources related to this resource.
type: object
required:
- self
- nsInstance
properties:
self:
description: >
URI of this resource.
$ref: "SOL005_def.yaml#/definitions/Link"
nsInstance:
description: >
Link to the NS instance that the operation applies to.
$ref: "SOL005_def.yaml#/definitions/Link"
cancel:
description: >
Link to the task resource that represents the "cancel"
operation for this LCM operation occurrence, if
cancelling is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link"
retry:
description: >
Link to the task resource that represents the "cancel"
operation for this LCM operation occurrence,
if cancelling is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link"
rollback:
description: >
Link to the task resource that represents the "rollback"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link"
continue:
description: >
Link to the task resource that represents the "continue"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link"
fail:
description: >
Link to the task resource that represents the "fail"
operation for this LCM operation occurrence, if rolling
back is currently allowed.
$ref: "SOL005_def.yaml#/definitions/Link"