1
2
3
4
5
6
7
8
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
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
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
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
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
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
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
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
479
480
481
482
483
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
522
523
524
525
526
527
528
529
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
587
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
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
659
660
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
700
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
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
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
|
.. contents::
:depth: 3
..
**VNF Management Requirements for OpenO**
Introduction
============
This document is **NF Management Requirements for OPEN-O**, which
describes the requirements for how VNFs interact and utilize OPEN-O.
OPEN-O is a platform that enables telecommunications and cable operators
to effectively deliver end-to-end services across Network Functions
Virtualization (NFV) Infrastructure, as well as Software Defined Network
(SDN) and legacy network services.
OPEN-O provide two ways to Manage VNFs, one is managed directly by gvnfm
that is already a component in OPEN-O, the other is managed by providing
a svnfm to manage special VNFs. When providing a svnfm, a svnfm adaptor
must be implemented the interfaces between nfvo and svnfm.
OPEN-O Model Design Framework provides the ability to design NFV
resources including NF and NS. The vendor must provide VNF and NS
packages that include a rich set of recipes, management and functional
interfaces, policies, configuration parameters, and infrastructure
requirements that can be utilized by the OPEN-O Model Design module to
onboard and catalog these resources.
The current VNF Package Requirement is based on a subset of the
Requirements contained in the ETSI Document: ETSI GS NFV-MAN 001 v1.1.1
and GS NFV IFA011 V0.3.0 (2015-10) - Network Functions Virtualization
(NFV), Management and Orchestration, VNF Packaging Specification.
1. .. rubric:: GVNFM Scenario
:name: gvnfm-scenario
1. **VNF Develop Steps**
Aid to help the VNF vendor to fasten the integration with the GVNFM, the
OpenO provides the VNF SDK tools, and the documents. In this charter,
the develop steps for VNF vendors will be introduced.
First, using the VNF SDK tools to design the VNF with TOSCA model and
output the VNF TOSCA package. The VNF package can be validated, and
tested.
Second, the VNF vendor should provide the VNF Rest API to integrate with
the GVNFM if needed. The VNF Rest API is aligned to the ETSI IFA
document.
Third, the TOSCA model supports the EPA feature.
Note:
1. The scripts to extend capacity to satisfy some special requirements.
In the R2, the scripts is not implemented fully, and will be provided
in the next release.
2. The monitoring and scale policy also be provide the next release.
1. **VNF Rest api**
The VNF must provide a rest api to support initial configuration over
HTTP(s).
1. **Set Initial Configuration**
+-----------------+---------------------------------------------+
| If Definition | Description |
+=================+=============================================+
| URI | http(s)://[hostname][:port]/configuration |
+-----------------+---------------------------------------------+
| Operation | POST |
+-----------------+---------------------------------------------+
| Direction | VNFM->VNF |
+-----------------+---------------------------------------------+
1. **Request**
+-------------------------+-------------+---------------+---------------------+------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=========================+=============+===============+=====================+==============================================================================+
| vnfInstanceId | M | 1 | Identifier | Identifier of the VNF instance which the VNF to set initial configuration. |
+-------------------------+-------------+---------------+---------------------+------------------------------------------------------------------------------+
| vnfConfigurationData | O | 0..1 | VnfConfiguration | Configuration data for the VNF instance. |
+-------------------------+-------------+---------------+---------------------+------------------------------------------------------------------------------+
| vnfcConfigurationData | O | 0..N | VnfcConfiguration | Configuration data for VNFC instances. |
+-------------------------+-------------+---------------+---------------------+------------------------------------------------------------------------------+
**VnfConfiguration:**
+-------------------+-------------+---------------+-----------------------------+---------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+===================+=============+===============+=============================+=============================================+
| cp | O | 0..N | CpConfiguration | External CPs |
+-------------------+-------------+---------------+-----------------------------+---------------------------------------------+
| vnfSpecificData | O | 0..1 | VnfConfigurableProperties | Configuration object containing values of |
| | | | | |
| | | | | VNF configurable properties. |
+-------------------+-------------+---------------+-----------------------------+---------------------------------------------+
**CpConfiguration:**
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+=============+=============+===============+==============+=============================================================================+
| cpId | M | 1 | Identifier | Uniquely identifies a CP instance within the |
| | | | | |
| | | | | namespace of a specific VNF instance or |
| | | | | |
| | | | | VNFC instance. |
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
| cpdId | M | 1 | Identifier | Uniquely identifies a type of CP instance within the namespace of a VNFD. |
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
| cpAddress | M | 1..N | CpAddress | Address and Port assigned to the CP. |
+-------------+-------------+---------------+--------------+-----------------------------------------------------------------------------+
**CpAddress:**
+---------------------+-------------+---------------+------------------+-----------------------------------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+=====================+=============+===============+==================+=====================================================================================================+
| address | M | 0..N | NetworkAddress | The address assigned to the CP instance |
| | | | | |
| | | | | (e.g. IP address, MAC address, etc.). It shall be provided for configuring a fixed address. |
+---------------------+-------------+---------------+------------------+-----------------------------------------------------------------------------------------------------+
| useDynamicAddress | M | 0..1 | ENUM | It determines whether an address shall be |
| | | | | |
| | | | | assigned dynamically. It shall be provided if a dynamic address needs to be configured on the CP. |
| | | | | |
| | | | | A cardinality of "0" indicates that no dynamic address needs to be configured on the CP. |
| | | | | |
| | | | | Permitted values: |
| | | | | |
| | | | | - TRUE |
| | | | | |
| | | | | - FALSE |
+---------------------+-------------+---------------+------------------+-----------------------------------------------------------------------------------------------------+
| port | M | 0..1 | Not specified | The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.). |
| | | | | |
| | | | | Reserved |
+---------------------+-------------+---------------+------------------+-----------------------------------------------------------------------------------------------------+
**VnfConfigurableProperties:**
+----------------+-------------+---------------+-----------+-----------------------------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+================+=============+===============+===========+===============================================================================================+
| autoScalable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-scaling functionality. |
| | | | | |
| | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
| | | | | |
| | | | | Permitted values: |
| | | | | |
| | | | | - TRUE |
| | | | | |
| | | | | - FALSE |
+----------------+-------------+---------------+-----------+-----------------------------------------------------------------------------------------------+
| autoHealable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-healing functionality. |
| | | | | |
| | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
| | | | | |
| | | | | Permitted values: |
| | | | | |
| | | | | - TRUE |
| | | | | |
| | | | | - FALSE |
+----------------+-------------+---------------+-----------+-----------------------------------------------------------------------------------------------+
+----------------+-------------+---------------+-----------+-----------------------------------------------------------------------------------------------+
**VnfcConfiguration:**
+--------------------+-------------+---------------+-------------------+----------------------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+====================+=============+===============+===================+========================================================================================+
| vnfcId | M | 1 | Identifier | Uniquely identifies a VNFC instance within the namespace of a specific VNF instance. |
+--------------------+-------------+---------------+-------------------+----------------------------------------------------------------------------------------+
| cp | O | 0..N | CpConfiguration | Internal CPs. |
+--------------------+-------------+---------------+-------------------+----------------------------------------------------------------------------------------+
| vnfcSpecificData | O | 0..1 | KeyValuePair | Configuration object containing values of VNFC configurable properties |
+--------------------+-------------+---------------+-------------------+----------------------------------------------------------------------------------------+
{
"vnfInstanceId": "1",
"vnfConfigurationData": {
"cp": [
{
"cpId": "cp-1",
"cpdId": "cpd-a",
"cpAddress": [
{
"addresses": [
{
"addressType": "MAC",
"l2AddressData": "00:f3:43:20:a2:a3"
},
{
"addressType": "IP",
"l3AddressData": {
"iPAddressType": "IPv4",
"iPAddress": "192.168.104.2"
}
}
],
"useDynamicAddress": "FALSE"
}
]
}
],
"vnfSpecificData": {
"autoScalable": "FALSE",
"autoHealable": "FALSE"
}
},
"vnfcConfigurationData": {
"vnfcId": "vnfc-1",
"cp": [
{
"cpId": "cp-11",
"cpdId": "cpd-1a",
"cpAddress": [
{
"addresses": [
{
"addressType": "MAC",
"l2AddressData": "00:f3:43:21:a2:a3"
},
{
"addressType": "IP",
"l3AddressData": {
"iPAddressType": "IPv4",
"iPAddress": "192.168.105.2"
}
}
],
"useDynamicAddress": "FALSE"
}
]
}
],
"vnfcSpecificData": {}
}
}
1. **Response**
+-------------------------+-------------+---------------+---------------------+---------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=========================+=============+===============+=====================+=================================================================================================================================+
| vnfConfigurationData | O | 0..1 | VnfConfiguration | Correspond to the vnfConfigurationData in the input information elements of the SetInitialConfiguration operation if it has. |
+-------------------------+-------------+---------------+---------------------+---------------------------------------------------------------------------------------------------------------------------------+
| vnfcConfigurationData | O | 0..N | VnfcConfiguration | Correspond to the vnfcConfigurationData in the input information elements of the SetInitialConfiguration operation if it has. |
+-------------------------+-------------+---------------+---------------------+---------------------------------------------------------------------------------------------------------------------------------+
{
"vnfConfigurationData": {
"cp": [
{
"cpId": "cp-1",
"cpdId": "cpd-a",
"cpAddress": [
{
"addresses": [
{
"addressType": "MAC",
"l2AddressData": "00:f3:43:20:a2:a3"
},
{
"addressType": "IP",
"l3AddressData": {
"iPAddressType": "IPv4",
"iPAddress": "192.168.104.2"
}
}
],
"useDynamicAddress": "FALSE"
}
]
}
],
"vnfSpecificData": {
"autoScalable": "FALSE",
"autoHealable": "FALSE",
…
}
},
"vnfcConfigurationData": {
"vnfcId": "vnfc-1",
"cp": [
{
"cpId": "cp-11",
"cpdId": "cpd-1a",
"cpAddress": [
{
"addresses": [
{
"addressType": "MAC",
"l2AddressData": "00:f3:43:21:a2:a3"
},
{
"addressType": "IP",
"l3AddressData": {
"iPAddressType": "IPv4",
"iPAddress": "192.168.105.2"
}
}
],
"useDynamicAddress": "FALSE"
}
]
}
],
"vnfcSpecificData": {…}
}
}
1. **Response Code**
+-----------+-----------------------+-------------------------------------------------------+
| Code | Meaning | Description |
+===========+=======================+=======================================================+
| 201 | Created | A VNF Instance identifier was created successfully. |
+-----------+-----------------------+-------------------------------------------------------+
| 4xx/5xx | <name from RFC7231> | <description> |
+-----------+-----------------------+-------------------------------------------------------+
1. .. rubric:: SVNFM Scenario
:name: svnfm-scenario
1. **VNFM Driver Develop Steps**
Aid to help the VNF vendor to fasten the integration with the NFVO via
Special VNFM, the OpenO provides the documents. In this charter, the
develop steps for VNF vendors will be introduced.
First, using the VNF SDK tools to design the VNF with TOSCA model and
output the VNF TOSCA package. The VNF package can be validated, and
tested.
Second, the VNF vendor should provide SVNFM Driver in the OpenO, which
is a micro service and in duty of translation interface from NFVO to
SVNFM. The interface of NFVO is aligned to the ETSI IFA interfaces and
can be gotten in the charter 5.5. The interface of SVNFM is provided by
the VNF vendor self.
1. **Create SVNFM Adaptor Mircoservice**
Some vnfs are managed by special vnfm, before add svnfm to openo, a
svnfm adaptor must be added to openo to adapter the interface of nfvo
and svnfm.
A svnfm adaptor is a micro service with unique name and an appointed
port, when started up, it must be auto registered to MSB(Micro server
bus),following describes an example rest of register to MSB:
POST /openoapi/microservices/v1/services
{
"serviceName": "catalog",
"version": "v1",
"url": "/openoapi/catalog/v1",
"protocol": "REST",
"visualRange": "1",
"nodes": [
{
"ip": "10.74.56.36",
"port": "8988",
"ttl": 0
}
]
}
A svnfm
1. **Interfaces provided by SVNFM Driver**
Interfaces use RESTful API and the format is as follows:
http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfm\_id}/[……]
**R1 vnfmtype:**
**zte-vnfm**
**fw-vnfm**
**juju**
1. **Instantiate VNF**
+-----------------+--------------------------------------------------------------------+
| If Definition | Description |
+=================+====================================================================+
| URI | http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfmid}/vnfs |
+-----------------+--------------------------------------------------------------------+
| Operation | POST |
+-----------------+--------------------------------------------------------------------+
| Direction | NSLCM->VNFMDriver |
+-----------------+--------------------------------------------------------------------+
1. **Request**
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+==========================+=============+===============+======================+===========================================================================================================================+
| vnfInstanceName | M | 1 | String | Human-readable name of the VNF instance to be created. |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| vnfPackageId | M | 1 | String | VNF packageId |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| vnfDescriptorId | M | 1 | String | Information sufficient to identify the VNF Descriptor which defines the VNF to be created. |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| flavourId | M | 0..1 | String | Reserved |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| vnfInstanceDescription | M | 0..1 | String | Human-readable description of the VNF instance to be created. |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| extVirtualLink | M | 0..N | ExtVirtualLinkData | References to external virtual links to connect the VNF to. |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
| additionalParam | M | 0..N | KeyValuePair | Additional parameters passed by the NFVO as input to the instantiation process, specific to the VNF being instantiated. |
+--------------------------+-------------+---------------+----------------------+---------------------------------------------------------------------------------------------------------------------------+
**ExtVirtualLinkData:**
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+================+=============+===============+===========+==================================================================================================================+
| vlInstanceId | M | 0..1 | String | Identifier of the VL instance. |
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
| vim | CM | 0..1 | VimInfo | Information about the VIM that manages this resource. |
| | | | | |
| | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
| networkId | M | 1 | String | The network UUID of VIM |
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
| cpdId | M | 0..1 | String | Identifier of the external CPD in VNFD |
+----------------+-------------+---------------+-----------+------------------------------------------------------------------------------------------------------------------+
**VimInfo:**
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
+=====================+=====================+=======================+====================+==========================================================================================================================================================+
| vimInfoId | M | 1 | Identifier | The identifier of this VimInfo instance, for the purpose of referencing it from other information elements. |
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| vimId | M | 1 | Identifier | The identifier of the VIM. |
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version, and protocol type. |
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| accessInfo | M | 0..N | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, Token, etc. |
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
| interfaceEndpoint | M | 1 | String | Information about the interface endpoint. An example is a URL. |
+---------------------+---------------------+-----------------------+--------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------+
**interfaceInfo:**
+----------------+-------------+---------------+-----------+---------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+================+=============+===============+===========+===============+
| vimType | M | 1 | String | vim |
+----------------+-------------+---------------+-----------+---------------+
| apiVersion | M | 1 | String | |
+----------------+-------------+---------------+-----------+---------------+
| protocolType | M | 1 | String | http |
| | | | | |
| | | | | https |
+----------------+-------------+---------------+-----------+---------------+
**accessInfo:**
+-------------+-------------+---------------+-----------+--------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+=============+=============+===============+===========+==========================+
| tenant | M | 1 | String | Tenant Name of tenant |
+-------------+-------------+---------------+-----------+--------------------------+
| username | M | 1 | String | Username for login |
+-------------+-------------+---------------+-----------+--------------------------+
| password | M | 1 | String | Password of login user |
+-------------+-------------+---------------+-----------+--------------------------+
{
“vnfInstanceName”:”vFW”,
“vnfPackageId”:”1”,
“vnfDescriptorId”:”1”,
“vnfInstanceDescription”:”vFW\_1”,
“extVirtualLinkLink”:[
{
”vlInstanceId”:”1”,
“resourceId”:”1246”,
” cpdId”:”11111”,
”vim”:
{
“vimInfoId”:”1”,
“vimid”:”1”,
“interfaceInfo”:{
"vimType":”vim”,
"apiVersion":”v2”,
"protocolType":”http”
}
“accessInfo”:{
"tenant":”tenant\_vCPE”,
"username":”vCPE”,
"password":”vCPE\_321”
}
“interfaceEndpoint”:”<interface endpoint url>”
}
}
]
“additionalParam”:{
……
}
}
1. **Response**
+-----------------+-------------+---------------+--------------+---------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=================+=============+===============+==============+=========================================================+
| jobId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
| | | | | |
| | | | | [lifecycleOperationOccurrenceId**]** |
+-----------------+-------------+---------------+--------------+---------------------------------------------------------+
| vnfInstanceId | M | 1 | Identifier | Identifier of the VNF instance. |
+-----------------+-------------+---------------+--------------+---------------------------------------------------------+
{
“jobId”:”1”,
“vnfInstanceId”:”1”
}
1. **Terminate VNF**
+-----------------+----------------------------------------------------------------------------------------------+
| IF Definition | Description |
+=================+==============================================================================================+
| URI | http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/terminate |
+-----------------+----------------------------------------------------------------------------------------------+
| Operation | POST |
+-----------------+----------------------------------------------------------------------------------------------+
| Direction | NSLCM->VNFMDriver |
+-----------------+----------------------------------------------------------------------------------------------+
1. **Request**
+------------------------------+-------------+---------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+==============================+=============+===============+================+===========================================================================================================================================================================================================================================================================================================+
| terminationType | M | 1 | Enum | Signals whether forceful or graceful termination is requested. |
| | | | | |
| | | | | In case of forceful termination, the VNF is shut down immediately, and resources are released. Note that if the VNF is still in service, this may adversely impact network service, and therefore, operator policies apply to determine if forceful termination is allowed in the particular situation. |
| | | | | |
| | | | | In case of graceful termination, the VNFM first arranges to take the VNF out of service (by means out of scope of the present specification, e.g. involving interaction with EM, if required). Once this was successful, or after a timeout, the VNFM shuts down the VNF and releases the resources. |
+------------------------------+-------------+---------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| gracefulTerminationTimeout | M | 0..1 | TimeDuration | The time interval (second) to wait for the VNF to be taken out of service during graceful termination, before shutting down the VNF and releasing the resources. |
| | | | | |
| | | | | If not given, it is expected that the VNFM waits for the successful taking out of service of the VNF, no matter how long it takes, before shutting down the VNF and releasing the resources (see note). |
| | | | | |
| | | | | Minimum timeout or timeout range are specified by the VNF Provider (e.g. defined in the VNFD or communicated by other means). |
| | | | | |
| | | | | Not relevant in case of forceful termination. |
+------------------------------+-------------+---------------+----------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
{
“vnfInstanceId”:”1”,
“terminationType”:”graceful”,
“gracefulTerminationTimeout”:”60”
}
1. **Response**
+-------------+-------------+---------------+--------------+---------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=============+=============+===============+==============+=========================================================+
| jobId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
| | | | | |
| | | | | [lifecycleOperationOccurrenceId**]** |
+-------------+-------------+---------------+--------------+---------------------------------------------------------+
{
“jobId”:”1”
}
1. **Query VNF**
+-----------------+------------------------------------------------------------------------------------+
| IF Definition | Description |
+=================+====================================================================================+
| URI | http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId} |
+-----------------+------------------------------------------------------------------------------------+
| Operation | GET |
+-----------------+------------------------------------------------------------------------------------+
| Direction | NSLCM->VNFMDriver |
+-----------------+------------------------------------------------------------------------------------+
1. **Request**
VNF filter: vnfInstanceId via url [R1]
1. **Response**
+-------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=============+=============+===============+===========+=======================================================================================================================================+
| vnfInfo | M | 0..N | VnfInfo | The information items about the selected VNF instance(s) that are returned. |
| | | | | |
| | | | | If attributeSelector is present, only the attributes listed in attributeSelector will be returned for the selected VNF instance(s). |
| | | | | |
| | | | | See note. |
+-------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------------------------------------------------+
**VnfInfo Table**
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| Attribute | Qualifier | Cardinality | Content | Description |
+==========================+=============+===============+===========+=============================================================================================+
| vnfInstanceId | M | 1 | String | VNF instance identifier. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfInstanceName | M | 0..1 | String | VNF instance name. See note. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfInstanceDescription | M | 0..1 | String | Human-readable description of the VNF instance. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfdId | M | 1 | String | Identifier of the VNFD on which the VNF instance is based. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfPackageId | M | 0..1 | String | Identifier of the VNF Package used to manage the lifecycle of the VNF instance. See note. |
| | | | | |
| | | | | Shall be present for an instantiated VNF instance. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| version | M | 1 | String | Version of the VNF. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfProvider | M | 1 | String | Name of the person or company providing the VNF. |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfType | M | 1 | String | VNF Application Type |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
| vnfStatus | M | 1 | Enum | The instantiation state of the VNF. Possible values: |
| | | | | |
| | | | | INACTIVE (Vnf is terminated or not instantiated ), |
| | | | | |
| | | | | ACTIVE (Vnf is instantiated). |
| | | | | |
| | | | | [instantiationState] |
+--------------------------+-------------+---------------+-----------+---------------------------------------------------------------------------------------------+
{
“vnfInfo”:
{
"nfInstanceId":”1”,
"vnfInstanceName":”vFW”,
"vnfInstanceDescription":”vFW in Nanjing TIC Edge”,
"vnfdId":”1”,
"vnfPackageId":”1”,
"version":”V1.1”,
"vnfProvider":”ZTE”,
"vnfType":”vFW”,
"vnfStatus":” ACTIVE”,
}
}
1. **Get operation status**
+-----------------+-------------------------------------------------------------------------------------------------------+
| IF Definition | Description |
+=================+=======================================================================================================+
| URI | http(s)://[hostname][:port]/openoapi/{vnfmtype} /v1/{vnfmid}/jobs/{jobid}&responseId={ responseId } |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Operation | GET |
+-----------------+-------------------------------------------------------------------------------------------------------+
| Direction | NSLCM->VNFMDriver |
+-----------------+-------------------------------------------------------------------------------------------------------+
1. **Request**
None
1. **Response**
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=======================+=============+===============+===============+======================================================================================+
| jobId | M | 1 | String | Job ID |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| responseDescriptor | M | 1 | - | Including: |
| | | | | |
| | | | | vnfStatus，statusDescription，errorCode，progress、responseHistoryList、responseId |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| status | M | 1 | String | JOB status |
| | | | | |
| | | | | started |
| | | | | |
| | | | | processing |
| | | | | |
| | | | | finished |
| | | | | |
| | | | | error |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| progress | M | 1 | Integer | progress (1-100) |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| statusDescription | M | 1 | String | Progress Description |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| errorCode | M | 1 | Integer | Errorcode |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| responseId | M | 1 | Integer | Response Identifier |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
| responseHistoryList | M | 0..n | ArrayList<> | History Response Messages from the requested responseId to lastest one. |
| | | | | |
| | | | | Including fields: |
| | | | | |
| | | | | vnfStatus, |
| | | | | |
| | | | | statusDescription, |
| | | | | |
| | | | | errorCode, |
| | | | | |
| | | | | progress, |
| | | | | |
| | | | | responseId |
+-----------------------+-------------+---------------+---------------+--------------------------------------------------------------------------------------+
{
"jobId" : "1234566",
"responseDescriptor" : {
"progress" : "40",
"status" : "proccessing",
"statusDescription" : "OMC VMs are decommissioned in VIM",
"errorCode" : null,
"responseId" : "42",
"responseHistoryList" : [{
"progress" : "40",
"status" : "proccessing",
"statusDescription" : "OMC VMs are decommissioned in VIM",
"errorCode" : null,
"responseId" : "1"
}, {
"progress" : "41",
"status" : "proccessing",
"statusDescription" : "OMC VMs are decommissioned in VIM",
"errorCode" : null,
"responseId" : "2"
}
]
}
}
1. **Scale VNF**
+-----------------+------------------------------------------------------------------------------------------+
| If Definition | Description |
+=================+==========================================================================================+
| URI | http(s)://[hostname][:port]/openoapi/{vnfmtype}/v1/{vnfmid}/vnfs/{vnfInstanceId}/scale |
+-----------------+------------------------------------------------------------------------------------------+
| Operation | POST |
+-----------------+------------------------------------------------------------------------------------------+
| Direction | NSLCM->VNFMDriver |
+-----------------+------------------------------------------------------------------------------------------+
1. **Request**
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+===========================================================================================================================================================================================================================================================================================+=============+===============+================+===============================================================================================================================================================================================================+
| type | M | 1 | Enum | Defines the type of the scale operation requested (scale out, scale in). The set of types actually supported depends on the capabilities of the VNF being managed, as declared in the VNFD. See note 1. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| aspectId | M | 1 | Identifier | Identifies the aspect of the VNF that is requested to be scaled, as declared in the VNFD. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| numberOfSteps | M | 0..1 | Integer | Number of scaling steps to be executed as part of this ScaleVnf operation. 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. |
| | | | | |
| | | | | See note 2. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| additionalParam | M | 0..N | KeyValuePair | Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled. |
| | | | | |
| | | | | **Reserved** |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
| NOTE 1: ETSI GS NFV-IFA 010 `[2] <#_bookmark7>`__ specifies that the lifecycle management operations that expand or contract a VNF instance include scale in, scale out, scale up and scale down. Vertical scaling (scale up, scale down) is not supported in the present document. |
| |
| SCALE\_IN designates scaling in. |
| |
| SCALE\_OUT 1 designates scaling out. |
| |
| NOTE 2: A scaling step is the smallest unit by which a VNF can be scaled w.r.t a particular scaling aspect. |
+-------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+-------------+---------------+----------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
{
“vnfInstanceId”:”5”,
“type”:” SCALE\_OUT”,
“aspectId”:”101”,
“numberOfSteps”:”1”,
“additionalParam”:{
……
}
}
1. **Response**
+-------------+-------------+---------------+--------------+-------------------------------------------------------------+
| Parameter | Qualifier | Cardinality | Content | Description |
+=============+=============+===============+==============+=============================================================+
| jobId | M | 1 | Identifier | The identifier of the VNF lifecycle operation occurrence. |
+-------------+-------------+---------------+--------------+-------------------------------------------------------------+
{
“jobId”:”1”
}
|
