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 |     DistributeTraffic  | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 576 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 577 |     Evacuate           |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 578 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 579 |     HealthCheck        | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 580 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 581 |     Lock               | Yes       |                  |                |          |     Any                                                    |
 582 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 583 |     Migrate            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 584 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 585 |     QuiesceTraffic     | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 586 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 587 |     Reboot             |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 588 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 589 |     Rebuild            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 590 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 591 |     Restart            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 592 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 593 |     ResumeTraffic      | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 594 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 595 |     Snapshot           |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 596 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 597 |     Start              |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 598 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 599 |     StartApplication   | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 600 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 601 |     Stop               |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 602 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 603 |     StopApplication    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 604 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 605 |     Sync               | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 606 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 607 |     Unlock             | Yes       |                  |                |          |     Any                                                    |
 608 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 609 |     UpgradeBackout     | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 610 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 611 |     UpgradeBackup      | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 612 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 613 |     UpgradePostCheck   | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 614 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 615 |     UpgradePreCheck    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 616 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 617 |     UpgradeSoftware    | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 618 +------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 619
 620
 621
 622 Self-Service VNF Onboarding
 623 ---------------------------
 624
 625 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:
 626
 627 -  Netconf with uploadable Yang model (requires a Netconf server running
 628    on the VNF)
 629
 630 -  Chef (requires a Chef client running on the VNF)
 631
 632 -  Ansible (does not require any changes to the VNF software)
 633
 634 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:
 635
 636 -  Define the VNF capabilities (set of actions that the VNF can
 637    support).
 638
 639 -  Create a template and parameter definitions for actions which use the
 640    Netconf, Chef, or Ansible protocols. The template is an xml or JSON
 641    block which defines the “payload” which is included in the request
 642    that is downloaded the VNF (if Netconf) or Chef/Ansible server.
 643
 644 -  Test actions which have templates/parameter definitions.
 645
 646 -  Upload the VNF definition, template, and parameter definition
 647    artifacts to SDC which distributes them to all APPC instances in the
 648    same environment (e.g., production).
 649
 650 For more details, see the APPC CDT Onboarding User Guide.
 651
 652
 653
 654 LCM Commands
 655 ============
 656
 657 The LCM commands that are valid for the current release.
 658
 659 ActionStatus
 660 ------------
 661
 662 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.
 663
 664 +--------------------------+----------------------------------------------------------+
 665 | **Target URL**           | /restconf /operations/ appc-provider-lcm:action-status   |
 666 +--------------------------+----------------------------------------------------------+
 667 | **Action**               | ActionStatus                                             |
 668 +--------------------------+----------------------------------------------------------+
 669 | **Action-Identifiers**   | vnf-id                                                   |
 670 +--------------------------+----------------------------------------------------------+
 671 | **Payload Parameters**   | See below                                                |
 672 +--------------------------+----------------------------------------------------------+
 673 | **Revision History**     | New in Beijing                                           |
 674 +--------------------------+----------------------------------------------------------+
 675
 676 |
 677
 678 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 679 |     **Payload Parameter**   |     **Description**                                        |     **Required**   |     **Example**                     |
 680 +=============================+============================================================+====================+=====================================+
 681 | request-id                  |     Request id from the previously submitted request       | Yes                |     "request-id": "123456789"       |
 682 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 683 | sub-request ID              |     Sub-Request id from the previously submitted request   | optional           |     "sub-request-id": "123456789"   |
 684 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 685 | originator-id               |     Originator id from the previously submitted request    | optional           |     "originator-id": "123456789"    |
 686 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 687
 688
 689 ActionStatus Response:
 690 ^^^^^^^^^^^^^^^^^^^^^^
 691
 692 A successful response contains a payload with the following:
 693
 694 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 695 |     **Payload Parameter**   |     **Description**                                                   |     **Required**   |     **Example**              |
 696 +=============================+=======================================================================+====================+==============================+
 697 | status-reason               |     Contains more details about status                                | No                 |                              |
 698 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 699 | status                      |     IN_PROGRESS – The request has been accepted and is in progress    | No                 |     "status": "SUCCESSFUL"   |
 700 |                             |                                                                       |                    |                              |
 701 |                             |     SUCCESSFUL – The request returned success message                 |                    |                              |
 702 |                             |                                                                       |                    |                              |
 703 |                             |     FAILED – The request failed and returned an error message         |                    |                              |
 704 |                             |                                                                       |                    |                              |
 705 |                             |     ABORTED – the request aborted                                     |                    |                              |
 706 |                             |                                                                       |                    |                              |
 707 |                             |     NOT_FOUND – The request is not found                              |                    |                              |
 708 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 709
 710 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:
 711
 712     ``"message": "MULTIPLE REQUESTS FOUND - using search criteria:
 713     request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
 714     vnf-id=ctsf0007v", "code": 315``
 715
 716 AttachVolume
 717 ------------
 718
 719 The AttachVolume command attaches a cinder volume to a VM via an Openstack command.
 720
 721 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.
 722
 723     NOTE: The command implementation is based on Openstack
 724     functionality. For further details, see
 725     http://developer.openstack.org/api-ref/compute/.
 726
 727 +--------------------------+----------------------------------------------------------+
 728 | **Target URL**           | /restconf/operations/appc-provider-lcm:attach-volume     |
 729 +--------------------------+----------------------------------------------------------+
 730 | **Action**               | AttachVolume                                             |
 731 +--------------------------+----------------------------------------------------------+
 732 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
 733 +--------------------------+----------------------------------------------------------+
 734 | **Payload Parameters**   | See table                                                |
 735 +--------------------------+----------------------------------------------------------+
 736 | **Revision History**     | New in Beijing                                           |
 737 +--------------------------+----------------------------------------------------------+
 738
 739 |
 740
 741 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 742 |     **Payload Parameter**   |     **Description**                                  |     **Required**   |     **Example**                                                                                                           |
 743 +=============================+======================================================+====================+===========================================================================================================================+
 744 | volumeId                    |     The UUID of the volume to attach.                | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",                                                                   |
 745 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 746 | device                      |     The device identifier                            | Yes                |     "device": "/dev/vdb"                                                                                                  |
 747 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 748 | 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" |
 749 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 750 | Identity-url                |     The identity URL used to access the resource     | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                     |
 751 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 752
 753 AttachVolume Response:
 754 ^^^^^^^^^^^^^^^^^^^^^^
 755
 756 Success: A successful AttachVolume returns a success status code 400.
 757
 758 Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include:
 759
 760 -  badRequest
 761 -  unauthorized
 762 -  forbidden
 763 -  itemNotFound
 764
 765
 766 Audit
 767 -----
 768
 769 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.
 770
 771 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
 772
 773 A failed Audit indicates that the configurations do not match.
 774
 775 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).
 776
 777 The Audit action does not require any payload parameters.
 778
 779 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
 780
 781
 782 +------------------------------+------------------------------------------------------+
 783 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:audit     |
 784 +------------------------------+------------------------------------------------------+
 785 |     **Action**               |     Audit                                            |
 786 +------------------------------+------------------------------------------------------+
 787 |     **Action-Identifiers**   |     vnf-id                                           |
 788 +------------------------------+------------------------------------------------------+
 789 |     **Payload Parameters**   |     See below                                        |
 790 +------------------------------+------------------------------------------------------+
 791 |     **Revision History**     |     Unchanged in this release.                       |
 792 +------------------------------+------------------------------------------------------+
 793
 794 |
 795
 796 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 797 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 798 +======================+===========================================================================================================================================================+=====================+==================================+
 799 |     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>"   |
 800 |                      |                                                                                                                                                           |                     |                                  |
 801 |                      |     \* If the publish\_config field is set to N in the payload, then:                                                                                     |                     |                                  |
 802 |                      |                                                                                                                                                           |                     |                                  |
 803 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration                      |                     |                                  |
 804 |                      |                                                                                                                                                           |                     |                                  |
 805 |                      |     - If the result of the audit is ‘no match’, then send the running configuration                                                                       |                     |                                  |
 806 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 807
 808 Audit Response
 809 ^^^^^^^^^^^^^^
 810
 811 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.
 812
 813
 814 CheckLock
 815 ---------
 816
 817 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
 818
 819 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.
 820
 821 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.
 822
 823 The CheckLock command returns a specific response structure that extends the default LCM response.
 824
 825 The CheckLock action does not require any payload parameters.
 826
 827 +------------------------------+--------------------------------------------------------+
 828 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:checklock   |
 829 +------------------------------+--------------------------------------------------------+
 830 |     **Action**               |     CheckLock                                          |
 831 +------------------------------+--------------------------------------------------------+
 832 |     **Action-Identifiers**   |     vnf-id                                             |
 833 +------------------------------+--------------------------------------------------------+
 834 |     **Payload Parameters**   |     None                                               |
 835 +------------------------------+--------------------------------------------------------+
 836 |     **Revision History**     |     Unchanged in this release.                         |
 837 +------------------------------+--------------------------------------------------------+
 838
 839 CheckLock Response
 840 ^^^^^^^^^^^^^^^^^^
 841
 842 The CheckLock command returns a customized version of the LCM
 843 response.
 844
 845
 846 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 847 |     **Parameter**   |     **Description**                                                                   |     **Required**   | **?Example**                    |
 848 +=====================+=======================================================================================+====================+=================================+
 849 |     locked          |     "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE.   |     No             |     "locked": "<TRUE\|FALSE>"   |
 850 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 851
 852
 853 **Example**::
 854
 855     {
 856       "output": {
 857                   "status": {
 858                               "code": <RESULT_CODE>, "message": "<RESULT_MESSAGE>"
 859                             },
 860                   "common-header": {
 861                                      "api-ver": "<API_VERSION>",
 862                                      "request-id": "<ECOMP\_REQUEST_ID>", "originator-id":
 863                                      "<ECOMP_SYSTEM_ID>",
 864                                      "sub-request-id": "<ECOMP_SUBREQUEST_ID>", "timestamp":
 865                                      "2016-08-08T23:09:00.11Z",
 866                                      "flags": {
 867                                                 "ttl": <TTL_VALUE>, "force": "<TRUE|FALSE>",
 868                                                 "mode": "<EXCLUSIVE|NORMAL>"
 869                                               }
 870                                    },
 871                   "locked": "<TRUE|FALSE>"
 872     }
 873
 874
 875 Configure
 876 ---------
 877
 878 Configure a VNF or a VNFC on the VNF after instantiation.
 879
 880 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.
 881
 882 A successful Configure request returns a success response.
 883
 884 A failed Configure action returns a failure response and the specific failure messages in the response block.
 885
 886 +------------------------------+--------------------------------------------------------+
 887 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configure   |
 888 +------------------------------+--------------------------------------------------------+
 889 |     **Action**               |     Configure                                          |
 890 +------------------------------+--------------------------------------------------------+
 891 |     **Action-Identifiers**   |     vnf-id                                             |
 892 +------------------------------+--------------------------------------------------------+
 893 |     **Payload Parameters**   |     See below                                          |
 894 +------------------------------+--------------------------------------------------------+
 895 |     **Revision History**     |     Unchanged in this release.                         |
 896 +------------------------------+--------------------------------------------------------+
 897
 898 |
 899
 900 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 901 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                            |     **Required?**   |     **Example**                                                 |
 902 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 903 +=================================+================================================================================================================================================================================================================+=====================+=================================================================+
 904 |     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              |                                                                 |
 905 |                                 |                                                                                                                                                                                                                |                     |     "payload":                                                  |
 906 |                                 |     vnfc-type:  must be included if template is vnfc specific                                                                                                                                                  |                     |     "{ \\"request-parameters                                    |
 907 |                                 |                                                                                                                                                                                                                |                     |     \\": {                                                      |
 908 |                                 |                                                                                                                                                                                                                |                     |     \\"vnf-host-ip-address\\":                                  |
 909 |                                 |                                                                                                                                                                                                                |                     |     \\”value\\”,                                                |
 910 |                                 |                                                                                                                                                                                                                |                     |     \\”vnfc-type\\”: \\”value\\”’                               |
 911 |                                 |                                                                                                                                                                                                                |                     |     }                                                           |
 912 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 913 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 914 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 915 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 916 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 917 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 918 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 919 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 920 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 921 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
 922 |     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>\\"}  |
 923 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 924
 925
 926 Configure Response
 927 ^^^^^^^^^^^^^^^^^^
 928
 929 The Configure response returns an indication of success or failure of the request.
 930
 931 **Success:** A successful Configure returns a success status code 400.
 932 **Failure:** A failed Configure returns a failure code 401 and the failure message.
 933
 934 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.
 935
 936 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.
 937
 938 ConfigModify
 939 ------------
 940
 941 Modifies the configuration on a VNF or VNFC in service.
 942
 943 This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook.
 944
 945 Request Structure:
 946
 947 +--------------------------+--------------------------------------------------------+
 948 | **Target URL**           | /restconf/operations/appc-provider-lcm:config-modify   |
 949 +--------------------------+--------------------------------------------------------+
 950 | **Action**               | ConfigModify                                           |
 951 +--------------------------+--------------------------------------------------------+
 952 | **Action-Identifiers**   | vnf-id                                                 |
 953 +--------------------------+--------------------------------------------------------+
 954 | **Payload Parameters**   | request-parameters, configuration-parameters           |
 955 +--------------------------+--------------------------------------------------------+
 956 | **Revision History**     | Unchanged in this release.                             |
 957 +--------------------------+--------------------------------------------------------+
 958
 959 Request Payload Parameters:
 960
 961 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
 962 | **Payload Parameter**   | **Description**                        | **Required?**   |     **Example**                                       |
 963 +=========================+========================================+=================+=======================================================+
 964 | request-parameters      | vnf-host-ip-address: optional if       | No              |     "payload":                                        |
 965 |                         | Netconf or other direct interface      |                 |     "{\\"request-parameters \\":                      |
 966 |                         | to the VNF. If not provided, it is     |                 |     {\\"vnf-host-ip-address\\": \\”value\\",          |
 967 |                         | obtained from A&AI                     |                 |     \\”vnfc-type\\”: \\”value\\”                      |
 968 |                         |                                        |                 |     }                                                 |
 969 |                         |                                        |                 |                                                       |
 970 |                         | vnfc-type: must be included if template|                 |                                                       |
 971 |                         | is vnfc specific                       |                 |                                                       |
 972 |                         |                                        |                 |     \\"configuration- parameters\\": {\\"name1\\":    |
 973 |                         |                                        |                 |     \\”value1\\”,\\"name2\\":                         |
 974 |                         |                                        |                 |     \\”value2\\”                                      |
 975 |                         |                                        |                 |     }                                                 |
 976 |                         |                                        |                 |     }                                                 |
 977 +-------------------------+----------------------------------------+-----------------+                                                       |
 978 | configuration-          | A set of instance specific             | No              |                                                       |
 979 | parameters              | configuration parameters should        |                 |                                                       |
 980 |                         | be specified.                          |                 |                                                       |
 981 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
 982
 983 ConfigModify Response
 984 ^^^^^^^^^^^^^^^^^^^^^
 985
 986 **Success:** A successful ConfigModify returns a success status code 400.
 987
 988 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.
 989
 990 **Failure:** A failed ConfigModify returns a failure code 401 and the failure message.
 991
 992 ConfigBackup
 993 ------------
 994
 995 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).
 996
 997 A successful ConfigBackup request returns a success response.
 998
 999 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
1000
1001 +------------------------------+-----------------------------------------------------------+
1002 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-backup  |
1003 +------------------------------+-----------------------------------------------------------+
1004 |     **Action**               |     ConfigBackup                                          |
1005 +------------------------------+-----------------------------------------------------------+
1006 |     **Action-Identifiers**   |     Vnf-id                                                |
1007 +------------------------------+-----------------------------------------------------------+
1008 |     **Payload Parameters**   |     See below                                             |
1009 +------------------------------+-----------------------------------------------------------+
1010 |     **Revision History**     |     Unchanged in this release.                            |
1011 +------------------------------+-----------------------------------------------------------+
1012
1013 |
1014
1015 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1016 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                   |
1017 +=================================+====================================================================================================================================================================================+=====================+===================================================================+
1018 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              | "payload": \\"configuration-parameters\\": {\\"<CONFIG-PARAMS>\\"}|
1019 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1020 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1021 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1022 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1023 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1024 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                   |
1025 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                   |
1026 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1027
1028 ConfigBackup Response
1029 ^^^^^^^^^^^^^^^^^^^^^
1030
1031 The ConfigBackup response returns an indication of success or failure of the request.
1032
1033 **Success:** A successful ConfigBackup returns a success status code 400.
1034 **Failure:** A failed ConfigBackup returns a failure code 401 and the failure message.
1035
1036
1037 ConfigRestore
1038 -------------
1039
1040 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
1041
1042 A successful ConfigRestore request returns a success response.
1043
1044 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
1045
1046 +------------------------------+------------------------------------------------------------------------------------------+
1047 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-restore                                |
1048 +------------------------------+------------------------------------------------------------------------------------------+
1049 |     **Action**               |     ConfigRestore                                                                        |
1050 +------------------------------+------------------------------------------------------------------------------------------+
1051 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1052 +------------------------------+------------------------------------------------------------------------------------------+
1053 |     **Payload Parameters**   |     See below                                                                            |
1054 +------------------------------+------------------------------------------------------------------------------------------+
1055 |     **Revision History**     |     Unchanged in this release.                                                           |
1056 +------------------------------+------------------------------------------------------------------------------------------+
1057
1058 |
1059
1060 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1061 |     **Parameter**               |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1062 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1063 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              |     "payload":                                                  |
1064 |                                 |                                                                                                                                                                                    |                     |     \\"configuration-parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
1065 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1066 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1067 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1068
1069 ConfigRestore Response
1070 ^^^^^^^^^^^^^^^^^^^^^^
1071
1072 **Success:** A successful ConfigRestore returns a success status code 400.
1073
1074 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.
1075
1076 **Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
1077
1078
1079
1080 ConfigScaleOut
1081 --------------
1082
1083 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.
1084
1085 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.
1086 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.
1087
1088 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1089
1090 |
1091
1092 +------------------------------+------------------------------------------------------------------------------------------+
1093 |     **Target URL**           |     /restconf /operations/appc-provider-lcm:config-scale-out                             |
1094 +------------------------------+------------------------------------------------------------------------------------------+
1095 |     **Action**               |     ConfigScaleOut                                                                       |
1096 +------------------------------+------------------------------------------------------------------------------------------+
1097 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1098 +------------------------------+------------------------------------------------------------------------------------------+
1099 |     **Payload Parameters**   |     See below                                                                            |
1100 +------------------------------+------------------------------------------------------------------------------------------+
1101 |     **Revision History**     |     New in Beijing                                                                       |
1102 +------------------------------+------------------------------------------------------------------------------------------+
1103
1104 |
1105
1106 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1107 |     **Payload Parameter**       |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                             |
1108 +=================================+==================================================================================================================================================================+=====================+=============================================+
1109 |     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":                             |
1110 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      "{\\"request-parameters \\":           |
1111 |                                 |     vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleOut.                                                                       |     Yes             |      {                                      |
1112 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\"vnf-host-ip-address\\":             |
1113 |                                 |     controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleOut.                            |                     |      \\”value\\”,                           |
1114 |                                 |     Will be needed if A&AI does not contain the template identifier.                                                                                             |     No              |      \\”vf-module-id\\”: \\”value\\”,       |
1115 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\”controller-template-id\\”:          |
1116 |     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\\”                            |
1117 |                                 |     values supplied.                                                                                                                                             |                     |      }                                      |
1118 |                                 |                                                                                                                                                                  |                     |                                             |
1119 |                                 |                                                                                                                                                                  |                     |      \\"configuration-parameters\\":        |
1120 |                                 |                                                                                                                                                                  |                     |        {\\"<CONFIG- PARAMS>\\"}             |
1121 |                                 |                                                                                                                                                                  |                     |                                             |
1122 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1123
1124 ConfigScaleOut Response
1125 ^^^^^^^^^^^^^^^^^^^^^^^
1126
1127 **Success:**
1128
1129  - A successful ConfigScaleOut returns a success status code 400 when completed.
1130
1131 **Failure:**
1132
1133  - A failed ConfigScaleOut returns a failure code 401 and the failure message.
1134  - 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.
1135
1136
1137 DetachVolume
1138 ------------
1139
1140 The DetachVolume command detaches a cinder volume from a VM via an Openstack command.
1141
1142 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.
1143
1144 NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1145
1146 +--------------------------+----------------------------------------------------------+
1147 | **Target URL**           | /restconf/operations/appc-provider-lcm:detach-volume     |
1148 +--------------------------+----------------------------------------------------------+
1149 | **Action**               | DetachVolume                                             |
1150 +--------------------------+----------------------------------------------------------+
1151 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
1152 +--------------------------+----------------------------------------------------------+
1153 | **Payload Parameters**   | See table                                                |
1154 +--------------------------+----------------------------------------------------------+
1155 | **Revision History**     | New in Beijing                                           |
1156 +--------------------------+----------------------------------------------------------+
1157
1158 Request Payload Parameters:
1159
1160 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1161 |     **Payload Parameter**   |     **Description**                                            |     **Required**   |     **Example**                                                                                                                |
1162 +=============================+================================================================+====================+================================================================================================================================+
1163 | volumeId                    |     The UUID of the volume to detach.                          | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"                                                                         |
1164 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1165 | 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"      |
1166 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1167 | Identity-url                |     The identity URL used to access the resource               | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                          |
1168 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1169
1170 DetachVolume Response:
1171 ^^^^^^^^^^^^^^^^^^^^^^
1172
1173 **Success:** A successful DetachVolume returns a success status code 400.
1174
1175 **Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include:
1176
1177         -  badRequest
1178         -  unauthorized
1179         -  forbidden
1180         -  itemNotFound
1181         -  conflict
1182
1183 DistributeTraffic
1184 -----------------
1185
1186 The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
1187 The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
1188 realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
1189 including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
1190 Format of configuration file is specific to each VNF type.
1191
1192 This command is executed using an Ansible playbook or Chef cookbook.
1193
1194 Request Structure:
1195
1196 +--------------------------+--------------------------------------------------------------+
1197 | **Target URL**           | /restconf/operations/appc-provider-lcm:distribute-traffic    |
1198 +--------------------------+--------------------------------------------------------------+
1199 | **Action**               | DistributeTraffic                                            |
1200 +--------------------------+--------------------------------------------------------------+
1201 | **Action-identifiers**   | vnf-id, vserver-id, vnfc-name                                |
1202 +--------------------------+--------------------------------------------------------------+
1203 | **Payload Parameters**   | See below                                                    |
1204 +--------------------------+--------------------------------------------------------------+
1205 | **Revision History**     | New in Casablanca                                            |
1206 +--------------------------+--------------------------------------------------------------+
1207
1208 Request Payload Parameters:
1209
1210 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------------------+
1211 | **Parameter**                   |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                                                           |
1212 +=================================+==================================================================================================================================================================+=====================+===========================================================================+
1213 |     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              |    "payload":                                                             |
1214 |                                 |     values supplied. The parameters are associated with request template defined with CDT                                                                        |                     |    "{\\"configuration-parameters\\":{                                     |
1215 |                                 |                                                                                                                                                                  |                     |    \\"config_file_name\\":\\"/opt/onap/ccsdk/Playbooks/dt/config\\",      |
1216 |                                 |                                                                                                                                                                  |                     |    \\"playbook\\":\\"ansible_vfw_distributetraffic@0.00.yml\\",           |
1217 |                                 |                                                                                                                                                                  |                     |    \\"node_list\\":\\"[vpkg-1]\\"                                         |
1218 |                                 |                                                                                                                                                                  |                     |    }                                                                      |
1219 |                                 |                                                                                                                                                                  |                     |    }"                                                                     |
1220 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------------------+
1221
1222 Exemplary CDT template for Ansible protocol::
1223
1224     {
1225         "PlaybookName": ${playbook},
1226         "NodeList": ${node_list},
1227         "EnvParameters": {
1228             "ConfigFileName": "${config_file_name}"
1229          },
1230         "Timeout": 3600
1231     }
1232
1233 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1234 Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.
1235
1236 DistributeTraffic Response
1237 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1238
1239 The response does not include any payload parameters.
1240
1241 **Success:** A successful distribute returns a success status code 400 after all traffic has been distributed.
1242
1243 **Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1244
1245 Evacuate
1246 --------
1247
1248 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).
1249
1250 The host on which the VM resides needs to be down.
1251
1252 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.
1253
1254 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm` parameter to false.
1255
1256 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
1257
1258 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1259
1260 +------------------------------+-------------------------------------------------------------------------+
1261 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:evacuate                     |
1262 +------------------------------+-------------------------------------------------------------------------+
1263 |     **Action**               |     Evacuate                                                            |
1264 +------------------------------+-------------------------------------------------------------------------+
1265 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                  |
1266 +------------------------------+-------------------------------------------------------------------------+
1267 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id, rebuild-vm, targethost-id           |
1268 +------------------------------+-------------------------------------------------------------------------+
1269 |     **Revision History**     |     Unchanged in this release.                                          |
1270 +------------------------------+-------------------------------------------------------------------------+
1271
1272 |
1273
1274 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1275 |     **Parameter**    |     **Description**                                                                                                                                                              |     **Required?**   |     **Example**                       |
1276 +======================+==================================================================================================================================================================================+=====================+=======================================+
1277 |     vm-id            |     The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self-link URL of the VM.                                                         |     Yes             |     "payload":                        |
1278 |                      |                                                                                                                                                                                  |                     |     "{\\"vm-id\\": \\"<VM-ID>         |
1279 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1280 |                      |                                                                                                                                                                                  |                     |     \\"identity-url\\":               |
1281 |                      |                                                                                                                                                                                  |                     |     \\"<IDENTITY-URL>\\",             |
1282 |                      |                                                                                                                                                                                  |                     |     \\"tenant-id\\": \\"<TENANT-ID>   |
1283 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1284 |                      |                                                                                                                                                                                  |                     |     \\"rebuild-vm\\": \\"false\\",    |
1285 |                      |                                                                                                                                                                                  |                     |     \\"targethost-id\\":              |
1286 |                      |                                                                                                                                                                                  |                     |     \\"nodeblade7\\"}"                |
1287 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1288 |     identity-url     |     The identity URL used to access the resource                                                                                                                                 |     Yes             |                                       |
1289 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1290 |     tenant-id        |     The id of the provider tenant that owns the resource                                                                                                                         |     Yes             |                                       |
1291 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1292 |     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              |                                       |
1293 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1294 |     targethost- id   |     A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host.                                                              |     No              |                                       |
1295 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1296
1297 Evacuate Response:
1298 ^^^^^^^^^^^^^^^^^^
1299 **Success:** A successful Evacuate returns a success status code 400.
1300 **Failure:** A failed Evacuate returns a failure code 401 and the failure message.
1301
1302
1303
1304 HealthCheck
1305 -----------
1306
1307 This command runs a VNF health check and returns the result.
1308
1309 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.
1310
1311
1312 +------------------------------+-----------------------------------------------------------+
1313 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:health-check   |
1314 +------------------------------+-----------------------------------------------------------+
1315 |     **Action**               |     HealthCheck                                           |
1316 +------------------------------+-----------------------------------------------------------+
1317 |     **Action-Identifiers**   |     Vnf-id                                                |
1318 +------------------------------+-----------------------------------------------------------+
1319 |     **Payload Parameters**   |     See below                                             |
1320 +------------------------------+-----------------------------------------------------------+
1321 |     **Revision History**     |     Unchanged in this release                             |
1322 +------------------------------+-----------------------------------------------------------+
1323
1324
1325 Request Payload Parameters:
1326
1327 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1328 |     **Parameter**   |     **Description**               |     **Required?**   |     **Example**                     |
1329 +=====================+===================================+=====================+=====================================+
1330 | request-parameters  |     host-ip-address -             |     No              |  "payload":                         |
1331 |                     |     Required only if REST         |                     |  "{\\"request-parameters \\":       |
1332 |                     |     service. This is the ip       |                     |  "{\\"host-ip-address\\":           |
1333 |                     |     address associated with the   |                     |  \\"10.222.22.2\\" }"               |
1334 |                     |     VM running the REST           |                     |                                     |
1335 |                     |     service.                      |                     |                                     |
1336 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1337
1338
1339 HealthCheck Response
1340 ^^^^^^^^^^^^^^^^^^^^
1341
1342 **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.
1343
1344     Examples::
1345
1346                 {
1347                   "identifier": "scope represented",
1348                   "state": "healthy",
1349                   "time": "01-01-1000:0000"
1350
1351                 }
1352
1353                 {
1354                    "identifier": "scope represented",
1355                    "state": "unhealthy",
1356                         {[
1357                    "info": "System threshold exceeded details",
1358                    "fault":
1359                          {
1360                            "cpuOverall": 0.80,
1361                            "cpuThreshold": 0.45
1362                          }
1363                         ]},
1364                    "time": "01-01-1000:0000"
1365                 }
1366
1367 **Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
1368
1369
1370 Lock
1371 ----
1372
1373 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1374
1375 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.
1376
1377 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.
1378
1379 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.
1380
1381 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.
1382
1383 The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file
1384
1385 +------------------------------+---------------------------------------------------+
1386 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:lock   |
1387 +------------------------------+---------------------------------------------------+
1388 |     **Action**               |     Lock                                          |
1389 +------------------------------+---------------------------------------------------+
1390 |     **Action-Identifier**    |     Vnf-id                                        |
1391 +------------------------------+---------------------------------------------------+
1392 |     **Payload Parameters**   |     None                                          |
1393 +------------------------------+---------------------------------------------------+
1394 |     **Revision History**     |     Unchanged in this release.                    |
1395 +------------------------------+---------------------------------------------------+
1396
1397 Lock Response
1398 ^^^^^^^^^^^^^
1399
1400 The Lock returns a 400 Success response if the Lock is successfully applied.
1401
1402 The Lock returns a 401 Failure response with the failure message if the Lock is not successful.
1403
1404
1405 Migrate
1406 -------
1407
1408 Migrates a running target VM from its current host to another.
1409
1410 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1411
1412 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.
1413
1414 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.
1415
1416
1417 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1418
1419
1420 +--------------------------------+-----------------------------------------------------------------------------------------------+
1421 | **Input Block**                | api-ver should be set to 2.00 for current version of Migrate                                  |
1422 +--------------------------------+-----------------------------------------------------------------------------------------------+
1423 |     **Target URL**             |     /restconf/operations/appc-provider-lcm:migrate                                            |
1424 +--------------------------------+-----------------------------------------------------------------------------------------------+
1425 |     **Action**                 |     Migrate                                                                                   |
1426 +--------------------------------+-----------------------------------------------------------------------------------------------+
1427 |     **Action-Identifiers**     |     Vnf-id, vserver-id                                                                        |
1428 +--------------------------------+-----------------------------------------------------------------------------------------------+
1429 |     **Payload Parameters**     |     vm-id, identity-url, tenant-id                                                            |
1430 +--------------------------------+-----------------------------------------------------------------------------------------------+
1431 |     **Revision History**       |     Unchanged in this release.                                                                |
1432 +--------------------------------+-----------------------------------------------------------------------------------------------+
1433
1434 Payload Parameters
1435
1436 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1437 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                               |
1438 +=====================+=========================================================================+=====================+===============================================+
1439 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                               |
1440 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                               |
1441 |                     |     link URL of the VM.                                                 |                     |     "payload":                                |
1442 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",             |
1443 |                     |                                                                         |                     |     \\"identity-url\\":                       |
1444 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",                     |
1445 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"tenant-id\\": \\"<TENANT-ID>\\"}"      |
1446 |     identity- url   |     The identity url used to access the resource                        |     Yes             |                                               |
1447 |                     |                                                                         |                     |                                               |
1448 +---------------------+-------------------------------------------------------------------------+---------------------+                                               |
1449 |     tenant-id       |     The id of the provider tenant that owns the resource                |     Yes             |                                               |
1450 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1451
1452
1453 Migrate Response
1454 ^^^^^^^^^^^^^^^^
1455
1456 **Success:** A successful Migrate returns a success status code 400.
1457
1458 **Failure:** A failed Migrate returns a failure code 401 and the failure message.
1459
1460
1461 QuiesceTraffic
1462 --------------
1463
1464 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.
1465
1466 This command is executed using an Ansible playbook or Chef cookbook.
1467
1468 Request Structure:
1469
1470 +--------------------------+----------------------------------------------------------+
1471 | **Target URL**           | /restconf/operations/appc-provider-lcm:quiesce-traffic   |
1472 +--------------------------+----------------------------------------------------------+
1473 | **Action**               | QuiesceTraffic                                           |
1474 +--------------------------+----------------------------------------------------------+
1475 | **Action-identifiers**   | vnf-id                                                   |
1476 +--------------------------+----------------------------------------------------------+
1477 | **Payload Parameters**   | operations-timeout                                       |
1478 +--------------------------+----------------------------------------------------------+
1479 | **Revision History**     | New in Beijing                                           |
1480 +--------------------------+----------------------------------------------------------+
1481
1482 Request Payload Parameters:
1483
1484 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
1485 | **Parameter**         |     **Description**                                                                                                                                                                                  |     **Required?**   |     **Example**                                |
1486 +=======================+======================================================================================================================================================================================================+=====================+================================================+
1487 | 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":                                 |
1488 |                       |                                                                                                                                                                                                      |                     |     "{\\"operations-timeout\\": \\"3600\\"}”   |
1489 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
1490
1491 QuiesceTraffic Response
1492 ^^^^^^^^^^^^^^^^^^^^^^^
1493
1494 The response does not include any payload parameters.
1495
1496 **Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced.
1497
1498    If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status.
1499
1500 **Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1501
1502     A specific error message is returned if there is a timeout error.
1503
1504 Reboot
1505 -------
1506
1507 The Reboot is used to reboot a VM.
1508
1509
1510 There are two types supported: HARD and SOFT. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.
1511
1512 **NOTE:** The command implementation is based on OpenStack functionality.  For further details, see http://developer.openstack.org/api-ref/compute/.
1513
1514 +------------------------------+-----------------------------------------------------------------------------------------------+
1515 | **Input Block**              | api-ver should be set to 2.00 for current version of Reboot                                   |
1516 +------------------------------+-----------------------------------------------------------------------------------------------+
1517 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:reboot                                             |
1518 +------------------------------+-----------------------------------------------------------------------------------------------+
1519 |     **Action**               |     Reboot                                                                                    |
1520 +------------------------------+-----------------------------------------------------------------------------------------------+
1521 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
1522 +------------------------------+-----------------------------------------------------------------------------------------------+
1523 |     **Payload Parameters**   |     See table below                                                                           |
1524 +------------------------------+-----------------------------------------------------------------------------------------------+
1525 |     **Revision History**     |     New in R3 release.                                                                        |
1526 +------------------------------+-----------------------------------------------------------------------------------------------+
1527
1528 Payload Parameters
1529
1530 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1531 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1532 +=================+===============================================+=================+=========================================+
1533 | type            |     The type of reboot.  Values are           | No              |                                         |
1534 |                 |     HARD and SOFT.  If not                    |                 |                                         |
1535 |                 |     specified, SOFT reboot is                 |                 | "payload":                              |
1536 |                 |     performed.                                |                 | "{\\"type\\": \\"HARD\\",               |
1537 |                 |                                               |                 |   \\"vm-id\\": \\"<VM-ID>\\",           |
1538 |                 |                                               |                 | \\"identity-url\\":                     |
1539 |                 |                                               |                 | \\"<IDENTITY-URL>\\"                    |
1540 |                 |                                               |                 | }"                                      |
1541 +-----------------+-----------------------------------------------+-----------------+                                         |
1542 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1543 |                 |     the resource. For backwards-              |                 |                                         |
1544 |                 |     compatibility, this can be the self-      |                 |                                         |
1545 |                 |     link URL of the VM.                       |                 |                                         |
1546 |                 |                                               |                 |                                         |
1547 |                 |                                               |                 |                                         |
1548 |                 |                                               |                 |                                         |
1549 |                 |                                               |                 |                                         |
1550 +-----------------+-----------------------------------------------+-----------------+                                         |
1551 | identity-url    |     The identity url used to access the       | Yes             |                                         |
1552 |                 |     resource.                                 |                 |                                         |
1553 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1554
1555 Reboot Response
1556 ^^^^^^^^^^^^^^^
1557
1558 **Success:** A successful Rebuild returns a success status code 400.
1559
1560 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
1561
1562 Rebuild
1563 -------
1564
1565 Recreates a target VM instance to a known, stable state.
1566
1567 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
1568
1569 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.
1570
1571 APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume
1572
1573
1574 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1575
1576
1577 +------------------------------+-----------------------------------------------------------------------------------------------+
1578 | **Input Block**              | api-ver should be set to 2.00 for current version of Rebuild                                  |
1579 +------------------------------+-----------------------------------------------------------------------------------------------+
1580 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:rebuild                                            |
1581 +------------------------------+-----------------------------------------------------------------------------------------------+
1582 |     **Action**               |     Rebuild                                                                                   |
1583 +------------------------------+-----------------------------------------------------------------------------------------------+
1584 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
1585 +------------------------------+-----------------------------------------------------------------------------------------------+
1586 |     **Payload Parameters**   |     See table below                                                                           |
1587 +------------------------------+-----------------------------------------------------------------------------------------------+
1588 |     **Revision History**     |     Unchanged in this release.                                                                |
1589 +------------------------------+-----------------------------------------------------------------------------------------------+
1590
1591
1592 Payload Parameters
1593
1594 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1595 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1596 +=================+===============================================+=================+=========================================+
1597 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1598 |                 |     the resource. For backwards-              |                 |                                         |
1599 |                 |     compatibility, this can be the self-      |                 | "payload":                              |
1600 |                 |     link URL of the VM.                       |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1601 |                 |                                               |                 | \\",                                    |
1602 |                 |                                               |                 | \\"identity-url\\":                     |
1603 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1604 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1605 +-----------------+-----------------------------------------------+-----------------+ \\"snapshot-id\\": \\"<SNAPSHOT- ID>\\" |
1606 | identity- url   |     The identity url used to access the       | Yes             | }"                                      |
1607 |                 |     resource.                                 |                 |                                         |
1608 +-----------------+-----------------------------------------------+-----------------+                                         |
1609 | tenant-id       |     The id of the provider tenant that owns   | Yes             |                                         |
1610 |                 |     the resource.                             |                 |                                         |
1611 +-----------------+-----------------------------------------------+-----------------+                                         |
1612 | snapshot-id     |  The snapshot-id of a previously saved image. | No              |                                         |
1613 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1614
1615 Rebuild Response
1616 ^^^^^^^^^^^^^^^^
1617
1618 **Success:** A successful Rebuild returns a success status code 400.
1619
1620 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
1621
1622 Restart
1623 -------
1624
1625 Use the Restart command to restart a VM.
1626
1627 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1628 |     **Input Block**          |     api-ver should be set to 2.00 for current version of Restart                                                |
1629 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1630 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:restart                                                              |
1631 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1632 |     **Action**               |     Restart                                                                                                     |
1633 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1634 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                          |
1635 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1636 |     **Payload Parameters**   |     See table below                                                                                             |
1637 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1638 |     **Revision History**     |     Unchanged in this release                                                                                   |
1639 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
1640
1641 Payload Parameters for **VM Restart**
1642
1643 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1644 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
1645 +=====================+=========================================================================+=====================+====================================+
1646 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
1647 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                    |
1648 |                     |     link URL of the VM                                                  |                     |     "payload":                     |
1649 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",  |
1650 |                     |                                                                         |                     |     \\"identity-url\\":            |
1651 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"<IDENTITY-URL>\\",          |
1652 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
1653 |                     |                                                                         |                     |     ID>\\"}"                       |
1654 +---------------------+-------------------------------------------------------------------------+---------------------+                                    |
1655 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
1656 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
1657
1658 ResumeTraffic
1659 -------------
1660
1661 The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.
1662
1663 This command is executed using an Ansible playbook or Chef cookbook.
1664
1665 Request Structure: The payload does not have any parameters.
1666
1667 +--------------------------+---------------------------------------------------------+
1668 | **Target URL**           | /restconf/operations/appc-provider-lcm:resume-traffic   |
1669 +--------------------------+---------------------------------------------------------+
1670 | **Action**               | ResumeTraffic                                           |
1671 +--------------------------+---------------------------------------------------------+
1672 | **Action-identifiers**   | vnf-id                                                  |
1673 +--------------------------+---------------------------------------------------------+
1674 | **Payload Parameters**   |                                                         |
1675 +--------------------------+---------------------------------------------------------+
1676 | **Revision History**     | New in Beijing                                          |
1677 +--------------------------+---------------------------------------------------------+
1678
1679 ResumeTraffic Response
1680 ^^^^^^^^^^^^^^^^^^^^^^
1681
1682 **Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed.
1683
1684 If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status
1685
1686 **Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1687
1688
1689 Snapshot
1690 --------
1691
1692 Creates a snapshot of a VM.
1693
1694 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
1695
1696 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.
1697
1698 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.
1699
1700 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1701
1702 +------------------------------+-----------------------------------------------------------------------------------------------------+
1703 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:snapshot                                                 |
1704 +------------------------------+-----------------------------------------------------------------------------------------------------+
1705 |     **Action**               |     Snapshot                                                                                        |
1706 +------------------------------+-----------------------------------------------------------------------------------------------------+
1707 |     **Action-identifiers**   |     vnf-id, vserver-id                                                                              |
1708 +------------------------------+-----------------------------------------------------------------------------------------------------+
1709 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id                                                                  |
1710 +------------------------------+-----------------------------------------------------------------------------------------------------+
1711 |     **Revision History**     |     Unchanged in this release.                                                                      |
1712 +------------------------------+-----------------------------------------------------------------------------------------------------+
1713
1714 Payload Parameters
1715
1716 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
1717 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                        |
1718 +=====================+=========================================================================+=====================+========================================+
1719 |     vm-id           |     The self-link URL of the VM                                         |     Yes             |                                        |
1720 |                     |                                                                         |                     |     "payload":                         |
1721 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",      |
1722 |                     |                                                                         |                     |     \\"identity-url\\":                |
1723 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",              |
1724 |                     |                                                                         |                     |     \\"tenant-id\\":\\"<TENANT-ID>\\"}"|
1725 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
1726 |     identity- url   |     The identity url used to access the resource                        |     No              |                                        |
1727 |                     |                                                                         |                     |                                        |
1728 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
1729 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                        |
1730 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
1731
1732 Snapshot Response
1733 ^^^^^^^^^^^^^^^^^
1734
1735 The Snapshot command returns an extended version of the LCM response.
1736
1737 The Snapshot response conforms to the standard response format.
1738
1739
1740 Start
1741 -----
1742
1743 Use the Start command to start a VM that is stopped.
1744
1745 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1746
1747 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1748 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start                                                                               |
1749 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1750 |     **Action**               |     Start                                                                                                                      |
1751 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1752 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                                         |
1753 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1754 |     **Payload Parameters**   |     See table below                                                                                                            |
1755 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1756 |     **Revision History**     |     Unchanged in this release                                                                                                  |
1757 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1758
1759 Payload Parameters
1760
1761 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1762 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1763 +=================+===============================================+=================+=========================================+
1764 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1765 |                 |     the resource. For backwards-              |                 | "payload":                              |
1766 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1767 |                 |     link URL of the VM.                       |                 | \\",                                    |
1768 |                 |                                               |                 | \\"identity-url\\":                     |
1769 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1770 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1771 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1772 | identity- url   |     The identity url used to access the       | No              |                                         |
1773 |                 |     resource                                  |                 |                                         |
1774 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1775 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
1776 |                 |     the resource                              |                 |                                         |
1777 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1778
1779
1780 StartApplication
1781 ----------------
1782
1783 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.
1784
1785 A successful StartApplication request returns a success response.
1786
1787 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
1788
1789 +------------------------------+---------------------------------------------------------------+
1790 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start-application  |
1791 +------------------------------+---------------------------------------------------------------+
1792 |     **Action**               |     StartApplication                                          |
1793 +------------------------------+---------------------------------------------------------------+
1794 |     **Action-Identifiers**   |     Vnf-id                                                    |
1795 +------------------------------+---------------------------------------------------------------+
1796 |     **Payload Parameters**   |     See table below                                           |
1797 +------------------------------+---------------------------------------------------------------+
1798 |     **Revision History**     |     Unchanged in this release.                                |
1799 +------------------------------+---------------------------------------------------------------+
1800
1801 |
1802
1803 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1804 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1805 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1806 |                                 |                                                                                                                                                                                    |                     |  "payload":                                                     |
1807 |     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>\\"}    |
1808 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1809
1810 StartApplication Response
1811 ^^^^^^^^^^^^^^^^^^^^^^^^^
1812
1813 The StartApplication response returns an indication of success or failure of the request.
1814
1815 Stop
1816 ----
1817
1818 Use the Stop command to stop a VM that was running.
1819
1820 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1821
1822 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1823 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop                                                                                |
1824 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1825 |     **Action**               |     Stop                                                                                                                       |
1826 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1827 |     **Action-identifiers**   |     vnf-id and vserver-id are required.                                                                                        |
1828 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1829 |     **Payload Parameters**   |     See table below                                                                                                            |
1830 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1831 |     **Revision History**     |     Unchanged in this release                                                                                                  |
1832 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
1833
1834 Payload Parameters
1835
1836 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1837 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
1838 +=================+===============================================+=================+=========================================+
1839 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
1840 |                 |     the resource. For backwards-              |                 | "payload":                              |
1841 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
1842 |                 |     link URL of the VM.                       |                 | \\",                                    |
1843 |                 |                                               |                 | \\"identity-url\\":                     |
1844 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
1845 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
1846 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1847 | identity- url   |     The identity url used to access the       | No              |                                         |
1848 |                 |     resource                                  |                 |                                         |
1849 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1850 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
1851 |                 |     the resource                              |                 |                                         |
1852 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
1853
1854
1855 StopApplication
1856 ---------------
1857
1858 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
1859
1860 A successful StopApplication request returns a success response.
1861
1862 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
1863
1864 +------------------------------+--------------------------------------------------------------+
1865 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop-application  |
1866 +------------------------------+--------------------------------------------------------------+
1867 |     **Action**               |     StopApplication                                          |
1868 +------------------------------+--------------------------------------------------------------+
1869 |     **Action-Identifiers**   |     Vnf-id                                                   |
1870 +------------------------------+--------------------------------------------------------------+
1871 |     **Payload Parameters**   |     See table below                                          |
1872 +------------------------------+--------------------------------------------------------------+
1873 |     **Revision History**     |     Unchanged in this release                                |
1874 +------------------------------+--------------------------------------------------------------+
1875
1876 |
1877
1878 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1879 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1880 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1881 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |     "payload":                                                  |
1882 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
1883 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1884
1885
1886 StopApplication Response
1887 ^^^^^^^^^^^^^^^^^^^^^^^^
1888
1889 The StopApplication response returns an indication of success or failure of the request.
1890
1891 Sync
1892 ----
1893
1894 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
1895
1896 A successful Sync returns a success status.
1897
1898 A failed Sync returns a failure response status and failure messages in the response payload block.
1899
1900 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).
1901
1902 +------------------------------+---------------------------------------------------+
1903 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:sync   |
1904 +------------------------------+---------------------------------------------------+
1905 |     **Action**               |     Sync                                          |
1906 +------------------------------+---------------------------------------------------+
1907 |     **Action-identifiers**   |     Vnf-id                                        |
1908 +------------------------------+---------------------------------------------------+
1909 |     **Payload Parameters**   |     None                                          |
1910 +------------------------------+---------------------------------------------------+
1911 |     **Revision History**     |     Unchanged in this release.                    |
1912 +------------------------------+---------------------------------------------------+
1913
1914 Unlock
1915 ------
1916
1917 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
1918
1919 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.
1920
1921 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
1922
1923 The Unlock command will only return success if the VNF was locked with same request-id.
1924
1925 The Unlock command returns only one final response with the status of the request processing.
1926
1927 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.
1928
1929 +------------------------------+-----------------------------------------------------+
1930 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:unlock   |
1931 +------------------------------+-----------------------------------------------------+
1932 |     **Action**               |     Unlock                                          |
1933 +------------------------------+-----------------------------------------------------+
1934 |     **Action-identifiers**   |     Vnf-id                                          |
1935 +------------------------------+-----------------------------------------------------+
1936 |     **Payload Parameters**   |     see table below                                 |
1937 +------------------------------+-----------------------------------------------------+
1938 |     **Revision History**     |     Unchanged in this release.                      |
1939 +------------------------------+-----------------------------------------------------+
1940
1941 |
1942
1943 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
1944 |     **Payload Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                  |
1945 +=================================+=========================================================================+=====================+==================================+
1946 |     request-id                  |     Request id from the previously submitted request                    |     Yes             |    "request-id": "123456789"     |
1947 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
1948
1949
1950 UpgradeBackout
1951 --------------
1952
1953 The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
1954
1955 This command is executed using an Ansible playbook or Chef cookbook.
1956
1957 Request Structure: The request payload includes an upgrade identifier.
1958
1959 +--------------------------+----------------------------------------------------------+
1960 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backout   |
1961 +--------------------------+----------------------------------------------------------+
1962 | **Action**               | UpgradeBackout                                           |
1963 +--------------------------+----------------------------------------------------------+
1964 | **Action-identifiers**   | vnf-id                                                   |
1965 +--------------------------+----------------------------------------------------------+
1966 | **Payload Parameters**   | existing-software-version, new-software-version          |
1967 +--------------------------+----------------------------------------------------------+
1968 | **Revision History**     | New in Beijing                                           |
1969 +--------------------------+----------------------------------------------------------+
1970
1971 Request Payload Parameters:
1972
1973 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1974 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1975 +=======================+=====================================+=====================+===============================================================================================+
1976 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
1977 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
1978 +-----------------------+-------------------------------------+---------------------+                                                                                               |
1979 | new-software-         |     The new software                |     Yes             |                                                                                               |
1980 | version               |     version after the               |                     |                                                                                               |
1981 |                       |     upgrade                         |                     |                                                                                               |
1982 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1983
1984 UpgradeBackout Response
1985 ^^^^^^^^^^^^^^^^^^^^^^^
1986
1987 **Success:** A successful backout returns a success status code 400.
1988
1989 **Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1990
1991 UpgradeBackup
1992 -------------
1993
1994 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.
1995
1996 This command is executed using an Ansible playbook or Chef cookbook.
1997
1998 Request Structure: The payload does not have any parameters required.
1999
2000 +--------------------------+---------------------------------------------------------+
2001 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backup   |
2002 +--------------------------+---------------------------------------------------------+
2003 | **Action**               | UpgradeBackup                                           |
2004 +--------------------------+---------------------------------------------------------+
2005 | **Action-identifiers**   | vnf-id                                                  |
2006 +--------------------------+---------------------------------------------------------+
2007 | **Payload Parameters**   | existing-software-version, new-software-version         |
2008 +--------------------------+---------------------------------------------------------+
2009 | **Revision History**     | New in Beijing.                                         |
2010 +--------------------------+---------------------------------------------------------+
2011
2012 Request Payload Parameters:
2013
2014 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2015 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2016 +=======================+=====================================+=====================+===============================================================================================+
2017 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2018 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2019 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2020 | new-software-         |     The new software                |     Yes             |                                                                                               |
2021 | version               |     version after the               |                     |                                                                                               |
2022 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2023
2024 UpgradeBackup Response
2025 ^^^^^^^^^^^^^^^^^^^^^^
2026
2027 **Success:** A successful backup returns a success status code 400.
2028
2029 **Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2030
2031 UpgradePostCheck
2032 ----------------
2033
2034 The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.
2035
2036 This command is executed using an Ansible playbook or Chef cookbook.
2037
2038 Request Structure:
2039
2040 +--------------------------+-------------------------------------------------------------+
2041 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-post-check   |
2042 +--------------------------+-------------------------------------------------------------+
2043 | **Action**               | UpgradePostCheck                                            |
2044 +--------------------------+-------------------------------------------------------------+
2045 | **Action-identifiers**   | vnf-id                                                      |
2046 +--------------------------+-------------------------------------------------------------+
2047 | **Payload Parameters**   | existing-software-version, new-software-version             |
2048 +--------------------------+-------------------------------------------------------------+
2049 | **Revision History**     | New in Beijing                                              |
2050 +--------------------------+-------------------------------------------------------------+
2051
2052 Request Payload Parameters:
2053
2054 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2055 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2056 +=======================+=====================================+=====================+===============================================================================================+
2057 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
2058 |  version              |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2059 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2060 | new-software-         |     The new software                |     Yes             |                                                                                               |
2061 | version               |     version after the               |                     |                                                                                               |
2062 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2063
2064 UpgradePostCheck Response
2065 ^^^^^^^^^^^^^^^^^^^^^^^^^
2066
2067 **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).
2068
2069 Response Payload Parameters:
2070
2071 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2072 | **Parameter** |     **Description**         |**Required?**|     **Example**                                                              |
2073 +===============+=============================+=============+==============================================================================+
2074 | Upgrade-      |     Returns the status      |     Yes     |                                                                              |
2075 | Status        |     of the upgradw          |             |     "payload":                                                               |
2076 |               |     post-check. Indicates   |             |     "{\\"upgrade-status\\": \\"Completed\\"}”                                |
2077 |               |     Completed or Failed     |             |     "payload": "{\\"upgrade-status\\":                                       |
2078 |               |                             |             |     \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” |
2079 +---------------+-----------------------------+-------------+                                                                              |
2080 | Message       |     If Not Available,       |             |                                                                              |
2081 |               |     message contains        |             |                                                                              |
2082 |               |     explanation.            |             |                                                                              |
2083 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2084
2085 **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.
2086
2087 UpgradePreCheck
2088 ---------------
2089
2090 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).
2091
2092 This command is executed using an Ansible playbook or Chef cookbook.
2093
2094 Request Structure:
2095
2096 +--------------------------+------------------------------------------------------------+
2097 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-pre-check   |
2098 +--------------------------+------------------------------------------------------------+
2099 | **Action**               | UpgradePreCheck                                            |
2100 +--------------------------+------------------------------------------------------------+
2101 | **Action-identifiers**   | vnf-id                                                     |
2102 +--------------------------+------------------------------------------------------------+
2103 | **Payload Parameters**   | existing-software-version, new-software-version            |
2104 +--------------------------+------------------------------------------------------------+
2105 | **Revision History**     | New in Beijing                                             |
2106 +--------------------------+------------------------------------------------------------+
2107
2108 Request Payload Parameters:
2109
2110 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2111 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2112 +=======================+=====================================+=====================+===============================================================================================+
2113 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2114 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2115 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2116 | new-software-         |     The new software                |     Yes             |                                                                                               |
2117 | version               |     version after the               |                     |                                                                                               |
2118 |                       |     upgrade                         |                     |                                                                                               |
2119 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2120
2121 UpgradePreCheck Response
2122 ^^^^^^^^^^^^^^^^^^^^^^^^
2123
2124 **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).
2125
2126 Response Payload Parameters:
2127
2128 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2129 | **Parameter**   |     **Description**       |     **Required?**   |     **Example**                                                                                                                  |
2130 +=================+===========================+=====================+==================================================================================================================================+
2131 | upgrade-status  |     Returns the status    |     Yes             |                                                                                                                                  |
2132 |                 |     of the upgrade pre-   |                     |     "payload":                                                                                                                   |
2133 |                 |     check. Indicates      |                     |     "{\\"upgrade-status\\": \\"Available\\"}”                                                                                    |
2134 |                 |     Available or Not      |                     |                                                                                                                                  |
2135 |                 |     Available             |                     |     "payload":                                                                                                                   |
2136 |                 |                           |                     |     "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }”   |
2137 +-----------------+---------------------------+---------------------+                                                                                                                                  |
2138 |     message     |     If Not Available,     |                     |                                                                                                                                  |
2139 |                 |     message contains      |                     |                                                                                                                                  |
2140 |                 |     explanation.          |                     |                                                                                                                                  |
2141 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2142
2143 **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.
2144
2145 UpgradeSoftware
2146 ---------------
2147
2148 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).
2149
2150 This command is executed using an Ansible playbook or Chef cookbook.
2151
2152 Request Structure: The request payload includes the new-software-version.
2153
2154 +--------------------------+-----------------------------------------------------------+
2155 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-software   |
2156 +--------------------------+-----------------------------------------------------------+
2157 | **Action**               | UpgradeSoftware                                           |
2158 +--------------------------+-----------------------------------------------------------+
2159 | **Action-identifiers**   | vnf-id                                                    |
2160 +--------------------------+-----------------------------------------------------------+
2161 | **Payload Parameters**   | existing-software-version, new-software-version           |
2162 +--------------------------+-----------------------------------------------------------+
2163 | **Revision History**     | New in Beijing                                            |
2164 +--------------------------+-----------------------------------------------------------+
2165
2166  Request Payload Parameters:
2167
2168 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2169 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2170 +=======================+=====================================+=====================+===============================================================================================+
2171 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
2172 | version               |      prior to the upgrade           |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2173 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2174 | new-software          |     The new software                |     Yes             |                                                                                               |
2175 | version               |     version after the               |                     |                                                                                               |
2176 |                       |     upgrade                         |                     |                                                                                               |
2177 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2178
2179 UpgradeSoftware Response
2180 ^^^^^^^^^^^^^^^^^^^^^^^^
2181
2182 **Success:** A successful upgrade returns a success status code 400.
2183
2184 If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status.
2185
2186 **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.
2187
2188 Notes regarding the Upgrade commands
2189 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2190 Ansible playbooks / Chef cookbooks:
2191
2192 -  All Ansible playbooks/cookbooks for the Upgrade commands will be
2193    stored in the same directory on the server. The directory name will
2194    be of the format:
2195
2196         {existing-software-version_new-software-version}.
2197
2198                 The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade).
2199
2200 -  The playbooks for upgrades should use a standard naming convention
2201    (for example: SoftwareUpgrade_{existing-software-version_new-software-version}).
2202
2203 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.
2204
2205 -  The template will contain the directory path/playbook name which
2206    would be parameterized.
2207
2208     {vnf-type}/UpgradeSoftware/${existing_software_version}_${new-software-version}/
2209     SoftwareUpgrade_{existing-software-version_new-software-version}.
2210
2211