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 |     ConfigScaleIn           | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 574 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 575 |     ConfigScaleOut          | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 576 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 577 |     DetachVolume            |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 578 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 579 |     DistributeTraffic       | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 580 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 581 |     DistributeTrafficCheck  | Yes       |                  | Yes            | Yes      | Chef and Ansible only (requires self-service onboarding)   |
 582 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 583 |     DownloadNESw            | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 584 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 585 |     Evacuate                |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 586 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 587 |     GetConfig               | Yes       |                  |                |          |     Ansible                                                |
 588 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 589 |     HealthCheck             | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 590 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 591 |     LicenseManagement       | Yes       |                  |                |          |     Ansible                                                |
 592 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 593 |     Lock                    | Yes       |                  |                |          |     Any                                                    |
 594 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 595 |     Migrate                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 596 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 597 |     PostEvacuate            | Yes       |                  |                |          |     Ansible                                                |
 598 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 599 |     PostMigrate             | Yes       |                  |                |          |     Ansible                                                |
 600 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 601 |     PostRebuild             | Yes       |                  |                |          |     Ansible                                                |
 602 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 603 |     PreConfigure            | Yes       |                  |                |          |     Ansible                                                |
 604 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 605 |     PreEvacuate             | Yes       |                  |                |          |     Ansible                                                |
 606 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 607 |     PreMigrate              | Yes       |                  |                |          |     Ansible                                                |
 608 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 609 |     PreRebuild              | Yes       |                  |                |          |     Ansible                                                |
 610 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 611 |     Provisioning            | Yes       |                  |                |          |     Ansible                                                |
 612 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 613 |     QuiesceTraffic          | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 614 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 615 |     Reboot                  |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 616 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 617 |     Rebuild                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 618 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 619 |     Restart                 |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 620 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 621 |     ResumeTraffic           | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 622 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 623 |     Snapshot                |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 624 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 625 |     Start                   |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 626 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 627 |     StartApplication        | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 628 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 629 |     StartTraffic            | Yes       |                  |                |          |     Ansible                                                |
 630 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 631 |     StatusTraffic           | Yes       |                  |                |          |     Ansible                                                |
 632 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 633 |     Stop                    |           |                  |                | Yes      |     Any (uses OpenStack command)                           |
 634 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 635 |     StopApplication         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 636 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 637 |     StopTraffic             | Yes       |                  |                |          |     Ansible                                                |
 638 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 639 |     Sync                    | Yes       |                  |                |          |     Any (requires self-service onboarding)                 |
 640 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 641 |     Unlock                  | Yes       |                  |                |          |     Any                                                    |
 642 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 643 |     UpgradeBackout          | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 644 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 645 |     UpgradeBackup           | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 646 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 647 |     UpgradePostCheck        | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 648 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 649 |     UpgradePreCheck         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 650 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 651 |     UpgradeSoftware         | Yes       |                  |                |          | Chef and Ansible only (requires self-service onboarding)   |
 652 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
 653
 654
 655
 656 Self-Service VNF Onboarding
 657 ---------------------------
 658
 659 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:
 660
 661 -  Netconf with uploadable Yang model (requires a Netconf server running
 662    on the VNF)
 663
 664 -  Chef (requires a Chef client running on the VNF)
 665
 666 -  Ansible (does not require any changes to the VNF software)
 667
 668 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:
 669
 670 -  Define the VNF capabilities (set of actions that the VNF can
 671    support).
 672
 673 -  Create a template and parameter definitions for actions which use the
 674    Netconf, Chef, or Ansible protocols. The template is an xml or JSON
 675    block which defines the “payload” which is included in the request
 676    that is downloaded the VNF (if Netconf) or Chef/Ansible server.
 677
 678 -  Test actions which have templates/parameter definitions.
 679
 680 -  Upload the VNF definition, template, and parameter definition
 681    artifacts to SDC which distributes them to all APPC instances in the
 682    same environment (e.g., production).
 683
 684 For more details, see the APPC CDT Onboarding User Guide.
 685
 686
 687
 688 LCM Commands
 689 ============
 690
 691 The LCM commands that are valid for the current release.
 692
 693 ActionStatus
 694 ------------
 695
 696 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.
 697
 698 +--------------------------+----------------------------------------------------------+
 699 | **Target URL**           | /restconf /operations/ appc-provider-lcm:action-status   |
 700 +--------------------------+----------------------------------------------------------+
 701 | **Action**               | ActionStatus                                             |
 702 +--------------------------+----------------------------------------------------------+
 703 | **Action-Identifiers**   | vnf-id                                                   |
 704 +--------------------------+----------------------------------------------------------+
 705 | **Payload Parameters**   | See below                                                |
 706 +--------------------------+----------------------------------------------------------+
 707 | **Revision History**     | New in Beijing                                           |
 708 +--------------------------+----------------------------------------------------------+
 709
 710 |
 711
 712 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 713 |     **Payload Parameter**   |     **Description**                                        |     **Required**   |     **Example**                     |
 714 +=============================+============================================================+====================+=====================================+
 715 | request-id                  |     Request id from the previously submitted request       | Yes                |     "request-id": "123456789"       |
 716 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 717 | sub-request ID              |     Sub-Request id from the previously submitted request   | optional           |     "sub-request-id": "123456789"   |
 718 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 719 | originator-id               |     Originator id from the previously submitted request    | optional           |     "originator-id": "123456789"    |
 720 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
 721
 722
 723 ActionStatus Response:
 724 ^^^^^^^^^^^^^^^^^^^^^^
 725
 726 A successful response contains a payload with the following:
 727
 728 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 729 |     **Payload Parameter**   |     **Description**                                                   |     **Required**   |     **Example**              |
 730 +=============================+=======================================================================+====================+==============================+
 731 | status-reason               |     Contains more details about status                                | No                 |                              |
 732 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 733 | status                      |     IN_PROGRESS – The request has been accepted and is in progress    | No                 |     "status": "SUCCESSFUL"   |
 734 |                             |                                                                       |                    |                              |
 735 |                             |     SUCCESSFUL – The request returned success message                 |                    |                              |
 736 |                             |                                                                       |                    |                              |
 737 |                             |     FAILED – The request failed and returned an error message         |                    |                              |
 738 |                             |                                                                       |                    |                              |
 739 |                             |     ABORTED – the request aborted                                     |                    |                              |
 740 |                             |                                                                       |                    |                              |
 741 |                             |     NOT_FOUND – The request is not found                              |                    |                              |
 742 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
 743
 744 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:
 745
 746     ``"message": "MULTIPLE REQUESTS FOUND - using search criteria:
 747     request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
 748     vnf-id=ctsf0007v", "code": 315``
 749
 750 ActivateNESw
 751 ---------------
 752
 753 The ActivateNESw LCM action activates the target software version needed for a software upgrade.
 754
 755 This command is executed using an Ansible playbook or Chef cookbook.
 756
 757 Request Structure:
 758
 759 +--------------------------+------------------------------------------------------------+
 760 | **Target URL**           | /restconf/operations/appc-provider-lcm:activate-n-e-sw     |
 761 +--------------------------+------------------------------------------------------------+
 762 | **Action**               | ActivateNESw                                               |
 763 +--------------------------+------------------------------------------------------------+
 764 | **Action-identifiers**   | vnf-id                                                     |
 765 +--------------------------+------------------------------------------------------------+
 766 | **Payload Parameters**   | See below                                                  |
 767 +--------------------------+------------------------------------------------------------+
 768 | **Revision History**     | New in Frankfurt                                           |
 769 +--------------------------+------------------------------------------------------------+
 770
 771 Request Payload Parameters:
 772
 773 +--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
 774 | **Parameter**            |     **Description**                 |     **Required?**   |     **Example**                                                                               |
 775 +==========================+=====================================+=====================+===============================================================================================+
 776 |  swVersionToBeActivated  |     The software to be activated    |     Yes             |     "payload":                                                                                |
 777 |                          |                                     |                     |     "{\"swVersionToBeActivated\": \"v2\"}"                                                    |
 778 +--------------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
 779
 780 ActivateNESw Response
 781 ^^^^^^^^^^^^^^^^^^^^^^^^
 782
 783 **Success:** If the ActivateNESw runs successfully, it returns a success status code 400. The response payload contains the results of the activating.
 784
 785 Response Payload Parameters:
 786
 787 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
 788 | **Parameter**   |     **Description**         |     **Required?**   |     **Example**                                                                                                              |
 789 +=================+=============================+=====================+==============================================================================================================================+
 790 | result          |     Returns the result      |     Yes             |                                                                                                                              |
 791 |                 |     of the activate-n-e-sw. |                     |     "payload":                                                                                                               |
 792 |                 |     Indicates Success or    |                     |     "{\\"result\\": \\"Success\\"}”                                                                                          |
 793 |                 |     Failure.                |                     |                                                                                                                              |
 794 +-----------------+-----------------------------+---------------------+                                                                                                                              |
 795 | reason          |     If not Success,         |                     |                                                                                                                              |
 796 |                 |     reason contains         |                     |                                                                                                                              |
 797 |                 |     explanation.            |                     |                                                                                                                              |
 798 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
 799
 800 **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.
 801
 802 AttachVolume
 803 ------------
 804
 805 The AttachVolume command attaches a cinder volume to a VM via an Openstack command.
 806
 807 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.
 808
 809     NOTE: The command implementation is based on Openstack
 810     functionality. For further details, see
 811     http://developer.openstack.org/api-ref/compute/.
 812
 813 +--------------------------+----------------------------------------------------------+
 814 | **Target URL**           | /restconf/operations/appc-provider-lcm:attach-volume     |
 815 +--------------------------+----------------------------------------------------------+
 816 | **Action**               | AttachVolume                                             |
 817 +--------------------------+----------------------------------------------------------+
 818 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
 819 +--------------------------+----------------------------------------------------------+
 820 | **Payload Parameters**   | See table                                                |
 821 +--------------------------+----------------------------------------------------------+
 822 | **Revision History**     | New in Beijing                                           |
 823 +--------------------------+----------------------------------------------------------+
 824
 825 |
 826
 827 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 828 |     **Payload Parameter**   |     **Description**                                  |     **Required**   |     **Example**                                                                                                           |
 829 +=============================+======================================================+====================+===========================================================================================================================+
 830 | volumeId                    |     The UUID of the volume to attach.                | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803",                                                                   |
 831 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 832 | device                      |     The device identifier                            | Yes                |     "device": "/dev/vdb"                                                                                                  |
 833 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 834 | 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" |
 835 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 836 | Identity-url                |     The identity URL used to access the resource     | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                     |
 837 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
 838
 839 AttachVolume Response:
 840 ^^^^^^^^^^^^^^^^^^^^^^
 841
 842 Success: A successful AttachVolume returns a success status code 400.
 843
 844 Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include:
 845
 846 -  badRequest
 847 -  unauthorized
 848 -  forbidden
 849 -  itemNotFound
 850
 851
 852 Audit
 853 -----
 854
 855 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.
 856
 857 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
 858
 859 A failed Audit indicates that the configurations do not match.
 860
 861 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).
 862
 863 The Audit action does not require any payload parameters.
 864
 865 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
 866
 867
 868 +------------------------------+------------------------------------------------------+
 869 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:audit     |
 870 +------------------------------+------------------------------------------------------+
 871 |     **Action**               |     Audit                                            |
 872 +------------------------------+------------------------------------------------------+
 873 |     **Action-Identifiers**   |     vnf-id                                           |
 874 +------------------------------+------------------------------------------------------+
 875 |     **Payload Parameters**   |     See below                                        |
 876 +------------------------------+------------------------------------------------------+
 877 |     **Revision History**     |     Unchanged in this release.                       |
 878 +------------------------------+------------------------------------------------------+
 879
 880 |
 881
 882 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 883 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
 884 +======================+===========================================================================================================================================================+=====================+==================================+
 885 |     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>"   |
 886 |                      |                                                                                                                                                           |                     |                                  |
 887 |                      |     \* If the publish\-config field is set to N in the payload, then:                                                                                     |                     |                                  |
 888 |                      |                                                                                                                                                           |                     |                                  |
 889 |                      |     - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration                      |                     |                                  |
 890 |                      |                                                                                                                                                           |                     |                                  |
 891 |                      |     - If the result of the audit is ‘no match’, then send the running configuration                                                                       |                     |                                  |
 892 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
 893
 894 Audit Response
 895 ^^^^^^^^^^^^^^
 896
 897 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.
 898
 899
 900 CheckLock
 901 ---------
 902
 903 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
 904
 905 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.
 906
 907 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.
 908
 909 The CheckLock command returns a specific response structure that extends the default LCM response.
 910
 911 The CheckLock action does not require any payload parameters.
 912
 913 +------------------------------+--------------------------------------------------------+
 914 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:checklock   |
 915 +------------------------------+--------------------------------------------------------+
 916 |     **Action**               |     CheckLock                                          |
 917 +------------------------------+--------------------------------------------------------+
 918 |     **Action-Identifiers**   |     vnf-id                                             |
 919 +------------------------------+--------------------------------------------------------+
 920 |     **Payload Parameters**   |     None                                               |
 921 +------------------------------+--------------------------------------------------------+
 922 |     **Revision History**     |     Unchanged in this release.                         |
 923 +------------------------------+--------------------------------------------------------+
 924
 925 CheckLock Response
 926 ^^^^^^^^^^^^^^^^^^
 927
 928 The CheckLock command returns a customized version of the LCM
 929 response.
 930
 931
 932 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 933 |     **Parameter**   |     **Description**                                                                   |     **Required**   | **?Example**                    |
 934 +=====================+=======================================================================================+====================+=================================+
 935 |     locked          |     "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE.   |     No             |     "locked": "<TRUE\|FALSE>"   |
 936 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
 937
 938
 939 **Example**::
 940
 941     {
 942       "output": {
 943                   "status": {
 944                               "code": <RESULT_CODE>, "message": "<RESULT_MESSAGE>"
 945                             },
 946                   "common-header": {
 947                                      "api-ver": "<API_VERSION>",
 948                                      "request-id": "<ECOMP\_REQUEST_ID>", "originator-id":
 949                                      "<ECOMP_SYSTEM_ID>",
 950                                      "sub-request-id": "<ECOMP_SUBREQUEST_ID>", "timestamp":
 951                                      "2016-08-08T23:09:00.11Z",
 952                                      "flags": {
 953                                                 "ttl": <TTL_VALUE>, "force": "<TRUE|FALSE>",
 954                                                 "mode": "<EXCLUSIVE|NORMAL>"
 955                                               }
 956                                    },
 957                   "locked": "<TRUE|FALSE>"
 958     }
 959
 960
 961 Configure
 962 ---------
 963
 964 Configure a VNF or a VNFC on the VNF after instantiation.
 965
 966 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.
 967
 968 A successful Configure request returns a success response.
 969
 970 A failed Configure action returns a failure response and the specific failure messages in the response block.
 971
 972 +------------------------------+--------------------------------------------------------+
 973 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:configure   |
 974 +------------------------------+--------------------------------------------------------+
 975 |     **Action**               |     Configure                                          |
 976 +------------------------------+--------------------------------------------------------+
 977 |     **Action-Identifiers**   |     vnf-id                                             |
 978 +------------------------------+--------------------------------------------------------+
 979 |     **Payload Parameters**   |     See below                                          |
 980 +------------------------------+--------------------------------------------------------+
 981 |     **Revision History**     |     Unchanged in this release.                         |
 982 +------------------------------+--------------------------------------------------------+
 983
 984 |
 985
 986 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
 987 |     **Payload Parameter**       |     **Description**                                                                                                                                                                                            |     **Required?**   |     **Example**                                                 |
 988 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 989 +=================================+================================================================================================================================================================================================================+=====================+=================================================================+
 990 |     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              |                                                                 |
 991 |                                 |                                                                                                                                                                                                                |                     |     "payload":                                                  |
 992 |                                 |     vnfc-type:  must be included if template is vnfc specific                                                                                                                                                  |                     |     "{ \\"request-parameters                                    |
 993 |                                 |                                                                                                                                                                                                                |                     |     \\": {                                                      |
 994 |                                 |                                                                                                                                                                                                                |                     |     \\"vnf-host-ip-address\\":                                  |
 995 |                                 |                                                                                                                                                                                                                |                     |     \\”value\\”,                                                |
 996 |                                 |                                                                                                                                                                                                                |                     |     \\”vnfc-type\\”: \\”value\\”’                               |
 997 |                                 |                                                                                                                                                                                                                |                     |     }                                                           |
 998 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
 999 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1000 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1001 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1002 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1003 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1004 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1005 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1006 |                                 |                                                                                                                                                                                                                |                     |                                                                 |
1007 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1008 |     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>\\"}  |
1009 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1010
1011
1012 Configure Response
1013 ^^^^^^^^^^^^^^^^^^
1014
1015 The Configure response returns an indication of success or failure of the request.
1016
1017 **Success:** A successful Configure returns a success status code 400.
1018 **Failure:** A failed Configure returns a failure code 401 and the failure message.
1019
1020 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.
1021
1022 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.
1023
1024 ConfigModify
1025 ------------
1026
1027 Modifies the configuration on a VNF or VNFC in service.
1028
1029 This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook.
1030
1031 Request Structure:
1032
1033 +--------------------------+--------------------------------------------------------+
1034 | **Target URL**           | /restconf/operations/appc-provider-lcm:config-modify   |
1035 +--------------------------+--------------------------------------------------------+
1036 | **Action**               | ConfigModify                                           |
1037 +--------------------------+--------------------------------------------------------+
1038 | **Action-Identifiers**   | vnf-id                                                 |
1039 +--------------------------+--------------------------------------------------------+
1040 | **Payload Parameters**   | request-parameters, configuration-parameters           |
1041 +--------------------------+--------------------------------------------------------+
1042 | **Revision History**     | Unchanged in this release.                             |
1043 +--------------------------+--------------------------------------------------------+
1044
1045 Request Payload Parameters:
1046
1047 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
1048 | **Payload Parameter**   | **Description**                        | **Required?**   |     **Example**                                       |
1049 +=========================+========================================+=================+=======================================================+
1050 | request-parameters      | vnf-host-ip-address: optional if       | No              |     "payload":                                        |
1051 |                         | Netconf or other direct interface      |                 |     "{\\"request-parameters \\":                      |
1052 |                         | to the VNF. If not provided, it is     |                 |     {\\"vnf-host-ip-address\\": \\”value\\",          |
1053 |                         | obtained from A&AI                     |                 |     \\”vnfc-type\\”: \\”value\\”                      |
1054 |                         |                                        |                 |     }                                                 |
1055 |                         |                                        |                 |                                                       |
1056 |                         | vnfc-type: must be included if template|                 |                                                       |
1057 |                         | is vnfc specific                       |                 |                                                       |
1058 |                         |                                        |                 |     \\"configuration- parameters\\": {\\"name1\\":    |
1059 |                         |                                        |                 |     \\”value1\\”,\\"name2\\":                         |
1060 |                         |                                        |                 |     \\”value2\\”                                      |
1061 |                         |                                        |                 |     }                                                 |
1062 |                         |                                        |                 |     }                                                 |
1063 +-------------------------+----------------------------------------+-----------------+                                                       |
1064 | configuration-          | A set of instance specific             | No              |                                                       |
1065 | parameters              | configuration parameters should        |                 |                                                       |
1066 |                         | be specified.                          |                 |                                                       |
1067 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
1068
1069 ConfigModify Request
1070 ^^^^^^^^^^^^^^^^^^^^
1071
1072     Examples::
1073
1074               {
1075                      "input": {
1076                           "common-header": {
1077                               "timestamp": "2017-10-25T11:10:04.244Z",
1078                               "api-ver": "2.00",
1079                               "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1080                               "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1081                               "sub-request-id": "1",
1082                               "flags": {
1083                                   "force": "TRUE",
1084                                   "ttl": 60000
1085                               }
1086                           },
1087                           "action": "ConfigModify",
1088                           "action-identifiers": {
1089                               "vnf-id": "<VNF_ID>"
1090                           },
1091                           "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
1092                                         \"config-json\": \"{\"pg-streams\":{
1093                                         \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" },
1094                                         {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" },
1095                                         { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
1096                                         { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" },
1097                                         {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
1098                           }
1099                       }
1100              }
1101
1102
1103 ConfigModify Response
1104 ^^^^^^^^^^^^^^^^^^^^^
1105
1106 **Success:** A successful ConfigModify returns a success status code 400.
1107
1108 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.
1109
1110 **Failure:** A failed ConfigModify returns a failure code 401 and the failure message.
1111
1112 ConfigBackup
1113 ------------
1114
1115 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).
1116
1117 A successful ConfigBackup request returns a success response.
1118
1119 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
1120
1121 +------------------------------+-----------------------------------------------------------+
1122 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-backup  |
1123 +------------------------------+-----------------------------------------------------------+
1124 |     **Action**               |     ConfigBackup                                          |
1125 +------------------------------+-----------------------------------------------------------+
1126 |     **Action-Identifiers**   |     Vnf-id                                                |
1127 +------------------------------+-----------------------------------------------------------+
1128 |     **Payload Parameters**   |     See below                                             |
1129 +------------------------------+-----------------------------------------------------------+
1130 |     **Revision History**     |     Unchanged in this release.                            |
1131 +------------------------------+-----------------------------------------------------------+
1132
1133 |
1134
1135 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1136 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                   |
1137 +=================================+====================================================================================================================================================================================+=====================+===================================================================+
1138 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              | "payload": \\"configuration-parameters\\": {\\"<CONFIG-PARAMS>\\"}|
1139 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1140 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1141 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1142 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1143 |                                 |                                                                                                                                                                                    |                     |                                                                   |
1144 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                   |
1145 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                   |
1146 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1147
1148 ConfigBackup Response
1149 ^^^^^^^^^^^^^^^^^^^^^
1150
1151 The ConfigBackup response returns an indication of success or failure of the request.
1152
1153 **Success:** A successful ConfigBackup returns a success status code 400.
1154 **Failure:** A failed ConfigBackup returns a failure code 401 and the failure message.
1155
1156
1157 ConfigRestore
1158 -------------
1159
1160 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
1161
1162 A successful ConfigRestore request returns a success response.
1163
1164 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
1165
1166 +------------------------------+------------------------------------------------------------------------------------------+
1167 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:config-restore                                |
1168 +------------------------------+------------------------------------------------------------------------------------------+
1169 |     **Action**               |     ConfigRestore                                                                        |
1170 +------------------------------+------------------------------------------------------------------------------------------+
1171 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1172 +------------------------------+------------------------------------------------------------------------------------------+
1173 |     **Payload Parameters**   |     See below                                                                            |
1174 +------------------------------+------------------------------------------------------------------------------------------+
1175 |     **Revision History**     |     Unchanged in this release.                                                           |
1176 +------------------------------+------------------------------------------------------------------------------------------+
1177
1178 |
1179
1180 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1181 |     **Parameter**               |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
1182 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1183 |     request-parameters          |     Not used. This request is limited to Ansible and Chef only.                                                                                                                    |     No              |     "payload":                                                  |
1184 |                                 |                                                                                                                                                                                    |                     |     \\"configuration-parameters\\": {\\"<CONFIG- PARAMS>\\"}    |
1185 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                                                 |
1186 |     configuration-parameters    |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |                                                                 |
1187 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1188
1189 ConfigRestore Response
1190 ^^^^^^^^^^^^^^^^^^^^^^
1191
1192 **Success:** A successful ConfigRestore returns a success status code 400.
1193
1194 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.
1195
1196 **Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
1197
1198
1199 ConfigScaleIn
1200 -------------
1201
1202 The ConfigScaleIn command is used to apply any actions on a VNF as part of a ScaleIn flow. Actions could include updating the VNF configuration or running a set of other tasks.
1203
1204 The ConfigScaleIn 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.
1205 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.
1206
1207 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1208
1209 |
1210
1211 +------------------------------+------------------------------------------------------------------------------------------+
1212 |     **Target URL**           |     /restconf /operations/appc-provider-lcm:config-scale-in                              |
1213 +------------------------------+------------------------------------------------------------------------------------------+
1214 |     **Action**               |     ConfigScaleIn                                                                        |
1215 +------------------------------+------------------------------------------------------------------------------------------+
1216 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1217 +------------------------------+------------------------------------------------------------------------------------------+
1218 |     **Payload Parameters**   |     See below                                                                            |
1219 +------------------------------+------------------------------------------------------------------------------------------+
1220 |     **Revision History**     |     New in Frankfurt                                                                     |
1221 +------------------------------+------------------------------------------------------------------------------------------+
1222
1223 |
1224
1225 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1226 |     **Payload Parameter**       |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                             |
1227 +=================================+==================================================================================================================================================================+=====================+=============================================+
1228 |     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":                             |
1229 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      "{\\"request-parameters \\":           |
1230 |                                 |     vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleIn.                                                                        |     Yes             |      {                                      |
1231 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\"vnf-host-ip-address\\":             |
1232 |                                 |     controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleIn.                             |                     |      \\”value\\”,                           |
1233 |                                 |     Will be needed if A&AI does not contain the template identifier.                                                                                             |     No              |      \\”vf-module-id\\”: \\”value\\”,       |
1234 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\”controller-template-id\\”:          |
1235 |     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\\”                            |
1236 |                                 |     values supplied.                                                                                                                                             |                     |      }                                      |
1237 |                                 |                                                                                                                                                                  |                     |                                             |
1238 |                                 |                                                                                                                                                                  |                     |      \\"configuration-parameters\\":        |
1239 |                                 |                                                                                                                                                                  |                     |        {\\"<CONFIG- PARAMS>\\"}             |
1240 |                                 |                                                                                                                                                                  |                     |                                             |
1241 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1242
1243 ConfigScaleIn Response
1244 ^^^^^^^^^^^^^^^^^^^^^^
1245
1246 **Success:**
1247
1248  - A successful ConfigScaleIn returns a success status code 400 when completed.
1249
1250 **Failure:**
1251
1252  - A failed ConfigScaleIn returns a failure code 401 and the failure message.
1253  - If the ConfigScaleIn 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.
1254
1255
1256
1257 ConfigScaleOut
1258 --------------
1259
1260 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.
1261
1262 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.
1263 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.
1264
1265 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1266
1267 |
1268
1269 +------------------------------+------------------------------------------------------------------------------------------+
1270 |     **Target URL**           |     /restconf /operations/appc-provider-lcm:config-scale-out                             |
1271 +------------------------------+------------------------------------------------------------------------------------------+
1272 |     **Action**               |     ConfigScaleOut                                                                       |
1273 +------------------------------+------------------------------------------------------------------------------------------+
1274 |     **Action-Identifiers**   |     Vnf-id                                                                               |
1275 +------------------------------+------------------------------------------------------------------------------------------+
1276 |     **Payload Parameters**   |     See below                                                                            |
1277 +------------------------------+------------------------------------------------------------------------------------------+
1278 |     **Revision History**     |     New in Beijing                                                                       |
1279 +------------------------------+------------------------------------------------------------------------------------------+
1280
1281 |
1282
1283 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1284 |     **Payload Parameter**       |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                             |
1285 +=================================+==================================================================================================================================================================+=====================+=============================================+
1286 |     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":                             |
1287 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      "{\\"request-parameters \\":           |
1288 |                                 |     vf-module-id:  used to determine the A&AI VM inventory associated with ConfigScaleOut.                                                                       |     Yes             |      {                                      |
1289 |                                 +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\"vnf-host-ip-address\\":             |
1290 |                                 |     controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleOut.                            |                     |      \\”value\\”,                           |
1291 |                                 |     Will be needed if A&AI does not contain the template identifier.                                                                                             |     No              |      \\”vf-module-id\\”: \\”value\\”,       |
1292 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+      \\”controller-template-id\\”:          |
1293 |     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\\”                            |
1294 |                                 |     values supplied.                                                                                                                                             |                     |      }                                      |
1295 |                                 |                                                                                                                                                                  |                     |                                             |
1296 |                                 |                                                                                                                                                                  |                     |      \\"configuration-parameters\\":        |
1297 |                                 |                                                                                                                                                                  |                     |        {\\"<CONFIG- PARAMS>\\"}             |
1298 |                                 |                                                                                                                                                                  |                     |                                             |
1299 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1300
1301 ConfigScaleOut Response
1302 ^^^^^^^^^^^^^^^^^^^^^^^
1303
1304 **Success:**
1305
1306  - A successful ConfigScaleOut returns a success status code 400 when completed.
1307
1308 **Failure:**
1309
1310  - A failed ConfigScaleOut returns a failure code 401 and the failure message.
1311  - 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.
1312
1313
1314 DetachVolume
1315 ------------
1316
1317 The DetachVolume command detaches a cinder volume from a VM via an Openstack command.
1318
1319 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.
1320
1321 NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1322
1323 +--------------------------+----------------------------------------------------------+
1324 | **Target URL**           | /restconf/operations/appc-provider-lcm:detach-volume     |
1325 +--------------------------+----------------------------------------------------------+
1326 | **Action**               | DetachVolume                                             |
1327 +--------------------------+----------------------------------------------------------+
1328 | **Action-Identifiers**   | vnf-id, vserver-id                                       |
1329 +--------------------------+----------------------------------------------------------+
1330 | **Payload Parameters**   | See table                                                |
1331 +--------------------------+----------------------------------------------------------+
1332 | **Revision History**     | New in Beijing                                           |
1333 +--------------------------+----------------------------------------------------------+
1334
1335 Request Payload Parameters:
1336
1337 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1338 |     **Payload Parameter**   |     **Description**                                            |     **Required**   |     **Example**                                                                                                                |
1339 +=============================+================================================================+====================+================================================================================================================================+
1340 | volumeId                    |     The UUID of the volume to detach.                          | Yes                |     "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803"                                                                         |
1341 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1342 | 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"      |
1343 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1344 | Identity-url                |     The identity URL used to access the resource               | Yes                |     "identity-url": "http://135.25.246.162:5000/v2.0"                                                                          |
1345 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1346
1347 DetachVolume Response:
1348 ^^^^^^^^^^^^^^^^^^^^^^
1349
1350 **Success:** A successful DetachVolume returns a success status code 400.
1351
1352 **Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include:
1353
1354         -  badRequest
1355         -  unauthorized
1356         -  forbidden
1357         -  itemNotFound
1358         -  conflict
1359
1360 DistributeTraffic
1361 -----------------
1362
1363 The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
1364 The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
1365 realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
1366 including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
1367 Format of configuration file is specific to each VNF type. The Optimization Framework component and Homing, Allocation and
1368 Placement mechanism can be used to retrieve instances of vf-modules of anchor points and destination points with
1369 corresponding policies.
1370
1371 This command is executed using an Ansible playbook or Chef cookbook.
1372
1373 Request Structure:
1374
1375 +--------------------------+--------------------------------------------------------------+
1376 | **Target URL**           | /restconf/operations/appc-provider-lcm:distribute-traffic    |
1377 +--------------------------+--------------------------------------------------------------+
1378 | **Action**               | DistributeTraffic                                            |
1379 +--------------------------+--------------------------------------------------------------+
1380 | **Action-identifiers**   | vnf-id, vserver-id, vnfc-name                                |
1381 +--------------------------+--------------------------------------------------------------+
1382 | **Payload Parameters**   | See below                                                    |
1383 +--------------------------+--------------------------------------------------------------+
1384 | **Revision History**     | New in Casablanca                                            |
1385 +--------------------------+--------------------------------------------------------------+
1386
1387 Request Payload Parameters:
1388
1389 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1390 | **Parameter**                   |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                                                              |
1391 +=================================+==================================================================================================================================================================+=====================+==============================================================================+
1392 |     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\":      |
1393 |                                 |     values supplied. The parameters are associated with request template defined with CDT                                                                        |                     | \"{\\\"destinations\\\": [{\\\"locationType\\\": \\\"att_aic\\\",            |
1394 |                                 |                                                                                                                                                                  |                     | \\\"isRehome\\\": \\\"false\\\", \\\"aic_version\\\": \\\"1\\\",             |
1395 |                                 |                                                                                                                                                                  |                     | \\\"ipv4-oam-address\\\": \\\"\\\", \\\"nf-name\\\":                         |
1396 |                                 |                                                                                                                                                                  |                     | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"cloudOwner\\\":                      |
1397 |                                 |                                                                                                                                                                  |                     | \\\"CloudOwner\\\", \\\"service_instance_id\\\":                             |
1398 |                                 |                                                                                                                                                                  |                     | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\",                                |
1399 |                                 |                                                                                                                                                                  |                     | \\\"vf-module-id\\\": \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\",          |
1400 |                                 |                                                                                                                                                                  |                     | \\\"cloudClli\\\": \\\"clli1\\\", \\\"ipv6-oam-address\\\": \\\"\\\",        |
1401 |                                 |                                                                                                                                                                  |                     | \\\"vf-module-name\\\": \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\",         |
1402 |                                 |                                                                                                                                                                  |                     | \\\"vnfHostName\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"nf-id\\\":      |
1403 |                                 |                                                                                                                                                                  |                     | (...)                                                                        |
1404 |                                 |                                                                                                                                                                  |                     | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1-vfw_private_1_port-6yfzndtyjzfz\\\", |
1405 |                                 |                                                                                                                                                                  |                     | \\\"ipv4-addresses\\\": [\\\"192.168.20.100\\\"], \\\"interface-id\\\":      |
1406 |                                 |                                                                                                                                                                  |                     | \\\"0a1d0300-de02-46e8-99f6-e786f1ba407a\\\", \\\"network-name\\\":          |
1407 |                                 |                                                                                                                                                                  |                     | \\\"\\\", \\\"ipv6-addresses\\\": []}]}], \\\"nf-type\\\": \\\"vnf\\\"}]}\", |
1408 |                                 |                                                                                                                                                                  |                     | \"fixed_ip_address\": \"10.0.210.103\", \"book_name\":                       |
1409 |                                 |                                                                                                                                                                  |                     | \"vpgn/latest/ansible/distributetraffic/site.yml\",                          |
1410 |                                 |                                                                                                                                                                  |                     | \"ne_id\": \"vofwl01pgn4407\"}}",                                            |
1411 |                                 |                                                                                                                                                                  |                     |                                                                              |
1412 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1413
1414 Exemplary CDT template for Ansible protocol::
1415
1416     {
1417         "InventoryNames": "VM",
1418         "PlaybookName": "${()=(book_name)}",
1419         "NodeList": [{
1420             "vm-info": [{
1421                 "ne_id": "${()=(ne_id)}",
1422                 "fixed_ip_address": "${()=(fixed_ip_address)}"
1423             }],
1424             "site": "site",
1425             "vnfc-type": "some-vnfc"
1426         }],
1427         "EnvParameters": {
1428             "ConfigFileName": "../traffic_distribution_config.json",
1429             "vnf_instance": "instance",
1430         },
1431         "FileParameters": {
1432             "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1433         },
1434         "Timeout": 3600
1435     }
1436
1437 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1438 Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.
1439
1440 DistributeTraffic Response
1441 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1442
1443 The response does not include any payload parameters.
1444
1445 **Success:** A successful distribute returns a success status code 400 after all traffic has been distributed.
1446
1447 **Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1448
1449
1450 DistributeTrafficCheck
1451 ----------------------
1452
1453 The Distribute Traffic Check LCM action complements Distribute Traffic LCM action with capabilities to test if destination point
1454 is ready to handle traffic or if anchor point accepts the configuration of destinations for traffic distribution. Finally,
1455 this action can be used to check if destination points handle traffic accordingly with the configuration.
1456
1457 This command is executed using an Ansible playbook or Chef cookbook.
1458
1459 Request Structure:
1460
1461 +--------------------------+--------------------------------------------------------------------+
1462 | **Target URL**           | /restconf/operations/appc-provider-lcm:distribute-traffic-check    |
1463 +--------------------------+--------------------------------------------------------------------+
1464 | **Action**               | DistributeTrafficCheck                                             |
1465 +--------------------------+--------------------------------------------------------------------+
1466 | **Action-identifiers**   | vnf-id, vserver-id, vnfc-name                                      |
1467 +--------------------------+--------------------------------------------------------------------+
1468 | **Payload Parameters**   | See below                                                          |
1469 +--------------------------+--------------------------------------------------------------------+
1470 | **Revision History**     | New in Dublin                                                      |
1471 +--------------------------+--------------------------------------------------------------------+
1472
1473 Request Payload Parameters:
1474
1475 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1476 | **Parameter**                   |     **Description**                                                                                                                                              |     **Required?**   |     **Example**                                               |
1477 +=================================+==================================================================================================================================================================+=====================+===============================================================+
1478 |     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\":                   |
1479 |                                 |     values supplied. The parameters are associated with request template defined with CDT                                                                        |                     |  {\"file_parameter_content\": \"{\\\"destinations\\\":        |
1480 |                                 |                                                                                                                                                                  |                     |  [                                                            |
1481 |                                 |                                                                                                                                                                  |                     |  {\\\"locationType\\\": \\\"att_aic\\\",                      |
1482 |                                 |                                                                                                                                                                  |                     |  \\\"isRehome\\\": \\\"false\\\",                             |
1483 |                                 |                                                                                                                                                                  |                     |  \\\"aic_version\\\": \\\"1\\\",                              |
1484 |                                 |                                                                                                                                                                  |                     |  \\\"ipv4-oam-address\\\": \\\"\\\",                          |
1485 |                                 |                                                                                                                                                                  |                     |  \\\"nf-name\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\",         |
1486 |                                 |                                                                                                                                                                  |                     |  \\\"cloudOwner\\\": \\\"CloudOwner\\\",                      |
1487 |                                 |                                                                                                                                                                  |                     |  \\\"service_instance_id\\\":                                 |
1488 |                                 |                                                                                                                                                                  |                     |  \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\",                |
1489 |                                 |                                                                                                                                                                  |                     |  \\\"vf-module-id\\\":                                        |
1490 |                                 |                                                                                                                                                                  |                     |  \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\",                |
1491 |                                 |                                                                                                                                                                  |                     |  \\\"cloudClli\\\": \\\"clli1\\\",                            |
1492 |                                 |                                                                                                                                                                  |                     |  \\\"ipv6-oam-address\\\": \\\"\\\",                          |
1493 |                                 |                                                                                                                                                                  |                     |  \\\"vf-module-name\\\":                                      |
1494 |                                 |                                                                                                                                                                  |                     |  \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\",                 |
1495 |                                 |                                                                                                                                                                  |                     |  \\\"vnfHostName\\\":                                         |
1496 |                                 |                                                                                                                                                                  |                     |  \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\",                          |
1497 |                                 |                                                                                                                                                                  |                     |  \\\"nf-id\\\": \\\"909d396b-4d99-4c6a-a59b-abe948873303\\\", |
1498 |                                 |                                                                                                                                                                  |                     |  (...)                                                        |
1499 |                                 |                                                                                                                                                                  |                     |  \\\"trafficPresence\\\": true}\",                            |
1500 |                                 |                                                                                                                                                                  |                     |  \"fixed_ip_address\": \"10.0.110.1\", \"book_name\":         |
1501 |                                 |                                                                                                                                                                  |                     |  \"vfw-sink/latest/ansible/distributetrafficcheck/site.yml\", |
1502 |                                 |                                                                                                                                                                  |                     |  \"ne_id\": \"vofwl02vfw4407\"}}"                             |
1503 |                                 |                                                                                                                                                                  |                     |                                                               |
1504 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1505
1506 Exemplary CDT template for Ansible protocol::
1507
1508     {
1509         "InventoryNames": "VM",
1510         "PlaybookName": "${()=(book_name)}",
1511         "NodeList": [{
1512             "vm-info": [{
1513                 "ne_id": "${()=(ne_id)}",
1514                 "fixed_ip_address": "${()=(fixed_ip_address)}"
1515             }],
1516             "site": "site",
1517             "vnfc-type": "some-vnfc"
1518         }],
1519         "EnvParameters": {
1520             "ConfigFileName": "../traffic_distribution_config.json",
1521             "vnf_instance": "instance",
1522         },
1523         "FileParameters": {
1524             "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1525         },
1526         "Timeout": 3600
1527     }
1528
1529 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1530 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
1531 be performed. In the payload example there is a trafficPresence parameter that emphasises if the traffic is expected on vFW instance.
1532
1533 DistributeTrafficCheck Response
1534 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1535
1536 The response does not include any payload parameters.
1537
1538 **Success:** A successful distribute traffic check returns a success status code 400 when conditions are satisfied.
1539
1540 **Failure:** A failed check returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1541
1542
1543 DownloadNESw
1544 ---------------
1545
1546 The DownloadNESw LCM action downloads the target software needed for a software upgrade.
1547
1548 This command is executed using an Ansible playbook or Chef cookbook.
1549
1550 Request Structure:
1551
1552 +--------------------------+------------------------------------------------------------+
1553 | **Target URL**           | /restconf/operations/appc-provider-lcm:download-n-e-sw     |
1554 +--------------------------+------------------------------------------------------------+
1555 | **Action**               | DownloadNESw                                               |
1556 +--------------------------+------------------------------------------------------------+
1557 | **Action-identifiers**   | vnf-id                                                     |
1558 +--------------------------+------------------------------------------------------------+
1559 | **Payload Parameters**   | See below                                                  |
1560 +--------------------------+------------------------------------------------------------+
1561 | **Revision History**     | New in Frankfurt                                           |
1562 +--------------------------+------------------------------------------------------------+
1563
1564 Request Payload Parameters:
1565
1566 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1567 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
1568 +=======================+=====================================+=====================+===============================================================================================+
1569 | swToBeDownloaded      |     The software to be downloaded   |     Yes             |     "payload":                                                                                |
1570 |                       |                                     |                     |     "{\"swToBeDownloaded\": \"\\\\'[{\\\\\\\"swLocation\\\\\\\":                              |
1571 |                       |                                     |                     |      \\\\\\\"http://192.168.1.10:10080/ran_du_pkg1-v2.zip\\\\\\\"}]\\\\'\"}"                  |
1572 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
1573
1574 DownloadNESw Response
1575 ^^^^^^^^^^^^^^^^^^^^^^^^
1576
1577 **Success:** If the DownloadNESw runs successfully, it returns a success status code 400. The response payload contains the results of the downloading.
1578
1579 Response Payload Parameters:
1580
1581 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
1582 | **Parameter**   |     **Description**         |     **Required?**   |     **Example**                                                                                                              |
1583 +=================+=============================+=====================+==============================================================================================================================+
1584 | result          |     Returns the result      |     Yes             |                                                                                                                              |
1585 |                 |     of the download-n-e-sw. |                     |     "payload":                                                                                                               |
1586 |                 |     Indicates Success or    |                     |     "{\\"result\\": \\"Success\\"}”                                                                                          |
1587 |                 |     Failure.                |                     |                                                                                                                              |
1588 +-----------------+-----------------------------+---------------------+                                                                                                                              |
1589 | reason          |     If not Success,         |                     |                                                                                                                              |
1590 |                 |     reason contains         |                     |                                                                                                                              |
1591 |                 |     explanation.            |                     |                                                                                                                              |
1592 +-----------------+-----------------------------+---------------------+------------------------------------------------------------------------------------------------------------------------------+
1593
1594 **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.
1595
1596
1597 Evacuate
1598 --------
1599
1600 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).
1601
1602 The host on which the VM resides needs to be down.
1603
1604 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.
1605
1606 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm` parameter to false.
1607
1608 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
1609
1610 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1611
1612 +------------------------------+-------------------------------------------------------------------------+
1613 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:evacuate                     |
1614 +------------------------------+-------------------------------------------------------------------------+
1615 |     **Action**               |     Evacuate                                                            |
1616 +------------------------------+-------------------------------------------------------------------------+
1617 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                  |
1618 +------------------------------+-------------------------------------------------------------------------+
1619 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id, rebuild-vm, targethost-id           |
1620 +------------------------------+-------------------------------------------------------------------------+
1621 |     **Revision History**     |     Unchanged in this release.                                          |
1622 +------------------------------+-------------------------------------------------------------------------+
1623
1624 |
1625
1626 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1627 |     **Parameter**    |     **Description**                                                                                                                                                              |     **Required?**   |     **Example**                       |
1628 +======================+==================================================================================================================================================================================+=====================+=======================================+
1629 |     vm-id            |     The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self-link URL of the VM.                                                         |     Yes             |     "payload":                        |
1630 |                      |                                                                                                                                                                                  |                     |     "{\\"vm-id\\": \\"<VM-ID>         |
1631 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1632 |                      |                                                                                                                                                                                  |                     |     \\"identity-url\\":               |
1633 |                      |                                                                                                                                                                                  |                     |     \\"<IDENTITY-URL>\\",             |
1634 |                      |                                                                                                                                                                                  |                     |     \\"tenant-id\\": \\"<TENANT-ID>   |
1635 |                      |                                                                                                                                                                                  |                     |     \\",                              |
1636 |                      |                                                                                                                                                                                  |                     |     \\"rebuild-vm\\": \\"false\\",    |
1637 |                      |                                                                                                                                                                                  |                     |     \\"targethost-id\\":              |
1638 |                      |                                                                                                                                                                                  |                     |     \\"nodeblade7\\"}"                |
1639 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1640 |     identity-url     |     The identity URL used to access the resource                                                                                                                                 |     Yes             |                                       |
1641 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1642 |     tenant-id        |     The id of the provider tenant that owns the resource                                                                                                                         |     Yes             |                                       |
1643 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1644 |     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              |                                       |
1645 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+                                       |
1646 |     targethost- id   |     A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host.                                                              |     No              |                                       |
1647 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1648
1649 Evacuate Response:
1650 ^^^^^^^^^^^^^^^^^^
1651 **Success:** A successful Evacuate returns a success status code 400.
1652 **Failure:** A failed Evacuate returns a failure code 401 and the failure message.
1653
1654
1655 GetConfig
1656 ---------
1657
1658 GetConfig LCM action for the MVM VNF types using the GetConfig playbook
1659 to retrieve the current config. This is limited to Ansible.
1660
1661 A successful GetConfig request returns a success response.
1662
1663 A failed GetConfig action returns a failure response code and the
1664 specific failure message in the response block.
1665
1666
1667 ====================== =================================================
1668 **Target URL**         /restconf/operations/appc-provider-lcm: GetConfig
1669 ====================== =================================================
1670 **Action**             GetConfig
1671 **Action-Identifiers** vnf-id
1672 **Payload Parameters** See table
1673 **Revision History**   New in Frankfurt
1674 ====================== =================================================
1675
1676 ========================= ========================================================================================================= ============= ======================================================================================================
1677 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1678 ========================= ========================================================================================================= ============= ======================================================================================================
1679 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
1680
1681                                                                                                                                                   "payload": "{}"
1682 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1683 ========================= ========================================================================================================= ============= ======================================================================================================
1684
1685 GetConfig Response:
1686 ~~~~~~~~~~~~~~~~~~~
1687
1688 Success: A successful GetConfig returns a success status code 400.
1689
1690 Failure: A failed GetConfig returns a failure code 401 and the failure
1691 message.
1692
1693
1694 HealthCheck
1695 -----------
1696
1697 This command runs a VNF health check and returns the result.
1698
1699 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.
1700
1701
1702 +------------------------------+-----------------------------------------------------------+
1703 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:health-check   |
1704 +------------------------------+-----------------------------------------------------------+
1705 |     **Action**               |     HealthCheck                                           |
1706 +------------------------------+-----------------------------------------------------------+
1707 |     **Action-Identifiers**   |     Vnf-id                                                |
1708 +------------------------------+-----------------------------------------------------------+
1709 |     **Payload Parameters**   |     See below                                             |
1710 +------------------------------+-----------------------------------------------------------+
1711 |     **Revision History**     |     Unchanged in this release                             |
1712 +------------------------------+-----------------------------------------------------------+
1713
1714
1715 Request Payload Parameters:
1716
1717 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1718 |     **Parameter**   |     **Description**               |     **Required?**   |     **Example**                     |
1719 +=====================+===================================+=====================+=====================================+
1720 | request-parameters  |     host-ip-address -             |     No              |  "payload":                         |
1721 |                     |     Required only if REST         |                     |  "{\\"request-parameters \\":       |
1722 |                     |     service. This is the ip       |                     |  "{\\"host-ip-address\\":           |
1723 |                     |     address associated with the   |                     |  \\"10.222.22.2\\" }"               |
1724 |                     |     VM running the REST           |                     |                                     |
1725 |                     |     service.                      |                     |                                     |
1726 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1727
1728
1729 HealthCheck Response
1730 ^^^^^^^^^^^^^^^^^^^^
1731
1732 **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.
1733
1734     Examples::
1735
1736                 {
1737                   "identifier": "scope represented",
1738                   "state": "healthy",
1739                   "time": "01-01-1000:0000"
1740
1741                 }
1742
1743                 {
1744                    "identifier": "scope represented",
1745                    "state": "unhealthy",
1746                         {[
1747                    "info": "System threshold exceeded details",
1748                    "fault":
1749                          {
1750                            "cpuOverall": 0.80,
1751                            "cpuThreshold": 0.45
1752                          }
1753                         ]},
1754                    "time": "01-01-1000:0000"
1755                 }
1756
1757 **Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
1758
1759 LicenseManagement
1760 -----------------
1761
1762 For LicenseManagement LCM action, invoke the LicenseManagement playbook.
1763 This is limited to Ansible.
1764
1765 A successful LicenseManagement request returns a success response.
1766
1767 A failed LicenseManagement action returns a failure response code and
1768 the specific failure message in the response block.
1769
1770
1771 ====================== ========================================================
1772 **Target URL**         /restconf/operations/appc-provider-lcm:LicenseManagement
1773 ====================== ========================================================
1774 **Action**             LicenseManagement
1775 **Action-Identifiers** vnf-id
1776 **Payload Parameters** See below
1777 **Revision History**   New in Frankfurt
1778 ====================== ========================================================
1779
1780 ========================= ========================================================================================================= ============= ======================================================================================================================
1781 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1782 ========================= ========================================================================================================= ============= ======================================================================================================================
1783 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "LicenseManagement",
1784
1785                                                                                                                                                   "action-identifiers": {
1786
1787                                                                                                                                                   "vnf-id": "rarf9901v"
1788
1789                                                                                                                                                   },
1790
1791                                                                                                                                                   "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\",\"license_action\":\"update\"}}" ---
1792
1793                                                                                                                                                   license_action can have any of these values ={ upload \| add \| install \| update \| renew \| delete \| revoke \| … }:
1794 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1795 ========================= ========================================================================================================= ============= ======================================================================================================================
1796
1797 LicenseManagement Response\ **:**
1798 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1799
1800 Success: A successful LicenseManagement returns a success status code
1801 400.
1802
1803 Failure: A failed LicenseManagement returns a failure code 401 and the
1804 failure message.
1805
1806
1807
1808
1809 Lock
1810 ----
1811
1812 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1813
1814 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.
1815
1816 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.
1817
1818 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.
1819
1820 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.
1821
1822 The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file
1823
1824 +------------------------------+---------------------------------------------------+
1825 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:lock   |
1826 +------------------------------+---------------------------------------------------+
1827 |     **Action**               |     Lock                                          |
1828 +------------------------------+---------------------------------------------------+
1829 |     **Action-Identifier**    |     Vnf-id                                        |
1830 +------------------------------+---------------------------------------------------+
1831 |     **Payload Parameters**   |     None                                          |
1832 +------------------------------+---------------------------------------------------+
1833 |     **Revision History**     |     Unchanged in this release.                    |
1834 +------------------------------+---------------------------------------------------+
1835
1836 Lock Response
1837 ^^^^^^^^^^^^^
1838
1839 The Lock returns a 400 Success response if the Lock is successfully applied.
1840
1841 The Lock returns a 401 Failure response with the failure message if the Lock is not successful.
1842
1843
1844 Migrate
1845 -------
1846
1847 Migrates a running target VM from its current host to another.
1848
1849 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1850
1851 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.
1852
1853 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.
1854
1855
1856 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1857
1858
1859 +--------------------------------+-----------------------------------------------------------------------------------------------+
1860 | **Input Block**                | api-ver should be set to 2.00 for current version of Migrate                                  |
1861 +--------------------------------+-----------------------------------------------------------------------------------------------+
1862 |     **Target URL**             |     /restconf/operations/appc-provider-lcm:migrate                                            |
1863 +--------------------------------+-----------------------------------------------------------------------------------------------+
1864 |     **Action**                 |     Migrate                                                                                   |
1865 +--------------------------------+-----------------------------------------------------------------------------------------------+
1866 |     **Action-Identifiers**     |     Vnf-id, vserver-id                                                                        |
1867 +--------------------------------+-----------------------------------------------------------------------------------------------+
1868 |     **Payload Parameters**     |     vm-id, identity-url, tenant-id                                                            |
1869 +--------------------------------+-----------------------------------------------------------------------------------------------+
1870 |     **Revision History**       |     Unchanged in this release.                                                                |
1871 +--------------------------------+-----------------------------------------------------------------------------------------------+
1872
1873 Payload Parameters
1874
1875 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1876 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                               |
1877 +=====================+=========================================================================+=====================+===============================================+
1878 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                               |
1879 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                               |
1880 |                     |     link URL of the VM.                                                 |                     |     "payload":                                |
1881 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",             |
1882 |                     |                                                                         |                     |     \\"identity-url\\":                       |
1883 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",                     |
1884 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"tenant-id\\": \\"<TENANT-ID>\\"}"      |
1885 |     identity- url   |     The identity url used to access the resource                        |     Yes             |                                               |
1886 |                     |                                                                         |                     |                                               |
1887 +---------------------+-------------------------------------------------------------------------+---------------------+                                               |
1888 |     tenant-id       |     The id of the provider tenant that owns the resource                |     Yes             |                                               |
1889 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1890
1891
1892 Migrate Response
1893 ^^^^^^^^^^^^^^^^
1894
1895 **Success:** A successful Migrate returns a success status code 400.
1896
1897 **Failure:** A failed Migrate returns a failure code 401 and the failure message.
1898
1899
1900 PostEvacuate
1901 -------------
1902
1903 PostEvacuate LCM action using the PostEvacuate playbook. This is limited
1904 to Ansible.
1905
1906 A successful PostEvacuate request returns a success response.
1907
1908 A failed PostEvacuate action returns a failure response code and the
1909 specific failure message in the response block.
1910
1911 ====================== ====================================================
1912 **Target URL**         /restconf/operations/appc-provider-lcm: PostEvacuate
1913 ====================== ====================================================
1914 **Action**             PostEvacuate
1915 **Action-Identifiers** vnf-id
1916 **Payload Parameters** See table
1917 **Revision History**   New in Frankfurt
1918 ====================== ====================================================
1919
1920 ========================= ========================================================================================================= ============= =====================================================================================================
1921 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1922 ========================= ========================================================================================================= ============= =====================================================================================================
1923 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1924 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1925 ========================= ========================================================================================================= ============= =====================================================================================================
1926
1927 PostEvacuate Response:
1928 ~~~~~~~~~~~~~~~~~~~~~~
1929
1930 Success: A successful PostEvacuate returns a success status code 400.
1931
1932 Failure: A failed PostEvacuate returns a failure code 401 and the
1933 failure message.
1934
1935
1936 PostMigrate
1937 -----------
1938
1939 PostMigrate LCM action using the PostMigrate playbook. This is limited
1940 to Ansible.
1941
1942 A successful PostMigrate request returns a success response.
1943
1944 A failed PostMigrate action returns a failure response code and the
1945 specific failure message in the response block.
1946
1947
1948 ====================== ===================================================
1949 **Target URL**         /restconf/operations/appc-provider-lcm: PostMigrate
1950 ====================== ===================================================
1951 **Action**             PostMigrate
1952 **Action-Identifiers** vnf-id
1953 **Payload Parameters** See below
1954 **Revision History**   New in Frankfurt
1955 ====================== ===================================================
1956
1957 ========================= ========================================================================================================= ============= =====================================================================================================
1958 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1959 ========================= ========================================================================================================= ============= =====================================================================================================
1960 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1961 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1962 ========================= ========================================================================================================= ============= =====================================================================================================
1963
1964 PostMigrate Response:
1965 ~~~~~~~~~~~~~~~~~~~~~
1966
1967 Success: A successful PostMigrate returns a success status code 400.
1968
1969 Failure: A failed PostMigrate returns a failure code 401 and the failure
1970 message.
1971
1972
1973
1974 PostRebuild
1975 -----------
1976
1977 PostRebuild LCM action using the PostRebuild playbook. This is limited
1978 to Ansible.
1979
1980 A successful PostRebuild request returns a success response.
1981
1982 A failed PostRebuild action returns a failure response code and the
1983 specific failure message in the response block.
1984
1985 ====================== ===================================================
1986 **Target URL**         /restconf/operations/appc-provider-lcm: PostRebuild
1987 ====================== ===================================================
1988 **Action**             PostRebuild
1989 **Action-Identifiers** vnf-id
1990 **Payload Parameters** See table
1991 **Revision History**   New in Frankfurt
1992 ====================== ===================================================
1993
1994 ========================= ========================================================================================================= ============= =====================================================================================================
1995 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
1996 ========================= ========================================================================================================= ============= =====================================================================================================
1997 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1998 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1999 ========================= ========================================================================================================= ============= =====================================================================================================
2000
2001 PostRebuild Response:
2002 ~~~~~~~~~~~~~~~~~~~~~
2003
2004 Success: A successful PostRebuild returns a success status code 400.
2005
2006 Failure: A failed PostRebuild returns a failure code 401 and the failure
2007 message.
2008
2009
2010 PreConfig
2011 ---------
2012
2013 PreConfig LCM action for the MVM VNF types using the PreConfigure
2014 playbook. This is limited to Ansible.
2015
2016 A successful PreConfig request returns a success response.
2017
2018 A failed PreConfig action returns a failure response code and the
2019 specific failure message in the response block.
2020
2021
2022 ====================== =================================================
2023 **Target URL**         /restconf/operations/appc-provider-lcm: PreConfig
2024 ====================== =================================================
2025 **Action**             PreConfig
2026 **Action-Identifiers** vnf-id
2027 **Payload Parameters** See table
2028 **Revision History**   New in Frankfurt
2029 ====================== =================================================
2030
2031 ========================= ========================================================================================================= ============= ======================================================================================================
2032 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2033 ========================= ========================================================================================================= ============= ======================================================================================================
2034 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
2035
2036                                                                                                                                                   "payload": "{}"
2037 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2038 ========================= ========================================================================================================= ============= ======================================================================================================
2039
2040 PreConfig Response:
2041 -------------------
2042
2043 Success: A successful PreConfig returns a success status code 400.
2044
2045 Failure: A failed PreConfig returns a failure code 401 and the failure
2046 message.
2047
2048 PreEvacuate
2049 ------------
2050
2051 PreEvacuate LCM action using the PreEvacuate playbook. This is limited
2052 to Ansible.
2053
2054 A successful PreEvacuate request returns a success response.
2055
2056 A failed PreEvacuate action returns a failure response code and the
2057 specific failure message in the response block.
2058
2059
2060 ====================== ===================================================
2061 **Target URL**         /restconf/operations/appc-provider-lcm: PreEvacuate
2062 ====================== ===================================================
2063 **Action**             PreEvacuate
2064 **Action-Identifiers** vnf-id
2065 **Payload Parameters** See table
2066 **Revision History**   New in Frankfurt
2067 ====================== ===================================================
2068
2069 ========================= ========================================================================================================= ============= =====================================================================================================
2070 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2071 ========================= ========================================================================================================= ============= =====================================================================================================
2072 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2073 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2074 ========================= ========================================================================================================= ============= =====================================================================================================
2075
2076 PreEvacuate Response:
2077 ~~~~~~~~~~~~~~~~~~~~~
2078
2079 Success: A successful PreEvacuate returns a success status code 400.
2080
2081 Failure: A failed PreEvacuate returns a failure code 401 and the failure
2082 message.
2083
2084 PreMigrate
2085 ----------
2086
2087 PreMigrate LCM action using the PreMigrate playbook. This is limited to
2088 Ansible.
2089
2090 A successful PreMigrate request returns a success response.
2091
2092 A failed PreMigrate action returns a failure response code and the
2093 specific failure message in the response block.
2094
2095 ====================== ==================================================
2096 **Target URL**         /restconf/operations/appc-provider-lcm: PreMigrate
2097 ====================== ==================================================
2098 **Action**             PreMigrate
2099 **Action-Identifiers** vnf-id
2100 **Payload Parameters** See table
2101 **Revision History**   New in Frankfurt
2102 ====================== ==================================================
2103
2104 ========================= ========================================================================================================= ============= =====================================================================================================
2105 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2106 ========================= ========================================================================================================= ============= =====================================================================================================
2107 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2108 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2109 ========================= ========================================================================================================= ============= =====================================================================================================
2110
2111 PreMigrate Response:
2112 ~~~~~~~~~~~~~~~~~~~~
2113
2114 Success: A successful PreMigrate returns a success status code 400.
2115
2116 Failure: A failed PreMigrate returns a failure code 401 and the failure
2117 message.
2118
2119
2120 PreRebuild
2121 ----------
2122
2123 PreRebuild LCM action using the PreRebuild playbook. This is limited to
2124 Ansible.
2125
2126 A successful PreRebuild request returns a success response.
2127
2128 A failed PreRebuild action returns a failure response code and the
2129 specific failure message in the response block.
2130
2131
2132 ====================== ==================================================
2133 **Target URL**         /restconf/operations/appc-provider-lcm: PreRebuild
2134 ====================== ==================================================
2135 **Action**             PreRebuild
2136 **Action-Identifiers** vnf-id
2137 **Payload Parameters** See table
2138 **Revision History**   New in Frankfurt
2139 ====================== ==================================================
2140
2141 ========================= ========================================================================================================= ============= =====================================================================================================
2142 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2143 ========================= ========================================================================================================= ============= =====================================================================================================
2144 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
2145 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2146 ========================= ========================================================================================================= ============= =====================================================================================================
2147
2148 PreRebuild Response:
2149 ~~~~~~~~~~~~~~~~~~~~
2150
2151 Success: A successful PreRebuild returns a success status code 400.
2152
2153 Failure: A failed PreRebuild returns a failure code 401 and the failure
2154 message.
2155
2156
2157 Provisioning
2158 ------------
2159
2160 For Provisioning LCM action, invoke the Provisioning playbook. This is
2161 limited to Ansible.
2162
2163 A successful Provisioning request returns a success response.
2164
2165 A failed Provisioning action returns a failure response code and the
2166 specific failure message in the response block.
2167
2168
2169 ====================== ===================================================
2170 **Target URL**         /restconf/operations/appc-provider-lcm:Provisioning
2171 ====================== ===================================================
2172 **Action**             Provisioning
2173 **Action-Identifiers** vnf-id
2174 **Payload Parameters** See table
2175 **Revision History**   New in Frankfurt
2176 ====================== ===================================================
2177
2178 ========================= ========================================================================================================= ============= =========================
2179 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2180 ========================= ========================================================================================================= ============= =========================
2181 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "Provisioning",
2182
2183                                                                                                                                                   "action-identifiers": {
2184
2185                                                                                                                                                   "vnf-id": "rarf9901v"
2186
2187                                                                                                                                                   },
2188
2189                                                                                                                                                   "payload": "{}"
2190 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2191 ========================= ========================================================================================================= ============= =========================
2192
2193 Provisioning Response\ **:**
2194 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2195
2196 Success: A successful Provisioning returns a success status code 400.
2197
2198 Failure: A failed Provisioning returns a failure code 401 and the
2199 failure message.
2200
2201
2202
2203 QuiesceTraffic
2204 --------------
2205
2206 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.
2207
2208 This command is executed using an Ansible playbook or Chef cookbook.
2209
2210 Request Structure:
2211
2212 +--------------------------+----------------------------------------------------------+
2213 | **Target URL**           | /restconf/operations/appc-provider-lcm:quiesce-traffic   |
2214 +--------------------------+----------------------------------------------------------+
2215 | **Action**               | QuiesceTraffic                                           |
2216 +--------------------------+----------------------------------------------------------+
2217 | **Action-identifiers**   | vnf-id                                                   |
2218 +--------------------------+----------------------------------------------------------+
2219 | **Payload Parameters**   | operations-timeout                                       |
2220 +--------------------------+----------------------------------------------------------+
2221 | **Revision History**     | New in Beijing                                           |
2222 +--------------------------+----------------------------------------------------------+
2223
2224 Request Payload Parameters:
2225
2226 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2227 | **Parameter**         |     **Description**                                                                                                                                                                                  |     **Required?**   |     **Example**                                |
2228 +=======================+======================================================================================================================================================================================================+=====================+================================================+
2229 | 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":                                 |
2230 |                       |                                                                                                                                                                                                      |                     |     "{\\"operations-timeout\\": \\"3600\\"}”   |
2231 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2232
2233 QuiesceTraffic Response
2234 ^^^^^^^^^^^^^^^^^^^^^^^
2235
2236 The response does not include any payload parameters.
2237
2238 **Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced.
2239
2240    If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status.
2241
2242 **Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2243
2244     A specific error message is returned if there is a timeout error.
2245
2246 Reboot
2247 -------
2248
2249 The Reboot is used to reboot a VM.
2250
2251
2252 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.
2253
2254 **NOTE:** The command implementation is based on OpenStack functionality.  For further details, see http://developer.openstack.org/api-ref/compute/.
2255
2256 +------------------------------+-----------------------------------------------------------------------------------------------+
2257 | **Input Block**              | api-ver should be set to 2.00 for current version of Reboot                                   |
2258 +------------------------------+-----------------------------------------------------------------------------------------------+
2259 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:reboot                                             |
2260 +------------------------------+-----------------------------------------------------------------------------------------------+
2261 |     **Action**               |     Reboot                                                                                    |
2262 +------------------------------+-----------------------------------------------------------------------------------------------+
2263 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
2264 +------------------------------+-----------------------------------------------------------------------------------------------+
2265 |     **Payload Parameters**   |     See table below                                                                           |
2266 +------------------------------+-----------------------------------------------------------------------------------------------+
2267 |     **Revision History**     |     New in R3 release.                                                                        |
2268 +------------------------------+-----------------------------------------------------------------------------------------------+
2269
2270 Payload Parameters
2271
2272 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2273 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2274 +=================+===============================================+=================+=========================================+
2275 | type            |     The type of reboot.  Values are           | No              |                                         |
2276 |                 |     HARD and SOFT.  If not                    |                 |                                         |
2277 |                 |     specified, SOFT reboot is                 |                 | "payload":                              |
2278 |                 |     performed.                                |                 | "{\\"type\\": \\"HARD\\",               |
2279 |                 |                                               |                 |   \\"vm-id\\": \\"<VM-ID>\\",           |
2280 |                 |                                               |                 | \\"identity-url\\":                     |
2281 |                 |                                               |                 | \\"<IDENTITY-URL>\\"                    |
2282 |                 |                                               |                 | }"                                      |
2283 +-----------------+-----------------------------------------------+-----------------+                                         |
2284 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2285 |                 |     the resource. For backwards-              |                 |                                         |
2286 |                 |     compatibility, this can be the self-      |                 |                                         |
2287 |                 |     link URL of the VM.                       |                 |                                         |
2288 |                 |                                               |                 |                                         |
2289 |                 |                                               |                 |                                         |
2290 |                 |                                               |                 |                                         |
2291 |                 |                                               |                 |                                         |
2292 +-----------------+-----------------------------------------------+-----------------+                                         |
2293 | identity-url    |     The identity url used to access the       | Yes             |                                         |
2294 |                 |     resource.                                 |                 |                                         |
2295 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2296
2297 Reboot Response
2298 ^^^^^^^^^^^^^^^
2299
2300 **Success:** A successful Rebuild returns a success status code 400.
2301
2302 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2303
2304 Rebuild
2305 -------
2306
2307 Recreates a target VM instance to a known, stable state.
2308
2309 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
2310
2311 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.
2312
2313 APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume
2314
2315
2316 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2317
2318
2319 +------------------------------+-----------------------------------------------------------------------------------------------+
2320 | **Input Block**              | api-ver should be set to 2.00 for current version of Rebuild                                  |
2321 +------------------------------+-----------------------------------------------------------------------------------------------+
2322 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:rebuild                                            |
2323 +------------------------------+-----------------------------------------------------------------------------------------------+
2324 |     **Action**               |     Rebuild                                                                                   |
2325 +------------------------------+-----------------------------------------------------------------------------------------------+
2326 |     **Action-identifiers**   |     Vnf-id, vserver-id                                                                        |
2327 +------------------------------+-----------------------------------------------------------------------------------------------+
2328 |     **Payload Parameters**   |     See table below                                                                           |
2329 +------------------------------+-----------------------------------------------------------------------------------------------+
2330 |     **Revision History**     |     Unchanged in this release.                                                                |
2331 +------------------------------+-----------------------------------------------------------------------------------------------+
2332
2333
2334 Payload Parameters
2335
2336 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2337 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2338 +=================+===============================================+=================+=========================================+
2339 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2340 |                 |     the resource. For backwards-              |                 |                                         |
2341 |                 |     compatibility, this can be the self-      |                 | "payload":                              |
2342 |                 |     link URL of the VM.                       |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2343 |                 |                                               |                 | \\",                                    |
2344 |                 |                                               |                 | \\"identity-url\\":                     |
2345 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2346 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2347 +-----------------+-----------------------------------------------+-----------------+ \\"snapshot-id\\": \\"<SNAPSHOT- ID>\\" |
2348 | identity- url   |     The identity url used to access the       | Yes             | }"                                      |
2349 |                 |     resource.                                 |                 |                                         |
2350 +-----------------+-----------------------------------------------+-----------------+                                         |
2351 | tenant-id       |     The id of the provider tenant that owns   | Yes             |                                         |
2352 |                 |     the resource.                             |                 |                                         |
2353 +-----------------+-----------------------------------------------+-----------------+                                         |
2354 | snapshot-id     |  The snapshot-id of a previously saved image. | No              |                                         |
2355 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2356
2357 Rebuild Response
2358 ^^^^^^^^^^^^^^^^
2359
2360 **Success:** A successful Rebuild returns a success status code 400.
2361
2362 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2363
2364 Restart
2365 -------
2366
2367 Use the Restart command to restart a VM.
2368
2369 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2370 |     **Input Block**          |     api-ver should be set to 2.00 for current version of Restart                                                |
2371 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2372 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:restart                                                              |
2373 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2374 |     **Action**               |     Restart                                                                                                     |
2375 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2376 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                          |
2377 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2378 |     **Payload Parameters**   |     See table below                                                                                             |
2379 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2380 |     **Revision History**     |     Unchanged in this release                                                                                   |
2381 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2382
2383 Payload Parameters for **VM Restart**
2384
2385 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2386 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                    |
2387 +=====================+=========================================================================+=====================+====================================+
2388 |     vm-id           |     The unique identifier (UUID) of                                     |     Yes             |                                    |
2389 |                     |     the resource. For backwards- compatibility, this can be the self-   |                     |                                    |
2390 |                     |     link URL of the VM                                                  |                     |     "payload":                     |
2391 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",  |
2392 |                     |                                                                         |                     |     \\"identity-url\\":            |
2393 +---------------------+-------------------------------------------------------------------------+---------------------+     \\"<IDENTITY-URL>\\",          |
2394 |     identity- url   |     The identity url used to access the resource                        |     No              |     \\"tenant-id\\": \\"<TENANT-   |
2395 |                     |                                                                         |                     |     ID>\\"}"                       |
2396 +---------------------+-------------------------------------------------------------------------+---------------------+                                    |
2397 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                    |
2398 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2399
2400 ResumeTraffic
2401 -------------
2402
2403 The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.
2404
2405 This command is executed using an Ansible playbook or Chef cookbook.
2406
2407 Request Structure: The payload does not have any parameters.
2408
2409 +--------------------------+---------------------------------------------------------+
2410 | **Target URL**           | /restconf/operations/appc-provider-lcm:resume-traffic   |
2411 +--------------------------+---------------------------------------------------------+
2412 | **Action**               | ResumeTraffic                                           |
2413 +--------------------------+---------------------------------------------------------+
2414 | **Action-identifiers**   | vnf-id                                                  |
2415 +--------------------------+---------------------------------------------------------+
2416 | **Payload Parameters**   |                                                         |
2417 +--------------------------+---------------------------------------------------------+
2418 | **Revision History**     | New in Beijing                                          |
2419 +--------------------------+---------------------------------------------------------+
2420
2421 ResumeTraffic Response
2422 ^^^^^^^^^^^^^^^^^^^^^^
2423
2424 **Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed.
2425
2426 If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status
2427
2428 **Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2429
2430
2431 Snapshot
2432 --------
2433
2434 Creates a snapshot of a VM.
2435
2436 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
2437
2438 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.
2439
2440 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.
2441
2442 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2443
2444 +------------------------------+-----------------------------------------------------------------------------------------------------+
2445 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:snapshot                                                 |
2446 +------------------------------+-----------------------------------------------------------------------------------------------------+
2447 |     **Action**               |     Snapshot                                                                                        |
2448 +------------------------------+-----------------------------------------------------------------------------------------------------+
2449 |     **Action-identifiers**   |     vnf-id, vserver-id                                                                              |
2450 +------------------------------+-----------------------------------------------------------------------------------------------------+
2451 |     **Payload Parameters**   |     vm-id, identity-url, tenant-id                                                                  |
2452 +------------------------------+-----------------------------------------------------------------------------------------------------+
2453 |     **Revision History**     |     Unchanged in this release.                                                                      |
2454 +------------------------------+-----------------------------------------------------------------------------------------------------+
2455
2456 Payload Parameters
2457
2458 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2459 | **Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                        |
2460 +=====================+=========================================================================+=====================+========================================+
2461 |     vm-id           |     The self-link URL of the VM                                         |     Yes             |                                        |
2462 |                     |                                                                         |                     |     "payload":                         |
2463 |                     |                                                                         |                     |     "{\\"vm-id\\": \\"<VM-ID>\\",      |
2464 |                     |                                                                         |                     |     \\"identity-url\\":                |
2465 |                     |                                                                         |                     |     \\"<IDENTITY-URL>\\",              |
2466 |                     |                                                                         |                     |     \\"tenant-id\\":\\"<TENANT-ID>\\"}"|
2467 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
2468 |     identity- url   |     The identity url used to access the resource                        |     No              |                                        |
2469 |                     |                                                                         |                     |                                        |
2470 +---------------------+-------------------------------------------------------------------------+---------------------+                                        |
2471 |     tenant-id       |     The id of the provider tenant that owns the resource                |     No              |                                        |
2472 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2473
2474 Snapshot Response
2475 ^^^^^^^^^^^^^^^^^
2476
2477 The Snapshot command returns an extended version of the LCM response.
2478
2479 The Snapshot response conforms to the standard response format.
2480
2481
2482 Start
2483 -----
2484
2485 Use the Start command to start a VM that is stopped.
2486
2487 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2488
2489 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2490 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start                                                                               |
2491 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2492 |     **Action**               |     Start                                                                                                                      |
2493 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2494 |     **Action-identifiers**   |     vnf-id and vserver-id are required                                                                                         |
2495 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2496 |     **Payload Parameters**   |     See table below                                                                                                            |
2497 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2498 |     **Revision History**     |     Unchanged in this release                                                                                                  |
2499 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2500
2501 Payload Parameters
2502
2503 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2504 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2505 +=================+===============================================+=================+=========================================+
2506 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2507 |                 |     the resource. For backwards-              |                 | "payload":                              |
2508 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2509 |                 |     link URL of the VM.                       |                 | \\",                                    |
2510 |                 |                                               |                 | \\"identity-url\\":                     |
2511 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2512 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2513 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2514 | identity- url   |     The identity url used to access the       | No              |                                         |
2515 |                 |     resource                                  |                 |                                         |
2516 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2517 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
2518 |                 |     the resource                              |                 |                                         |
2519 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2520
2521
2522 StartApplication
2523 ----------------
2524
2525 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.
2526
2527 A successful StartApplication request returns a success response.
2528
2529 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
2530
2531 +------------------------------+---------------------------------------------------------------+
2532 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:start-application  |
2533 +------------------------------+---------------------------------------------------------------+
2534 |     **Action**               |     StartApplication                                          |
2535 +------------------------------+---------------------------------------------------------------+
2536 |     **Action-Identifiers**   |     Vnf-id                                                    |
2537 +------------------------------+---------------------------------------------------------------+
2538 |     **Payload Parameters**   |     See table below                                           |
2539 +------------------------------+---------------------------------------------------------------+
2540 |     **Revision History**     |     Unchanged in this release.                                |
2541 +------------------------------+---------------------------------------------------------------+
2542
2543 |
2544
2545 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2546 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
2547 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2548 |                                 |                                                                                                                                                                                    |                     |  "payload":                                                     |
2549 |     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>\\"}    |
2550 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2551
2552 StartApplication Response
2553 ^^^^^^^^^^^^^^^^^^^^^^^^^
2554
2555 The StartApplication response returns an indication of success or failure of the request.
2556
2557 StartTraffic
2558 ------------
2559
2560 For StartTraffic LCM action, invoke the StartTraffic playbook. This is
2561 limited to Ansible.
2562
2563 A successful StartTraffic request returns a success response.
2564
2565 A failed StartTraffic action returns a failure response code and the
2566 specific failure message in the response block.
2567
2568
2569 ====================== ===================================================
2570 **Target URL**         /restconf/operations/appc-provider-lcm:StartTraffic
2571 ====================== ===================================================
2572 **Action**             StartTraffic
2573 **Action-Identifiers** vnf-id
2574 **Payload Parameters** See table
2575 **Revision History**   New in Frankfurt
2576 ====================== ===================================================
2577
2578 ========================= ========================================================================================================= ============= =========================
2579 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2580 ========================= ========================================================================================================= ============= =========================
2581 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StartTraffic",
2582
2583                                                                                                                                                   "action-identifiers": {
2584
2585                                                                                                                                                   "vnf-id": "rarf9901v"
2586
2587                                                                                                                                                   },
2588
2589                                                                                                                                                   "payload": "{}"
2590 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2591 ========================= ========================================================================================================= ============= =========================
2592
2593 StartTraffic Response\ **:**
2594 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2595
2596 Success: A successful StartTraffic returns a success status code 400.
2597
2598 Failure: A failed StartTraffic returns a failure code 401 and the
2599 failure message.
2600
2601
2602
2603 StatusTraffic
2604 -------------
2605
2606 For StatusTraffic LCM action, invoke the StatusTraffic playbook. This is
2607 limited to Ansible.
2608
2609 A successful StatusTraffic request returns a success response.
2610
2611 A failed StatusTraffic action returns a failure response code and the
2612 specific failure message in the response block.
2613
2614 ====================== ====================================================
2615 **Target URL**         /restconf/operations/appc-provider-lcm:StatusTraffic
2616 ====================== ====================================================
2617 **Action**             StatusTraffic
2618 **Action-Identifiers** vnf-id
2619 **Payload Parameters** See table
2620 **Revision History**   New in Frankfurt
2621 ====================== ====================================================
2622
2623 ========================= ========================================================================================================= ============= ==========================
2624 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2625 ========================= ========================================================================================================= ============= ==========================
2626 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StatusTraffic",
2627
2628                                                                                                                                                   "action-identifiers": {
2629
2630                                                                                                                                                   "vnf-id": "rarf9901v"
2631
2632                                                                                                                                                   },
2633
2634                                                                                                                                                   "payload": "{}"
2635 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2636 ========================= ========================================================================================================= ============= ==========================
2637
2638 StatusTraffic Response\ **:**
2639 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2640
2641 Success: A successful StatusTraffic returns a success status code 400.
2642
2643 Failure: A failed StatusTraffic returns a failure code 401 and the
2644 failure message.
2645
2646
2647 Stop
2648 ----
2649
2650 Use the Stop command to stop a VM that was running.
2651
2652 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2653
2654 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2655 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop                                                                                |
2656 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2657 |     **Action**               |     Stop                                                                                                                       |
2658 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2659 |     **Action-identifiers**   |     vnf-id and vserver-id are required.                                                                                        |
2660 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2661 |     **Payload Parameters**   |     See table below                                                                                                            |
2662 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2663 |     **Revision History**     |     Unchanged in this release                                                                                                  |
2664 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2665
2666 Payload Parameters
2667
2668 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2669 | **Parameter**   |     **Description**                           | **Required?**   | **Example**                             |
2670 +=================+===============================================+=================+=========================================+
2671 | vm-id           |     The unique identifier (UUID) of           | Yes             |                                         |
2672 |                 |     the resource. For backwards-              |                 | "payload":                              |
2673 |                 |     compatibility, this can be the self-      |                 | "{\\"vm-id\\": \\"<VM-ID>               |
2674 |                 |     link URL of the VM.                       |                 | \\",                                    |
2675 |                 |                                               |                 | \\"identity-url\\":                     |
2676 |                 |                                               |                 | \\"<IDENTITY-URL>\\",                   |
2677 |                 |                                               |                 | \\"tenant-id\\": \\"<TENANT- ID>\\"}"   |
2678 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2679 | identity- url   |     The identity url used to access the       | No              |                                         |
2680 |                 |     resource                                  |                 |                                         |
2681 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2682 | tenant-id       |     The id of the provider tenant that owns   | No              |                                         |
2683 |                 |     the resource                              |                 |                                         |
2684 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2685
2686
2687 StopApplication
2688 ---------------
2689
2690 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
2691
2692 A successful StopApplication request returns a success response.
2693
2694 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
2695
2696 +------------------------------+--------------------------------------------------------------+
2697 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:stop-application  |
2698 +------------------------------+--------------------------------------------------------------+
2699 |     **Action**               |     StopApplication                                          |
2700 +------------------------------+--------------------------------------------------------------+
2701 |     **Action-Identifiers**   |     Vnf-id                                                   |
2702 +------------------------------+--------------------------------------------------------------+
2703 |     **Payload Parameters**   |     See table below                                          |
2704 +------------------------------+--------------------------------------------------------------+
2705 |     **Revision History**     |     Unchanged in this release                                |
2706 +------------------------------+--------------------------------------------------------------+
2707
2708 |
2709
2710 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2711 |     **Payload Parameter**       |     **Description**                                                                                                                                                                |     **Required?**   |     **Example**                                                 |
2712 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2713 |     configuration- parameters   |     A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook.                                                 |     No              |     "payload":                                                  |
2714 |                                 |                                                                                                                                                                                    |                     |     \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"}   |
2715 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2716
2717
2718 StopApplication Response
2719 ^^^^^^^^^^^^^^^^^^^^^^^^
2720
2721 The StopApplication response returns an indication of success or failure of the request.
2722
2723 StopTraffic
2724 -----------
2725
2726 For StopTraffic LCM action, invoke the StopTraffic playbook. This is
2727 limited to Ansible.
2728
2729 A successful StopTraffic request returns a success response.
2730
2731 A failed StopTraffic action returns a failure response code and the
2732 specific failure message in the response block.
2733
2734
2735 ====================== ==================================================
2736 **Target URL**         /restconf/operations/appc-provider-lcm:StopTraffic
2737 ====================== ==================================================
2738 **Action**             Provisioning
2739 **Action-Identifiers** vnf-id
2740 **Payload Parameters** See table
2741 **Revision History**   New in Frankfurt
2742 ====================== ==================================================
2743
2744 ========================= ========================================================================================================= ============= ========================================================================
2745 **Payload Parameter**     **Description**                                                                                           **Required?** **Example**
2746 ========================= ========================================================================================================= ============= ========================================================================
2747 request- parameters       Not used. This request is limited to Ansible only.                                                        No            "action": "StopTraffic",
2748
2749                                                                                                                                                   "action-identifiers": {
2750
2751                                                                                                                                                   "vnf-id": "rarf9901v"
2752
2753                                                                                                                                                   },
2754
2755                                                                                                                                                   "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\"}}"
2756 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2757 ========================= ========================================================================================================= ============= ========================================================================
2758
2759 StopTraffic Response\ **:**
2760 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2761
2762 Success: A successful StopTraffic returns a success status code 400.
2763
2764 Failure: A failed StopTraffic returns a failure code 401 and the failure
2765 message.
2766
2767
2768 Sync
2769 ----
2770
2771 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
2772
2773 A successful Sync returns a success status.
2774
2775 A failed Sync returns a failure response status and failure messages in the response payload block.
2776
2777 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).
2778
2779 +------------------------------+---------------------------------------------------+
2780 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:sync   |
2781 +------------------------------+---------------------------------------------------+
2782 |     **Action**               |     Sync                                          |
2783 +------------------------------+---------------------------------------------------+
2784 |     **Action-identifiers**   |     Vnf-id                                        |
2785 +------------------------------+---------------------------------------------------+
2786 |     **Payload Parameters**   |     See below                                     |
2787 +------------------------------+---------------------------------------------------+
2788 |     **Revision History**     |     Unchanged in this release.                    |
2789 +------------------------------+---------------------------------------------------+
2790
2791 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2792 |     **Parameter**    |     **Description**                                                                                                                                       |     **Required?**   |     **Example**                  |
2793 +======================+===========================================================================================================================================================+=====================+==================================+
2794 |     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>"   |
2795 |                      |                                                                                                                                                           |                     |                                  |
2796 |                      |     \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file                                     |                     |                                  |
2797 |                      |                                                                                                                                                           |                     |                                  |
2798 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2799
2800
2801 Unlock
2802 ------
2803
2804 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
2805
2806 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.
2807
2808 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
2809
2810 The Unlock command will only return success if the VNF was locked with same request-id.
2811
2812 The Unlock command returns only one final response with the status of the request processing.
2813
2814 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.
2815
2816 +------------------------------+-----------------------------------------------------+
2817 |     **Target URL**           |     /restconf/operations/appc-provider-lcm:unlock   |
2818 +------------------------------+-----------------------------------------------------+
2819 |     **Action**               |     Unlock                                          |
2820 +------------------------------+-----------------------------------------------------+
2821 |     **Action-identifiers**   |     Vnf-id                                          |
2822 +------------------------------+-----------------------------------------------------+
2823 |     **Payload Parameters**   |     see table below                                 |
2824 +------------------------------+-----------------------------------------------------+
2825 |     **Revision History**     |     Unchanged in this release.                      |
2826 +------------------------------+-----------------------------------------------------+
2827
2828 |
2829
2830 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2831 |     **Payload Parameter**       |     **Description**                                                     |     **Required?**   |     **Example**                  |
2832 +=================================+=========================================================================+=====================+==================================+
2833 |     request-id                  |     Request id from the previously submitted request                    |     Yes             |    "request-id": "123456789"     |
2834 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2835
2836
2837 UpgradeBackout
2838 --------------
2839
2840 The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
2841
2842 This command is executed using an Ansible playbook or Chef cookbook.
2843
2844 Request Structure: The request payload includes an upgrade identifier.
2845
2846 +--------------------------+----------------------------------------------------------+
2847 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backout   |
2848 +--------------------------+----------------------------------------------------------+
2849 | **Action**               | UpgradeBackout                                           |
2850 +--------------------------+----------------------------------------------------------+
2851 | **Action-identifiers**   | vnf-id                                                   |
2852 +--------------------------+----------------------------------------------------------+
2853 | **Payload Parameters**   | existing-software-version, new-software-version          |
2854 +--------------------------+----------------------------------------------------------+
2855 | **Revision History**     | New in Beijing                                           |
2856 +--------------------------+----------------------------------------------------------+
2857
2858 Request Payload Parameters:
2859
2860 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2861 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2862 +=======================+=====================================+=====================+===============================================================================================+
2863 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2864 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2865 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2866 | new-software-         |     The new software                |     Yes             |                                                                                               |
2867 | version               |     version after the               |                     |                                                                                               |
2868 |                       |     upgrade                         |                     |                                                                                               |
2869 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2870
2871 UpgradeBackout Response
2872 ^^^^^^^^^^^^^^^^^^^^^^^
2873
2874 **Success:** A successful backout returns a success status code 400.
2875
2876 **Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2877
2878 UpgradeBackup
2879 -------------
2880
2881 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.
2882
2883 This command is executed using an Ansible playbook or Chef cookbook.
2884
2885 Request Structure: The payload does not have any parameters required.
2886
2887 +--------------------------+---------------------------------------------------------+
2888 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-backup   |
2889 +--------------------------+---------------------------------------------------------+
2890 | **Action**               | UpgradeBackup                                           |
2891 +--------------------------+---------------------------------------------------------+
2892 | **Action-identifiers**   | vnf-id                                                  |
2893 +--------------------------+---------------------------------------------------------+
2894 | **Payload Parameters**   | existing-software-version, new-software-version         |
2895 +--------------------------+---------------------------------------------------------+
2896 | **Revision History**     | New in Beijing.                                         |
2897 +--------------------------+---------------------------------------------------------+
2898
2899 Request Payload Parameters:
2900
2901 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2902 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2903 +=======================+=====================================+=====================+===============================================================================================+
2904 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
2905 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2906 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2907 | new-software-         |     The new software                |     Yes             |                                                                                               |
2908 | version               |     version after the               |                     |                                                                                               |
2909 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2910
2911 UpgradeBackup Response
2912 ^^^^^^^^^^^^^^^^^^^^^^
2913
2914 **Success:** A successful backup returns a success status code 400.
2915
2916 **Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2917
2918 UpgradePostCheck
2919 ----------------
2920
2921 The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.
2922
2923 This command is executed using an Ansible playbook or Chef cookbook.
2924
2925 Request Structure:
2926
2927 +--------------------------+-------------------------------------------------------------+
2928 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-post-check   |
2929 +--------------------------+-------------------------------------------------------------+
2930 | **Action**               | UpgradePostCheck                                            |
2931 +--------------------------+-------------------------------------------------------------+
2932 | **Action-identifiers**   | vnf-id                                                      |
2933 +--------------------------+-------------------------------------------------------------+
2934 | **Payload Parameters**   | existing-software-version, new-software-version             |
2935 +--------------------------+-------------------------------------------------------------+
2936 | **Revision History**     | New in Beijing                                              |
2937 +--------------------------+-------------------------------------------------------------+
2938
2939 Request Payload Parameters:
2940
2941 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2942 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2943 +=======================+=====================================+=====================+===============================================================================================+
2944 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
2945 |  version              |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
2946 +-----------------------+-------------------------------------+---------------------+                                                                                               |
2947 | new-software-         |     The new software                |     Yes             |                                                                                               |
2948 | version               |     version after the               |                     |                                                                                               |
2949 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2950
2951 UpgradePostCheck Response
2952 ^^^^^^^^^^^^^^^^^^^^^^^^^
2953
2954 **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).
2955
2956 Response Payload Parameters:
2957
2958 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2959 | **Parameter** |     **Description**         |**Required?**|     **Example**                                                              |
2960 +===============+=============================+=============+==============================================================================+
2961 | Upgrade-      |     Returns the status      |     Yes     |                                                                              |
2962 | Status        |     of the upgradw          |             |     "payload":                                                               |
2963 |               |     post-check. Indicates   |             |     "{\\"upgrade-status\\": \\"Completed\\"}”                                |
2964 |               |     Completed or Failed     |             |     "payload": "{\\"upgrade-status\\":                                       |
2965 |               |                             |             |     \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” |
2966 +---------------+-----------------------------+-------------+                                                                              |
2967 | Message       |     If Not Available,       |             |                                                                              |
2968 |               |     message contains        |             |                                                                              |
2969 |               |     explanation.            |             |                                                                              |
2970 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2971
2972 **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.
2973
2974 UpgradePreCheck
2975 ---------------
2976
2977 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).
2978
2979 This command is executed using an Ansible playbook or Chef cookbook.
2980
2981 Request Structure:
2982
2983 +--------------------------+------------------------------------------------------------+
2984 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-pre-check   |
2985 +--------------------------+------------------------------------------------------------+
2986 | **Action**               | UpgradePreCheck                                            |
2987 +--------------------------+------------------------------------------------------------+
2988 | **Action-identifiers**   | vnf-id                                                     |
2989 +--------------------------+------------------------------------------------------------+
2990 | **Payload Parameters**   | existing-software-version, new-software-version            |
2991 +--------------------------+------------------------------------------------------------+
2992 | **Revision History**     | New in Beijing                                             |
2993 +--------------------------+------------------------------------------------------------+
2994
2995 Request Payload Parameters:
2996
2997 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2998 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
2999 +=======================+=====================================+=====================+===============================================================================================+
3000 | existing-software-    |     The existing software version   |     Yes             |     "payload":                                                                                |
3001 | version               |     prior to the upgrade            |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
3002 +-----------------------+-------------------------------------+---------------------+                                                                                               |
3003 | new-software-         |     The new software                |     Yes             |                                                                                               |
3004 | version               |     version after the               |                     |                                                                                               |
3005 |                       |     upgrade                         |                     |                                                                                               |
3006 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
3007
3008 UpgradePreCheck Response
3009 ^^^^^^^^^^^^^^^^^^^^^^^^
3010
3011 **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).
3012
3013 Response Payload Parameters:
3014
3015 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
3016 | **Parameter**   |     **Description**       |     **Required?**   |     **Example**                                                                                                                  |
3017 +=================+===========================+=====================+==================================================================================================================================+
3018 | upgrade-status  |     Returns the status    |     Yes             |                                                                                                                                  |
3019 |                 |     of the upgrade pre-   |                     |     "payload":                                                                                                                   |
3020 |                 |     check. Indicates      |                     |     "{\\"upgrade-status\\": \\"Available\\"}”                                                                                    |
3021 |                 |     Available or Not      |                     |                                                                                                                                  |
3022 |                 |     Available             |                     |     "payload":                                                                                                                   |
3023 |                 |                           |                     |     "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }”   |
3024 +-----------------+---------------------------+---------------------+                                                                                                                                  |
3025 |     message     |     If Not Available,     |                     |                                                                                                                                  |
3026 |                 |     message contains      |                     |                                                                                                                                  |
3027 |                 |     explanation.          |                     |                                                                                                                                  |
3028 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
3029
3030 **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.
3031
3032 UpgradeSoftware
3033 ---------------
3034
3035 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).
3036
3037 This command is executed using an Ansible playbook or Chef cookbook.
3038
3039 Request Structure: The request payload includes the new-software-version.
3040
3041 +--------------------------+-----------------------------------------------------------+
3042 | **Target URL**           | /restconf/operations/appc-provider-lcm:upgrade-software   |
3043 +--------------------------+-----------------------------------------------------------+
3044 | **Action**               | UpgradeSoftware                                           |
3045 +--------------------------+-----------------------------------------------------------+
3046 | **Action-identifiers**   | vnf-id                                                    |
3047 +--------------------------+-----------------------------------------------------------+
3048 | **Payload Parameters**   | existing-software-version, new-software-version           |
3049 +--------------------------+-----------------------------------------------------------+
3050 | **Revision History**     | New in Beijing                                            |
3051 +--------------------------+-----------------------------------------------------------+
3052
3053  Request Payload Parameters:
3054
3055 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
3056 | **Parameter**         |     **Description**                 |     **Required?**   |     **Example**                                                                               |
3057 +=======================+=====================================+=====================+===============================================================================================+
3058 | existing- software-   |     The existing software version   |     Yes             |     "payload":                                                                                |
3059 | version               |      prior to the upgrade           |                     |     "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}”   |
3060 +-----------------------+-------------------------------------+---------------------+                                                                                               |
3061 | new-software          |     The new software                |     Yes             |                                                                                               |
3062 | version               |     version after the               |                     |                                                                                               |
3063 |                       |     upgrade                         |                     |                                                                                               |
3064 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
3065
3066 UpgradeSoftware Response
3067 ^^^^^^^^^^^^^^^^^^^^^^^^
3068
3069 **Success:** A successful upgrade returns a success status code 400.
3070
3071 If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status.
3072
3073 **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.
3074
3075 Notes regarding the Upgrade commands
3076 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
3077 Ansible playbooks / Chef cookbooks:
3078
3079 -  All Ansible playbooks/cookbooks for the Upgrade commands will be
3080    stored in the same directory on the server. The directory name will
3081    be of the format:
3082
3083         {existing-software-version_new-software-version}.
3084
3085                 The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade).
3086
3087 -  The playbooks for upgrades should use a standard naming convention
3088    (for example: SoftwareUpgrade_{existing-software-version_new-software-version}).
3089
3090 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.
3091
3092 -  The template will contain the directory path/playbook name which
3093    would be parameterized.
3094
3095     {vnf-type}/UpgradeSoftware/${existing_software_version}_${new-software-version}/
3096     SoftwareUpgrade_{existing-software-version_new-software-version}.
3097
3098