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

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