11 The scope of the present document is to describe the VNFM exposed
\r
12 API specification over Or-Vnfm Reference Point.
\r
14 **2 Terms, Definitions and Abbreviations**
\r
15 ===========================================
\r
17 For the purposes of the present document, the following
\r
18 abbreviations apply:
\r
20 +------------------------+-----------------------------------------------------+
\r
21 | **Abbreviation** | |
\r
22 +========================+=====================================================+
\r
23 | NFVO | Network Functions Virtualization Orchestrator |
\r
24 +------------------------+-----------------------------------------------------+
\r
25 | VNFM | Virtual Network Function Manager |
\r
26 +------------------------+-----------------------------------------------------+
\r
27 | VNF | Virtual Network Function |
\r
28 +------------------------+-----------------------------------------------------+
\r
29 Table 2-1 abbreviations
\r
31 **3. Interfaces provided by VNFM** (Or-Vnfm/Ve-Vnfm-vnf)
\r
32 ==========================================================
\r
34 Interfaces use RESTful API and the format is as follows:
\r
35 http(s)://[hostname][:port]/gvnfmapi/lcm/v1/[……]
\r
40 **{apiRoot} is** http(s)://[hostname][:port]/gvnfmapi
\r
42 **3.1 Create VNF Identifier**
\r
43 -----------------------------
\r
45 +---------------------+--------------------------------------------------------------+
\r
46 | If Definition | Description |
\r
47 +=====================+==============================================================+
\r
48 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances |
\r
49 +---------------------+--------------------------------------------------------------+
\r
50 | Operation | POST |
\r
51 +---------------------+--------------------------------------------------------------+
\r
52 | Direction | NFVO->VNFMLCM |
\r
53 +---------------------+--------------------------------------------------------------+
\r
57 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
58 | Parameter | Qualifier | Cardinality | Content | Description |
\r
59 +===========================+=============+===============+==================+=====================================================================================+
\r
60 | vnfdId | M | 1 | Identifier | Identifier that identifies the VNFD which defines the VNF instance to be created. |
\r
61 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
62 | vnfInstanceName | M | 1 | String | Human-readable name of the VNF instance to be created. |
\r
63 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
64 | vnfInstanceDescription | O | 0..1 | String | Human-readable description of the VNF instance to be created. |
\r
65 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
68 "vnfdId": "zte\_vFW\_51610",
\r
69 "vnfInstanceName": "vFW\_01",
\r
70 " vnfInstanceDescription": " vFW in Nanjing TIC Edge"
\r
75 +-----------------+-------------+---------------+------------------+-----------------------------------------+
\r
76 | Parameter | Qualifier | Cardinality | Content | Description |
\r
77 +=================+=============+===============+==================+=========================================+
\r
78 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier just created. |
\r
79 +-----------------+-------------+---------------+------------------+-----------------------------------------+
\r
82 "vnfInstanceId": "1"
\r
85 **3.1.3 Response Code**
\r
87 +-----------+-----------------------+-----------------------------------------------------------+
\r
88 | Code | Meaning | Description |
\r
89 +===========+=======================+===========================================================+
\r
90 | 201 | Created | A VNF Instance identifier was created successfully. |
\r
91 +-----------+-----------------------+-----------------------------------------------------------+
\r
92 | 4xx/5xx | <name from RFC7231> | <description> |
\r
93 +-----------+-----------------------+-----------------------------------------------------------+
\r
95 **3.2 Delete VNF Identifier**
\r
96 -----------------------------
\r
98 +---------------------+------------------------------------------------------------------------------+
\r
99 | If Definition | Description |
\r
100 +=====================+==============================================================================+
\r
101 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances/{vnfInstanceId} |
\r
102 +---------------------+------------------------------------------------------------------------------+
\r
103 | Operation | DELETE |
\r
104 +---------------------+------------------------------------------------------------------------------+
\r
105 | Direction | NFVO->VNFMLCM |
\r
106 +---------------------+------------------------------------------------------------------------------+
\r
110 +-------------+-------------+---------------+---------------+---------------+
\r
111 | Parameter | Qualifier | Cardinality | Content | Description |
\r
112 +=============+=============+===============+===============+===============+
\r
114 +-------------+-------------+---------------+---------------+---------------+
\r
118 +-------------+-------------+---------------+---------------+---------------+
\r
119 | Parameter | Qualifier | Cardinality | Content | Description |
\r
120 +=============+=============+===============+===============+===============+
\r
122 +-------------+-------------+---------------+---------------+---------------+
\r
124 **3.2.3 Response Code**
\r
126 +--------+-----------+-------------------+
\r
127 | Code | Meaning | Description |
\r
128 +--------+-----------+-------------------+
\r
130 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
\r
131 | 204 | No Content | The VNF instance resource and the associated VNF identifier were deleted successfully. |
\r
132 +===========+=======================+==============================================================================================+
\r
133 | 4xx/5xx | <name from RFC7231> | <description> |
\r
134 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
\r
136 3.3 Instantiate VNF
\r
137 -------------------
\r
139 +---------------------+-------------------------------------------------------------------------------------------+
\r
140 | If Definition | Description |
\r
141 +=====================+===========================================================================================+
\r
142 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId}/instantiate |
\r
143 +---------------------+-------------------------------------------------------------------------------------------+
\r
144 | Operation | POST |
\r
145 +---------------------+-------------------------------------------------------------------------------------------+
\r
146 | Direction | NFVO->VNFMLCM |
\r
147 +---------------------+-------------------------------------------------------------------------------------------+
\r
151 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
152 | Parameter | Qualifier | Cardinality | Content | Description |
\r
153 +====================+===========+=============+=====================+===============================================================+
\r
154 | flavourId | M | 1 | IdentifierInV nfd | Identifier of the VNF deployment flavour to be instantiated. |
\r
155 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
156 | instantiation | O | 0..1 | IdentifierInVnfd | Identifier of the instantiation |
\r
157 | LevelId | | | | level of the deployment |
\r
158 | | | | | flavour to be instantiated. If |
\r
159 | | | | | not present, the default |
\r
160 | | | | | instantiation level as |
\r
161 | | | | | declared in the VNFD is |
\r
162 | | | | | instantiated. |
\r
164 | | | | | Reserved |
\r
165 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
166 | extVirtualLinks | O | 0..N | ExtVirtualLin kData | Information about external VLs to connect the VNF to. |
\r
167 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
168 | extManagedVirtualL | O | 0..N | ExtManaged | Information about internal |
\r
169 | inks | | | VirtualLinkData | VLs that are managed by |
\r
170 | | | | | other entities than the VNFM. |
\r
172 | | | | | Reserved |
\r
173 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
174 | localization | O | 0..1 | String | Localization language of the VNF to be instantiated can be |
\r
175 | Language | | | | declared in the VNFD. The value shall comply with the format |
\r
176 | | | | | defined in IETF RFC 5646 [6]. |
\r
178 | | | | | Reserved |
\r
179 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
180 | additionalParams | O | 0..N | KeyValuePair | Additional input parameters for the instantiation process, |
\r
181 | | | | | specific to the VNF being instantiated. |
\r
182 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
184 **ExtVirtualLinkData:**
\r
186 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
187 | Attribute | Qualifier | Cardinality | Content | Description |
\r
188 +==================+===========+=============+=================+==================================================================================+
\r
189 | vlInstanceId | O | 0..1 | Identifier | Identifier of the VL instance. |
\r
190 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
191 | vim | CM | 0..1 | VimInfo | Information about the VIM that manages this resource. |
\r
192 | | | | | This attribute shall be supported and present if VNF-related resource management |
\r
193 | | | | | in direct mode is applicable. |
\r
194 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
195 | resourceProvider | CM | 0..1 | Identifier | Identifies the entity responsible for the management of this resource. |
\r
196 | Id | | | | This attribute shall be present if |
\r
197 | | | | | VNF-related resource management in indirect mode is applicable. |
\r
199 | | | | | Reserved |
\r
200 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
201 | resourceId | M | 1 | IdentifierInVim | The identifier of the resource in the scope of the VIM or the resource provider. |
\r
202 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
203 | extCps | M | 1..N | VnfExtCpData | External CPs of the VNF to be connected to this external VL. |
\r
204 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
208 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
209 | Attribute | Qualifier | Cardinality | Content | Description |
\r
210 +=================+===========+=============+==============+==========================================================================================================================================+
\r
211 | vimInfoId | M | 1 | Identifier | The identifier of this VimInfo instance, for the purpose of referencing it from other information elements. |
\r
212 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
213 | vimId | M | 1 | Identifier | The identifier of the VIM. |
\r
214 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
215 | interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version, and protocol type. |
\r
216 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
217 | accessInfo | M | 0..N | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, |
\r
218 | | | | | Token, etc. |
\r
219 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
220 | interface | M | 1 | String | Information about the interface endpoint. An example is a URL. |
\r
221 | Endpoint | | | | Token, etc. |
\r
222 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
225 +------------------+---------------+--------------------------------------+
\r
226 | **Key Define** | **Content** | **Description** |
\r
227 +==================+===============+======================================+
\r
228 | vimType | String | The type of the VIM. |
\r
229 +------------------+---------------+--------------------------------------+
\r
230 | apiVersion | String | The Version of the api of the VIM. |
\r
231 +------------------+---------------+--------------------------------------+
\r
232 | protocolType | String | http https |
\r
233 +------------------+---------------+--------------------------------------+
\r
236 +------------------+---------------+--------------------------+
\r
237 | **Key Define** | **Content** | **Description** |
\r
238 +==================+===============+==========================+
\r
239 | tenant | String | Tenant Name of tenant |
\r
240 +------------------+---------------+--------------------------+
\r
241 | username | String | Username for login |
\r
242 +------------------+---------------+--------------------------+
\r
243 | password | String | Password of login user |
\r
244 +------------------+---------------+--------------------------+
\r
248 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
249 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
250 +========================+=====================+=======================+====================+===========================================================+
\r
251 | cpdId | M | 1 | IdentifierInVnfd | The identifier of the CPD in the VNFD. |
\r
252 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
253 | addresses | O | 0..N | NetworkAddress | List of (fixed) network addresses that |
\r
254 | | | | | need to be configured on the CP. This attribute shall |
\r
255 | | | | | be present if fixed addresses need to be configured. |
\r
256 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
257 | numDynamicAddre sses | O | 0..1 | Integer | Number of network addresses to be assigned dynamically. |
\r
258 | | | | | This attribute shall be present if dynamic |
\r
259 | | | | | addresses need to be configured. |
\r
260 | | | | | Reserved |
\r
261 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
263 **NetworkAddress:**
\r
265 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
266 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
267 +=================+=====================+=======================+===================+===============================================================================================================+
\r
268 | addressType | M | 1 | Enum | Describes the type of the address to be assigned to the CP instantiated from the parent CPD. |
\r
270 | | | | | Permitted values: |
\r
275 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
276 | 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
278 | | | | | Shall be present when the addressType is MAC address. |
\r
279 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
280 | l3AddressData | CM | 0..1 | L3AddressData | Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. |
\r
282 | | | | | Shall be present when the addressType is IP address. |
\r
283 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
287 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
288 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
289 +=================+=====================+=======================+===================+=======================+
\r
290 | iPAddressType | M | 1 | ENUM | IP address type. |
\r
292 | | | | | Permitted values: |
\r
297 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
298 | iPAddress | M | 1 | String | IP address |
\r
299 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
303 "flavourId": "flavour\_1",
\r
304 "instantiationLevelId":"instantiationLevel\_1",
\r
305 "extVirtualLinks": [
\r
307 "vlInstanceId": "1",
\r
313 "apiVersion": "v2",
\r
314 "protocolType": "http"
\r
317 "tenant": "tenant\_vCPE",
\r
318 "username": "vCPE",
\r
319 "password": "vCPE\_321"
\r
321 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
323 "resourceId": "1246",
\r
326 "cpdId": "11", "addresses": [
\r
328 "addressType": "MAC",
\r
329 "l2AddressData": "00:f3:43:20:a2:a3"
\r
332 "addressType": "IP",
\r
334 "iPAddressType": "IPv4",
\r
335 "iPAddress": "192.168.104.2"
\r
339 "numDynamicAddresses": 0
\r
345 "localizationLanguage": "en\_US", "additionalParams": {...}
\r
350 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
351 | Parameter | Qualifier | Cardinality | Content | Description |
\r
352 +=============+=============+===============+==================+=========================================================+
\r
353 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
\r
354 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
362 **3.3.3 Response Code**
\r
363 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
364 | Code | Meaning | Description |
\r
365 +===========+=======================+==========================================================================================+
\r
366 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
\r
367 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
368 | 4xx/5xx | <name from RFC7231> | <description> |
\r
369 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
371 **3.4 Terminate VNF**
\r
372 ---------------------
\r
374 +---------------------+-----------------------------------------------------------------------------------------+
\r
375 | If Definition | Description |
\r
376 +=====================+=========================================================================================+
\r
377 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances/{vnfInstanceId}/term inate |
\r
378 +---------------------+-----------------------------------------------------------------------------------------+
\r
379 | Operation | POST |
\r
380 +---------------------+-----------------------------------------------------------------------------------------+
\r
381 | Direction | NFVO->VNFMLCM |
\r
382 +---------------------+-----------------------------------------------------------------------------------------+
\r
386 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
387 | Parameter | Qualifier | Cardinality | Content | Description |
\r
388 +===================+=============+===============+===============+=========================================================================+
\r
389 | terminationType | M | 1 | Enum | Indicates whether forceful or graceful termination is requested. |
\r
391 | | | | | Permitted values: |
\r
393 | | | | | - FORCEFUL: The VNFM |
\r
394 | | | | | will shut down the VNF and release the resources immediately |
\r
395 | | | | | after accepting the request. |
\r
396 | | | | | - GRACEFUL: The VNFM |
\r
398 | | | | | will first arrange to take the VNF out of service after accepting |
\r
399 | | | | | the request. Once the operation is successful or once the timer |
\r
400 | | | | | value specified in the |
\r
401 | | | | | “gracefulTerminationTime out” attribute expires, the VNFM will shut |
\r
402 | | | | | down the VNF and release the resources. |
\r
403 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
404 | graceful | O | 0..1 | Integer | This attribute is only |
\r
405 | Termination | | | | applicable in case of graceful |
\r
406 | Timeout | | | | termination. It defines the |
\r
407 | | | | | time to wait for the VNF to be |
\r
408 | | | | | taken out of service before |
\r
409 | | | | | shutting down the VNF and |
\r
410 | | | | | releasing the resources. |
\r
411 | | | | | The unit is seconds. |
\r
412 | | | | | If not given and the |
\r
413 | | | | | "terminationType" |
\r
414 | | | | | attribute is set to |
\r
415 | | | | | "GRACEFUL", it is expected |
\r
416 | | | | | that the VNFM waits for |
\r
417 | | | | | the successful taking out of |
\r
418 | | | | | service of the VNF, no |
\r
419 | | | | | matter how long it takes, |
\r
420 | | | | | before shutting down the |
\r
421 | | | | | VNF and releasing the |
\r
422 | | | | | resources. |
\r
423 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
425 "terminationType": "GRACEFUL",
\r
426 "gracefulTerminationTimeout": 120
\r
431 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
432 | Parameter | Qualifier | Cardinality | Content | Description |
\r
433 +=============+=============+===============+==================+=========================================================+
\r
434 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
\r
435 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
441 **3.4.3 Response Code**
\r
443 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
444 | Code | Meaning | Description |
\r
445 +===========+=======================+==========================================================================================+
\r
446 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
\r
447 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
448 | 4xx/5xx | <name from RFC7231> | <description> |
\r
449 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
451 **3.5 Query multiple VNF**
\r
452 ---------------------------
\r
453 +---------------------+--------------------------------------------------------------+
\r
454 | If Definition | Description |
\r
455 +=====================+==============================================================+
\r
456 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances |
\r
457 +---------------------+--------------------------------------------------------------+
\r
458 | Operation | GET |
\r
459 +---------------------+--------------------------------------------------------------+
\r
460 | Direction | NFVO->VNFMLCM |
\r
461 +---------------------+--------------------------------------------------------------+
\r
465 +-------------+-------------+---------------+---------------+---------------+
\r
466 | Parameter | Qualifier | Cardinality | Content | Description |
\r
467 +=============+=============+===============+===============+===============+
\r
469 +-------------+-------------+---------------+---------------+---------------+
\r
473 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
474 | Parameter | Qualifier | Cardinality | Content | Description |
\r
475 +====================+=============+===============+========================+======================================================================================+
\r
476 | vnfInstanceInfos | M | 0..N | VnfInstanceI nfo | Returned if information about zero or more VNF instances was queried successfully. |
\r
477 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
478 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
480 **VnfInstanceInfo:**
\r
482 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
483 | Attribute | Qualifier|Cardinality | Content | Description |
\r
484 +==================================+==========+============+============================+=======================================================================================================================================================+
\r
485 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier. |
\r
486 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
487 | vnfInstanceName | M | 1 | String | VNF instance name. |
\r
488 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
489 | vnfInstanceDescr iption | M | 1 | String | Human-readable description of the VNF instance. |
\r
490 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
491 | 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
492 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
493 | vnfdId | M | 1 | Identifier | Identifier of the VNFD on which the VNF instance is based. |
\r
494 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
495 | vnfdVersion | M | 1 | Identifier | Identifies the version of the VNFD. The value is copied from the VNFD. |
\r
496 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
497 | vnfSoftwareVersi on | M | 1 | String | Software version of the VNF. |
\r
499 | | | | | The value is copied from the VNFD. |
\r
500 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
501 | vnfProvider | M | 1 | String | Name of the person or company providing the VNF. |
\r
503 | | | | | The value is copied from the VNFD. |
\r
504 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
505 | vnfProductName | M | 1 | String | Name to identify the VNF Product. The value is copied from the VNFD. |
\r
506 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
507 | vnfConfigurableP roperties | O | 0..N | KeyValuePair | Current values of the configurable properties of the VNF instance. |
\r
509 | | | | | Configurable properties as declared in the VNFD. |
\r
510 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
511 | instantiationState | M | 1 | Enum | The instantiation state of the VNF. |
\r
513 | | | | | Permitted values: |
\r
515 | | | | | - NOT\_INSTANTIATED: The VNF |
\r
517 | | | | | instance is terminated or not instantiated. |
\r
519 | | | | | - INSTANTIATED: The VNF instance is instantiated. |
\r
520 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
521 | instantiatedVnfInf o | CM | 0..1 | InstantiatedVnf Info | Information specific to an instantiated VNF instance. |
\r
523 | | | | | This attribute shall be present if the instantiateState attribute value is INSTANTIATED. |
\r
524 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
525 | metadata | O | 0..N | KeyValuePair | Additional metadata describing the VNF instance. |
\r
527 | | | | | This attribute can be modified with the Modify VNF information operation. |
\r
528 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
529 | extensions | O | 0..N | KeyValuePair | VNF-specific attributes. |
\r
531 | | | | | This attribute can be modified with the Modify VNF information operation. |
\r
532 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
534 **InstantiatedVnfInfo:**
\r
536 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
537 | Attribute | Qualifier | Cardinality| Content | Description |
\r
538 +==============================+===========+============+==============================+========================================================================================================================+
\r
539 | flavourId | M | 1 | IdentifierInVnfd | Identifier of the VNF deployment flavour to be instantiated. |
\r
541 | | | | | Reserved |
\r
542 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
543 | vnfState | M | 1 | ENUM | State of the VNF instance. |
\r
545 | | | | | Permitted values: |
\r
547 | | | | | - STARTED: The VNF instance is up and running. |
\r
549 | | | | | - STOPPED: The VNF instance has been shut down. |
\r
550 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
551 | 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
553 | | | | | w.r.t. that aspect. |
\r
555 | | | | | This attribute shall be present if the VNF supports scaling. |
\r
556 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
557 | extCpInfo | O | 0..N | CpInfo | Information about the external CPs exposed by the VNF instance. |
\r
558 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
559 | extVirtualLink | O | 0..N | ExtVirtualLinkI nfo | Information about the external VLs the VNF instance is connected to. |
\r
560 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
561 | extManagedVirtu alLink | O | 0..N | extManagedVir tualLinkInfo | Information about the externally-managed internal VLs of the VNF instance. |
\r
563 | | | | | Reserved |
\r
564 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
565 | monitoringParam eters | O | 0..N | MonitoringPar ameter | Active monitoring parameters. |
\r
567 | | | | | Reserved |
\r
568 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
569 | localizationLangu age | O | 0..1 | String | Localization language of the VNF to be instantiated. |
\r
571 | | | | | The value shall comply with the format defined in IETF RFC 5646 [6]. |
\r
572 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
573 | vimInfo | CM | 0..N | VimInfo | Information about VIM(s) managing resources for the VNF instance. |
\r
575 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
576 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
577 | vnfcResourceInfo | CM | 0..N | VnfcResourceI nfo | Information about the virtualised compute and storage resource(s) used by the VNFCs of the VNF instance. |
\r
579 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
580 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
581 | virtualLinkResourceInfo | CM | 0..N | VirtualLinkRes ourceInfo | Information about the virtualised network resource(s) used by the VLs of the VNF instance. |
\r
583 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
584 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
585 | virtualStorageResourceInfo | CM | 0..N | VirtualStorage ResourceInfo | Information about the virtualised storage resource(s) used as storage for the VNF instance. |
\r
587 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
588 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
592 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
593 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
594 +==================+=============+====================+====================+=====================================================================================================================================+
\r
595 | aspectId | M | 1 | IdentifierInVnfd | Identifier of the scaling aspect. |
\r
596 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
597 | 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
598 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
599 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
603 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
604 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
605 +====================+=============+====================+====================+==================================================================+
\r
606 | cpInstanceId | M | 1 | Identifier | Identifier of the CP instance. |
\r
607 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
608 | cpdId | M | 1 | IdentifierInVnfd | Identifier of the CPD, in the VNFD. |
\r
609 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
610 | addresses | O | 0..N | NetworkAddre ss | List of network addresses that have been configured on the CP. |
\r
611 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
613 **ExtVirtualLinkInfo:**
\r
615 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
616 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
617 +========================+=============+====================+===================+=================================================+
\r
618 | extVirtualLinkId | M | 1 | Identifier | Identifier of the external VL. |
\r
619 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
620 | resourceHandle | M | 1 | ResourceHand le | Identifier of the resource realizing this VL. |
\r
621 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
622 | linkPorts | O | 0..N | VnfLinkPort | Link ports of this VL. |
\r
623 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
625 **ResourceHandle:**
\r
627 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
628 | Attribute | Qualifier | Cardinality| Content | Description |
\r
629 +=====================+============+============+===================+========================================================================================================+
\r
630 | vimId | CM | 0..1 | Identifier | Identifier of the VimInfo information element defining the VIM who manages the resource. |
\r
632 | | | | | This attribute shall be present if |
\r
634 | | | | | VNF-related resource management in direct mode is applicable. |
\r
636 | | | | | The value refers to a vimInfo item in the VnfInstance. |
\r
637 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
638 | resourceProviderId | CM | 0..1 | Identifier | Identifier of the entity responsible for the management of the resource. |
\r
640 | | | | | This attribute shall be present when VNF-related resource management in indirect mode is applicable. |
\r
642 | | | | | Reserved |
\r
643 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
644 | resourceId | M | 1 | IdentifierInVim | Identifier of the resource in the scope of the VIM or the resource provider. |
\r
645 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
649 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
650 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
651 +======================+=============+====================+===================+================================================================================================+
\r
652 | resourceHandle | M | 1 | ResourceHand le | Identifier of the virtualised network resource realizing this link port. |
\r
653 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
654 | cpInstanceId | M | 1 | IdentifierInVnf | External CP of the VNF to be connected to this link port. |
\r
656 | | | | | There shall be at most one link port associated with any external connection point instance. |
\r
658 | | | | | The value refers to an extCpInfo item in the VnfInstance. |
\r
659 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
660 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
662 **VnfcResourceInfo:**
\r
664 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
665 | Attribute | Qualifier | Cardinality| Content | Description |
\r
666 +=======================+============+============+====================+=====================================================================================================================+
\r
667 | vnfcInstanceId | M | 1 | IdentifierInVnf | Identifier of this VNFC instance. |
\r
668 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
669 | vduId | M | 1 | IdentifierInVnfd | Reference to the applicable Vdu information element in the VNFD. |
\r
670 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
671 | computeResourc e | M | 1 | ResourceHand le | Reference to the VirtualCompute resource. |
\r
672 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
673 | storageResourceI ds | M | 1..N | IdentifierInVnf | Reference(s) to the VirtualStorage resource(s). |
\r
675 | | | | | The value refers to a VirtualStorageResourceInfo item in the VnfInstance. |
\r
676 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
677 | reservationId | O | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
\r
679 | | | | | Reserved |
\r
680 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
682 **VirtualStorageResourceInfo:**
\r
684 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
685 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
686 +=================================+=============+====================+====================+=====================================================================================================================+
\r
687 | virtualStorageInst anceId | M | 1 | IdentifierInVnf | Identifier of this virtual storage resource instance. |
\r
688 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
689 | virtualStorageDe scId | M | 1 | IdentifierInVnfd | Identifier of the VirtualStorageDesc in the VNFD. |
\r
690 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
691 | storageResource | M | 1 | ResourceHand le | Reference to the VirtualStorage resource. |
\r
692 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
693 | reservationId | M | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
\r
695 | | | | | Reserved |
\r
696 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
698 **VirtualLinkResourceInfo:**
\r
700 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
701 | Attribute | Qualifier | Cardinality | Content | Description |
\r
702 +==============================+===========+==============+====================+=====================================================================================================================+
\r
703 | virtualLinkInstanceId | M | 1 | IdentifierInVnf | Identifier of this VL instance. |
\r
704 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
705 | virtualLinkDescId | M | 1 | IdentifierInVnfd | Identifier of the Virtual Link Descriptor (VLD) in the VNFD. |
\r
706 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
707 | networkResource | M | 1 | ResourceHand le | Reference to the VirtualNetwork resource. |
\r
708 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
709 | reservationId | M | 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
718 "vnfInstanceId": "1",
\r
719 "vnfInstanceName": "vFW\_01",
\r
720 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
\r
721 "onboardedVnfPkgInfoId": "1",
\r
722 "vnfdId": "zte\_vFW\_51610",
\r
723 "vnfdVersion": "V1.0",
\r
724 "vnfSoftwareVersion": "V1.0",
\r
725 "vnfProvider": "ZTE",
\r
726 "vnfProductName": "vFW",
\r
727 "vnfConfigurableProperties": {...},
\r
728 "instantiationState": "INSTANTIATED",
\r
729 "instantiatedVnfInfo": {
\r
731 "vnfState": "STARTED",
\r
734 "aspectId": "aspect1",
\r
740 "cpInstanceId": "1",
\r
741 "cpdId": "1", "addresses": [
\r
743 "addressType": "MAC",
\r
744 "l2AddressData": "00:f3:43:20:a2:a3"
\r
747 "addressType": "IP",
\r
749 "iPAddressType": "IPv4",
\r
750 "address": "192.168.104.2"
\r
756 "extVirtualLink": [
\r
758 "extVirtualLinkId": "extvl1",
\r
759 "resourceHandle": {
\r
761 "resourceId": "1111"
\r
769 "resourceId": "2121"
\r
771 "cpInstanceId": "1"
\r
777 "monitoringParameters": {...},
\r
778 "localizationLanguage": "en\_US",
\r
785 "apiVersion": "v2",
\r
786 "protocolType": "http"
\r
789 "tenant": "tenant\_vCPE",
\r
790 "username": "vCPE",
\r
791 "password": "vCPE\_321"
\r
794 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
797 "vnfcResourceInfo": [
\r
799 "vnfcInstanceId": "vm1",
\r
801 "computeResource": {
\r
803 "resourceId": "3333"
\r
805 "storageResourceIds": [ "storage1"
\r
809 "virtualLinkResourceInfo": [
\r
811 "virtualLinkInstanceId": "vl01",
\r
812 "virtualLinkDescId": "vl01",
\r
813 "networkResource": {
\r
815 "resourceId": "4444"
\r
819 "virtualStorageResourceInfo": [
\r
821 "virtualStorageInstanceId": "storage1",
\r
822 "virtualStorageDescId":"storage1",
\r
823 "storageResource": {
\r
825 "resourceId": "555"
\r
831 "extensions": {...}
\r
835 **3.5.3 Response Code**
\r
837 +-----------+-----------------------+----------------------------------+
\r
838 | Code | Meaning | Description |
\r
839 +===========+=======================+==================================+
\r
840 | 200 | Ok | The request has succeeded. |
\r
841 +-----------+-----------------------+----------------------------------+
\r
842 | 4xx/5xx | <name from RFC7231> | <description> |
\r
843 +-----------+-----------------------+----------------------------------+
\r
845 **3.6 Query single VNF**
\r
846 ------------------------
\r
847 +---------------------+------------------------------------------------------------------------------+
\r
848 | If Definition | Description |
\r
849 +=====================+==============================================================================+
\r
850 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId} |
\r
851 +---------------------+------------------------------------------------------------------------------+
\r
852 | Operation | GET |
\r
853 +---------------------+------------------------------------------------------------------------------+
\r
854 | Direction | NFVO->VNFMLCM |
\r
855 +---------------------+------------------------------------------------------------------------------+
\r
859 +-------------+-------------+---------------+---------------+---------------+
\r
860 | Parameter | Qualifier | Cardinality | Content | Description |
\r
861 +=============+=============+===============+===============+===============+
\r
863 +-------------+-------------+---------------+---------------+---------------+
\r
867 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
868 | Parameter | Qualifier | Cardinality | Content | Description |
\r
869 +===================+=============+===============+========================+=======================================+
\r
870 | vnfInstanceInfo | M | 1 | VnfInstanceI nfo | The information of the VNF instance |
\r
871 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
872 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
874 **3.6.3 Response Code**
\r
876 +-----------+-----------------------+----------------------------------+
\r
877 | Code | Meaning | Description |
\r
878 +===========+=======================+==================================+
\r
879 | 200 | Ok | The request has succeeded. |
\r
880 +-----------+-----------------------+----------------------------------+
\r
881 | 4xx/5xx | <name from RFC7231> | <description> |
\r
882 +-----------+-----------------------+----------------------------------+
\r
886 "vnfInstanceId": "1",
\r
887 "vnfInstanceName": "vFW\_01",
\r
888 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
\r
889 "onboardedVnfPkgInfoId": "1",
\r
890 "vnfdId": "zte\_vFW\_51610",
\r
891 "vnfdVersion": "V1.0",
\r
892 "vnfSoftwareVersion": "V1.0",
\r
893 "vnfProvider": "ZTE",
\r
894 "vnfProductName": "vFW",
\r
895 "vnfConfigurableProperties": {...},
\r
896 "instantiationState": "INSTANTIATED",
\r
897 "instantiatedVnfInfo": {
\r
899 "vnfState": "STARTED",
\r
902 "aspectId": "aspect1",
\r
909 "cpInstanceId": "1",
\r
910 "cpdId": "1", "addresses": [
\r
912 "addressType": "MAC",
\r
913 "l2AddressData": "00:f3:43:20:a2:a3"
\r
917 "addressType": "IP",
\r
919 "iPAddressType": "IPv4",
\r
920 "address": "192.168.104.2"
\r
927 "extVirtualLink": [
\r
929 "extVirtualLinkId": "extvl1",
\r
930 "resourceHandle": {
\r
932 "resourceId": "1111"
\r
939 "resourceId": "2121"
\r
941 "cpInstanceId": "1"
\r
947 "monitoringParameters": {...},
\r
948 "localizationLanguage": "en\_US",
\r
955 "apiVersion": "v2",
\r
956 "protocolType": "http"
\r
959 "tenant": "tenant\_vCPE",
\r
960 "username": "vCPE",
\r
961 "password": "vCPE\_321"
\r
963 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
967 "vnfcResourceInfo": [
\r
969 "vnfcInstanceId": "vm1",
\r
971 "computeResource": {
\r
973 "resourceId": "3333"
\r
976 "storageResourceIds": [ "storage1"
\r
981 "virtualLinkResourceInfo": [
\r
983 "virtualLinkInstanceId": "vl01",
\r
984 "virtualLinkDescId": "vl01",
\r
985 "networkResource": {
\r
987 "resourceId": "4444"
\r
992 "virtualStorageResourceInfo": [
\r
994 "virtualStorageInstanceId": "storage1",
\r
995 "virtualStorageDescId": "storage1",
\r
996 "storageResource": {
\r
998 "resourceId": "555"
\r
1003 "metadata": {...},
\r
1004 "extensions": {...}
\r
1007 **3.7 Get Operation Status**
\r
1008 ------------------------------
\r
1009 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1010 | If Definition | Description |
\r
1011 +=====================+=================================================================================================+
\r
1012 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId} |
\r
1013 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1014 | Operation | GET |
\r
1015 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1016 | Direction | NFVO->GVNFM |
\r
1017 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1023 **3.7.2 Response**
\r
1025 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1026 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1027 +====================+=============+===============+===========+==================================================================================+
\r
1028 | vnfLcOpId | M | 1 | String | Identifier of a VNF lifecycle operation occurrence |
\r
1029 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1030 | vnfInstanceId | M | 1 | String | Identifier of the VNF instance to which the operation applies |
\r
1031 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1032 | lcmOperationType | M | 1 | ENUM | Type of the actual LCM operation represented by this lcm operation occurrence. |
\r
1034 | | | | | Permitted values: |
\r
1035 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1036 | | | | | - INSTANTIATE:the |
\r
1038 | | | | | Instantiate VNF LCM operation. |
\r
1040 | | | | | - SCALE: the Scale VNF LCM operation. |
\r
1042 | | | | | - SCALE\_TO\_LEVEL: the |
\r
1044 | | | | | Scale VNF to Level LCM operation. |
\r
1046 | | | | | - CHANGE\_FLAVOUR: |
\r
1048 | | | | | the Change VNF Flavour LCM operation. |
\r
1050 | | | | | - TERMINATE: the |
\r
1052 | | | | | Terminate VNF LCM operation. |
\r
1054 | | | | | - HEAL: the Heal VNF LCM operation. |
\r
1056 | | | | | - OPERATE: the Operate VNF LCM operation. |
\r
1058 | | | | | - CHANGE\_EXT\_VLS: the |
\r
1060 | | | | | Change VNF external VLs LCM operation. (Reserved) |
\r
1061 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1062 | startTime | M | 1 | String | Date-time of the start of the operation. |
\r
1064 | | | | | Representation: String formatted according to RFC 3339 [13] |
\r
1065 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1066 | responseDescriptor | M | 1 | VnfLcOp | Including:responseId,progress,statusstatusDescription |
\r
1067 | | | | Response | |
\r
1068 | | | | Descriptor| ,errorCode,responseHistoryList |
\r
1069 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1071 **VnfLcOpResponseDescriptor:**
\r
1073 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1074 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1075 +===========================+=================+====================+===============+===========================================================+
\r
1076 | responseId | M | 1 | Integer | Response Identifier |
\r
1077 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1078 | progress | M | 1 | Integer | progress (1-100) |
\r
1079 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1080 | lcmOperationS tatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
\r
1082 | | | | | Permitted values: |
\r
1084 | | | | | - STARTING: The operation is starting.. |
\r
1086 | | | | | - PROCESSING: The operation is |
\r
1087 | | | | | currently in execution. |
\r
1089 | | | | | - COMPLETED: The operation has completed successfully. |
\r
1091 | | | | | - FAILED: The operation has failed and it cannot be |
\r
1092 | | | | | retried or rolled back, as it is determined |
\r
1093 | | | | | that such action won't succeed. |
\r
1094 | | | | | - FAILED\_TEMP: The operation has failed and execution |
\r
1095 | | | | | has stopped, but the execution of the |
\r
1096 | | | | | operation is not considered to be closed. |
\r
1097 | | | | | (Reserved) |
\r
1098 | | | | | - ROLLING\_BACK: The operation is currently being rolled |
\r
1099 | | | | | back. (Reserved) |
\r
1101 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
\r
1102 | | | | | original operation invocation has been |
\r
1103 | | | | | restored as closely as possible. (Reserved) |
\r
1104 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1105 | statusDescripti on | O | 0..1 | String | Status Description of a VNF lifecycle operation |
\r
1106 | | | | | occurrence |
\r
1107 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1108 | errorCode | O | 0..1 | Integer | Errorcode |
\r
1109 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1110 | responseHistor yList | O | 0..N | VnfLcOpDetail | History Response Messages from the requested |
\r
1111 | | | | | responseId to lastest one. |
\r
1112 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1114 **VnfLcOpDetail:**
\r
1116 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1117 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1118 +===========================+=================+====================+===============+===========================================================+
\r
1119 | responseId | M | 1 | Integer | Response Identifier |
\r
1120 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1121 | progress | M | 1 | Integer | progress (1-100) |
\r
1122 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1123 | lcmOperationS tatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
\r
1125 | | | | | Permitted values: |
\r
1127 | | | | | - STARTING: The operation is starting.. |
\r
1129 | | | | | - PROCESSING: The operation is currently in execution. |
\r
1131 | | | | | - COMPLETED: The operation has completed successfully. |
\r
1133 | | | | | - FAILED: The operation has failed and it |
\r
1134 | | | | | cannot be retried or rolled back, as it is |
\r
1135 | | | | | determined that such action won't succeed. |
\r
1138 | | | | | - FAILED\_TEMP: The operation has failed and execution |
\r
1139 | | | | | has stopped, but the execution of the operation |
\r
1140 | | | | | is not considered to be closed. (Reserved) |
\r
1142 | | | | | - ROLLING\_BACK: The operation is currently being |
\r
1143 | | | | | rolled back. (Reserved) |
\r
1146 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
\r
1147 | | | | | original operation invocation has been restored |
\r
1148 | | | | | as closely as possible. (Reserved) |
\r
1150 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1151 | statusDescription | O | 0..1 | String | Status Description of a VNF lifecycle operation occurrence|
\r
1152 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1153 | errorCode | O | 0..1 | Integer | Errorcode |
\r
1154 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1158 "vnfLcOpId": "1234566",
\r
1160 "vnfInstanceId": "1",
\r
1161 "lcmOperationType": "INSTANTIATE",
\r
1163 "startTime": "2017-01-01T12:00:27.87+00:20",
\r
1165 "responseDescriptor": {
\r
1168 "lcmOperationStatus": "PROCESSING",
\r
1169 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1170 "errorCode": null,
\r
1171 "responseHistoryList": [
\r
1175 "lcmOperationStatus": "PROCESSING",
\r
1176 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1182 "lcmOperationStatus": "PROCESSING",
\r
1183 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1190 **3.7.3 Response Code**
\r
1192 +-----------+-----------------------+----------------------------------+
\r
1193 | Code | Meaning | Description |
\r
1194 +===========+=======================+==================================+
\r
1195 | 200 | Ok | The request has succeeded. |
\r
1196 +-----------+-----------------------+----------------------------------+
\r
1197 | 4xx/5xx | <name from RFC7231> | <description> |
\r
1198 +-----------+-----------------------+----------------------------------+
\r
1200 **4.Interfaces provided by VNF**\ (Ve-Vnfm-vnf)
\r
1201 ===============================================
\r
1203 **4.1 Set Initial Configuration**
\r
1204 -----------------------------
\r
1206 +---------------------+---------------------------------------------+
\r
1207 | If Definition | Description |
\r
1208 +=====================+=============================================+
\r
1209 | URI | http(s)://[hostname][:port]/configuration |
\r
1210 +---------------------+---------------------------------------------+
\r
1211 | Operation | POST |
\r
1212 +---------------------+---------------------------------------------+
\r
1213 | Direction | VNFM->VNF |
\r
1214 +---------------------+---------------------------------------------+
\r
1218 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1219 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1220 +=========================+=============+===============+==========================+==============================================================================+
\r
1221 | vnfInstanceId | M | 1 | Identifier | Identifier of the VNF instance which the VNF to set initial configuration. |
\r
1222 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1223 | vnfConfigurationData | O | 0..1 | VnfConfigur ation | Configuration data for the VNF instance. |
\r
1224 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1225 | vnfcConfigurationData | O | 0..N | VnfcConfigu ration | Configuration data for VNFC instances. |
\r
1226 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1228 **VnfConfiguration:**
\r
1230 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1231 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1232 +=======================+=================+====================+==================================+==============================================================================+
\r
1233 | cp | O | 0..N | CpConfiguratio n | External CPs |
\r
1234 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1235 | vnfSpecificData | O | 0..1 | VnfConfigurabl eProperties | Configuration object containing values of VNF configurable properties. |
\r
1236 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1238 **CpConfiguration:**
\r
1240 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1241 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1242 +=================+=============+====================+==============+=======================================================================================================+
\r
1243 | cpId | M | 1 | Identifier | Uniquely identifies a CP instance within the namespace of a specific VNF instance or VNFC instance. |
\r
1244 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1245 | cpdId | M | 1 | Identifier | Uniquely identifies a type of CP instance within the namespace of a VNFD. |
\r
1246 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1247 | cpAddress | M | 1..N | CpAddress | Address and Port assigned to the CP. |
\r
1248 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1252 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1253 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1254 +==========================+=============+====================+===================+===============================================================================================================================================+
\r
1255 | 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
1256 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1257 | 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
1259 | | | | | A cardinality of "0" indicates that no dynamic address needs to be configured on the CP. |
\r
1261 | | | | | Permitted values: |
\r
1263 | | | | | - TRUE |
\r
1265 | | | | | - FALSE |
\r
1266 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1267 | port | M | 0..1 | Not specified | The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.). |
\r
1269 | | | | | Reserved |
\r
1270 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1272 **VnfConfigurableProperties:**
\r
1274 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1275 | Attribute | Qualifier | Cardinality | Content| Description |
\r
1276 +====================+===========+==============+========+===============================================================================================+
\r
1277 | autoScalable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-scaling functionality. |
\r
1279 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
\r
1281 | | | | | Permitted values: |
\r
1283 | | | | | - TRUE |
\r
1285 | | | | | - FALSE |
\r
1286 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1287 | autoHealable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-healing functionality. |
\r
1289 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
\r
1291 | | | | | Permitted values: |
\r
1293 | | | | | - TRUE |
\r
1295 | | | | | - FALSE |
\r
1296 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1298 **VnfcConfiguration:**
\r
1300 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1301 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1302 +========================+=============+====================+====================+========================================================================================+
\r
1303 | vnfcId | M | 1 | Identifier | Uniquely identifies a VNFC instance within the namespace of a specific VNF instance. |
\r
1304 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1305 | cp | O | 0..N | CpConfiguratio n | Internal CPs. |
\r
1306 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1307 | vnfcSpecificData | O | 0..1 | KeyValuePair | Configuration object containing values of VNFC configurable properties |
\r
1308 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1312 "vnfInstanceId": "1",
\r
1313 "vnfConfigurationData": {
\r
1317 "cpdId": "cpd-a",
\r
1322 "addressType": "MAC",
\r
1323 "l2AddressData": "00:f3:43:20:a2:a3"
\r
1326 "addressType": "IP",
\r
1327 "l3AddressData": {
\r
1328 "iPAddressType": "IPv4",
\r
1329 "iPAddress": "192.168.104.2"
\r
1333 "useDynamicAddress": "FALSE"
\r
1338 "vnfSpecificData": {
\r
1339 "autoScalable": "FALSE",
\r
1340 "autoHealable": "FALSE"
\r
1343 "vnfcConfigurationData":
\r
1345 "vnfcId": "vnfc-1",
\r
1349 "cpdId": "cpd-1a",
\r
1354 "addressType": "MAC",
\r
1355 "l2AddressData": "00:f3:43:21:a2:a3"
\r
1358 "addressType": "IP",
\r
1359 "l3AddressData": {
\r
1360 "iPAddressType": "IPv4",
\r
1361 "iPAddress": "192.168.105.2"
\r
1365 "useDynamicAddress": "FALSE"
\r
1370 "vnfcSpecificData": {}
\r
1375 **4.1.2 Response**
\r
1376 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1377 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1378 +=======================+=============+===============+===================+=================================+
\r
1379 | vnfConfigurationData | O | 0..1 | VnfConfiguration | Correspond to the |
\r
1380 | | | | | vnfConfigurationData in the |
\r
1381 | | | | | input information elements of |
\r
1382 | | | | | the SetInitialConfiguration |
\r
1383 | | | | | operation if it has. |
\r
1384 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1385 | vnfcConfigurationDa | O | 0..N | VnfConfiguration | Correspond to the |
\r
1386 | ta | | | | vnfcConfigurationData in the |
\r
1387 | | | | | input information elements of |
\r
1388 | | | | | the SetInitialConfiguration |
\r
1389 | | | | | operation if it has. |
\r
1390 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1393 "vnfConfigurationData": {
\r
1397 "cpdId": "cpd-a", "cpAddress": [
\r
1401 "addressType": "MAC",
\r
1402 "l2AddressData": "00:f3:43:20:a2:a3"
\r
1405 "addressType": "IP",
\r
1406 "l3AddressData": {
\r
1407 "iPAddressType": "IPv4",
\r
1408 "iPAddress": "192.168.104.2"
\r
1412 "useDynamicAddress": "FALSE"
\r
1417 "vnfSpecificData": {
\r
1418 "autoScalable": "FALSE",
\r
1419 "autoHealable": "FALSE",
\r
1423 "vnfcConfigurationData": {
\r
1424 "vnfcId": "vnfc-1",
\r
1428 "cpdId": "cpd-1a",
\r
1433 "addressType": "MAC",
\r
1434 "l2AddressData": "00:f3:43:21:a2:a3"
\r
1437 "addressType": "IP",
\r
1438 "l3AddressData": {
\r
1439 "iPAddressType": "IPv4",
\r
1440 "iPAddress": "192.168.105.2"
\r
1444 "useDynamicAddress": "FALSE"
\r
1449 "vnfcSpecificData": {…}
\r
1453 **4.1.3Response Code**
\r
1455 +-----------+-----------------------+-----------------------------------------------------------+
\r
1456 | Code | Meaning | Description |
\r
1457 +===========+=======================+===========================================================+
\r
1458 | 201 | Created | A VNF Instance identifier was created successfully. |
\r
1459 +-----------+-----------------------+-----------------------------------------------------------+
\r
1460 | 4xx/5xx | <name from RFC7231> | <description> |
\r
1461 +-----------+-----------------------+-----------------------------------------------------------+
\r
1463 .. |image0| image:: VNFM_API.png
\r
Code Review / vfc / nfvo / lcm.git / blob