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

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