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

   1 .. ============LICENSE_START==========================================
   2 .. ===================================================================
   3 .. Copyright © 2017-2018 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).  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 message bus 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 message bus 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 ``APPC``.                                                       |                     |
 112 |                      |                                                                                                                |                     |
 113 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 114 | correlation- id      | Correlation ID used for associating responses in APPC Client Library.                                          |     Yes             |
 115 |                      | Built as: ``<request-id>-<sub-request-id>``                                                                    |                     |
 116 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 117 | rpc-name             | The target Remote Processing Call (RPC) name which should match the LCM command name. For example:``configure``|     Yes             |
 118 |                      |                                                                                                                |                     |
 119 |                      | The convention for RPC names and the target URL is that multi-word command names should have a dash between    |                     |
 120 |                      | words, e.g.,                                                                                                   |                     |
 121 |                      | /restconf/operations/appc-provider-lcm:action-status                                                           |                     |
 122 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 123 | type                 | Message type: request, response or error                                                                       |     Yes             |
 124 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 125 | body                 | Contains the input or output LCM command content, which is either the request or response                      |                     |
 126 |                      | The body field format is identical to the equivalent HTTP Rest API command based on the specific RPC name.     |     Yes             |
 127 |                      | For example::                                                                                                  |                     |
 128 |                      |                                                                                                                |                     |
 129 |                      |     {                                                                                                          |                     |
 130 |                      |     "input" : {                                                                                                |                     |
 131 |                      |                 "common-header" : {...}                                                                        |                     |
 132 |                      |                 "action" : "configure",                                                                        |                     |
 133 |                      |                 "action-identifiers" : {...},                                                                  |                     |
 134 |                      |                 "payload": "..."                                                                               |                     |
 135 |                      |     }                                                                                                          |                     |
 136 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 137
 138
 139 Generic Request Format
 140 ----------------------
 141
 142 The LCM API general request format is applicable for both POST HTTP API and for the message body received via the message bus.
 143
 144 LCM Request
 145 ^^^^^^^^^^^
 146
 147 The LCM request comprises a common header and a section containing the details of the LCM action.
 148 The LCM request conforms to the following structure::
 149
 150     {
 151     "input": {
 152                 "common-header": {"timestamp": "<TIMESTAMP>",
 153                                         "api-ver": "<API_VERSION>",
 154                                         "originator-id": "<SYSTEM_ID>",
 155                                         "request-id": "<REQUEST_ID>",
 156                                         "sub-request-id": "<SUBREQUEST_ID>",
 157                                         "flags": {
 158                                                    "mode": "<EXCLUSIVE|NORMAL>",
 159                                                    "force": "<TRUE|FALSE>",
 160                                                    "ttl": "<TTL_VALUE>"
 161                                                  }
 162                                  },
 163                 "action": "<COMMAND_ACTION>",
 164                 "action-identifiers": {
 165                                         "vnf-id": "<VNF_ID>",
 166                                         "vnfc-name": "<VNFC_NAME>",
 167                                         "vserver-id": "VSERVER_ID"
 168                                       },
 169                 ["payload": "<PAYLOAD>"]
 170              }
 171     }
 172
 173
 174 Table 2 LCM Request Fields
 175
 176 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 177 |     **Field**             |     **Description**                                                                                                                                                                                                                                                                                                                                                         |     **Required?**   |
 178 +===========================+=============================================================================================================================================================================================================================================================================================================================================================================+=====================+
 179 |     input                 |     The block that defines the details of the input to the command processing. Contains the common-header details.                                                                                                                                                                                                                                                          |     Yes             |
 180 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 181 |     common- header        |     The block that contains the generic details about a request.                                                                                                                                                                                                                                                                                                            |     Yes             |
 182 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 183 |     timestamp             |     The time of the request, in ISO 8601 format, ZULU offset. For example: 2016-08-03T08:50:18.97Z.                                                                                                                                                                                                                                                                         |     Yes             |
 184 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 185 |                           |     APPC will reject the request if timestamp is in the future (due to clock error), or timestamp is too old (compared to TTL flag)                                                                                                                                                                                                                                         |                     |
 186 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 187 |     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.                                                                                                                                                                                                                    |     Yes             |
 188 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 189 |                           |     2.00 should be used for all LCM API requests                                                                                                                                                                                                                                                                                                                            |                     |
 190 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 191 |     originator-id         |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                                                                                                                                                                               |     Yes             |
 192 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 193 |                           |     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.                                                                                                                                                                                           |                     |
 194 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 195 |     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             |
 196 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 197 |                           |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                                                                                                                                                                   |                     |
 198 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 199 |     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              |
 200 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 201 |     flags                 | Generic flags that apply to all LCM actions:                                                                                                                                                                                                                                                                                                                                |     No              |
 202 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 203 |                           | -  "MODE" :                                                                                                                                                                                                                                                                                                                                                                 |                     |
 204 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 205 |                           |    -  "EXCLUSIVE" - reject requests on this VNF while another request is in progress, or                                                                                                                                                                                                                                                                                    |                     |
 206 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 207 |                           |    -  "NORMAL" - allow requests (pending additional validations) on this VNF if there is another request is in progress.                                                                                                                                                                                                                                                    |                     |
 208 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 209 |                           | -  "FORCE" :                                                                                                                                                                                                                                                                                                                                                                |                     |
 210 |                           |       - **TRUE** – forces APPC to process the request regardless of whether there is another request for the VNF or VM in progress.                                                                                                                                                                                                                                         |                     |
 211 |                           |       - **FALSE** – default value. Will return an error if there is another action in progress on the same VNF or VM, unless the two actions are allowed in parallel based on a Request Management Model stored in APPC. The model allows some non-disruptive actions such as Lock, Unlock, CheckLock, and ActionStatus to be performed in conjunction with other actions.  |                     |
 212 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 213 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 214 |                           | -  "TTL": <0....N> - The timeout value is used to determine if the request timeout has been exceeded (i.e., if the TTL value is less than the current time minus the timestamp, the request is rejected). The value is in seconds.                                                                                                                                          |                     |
 215 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 216 |                           |     If no TTL value provided, the default/configurable TTL value is to be used.                                                                                                                                                                                                                                                                                             |                     |
 217 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 218 |     action                |     The action to be taken by APPC, for example: Test, Start                                                                                                                                                                                                                                                                                                                |     Yes             |
 219 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 220 |                           |     These are case-sensitive; e.g.,”Restart” is correct; “restart” is incorrect.                                                                                                                                                                                                                                                                                            |                     |
 221 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 222 |                           |     ***NOTE:** The specific value for the action parameter is provided for each command.                                                                                                                                                                                                                                                                                    |                     |
 223 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 224 |     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             |
 225 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 226 |     service-instance-id   |     Identifies a specific service instance that the command refers to. When multiple APPC instances are used and applied to a subset of services, this will become significant. The field is mandatory when the vnf-id is empty. Currently not used.                                                                                                                        |     No              |
 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. Currently not used.                                                                                                                                                                                                                              |     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:                                                                                                                                                                                                          |                     |
 239 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 240 |                           |        ``"{\" vnf-host-ip-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 Request Processing and Validation Logic
 250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 251
 252 When a new request is received, APPC applies the following validation logic. For any failure, the request is rejected and an error (300 range) is returned.
 253
 254 1. If the request has timeout (i.e., the difference between current
 255    time and the request timestamp value is greater than TTL value in
 256    request), a timeout error is returned.
 257
 258 2. If the request is a duplicate of an existing request in progress
 259    (same request-id, sub-request-id, originator-id), a duplicate error
 260    is returned.
 261
 262 3. If there is a Lock on the vnf-id, reject any new action if it is not
 263    associated with the locking request-id, a lockout error is returned.
 264
 265 4. If the Force flag = Y, then allow the new action regardless of
 266    whether there is an action in progress.
 267
 268 5. If the Mode flag = Exclusive on a request in progress, any new
 269    request is rejected until the request in progress is completed.
 270
 271 6. If request is received and there are one or more requests in
 272    progress, then the new request is evaluated to determine if there is
 273    any overlap in scope with the existing requests (for example, a new
 274    VNF level request would overlap with another request in progress).
 275
 276    a. If there is no overlap between the new request and requests in
 277       progress, the new request is accepted.
 278
 279    b. If there is overlap, then only special cases are allowed in
 280       parallel (for example, Audit and HealthCheck are allowed).
 281
 282
 283 Generic Response Format
 284 -----------------------
 285
 286
 287 This section describes the generic response format.
 288
 289 The response format is applicable for both POST HTTP API and for the message body received via the message bus.
 290
 291
 292 LCM Response
 293 ^^^^^^^^^^^^
 294
 295 The LCM response comprises a common header and a section containing the payload and action details.
 296
 297 The LCM response conforms to the following structure::
 298
 299     {
 300         "output": {
 301                     "common-header": {
 302                                         "api-ver": "<API_VERSION>",
 303                                         "flags": {
 304                                                    "ttl": <TTL_VALUE>,
 305                                                    "force": "<TRUE|FALSE>",
 306                                                    "mode": "<EXCLUSIVE|NORMAL>"
 307                                                  },
 308                                         "originator-id": "<SYSTEM_ID>",
 309                                         "request-id": "<REQUEST_ID>",
 310                                         "sub-request-id": "<SUBREQUEST_ID>",
 311                                         "timestamp": "2016-08-08T23:09:00.11Z",
 312                                      },
 313                     "payload": "<PAYLOAD>",
 314                     [Additional fields],
 315                     "status": {
 316                                 "code": <RESULT_CODE>,
 317                                 "message": "<RESULT_MESSAGE>"
 318                               }
 319                   }
 320     }
 321
 322
 323 Table 3 LCM Response Fields
 324
 325 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 326 |     **Field**        |     **Description**                                                                                                                                                                                                       |     **Required?**   |
 327 +======================+===========================================================================================================================================================================================================================+=====================+
 328 |     output           |     The block that defines the details of the output of the command processing. Contains the ``common-header`` details.                                                                                                   |     Yes             |
 329 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 330 |     common- header   |     The block that contains the generic details about a request.                                                                                                                                                          |     Yes             |
 331 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 332 |     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.                                                                  |     Yes             |
 333 |                      |                                                                                                                                                                                                                           |                     |
 334 |                      |     -  2.00 should be used for all LCM API requests                                                                                                                                                                       |                     |
 335 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 336 |     originator-id    |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                             |     Yes             |
 337 |                      |                                                                                                                                                                                                                           |                     |
 338 |                      |     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.                                         |                     |
 339 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 340 |     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             |
 341 |                      |                                                                                                                                                                                                                           |                     |
 342 |                      |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                 |                     |
 343 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 344 |     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              |
 345 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 346 |     timestamp        |     The time of the request, in ISO 8601 format, ZULU offset. For example: ``2016-08-03T08:50:18.97Z``.                                                                                                                   |     Yes             |
 347 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 348 |     status           |     The status describes the outcome of the command processing. Contains a ``code`` and a ``message`` providing success or failure details.                                                                               |     Yes             |
 349 |                      |                                                                                                                                                                                                                           |                     |
 350 |                      |     ***NOTE:** See* status *for code values.*                                                                                                                                                                             |                     |
 351 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 352 |     payload          |     An open-format field.                                                                                                                                                                                                 |     No              |
 353 |                      |                                                                                                                                                                                                                           |                     |
 354 |                      |     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\\"}"``.        |                     |
 355 |                      |                                                                                                                                                                                                                           |                     |
 356 |                      |     The payload is typically used to provide parametric data associated with the response to the command.                                                                                                                 |                     |
 357 |                      |                                                                                                                                                                                                                           |                     |
 358 |                      |     Note that not all LCM commands need have a payload.                                                                                                                                                                   |                     |
 359 |                      |                                                                                                                                                                                                                           |                     |
 360 |                      |     ***NOTE:** The specific value(s) for the response payload, where relevant, is provided for in each* command *description.*                                                                                            |                     |
 361 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 362 |     [Field name]     |     Additional fields can be provided in the response, if needed, by specific commands.                                                                                                                                   |     No              |
 363 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 364 |     code             |     A unique pre-defined value that identifies the exact nature of the success or failure status.                                                                                                                         |     No              |
 365 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 366 |     message          |     The description of the success or failure status.                                                                                                                                                                     |     No              |
 367 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 368
 369
 370 Status Codes
 371 ------------
 372
 373 The status code is returned in the response message as the ``code`` parameter, and the description as the message parameter.
 374
 375 The different responses are categorized as follows:
 376
 377 **ACCEPTED**
 378
 379     Request is valid and accepted for processing.
 380
 381 **ERROR**
 382
 383     Request invalid or incomplete.
 384
 385 **REJECT**
 386
 387     Request rejected during processing due to invalid data, such as an
 388     unsupported command.
 389
 390 **SUCCESS**
 391
 392     Request is valid and completes successfully.
 393
 394 **FAILURE**
 395
 396     The request processing resulted in failure.
 397
 398     A FAILURE response is always returned asynchronously via the message
 399     bus.
 400
 401 **PARTIAL SUCCESS**
 402
 403     The request processing resulted in partial success where at least
 404     one step in a longer process completed successfully.
 405
 406     A PARTIAL SUCCESS response is always returned asynchronously via the
 407     message bus.
 408
 409 **PARTIAL FAILURE**
 410
 411     The request processing resulted in partial failure.
 412
 413     A PARTIAL FAILURE response is always returned asynchronously via the
 414     message bus.
 415
 416 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 417 |     **Category**      |     **Code**   |     **Message / Description**                                                                                                        |
 418 +=======================+================+======================================================================================================================================+
 419 |     ACCEPTED          |     100        |     ACCEPTED - Request accepted                                                                                                      |
 420 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 421 |     ERROR             |     200        |     UNEXPECTED ERROR - ${detailedErrorMsg}                                                                                           |
 422 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 423 |     REJECT            |     300        |     REJECTED - ${detailedErrorMsg}                                                                                                   |
 424 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 425 |                       |     301        |     INVALID INPUT PARAMETER -${detailedErrorMsg}                                                                                     |
 426 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 427 |                       |     302        |     MISSING MANDATORY PARAMETER - Parameter ${paramName} is missing                                                                  |
 428 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 429 |                       |     303        |     REQUEST PARSING FAILED - ${detailedErrorMsg}                                                                                     |
 430 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 431 |                       |     304        |     NO TRANSITION DEFINED - No Transition Defined for ${actionName} action and ${currentState} state                                 |
 432 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 433 |                       |     305        |     ACTION NOT SUPPORTED - ${actionName} action is not supported                                                                     |
 434 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 435 |                       |     306        |     VNF NOT FOUND - VNF with ID ${vnfId} was not found                                                                               |
 436 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 437 |                       |     307        |     DG WORKFLOW NOT FOUND - No DG workflow found for the combination of ${dgModule} module ${dgName} name and ${dgVersion} version   |
 438 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 439 |                       |     308        |     WORKFLOW NOT FOUND - No workflow found for VNF type                                                                              |
 440 |                       |                |                                                                                                                                      |
 441 |                       |                |     ${vnfTypeVersion} and ${actionName} action                                                                                       |
 442 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 443 |                       |     309        |     UNSTABLE VNF - VNF ${vnfId} is not stable to accept the command                                                                  |
 444 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 445 |                       |     310        |     LOCKING FAILURE -${detailedErrorMsg}                                                                                             |
 446 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 447 |                       |     311        |     EXPIREDREQUEST. The request processing time exceeded the maximum available time                                                  |
 448 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 449 |                       |     312        |     DUPLICATEREQUEST. The request already exists                                                                                     |
 450 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 451 |                       |     313        |     MISSING VNF DATA IN A&AI - ${attributeName} not found for VNF ID =                                                               |
 452 |                       |                |                                                                                                                                      |
 453 |                       |                |     ${vnfId}                                                                                                                         |
 454 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 455 |                       |     315        |     MULTIPLE REQUESTS USING SEARCH CRITERIA: ${parameters}                                                                           |
 456 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 457 |                       |     316        |     POLICY VALIDATION FAILURE - Request rejected as per the request validation policy                                                |
 458 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 459 |     SUCCESS           |     400        |     The request was processed successfully                                                                                           |
 460 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 461 |     FAILURE           |     401        |     DG FAILURE - ${ detailedErrorMsg }                                                                                               |
 462 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 463 |                       |     402        |     NO TRANSITION DEFINED - No Transition Defined for ${ actionName} action and ${currentState} state                                |
 464 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 465 |                       |     403        |     UPDATE\_AAI\_FAILURE - failed to update AAI. ${errorMsg}                                                                         |
 466 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 467 |                       |     404        |     EXPIRED REQUEST FAILURE - failed during processing because TTL expired                                                           |
 468 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 469 |                       |     405        |     UNEXPECTED FAILURE - ${detailedErrorMsg}                                                                                         |
 470 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 471 |                       |     406        |     UNSTABLE VNF FAILURE - VNF ${vnfId} is not stable to accept the command                                                          |
 472 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 473 |                       |     450        |     REQUEST NOT SUPPORTED                                                                                                            |
 474 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 475 |     PARTIAL SUCCESS   |     500        |     PARTIAL SUCCESS                                                                                                                  |
 476 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 477 |     PARTIAL FAILURE   |     501 -      |     PARTIAL FAILURE                                                                                                                  |
 478 |                       |     599        |                                                                                                                                      |
 479 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 480
 481
 482 Malformed Message Response
 483 --------------------------
 484
 485 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.
 486
 487 **Response Format for Malformed Requests**::
 488
 489     {
 490       "errors": {
 491                   "error": [
 492                             {
 493                               "error-type": "protocol",
 494                               "error-tag": "malformed-message",
 495                               "error-message": "<ERROR-MESSAGE>",
 496                               "error-info": "<ERROR-INFO>"
 497                             }
 498                            ]
 499                 }
 500     }
 501
 502
 503 **Example Response**::
 504
 505     {
 506       "errors": {
 507                   "error": [
 508                             {
 509                               "error-type": "protocol",
 510                               "error-tag": "malformed-message",
 511                               "error-message": "Error parsing input: Invalid value 'Stopp' for
 512                                enum type. Allowed values are: [Sync, Audit, Stop, Terminate]",
 513                               "error-info": "java.lang.IllegalArgumentException: Invalid value
 514                                 'Stopp' for enum type. Allowed values are: [Sync, Audit, Stop,
 515                                 Terminate]..."
 516                             }
 517                            ]
 518                 }
 519     }
 520
 521
 522
 523 API Scope
 524 =========
 525
 526 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.
 527
 528
 529 Commands, or actions, can be performed at one or more of the following scope levels:
 530
 531
 532 +-----------------+----------------------------------------------------------------------------------------+
 533 | **VNF**         | Commands can be applied at the level of a specific VNF instance using the vnf-id.      |
 534 +-----------------+----------------------------------------------------------------------------------------+
 535 | **VF-Module**   | Commands can be applied at the level of a specific VF-Module using the vf-module-id.   |
 536 +-----------------+----------------------------------------------------------------------------------------+
 537 | **VNFC**        | Commands can be applied at the level of a specific VNFC instance using a vnfc-name.    |
 538 +-----------------+----------------------------------------------------------------------------------------+
 539 | **VM**          | Commands can be applied at the level of a specific VM instance using a vserver-id.     |
 540 +-----------------+----------------------------------------------------------------------------------------+
 541
 542
 543 **VNF/VM Types Supported**
 544
 545 Commands, or actions, may be currently supported on all VNF types or a limited set of VNF types. Note that the intent is to support all actions on all VNF types which have been successfully onboarded in a self-service mode.
 546
 547   - **Any** Currently supported on any vnf-type.
 548
 549   - **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.
 550
 551
 552 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 553 |     **Command**        | **VNF**   |  **VF-Module**   |     **VNFC**   | **VM**   |     **VNF/VM Types Supported**                             |
 554 +========================+===========+==================+================+==========+============================================================+
 555 |     ActionStatus       | Yes       |                  |                |          |     Any                                                    |
 556 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 557 |     AttachVolume       |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 558 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 559 |     Audit              | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 560 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 561 |     CheckLock          | Yes       |                  |                |          |     Any                                                    |
 562 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 563 |     Configure          | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 564 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 565 |     ConfigBackup       | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 566 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 567 |     ConfigModify       | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 568 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 569 |     ConfigRestore      | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 570 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 571 |     ConfigScaleOut     | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 572 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 573 |     DetachVolume       |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 574 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 575 |     Evacuate           |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 576 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 577 |     HealthCheck        | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 578 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 579 |     Lock               | Yes       |                  |                |          |     Any                                                    |
 580 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 581 |     Migrate            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 582 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 583 |     QuiesceTraffic     | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 584 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 585 |     Rebuild            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 586 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 587 |     Restart            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 588 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 589 |     ResumeTraffic      | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 590 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 591 |     Snapshot           |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 592 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 593 |     Start              |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 594 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 595 |     StartApplication   | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 596 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 597 |     Stop               |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 598 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 599 |     StopApplication    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 600 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 601 |     Sync               | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 602 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 603 |     Unlock             | Yes       |                  |                |          |     Any                                                    |
 604 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 605 |     UpgradeBackout     | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 606 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 607 |     UpgradeBackup      | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 608 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 609 |     UpgradePostCheck   | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 610 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 611 |     UpgradePreCheck    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 612 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 613 |     UpgradeSoftware    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 614 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 615
 616
 617
 618 Self-Service VNF Onboarding
 619 ---------------------------
 620
 621 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:
 622
 623 -  Netconf with uploadable Yang model (requires a Netconf server running
 624    on the VNF)
 625
 626 -  Chef (requires a Chef client running on the VNF)
 627
 628 -  Ansible (does not require any changes to the VNF software)
 629
 630 The self-service onboarding process is done using an APPC Design GUI (also referred to as CDT) 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:
 631
 632 -  Define the VNF capabilities (set of actions that the VNF can
 633    support).
 634
 635 -  Create a template and parameter definitions for actions which use the
 636    Netconf, Chef, or Ansible protocols. The template is an xml or JSON
 637    block which defines the “payload” which is included in the request
 638    that is downloaded the VNF (if Netconf) or Chef/Ansible server.
 639
 640 -  Test actions which have templates/parameter definitions.
 641
 642 -  Upload the VNF definition, template, and parameter definition
 643    artifacts to SDC which distributes them to all APPC instances in the
 644    same environment (e.g., production).
 645
 646 For more details, see the APPC CDT Onboarding User Guide.
 647
 648
 649
 650 LCM Commands
 651 ============
 652
 653 The LCM commands that are valid for the current release.
 654
 655 ActionStatus
 656 ------------
 657
 658 The ActionStatus command returns that state of any action request that has been previously submitted to an APPC instance for a specified VNF. This enables the client to know the status of a previous request and helps them decide if they should reissue a request.
 659
 660 +--------------------------+----------------------------------------------------------+
 661 | **Target URL**           | /restconf /operations/ appc-provider-lcm:action-status   |
 662 +--------------------------+----------------------------------------------------------+
 663 | **Action**               | ActionStatus                                             |
 664 +--------------------------+----------------------------------------------------------+
 665 | **Action-Identifiers**   | vnf-id                                                   |
 666 +--------------------------+----------------------------------------------------------+
 667 | **Payload Parameters**   | See below                                                |
 668 +--------------------------+----------------------------------------------------------+
 669 | **Revision History**     | New in Beijing                                           |
 670 +--------------------------+----------------------------------------------------------+
 671
 672 |
 673
 674 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 675 |     **Payload Parameter**   |     **Description**                                        |     **Required**   |     **Example**                     |
 676 +=============================+============================================================+====================+=====================================+
 677 | request-id                  |     Request id from the previously submitted request       | Yes                |     "request-id": "123456789"       |
 678 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 679 | sub-request ID              |     Sub-Request id from the previously submitted request   | optional           |     "sub-request-id": "123456789"   |
 680 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 681 | originator-id               |     Originator id from the previously submitted request    | optional           |     "originator-id": "123456789"    |
 682 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 683
 684
 685 ActionStatus Response:
 686 ^^^^^^^^^^^^^^^^^^^^^^
 687
 688 A successful response contains a payload with the following:
 689
 690 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 691 |     **Payload Parameter**   |     **Description**                                                   |     **Required**   |     **Example**              |
 692 +=============================+=======================================================================+====================+==============================+
 693 | status-reason               |     Contains more details about status                                | No                 |                              |
 694 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 695 | status                      |     IN_PROGRESS – The request has been accepted and is in progress    | No                 |     "status": "SUCCESSFUL"   |
 696 |                             |                                                                       |                    |                              |
 697 |                             |     SUCCESSFUL – The request returned success message                 |                    |                              |
 698 |                             |                                                                       |                    |                              |
 699 |                             |     FAILED – The request failed and returned an error message         |                    |                              |
 700 |                             |                                                                       |                    |                              |
 701 |                             |     ABORTED – the request aborted                                     |                    |                              |
 702 |                             |                                                                       |                    |                              |
 703 |                             |     NOT_FOUND – The request is not found                              |                    |                              |
 704 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 705
 706 If the ActionStatus request was rejected or could not be processed, it returns a valid error code or error message (but no payload).Example below:
 707
 708     ``"message": "MULTIPLE REQUESTS FOUND - using search criteria:
 709     request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
 710     vnf-id=ctsf0007v", "code": 315``
 711
 712 AttachVolume
 713 ------------
 714
 715 The AttachVolume command attaches a cinder volume to a VM via an Openstack command.
 716
 717 Cinder is a Block Storage service for OpenStack. It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self service API to request and consume those resources without requiring any knowledge of where their  storage is actually deployed or on what type of device.
 718
 719     NOTE: The command implementation is based on Openstack
 720     functionality. For further details, see
 721     http://developer.openstack.org/api-ref/compute/.
 722
 723 +--------------------------+----------------------------------------------------------+
 724 | **Target URL**           | /restconf/operations/appc-provider-lcm:attach-volume     |
 725 +--------------------------+----------------------------------------------------------+
 726 | **Action**               | AttachVolume                                             |
 727 +--------------------------+----------------------------------------------------------+
 728 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
 729 +--------------------------+----------------------------------------------------------+
 730 | **Payload Parameters**   | See table                                                |
 731 +--------------------------+----------------------------------------------------------+
 732 | **Revision History**     | New in Beijing                                           |
 733 +--------------------------+----------------------------------------------------------+
 734
 735 |
 736
 737 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 738 |     **Payload Parameter**   |     **Description**                                  |     **Required**   |     **Example**                                                                                                           |
 739 +=============================+======================================================+====================+===========================================================================================================================+
 740 | volumeId                    |     The UUID of the volume to attach.                | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",                                                                   |
 741 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 742 | device                      |     The device identifier                            | Yes                |     "device": "/dev/vdb"                                                                                                  |
 743 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 744 | vm-id                       |     TThe self- link URL of the VM.                   | Yes                |     "vm-id": http://135.25.246.162:8774/v2/64af07e991424b8e9e54eca27d5c0d48/servers/b074cd1b-8d53-412e-a102-351cc51ac10a" |
 745 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 746 | Identity-url                |     The identity URL used to access the resource     | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                     |
 747 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 748
 749 AttachVolume Response:
 750 ^^^^^^^^^^^^^^^^^^^^^^
 751
 752 Success: A successful AttachVolume returns a success status code 400.
 753
 754 Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include:
 755
 756 -  badRequest
 757 -  unauthorized
 758 -  forbidden
 759 -  itemNotFound
 760
 761
 762 Audit
 763 -----
 764
 765 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.
 766
 767 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
 768
 769 A failed Audit indicates that the configurations do not match.
 770
 771 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).
 772
 773 The Audit action does not require any payload parameters.
 774
 775 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
 776
 777
 778 +------------------------------+------------------------------------------------------+
 779 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:audit     |
 780 +------------------------------+------------------------------------------------------+
 781 |     **Action**               |     Audit                                            |
 782 +------------------------------+------------------------------------------------------+
 783 |     **Action-Identifiers**   |     vnf-id                                           |
 784 +------------------------------+------------------------------------------------------+
 785 |     **Payload Parameters**   |     See below                                        |
 786 +------------------------------+------------------------------------------------------+
 787 |     **Revision History**     |     Unchanged in this release.                       |
 788 +------------------------------+------------------------------------------------------+
 789
 790 |
 791
 792 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 793 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 794 +======================+===========================================================================================================================================================+=====================+==================================+
 795 |     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 message bus             |     Yes             |     "publish-config": "<Y\|N>"   |
 796 |                      |                                                                                                                                                           |                     |                                  |
 797 |                      |     \* If the publish\_config field is set to N in the payload, then:                                                                                     |                     |                                  |
 798 |                      |                                                                                                                                                           |                     |                                  |
 799 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration                      |                     |                                  |
 800 |                      |                                                                                                                                                           |                     |                                  |
 801 |                      |     - If the result of the audit is ‘no match’, then send the running configuration                                                                       |                     |                                  |
 802 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 803
 804 Audit Response
 805 ^^^^^^^^^^^^^^
 806
 807 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 bus which may be received by an external configuration storage system.
 808
 809
 810 CheckLock
 811 ---------
 812
 813 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
 814
 815 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.
 816
 817 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.
 818
 819 The CheckLock command returns a specific response structure that extends the default LCM response.
 820
 821 The CheckLock action does not require any payload parameters.
 822
 823 +------------------------------+--------------------------------------------------------+
 824 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:checklock   |
 825 +------------------------------+--------------------------------------------------------+
 826 |     **Action**               |     CheckLock                                          |
 827 +------------------------------+--------------------------------------------------------+
 828 |     **Action-Identifiers**   |     vnf-id                                             |
 829 +------------------------------+--------------------------------------------------------+
 830 |     **Payload Parameters**   |     None                                               |
 831 +------------------------------+--------------------------------------------------------+
 832 |     **Revision History**     |     Unchanged in this release.                         |
 833 +------------------------------+--------------------------------------------------------+
 834
 835 CheckLock Response
 836 ^^^^^^^^^^^^^^^^^^
 837
 838 The CheckLock command returns a customized version of the LCM
 839 response.
 840
 841
 842 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 843 |     **Parameter**   |     **Description**                                                                   |     **Required**   | **?Example**                    |
 844 +=====================+=======================================================================================+====================+=================================+
 845 |     locked          |     "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE.   |     No             |     "locked": "<TRUE\|FALSE>"   |
 846 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 847
 848
 849 **Example**::
 850
 851     {
 852       "output": {
 853                   "status": {
 854                               "code": <RESULT_CODE>, "message": "<RESULT_MESSAGE>"
 855                             },
 856                   "common-header": {
 857                                      "api-ver": "<API_VERSION>",
 858                                      "request-id": "<ECOMP\_REQUEST_ID>", "originator-id":
 859                                      "<ECOMP_SYSTEM_ID>",
 860                                      "sub-request-id": "<ECOMP_SUBREQUEST_ID>", "timestamp":
 861                                      "2016-08-08T23:09:00.11Z",
 862                                      "flags": {
 863                                                 "ttl": <TTL_VALUE>, "force": "<TRUE|FALSE>",
 864                                                 "mode": "<EXCLUSIVE|NORMAL>"
 865                                               }
 866                                    },
 867                   "locked": "<TRUE|FALSE>"
 868     }
 869
 870
 871 Configure
 872 ---------
 873
 874 Configure a VNF or a VNFC on the VNF after instantiation.
 875
 876 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.
 877
 878 A successful Configure request returns a success response.
 879
 880 A failed Configure action returns a failure response and the specific failure messages in the response block.
 881
 882 +------------------------------+--------------------------------------------------------+
 883 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configure   |
 884 +------------------------------+--------------------------------------------------------+
 885 |     **Action**               |     Configure                                          |
 886 +------------------------------+--------------------------------------------------------+
 887 |     **Action-Identifiers**   |     vnf-id                                             |
 888 +------------------------------+--------------------------------------------------------+
 889 |     **Payload Parameters**   |     See below                                          |
 890 +------------------------------+--------------------------------------------------------+
 891 |     **Revision History**     |     Unchanged in this release.                         |
 892 +------------------------------+--------------------------------------------------------+
 893
 894 |
 895
 896 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 897 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                            |     **Required?**   |     **Example**                                                 |
 898 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 899 +=================================+================================================================================================================================================================================================================+=====================+=================================================================+
 900 |     request-parameters          |     vnf-host-ip-address: optional if Netconf or other direct interface to the VNF.   If not provided, APPC will look for the host-ip-address in the A&AI VNF oam ipv4 address field.                           |     No              |                                                                 |
 901 |                                 |                                                                                                                                                                                                                |                     |     "payload":                                                  |
 902 |                                 |     vnfc-type:  must be included if template is vnfc specific                                                                                                                                                  |                     |     "{ \\"request-parameters                                    |
 903 |                                 |                                                                                                                                                                                                                |                     |     \\": {                                                      |
 904 |                                 |                                                                                                                                                                                                                |                     |     \\"vnf-host-ip-address\\":                                  |
 905 |                                 |                                                                                                                                                                                                                |                     |     \\”value\\”,                                                |
 906 |                                 |                                                                                                                                                                                                                |                     |     \\”vnfc-type\\”: \\”value\\”’                               |
 907 |                                 |                                                                                                                                                                                                                |                     |     }                                                           |
 908 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 909 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 910 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 911 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 912 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 913 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 914 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 915 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 916 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 917 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
 918 |     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              |      \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}  |
 919 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 920
 921
 922 Configure Response
 923 ^^^^^^^^^^^^^^^^^^
 924
 925 The Configure response returns an indication of success or failure of the request.
 926
 927 **Success:** A successful Configure returns a success status code 400.
 928 **Failure:** A failed Configure returns a failure code 401 and the failure message.
 929
 930 If successful, the return payload contains the ‘upload_config_id’ and values for any records created in the APPC DB. In addition, the configuration is sent to the ONAP Data Router bus  which may be received by an external configuration storage system.
 931
 932 If APPC in unable to update A&AI with the VNFC records, a 501 intermediate error message returned prior to the final 400 or 401 success message.
 933
 934 ConfigModify
 935 ------------
 936
 937 Modifies the configuration on a VNF or VNFC in service.
 938
 939 This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook.
 940
 941 Request Structure:
 942
 943 +--------------------------+--------------------------------------------------------+
 944 | **Target URL**           | /restconf/operations/appc-provider-lcm:config-modify   |
 945 +--------------------------+--------------------------------------------------------+
 946 | **Action**               | ConfigModify                                           |
 947 +--------------------------+--------------------------------------------------------+
 948 | **Action-Identifiers**   | vnf-id                                                 |
 949 +--------------------------+--------------------------------------------------------+
 950 | **Payload Parameters**   | request-parameters, configuration-parameters           |
 951 +--------------------------+--------------------------------------------------------+
 952 | **Revision History**     | Unchanged in this release.                             |
 953 +--------------------------+--------------------------------------------------------+
 954
 955 Request Payload Parameters:
 956
 957 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
 958 | **Payload Parameter**   | **Description**                        | **Required?**   |     **Example**                                       |
 959 +=========================+========================================+=================+=======================================================+
 960 | request-parameters      | vnf-host-ip-address: optional if       | No              |     "payload":                                        |
 961 |                         | Netconf or other direct interface      |                 |     "{\\"request-parameters \\":                      |
 962 |                         | to the VNF. If not provided, it is     |                 |     {\\"vnf-host-ip-address\\": \\”value\\",          |
 963 |                         | obtained from A&AI                     |                 |     \\”vnfc-type\\”: \\”value\\”                      |
 964 |                         |                                        |                 |     }                                                 |
 965 |                         |                                        |                 |                                                       |
 966 |                         | vnfc-type: must be included if template|                 |                                                       |
 967 |                         | is vnfc specific                       |                 |                                                       |
 968 |                         |                                        |                 |     \\"configuration- parameters\\": {\\"name1\\":    |
 969 |                         |                                        |                 |     \\”value1\\”,\\"name2\\":                         |
 970 |                         |                                        |                 |     \\”value2\\”                                      |
 971 |                         |                                        |                 |     }                                                 |
 972 |                         |                                        |                 |     }                                                 |
 973 +-------------------------+----------------------------------------+-----------------+                                                       |
 974 | configuration-          | A set of instance specific             | No              |                                                       |
 975 | parameters              | configuration parameters should        |                 |                                                       |
 976 |                         | be specified.                          |                 |                                                       |
 977 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
 978
 979 ConfigModify Response
 980 ^^^^^^^^^^^^^^^^^^^^^
 981
 982 **Success:** A successful ConfigModify returns a success status code 400.
 983
 984 If successful, the return payload contains the ‘upload_config_id’ and values associated with the configuration stored in the APPC DB. In addition, the configuration is sent to the message bus which may be received by an external configuration storage system.
 985
 986 **Failure:** A failed ConfigModify returns a failure code 401 and the failure message.
 987
 988 ConfigBackup
 989 ------------
 990
 991 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).
 992
 993 A successful ConfigBackup request returns a success response.
 994
 995 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
 996
 997 +------------------------------+-----------------------------------------------------------+
 998 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configbackup   |
 999 +------------------------------+-----------------------------------------------------------+
1000 |     **Action**               |     ConfigBackup                                          |
1001 +------------------------------+-----------------------------------------------------------+
1002 |     **Action-Identifiers**   |     Vnf-id                                                |
1003 +------------------------------+-----------------------------------------------------------+
1004 |     **Payload Parameters**   |     See below                                             |
1005 +------------------------------+-----------------------------------------------------------+
1006 |     **Revision History**     |     Unchanged in this release.                            |
1007 +------------------------------+-----------------------------------------------------------+
1008
1009 |
1010
1011 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1012 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                   |
1013 +=================================+====================================================================================================================================================================================+=====================+===================================================================+
1014 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              | "payload": \\"configuration-parameters\\": {\\"<CONFIG-PARAMS>\\"}|
1015 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1016 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1017 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1018 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1019 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1020 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                   |
1021 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                   |
1022 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1023
1024 ConfigBackup Response
1025 ^^^^^^^^^^^^^^^^^^^^^
1026
1027 The ConfigBackup response returns an indication of success or failure of the request.
1028
1029 **Success:** A successful ConfigBackup returns a success status code 400.
1030 **Failure:** A failed ConfigBackup returns a failure code 401 and the failure message.
1031
1032
1033 ConfigRestore
1034 -------------
1035
1036 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
1037
1038 A successful ConfigRestore request returns a success response.
1039
1040 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
1041
1042 +------------------------------+------------------------------------------------------------------------------------------+
1043 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-restore                                |
1044 +------------------------------+------------------------------------------------------------------------------------------+
1045 |     **Action**               |     ConfigRestore                                                                        |
1046 +------------------------------+------------------------------------------------------------------------------------------+
1047 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1048 +------------------------------+------------------------------------------------------------------------------------------+
1049 |     **Payload Parameters**   |     See below                                                                            |
1050 +------------------------------+------------------------------------------------------------------------------------------+
1051 |     **Revision History**     |     Unchanged in this release.                                                           |
1052 +------------------------------+------------------------------------------------------------------------------------------+
1053
1054 |
1055
1056 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1057 |     **Parameter**               |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1058 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1059 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              |     "payload":                                                  |
1060 |                                 |                                                                                                                                                                                    |                     |     \\"configuration-parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
1061 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1062 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1063 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1064
1065 ConfigRestore Response
1066 ^^^^^^^^^^^^^^^^^^^^^^
1067
1068 **Success:** A successful ConfigRestore returns a success status code 400.
1069
1070 If successful, the return payload contains the ‘upload_config_id’ and values associated with the configuration stored in the APPC DB.  In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system.
1071
1072 **Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
1073
1074
1075
1076 ConfigScaleOut
1077 --------------
1078
1079 The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow. Actions could include updating the VNF configuration or running a set of other tasks.
1080
1081 The ConfigScaleOut action can have multiple APPC templates associated with it.  APPC retrieves the VfModuleModelName from A&AI (model.model-vers.model-name), which is used as the unique identifier to select the correct APPC template.
1082 APPC creates or updates VNFC records in A&AI for the newly instantiated VM’s.  The orchestration-status of the VNFC’s is set to CONFIGURED.
1083
1084 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1085
1086 |
1087
1088 +------------------------------+------------------------------------------------------------------------------------------+
1089 |     **Target URL**           |     /restconf /operations/appc-provider-lcm:config-scale-out                             |
1090 +------------------------------+------------------------------------------------------------------------------------------+
1091 |     **Action**               |     ConfigScaleOut                                                                       |
1092 +------------------------------+------------------------------------------------------------------------------------------+
1093 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1094 +------------------------------+------------------------------------------------------------------------------------------+
1095 |     **Payload Parameters**   |     See below                                                                            |
1096 +------------------------------+------------------------------------------------------------------------------------------+
1097 |     **Revision History**     |     New in Beijing                                                                       |
1098 +------------------------------+------------------------------------------------------------------------------------------+
1099
1100 |
1101
1102 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1103 |     **Payload Parameter**       |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                             |
1104 +=================================+==================================================================================================================================================================+=====================+=============================================+
1105 |     request-parameters          |     vnf-host-ip-address: optional if Netconf or other direct interface to the VNF.   If not provided, the vnf-host-ip-address will be obtained from A&AI.        |     No              |      "payload":                             |
1106 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      "{\\"request-parameters \\":           |
1107 |                                 |     vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleOut.                                                                       |     Yes             |      {                                      |
1108 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\"vnf-host-ip-address\\":             |
1109 |                                 |     controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleOut.                            |                     |      \\”value\\”,                           |
1110 |                                 |     Will be needed if A&AI does not contain the template identifier.                                                                                             |     No              |      \\”vf-module-id\\”: \\”value\\”,       |
1111 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\”controller-template-id\\”:          |
1112 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the        |     No              |      \\”value\\”                            |
1113 |                                 |     values supplied.                                                                                                                                             |                     |      }                                      |
1114 |                                 |                                                                                                                                                                  |                     |                                             |
1115 |                                 |                                                                                                                                                                  |                     |      \\"configuration-parameters\\":        |
1116 |                                 |                                                                                                                                                                  |                     |        {\\"<CONFIG- PARAMS>\\"}             |
1117 |                                 |                                                                                                                                                                  |                     |                                             |
1118 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1119
1120 ConfigScaleOut Response
1121 ^^^^^^^^^^^^^^^^^^^^^^^
1122
1123 **Success:**
1124
1125  - A successful ConfigScaleOut returns a success status code 400 when completed.
1126
1127 **Failure:**
1128
1129  - A failed ConfigScaleOut returns a failure code 401 and the failure message.
1130  - If the ConfigScaleOut is successfully performed on the VNF but there is a failure to update A&AI inventory, an intermediate failure message with failure code 501 is returned prior to the final 400 success message.
1131
1132
1133 DetachVolume
1134 ------------
1135
1136 The DetachVolume command detaches a cinder volume from a VM via an Openstack command.
1137
1138 Cinder is a Block Storage service for OpenStack. It's designed to present storage resources to end users that can be consumed by the OpenStack Compute Project (Nova). The short description of Cinder is that it virtualizes the management of block storage devices and provides end users with a self-service API to request and consume those resources without requiring any knowledge of where their storage is actually deployed or on what type of device.
1139
1140 NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1141
1142 +--------------------------+----------------------------------------------------------+
1143 | **Target URL**           | /restconf/operations/appc-provider-lcm:detach-volume     |
1144 +--------------------------+----------------------------------------------------------+
1145 | **Action**               | DetachVolume                                             |
1146 +--------------------------+----------------------------------------------------------+
1147 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
1148 +--------------------------+----------------------------------------------------------+
1149 | **Payload Parameters**   | See table                                                |
1150 +--------------------------+----------------------------------------------------------+
1151 | **Revision History**     | New in Beijing                                           |
1152 +--------------------------+----------------------------------------------------------+
1153
1154 Request Payload Parameters:
1155
1156 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1157 |     **Payload Parameter**   |     **Description**                                            |     **Required**   |     **Example**                                                                                                                |
1158 +=============================+================================================================+====================+================================================================================================================================+
1159 | volumeId                    |     The UUID of the volume to detach.                          | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"                                                                         |
1160 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1161 | vm-id                       |     The self- link URL of the VM.                              | Yes                |     "vm-id": http://135.25.246.162:8774/v2/64af07e991424b8e9e54eca27d5c0d48/servers/b074cd1b-8d53-412e-a102-351cc51ac10a"      |
1162 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1163 | Identity-url                |     The identity URL used to access the resource               | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                          |
1164 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1165
1166 DetachVolume Response:
1167 ^^^^^^^^^^^^^^^^^^^^^^
1168
1169 **Success:** A successful DetachVolume returns a success status code 400.
1170
1171 **Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include:
1172
1173         -  badRequest
1174         -  unauthorized
1175         -  forbidden
1176         -  itemNotFound
1177         -  conflict
1178
1179
1180 Evacuate
1181 --------
1182
1183 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).
1184
1185 The host on which the VM resides needs to be down.
1186
1187 If the target host 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.
1188
1189 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm` parameter to false.
1190
1191 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
1192
1193 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1194
1195 +------------------------------+-------------------------------------------------------------------------+
1196 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:evacuate                     |
1197 +------------------------------+-------------------------------------------------------------------------+
1198 |     **Action**               |     Evacuate                                                            |
1199 +------------------------------+-------------------------------------------------------------------------+
1200 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                  |
1201 +------------------------------+-------------------------------------------------------------------------+
1202 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id, rebuild-vm, targethost-id           |
1203 +------------------------------+-------------------------------------------------------------------------+
1204 |     **Revision History**     |     Unchanged in this release.                                          |
1205 +------------------------------+-------------------------------------------------------------------------+
1206
1207 |
1208
1209 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1210 |     **Parameter**    |     **Description**                                                                                                                                                              |     **Required?**   |     **Example**                       |
1211 +======================+==================================================================================================================================================================================+=====================+=======================================+
1212 |     vm-id            |     The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self-link URL of the VM.                                                         |     Yes             |     "payload":                        |
1213 |                      |                                                                                                                                                                                  |                     |     "{\\"vm-id\\": \\"<VM-ID>         |
1214 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1215 |                      |                                                                                                                                                                                  |                     |     \\"identity-url\\":               |
1216 |                      |                                                                                                                                                                                  |                     |     \\"<IDENTITY-URL>\\",             |
1217 |                      |                                                                                                                                                                                  |                     |     \\"tenant-id\\": \\"<TENANT-ID>   |
1218 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1219 |                      |                                                                                                                                                                                  |                     |     \\"rebuild-vm\\": \\"false\\",    |
1220 |                      |                                                                                                                                                                                  |                     |     \\"targethost-id\\":              |
1221 |                      |                                                                                                                                                                                  |                     |     \\"nodeblade7\\"}"                |
1222 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1223 |     identity-url     |     The identity URL used to access the resource                                                                                                                                 |     Yes             |                                       |
1224 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1225 |     tenant-id        |     The id of the provider tenant that owns the resource                                                                                                                         |     Yes             |                                       |
1226 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1227 |     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              |                                       |
1228 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1229 |     targethost- id   |     A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host.                                                              |     No              |                                       |
1230 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1231
1232 Evacuate Response:
1233 ^^^^^^^^^^^^^^^^^^
1234 **Success:** A successful Evacuate returns a success status code 400.
1235 **Failure:** A failed Evacuate returns a failure code 401 and the failure message.
1236
1237
1238
1239 HealthCheck
1240 -----------
1241
1242 This command runs a VNF health check and returns the result.
1243
1244 The VNF level HealthCheck is a check over the entire scope of the VNF. The VNF must be 100% healthy, ready to take requests and provide services, with all VNF required capabilities ready to provide services and with all active and standby resources fully ready with no open MINOR, MAJOR or CRITICAL alarms.
1245
1246
1247 +------------------------------+-----------------------------------------------------------+
1248 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:health-check   |
1249 +------------------------------+-----------------------------------------------------------+
1250 |     **Action**               |     HealthCheck                                           |
1251 +------------------------------+-----------------------------------------------------------+
1252 |     **Action-Identifiers**   |     Vnf-id                                                |
1253 +------------------------------+-----------------------------------------------------------+
1254 |     **Payload Parameters**   |     See below                                             |
1255 +------------------------------+-----------------------------------------------------------+
1256 |     **Revision History**     |     Unchanged in this release                             |
1257 +------------------------------+-----------------------------------------------------------+
1258
1259
1260 Request Payload Parameters:
1261
1262 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1263 |     **Parameter**   |     **Description**               |     **Required?**   |     **Example**                     |
1264 +=====================+===================================+=====================+=====================================+
1265 | request-parameters  |     host-ip-address -             |     No              |  "payload":                         |
1266 |                     |     Required only if REST         |                     |  "{\\"request-parameters \\":       |
1267 |                     |     service. This is the ip       |                     |  "{\\"host-ip-address\\":           |
1268 |                     |     address associated with the   |                     |  \\"10.222.22.2\\" }"               |
1269 |                     |     VM running the REST           |                     |                                     |
1270 |                     |     service.                      |                     |                                     |
1271 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1272
1273
1274 HealthCheck Response
1275 ^^^^^^^^^^^^^^^^^^^^
1276
1277 **Success:** The HealthCheck returns a 400 success message if the test completes. A JSON payload is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information.
1278
1279     Examples::
1280
1281                 {
1282                   "identifier": "scope represented",
1283                   "state": "healthy",
1284                   "time": "01-01-1000:0000"
1285
1286                 }
1287
1288                 {
1289                    "identifier": "scope represented",
1290                    "state": "unhealthy",
1291                         {[
1292                    "info": "System threshold exceeded details",
1293                    "fault":
1294                          {
1295                            "cpuOverall": 0.80,
1296                            "cpuThreshold": 0.45
1297                          }
1298                         ]},
1299                    "time": "01-01-1000:0000"
1300                 }
1301
1302 **Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
1303
1304
1305 Lock
1306 ----
1307
1308 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1309
1310 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.
1311
1312 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.
1313
1314 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.
1315
1316 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.
1317
1318 The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file
1319
1320 +------------------------------+---------------------------------------------------+
1321 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:lock   |
1322 +------------------------------+---------------------------------------------------+
1323 |     **Action**               |     Lock                                          |
1324 +------------------------------+---------------------------------------------------+
1325 |     **Action-Identifier**    |     Vnf-id                                        |
1326 +------------------------------+---------------------------------------------------+
1327 |     **Payload Parameters**   |     None                                          |
1328 +------------------------------+---------------------------------------------------+
1329 |     **Revision History**     |     Unchanged in this release.                    |
1330 +------------------------------+---------------------------------------------------+
1331
1332 Lock Response
1333 ^^^^^^^^^^^^^
1334
1335 The Lock returns a 400 Success response if the Lock is successfully applied.
1336
1337 The Lock returns a 401 Failure response with the failure message if the Lock is not successful.
1338
1339
1340 Migrate
1341 -------
1342
1343 Migrates a running target VM from its current host to another.
1344
1345 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1346
1347 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.
1348
1349 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.
1350
1351
1352 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1353
1354
1355 +--------------------------------+-----------------------------------------------------------------------------------------------+
1356 | **Input Block**                | api-ver should be set to 2.00 for current version of Migrate                                  |
1357 +--------------------------------+-----------------------------------------------------------------------------------------------+
1358 |     **Target URL**             |     /restconf/operations/appc-provider-lcm:migrate                                            |
1359 +--------------------------------+-----------------------------------------------------------------------------------------------+
1360 |     **Action**                 |     Migrate                                                                                   |
1361 +--------------------------------+-----------------------------------------------------------------------------------------------+
1362 |     **Action-Identifiers**     |     Vnf-id, vserver-id                                                                        |
1363 +--------------------------------+-----------------------------------------------------------------------------------------------+
1364 |     **Payload Parameters**     |     vm-id, identity-url, tenant-id                                                            |
1365 +--------------------------------+-----------------------------------------------------------------------------------------------+
1366 |     **Revision History**       |     Unchanged in this release.                                                                |
1367 +--------------------------------+-----------------------------------------------------------------------------------------------+
1368
1369 Payload Parameters
1370
1371 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1372 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                               |
1373 +=====================+=========================================================================+=====================+===============================================+
1374 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                               |
1375 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                               |
1376 |                     |     link URL of the VM.                                                 |                     |     "payload":                                |
1377 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",             |
1378 |                     |                                                                         |                     |     \\"identity-url\\":                       |
1379 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",                     |
1380 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"tenant-id\\": \\"<TENANT-ID>\\"}"      |
1381 |     identity- url   |     The identity url used to access the resource                        |     Yes             |                                               |
1382 |                     |                                                                         |                     |                                               |
1383 +---------------------+-------------------------------------------------------------------------+---------------------+                                               |
1384 |     tenant-id       |     The id of the provider tenant that owns the resource                |     Yes             |                                               |
1385 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1386
1387
1388 Migrate Response
1389 ^^^^^^^^^^^^^^^^
1390
1391 **Success:** A successful Migrate returns a success status code 400.
1392
1393 **Failure:** A failed Migrate returns a failure code 401 and the failure message.
1394
1395
1396 QuiesceTraffic
1397 --------------
1398
1399 The QuiesceTraffic LCM action gracefully stops the traffic on the VNF (i.e., no service interruption for traffic in progress). All application processes are assumed to be running but no traffic is being processed.
1400
1401 This command is executed using an Ansible playbook or Chef cookbook.
1402
1403 Request Structure:
1404
1405 +--------------------------+----------------------------------------------------------+
1406 | **Target URL**           | /restconf/operations/appc-provider-lcm:quiesce-traffic   |
1407 +--------------------------+----------------------------------------------------------+
1408 | **Action**               | QuiesceTraffic                                           |
1409 +--------------------------+----------------------------------------------------------+
1410 | **Action-identifiers**   | vnf-id                                                   |
1411 +--------------------------+----------------------------------------------------------+
1412 | **Payload Parameters**   | operations-timeout                                       |
1413 +--------------------------+----------------------------------------------------------+
1414 | **Revision History**     | New in Beijing                                           |
1415 +--------------------------+----------------------------------------------------------+
1416
1417 Request Payload Parameters:
1418
1419 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
1420 | **Parameter**         |     **Description**                                                                                                                                                                                  |     **Required?**   |     **Example**                                |
1421 +=======================+======================================================================================================================================================================================================+=====================+================================================+
1422 | operations-timeout    |     This is the maximum time in seconds that the command will run before APPC returns a timeout error. If the APPC template has a lower timeout value, the APPC template timeout value is applied.   |     Yes             |     "payload":                                 |
1423 |                       |                                                                                                                                                                                                      |                     |     "{\\"operations-timeout\\": \\"3600\\"}”   |
1424 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
1425
1426 QuiesceTraffic Response
1427 ^^^^^^^^^^^^^^^^^^^^^^^
1428
1429 The response does not include any payload parameters.
1430
1431 **Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced.
1432
1433    If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status.
1434
1435 **Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1436
1437     A specific error message is returned if there is a timeout error.
1438
1439
1440
1441 Rebuild
1442 -------
1443
1444 Recreates a target VM instance to a known, stable state.
1445
1446 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
1447
1448 Rebuild VM uses the snapshot provided by the snapshot-id (if provided).  If not provided, the latest snapshot is used.  If there are no snapshots, it uses the (original) Glance image.
1449
1450 APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume
1451
1452
1453 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1454
1455
1456 +------------------------------+-----------------------------------------------------------------------------------------------+
1457 | **Input Block**              | api-ver should be set to 2.00 for current version of Rebuild                                  |
1458 +------------------------------+-----------------------------------------------------------------------------------------------+
1459 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:rebuild                                            |
1460 +------------------------------+-----------------------------------------------------------------------------------------------+
1461 |     **Action**               |     Rebuild                                                                                   |
1462 +------------------------------+-----------------------------------------------------------------------------------------------+
1463 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
1464 +------------------------------+-----------------------------------------------------------------------------------------------+
1465 |     **Payload Parameters**   |     See table below                                                                           |
1466 +------------------------------+-----------------------------------------------------------------------------------------------+
1467 |     **Revision History**     |     Unchanged in this release.                                                                |
1468 +------------------------------+-----------------------------------------------------------------------------------------------+
1469
1470
1471 Payload Parameters
1472
1473 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1474 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1475 +=================+===============================================+=================+=========================================+
1476 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1477 |                 |     the resource. For backwards-              |                 |                                         |
1478 |                 |     compatibility, this can be the self-      |                 | "payload":                              |
1479 |                 |     link URL of the VM.                       |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1480 |                 |                                               |                 | \\",                                    |
1481 |                 |                                               |                 | \\"identity-url\\":                     |
1482 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1483 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1484 +-----------------+-----------------------------------------------+-----------------+ \\"snapshot-id\\": \\"<SNAPSHOT- ID>\\" |
1485 | identity- url   |     The identity url used to access the       | Yes             | }"                                      |
1486 |                 |     resource.                                 |                 |                                         |
1487 +-----------------+-----------------------------------------------+-----------------+                                         |
1488 | tenant-id       |     The id of the provider tenant that owns   | Yes             |                                         |
1489 |                 |     the resource.                             |                 |                                         |
1490 +-----------------+-----------------------------------------------+-----------------+                                         |
1491 | snapshot-id     |  The snapshot-id of a previously saved image. | No              |                                         |
1492 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1493
1494 Rebuild Response
1495 ^^^^^^^^^^^^^^^^
1496
1497 **Success:** A successful Rebuild returns a success status code 400.
1498
1499 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
1500
1501 Restart
1502 -------
1503
1504 Use the Restart command to restart a VM.
1505
1506 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1507 |     **Input Block**          |     api-ver should be set to 2.00 for current version of Restart                                                |
1508 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1509 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:restart                                                              |
1510 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1511 |     **Action**               |     Restart                                                                                                     |
1512 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1513 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                          |
1514 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1515 |     **Payload Parameters**   |     See table below                                                                                             |
1516 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1517 |     **Revision History**     |     Unchanged in this release                                                                                   |
1518 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1519
1520 Payload Parameters for **VM Restart**
1521
1522 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1523 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
1524 +=====================+=========================================================================+=====================+====================================+
1525 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
1526 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                    |
1527 |                     |     link URL of the VM                                                  |                     |     "payload":                     |
1528 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",  |
1529 |                     |                                                                         |                     |     \\"identity-url\\":            |
1530 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"<IDENTITY-URL>\\",          |
1531 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
1532 |                     |                                                                         |                     |     ID>\\"}"                       |
1533 +---------------------+-------------------------------------------------------------------------+---------------------+                                    |
1534 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
1535 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1536
1537 ResumeTraffic
1538 -------------
1539
1540 The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.
1541
1542 This command is executed using an Ansible playbook or Chef cookbook.
1543
1544 Request Structure: The payload does not have any parameters.
1545
1546 +--------------------------+---------------------------------------------------------+
1547 | **Target URL**           | /restconf/operations/appc-provider-lcm:resume-traffic   |
1548 +--------------------------+---------------------------------------------------------+
1549 | **Action**               | ResumeTraffic                                           |
1550 +--------------------------+---------------------------------------------------------+
1551 | **Action-identifiers**   | vnf-id                                                  |
1552 +--------------------------+---------------------------------------------------------+
1553 | **Payload Parameters**   |                                                         |
1554 +--------------------------+---------------------------------------------------------+
1555 | **Revision History**     | New in Beijing                                          |
1556 +--------------------------+---------------------------------------------------------+
1557
1558 ResumeTraffic Response
1559 ^^^^^^^^^^^^^^^^^^^^^^
1560
1561 **Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed.
1562
1563 If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status
1564
1565 **Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1566
1567
1568 Snapshot
1569 --------
1570
1571 Creates a snapshot of a VM.
1572
1573 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
1574
1575 This command can be applied to a VM in any VNF type. The only restriction is that the particular VNF should be built based on the generic heat stack.
1576
1577 Note: Snapshot is not reliable unless the VM is in a stopped, paused, or quiesced (no traffic being processed) status. It is up to the caller to ensure that the VM is in one of these states.
1578
1579 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1580
1581 +------------------------------+-----------------------------------------------------------------------------------------------------+
1582 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:snapshot                                                 |
1583 +------------------------------+-----------------------------------------------------------------------------------------------------+
1584 |     **Action**               |     Snapshot                                                                                        |
1585 +------------------------------+-----------------------------------------------------------------------------------------------------+
1586 |     **Action-identifiers**   |     vnf-id, vserver-id                                                                              |
1587 +------------------------------+-----------------------------------------------------------------------------------------------------+
1588 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id                                                                  |
1589 +------------------------------+-----------------------------------------------------------------------------------------------------+
1590 |     **Revision History**     |     Unchanged in this release.                                                                      |
1591 +------------------------------+-----------------------------------------------------------------------------------------------------+
1592
1593 Payload Parameters
1594
1595 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
1596 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                        |
1597 +=====================+=========================================================================+=====================+========================================+
1598 |     vm-id           |     The self-link URL of the VM                                         |     Yes             |                                        |
1599 |                     |                                                                         |                     |     "payload":                         |
1600 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",      |
1601 |                     |                                                                         |                     |     \\"identity-url\\":                |
1602 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",              |
1603 |                     |                                                                         |                     |     \\"tenant-id\\":\\"<TENANT-ID>\\"}"|
1604 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
1605 |     identity- url   |     The identity url used to access the resource                        |     No              |                                        |
1606 |                     |                                                                         |                     |                                        |
1607 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
1608 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                        |
1609 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
1610
1611 Snapshot Response
1612 ^^^^^^^^^^^^^^^^^
1613
1614 The Snapshot command returns an extended version of the LCM response.
1615
1616 The Snapshot response conforms to the standard response format.
1617
1618
1619 Start
1620 -----
1621
1622 Use the Start command to start a VM that is stopped.
1623
1624 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1625
1626 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1627 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start                                                                               |
1628 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1629 |     **Action**               |     Start                                                                                                                      |
1630 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1631 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                                         |
1632 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1633 |     **Payload Parameters**   |     See table below                                                                                                            |
1634 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1635 |     **Revision History**     |     Unchanged in this release                                                                                                  |
1636 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1637
1638 Payload Parameters
1639
1640 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1641 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1642 +=================+===============================================+=================+=========================================+
1643 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1644 |                 |     the resource. For backwards-              |                 | "payload":                              |
1645 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1646 |                 |     link URL of the VM.                       |                 | \\",                                    |
1647 |                 |                                               |                 | \\"identity-url\\":                     |
1648 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1649 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1650 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1651 | identity- url   |     The identity url used to access the       | No              |                                         |
1652 |                 |     resource                                  |                 |                                         |
1653 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1654 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
1655 |                 |     the resource                              |                 |                                         |
1656 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1657
1658
1659 StartApplication
1660 ----------------
1661
1662 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.
1663
1664 A successful StartApplication request returns a success response.
1665
1666 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
1667
1668 +------------------------------+---------------------------------------------------------------+
1669 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start-application  |
1670 +------------------------------+---------------------------------------------------------------+
1671 |     **Action**               |     StartApplication                                          |
1672 +------------------------------+---------------------------------------------------------------+
1673 |     **Action-Identifiers**   |     Vnf-id                                                    |
1674 +------------------------------+---------------------------------------------------------------+
1675 |     **Payload Parameters**   |     See table below                                           |
1676 +------------------------------+---------------------------------------------------------------+
1677 |     **Revision History**     |     Unchanged in this release.                                |
1678 +------------------------------+---------------------------------------------------------------+
1679
1680 |
1681
1682 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1683 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1684 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1685 |                                 |                                                                                                                                                                                    |                     |  "payload":                                                     |
1686 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |  "{\\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
1687 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1688
1689 StartApplication Response
1690 ^^^^^^^^^^^^^^^^^^^^^^^^^
1691
1692 The StartApplication response returns an indication of success or failure of the request.
1693
1694 Stop
1695 ----
1696
1697 Use the Stop command to stop a VM that was running.
1698
1699 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1700
1701 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1702 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop                                                                                |
1703 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1704 |     **Action**               |     Stop                                                                                                                       |
1705 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1706 |     **Action-identifiers**   |     vnf-id and vserver-id are required.                                                                                        |
1707 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1708 |     **Payload Parameters**   |     See table below                                                                                                            |
1709 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1710 |     **Revision History**     |     Unchanged in this release                                                                                                  |
1711 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1712
1713 Payload Parameters
1714
1715 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1716 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1717 +=================+===============================================+=================+=========================================+
1718 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1719 |                 |     the resource. For backwards-              |                 | "payload":                              |
1720 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1721 |                 |     link URL of the VM.                       |                 | \\",                                    |
1722 |                 |                                               |                 | \\"identity-url\\":                     |
1723 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1724 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1725 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1726 | identity- url   |     The identity url used to access the       | No              |                                         |
1727 |                 |     resource                                  |                 |                                         |
1728 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1729 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
1730 |                 |     the resource                              |                 |                                         |
1731 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1732
1733
1734 StopApplication
1735 ---------------
1736
1737 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
1738
1739 A successful StopApplication request returns a success response.
1740
1741 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
1742
1743 +------------------------------+--------------------------------------------------------------+
1744 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stopapplication   |
1745 +------------------------------+--------------------------------------------------------------+
1746 |     **Action**               |     StopApplication                                          |
1747 +------------------------------+--------------------------------------------------------------+
1748 |     **Action-Identifiers**   |     Vnf-id                                                   |
1749 +------------------------------+--------------------------------------------------------------+
1750 |     **Payload Parameters**   |     See table below                                          |
1751 +------------------------------+--------------------------------------------------------------+
1752 |     **Revision History**     |     Unchanged in this release                                |
1753 +------------------------------+--------------------------------------------------------------+
1754
1755 |
1756
1757 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1758 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1759 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1760 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |     "payload":                                                  |
1761 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
1762 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1763
1764
1765 StopApplication Response
1766 ^^^^^^^^^^^^^^^^^^^^^^^^
1767
1768 The StopApplication response returns an indication of success or failure of the request.
1769
1770 Sync
1771 ----
1772
1773 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
1774
1775 A successful Sync returns a success status.
1776
1777 A failed Sync returns a failure response status and failure messages in the response payload block.
1778
1779 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).
1780
1781 +------------------------------+---------------------------------------------------+
1782 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:sync   |
1783 +------------------------------+---------------------------------------------------+
1784 |     **Action**               |     Sync                                          |
1785 +------------------------------+---------------------------------------------------+
1786 |     **Action-identifiers**   |     Vnf-id                                        |
1787 +------------------------------+---------------------------------------------------+
1788 |     **Payload Parameters**   |     None                                          |
1789 +------------------------------+---------------------------------------------------+
1790 |     **Revision History**     |     Unchanged in this release.                    |
1791 +------------------------------+---------------------------------------------------+
1792
1793 Unlock
1794 ------
1795
1796 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
1797
1798 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.
1799
1800 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
1801
1802 The Unlock command will only return success if the VNF was locked with same request-id.
1803
1804 The Unlock command returns only one final response with the status of the request processing.
1805
1806 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.
1807
1808 +------------------------------+-----------------------------------------------------+
1809 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:unlock   |
1810 +------------------------------+-----------------------------------------------------+
1811 |     **Action**               |     Unlock                                          |
1812 +------------------------------+-----------------------------------------------------+
1813 |     **Action-identifiers**   |     Vnf-id                                          |
1814 +------------------------------+-----------------------------------------------------+
1815 |     **Payload Parameters**   |     see table below                                 |
1816 +------------------------------+-----------------------------------------------------+
1817 |     **Revision History**     |     Unchanged in this release.                      |
1818 +------------------------------+-----------------------------------------------------+
1819
1820 |
1821
1822 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
1823 |     **Payload Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                  |
1824 +=================================+=========================================================================+=====================+==================================+
1825 |     request-id                  |     Request id from the previously submitted request                    |     Yes             |    "request-id": "123456789"     |
1826 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
1827
1828
1829 UpgradeBackout
1830 --------------
1831
1832 The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
1833
1834 This command is executed using an Ansible playbook or Chef cookbook.
1835
1836 Request Structure: The request payload includes an upgrade identifier.
1837
1838 +--------------------------+----------------------------------------------------------+
1839 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backout   |
1840 +--------------------------+----------------------------------------------------------+
1841 | **Action**               | UpgradeBackout                                           |
1842 +--------------------------+----------------------------------------------------------+
1843 | **Action-identifiers**   | vnf-id                                                   |
1844 +--------------------------+----------------------------------------------------------+
1845 | **Payload Parameters**   | existing-software-version, new-software-version          |
1846 +--------------------------+----------------------------------------------------------+
1847 | **Revision History**     | New in Beijing                                           |
1848 +--------------------------+----------------------------------------------------------+
1849
1850 Request Payload Parameters:
1851
1852 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1853 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1854 +=======================+=====================================+=====================+===============================================================================================+
1855 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
1856 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
1857 +-----------------------+-------------------------------------+---------------------+                                                                                               |
1858 | new-software-         |     The new software                |     Yes             |                                                                                               |
1859 | version               |     version after the               |                     |                                                                                               |
1860 |                       |     upgrade                         |                     |                                                                                               |
1861 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1862
1863 UpgradeBackout Response
1864 ^^^^^^^^^^^^^^^^^^^^^^^
1865
1866 **Success:** A successful backout returns a success status code 400.
1867
1868 **Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1869
1870 UpgradeBackup
1871 -------------
1872
1873 The UpgradeBackup LCM action does a full backup of the VNF data prior to an upgrade. The backup is done on the Ansible or Chef server in a location that is specified in the playbook or cookbook. If there is an existing backup, it is overwritten by the new backup.
1874
1875 This command is executed using an Ansible playbook or Chef cookbook.
1876
1877 Request Structure: The payload does not have any parameters required.
1878
1879 +--------------------------+---------------------------------------------------------+
1880 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backup   |
1881 +--------------------------+---------------------------------------------------------+
1882 | **Action**               | UpgradeBackup                                           |
1883 +--------------------------+---------------------------------------------------------+
1884 | **Action-identifiers**   | vnf-id                                                  |
1885 +--------------------------+---------------------------------------------------------+
1886 | **Payload Parameters**   | existing-software-version, new-software-version         |
1887 +--------------------------+---------------------------------------------------------+
1888 | **Revision History**     | New in Beijing.                                         |
1889 +--------------------------+---------------------------------------------------------+
1890
1891 Request Payload Parameters:
1892
1893 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1894 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1895 +=======================+=====================================+=====================+===============================================================================================+
1896 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
1897 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
1898 +-----------------------+-------------------------------------+---------------------+                                                                                               |
1899 | new-software-         |     The new software                |     Yes             |                                                                                               |
1900 | version               |     version after the               |                     |                                                                                               |
1901 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1902
1903 UpgradeBackup Response
1904 ^^^^^^^^^^^^^^^^^^^^^^
1905
1906 **Success:** A successful backup returns a success status code 400.
1907
1908 **Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1909
1910 UpgradePostCheck
1911 ----------------
1912
1913 The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.
1914
1915 This command is executed using an Ansible playbook or Chef cookbook.
1916
1917 Request Structure:
1918
1919 +--------------------------+-------------------------------------------------------------+
1920 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-post-check   |
1921 +--------------------------+-------------------------------------------------------------+
1922 | **Action**               | UpgradePostCheck                                            |
1923 +--------------------------+-------------------------------------------------------------+
1924 | **Action-identifiers**   | vnf-id                                                      |
1925 +--------------------------+-------------------------------------------------------------+
1926 | **Payload Parameters**   | existing-software-version, new-software-version             |
1927 +--------------------------+-------------------------------------------------------------+
1928 | **Revision History**     | New in Beijing                                              |
1929 +--------------------------+-------------------------------------------------------------+
1930
1931 Request Payload Parameters:
1932
1933 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1934 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1935 +=======================+=====================================+=====================+===============================================================================================+
1936 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
1937 |  version              |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
1938 +-----------------------+-------------------------------------+---------------------+                                                                                               |
1939 | new-software-         |     The new software                |     Yes             |                                                                                               |
1940 | version               |     version after the               |                     |                                                                                               |
1941 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1942
1943 UpgradePostCheck Response
1944 ^^^^^^^^^^^^^^^^^^^^^^^^^
1945
1946 **Success:** If the UpgradePostCheck run successfully, it returns a success status code 400. The response payload contains the results of the check (Completed or Failed).
1947
1948 Response Payload Parameters:
1949
1950 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
1951 | **Parameter** |     **Description**         |**Required?**|     **Example**                                                              |
1952 +===============+=============================+=============+==============================================================================+
1953 | Upgrade-      |     Returns the status      |     Yes     |                                                                              |
1954 | Status        |     of the upgradw          |             |     "payload":                                                               |
1955 |               |     post-check. Indicates   |             |     "{\\"upgrade-status\\": \\"Completed\\"}”                                |
1956 |               |     Completed or Failed     |             |     "payload": "{\\"upgrade-status\\":                                       |
1957 |               |                             |             |     \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” |
1958 +---------------+-----------------------------+-------------+                                                                              |
1959 | Message       |     If Not Available,       |             |                                                                              |
1960 |               |     message contains        |             |                                                                              |
1961 |               |     explanation.            |             |                                                                              |
1962 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
1963
1964 **Failure:** If the UpgradePostCheck could not be run, it returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1965
1966 UpgradePreCheck
1967 ---------------
1968
1969 The UpgradePreCheck LCM action checks that the VNF has the correct software version needed for a software upgrade. This command can be executed on a running VNF (i.e. processing traffic).
1970
1971 This command is executed using an Ansible playbook or Chef cookbook.
1972
1973 Request Structure:
1974
1975 +--------------------------+------------------------------------------------------------+
1976 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-pre-check   |
1977 +--------------------------+------------------------------------------------------------+
1978 | **Action**               | UpgradePreCheck                                            |
1979 +--------------------------+------------------------------------------------------------+
1980 | **Action-identifiers**   | vnf-id                                                     |
1981 +--------------------------+------------------------------------------------------------+
1982 | **Payload Parameters**   | existing-software-version, new-software-version            |
1983 +--------------------------+------------------------------------------------------------+
1984 | **Revision History**     | New in Beijing                                             |
1985 +--------------------------+------------------------------------------------------------+
1986
1987 Request Payload Parameters:
1988
1989 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1990 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1991 +=======================+=====================================+=====================+===============================================================================================+
1992 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
1993 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
1994 +-----------------------+-------------------------------------+---------------------+                                                                                               |
1995 | new-software-         |     The new software                |     Yes             |                                                                                               |
1996 | version               |     version after the               |                     |                                                                                               |
1997 |                       |     upgrade                         |                     |                                                                                               |
1998 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1999
2000 UpgradePreCheck Response
2001 ^^^^^^^^^^^^^^^^^^^^^^^^
2002
2003 **Success:** If the UpgradePreCheck runs successfully, it returns a success status code 400. The response payload contains the results of the check (Available or Not Available for upgrade).
2004
2005 Response Payload Parameters:
2006
2007 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2008 | **Parameter**   |     **Description**       |     **Required?**   |     **Example**                                                                                                                  |
2009 +=================+===========================+=====================+==================================================================================================================================+
2010 | upgrade-status  |     Returns the status    |     Yes             |                                                                                                                                  |
2011 |                 |     of the upgrade pre-   |                     |     "payload":                                                                                                                   |
2012 |                 |     check. Indicates      |                     |     "{\\"upgrade-status\\": \\"Available\\"}”                                                                                    |
2013 |                 |     Available or Not      |                     |                                                                                                                                  |
2014 |                 |     Available             |                     |     "payload":                                                                                                                   |
2015 |                 |                           |                     |     "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }”   |
2016 +-----------------+---------------------------+---------------------+                                                                                                                                  |
2017 |     message     |     If Not Available,     |                     |                                                                                                                                  |
2018 |                 |     message contains      |                     |                                                                                                                                  |
2019 |                 |     explanation.          |                     |                                                                                                                                  |
2020 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2021
2022 **Failure:** If an UpgradePreCheck fails to run, it returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2023
2024 UpgradeSoftware
2025 ---------------
2026
2027 The UpgradeSoftware LCM action upgrades the target VNF to a new version. It is expected that the VNF is in a quiesced status (not processing traffic).
2028
2029 This command is executed using an Ansible playbook or Chef cookbook.
2030
2031 Request Structure: The request payload includes the new-software-version.
2032
2033 +--------------------------+-----------------------------------------------------------+
2034 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-software   |
2035 +--------------------------+-----------------------------------------------------------+
2036 | **Action**               | UpgradeSoftware                                           |
2037 +--------------------------+-----------------------------------------------------------+
2038 | **Action-identifiers**   | vnf-id                                                    |
2039 +--------------------------+-----------------------------------------------------------+
2040 | **Payload Parameters**   | existing-software-version, new-software-version           |
2041 +--------------------------+-----------------------------------------------------------+
2042 | **Revision History**     | New in Beijing                                            |
2043 +--------------------------+-----------------------------------------------------------+
2044
2045  Request Payload Parameters:
2046
2047 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2048 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2049 +=======================+=====================================+=====================+===============================================================================================+
2050 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
2051 | version               |      prior to the upgrade           |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2052 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2053 | new-software          |     The new software                |     Yes             |                                                                                               |
2054 | version               |     version after the               |                     |                                                                                               |
2055 |                       |     upgrade                         |                     |                                                                                               |
2056 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2057
2058 UpgradeSoftware Response
2059 ^^^^^^^^^^^^^^^^^^^^^^^^
2060
2061 **Success:** A successful upgrade returns a success status code 400.
2062
2063 If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status.
2064
2065 **Failure:** A failed upgrade returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block. A failure does not assume that the software upgrade has been rolled back.
2066
2067 Notes regarding the Upgrade commands
2068 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2069 Ansible playbooks / Chef cookbooks:
2070
2071 -  All Ansible playbooks/cookbooks for the Upgrade commands will be
2072    stored in the same directory on the server. The directory name will
2073    be of the format:
2074
2075         {existing-software-version_new-software-version}.
2076
2077                 The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade).
2078
2079 -  The playbooks for upgrades should use a standard naming convention
2080    (for example: SoftwareUpgrade_{existing-software-version_new-software-version}).
2081
2082 APPC template: The APPC templates for the Upgrade commands can be common across upgrades for the vnf-type if the path and filenames are standardized.
2083
2084 -  The template will contain the directory path/playbook name which
2085    would be parameterized.
2086
2087     {vnf-type}/UpgradeSoftware/${existing_software_version}_${new-software-version}/
2088     SoftwareUpgrade_{existing-software-version_new-software-version}.
2089
2090