docs/APPC LCM API Guide/APPC LCM API Guide.rst

   1 .. ============LICENSE_START==========================================
   2 .. ===================================================================
   3 .. Copyright © 2017 AT&T Intellectual Property. All rights reserved.
   4 .. ===================================================================
   5 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
   6 .. you may not use this documentation except in compliance with the License.
   7 .. You may obtain a copy of the License at
   8 ..
   9 ..  https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 .. Unless required by applicable law or agreed to in writing, software
  12 .. distributed under the License is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ============LICENSE_END============================================
  17 .. ECOMP is a trademark and service mark of AT&T Intellectual Property.
  18
  19 .. _appc_api_guide:
  20
  21 ==================
  22 APPC LCM API Guide
  23 ==================
  24
  25 Introduction
  26 ============
  27
  28 This guide describes the APPC API that allows you to manage and control the life cycle of controlled virtual network functions (VNFs).
  29
  30
  31 Target Audience
  32 ---------------
  33 This document is intended for an advanced technical audience, such as the engineers or architects who need to use this guide to develop an interfacing application. The guide assumes a knowledge of the Open Network Automation Platform (ONAP) components and features, and familiarity with JSON notation.
  34
  35
  36 Life Cycle Management Commands
  37 ==============================
  38
  39 APPC receives commands from external ONAP components, such as SO, Policy, DCAE, or the Portal, to manage the life cycle of virtual applications and their components.
  40
  41 A virtual application is composed of the following layers of network technology:
  42
  43 - Virtual Network Function (VNF)
  44 - Virtual Network Function Component (VNFC)
  45 - Virtual Machine (VM)
  46
  47 A Life Cycle Management (LCM) command may affect one or more of these layers.
  48
  49 An LCM command is sent as a request to the APPC using an HTTP POST request or in a message on a message bus (DMaaP or UEB).  A request may result in either a single synchronous response or multiple asynchronous responses:
  50
  51 - An **asynchronous** command, which is sent as an authorized and valid request, results in at least two discrete response events:
  52     - an accept response, to indicate that the request is accepted for processing
  53     - a final response to indicate the status and outcome of the request processing
  54     - An unauthorized or invalid request results in a single ERROR response.
  55
  56 - A **synchronous** command, such as Lock or Unlock, results in a single response that is either SUCCESS or ERROR.
  57
  58 **NOTE:** For both asynchronous or synchronous commands, the first response is always returned using the same transport that the initial action used. For example, if the action request was via the message bus (such as when it originates from Policy), then the response is also via the message bus. However, if the request was via a direct HTTP call, the response is similarly a synchronous HTTP response.
  59
  60
  61 Message Bus and the LCM API Client Library
  62 ------------------------------------------
  63
  64 The recommended approach for sending/receiving requests to APPC is via the message bus.   To support this approach, an APPC client library is available and should be used.  The client library aims to provide consumers of APPC capabilities with a strongly-typed Java interface and to encapsulate the actual interaction with APPC component via the message bus.
  65
  66 For more details, see the APPC Client Library Guide at:
  67
  68   :ref:`appc_client_library`
  69
  70
  71 The client library supports both synchronous and asynchronous flows as follows.
  72
  73 Asynchronous Flow
  74 ^^^^^^^^^^^^^^^^^
  75
  76 - The APPC Client Library is called via an asynchronous API using a full command object, which is mapped to a JSON representation.
  77 - The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic.
  78 - The APPC client pulls response messages from the configured topic.
  79 - On receiving the response for the command, APPC client runs the relevant callback method of the consumer ResponseHandler.
  80
  81 Synchronous Flow
  82 ^^^^^^^^^^^^^^^^
  83
  84 - The APPC Client Library is called via a synchronous API using a full command object, which is mapped to a JSON representation.
  85 - The APPC client calls the UEB/DMaaP client and sends the JSON command to a configured topic.
  86 - The APPC client pulls response messages from the configured topic.
  87 - On receiving the final response for the command, the APPC client returns the response object with a final status.
  88
  89 The client library adds the following wrapper around request and responses to the LCM API (described below)::
  90
  91     {
  92         "version" : "2.0",
  93         "cambria.partition" : "<TOPIC>",
  94         "correlation-id" :"<CORRELATION_ID>",
  95         "rpc-name" : "<RPC_NME>",
  96         "type" : <MESSAGE_TYPE>
  97         "body" : <RPC_SPECIFIC_BODY>
  98     }
  99
 100
 101
 102 Table 1 Request / Response Message Fields
 103
 104 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 105 | **Field**            | **Description**                                                                                                | **Required**        |
 106 +======================+================================================================================================================+=====================+
 107 | version              | Indicates the version of the message bus protocol with APPC. Version 2.0 should be used.                       |     Yes             |
 108 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 109 | cambria. partition   | Indicates the specific topic partition that the message is intended for. For example:                          |     No              |
 110 |                      |                                                                                                                |                     |
 111 |                      | -  For incoming messages, this value should be APP-C.                                                          |                     |
 112 |                      |                                                                                                                |                     |
 113 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 114 | correlation- id      | Correlation ID used for associating responses in APPC Client Library. Built as: <request-id>-<sub-request-id>  |     Yes             |
 115 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 116 | rpc-name             | The target Remote Processing Call (RPC) name which should match the LCM command name. For example: configure   |     Yes             |
 117 |                      |                                                                                                                |                     |
 118 |                      | The convention for RPC names and the target URL is that multi-word command names should have a dash between    |                     |
 119 |                      | words, e.g.,                                                                                                   |                     |
 120 |                      | /restconf/operations/appc-provider-lcm:config-modify                                                           |                     |
 121 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 122 | type                 | Message type: request, response or error                                                                       |     Yes             |
 123 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 124 | body                 | Contains the input or output LCM command content, which is either the request or response                      |                     |
 125 |                      | The body field format is identical to the equivalent HTTP Rest API command based on the specific RPC name      |     Yes             |
 126 |                      |                                                                                                                |                     |
 127 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 128
 129
 130 Generic Request Format
 131 ----------------------
 132
 133 The LCM API general request format is applicable for both POST HTTP API and for the message body received via the EUB/DMaaP bus.
 134
 135 LCM Request
 136 ^^^^^^^^^^^
 137
 138 The LCM request comprises a common header and a section containing the details of the LCM action.
 139 The LCM request conforms to the following structure::
 140
 141     {
 142     "input": {
 143                 "common-header": {"timestamp": "<TIMESTAMP>",
 144                                         "api-ver": "<API_VERSION>",
 145                                         "originator-id": "<ECOMP_SYSTEM_ID>",
 146                                         "request-id": "<ECOMP_REQUEST_ID>",
 147                                         "sub-request-id": "<ECOMP_SUBREQUEST_ID>",
 148                                         "flags": {
 149                                                    "mode": "<EXCLUSIVE|NORMAL>",
 150                                                    "force": "<TRUE|FALSE>",
 151                                                    "ttl": "<TTL_VALUE>"
 152                                                  }
 153                                  },
 154                 "action": "<COMMAND_ACTION>",
 155                 "action-identifiers": {
 156                                         "vnf-id": "<ECOMP_VNF_ID>",
 157                                         "vnfc-name": "<ECOMP_VNFC_NAME>",
 158                                         "vserver-id": "VSERVER_ID"
 159                                       },
 160                 ["payload": "<PAYLOAD>"]
 161              }
 162     }
 163
 164
 165 Table 2 LCM Request Fields
 166
 167 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 168 |     **Field**             |     **Description**                                                                                                                                                                                                                                                                                                    |     **Required?**   |
 169 +===========================+========================================================================================================================================================================================================================================================================================================================+=====================+
 170 |     input                 |     The block that defines the details of the input to the command processing. Contains the common-header details.                                                                                                                                                                                                     |     Yes             |
 171 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 172 |     common- header        |     The block that contains the generic details about a request.                                                                                                                                                                                                                                                       |     Yes             |
 173 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 174 |     timestamp             |     The time of the request, in ISO 8601 format, ZULU offset. For example: 2016-08-03T08:50:18.97Z.                                                                                                                                                                                                                    |     Yes             |
 175 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 176 |                           |     APPC will reject the request if timestamp is in the future (due to clock error), or timestamp is too old (compared to TTL flag)                                                                                                                                                                                    |                     |
 177 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 178 |     api-ver               |     Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. For example:                                                                                                                                                  |     Yes             |
 179 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 180 |                           | -  5.00 for this version                                                                                                                                                                                                                                                                                               |                     |
 181 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 182 |     originator-id         |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                                                                                                                          |     Yes             |
 183 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 184 |                           |     It can be used for addressing purposes, such as to return an asynchronous response to the correct destination, in particular where there are multiple consumers of APPC APIs.                                                                                                                                      |                     |
 185 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 186 |     request-id            |     The UUID for the request ID, limited to a length of 40 characters. The unique OSS/BSS identifier for the request ID that triggers the current LCM action. Multiple API calls can be made with the same request-id.                                                                                                 |     Yes             |
 187 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 188 |                           |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                                                                                                              |                     |
 189 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 190 |     sub-request-id        |     Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request.                                                                                                                                                                |     No              |
 191 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 192 |     flags                 |     Generic flags that apply to all LCM actions:                                                                                                                                                                                                                                                                       |     No              |
 193 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 194 |                           | -  "MODE" :                                                                                                                                                                                                                                                                                                            |                     |
 195 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 196 |                           |    -  "EXCLUSIVE" - accept no queued requests on this VNF while processing, or                                                                                                                                                                                                                                         |                     |
 197 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 198 |                           |    -  "NORMAL" - queue other requests until complete                                                                                                                                                                                                                                                                   |                     |
 199 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 200 |                           | -  "FORCE" : "TRUE"\|"FALSE" - run action even if target is in an unstable state (for example, if VNF is busy processing another LCM command or if a previous command failed and VNF was indicated as not STABLE), or not.                                                                                             |                     |
 201 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 202 |                           |     The specific behavior of forced actions varies, but implies cancellation of the previous action and an override by the new action. The default value is FALSE.                                                                                                                                                     |                     |
 203 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 204 |                           |     Force flag are used to bypass APPC’s working state management for the VNF(VNF working State Management) :                                                                                                                                                                                                          |                     |
 205 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 206 |                           |     APPC maintains working state (in the VNF\_STATE\_MANAGEMENT table present in the APPC-DB) for the VNF depending on the last action performed on it:                                                                                                                                                                |                     |
 207 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 208 |                           |     There are below 3 states appc have for VNF while performing non-read only operation (Read-Only operations are : Lock, Unlock, CheckLock, Sync, Audit etc. ) :                                                                                                                                                      |                     |
 209 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 210 |                           |     1) Stable – If the last action performed on a VNF is Successful (returning Success).                                                                                                                                                                                                                               |                     |
 211 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 212 |                           |     2) Unstable – This is the intermediate state for any VNF on which operation is being performed.                                                                                                                                                                                                                    |                     |
 213 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 214 |                           |     3) Unknown – This is the status when the last action performed on a VNF is not successful.                                                                                                                                                                                                                         |                     |
 215 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 216 |                           |     APPC have validation that it will not allow any operations on VNF which is in Unstable or Unknown state. To skip this check end-user can pass Force-flag=true in the request.                                                                                                                                      |                     |
 217 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 218 |                           | -  "TTL": <0....N> - The timeout value for the action to run, between action received by APPC and action initiated.                                                                                                                                                                                                    |                     |
 219 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 220 |                           |     If no TTL value provided, the default/configurable TTL value is to be used.                                                                                                                                                                                                                                        |                     |
 221 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 222 |     action                |     The action to be taken by APPC, for example: Test, Start, Terminate.                                                                                                                                                                                                                                               |     Yes             |
 223 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 224 |                           |     ***NOTE:** The specific value for the action parameter is provided for each* command.                                                                                                                                                                                                                              |                     |
 225 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 226 |     action- identifiers   |     A block containing the action arguments. These are used to specify the object upon which APPC LCM command is to operate. At least one action-identifier must be specified (note that vnf-id is mandatory). For actions that are at the VM level, the action-identifiers provided would be vnf-id and vserver-id.   | Yes                 |
 227 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 228 |     vnf-id                |     Identifies the VNF instance to which this action is to be applied. Required for actions.                                                                                                                                                                                                                           |     Yes             |
 229 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 230 |     vnfc-name             |     Identifies the VNFC instance to which this action is to be applied. Required if the action applied to a specific VNFC.                                                                                                                                                                                             |     No              |
 231 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 232 |     vserver-id            |     Identifies a specific VM instance to which this action is to be applied. Required if the action applied to a specific VM. (Populate the vserver-id field with the UUID of the VM)                                                                                                                                  |     No              |
 233 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 234 |     vf-module-id          |     Identifies a specific VF module to which this action is to be applied. Required if the action applied to a specific VF module.                                                                                                                                                                                     |     No              |
 235 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 236 |     payload               |     An action-specific open-format field.                                                                                                                                                                                                                                                                              |     No              |
 237 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 238 |                           |     The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: "{\\" vnf -host- ip                                                                                                                                 |                     |
 239 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 240 |                           |     -address\\": \\"<VNF-HOST-IP-ADDRESS>\\"}".                                                                                                                                                                                                                                                                        |                     |
 241 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 242 |                           |     The payload is typically used to provide parametric data associated with the command, such as a list of configuration parameters.                                                                                                                                                                                  |                     |
 243 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 244 |                           |     Note that not all LCM commands need have a payload.                                                                                                                                                                                                                                                                |                     |
 245 |                           |                                                                                                                                                                                                                                                                                                                        |                     |
 246 |                           |     ***NOTE:** See discussion below on the use of payloads for self-service actions.*                                                                                                                                                                                                                                  |                     |
 247 +---------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 248
 249
 250 Generic Response Format
 251 -----------------------
 252
 253
 254 This section describes the generic response format.
 255
 256 The response format is applicable for both POST HTTP API and for the message body received via the EUB/DMaaP bus.
 257
 258
 259 LCM Response
 260 ^^^^^^^^^^^^
 261
 262 The LCM response comprises a common header and a section containing the payload and action details.
 263
 264 The LCM response conforms to the following structure::
 265
 266     {
 267         "output": {
 268                     "common-header": {
 269                                         "api-ver": "<API\_VERSION>",
 270                                         "flags": {
 271                                                    "ttl": <TTL\_VALUE>,
 272                                                    "force": "<TRUE\|FALSE>",
 273                                                    "mode": "<EXCLUSIVE\|NORMAL>"
 274                                                  },
 275                                         "originator-id": "<ECOMP\_SYSTEM\_ID>",
 276                                         "request-id": "<ECOMP\_REQUEST\_ID>",
 277                                         "sub-request-id": "<ECOMP\_SUBREQUEST\_ID>",
 278                                         "timestamp": "2016-08-08T23:09:00.11Z",
 279                                      },
 280                     "payload": "<PAYLOAD>",
 281                     [Additional fields],
 282                     "status": {
 283                                 "code": <RESULT\_CODE>,
 284                                 "message": "<RESULT\_MESSAGE>"
 285                               }
 286                   }
 287     }
 288
 289
 290 Table 3 LCM Response Fields
 291
 292 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 293 |     **Field**        |     **Description**                                                                                                                                                                                                       |     **Required?**   |
 294 +======================+===========================================================================================================================================================================================================================+=====================+
 295 |     output           |     The block that defines the details of the output of the command processing. Contains the common-header details.                                                                                                       |     Yes             |
 296 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 297 |     common- header   |     The block that contains the generic details about a request.                                                                                                                                                          |     Yes             |
 298 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 299 |     api-ver          |     Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version. For example:                                                     |     Yes             |
 300 |                      |                                                                                                                                                                                                                           |                     |
 301 |                      | -  5.00 for this version                                                                                                                                                                                                  |                     |
 302 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 303 |     originator-id    |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                             |     Yes             |
 304 |                      |                                                                                                                                                                                                                           |                     |
 305 |                      |     It can be used for addressing purposes, such as to return an asynchronous response to the correct destination, in particular where there are multiple consumers of APPC APIs.                                         |                     |
 306 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 307 |     request-id       |     The UUID for the request ID, limited to a length of 40 characters. The unique OSS/BSS identifier for the request ID that triggers the current LCM action. Multiple API calls can be made with the same request- id.   |     Yes             |
 308 |                      |                                                                                                                                                                                                                           |                     |
 309 |                      |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                 |                     |
 310 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 311 |     sub-request-id   |     Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request.                                                                   |     No              |
 312 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 313 |     timestamp        |     The time of the request, in ISO 8601 format, ZULU offset. For example: 2016-08-03T08:50:18.97Z.                                                                                                                       |     Yes             |
 314 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 315 |     status           |     The status describes the outcome of the command processing. Contains a code and a message providing success or failure details.                                                                                       |     Yes             |
 316 |                      |                                                                                                                                                                                                                           |                     |
 317 |                      |     ***NOTE:** See* status *for code values.*                                                                                                                                                                             |                     |
 318 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 319 |     payload          |     An open-format field.                                                                                                                                                                                                 |     No              |
 320 |                      |                                                                                                                                                                                                                           |                     |
 321 |                      |     The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: "{\\"upload\_config\_id\\": \\"<value\\"}".            |                     |
 322 |                      |                                                                                                                                                                                                                           |                     |
 323 |                      |     The payload is typically used to provide parametric data associated with the response to the command.                                                                                                                 |                     |
 324 |                      |                                                                                                                                                                                                                           |                     |
 325 |                      |     Note that not all LCM commands need have a payload.                                                                                                                                                                   |                     |
 326 |                      |                                                                                                                                                                                                                           |                     |
 327 |                      |     ***NOTE:** The specific value(s) for the response payload, where relevant, is provided for in each* command *description.*                                                                                            |                     |
 328 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 329 |     [Field name]     |     Additional fields can be provided in the response, if needed, by specific commands.                                                                                                                                   |     No              |
 330 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 331 |     code             |     A unique pre-defined value that identifies the exact nature of the success or failure status.                                                                                                                         |     No              |
 332 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 333 |     message          |     The description of the success or failure status.                                                                                                                                                                     |     No              |
 334 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 335
 336
 337 Status Codes
 338 ------------
 339
 340 The status code is returned in the response message as the code parameter, and the description as the message parameter.
 341
 342 The different responses are categorized as follows:
 343
 344 **ACCEPTED**
 345
 346     Request is valid and accepted for processing.
 347
 348 **ERROR**
 349
 350     Request invalid or incomplete.
 351
 352 **REJECT**
 353
 354     Request rejected during processing due to invalid data, such as an
 355     unsupported command or a non-existent service-instance-id.
 356
 357 **SUCCESS**
 358
 359     Request is valid and completes successfully.
 360
 361 **FAILURE**
 362
 363     The request processing resulted in failure.
 364
 365     A FAILURE response is always returned asynchronously via the message
 366     bus.
 367
 368 **PARTIAL SUCCESS**
 369
 370     The request processing resulted in partial success where at least
 371     one step in a longer process completed successfully.
 372
 373     A PARTIAL SUCCESS response is always returned asynchronously via the
 374     message bus.
 375
 376 **PARTIAL FAILURE**
 377
 378     The request processing resulted in partial failure.
 379
 380     A PARTIAL FAILURE response is always returned asynchronously via the
 381     message bus.
 382
 383 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 384 |     **Category**      |     **Code**   |     **Message / Description**                                                                                                        |
 385 +=======================+================+======================================================================================================================================+
 386 |     ACCEPTED          |     100        |     ACCEPTED - Request accepted                                                                                                      |
 387 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 388 |     ERROR             |     200        |     UNEXPECTED ERROR - ${detailedErrorMsg}                                                                                           |
 389 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 390 |     REJECT            |     300        |     REJECTED - ${detailedErrorMsg}                                                                                                   |
 391 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 392 |                       |     301        |     INVALID INPUT PARAMETER -${detailedErrorMsg}                                                                                     |
 393 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 394 |                       |     302        |     MISSING MANDATORY PARAMETER - Parameter ${paramName} is missing                                                                  |
 395 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 396 |                       |     303        |     REQUEST PARSING FAILED - ${detailedErrorMsg}                                                                                     |
 397 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 398 |                       |     304        |     NO TRANSITION DEFINED - No Transition Defined for ${actionName} action and ${currentState} state                                 |
 399 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 400 |                       |     305        |     ACTION NOT SUPPORTED - ${actionName} action is not supported                                                                     |
 401 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 402 |                       |     306        |     VNF NOT FOUND - VNF with ID ${vnfId} was not found                                                                               |
 403 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 404 |                       |     307        |     DG WORKFLOW NOT FOUND - No DG workflow found for the combination of ${dgModule} module ${dgName} name and ${dgVersion} version   |
 405 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 406 |                       |     308        |     WORKFLOW NOT FOUND - No workflow found for VNF type                                                                              |
 407 |                       |                |                                                                                                                                      |
 408 |                       |                |     ${vnfTypeVersion} and ${actionName} action                                                                                       |
 409 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 410 |                       |     309        |     UNSTABLE VNF - VNF ${vnfId} is not stable to accept the command                                                                  |
 411 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 412 |                       |     310        |     LOCKING FAILURE -${detailedErrorMsg}                                                                                             |
 413 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 414 |                       |     311        |     EXPIREDREQUEST. The request processing time exceeded the maximum available time                                                  |
 415 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 416 |                       |     312        |     DUPLICATEREQUEST. The request already exists                                                                                     |
 417 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 418 |                       |     313        |     MISSING VNF DATA IN A&AI - ${attributeName} not found for VNF ID =                                                               |
 419 |                       |                |                                                                                                                                      |
 420 |                       |                |     ${vnfId}                                                                                                                         |
 421 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 422 |     SUCCESS           |     400        |     The request was processed successfully                                                                                           |
 423 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 424 |     FAILURE           |     401        |     DG FAILURE - ${ detailedErrorMsg }                                                                                               |
 425 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 426 |                       |     402        |     NO TRANSITION DEFINED - No Transition Defined for ${ actionName} action and ${currentState} state                                |
 427 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 428 |                       |     403        |     UPDATE\_AAI\_FAILURE - failed to update AAI. ${errorMsg}                                                                         |
 429 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 430 |                       |     404        |     EXPIRED REQUEST FAILURE - failed during processing because TTL expired                                                           |
 431 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 432 |                       |     405        |     UNEXPECTED FAILURE - ${detailedErrorMsg}                                                                                         |
 433 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 434 |                       |     406        |     UNSTABLE VNF FAILURE - VNF ${vnfId} is not stable to accept the command                                                          |
 435 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 436 |                       |     450        |     Requested action is not supported on the VNF                                                                                     |
 437 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 438 |     PARTIAL SUCCESS   |     500        |     PARTIAL SUCCESS                                                                                                                  |
 439 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 440 |     PARTIAL FAILURE   |     501 -      |     PARTIAL FAILURE                                                                                                                  |
 441 |                       |                |                                                                                                                                      |
 442 |                       |     599        |                                                                                                                                      |
 443 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 444
 445
 446 Malformed Message Response
 447 --------------------------
 448
 449 A malformed message is an invalid request based on the LCM API YANG scheme specification. APPC rejects malformed requests as implemented by ODL infrastructure level.
 450
 451 **Response Format for Malformed Requests**::
 452
 453     {
 454       "errors": {
 455                   "error": [
 456                             {
 457                               "error-type": "protocol",
 458                               "error-tag": "malformed-message",
 459                               "error-message": "<ERROR-MESSAGE>",
 460                               "error-info": "<ERROR-INFO>"
 461                             }
 462                            ]
 463                 }
 464     }
 465
 466
 467 **Example Response**::
 468
 469     {
 470       "errors": {
 471                   "error": [
 472                             {
 473                               "error-type": "protocol",
 474                               "error-tag": "malformed-message",
 475                               "error-message": "Error parsing input: Invalid value 'Stopp' for
 476                                enum type. Allowed values are: [Sync, Audit, Stop, Terminate]",
 477                               "error-info": "java.lang.IllegalArgumentException: Invalid value
 478                                 'Stopp' for enum type. Allowed values are: [Sync, Audit, Stop,
 479                                 Terminate]..."
 480                             }
 481                            ]
 482                 }
 483     }
 484
 485
 486
 487 API Scope
 488 =========
 489
 490 Defines the level at which the LCM command operates for the current release of APPC and the VNF types which are supported for each command.
 491
 492
 493 Commands, or actions, can be performed at one or more of the following scope levels:
 494
 495
 496 +-----------------+----------------------------------------------------------------------------------------+
 497 | **VNF**         | Commands can be applied at the level of a specific VNF instance using the vnf-id.      |
 498 +-----------------+----------------------------------------------------------------------------------------+
 499 | **VF-Module**   | Commands can be applied at the level of a specific VF-Module using the vf-module-id.   |
 500 +-----------------+----------------------------------------------------------------------------------------+
 501 | **VNFC**        | Commands can be applied at the level of a specific VNFC instance using a vnfc-name.    |
 502 +-----------------+----------------------------------------------------------------------------------------+
 503 | **VM**          | Commands can be applied at the level of a specific VM instance using a vserver-id.     |
 504 +-----------------+----------------------------------------------------------------------------------------+
 505
 506
 507 **VNF’s Types Supported**
 508
 509 Commands, or actions, may be currently supported on all VNF types or a limited set of VNF types. Note that the intent in the 1710 release is to support all actions on all VNF types which have been successfully onboarded in a self-service mode.
 510
 511 **Any -** Currently supported on any vnf-type.
 512
 513 **Any (requires self-service onboarding) –** Currently supported on any vnf-type which has been onboarded using the APPC self-service onboarding process. See further discussion on self-service onboarding below.
 514
 515
 516 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 517 |     **Command**        |     **VNF**   |     **VF-Module**   |     **VNFC**   |     **VM**   |     **VNF/VM Types Supported**                                 |
 518 +========================+===============+=====================+================+==============+================================================================+
 519 |     Audit              |     Yes       |                     |                |              |     Any (requires self-service onboarding)                     |
 520 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 521 |     CheckLock          |     Yes       |                     |                |              |     Any (APPC internal command)                                |
 522 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 523 |     Configure          |     Yes       |                     |     Yes        |              |     Any (requires self-service onboarding)                     |
 524 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 525 |     ConfigModify       |     Yes       |                     |     Yes        |              |     Any (requires self-service onboarding)                     |
 526 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 527 |     ConfigBackup       |     Yes       |                     |                |              |     Chef and Ansible only (requires self-service onboarding)   |
 528 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 529 |     ConfigRestore      |     Yes       |                     |                |              |     Chef and Ansible only (requires self-service onboarding)   |
 530 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 531 |     Evacuate           |               |                     |                |     Yes      | Any (uses OpenStack Evacuate command)                          |
 532 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 533 |     HealthCheck        |     Yes       |                     |                |              |     Any (requires self-service onboarding)                     |
 534 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 535 |     Lock               |     Yes       |                     |                |              |     Any (APPC internal command)                                |
 536 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 537 |     Migrate            |               |                     |                |     Yes      |     Any (uses OpenStack Migrate command)                       |
 538 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 539 |     Rebuild            |               |                     |                |     Yes      |     Any (uses OpenStack Rebuild command)                       |
 540 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 541 |     Restart            |     Yes       |                     |                |     Yes      |     Any (uses OpenStack Start and Stop commands)               |
 542 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 543 |     Snapshot           |               |                     |                |     Yes      |     Any (uses OpenStack Snapshot command)                      |
 544 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 545 |     Start              |     Yes       |     Yes             |                |     Yes      |     Any (uses OpenStack Start command)                         |
 546 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 547 |     StartApplication   |     Yes       |                     |                |              |     Chef and Ansible only (requires self-service onboarding)   |
 548 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 549 |     Stop               |     Yes       |     Yes             |                |     Yes      |     Any (uses OpenStack Stop command)                          |
 550 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 551 |     StopApplication    |     Yes       |                     |                |              |     Chef and Ansible only (requires self-service onboarding)   |
 552 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 553 |     Sync               |     Yes       |                     |                |              |     Any (requires self-service onboarding)                     |
 554 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 555 |     Unlock             |     Yes       |                     |                |              |     Any (APPC internal command)                                |
 556 +------------------------+---------------+---------------------+----------------+--------------+----------------------------------------------------------------+
 557
 558
 559
 560 Self-Service VNF Onboarding
 561 ---------------------------
 562
 563 The APPC architecture is designed for VNF self-service onboarding (i.e., a VNF owner or vendor through the use of tools can enable a new VNF to support the LCM API actions that are designate as self-service). The VNF must support one or more of the following interface protocols:
 564
 565 -  Netconf with uploadable Yang model (requires a Netconf server running
 566    on the VNF)
 567
 568 -  Chef (requires a Chef client running on the VNF)
 569
 570 -  Ansible (does not require any changes to the VNF software)
 571
 572 The self-service onboarding process is done using an APPC Design GUI which interacts with an APPC instance which is dedicated to self-service onboarding. The steps in the onboarding process using the APPC Design GUI are:
 573
 574 -  Define the VNF capabilities (set of actions that the VNF can
 575    support).
 576
 577 -  Create a template and parameter definitions for actions which use the
 578    Netconf, Chef, or Ansible protocols. The template is an xml or JSON
 579    block which defines the “payload” which is included in the request
 580    that is downloaded the VNF (if Netconf) or Chef/Ansible server.
 581
 582 -  Test actions which have templates/parameter definitions.
 583
 584 -  Upload the VNF definition, template, and parameter definition
 585    artifacts to SDC which distributes them to all APPC instances in the
 586    same environment (e.g., production).
 587
 588 For more details, see the APPC Self-Service VNF Onboarding Guide.
 589
 590
 591
 592 LCM Commands
 593 ============
 594
 595 The LCM commands that are valid for the current release.
 596
 597
 598 Audit
 599 -----
 600
 601 The Audit command compares the configuration of the VNF associated with the current request against the most recent configuration that is stored in APPC's configuration database.
 602
 603 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
 604
 605 A failed Audit indicates that the configurations do not match.
 606
 607 This command can be applied to any VNF type. The only restriction is that the VNF has been onboarded in self-service mode (which requires that the VNF supports a request to return the running configuration).
 608
 609 The Audit action does not require any payload parameters.
 610
 611 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
 612
 613
 614 +------------------------------+------------------------------------------------------+
 615 |     **Target URL**           |     /restconf /operations/ appc-provider-lcm:audit   |
 616 +------------------------------+------------------------------------------------------+
 617 |     **Action**               |     Audit                                            |
 618 +------------------------------+------------------------------------------------------+
 619 |     **Action-Identifiers**   |     vnf-id                                           |
 620 +------------------------------+------------------------------------------------------+
 621 |     **Payload Parameters**   |     See below                                        |
 622 +------------------------------+------------------------------------------------------+
 623 |     **Revision History**     |     Unchanged in this version.                       |
 624 +------------------------------+------------------------------------------------------+
 625
 626 |
 627
 628 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 629 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 630 +======================+===========================================================================================================================================================+=====================+==================================+
 631 |     publish-config   |     \* If the publish\_config field is set to Y in the payload, then always send the running configuration from the VNF using the Data Router             |     Yes             |     "publish-config": "<Y\|N>"   |
 632 |                      |                                                                                                                                                           |                     |                                  |
 633 |                      |     \* If the publish\_config field is set to N in the payload, then:                                                                                     |                     |                                  |
 634 |                      |                                                                                                                                                           |                     |                                  |
 635 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration in the Data Router   |                     |                                  |
 636 |                      |                                                                                                                                                           |                     |                                  |
 637 |                      |     - If the result of the audit is ‘no match’, then send the running configuration on the Data Router                                                    |                     |                                  |
 638 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 639
 640 Audit Response
 641 ^^^^^^^^^^^^^^
 642
 643 The audit response returns an indication of success or failure of the audit. If a new configuration is uploaded to the APPC database, the payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system.
 644
 645
 646 CheckLock
 647 ---------
 648
 649 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
 650
 651 A CheckLock command is deemed successful if the processing completes without error, whether the VNF is locked or not. The command returns only a single response with a final status.
 652
 653 Note that APPC locks the target VNF during any VNF command processing, so a VNF can have a locked status even if no Lock command has been explicitly called.
 654
 655 The CheckLock command returns a specific response structure that extends the default LCM response.
 656
 657 The CheckLock action does not require any payload parameters.
 658
 659 +------------------------------+--------------------------------------------------------+
 660 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:checklock   |
 661 +------------------------------+--------------------------------------------------------+
 662 |     **Action**               |     CheckLock                                          |
 663 +------------------------------+--------------------------------------------------------+
 664 |     **Action-Identifiers**   |     vnf-id                                             |
 665 +------------------------------+--------------------------------------------------------+
 666 |     **Payload Parameters**   |     None                                               |
 667 +------------------------------+--------------------------------------------------------+
 668 |     **Revision History**     |     Unchanged in this version.                         |
 669 +------------------------------+--------------------------------------------------------+
 670
 671 CheckLock Response
 672 ^^^^^^^^^^^^^^^^^^
 673
 674 The CheckLock command returns a customized version of the LCM
 675 response.
 676
 677
 678 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 679 |     **Parameter**   |     **Description**                                                                   |     **Required**   | **?Example**                    |
 680 +=====================+=======================================================================================+====================+=================================+
 681 |     locked          |     "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE.   |     No             |     "locked": "<TRUE\|FALSE>"   |
 682 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 683
 684
 685 **Example**::
 686
 687     {
 688       "output": {
 689                   "status": {
 690                               "code": <RESULT\_CODE>, "message": "<RESULT\_MESSAGE>"
 691                             },
 692                   "common-header": {
 693                                      "api-ver": "<API\_VERSION>",
 694                                      "request-id": "<ECOMP\_REQUEST\_ID>", "originator-id":
 695                                      "<ECOMP\_SYSTEM\_ID>",
 696                                      "sub-request-id": "<ECOMP\_SUBREQUEST\_ID>", "timestamp":
 697                                      "2016-08-08T23:09:00.11Z",
 698                                      "flags": {
 699                                                 "ttl": <TTL\_VALUE>, "force": "<TRUE\|FALSE>",
 700                                                 "mode": "<EXCLUSIVE\|NORMAL>"
 701                                               }
 702                                    },
 703                   "locked": "<TRUE\|FALSE>"
 704     }
 705
 706
 707 Configure
 708 ---------
 709
 710 Configure a VNF or a VNFC on the VNF after instantiation.
 711
 712 A set of configuration parameter values specified in the configuration template is included in the request. Other configuration parameter values may be obtained from an external system.
 713
 714 A successful Configure request returns a success response.
 715
 716 A failed Configure action returns a failure response and the specific failure messages in the response block.
 717
 718 +------------------------------+--------------------------------------------------------+
 719 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configure   |
 720 +------------------------------+--------------------------------------------------------+
 721 |     **Action**               |     Configure                                          |
 722 +------------------------------+--------------------------------------------------------+
 723 |     **Action-Identifiers**   |     vnf-id                                             |
 724 +------------------------------+--------------------------------------------------------+
 725 |     **Payload Parameters**   |     See below                                          |
 726 +------------------------------+--------------------------------------------------------+
 727 |     **Revision History**     |     Unchanged in this version.                         |
 728 +------------------------------+--------------------------------------------------------+
 729
 730 |
 731
 732 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 733 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                                                                                                                        |     **Required?**   |     **Example**                                                 |
 734 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 735 +=================================+============================================================================================================================================================================================================================================================================================================+=====================+=================================================================+
 736 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF, if Netconf. A template-name may also be included in the event that a specific configuration template needs to be identified. If the request is vnfc-specific, the vnfc-type must be included.   |     Yes             |                                                                 |
 737 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     "payload":                                                  |
 738 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 739 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     "{\"request-parameters                                      |
 740 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 741 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \": {                                                       |
 742 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 743 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \"host-ip-address\": \”value\”,                             |
 744 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 745 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \”vnfc-type\”: \”value\”’,                                  |
 746 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 747 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \”template-name\”: \”name\”                                 |
 748 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 749 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     }                                                           |
 750 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 751 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \"configuration- parameters\": {\"<CONFIG- PARAMS>\"}       |
 752 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 753 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 754 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified. If provided, APPC replaces variables in the configuration template with the values supplied.                                                                                                                                  |     No              |                                                                 |
 755 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 756
 757
 758 Configure Response
 759 ^^^^^^^^^^^^^^^^^^
 760
 761 The Configure response returns an indication of success or failure of the request. If successful, the return payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ONAP Data Router bus  which may be received by an external configuration storage system.
 762
 763 SO is creating the VNFC records in A&AI. APPC is updating the VNFC status.
 764
 765 ConfigModify
 766 ------------
 767
 768 Modifies the configuration on a VNF or VNFC in service.
 769
 770 A successful ConfigModify request returns a success response.
 771
 772 A failed ConfigModify action returns a failure response code and the specific failure message in the response block.
 773
 774 **NOTE:** See also `Configure <#_bookmark35>`__
 775
 776 +------------------------------+-----------------------------------------------------------+
 777 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configmodify   |
 778 +------------------------------+-----------------------------------------------------------+
 779 |     **Action**               |     ConfigModify                                          |
 780 +------------------------------+-----------------------------------------------------------+
 781 |     **Action-Identifiers**   |     Vnf-id                                                |
 782 +------------------------------+-----------------------------------------------------------+
 783 |     **Payload Parameters**   |     See below                                             |
 784 +------------------------------+-----------------------------------------------------------+
 785 |     **Revision History**     |     Unchanged in this version.                            |
 786 +------------------------------+-----------------------------------------------------------+
 787
 788 |
 789
 790 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 791 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                                                                                                                        |     **Required?**   |     **Example**                                                 |
 792 +=================================+============================================================================================================================================================================================================================================================================================================+=====================+=================================================================+
 793 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF, if Netconf. A template-name may also be included in the event that a specific configuration template needs to be identified. If the request is vnfc-specific, the vnfc-type must be included.   |     Yes             |     "payload":                                                  |
 794 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 795 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     "{\"request-parameters                                      |
 796 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 797 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \": {                                                       |
 798 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 799 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \"host-ip-address\": \”value\”,                             |
 800 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 801 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \”vnfc-type\”: \”value\”’                                   |
 802 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 803 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \”template-name\”: \”name\”,                                |
 804 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 805 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     }                                                           |
 806 |                                 |                                                                                                                                                                                                                                                                                                            |                     |                                                                 |
 807 |                                 |                                                                                                                                                                                                                                                                                                            |                     |     \"configuration- parameters\": {\"<CONFIG- PARAMS>\"}       |
 808 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 809 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified. If provided, APPC replaces variables in the configuration template with the values supplied.                                                                                                                                  |     No              |                                                                 |
 810 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 811
 812 If successful, this request returns a success response.
 813
 814 A failed Configure action returns a failure response and the specific failure message in the response block.
 815
 816 ConfigModify Response
 817 ^^^^^^^^^^^^^^^^^^^^^
 818
 819 The ConfigModify response returns an indication of success or failure of the request. If successful, the return payload contains the ‘upload\_config\_id’ and values for any records created. In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system.
 820
 821 ConfigBackup
 822 ------------
 823
 824 Stores the current VNF configuration on a local file system (not in APPC). This is limited to Ansible and Chef. There can only be one stored configuration (if there is a previously saved configuration, it is replaced with the current VNF configuration).
 825
 826 A successful ConfigBackup request returns a success response.
 827
 828 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
 829
 830 +------------------------------+-----------------------------------------------------------+
 831 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configbackup   |
 832 +------------------------------+-----------------------------------------------------------+
 833 |     **Action**               |     ConfigBackup                                          |
 834 +------------------------------+-----------------------------------------------------------+
 835 |     **Action-Identifiers**   |     Vnf-id                                                |
 836 +------------------------------+-----------------------------------------------------------+
 837 |     **Payload Parameters**   |     See below                                             |
 838 +------------------------------+-----------------------------------------------------------+
 839 |     **Revision History**     |     New in this version.                                  |
 840 +------------------------------+-----------------------------------------------------------+
 841
 842 |
 843
 844 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 845 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
 846 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
 847 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server).   |     Yes             | "payload":                                                      |
 848 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 849 |                                 |                                                                                                                                                                                    |                     |     "{\"request-parameters                                      |
 850 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 851 |                                 |                                                                                                                                                                                    |                     |     \": {                                                       |
 852 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 853 |                                 |                                                                                                                                                                                    |                     |     \"host-ip-address\": \”value\”                              |
 854 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 855 |                                 |                                                                                                                                                                                    |                     |     }                                                           |
 856 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 857 |                                 |                                                                                                                                                                                    |                     |     \"configuration- parameters\": {\"<CONFIG- PARAMS>\"}       |
 858 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 859 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
 860 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 861
 862 ConfigBackup Response
 863 ^^^^^^^^^^^^^^^^^^^^^
 864
 865 The ConfigBackup response returns an indication of success or failure of the request.
 866
 867 ConfigRestore
 868 -------------
 869
 870 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
 871
 872 A successful ConfigRestore request returns a success response.
 873
 874 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
 875
 876 +------------------------------+------------------------------------------------------------------------------------------+
 877 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configrestore                                 |
 878 +------------------------------+------------------------------------------------------------------------------------------+
 879 |     **Action**               |     ConfigRestore                                                                        |
 880 +------------------------------+------------------------------------------------------------------------------------------+
 881 |     **Action-Identifiers**   |     Vnf-id                                                                               |
 882 +------------------------------+------------------------------------------------------------------------------------------+
 883 |     **Payload Parameters**   |     `request-parameters <#_bookmark24>`__, `configuration-parameters <#_bookmark26>`__   |
 884 +------------------------------+------------------------------------------------------------------------------------------+
 885 |     **Revision History**     |     New in this version.                                                                 |
 886 +------------------------------+------------------------------------------------------------------------------------------+
 887
 888 |
 889
 890 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 891 |     **Parameter**               |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
 892 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
 893 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server).   |     Yes             |     "payload":                                                  |
 894 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 895 |                                 |                                                                                                                                                                                    |                     |     "{\"request-parameters                                      |
 896 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 897 |                                 |                                                                                                                                                                                    |                     |     \": {                                                       |
 898 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 899 |                                 |                                                                                                                                                                                    |                     |     \"host-ip-address\\": \”value\”                             |
 900 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 901 |                                 |                                                                                                                                                                                    |                     |     }                                                           |
 902 |                                 |                                                                                                                                                                                    |                     |                                                                 |
 903 |                                 |                                                                                                                                                                                    |                     |     \"configuration- parameters\": {\"<CONFIG- PARAMS>\"}       |
 904 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 905 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
 906 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 907
 908 ConfigRestore Response
 909 ^^^^^^^^^^^^^^^^^^^^^^
 910
 911 The ConfigRestore response returns an indication of success or failure of the request.
 912
 913 Evacuate
 914 --------
 915
 916 Evacuates a specified VM from its current host to another. After a successful evacuate, a rebuild VM is performed if a snapshot is available (and the VM boots from a snapshot.
 917
 918 The host on which the VM resides needs to be down.
 919
 920 If the node is not specified in the request, it will be selected by relying on internal rules to evacuate. The Evacuate action will fail if the specified target host is not UP/ENABLED.
 921
 922 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm <#_bookmark43>`__ parameter to false.
 923
 924 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
 925
 926 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
 927
 928 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 929 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:evacuate                                                                                                            |
 930 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 931 |     **Action**               |     Evacuate                                                                                                                                                   |
 932 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 933 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                                                                                         |
 934 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 935 |     **Payload Parameters**   |     `vm-id <#_bookmark40>`__, `identity-url <#_bookmark41>`__, `tenant-id <#_bookmark42>`__, `rebuild-vm <#_bookmark43>`__, `targethost-id <#_bookmark44>`__   |
 936 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 937 |     **Revision History**     |     Unchanged in this version.                                                                                                                                 |
 938 +------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+
 939
 940 |
 941
 942 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 943 |     **Parameter**    |     **Description**                                                                                                                                                              |     **Required?**   |     **Example**                       |
 944 +======================+==================================================================================================================================================================================+=====================+=======================================+
 945 |     vm-id            |     The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self- link URL of the VM.                                                        |     Yes             |     "payload":                        |
 946 |                      |                                                                                                                                                                                  |                     |                                       |
 947 |                      |                                                                                                                                                                                  |                     |     "{\"vm-id\": \"<VM-ID>            |
 948 |                      |                                                                                                                                                                                  |                     |                                       |
 949 |                      |                                                                                                                                                                                  |                     |     \",                               |
 950 |                      |                                                                                                                                                                                  |                     |                                       |
 951 |                      |                                                                                                                                                                                  |                     |     \"identity-url\":                 |
 952 |                      |                                                                                                                                                                                  |                     |                                       |
 953 |                      |                                                                                                                                                                                  |                     |     \"<IDENTITY-URL>\",               |
 954 |                      |                                                                                                                                                                                  |                     |                                       |
 955 |                      |                                                                                                                                                                                  |                     |     \"tenant-id\\": \"<TENANT-ID>     |
 956 |                      |                                                                                                                                                                                  |                     |                                       |
 957 |                      |                                                                                                                                                                                  |                     |     \",                               |
 958 |                      |                                                                                                                                                                                  |                     |                                       |
 959 |                      |                                                                                                                                                                                  |                     |     \"rebuild-vm\": \"false\",        |
 960 |                      |                                                                                                                                                                                  |                     |                                       |
 961 |                      |                                                                                                                                                                                  |                     |     \"targethost-id\":                |
 962 |                      |                                                                                                                                                                                  |                     |                                       |
 963 |                      |                                                                                                                                                                                  |                     |     \"nodeblade7\"}"                  |
 964 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 965 |     identity- url    |     The identity URL used to access the resource                                                                                                                                 |     No              |                                       |
 966 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 967 |     tenant-id        |     The id of the provider tenant that owns the resource                                                                                                                         |     No              |                                       |
 968 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 969 |     rebuild- vm      |     A boolean flag indicating if a Rebuild is to be performed after an Evacuate. The default action is to do a Rebuild. It can be switched off by setting the flag to "false".   |     No              |                                       |
 970 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 971 |     targethost- id   |     A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host.                                                              |     No              |                                       |
 972 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
 973
 974 HealthCheck
 975 -----------
 976
 977 This command runs a VNF health check and returns the result.
 978
 979 A health check is VNF-specific. For a complex VNF, APPC initiates further subordinate health checks.
 980
 981 HealthCheck is a VNF level command which interrogates the VNF in order to determine the health of the VNF and the VNFCs. The HealthCheck will be implemented differently for each VNF.
 982
 983
 984 +------------------------------+-----------------------------------------------------------+
 985 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:health-check   |
 986 +------------------------------+-----------------------------------------------------------+
 987 |     **Action**               |     HealthCheck                                           |
 988 +------------------------------+-----------------------------------------------------------+
 989 |     **Action-Identifiers**   |     Vnf-id                                                |
 990 +------------------------------+-----------------------------------------------------------+
 991 |     **Payload Parameters**   |     `vnf-host-ip-address <#_bookmark46>`__                |
 992 +------------------------------+-----------------------------------------------------------+
 993 |     **Revision History**     |     Changed in this version.                              |
 994 +------------------------------+-----------------------------------------------------------+
 995
 996 |
 997
 998 +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+-------------------------------------+
 999 |     **Paramete**            |     **Description**                                                                                                                                            |  **Required?**   | **Example**                         |
1000 +=============================+================================================================================================================================================================+==================+=====================================+
1001 |     vnf- host-ip- address   |     The IP address used to connect to the VNF, using a protocol such as SSH. For example, for a vSCP VNF, the floating IP address of the SMP should be used.   |     Yes          |     "payload":                      |
1002 |                             |                                                                                                                                                                |                  |                                     |
1003 |                             |                                                                                                                                                                |                  |     "{\"vnf-host-ip-address\":      |
1004 |                             |                                                                                                                                                                |                  |                                     |
1005 |                             |                                                                                                                                                                |                  |     \"10.222.22.2\"}"               |
1006 +-----------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------+-------------------------------------+
1007
1008 Lock
1009 ----
1010
1011 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1012
1013 The Lock action will return a successful result if the VNF is not already locked or if it was locked with the same request-id, otherwise the action returns a response with a reject status code.
1014
1015 Lock is a command intended for APPC and does not execute an actual VNF command. Instead, lock will ensure that ONAP is granted exclusive access to the VNF.
1016
1017 When a VNF is locked, any subsequent sequential commands with same request-id will be accepted. Commands associated with other request-ids will be rejected.
1018
1019 The Lock command returns only one final response with the status of the request processing.
1020
1021 APPC locks the target VNF during any VNF command processing. If a lock action is then requested on that VNF, it will be rejected because the VNF was already locked, even though no actual lock command was explicitly invoked.
1022
1023 +------------------------------+---------------------------------------------------+
1024 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:lock   |
1025 +------------------------------+---------------------------------------------------+
1026 |     **Action**               |     Lock                                          |
1027 +------------------------------+---------------------------------------------------+
1028 |     **Action-Identifier**    |     Vnf-id                                        |
1029 +------------------------------+---------------------------------------------------+
1030 |     **Payload Parameters**   |     None                                          |
1031 +------------------------------+---------------------------------------------------+
1032 |     **Revision History**     |     Unchanged in this version.                    |
1033 +------------------------------+---------------------------------------------------+
1034
1035 Migrate
1036 -------
1037
1038 Migrates a running target VM from its current host to another.
1039
1040 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1041
1042 Migrate suspends the guest virtual machine, and moves an image of the guest virtual machine's disk to the destination host physical machine. The guest virtual machine is then resumed on the destination host physical machine and the disk storage that it used on the source host physical machine is freed.
1043
1044 The migrate action will leave the VM in the same Openstack state the VM had been in prior to the migrate action. If a VM was stopped before migration, a separate VM-level restart command would be needed to restart the VM after migration.
1045
1046 A successful Migrate action returns a success response.
1047
1048 A failed Migrate action returns a failure and the failure messages in the response payload block.
1049
1050 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1051
1052 +--------------------------------+-----------------------------------------------------------------------------------------------+
1053 |     **Target URL**             |     /restconf/operations/appc-provider-lcm:migrate                                            |
1054 +--------------------------------+-----------------------------------------------------------------------------------------------+
1055 |     **Action**                 |     Migrate                                                                                   |
1056 +--------------------------------+-----------------------------------------------------------------------------------------------+
1057 |     **Action-Identifiers**     |     Vnf-id, vserver-id                                                                        |
1058 +--------------------------------+-----------------------------------------------------------------------------------------------+
1059 |     \ **Payload Parameters**   |     `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__   |
1060 +--------------------------------+-----------------------------------------------------------------------------------------------+
1061 |     **Revision History**       |     Unchanged in this version.                                                                |
1062 +--------------------------------+-----------------------------------------------------------------------------------------------+
1063
1064 Payload Parameters
1065
1066 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1067 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
1068 +=====================+=========================================================================+=====================+====================================+
1069 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
1070 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |     "payload":                     |
1071 |                     |     link URL of the VM.                                                 |                     |                                    |
1072 |                     |                                                                         |                     |     "{\\"vm-id\": \\"<VM-ID>\\",   |
1073 |                     |                                                                         |                     |     \\"identity-url\\":            |
1074 |                     |                                                                         |                     |                                    |
1075 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",          |
1076 +---------------------+-------------------------------------------------------------------------+---------------------+                                    +
1077 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
1078 |                     |                                                                         |                     |     ID>\\"}"                       |
1079 +---------------------+-------------------------------------------------------------------------+---------------------+                                    +
1080 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
1081 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1082
1083 Rebuild
1084 -------
1085
1086 Recreates a target VM instance to a known, stable state.
1087
1088 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
1089
1090 APPC only supports the rebuild operation for a VM that boots from image (snapshot), i.e., APPC rejects a rebuild request if it determines the VM boots from volume (disk).
1091
1092 A successful rebuild returns a success response and the rebuild details in the response payload block. A failed rebuild returns a failure and the failure messages in the response payload block.
1093
1094 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1095
1096 +------------------------------+-----------------------------------------------------------------------------------------------+
1097 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:rebuild                                            |
1098 +------------------------------+-----------------------------------------------------------------------------------------------+
1099 |     **Action**               |     Rebuild                                                                                   |
1100 +------------------------------+-----------------------------------------------------------------------------------------------+
1101 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
1102 +------------------------------+-----------------------------------------------------------------------------------------------+
1103 |     **Payload Parameters**   |     `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__   |
1104 +------------------------------+-----------------------------------------------------------------------------------------------+
1105 |     **Revision History**     |     Unchanged in this version.                                                                |
1106 +------------------------------+-----------------------------------------------------------------------------------------------+
1107
1108 Restart
1109 -------
1110
1111 Use the Restart command to restart a VNF or a single VM. The generic VNF Restart uses a simple restart logic where all VM’s are stopped and re-started.
1112
1113 The generic Restart operation is invoked either for the VM or the VNF level.
1114
1115 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1116 |     **Input Block**          |     api-ver must be set to 2.00 for *VNF Restart*                                                               |
1117 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1118 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:restart                                                              |
1119 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1120 |     **Action**               |     Restart                                                                                                     |
1121 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1122 |     **Action-identifiers**   |     Vnf-id is required; if restart is for a single VM, then vserver-id is also required.                        |
1123 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1124 |     **Payload Parameters**   |     For *VNF* Restart: `host Identity <#_bookmark57>`__, `vnf-host-ip-address <#_bookmark58>`__                 |
1125 |                              |                                                                                                                 |
1126 |                              |     For *VM* Restart: `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__   |
1127 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1128 |     **Revision History**     |     Revised in this version.                                                                                    |
1129 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1130
1131 Payload Parameters for **VNF Restart**
1132
1133 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1134 |     **Parameter**           |     **Description**                                                                                                                                               |     **Required?**   |     **Example**                       |
1135 +=============================+===================================================================================================================================================================+=====================+=======================================+
1136 |     Cloud Identity          |     The identity URL of the OpenStack host on which the VNF resource was created. If not provided, this information will be retrieved from the properties file.   |     No              |     "payload":                        |
1137 |                             |                                                                                                                                                                   |                     |     "{\\" vnf-host-ip-address \\":    |
1138 |                             |                                                                                                                                                                   |                     |                                       |
1139 |                             |                                                                                                                                                                   |                     |     \\"<VNF\_FLOATING\_IP\_ADDRESS>   |
1140 |                             |                                                                                                                                                                   |                     |     \\",                              |
1141 |                             |                                                                                                                                                                   |                     |     \\" hostIdentity \\":             |
1142 |                             |                                                                                                                                                                   |                     |     \\"<OpenStack IP Address>\\"      |
1143 |                             |                                                                                                                                                                   |                     |     }"                                |
1144 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1145 |     vnf- host-ip- address   |     The IP address used to connect to the VNF, using a protocol such as SSH. For example, for a vSCP VNF, the floating IP address of the SMP should be used.      |     Yes             |                                       |
1146 +-----------------------------+-------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1147
1148 Payload Parameters for **VM Restart**
1149
1150 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1151 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
1152 +=====================+=========================================================================+=====================+====================================+
1153 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
1154 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |     "payload":                     |
1155 |                     |     link URL of the VM.                                                 |                     |                                    |
1156 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",  |
1157 |                     |                                                                         |                     |     \\"identity-url\\":            |
1158 |                     |                                                                         |                     |                                    |
1159 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"<IDENTITY-URL>\\",          |
1160 |     identity- url   |     The identity url used to access the resource                        |     No              |     \"tenant-id\": \"<TENANT-      |
1161 |                     |                                                                         |                     |     ID>\"}"                        |
1162 +---------------------+-------------------------------------------------------------------------+---------------------+                                    +
1163 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
1164 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1165
1166 Snapshot
1167 --------
1168
1169 Creates a snapshot of a VM.
1170
1171 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
1172
1173 This command can be applied to any VNF type. The only restriction is that the particular VNF should be built based on the generic heat stack.
1174
1175 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1176
1177 +------------------------------+-----------------------------------------------------------------------------------------------------+
1178 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:snapshot                                                 |
1179 +------------------------------+-----------------------------------------------------------------------------------------------------+
1180 |     **Action**               |     Snapshot                                                                                        |
1181 +------------------------------+-----------------------------------------------------------------------------------------------------+
1182 |     **Action-identifiers**   |     Vnf-id is required. If the snapshot is for a single VM, then the vserver-id is also required.   |
1183 +------------------------------+-----------------------------------------------------------------------------------------------------+
1184 |     **Payload Parameters**   |     `vm-id <#_bookmark52>`__, `identity-url <#_bookmark54>`__, `tenant-id <#_bookmark55>`__         |
1185 +------------------------------+-----------------------------------------------------------------------------------------------------+
1186 |     **Revision History**     |     Unchanged in this version.                                                                      |
1187 +------------------------------+-----------------------------------------------------------------------------------------------------+
1188
1189 Payload Parameters
1190
1191 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1192 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
1193 +=====================+=========================================================================+=====================+====================================+
1194 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
1195 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1196 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |     "payload":                     |
1197 |                     |     link URL of the VM.                                                 |                     |                                    |
1198 |                     |                                                                         |                     |     "{\\"vm-id\": \\"<VM-ID>       |
1199 |                     |                                                                         |                     |                                    |
1200 |                     |                                                                         |                     |     \\",                           |
1201 |                     |     link URL of the VM.                                                 |                     |     \\"identity-url\\":            |
1202 |                     |                                                                         |                     |                                    |
1203 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",          |
1204 +---------------------+-------------------------------------------------------------------------+---------------------+                                    +
1205 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
1206 |                     |                                                                         |                     |     ID>\\"}"                       |
1207 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1208 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
1209 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1210
1211 Snapshot Response
1212 ^^^^^^^^^^^^^^^^^
1213
1214 The Snapshot command returns an extended version of the LCM response.
1215
1216 The Snapshot response conforms to the `standard response format <#_bookmark5>`__, but has the following additional field.
1217
1218 Additional Parameters
1219
1220 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+---------------------------------------+
1221 |     **Parameter**   |     **Description**                                                                                                                                    |     **Required**   | **?Example**                          |
1222 +=====================+========================================================================================================================================================+====================+=======================================+
1223 |     snapshot-id     |     The snapshot identifier created by cloud host. This identifier will be returned only in the final success response returned via the message bus.   |     No             |     "snapshot-id": "<SNAPSHOT\_ID>"   |
1224 +---------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+--------------------+---------------------------------------+
1225
1226 Start
1227 -----
1228
1229 Use the Start command to start a VNF, VF-Module, or VM that is stopped or not running.
1230
1231 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1232
1233 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1234 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start                                                                               |
1235 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1236 |     **Action**               |     Start                                                                                                                      |
1237 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1238 |     **Action-identifiers**   |     Vnf-id is required; vf-module-id or vserver-id is also required if the action is at vf-module or vm level, respectively.   |
1239 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1240 |     **Payload Parameters**   |     None                                                                                                                       |
1241 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1242 |     **Revision History**     |     Revised in this version.                                                                                                   |
1243 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1244
1245 StartApplication
1246 ----------------
1247
1248 Starts the VNF application, if needed, after a VM is instantiated/configured or after VM start or restart. Supported using Chef cookbook or Ansible playbook only.
1249
1250 A successful StartApplication request returns a success response.
1251
1252 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
1253
1254 +------------------------------+---------------------------------------------------------------+
1255 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:startapplication   |
1256 +------------------------------+---------------------------------------------------------------+
1257 |     **Action**               |     StartApplication                                          |
1258 +------------------------------+---------------------------------------------------------------+
1259 |     **Action-Identifiers**   |     Vnf-id                                                    |
1260 +------------------------------+---------------------------------------------------------------+
1261 |     **Payload Parameters**   |     See below                                                 |
1262 +------------------------------+---------------------------------------------------------------+
1263 |     **Revision History**     |     New in this version.                                      |
1264 +------------------------------+---------------------------------------------------------------+
1265
1266 |
1267
1268 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1269 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1270 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1271 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server).   |     Yes             |     "payload":                                                  |
1272 |                                 |                                                                                                                                                                                    |                     |                                                                 |
1273 |                                 |                                                                                                                                                                                    |                     |     "{\\"request-parameters                                     |
1274 |                                 |                                                                                                                                                                                    |                     |     \\": {                                                      |
1275 |                                 |                                                                                                                                                                                    |                     |     \\"host-ip-address\\": \\”value\\”                          |
1276 |                                 |                                                                                                                                                                                    |                     |     }                                                           |
1277 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
1278 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1279 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1280 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1281
1282 StartApplication Response
1283 ^^^^^^^^^^^^^^^^^^^^^^^^^
1284
1285 The StartApplication response returns an indication of success or failure of the request.
1286
1287 Stop
1288 ----
1289
1290 Use the Stop command to start a VNF, VF-Module, or VM that is stopped or not running.
1291
1292 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1293
1294 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1295 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop                                                                                |
1296 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1297 |     **Action**               |     Stop                                                                                                                       |
1298 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1299 |     **Action-identifiers**   |     Vnf-id is required; vf-module-id or vserver-id is also required if the action is at vf-module or vm level, respectively.   |
1300 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1301 |     **Payload Parameters**   |     None                                                                                                                       |
1302 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1303 |     **Revision History**     |     Revised in this version.                                                                                                   |
1304 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1305
1306 StopApplication
1307 ---------------
1308
1309 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
1310
1311 A successful StopApplication request returns a success response.
1312
1313 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
1314
1315 +------------------------------+--------------------------------------------------------------+
1316 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stopapplication   |
1317 +------------------------------+--------------------------------------------------------------+
1318 |     **Action**               |     StopApplication                                          |
1319 +------------------------------+--------------------------------------------------------------+
1320 |     **Action-Identifiers**   |     Vnf-id                                                   |
1321 +------------------------------+--------------------------------------------------------------+
1322 |     **Payload Parameters**   |     See below                                                |
1323 +------------------------------+--------------------------------------------------------------+
1324 |     **Revision History**     |     New in this version.                                     |
1325 +------------------------------+--------------------------------------------------------------+
1326
1327 |
1328
1329 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1330 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1331 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1332 |     request- parameters         |     The parameters required to process the request must include the host-ip-address to connect to the VNF (for Chef and Ansible, this will be the url to connect to the server).   |     Yes             |     "payload":                                                  |
1333 |                                 |                                                                                                                                                                                    |                     |     "{\\"request-parameters                                     |
1334 |                                 |                                                                                                                                                                                    |                     |     \\": {                                                      |
1335 |                                 |                                                                                                                                                                                    |                     |     \\"host-ip-address\\": \\”va lue\\”                         |
1336 |                                 |                                                                                                                                                                                    |                     |     }                                                           |
1337 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
1338 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1339 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1340 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1341
1342 StopApplication Response
1343 ^^^^^^^^^^^^^^^^^^^^^^^^
1344
1345 The StopApplication response returns an indication of success or failure of the request.
1346
1347 Sync
1348 ----
1349
1350 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
1351
1352 A successful Sync returns a success status.
1353
1354 A failed Sync returns a failure response status and failure messages in the response payload block.
1355
1356 This command can be applied to any VNF type. The only restriction is that the VNF has been onboarded in self-service mode (which requires that the VNF supports a request to return the running configuration).
1357
1358 +------------------------------+---------------------------------------------------+
1359 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:sync   |
1360 +------------------------------+---------------------------------------------------+
1361 |     **Action**               |     Sync                                          |
1362 +------------------------------+---------------------------------------------------+
1363 |     **Action-identifiers**   |     Vnf-id                                        |
1364 +------------------------------+---------------------------------------------------+
1365 |     **Payload Parameters**   |     None                                          |
1366 +------------------------------+---------------------------------------------------+
1367 |     **Revision History**     |     Unchanged in this version.                    |
1368 +------------------------------+---------------------------------------------------+
1369
1370 Unlock
1371 ------
1372
1373 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
1374
1375 Unlock is a command intended for APPC and does not execute an actual VNF command. Instead, unlock will release the VNF from the exclusive access held by the specific request-id allowing other requests for the VNF to be accepted.
1376
1377 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
1378
1379 The Unlock command will only return success if the VNF was locked with same `request-id <#_bookmark4>`__.
1380
1381 The Unlock command returns only one final response with the status of the request processing.
1382
1383 Note: APPC locks the target VNF during any command processing. If an Unlock action is then requested on that VNF with a different request-id, it will be rejected because the VNF is already locked for another process, even though no actual lock command was explicitly invoked.
1384
1385 +------------------------------+-----------------------------------------------------+
1386 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:unlock   |
1387 +------------------------------+-----------------------------------------------------+
1388 |     **Action**               |     Unlock                                          |
1389 +------------------------------+-----------------------------------------------------+
1390 |     **Action-identifiers**   |     Vnf-id                                          |
1391 +------------------------------+-----------------------------------------------------+
1392 |     **Payload Parameters**   |     None                                            |
1393 +------------------------------+-----------------------------------------------------+
1394 |     **Revision History**     |     Unchanged in this version.                      |
1395 +------------------------------+-----------------------------------------------------+
1396