Newer
Older
"type": "object",
"required": [
"id",
"nsInstanceId",
"nsLcmOpOccId",
Hammad Zafar
committed
"operation",
"notificationType",
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
"subscriptionId",
"timestamp",
"notificationStatus",
"operationState",
"isAutomaticInvocation",
"_links"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"nsInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"nsLcmOpOccId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"operation": {
"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.\n",
"type": "string",
"enum": [
"INSTANTIATE",
"SCALE",
"UPDATE",
"TERMINATE",
"HEAL"
]
},
"notificationType": {
"description": "Discriminator for the different notification types. Shall be set to \"NsLcmOperationOccurrenceNotification\" for this notification type.\n",
"type": "string"
},
"subscriptionId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"timestamp": {
"description": "Date-time stamp. Representation: String formatted according toas defined by the date-time production in IETF RFC 3339.\n",
"format": "date-time"
},
"notificationStatus": {
"description": "Indicates whether this notification reports about the start of a NS lifecycle operation or the result of a NS lifecycle operation. Permitted values: - START: Informs about the start of the NS LCM operation occurrence. - RESULT: Informs about the final or intermediate result of the NS LCM operation occurrence.\n",
"type": "string",
"enum": [
"START",
"RESULT"
]
},
"operationState": {
"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.\n",
"type": "string",
"enum": [
"PROCESSING",
"COMPLETED",
"FAILED_TEMP",
"FAILED",
"ROLLING_BACK",
"ROLLED_BACK"
]
},
"isAutomaticInvocation": {
"description": "The Boolean is a data type having two values (TRUE and FALSE).\n",
"type": "boolean"
},
Hammad Zafar
committed
"verbosity": {
"description": "The enumeration LcmOpOccNotificationVerbosityType provides values to control the verbosity of LCM operation occurrence notifications. It shall comply with the provisions defined in table 6.5.4.11-1. * FULL: This signals a full notification which contains all change details. * SHORT: This signals a short notification which omits large-volume change details to reduce the size of data to\n be sent via the notification mechanism.\n",
"type": "string",
"enum": [
"FULL",
"SHORT"
]
},
"affectedVnf": {
Hammad Zafar
committed
"description": "Information about the VNF instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the NS LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
"type": "array",
"items": {
"description": "This type provides information about added, deleted and modified VNFs. It shall comply with the provisions in Table 6.5.3.2-1.\n",
"type": "object",
"required": [
"vnfInstanceId",
"vnfdId",
Hammad Zafar
committed
"vnfProfileId",
"vnfName",
"changeType",
"changeResult"
],
"anyOf": [
{
"required": [
"changedExtConnectivity"
]
},
{
"oneOf": [
{
"required": [
"changedVnfInfo"
]
},
{
"required": [
"modificationsTriggeredByVnfPkgChange"
]
}
]
}
],
"properties": {
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProfileId": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
"type": "string"
},
"vnfName": {
"description": "Name of the VNF Instance.\n",
"type": "string"
},
"changeType": {
Hammad Zafar
committed
"description": "Signals the type of change Permitted values: - ADD - REMOVE - INSTANTIATE - TERMINATE - SCALE - CHANGE_FLAVOUR - HEAL - OPERATE - MODIFY_INFORMATION - CHANGE_EXTERNAL_VNF_CONNECTIVITY -\tCHANGE_VNFPKG\n",
"type": "string",
"enum": [
"ADD",
"REMOVE",
"INSTANTIATE",
"TERMINATE",
"SCALE",
"CHANGE_FLAVOUR",
"HEAL",
"OPERATE",
"MODIFY_INFORMATION",
Hammad Zafar
committed
"CHANGE_EXTERNAL_VNF_CONNECTIVITY",
"CHANGE_VNFPKG"
]
},
"changeResult": {
"description": "Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n",
"type": "string",
"enum": [
"COMPLETED",
"ROLLED_BACK",
"FAILED"
]
},
"changedInfo": {
"description": "Information about the changed VNF instance 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.\n",
"type": "object",
Hammad Zafar
committed
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
"anyOf": [
{
"required": [
"changedVnfInfo"
]
},
{
"required": [
"changedVnfInfo"
]
},
{
"required": [
"modificationsTriggeredByVnfPkgChange"
]
}
],
"oneOf": [
{
"required": [
"changedVnfInfo"
]
},
{
"required": [
"modificationsTriggeredByVnfPkgChange"
]
}
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
],
"properties": {
"changedVnfInfo": {
"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.\n",
"type": "object",
"required": [
"vnfInstanceId"
],
"properties": {
"vnfInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfInstanceName": {
"description": "New value of the \"vnfInstanceName\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n",
"type": "string"
},
"vnfInstanceDescription": {
"description": "New value of the \"vnfInstanceDescription\" attribute in \"VnfInstance\", or \"null\" to remove the attribute.\n",
"type": "string"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfConfigurableProperties": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
},
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
},
"extensions": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"changedExtConnectivity": {
Hammad Zafar
committed
"description": "Information about changed external connectivity, if applicable.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n",
"type": "object",
"required": [
Hammad Zafar
committed
"resourceId"
],
"properties": {
Hammad Zafar
committed
"vimId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
Hammad Zafar
committed
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
"type": "string"
}
}
},
"extLinkPorts": {
"description": "Link ports of this VL.\n",
"type": "array",
"items": {
"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. \n",
"type": "object",
"required": [
"id",
"resourceHandle"
],
"properties": {
"id": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceHandle": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n",
"type": "object",
"required": [
"resourceId"
],
"properties": {
"vimId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
"type": "string"
}
Hammad Zafar
committed
},
"cpInstanceId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
Hammad Zafar
committed
}
}
},
"currentVnfExtCpData": {
"description": "This type represents configuration information for external CPs created from a CPD.\n",
"type": "object",
"required": [
"cpdId"
],
"properties": {
"cpdId": {
"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
"type": "string"
Hammad Zafar
committed
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
},
"cpConfig": {
"description": "Map of instance data that need to be configured on the CP instances created from the respective CPD. The key of the map which identifies the individual VnfExtCpConfig entries is managed by the API consumer. The entries shall be applied by the VNFM according to the rules of JSON Merge Patch (see IETF RFC 7396). The map entry value shall be set to \"null\" in order to delete a \"VnfExtCpConfig\" entry identified by a particular key value from the map, i.e. for the disconnection of an existing external CP instance addressed by cpInstanceId in the deleted map entry from a particular external virtual link, and deletion of that instance in case it represents a subport. Deleting the last key from the map removes the affected instance of the \"VnfExtCpData\" structure from its parent data structure. Within one VNF instance, all VNFC instances created from a particular VDU have the same external connectivity. Thus, given a particular value of the cpdId attribute, there shall be one cpConfig entry for each VNFC instance that has been or can be created from a VDU which includes a CPD identified by the cpdId attribute. If the cpConfig represents a subport in a trunk, all cpConfig entries in this list shall have the same segmentationId, which means they are connected to the same set of external VLs via the trunk.\n",
"type": "object",
"additionalProperties": {
"description": "This type represents an externally provided link port or network address information per instance of an external connection point. In case a link port is provided, the VNFM shall use that link port when connecting the external CP to the external VL. In a link port is not provided, the VNFM shall create a link port on the external VL, and use that link port to connect the external CP to the external VL.\n",
"type": "object",
"anyOf": [
{
"required": [
"linkPortId"
]
},
{
"required": [
"cpProtocolData"
]
}
],
"properties": {
"parentCpConfigId": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"linkPortId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"cpProtocolData": {
"description": "Parameters for configuring the network protocols on the link port that connects the CP to a VL. The following conditions apply to the attributes \"linkPortId\" and \"cpProtocolData\": * At least one of the \"linkPortId\" and \"cpProtocolData\" attributes\n shall be present for a to-be-created external CP instance or an\n existing external CP instance.\n* If the \"linkPortId\" attribute is absent, the VNFM shall create a\n link port.\n* If the \"cpProtocolData\" attribute is absent, the \"linkPortId\"\n attribute shall be provided referencing a pre-created link port,\n and the VNFM can use means outside the scope of the present\n document to obtain the pre-configured address information for the\n connection point from the resource representing the link port.\n* If both \"cpProtocolData\" and \"linkportId\" are provided, the API\n consumer shall ensure that the cpProtocolData can be used with the\n pre-created link port referenced by \"linkPortId\".\n",
"type": "array",
"items": {
"description": "This type represents network protocol data.\n",
"type": "object",
"required": [
"layerProtocol"
],
"properties": {
"layerProtocol": {
"description": "Identifier of layer(s) and protocol(s). Permitted values: IP_OVER_ETHERNET.\n",
"type": "string",
"enum": [
"IP_OVER_ETHERNET"
]
},
"ipOverEthernet": {
"description": "This type represents network address data for IP over Ethernet.\n",
"type": "object",
"anyOf": [
{
"required": [
"ipAddresses"
]
},
{
"required": [
"macAddress"
]
}
],
"properties": {
"macAddress": {
"description": "A MAC address. Representation: string that consists of groups of two hexadecimal digits, separated by hyphens or colons.\n",
"type": "string",
"format": "MAC"
},
"segmentationId": {
"description": "Identification of the network segment to which the Cp instance connects to. If the Cp instance represents a subport in a trunk, \"segmentationId\" shall be present. Otherwise it shall not be present. Depending on the NFVI networking infrastructure, the \"segmentationId\" may indicate the actual network segment value (e.g. vlan Id, Vxlan segmentation id, etc.) used in the transport header of the packets or it may be an identifier used between the application and the NFVI networking infrastructure to identify the network sub-interface of the trunk port in question. In the latter case the NFVI infrastructure will map this local \"segmentationId\" to whatever \"segmentationId\" is actually used by the NFVIs transport technology.\n",
"type": "string"
},
"ipAddresses": {
"description": "List of IP addresses to assign to the CP instance. Each entry represents IP address data for fixed or dynamic IP address assignment per subnet. If this attribute is not present, no IP address shall be assigned.\n",
"type": "array",
"items": {
"type": "object",
"required": [
"type"
],
"oneOf": [
{
"required": [
"fixedAddresses"
]
},
{
"required": [
"numDynamicAddresses"
]
},
{
"required": [
"addressRange"
]
}
],
"properties": {
"type": {
"description": "The type of the IP addresses. Permitted values: IPV4, IPV6.\n",
"type": "string",
"enum": [
"IPV4",
"IPV6"
]
},
"fixedAddresses": {
"description": "Fixed addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
},
"numDynamicAddresses": {
"description": "Number of dynamic addresses to assign (from the subnet defined by \"subnetId\" if provided). Exactly one of \"fixedAddresses\", \"numDynamicAddresses\" or \"ipAddressRange\" shall be present.\n",
"type": "integer"
},
"addressRange": {
"description": "An IP address range to be used, e.g. in case of egress connections. In case this attribute is present, IP addresses from the range will be used.\n",
"type": "object",
"required": [
"minAddress",
"maxAddress"
],
"properties": {
"minAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
},
"maxAddress": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
},
"subnetId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
}
Hammad Zafar
committed
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
},
"modificationsTriggeredByVnfPkgChange": {
"description": "This type represents attribute modifications that were performed on an \"Individual VNF instance\" resource when changing the current VNF package. The attributes that can be included consist of those requested to be modified explicitly in the \"ChangeCurrentVnfPkgRequest\" data structure, and additional attributes of the \"VnfInstance\" data structure that were modified implicitly during the operation. The \"ModificationsTriggeredByVnfPkgChange\" data type shall comply with the provisions defined in table 6.5.3.79-1.\n",
"type": "object",
"properties": {
"vnfConfigurableProperties": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
},
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
},
"extensions": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
},
"vnfdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vnfProvider": {
"description": "If present, this attribute signals the new value of the \"vnfProvider\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of the related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfProductName": {
"description": "If present, this attribute signals the new value of the \"vnfProductName\" attribute in \"VnfInstance\". If present, this attribute (which depends on the value of the \"vnfdId\" attribute) was modified implicitly during the related operation, and contains a copy of the value of the related attribute from the VNFD in the VNF Package identified by the \"vnfdId\" attribute.\n",
"type": "string"
},
"vnfSoftwareVersion": {
"description": "A Version. Representation: string of variable length.\n",
"type": "string"
},
"vnfdVersion": {
"description": "A Version. Representation: string of variable length.\n",
"type": "string"
}
}
}
}
}
}
}
},
"affectedPnf": {
Hammad Zafar
committed
"description": "Information about the PNF instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the NS LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
"type": "array",
"items": {
"description": "This type provides information about added, deleted and modified PNFs. It shall comply with the provisions in Table 6.5.3.3-1.\n",
"type": "object",
"required": [
"pnfId",
"pnfdId",
"pnfProfileId",
"cpInstanceId"
],
"properties": {
"pnfId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"pnfdId": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
"type": "string"
},
"pnfProfileId": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
"type": "string"
},
"pnfName": {
"description": "Name of the PNF.\n",
"type": "string"
},
"cpInstanceId": {
"description": "Identifier of the CP in the scope of the PNF.\n",
"type": "array",
"items": {
"description": "An Identifier that is unique within respect to a PNF. Representation: string of variable length.\n",
"type": "string"
}
},
"changeType": {
"description": "Signals the type of change. Permitted values: - ADD - REMOVE - MODIFY\n",
"type": "string",
"enum": [
"ADD",
"REMOVE",
"MODIFY"
]
},
"changeResult": {
"description": "Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n",
"type": "string",
"enum": [
"COMPLETED",
"ROLLED_BACK",
"FAILED"
]
}
}
}
},
"affectedVl": {
Hammad Zafar
committed
"description": "Information about the VL instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the NS LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
"type": "array",
"items": {
"description": "This type provides information about added, deleted, modified and temporary VLs.\n",
"type": "object",
"required": [
"id",
"virtualLinkDescId",
"changeType",
"networkResource"
],
"properties": {
"id": {
"description": "An identifier that is unique for the respective type within a VNF instance, but may not be globally unique.\n",
"type": "string"
},
"virtualLinkDescId": {
"description": "Identifier of the VNF Virtual Link Descriptor (VLD) in the VNFD.\n",
"type": "string"
},
"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.\n",
"type": "string",
"enum": [
"ADDED",
"REMOVED",
"MODIFIED",
"TEMPORARY",
"LINK_PORT_ADDED",
"LINK_PORT_REMOVED"
]
},
Hammad Zafar
committed
"linkPortIds": {
"description": "Identifiers of the link ports of the affected VL related to the change. Each identifier references an \"NsLinkPortInfo\" structure. Shall be set when changeType is equal to \"ADD_LINK_PORT\" or \"REMOVE_LINK_PORT\", and the related \"NsLinkPortInfo\" structures are present (case \"add\") or have been present (case \"remove\") in the NsVirtualLinkInfo structure that is represented by the \"virtualLink¬Info\" attribute in the \"NsInstance\" structure. The resource handles of the affected NS link ports can be found by dereferencing the identifiers in the \"linkPortIds\" attribute.\n",
"type": "array",
"items": {
"description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n",
"type": "string"
}
},
"networkResource": {
"description": "This type represents the information that allows addressing a virtualised resource that is used by a VNF instance or by an NS instance. Information about the resource is available from the VIM.\n",
"type": "object",
"required": [
"resourceId"
],
"properties": {
"vimId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceProviderId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"resourceId": {
"description": "An identifier maintained by the VIM or other resource provider. It is expected to be unique within the VIM instance. Representation: string of variable length.\n",
"type": "string"
},
"vimLevelResourceType": {
Hammad Zafar
committed
"description": "Type of the resource in the scope of the VIM, the WIM or the resource provider. The value set of the \"vimLevelResourceType\" attribute is within the scope of the VIM, the WIM or the resource provider and can be used as information that complements the ResourceHandle.\n",
"type": "string"
}
}
},
"metadata": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
}
},
"affectedVnffg": {
Hammad Zafar
committed
"description": "Information about the VNFFG instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the NS LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
"type": "array",
"items": {
"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.\n",
"type": "object",
"required": [
"vnffgInstanceId",
"vnffgdId"
],
"properties": {
"vnffgInstanceId": {
"description": "An identifier that is unique with respect to a NS. Representation: string of variable length.\n",
"type": "string"
},
"vnffgdId": {
"description": "An identifier that is unique within a NS descriptor. Representation: string of variable length.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of change. Permitted values: - ADD - DELETE - MODIFY\n",
"type": "string",
"enum": [
"ADD",
"DELETE",
"MODIFY"
]
},
"changeResult": {
"description": "Signals the result of change identified by the \"changeType\" attribute. Permitted values: - COMPLETED - ROLLED_BACK - FAILED\n",
"type": "string",
"enum": [
"COMPLETED",
"ROLLED_BACK",
"FAILED"
]
}
}
}
},
"affectedNs": {
Hammad Zafar
committed
"description": "Information about the SAP instances that were affected during the lifecycle operation. Shall be present if the \"notificationStatus\" is set to \"RESULT\", the \"verbosity\" attribute is set to \"FULL\" and the operation has performed any resource modification. Shall be absent otherwise. This attribute contains information about the cumulative changes to virtualised resources that were performed so far by the NS LCM operation occurrence and by any of the error handling procedures for that operation occurrence.\n",
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
"type": "array",
"items": {
"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.\n",
"type": "object",
"required": [
"nsInstanceId",
"nsdId",
"changeType",
"changeResult"
],
"properties": {
"nsInstanceId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"nsdId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"changeType": {
"description": "Signals the type of lifecycle change. Permitted values: - ADD - REMOVE - INSTANTIATE - SCALE - UPDATE - HEAL - TERMINATE\n",
"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\n",
"type": "string",
"enum": [
"COMPLETED",
"ROLLED_BACK",
"FAILED",
"PARTIALLY_COMPLETED"
]
Hammad Zafar
committed
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
},
"changedInfo": {
"description": "Information about the changed NS instance information, if applicable.\n",
"type": "object",
"properties": {
"wanConnectionInfoModifications": {
"description": "Information about the modified WAN related connectivity information, if applicable.\n",
"type": "array",
"items": {
"description": "This type represents attribute modifications that were performed on WAN connection information. The attributes that can be included consist of those requested to be modified explicitly with the \"UpdateNsRequest\" data structure. It shall comply with the provisions defined in table 6.5.3.93-1.\n",
"type": "object",
"required": [
"wanConnectionInfoId"
],
"properties": {
"wanConnectionInfoId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"mscsName": {
"description": "If present, this attribute signals modifications of the \"mscsName\" attribute in \"MscsInfo\" as defined in clause 6.5.3.82.\n",
"type": "string"
},
"mscsDescription": {
"description": "If present, this attribute signals modifications of the \"mscsDescription\" attribute in \"MscsInfo\" as defined in clause 6.5.3.82.\n",
"type": "string"
},
"mscsEndpoints": {
"description": "If present, this attribute signals modifications of certain entries in the \"mscsEndpoints\" attribute array in \"MscsInfo\", as defined in clause 6.5.3.82.\n",
"type": "array",
"items": {
"description": "This type provides encapsulates information about an MSCS endpoint of the MSCS. It shall comply with the provisions defined in table 6.5.3.83-1.\n",
"type": "object",
"required": [
"mscsEndpointId",
"directionality",
"connectivityServiceEndpoinId"
],
"properties": {
"mscsEndpointId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"directionality": {
"description": "Directionality of the data traffic in the context of the terminating MSCS endpoint from WANs perspective. Permitted values: -\tINBOUND: to indicate into the WAN. -\tOUTBOUND: to indicate from the WAN. -\tBOTH: to indicate bidirectional data traffic to/from the WAN.\n",
"type": "string",
"enum": [
"INBOUND",
"OUTBOUND",
"BOTH"
]
},
"connectivityServiceEndpoinId": {
"description": "References the connectivity service endpoint configuration information applicable to support the MSCS endpoint. More than one connectivity service endpoint can be referred when endpoints are in LAG mode.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
}
}
}
},
"removeMscsEndpointIds": {
"description": "If present, this attribute signals the deletion of certain entries in the \"mscsEndpoints\" attribute array in \"MscsInfo\", as defined in clause 6.5.3.82.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"connectivityServiceEndpoints": {
"description": "If present, this attribute signals modifications of certain entries in the \"connectivityServiceEndpoints\" attribute array in \"WanConnectionProtocolInfo\", as defined in clause 6.5.3.91.\n",
"type": "array",
"items": {
"description": "This type provides configuration data for the NFVI-PoP network gateway providing connectivity service endpoints. The connectivity service endpoints are used as endpoints by an MSCS. It shall comply with the provisions defined in Table 6.5.3.84-1.\n",
"type": "object",
"required": [
"connectivityServiceEndpointId",
"vimId"
],
"properties": {
"connectivityServiceEndpointId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"vimId": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
},
"siteToWanLayer2ProtocolData": {
"description": "This type provides information about Layer 2 protocol specific information for the configuration of the NFVI-PoP network gateway to enable the stitching of the intra-site VN to the MSCS over the WAN. It shall comply with the provisions defined in Table 6.5.3.85-1.\n",
"type": "object",
"required": [
"layer2ConnectionInfo"
],
"properties": {
"layer2ConnectionInfo": {
"description": "Layer 2 protocol parameters of the connectivity service endpoint (CSE).\n",
"type": "object",
"required": [
"connectionType",
"interfaceType",
"interfaceTagging",
"encapsulationType"
],
"properties": {
"connectionType": {
"description": "The type of connection to be established on the connectivity service point. Permitted values: -\tCSE: defined by the characteristics of the existing referred connectivity service point. -\tAGGREGATE_CSE: create an aggregation of the connectivity service endpoints.\n",
"type": "string",
"enum": [
"CSE",
"AGGREGATE_CSE"
]
},
"interfaceType": {
"description": "To indicate whether to create logical interfaces on the referred connectivity service endpoint or new aggregated connectivity service endpoint. Permitted values: -\tPARENT: use the mapped interface to the connectivity service endpoint as is, i.e., do not create logical interfaces. -\tLOGICAL: create logical interfaces.\n",
"type": "string",
"enum": [
"PARENT",
"LOGICAL"
]
},
"interfaceTagging": {
"description": "The type of frames to forward on the connectivity service point. Permitted values: -\tUNTAGGED: an interface where frames are not tagged. -\tTAGGED: an interface configured to forward tagged frames (i.e., enabled for VLAN tagging).\n",
"type": "string",
"enum": [
"UNTAGGED",
"TAGGED"
]
},
"encapsulationType": {
"description": "The type of encapsulation. If the interfaceTagging=\"TAGGED\", either \"VLAN\" or \"VXLAN\" shall be set. Permitted values: -\tETH: generic Ethernet encapsulation. -\tVLAN: encapsulation based on VLAN. -\tVXLAN: encapsulation based on VXLAN.\n",
"type": "string",
"enum": [
"ETH",
"VLAN",
"VXLAN"
]
},
"vlanTaggingType": {
"description": "Type of encapsulation method for VLAN tagging. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VLAN\". Permitted values: -\tDOT1Q: used when packets on the CSE are encapsulated with one or a set of customer VLAN identifiers. -\tQINQ: used when packets on the CSE are encapsulated with multiple customer VLAN identifiers and a single\n service VLAN identifier.\n- QINANY: used when packets on the CSE have no specific customer VLAN and a service VLAN identifier is used.\n",
"type": "string",
"enum": [
"DOT1Q",
"QINQ",
"QINANY"
]
},
"wanSegmentIds": {
"description": "Segment identifiers to pass on the tagged interface. Shall be present if encapsulationType=\"VLAN\" or VXLAN\".\n",
"type": "object",
"required": [
"wanSegmentIdValue"
],
"properties": {
"wanSegmentIdValue": {
"description": "Identifier of the network segment (e.g., VLAN id or VNI).\n",
"type": "string"
},
"wanSegmentIdUpperRange": {
"description": "Identifier of the upper range network segment, in case the \"wanSegmentIds\" is used to define a range.\n",
"type": "string"
}
}
},
"vxlanConfig": {
"description": "Additional configuration needed when using VXLAN encapsulation. Shall be present if interfaceTagging=\"TAGGED\" and encapsulationType=\"VXLAN\".\n",
"type": "object",
"required": [
"peerMode"
],
"properties": {
"peerMode": {
"description": "Type of VXLAN access mode. Default value is \"STATIC\".\nPermitted values: -\tSTATIC -\tBGP_EVPN\n",
"type": "string",
"enum": [
"STATIC",
"BGP_EVPN"
]
},
"peers": {
"description": "List of IP addresses of VTEP peers when using static mode.\n",
"type": "array",
"items": {
"description": "An IPV4 or IPV6 address. Representation: In case of an IPV4 address, string that consists of four decimal integers separated by dots, each integer ranging from 0 to 255. In case of an IPV6 address, string that consists of groups of zero to four hexadecimal digits, separated by colons.\n",
"type": "string",
"format": "IP"
}
}
}
},
"lagInterfaceData": {
"description": "Information for setting up a LAG interface aggregating multiple connectivity service endpoints.\n",
"type": "object",
"required": [
"aggregatedEndpoints",
"lacpActivation",
"lacpConfig"
],
"properties": {
"aggregatedEndpoints": {
"description": "List of the connectivity service endpoints that are to be aggregated. Shall be present if connectionType=\"AGGREGATE_CSE\". In case of aggregating connectivity service endpoints, only one SiteToWanLayer2ProtocolData shall be provided for the whole set of aggregated endpoints.\n",
"type": "array",
"items": {
"description": "An identifier with the intention of being globally unique.\n",
"type": "string"
}
},
"lacpActivation": {
"description": "Indicates whether to activate LACP on the interface. If \"TRUE\", the LACP is to be activated, or \"FALSE\" otherwise. Default value is \"FALSE\".\n",
"type": "boolean"
},
"lacpConfig": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"layer2ControlProtocol": {
"description": "This type represents a list of key-value pairs. The order of the pairs in the list is not significant. In JSON, a set of key- value pairs is represented as an object. It shall comply with the provisions defined in clause 4 of IETF RFC 7159.\n",
"type": "object"
}
}
},
"mtuL2": {
"description": "Maximum Transmission Unit (MTU) that can be forwarded at layer 2 (in bytes). Default value is \"1500\" (bytes).\n",
"type": "number"
},
"virtualRoutingAndForwarding": {
"description": "Configuration related to the L2 virtual routing and forwarding (MAC-VRF).\n",
"type": "object",
"required": [
"macVrfName"
],
"properties": {
"macVrfName": {
"description": "Name (or identifier) of the MAC-VRF instance.\n",
"type": "string"
}
}
},
"forwardingConfig": {
"description": "Information related to the forwarding of the VN in the NFVI-PoP to the connectivity service endpoint, if information about the VN to \"stitch\" is already known. . by the OSS/BSS. Shall not be provided otherwise, in which case the NFVO will infer the forwarding configuration based on the NS VL, or external VL, or externally-managed VL provisioning.\n",
"type": "object",
"oneOf": [
{
"required": [
"networkResources"
]
},
{
"required": [
"vnSegmentIds"
]
}
],
"properties": {
"networkResources": {