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