5 **GVNFM Northbound & Southbound APIs**
11 The scope of the present document is to describe the GVNFM exposed API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
12 Some content has been updated, about the API Swagger definition, you can find here 'GVNFM_LCM_APIs<https://gerrit.onap.org/r/gitweb?p=vfc/gvnfm/vnflcm.git;a=blob;f=lcm/lcm/swagger/swagger.json;h=f098d282927d3535f5e9e6950f26b9171e04d30c;hb=HEAD>'.
15 **2 Terms, Definitions and Abbreviations**
16 ===========================================
18 For the purposes of the present document, the following
21 +------------------------+-----------------------------------------------------+
22 | **Abbreviation** | |
23 +========================+=====================================================+
24 | NFVO | Network Functions Virtualization Orchestrator |
25 +------------------------+-----------------------------------------------------+
26 | VNFM | Virtual Network Function Manager |
27 +------------------------+-----------------------------------------------------+
28 | VNF | Virtual Network Function |
29 +------------------------+-----------------------------------------------------+
31 Table 2-1 abbreviations
33 **3. Interfaces provided by GVNFM** (Or-Vnfm)
34 ==========================================================
36 Interfaces use RESTful API and the format is as follows:
37 http(s)://[hostname][:port]/api/vnflcm/v1/[……]
42 **{apiRoot} is** http(s)://[hostname][:port]/api
44 **3.1 Create VNF Identifier**
45 -----------------------------
47 +---------------------+--------------------------------------------------------------+
48 | If Definition | Description |
49 +=====================+==============================================================+
50 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
51 +---------------------+--------------------------------------------------------------+
53 +---------------------+--------------------------------------------------------------+
54 | Direction | NFVO->VNFMLCM |
55 +---------------------+--------------------------------------------------------------+
59 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
60 | Parameter | Qualifier | Cardinality | Content | Description |
61 +===========================+=============+===============+==================+=====================================================================================+
62 | vnfdId | M | 1 | Identifier | Identifier that identifies the VNFD which defines the VNF instance to be created. |
63 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
64 | vnfInstanceName | M | 1 | String | Human-readable name of the VNF instance to be created. |
65 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
66 | vnfInstanceDescription | O | 0..1 | String | Human-readable description of the VNF instance to be created. |
67 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
70 "vnfdId": "zte\_vFW\_51610",
71 "vnfInstanceName": "vFW\_01",
72 "vnfInstanceDescription": " vFW in Nanjing TIC Edge"
78 +-----------------+-------------+---------------+------------------+-----------------------------------------+
79 | Parameter | Qualifier | Cardinality | Content | Description |
80 +=================+=============+===============+==================+=========================================+
81 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier just created. |
82 +-----------------+-------------+---------------+------------------+-----------------------------------------+
89 **3.1.3 Response Code**
91 +-----------+-----------------------+-----------------------------------------------------------+
92 | Code | Meaning | Description |
93 +===========+=======================+===========================================================+
94 | 201 | Created | A VNF Instance identifier was created successfully. |
95 +-----------+-----------------------+-----------------------------------------------------------+
96 | 4xx/5xx | <name from RFC7231> | <description> |
97 +-----------+-----------------------+-----------------------------------------------------------+
99 **3.2 Delete VNF Identifier**
100 -----------------------------
102 +---------------------+------------------------------------------------------------------------------+
103 | If Definition | Description |
104 +=====================+==============================================================================+
105 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId} |
106 +---------------------+------------------------------------------------------------------------------+
107 | Operation | DELETE |
108 +---------------------+------------------------------------------------------------------------------+
109 | Direction | NFVO->VNFMLCM |
110 +---------------------+------------------------------------------------------------------------------+
114 +-------------+-------------+---------------+---------------+---------------+
115 | Parameter | Qualifier | Cardinality | Content | Description |
116 +=============+=============+===============+===============+===============+
118 +-------------+-------------+---------------+---------------+---------------+
122 +-------------+-------------+---------------+---------------+---------------+
123 | Parameter | Qualifier | Cardinality | Content | Description |
124 +=============+=============+===============+===============+===============+
126 +-------------+-------------+---------------+---------------+---------------+
128 **3.2.3 Response Code**
130 +--------+-----------+-------------------+
131 | Code | Meaning | Description |
132 +--------+-----------+-------------------+
134 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
135 | 204 | No Content | The VNF instance resource and the associated VNF identifier were deleted successfully. |
136 +===========+=======================+==============================================================================================+
137 | 4xx/5xx | <name from RFC7231> | <description> |
138 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
140 **3.3 Instantiate VNF**
141 -----------------------
143 +---------------------+-------------------------------------------------------------------------------------------+
144 | If Definition | Description |
145 +=====================+===========================================================================================+
146 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId}/instantiate |
147 +---------------------+-------------------------------------------------------------------------------------------+
149 +---------------------+-------------------------------------------------------------------------------------------+
150 | Direction | NFVO->VNFMLCM |
151 +---------------------+-------------------------------------------------------------------------------------------+
155 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
156 | Parameter | Qualifier | Cardinality | Content | Description |
157 +====================+===========+=============+=====================+===============================================================+
158 | flavourId | M | 1 | IdentifierInV nfd | Identifier of the VNF deployment flavour to be instantiated. |
159 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
160 | instantiation | O | 0..1 | IdentifierInVnfd | Identifier of the instantiation |
161 | LevelId | | | | level of the deployment |
162 | | | | | flavour to be instantiated. If |
163 | | | | | not present, the default |
164 | | | | | instantiation level as |
165 | | | | | declared in the VNFD is |
166 | | | | | instantiated. |
169 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
170 | extVirtualLinks | O | 0..N | ExtVirtualLin kData | Information about external VLs to connect the VNF to. |
171 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
172 | extManagedVirtualL | O | 0..N | ExtManaged | Information about internal |
173 | inks | | | VirtualLinkData | VLs that are managed by |
174 | | | | | other entities than the VNFM. |
177 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
178 | localization | O | 0..1 | String | Localization language of the VNF to be instantiated can be |
179 | Language | | | | declared in the VNFD. The value shall comply with the format |
180 | | | | | defined in IETF RFC 5646 [6]. |
183 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
184 | additionalParams | O | 0..N | KeyValuePair | Additional input parameters for the instantiation process, |
185 | | | | | specific to the VNF being instantiated. |
186 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
188 **ExtVirtualLinkData:**
190 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
191 | Attribute | Qualifier | Cardinality | Content | Description |
192 +==================+===========+=============+=================+==================================================================================+
193 | vlInstanceId | O | 0..1 | Identifier | Identifier of the VL instance. |
194 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
195 | vim | CM | 0..1 | VimInfo | Information about the VIM that manages this resource. |
196 | | | | | This attribute shall be supported and present if VNF-related resource management |
197 | | | | | in direct mode is applicable. |
198 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
199 | resourceProvider | CM | 0..1 | Identifier | Identifies the entity responsible for the management of this resource. |
200 | Id | | | | This attribute shall be present if |
201 | | | | | VNF-related resource management in indirect mode is applicable. |
204 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
205 | resourceId | M | 1 | IdentifierInVim | The identifier of the resource in the scope of the VIM or the resource provider. |
206 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
207 | extCps | M | 1..N | VnfExtCpData | External CPs of the VNF to be connected to this external VL. |
208 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
212 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
213 | Attribute | Qualifier | Cardinality | Content | Description |
214 +=================+===========+=============+==============+==========================================================================================================================================+
215 | vimInfoId | M | 1 | Identifier | The identifier of this VimInfo instance, for the purpose of referencing it from other information elements. |
216 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
217 | vimId | M | 1 | Identifier | The identifier of the VIM. |
218 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
219 | interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version, and protocol type. |
220 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
221 | accessInfo | M | 0..N | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, |
222 | | | | | Token, etc. |
223 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
224 | interface | M | 1 | String | Information about the interface endpoint. An example is a URL. |
225 | Endpoint | | | | Token, etc. |
226 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
230 +------------------+---------------+--------------------------------------+
231 | **Key Define** | **Content** | **Description** |
232 +==================+===============+======================================+
233 | vimType | String | The type of the VIM. |
234 +------------------+---------------+--------------------------------------+
235 | apiVersion | String | The Version of the api of the VIM. |
236 +------------------+---------------+--------------------------------------+
237 | protocolType | String | http https |
238 +------------------+---------------+--------------------------------------+
242 +------------------+---------------+--------------------------+
243 | **Key Define** | **Content** | **Description** |
244 +==================+===============+==========================+
245 | tenant | String | Tenant Name of tenant |
246 +------------------+---------------+--------------------------+
247 | username | String | Username for login |
248 +------------------+---------------+--------------------------+
249 | password | String | Password of login user |
250 +------------------+---------------+--------------------------+
254 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
255 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
256 +========================+=====================+=======================+====================+===========================================================+
257 | cpdId | M | 1 | IdentifierInVnfd | The identifier of the CPD in the VNFD. |
258 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
259 | addresses | O | 0..N | NetworkAddress | List of (fixed) network addresses that |
260 | | | | | need to be configured on the CP. This attribute shall |
261 | | | | | be present if fixed addresses need to be configured. |
262 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
263 | numDynamicAddre sses | O | 0..1 | Integer | Number of network addresses to be assigned dynamically. |
264 | | | | | This attribute shall be present if dynamic |
265 | | | | | addresses need to be configured. |
267 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
271 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
272 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
273 +=================+=====================+=======================+===================+===============================================================================================================+
274 | addressType | M | 1 | Enum | Describes the type of the address to be assigned to the CP instantiated from the parent CPD. |
276 | | | | | Permitted values: |
281 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
282 | l2AddressData | CM | 0..1 | String | Provides the information on the MAC addresses to be assigned to the CP(s) instantiated from the parent CPD. |
284 | | | | | Shall be present when the addressType is MAC address. |
285 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
286 | l3AddressData | CM | 0..1 | L3AddressData | Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. |
288 | | | | | Shall be present when the addressType is IP address. |
289 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
293 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
294 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
295 +=================+=====================+=======================+===================+=======================+
296 | iPAddressType | M | 1 | ENUM | IP address type. |
298 | | | | | Permitted values: |
303 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
304 | iPAddress | M | 1 | String | IP address |
305 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
309 "flavourId": "flavour\_1",
310 "instantiationLevelId":"instantiationLevel\_1",
313 { "vlInstanceId": "1",
321 "protocolType": "http"
326 "tenant": "tenant\_vCPE",
328 "password": "vCPE\_321"
331 "interfaceEndpoint": "http://10.43.21.105:80/"
334 "resourceId": "1246",
338 "cpdId": "11", "addresses": [
341 "addressType": "MAC",
342 "l2AddressData": "00:f3:43:20:a2:a3"
350 "iPAddressType": "IPv4",
351 "iPAddress": "192.168.104.2"
358 "numDynamicAddresses": 0
370 "localizationLanguage": "en\_US", "additionalParams": {...}
377 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
378 | Parameter | Qualifier | Cardinality | Content | Description |
379 +=============+=============+===============+==================+=========================================================+
380 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
381 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
389 **3.3.3 Response Code**
391 +-----------+-----------------------+------------------------------------------------------------------------------------------+
392 | Code | Meaning | Description |
393 +===========+=======================+==========================================================================================+
394 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
395 +-----------+-----------------------+------------------------------------------------------------------------------------------+
396 | 4xx/5xx | <name from RFC7231> | <description> |
397 +-----------+-----------------------+------------------------------------------------------------------------------------------+
399 **3.4 Terminate VNF**
400 ---------------------
402 +---------------------+-----------------------------------------------------------------------------------------+
403 | If Definition | Description |
404 +=====================+=========================================================================================+
405 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId}/term inate |
406 +---------------------+-----------------------------------------------------------------------------------------+
408 +---------------------+-----------------------------------------------------------------------------------------+
409 | Direction | NFVO->VNFMLCM |
410 +---------------------+-----------------------------------------------------------------------------------------+
414 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
415 | Parameter | Qualifier | Cardinality | Content | Description |
416 +===================+=============+===============+===============+=========================================================================+
417 | terminationType | M | 1 | Enum | Indicates whether forceful or graceful termination is requested. |
419 | | | | | Permitted values: |
421 | | | | | - FORCEFUL: The VNFM |
422 | | | | | will shut down the VNF and release the resources immediately |
423 | | | | | after accepting the request. |
424 | | | | | - GRACEFUL: The VNFM |
426 | | | | | will first arrange to take the VNF out of service after accepting |
427 | | | | | the request. Once the operation is successful or once the timer |
428 | | | | | value specified in the |
430 | | | | | “gracefulTerminationTime out” attribute expires, the VNFM will shut |
431 | | | | | down the VNF and release the resources. |
432 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
433 | graceful | O | 0..1 | Integer | This attribute is only |
434 | Termination | | | | applicable in case of graceful |
435 | Timeout | | | | termination. It defines the |
436 | | | | | time to wait for the VNF to be |
437 | | | | | taken out of service before |
438 | | | | | shutting down the VNF and |
439 | | | | | releasing the resources. |
440 | | | | | The unit is seconds. |
441 | | | | | If not given and the |
442 | | | | | "terminationType" |
443 | | | | | attribute is set to |
444 | | | | | "GRACEFUL", it is expected |
445 | | | | | that the VNFM waits for |
446 | | | | | the successful taking out of |
447 | | | | | service of the VNF, no |
448 | | | | | matter how long it takes, |
449 | | | | | before shutting down the |
450 | | | | | VNF and releasing the |
451 | | | | | resources. |
452 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
455 "terminationType": "GRACEFUL",
456 "gracefulTerminationTimeout": 120
462 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
463 | Parameter | Qualifier | Cardinality | Content | Description |
464 +=============+=============+===============+==================+=========================================================+
465 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
466 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
473 **3.4.3 Response Code**
475 +-----------+-----------------------+------------------------------------------------------------------------------------------+
476 | Code | Meaning | Description |
477 +===========+=======================+==========================================================================================+
478 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
479 +-----------+-----------------------+------------------------------------------------------------------------------------------+
480 | 4xx/5xx | <name from RFC7231> | <description> |
481 +-----------+-----------------------+------------------------------------------------------------------------------------------+
483 **3.5 Query multiple VNF**
484 ---------------------------
485 +---------------------+--------------------------------------------------------------+
486 | If Definition | Description |
487 +=====================+==============================================================+
488 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances |
489 +---------------------+--------------------------------------------------------------+
491 +---------------------+--------------------------------------------------------------+
492 | Direction | NFVO->VNFMLCM |
493 +---------------------+--------------------------------------------------------------+
497 +-------------+-------------+---------------+---------------+---------------+
498 | Parameter | Qualifier | Cardinality | Content | Description |
499 +=============+=============+===============+===============+===============+
501 +-------------+-------------+---------------+---------------+---------------+
505 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
506 | Parameter | Qualifier | Cardinality | Content | Description |
507 +====================+=============+===============+========================+======================================================================================+
508 | vnfInstanceInfos | M | 0..N | VnfInstanceI nfo | Returned if information about zero or more VNF instances was queried successfully. |
509 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
510 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
514 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
515 | Attribute | Qualifier|Cardinality | Content | Description |
516 +==================================+==========+============+============================+=======================================================================================================================================================+
517 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier. |
518 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
519 | vnfInstanceName | M | 1 | String | VNF instance name. |
520 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
521 | vnfInstanceDescr iption | M | 1 | String | Human-readable description of the VNF instance. |
522 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
523 | onboardedVnfPk gInfoId | M | 1 | Identifier | Identifier of information held by the NFVO about the specific VNF Package on which the VNF is based. This identifier was allocated by the NFVO. |
524 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
525 | vnfdId | M | 1 | Identifier | Identifier of the VNFD on which the VNF instance is based. |
526 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
527 | vnfdVersion | M | 1 | Identifier | Identifies the version of the VNFD. The value is copied from the VNFD. |
528 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
529 | vnfSoftwareVersi on | M | 1 | String | Software version of the VNF. |
531 | | | | | The value is copied from the VNFD. |
532 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
533 | vnfProvider | M | 1 | String | Name of the person or company providing the VNF. |
535 | | | | | The value is copied from the VNFD. |
536 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
537 | vnfProductName | M | 1 | String | Name to identify the VNF Product. The value is copied from the VNFD. |
538 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
539 | vnfConfigurableP roperties | O | 0..N | KeyValuePair | Current values of the configurable properties of the VNF instance. |
541 | | | | | Configurable properties as declared in the VNFD. |
542 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
543 | instantiationState | M | 1 | Enum | The instantiation state of the VNF. |
545 | | | | | Permitted values: |
547 | | | | | - NOT\_INSTANTIATED: The VNF |
549 | | | | | instance is terminated or not instantiated. |
551 | | | | | - INSTANTIATED: The VNF instance is instantiated. |
552 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
553 | instantiatedVnfInf o | CM | 0..1 | InstantiatedVnf Info | Information specific to an instantiated VNF instance. |
555 | | | | | This attribute shall be present if the instantiateState attribute value is INSTANTIATED. |
556 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
557 | metadata | O | 0..N | KeyValuePair | Additional metadata describing the VNF instance. |
559 | | | | | This attribute can be modified with the Modify VNF information operation. |
560 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
561 | extensions | O | 0..N | KeyValuePair | VNF-specific attributes. |
563 | | | | | This attribute can be modified with the Modify VNF information operation. |
564 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
566 **InstantiatedVnfInfo:**
568 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
569 | Attribute | Qualifier | Cardinality| Content | Description |
570 +==============================+===========+============+==============================+========================================================================================================================+
571 | flavourId | M | 1 | IdentifierInVnfd | Identifier of the VNF deployment flavour to be instantiated. |
574 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
575 | vnfState | M | 1 | ENUM | State of the VNF instance. |
577 | | | | | Permitted values: |
579 | | | | | - STARTED: The VNF instance is up and running. |
581 | | | | | - STOPPED: The VNF instance has been shut down. |
582 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
583 | scaleStatus | O | 0..N | ScaleInfo | Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled |
585 | | | | | w.r.t. that aspect. |
587 | | | | | This attribute shall be present if the VNF supports scaling. |
588 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
589 | extCpInfo | O | 0..N | CpInfo | Information about the external CPs exposed by the VNF instance. |
590 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
591 | extVirtualLink | O | 0..N | ExtVirtualLinkI nfo | Information about the external VLs the VNF instance is connected to. |
592 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
593 | extManagedVirtu alLink | O | 0..N | extManagedVir tualLinkInfo | Information about the externally-managed internal VLs of the VNF instance. |
596 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
597 | monitoringParam eters | O | 0..N | MonitoringPar ameter | Active monitoring parameters. |
600 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
601 | localizationLangu age | O | 0..1 | String | Localization language of the VNF to be instantiated. |
603 | | | | | The value shall comply with the format defined in IETF RFC 5646 [6]. |
604 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
605 | vimInfo | CM | 0..N | VimInfo | Information about VIM(s) managing resources for the VNF instance. |
607 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
608 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
609 | vnfcResourceInfo | CM | 0..N | VnfcResourceI nfo | Information about the virtualised compute and storage resource(s) used by the VNFCs of the VNF instance. |
611 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
612 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
613 | virtualLinkResourceInfo | CM | 0..N | VirtualLinkRes ourceInfo | Information about the virtualised network resource(s) used by the VLs of the VNF instance. |
615 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
616 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
617 | virtualStorageResourceInfo | CM | 0..N | VirtualStorage ResourceInfo | Information about the virtualised storage resource(s) used as storage for the VNF instance. |
619 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
620 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
624 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
625 | Attribute | Qualifier | Cardinalit y | Content | Description |
626 +==================+=============+====================+====================+=====================================================================================================================================+
627 | aspectId | M | 1 | IdentifierInVnfd | Identifier of the scaling aspect. |
628 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
629 | scaleLevel | M | 1 | Integer | Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD. |
630 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
631 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
635 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
636 | Attribute | Qualifier | Cardinalit y | Content | Description |
637 +====================+=============+====================+====================+==================================================================+
638 | cpInstanceId | M | 1 | Identifier | Identifier of the CP instance. |
639 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
640 | cpdId | M | 1 | IdentifierInVnfd | Identifier of the CPD, in the VNFD. |
641 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
642 | addresses | O | 0..N | NetworkAddre ss | List of network addresses that have been configured on the CP. |
643 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
645 **ExtVirtualLinkInfo:**
647 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
648 | Attribute | Qualifier | Cardinalit y | Content | Description |
649 +========================+=============+====================+===================+=================================================+
650 | extVirtualLinkId | M | 1 | Identifier | Identifier of the external VL. |
651 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
652 | resourceHandle | M | 1 | ResourceHand le | Identifier of the resource realizing this VL. |
653 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
654 | linkPorts | O | 0..N | VnfLinkPort | Link ports of this VL. |
655 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
659 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
660 | Attribute | Qualifier | Cardinality| Content | Description |
661 +=====================+============+============+===================+========================================================================================================+
662 | vimId | CM | 0..1 | Identifier | Identifier of the VimInfo information element defining the VIM who manages the resource. |
664 | | | | | This attribute shall be present if |
666 | | | | | VNF-related resource management in direct mode is applicable. |
668 | | | | | The value refers to a vimInfo item in the VnfInstance. |
669 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
670 | resourceProviderId | CM | 0..1 | Identifier | Identifier of the entity responsible for the management of the resource. |
672 | | | | | This attribute shall be present when VNF-related resource management in indirect mode is applicable. |
675 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
676 | resourceId | M | 1 | IdentifierInVim | Identifier of the resource in the scope of the VIM or the resource provider. |
677 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
681 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
682 | Attribute | Qualifier | Cardinalit y | Content | Description |
683 +======================+=============+====================+===================+================================================================================================+
684 | resourceHandle | M | 1 | ResourceHand le | Identifier of the virtualised network resource realizing this link port. |
685 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
686 | cpInstanceId | M | 1 | IdentifierInVnf | External CP of the VNF to be connected to this link port. |
688 | | | | | There shall be at most one link port associated with any external connection point instance. |
690 | | | | | The value refers to an extCpInfo item in the VnfInstance. |
691 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
692 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
694 **VnfcResourceInfo:**
696 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
697 | Attribute | Qualifier | Cardinality| Content | Description |
698 +=======================+============+============+====================+=====================================================================================================================+
699 | vnfcInstanceId | M | 1 | IdentifierInVnf | Identifier of this VNFC instance. |
700 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
701 | vduId | M | 1 | IdentifierInVnfd | Reference to the applicable Vdu information element in the VNFD. |
702 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
703 | computeResourc e | M | 1 | ResourceHand le | Reference to the VirtualCompute resource. |
704 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
705 | storageResourceI ds | M | 1..N | IdentifierInVnf | Reference(s) to the VirtualStorage resource(s). |
707 | | | | | The value refers to a VirtualStorageResourceInfo item in the VnfInstance. |
708 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
709 | reservationId | O | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
712 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
714 **VirtualStorageResourceInfo:**
716 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
717 | Attribute | Qualifier | Cardinalit y | Content | Description |
718 +=================================+=============+====================+====================+=====================================================================================================================+
719 | virtualStorageInst anceId | M | 1 | IdentifierInVnf | Identifier of this virtual storage resource instance. |
720 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
721 | virtualStorageDe scId | M | 1 | IdentifierInVnfd | Identifier of the VirtualStorageDesc in the VNFD. |
722 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
723 | storageResource | M | 1 | ResourceHand le | Reference to the VirtualStorage resource. |
724 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
725 | reservationId | M | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
728 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
730 **VirtualLinkResourceInfo:**
732 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
733 | Attribute | Qualifier | Cardinality | Content | Description |
734 +==============================+===========+==============+====================+=====================================================================================================================+
735 | virtualLinkInstanceId | M | 1 | IdentifierInVnf | Identifier of this VL instance. |
736 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
737 | virtualLinkDescId | M | 1 | IdentifierInVnfd | Identifier of the Virtual Link Descriptor (VLD) in the VNFD. |
738 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
739 | networkResource | M | 1 | ResourceHand le | Reference to the VirtualNetwork resource. |
740 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
741 | reservationId | M | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
744 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
750 "vnfInstanceId": "1",
751 "vnfInstanceName": "vFW\_01",
752 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
753 "onboardedVnfPkgInfoId": "1",
754 "vnfdId": "zte\_vFW\_51610",
755 "vnfdVersion": "V1.0",
756 "vnfSoftwareVersion": "V1.0",
757 "vnfProvider": "ZTE",
758 "vnfProductName": "vFW",
759 "vnfConfigurableProperties": {...},
760 "instantiationState": "INSTANTIATED",
761 "instantiatedVnfInfo": {
764 "vnfState": "STARTED",
768 "aspectId": "aspect1",
779 "cpdId": "1", "addresses": [
782 "addressType": "MAC",
783 "l2AddressData": "00:f3:43:20:a2:a3"
791 "iPAddressType": "IPv4",
792 "address": "192.168.104.2"
806 "extVirtualLinkId": "extvl1",
835 "monitoringParameters": {...},
836 "localizationLanguage": "en\_US",
846 "protocolType": "http"
852 "tenant": "tenant\_vCPE",
854 "password": "vCPE\_321"
858 "interfaceEndpoint": "http://10.43.21.105:80/"
863 "vnfcResourceInfo": [
866 "vnfcInstanceId": "vm1",
875 "storageResourceIds": [ "storage1"
882 "virtualLinkResourceInfo": [
885 "virtualLinkInstanceId": "vl01",
886 "virtualLinkDescId": "vl01",
897 "virtualStorageResourceInfo": [
900 "virtualStorageInstanceId": "storage1",
901 "virtualStorageDescId":"storage1",
921 **3.5.3 Response Code**
923 +-----------+-----------------------+----------------------------------+
924 | Code | Meaning | Description |
925 +===========+=======================+==================================+
926 | 200 | Ok | The request has succeeded. |
927 +-----------+-----------------------+----------------------------------+
928 | 4xx/5xx | <name from RFC7231> | <description> |
929 +-----------+-----------------------+----------------------------------+
931 **3.6 Query single VNF**
932 ------------------------
933 +---------------------+------------------------------------------------------------------------------+
934 | If Definition | Description |
935 +=====================+==============================================================================+
936 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId} |
937 +---------------------+------------------------------------------------------------------------------+
939 +---------------------+------------------------------------------------------------------------------+
940 | Direction | NFVO->VNFMLCM |
941 +---------------------+------------------------------------------------------------------------------+
945 +-------------+-------------+---------------+---------------+---------------+
946 | Parameter | Qualifier | Cardinality | Content | Description |
947 +=============+=============+===============+===============+===============+
949 +-------------+-------------+---------------+---------------+---------------+
953 +-------------------+-------------+---------------+------------------------+---------------------------------------+
954 | Parameter | Qualifier | Cardinality | Content | Description |
955 +===================+=============+===============+========================+=======================================+
956 | vnfInstanceInfo | M | 1 | VnfInstanceI nfo | The information of the VNF instance |
957 +-------------------+-------------+---------------+------------------------+---------------------------------------+
958 +-------------------+-------------+---------------+------------------------+---------------------------------------+
960 **3.6.3 Response Code**
962 +-----------+-----------------------+----------------------------------+
963 | Code | Meaning | Description |
964 +===========+=======================+==================================+
965 | 200 | Ok | The request has succeeded. |
966 +-----------+-----------------------+----------------------------------+
967 | 4xx/5xx | <name from RFC7231> | <description> |
968 +-----------+-----------------------+----------------------------------+
972 "vnfInstanceId": "1",
973 "vnfInstanceName": "vFW\_01",
974 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
975 "onboardedVnfPkgInfoId": "1",
976 "vnfdId": "zte\_vFW\_51610",
977 "vnfdVersion": "V1.0",
978 "vnfSoftwareVersion": "V1.0",
979 "vnfProvider": "ZTE",
980 "vnfProductName": "vFW",
981 "vnfConfigurableProperties": {...},
982 "instantiationState": "INSTANTIATED",
983 "instantiatedVnfInfo": {
985 "vnfState": "STARTED",
989 "aspectId": "aspect1",
1000 "cpdId": "1", "addresses": [
1003 "addressType": "MAC",
1004 "l2AddressData": "00:f3:43:20:a2:a3"
1009 "addressType": "IP",
1012 "iPAddressType": "IPv4",
1013 "address": "192.168.104.2"
1028 "extVirtualLinkId": "extvl1",
1032 "resourceId": "1111"
1043 "resourceId": "2121"
1056 "monitoringParameters": {...},
1057 "localizationLanguage": "en\_US",
1067 "protocolType": "http"
1073 "tenant": "tenant\_vCPE",
1075 "password": "vCPE\_321"
1078 "interfaceEndpoint": "http://10.43.21.105:80/"
1084 "vnfcResourceInfo": [
1087 "vnfcInstanceId": "vm1",
1089 "computeResource": {
1092 "resourceId": "3333"
1096 "storageResourceIds": [ "storage1"
1103 "virtualLinkResourceInfo": [
1106 "virtualLinkInstanceId": "vl01",
1107 "virtualLinkDescId": "vl01",
1108 "networkResource": {
1111 "resourceId": "4444"
1119 "virtualStorageResourceInfo": [
1122 "virtualStorageInstanceId": "storage1",
1123 "virtualStorageDescId": "storage1",
1124 "storageResource": {
1141 **3.7 Get Operation Status**
1142 ------------------------------
1143 +---------------------+-------------------------------------------------------------------------------------------------+
1144 | If Definition | Description |
1145 +=====================+=================================================================================================+
1146 | URI | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId} |
1147 +---------------------+-------------------------------------------------------------------------------------------------+
1149 +---------------------+-------------------------------------------------------------------------------------------------+
1150 | Direction | NFVO->GVNFM |
1151 +---------------------+-------------------------------------------------------------------------------------------------+
1159 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1160 | Parameter | Qualifier | Cardinality | Content | Description |
1161 +====================+=============+===============+===========+==================================================================================+
1162 | vnfLcOpId | M | 1 | String | Identifier of a VNF lifecycle operation occurrence |
1163 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1164 | vnfInstanceId | M | 1 | String | Identifier of the VNF instance to which the operation applies |
1165 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1166 | lcmOperationType | M | 1 | ENUM | Type of the actual LCM operation represented by this lcm operation occurrence. |
1168 | | | | | Permitted values: |
1170 | | | | | - INSTANTIATE:the |
1172 | | | | | Instantiate VNF LCM operation. |
1174 | | | | | - SCALE: the Scale VNF LCM operation. |
1176 | | | | | - SCALE\_TO\_LEVEL: the |
1178 | | | | | Scale VNF to Level LCM operation. |
1180 | | | | | - CHANGE\_FLAVOUR: |
1182 | | | | | the Change VNF Flavour LCM operation. |
1184 | | | | | - TERMINATE: the |
1186 | | | | | Terminate VNF LCM operation. |
1188 | | | | | - HEAL: the Heal VNF LCM operation. |
1190 | | | | | - OPERATE: the Operate VNF LCM operation. |
1192 | | | | | - CHANGE\_EXT\_VLS: the |
1194 | | | | | Change VNF external VLs LCM operation. (Reserved) |
1195 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1196 | startTime | M | 1 | String | Date-time of the start of the operation. |
1198 | | | | | Representation: String formatted according to RFC 3339 [13] |
1199 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1200 | responseDescriptor | M | 1 | VnfLcOp | Including:responseId,progress,statusstatusDescription |
1201 | | | | Response | |
1202 | | | | Descriptor| ,errorCode,responseHistoryList |
1203 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1205 **VnfLcOpResponseDescriptor:**
1207 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1208 | Attribute | Qualifier | Cardinalit y | Content | Description |
1209 +===========================+=================+====================+===============+===========================================================+
1210 | responseId | M | 1 | Integer | Response Identifier |
1211 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1212 | progress | M | 1 | Integer | progress (1-100) |
1213 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1214 | lcmOperationStatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
1216 | | | | | Permitted values: |
1218 | | | | | - STARTING: The operation is starting.. |
1220 | | | | | - PROCESSING: The operation is |
1221 | | | | | currently in execution. |
1223 | | | | | - COMPLETED: The operation has completed successfully. |
1225 | | | | | - FAILED: The operation has failed and it cannot be |
1226 | | | | | retried or rolled back, as it is determined |
1227 | | | | | that such action won't succeed. |
1228 | | | | | - FAILED\_TEMP: The operation has failed and execution |
1229 | | | | | has stopped, but the execution of the |
1230 | | | | | operation is not considered to be closed. |
1232 | | | | | (Reserved) |
1234 | | | | | - ROLLING\_BACK: The operation is currently being rolled |
1235 | | | | | back. (Reserved) |
1237 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
1238 | | | | | original operation invocation has been |
1240 | | | | | restored as closely as possible. (Reserved) |
1241 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1242 | statusDescripti on | O | 0..1 | String | Status Description of a VNF lifecycle operation |
1243 | | | | | occurrence |
1244 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1245 | errorCode | O | 0..1 | Integer | Errorcode |
1246 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1247 | responseHistor yList | O | 0..N | VnfLcOpDetail | History Response Messages from the requested |
1248 | | | | | responseId to lastest one. |
1249 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1253 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1254 | Attribute | Qualifier | Cardinalit y | Content | Description |
1255 +===========================+=================+====================+===============+===========================================================+
1256 | responseId | M | 1 | Integer | Response Identifier |
1257 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1258 | progress | M | 1 | Integer | progress (1-100) |
1259 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1260 | lcmOperationS tatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
1262 | | | | | Permitted values: |
1264 | | | | | - STARTING: The operation is starting.. |
1266 | | | | | - PROCESSING: The operation is currently in execution. |
1268 | | | | | - COMPLETED: The operation has completed successfully. |
1270 | | | | | - FAILED: The operation has failed and it |
1271 | | | | | cannot be retried or rolled back, as it is |
1272 | | | | | determined that such action won't succeed. |
1275 | | | | | - FAILED\_TEMP: The operation has failed and execution |
1276 | | | | | has stopped, but the execution of the operation |
1277 | | | | | is not considered to be closed. (Reserved) |
1279 | | | | | - ROLLING\_BACK: The operation is currently being |
1280 | | | | | rolled back. (Reserved) |
1283 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
1284 | | | | | original operation invocation has been restored |
1285 | | | | | as closely as possible. (Reserved) |
1287 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1288 | statusDescription | O | 0..1 | String | Status Description of a VNF lifecycle operation occurrence|
1289 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1290 | errorCode | O | 0..1 | Integer | Errorcode |
1291 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1295 "vnfLcOpId": "1234566",
1297 "vnfInstanceId": "1",
1298 "lcmOperationType": "INSTANTIATE",
1300 "startTime": "2017-01-01T12:00:27.87+00:20",
1302 "responseDescriptor": {
1306 "lcmOperationStatus": "PROCESSING",
1307 "statusDescription": "OMC VMs are decommissioned in VIM",
1309 "responseHistoryList": [
1314 "lcmOperationStatus": "PROCESSING",
1315 "statusDescription": "OMC VMs are decommissioned in VIM",
1323 "lcmOperationStatus": "PROCESSING",
1324 "statusDescription": "OMC VMs are decommissioned in VIM",
1335 **3.7.3 Response Code**
1337 +-----------+-----------------------+----------------------------------+
1338 | Code | Meaning | Description |
1339 +===========+=======================+==================================+
1340 | 200 | Ok | The request has succeeded. |
1341 +-----------+-----------------------+----------------------------------+
1342 | 4xx/5xx | <name from RFC7231> | <description> |
1343 +-----------+-----------------------+----------------------------------+
1345 **4.Interfaces provided by VNF**\ (Ve-Vnfm-vnf)
1346 ===============================================
1348 **4.1 Set Initial Configuration**
1349 ---------------------------------
1351 +---------------------+---------------------------------------------+
1352 | If Definition | Description |
1353 +=====================+=============================================+
1354 | URI | http(s)://[hostname][:port]/configuration |
1355 +---------------------+---------------------------------------------+
1356 | Operation | POST |
1357 +---------------------+---------------------------------------------+
1358 | Direction | VNFM->VNF |
1359 +---------------------+---------------------------------------------+
1363 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1364 | Parameter | Qualifier | Cardinality | Content | Description |
1365 +=========================+=============+===============+==========================+==============================================================================+
1366 | vnfInstanceId | M | 1 | Identifier | Identifier of the VNF instance which the VNF to set initial configuration. |
1367 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1368 | vnfConfigurationData | O | 0..1 | VnfConfigur ation | Configuration data for the VNF instance. |
1369 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1370 | vnfcConfigurationData | O | 0..N | VnfcConfigu ration | Configuration data for VNFC instances. |
1371 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1373 **VnfConfiguration:**
1375 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1376 | Attribute | Qualifier | Cardinalit y | Content | Description |
1377 +=======================+=================+====================+==================================+==============================================================================+
1378 | cp | O | 0..N | CpConfiguratio n | External CPs |
1379 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1380 | vnfSpecificData | O | 0..1 | VnfConfigurabl eProperties | Configuration object containing values of VNF configurable properties. |
1381 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1383 **CpConfiguration:**
1385 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1386 | Attribute | Qualifier | Cardinalit y | Content | Description |
1387 +=================+=============+====================+==============+=======================================================================================================+
1388 | cpId | M | 1 | Identifier | Uniquely identifies a CP instance within the namespace of a specific VNF instance or VNFC instance. |
1389 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1390 | cpdId | M | 1 | Identifier | Uniquely identifies a type of CP instance within the namespace of a VNFD. |
1391 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1392 | cpAddress | M | 1..N | CpAddress | Address and Port assigned to the CP. |
1393 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1397 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1398 | Attribute | Qualifier | Cardinalit y | Content | Description |
1399 +==========================+=============+====================+===================+===============================================================================================================================================+
1400 | address | M | 0..N | NetworkAddre ss | The address assigned to the CP instance (e.g. IP address, MAC address, etc.). It shall be provided for configuring a fixed address. |
1401 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1402 | 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. |
1404 | | | | | A cardinality of "0" indicates that no dynamic address needs to be configured on the CP. |
1406 | | | | | Permitted values: |
1411 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1412 | port | M | 0..1 | Not specified | The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.). |
1414 | | | | | Reserved |
1415 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1417 **VnfConfigurableProperties:**
1419 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1420 | Attribute | Qualifier | Cardinality | Content| Description |
1421 +====================+===========+==============+========+===============================================================================================+
1422 | autoScalable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-scaling functionality. |
1424 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
1426 | | | | | Permitted values: |
1431 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1432 | autoHealable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-healing functionality. |
1434 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
1436 | | | | | Permitted values: |
1441 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1443 **VnfcConfiguration:**
1445 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1446 | Attribute | Qualifier | Cardinalit y | Content | Description |
1447 +========================+=============+====================+====================+========================================================================================+
1448 | vnfcId | M | 1 | Identifier | Uniquely identifies a VNFC instance within the namespace of a specific VNF instance. |
1449 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1450 | cp | O | 0..N | CpConfiguratio n | Internal CPs. |
1451 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1452 | vnfcSpecificData | O | 0..1 | KeyValuePair | Configuration object containing values of VNFC configurable properties |
1453 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1457 "vnfInstanceId": "1",
1458 "vnfConfigurationData": {
1471 "addressType": "MAC",
1472 "l2AddressData": "00:f3:43:20:a2:a3"
1477 "addressType": "IP",
1480 "iPAddressType": "IPv4",
1481 "iPAddress": "192.168.104.2"
1489 "useDynamicAddress": "FALSE"
1499 "vnfSpecificData": {
1501 "autoScalable": "FALSE",
1502 "autoHealable": "FALSE"
1508 "vnfcConfigurationData":
1522 "addressType": "MAC",
1523 "l2AddressData": "00:f3:43:21:a2:a3"
1528 "addressType": "IP",
1531 "iPAddressType": "IPv4",
1532 "iPAddress": "192.168.105.2"
1539 "useDynamicAddress": "FALSE"
1549 "vnfcSpecificData": {}
1558 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1559 | Parameter | Qualifier | Cardinality | Content | Description |
1560 +=======================+=============+===============+===================+=================================+
1561 | vnfConfigurationData | O | 0..1 | VnfConfiguration | Correspond to the |
1562 | | | | | vnfConfigurationData in the |
1563 | | | | | input information elements of |
1564 | | | | | the SetInitialConfiguration |
1565 | | | | | operation if it has. |
1566 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1567 | vnfcConfigurationDa | O | 0..N | VnfConfiguration | Correspond to the |
1568 | ta | | | | vnfcConfigurationData in the |
1569 | | | | | input information elements of |
1570 | | | | | the SetInitialConfiguration |
1571 | | | | | operation if it has. |
1572 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1575 "vnfConfigurationData": {
1581 "cpdId": "cpd-a", "cpAddress": [
1587 "addressType": "MAC",
1588 "l2AddressData": "00:f3:43:20:a2:a3"
1593 "addressType": "IP",
1596 "iPAddressType": "IPv4",
1597 "iPAddress": "192.168.104.2"
1605 "useDynamicAddress": "FALSE"
1614 "vnfSpecificData": {
1616 "autoScalable": "FALSE",
1617 "autoHealable": "FALSE",
1624 "vnfcConfigurationData": {
1639 "addressType": "MAC",
1640 "l2AddressData": "00:f3:43:21:a2:a3"
1645 "addressType": "IP",
1648 "iPAddressType": "IPv4",
1649 "iPAddress": "192.168.105.2"
1657 "useDynamicAddress": "FALSE"
1667 "vnfcSpecificData": {…}
1673 **4.1.3Response Code**
1675 +-----------+-----------------------+-----------------------------------------------------------+
1676 | Code | Meaning | Description |
1677 +===========+=======================+===========================================================+
1678 | 201 | Created | A VNF Instance identifier was created successfully. |
1679 +-----------+-----------------------+-----------------------------------------------------------+
1680 | 4xx/5xx | <name from RFC7231> | <description> |
1681 +-----------+-----------------------+-----------------------------------------------------------+
1683 .. |image0| image:: VNFM_API.png