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
30 Table 2-1 abbreviations
\r
32 **3. Interfaces provided by VNFM** (Or-Vnfm/Ve-Vnfm-vnf)
\r
33 ==========================================================
\r
35 Interfaces use RESTful API and the format is as follows:
\r
36 http(s)://[hostname][:port]/gvnfmapi/lcm/v1/[……]
\r
41 **{apiRoot} is** http(s)://[hostname][:port]/gvnfmapi
\r
43 **3.1 Create VNF Identifier**
\r
44 -----------------------------
\r
46 +---------------------+--------------------------------------------------------------+
\r
47 | If Definition | Description |
\r
48 +=====================+==============================================================+
\r
49 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances |
\r
50 +---------------------+--------------------------------------------------------------+
\r
51 | Operation | POST |
\r
52 +---------------------+--------------------------------------------------------------+
\r
53 | Direction | NFVO->VNFMLCM |
\r
54 +---------------------+--------------------------------------------------------------+
\r
58 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
59 | Parameter | Qualifier | Cardinality | Content | Description |
\r
60 +===========================+=============+===============+==================+=====================================================================================+
\r
61 | vnfdId | M | 1 | Identifier | Identifier that identifies the VNFD which defines the VNF instance to be created. |
\r
62 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
63 | vnfInstanceName | M | 1 | String | Human-readable name of the VNF instance to be created. |
\r
64 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
65 | vnfInstanceDescription | O | 0..1 | String | Human-readable description of the VNF instance to be created. |
\r
66 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
\r
69 "vnfdId": "zte\_vFW\_51610",
\r
70 "vnfInstanceName": "vFW\_01",
\r
71 "vnfInstanceDescription": " vFW in Nanjing TIC Edge"
\r
77 +-----------------+-------------+---------------+------------------+-----------------------------------------+
\r
78 | Parameter | Qualifier | Cardinality | Content | Description |
\r
79 +=================+=============+===============+==================+=========================================+
\r
80 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier just created. |
\r
81 +-----------------+-------------+---------------+------------------+-----------------------------------------+
\r
84 "vnfInstanceId": "1"
\r
88 **3.1.3 Response Code**
\r
90 +-----------+-----------------------+-----------------------------------------------------------+
\r
91 | Code | Meaning | Description |
\r
92 +===========+=======================+===========================================================+
\r
93 | 201 | Created | A VNF Instance identifier was created successfully. |
\r
94 +-----------+-----------------------+-----------------------------------------------------------+
\r
95 | 4xx/5xx | <name from RFC7231> | <description> |
\r
96 +-----------+-----------------------+-----------------------------------------------------------+
\r
98 **3.2 Delete VNF Identifier**
\r
99 -----------------------------
\r
101 +---------------------+------------------------------------------------------------------------------+
\r
102 | If Definition | Description |
\r
103 +=====================+==============================================================================+
\r
104 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances/{vnfInstanceId} |
\r
105 +---------------------+------------------------------------------------------------------------------+
\r
106 | Operation | DELETE |
\r
107 +---------------------+------------------------------------------------------------------------------+
\r
108 | Direction | NFVO->VNFMLCM |
\r
109 +---------------------+------------------------------------------------------------------------------+
\r
113 +-------------+-------------+---------------+---------------+---------------+
\r
114 | Parameter | Qualifier | Cardinality | Content | Description |
\r
115 +=============+=============+===============+===============+===============+
\r
117 +-------------+-------------+---------------+---------------+---------------+
\r
121 +-------------+-------------+---------------+---------------+---------------+
\r
122 | Parameter | Qualifier | Cardinality | Content | Description |
\r
123 +=============+=============+===============+===============+===============+
\r
125 +-------------+-------------+---------------+---------------+---------------+
\r
127 **3.2.3 Response Code**
\r
129 +--------+-----------+-------------------+
\r
130 | Code | Meaning | Description |
\r
131 +--------+-----------+-------------------+
\r
133 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
\r
134 | 204 | No Content | The VNF instance resource and the associated VNF identifier were deleted successfully. |
\r
135 +===========+=======================+==============================================================================================+
\r
136 | 4xx/5xx | <name from RFC7231> | <description> |
\r
137 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
\r
139 **3.3 Instantiate VNF**
\r
140 -----------------------
\r
142 +---------------------+-------------------------------------------------------------------------------------------+
\r
143 | If Definition | Description |
\r
144 +=====================+===========================================================================================+
\r
145 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId}/instantiate |
\r
146 +---------------------+-------------------------------------------------------------------------------------------+
\r
147 | Operation | POST |
\r
148 +---------------------+-------------------------------------------------------------------------------------------+
\r
149 | Direction | NFVO->VNFMLCM |
\r
150 +---------------------+-------------------------------------------------------------------------------------------+
\r
154 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
155 | Parameter | Qualifier | Cardinality | Content | Description |
\r
156 +====================+===========+=============+=====================+===============================================================+
\r
157 | flavourId | M | 1 | IdentifierInV nfd | Identifier of the VNF deployment flavour to be instantiated. |
\r
158 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
159 | instantiation | O | 0..1 | IdentifierInVnfd | Identifier of the instantiation |
\r
160 | LevelId | | | | level of the deployment |
\r
161 | | | | | flavour to be instantiated. If |
\r
162 | | | | | not present, the default |
\r
163 | | | | | instantiation level as |
\r
164 | | | | | declared in the VNFD is |
\r
165 | | | | | instantiated. |
\r
167 | | | | | Reserved |
\r
168 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
169 | extVirtualLinks | O | 0..N | ExtVirtualLin kData | Information about external VLs to connect the VNF to. |
\r
170 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
171 | extManagedVirtualL | O | 0..N | ExtManaged | Information about internal |
\r
172 | inks | | | VirtualLinkData | VLs that are managed by |
\r
173 | | | | | other entities than the VNFM. |
\r
175 | | | | | Reserved |
\r
176 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
177 | localization | O | 0..1 | String | Localization language of the VNF to be instantiated can be |
\r
178 | Language | | | | declared in the VNFD. The value shall comply with the format |
\r
179 | | | | | defined in IETF RFC 5646 [6]. |
\r
181 | | | | | Reserved |
\r
182 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
183 | additionalParams | O | 0..N | KeyValuePair | Additional input parameters for the instantiation process, |
\r
184 | | | | | specific to the VNF being instantiated. |
\r
185 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
\r
187 **ExtVirtualLinkData:**
\r
189 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
190 | Attribute | Qualifier | Cardinality | Content | Description |
\r
191 +==================+===========+=============+=================+==================================================================================+
\r
192 | vlInstanceId | O | 0..1 | Identifier | Identifier of the VL instance. |
\r
193 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
194 | vim | CM | 0..1 | VimInfo | Information about the VIM that manages this resource. |
\r
195 | | | | | This attribute shall be supported and present if VNF-related resource management |
\r
196 | | | | | in direct mode is applicable. |
\r
197 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
198 | resourceProvider | CM | 0..1 | Identifier | Identifies the entity responsible for the management of this resource. |
\r
199 | Id | | | | This attribute shall be present if |
\r
200 | | | | | VNF-related resource management in indirect mode is applicable. |
\r
202 | | | | | Reserved |
\r
203 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
204 | resourceId | M | 1 | IdentifierInVim | The identifier of the resource in the scope of the VIM or the resource provider. |
\r
205 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
206 | extCps | M | 1..N | VnfExtCpData | External CPs of the VNF to be connected to this external VL. |
\r
207 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
\r
211 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
212 | Attribute | Qualifier | Cardinality | Content | Description |
\r
213 +=================+===========+=============+==============+==========================================================================================================================================+
\r
214 | vimInfoId | M | 1 | Identifier | The identifier of this VimInfo instance, for the purpose of referencing it from other information elements. |
\r
215 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
216 | vimId | M | 1 | Identifier | The identifier of the VIM. |
\r
217 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
218 | interfaceInfo | M | 0..N | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version, and protocol type. |
\r
219 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
220 | accessInfo | M | 0..N | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth, |
\r
221 | | | | | Token, etc. |
\r
222 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
223 | interface | M | 1 | String | Information about the interface endpoint. An example is a URL. |
\r
224 | Endpoint | | | | Token, etc. |
\r
225 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
\r
229 +------------------+---------------+--------------------------------------+
\r
230 | **Key Define** | **Content** | **Description** |
\r
231 +==================+===============+======================================+
\r
232 | vimType | String | The type of the VIM. |
\r
233 +------------------+---------------+--------------------------------------+
\r
234 | apiVersion | String | The Version of the api of the VIM. |
\r
235 +------------------+---------------+--------------------------------------+
\r
236 | protocolType | String | http https |
\r
237 +------------------+---------------+--------------------------------------+
\r
241 +------------------+---------------+--------------------------+
\r
242 | **Key Define** | **Content** | **Description** |
\r
243 +==================+===============+==========================+
\r
244 | tenant | String | Tenant Name of tenant |
\r
245 +------------------+---------------+--------------------------+
\r
246 | username | String | Username for login |
\r
247 +------------------+---------------+--------------------------+
\r
248 | password | String | Password of login user |
\r
249 +------------------+---------------+--------------------------+
\r
253 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
254 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
255 +========================+=====================+=======================+====================+===========================================================+
\r
256 | cpdId | M | 1 | IdentifierInVnfd | The identifier of the CPD in the VNFD. |
\r
257 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
258 | addresses | O | 0..N | NetworkAddress | List of (fixed) network addresses that |
\r
259 | | | | | need to be configured on the CP. This attribute shall |
\r
260 | | | | | be present if fixed addresses need to be configured. |
\r
261 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
262 | numDynamicAddre sses | O | 0..1 | Integer | Number of network addresses to be assigned dynamically. |
\r
263 | | | | | This attribute shall be present if dynamic |
\r
264 | | | | | addresses need to be configured. |
\r
265 | | | | | Reserved |
\r
266 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
\r
268 **NetworkAddress:**
\r
270 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
271 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
272 +=================+=====================+=======================+===================+===============================================================================================================+
\r
273 | addressType | M | 1 | Enum | Describes the type of the address to be assigned to the CP instantiated from the parent CPD. |
\r
275 | | | | | Permitted values: |
\r
280 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
281 | 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
283 | | | | | Shall be present when the addressType is MAC address. |
\r
284 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
285 | l3AddressData | CM | 0..1 | L3AddressData | Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD. |
\r
287 | | | | | Shall be present when the addressType is IP address. |
\r
288 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
\r
292 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
293 | **Attribute** | **Qualifier** | **Cardinality** | **Content** | **Description** |
\r
294 +=================+=====================+=======================+===================+=======================+
\r
295 | iPAddressType | M | 1 | ENUM | IP address type. |
\r
297 | | | | | Permitted values: |
\r
302 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
303 | iPAddress | M | 1 | String | IP address |
\r
304 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
\r
308 "flavourId": "flavour\_1",
\r
309 "instantiationLevelId":"instantiationLevel\_1",
\r
310 "extVirtualLinks": [
\r
312 { "vlInstanceId": "1",
\r
319 "apiVersion": "v2",
\r
320 "protocolType": "http"
\r
325 "tenant": "tenant\_vCPE",
\r
326 "username": "vCPE",
\r
327 "password": "vCPE\_321"
\r
330 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
333 "resourceId": "1246",
\r
337 "cpdId": "11", "addresses": [
\r
340 "addressType": "MAC",
\r
341 "l2AddressData": "00:f3:43:20:a2:a3"
\r
346 "addressType": "IP",
\r
349 "iPAddressType": "IPv4",
\r
350 "iPAddress": "192.168.104.2"
\r
357 "numDynamicAddresses": 0
\r
369 "localizationLanguage": "en\_US", "additionalParams": {...}
\r
376 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
377 | Parameter | Qualifier | Cardinality | Content | Description |
\r
378 +=============+=============+===============+==================+=========================================================+
\r
379 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
\r
380 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
388 **3.3.3 Response Code**
\r
390 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
391 | Code | Meaning | Description |
\r
392 +===========+=======================+==========================================================================================+
\r
393 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
\r
394 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
395 | 4xx/5xx | <name from RFC7231> | <description> |
\r
396 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
398 **3.4 Terminate VNF**
\r
399 ---------------------
\r
401 +---------------------+-----------------------------------------------------------------------------------------+
\r
402 | If Definition | Description |
\r
403 +=====================+=========================================================================================+
\r
404 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances/{vnfInstanceId}/term inate |
\r
405 +---------------------+-----------------------------------------------------------------------------------------+
\r
406 | Operation | POST |
\r
407 +---------------------+-----------------------------------------------------------------------------------------+
\r
408 | Direction | NFVO->VNFMLCM |
\r
409 +---------------------+-----------------------------------------------------------------------------------------+
\r
413 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
414 | Parameter | Qualifier | Cardinality | Content | Description |
\r
415 +===================+=============+===============+===============+=========================================================================+
\r
416 | terminationType | M | 1 | Enum | Indicates whether forceful or graceful termination is requested. |
\r
418 | | | | | Permitted values: |
\r
420 | | | | | - FORCEFUL: The VNFM |
\r
421 | | | | | will shut down the VNF and release the resources immediately |
\r
422 | | | | | after accepting the request. |
\r
423 | | | | | - GRACEFUL: The VNFM |
\r
425 | | | | | will first arrange to take the VNF out of service after accepting |
\r
426 | | | | | the request. Once the operation is successful or once the timer |
\r
427 | | | | | value specified in the |
\r
429 | | | | | “gracefulTerminationTime out” attribute expires, the VNFM will shut |
\r
430 | | | | | down the VNF and release the resources. |
\r
431 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
432 | graceful | O | 0..1 | Integer | This attribute is only |
\r
433 | Termination | | | | applicable in case of graceful |
\r
434 | Timeout | | | | termination. It defines the |
\r
435 | | | | | time to wait for the VNF to be |
\r
436 | | | | | taken out of service before |
\r
437 | | | | | shutting down the VNF and |
\r
438 | | | | | releasing the resources. |
\r
439 | | | | | The unit is seconds. |
\r
440 | | | | | If not given and the |
\r
441 | | | | | "terminationType" |
\r
442 | | | | | attribute is set to |
\r
443 | | | | | "GRACEFUL", it is expected |
\r
444 | | | | | that the VNFM waits for |
\r
445 | | | | | the successful taking out of |
\r
446 | | | | | service of the VNF, no |
\r
447 | | | | | matter how long it takes, |
\r
448 | | | | | before shutting down the |
\r
449 | | | | | VNF and releasing the |
\r
450 | | | | | resources. |
\r
451 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
\r
454 "terminationType": "GRACEFUL",
\r
455 "gracefulTerminationTimeout": 120
\r
461 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
462 | Parameter | Qualifier | Cardinality | Content | Description |
\r
463 +=============+=============+===============+==================+=========================================================+
\r
464 | vnfLcOpId | M | 1 | Identifier | Identifier of the VNF lifecycle operation occurrence. |
\r
465 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
\r
472 **3.4.3 Response Code**
\r
474 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
475 | Code | Meaning | Description |
\r
476 +===========+=======================+==========================================================================================+
\r
477 | 202 | Accepted | The request is accepted for processing, but the processing has not been completed. |
\r
478 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
479 | 4xx/5xx | <name from RFC7231> | <description> |
\r
480 +-----------+-----------------------+------------------------------------------------------------------------------------------+
\r
482 **3.5 Query multiple VNF**
\r
483 ---------------------------
\r
484 +---------------------+--------------------------------------------------------------+
\r
485 | If Definition | Description |
\r
486 +=====================+==============================================================+
\r
487 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_instances |
\r
488 +---------------------+--------------------------------------------------------------+
\r
489 | Operation | GET |
\r
490 +---------------------+--------------------------------------------------------------+
\r
491 | Direction | NFVO->VNFMLCM |
\r
492 +---------------------+--------------------------------------------------------------+
\r
496 +-------------+-------------+---------------+---------------+---------------+
\r
497 | Parameter | Qualifier | Cardinality | Content | Description |
\r
498 +=============+=============+===============+===============+===============+
\r
500 +-------------+-------------+---------------+---------------+---------------+
\r
504 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
505 | Parameter | Qualifier | Cardinality | Content | Description |
\r
506 +====================+=============+===============+========================+======================================================================================+
\r
507 | vnfInstanceInfos | M | 0..N | VnfInstanceI nfo | Returned if information about zero or more VNF instances was queried successfully. |
\r
508 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
509 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
\r
511 **VnfInstanceInfo:**
\r
513 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
514 | Attribute | Qualifier|Cardinality | Content | Description |
\r
515 +==================================+==========+============+============================+=======================================================================================================================================================+
\r
516 | vnfInstanceId | M | 1 | Identifier | VNF instance identifier. |
\r
517 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
518 | vnfInstanceName | M | 1 | String | VNF instance name. |
\r
519 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
520 | vnfInstanceDescr iption | M | 1 | String | Human-readable description of the VNF instance. |
\r
521 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
522 | 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
523 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
524 | vnfdId | M | 1 | Identifier | Identifier of the VNFD on which the VNF instance is based. |
\r
525 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
526 | vnfdVersion | M | 1 | Identifier | Identifies the version of the VNFD. The value is copied from the VNFD. |
\r
527 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
528 | vnfSoftwareVersi on | M | 1 | String | Software version of the VNF. |
\r
530 | | | | | The value is copied from the VNFD. |
\r
531 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
532 | vnfProvider | M | 1 | String | Name of the person or company providing the VNF. |
\r
534 | | | | | The value is copied from the VNFD. |
\r
535 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
536 | vnfProductName | M | 1 | String | Name to identify the VNF Product. The value is copied from the VNFD. |
\r
537 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
538 | vnfConfigurableP roperties | O | 0..N | KeyValuePair | Current values of the configurable properties of the VNF instance. |
\r
540 | | | | | Configurable properties as declared in the VNFD. |
\r
541 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
542 | instantiationState | M | 1 | Enum | The instantiation state of the VNF. |
\r
544 | | | | | Permitted values: |
\r
546 | | | | | - NOT\_INSTANTIATED: The VNF |
\r
548 | | | | | instance is terminated or not instantiated. |
\r
550 | | | | | - INSTANTIATED: The VNF instance is instantiated. |
\r
551 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
552 | instantiatedVnfInf o | CM | 0..1 | InstantiatedVnf Info | Information specific to an instantiated VNF instance. |
\r
554 | | | | | This attribute shall be present if the instantiateState attribute value is INSTANTIATED. |
\r
555 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
556 | metadata | O | 0..N | KeyValuePair | Additional metadata describing the VNF instance. |
\r
558 | | | | | This attribute can be modified with the Modify VNF information operation. |
\r
559 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
560 | extensions | O | 0..N | KeyValuePair | VNF-specific attributes. |
\r
562 | | | | | This attribute can be modified with the Modify VNF information operation. |
\r
563 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
\r
565 **InstantiatedVnfInfo:**
\r
567 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
568 | Attribute | Qualifier | Cardinality| Content | Description |
\r
569 +==============================+===========+============+==============================+========================================================================================================================+
\r
570 | flavourId | M | 1 | IdentifierInVnfd | Identifier of the VNF deployment flavour to be instantiated. |
\r
572 | | | | | Reserved |
\r
573 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
574 | vnfState | M | 1 | ENUM | State of the VNF instance. |
\r
576 | | | | | Permitted values: |
\r
578 | | | | | - STARTED: The VNF instance is up and running. |
\r
580 | | | | | - STOPPED: The VNF instance has been shut down. |
\r
581 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
582 | 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
584 | | | | | w.r.t. that aspect. |
\r
586 | | | | | This attribute shall be present if the VNF supports scaling. |
\r
587 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
588 | extCpInfo | O | 0..N | CpInfo | Information about the external CPs exposed by the VNF instance. |
\r
589 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
590 | extVirtualLink | O | 0..N | ExtVirtualLinkI nfo | Information about the external VLs the VNF instance is connected to. |
\r
591 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
592 | extManagedVirtu alLink | O | 0..N | extManagedVir tualLinkInfo | Information about the externally-managed internal VLs of the VNF instance. |
\r
594 | | | | | Reserved |
\r
595 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
596 | monitoringParam eters | O | 0..N | MonitoringPar ameter | Active monitoring parameters. |
\r
598 | | | | | Reserved |
\r
599 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
600 | localizationLangu age | O | 0..1 | String | Localization language of the VNF to be instantiated. |
\r
602 | | | | | The value shall comply with the format defined in IETF RFC 5646 [6]. |
\r
603 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
604 | vimInfo | CM | 0..N | VimInfo | Information about VIM(s) managing resources for the VNF instance. |
\r
606 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
607 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
608 | vnfcResourceInfo | CM | 0..N | VnfcResourceI nfo | Information about the virtualised compute and storage resource(s) used by the VNFCs of the VNF instance. |
\r
610 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
611 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
612 | virtualLinkResourceInfo | CM | 0..N | VirtualLinkRes ourceInfo | Information about the virtualised network resource(s) used by the VLs of the VNF instance. |
\r
614 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
615 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
616 | virtualStorageResourceInfo | CM | 0..N | VirtualStorage ResourceInfo | Information about the virtualised storage resource(s) used as storage for the VNF instance. |
\r
618 | | | | | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable. |
\r
619 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
\r
623 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
624 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
625 +==================+=============+====================+====================+=====================================================================================================================================+
\r
626 | aspectId | M | 1 | IdentifierInVnfd | Identifier of the scaling aspect. |
\r
627 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
628 | 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
629 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
630 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
\r
634 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
635 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
636 +====================+=============+====================+====================+==================================================================+
\r
637 | cpInstanceId | M | 1 | Identifier | Identifier of the CP instance. |
\r
638 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
639 | cpdId | M | 1 | IdentifierInVnfd | Identifier of the CPD, in the VNFD. |
\r
640 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
641 | addresses | O | 0..N | NetworkAddre ss | List of network addresses that have been configured on the CP. |
\r
642 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
\r
644 **ExtVirtualLinkInfo:**
\r
646 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
647 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
648 +========================+=============+====================+===================+=================================================+
\r
649 | extVirtualLinkId | M | 1 | Identifier | Identifier of the external VL. |
\r
650 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
651 | resourceHandle | M | 1 | ResourceHand le | Identifier of the resource realizing this VL. |
\r
652 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
653 | linkPorts | O | 0..N | VnfLinkPort | Link ports of this VL. |
\r
654 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
\r
656 **ResourceHandle:**
\r
658 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
659 | Attribute | Qualifier | Cardinality| Content | Description |
\r
660 +=====================+============+============+===================+========================================================================================================+
\r
661 | vimId | CM | 0..1 | Identifier | Identifier of the VimInfo information element defining the VIM who manages the resource. |
\r
663 | | | | | This attribute shall be present if |
\r
665 | | | | | VNF-related resource management in direct mode is applicable. |
\r
667 | | | | | The value refers to a vimInfo item in the VnfInstance. |
\r
668 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
669 | resourceProviderId | CM | 0..1 | Identifier | Identifier of the entity responsible for the management of the resource. |
\r
671 | | | | | This attribute shall be present when VNF-related resource management in indirect mode is applicable. |
\r
673 | | | | | Reserved |
\r
674 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
675 | resourceId | M | 1 | IdentifierInVim | Identifier of the resource in the scope of the VIM or the resource provider. |
\r
676 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
\r
680 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
681 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
682 +======================+=============+====================+===================+================================================================================================+
\r
683 | resourceHandle | M | 1 | ResourceHand le | Identifier of the virtualised network resource realizing this link port. |
\r
684 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
685 | cpInstanceId | M | 1 | IdentifierInVnf | External CP of the VNF to be connected to this link port. |
\r
687 | | | | | There shall be at most one link port associated with any external connection point instance. |
\r
689 | | | | | The value refers to an extCpInfo item in the VnfInstance. |
\r
690 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
691 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
\r
693 **VnfcResourceInfo:**
\r
695 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
696 | Attribute | Qualifier | Cardinality| Content | Description |
\r
697 +=======================+============+============+====================+=====================================================================================================================+
\r
698 | vnfcInstanceId | M | 1 | IdentifierInVnf | Identifier of this VNFC instance. |
\r
699 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
700 | vduId | M | 1 | IdentifierInVnfd | Reference to the applicable Vdu information element in the VNFD. |
\r
701 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
702 | computeResourc e | M | 1 | ResourceHand le | Reference to the VirtualCompute resource. |
\r
703 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
704 | storageResourceI ds | M | 1..N | IdentifierInVnf | Reference(s) to the VirtualStorage resource(s). |
\r
706 | | | | | The value refers to a VirtualStorageResourceInfo item in the VnfInstance. |
\r
707 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
708 | reservationId | O | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
\r
710 | | | | | Reserved |
\r
711 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
713 **VirtualStorageResourceInfo:**
\r
715 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
716 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
717 +=================================+=============+====================+====================+=====================================================================================================================+
\r
718 | virtualStorageInst anceId | M | 1 | IdentifierInVnf | Identifier of this virtual storage resource instance. |
\r
719 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
720 | virtualStorageDe scId | M | 1 | IdentifierInVnfd | Identifier of the VirtualStorageDesc in the VNFD. |
\r
721 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
722 | storageResource | M | 1 | ResourceHand le | Reference to the VirtualStorage resource. |
\r
723 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
724 | reservationId | M | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
\r
726 | | | | | Reserved |
\r
727 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
729 **VirtualLinkResourceInfo:**
\r
731 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
732 | Attribute | Qualifier | Cardinality | Content | Description |
\r
733 +==============================+===========+==============+====================+=====================================================================================================================+
\r
734 | virtualLinkInstanceId | M | 1 | IdentifierInVnf | Identifier of this VL instance. |
\r
735 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
736 | virtualLinkDescId | M | 1 | IdentifierInVnfd | Identifier of the Virtual Link Descriptor (VLD) in the VNFD. |
\r
737 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
738 | networkResource | M | 1 | ResourceHand le | Reference to the VirtualNetwork resource. |
\r
739 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
740 | reservationId | M | 0..1 | Identifier | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists. |
\r
742 | | | | | Reserved |
\r
743 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
\r
749 "vnfInstanceId": "1",
\r
750 "vnfInstanceName": "vFW\_01",
\r
751 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
\r
752 "onboardedVnfPkgInfoId": "1",
\r
753 "vnfdId": "zte\_vFW\_51610",
\r
754 "vnfdVersion": "V1.0",
\r
755 "vnfSoftwareVersion": "V1.0",
\r
756 "vnfProvider": "ZTE",
\r
757 "vnfProductName": "vFW",
\r
758 "vnfConfigurableProperties": {...},
\r
759 "instantiationState": "INSTANTIATED",
\r
760 "instantiatedVnfInfo": {
\r
763 "vnfState": "STARTED",
\r
767 "aspectId": "aspect1",
\r
777 "cpInstanceId": "1",
\r
778 "cpdId": "1", "addresses": [
\r
781 "addressType": "MAC",
\r
782 "l2AddressData": "00:f3:43:20:a2:a3"
\r
787 "addressType": "IP",
\r
790 "iPAddressType": "IPv4",
\r
791 "address": "192.168.104.2"
\r
802 "extVirtualLink": [
\r
805 "extVirtualLinkId": "extvl1",
\r
806 "resourceHandle": {
\r
809 "resourceId": "1111"
\r
820 "resourceId": "2121"
\r
824 "cpInstanceId": "1"
\r
834 "monitoringParameters": {...},
\r
835 "localizationLanguage": "en\_US",
\r
844 "apiVersion": "v2",
\r
845 "protocolType": "http"
\r
851 "tenant": "tenant\_vCPE",
\r
852 "username": "vCPE",
\r
853 "password": "vCPE\_321"
\r
857 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
862 "vnfcResourceInfo": [
\r
865 "vnfcInstanceId": "vm1",
\r
867 "computeResource": {
\r
870 "resourceId": "3333"
\r
874 "storageResourceIds": [ "storage1"
\r
881 "virtualLinkResourceInfo": [
\r
884 "virtualLinkInstanceId": "vl01",
\r
885 "virtualLinkDescId": "vl01",
\r
886 "networkResource": {
\r
889 "resourceId": "4444"
\r
896 "virtualStorageResourceInfo": [
\r
899 "virtualStorageInstanceId": "storage1",
\r
900 "virtualStorageDescId":"storage1",
\r
901 "storageResource": {
\r
904 "resourceId": "555"
\r
914 "extensions": {...}
\r
920 **3.5.3 Response Code**
\r
922 +-----------+-----------------------+----------------------------------+
\r
923 | Code | Meaning | Description |
\r
924 +===========+=======================+==================================+
\r
925 | 200 | Ok | The request has succeeded. |
\r
926 +-----------+-----------------------+----------------------------------+
\r
927 | 4xx/5xx | <name from RFC7231> | <description> |
\r
928 +-----------+-----------------------+----------------------------------+
\r
930 **3.6 Query single VNF**
\r
931 ------------------------
\r
932 +---------------------+------------------------------------------------------------------------------+
\r
933 | If Definition | Description |
\r
934 +=====================+==============================================================================+
\r
935 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId} |
\r
936 +---------------------+------------------------------------------------------------------------------+
\r
937 | Operation | GET |
\r
938 +---------------------+------------------------------------------------------------------------------+
\r
939 | Direction | NFVO->VNFMLCM |
\r
940 +---------------------+------------------------------------------------------------------------------+
\r
944 +-------------+-------------+---------------+---------------+---------------+
\r
945 | Parameter | Qualifier | Cardinality | Content | Description |
\r
946 +=============+=============+===============+===============+===============+
\r
948 +-------------+-------------+---------------+---------------+---------------+
\r
952 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
953 | Parameter | Qualifier | Cardinality | Content | Description |
\r
954 +===================+=============+===============+========================+=======================================+
\r
955 | vnfInstanceInfo | M | 1 | VnfInstanceI nfo | The information of the VNF instance |
\r
956 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
957 +-------------------+-------------+---------------+------------------------+---------------------------------------+
\r
959 **3.6.3 Response Code**
\r
961 +-----------+-----------------------+----------------------------------+
\r
962 | Code | Meaning | Description |
\r
963 +===========+=======================+==================================+
\r
964 | 200 | Ok | The request has succeeded. |
\r
965 +-----------+-----------------------+----------------------------------+
\r
966 | 4xx/5xx | <name from RFC7231> | <description> |
\r
967 +-----------+-----------------------+----------------------------------+
\r
971 "vnfInstanceId": "1",
\r
972 "vnfInstanceName": "vFW\_01",
\r
973 "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
\r
974 "onboardedVnfPkgInfoId": "1",
\r
975 "vnfdId": "zte\_vFW\_51610",
\r
976 "vnfdVersion": "V1.0",
\r
977 "vnfSoftwareVersion": "V1.0",
\r
978 "vnfProvider": "ZTE",
\r
979 "vnfProductName": "vFW",
\r
980 "vnfConfigurableProperties": {...},
\r
981 "instantiationState": "INSTANTIATED",
\r
982 "instantiatedVnfInfo": {
\r
984 "vnfState": "STARTED",
\r
988 "aspectId": "aspect1",
\r
998 "cpInstanceId": "1",
\r
999 "cpdId": "1", "addresses": [
\r
1002 "addressType": "MAC",
\r
1003 "l2AddressData": "00:f3:43:20:a2:a3"
\r
1008 "addressType": "IP",
\r
1009 "l3AddressData": {
\r
1011 "iPAddressType": "IPv4",
\r
1012 "address": "192.168.104.2"
\r
1024 "extVirtualLink": [
\r
1027 "extVirtualLinkId": "extvl1",
\r
1028 "resourceHandle": {
\r
1031 "resourceId": "1111"
\r
1042 "resourceId": "2121"
\r
1045 "cpInstanceId": "1"
\r
1055 "monitoringParameters": {...},
\r
1056 "localizationLanguage": "en\_US",
\r
1062 "interfaceInfo": {
\r
1065 "apiVersion": "v2",
\r
1066 "protocolType": "http"
\r
1072 "tenant": "tenant\_vCPE",
\r
1073 "username": "vCPE",
\r
1074 "password": "vCPE\_321"
\r
1077 "interfaceEndpoint": "http://10.43.21.105:80/"
\r
1083 "vnfcResourceInfo": [
\r
1086 "vnfcInstanceId": "vm1",
\r
1088 "computeResource": {
\r
1091 "resourceId": "3333"
\r
1095 "storageResourceIds": [ "storage1"
\r
1102 "virtualLinkResourceInfo": [
\r
1105 "virtualLinkInstanceId": "vl01",
\r
1106 "virtualLinkDescId": "vl01",
\r
1107 "networkResource": {
\r
1110 "resourceId": "4444"
\r
1118 "virtualStorageResourceInfo": [
\r
1121 "virtualStorageInstanceId": "storage1",
\r
1122 "virtualStorageDescId": "storage1",
\r
1123 "storageResource": {
\r
1126 "resourceId": "555"
\r
1135 "metadata": {...},
\r
1136 "extensions": {...}
\r
1140 **3.7 Get Operation Status**
\r
1141 ------------------------------
\r
1142 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1143 | If Definition | Description |
\r
1144 +=====================+=================================================================================================+
\r
1145 | URI | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId} |
\r
1146 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1147 | Operation | GET |
\r
1148 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1149 | Direction | NFVO->GVNFM |
\r
1150 +---------------------+-------------------------------------------------------------------------------------------------+
\r
1156 **3.7.2 Response**
\r
1158 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1159 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1160 +====================+=============+===============+===========+==================================================================================+
\r
1161 | vnfLcOpId | M | 1 | String | Identifier of a VNF lifecycle operation occurrence |
\r
1162 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1163 | vnfInstanceId | M | 1 | String | Identifier of the VNF instance to which the operation applies |
\r
1164 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1165 | lcmOperationType | M | 1 | ENUM | Type of the actual LCM operation represented by this lcm operation occurrence. |
\r
1167 | | | | | Permitted values: |
\r
1169 | | | | | - INSTANTIATE:the |
\r
1171 | | | | | Instantiate VNF LCM operation. |
\r
1173 | | | | | - SCALE: the Scale VNF LCM operation. |
\r
1175 | | | | | - SCALE\_TO\_LEVEL: the |
\r
1177 | | | | | Scale VNF to Level LCM operation. |
\r
1179 | | | | | - CHANGE\_FLAVOUR: |
\r
1181 | | | | | the Change VNF Flavour LCM operation. |
\r
1183 | | | | | - TERMINATE: the |
\r
1185 | | | | | Terminate VNF LCM operation. |
\r
1187 | | | | | - HEAL: the Heal VNF LCM operation. |
\r
1189 | | | | | - OPERATE: the Operate VNF LCM operation. |
\r
1191 | | | | | - CHANGE\_EXT\_VLS: the |
\r
1193 | | | | | Change VNF external VLs LCM operation. (Reserved) |
\r
1194 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1195 | startTime | M | 1 | String | Date-time of the start of the operation. |
\r
1197 | | | | | Representation: String formatted according to RFC 3339 [13] |
\r
1198 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1199 | responseDescriptor | M | 1 | VnfLcOp | Including:responseId,progress,statusstatusDescription |
\r
1200 | | | | Response | |
\r
1201 | | | | Descriptor| ,errorCode,responseHistoryList |
\r
1202 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
\r
1204 **VnfLcOpResponseDescriptor:**
\r
1206 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1207 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1208 +===========================+=================+====================+===============+===========================================================+
\r
1209 | responseId | M | 1 | Integer | Response Identifier |
\r
1210 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1211 | progress | M | 1 | Integer | progress (1-100) |
\r
1212 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1213 | lcmOperationStatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
\r
1215 | | | | | Permitted values: |
\r
1217 | | | | | - STARTING: The operation is starting.. |
\r
1219 | | | | | - PROCESSING: The operation is |
\r
1220 | | | | | currently in execution. |
\r
1222 | | | | | - COMPLETED: The operation has completed successfully. |
\r
1224 | | | | | - FAILED: The operation has failed and it cannot be |
\r
1225 | | | | | retried or rolled back, as it is determined |
\r
1226 | | | | | that such action won't succeed. |
\r
1227 | | | | | - FAILED\_TEMP: The operation has failed and execution |
\r
1228 | | | | | has stopped, but the execution of the |
\r
1229 | | | | | operation is not considered to be closed. |
\r
1231 | | | | | (Reserved) |
\r
1233 | | | | | - ROLLING\_BACK: The operation is currently being rolled |
\r
1234 | | | | | back. (Reserved) |
\r
1236 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
\r
1237 | | | | | original operation invocation has been |
\r
1239 | | | | | restored as closely as possible. (Reserved) |
\r
1240 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1241 | statusDescripti on | O | 0..1 | String | Status Description of a VNF lifecycle operation |
\r
1242 | | | | | occurrence |
\r
1243 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1244 | errorCode | O | 0..1 | Integer | Errorcode |
\r
1245 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1246 | responseHistor yList | O | 0..N | VnfLcOpDetail | History Response Messages from the requested |
\r
1247 | | | | | responseId to lastest one. |
\r
1248 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1250 **VnfLcOpDetail:**
\r
1252 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1253 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1254 +===========================+=================+====================+===============+===========================================================+
\r
1255 | responseId | M | 1 | Integer | Response Identifier |
\r
1256 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1257 | progress | M | 1 | Integer | progress (1-100) |
\r
1258 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1259 | lcmOperationS tatus | M | 1 | ENUM | Status of a VNF lifecycle operation occurrence |
\r
1261 | | | | | Permitted values: |
\r
1263 | | | | | - STARTING: The operation is starting.. |
\r
1265 | | | | | - PROCESSING: The operation is currently in execution. |
\r
1267 | | | | | - COMPLETED: The operation has completed successfully. |
\r
1269 | | | | | - FAILED: The operation has failed and it |
\r
1270 | | | | | cannot be retried or rolled back, as it is |
\r
1271 | | | | | determined that such action won't succeed. |
\r
1274 | | | | | - FAILED\_TEMP: The operation has failed and execution |
\r
1275 | | | | | has stopped, but the execution of the operation |
\r
1276 | | | | | is not considered to be closed. (Reserved) |
\r
1278 | | | | | - ROLLING\_BACK: The operation is currently being |
\r
1279 | | | | | rolled back. (Reserved) |
\r
1282 | | | | | - ROLLED\_BACK: The state of the VNF prior to the |
\r
1283 | | | | | original operation invocation has been restored |
\r
1284 | | | | | as closely as possible. (Reserved) |
\r
1286 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1287 | statusDescription | O | 0..1 | String | Status Description of a VNF lifecycle operation occurrence|
\r
1288 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1289 | errorCode | O | 0..1 | Integer | Errorcode |
\r
1290 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
\r
1294 "vnfLcOpId": "1234566",
\r
1296 "vnfInstanceId": "1",
\r
1297 "lcmOperationType": "INSTANTIATE",
\r
1299 "startTime": "2017-01-01T12:00:27.87+00:20",
\r
1301 "responseDescriptor": {
\r
1305 "lcmOperationStatus": "PROCESSING",
\r
1306 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1307 "errorCode": null,
\r
1308 "responseHistoryList": [
\r
1313 "lcmOperationStatus": "PROCESSING",
\r
1314 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1322 "lcmOperationStatus": "PROCESSING",
\r
1323 "statusDescription": "OMC VMs are decommissioned in VIM",
\r
1334 **3.7.3 Response Code**
\r
1336 +-----------+-----------------------+----------------------------------+
\r
1337 | Code | Meaning | Description |
\r
1338 +===========+=======================+==================================+
\r
1339 | 200 | Ok | The request has succeeded. |
\r
1340 +-----------+-----------------------+----------------------------------+
\r
1341 | 4xx/5xx | <name from RFC7231> | <description> |
\r
1342 +-----------+-----------------------+----------------------------------+
\r
1344 **4.Interfaces provided by VNF**\ (Ve-Vnfm-vnf)
\r
1345 ===============================================
\r
1347 **4.1 Set Initial Configuration**
\r
1348 ---------------------------------
\r
1350 +---------------------+---------------------------------------------+
\r
1351 | If Definition | Description |
\r
1352 +=====================+=============================================+
\r
1353 | URI | http(s)://[hostname][:port]/configuration |
\r
1354 +---------------------+---------------------------------------------+
\r
1355 | Operation | POST |
\r
1356 +---------------------+---------------------------------------------+
\r
1357 | Direction | VNFM->VNF |
\r
1358 +---------------------+---------------------------------------------+
\r
1362 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1363 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1364 +=========================+=============+===============+==========================+==============================================================================+
\r
1365 | vnfInstanceId | M | 1 | Identifier | Identifier of the VNF instance which the VNF to set initial configuration. |
\r
1366 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1367 | vnfConfigurationData | O | 0..1 | VnfConfigur ation | Configuration data for the VNF instance. |
\r
1368 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1369 | vnfcConfigurationData | O | 0..N | VnfcConfigu ration | Configuration data for VNFC instances. |
\r
1370 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
\r
1372 **VnfConfiguration:**
\r
1374 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1375 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1376 +=======================+=================+====================+==================================+==============================================================================+
\r
1377 | cp | O | 0..N | CpConfiguratio n | External CPs |
\r
1378 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1379 | vnfSpecificData | O | 0..1 | VnfConfigurabl eProperties | Configuration object containing values of VNF configurable properties. |
\r
1380 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
\r
1382 **CpConfiguration:**
\r
1384 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1385 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1386 +=================+=============+====================+==============+=======================================================================================================+
\r
1387 | cpId | M | 1 | Identifier | Uniquely identifies a CP instance within the namespace of a specific VNF instance or VNFC instance. |
\r
1388 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1389 | cpdId | M | 1 | Identifier | Uniquely identifies a type of CP instance within the namespace of a VNFD. |
\r
1390 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1391 | cpAddress | M | 1..N | CpAddress | Address and Port assigned to the CP. |
\r
1392 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
\r
1396 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1397 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1398 +==========================+=============+====================+===================+===============================================================================================================================================+
\r
1399 | 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
1400 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1401 | 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
1403 | | | | | A cardinality of "0" indicates that no dynamic address needs to be configured on the CP. |
\r
1405 | | | | | Permitted values: |
\r
1407 | | | | | - TRUE |
\r
1409 | | | | | - FALSE |
\r
1410 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1411 | port | M | 0..1 | Not specified | The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.). |
\r
1413 | | | | | Reserved |
\r
1414 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
\r
1416 **VnfConfigurableProperties:**
\r
1418 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1419 | Attribute | Qualifier | Cardinality | Content| Description |
\r
1420 +====================+===========+==============+========+===============================================================================================+
\r
1421 | autoScalable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-scaling functionality. |
\r
1423 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
\r
1425 | | | | | Permitted values: |
\r
1427 | | | | | - TRUE |
\r
1429 | | | | | - FALSE |
\r
1430 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1431 | autoHealable | O | 0..1 | ENUM | It permits to enable (TRUE) / disable (FALSE) the auto-healing functionality. |
\r
1433 | | | | | A cardinality of "0" indicates that configuring this present VNF property is not supported. |
\r
1435 | | | | | Permitted values: |
\r
1437 | | | | | - TRUE |
\r
1439 | | | | | - FALSE |
\r
1440 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
\r
1442 **VnfcConfiguration:**
\r
1444 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1445 | Attribute | Qualifier | Cardinalit y | Content | Description |
\r
1446 +========================+=============+====================+====================+========================================================================================+
\r
1447 | vnfcId | M | 1 | Identifier | Uniquely identifies a VNFC instance within the namespace of a specific VNF instance. |
\r
1448 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1449 | cp | O | 0..N | CpConfiguratio n | Internal CPs. |
\r
1450 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1451 | vnfcSpecificData | O | 0..1 | KeyValuePair | Configuration object containing values of VNFC configurable properties |
\r
1452 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
\r
1456 "vnfInstanceId": "1",
\r
1457 "vnfConfigurationData": {
\r
1463 "cpdId": "cpd-a",
\r
1470 "addressType": "MAC",
\r
1471 "l2AddressData": "00:f3:43:20:a2:a3"
\r
1476 "addressType": "IP",
\r
1477 "l3AddressData": {
\r
1479 "iPAddressType": "IPv4",
\r
1480 "iPAddress": "192.168.104.2"
\r
1488 "useDynamicAddress": "FALSE"
\r
1498 "vnfSpecificData": {
\r
1500 "autoScalable": "FALSE",
\r
1501 "autoHealable": "FALSE"
\r
1507 "vnfcConfigurationData":
\r
1509 "vnfcId": "vnfc-1",
\r
1514 "cpdId": "cpd-1a",
\r
1521 "addressType": "MAC",
\r
1522 "l2AddressData": "00:f3:43:21:a2:a3"
\r
1527 "addressType": "IP",
\r
1528 "l3AddressData": {
\r
1530 "iPAddressType": "IPv4",
\r
1531 "iPAddress": "192.168.105.2"
\r
1538 "useDynamicAddress": "FALSE"
\r
1548 "vnfcSpecificData": {}
\r
1555 **4.1.2 Response**
\r
1557 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1558 | Parameter | Qualifier | Cardinality | Content | Description |
\r
1559 +=======================+=============+===============+===================+=================================+
\r
1560 | vnfConfigurationData | O | 0..1 | VnfConfiguration | Correspond to the |
\r
1561 | | | | | vnfConfigurationData in the |
\r
1562 | | | | | input information elements of |
\r
1563 | | | | | the SetInitialConfiguration |
\r
1564 | | | | | operation if it has. |
\r
1565 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1566 | vnfcConfigurationDa | O | 0..N | VnfConfiguration | Correspond to the |
\r
1567 | ta | | | | vnfcConfigurationData in the |
\r
1568 | | | | | input information elements of |
\r
1569 | | | | | the SetInitialConfiguration |
\r
1570 | | | | | operation if it has. |
\r
1571 +-----------------------+-------------+---------------+-------------------+---------------------------------+
\r
1574 "vnfConfigurationData": {
\r
1580 "cpdId": "cpd-a", "cpAddress": [
\r
1586 "addressType": "MAC",
\r
1587 "l2AddressData": "00:f3:43:20:a2:a3"
\r
1592 "addressType": "IP",
\r
1593 "l3AddressData": {
\r
1595 "iPAddressType": "IPv4",
\r
1596 "iPAddress": "192.168.104.2"
\r
1604 "useDynamicAddress": "FALSE"
\r
1613 "vnfSpecificData": {
\r
1615 "autoScalable": "FALSE",
\r
1616 "autoHealable": "FALSE",
\r
1623 "vnfcConfigurationData": {
\r
1625 "vnfcId": "vnfc-1",
\r
1630 "cpdId": "cpd-1a",
\r
1638 "addressType": "MAC",
\r
1639 "l2AddressData": "00:f3:43:21:a2:a3"
\r
1644 "addressType": "IP",
\r
1645 "l3AddressData": {
\r
1647 "iPAddressType": "IPv4",
\r
1648 "iPAddress": "192.168.105.2"
\r
1656 "useDynamicAddress": "FALSE"
\r
1666 "vnfcSpecificData": {…}
\r
1672 **4.1.3Response Code**
\r
1674 +-----------+-----------------------+-----------------------------------------------------------+
\r
1675 | Code | Meaning | Description |
\r
1676 +===========+=======================+===========================================================+
\r
1677 | 201 | Created | A VNF Instance identifier was created successfully. |
\r
1678 +-----------+-----------------------+-----------------------------------------------------------+
\r
1679 | 4xx/5xx | <name from RFC7231> | <description> |
\r
1680 +-----------+-----------------------+-----------------------------------------------------------+
\r
1682 .. |image0| image:: VNFM_API.png
\r
Code Review / vfc / nfvo / lcm.git / blob