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

   1 .. ============LICENSE_START==========================================
   2 .. ===================================================================
   3 .. Copyright © 2017-2018 AT&T Intellectual Property. All rights reserved.
   4 .. ===================================================================
   5 .. Licensed under the Creative Commons License, Attribution 4.0 Intl.  (the "License");
   6 .. you may not use this documentation except in compliance with the License.
   7 .. You may obtain a copy of the License at
   8 ..
   9 ..  https://creativecommons.org/licenses/by/4.0/
  10 ..
  11 .. Unless required by applicable law or agreed to in writing, software
  12 .. distributed under the License is distributed on an "AS IS" BASIS,
  13 .. WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
  14 .. See the License for the specific language governing permissions and
  15 .. limitations under the License.
  16 .. ============LICENSE_END============================================
  17 .. ECOMP is a trademark and service mark of AT&T Intellectual Property.
  18
  19 .. _appc_api_guide:
  20
  21 ==================
  22 APPC LCM API Guide
  23 ==================
  24
  25 Introduction
  26 ============
  27
  28 This guide describes the APPC API that allows you to manage and control the life cycle of controlled virtual network functions (VNFs).
  29
  30
  31 Target Audience
  32 ---------------
  33 This document is intended for an advanced technical audience, such as the engineers or architects who need to use this guide to develop an interfacing application. The guide assumes a knowledge of the Open Network Automation Platform (ONAP) components and features, and familiarity with JSON notation.
  34
  35
  36 Life Cycle Management Commands
  37 ==============================
  38
  39 APPC receives commands from external ONAP components, such as SO, Policy, DCAE, or the Portal, to manage the life cycle of virtual applications and their components.
  40
  41 A virtual application is composed of the following layers of network technology:
  42
  43 - Virtual Network Function (VNF)
  44 - Virtual Network Function Component (VNFC)
  45 - Virtual Machine (VM)
  46
  47 A Life Cycle Management (LCM) command may affect one or more of these layers.
  48
  49 An LCM command is sent as a request to the APPC using an HTTP POST request or in a message on a message bus (DMaaP).  A request may result in either a single synchronous response or multiple asynchronous responses:
  50
  51 - An **asynchronous** command, which is sent as an authorized and valid request, results in at least two discrete response events:
  52     - an accept response, to indicate that the request is accepted for processing
  53     - a final response to indicate the status and outcome of the request processing
  54     - An unauthorized or invalid request results in a single ERROR response.
  55
  56 - A **synchronous** command, such as Lock or Unlock, results in a single response that is either SUCCESS or ERROR.
  57
  58 **NOTE:** For both asynchronous or synchronous commands, the first response is always returned using the same transport that the initial action used. For example, if the action request was via the message bus (such as when it originates from Policy), then the response is also via the message bus. However, if the request was via a direct HTTP call, the response is similarly a synchronous HTTP response.
  59
  60
  61 Message Bus and the LCM API Client Library
  62 ------------------------------------------
  63
  64 The recommended approach for sending/receiving requests to APPC is via the message bus.   To support this approach, an APPC client library is available and should be used.  The client library aims to provide consumers of APPC capabilities with a strongly-typed Java interface and to encapsulate the actual interaction with APPC component via the message bus.
  65
  66 For more details, see the APPC Client Library Guide at:
  67
  68   :ref:`appc_client_library`
  69
  70
  71 The client library supports both synchronous and asynchronous flows as follows.
  72
  73 Asynchronous Flow
  74 ^^^^^^^^^^^^^^^^^
  75
  76 - The APPC Client Library is called via an asynchronous API using a full command object, which is mapped to a JSON representation.
  77 - The APPC client calls the message bus client and sends the JSON command to a configured topic.
  78 - The APPC client pulls response messages from the configured topic.
  79 - On receiving the response for the command, APPC client runs the relevant callback method of the consumer ResponseHandler.
  80
  81 Synchronous Flow
  82 ^^^^^^^^^^^^^^^^
  83
  84 - The APPC Client Library is called via a synchronous API using a full command object, which is mapped to a JSON representation.
  85 - The APPC client calls the message bus client and sends the JSON command to a configured topic.
  86 - The APPC client pulls response messages from the configured topic.
  87 - On receiving the final response for the command, the APPC client returns the response object with a final status.
  88
  89 The client library adds the following wrapper around request and responses to the LCM API (described below)::
  90
  91     {
  92         "version" : "2.0",
  93         "cambria.partition" : "<TOPIC>",
  94         "correlation-id" :"<CORRELATION_ID>",
  95         "rpc-name" : "<RPC_NME>",
  96         "type" : <MESSAGE_TYPE>
  97         "body" : <RPC_SPECIFIC_BODY>
  98     }
  99
 100
 101
 102 Table 1 Request / Response Message Fields
 103
 104 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 105 | **Field**            | **Description**                                                                                                | **Required**        |
 106 +======================+================================================================================================================+=====================+
 107 | version              | Indicates the version of the message bus protocol with APPC. Version 2.0 should be used.                       |     Yes             |
 108 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 109 | cambria. partition   | Indicates the specific topic partition that the message is intended for. For example:                          |     No              |
 110 |                      |                                                                                                                |                     |
 111 |                      | -  For incoming messages, this value should be ``APPC``.                                                       |                     |
 112 |                      |                                                                                                                |                     |
 113 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 114 | correlation- id      | Correlation ID used for associating responses in APPC Client Library.                                          |     Yes             |
 115 |                      | Built as: ``<request-id>-<sub-request-id>``                                                                    |                     |
 116 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 117 | rpc-name             | The target Remote Processing Call (RPC) name which should match the LCM command name. For example:``configure``|     Yes             |
 118 |                      |                                                                                                                |                     |
 119 |                      | The convention for RPC names and the target URL is that multi-word command names should have a dash between    |                     |
 120 |                      | words, e.g.,                                                                                                   |                     |
 121 |                      | /restconf/operations/appc-provider-lcm:action-status                                                           |                     |
 122 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 123 | type                 | Message type: request, response or error                                                                       |     Yes             |
 124 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 125 | body                 | Contains the input or output LCM command content, which is either the request or response                      |                     |
 126 |                      | The body field format is identical to the equivalent HTTP Rest API command based on the specific RPC name.     |     Yes             |
 127 |                      | For example::                                                                                                  |                     |
 128 |                      |                                                                                                                |                     |
 129 |                      |     {                                                                                                          |                     |
 130 |                      |     "input" : {                                                                                                |                     |
 131 |                      |                 "common-header" : {...}                                                                        |                     |
 132 |                      |                 "action" : "configure",                                                                        |                     |
 133 |                      |                 "action-identifiers" : {...},                                                                  |                     |
 134 |                      |                 "payload": "..."                                                                               |                     |
 135 |                      |     }                                                                                                          |                     |
 136 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
 137
 138
 139 Generic Request Format
 140 ----------------------
 141
 142 The LCM API general request format is applicable for both POST HTTP API and for the message body received via the message bus.
 143
 144 LCM Request
 145 ^^^^^^^^^^^
 146
 147 The LCM request comprises a common header and a section containing the details of the LCM action.
 148 The LCM request conforms to the following structure::
 149
 150     {
 151     "input": {
 152                 "common-header": {"timestamp": "<TIMESTAMP>",
 153                                         "api-ver": "<API_VERSION>",
 154                                         "originator-id": "<SYSTEM_ID>",
 155                                         "request-id": "<REQUEST_ID>",
 156                                         "sub-request-id": "<SUBREQUEST_ID>",
 157                                         "flags": {
 158                                                    "mode": "<EXCLUSIVE|NORMAL>",
 159                                                    "force": "<TRUE|FALSE>",
 160                                                    "ttl": "<TTL_VALUE>"
 161                                                  }
 162                                  },
 163                 "action": "<COMMAND_ACTION>",
 164                 "action-identifiers": {
 165                                         "vnf-id": "<VNF_ID>",
 166                                         "vnfc-name": "<VNFC_NAME>",
 167                                         "vserver-id": "VSERVER_ID"
 168                                       },
 169                 ["payload": "<PAYLOAD>"]
 170              }
 171     }
 172
 173
 174 Table 2 LCM Request Fields
 175
 176 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 177 |     **Field**             |     **Description**                                                                                                                                                                                                                                                                                                                                                         |     **Required?**   |
 178 +===========================+=============================================================================================================================================================================================================================================================================================================================================================================+=====================+
 179 |     input                 |     The block that defines the details of the input to the command processing. Contains the common-header details.                                                                                                                                                                                                                                                          |     Yes             |
 180 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 181 |     common- header        |     The block that contains the generic details about a request.                                                                                                                                                                                                                                                                                                            |     Yes             |
 182 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 183 |     timestamp             |     The time of the request, in ISO 8601 format, ZULU offset. For example: 2016-08-03T08:50:18.97Z.                                                                                                                                                                                                                                                                         |     Yes             |
 184 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 185 |                           |     APPC will reject the request if timestamp is in the future (due to clock error), or timestamp is too old (compared to TTL flag)                                                                                                                                                                                                                                         |                     |
 186 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 187 |     api-ver               |     Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version.                                                                                                                                                                                                                    |     Yes             |
 188 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 189 |                           |     2.00 should be used for all LCM API requests                                                                                                                                                                                                                                                                                                                            |                     |
 190 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 191 |     originator-id         |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                                                                                                                                                                               |     Yes             |
 192 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 193 |                           |     It can be used for addressing purposes, such as to return an asynchronous response to the correct destination, in particular where there are multiple consumers of APPC APIs.                                                                                                                                                                                           |                     |
 194 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 195 |     request-id            |     The UUID for the request ID, limited to a length of 40 characters. The unique OSS/BSS identifier for the request ID that triggers the current LCM action. Multiple API calls can be made with the same request-id.                                                                                                                                                      |     Yes             |
 196 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 197 |                           |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                                                                                                                                                                   |                     |
 198 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 199 |     sub-request-id        |     Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request.                                                                                                                                                                                                                     |     No              |
 200 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 201 |     flags                 | Generic flags that apply to all LCM actions:                                                                                                                                                                                                                                                                                                                                |     No              |
 202 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 203 |                           | -  "MODE" :                                                                                                                                                                                                                                                                                                                                                                 |                     |
 204 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 205 |                           |    -  "EXCLUSIVE" - reject requests on this VNF while another request is in progress, or                                                                                                                                                                                                                                                                                    |                     |
 206 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 207 |                           |    -  "NORMAL" - allow requests (pending additional validations) on this VNF if there is another request is in progress.                                                                                                                                                                                                                                                    |                     |
 208 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 209 |                           | -  "FORCE" :                                                                                                                                                                                                                                                                                                                                                                |                     |
 210 |                           |       - **TRUE** – forces APPC to process the request regardless of whether there is another request for the VNF or VM in progress.                                                                                                                                                                                                                                         |                     |
 211 |                           |       - **FALSE** – default value. Will return an error if there is another action in progress on the same VNF or VM, unless the two actions are allowed in parallel based on a Request Management Model stored in APPC. The model allows some non-disruptive actions such as Lock, Unlock, CheckLock, and ActionStatus to be performed in conjunction with other actions.  |                     |
 212 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 213 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 214 |                           | -  "TTL": <0....N> - The timeout value is used to determine if the request timeout has been exceeded (i.e., if the TTL value is less than the current time minus the timestamp, the request is rejected). The value is in seconds.                                                                                                                                          |                     |
 215 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 216 |                           |     If no TTL value provided, the default/configurable TTL value is to be used.                                                                                                                                                                                                                                                                                             |                     |
 217 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 218 |     action                |     The action to be taken by APPC, for example: Test, Start                                                                                                                                                                                                                                                                                                                |     Yes             |
 219 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 220 |                           |     These are case-sensitive; e.g.,”Restart” is correct; “restart” is incorrect.                                                                                                                                                                                                                                                                                            |                     |
 221 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 222 |                           |     ***NOTE:** The specific value for the action parameter is provided for each command.                                                                                                                                                                                                                                                                                    |                     |
 223 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 224 |     action-identifiers    |     A block containing the action arguments. These are used to specify the object upon which APPC LCM command is to operate. At least one action-identifier must be specified (note that vnf-id is mandatory). For actions that are at the VM level, the action-identifiers provided would be vnf-id and vserver-id.                                                        |     Yes             |
 225 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 226 |     service-instance-id   |     Identifies a specific service instance that the command refers to. When multiple APPC instances are used and applied to a subset of services, this will become significant. The field is mandatory when the vnf-id is empty. Currently not used.                                                                                                                        |     No              |
 227 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 228 |     vnf-id                |     Identifies the VNF instance to which this action is to be applied. Required for actions.                                                                                                                                                                                                                                                                                |     Yes             |
 229 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 230 |     vnfc-name             |     Identifies the VNFC instance to which this action is to be applied. Required if the action applied to a specific VNFC. Currently not used.                                                                                                                                                                                                                              |     No              |
 231 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 232 |     vserver-id            |     Identifies a specific VM instance to which this action is to be applied. Required if the action applied to a specific VM. (Populate the vserver-id field with the UUID of the VM)                                                                                                                                                                                       |     No              |
 233 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 234 |     vf-module-id          |     Identifies a specific VF module to which this action is to be applied. Required if the action applied to a specific VF module.                                                                                                                                                                                                                                          |     No              |
 235 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 236 |     payload               |     An action-specific open-format field.                                                                                                                                                                                                                                                                                                                                   |     No              |
 237 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 238 |                           |     The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example:                                                                                                                                                                                                          |                     |
 239 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 240 |                           |        ``"{\" vnf-host-ip-address\": \"<VNF-HOST-IP-ADDRESS>\"}"``                                                                                                                                                                                                                                                                                                          |                     |
 241 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 242 |                           |     The payload is typically used to provide parametric data associated with the command, such as a list of configuration parameters.                                                                                                                                                                                                                                       |                     |
 243 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 244 |                           |     Note that not all LCM commands need have a payload.                                                                                                                                                                                                                                                                                                                     |                     |
 245 |                           |                                                                                                                                                                                                                                                                                                                                                                             |                     |
 246 |                           |     ***NOTE:** See discussion below on the use of payloads for self-service actions.                                                                                                                                                                                                                                                                                        |                     |
 247 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 248
 249 Request Processing and Validation Logic
 250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 251
 252 When a new request is received, APPC applies the following validation logic. For any failure, the request is rejected and an error (300 range) is returned.
 253
 254 1. If the request has timeout (i.e., the difference between current
 255    time and the request timestamp value is greater than TTL value in
 256    request), a timeout error is returned.
 257
 258 2. If the request is a duplicate of an existing request in progress
 259    (same request-id, sub-request-id, originator-id), a duplicate error
 260    is returned.
 261
 262 3. If there is a Lock on the vnf-id, reject any new action if it is not
 263    associated with the locking request-id, a lockout error is returned.
 264
 265 4. If the Force flag = Y, then allow the new action regardless of
 266    whether there is an action in progress.
 267
 268 5. If the Mode flag = Exclusive on a request in progress, any new
 269    request is rejected until the request in progress is completed.
 270
 271 6. If request is received and there are one or more requests in
 272    progress, then the new request is evaluated to determine if there is
 273    any overlap in scope with the existing requests (for example, a new
 274    VNF level request would overlap with another request in progress).
 275
 276    a. If there is no overlap between the new request and requests in
 277       progress, the new request is accepted.
 278
 279    b. If there is overlap, then only special cases are allowed in
 280       parallel (for example, Audit and HealthCheck are allowed).
 281
 282
 283 Generic Response Format
 284 -----------------------
 285
 286
 287 This section describes the generic response format.
 288
 289 The response format is applicable for both POST HTTP API and for the message body received via the message bus.
 290
 291
 292 LCM Response
 293 ^^^^^^^^^^^^
 294
 295 The LCM response comprises a common header and a section containing the payload and action details.
 296
 297 The LCM response conforms to the following structure::
 298
 299     {
 300         "output": {
 301                     "common-header": {
 302                                         "api-ver": "<API_VERSION>",
 303                                         "flags": {
 304                                                    "ttl": <TTL_VALUE>,
 305                                                    "force": "<TRUE|FALSE>",
 306                                                    "mode": "<EXCLUSIVE|NORMAL>"
 307                                                  },
 308                                         "originator-id": "<SYSTEM_ID>",
 309                                         "request-id": "<REQUEST_ID>",
 310                                         "sub-request-id": "<SUBREQUEST_ID>",
 311                                         "timestamp": "2016-08-08T23:09:00.11Z",
 312                                      },
 313                     "payload": "<PAYLOAD>",
 314                     [Additional fields],
 315                     "status": {
 316                                 "code": <RESULT_CODE>,
 317                                 "message": "<RESULT_MESSAGE>"
 318                               }
 319                   }
 320     }
 321
 322
 323 Table 3 LCM Response Fields
 324
 325 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 326 |     **Field**        |     **Description**                                                                                                                                                                                                       |     **Required?**   |
 327 +======================+===========================================================================================================================================================================================================================+=====================+
 328 |     output           |     The block that defines the details of the output of the command processing. Contains the ``common-header`` details.                                                                                                   |     Yes             |
 329 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 330 |     common- header   |     The block that contains the generic details about a request.                                                                                                                                                          |     Yes             |
 331 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 332 |     api-ver          |     Identifies the API version, in X.YY format, where X denotes the major version increased with each APPC release, and YY is the minor release version.                                                                  |     Yes             |
 333 |                      |                                                                                                                                                                                                                           |                     |
 334 |                      |     -  2.00 should be used for all LCM API requests                                                                                                                                                                       |                     |
 335 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 336 |     originator-id    |     An identifier of the calling system limited to a length of 40 characters.                                                                                                                                             |     Yes             |
 337 |                      |                                                                                                                                                                                                                           |                     |
 338 |                      |     It can be used for addressing purposes, such as to return an asynchronous response to the correct destination, in particular where there are multiple consumers of APPC APIs.                                         |                     |
 339 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 340 |     request-id       |     The UUID for the request ID, limited to a length of 40 characters. The unique OSS/BSS identifier for the request ID that triggers the current LCM action. Multiple API calls can be made with the same request- id.   |     Yes             |
 341 |                      |                                                                                                                                                                                                                           |                     |
 342 |                      |     The request-id is stored throughout the operations performed during a single request.                                                                                                                                 |                     |
 343 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 344 |     sub-request-id   |     Uniquely identifies a specific LCM or control action, limited to a length of 40 characters. Persists throughout the life cycle of a single request.                                                                   |     No              |
 345 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 346 |     timestamp        |     The time of the request, in ISO 8601 format, ZULU offset. For example: ``2016-08-03T08:50:18.97Z``.                                                                                                                   |     Yes             |
 347 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 348 |     status           |     The status describes the outcome of the command processing. Contains a ``code`` and a ``message`` providing success or failure details.                                                                               |     Yes             |
 349 |                      |                                                                                                                                                                                                                           |                     |
 350 |                      |     ***NOTE:** See* status *for code values.*                                                                                                                                                                             |                     |
 351 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 352 |     payload          |     An open-format field.                                                                                                                                                                                                 |     No              |
 353 |                      |                                                                                                                                                                                                                           |                     |
 354 |                      |     The payload can be any valid JSON string value. JSON escape characters need to be added when an inner JSON string is included within the payload, for example: ``"{\\"upload\_config\_id\\": \\"<value\\"}"``.        |                     |
 355 |                      |                                                                                                                                                                                                                           |                     |
 356 |                      |     The payload is typically used to provide parametric data associated with the response to the command.                                                                                                                 |                     |
 357 |                      |                                                                                                                                                                                                                           |                     |
 358 |                      |     Note that not all LCM commands need have a payload.                                                                                                                                                                   |                     |
 359 |                      |                                                                                                                                                                                                                           |                     |
 360 |                      |     ***NOTE:** The specific value(s) for the response payload, where relevant, is provided for in each* command *description.*                                                                                            |                     |
 361 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 362 |     [Field name]     |     Additional fields can be provided in the response, if needed, by specific commands.                                                                                                                                   |     No              |
 363 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 364 |     code             |     A unique pre-defined value that identifies the exact nature of the success or failure status.                                                                                                                         |     No              |
 365 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 366 |     message          |     The description of the success or failure status.                                                                                                                                                                     |     No              |
 367 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
 368
 369
 370 Status Codes
 371 ------------
 372
 373 The status code is returned in the response message as the ``code`` parameter, and the description as the message parameter.
 374
 375 The different responses are categorized as follows:
 376
 377 **ACCEPTED**
 378
 379     Request is valid and accepted for processing.
 380
 381 **ERROR**
 382
 383     Request invalid or incomplete.
 384
 385 **REJECT**
 386
 387     Request rejected during processing due to invalid data, such as an
 388     unsupported command.
 389
 390 **SUCCESS**
 391
 392     Request is valid and completes successfully.
 393
 394 **FAILURE**
 395
 396     The request processing resulted in failure.
 397
 398     A FAILURE response is always returned asynchronously via the message
 399     bus.
 400
 401 **PARTIAL SUCCESS**
 402
 403     The request processing resulted in partial success where at least
 404     one step in a longer process completed successfully.
 405
 406     A PARTIAL SUCCESS response is always returned asynchronously via the
 407     message bus.
 408
 409 **PARTIAL FAILURE**
 410
 411     The request processing resulted in partial failure.
 412
 413     A PARTIAL FAILURE response is always returned asynchronously via the
 414     message bus.
 415
 416 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 417 |     **Category**      |     **Code**   |     **Message / Description**                                                                                                        |
 418 +=======================+================+======================================================================================================================================+
 419 |     ACCEPTED          |     100        |     ACCEPTED - Request accepted                                                                                                      |
 420 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 421 |     ERROR             |     200        |     UNEXPECTED ERROR - ${detailedErrorMsg}                                                                                           |
 422 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 423 |     REJECT            |     300        |     REJECTED - ${detailedErrorMsg}                                                                                                   |
 424 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 425 |                       |     301        |     INVALID INPUT PARAMETER -${detailedErrorMsg}                                                                                     |
 426 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 427 |                       |     302        |     MISSING MANDATORY PARAMETER - Parameter ${paramName} is missing                                                                  |
 428 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 429 |                       |     303        |     REQUEST PARSING FAILED - ${detailedErrorMsg}                                                                                     |
 430 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 431 |                       |     304        |     NO TRANSITION DEFINED - No Transition Defined for ${actionName} action and ${currentState} state                                 |
 432 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 433 |                       |     305        |     ACTION NOT SUPPORTED - ${actionName} action is not supported                                                                     |
 434 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 435 |                       |     306        |     VNF NOT FOUND - VNF with ID ${vnfId} was not found                                                                               |
 436 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 437 |                       |     307        |     DG WORKFLOW NOT FOUND - No DG workflow found for the combination of ${dgModule} module ${dgName} name and ${dgVersion} version   |
 438 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 439 |                       |     308        |     WORKFLOW NOT FOUND - No workflow found for VNF type                                                                              |
 440 |                       |                |                                                                                                                                      |
 441 |                       |                |     ${vnfTypeVersion} and ${actionName} action                                                                                       |
 442 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 443 |                       |     309        |     UNSTABLE VNF - VNF ${vnfId} is not stable to accept the command                                                                  |
 444 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 445 |                       |     310        |     LOCKING FAILURE -${detailedErrorMsg}                                                                                             |
 446 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 447 |                       |     311        |     EXPIREDREQUEST. The request processing time exceeded the maximum available time                                                  |
 448 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 449 |                       |     312        |     DUPLICATEREQUEST. The request already exists                                                                                     |
 450 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 451 |                       |     313        |     MISSING VNF DATA IN A&AI - ${attributeName} not found for VNF ID =                                                               |
 452 |                       |                |                                                                                                                                      |
 453 |                       |                |     ${vnfId}                                                                                                                         |
 454 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 455 |                       |     315        |     MULTIPLE REQUESTS USING SEARCH CRITERIA: ${parameters}                                                                           |
 456 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 457 |                       |     316        |     POLICY VALIDATION FAILURE - Request rejected as per the request validation policy                                                |
 458 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 459 |     SUCCESS           |     400        |     The request was processed successfully                                                                                           |
 460 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 461 |     FAILURE           |     401        |     DG FAILURE - ${ detailedErrorMsg }                                                                                               |
 462 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 463 |                       |     402        |     NO TRANSITION DEFINED - No Transition Defined for ${ actionName} action and ${currentState} state                                |
 464 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 465 |                       |     403        |     UPDATE\_AAI\_FAILURE - failed to update AAI. ${errorMsg}                                                                         |
 466 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 467 |                       |     404        |     EXPIRED REQUEST FAILURE - failed during processing because TTL expired                                                           |
 468 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 469 |                       |     405        |     UNEXPECTED FAILURE - ${detailedErrorMsg}                                                                                         |
 470 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 471 |                       |     406        |     UNSTABLE VNF FAILURE - VNF ${vnfId} is not stable to accept the command                                                          |
 472 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 473 |                       |     450        |     REQUEST NOT SUPPORTED                                                                                                            |
 474 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 475 |     PARTIAL SUCCESS   |     500        |     PARTIAL SUCCESS                                                                                                                  |
 476 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 477 |     PARTIAL FAILURE   |     501 -      |     PARTIAL FAILURE                                                                                                                  |
 478 |                       |     599        |                                                                                                                                      |
 479 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
 480
 481
 482 Malformed Message Response
 483 --------------------------
 484
 485 A malformed message is an invalid request based on the LCM API YANG scheme specification. APPC rejects malformed requests as implemented by ODL infrastructure level.
 486
 487 **Response Format for Malformed Requests**::
 488
 489     {
 490       "errors": {
 491                   "error": [
 492                             {
 493                               "error-type": "protocol",
 494                               "error-tag": "malformed-message",
 495                               "error-message": "<ERROR-MESSAGE>",
 496                               "error-info": "<ERROR-INFO>"
 497                             }
 498                            ]
 499                 }
 500     }
 501
 502
 503 **Example Response**::
 504
 505     {
 506       "errors": {
 507                   "error": [
 508                             {
 509                               "error-type": "protocol",
 510                               "error-tag": "malformed-message",
 511                               "error-message": "Error parsing input: Invalid value 'Stopp' for
 512                                enum type. Allowed values are: [Sync, Audit, Stop, Terminate]",
 513                               "error-info": "java.lang.IllegalArgumentException: Invalid value
 514                                 'Stopp' for enum type. Allowed values are: [Sync, Audit, Stop,
 515                                 Terminate]..."
 516                             }
 517                            ]
 518                 }
 519     }
 520
 521
 522
 523 API Scope
 524 =========
 525
 526 Defines the level at which the LCM command operates for the current release of APPC and the VNF types which are supported for each command.
 527
 528
 529 Commands, or actions, can be performed at one or more of the following scope levels:
 530
 531
 532 +-----------------+----------------------------------------------------------------------------------------+
 533 | **VNF**         | Commands can be applied at the level of a specific VNF instance using the vnf-id.      |
 534 +-----------------+----------------------------------------------------------------------------------------+
 535 | **VF-Module**   | Commands can be applied at the level of a specific VF-Module using the vf-module-id.   |
 536 +-----------------+----------------------------------------------------------------------------------------+
 537 | **VNFC**        | Commands can be applied at the level of a specific VNFC instance using a vnfc-name.    |
 538 +-----------------+----------------------------------------------------------------------------------------+
 539 | **VM**          | Commands can be applied at the level of a specific VM instance using a vserver-id.     |
 540 +-----------------+----------------------------------------------------------------------------------------+
 541
 542
 543 **VNF/VM Types Supported**
 544
 545 Commands, or actions, may be currently supported on all VNF types or a limited set of VNF types. Note that the intent is to support all actions on all VNF types which have been successfully onboarded in a self-service mode.
 546
 547   - **Any** Currently supported on any vnf-type.
 548
 549   - **Any (requires self-service onboarding)** Currently supported on any vnf-type which has been onboarded using the APPC self-service onboarding process. See further discussion on self-service onboarding below.
 550
 551
 552 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 553 |     **Command**             | **VNF**   |  **VF-Module**   |     **VNFC**   | **VM**   |     **VNF/VM Types Supported**                             |
 554 +=============================+===========+==================+================+==========+============================================================+
 555 |     ActionStatus            | Yes       |                  |                |          |     Any                                                    |
 556 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 557 |     ActivateNESw            | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 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       |                  |                |          |     Any (requires self-service onboarding)                 |
 566 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 567 |     ConfigBackup            | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 568 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 569 |     ConfigModify            | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 570 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 571 |     ConfigRestore           | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 572 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 573 |     ConfigScaleOut          | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 574 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 575 |     DetachVolume            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 576 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 577 |     DistributeTraffic       | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 578 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 579 |     DistributeTrafficCheck  | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 580 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 581 |     DownloadNESw            | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 582 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 583 |     Evacuate                |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 584 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 585 |     GetConfig               | Yes       |                  |                |          |     Ansible                                                |
 586 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 587 |     HealthCheck             | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 588 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 589 |     LicenseManagement       | Yes       |                  |                |          |     Ansible                                                |
 590 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 591 |     Lock                    | Yes       |                  |                |          |     Any                                                    |
 592 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 593 |     Migrate                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 594 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 595 |     PostEvacuate            | Yes       |                  |                |          |     Ansible                                                |
 596 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 597 |     PostMigrate             | Yes       |                  |                |          |     Ansible                                                |
 598 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 599 |     PostRebuild             | Yes       |                  |                |          |     Ansible                                                |
 600 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 601 |     PreConfigure            | Yes       |                  |                |          |     Ansible                                                |
 602 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 603 |     PreEvacuate             | Yes       |                  |                |          |     Ansible                                                |
 604 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 605 |     PreMigrate              | Yes       |                  |                |          |     Ansible                                                |
 606 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 607 |     PreRebuild              | Yes       |                  |                |          |     Ansible                                                |
 608 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 609 |     Provisioning            | Yes       |                  |                |          |     Ansible                                                |
 610 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 611 |     QuiesceTraffic          | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 612 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 613 |     Reboot                  |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 614 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 615 |     Rebuild                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 616 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 617 |     Restart                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 618 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 619 |     ResumeTraffic           | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 620 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 621 |     Snapshot                |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 622 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 623 |     Start                   |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 624 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 625 |     StartApplication        | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 626 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 627 |     StartTraffic            | Yes       |                  |                |          |     Ansible                                                |
 628 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 629 |     StatusTraffic           | Yes       |                  |                |          |     Ansible                                                |
 630 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 631 |     Stop                    |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 632 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 633 |     StopApplication         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 634 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 635 |     StopTraffic             | Yes       |                  |                |          |     Ansible                                                |
 636 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 637 |     Sync                    | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 638 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 639 |     Unlock                  | Yes       |                  |                |          |     Any                                                    |
 640 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 641 |     UpgradeBackout          | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 642 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 643 |     UpgradeBackup           | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 644 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 645 |     UpgradePostCheck        | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 646 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 647 |     UpgradePreCheck         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 648 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 649 |     UpgradeSoftware         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 650 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 651
 652
 653
 654 Self-Service VNF Onboarding
 655 ---------------------------
 656
 657 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:
 658
 659 -  Netconf with uploadable Yang model (requires a Netconf server running
 660    on the VNF)
 661
 662 -  Chef (requires a Chef client running on the VNF)
 663
 664 -  Ansible (does not require any changes to the VNF software)
 665
 666 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:
 667
 668 -  Define the VNF capabilities (set of actions that the VNF can
 669    support).
 670
 671 -  Create a template and parameter definitions for actions which use the
 672    Netconf, Chef, or Ansible protocols. The template is an xml or JSON
 673    block which defines the “payload” which is included in the request
 674    that is downloaded the VNF (if Netconf) or Chef/Ansible server.
 675
 676 -  Test actions which have templates/parameter definitions.
 677
 678 -  Upload the VNF definition, template, and parameter definition
 679    artifacts to SDC which distributes them to all APPC instances in the
 680    same environment (e.g., production).
 681
 682 For more details, see the APPC CDT Onboarding User Guide.
 683
 684
 685
 686 LCM Commands
 687 ============
 688
 689 The LCM commands that are valid for the current release.
 690
 691 ActionStatus
 692 ------------
 693
 694 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.
 695
 696 +--------------------------+----------------------------------------------------------+
 697 | **Target URL**           | /restconf /operations/ appc-provider-lcm:action-status   |
 698 +--------------------------+----------------------------------------------------------+
 699 | **Action**               | ActionStatus                                             |
 700 +--------------------------+----------------------------------------------------------+
 701 | **Action-Identifiers**   | vnf-id                                                   |
 702 +--------------------------+----------------------------------------------------------+
 703 | **Payload Parameters**   | See below                                                |
 704 +--------------------------+----------------------------------------------------------+
 705 | **Revision History**     | New in Beijing                                           |
 706 +--------------------------+----------------------------------------------------------+
 707
 708 |
 709
 710 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 711 |     **Payload Parameter**   |     **Description**                                        |     **Required**   |     **Example**                     |
 712 +=============================+============================================================+====================+=====================================+
 713 | request-id                  |     Request id from the previously submitted request       | Yes                |     "request-id": "123456789"       |
 714 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 715 | sub-request ID              |     Sub-Request id from the previously submitted request   | optional           |     "sub-request-id": "123456789"   |
 716 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 717 | originator-id               |     Originator id from the previously submitted request    | optional           |     "originator-id": "123456789"    |
 718 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 719
 720
 721 ActionStatus Response:
 722 ^^^^^^^^^^^^^^^^^^^^^^
 723
 724 A successful response contains a payload with the following:
 725
 726 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 727 |     **Payload Parameter**   |     **Description**                                                   |     **Required**   |     **Example**              |
 728 +=============================+=======================================================================+====================+==============================+
 729 | status-reason               |     Contains more details about status                                | No                 |                              |
 730 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 731 | status                      |     IN_PROGRESS – The request has been accepted and is in progress    | No                 |     "status": "SUCCESSFUL"   |
 732 |                             |                                                                       |                    |                              |
 733 |                             |     SUCCESSFUL – The request returned success message                 |                    |                              |
 734 |                             |                                                                       |                    |                              |
 735 |                             |     FAILED – The request failed and returned an error message         |                    |                              |
 736 |                             |                                                                       |                    |                              |
 737 |                             |     ABORTED – the request aborted                                     |                    |                              |
 738 |                             |                                                                       |                    |                              |
 739 |                             |     NOT_FOUND – The request is not found                              |                    |                              |
 740 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 741
 742 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:
 743
 744     ``"message": "MULTIPLE REQUESTS FOUND - using search criteria:
 745     request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
 746     vnf-id=ctsf0007v", "code": 315``
 747
 748 ActivateNESw
 749 ---------------
 750
 751 The ActivateNESw LCM action activates the target software version needed for a software upgrade.
 752
 753 This command is executed using an Ansible playbook or Chef cookbook.
 754
 755 Request Structure:
 756
 757 +--------------------------+------------------------------------------------------------+
 758 | **Target URL**           | /restconf/operations/appc-provider-lcm:activate-n-e-sw     |
 759 +--------------------------+------------------------------------------------------------+
 760 | **Action**               | ActivateNESw                                               |
 761 +--------------------------+------------------------------------------------------------+
 762 | **Action-identifiers**   | vnf-id                                                     |
 763 +--------------------------+------------------------------------------------------------+
 764 | **Payload Parameters**   | See below                                                  |
 765 +--------------------------+------------------------------------------------------------+
 766 | **Revision History**     | New in Frankfurt                                           |
 767 +--------------------------+------------------------------------------------------------+
 768
 769 Request Payload Parameters:
 770
 771 +--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
 772 | **Parameter**            |     **Description**                 |     **Required?**   |     **Example**                                                                               |
 773 +==========================+=====================================+=====================+===============================================================================================+
 774 |  swVersionToBeActivated  |     The software to be activated    |     Yes             |     "payload":                                                                                |
 775 |                          |                                     |                     |     "{\"swVersionToBeActivated\": \"v2\"}"                                                    |
 776 +--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
 777
 778 ActivateNESw Response
 779 ^^^^^^^^^^^^^^^^^^^^^^^^
 780
 781 **Success:** If the ActivateNESw runs successfully, it returns a success status code 400. The response payload contains the results of the activating.
 782
 783 Response Payload Parameters:
 784
 785 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
 786 | **Parameter**   |     **Description**         |     **Required?**   |     **Example**                                                                                                              |
 787 +=================+=============================+=====================+==============================================================================================================================+
 788 | result          |     Returns the result      |     Yes             |                                                                                                                              |
 789 |                 |     of the activate-n-e-sw. |                     |     "payload":                                                                                                               |
 790 |                 |     Indicates Success or    |                     |     "{\\"result\\": \\"Success\\"}”                                                                                          |
 791 |                 |     Failure.                |                     |                                                                                                                              |
 792 +-----------------+-----------------------------+---------------------+                                                                                                                              |
 793 | reason          |     If not Success,         |                     |                                                                                                                              |
 794 |                 |     reason contains         |                     |                                                                                                                              |
 795 |                 |     explanation.            |                     |                                                                                                                              |
 796 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
 797
 798 **Failure:** If an ActivateNESw fails to run, it returns a failure code 401 and the failure reason from the Ansible or Chef server in the response payload block.
 799
 800 AttachVolume
 801 ------------
 802
 803 The AttachVolume command attaches a cinder volume to a VM via an Openstack command.
 804
 805 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.
 806
 807     NOTE: The command implementation is based on Openstack
 808     functionality. For further details, see
 809     http://developer.openstack.org/api-ref/compute/.
 810
 811 +--------------------------+----------------------------------------------------------+
 812 | **Target URL**           | /restconf/operations/appc-provider-lcm:attach-volume     |
 813 +--------------------------+----------------------------------------------------------+
 814 | **Action**               | AttachVolume                                             |
 815 +--------------------------+----------------------------------------------------------+
 816 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
 817 +--------------------------+----------------------------------------------------------+
 818 | **Payload Parameters**   | See table                                                |
 819 +--------------------------+----------------------------------------------------------+
 820 | **Revision History**     | New in Beijing                                           |
 821 +--------------------------+----------------------------------------------------------+
 822
 823 |
 824
 825 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 826 |     **Payload Parameter**   |     **Description**                                  |     **Required**   |     **Example**                                                                                                           |
 827 +=============================+======================================================+====================+===========================================================================================================================+
 828 | volumeId                    |     The UUID of the volume to attach.                | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",                                                                   |
 829 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 830 | device                      |     The device identifier                            | Yes                |     "device": "/dev/vdb"                                                                                                  |
 831 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 832 | vm-id                       |     TThe self- link URL of the VM.                   | Yes                |     "vm-id": http://135.25.246.162:8774/v2/64af07e991424b8e9e54eca27d5c0d48/servers/b074cd1b-8d53-412e-a102-351cc51ac10a" |
 833 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 834 | Identity-url                |     The identity URL used to access the resource     | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                     |
 835 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 836
 837 AttachVolume Response:
 838 ^^^^^^^^^^^^^^^^^^^^^^
 839
 840 Success: A successful AttachVolume returns a success status code 400.
 841
 842 Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include:
 843
 844 -  badRequest
 845 -  unauthorized
 846 -  forbidden
 847 -  itemNotFound
 848
 849
 850 Audit
 851 -----
 852
 853 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.
 854
 855 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
 856
 857 A failed Audit indicates that the configurations do not match.
 858
 859 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).
 860
 861 The Audit action does not require any payload parameters.
 862
 863 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
 864
 865
 866 +------------------------------+------------------------------------------------------+
 867 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:audit     |
 868 +------------------------------+------------------------------------------------------+
 869 |     **Action**               |     Audit                                            |
 870 +------------------------------+------------------------------------------------------+
 871 |     **Action-Identifiers**   |     vnf-id                                           |
 872 +------------------------------+------------------------------------------------------+
 873 |     **Payload Parameters**   |     See below                                        |
 874 +------------------------------+------------------------------------------------------+
 875 |     **Revision History**     |     Unchanged in this release.                       |
 876 +------------------------------+------------------------------------------------------+
 877
 878 |
 879
 880 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 881 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 882 +======================+===========================================================================================================================================================+=====================+==================================+
 883 |     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>"   |
 884 |                      |                                                                                                                                                           |                     |                                  |
 885 |                      |     \* If the publish\-config field is set to N in the payload, then:                                                                                     |                     |                                  |
 886 |                      |                                                                                                                                                           |                     |                                  |
 887 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration                      |                     |                                  |
 888 |                      |                                                                                                                                                           |                     |                                  |
 889 |                      |     - If the result of the audit is ‘no match’, then send the running configuration                                                                       |                     |                                  |
 890 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 891
 892 Audit Response
 893 ^^^^^^^^^^^^^^
 894
 895 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.
 896
 897
 898 CheckLock
 899 ---------
 900
 901 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
 902
 903 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.
 904
 905 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.
 906
 907 The CheckLock command returns a specific response structure that extends the default LCM response.
 908
 909 The CheckLock action does not require any payload parameters.
 910
 911 +------------------------------+--------------------------------------------------------+
 912 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:checklock   |
 913 +------------------------------+--------------------------------------------------------+
 914 |     **Action**               |     CheckLock                                          |
 915 +------------------------------+--------------------------------------------------------+
 916 |     **Action-Identifiers**   |     vnf-id                                             |
 917 +------------------------------+--------------------------------------------------------+
 918 |     **Payload Parameters**   |     None                                               |
 919 +------------------------------+--------------------------------------------------------+
 920 |     **Revision History**     |     Unchanged in this release.                         |
 921 +------------------------------+--------------------------------------------------------+
 922
 923 CheckLock Response
 924 ^^^^^^^^^^^^^^^^^^
 925
 926 The CheckLock command returns a customized version of the LCM
 927 response.
 928
 929
 930 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 931 |     **Parameter**   |     **Description**                                                                   |     **Required**   | **?Example**                    |
 932 +=====================+=======================================================================================+====================+=================================+
 933 |     locked          |     "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE.   |     No             |     "locked": "<TRUE\|FALSE>"   |
 934 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 935
 936
 937 **Example**::
 938
 939     {
 940       "output": {
 941                   "status": {
 942                               "code": <RESULT_CODE>, "message": "<RESULT_MESSAGE>"
 943                             },
 944                   "common-header": {
 945                                      "api-ver": "<API_VERSION>",
 946                                      "request-id": "<ECOMP\_REQUEST_ID>", "originator-id":
 947                                      "<ECOMP_SYSTEM_ID>",
 948                                      "sub-request-id": "<ECOMP_SUBREQUEST_ID>", "timestamp":
 949                                      "2016-08-08T23:09:00.11Z",
 950                                      "flags": {
 951                                                 "ttl": <TTL_VALUE>, "force": "<TRUE|FALSE>",
 952                                                 "mode": "<EXCLUSIVE|NORMAL>"
 953                                               }
 954                                    },
 955                   "locked": "<TRUE|FALSE>"
 956     }
 957
 958
 959 Configure
 960 ---------
 961
 962 Configure a VNF or a VNFC on the VNF after instantiation.
 963
 964 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.
 965
 966 A successful Configure request returns a success response.
 967
 968 A failed Configure action returns a failure response and the specific failure messages in the response block.
 969
 970 +------------------------------+--------------------------------------------------------+
 971 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configure   |
 972 +------------------------------+--------------------------------------------------------+
 973 |     **Action**               |     Configure                                          |
 974 +------------------------------+--------------------------------------------------------+
 975 |     **Action-Identifiers**   |     vnf-id                                             |
 976 +------------------------------+--------------------------------------------------------+
 977 |     **Payload Parameters**   |     See below                                          |
 978 +------------------------------+--------------------------------------------------------+
 979 |     **Revision History**     |     Unchanged in this release.                         |
 980 +------------------------------+--------------------------------------------------------+
 981
 982 |
 983
 984 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 985 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                            |     **Required?**   |     **Example**                                                 |
 986 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 987 +=================================+================================================================================================================================================================================================================+=====================+=================================================================+
 988 |     request-parameters          |     vnf-host-ip-address: optional if Netconf or other direct interface to the VNF.   If not provided, APPC will look for the host-ip-address in the A&AI VNF oam ipv4 address field.                           |     No              |                                                                 |
 989 |                                 |                                                                                                                                                                                                                |                     |     "payload":                                                  |
 990 |                                 |     vnfc-type:  must be included if template is vnfc specific                                                                                                                                                  |                     |     "{ \\"request-parameters                                    |
 991 |                                 |                                                                                                                                                                                                                |                     |     \\": {                                                      |
 992 |                                 |                                                                                                                                                                                                                |                     |     \\"vnf-host-ip-address\\":                                  |
 993 |                                 |                                                                                                                                                                                                                |                     |     \\”value\\”,                                                |
 994 |                                 |                                                                                                                                                                                                                |                     |     \\”vnfc-type\\”: \\”value\\”’                               |
 995 |                                 |                                                                                                                                                                                                                |                     |     }                                                           |
 996 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 997 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 998 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 999 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1000 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1001 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1002 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1003 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1004 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1005 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1006 |     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>\\"}  |
1007 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1008
1009
1010 Configure Response
1011 ^^^^^^^^^^^^^^^^^^
1012
1013 The Configure response returns an indication of success or failure of the request.
1014
1015 **Success:** A successful Configure returns a success status code 400.
1016 **Failure:** A failed Configure returns a failure code 401 and the failure message.
1017
1018 If successful, the return payload contains the ‘upload_config_id’ and values for any records created in the APPC DB. In addition, the configuration is sent to the ONAP Data Router bus  which may be received by an external configuration storage system.
1019
1020 If APPC in unable to update A&AI with the VNFC records, a 501 intermediate error message returned prior to the final 400 or 401 success message.
1021
1022 ConfigModify
1023 ------------
1024
1025 Modifies the configuration on a VNF or VNFC in service.
1026
1027 This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook.
1028
1029 Request Structure:
1030
1031 +--------------------------+--------------------------------------------------------+
1032 | **Target URL**           | /restconf/operations/appc-provider-lcm:config-modify   |
1033 +--------------------------+--------------------------------------------------------+
1034 | **Action**               | ConfigModify                                           |
1035 +--------------------------+--------------------------------------------------------+
1036 | **Action-Identifiers**   | vnf-id                                                 |
1037 +--------------------------+--------------------------------------------------------+
1038 | **Payload Parameters**   | request-parameters, configuration-parameters           |
1039 +--------------------------+--------------------------------------------------------+
1040 | **Revision History**     | Unchanged in this release.                             |
1041 +--------------------------+--------------------------------------------------------+
1042
1043 Request Payload Parameters:
1044
1045 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
1046 | **Payload Parameter**   | **Description**                        | **Required?**   |     **Example**                                       |
1047 +=========================+========================================+=================+=======================================================+
1048 | request-parameters      | vnf-host-ip-address: optional if       | No              |     "payload":                                        |
1049 |                         | Netconf or other direct interface      |                 |     "{\\"request-parameters \\":                      |
1050 |                         | to the VNF. If not provided, it is     |                 |     {\\"vnf-host-ip-address\\": \\”value\\",          |
1051 |                         | obtained from A&AI                     |                 |     \\”vnfc-type\\”: \\”value\\”                      |
1052 |                         |                                        |                 |     }                                                 |
1053 |                         |                                        |                 |                                                       |
1054 |                         | vnfc-type: must be included if template|                 |                                                       |
1055 |                         | is vnfc specific                       |                 |                                                       |
1056 |                         |                                        |                 |     \\"configuration- parameters\\": {\\"name1\\":    |
1057 |                         |                                        |                 |     \\”value1\\”,\\"name2\\":                         |
1058 |                         |                                        |                 |     \\”value2\\”                                      |
1059 |                         |                                        |                 |     }                                                 |
1060 |                         |                                        |                 |     }                                                 |
1061 +-------------------------+----------------------------------------+-----------------+                                                       |
1062 | configuration-          | A set of instance specific             | No              |                                                       |
1063 | parameters              | configuration parameters should        |                 |                                                       |
1064 |                         | be specified.                          |                 |                                                       |
1065 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
1066
1067 ConfigModify Request
1068 ^^^^^^^^^^^^^^^^^^^^
1069
1070     Examples::
1071
1072               {
1073                      "input": {
1074                           "common-header": {
1075                               "timestamp": "2017-10-25T11:10:04.244Z",
1076                               "api-ver": "2.00",
1077                               "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1078                               "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1079                               "sub-request-id": "1",
1080                               "flags": {
1081                                   "force": "TRUE",
1082                                   "ttl": 60000
1083                               }
1084                           },
1085                           "action": "ConfigModify",
1086                           "action-identifiers": {
1087                               "vnf-id": "<VNF_ID>"
1088                           },
1089                           "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
1090                                         \"config-json\": \"{\"pg-streams\":{
1091                                         \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" },
1092                                         {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" },
1093                                         { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
1094                                         { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" },
1095                                         {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
1096                           }
1097                       }
1098              }
1099
1100
1101 ConfigModify Response
1102 ^^^^^^^^^^^^^^^^^^^^^
1103
1104 **Success:** A successful ConfigModify returns a success status code 400.
1105
1106 If successful, the return payload contains the ‘upload_config_id’ and values associated with the configuration stored in the APPC DB. In addition, the configuration is sent to the message bus which may be received by an external configuration storage system.
1107
1108 **Failure:** A failed ConfigModify returns a failure code 401 and the failure message.
1109
1110 ConfigBackup
1111 ------------
1112
1113 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).
1114
1115 A successful ConfigBackup request returns a success response.
1116
1117 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
1118
1119 +------------------------------+-----------------------------------------------------------+
1120 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-backup  |
1121 +------------------------------+-----------------------------------------------------------+
1122 |     **Action**               |     ConfigBackup                                          |
1123 +------------------------------+-----------------------------------------------------------+
1124 |     **Action-Identifiers**   |     Vnf-id                                                |
1125 +------------------------------+-----------------------------------------------------------+
1126 |     **Payload Parameters**   |     See below                                             |
1127 +------------------------------+-----------------------------------------------------------+
1128 |     **Revision History**     |     Unchanged in this release.                            |
1129 +------------------------------+-----------------------------------------------------------+
1130
1131 |
1132
1133 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1134 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                   |
1135 +=================================+====================================================================================================================================================================================+=====================+===================================================================+
1136 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              | "payload": \\"configuration-parameters\\": {\\"<CONFIG-PARAMS>\\"}|
1137 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1138 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1139 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1140 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1141 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1142 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                   |
1143 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                   |
1144 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1145
1146 ConfigBackup Response
1147 ^^^^^^^^^^^^^^^^^^^^^
1148
1149 The ConfigBackup response returns an indication of success or failure of the request.
1150
1151 **Success:** A successful ConfigBackup returns a success status code 400.
1152 **Failure:** A failed ConfigBackup returns a failure code 401 and the failure message.
1153
1154
1155 ConfigRestore
1156 -------------
1157
1158 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
1159
1160 A successful ConfigRestore request returns a success response.
1161
1162 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
1163
1164 +------------------------------+------------------------------------------------------------------------------------------+
1165 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-restore                                |
1166 +------------------------------+------------------------------------------------------------------------------------------+
1167 |     **Action**               |     ConfigRestore                                                                        |
1168 +------------------------------+------------------------------------------------------------------------------------------+
1169 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1170 +------------------------------+------------------------------------------------------------------------------------------+
1171 |     **Payload Parameters**   |     See below                                                                            |
1172 +------------------------------+------------------------------------------------------------------------------------------+
1173 |     **Revision History**     |     Unchanged in this release.                                                           |
1174 +------------------------------+------------------------------------------------------------------------------------------+
1175
1176 |
1177
1178 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1179 |     **Parameter**               |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1180 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1181 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              |     "payload":                                                  |
1182 |                                 |                                                                                                                                                                                    |                     |     \\"configuration-parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
1183 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1184 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1185 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1186
1187 ConfigRestore Response
1188 ^^^^^^^^^^^^^^^^^^^^^^
1189
1190 **Success:** A successful ConfigRestore returns a success status code 400.
1191
1192 If successful, the return payload contains the ‘upload_config_id’ and values associated with the configuration stored in the APPC DB.  In addition, the configuration is sent to the ONAP Data Router bus which may be received by an external configuration storage system.
1193
1194 **Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
1195
1196
1197
1198 ConfigScaleOut
1199 --------------
1200
1201 The ConfigScaleOut command is used to apply any actions on a VNF as part of a ScaleOut flow. Actions could include updating the VNF configuration or running a set of other tasks.
1202
1203 The ConfigScaleOut action can have multiple APPC templates associated with it.  APPC retrieves the VfModuleModelName from A&AI (model.model-vers.model-name), which is used as the unique identifier to select the correct APPC template.
1204 APPC creates or updates VNFC records in A&AI for the newly instantiated VM’s.  The orchestration-status of the VNFC’s is set to CONFIGURED.
1205
1206 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1207
1208 |
1209
1210 +------------------------------+------------------------------------------------------------------------------------------+
1211 |     **Target URL**           |     /restconf /operations/appc-provider-lcm:config-scale-out                             |
1212 +------------------------------+------------------------------------------------------------------------------------------+
1213 |     **Action**               |     ConfigScaleOut                                                                       |
1214 +------------------------------+------------------------------------------------------------------------------------------+
1215 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1216 +------------------------------+------------------------------------------------------------------------------------------+
1217 |     **Payload Parameters**   |     See below                                                                            |
1218 +------------------------------+------------------------------------------------------------------------------------------+
1219 |     **Revision History**     |     New in Beijing                                                                       |
1220 +------------------------------+------------------------------------------------------------------------------------------+
1221
1222 |
1223
1224 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1225 |     **Payload Parameter**       |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                             |
1226 +=================================+==================================================================================================================================================================+=====================+=============================================+
1227 |     request-parameters          |     vnf-host-ip-address: optional if Netconf or other direct interface to the VNF.   If not provided, the vnf-host-ip-address will be obtained from A&AI.        |     No              |      "payload":                             |
1228 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      "{\\"request-parameters \\":           |
1229 |                                 |     vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleOut.                                                                       |     Yes             |      {                                      |
1230 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\"vnf-host-ip-address\\":             |
1231 |                                 |     controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleOut.                            |                     |      \\”value\\”,                           |
1232 |                                 |     Will be needed if A&AI does not contain the template identifier.                                                                                             |     No              |      \\”vf-module-id\\”: \\”value\\”,       |
1233 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\”controller-template-id\\”:          |
1234 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the        |     No              |      \\”value\\”                            |
1235 |                                 |     values supplied.                                                                                                                                             |                     |      }                                      |
1236 |                                 |                                                                                                                                                                  |                     |                                             |
1237 |                                 |                                                                                                                                                                  |                     |      \\"configuration-parameters\\":        |
1238 |                                 |                                                                                                                                                                  |                     |        {\\"<CONFIG- PARAMS>\\"}             |
1239 |                                 |                                                                                                                                                                  |                     |                                             |
1240 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1241
1242 ConfigScaleOut Response
1243 ^^^^^^^^^^^^^^^^^^^^^^^
1244
1245 **Success:**
1246
1247  - A successful ConfigScaleOut returns a success status code 400 when completed.
1248
1249 **Failure:**
1250
1251  - A failed ConfigScaleOut returns a failure code 401 and the failure message.
1252  - If the ConfigScaleOut is successfully performed on the VNF but there is a failure to update A&AI inventory, an intermediate failure message with failure code 501 is returned prior to the final 400 success message.
1253
1254
1255 DetachVolume
1256 ------------
1257
1258 The DetachVolume command detaches a cinder volume from a VM via an Openstack command.
1259
1260 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.
1261
1262 NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1263
1264 +--------------------------+----------------------------------------------------------+
1265 | **Target URL**           | /restconf/operations/appc-provider-lcm:detach-volume     |
1266 +--------------------------+----------------------------------------------------------+
1267 | **Action**               | DetachVolume                                             |
1268 +--------------------------+----------------------------------------------------------+
1269 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
1270 +--------------------------+----------------------------------------------------------+
1271 | **Payload Parameters**   | See table                                                |
1272 +--------------------------+----------------------------------------------------------+
1273 | **Revision History**     | New in Beijing                                           |
1274 +--------------------------+----------------------------------------------------------+
1275
1276 Request Payload Parameters:
1277
1278 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1279 |     **Payload Parameter**   |     **Description**                                            |     **Required**   |     **Example**                                                                                                                |
1280 +=============================+================================================================+====================+================================================================================================================================+
1281 | volumeId                    |     The UUID of the volume to detach.                          | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"                                                                         |
1282 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1283 | vm-id                       |     The self- link URL of the VM.                              | Yes                |     "vm-id": http://135.25.246.162:8774/v2/64af07e991424b8e9e54eca27d5c0d48/servers/b074cd1b-8d53-412e-a102-351cc51ac10a"      |
1284 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1285 | Identity-url                |     The identity URL used to access the resource               | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                          |
1286 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1287
1288 DetachVolume Response:
1289 ^^^^^^^^^^^^^^^^^^^^^^
1290
1291 **Success:** A successful DetachVolume returns a success status code 400.
1292
1293 **Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include:
1294
1295         -  badRequest
1296         -  unauthorized
1297         -  forbidden
1298         -  itemNotFound
1299         -  conflict
1300
1301 DistributeTraffic
1302 -----------------
1303
1304 The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
1305 The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
1306 realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
1307 including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
1308 Format of configuration file is specific to each VNF type. The Optimization Framework component and Homing, Allocation and
1309 Placement mechanism can be used to retrieve instances of vf-modules of anchor points and destination points with
1310 corresponding policies.
1311
1312 This command is executed using an Ansible playbook or Chef cookbook.
1313
1314 Request Structure:
1315
1316 +--------------------------+--------------------------------------------------------------+
1317 | **Target URL**           | /restconf/operations/appc-provider-lcm:distribute-traffic    |
1318 +--------------------------+--------------------------------------------------------------+
1319 | **Action**               | DistributeTraffic                                            |
1320 +--------------------------+--------------------------------------------------------------+
1321 | **Action-identifiers**   | vnf-id, vserver-id, vnfc-name                                |
1322 +--------------------------+--------------------------------------------------------------+
1323 | **Payload Parameters**   | See below                                                    |
1324 +--------------------------+--------------------------------------------------------------+
1325 | **Revision History**     | New in Casablanca                                            |
1326 +--------------------------+--------------------------------------------------------------+
1327
1328 Request Payload Parameters:
1329
1330 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1331 | **Parameter**                   |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                                                              |
1332 +=================================+==================================================================================================================================================================+=====================+==============================================================================+
1333 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the        |     No              | "payload": "{\"configuration-parameters\": {\"file_parameter_content\":      |
1334 |                                 |     values supplied. The parameters are associated with request template defined with CDT                                                                        |                     | \"{\\\"destinations\\\": [{\\\"locationType\\\": \\\"att_aic\\\",            |
1335 |                                 |                                                                                                                                                                  |                     | \\\"isRehome\\\": \\\"false\\\", \\\"aic_version\\\": \\\"1\\\",             |
1336 |                                 |                                                                                                                                                                  |                     | \\\"ipv4-oam-address\\\": \\\"\\\", \\\"nf-name\\\":                         |
1337 |                                 |                                                                                                                                                                  |                     | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"cloudOwner\\\":                      |
1338 |                                 |                                                                                                                                                                  |                     | \\\"CloudOwner\\\", \\\"service_instance_id\\\":                             |
1339 |                                 |                                                                                                                                                                  |                     | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\",                                |
1340 |                                 |                                                                                                                                                                  |                     | \\\"vf-module-id\\\": \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\",          |
1341 |                                 |                                                                                                                                                                  |                     | \\\"cloudClli\\\": \\\"clli1\\\", \\\"ipv6-oam-address\\\": \\\"\\\",        |
1342 |                                 |                                                                                                                                                                  |                     | \\\"vf-module-name\\\": \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\",         |
1343 |                                 |                                                                                                                                                                  |                     | \\\"vnfHostName\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"nf-id\\\":      |
1344 |                                 |                                                                                                                                                                  |                     | (...)                                                                        |
1345 |                                 |                                                                                                                                                                  |                     | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1-vfw_private_1_port-6yfzndtyjzfz\\\", |
1346 |                                 |                                                                                                                                                                  |                     | \\\"ipv4-addresses\\\": [\\\"192.168.20.100\\\"], \\\"interface-id\\\":      |
1347 |                                 |                                                                                                                                                                  |                     | \\\"0a1d0300-de02-46e8-99f6-e786f1ba407a\\\", \\\"network-name\\\":          |
1348 |                                 |                                                                                                                                                                  |                     | \\\"\\\", \\\"ipv6-addresses\\\": []}]}], \\\"nf-type\\\": \\\"vnf\\\"}]}\", |
1349 |                                 |                                                                                                                                                                  |                     | \"fixed_ip_address\": \"10.0.210.103\", \"book_name\":                       |
1350 |                                 |                                                                                                                                                                  |                     | \"vpgn/latest/ansible/distributetraffic/site.yml\",                          |
1351 |                                 |                                                                                                                                                                  |                     | \"ne_id\": \"vofwl01pgn4407\"}}",                                            |
1352 |                                 |                                                                                                                                                                  |                     |                                                                              |
1353 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1354
1355 Exemplary CDT template for Ansible protocol::
1356
1357     {
1358         "InventoryNames": "VM",
1359         "PlaybookName": "${()=(book_name)}",
1360         "NodeList": [{
1361             "vm-info": [{
1362                 "ne_id": "${()=(ne_id)}",
1363                 "fixed_ip_address": "${()=(fixed_ip_address)}"
1364             }],
1365             "site": "site",
1366             "vnfc-type": "some-vnfc"
1367         }],
1368         "EnvParameters": {
1369             "ConfigFileName": "../traffic_distribution_config.json",
1370             "vnf_instance": "instance",
1371         },
1372         "FileParameters": {
1373             "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1374         },
1375         "Timeout": 3600
1376     }
1377
1378 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1379 Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.
1380
1381 DistributeTraffic Response
1382 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1383
1384 The response does not include any payload parameters.
1385
1386 **Success:** A successful distribute returns a success status code 400 after all traffic has been distributed.
1387
1388 **Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1389
1390
1391 DistributeTrafficCheck
1392 ----------------------
1393
1394 The Distribute Traffic Check LCM action complements Distribute Traffic LCM action with capabilities to test if destination point
1395 is ready to handle traffic or if anchor point accepts the configuration of destinations for traffic distribution. Finally,
1396 this action can be used to check if destination points handle traffic accordingly with the configuration.
1397
1398 This command is executed using an Ansible playbook or Chef cookbook.
1399
1400 Request Structure:
1401
1402 +--------------------------+--------------------------------------------------------------------+
1403 | **Target URL**           | /restconf/operations/appc-provider-lcm:distribute-traffic-check    |
1404 +--------------------------+--------------------------------------------------------------------+
1405 | **Action**               | DistributeTrafficCheck                                             |
1406 +--------------------------+--------------------------------------------------------------------+
1407 | **Action-identifiers**   | vnf-id, vserver-id, vnfc-name                                      |
1408 +--------------------------+--------------------------------------------------------------------+
1409 | **Payload Parameters**   | See below                                                          |
1410 +--------------------------+--------------------------------------------------------------------+
1411 | **Revision History**     | New in Dublin                                                      |
1412 +--------------------------+--------------------------------------------------------------------+
1413
1414 Request Payload Parameters:
1415
1416 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1417 | **Parameter**                   |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                                               |
1418 +=================================+==================================================================================================================================================================+=====================+===============================================================+
1419 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified. If provided, APP-C replaces variables in the configuration template with the        |     No              |  "payload": "{\"configuration-parameters\":                   |
1420 |                                 |     values supplied. The parameters are associated with request template defined with CDT                                                                        |                     |  {\"file_parameter_content\": \"{\\\"destinations\\\":        |
1421 |                                 |                                                                                                                                                                  |                     |  [                                                            |
1422 |                                 |                                                                                                                                                                  |                     |  {\\\"locationType\\\": \\\"att_aic\\\",                      |
1423 |                                 |                                                                                                                                                                  |                     |  \\\"isRehome\\\": \\\"false\\\",                             |
1424 |                                 |                                                                                                                                                                  |                     |  \\\"aic_version\\\": \\\"1\\\",                              |
1425 |                                 |                                                                                                                                                                  |                     |  \\\"ipv4-oam-address\\\": \\\"\\\",                          |
1426 |                                 |                                                                                                                                                                  |                     |  \\\"nf-name\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\",         |
1427 |                                 |                                                                                                                                                                  |                     |  \\\"cloudOwner\\\": \\\"CloudOwner\\\",                      |
1428 |                                 |                                                                                                                                                                  |                     |  \\\"service_instance_id\\\":                                 |
1429 |                                 |                                                                                                                                                                  |                     |  \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\",                |
1430 |                                 |                                                                                                                                                                  |                     |  \\\"vf-module-id\\\":                                        |
1431 |                                 |                                                                                                                                                                  |                     |  \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\",                |
1432 |                                 |                                                                                                                                                                  |                     |  \\\"cloudClli\\\": \\\"clli1\\\",                            |
1433 |                                 |                                                                                                                                                                  |                     |  \\\"ipv6-oam-address\\\": \\\"\\\",                          |
1434 |                                 |                                                                                                                                                                  |                     |  \\\"vf-module-name\\\":                                      |
1435 |                                 |                                                                                                                                                                  |                     |  \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\",                 |
1436 |                                 |                                                                                                                                                                  |                     |  \\\"vnfHostName\\\":                                         |
1437 |                                 |                                                                                                                                                                  |                     |  \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\",                          |
1438 |                                 |                                                                                                                                                                  |                     |  \\\"nf-id\\\": \\\"909d396b-4d99-4c6a-a59b-abe948873303\\\", |
1439 |                                 |                                                                                                                                                                  |                     |  (...)                                                        |
1440 |                                 |                                                                                                                                                                  |                     |  \\\"trafficPresence\\\": true}\",                            |
1441 |                                 |                                                                                                                                                                  |                     |  \"fixed_ip_address\": \"10.0.110.1\", \"book_name\":         |
1442 |                                 |                                                                                                                                                                  |                     |  \"vfw-sink/latest/ansible/distributetrafficcheck/site.yml\", |
1443 |                                 |                                                                                                                                                                  |                     |  \"ne_id\": \"vofwl02vfw4407\"}}"                             |
1444 |                                 |                                                                                                                                                                  |                     |                                                               |
1445 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1446
1447 Exemplary CDT template for Ansible protocol::
1448
1449     {
1450         "InventoryNames": "VM",
1451         "PlaybookName": "${()=(book_name)}",
1452         "NodeList": [{
1453             "vm-info": [{
1454                 "ne_id": "${()=(ne_id)}",
1455                 "fixed_ip_address": "${()=(fixed_ip_address)}"
1456             }],
1457             "site": "site",
1458             "vnfc-type": "some-vnfc"
1459         }],
1460         "EnvParameters": {
1461             "ConfigFileName": "../traffic_distribution_config.json",
1462             "vnf_instance": "instance",
1463         },
1464         "FileParameters": {
1465             "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1466         },
1467         "Timeout": 3600
1468     }
1469
1470 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1471 Distribute Traffic config file can have similar parameters like the one Distribute Traffic action and can have some extra information like the type of check to
1472 be performed. In the payload example there is a trafficPresence parameter that emphasises if the traffic is expected on vFW instance.
1473
1474 DistributeTrafficCheck Response
1475 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1476
1477 The response does not include any payload parameters.
1478
1479 **Success:** A successful distribute traffic check returns a success status code 400 when conditions are satisfied.
1480
1481 **Failure:** A failed check returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1482
1483
1484 DownloadNESw
1485 ---------------
1486
1487 The DownloadNESw LCM action downloads the target software needed for a software upgrade.
1488
1489 This command is executed using an Ansible playbook or Chef cookbook.
1490
1491 Request Structure:
1492
1493 +--------------------------+------------------------------------------------------------+
1494 | **Target URL**           | /restconf/operations/appc-provider-lcm:download-n-e-sw     |
1495 +--------------------------+------------------------------------------------------------+
1496 | **Action**               | DownloadNESw                                               |
1497 +--------------------------+------------------------------------------------------------+
1498 | **Action-identifiers**   | vnf-id                                                     |
1499 +--------------------------+------------------------------------------------------------+
1500 | **Payload Parameters**   | See below                                                  |
1501 +--------------------------+------------------------------------------------------------+
1502 | **Revision History**     | New in Frankfurt                                           |
1503 +--------------------------+------------------------------------------------------------+
1504
1505 Request Payload Parameters:
1506
1507 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1508 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1509 +=======================+=====================================+=====================+===============================================================================================+
1510 | swToBeDownloaded      |     The software to be downloaded   |     Yes             |     "payload":                                                                                |
1511 |                       |                                     |                     |     "{\"swToBeDownloaded\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\":                              |
1512 |                       |                                     |                     |      \\\\\\\"http://192.168.1.10:10080/ran_du_pkg1-v2.zip\\\\\\\"}]\\\\'\"}"                  |
1513 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1514
1515 DownloadNESw Response
1516 ^^^^^^^^^^^^^^^^^^^^^^^^
1517
1518 **Success:** If the DownloadNESw runs successfully, it returns a success status code 400. The response payload contains the results of the downloading.
1519
1520 Response Payload Parameters:
1521
1522 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
1523 | **Parameter**   |     **Description**         |     **Required?**   |     **Example**                                                                                                              |
1524 +=================+=============================+=====================+==============================================================================================================================+
1525 | result          |     Returns the result      |     Yes             |                                                                                                                              |
1526 |                 |     of the download-n-e-sw. |                     |     "payload":                                                                                                               |
1527 |                 |     Indicates Success or    |                     |     "{\\"result\\": \\"Success\\"}”                                                                                          |
1528 |                 |     Failure.                |                     |                                                                                                                              |
1529 +-----------------+-----------------------------+---------------------+                                                                                                                              |
1530 | reason          |     If not Success,         |                     |                                                                                                                              |
1531 |                 |     reason contains         |                     |                                                                                                                              |
1532 |                 |     explanation.            |                     |                                                                                                                              |
1533 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
1534
1535 **Failure:** If a DownloadNESw fails to run, it returns a failure code 401 and the failure reason from the Ansible or Chef server in the response payload block.
1536
1537
1538 Evacuate
1539 --------
1540
1541 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).
1542
1543 The host on which the VM resides needs to be down.
1544
1545 If the target host is not specified in the request, it will be selected by relying on internal rules to evacuate. The Evacuate action will fail if the specified target host is not UP/ENABLED.
1546
1547 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm` parameter to false.
1548
1549 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
1550
1551 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1552
1553 +------------------------------+-------------------------------------------------------------------------+
1554 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:evacuate                     |
1555 +------------------------------+-------------------------------------------------------------------------+
1556 |     **Action**               |     Evacuate                                                            |
1557 +------------------------------+-------------------------------------------------------------------------+
1558 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                  |
1559 +------------------------------+-------------------------------------------------------------------------+
1560 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id, rebuild-vm, targethost-id           |
1561 +------------------------------+-------------------------------------------------------------------------+
1562 |     **Revision History**     |     Unchanged in this release.                                          |
1563 +------------------------------+-------------------------------------------------------------------------+
1564
1565 |
1566
1567 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1568 |     **Parameter**    |     **Description**                                                                                                                                                              |     **Required?**   |     **Example**                       |
1569 +======================+==================================================================================================================================================================================+=====================+=======================================+
1570 |     vm-id            |     The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self-link URL of the VM.                                                         |     Yes             |     "payload":                        |
1571 |                      |                                                                                                                                                                                  |                     |     "{\\"vm-id\\": \\"<VM-ID>         |
1572 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1573 |                      |                                                                                                                                                                                  |                     |     \\"identity-url\\":               |
1574 |                      |                                                                                                                                                                                  |                     |     \\"<IDENTITY-URL>\\",             |
1575 |                      |                                                                                                                                                                                  |                     |     \\"tenant-id\\": \\"<TENANT-ID>   |
1576 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1577 |                      |                                                                                                                                                                                  |                     |     \\"rebuild-vm\\": \\"false\\",    |
1578 |                      |                                                                                                                                                                                  |                     |     \\"targethost-id\\":              |
1579 |                      |                                                                                                                                                                                  |                     |     \\"nodeblade7\\"}"                |
1580 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1581 |     identity-url     |     The identity URL used to access the resource                                                                                                                                 |     Yes             |                                       |
1582 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1583 |     tenant-id        |     The id of the provider tenant that owns the resource                                                                                                                         |     Yes             |                                       |
1584 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1585 |     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              |                                       |
1586 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1587 |     targethost- id   |     A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host.                                                              |     No              |                                       |
1588 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1589
1590 Evacuate Response:
1591 ^^^^^^^^^^^^^^^^^^
1592 **Success:** A successful Evacuate returns a success status code 400.
1593 **Failure:** A failed Evacuate returns a failure code 401 and the failure message.
1594
1595
1596 GetConfig
1597 ---------
1598
1599 GetConfig LCM action for the MVM VNF types using the GetConfig playbook
1600 to retrieve the current config. This is limited to Ansible.
1601
1602 A successful GetConfig request returns a success response.
1603
1604 A failed GetConfig action returns a failure response code and the
1605 specific failure message in the response block.
1606
1607
1608 ====================== =================================================
1609 **Target URL**         /restconf/operations/appc-provider-lcm: GetConfig
1610 ====================== =================================================
1611 **Action**             GetConfig
1612 **Action-Identifiers** vnf-id
1613 **Payload Parameters** See table
1614 **Revision History**   New in Frankfurt
1615 ====================== =================================================
1616
1617 ========================= ========================================================================================================= ============= ======================================================================================================
1618 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1619 ========================= ========================================================================================================= ============= ======================================================================================================
1620 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
1621
1622                                                                                                                                                   "payload": "{}"
1623 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1624 ========================= ========================================================================================================= ============= ======================================================================================================
1625
1626 GetConfig Response:
1627 ~~~~~~~~~~~~~~~~~~~
1628
1629 Success: A successful GetConfig returns a success status code 400.
1630
1631 Failure: A failed GetConfig returns a failure code 401 and the failure
1632 message.
1633
1634
1635 HealthCheck
1636 -----------
1637
1638 This command runs a VNF health check and returns the result.
1639
1640 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.
1641
1642
1643 +------------------------------+-----------------------------------------------------------+
1644 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:health-check   |
1645 +------------------------------+-----------------------------------------------------------+
1646 |     **Action**               |     HealthCheck                                           |
1647 +------------------------------+-----------------------------------------------------------+
1648 |     **Action-Identifiers**   |     Vnf-id                                                |
1649 +------------------------------+-----------------------------------------------------------+
1650 |     **Payload Parameters**   |     See below                                             |
1651 +------------------------------+-----------------------------------------------------------+
1652 |     **Revision History**     |     Unchanged in this release                             |
1653 +------------------------------+-----------------------------------------------------------+
1654
1655
1656 Request Payload Parameters:
1657
1658 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1659 |     **Parameter**   |     **Description**               |     **Required?**   |     **Example**                     |
1660 +=====================+===================================+=====================+=====================================+
1661 | request-parameters  |     host-ip-address -             |     No              |  "payload":                         |
1662 |                     |     Required only if REST         |                     |  "{\\"request-parameters \\":       |
1663 |                     |     service. This is the ip       |                     |  "{\\"host-ip-address\\":           |
1664 |                     |     address associated with the   |                     |  \\"10.222.22.2\\" }"               |
1665 |                     |     VM running the REST           |                     |                                     |
1666 |                     |     service.                      |                     |                                     |
1667 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1668
1669
1670 HealthCheck Response
1671 ^^^^^^^^^^^^^^^^^^^^
1672
1673 **Success:** The HealthCheck returns a 400 success message if the test completes. A JSON payload is returned indicating state (healthy, unhealthy), scope identifier, time-stamp and one or more blocks containing info and fault information.
1674
1675     Examples::
1676
1677                 {
1678                   "identifier": "scope represented",
1679                   "state": "healthy",
1680                   "time": "01-01-1000:0000"
1681
1682                 }
1683
1684                 {
1685                    "identifier": "scope represented",
1686                    "state": "unhealthy",
1687                         {[
1688                    "info": "System threshold exceeded details",
1689                    "fault":
1690                          {
1691                            "cpuOverall": 0.80,
1692                            "cpuThreshold": 0.45
1693                          }
1694                         ]},
1695                    "time": "01-01-1000:0000"
1696                 }
1697
1698 **Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
1699
1700 LicenseManagement
1701 -----------------
1702
1703 For LicenseManagement LCM action, invoke the LicenseManagement playbook.
1704 This is limited to Ansible.
1705
1706 A successful LicenseManagement request returns a success response.
1707
1708 A failed LicenseManagement action returns a failure response code and
1709 the specific failure message in the response block.
1710
1711
1712 ====================== ========================================================
1713 **Target URL**         /restconf/operations/appc-provider-lcm:LicenseManagement
1714 ====================== ========================================================
1715 **Action**             LicenseManagement
1716 **Action-Identifiers** vnf-id
1717 **Payload Parameters** See below
1718 **Revision History**   New in Frankfurt
1719 ====================== ========================================================
1720
1721 ========================= ========================================================================================================= ============= ======================================================================================================================
1722 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1723 ========================= ========================================================================================================= ============= ======================================================================================================================
1724 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "LicenseManagement",
1725
1726                                                                                                                                                   "action-identifiers": {
1727
1728                                                                                                                                                   "vnf-id": "rarf9901v"
1729
1730                                                                                                                                                   },
1731
1732                                                                                                                                                   "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\",\"license_action\":\"update\"}}" ---
1733
1734                                                                                                                                                   license_action can have any of these values ={ upload \| add \| install \| update \| renew \| delete \| revoke \| … }:
1735 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1736 ========================= ========================================================================================================= ============= ======================================================================================================================
1737
1738 LicenseManagement Response\ **:**
1739 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1740
1741 Success: A successful LicenseManagement returns a success status code
1742 400.
1743
1744 Failure: A failed LicenseManagement returns a failure code 401 and the
1745 failure message.
1746
1747
1748
1749
1750 Lock
1751 ----
1752
1753 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1754
1755 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.
1756
1757 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.
1758
1759 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.
1760
1761 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.
1762
1763 The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file
1764
1765 +------------------------------+---------------------------------------------------+
1766 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:lock   |
1767 +------------------------------+---------------------------------------------------+
1768 |     **Action**               |     Lock                                          |
1769 +------------------------------+---------------------------------------------------+
1770 |     **Action-Identifier**    |     Vnf-id                                        |
1771 +------------------------------+---------------------------------------------------+
1772 |     **Payload Parameters**   |     None                                          |
1773 +------------------------------+---------------------------------------------------+
1774 |     **Revision History**     |     Unchanged in this release.                    |
1775 +------------------------------+---------------------------------------------------+
1776
1777 Lock Response
1778 ^^^^^^^^^^^^^
1779
1780 The Lock returns a 400 Success response if the Lock is successfully applied.
1781
1782 The Lock returns a 401 Failure response with the failure message if the Lock is not successful.
1783
1784
1785 Migrate
1786 -------
1787
1788 Migrates a running target VM from its current host to another.
1789
1790 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1791
1792 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.
1793
1794 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.
1795
1796
1797 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1798
1799
1800 +--------------------------------+-----------------------------------------------------------------------------------------------+
1801 | **Input Block**                | api-ver should be set to 2.00 for current version of Migrate                                  |
1802 +--------------------------------+-----------------------------------------------------------------------------------------------+
1803 |     **Target URL**             |     /restconf/operations/appc-provider-lcm:migrate                                            |
1804 +--------------------------------+-----------------------------------------------------------------------------------------------+
1805 |     **Action**                 |     Migrate                                                                                   |
1806 +--------------------------------+-----------------------------------------------------------------------------------------------+
1807 |     **Action-Identifiers**     |     Vnf-id, vserver-id                                                                        |
1808 +--------------------------------+-----------------------------------------------------------------------------------------------+
1809 |     **Payload Parameters**     |     vm-id, identity-url, tenant-id                                                            |
1810 +--------------------------------+-----------------------------------------------------------------------------------------------+
1811 |     **Revision History**       |     Unchanged in this release.                                                                |
1812 +--------------------------------+-----------------------------------------------------------------------------------------------+
1813
1814 Payload Parameters
1815
1816 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1817 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                               |
1818 +=====================+=========================================================================+=====================+===============================================+
1819 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                               |
1820 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                               |
1821 |                     |     link URL of the VM.                                                 |                     |     "payload":                                |
1822 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",             |
1823 |                     |                                                                         |                     |     \\"identity-url\\":                       |
1824 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",                     |
1825 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"tenant-id\\": \\"<TENANT-ID>\\"}"      |
1826 |     identity- url   |     The identity url used to access the resource                        |     Yes             |                                               |
1827 |                     |                                                                         |                     |                                               |
1828 +---------------------+-------------------------------------------------------------------------+---------------------+                                               |
1829 |     tenant-id       |     The id of the provider tenant that owns the resource                |     Yes             |                                               |
1830 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1831
1832
1833 Migrate Response
1834 ^^^^^^^^^^^^^^^^
1835
1836 **Success:** A successful Migrate returns a success status code 400.
1837
1838 **Failure:** A failed Migrate returns a failure code 401 and the failure message.
1839
1840
1841 PostEvacuate
1842 -------------
1843
1844 PostEvacuate LCM action using the PostEvacuate playbook. This is limited
1845 to Ansible.
1846
1847 A successful PostEvacuate request returns a success response.
1848
1849 A failed PostEvacuate action returns a failure response code and the
1850 specific failure message in the response block.
1851
1852 ====================== ====================================================
1853 **Target URL**         /restconf/operations/appc-provider-lcm: PostEvacuate
1854 ====================== ====================================================
1855 **Action**             PostEvacuate
1856 **Action-Identifiers** vnf-id
1857 **Payload Parameters** See table
1858 **Revision History**   New in Frankfurt
1859 ====================== ====================================================
1860
1861 ========================= ========================================================================================================= ============= =====================================================================================================
1862 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1863 ========================= ========================================================================================================= ============= =====================================================================================================
1864 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1865 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1866 ========================= ========================================================================================================= ============= =====================================================================================================
1867
1868 PostEvacuate Response:
1869 ~~~~~~~~~~~~~~~~~~~~~~
1870
1871 Success: A successful PostEvacuate returns a success status code 400.
1872
1873 Failure: A failed PostEvacuate returns a failure code 401 and the
1874 failure message.
1875
1876
1877 PostMigrate
1878 -----------
1879
1880 PostMigrate LCM action using the PostMigrate playbook. This is limited
1881 to Ansible.
1882
1883 A successful PostMigrate request returns a success response.
1884
1885 A failed PostMigrate action returns a failure response code and the
1886 specific failure message in the response block.
1887
1888
1889 ====================== ===================================================
1890 **Target URL**         /restconf/operations/appc-provider-lcm: PostMigrate
1891 ====================== ===================================================
1892 **Action**             PostMigrate
1893 **Action-Identifiers** vnf-id
1894 **Payload Parameters** See below
1895 **Revision History**   New in Frankfurt
1896 ====================== ===================================================
1897
1898 ========================= ========================================================================================================= ============= =====================================================================================================
1899 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1900 ========================= ========================================================================================================= ============= =====================================================================================================
1901 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1902 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1903 ========================= ========================================================================================================= ============= =====================================================================================================
1904
1905 PostMigrate Response:
1906 ~~~~~~~~~~~~~~~~~~~~~
1907
1908 Success: A successful PostMigrate returns a success status code 400.
1909
1910 Failure: A failed PostMigrate returns a failure code 401 and the failure
1911 message.
1912
1913
1914
1915 PostRebuild
1916 -----------
1917
1918 PostRebuild LCM action using the PostRebuild playbook. This is limited
1919 to Ansible.
1920
1921 A successful PostRebuild request returns a success response.
1922
1923 A failed PostRebuild action returns a failure response code and the
1924 specific failure message in the response block.
1925
1926 ====================== ===================================================
1927 **Target URL**         /restconf/operations/appc-provider-lcm: PostRebuild
1928 ====================== ===================================================
1929 **Action**             PostRebuild
1930 **Action-Identifiers** vnf-id
1931 **Payload Parameters** See table
1932 **Revision History**   New in Frankfurt
1933 ====================== ===================================================
1934
1935 ========================= ========================================================================================================= ============= =====================================================================================================
1936 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1937 ========================= ========================================================================================================= ============= =====================================================================================================
1938 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1939 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1940 ========================= ========================================================================================================= ============= =====================================================================================================
1941
1942 PostRebuild Response:
1943 ~~~~~~~~~~~~~~~~~~~~~
1944
1945 Success: A successful PostRebuild returns a success status code 400.
1946
1947 Failure: A failed PostRebuild returns a failure code 401 and the failure
1948 message.
1949
1950
1951 PreConfig
1952 ---------
1953
1954 PreConfig LCM action for the MVM VNF types using the PreConfigure
1955 playbook. This is limited to Ansible.
1956
1957 A successful PreConfig request returns a success response.
1958
1959 A failed PreConfig action returns a failure response code and the
1960 specific failure message in the response block.
1961
1962
1963 ====================== =================================================
1964 **Target URL**         /restconf/operations/appc-provider-lcm: PreConfig
1965 ====================== =================================================
1966 **Action**             PreConfig
1967 **Action-Identifiers** vnf-id
1968 **Payload Parameters** See table
1969 **Revision History**   New in Frankfurt
1970 ====================== =================================================
1971
1972 ========================= ========================================================================================================= ============= ======================================================================================================
1973 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1974 ========================= ========================================================================================================= ============= ======================================================================================================
1975 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
1976
1977                                                                                                                                                   "payload": "{}"
1978 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1979 ========================= ========================================================================================================= ============= ======================================================================================================
1980
1981 PreConfig Response:
1982 -------------------
1983
1984 Success: A successful PreConfig returns a success status code 400.
1985
1986 Failure: A failed PreConfig returns a failure code 401 and the failure
1987 message.
1988
1989 PreEvacuate
1990 ------------
1991
1992 PreEvacuate LCM action using the PreEvacuate playbook. This is limited
1993 to Ansible.
1994
1995 A successful PreEvacuate request returns a success response.
1996
1997 A failed PreEvacuate action returns a failure response code and the
1998 specific failure message in the response block.
1999
2000
2001 ====================== ===================================================
2002 **Target URL**         /restconf/operations/appc-provider-lcm: PreEvacuate
2003 ====================== ===================================================
2004 **Action**             PreEvacuate
2005 **Action-Identifiers** vnf-id
2006 **Payload Parameters** See table
2007 **Revision History**   New in Frankfurt
2008 ====================== ===================================================
2009
2010 ========================= ========================================================================================================= ============= =====================================================================================================
2011 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2012 ========================= ========================================================================================================= ============= =====================================================================================================
2013 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2014 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2015 ========================= ========================================================================================================= ============= =====================================================================================================
2016
2017 PreEvacuate Response:
2018 ~~~~~~~~~~~~~~~~~~~~~
2019
2020 Success: A successful PreEvacuate returns a success status code 400.
2021
2022 Failure: A failed PreEvacuate returns a failure code 401 and the failure
2023 message.
2024
2025 PreMigrate
2026 ----------
2027
2028 PreMigrate LCM action using the PreMigrate playbook. This is limited to
2029 Ansible.
2030
2031 A successful PreMigrate request returns a success response.
2032
2033 A failed PreMigrate action returns a failure response code and the
2034 specific failure message in the response block.
2035
2036 ====================== ==================================================
2037 **Target URL**         /restconf/operations/appc-provider-lcm: PreMigrate
2038 ====================== ==================================================
2039 **Action**             PreMigrate
2040 **Action-Identifiers** vnf-id
2041 **Payload Parameters** See table
2042 **Revision History**   New in Frankfurt
2043 ====================== ==================================================
2044
2045 ========================= ========================================================================================================= ============= =====================================================================================================
2046 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2047 ========================= ========================================================================================================= ============= =====================================================================================================
2048 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2049 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2050 ========================= ========================================================================================================= ============= =====================================================================================================
2051
2052 PreMigrate Response:
2053 ~~~~~~~~~~~~~~~~~~~~
2054
2055 Success: A successful PreMigrate returns a success status code 400.
2056
2057 Failure: A failed PreMigrate returns a failure code 401 and the failure
2058 message.
2059
2060
2061 PreRebuild
2062 ----------
2063
2064 PreRebuild LCM action using the PreRebuild playbook. This is limited to
2065 Ansible.
2066
2067 A successful PreRebuild request returns a success response.
2068
2069 A failed PreRebuild action returns a failure response code and the
2070 specific failure message in the response block.
2071
2072
2073 ====================== ==================================================
2074 **Target URL**         /restconf/operations/appc-provider-lcm: PreRebuild
2075 ====================== ==================================================
2076 **Action**             PreRebuild
2077 **Action-Identifiers** vnf-id
2078 **Payload Parameters** See table
2079 **Revision History**   New in Frankfurt
2080 ====================== ==================================================
2081
2082 ========================= ========================================================================================================= ============= =====================================================================================================
2083 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2084 ========================= ========================================================================================================= ============= =====================================================================================================
2085 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2086 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2087 ========================= ========================================================================================================= ============= =====================================================================================================
2088
2089 PreRebuild Response:
2090 ~~~~~~~~~~~~~~~~~~~~
2091
2092 Success: A successful PreRebuild returns a success status code 400.
2093
2094 Failure: A failed PreRebuild returns a failure code 401 and the failure
2095 message.
2096
2097
2098 Provisioning
2099 ------------
2100
2101 For Provisioning LCM action, invoke the Provisioning playbook. This is
2102 limited to Ansible.
2103
2104 A successful Provisioning request returns a success response.
2105
2106 A failed Provisioning action returns a failure response code and the
2107 specific failure message in the response block.
2108
2109
2110 ====================== ===================================================
2111 **Target URL**         /restconf/operations/appc-provider-lcm:Provisioning
2112 ====================== ===================================================
2113 **Action**             Provisioning
2114 **Action-Identifiers** vnf-id
2115 **Payload Parameters** See table
2116 **Revision History**   New in Frankfurt
2117 ====================== ===================================================
2118
2119 ========================= ========================================================================================================= ============= =========================
2120 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2121 ========================= ========================================================================================================= ============= =========================
2122 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "Provisioning",
2123
2124                                                                                                                                                   "action-identifiers": {
2125
2126                                                                                                                                                   "vnf-id": "rarf9901v"
2127
2128                                                                                                                                                   },
2129
2130                                                                                                                                                   "payload": "{}"
2131 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2132 ========================= ========================================================================================================= ============= =========================
2133
2134 Provisioning Response\ **:**
2135 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2136
2137 Success: A successful Provisioning returns a success status code 400.
2138
2139 Failure: A failed Provisioning returns a failure code 401 and the
2140 failure message.
2141
2142
2143
2144 QuiesceTraffic
2145 --------------
2146
2147 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.
2148
2149 This command is executed using an Ansible playbook or Chef cookbook.
2150
2151 Request Structure:
2152
2153 +--------------------------+----------------------------------------------------------+
2154 | **Target URL**           | /restconf/operations/appc-provider-lcm:quiesce-traffic   |
2155 +--------------------------+----------------------------------------------------------+
2156 | **Action**               | QuiesceTraffic                                           |
2157 +--------------------------+----------------------------------------------------------+
2158 | **Action-identifiers**   | vnf-id                                                   |
2159 +--------------------------+----------------------------------------------------------+
2160 | **Payload Parameters**   | operations-timeout                                       |
2161 +--------------------------+----------------------------------------------------------+
2162 | **Revision History**     | New in Beijing                                           |
2163 +--------------------------+----------------------------------------------------------+
2164
2165 Request Payload Parameters:
2166
2167 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2168 | **Parameter**         |     **Description**                                                                                                                                                                                  |     **Required?**   |     **Example**                                |
2169 +=======================+======================================================================================================================================================================================================+=====================+================================================+
2170 | 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":                                 |
2171 |                       |                                                                                                                                                                                                      |                     |     "{\\"operations-timeout\\": \\"3600\\"}”   |
2172 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2173
2174 QuiesceTraffic Response
2175 ^^^^^^^^^^^^^^^^^^^^^^^
2176
2177 The response does not include any payload parameters.
2178
2179 **Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced.
2180
2181    If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status.
2182
2183 **Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2184
2185     A specific error message is returned if there is a timeout error.
2186
2187 Reboot
2188 -------
2189
2190 The Reboot is used to reboot a VM.
2191
2192
2193 There are two types supported: HARD and SOFT. A SOFT reboot attempts a graceful shutdown and restart of the server. A HARD reboot attempts a forced shutdown and restart of the server. The HARD reboot corresponds to the power cycles of the server.
2194
2195 **NOTE:** The command implementation is based on OpenStack functionality.  For further details, see http://developer.openstack.org/api-ref/compute/.
2196
2197 +------------------------------+-----------------------------------------------------------------------------------------------+
2198 | **Input Block**              | api-ver should be set to 2.00 for current version of Reboot                                   |
2199 +------------------------------+-----------------------------------------------------------------------------------------------+
2200 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:reboot                                             |
2201 +------------------------------+-----------------------------------------------------------------------------------------------+
2202 |     **Action**               |     Reboot                                                                                    |
2203 +------------------------------+-----------------------------------------------------------------------------------------------+
2204 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
2205 +------------------------------+-----------------------------------------------------------------------------------------------+
2206 |     **Payload Parameters**   |     See table below                                                                           |
2207 +------------------------------+-----------------------------------------------------------------------------------------------+
2208 |     **Revision History**     |     New in R3 release.                                                                        |
2209 +------------------------------+-----------------------------------------------------------------------------------------------+
2210
2211 Payload Parameters
2212
2213 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2214 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2215 +=================+===============================================+=================+=========================================+
2216 | type            |     The type of reboot.  Values are           | No              |                                         |
2217 |                 |     HARD and SOFT.  If not                    |                 |                                         |
2218 |                 |     specified, SOFT reboot is                 |                 | "payload":                              |
2219 |                 |     performed.                                |                 | "{\\"type\\": \\"HARD\\",               |
2220 |                 |                                               |                 |   \\"vm-id\\": \\"<VM-ID>\\",           |
2221 |                 |                                               |                 | \\"identity-url\\":                     |
2222 |                 |                                               |                 | \\"<IDENTITY-URL>\\"                    |
2223 |                 |                                               |                 | }"                                      |
2224 +-----------------+-----------------------------------------------+-----------------+                                         |
2225 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2226 |                 |     the resource. For backwards-              |                 |                                         |
2227 |                 |     compatibility, this can be the self-      |                 |                                         |
2228 |                 |     link URL of the VM.                       |                 |                                         |
2229 |                 |                                               |                 |                                         |
2230 |                 |                                               |                 |                                         |
2231 |                 |                                               |                 |                                         |
2232 |                 |                                               |                 |                                         |
2233 +-----------------+-----------------------------------------------+-----------------+                                         |
2234 | identity-url    |     The identity url used to access the       | Yes             |                                         |
2235 |                 |     resource.                                 |                 |                                         |
2236 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2237
2238 Reboot Response
2239 ^^^^^^^^^^^^^^^
2240
2241 **Success:** A successful Rebuild returns a success status code 400.
2242
2243 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2244
2245 Rebuild
2246 -------
2247
2248 Recreates a target VM instance to a known, stable state.
2249
2250 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
2251
2252 Rebuild VM uses the snapshot provided by the snapshot-id (if provided).  If not provided, the latest snapshot is used.  If there are no snapshots, it uses the (original) Glance image.
2253
2254 APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume
2255
2256
2257 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2258
2259
2260 +------------------------------+-----------------------------------------------------------------------------------------------+
2261 | **Input Block**              | api-ver should be set to 2.00 for current version of Rebuild                                  |
2262 +------------------------------+-----------------------------------------------------------------------------------------------+
2263 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:rebuild                                            |
2264 +------------------------------+-----------------------------------------------------------------------------------------------+
2265 |     **Action**               |     Rebuild                                                                                   |
2266 +------------------------------+-----------------------------------------------------------------------------------------------+
2267 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
2268 +------------------------------+-----------------------------------------------------------------------------------------------+
2269 |     **Payload Parameters**   |     See table below                                                                           |
2270 +------------------------------+-----------------------------------------------------------------------------------------------+
2271 |     **Revision History**     |     Unchanged in this release.                                                                |
2272 +------------------------------+-----------------------------------------------------------------------------------------------+
2273
2274
2275 Payload Parameters
2276
2277 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2278 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2279 +=================+===============================================+=================+=========================================+
2280 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2281 |                 |     the resource. For backwards-              |                 |                                         |
2282 |                 |     compatibility, this can be the self-      |                 | "payload":                              |
2283 |                 |     link URL of the VM.                       |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2284 |                 |                                               |                 | \\",                                    |
2285 |                 |                                               |                 | \\"identity-url\\":                     |
2286 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2287 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2288 +-----------------+-----------------------------------------------+-----------------+ \\"snapshot-id\\": \\"<SNAPSHOT- ID>\\" |
2289 | identity- url   |     The identity url used to access the       | Yes             | }"                                      |
2290 |                 |     resource.                                 |                 |                                         |
2291 +-----------------+-----------------------------------------------+-----------------+                                         |
2292 | tenant-id       |     The id of the provider tenant that owns   | Yes             |                                         |
2293 |                 |     the resource.                             |                 |                                         |
2294 +-----------------+-----------------------------------------------+-----------------+                                         |
2295 | snapshot-id     |  The snapshot-id of a previously saved image. | No              |                                         |
2296 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2297
2298 Rebuild Response
2299 ^^^^^^^^^^^^^^^^
2300
2301 **Success:** A successful Rebuild returns a success status code 400.
2302
2303 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2304
2305 Restart
2306 -------
2307
2308 Use the Restart command to restart a VM.
2309
2310 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2311 |     **Input Block**          |     api-ver should be set to 2.00 for current version of Restart                                                |
2312 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2313 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:restart                                                              |
2314 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2315 |     **Action**               |     Restart                                                                                                     |
2316 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2317 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                          |
2318 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2319 |     **Payload Parameters**   |     See table below                                                                                             |
2320 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2321 |     **Revision History**     |     Unchanged in this release                                                                                   |
2322 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2323
2324 Payload Parameters for **VM Restart**
2325
2326 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2327 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
2328 +=====================+=========================================================================+=====================+====================================+
2329 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
2330 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                    |
2331 |                     |     link URL of the VM                                                  |                     |     "payload":                     |
2332 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",  |
2333 |                     |                                                                         |                     |     \\"identity-url\\":            |
2334 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"<IDENTITY-URL>\\",          |
2335 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
2336 |                     |                                                                         |                     |     ID>\\"}"                       |
2337 +---------------------+-------------------------------------------------------------------------+---------------------+                                    |
2338 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
2339 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2340
2341 ResumeTraffic
2342 -------------
2343
2344 The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.
2345
2346 This command is executed using an Ansible playbook or Chef cookbook.
2347
2348 Request Structure: The payload does not have any parameters.
2349
2350 +--------------------------+---------------------------------------------------------+
2351 | **Target URL**           | /restconf/operations/appc-provider-lcm:resume-traffic   |
2352 +--------------------------+---------------------------------------------------------+
2353 | **Action**               | ResumeTraffic                                           |
2354 +--------------------------+---------------------------------------------------------+
2355 | **Action-identifiers**   | vnf-id                                                  |
2356 +--------------------------+---------------------------------------------------------+
2357 | **Payload Parameters**   |                                                         |
2358 +--------------------------+---------------------------------------------------------+
2359 | **Revision History**     | New in Beijing                                          |
2360 +--------------------------+---------------------------------------------------------+
2361
2362 ResumeTraffic Response
2363 ^^^^^^^^^^^^^^^^^^^^^^
2364
2365 **Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed.
2366
2367 If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status
2368
2369 **Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2370
2371
2372 Snapshot
2373 --------
2374
2375 Creates a snapshot of a VM.
2376
2377 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
2378
2379 This command can be applied to a VM in any VNF type. The only restriction is that the particular VNF should be built based on the generic heat stack.
2380
2381 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.
2382
2383 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2384
2385 +------------------------------+-----------------------------------------------------------------------------------------------------+
2386 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:snapshot                                                 |
2387 +------------------------------+-----------------------------------------------------------------------------------------------------+
2388 |     **Action**               |     Snapshot                                                                                        |
2389 +------------------------------+-----------------------------------------------------------------------------------------------------+
2390 |     **Action-identifiers**   |     vnf-id, vserver-id                                                                              |
2391 +------------------------------+-----------------------------------------------------------------------------------------------------+
2392 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id                                                                  |
2393 +------------------------------+-----------------------------------------------------------------------------------------------------+
2394 |     **Revision History**     |     Unchanged in this release.                                                                      |
2395 +------------------------------+-----------------------------------------------------------------------------------------------------+
2396
2397 Payload Parameters
2398
2399 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2400 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                        |
2401 +=====================+=========================================================================+=====================+========================================+
2402 |     vm-id           |     The self-link URL of the VM                                         |     Yes             |                                        |
2403 |                     |                                                                         |                     |     "payload":                         |
2404 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",      |
2405 |                     |                                                                         |                     |     \\"identity-url\\":                |
2406 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",              |
2407 |                     |                                                                         |                     |     \\"tenant-id\\":\\"<TENANT-ID>\\"}"|
2408 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
2409 |     identity- url   |     The identity url used to access the resource                        |     No              |                                        |
2410 |                     |                                                                         |                     |                                        |
2411 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
2412 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                        |
2413 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2414
2415 Snapshot Response
2416 ^^^^^^^^^^^^^^^^^
2417
2418 The Snapshot command returns an extended version of the LCM response.
2419
2420 The Snapshot response conforms to the standard response format.
2421
2422
2423 Start
2424 -----
2425
2426 Use the Start command to start a VM that is stopped.
2427
2428 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2429
2430 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2431 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start                                                                               |
2432 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2433 |     **Action**               |     Start                                                                                                                      |
2434 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2435 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                                         |
2436 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2437 |     **Payload Parameters**   |     See table below                                                                                                            |
2438 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2439 |     **Revision History**     |     Unchanged in this release                                                                                                  |
2440 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2441
2442 Payload Parameters
2443
2444 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2445 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2446 +=================+===============================================+=================+=========================================+
2447 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2448 |                 |     the resource. For backwards-              |                 | "payload":                              |
2449 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2450 |                 |     link URL of the VM.                       |                 | \\",                                    |
2451 |                 |                                               |                 | \\"identity-url\\":                     |
2452 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2453 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2454 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2455 | identity- url   |     The identity url used to access the       | No              |                                         |
2456 |                 |     resource                                  |                 |                                         |
2457 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2458 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
2459 |                 |     the resource                              |                 |                                         |
2460 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2461
2462
2463 StartApplication
2464 ----------------
2465
2466 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.
2467
2468 A successful StartApplication request returns a success response.
2469
2470 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
2471
2472 +------------------------------+---------------------------------------------------------------+
2473 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start-application  |
2474 +------------------------------+---------------------------------------------------------------+
2475 |     **Action**               |     StartApplication                                          |
2476 +------------------------------+---------------------------------------------------------------+
2477 |     **Action-Identifiers**   |     Vnf-id                                                    |
2478 +------------------------------+---------------------------------------------------------------+
2479 |     **Payload Parameters**   |     See table below                                           |
2480 +------------------------------+---------------------------------------------------------------+
2481 |     **Revision History**     |     Unchanged in this release.                                |
2482 +------------------------------+---------------------------------------------------------------+
2483
2484 |
2485
2486 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2487 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
2488 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2489 |                                 |                                                                                                                                                                                    |                     |  "payload":                                                     |
2490 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |  "{\\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
2491 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2492
2493 StartApplication Response
2494 ^^^^^^^^^^^^^^^^^^^^^^^^^
2495
2496 The StartApplication response returns an indication of success or failure of the request.
2497
2498 StartTraffic
2499 ------------
2500
2501 For StartTraffic LCM action, invoke the StartTraffic playbook. This is
2502 limited to Ansible.
2503
2504 A successful StartTraffic request returns a success response.
2505
2506 A failed StartTraffic action returns a failure response code and the
2507 specific failure message in the response block.
2508
2509
2510 ====================== ===================================================
2511 **Target URL**         /restconf/operations/appc-provider-lcm:StartTraffic
2512 ====================== ===================================================
2513 **Action**             StartTraffic
2514 **Action-Identifiers** vnf-id
2515 **Payload Parameters** See table
2516 **Revision History**   New in Frankfurt
2517 ====================== ===================================================
2518
2519 ========================= ========================================================================================================= ============= =========================
2520 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2521 ========================= ========================================================================================================= ============= =========================
2522 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StartTraffic",
2523
2524                                                                                                                                                   "action-identifiers": {
2525
2526                                                                                                                                                   "vnf-id": "rarf9901v"
2527
2528                                                                                                                                                   },
2529
2530                                                                                                                                                   "payload": "{}"
2531 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2532 ========================= ========================================================================================================= ============= =========================
2533
2534 StartTraffic Response\ **:**
2535 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2536
2537 Success: A successful StartTraffic returns a success status code 400.
2538
2539 Failure: A failed StartTraffic returns a failure code 401 and the
2540 failure message.
2541
2542
2543
2544 StatusTraffic
2545 -------------
2546
2547 For StatusTraffic LCM action, invoke the StatusTraffic playbook. This is
2548 limited to Ansible.
2549
2550 A successful StatusTraffic request returns a success response.
2551
2552 A failed StatusTraffic action returns a failure response code and the
2553 specific failure message in the response block.
2554
2555 ====================== ====================================================
2556 **Target URL**         /restconf/operations/appc-provider-lcm:StatusTraffic
2557 ====================== ====================================================
2558 **Action**             StatusTraffic
2559 **Action-Identifiers** vnf-id
2560 **Payload Parameters** See table
2561 **Revision History**   New in Frankfurt
2562 ====================== ====================================================
2563
2564 ========================= ========================================================================================================= ============= ==========================
2565 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2566 ========================= ========================================================================================================= ============= ==========================
2567 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StatusTraffic",
2568
2569                                                                                                                                                   "action-identifiers": {
2570
2571                                                                                                                                                   "vnf-id": "rarf9901v"
2572
2573                                                                                                                                                   },
2574
2575                                                                                                                                                   "payload": "{}"
2576 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2577 ========================= ========================================================================================================= ============= ==========================
2578
2579 StatusTraffic Response\ **:**
2580 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2581
2582 Success: A successful StatusTraffic returns a success status code 400.
2583
2584 Failure: A failed StatusTraffic returns a failure code 401 and the
2585 failure message.
2586
2587
2588 Stop
2589 ----
2590
2591 Use the Stop command to stop a VM that was running.
2592
2593 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2594
2595 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2596 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop                                                                                |
2597 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2598 |     **Action**               |     Stop                                                                                                                       |
2599 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2600 |     **Action-identifiers**   |     vnf-id and vserver-id are required.                                                                                        |
2601 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2602 |     **Payload Parameters**   |     See table below                                                                                                            |
2603 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2604 |     **Revision History**     |     Unchanged in this release                                                                                                  |
2605 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2606
2607 Payload Parameters
2608
2609 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2610 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2611 +=================+===============================================+=================+=========================================+
2612 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2613 |                 |     the resource. For backwards-              |                 | "payload":                              |
2614 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2615 |                 |     link URL of the VM.                       |                 | \\",                                    |
2616 |                 |                                               |                 | \\"identity-url\\":                     |
2617 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2618 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2619 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2620 | identity- url   |     The identity url used to access the       | No              |                                         |
2621 |                 |     resource                                  |                 |                                         |
2622 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2623 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
2624 |                 |     the resource                              |                 |                                         |
2625 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2626
2627
2628 StopApplication
2629 ---------------
2630
2631 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
2632
2633 A successful StopApplication request returns a success response.
2634
2635 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
2636
2637 +------------------------------+--------------------------------------------------------------+
2638 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop-application  |
2639 +------------------------------+--------------------------------------------------------------+
2640 |     **Action**               |     StopApplication                                          |
2641 +------------------------------+--------------------------------------------------------------+
2642 |     **Action-Identifiers**   |     Vnf-id                                                   |
2643 +------------------------------+--------------------------------------------------------------+
2644 |     **Payload Parameters**   |     See table below                                          |
2645 +------------------------------+--------------------------------------------------------------+
2646 |     **Revision History**     |     Unchanged in this release                                |
2647 +------------------------------+--------------------------------------------------------------+
2648
2649 |
2650
2651 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2652 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
2653 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2654 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |     "payload":                                                  |
2655 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
2656 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2657
2658
2659 StopApplication Response
2660 ^^^^^^^^^^^^^^^^^^^^^^^^
2661
2662 The StopApplication response returns an indication of success or failure of the request.
2663
2664 StopTraffic
2665 -----------
2666
2667 For StopTraffic LCM action, invoke the StopTraffic playbook. This is
2668 limited to Ansible.
2669
2670 A successful StopTraffic request returns a success response.
2671
2672 A failed StopTraffic action returns a failure response code and the
2673 specific failure message in the response block.
2674
2675
2676 ====================== ==================================================
2677 **Target URL**         /restconf/operations/appc-provider-lcm:StopTraffic
2678 ====================== ==================================================
2679 **Action**             Provisioning
2680 **Action-Identifiers** vnf-id
2681 **Payload Parameters** See table
2682 **Revision History**   New in Frankfurt
2683 ====================== ==================================================
2684
2685 ========================= ========================================================================================================= ============= ========================================================================
2686 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2687 ========================= ========================================================================================================= ============= ========================================================================
2688 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StopTraffic",
2689
2690                                                                                                                                                   "action-identifiers": {
2691
2692                                                                                                                                                   "vnf-id": "rarf9901v"
2693
2694                                                                                                                                                   },
2695
2696                                                                                                                                                   "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\"}}"
2697 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2698 ========================= ========================================================================================================= ============= ========================================================================
2699
2700 StopTraffic Response\ **:**
2701 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2702
2703 Success: A successful StopTraffic returns a success status code 400.
2704
2705 Failure: A failed StopTraffic returns a failure code 401 and the failure
2706 message.
2707
2708
2709 Sync
2710 ----
2711
2712 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
2713
2714 A successful Sync returns a success status.
2715
2716 A failed Sync returns a failure response status and failure messages in the response payload block.
2717
2718 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).
2719
2720 +------------------------------+---------------------------------------------------+
2721 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:sync   |
2722 +------------------------------+---------------------------------------------------+
2723 |     **Action**               |     Sync                                          |
2724 +------------------------------+---------------------------------------------------+
2725 |     **Action-identifiers**   |     Vnf-id                                        |
2726 +------------------------------+---------------------------------------------------+
2727 |     **Payload Parameters**   |     See below                                     |
2728 +------------------------------+---------------------------------------------------+
2729 |     **Revision History**     |     Unchanged in this release.                    |
2730 +------------------------------+---------------------------------------------------+
2731
2732 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2733 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
2734 +======================+===========================================================================================================================================================+=====================+==================================+
2735 |     publish-config   |     \* If the publish\-config field is set to Y in the payload, then always write the running configuration to file                                       |     Yes             |     "publish-config": "<Y\|N>"   |
2736 |                      |                                                                                                                                                           |                     |                                  |
2737 |                      |     \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file                                     |                     |                                  |
2738 |                      |                                                                                                                                                           |                     |                                  |
2739 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2740
2741
2742 Unlock
2743 ------
2744
2745 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
2746
2747 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.
2748
2749 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
2750
2751 The Unlock command will only return success if the VNF was locked with same request-id.
2752
2753 The Unlock command returns only one final response with the status of the request processing.
2754
2755 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.
2756
2757 +------------------------------+-----------------------------------------------------+
2758 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:unlock   |
2759 +------------------------------+-----------------------------------------------------+
2760 |     **Action**               |     Unlock                                          |
2761 +------------------------------+-----------------------------------------------------+
2762 |     **Action-identifiers**   |     Vnf-id                                          |
2763 +------------------------------+-----------------------------------------------------+
2764 |     **Payload Parameters**   |     see table below                                 |
2765 +------------------------------+-----------------------------------------------------+
2766 |     **Revision History**     |     Unchanged in this release.                      |
2767 +------------------------------+-----------------------------------------------------+
2768
2769 |
2770
2771 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2772 |     **Payload Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                  |
2773 +=================================+=========================================================================+=====================+==================================+
2774 |     request-id                  |     Request id from the previously submitted request                    |     Yes             |    "request-id": "123456789"     |
2775 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2776
2777
2778 UpgradeBackout
2779 --------------
2780
2781 The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
2782
2783 This command is executed using an Ansible playbook or Chef cookbook.
2784
2785 Request Structure: The request payload includes an upgrade identifier.
2786
2787 +--------------------------+----------------------------------------------------------+
2788 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backout   |
2789 +--------------------------+----------------------------------------------------------+
2790 | **Action**               | UpgradeBackout                                           |
2791 +--------------------------+----------------------------------------------------------+
2792 | **Action-identifiers**   | vnf-id                                                   |
2793 +--------------------------+----------------------------------------------------------+
2794 | **Payload Parameters**   | existing-software-version, new-software-version          |
2795 +--------------------------+----------------------------------------------------------+
2796 | **Revision History**     | New in Beijing                                           |
2797 +--------------------------+----------------------------------------------------------+
2798
2799 Request Payload Parameters:
2800
2801 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2802 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2803 +=======================+=====================================+=====================+===============================================================================================+
2804 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2805 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2806 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2807 | new-software-         |     The new software                |     Yes             |                                                                                               |
2808 | version               |     version after the               |                     |                                                                                               |
2809 |                       |     upgrade                         |                     |                                                                                               |
2810 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2811
2812 UpgradeBackout Response
2813 ^^^^^^^^^^^^^^^^^^^^^^^
2814
2815 **Success:** A successful backout returns a success status code 400.
2816
2817 **Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2818
2819 UpgradeBackup
2820 -------------
2821
2822 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.
2823
2824 This command is executed using an Ansible playbook or Chef cookbook.
2825
2826 Request Structure: The payload does not have any parameters required.
2827
2828 +--------------------------+---------------------------------------------------------+
2829 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backup   |
2830 +--------------------------+---------------------------------------------------------+
2831 | **Action**               | UpgradeBackup                                           |
2832 +--------------------------+---------------------------------------------------------+
2833 | **Action-identifiers**   | vnf-id                                                  |
2834 +--------------------------+---------------------------------------------------------+
2835 | **Payload Parameters**   | existing-software-version, new-software-version         |
2836 +--------------------------+---------------------------------------------------------+
2837 | **Revision History**     | New in Beijing.                                         |
2838 +--------------------------+---------------------------------------------------------+
2839
2840 Request Payload Parameters:
2841
2842 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2843 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2844 +=======================+=====================================+=====================+===============================================================================================+
2845 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2846 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2847 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2848 | new-software-         |     The new software                |     Yes             |                                                                                               |
2849 | version               |     version after the               |                     |                                                                                               |
2850 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2851
2852 UpgradeBackup Response
2853 ^^^^^^^^^^^^^^^^^^^^^^
2854
2855 **Success:** A successful backup returns a success status code 400.
2856
2857 **Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2858
2859 UpgradePostCheck
2860 ----------------
2861
2862 The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.
2863
2864 This command is executed using an Ansible playbook or Chef cookbook.
2865
2866 Request Structure:
2867
2868 +--------------------------+-------------------------------------------------------------+
2869 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-post-check   |
2870 +--------------------------+-------------------------------------------------------------+
2871 | **Action**               | UpgradePostCheck                                            |
2872 +--------------------------+-------------------------------------------------------------+
2873 | **Action-identifiers**   | vnf-id                                                      |
2874 +--------------------------+-------------------------------------------------------------+
2875 | **Payload Parameters**   | existing-software-version, new-software-version             |
2876 +--------------------------+-------------------------------------------------------------+
2877 | **Revision History**     | New in Beijing                                              |
2878 +--------------------------+-------------------------------------------------------------+
2879
2880 Request Payload Parameters:
2881
2882 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2883 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2884 +=======================+=====================================+=====================+===============================================================================================+
2885 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
2886 |  version              |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2887 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2888 | new-software-         |     The new software                |     Yes             |                                                                                               |
2889 | version               |     version after the               |                     |                                                                                               |
2890 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2891
2892 UpgradePostCheck Response
2893 ^^^^^^^^^^^^^^^^^^^^^^^^^
2894
2895 **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).
2896
2897 Response Payload Parameters:
2898
2899 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2900 | **Parameter** |     **Description**         |**Required?**|     **Example**                                                              |
2901 +===============+=============================+=============+==============================================================================+
2902 | Upgrade-      |     Returns the status      |     Yes     |                                                                              |
2903 | Status        |     of the upgradw          |             |     "payload":                                                               |
2904 |               |     post-check. Indicates   |             |     "{\\"upgrade-status\\": \\"Completed\\"}”                                |
2905 |               |     Completed or Failed     |             |     "payload": "{\\"upgrade-status\\":                                       |
2906 |               |                             |             |     \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” |
2907 +---------------+-----------------------------+-------------+                                                                              |
2908 | Message       |     If Not Available,       |             |                                                                              |
2909 |               |     message contains        |             |                                                                              |
2910 |               |     explanation.            |             |                                                                              |
2911 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2912
2913 **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.
2914
2915 UpgradePreCheck
2916 ---------------
2917
2918 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).
2919
2920 This command is executed using an Ansible playbook or Chef cookbook.
2921
2922 Request Structure:
2923
2924 +--------------------------+------------------------------------------------------------+
2925 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-pre-check   |
2926 +--------------------------+------------------------------------------------------------+
2927 | **Action**               | UpgradePreCheck                                            |
2928 +--------------------------+------------------------------------------------------------+
2929 | **Action-identifiers**   | vnf-id                                                     |
2930 +--------------------------+------------------------------------------------------------+
2931 | **Payload Parameters**   | existing-software-version, new-software-version            |
2932 +--------------------------+------------------------------------------------------------+
2933 | **Revision History**     | New in Beijing                                             |
2934 +--------------------------+------------------------------------------------------------+
2935
2936 Request Payload Parameters:
2937
2938 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2939 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2940 +=======================+=====================================+=====================+===============================================================================================+
2941 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2942 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2943 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2944 | new-software-         |     The new software                |     Yes             |                                                                                               |
2945 | version               |     version after the               |                     |                                                                                               |
2946 |                       |     upgrade                         |                     |                                                                                               |
2947 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2948
2949 UpgradePreCheck Response
2950 ^^^^^^^^^^^^^^^^^^^^^^^^
2951
2952 **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).
2953
2954 Response Payload Parameters:
2955
2956 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2957 | **Parameter**   |     **Description**       |     **Required?**   |     **Example**                                                                                                                  |
2958 +=================+===========================+=====================+==================================================================================================================================+
2959 | upgrade-status  |     Returns the status    |     Yes             |                                                                                                                                  |
2960 |                 |     of the upgrade pre-   |                     |     "payload":                                                                                                                   |
2961 |                 |     check. Indicates      |                     |     "{\\"upgrade-status\\": \\"Available\\"}”                                                                                    |
2962 |                 |     Available or Not      |                     |                                                                                                                                  |
2963 |                 |     Available             |                     |     "payload":                                                                                                                   |
2964 |                 |                           |                     |     "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }”   |
2965 +-----------------+---------------------------+---------------------+                                                                                                                                  |
2966 |     message     |     If Not Available,     |                     |                                                                                                                                  |
2967 |                 |     message contains      |                     |                                                                                                                                  |
2968 |                 |     explanation.          |                     |                                                                                                                                  |
2969 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2970
2971 **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.
2972
2973 UpgradeSoftware
2974 ---------------
2975
2976 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).
2977
2978 This command is executed using an Ansible playbook or Chef cookbook.
2979
2980 Request Structure: The request payload includes the new-software-version.
2981
2982 +--------------------------+-----------------------------------------------------------+
2983 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-software   |
2984 +--------------------------+-----------------------------------------------------------+
2985 | **Action**               | UpgradeSoftware                                           |
2986 +--------------------------+-----------------------------------------------------------+
2987 | **Action-identifiers**   | vnf-id                                                    |
2988 +--------------------------+-----------------------------------------------------------+
2989 | **Payload Parameters**   | existing-software-version, new-software-version           |
2990 +--------------------------+-----------------------------------------------------------+
2991 | **Revision History**     | New in Beijing                                            |
2992 +--------------------------+-----------------------------------------------------------+
2993
2994  Request Payload Parameters:
2995
2996 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2997 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2998 +=======================+=====================================+=====================+===============================================================================================+
2999 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
3000 | version               |      prior to the upgrade           |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
3001 +-----------------------+-------------------------------------+---------------------+                                                                                               |
3002 | new-software          |     The new software                |     Yes             |                                                                                               |
3003 | version               |     version after the               |                     |                                                                                               |
3004 |                       |     upgrade                         |                     |                                                                                               |
3005 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
3006
3007 UpgradeSoftware Response
3008 ^^^^^^^^^^^^^^^^^^^^^^^^
3009
3010 **Success:** A successful upgrade returns a success status code 400.
3011
3012 If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status.
3013
3014 **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.
3015
3016 Notes regarding the Upgrade commands
3017 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3018 Ansible playbooks / Chef cookbooks:
3019
3020 -  All Ansible playbooks/cookbooks for the Upgrade commands will be
3021    stored in the same directory on the server. The directory name will
3022    be of the format:
3023
3024         {existing-software-version_new-software-version}.
3025
3026                 The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade).
3027
3028 -  The playbooks for upgrades should use a standard naming convention
3029    (for example: SoftwareUpgrade_{existing-software-version_new-software-version}).
3030
3031 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.
3032
3033 -  The template will contain the directory path/playbook name which
3034    would be parameterized.
3035
3036     {vnf-type}/UpgradeSoftware/${existing_software_version}_${new-software-version}/
3037     SoftwareUpgrade_{existing-software-version_new-software-version}.
3038
3039