Code Review / vfc / nfvo / lcm.git / blobdiff
? search:
summary | shortlog | log | commit | commitdiff | review | tree
raw | inline | side by side
update the api files
[vfc/nfvo/lcm.git] / docs / APIs / VNFLCM_API / VNFLCM_API.rst
diff --git a/docs/APIs/VNFLCM_API/VNFLCM_API.rst b/docs/APIs/VNFLCM_API/VNFLCM_API.rst
index 9b277d4..c6db432 100644 (file)
--- a/docs/APIs/VNFLCM_API/VNFLCM_API.rst
+++ b/docs/APIs/VNFLCM_API/VNFLCM_API.rst
@@ -26,6 +26,7 @@
 +------------------------+-----------------------------------------------------+\r
 |     VNF                |     Virtual Network Function                        |\r
 +------------------------+-----------------------------------------------------+\r
+\r
 Table 2-1 abbreviations\r
 \r
 **3. Interfaces provided by VNFM**  (Or-Vnfm/Ve-Vnfm-vnf) \r
@@ -67,7 +68,8 @@ Table 2-1 abbreviations
     {\r
       "vnfdId": "zte\_vFW\_51610", \r
       "vnfInstanceName": "vFW\_01",\r
-      " vnfInstanceDescription": " vFW in Nanjing TIC Edge"\r
+      "vnfInstanceDescription": " vFW in Nanjing TIC Edge"\r
+\r
     }\r
 \r
 **3.1.2 Response**\r
@@ -80,6 +82,7 @@ Table 2-1 abbreviations
 \r
     {\r
       "vnfInstanceId": "1"\r
+\r
     }\r
 \r
 **3.1.3 Response Code**\r
@@ -133,8 +136,8 @@ Table 2-1 abbreviations
 | 4xx/5xx   | <name from RFC7231>   |     <description>                                                                            |\r
 +-----------+-----------------------+----------------------------------------------------------------------------------------------+\r
 \r
-3.3 Instantiate VNF\r
--------------------\r
+**3.3 Instantiate VNF**\r
+-----------------------\r
 \r
 +---------------------+-------------------------------------------------------------------------------------------+\r
 |     If Definition   | Description                                                                               |\r
@@ -203,8 +206,8 @@ Table 2-1 abbreviations
 | extCps           | M         | 1..N        | VnfExtCpData    | External CPs of the VNF to be connected to this external VL.                     |\r
 +------------------+-----------+-------------+-----------------+----------------------------------------------------------------------------------+\r
 \r
-\r
     **VimInfo:**\r
+\r
 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+\r
 | Attribute       | Qualifier | Cardinality | Content      | Description                                                                                                                              |\r
 +=================+===========+=============+==============+==========================================================================================================================================+\r
@@ -222,6 +225,7 @@ Table 2-1 abbreviations
 +-----------------+-----------+-------------+--------------+------------------------------------------------------------------------------------------------------------------------------------------+\r
 \r
     **interfaceInfo:**\r
+\r
 +------------------+---------------+--------------------------------------+\r
 | **Key Define**   | **Content**   | **Description**                      |\r
 +==================+===============+======================================+\r
@@ -233,6 +237,7 @@ Table 2-1 abbreviations
 +------------------+---------------+--------------------------------------+\r
 \r
     **accessInfo:**\r
+\r
 +------------------+---------------+--------------------------+\r
 | **Key Define**   | **Content**   | **Description**          |\r
 +==================+===============+==========================+\r
@@ -252,7 +257,7 @@ Table 2-1 abbreviations
 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+\r
 | addresses              |     O               | 0..N                  | NetworkAddress     | List of (fixed) network addresses that                    |\r
 |                        |                     |                       |                    | need to be configured on the CP. This attribute shall     |\r
-|                        |                     |                       |                    |  be present if fixed addresses need to be configured.     |\r
+|                        |                     |                       |                    | be present if fixed addresses need to be configured.      |\r
 +------------------------+---------------------+-----------------------+--------------------+-----------------------------------------------------------+\r
 | numDynamicAddre sses   |     O               | 0..1                  | Integer            | Number of network addresses to be assigned dynamically.   |\r
 |                        |                     |                       |                    | This attribute shall be present if dynamic                |\r
@@ -303,48 +308,69 @@ Table 2-1 abbreviations
       "flavourId": "flavour\_1", \r
       "instantiationLevelId":"instantiationLevel\_1", \r
       "extVirtualLinks": [\r
-        {\r
-          "vlInstanceId": "1",\r
+\r
+        {  "vlInstanceId": "1",\r
            "vim": {\r
             "vimInfoId": "1",\r
             "vimId": "1", \r
             "interfaceInfo": {\r
+\r
               "vimType": "vim",\r
               "apiVersion": "v2",\r
               "protocolType": "http"\r
+\r
             },\r
             "accessInfo": {\r
+\r
               "tenant": "tenant\_vCPE", \r
               "username": "vCPE", \r
               "password": "vCPE\_321"\r
+\r
             },\r
             "interfaceEndpoint": "http://10.43.21.105:80/"\r
+\r
         },\r
         "resourceId": "1246", \r
         "extCps": [\r
+\r
           {\r
             "cpdId": "11", "addresses": [\r
+\r
               {\r
                 "addressType": "MAC", \r
                 "l2AddressData": "00:f3:43:20:a2:a3"\r
+\r
               },\r
               {\r
+\r
                 "addressType": "IP", \r
                 "l3AddressData": {\r
+\r
                   "iPAddressType": "IPv4", \r
                   "iPAddress": "192.168.104.2"\r
+\r
                 }\r
+\r
               }\r
+\r
             ],\r
             "numDynamicAddresses": 0\r
-          }\r
+\r
+          },\r
+\r
+          ...\r
+\r
           ]\r
+\r
         }\r
+\r
       ],\r
 \r
       "localizationLanguage": "en\_US", "additionalParams": {...}\r
+\r
     }\r
 \r
+\r
 **3.3.2 Response**\r
 \r
 +-------------+-------------+---------------+------------------+---------------------------------------------------------+\r
@@ -360,6 +386,7 @@ Table 2-1 abbreviations
     }\r
 \r
     **3.3.3 Response Code**\r
+\r
 +-----------+-----------------------+------------------------------------------------------------------------------------------+\r
 | Code      | Meaning               |     Description                                                                          |\r
 +===========+=======================+==========================================================================================+\r
@@ -398,12 +425,13 @@ Table 2-1 abbreviations
 |                   |             |               |               |     will first arrange to take the VNF out of service after accepting   |\r
 |                   |             |               |               |     the request. Once the operation is successful or once the timer     |\r
 |                   |             |               |               |     value specified in the                                              |\r
+|                   |             |               |               |                                                                         |\r
 |                   |             |               |               |    “gracefulTerminationTime out” attribute expires, the VNFM will shut  |\r
 |                   |             |               |               |     down the VNF and release the resources.                             |\r
 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+\r
 | graceful          | O           | 0..1          |     Integer   | This attribute is only                                                  |\r
 | Termination       |             |               |               | applicable in case of graceful                                          |\r
-|  Timeout          |             |               |               | termination. It defines the                                             |\r
+| Timeout           |             |               |               | termination. It defines the                                             |\r
 |                   |             |               |               | time to wait for the VNF to be                                          |\r
 |                   |             |               |               | taken out of service before                                             |\r
 |                   |             |               |               | shutting down the VNF and                                               |\r
@@ -421,9 +449,11 @@ Table 2-1 abbreviations
 |                   |             |               |               | VNF and releasing the                                                   |\r
 |                   |             |               |               | resources.                                                              |\r
 +-------------------+-------------+---------------+---------------+-------------------------------------------------------------------------+\r
+\r
  {\r
     "terminationType": "GRACEFUL", \r
     "gracefulTerminationTimeout": 120\r
+\r
  }\r
 \r
 **3.4.2 Response**\r
@@ -436,6 +466,7 @@ Table 2-1 abbreviations
 \r
     {\r
       "vnfLcOpId": "2"\r
+\r
     }\r
 \r
 **3.4.3 Response Code**\r
@@ -727,109 +758,163 @@ Table 2-1 abbreviations
         "vnfConfigurableProperties": {...},\r
         "instantiationState": "INSTANTIATED", \r
         "instantiatedVnfInfo": {\r
+\r
           "flavourId": "1", \r
           "vnfState": "STARTED", \r
           "scaleStatus": [\r
+\r
             {\r
               "aspectId": "aspect1", \r
               "scaleLevel": 1\r
+\r
             }\r
+\r
           ],\r
+\r
         "extCpInfo": [\r
+\r
           {\r
             "cpInstanceId": "1",\r
             "cpdId": "1", "addresses": [\r
+\r
               {\r
                 "addressType": "MAC", \r
                 "l2AddressData": "00:f3:43:20:a2:a3"\r
+\r
               },\r
+\r
               {\r
                 "addressType": "IP", \r
                 "l3AddressData": {\r
+\r
                   "iPAddressType": "IPv4", \r
                   "address": "192.168.104.2"\r
+\r
                 }\r
+\r
               }\r
+\r
             ]\r
+\r
           }  \r
+\r
         ],\r
         "extVirtualLink": [\r
+\r
           {\r
             "extVirtualLinkId": "extvl1", \r
             "resourceHandle": {\r
+\r
               "vimId": "1",\r
               "resourceId": "1111"\r
+\r
             },\r
 \r
           "linkPorts": [\r
+\r
             {\r
               "resourceHandle": \r
+\r
               { \r
                 "vimId": "1",\r
                 "resourceId": "2121"\r
+\r
               },\r
+\r
               "cpInstanceId": "1"\r
+\r
             }\r
+\r
           ]\r
+\r
         }\r
+\r
       ],\r
 \r
       "monitoringParameters": {...}, \r
       "localizationLanguage": "en\_US",\r
       "vimInfo": [\r
+\r
         {\r
           "vimInfoId": "1",\r
           "vimId": "1", \r
           "interfaceInfo": {\r
+\r
             "vimType": "vim",\r
             "apiVersion": "v2", \r
             "protocolType": "http"\r
+\r
           },\r
+\r
           "accessInfo": {\r
+\r
               "tenant": "tenant\_vCPE", \r
               "username": "vCPE", \r
               "password": "vCPE\_321"\r
+\r
           },\r
 \r
         "interfaceEndpoint": "http://10.43.21.105:80/"\r
+\r
       }\r
+\r
     ],\r
     "vnfcResourceInfo": [\r
+\r
       {\r
         "vnfcInstanceId": "vm1", \r
         "vduId": "vdu1", \r
         "computeResource": {\r
+\r
           "vimId": "1",\r
           "resourceId": "3333"\r
+\r
         },\r
+\r
         "storageResourceIds": [ "storage1"\r
         ]\r
+\r
       }\r
+\r
     ],\r
+\r
     "virtualLinkResourceInfo": [\r
+\r
       {\r
         "virtualLinkInstanceId": "vl01", \r
         "virtualLinkDescId": "vl01",\r
         "networkResource": {\r
+\r
           "vimId": "1",\r
           "resourceId": "4444"\r
+\r
         }\r
+\r
       }\r
+\r
     ],\r
     "virtualStorageResourceInfo": [\r
+\r
     {\r
       "virtualStorageInstanceId": "storage1", \r
       "virtualStorageDescId":"storage1", \r
       "storageResource": {\r
+\r
         "vimId": "1",\r
         "resourceId": "555"\r
+\r
       }\r
+\r
     }\r
+\r
     ]\r
+\r
   },\r
   "metadata": {...},\r
   "extensions": {...}\r
+\r
  }\r
+\r
 ]\r
 \r
 **3.5.3 Response Code**\r
@@ -847,7 +932,7 @@ Table 2-1 abbreviations
 +---------------------+------------------------------------------------------------------------------+\r
 |     If Definition   | Description                                                                  |\r
 +=====================+==============================================================================+\r
-|     URI             | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId}   |\r
+|     URI             | http(s)://[hostname][:port]/gvnfmapi/lcm/v1/vnf_instances/{vnfInstanceId}    |\r
 +---------------------+------------------------------------------------------------------------------+\r
 |     Operation       | GET                                                                          |\r
 +---------------------+------------------------------------------------------------------------------+\r
@@ -898,110 +983,158 @@ Table 2-1 abbreviations
     "flavourId": "1", \r
     "vnfState": "STARTED", \r
     "scaleStatus": [\r
+\r
     {\r
       "aspectId": "aspect1", \r
       "scaleLevel": 1\r
+\r
     }\r
+\r
     ],\r
 \r
     "extCpInfo": [\r
+\r
     {\r
     "cpInstanceId": "1",\r
     "cpdId": "1", "addresses": [\r
+\r
     {\r
       "addressType": "MAC", \r
       "l2AddressData": "00:f3:43:20:a2:a3"\r
+\r
     },\r
 \r
     {\r
       "addressType": "IP", \r
       "l3AddressData": {\r
+\r
         "iPAddressType": "IPv4", \r
         "address": "192.168.104.2"\r
+\r
       }\r
+\r
     }\r
+\r
     ]\r
+\r
   }\r
+\r
   ],\r
 \r
     "extVirtualLink": [\r
+\r
     {\r
       "extVirtualLinkId": "extvl1", \r
       "resourceHandle": {\r
+\r
         "vimId": "1",\r
         "resourceId": "1111"\r
+\r
       },\r
+\r
     "linkPorts": [\r
+\r
     {\r
-      "resourceHandle": \r
+      "resourceHandle":\r
+ \r
       { \r
         "vimId": "1",\r
         "resourceId": "2121"\r
+\r
       },\r
       "cpInstanceId": "1"\r
+\r
     }\r
+\r
     ]\r
+\r
     }\r
+\r
     ],\r
 \r
     "monitoringParameters": {...}, \r
     "localizationLanguage": "en\_US",\r
     "vimInfo": [\r
+\r
     {\r
       "vimInfoId": "1",\r
       "vimId": "1", \r
       "interfaceInfo": {\r
+\r
         "vimType": "vim",\r
         "apiVersion": "v2", \r
         "protocolType": "http"\r
+\r
     },\r
+\r
     "accessInfo": {\r
+\r
       "tenant": "tenant\_vCPE", \r
       "username": "vCPE", \r
       "password": "vCPE\_321"\r
+\r
     },\r
     "interfaceEndpoint": "http://10.43.21.105:80/"\r
+\r
     }\r
+\r
   ],\r
 \r
     "vnfcResourceInfo": [\r
+\r
       {\r
         "vnfcInstanceId": "vm1", \r
         "vduId": "vdu1", \r
         "computeResource": {\r
+\r
           "vimId": "1",\r
           "resourceId": "3333"\r
+\r
       },\r
 \r
       "storageResourceIds": [ "storage1"\r
       ]\r
+\r
       }\r
+\r
     ],\r
 \r
     "virtualLinkResourceInfo": [\r
+\r
       {\r
         "virtualLinkInstanceId": "vl01", \r
         "virtualLinkDescId": "vl01",\r
         "networkResource": {\r
+\r
           "vimId": "1",\r
           "resourceId": "4444"\r
+\r
          }\r
+\r
       }\r
+\r
     ],\r
 \r
     "virtualStorageResourceInfo": [\r
+\r
     {\r
       "virtualStorageInstanceId": "storage1", \r
       "virtualStorageDescId": "storage1", \r
       "storageResource": {\r
+\r
         "vimId": "1",\r
         "resourceId": "555"\r
+\r
       }\r
+\r
     }\r
+\r
     ]\r
+\r
    },\r
     "metadata": {...},\r
     "extensions": {...}\r
+\r
   }\r
 \r
 **3.7 Get Operation Status**\r
@@ -1032,7 +1165,7 @@ Table 2-1 abbreviations
 | lcmOperationType   | M           | 1             | ENUM      | Type of the actual LCM operation represented by this lcm operation occurrence.   |\r
 |                    |             |               |           |                                                                                  |\r
 |                    |             |               |           | Permitted values:                                                                |\r
-+--------------------+-------------+---------------+-----------+----------------------------------------------------------------------------------+\r
+|                    |             |               |           |                                                                                  |\r
 |                    |             |               |           | -  INSTANTIATE:the                                                               |\r
 |                    |             |               |           |                                                                                  |\r
 |                    |             |               |           |     Instantiate VNF LCM operation.                                               |\r
@@ -1077,7 +1210,7 @@ Table 2-1 abbreviations
 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+\r
 |     progress              |     M           |     1              |     Integer   |     progress (1-100)                                      |\r
 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+\r
-|     lcmOperationS tatus   |     M           |     1              |     ENUM      |     Status of a VNF lifecycle operation occurrence        |\r
+|     lcmOperationStatus    |     M           |     1              |     ENUM      |     Status of a VNF lifecycle operation occurrence        |\r
 |                           |                 |                    |               |                                                           |\r
 |                           |                 |                    |               |     Permitted values:                                     |\r
 |                           |                 |                    |               |                                                           |\r
@@ -1094,13 +1227,16 @@ Table 2-1 abbreviations
 |                           |                 |                    |               | -  FAILED\_TEMP: The operation has failed and execution   |\r
 |                           |                 |                    |               |             has stopped, but the execution of the         |\r
 |                           |                 |                    |               |             operation is not considered to be closed.     |\r
+|                           |                 |                    |               |                                                           |\r
 |                           |                 |                    |               |            (Reserved)                                     |\r
+|                           |                 |                    |               |                                                           |\r
 |                           |                 |                    |               | -  ROLLING\_BACK: The operation is currently being rolled |\r
 |                           |                 |                    |               |                   back. (Reserved)                        |\r
 |                           |                 |                    |               |                                                           |\r
 |                           |                 |                    |               | -  ROLLED\_BACK: The state of the VNF prior to the        |\r
 |                           |                 |                    |               |              original operation invocation has been       |\r
-|                           |                 |                    |               |             restored as closely as possible. (Reserved)   |\r
+|                           |                 |                    |               |                                                           |\r
+|                           |                 |                    |               |             restored as closely as possible. (Reserved)   |    \r
 +---------------------------+-----------------+--------------------+---------------+-----------------------------------------------------------+\r
 |    statusDescripti on     |     O           |     0..1           | String        |     Status Description of a VNF lifecycle operation       |\r
 |                           |                 |                    |               |     occurrence                                            |\r
@@ -1162,29 +1298,37 @@ Table 2-1 abbreviations
 \r
     "startTime": "2017-01-01T12:00:27.87+00:20",\r
 \r
-    "responseDescriptor": { \r
+    "responseDescriptor": {\r
+ \r
         "responseId": 3,\r
         "progress": 40, \r
         "lcmOperationStatus": "PROCESSING",\r
         "statusDescription": "OMC VMs are decommissioned in VIM",\r
         "errorCode": null,\r
         "responseHistoryList": [\r
+\r
          {\r
            "responseId": 1,\r
            "progress": 40, \r
            "lcmOperationStatus": "PROCESSING",\r
            "statusDescription": "OMC VMs are decommissioned in VIM",\r
            "errorCode": null\r
+\r
          },\r
          {\r
+\r
            "responseId": 2,\r
            "progress": 41, \r
            "lcmOperationStatus": "PROCESSING",\r
            "statusDescription": "OMC VMs are decommissioned in VIM",\r
            "errorCode": null\r
+\r
          }\r
+\r
         ]\r
+\r
       }\r
+\r
     }\r
 \r
 **3.7.3 Response Code**\r
@@ -1201,7 +1345,7 @@ Table 2-1 abbreviations
 ===============================================\r
 \r
 **4.1 Set Initial Configuration**\r
------------------------------\r
+---------------------------------\r
 \r
 +---------------------+---------------------------------------------+\r
 |     If Definition   | Description                                 |\r
@@ -1311,68 +1455,105 @@ Table 2-1 abbreviations
 \r
     "vnfInstanceId": "1", \r
     "vnfConfigurationData": {\r
+\r
       "cp": [\r
+\r
         {\r
           "cpId": "cp-1",\r
           "cpdId": "cpd-a", \r
           "cpAddress": [\r
+\r
             {\r
               "addresses": [\r
+\r
                 {\r
                   "addressType": "MAC", \r
                   "l2AddressData": "00:f3:43:20:a2:a3"\r
+\r
                 },\r
                 {\r
+\r
                   "addressType": "IP", \r
                     "l3AddressData": {\r
+\r
                       "iPAddressType": "IPv4", \r
                       "iPAddress": "192.168.104.2"\r
+\r
                     }\r
+\r
                 }\r
+\r
                 ],\r
+\r
               "useDynamicAddress": "FALSE"\r
+\r
             }\r
+\r
           ]\r
+\r
         }\r
+\r
       ],\r
+\r
     "vnfSpecificData": { \r
+\r
         "autoScalable": "FALSE", \r
         "autoHealable": "FALSE"\r
+\r
     }\r
+\r
   },\r
+\r
   "vnfcConfigurationData": \r
     { \r
         "vnfcId": "vnfc-1", \r
         "cp": [\r
+\r
           {\r
             "cpId": "cp-11",\r
             "cpdId": "cpd-1a",\r
             "cpAddress": [\r
+\r
               {\r
                 "addresses": [\r
+\r
                   {\r
                     "addressType": "MAC", \r
                     "l2AddressData": "00:f3:43:21:a2:a3"\r
+\r
                   },\r
                   {\r
+\r
                     "addressType": "IP", \r
                     "l3AddressData": {\r
+\r
                       "iPAddressType": "IPv4", \r
                       "iPAddress": "192.168.105.2"\r
+\r
                     }\r
+\r
                   }\r
+\r
                 ],\r
                 "useDynamicAddress": "FALSE"\r
+\r
               }\r
+\r
             ]\r
+\r
           }\r
+\r
         ],\r
+\r
       "vnfcSpecificData": {}\r
+\r
     }\r
+\r
   }\r
 \r
 \r
     **4.1.2 Response**\r
+\r
 +-----------------------+-------------+---------------+-------------------+---------------------------------+\r
 | Parameter             | Qualifier   | Cardinality   |     Content       | Description                     |\r
 +=======================+=============+===============+===================+=================================+\r
@@ -1391,63 +1572,101 @@ Table 2-1 abbreviations
 \r
     {\r
       "vnfConfigurationData": { \r
+\r
         "cp": [\r
+\r
           {\r
             "cpId": "cp-1",\r
             "cpdId": "cpd-a", "cpAddress": [\r
+\r
               {\r
                 "addresses": [\r
+\r
                   {\r
                     "addressType": "MAC", \r
                     "l2AddressData": "00:f3:43:20:a2:a3"\r
+\r
                   },\r
                   {\r
+\r
                     "addressType": "IP", \r
                     "l3AddressData": {\r
+\r
                       "iPAddressType": "IPv4", \r
                       "iPAddress": "192.168.104.2"\r
+\r
                     }\r
+\r
                   }\r
+\r
                 ],\r
+\r
                 "useDynamicAddress": "FALSE"\r
+\r
               }\r
+\r
             ]\r
+\r
           }\r
+\r
         ],\r
         "vnfSpecificData": { \r
+\r
             "autoScalable": "FALSE", \r
             "autoHealable": "FALSE",\r
             …\r
+\r
         }\r
+\r
       },\r
+\r
       "vnfcConfigurationData": { \r
+\r
           "vnfcId": "vnfc-1", \r
           "cp": [\r
+\r
             {\r
               "cpId": "cp-11",\r
               "cpdId": "cpd-1a", \r
               "cpAddress": [\r
+\r
                 {\r
                   "addresses": [\r
+\r
                     {\r
+\r
                       "addressType": "MAC", \r
                       "l2AddressData": "00:f3:43:21:a2:a3"\r
+\r
                     },\r
                     {\r
+\r
                       "addressType": "IP", \r
                       "l3AddressData": {\r
+\r
                         "iPAddressType": "IPv4", \r
                         "iPAddress": "192.168.105.2"\r
+\r
                        }\r
+\r
                     }\r
+\r
                   ],\r
+\r
                   "useDynamicAddress": "FALSE"\r
+\r
                 }\r
+\r
               ]\r
+\r
             }\r
+\r
           ],\r
+\r
       "vnfcSpecificData": {…}\r
+\r
     }\r
+\r
   }\r
 \r
     **4.1.3Response Code**\r
@@ -1462,4 +1681,4 @@ Table 2-1 abbreviations
 \r
 .. |image0| image:: VNFM_API.png\r
    :width: 5.07047in\r
-   :height: 5.63208in
\ No newline at end of file
+   :height: 5.6320
\ No newline at end of file
NS lifecycle management