docs/platform/APIs/VNFLCM_API/VNFLCM_API.rst

   1 .. contents::
   2    :depth: 3
   3 ..
   4
   5    **GVNFM Northbound & Southbound APIs**
   6    **V0.1**
   7
   8 **1 Scope**
   9 =============
  10
  11 The scope of the this document is to describe the GVNFM exposed API specification over Or-Vnfm reference point and Ve-Vnfm-vnf reference point.
  12 Some content has been updated, about the API Swagger definition, you can find here 'GVNFM_LCM_APIs<https://gerrit.onap.org/r/gitweb?p=vfc/gvnfm/vnflcm.git;a=blob;f=lcm/lcm/swagger/swagger.json;h=f098d282927d3535f5e9e6950f26b9171e04d30c;hb=HEAD>'.
  13
  14
  15 **2 Terms, Definitions and Abbreviations**
  16 ===========================================
  17
  18  For the purpose of the present document, the following
  19  abbreviations apply:
  20
  21 +------------------------+-----------------------------------------------------+
  22 |     **Abbreviation**   |                                                     |
  23 +========================+=====================================================+
  24 |     NFVO               |     Network Functions Virtualization Orchestrator   |
  25 +------------------------+-----------------------------------------------------+
  26 |     VNFM               |     Virtual Network Function Manager                |
  27 +------------------------+-----------------------------------------------------+
  28 |     VNF                |     Virtual Network Function                        |
  29 +------------------------+-----------------------------------------------------+
  30
  31 Table 2-1 abbreviations
  32
  33 **3. Interfaces provided by GVNFM**  (Or-Vnfm)
  34 ==========================================================
  35
  36    Interfaces use RESTful API and the format is as follows:
  37    http(s)://[hostname][:port]/api/vnflcm/v1/[……]
  38
  39 |image0|
  40
  41
  42     **{apiRoot} is** http(s)://[hostname][:port]/api
  43
  44 **3.1 Create VNF Identifier**
  45 -----------------------------
  46
  47 +---------------------+--------------------------------------------------------------+
  48 |     If Definition   | Description                                                  |
  49 +=====================+==============================================================+
  50 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances   |
  51 +---------------------+--------------------------------------------------------------+
  52 |     Operation       | POST                                                         |
  53 +---------------------+--------------------------------------------------------------+
  54 |     Direction       | NFVO->VNFMLCM                                                |
  55 +---------------------+--------------------------------------------------------------+
  56
  57 **3.1.1 Request**
  58
  59 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
  60 | Parameter                 | Qualifier   | Cardinality   |     Content      | Description                                                                         |
  61 +===========================+=============+===============+==================+=====================================================================================+
  62 | vnfdId                    | M           | 1             |     Identifier   | Identifier that identifies the VNFD which defines the VNF instance to be created.   |
  63 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
  64 | vnfInstanceName           | M           | 1             |     String       | Human-readable name of the VNF instance to be created.                              |
  65 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
  66 | vnfInstanceDescription    | O           | 0..1          |     String       | Human-readable description of the VNF instance to be created.                       |
  67 +---------------------------+-------------+---------------+------------------+-------------------------------------------------------------------------------------+
  68
  69     {
  70       "vnfdId": "zte\_vFW\_51610",
  71       "vnfInstanceName": "vFW\_01",
  72       "vnfInstanceDescription": " vFW in Nanjing TIC Edge"
  73
  74     }
  75
  76 **3.1.2 Response**
  77
  78 +-----------------+-------------+---------------+------------------+-----------------------------------------+
  79 | Parameter       | Qualifier   | Cardinality   |     Content      | Description                             |
  80 +=================+=============+===============+==================+=========================================+
  81 | vnfInstanceId   | M           | 1             |     Identifier   | VNF instance identifier just created.   |
  82 +-----------------+-------------+---------------+------------------+-----------------------------------------+
  83
  84     {
  85       "vnfInstanceId": "1"
  86
  87     }
  88
  89 **3.1.3 Response Code**
  90
  91 +-----------+-----------------------+-----------------------------------------------------------+
  92 | Code      | Meaning               |     Description                                           |
  93 +===========+=======================+===========================================================+
  94 | 201       | Created               |     A VNF Instance identifier was created successfully.   |
  95 +-----------+-----------------------+-----------------------------------------------------------+
  96 | 4xx/5xx   | <name from RFC7231>   |     <description>                                         |
  97 +-----------+-----------------------+-----------------------------------------------------------+
  98
  99 **3.2 Delete VNF Identifier**
 100 -----------------------------
 101
 102 +---------------------+------------------------------------------------------------------------------+
 103 |     If Definition   | Description                                                                  |
 104 +=====================+==============================================================================+
 105 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId}   |
 106 +---------------------+------------------------------------------------------------------------------+
 107 |     Operation       | DELETE                                                                       |
 108 +---------------------+------------------------------------------------------------------------------+
 109 |     Direction       | NFVO->VNFMLCM                                                                |
 110 +---------------------+------------------------------------------------------------------------------+
 111
 112 **3.2.1 Request**
 113
 114 +-------------+-------------+---------------+---------------+---------------+
 115 | Parameter   | Qualifier   | Cardinality   |     Content   | Description   |
 116 +=============+=============+===============+===============+===============+
 117 | n/a         |             |               |               |               |
 118 +-------------+-------------+---------------+---------------+---------------+
 119
 120 **3.2.2 Response**
 121
 122 +-------------+-------------+---------------+---------------+---------------+
 123 | Parameter   | Qualifier   | Cardinality   |     Content   | Description   |
 124 +=============+=============+===============+===============+===============+
 125 | n/a         |             |               |               |               |
 126 +-------------+-------------+---------------+---------------+---------------+
 127
 128 **3.2.3 Response Code**
 129
 130 +--------+-----------+-------------------+
 131 | Code   | Meaning   |     Description   |
 132 +--------+-----------+-------------------+
 133
 134 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
 135 | 204       | No Content            |     The VNF instance resource and the associated VNF identifier were deleted successfully.   |
 136 +===========+=======================+==============================================================================================+
 137 | 4xx/5xx   | <name from RFC7231>   |     <description>                                                                            |
 138 +-----------+-----------------------+----------------------------------------------------------------------------------------------+
 139
 140 **3.3 Instantiate VNF**
 141 -----------------------
 142
 143 +---------------------+-------------------------------------------------------------------------------------------+
 144 |     If Definition   | Description                                                                               |
 145 +=====================+===========================================================================================+
 146 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId}/instantiate     |
 147 +---------------------+-------------------------------------------------------------------------------------------+
 148 |     Operation       | POST                                                                                      |
 149 +---------------------+-------------------------------------------------------------------------------------------+
 150 |     Direction       | NFVO->VNFMLCM                                                                             |
 151 +---------------------+-------------------------------------------------------------------------------------------+
 152
 153 3.3.1 **Request**
 154
 155 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 156 | Parameter          | Qualifier | Cardinality | Content             | Description                                                   |
 157 +====================+===========+=============+=====================+===============================================================+
 158 | flavourId          | M         | 1           | IdentifierInV nfd   | Identifier of the VNF deployment flavour to be instantiated.  |
 159 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 160 | instantiation      | O         | 0..1        | IdentifierInVnfd    | Identifier of the instantiation                               |
 161 | LevelId            |           |             |                     | level of the deployment                                       |
 162 |                    |           |             |                     | flavour to be instantiated. If                                |
 163 |                    |           |             |                     | not present, the default                                      |
 164 |                    |           |             |                     | instantiation level as                                        |
 165 |                    |           |             |                     | declared in the VNFD is                                       |
 166 |                    |           |             |                     | instantiated.                                                 |
 167 |                    |           |             |                     |                                                               |
 168 |                    |           |             |                     | Reserved                                                      |
 169 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 170 | extVirtualLinks    | O         | 0..N        | ExtVirtualLin kData | Information about external VLs to connect the VNF to.         |
 171 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 172 | extManagedVirtualL | O         | 0..N        | ExtManaged          | Information about internal                                    |
 173 | inks               |           |             | VirtualLinkData     | VLs that are managed by                                       |
 174 |                    |           |             |                     | other entities than the VNFM.                                 |
 175 |                    |           |             |                     |                                                               |
 176 |                    |           |             |                     | Reserved                                                      |
 177 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 178 | localization       | O         | 0..1        | String              | Localization language of the VNF to be instantiated can be    |
 179 | Language           |           |             |                     | declared in the VNFD. The value shall comply with the format  |
 180 |                    |           |             |                     | defined in IETF RFC 5646 [6].                                 |
 181 |                    |           |             |                     |                                                               |
 182 |                    |           |             |                     | Reserved                                                      |
 183 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 184 | additionalParams   | O         | 0..N        | KeyValuePair        | Additional input parameters for the instantiation process,    |
 185 |                    |           |             |                     | specific to the VNF being instantiated.                       |
 186 +--------------------+-----------+-------------+---------------------+---------------------------------------------------------------+
 187
 188 **ExtVirtualLinkData:**
 189
 190 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 191 | Attribute        | Qualifier | Cardinality | Content         | Description                                                                      |
 192 +==================+===========+=============+=================+==================================================================================+
 193 | vlInstanceId     | O         | 0..1        | Identifier      | Identifier of the VL instance.                                                   |
 194 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 195 | vim              | CM        | 0..1        | VimInfo         | Information about the VIM that manages this resource.                            |
 196 |                  |           |             |                 | This attribute shall be supported and present if VNF-related resource management |
 197 |                  |           |             |                 | in direct mode is applicable.                                                    |
 198 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 199 | resourceProvider | CM        | 0..1        | Identifier      | Identifies the entity responsible for the management of this resource.           |
 200 | Id               |           |             |                 | This attribute shall be present if                                               |
 201 |                  |           |             |                 | VNF-related resource management in indirect mode is applicable.                  |
 202 |                  |           |             |                 |                                                                                  |
 203 |                  |           |             |                 | Reserved                                                                         |
 204 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 205 | resourceId       | M         | 1           | IdentifierInVim | The identifier of the resource in the scope of the VIM or the resource provider. |
 206 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 207 | extCps           | M         | 1..N        | VnfExtCpData    | External CPs of the VNF to be connected to this external VL.                     |
 208 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+
 209
 210     **VimInfo:**
 211
 212 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 213 | Attribute       | Qualifier | Cardinality | Content      | Description                                                                                                                              |
 214 +=================+===========+=============+==============+==========================================================================================================================================+
 215 | vimInfoId       | M         | 1           | Identifier   | The identifier of this VimInfo instance, for the purpose of referencing it from other information elements.                              |
 216 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 217 | vimId           | M         | 1           | Identifier   | The identifier of the VIM.                                                                                                               |
 218 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 219 | interfaceInfo   | M         | 0..N        | KeyValuePair | Information about the interface to the VIM, including VIM provider type, API version and protocol type.                                 |
 220 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 221 | accessInfo      | M         | 0..N        | KeyValuePair | Authentication credentials for accessing the VIM. Examples may include those to support different authentication schemes, e.g., OAuth,   |
 222 |                 |           |             |              | Token etc.                                                                                                                              |
 223 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 224 | interface       | M         | 1           | String       | Information about the interface endpoint. An example is a URL.                                                                           |
 225 | Endpoint        |           |             |              | Token etc.                                                                                                                              |
 226 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+
 227
 228     **interfaceInfo:**
 229
 230 +------------------+---------------+--------------------------------------+
 231 | **Key Define**   | **Content**   | **Description**                      |
 232 +==================+===============+======================================+
 233 | vimType          | String        | The type of the VIM.                 |
 234 +------------------+---------------+--------------------------------------+
 235 | apiVersion       | String        | The version of the api of the VIM.   |
 236 +------------------+---------------+--------------------------------------+
 237 | protocolType     | String        | http https                           |
 238 +------------------+---------------+--------------------------------------+
 239
 240     **accessInfo:**
 241
 242 +------------------+---------------+--------------------------+
 243 | **Key Define**   | **Content**   | **Description**          |
 244 +==================+===============+==========================+
 245 | tenant           | String        | Tenant Name of tenant    |
 246 +------------------+---------------+--------------------------+
 247 | username         | String        | Username for login       |
 248 +------------------+---------------+--------------------------+
 249 | password         | String        | Password of login user   |
 250 +------------------+---------------+--------------------------+
 251
 252     **VnfExtCpData:**
 253
 254 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
 255 | **Attribute**          |     **Qualifier**   |     **Cardinality**   |     **Content**    |     **Description**                                       |
 256 +========================+=====================+=======================+====================+===========================================================+
 257 | cpdId                  |     M               | 1                     | IdentifierInVnfd   | The identifier of the CPD in the VNFD.                    |
 258 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
 259 | addresses              |     O               | 0..N                  | NetworkAddress     | List of (fixed) network addresses that                    |
 260 |                        |                     |                       |                    | need to be configured on the CP. This attribute shall     |
 261 |                        |                     |                       |                    | be present if fixed addresses need to be configured.      |
 262 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
 263 | numDynamicAddre sses   |     O               | 0..1                  | Integer            | Number of network addresses to be assigned dynamically.   |
 264 |                        |                     |                       |                    | This attribute shall be present if dynamic                |
 265 |                        |                     |                       |                    | addresses need to be configured.                          |
 266 |                        |                     |                       |                    | Reserved                                                  |
 267 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+
 268
 269     **NetworkAddress:**
 270
 271 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
 272 | **Attribute**   |     **Qualifier**   |     **Cardinality**   |     **Content**   |     **Description**                                                                                           |
 273 +=================+=====================+=======================+===================+===============================================================================================================+
 274 | addressType     |     M               | 1                     | Enum              | Describes the type of the address to be assigned to the CP instantiated from the parent CPD.                  |
 275 |                 |                     |                       |                   |                                                                                                               |
 276 |                 |                     |                       |                   | Permitted values:                                                                                             |
 277 |                 |                     |                       |                   |                                                                                                               |
 278 |                 |                     |                       |                   | -  MAC                                                                                                        |
 279 |                 |                     |                       |                   |                                                                                                               |
 280 |                 |                     |                       |                   | -  IP                                                                                                         |
 281 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
 282 | l2AddressData   |     CM              | 0..1                  | String            | Provides the information on the MAC addresses to be assigned to the CP(s) instantiated from the parent CPD.   |
 283 |                 |                     |                       |                   |                                                                                                               |
 284 |                 |                     |                       |                   | Shall be present when the addressType is MAC address.                                                         |
 285 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
 286 | l3AddressData   |     CM              | 0..1                  | L3AddressData     | Provides the information on the IP addresses to be assigned to the CP instantiated from the parent CPD.       |
 287 |                 |                     |                       |                   |                                                                                                               |
 288 |                 |                     |                       |                   | Shall be present when the addressType is IP address.                                                          |
 289 +-----------------+---------------------+-----------------------+-------------------+---------------------------------------------------------------------------------------------------------------+
 290
 291     **L3AddressData:**
 292
 293 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
 294 | **Attribute**   |     **Qualifier**   |     **Cardinality**   |     **Content**   |     **Description**   |
 295 +=================+=====================+=======================+===================+=======================+
 296 | iPAddressType   |     M               | 1                     | ENUM              | IP address type.      |
 297 |                 |                     |                       |                   |                       |
 298 |                 |                     |                       |                   | Permitted values:     |
 299 |                 |                     |                       |                   |                       |
 300 |                 |                     |                       |                   | -  IPv4               |
 301 |                 |                     |                       |                   |                       |
 302 |                 |                     |                       |                   | -  IPv6               |
 303 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
 304 | iPAddress       |     M               | 1                     | String            | IP address            |
 305 +-----------------+---------------------+-----------------------+-------------------+-----------------------+
 306
 307     {
 308
 309       "flavourId": "flavour\_1",
 310       "instantiationLevelId":"instantiationLevel\_1",
 311       "extVirtualLinks": [
 312
 313         {  "vlInstanceId": "1",
 314            "vim": {
 315             "vimInfoId": "1",
 316             "vimId": "1",
 317             "interfaceInfo": {
 318
 319               "vimType": "vim",
 320               "apiVersion": "v2",
 321               "protocolType": "http"
 322
 323             },
 324             "accessInfo": {
 325
 326               "tenant": "tenant\_vCPE",
 327               "username": "vCPE",
 328               "password": "vCPE\_321"
 329
 330             },
 331             "interfaceEndpoint": "http://10.43.21.105:80/"
 332
 333         },
 334         "resourceId": "1246",
 335         "extCps": [
 336
 337           {
 338             "cpdId": "11", "addresses": [
 339
 340               {
 341                 "addressType": "MAC",
 342                 "l2AddressData": "00:f3:43:20:a2:a3"
 343
 344               },
 345               {
 346
 347                 "addressType": "IP",
 348                 "l3AddressData": {
 349
 350                   "iPAddressType": "IPv4",
 351                   "iPAddress": "192.168.104.2"
 352
 353                 }
 354
 355               }
 356
 357             ],
 358             "numDynamicAddresses": 0
 359
 360           },
 361
 362           ...
 363
 364           ]
 365
 366         }
 367
 368       ],
 369
 370       "localizationLanguage": "en\_US", "additionalParams": {...}
 371
 372     }
 373
 374
 375 **3.3.2 Response**
 376
 377 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
 378 | Parameter   | Qualifier   | Cardinality   |     Content      | Description                                             |
 379 +=============+=============+===============+==================+=========================================================+
 380 | vnfLcOpId   | M           | 1             |     Identifier   | Identifier of the VNF lifecycle operation occurrence.   |
 381 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
 382
 383     {
 384
 385     "vnfLcOpId": "1"
 386
 387     }
 388
 389     **3.3.3 Response Code**
 390
 391 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 392 | Code      | Meaning               |     Description                                                                          |
 393 +===========+=======================+==========================================================================================+
 394 | 202       | Accepted              |     The request is accepted for processing, but the processing has not been completed.   |
 395 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 396 | 4xx/5xx   | <name from RFC7231>   |     <description>                                                                        |
 397 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 398
 399 **3.4 Terminate VNF**
 400 ---------------------
 401
 402 +---------------------+-----------------------------------------------------------------------------------------+
 403 |     If Definition   | Description                                                                             |
 404 +=====================+=========================================================================================+
 405 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances/{vnfInstanceId}/term inate   |
 406 +---------------------+-----------------------------------------------------------------------------------------+
 407 |     Operation       | POST                                                                                    |
 408 +---------------------+-----------------------------------------------------------------------------------------+
 409 |     Direction       | NFVO->VNFMLCM                                                                           |
 410 +---------------------+-----------------------------------------------------------------------------------------+
 411
 412 **3.4.1 Request**
 413
 414 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
 415 | Parameter         | Qualifier   | Cardinality   |     Content   | Description                                                             |
 416 +===================+=============+===============+===============+=========================================================================+
 417 | terminationType   | M           | 1             |     Enum      | Indicates whether forceful or graceful termination is requested.        |
 418 |                   |             |               |               |                                                                         |
 419 |                   |             |               |               | Permitted values:                                                       |
 420 |                   |             |               |               |                                                                         |
 421 |                   |             |               |               | -  FORCEFUL: The VNFM                                                   |
 422 |                   |             |               |               |     will shut down the VNF and release the resources immediately        |
 423 |                   |             |               |               |     after accepting the request.                                        |
 424 |                   |             |               |               | -  GRACEFUL: The VNFM                                                   |
 425 |                   |             |               |               |                                                                         |
 426 |                   |             |               |               |     will first arrange to take the VNF out of service after accepting   |
 427 |                   |             |               |               |     the request. Once the operation is successful or once the timer     |
 428 |                   |             |               |               |     value specified in the                                              |
 429 |                   |             |               |               |                                                                         |
 430 |                   |             |               |               |    “gracefulTerminationTime out” attribute expires, the VNFM will shut  |
 431 |                   |             |               |               |     down the VNF and release the resources.                             |
 432 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
 433 | graceful          | O           | 0..1          |     Integer   | This attribute is only                                                  |
 434 | Termination       |             |               |               | applicable in case of graceful                                          |
 435 | Timeout           |             |               |               | termination. It defines the                                             |
 436 |                   |             |               |               | time to wait for the VNF to be                                          |
 437 |                   |             |               |               | taken out of service before                                             |
 438 |                   |             |               |               | shutting down the VNF and                                               |
 439 |                   |             |               |               | releasing the resources.                                                |
 440 |                   |             |               |               | The unit is seconds.                                                    |
 441 |                   |             |               |               | If not given and the                                                    |
 442 |                   |             |               |               | "terminationType"                                                       |
 443 |                   |             |               |               | attribute is set to                                                     |
 444 |                   |             |               |               | "GRACEFUL", it is expected                                              |
 445 |                   |             |               |               | that the VNFM waits for                                                 |
 446 |                   |             |               |               | the successful taking out of                                            |
 447 |                   |             |               |               | service of the VNF, no                                                  |
 448 |                   |             |               |               | matter how long it takes,                                               |
 449 |                   |             |               |               | before shutting down the                                                |
 450 |                   |             |               |               | VNF and releasing the                                                   |
 451 |                   |             |               |               | resources.                                                              |
 452 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+
 453
 454  {
 455     "terminationType": "GRACEFUL",
 456     "gracefulTerminationTimeout": 120
 457
 458  }
 459
 460 **3.4.2 Response**
 461
 462 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
 463 | Parameter   | Qualifier   | Cardinality   |     Content      | Description                                             |
 464 +=============+=============+===============+==================+=========================================================+
 465 | vnfLcOpId   | M           | 1             |     Identifier   | Identifier of the VNF lifecycle operation occurrence.   |
 466 +-------------+-------------+---------------+------------------+---------------------------------------------------------+
 467
 468     {
 469       "vnfLcOpId": "2"
 470
 471     }
 472
 473 **3.4.3 Response Code**
 474
 475 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 476 | Code      | Meaning               |     Description                                                                          |
 477 +===========+=======================+==========================================================================================+
 478 | 202       | Accepted              |     The request is accepted for processing, but the processing has not been completed.   |
 479 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 480 | 4xx/5xx   | <name from RFC7231>   |     <description>                                                                        |
 481 +-----------+-----------------------+------------------------------------------------------------------------------------------+
 482
 483 **3.5 Query multiple VNF**
 484 ---------------------------
 485 +---------------------+--------------------------------------------------------------+
 486 |     If Definition   | Description                                                  |
 487 +=====================+==============================================================+
 488 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_instances   |
 489 +---------------------+--------------------------------------------------------------+
 490 |     Operation       | GET                                                          |
 491 +---------------------+--------------------------------------------------------------+
 492 |     Direction       | NFVO->VNFMLCM                                                |
 493 +---------------------+--------------------------------------------------------------+
 494
 495 **3.5.1 Request**
 496
 497 +-------------+-------------+---------------+---------------+---------------+
 498 | Parameter   | Qualifier   | Cardinality   |     Content   | Description   |
 499 +=============+=============+===============+===============+===============+
 500 | n/a         |             |               |               |               |
 501 +-------------+-------------+---------------+---------------+---------------+
 502
 503 **3.5.2 Response**
 504
 505 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
 506 | Parameter          | Qualifier   | Cardinality   |     Content            | Description                                                                          |
 507 +====================+=============+===============+========================+======================================================================================+
 508 | vnfInstanceInfos   | M           | 0..N          |     VnfInstanceI nfo   | Returned if information about zero or more VNF instances was queried successfully.   |
 509 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
 510 +--------------------+-------------+---------------+------------------------+--------------------------------------------------------------------------------------+
 511
 512     **VnfInstanceInfo:**
 513
 514 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 515 |     Attribute                    | Qualifier|Cardinality |     Content                |     Description                                                                                                                                       |
 516 +==================================+==========+============+============================+=======================================================================================================================================================+
 517 |     vnfInstanceId                |     M    |     1      |     Identifier             |     VNF instance identifier.                                                                                                                          |
 518 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 519 |     vnfInstanceName              |     M    |     1      |     String                 |     VNF instance name.                                                                                                                                |
 520 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 521 |     vnfInstanceDescr iption      |     M    |     1      |     String                 |     Human-readable description of the VNF instance.                                                                                                   |
 522 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 523 |     onboardedVnfPk gInfoId       |     M    |     1      |     Identifier             |     Identifier of information held by the NFVO about the specific VNF Package on which the VNF is based. This identifier was allocated by the NFVO.   |
 524 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 525 |     vnfdId                       |     M    |     1      |     Identifier             |     Identifier of the VNFD on which the VNF instance is based.                                                                                        |
 526 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 527 |     vnfdVersion                  |     M    |     1      |     Identifier             |     Identifies the version of the VNFD. The value is copied from the VNFD.                                                                            |
 528 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 529 |     vnfSoftwareVersi on          |     M    |     1      |     String                 |     Software version of the VNF.                                                                                                                      |
 530 |                                  |          |            |                            |                                                                                                                                                       |
 531 |                                  |          |            |                            |     The value is copied from the VNFD.                                                                                                                |
 532 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 533 |     vnfProvider                  |     M    |     1      |     String                 |     Name of the person or company providing the VNF.                                                                                                  |
 534 |                                  |          |            |                            |                                                                                                                                                       |
 535 |                                  |          |            |                            |     The value is copied from the VNFD.                                                                                                                |
 536 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 537 |     vnfProductName               |     M    |     1      |     String                 |     Name to identify the VNF Product. The value is copied from the VNFD.                                                                              |
 538 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 539 |     vnfConfigurableP roperties   |     O    |     0..N   |     KeyValuePair           |     Current values of the configurable properties of the VNF instance.                                                                                |
 540 |                                  |          |            |                            |                                                                                                                                                       |
 541 |                                  |          |            |                            |     Configurable properties as declared in the VNFD.                                                                                                  |
 542 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 543 |     instantiationState           |     M    |     1      |     Enum                   |     The instantiation state of the VNF.                                                                                                               |
 544 |                                  |          |            |                            |                                                                                                                                                       |
 545 |                                  |          |            |                            |     Permitted values:                                                                                                                                 |
 546 |                                  |          |            |                            |                                                                                                                                                       |
 547 |                                  |          |            |                            | -  NOT\_INSTANTIATED: The VNF                                                                                                                         |
 548 |                                  |          |            |                            |                                                                                                                                                       |
 549 |                                  |          |            |                            |     instance is terminated or not instantiated.                                                                                                       |
 550 |                                  |          |            |                            |                                                                                                                                                       |
 551 |                                  |          |            |                            | -  INSTANTIATED: The VNF instance is instantiated.                                                                                                    |
 552 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 553 |     instantiatedVnfInf o         |     CM   |     0..1   |     InstantiatedVnf Info   |     Information specific to an instantiated VNF instance.                                                                                             |
 554 |                                  |          |            |                            |                                                                                                                                                       |
 555 |                                  |          |            |                            |     This attribute shall be present if the instantiateState attribute value is INSTANTIATED.                                                          |
 556 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 557 |     metadata                     |     O    |     0..N   |     KeyValuePair           |     Additional metadata describing the VNF instance.                                                                                                  |
 558 |                                  |          |            |                            |                                                                                                                                                       |
 559 |                                  |          |            |                            |     This attribute can be modified with the Modify VNF information operation.                                                                         |
 560 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 561 |     extensions                   |     O    |     0..N   |     KeyValuePair           |     VNF-specific attributes.                                                                                                                          |
 562 |                                  |          |            |                            |                                                                                                                                                       |
 563 |                                  |          |            |                            |     This attribute can be modified with the Modify VNF information operation.                                                                         |
 564 +----------------------------------+----------+------------+----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------+
 565
 566     **InstantiatedVnfInfo:**
 567
 568 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 569 |     Attribute                | Qualifier | Cardinality| Content                      |     Description                                                                                                        |
 570 +==============================+===========+============+==============================+========================================================================================================================+
 571 |     flavourId                | M         |     1      | IdentifierInVnfd             | Identifier of the VNF deployment flavour to be instantiated.                                                           |
 572 |                              |           |            |                              |                                                                                                                        |
 573 |                              |           |            |                              | Reserved                                                                                                               |
 574 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 575 |     vnfState                 | M         |     1      | ENUM                         | State of the VNF instance.                                                                                             |
 576 |                              |           |            |                              |                                                                                                                        |
 577 |                              |           |            |                              | Permitted values:                                                                                                      |
 578 |                              |           |            |                              |                                                                                                                        |
 579 |                              |           |            |                              | -  STARTED: The VNF instance is up and running.                                                                        |
 580 |                              |           |            |                              |                                                                                                                        |
 581 |                              |           |            |                              | -  STOPPED: The VNF instance has been shut down.                                                                       |
 582 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 583 |     scaleStatus              | O         |     0..N   | ScaleInfo                    | Scale status of the VNF, one entry per aspect. Represents for every scaling aspect how "big" the VNF has been scaled   |
 584 |                              |           |            |                              |                                                                                                                        |
 585 |                              |           |            |                              | w.r.t. that aspect.                                                                                                    |
 586 |                              |           |            |                              |                                                                                                                        |
 587 |                              |           |            |                              | This attribute shall be present if the VNF supports scaling.                                                           |
 588 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 589 |     extCpInfo                | O         |     0..N   | CpInfo                       | Information about the external CPs exposed by the VNF instance.                                                        |
 590 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 591 |     extVirtualLink           | O         |     0..N   | ExtVirtualLinkI nfo          | Information about the external VLs the VNF instance is connected to.                                                   |
 592 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 593 |     extManagedVirtu alLink   | O         |     0..N   | extManagedVir tualLinkInfo   | Information about the externally-managed internal VLs of the VNF instance.                                             |
 594 |                              |           |            |                              |                                                                                                                        |
 595 |                              |           |            |                              | Reserved                                                                                                               |
 596 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 597 |     monitoringParam eters    | O         |     0..N   | MonitoringPar ameter         | Active monitoring parameters.                                                                                          |
 598 |                              |           |            |                              |                                                                                                                        |
 599 |                              |           |            |                              | Reserved                                                                                                               |
 600 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 601 |     localizationLangu age    | O         |     0..1   | String                       | Localization language of the VNF to be instantiated.                                                                   |
 602 |                              |           |            |                              |                                                                                                                        |
 603 |                              |           |            |                              | The value shall comply with the format defined in IETF RFC 5646 [6].                                                   |
 604 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 605 |     vimInfo                  | CM        |     0..N   | VimInfo                      | Information about VIM(s) managing resources for the VNF instance.                                                      |
 606 |                              |           |            |                              |                                                                                                                        |
 607 |                              |           |            |                              | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable.         |
 608 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 609 |     vnfcResourceInfo         | CM        |     0..N   | VnfcResourceI nfo            | Information about the virtualised compute and storage resource(s) used by the VNFCs of the VNF instance.               |
 610 |                              |           |            |                              |                                                                                                                        |
 611 |                              |           |            |                              | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable.         |
 612 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 613 | virtualLinkResourceInfo      | CM        |     0..N   | VirtualLinkRes ourceInfo     | Information about the virtualised network resource(s) used by the VLs of the VNF instance.                             |
 614 |                              |           |            |                              |                                                                                                                        |
 615 |                              |           |            |                              | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable.         |
 616 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 617 | virtualStorageResourceInfo   | CM        |     0..N   | VirtualStorage ResourceInfo  | Information about the virtualised storage resource(s) used as storage for the VNF instance.                            |
 618 |                              |           |            |                              |                                                                                                                        |
 619 |                              |           |            |                              | This attribute shall be supported and present if VNF-related resource management in direct mode is applicable.         |
 620 +------------------------------+-----------+------------+------------------------------+------------------------------------------------------------------------------------------------------------------------+
 621
 622 **ScaleInfo:**
 623
 624 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 625 |     Attribute    | Qualifier   |     Cardinalit y   | Content            | Description                                                                                                                         |
 626 +==================+=============+====================+====================+=====================================================================================================================================+
 627 |     aspectId     | M           |     1              | IdentifierInVnfd   | Identifier of the scaling aspect.                                                                                                   |
 628 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 629 |     scaleLevel   | M           |     1              | Integer            | Indicates the scale level. The minimum value shall be 0 and the maximum value shall be <= maxScaleLevel as described in the VNFD.   |
 630 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 631 +------------------+-------------+--------------------+--------------------+-------------------------------------------------------------------------------------------------------------------------------------+
 632
 633     **CpInfo:**
 634
 635 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
 636 |     Attribute      | Qualifier   |     Cardinalit y   | Content            | Description                                                      |
 637 +====================+=============+====================+====================+==================================================================+
 638 |     cpInstanceId   | M           |     1              | Identifier         | Identifier of the CP instance.                                   |
 639 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
 640 |     cpdId          | M           |     1              | IdentifierInVnfd   | Identifier of the CPD, in the VNFD.                              |
 641 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
 642 |     addresses      | O           |     0..N           | NetworkAddre ss    | List of network addresses that have been configured on the CP.   |
 643 +--------------------+-------------+--------------------+--------------------+------------------------------------------------------------------+
 644
 645     **ExtVirtualLinkInfo:**
 646
 647 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
 648 |     Attribute          | Qualifier   |     Cardinalit y   | Content           | Description                                     |
 649 +========================+=============+====================+===================+=================================================+
 650 |     extVirtualLinkId   | M           |     1              | Identifier        | Identifier of the external VL.                  |
 651 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
 652 |     resourceHandle     | M           |     1              | ResourceHand le   | Identifier of the resource realizing this VL.   |
 653 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
 654 |     linkPorts          | O           |     0..N           | VnfLinkPort       | Link ports of this VL.                          |
 655 +------------------------+-------------+--------------------+-------------------+-------------------------------------------------+
 656
 657     **ResourceHandle:**
 658
 659 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
 660 |     Attribute       | Qualifier  | Cardinality| Content           | Description                                                                                            |
 661 +=====================+============+============+===================+========================================================================================================+
 662 |     vimId           | CM         |     0..1   | Identifier        | Identifier of the VimInfo information element defining the VIM who manages the resource.               |
 663 |                     |            |            |                   |                                                                                                        |
 664 |                     |            |            |                   | This attribute shall be present if                                                                     |
 665 |                     |            |            |                   |                                                                                                        |
 666 |                     |            |            |                   | VNF-related resource management in direct mode is applicable.                                          |
 667 |                     |            |            |                   |                                                                                                        |
 668 |                     |            |            |                   | The value refers to a vimInfo item in the VnfInstance.                                                 |
 669 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
 670 | resourceProviderId  | CM         |     0..1   | Identifier        | Identifier of the entity responsible for the management of the resource.                               |
 671 |                     |            |            |                   |                                                                                                        |
 672 |                     |            |            |                   | This attribute shall be present when VNF-related resource management in indirect mode is applicable.   |
 673 |                     |            |            |                   |                                                                                                        |
 674 |                     |            |            |                   | Reserved                                                                                               |
 675 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
 676 |     resourceId      | M          |     1      | IdentifierInVim   | Identifier of the resource in the scope of the VIM or the resource provider.                           |
 677 +---------------------+------------+------------+-------------------+--------------------------------------------------------------------------------------------------------+
 678
 679     **VnfLinkPort:**
 680
 681 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
 682 |     Attribute        | Qualifier   |     Cardinalit y   | Content           | Description                                                                                    |
 683 +======================+=============+====================+===================+================================================================================================+
 684 |     resourceHandle   | M           |     1              | ResourceHand le   | Identifier of the virtualised network resource realizing this link port.                       |
 685 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
 686 |     cpInstanceId     | M           |     1              | IdentifierInVnf   | External CP of the VNF to be connected to this link port.                                      |
 687 |                      |             |                    |                   |                                                                                                |
 688 |                      |             |                    |                   | There shall be at most one link port associated with any external connection point instance.   |
 689 |                      |             |                    |                   |                                                                                                |
 690 |                      |             |                    |                   | The value refers to an extCpInfo item in the VnfInstance.                                      |
 691 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
 692 +----------------------+-------------+--------------------+-------------------+------------------------------------------------------------------------------------------------+
 693
 694     **VnfcResourceInfo:**
 695
 696 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 697 |     Attribute         | Qualifier  | Cardinality| Content            | Description                                                                                                         |
 698 +=======================+============+============+====================+=====================================================================================================================+
 699 | vnfcInstanceId        | M          |     1      | IdentifierInVnf    | Identifier of this VNFC instance.                                                                                   |
 700 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 701 | vduId                 | M          |     1      | IdentifierInVnfd   | Reference to the applicable Vdu information element in the VNFD.                                                    |
 702 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 703 | computeResourc e      | M          |     1      | ResourceHand le    | Reference to the VirtualCompute resource.                                                                           |
 704 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 705 | storageResourceI ds   | M          |     1..N   | IdentifierInVnf    | Reference(s) to the VirtualStorage resource(s).                                                                     |
 706 |                       |            |            |                    |                                                                                                                     |
 707 |                       |            |            |                    | The value refers to a VirtualStorageResourceInfo item in the VnfInstance.                                           |
 708 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 709 | reservationId         | O          |     0..1   | Identifier         | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists.   |
 710 |                       |            |            |                    |                                                                                                                     |
 711 |                       |            |            |                    | Reserved                                                                                                            |
 712 +-----------------------+------------+------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 713
 714     **VirtualStorageResourceInfo:**
 715
 716 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 717 |     Attribute                   | Qualifier   |     Cardinalit y   | Content            | Description                                                                                                         |
 718 +=================================+=============+====================+====================+=====================================================================================================================+
 719 |     virtualStorageInst anceId   | M           |     1              | IdentifierInVnf    | Identifier of this virtual storage resource instance.                                                               |
 720 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 721 |     virtualStorageDe scId       | M           |     1              | IdentifierInVnfd   | Identifier of the VirtualStorageDesc in the VNFD.                                                                   |
 722 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 723 |     storageResource             | M           |     1              | ResourceHand le    | Reference to the VirtualStorage resource.                                                                           |
 724 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 725 |     reservationId               | M           |     0..1           | Identifier         | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists.   |
 726 |                                 |             |                    |                    |                                                                                                                     |
 727 |                                 |             |                    |                    | Reserved                                                                                                            |
 728 +---------------------------------+-------------+--------------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 729
 730     **VirtualLinkResourceInfo:**
 731
 732 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 733 |     Attribute                | Qualifier |  Cardinality | Content            | Description                                                                                                         |
 734 +==============================+===========+==============+====================+=====================================================================================================================+
 735 |     virtualLinkInstanceId    | M         |       1      | IdentifierInVnf    | Identifier of this VL instance.                                                                                     |
 736 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 737 |     virtualLinkDescId        | M         |       1      | IdentifierInVnfd   | Identifier of the Virtual Link Descriptor (VLD) in the VNFD.                                                        |
 738 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 739 |     networkResource          | M         |       1      | ResourceHand le    | Reference to the VirtualNetwork resource.                                                                           |
 740 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 741 |     reservationId            | M         |       0..1   | Identifier         | The reservation identifier applicable to the resource. It shall be present when an applicable reservation exists.   |
 742 |                              |           |              |                    |                                                                                                                     |
 743 |                              |           |              |                    | Reserved                                                                                                            |
 744 +------------------------------+-----------+--------------+--------------------+---------------------------------------------------------------------------------------------------------------------+
 745
 746     [
 747
 748       {
 749
 750         "vnfInstanceId": "1",
 751         "vnfInstanceName": "vFW\_01",
 752         "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
 753         "onboardedVnfPkgInfoId": "1",
 754         "vnfdId": "zte\_vFW\_51610",
 755         "vnfdVersion": "V1.0",
 756         "vnfSoftwareVersion": "V1.0",
 757         "vnfProvider": "ZTE",
 758         "vnfProductName": "vFW",
 759         "vnfConfigurableProperties": {...},
 760         "instantiationState": "INSTANTIATED",
 761         "instantiatedVnfInfo": {
 762
 763           "flavourId": "1",
 764           "vnfState": "STARTED",
 765           "scaleStatus": [
 766
 767             {
 768               "aspectId": "aspect1",
 769               "scaleLevel": 1
 770
 771             }
 772
 773           ],
 774
 775         "extCpInfo": [
 776
 777           {
 778             "cpInstanceId": "1",
 779             "cpdId": "1", "addresses": [
 780
 781               {
 782                 "addressType": "MAC",
 783                 "l2AddressData": "00:f3:43:20:a2:a3"
 784
 785               },
 786
 787               {
 788                 "addressType": "IP",
 789                 "l3AddressData": {
 790
 791                   "iPAddressType": "IPv4",
 792                   "address": "192.168.104.2"
 793
 794                 }
 795
 796               }
 797
 798             ]
 799
 800           }
 801
 802         ],
 803         "extVirtualLink": [
 804
 805           {
 806             "extVirtualLinkId": "extvl1",
 807             "resourceHandle": {
 808
 809               "vimId": "1",
 810               "resourceId": "1111"
 811
 812             },
 813
 814           "linkPorts": [
 815
 816             {
 817               "resourceHandle":
 818
 819               {
 820                 "vimId": "1",
 821                 "resourceId": "2121"
 822
 823               },
 824
 825               "cpInstanceId": "1"
 826
 827             }
 828
 829           ]
 830
 831         }
 832
 833       ],
 834
 835       "monitoringParameters": {...},
 836       "localizationLanguage": "en\_US",
 837       "vimInfo": [
 838
 839         {
 840           "vimInfoId": "1",
 841           "vimId": "1",
 842           "interfaceInfo": {
 843
 844             "vimType": "vim",
 845             "apiVersion": "v2",
 846             "protocolType": "http"
 847
 848           },
 849
 850           "accessInfo": {
 851
 852               "tenant": "tenant\_vCPE",
 853               "username": "vCPE",
 854               "password": "vCPE\_321"
 855
 856           },
 857
 858         "interfaceEndpoint": "http://10.43.21.105:80/"
 859
 860       }
 861
 862     ],
 863     "vnfcResourceInfo": [
 864
 865       {
 866         "vnfcInstanceId": "vm1",
 867         "vduId": "vdu1",
 868         "computeResource": {
 869
 870           "vimId": "1",
 871           "resourceId": "3333"
 872
 873         },
 874
 875         "storageResourceIds": [ "storage1"
 876         ]
 877
 878       }
 879
 880     ],
 881
 882     "virtualLinkResourceInfo": [
 883
 884       {
 885         "virtualLinkInstanceId": "vl01",
 886         "virtualLinkDescId": "vl01",
 887         "networkResource": {
 888
 889           "vimId": "1",
 890           "resourceId": "4444"
 891
 892         }
 893
 894       }
 895
 896     ],
 897     "virtualStorageResourceInfo": [
 898
 899     {
 900       "virtualStorageInstanceId": "storage1",
 901       "virtualStorageDescId":"storage1",
 902       "storageResource": {
 903
 904         "vimId": "1",
 905         "resourceId": "555"
 906
 907       }
 908
 909     }
 910
 911     ]
 912
 913   },
 914   "metadata": {...},
 915   "extensions": {...}
 916
 917  }
 918
 919 ]
 920
 921 **3.5.3 Response Code**
 922
 923 +-----------+-----------------------+----------------------------------+
 924 | Code      | Meaning               |     Description                  |
 925 +===========+=======================+==================================+
 926 | 200       | Ok                    |     The request has succeeded.   |
 927 +-----------+-----------------------+----------------------------------+
 928 | 4xx/5xx   | <name from RFC7231>   |     <description>                |
 929 +-----------+-----------------------+----------------------------------+
 930
 931 **3.6 Query single VNF**
 932 ------------------------
 933 +---------------------+------------------------------------------------------------------------------+
 934 |     If Definition   | Description                                                                  |
 935 +=====================+==============================================================================+
 936 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf_instances/{vnfInstanceId}    |
 937 +---------------------+------------------------------------------------------------------------------+
 938 |     Operation       | GET                                                                          |
 939 +---------------------+------------------------------------------------------------------------------+
 940 |     Direction       | NFVO->VNFMLCM                                                                |
 941 +---------------------+------------------------------------------------------------------------------+
 942
 943 **3.6.1 Request**
 944
 945 +-------------+-------------+---------------+---------------+---------------+
 946 | Parameter   | Qualifier   | Cardinality   |     Content   | Description   |
 947 +=============+=============+===============+===============+===============+
 948 | n/a         |             |               |               |               |
 949 +-------------+-------------+---------------+---------------+---------------+
 950
 951 **3.6.2 Response**
 952
 953 +-------------------+-------------+---------------+------------------------+---------------------------------------+
 954 | Parameter         | Qualifier   | Cardinality   |     Content            | Description                           |
 955 +===================+=============+===============+========================+=======================================+
 956 | vnfInstanceInfo   | M           | 1             |     VnfInstanceI nfo   | The information of the VNF instance   |
 957 +-------------------+-------------+---------------+------------------------+---------------------------------------+
 958 +-------------------+-------------+---------------+------------------------+---------------------------------------+
 959
 960 **3.6.3 Response Code**
 961
 962 +-----------+-----------------------+----------------------------------+
 963 | Code      | Meaning               |     Description                  |
 964 +===========+=======================+==================================+
 965 | 200       | Ok                    |     The request has succeeded.   |
 966 +-----------+-----------------------+----------------------------------+
 967 | 4xx/5xx   | <name from RFC7231>   |     <description>                |
 968 +-----------+-----------------------+----------------------------------+
 969
 970     {
 971
 972     "vnfInstanceId": "1",
 973     "vnfInstanceName": "vFW\_01",
 974     "vnfInstanceDescription": "vFW in Nanjing TIC Edge",
 975     "onboardedVnfPkgInfoId": "1",
 976     "vnfdId": "zte\_vFW\_51610",
 977     "vnfdVersion": "V1.0",
 978     "vnfSoftwareVersion": "V1.0",
 979     "vnfProvider": "ZTE",
 980     "vnfProductName": "vFW",
 981     "vnfConfigurableProperties": {...},
 982     "instantiationState": "INSTANTIATED",
 983     "instantiatedVnfInfo": {
 984     "flavourId": "1",
 985     "vnfState": "STARTED",
 986     "scaleStatus": [
 987
 988     {
 989       "aspectId": "aspect1",
 990       "scaleLevel": 1
 991
 992     }
 993
 994     ],
 995
 996     "extCpInfo": [
 997
 998     {
 999     "cpInstanceId": "1",
1000     "cpdId": "1", "addresses": [
1001
1002     {
1003       "addressType": "MAC",
1004       "l2AddressData": "00:f3:43:20:a2:a3"
1005
1006     },
1007
1008     {
1009       "addressType": "IP",
1010       "l3AddressData": {
1011
1012         "iPAddressType": "IPv4",
1013         "address": "192.168.104.2"
1014
1015       }
1016
1017     }
1018
1019     ]
1020
1021   }
1022
1023   ],
1024
1025     "extVirtualLink": [
1026
1027     {
1028       "extVirtualLinkId": "extvl1",
1029       "resourceHandle": {
1030
1031         "vimId": "1",
1032         "resourceId": "1111"
1033
1034       },
1035
1036     "linkPorts": [
1037
1038     {
1039       "resourceHandle":
1040
1041       {
1042         "vimId": "1",
1043         "resourceId": "2121"
1044
1045       },
1046       "cpInstanceId": "1"
1047
1048     }
1049
1050     ]
1051
1052     }
1053
1054     ],
1055
1056     "monitoringParameters": {...},
1057     "localizationLanguage": "en\_US",
1058     "vimInfo": [
1059
1060     {
1061       "vimInfoId": "1",
1062       "vimId": "1",
1063       "interfaceInfo": {
1064
1065         "vimType": "vim",
1066         "apiVersion": "v2",
1067         "protocolType": "http"
1068
1069     },
1070
1071     "accessInfo": {
1072
1073       "tenant": "tenant\_vCPE",
1074       "username": "vCPE",
1075       "password": "vCPE\_321"
1076
1077     },
1078     "interfaceEndpoint": "http://10.43.21.105:80/"
1079
1080     }
1081
1082   ],
1083
1084     "vnfcResourceInfo": [
1085
1086       {
1087         "vnfcInstanceId": "vm1",
1088         "vduId": "vdu1",
1089         "computeResource": {
1090
1091           "vimId": "1",
1092           "resourceId": "3333"
1093
1094       },
1095
1096       "storageResourceIds": [ "storage1"
1097       ]
1098
1099       }
1100
1101     ],
1102
1103     "virtualLinkResourceInfo": [
1104
1105       {
1106         "virtualLinkInstanceId": "vl01",
1107         "virtualLinkDescId": "vl01",
1108         "networkResource": {
1109
1110           "vimId": "1",
1111           "resourceId": "4444"
1112
1113          }
1114
1115       }
1116
1117     ],
1118
1119     "virtualStorageResourceInfo": [
1120
1121     {
1122       "virtualStorageInstanceId": "storage1",
1123       "virtualStorageDescId": "storage1",
1124       "storageResource": {
1125
1126         "vimId": "1",
1127         "resourceId": "555"
1128
1129       }
1130
1131     }
1132
1133     ]
1134
1135    },
1136     "metadata": {...},
1137     "extensions": {...}
1138
1139   }
1140
1141 **3.7 Get Operation Status**
1142 ------------------------------
1143 +---------------------+-------------------------------------------------------------------------------------------------+
1144 |     If Definition   | Description                                                                                     |
1145 +=====================+=================================================================================================+
1146 |     URI             | http(s)://[hostname][:port]/api/vnflcm/v1/vnf\_lc\_ops/{vnfLcOpId}&response Id={responseId}   |
1147 +---------------------+-------------------------------------------------------------------------------------------------+
1148 |     Operation       | GET                                                                                             |
1149 +---------------------+-------------------------------------------------------------------------------------------------+
1150 |     Direction       | NFVO->GVNFM                                                                                     |
1151 +---------------------+-------------------------------------------------------------------------------------------------+
1152
1153 **3.7.1 Request**
1154
1155     None
1156
1157 **3.7.2 Response**
1158
1159 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1160 | Parameter          | Qualifier   | Cardinality   | Content   | Description                                                                      |
1161 +====================+=============+===============+===========+==================================================================================+
1162 | vnfLcOpId          | M           | 1             | String    | Identifier of a VNF lifecycle operation occurrence                               |
1163 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1164 | vnfInstanceId      | M           | 1             | String    | Identifier of the VNF instance to which the operation applies                    |
1165 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1166 | lcmOperationType   | M           | 1             | ENUM      | Type of the actual LCM operation represented by this lcm operation occurrence.   |
1167 |                    |             |               |           |                                                                                  |
1168 |                    |             |               |           | Permitted values:                                                                |
1169 |                    |             |               |           |                                                                                  |
1170 |                    |             |               |           | -  INSTANTIATE:the                                                               |
1171 |                    |             |               |           |                                                                                  |
1172 |                    |             |               |           |     Instantiate VNF LCM operation.                                               |
1173 |                    |             |               |           |                                                                                  |
1174 |                    |             |               |           | -  SCALE: the Scale VNF LCM operation.                                           |
1175 |                    |             |               |           |                                                                                  |
1176 |                    |             |               |           | -  SCALE\_TO\_LEVEL: the                                                         |
1177 |                    |             |               |           |                                                                                  |
1178 |                    |             |               |           |     Scale VNF to Level LCM operation.                                            |
1179 |                    |             |               |           |                                                                                  |
1180 |                    |             |               |           | -  CHANGE\_FLAVOUR:                                                              |
1181 |                    |             |               |           |                                                                                  |
1182 |                    |             |               |           |     the Change VNF Flavour LCM operation.                                        |
1183 |                    |             |               |           |                                                                                  |
1184 |                    |             |               |           | -  TERMINATE: the                                                                |
1185 |                    |             |               |           |                                                                                  |
1186 |                    |             |               |           |     Terminate VNF LCM operation.                                                 |
1187 |                    |             |               |           |                                                                                  |
1188 |                    |             |               |           | -  HEAL: the Heal VNF LCM operation.                                             |
1189 |                    |             |               |           |                                                                                  |
1190 |                    |             |               |           | -  OPERATE: the Operate VNF LCM operation.                                       |
1191 |                    |             |               |           |                                                                                  |
1192 |                    |             |               |           | -  CHANGE\_EXT\_VLS: the                                                         |
1193 |                    |             |               |           |                                                                                  |
1194 |                    |             |               |           |     Change VNF external VLs LCM operation. (Reserved)                            |
1195 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1196 | startTime          | M           | 1             | String    | Date-time of the start of the operation.                                         |
1197 |                    |             |               |           |                                                                                  |
1198 |                    |             |               |           | Representation: String formatted according to RFC 3339 [13]                      |
1199 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1200 | responseDescriptor | M           | 1             | VnfLcOp   | Including:responseId,progress,statusstatusDescription                            |
1201 |                    |             |               | Response  |                                                                                  |
1202 |                    |             |               | Descriptor| ,errorCode,responseHistoryList                                                   |
1203 +--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+
1204
1205     **VnfLcOpResponseDescriptor:**
1206
1207 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1208 |     Attribute             |     Qualifier   |     Cardinalit y   |     Content   |     Description                                           |
1209 +===========================+=================+====================+===============+===========================================================+
1210 |     responseId            |     M           |     1              |     Integer   |     Response Identifier                                   |
1211 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1212 |     progress              |     M           |     1              |     Integer   |     progress (1-100)                                      |
1213 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1214 |     lcmOperationStatus    |     M           |     1              |     ENUM      |     Status of a VNF lifecycle operation occurrence        |
1215 |                           |                 |                    |               |                                                           |
1216 |                           |                 |                    |               |     Permitted values:                                     |
1217 |                           |                 |                    |               |                                                           |
1218 |                           |                 |                    |               | -  STARTING: The operation is starting..                  |
1219 |                           |                 |                    |               |                                                           |
1220 |                           |                 |                    |               | -  PROCESSING: The operation is                           |
1221 |                           |                 |                    |               |     currently in execution.                               |
1222 |                           |                 |                    |               |                                                           |
1223 |                           |                 |                    |               | -  COMPLETED: The operation has completed successfully.   |
1224 |                           |                 |                    |               |                                                           |
1225 |                           |                 |                    |               | -  FAILED: The operation has failed and it cannot be      |
1226 |                           |                 |                    |               |            retried or rolled back, as it is determined    |
1227 |                           |                 |                    |               |            that such action won't succeed.                |
1228 |                           |                 |                    |               | -  FAILED\_TEMP: The operation has failed and execution   |
1229 |                           |                 |                    |               |             has stopped, but the execution of the         |
1230 |                           |                 |                    |               |             operation is not considered to be closed.     |
1231 |                           |                 |                    |               |                                                           |
1232 |                           |                 |                    |               |            (Reserved)                                     |
1233 |                           |                 |                    |               |                                                           |
1234 |                           |                 |                    |               | -  ROLLING\_BACK: The operation is currently being rolled |
1235 |                           |                 |                    |               |                   back. (Reserved)                        |
1236 |                           |                 |                    |               |                                                           |
1237 |                           |                 |                    |               | -  ROLLED\_BACK: The state of the VNF prior to the        |
1238 |                           |                 |                    |               |              original operation invocation has been       |
1239 |                           |                 |                    |               |                                                           |
1240 |                           |                 |                    |               |             restored as closely as possible. (Reserved)   |
1241 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1242 |    statusDescripti on     |     O           |     0..1           | String        |     Status Description of a VNF lifecycle operation       |
1243 |                           |                 |                    |               |     occurrence                                            |
1244 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1245 |    errorCode              |     O           |     0..1           | Integer       |     Errorcode                                             |
1246 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1247 |    responseHistor yList   |     O           |     0..N           | VnfLcOpDetail |     History Response Messages from the requested          |
1248 |                           |                 |                    |               |     responseId to lastest one.                            |
1249 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1250
1251     **VnfLcOpDetail:**
1252
1253 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1254 |     Attribute             |     Qualifier   |     Cardinalit y   |     Content   |     Description                                           |
1255 +===========================+=================+====================+===============+===========================================================+
1256 |     responseId            |     M           |     1              |     Integer   |     Response Identifier                                   |
1257 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1258 |     progress              |     M           |     1              |     Integer   |     progress (1-100)                                      |
1259 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1260 |     lcmOperationS tatus   |     M           |     1              |     ENUM      |     Status of a VNF lifecycle operation occurrence        |
1261 |                           |                 |                    |               |                                                           |
1262 |                           |                 |                    |               |     Permitted values:                                     |
1263 |                           |                 |                    |               |                                                           |
1264 |                           |                 |                    |               | -  STARTING: The operation is starting..                  |
1265 |                           |                 |                    |               |                                                           |
1266 |                           |                 |                    |               | -  PROCESSING: The operation is currently in execution.   |
1267 |                           |                 |                    |               |                                                           |
1268 |                           |                 |                    |               | -  COMPLETED: The operation has completed successfully.   |
1269 |                           |                 |                    |               |                                                           |
1270 |                           |                 |                    |               | -  FAILED: The operation has failed and it                |
1271 |                           |                 |                    |               |     cannot be retried or rolled back, as it is            |
1272 |                           |                 |                    |               |     determined that such action won't succeed.            |
1273 |                           |                 |                    |               |                                                           |
1274 |                           |                 |                    |               |                                                           |
1275 |                           |                 |                    |               | -  FAILED\_TEMP: The operation has failed and execution   |
1276 |                           |                 |                    |               |       has stopped, but the execution of the operation     |
1277 |                           |                 |                    |               |       is not considered to be closed. (Reserved)          |
1278 |                           |                 |                    |               |                                                           |
1279 |                           |                 |                    |               | -  ROLLING\_BACK: The operation is currently being        |
1280 |                           |                 |                    |               |        rolled back. (Reserved)                            |
1281 |                           |                 |                    |               |                                                           |
1282 |                           |                 |                    |               |                                                           |
1283 |                           |                 |                    |               | -  ROLLED\_BACK: The state of the VNF prior to the        |
1284 |                           |                 |                    |               |        original operation invocation has been restored    |
1285 |                           |                 |                    |               |        as closely as possible. (Reserved)                 |
1286 |                           |                 |                    |               |                                                           |
1287 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1288 |     statusDescription     |     O           |     0..1           |     String    | Status Description of a VNF lifecycle operation occurrence|
1289 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1290 |     errorCode             |     O           |     0..1           |     Integer   | Errorcode                                                 |
1291 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+
1292
1293     {
1294
1295     "vnfLcOpId": "1234566",
1296
1297     "vnfInstanceId": "1",
1298     "lcmOperationType": "INSTANTIATE",
1299
1300     "startTime": "2017-01-01T12:00:27.87+00:20",
1301
1302     "responseDescriptor": {
1303
1304         "responseId": 3,
1305         "progress": 40,
1306         "lcmOperationStatus": "PROCESSING",
1307         "statusDescription": "OMC VMs are decommissioned in VIM",
1308         "errorCode": null,
1309         "responseHistoryList": [
1310
1311          {
1312            "responseId": 1,
1313            "progress": 40,
1314            "lcmOperationStatus": "PROCESSING",
1315            "statusDescription": "OMC VMs are decommissioned in VIM",
1316            "errorCode": null
1317
1318          },
1319          {
1320
1321            "responseId": 2,
1322            "progress": 41,
1323            "lcmOperationStatus": "PROCESSING",
1324            "statusDescription": "OMC VMs are decommissioned in VIM",
1325            "errorCode": null
1326
1327          }
1328
1329         ]
1330
1331       }
1332
1333     }
1334
1335 **3.7.3 Response Code**
1336
1337 +-----------+-----------------------+----------------------------------+
1338 | Code      | Meaning               |     Description                  |
1339 +===========+=======================+==================================+
1340 | 200       | Ok                    |     The request has succeeded.   |
1341 +-----------+-----------------------+----------------------------------+
1342 | 4xx/5xx   | <name from RFC7231>   |     <description>                |
1343 +-----------+-----------------------+----------------------------------+
1344
1345 **4.Interfaces provided by VNF**\ (Ve-Vnfm-vnf)
1346 ===============================================
1347
1348 **4.1 Set Initial Configuration**
1349 ---------------------------------
1350
1351 +---------------------+---------------------------------------------+
1352 |     If Definition   | Description                                 |
1353 +=====================+=============================================+
1354 |     URI             | http(s)://[hostname][:port]/configuration   |
1355 +---------------------+---------------------------------------------+
1356 |     Operation       | POST                                        |
1357 +---------------------+---------------------------------------------+
1358 |     Direction       | VNFM->VNF                                   |
1359 +---------------------+---------------------------------------------+
1360
1361     **4.1.1Request**
1362
1363 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1364 | Parameter               | Qualifier   | Cardinality   |     Content              | Description                                                                  |
1365 +=========================+=============+===============+==========================+==============================================================================+
1366 | vnfInstanceId           | M           | 1             |     Identifier           | Identifier of the VNF instance which the VNF to set initial configuration.   |
1367 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1368 | vnfConfigurationData    | O           | 0..1          |     VnfConfigur ation    | Configuration data for the VNF instance.                                     |
1369 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1370 | vnfcConfigurationData   | O           | 0..N          |     VnfcConfigu ration   | Configuration data for VNFC instances.                                       |
1371 +-------------------------+-------------+---------------+--------------------------+------------------------------------------------------------------------------+
1372
1373 **VnfConfiguration:**
1374
1375 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1376 |     Attribute         |     Qualifier   |     Cardinalit y   |     Content                      |     Description                                                              |
1377 +=======================+=================+====================+==================================+==============================================================================+
1378 |     cp                |     O           |     0..N           |     CpConfiguratio n             |     External CPs                                                             |
1379 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1380 |     vnfSpecificData   |     O           |     0..1           |     VnfConfigurabl eProperties   |     Configuration object containing values of VNF configurable properties.   |
1381 +-----------------------+-----------------+--------------------+----------------------------------+------------------------------------------------------------------------------+
1382
1383 **CpConfiguration:**
1384
1385 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1386 |     Attribute   | Qualifier   |     Cardinalit y   | Content      | Description                                                                                           |
1387 +=================+=============+====================+==============+=======================================================================================================+
1388 |     cpId        | M           |     1              | Identifier   | Uniquely identifies a CP instance within the namespace of a specific VNF instance or VNFC instance.   |
1389 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1390 |     cpdId       | M           |     1              | Identifier   | Uniquely identifies a type of CP instance within the namespace of a VNFD.                             |
1391 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1392 |     cpAddress   | M           |     1..N           | CpAddress    | Address and Port assigned to the CP.                                                                  |
1393 +-----------------+-------------+--------------------+--------------+-------------------------------------------------------------------------------------------------------+
1394
1395     **CpAddress:**
1396
1397 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1398 |     Attribute            | Qualifier   |     Cardinalit y   | Content           | Description                                                                                                                                   |
1399 +==========================+=============+====================+===================+===============================================================================================================================================+
1400 |     address              | M           |     0..N           | NetworkAddre ss   | The address assigned to the CP instance (e.g. IP address, MAC address, etc.). It shall be provided for configuring a fixed address.           |
1401 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1402 |     useDynamicAddress    | M           |     0..1           | ENUM              | It determines whether an address shall be assigned dynamically. It shall be provided if a dynamic address needs to be configured on the CP.   |
1403 |                          |             |                    |                   |                                                                                                                                               |
1404 |                          |             |                    |                   | A cardinality of "0" indicates that no dynamic address needs to be configured on the CP.                                                      |
1405 |                          |             |                    |                   |                                                                                                                                               |
1406 |                          |             |                    |                   | Permitted values:                                                                                                                             |
1407 |                          |             |                    |                   |                                                                                                                                               |
1408 |                          |             |                    |                   | -  TRUE                                                                                                                                       |
1409 |                          |             |                    |                   |                                                                                                                                               |
1410 |                          |             |                    |                   | -  FALSE                                                                                                                                      |
1411 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1412 |     port                 | M           |     0..1           | Not specified     | The port assigned to the CP instance (e.g. IP port number, Ethernet port number, etc.).                                                       |
1413 |                          |             |                    |                   |                                                                                                                                               |
1414 |                          |             |                    |                   | Reserved                                                                                                                                      |
1415 +--------------------------+-------------+--------------------+-------------------+-----------------------------------------------------------------------------------------------------------------------------------------------+
1416
1417     **VnfConfigurableProperties:**
1418
1419 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1420 |     Attribute      | Qualifier | Cardinality  | Content| Description                                                                                   |
1421 +====================+===========+==============+========+===============================================================================================+
1422 |     autoScalable   | O         |       0..1   | ENUM   | It permits to enable (TRUE) / disable (FALSE) the auto-scaling functionality.                 |
1423 |                    |           |              |        |                                                                                               |
1424 |                    |           |              |        | A cardinality of "0" indicates that configuring this present VNF property is not supported.   |
1425 |                    |           |              |        |                                                                                               |
1426 |                    |           |              |        | Permitted values:                                                                             |
1427 |                    |           |              |        |                                                                                               |
1428 |                    |           |              |        | -  TRUE                                                                                       |
1429 |                    |           |              |        |                                                                                               |
1430 |                    |           |              |        | -  FALSE                                                                                      |
1431 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1432 |     autoHealable   | O         |       0..1   | ENUM   | It permits to enable (TRUE) / disable (FALSE) the auto-healing functionality.                 |
1433 |                    |           |              |        |                                                                                               |
1434 |                    |           |              |        | A cardinality of "0" indicates that configuring this present VNF property is not supported.   |
1435 |                    |           |              |        |                                                                                               |
1436 |                    |           |              |        | Permitted values:                                                                             |
1437 |                    |           |              |        |                                                                                               |
1438 |                    |           |              |        | -  TRUE                                                                                       |
1439 |                    |           |              |        |                                                                                               |
1440 |                    |           |              |        | -  FALSE                                                                                      |
1441 +--------------------+-----------+--------------+--------+-----------------------------------------------------------------------------------------------+
1442
1443 **VnfcConfiguration:**
1444
1445 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1446 |     Attribute          | Qualifier   |     Cardinalit y   | Content            | Description                                                                            |
1447 +========================+=============+====================+====================+========================================================================================+
1448 |     vnfcId             | M           |     1              | Identifier         | Uniquely identifies a VNFC instance within the namespace of a specific VNF instance.   |
1449 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1450 |     cp                 | O           |     0..N           | CpConfiguratio n   | Internal CPs.                                                                          |
1451 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1452 |     vnfcSpecificData   | O           |     0..1           | KeyValuePair       | Configuration object containing values of VNFC configurable properties                 |
1453 +------------------------+-------------+--------------------+--------------------+----------------------------------------------------------------------------------------+
1454
1455     {
1456
1457     "vnfInstanceId": "1",
1458     "vnfConfigurationData": {
1459
1460       "cp": [
1461
1462         {
1463           "cpId": "cp-1",
1464           "cpdId": "cpd-a",
1465           "cpAddress": [
1466
1467             {
1468               "addresses": [
1469
1470                 {
1471                   "addressType": "MAC",
1472                   "l2AddressData": "00:f3:43:20:a2:a3"
1473
1474                 },
1475                 {
1476
1477                   "addressType": "IP",
1478                     "l3AddressData": {
1479
1480                       "iPAddressType": "IPv4",
1481                       "iPAddress": "192.168.104.2"
1482
1483                     }
1484
1485                 }
1486
1487                 ],
1488
1489               "useDynamicAddress": "FALSE"
1490
1491             }
1492
1493           ]
1494
1495         }
1496
1497       ],
1498
1499     "vnfSpecificData": {
1500
1501         "autoScalable": "FALSE",
1502         "autoHealable": "FALSE"
1503
1504     }
1505
1506   },
1507
1508   "vnfcConfigurationData":
1509     {
1510         "vnfcId": "vnfc-1",
1511         "cp": [
1512
1513           {
1514             "cpId": "cp-11",
1515             "cpdId": "cpd-1a",
1516             "cpAddress": [
1517
1518               {
1519                 "addresses": [
1520
1521                   {
1522                     "addressType": "MAC",
1523                     "l2AddressData": "00:f3:43:21:a2:a3"
1524
1525                   },
1526                   {
1527
1528                     "addressType": "IP",
1529                     "l3AddressData": {
1530
1531                       "iPAddressType": "IPv4",
1532                       "iPAddress": "192.168.105.2"
1533
1534                     }
1535
1536                   }
1537
1538                 ],
1539                 "useDynamicAddress": "FALSE"
1540
1541               }
1542
1543             ]
1544
1545           }
1546
1547         ],
1548
1549       "vnfcSpecificData": {}
1550
1551     }
1552
1553   }
1554
1555
1556     **4.1.2 Response**
1557
1558 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1559 | Parameter             | Qualifier   | Cardinality   |     Content       | Description                     |
1560 +=======================+=============+===============+===================+=================================+
1561 | vnfConfigurationData  | O           | 0..1          |  VnfConfiguration | Correspond to the               |
1562 |                       |             |               |                   | vnfConfigurationData in the     |
1563 |                       |             |               |                   | input information elements of   |
1564 |                       |             |               |                   | the SetInitialConfiguration     |
1565 |                       |             |               |                   | operation if it has.            |
1566 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1567 | vnfcConfigurationDa   | O           | 0..N          |  VnfConfiguration | Correspond to the               |
1568 | ta                    |             |               |                   | vnfcConfigurationData in the    |
1569 |                       |             |               |                   | input information elements of   |
1570 |                       |             |               |                   | the SetInitialConfiguration     |
1571 |                       |             |               |                   | operation if it has.            |
1572 +-----------------------+-------------+---------------+-------------------+---------------------------------+
1573
1574     {
1575       "vnfConfigurationData": {
1576
1577         "cp": [
1578
1579           {
1580             "cpId": "cp-1",
1581             "cpdId": "cpd-a", "cpAddress": [
1582
1583               {
1584                 "addresses": [
1585
1586                   {
1587                     "addressType": "MAC",
1588                     "l2AddressData": "00:f3:43:20:a2:a3"
1589
1590                   },
1591                   {
1592
1593                     "addressType": "IP",
1594                     "l3AddressData": {
1595
1596                       "iPAddressType": "IPv4",
1597                       "iPAddress": "192.168.104.2"
1598
1599                     }
1600
1601                   }
1602
1603                 ],
1604
1605                 "useDynamicAddress": "FALSE"
1606
1607               }
1608
1609             ]
1610
1611           }
1612
1613         ],
1614         "vnfSpecificData": {
1615
1616             "autoScalable": "FALSE",
1617             "autoHealable": "FALSE",
1618             …
1619
1620         }
1621
1622       },
1623
1624       "vnfcConfigurationData": {
1625
1626           "vnfcId": "vnfc-1",
1627           "cp": [
1628
1629             {
1630               "cpId": "cp-11",
1631               "cpdId": "cpd-1a",
1632               "cpAddress": [
1633
1634                 {
1635                   "addresses": [
1636
1637                     {
1638
1639                       "addressType": "MAC",
1640                       "l2AddressData": "00:f3:43:21:a2:a3"
1641
1642                     },
1643                     {
1644
1645                       "addressType": "IP",
1646                       "l3AddressData": {
1647
1648                         "iPAddressType": "IPv4",
1649                         "iPAddress": "192.168.105.2"
1650
1651                        }
1652
1653                     }
1654
1655                   ],
1656
1657                   "useDynamicAddress": "FALSE"
1658
1659                 }
1660
1661               ]
1662
1663             }
1664
1665           ],
1666
1667       "vnfcSpecificData": {…}
1668
1669     }
1670
1671   }
1672
1673     **4.1.3Response Code**
1674
1675 +-----------+-----------------------+-----------------------------------------------------------+
1676 | Code      | Meaning               |     Description                                           |
1677 +===========+=======================+===========================================================+
1678 | 201       | Created               |     A VNF Instance identifier was created successfully.   |
1679 +-----------+-----------------------+-----------------------------------------------------------+
1680 | 4xx/5xx   | <name from RFC7231>   |     <description>                                         |
1681 +-----------+-----------------------+-----------------------------------------------------------+
1682
1683 .. |image0| image:: VNFM_API.png
1684    :width: 5.07047in
1685    :height: 5.6320in