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
9 .. https://creativecommons.org/licenses/by/4.0/
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.
28 This guide describes the APPC API that allows you to manage and control the life cycle of controlled virtual network functions (VNFs).
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.
36 Life Cycle Management Commands
37 ==============================
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.
41 A virtual application is composed of the following layers of network technology:
43 - Virtual Network Function (VNF)
44 - Virtual Network Function Component (VNFC)
45 - Virtual Machine (VM)
47 A Life Cycle Management (LCM) command may affect one or more of these layers.
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:
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.
56 - A **synchronous** command, such as Lock or Unlock, results in a single response that is either SUCCESS or ERROR.
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.
61 Message Bus and the LCM API Client Library
62 ------------------------------------------
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.
66 For more details, see the APPC Client Library Guide at:
68 :ref:`appc_client_library`
71 The client library supports both synchronous and asynchronous flows as follows.
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.
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.
89 The client library adds the following wrapper around request and responses to the LCM API (described below)::
93 "cambria.partition" : "<TOPIC>",
94 "correlation-id" :"<CORRELATION_ID>",
95 "rpc-name" : "<RPC_NME>",
96 "type" : <MESSAGE_TYPE>
97 "body" : <RPC_SPECIFIC_BODY>
102 Table 1 Request / Response Message Fields
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 |
111 | | - For incoming messages, this value should be ``APPC``. | |
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 |
119 | | The convention for RPC names and the target URL is that multi-word command names should have a dash between | |
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:: | |
131 | | "common-header" : {...} | |
132 | | "action" : "configure", | |
133 | | "action-identifiers" : {...}, | |
134 | | "payload": "..." | |
136 +----------------------+----------------------------------------------------------------------------------------------------------------+---------------------+
139 Generic Request Format
140 ----------------------
142 The LCM API general request format is applicable for both POST HTTP API and for the message body received via the message bus.
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::
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>",
158 "mode": "<EXCLUSIVE|NORMAL>",
159 "force": "<TRUE|FALSE>",
163 "action": "<COMMAND_ACTION>",
164 "action-identifiers": {
165 "vnf-id": "<VNF_ID>",
166 "vnfc-name": "<VNFC_NAME>",
167 "vserver-id": "VSERVER_ID"
169 ["payload": "<PAYLOAD>"]
174 Table 2 LCM Request Fields
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 |
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 |
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 |
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 |
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 |
205 | | - "EXCLUSIVE" - reject requests on this VNF while another request is in progress, or | |
207 | | - "NORMAL" - allow requests (pending additional validations) on this VNF if there is another request is in progress. | |
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. | |
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. | |
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 |
220 | | These are case-sensitive; e.g.,”Restart” is correct; “restart” is incorrect. | |
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 |
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: | |
240 | | ``"{\" vnf-host-ip-address\": \"<VNF-HOST-IP-ADDRESS>\"}"`` | |
242 | | The payload is typically used to provide parametric data associated with the command, such as a list of configuration parameters. | |
244 | | Note that not all LCM commands need have a payload. | |
246 | | ***NOTE:** See discussion below on the use of payloads for self-service actions. | |
247 +---------------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
249 Request Processing and Validation Logic
250 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
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.
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.
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
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.
265 4. If the Force flag = Y, then allow the new action regardless of
266 whether there is an action in progress.
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.
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).
276 a. If there is no overlap between the new request and requests in
277 progress, the new request is accepted.
279 b. If there is overlap, then only special cases are allowed in
280 parallel (for example, Audit and HealthCheck are allowed).
283 Generic Response Format
284 -----------------------
287 This section describes the generic response format.
289 The response format is applicable for both POST HTTP API and for the message body received via the message bus.
295 The LCM response comprises a common header and a section containing the payload and action details.
297 The LCM response conforms to the following structure::
302 "api-ver": "<API_VERSION>",
305 "force": "<TRUE|FALSE>",
306 "mode": "<EXCLUSIVE|NORMAL>"
308 "originator-id": "<SYSTEM_ID>",
309 "request-id": "<REQUEST_ID>",
310 "sub-request-id": "<SUBREQUEST_ID>",
311 "timestamp": "2016-08-08T23:09:00.11Z",
313 "payload": "<PAYLOAD>",
316 "code": <RESULT_CODE>,
317 "message": "<RESULT_MESSAGE>"
323 Table 3 LCM Response Fields
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 |
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 |
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 |
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 |
350 | | ***NOTE:** See* status *for code values.* | |
351 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
352 | payload | An open-format field. | No |
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\\"}"``. | |
356 | | The payload is typically used to provide parametric data associated with the response to the command. | |
358 | | Note that not all LCM commands need have a payload. | |
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 +----------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+
373 The status code is returned in the response message as the ``code`` parameter, and the description as the message parameter.
375 The different responses are categorized as follows:
379 Request is valid and accepted for processing.
383 Request invalid or incomplete.
387 Request rejected during processing due to invalid data, such as an
392 Request is valid and completes successfully.
396 The request processing resulted in failure.
398 A FAILURE response is always returned asynchronously via the message
403 The request processing resulted in partial success where at least
404 one step in a longer process completed successfully.
406 A PARTIAL SUCCESS response is always returned asynchronously via the
411 The request processing resulted in partial failure.
413 A PARTIAL FAILURE response is always returned asynchronously via the
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 |
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 = |
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 |
479 +-----------------------+----------------+--------------------------------------------------------------------------------------------------------------------------------------+
482 Malformed Message Response
483 --------------------------
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.
487 **Response Format for Malformed Requests**::
493 "error-type": "protocol",
494 "error-tag": "malformed-message",
495 "error-message": "<ERROR-MESSAGE>",
496 "error-info": "<ERROR-INFO>"
503 **Example Response**::
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,
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.
529 Commands, or actions, can be performed at one or more of the following scope levels:
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 +-----------------+----------------------------------------------------------------------------------------+
543 **VNF/VM Types Supported**
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.
547 - **Any** Currently supported on any vnf-type.
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.
552 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
553 | **Command** | **VNF** | **VF-Module** | **VNFC** | **VM** | **VNF/VM Types Supported** |
554 +=============================+===========+==================+================+==========+============================================================+
555 | ActionStatus | Yes | | | | Any |
556 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
557 | AttachVolume | | | | Yes | Any (uses OpenStack command) |
558 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
559 | Audit | Yes | | | | Any (requires self-service onboarding) |
560 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
561 | CheckLock | Yes | | | | Any |
562 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
563 | Configure | Yes | | | | Any (requires self-service onboarding) |
564 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
565 | ConfigBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
566 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
567 | ConfigModify | Yes | | | | Any (requires self-service onboarding) |
568 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
569 | ConfigRestore | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
570 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
571 | ConfigScaleOut | Yes | | | | Any (requires self-service onboarding) |
572 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
573 | DetachVolume | | | | Yes | Any (uses OpenStack command) |
574 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
575 | DistributeTraffic | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) |
576 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
577 | DistributeTrafficCheck | Yes | | Yes | Yes | Chef and Ansible only (requires self-service onboarding) |
578 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
579 | Evacuate | | | | Yes | Any (uses OpenStack command) |
580 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
581 | GetConfig | Yes | | | | Ansible |
582 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
583 | HealthCheck | Yes | | | | Any (requires self-service onboarding) |
584 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
585 | LicenseManagement | Yes | | | | Ansible |
586 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
587 | Lock | Yes | | | | Any |
588 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
589 | Migrate | | | | Yes | Any (uses OpenStack command) |
590 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
591 | PostEvacuate | Yes | | | | Ansible |
592 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
593 | PostMigrate | Yes | | | | Ansible |
594 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
595 | PostRebuild | Yes | | | | Ansible |
596 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
597 | PreConfigure | Yes | | | | Ansible |
598 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
599 | PreEvacuate | Yes | | | | Ansible |
600 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
601 | PreMigrate | Yes | | | | Ansible |
602 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
603 | PreRebuild | Yes | | | | Ansible |
604 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
605 | Provisioning | Yes | | | | Ansible |
606 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
607 | QuiesceTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
608 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
609 | Reboot | | | | Yes | Any (uses OpenStack command) |
610 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
611 | Rebuild | | | | Yes | Any (uses OpenStack command) |
612 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
613 | Restart | | | | Yes | Any (uses OpenStack command) |
614 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
615 | ResumeTraffic | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
616 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
617 | Snapshot | | | | Yes | Any (uses OpenStack command) |
618 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
619 | Start | | | | Yes | Any (uses OpenStack command) |
620 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
621 | StartApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
622 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
623 | StartTraffic | Yes | | | | Ansible |
624 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
625 | StatusTraffic | Yes | | | | Ansible |
626 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
627 | Stop | | | | Yes | Any (uses OpenStack command) |
628 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
629 | StopApplication | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
630 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
631 | StopTraffic | Yes | | | | Ansible |
632 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
633 | Sync | Yes | | | | Any (requires self-service onboarding) |
634 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
635 | Unlock | Yes | | | | Any |
636 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
637 | UpgradeBackout | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
638 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
639 | UpgradeBackup | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
640 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
641 | UpgradePostCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
642 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
643 | UpgradePreCheck | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
644 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
645 | UpgradeSoftware | Yes | | | | Chef and Ansible only (requires self-service onboarding) |
646 +-----------------------------+-----------+------------------+----------------+----------+------------------------------------------------------------+
650 Self-Service VNF Onboarding
651 ---------------------------
653 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:
655 - Netconf with uploadable Yang model (requires a Netconf server running
658 - Chef (requires a Chef client running on the VNF)
660 - Ansible (does not require any changes to the VNF software)
662 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:
664 - Define the VNF capabilities (set of actions that the VNF can
667 - Create a template and parameter definitions for actions which use the
668 Netconf, Chef, or Ansible protocols. The template is an xml or JSON
669 block which defines the “payload” which is included in the request
670 that is downloaded the VNF (if Netconf) or Chef/Ansible server.
672 - Test actions which have templates/parameter definitions.
674 - Upload the VNF definition, template, and parameter definition
675 artifacts to SDC which distributes them to all APPC instances in the
676 same environment (e.g., production).
678 For more details, see the APPC CDT Onboarding User Guide.
685 The LCM commands that are valid for the current release.
690 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.
692 +--------------------------+----------------------------------------------------------+
693 | **Target URL** | /restconf /operations/ appc-provider-lcm:action-status |
694 +--------------------------+----------------------------------------------------------+
695 | **Action** | ActionStatus |
696 +--------------------------+----------------------------------------------------------+
697 | **Action-Identifiers** | vnf-id |
698 +--------------------------+----------------------------------------------------------+
699 | **Payload Parameters** | See below |
700 +--------------------------+----------------------------------------------------------+
701 | **Revision History** | New in Beijing |
702 +--------------------------+----------------------------------------------------------+
706 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
707 | **Payload Parameter** | **Description** | **Required** | **Example** |
708 +=============================+============================================================+====================+=====================================+
709 | request-id | Request id from the previously submitted request | Yes | "request-id": "123456789" |
710 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
711 | sub-request ID | Sub-Request id from the previously submitted request | optional | "sub-request-id": "123456789" |
712 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
713 | originator-id | Originator id from the previously submitted request | optional | "originator-id": "123456789" |
714 +-----------------------------+------------------------------------------------------------+--------------------+-------------------------------------+
717 ActionStatus Response:
718 ^^^^^^^^^^^^^^^^^^^^^^
720 A successful response contains a payload with the following:
722 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
723 | **Payload Parameter** | **Description** | **Required** | **Example** |
724 +=============================+=======================================================================+====================+==============================+
725 | status-reason | Contains more details about status | No | |
726 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
727 | status | IN_PROGRESS – The request has been accepted and is in progress | No | "status": "SUCCESSFUL" |
729 | | SUCCESSFUL – The request returned success message | | |
731 | | FAILED – The request failed and returned an error message | | |
733 | | ABORTED – the request aborted | | |
735 | | NOT_FOUND – The request is not found | | |
736 +-----------------------------+-----------------------------------------------------------------------+--------------------+------------------------------+
738 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:
740 ``"message": "MULTIPLE REQUESTS FOUND - using search criteria:
741 request- id=c09ac7d1-de62-0016-2000-e63701125559 AND
742 vnf-id=ctsf0007v", "code": 315``
747 The AttachVolume command attaches a cinder volume to a VM via an Openstack command.
749 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.
751 NOTE: The command implementation is based on Openstack
752 functionality. For further details, see
753 http://developer.openstack.org/api-ref/compute/.
755 +--------------------------+----------------------------------------------------------+
756 | **Target URL** | /restconf/operations/appc-provider-lcm:attach-volume |
757 +--------------------------+----------------------------------------------------------+
758 | **Action** | AttachVolume |
759 +--------------------------+----------------------------------------------------------+
760 | **Action-Identifiers** | vnf-id, vserver-id |
761 +--------------------------+----------------------------------------------------------+
762 | **Payload Parameters** | See table |
763 +--------------------------+----------------------------------------------------------+
764 | **Revision History** | New in Beijing |
765 +--------------------------+----------------------------------------------------------+
769 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
770 | **Payload Parameter** | **Description** | **Required** | **Example** |
771 +=============================+======================================================+====================+===========================================================================================================================+
772 | volumeId | The UUID of the volume to attach. | Yes | "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803", |
773 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
774 | device | The device identifier | Yes | "device": "/dev/vdb" |
775 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
776 | 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" |
777 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
778 | Identity-url | The identity URL used to access the resource | Yes | "identity-url": "http://135.25.246.162:5000/v2.0" |
779 +-----------------------------+------------------------------------------------------+--------------------+---------------------------------------------------------------------------------------------------------------------------+
781 AttachVolume Response:
782 ^^^^^^^^^^^^^^^^^^^^^^
784 Success: A successful AttachVolume returns a success status code 400.
786 Failure: A failed AttachVolume returns a failure code 401 and the failure message. Failure messages can include:
797 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.
799 A successful Audit means that the current VNF configuration matches the latest APPC stored configuration.
801 A failed Audit indicates that the configurations do not match.
803 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).
805 The Audit action does not require any payload parameters.
807 **NOTE:** Audit does not return a payload containing details of the comparison, only the Success/Failure status.
810 +------------------------------+------------------------------------------------------+
811 | **Target URL** | /restconf/operations/appc-provider-lcm:audit |
812 +------------------------------+------------------------------------------------------+
813 | **Action** | Audit |
814 +------------------------------+------------------------------------------------------+
815 | **Action-Identifiers** | vnf-id |
816 +------------------------------+------------------------------------------------------+
817 | **Payload Parameters** | See below |
818 +------------------------------+------------------------------------------------------+
819 | **Revision History** | Unchanged in this release. |
820 +------------------------------+------------------------------------------------------+
824 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
825 | **Parameter** | **Description** | **Required?** | **Example** |
826 +======================+===========================================================================================================================================================+=====================+==================================+
827 | 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>" |
829 | | \* If the publish\-config field is set to N in the payload, then: | | |
831 | | - If the result of the audit is ‘match’ (latest APPC config and the running config match), do not send the running configuration | | |
833 | | - If the result of the audit is ‘no match’, then send the running configuration | | |
834 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
839 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.
845 The CheckLock command returns true if the specified VNF is locked; otherwise, false is returned.
847 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.
849 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.
851 The CheckLock command returns a specific response structure that extends the default LCM response.
853 The CheckLock action does not require any payload parameters.
855 +------------------------------+--------------------------------------------------------+
856 | **Target URL** | /restconf/operations/appc-provider-lcm:checklock |
857 +------------------------------+--------------------------------------------------------+
858 | **Action** | CheckLock |
859 +------------------------------+--------------------------------------------------------+
860 | **Action-Identifiers** | vnf-id |
861 +------------------------------+--------------------------------------------------------+
862 | **Payload Parameters** | None |
863 +------------------------------+--------------------------------------------------------+
864 | **Revision History** | Unchanged in this release. |
865 +------------------------------+--------------------------------------------------------+
870 The CheckLock command returns a customized version of the LCM
874 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
875 | **Parameter** | **Description** | **Required** | **?Example** |
876 +=====================+=======================================================================================+====================+=================================+
877 | locked | "TRUE"\|"FALSE" - returns TRUE if the specified VNF is locked, otherwise FALSE. | No | "locked": "<TRUE\|FALSE>" |
878 +---------------------+---------------------------------------------------------------------------------------+--------------------+---------------------------------+
886 "code": <RESULT_CODE>, "message": "<RESULT_MESSAGE>"
889 "api-ver": "<API_VERSION>",
890 "request-id": "<ECOMP\_REQUEST_ID>", "originator-id":
892 "sub-request-id": "<ECOMP_SUBREQUEST_ID>", "timestamp":
893 "2016-08-08T23:09:00.11Z",
895 "ttl": <TTL_VALUE>, "force": "<TRUE|FALSE>",
896 "mode": "<EXCLUSIVE|NORMAL>"
899 "locked": "<TRUE|FALSE>"
906 Configure a VNF or a VNFC on the VNF after instantiation.
908 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.
910 A successful Configure request returns a success response.
912 A failed Configure action returns a failure response and the specific failure messages in the response block.
914 +------------------------------+--------------------------------------------------------+
915 | **Target URL** | /restconf/operations/appc-provider-lcm:configure |
916 +------------------------------+--------------------------------------------------------+
917 | **Action** | Configure |
918 +------------------------------+--------------------------------------------------------+
919 | **Action-Identifiers** | vnf-id |
920 +------------------------------+--------------------------------------------------------+
921 | **Payload Parameters** | See below |
922 +------------------------------+--------------------------------------------------------+
923 | **Revision History** | Unchanged in this release. |
924 +------------------------------+--------------------------------------------------------+
928 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
929 | **Payload Parameter** | **Description** | **Required?** | **Example** |
931 +=================================+================================================================================================================================================================================================================+=====================+=================================================================+
932 | 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 | |
934 | | vnfc-type: must be included if template is vnfc specific | | "{ \\"request-parameters |
936 | | | | \\"vnf-host-ip-address\\": |
937 | | | | \\”value\\”, |
938 | | | | \\”vnfc-type\\”: \\”value\\”’ |
949 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
950 | 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>\\"} |
951 +---------------------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
957 The Configure response returns an indication of success or failure of the request.
959 **Success:** A successful Configure returns a success status code 400.
960 **Failure:** A failed Configure returns a failure code 401 and the failure message.
962 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.
964 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.
969 Modifies the configuration on a VNF or VNFC in service.
971 This command is executed either directly on the VNF (such as for Netconf) or using an Ansible playbook or Chef cookbook.
975 +--------------------------+--------------------------------------------------------+
976 | **Target URL** | /restconf/operations/appc-provider-lcm:config-modify |
977 +--------------------------+--------------------------------------------------------+
978 | **Action** | ConfigModify |
979 +--------------------------+--------------------------------------------------------+
980 | **Action-Identifiers** | vnf-id |
981 +--------------------------+--------------------------------------------------------+
982 | **Payload Parameters** | request-parameters, configuration-parameters |
983 +--------------------------+--------------------------------------------------------+
984 | **Revision History** | Unchanged in this release. |
985 +--------------------------+--------------------------------------------------------+
987 Request Payload Parameters:
989 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
990 | **Payload Parameter** | **Description** | **Required?** | **Example** |
991 +=========================+========================================+=================+=======================================================+
992 | request-parameters | vnf-host-ip-address: optional if | No | "payload": |
993 | | Netconf or other direct interface | | "{\\"request-parameters \\": |
994 | | to the VNF. If not provided, it is | | {\\"vnf-host-ip-address\\": \\”value\\", |
995 | | obtained from A&AI | | \\”vnfc-type\\”: \\”value\\” |
998 | | vnfc-type: must be included if template| | |
999 | | is vnfc specific | | |
1000 | | | | \\"configuration- parameters\\": {\\"name1\\": |
1001 | | | | \\”value1\\”,\\"name2\\": |
1002 | | | | \\”value2\\” |
1005 +-------------------------+----------------------------------------+-----------------+ |
1006 | configuration- | A set of instance specific | No | |
1007 | parameters | configuration parameters should | | |
1008 | | be specified. | | |
1009 +-------------------------+----------------------------------------+-----------------+-------------------------------------------------------+
1011 ConfigModify Request
1012 ^^^^^^^^^^^^^^^^^^^^
1019 "timestamp": "2017-10-25T11:10:04.244Z",
1021 "originator-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1022 "request-id": "664be3d2-6c12-4f4b-a3e7-c349acced200",
1023 "sub-request-id": "1",
1029 "action": "ConfigModify",
1030 "action-identifiers": {
1031 "vnf-id": "<VNF_ID>"
1033 "payload": "{ \"config-url\":\"5f517fd4-bf3d-43bc-8147-1b61776d7ded\",
1034 \"config-json\": \"{\"pg-streams\":{
1035 \"pg-stream\": [{ \"id\":\"fw_udp1\", \"is-enabled\": \"true\" },
1036 {\"id\": \"fw_udp2\", \"is-enabled\":\"true\" },
1037 { \"id\": \"fw_udp3\",\"is-enabled\": \"true\" },
1038 { \"id\":\"fw_udp4\", \"is-enabled\": \"true\" },
1039 {\"id\": \"fw_udp5\", \"is-enabled\":\"true\" }]}}"
1045 ConfigModify Response
1046 ^^^^^^^^^^^^^^^^^^^^^
1048 **Success:** A successful ConfigModify returns a success status code 400.
1050 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.
1052 **Failure:** A failed ConfigModify returns a failure code 401 and the failure message.
1057 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).
1059 A successful ConfigBackup request returns a success response.
1061 A failed ConfigBackup action returns a failure response code and the specific failure message in the response block.
1063 +------------------------------+-----------------------------------------------------------+
1064 | **Target URL** | /restconf/operations/appc-provider-lcm:config-backup |
1065 +------------------------------+-----------------------------------------------------------+
1066 | **Action** | ConfigBackup |
1067 +------------------------------+-----------------------------------------------------------+
1068 | **Action-Identifiers** | Vnf-id |
1069 +------------------------------+-----------------------------------------------------------+
1070 | **Payload Parameters** | See below |
1071 +------------------------------+-----------------------------------------------------------+
1072 | **Revision History** | Unchanged in this release. |
1073 +------------------------------+-----------------------------------------------------------+
1077 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1078 | **Payload Parameter** | **Description** | **Required?** | **Example** |
1079 +=================================+====================================================================================================================================================================================+=====================+===================================================================+
1080 | request-parameters | Not used. This request is limited to Ansible and Chef only. | No | "payload": \\"configuration-parameters\\": {\\"<CONFIG-PARAMS>\\"}|
1086 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1087 | configuration-parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | |
1088 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-------------------------------------------------------------------+
1090 ConfigBackup Response
1091 ^^^^^^^^^^^^^^^^^^^^^
1093 The ConfigBackup response returns an indication of success or failure of the request.
1095 **Success:** A successful ConfigBackup returns a success status code 400.
1096 **Failure:** A failed ConfigBackup returns a failure code 401 and the failure message.
1102 Applies a previously saved configuration to the active VNF configuration. This is limited to Ansible and Chef. There can only be one stored configuration.
1104 A successful ConfigRestore request returns a success response.
1106 A failed ConfigRestore action returns a failure response code and the specific failure message in the response block.
1108 +------------------------------+------------------------------------------------------------------------------------------+
1109 | **Target URL** | /restconf/operations/appc-provider-lcm:config-restore |
1110 +------------------------------+------------------------------------------------------------------------------------------+
1111 | **Action** | ConfigRestore |
1112 +------------------------------+------------------------------------------------------------------------------------------+
1113 | **Action-Identifiers** | Vnf-id |
1114 +------------------------------+------------------------------------------------------------------------------------------+
1115 | **Payload Parameters** | See below |
1116 +------------------------------+------------------------------------------------------------------------------------------+
1117 | **Revision History** | Unchanged in this release. |
1118 +------------------------------+------------------------------------------------------------------------------------------+
1122 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1123 | **Parameter** | **Description** | **Required?** | **Example** |
1124 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
1125 | request-parameters | Not used. This request is limited to Ansible and Chef only. | No | "payload": |
1126 | | | | \\"configuration-parameters\\": {\\"<CONFIG- PARAMS>\\"} |
1127 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1128 | configuration-parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | |
1129 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
1131 ConfigRestore Response
1132 ^^^^^^^^^^^^^^^^^^^^^^
1134 **Success:** A successful ConfigRestore returns a success status code 400.
1136 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.
1138 **Failure:** A failed ConfigRestore returns a failure code 401 and the failure message.
1145 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.
1147 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.
1148 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.
1150 This action is supported via the Netconf (limited to configuration changes), Chef, and Ansible protocols.
1154 +------------------------------+------------------------------------------------------------------------------------------+
1155 | **Target URL** | /restconf /operations/appc-provider-lcm:config-scale-out |
1156 +------------------------------+------------------------------------------------------------------------------------------+
1157 | **Action** | ConfigScaleOut |
1158 +------------------------------+------------------------------------------------------------------------------------------+
1159 | **Action-Identifiers** | Vnf-id |
1160 +------------------------------+------------------------------------------------------------------------------------------+
1161 | **Payload Parameters** | See below |
1162 +------------------------------+------------------------------------------------------------------------------------------+
1163 | **Revision History** | New in Beijing |
1164 +------------------------------+------------------------------------------------------------------------------------------+
1168 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1169 | **Payload Parameter** | **Description** | **Required?** | **Example** |
1170 +=================================+==================================================================================================================================================================+=====================+=============================================+
1171 | 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": |
1172 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ "{\\"request-parameters \\": |
1173 | | vf-module-id: used to determine the A&AI VM inventory associated with ConfigScaleOut. | Yes | { |
1174 | +------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ \\"vnf-host-ip-address\\": |
1175 | | controller-template-id: optional. This is a unique identifier that will identify the template associated with the ConfigScaleOut. | | \\”value\\”, |
1176 | | Will be needed if A&AI does not contain the template identifier. | No | \\”vf-module-id\\”: \\”value\\”, |
1177 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ \\”controller-template-id\\”: |
1178 | 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\\” |
1179 | | values supplied. | | } |
1181 | | | | \\"configuration-parameters\\": |
1182 | | | | {\\"<CONFIG- PARAMS>\\"} |
1184 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------+
1186 ConfigScaleOut Response
1187 ^^^^^^^^^^^^^^^^^^^^^^^
1191 - A successful ConfigScaleOut returns a success status code 400 when completed.
1195 - A failed ConfigScaleOut returns a failure code 401 and the failure message.
1196 - 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.
1202 The DetachVolume command detaches a cinder volume from a VM via an Openstack command.
1204 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.
1206 NOTE: The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1208 +--------------------------+----------------------------------------------------------+
1209 | **Target URL** | /restconf/operations/appc-provider-lcm:detach-volume |
1210 +--------------------------+----------------------------------------------------------+
1211 | **Action** | DetachVolume |
1212 +--------------------------+----------------------------------------------------------+
1213 | **Action-Identifiers** | vnf-id, vserver-id |
1214 +--------------------------+----------------------------------------------------------+
1215 | **Payload Parameters** | See table |
1216 +--------------------------+----------------------------------------------------------+
1217 | **Revision History** | New in Beijing |
1218 +--------------------------+----------------------------------------------------------+
1220 Request Payload Parameters:
1222 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1223 | **Payload Parameter** | **Description** | **Required** | **Example** |
1224 +=============================+================================================================+====================+================================================================================================================================+
1225 | volumeId | The UUID of the volume to detach. | Yes | "volumeId": "a26887c6-c47b-4654-abb5-dfadf7d3f803" |
1226 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1227 | 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" |
1228 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1229 | Identity-url | The identity URL used to access the resource | Yes | "identity-url": "http://135.25.246.162:5000/v2.0" |
1230 +-----------------------------+----------------------------------------------------------------+--------------------+--------------------------------------------------------------------------------------------------------------------------------+
1232 DetachVolume Response:
1233 ^^^^^^^^^^^^^^^^^^^^^^
1235 **Success:** A successful DetachVolume returns a success status code 400.
1237 **Failure:** A failed DetachVolume returns a failure code 401 and the failure message. Failure messages can include:
1248 The Distribute Traffic LCM action is used to distribute traffic across different instances of VNF, VNFC or VM.
1249 The entity for which Distribute Traffic LCM action is being invoked is called an anchor point that is responsible for final
1250 realization of request. Parameters present in configuration file specify where and how traffic should be distributed,
1251 including: traffic destination points like VNFs, VNFCs or VMs; distribution weights; rollback strategy.
1252 Format of configuration file is specific to each VNF type. The Optimization Framework component and Homing, Allocation and
1253 Placement mechanism can be used to retrieve instances of vf-modules of anchor points and destination points with
1254 corresponding policies.
1256 This command is executed using an Ansible playbook or Chef cookbook.
1260 +--------------------------+--------------------------------------------------------------+
1261 | **Target URL** | /restconf/operations/appc-provider-lcm:distribute-traffic |
1262 +--------------------------+--------------------------------------------------------------+
1263 | **Action** | DistributeTraffic |
1264 +--------------------------+--------------------------------------------------------------+
1265 | **Action-identifiers** | vnf-id, vserver-id, vnfc-name |
1266 +--------------------------+--------------------------------------------------------------+
1267 | **Payload Parameters** | See below |
1268 +--------------------------+--------------------------------------------------------------+
1269 | **Revision History** | New in Casablanca |
1270 +--------------------------+--------------------------------------------------------------+
1272 Request Payload Parameters:
1274 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1275 | **Parameter** | **Description** | **Required?** | **Example** |
1276 +=================================+==================================================================================================================================================================+=====================+==============================================================================+
1277 | 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\": |
1278 | | values supplied. The parameters are associated with request template defined with CDT | | \"{\\\"destinations\\\": [{\\\"locationType\\\": \\\"att_aic\\\", |
1279 | | | | \\\"isRehome\\\": \\\"false\\\", \\\"aic_version\\\": \\\"1\\\", |
1280 | | | | \\\"ipv4-oam-address\\\": \\\"\\\", \\\"nf-name\\\": |
1281 | | | | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"cloudOwner\\\": |
1282 | | | | \\\"CloudOwner\\\", \\\"service_instance_id\\\": |
1283 | | | | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\", |
1284 | | | | \\\"vf-module-id\\\": \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\", |
1285 | | | | \\\"cloudClli\\\": \\\"clli1\\\", \\\"ipv6-oam-address\\\": \\\"\\\", |
1286 | | | | \\\"vf-module-name\\\": \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\", |
1287 | | | | \\\"vnfHostName\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", \\\"nf-id\\\": |
1289 | | | | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1-vfw_private_1_port-6yfzndtyjzfz\\\", |
1290 | | | | \\\"ipv4-addresses\\\": [\\\"192.168.20.100\\\"], \\\"interface-id\\\": |
1291 | | | | \\\"0a1d0300-de02-46e8-99f6-e786f1ba407a\\\", \\\"network-name\\\": |
1292 | | | | \\\"\\\", \\\"ipv6-addresses\\\": []}]}], \\\"nf-type\\\": \\\"vnf\\\"}]}\", |
1293 | | | | \"fixed_ip_address\": \"10.0.210.103\", \"book_name\": |
1294 | | | | \"vpgn/latest/ansible/distributetraffic/site.yml\", |
1295 | | | | \"ne_id\": \"vofwl01pgn4407\"}}", |
1297 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------------------------------------+
1299 Exemplary CDT template for Ansible protocol::
1302 "InventoryNames": "VM",
1303 "PlaybookName": "${()=(book_name)}",
1306 "ne_id": "${()=(ne_id)}",
1307 "fixed_ip_address": "${()=(fixed_ip_address)}"
1310 "vnfc-type": "some-vnfc"
1313 "ConfigFileName": "../traffic_distribution_config.json",
1314 "vnf_instance": "instance",
1317 "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1322 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1323 Distribute Traffic config file can have such parameters like traffic destinations, distribution weights or rollback strategy.
1325 DistributeTraffic Response
1326 ^^^^^^^^^^^^^^^^^^^^^^^^^^
1328 The response does not include any payload parameters.
1330 **Success:** A successful distribute returns a success status code 400 after all traffic has been distributed.
1332 **Failure:** A failed distribute returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1335 DistributeTrafficCheck
1336 ----------------------
1338 The Distribute Traffic Check LCM action complements Distribute Traffic LCM action with capabilities to test if destination point
1339 is ready to handle traffic or if anchor point accepts the configuration of destinations for traffic distribution. Finally,
1340 this action can be used to check if destination points handle traffic accordingly with the configuration.
1342 This command is executed using an Ansible playbook or Chef cookbook.
1346 +--------------------------+--------------------------------------------------------------------+
1347 | **Target URL** | /restconf/operations/appc-provider-lcm:distribute-traffic-check |
1348 +--------------------------+--------------------------------------------------------------------+
1349 | **Action** | DistributeTrafficCheck |
1350 +--------------------------+--------------------------------------------------------------------+
1351 | **Action-identifiers** | vnf-id, vserver-id, vnfc-name |
1352 +--------------------------+--------------------------------------------------------------------+
1353 | **Payload Parameters** | See below |
1354 +--------------------------+--------------------------------------------------------------------+
1355 | **Revision History** | New in Dublin |
1356 +--------------------------+--------------------------------------------------------------------+
1358 Request Payload Parameters:
1360 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1361 | **Parameter** | **Description** | **Required?** | **Example** |
1362 +=================================+==================================================================================================================================================================+=====================+===============================================================+
1363 | 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\": |
1364 | | values supplied. The parameters are associated with request template defined with CDT | | {\"file_parameter_content\": \"{\\\"destinations\\\": |
1366 | | | | {\\\"locationType\\\": \\\"att_aic\\\", |
1367 | | | | \\\"isRehome\\\": \\\"false\\\", |
1368 | | | | \\\"aic_version\\\": \\\"1\\\", |
1369 | | | | \\\"ipv4-oam-address\\\": \\\"\\\", |
1370 | | | | \\\"nf-name\\\": \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", |
1371 | | | | \\\"cloudOwner\\\": \\\"CloudOwner\\\", |
1372 | | | | \\\"service_instance_id\\\": |
1373 | | | | \\\"319e60ef-08b1-47aa-ae92-51b97f05e1bc\\\", |
1374 | | | | \\\"vf-module-id\\\": |
1375 | | | | \\\"0dce0e61-9309-449a-8e3e-f001635aaab1\\\", |
1376 | | | | \\\"cloudClli\\\": \\\"clli1\\\", |
1377 | | | | \\\"ipv6-oam-address\\\": \\\"\\\", |
1378 | | | | \\\"vf-module-name\\\": |
1379 | | | | \\\"Vfmodule_Ete_vFWDTvFWSNK_ccc04407_1\\\", |
1380 | | | | \\\"vnfHostName\\\": |
1381 | | | | \\\"Ete_vFWDTvFWSNK_ccc04407_1\\\", |
1382 | | | | \\\"nf-id\\\": \\\"909d396b-4d99-4c6a-a59b-abe948873303\\\", |
1384 | | | | \\\"trafficPresence\\\": true}\", |
1385 | | | | \"fixed_ip_address\": \"10.0.110.1\", \"book_name\": |
1386 | | | | \"vfw-sink/latest/ansible/distributetrafficcheck/site.yml\", |
1387 | | | | \"ne_id\": \"vofwl02vfw4407\"}}" |
1389 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------------------------------+
1391 Exemplary CDT template for Ansible protocol::
1394 "InventoryNames": "VM",
1395 "PlaybookName": "${()=(book_name)}",
1398 "ne_id": "${()=(ne_id)}",
1399 "fixed_ip_address": "${()=(fixed_ip_address)}"
1402 "vnfc-type": "some-vnfc"
1405 "ConfigFileName": "../traffic_distribution_config.json",
1406 "vnf_instance": "instance",
1409 "traffic_distribution_config.json": "${()=(file_parameter_content)}"
1414 EnvParameters includes protocol specific parameters, here with name of configuration file having additional parameters for Ansible playbook or Chef cookbook.
1415 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
1416 be performed. In the payload example there is a trafficPresence parameter that emphasises if the traffic is expected on vFW instance.
1418 DistributeTrafficCheck Response
1419 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1421 The response does not include any payload parameters.
1423 **Success:** A successful distribute traffic check returns a success status code 400 when conditions are satisfied.
1425 **Failure:** A failed check returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
1432 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).
1434 The host on which the VM resides needs to be down.
1436 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.
1438 After Evacuate, the rebuild VM can be disabled by setting the optional `rebuild-vm` parameter to false.
1440 A successful Evacuate action returns a success response. A failed Evacuate action returns a failure.
1442 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1444 +------------------------------+-------------------------------------------------------------------------+
1445 | **Target URL** | /restconf/operations/appc-provider-lcm:evacuate |
1446 +------------------------------+-------------------------------------------------------------------------+
1447 | **Action** | Evacuate |
1448 +------------------------------+-------------------------------------------------------------------------+
1449 | **Action-identifiers** | Vnf-id, vserver-id |
1450 +------------------------------+-------------------------------------------------------------------------+
1451 | **Payload Parameters** | vm-id, identity-url, tenant-id, rebuild-vm, targethost-id |
1452 +------------------------------+-------------------------------------------------------------------------+
1453 | **Revision History** | Unchanged in this release. |
1454 +------------------------------+-------------------------------------------------------------------------+
1458 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1459 | **Parameter** | **Description** | **Required?** | **Example** |
1460 +======================+==================================================================================================================================================================================+=====================+=======================================+
1461 | vm-id | The unique identifier (UUID) of the resource. For backwards- compatibility, this can be the self-link URL of the VM. | Yes | "payload": |
1462 | | | | "{\\"vm-id\\": \\"<VM-ID> |
1464 | | | | \\"identity-url\\": |
1465 | | | | \\"<IDENTITY-URL>\\", |
1466 | | | | \\"tenant-id\\": \\"<TENANT-ID> |
1468 | | | | \\"rebuild-vm\\": \\"false\\", |
1469 | | | | \\"targethost-id\\": |
1470 | | | | \\"nodeblade7\\"}" |
1471 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1472 | identity-url | The identity URL used to access the resource | Yes | |
1473 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1474 | tenant-id | The id of the provider tenant that owns the resource | Yes | |
1475 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1476 | 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 | |
1477 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+ |
1478 | targethost- id | A target hostname indicating the host the VM is evacuated to. By default, the cloud determines the target host. | No | |
1479 +----------------------+----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+---------------------------------------+
1483 **Success:** A successful Evacuate returns a success status code 400.
1484 **Failure:** A failed Evacuate returns a failure code 401 and the failure message.
1490 GetConfig LCM action for the MVM VNF types using the GetConfig playbook
1491 to retrieve the current config. This is limited to Ansible.
1493 A successful GetConfig request returns a success response.
1495 A failed GetConfig action returns a failure response code and the
1496 specific failure message in the response block.
1499 ====================== =================================================
1500 **Target URL** /restconf/operations/appc-provider-lcm: GetConfig
1501 ====================== =================================================
1502 **Action** GetConfig
1503 **Action-Identifiers** vnf-id
1504 **Payload Parameters** See table
1505 **Revision History** New in Frankfurt
1506 ====================== =================================================
1508 ========================= ========================================================================================================= ============= ======================================================================================================
1509 **Payload Parameter** **Description** **Required?** **Example**
1510 ========================= ========================================================================================================= ============= ======================================================================================================
1511 request- parameters Not used. This request is limited to Ansible only. No "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
1514 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1515 ========================= ========================================================================================================= ============= ======================================================================================================
1520 Success: A successful GetConfig returns a success status code 400.
1522 Failure: A failed GetConfig returns a failure code 401 and the failure
1529 This command runs a VNF health check and returns the result.
1531 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.
1534 +------------------------------+-----------------------------------------------------------+
1535 | **Target URL** | /restconf/operations/appc-provider-lcm:health-check |
1536 +------------------------------+-----------------------------------------------------------+
1537 | **Action** | HealthCheck |
1538 +------------------------------+-----------------------------------------------------------+
1539 | **Action-Identifiers** | Vnf-id |
1540 +------------------------------+-----------------------------------------------------------+
1541 | **Payload Parameters** | See below |
1542 +------------------------------+-----------------------------------------------------------+
1543 | **Revision History** | Unchanged in this release |
1544 +------------------------------+-----------------------------------------------------------+
1547 Request Payload Parameters:
1549 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1550 | **Parameter** | **Description** | **Required?** | **Example** |
1551 +=====================+===================================+=====================+=====================================+
1552 | request-parameters | host-ip-address - | No | "payload": |
1553 | | Required only if REST | | "{\\"request-parameters \\": |
1554 | | service. This is the ip | | "{\\"host-ip-address\\": |
1555 | | address associated with the | | \\"10.222.22.2\\" }" |
1556 | | VM running the REST | | |
1558 +---------------------+-----------------------------------+---------------------+-------------------------------------+
1561 HealthCheck Response
1562 ^^^^^^^^^^^^^^^^^^^^
1564 **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.
1569 "identifier": "scope represented",
1571 "time": "01-01-1000:0000"
1576 "identifier": "scope represented",
1577 "state": "unhealthy",
1579 "info": "System threshold exceeded details",
1583 "cpuThreshold": 0.45
1586 "time": "01-01-1000:0000"
1589 **Failure:** If the VNF is unable to run the HealthCheck. APP-C returns the error code 401 and the http error message.
1594 For LicenseManagement LCM action, invoke the LicenseManagement playbook.
1595 This is limited to Ansible.
1597 A successful LicenseManagement request returns a success response.
1599 A failed LicenseManagement action returns a failure response code and
1600 the specific failure message in the response block.
1603 ====================== ========================================================
1604 **Target URL** /restconf/operations/appc-provider-lcm:LicenseManagement
1605 ====================== ========================================================
1606 **Action** LicenseManagement
1607 **Action-Identifiers** vnf-id
1608 **Payload Parameters** See below
1609 **Revision History** New in Frankfurt
1610 ====================== ========================================================
1612 ========================= ========================================================================================================= ============= ======================================================================================================================
1613 **Payload Parameter** **Description** **Required?** **Example**
1614 ========================= ========================================================================================================= ============= ======================================================================================================================
1615 request- parameters Not used. This request is limited to Ansible only. No "action": "LicenseManagement",
1617 "action-identifiers": {
1619 "vnf-id": "rarf9901v"
1623 "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\",\"license_action\":\"update\"}}" ---
1625 license_action can have any of these values ={ upload \| add \| install \| update \| renew \| delete \| revoke \| … }:
1626 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1627 ========================= ========================================================================================================= ============= ======================================================================================================================
1629 LicenseManagement Response\ **:**
1630 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
1632 Success: A successful LicenseManagement returns a success status code
1635 Failure: A failed LicenseManagement returns a failure code 401 and the
1644 Use the Lock command to ensure exclusive access during a series of critical LCM commands.
1646 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.
1648 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.
1650 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.
1652 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.
1654 The lock automatically clears after 900 seconds (15 minutes). This 900 second value can be adjusted in the properties file
1656 +------------------------------+---------------------------------------------------+
1657 | **Target URL** | /restconf/operations/appc-provider-lcm:lock |
1658 +------------------------------+---------------------------------------------------+
1659 | **Action** | Lock |
1660 +------------------------------+---------------------------------------------------+
1661 | **Action-Identifier** | Vnf-id |
1662 +------------------------------+---------------------------------------------------+
1663 | **Payload Parameters** | None |
1664 +------------------------------+---------------------------------------------------+
1665 | **Revision History** | Unchanged in this release. |
1666 +------------------------------+---------------------------------------------------+
1671 The Lock returns a 400 Success response if the Lock is successfully applied.
1673 The Lock returns a 401 Failure response with the failure message if the Lock is not successful.
1679 Migrates a running target VM from its current host to another.
1681 A destination node will be selected by relying on internal rules to migrate. Migrate calls a command in order to perform the operation.
1683 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.
1685 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.
1688 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
1691 +--------------------------------+-----------------------------------------------------------------------------------------------+
1692 | **Input Block** | api-ver should be set to 2.00 for current version of Migrate |
1693 +--------------------------------+-----------------------------------------------------------------------------------------------+
1694 | **Target URL** | /restconf/operations/appc-provider-lcm:migrate |
1695 +--------------------------------+-----------------------------------------------------------------------------------------------+
1696 | **Action** | Migrate |
1697 +--------------------------------+-----------------------------------------------------------------------------------------------+
1698 | **Action-Identifiers** | Vnf-id, vserver-id |
1699 +--------------------------------+-----------------------------------------------------------------------------------------------+
1700 | **Payload Parameters** | vm-id, identity-url, tenant-id |
1701 +--------------------------------+-----------------------------------------------------------------------------------------------+
1702 | **Revision History** | Unchanged in this release. |
1703 +--------------------------------+-----------------------------------------------------------------------------------------------+
1707 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1708 | **Parameter** | **Description** | **Required?** | **Example** |
1709 +=====================+=========================================================================+=====================+===============================================+
1710 | vm-id | The unique identifier (UUID) of | Yes | |
1711 | | the resource. For backwards- compatibility, this can be the self- | | |
1712 | | link URL of the VM. | | "payload": |
1713 | | | | "{\\"vm-id\\": \\"<VM-ID>\\", |
1714 | | | | \\"identity-url\\": |
1715 | | | | \\"<IDENTITY-URL>\\", |
1716 +---------------------+-------------------------------------------------------------------------+---------------------+ \\"tenant-id\\": \\"<TENANT-ID>\\"}" |
1717 | identity- url | The identity url used to access the resource | Yes | |
1719 +---------------------+-------------------------------------------------------------------------+---------------------+ |
1720 | tenant-id | The id of the provider tenant that owns the resource | Yes | |
1721 +---------------------+-------------------------------------------------------------------------+---------------------+-----------------------------------------------+
1727 **Success:** A successful Migrate returns a success status code 400.
1729 **Failure:** A failed Migrate returns a failure code 401 and the failure message.
1735 PostEvacuate LCM action using the PostEvacuate playbook. This is limited
1738 A successful PostEvacuate request returns a success response.
1740 A failed PostEvacuate action returns a failure response code and the
1741 specific failure message in the response block.
1743 ====================== ====================================================
1744 **Target URL** /restconf/operations/appc-provider-lcm: PostEvacuate
1745 ====================== ====================================================
1746 **Action** PostEvacuate
1747 **Action-Identifiers** vnf-id
1748 **Payload Parameters** See table
1749 **Revision History** New in Frankfurt
1750 ====================== ====================================================
1752 ========================= ========================================================================================================= ============= =====================================================================================================
1753 **Payload Parameter** **Description** **Required?** **Example**
1754 ========================= ========================================================================================================= ============= =====================================================================================================
1755 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1756 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1757 ========================= ========================================================================================================= ============= =====================================================================================================
1759 PostEvacuate Response:
1760 ~~~~~~~~~~~~~~~~~~~~~~
1762 Success: A successful PostEvacuate returns a success status code 400.
1764 Failure: A failed PostEvacuate returns a failure code 401 and the
1771 PostMigrate LCM action using the PostMigrate playbook. This is limited
1774 A successful PostMigrate request returns a success response.
1776 A failed PostMigrate action returns a failure response code and the
1777 specific failure message in the response block.
1780 ====================== ===================================================
1781 **Target URL** /restconf/operations/appc-provider-lcm: PostMigrate
1782 ====================== ===================================================
1783 **Action** PostMigrate
1784 **Action-Identifiers** vnf-id
1785 **Payload Parameters** See below
1786 **Revision History** New in Frankfurt
1787 ====================== ===================================================
1789 ========================= ========================================================================================================= ============= =====================================================================================================
1790 **Payload Parameter** **Description** **Required?** **Example**
1791 ========================= ========================================================================================================= ============= =====================================================================================================
1792 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1793 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1794 ========================= ========================================================================================================= ============= =====================================================================================================
1796 PostMigrate Response:
1797 ~~~~~~~~~~~~~~~~~~~~~
1799 Success: A successful PostMigrate returns a success status code 400.
1801 Failure: A failed PostMigrate returns a failure code 401 and the failure
1809 PostRebuild LCM action using the PostRebuild playbook. This is limited
1812 A successful PostRebuild request returns a success response.
1814 A failed PostRebuild action returns a failure response code and the
1815 specific failure message in the response block.
1817 ====================== ===================================================
1818 **Target URL** /restconf/operations/appc-provider-lcm: PostRebuild
1819 ====================== ===================================================
1820 **Action** PostRebuild
1821 **Action-Identifiers** vnf-id
1822 **Payload Parameters** See table
1823 **Revision History** New in Frankfurt
1824 ====================== ===================================================
1826 ========================= ========================================================================================================= ============= =====================================================================================================
1827 **Payload Parameter** **Description** **Required?** **Example**
1828 ========================= ========================================================================================================= ============= =====================================================================================================
1829 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1830 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1831 ========================= ========================================================================================================= ============= =====================================================================================================
1833 PostRebuild Response:
1834 ~~~~~~~~~~~~~~~~~~~~~
1836 Success: A successful PostRebuild returns a success status code 400.
1838 Failure: A failed PostRebuild returns a failure code 401 and the failure
1845 PreConfig LCM action for the MVM VNF types using the PreConfigure
1846 playbook. This is limited to Ansible.
1848 A successful PreConfig request returns a success response.
1850 A failed PreConfig action returns a failure response code and the
1851 specific failure message in the response block.
1854 ====================== =================================================
1855 **Target URL** /restconf/operations/appc-provider-lcm: PreConfig
1856 ====================== =================================================
1857 **Action** PreConfig
1858 **Action-Identifiers** vnf-id
1859 **Payload Parameters** See table
1860 **Revision History** New in Frankfurt
1861 ====================== =================================================
1863 ========================= ========================================================================================================= ============= ======================================================================================================
1864 **Payload Parameter** **Description** **Required?** **Example**
1865 ========================= ========================================================================================================= ============= ======================================================================================================
1866 request- parameters Not used. This request is limited to Ansible only. No "payload": "{\"configuration-parameters\":{\"vnf_name\":\"test\",\"operations_timeout\":\"3600\"}}" or
1869 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1870 ========================= ========================================================================================================= ============= ======================================================================================================
1875 Success: A successful PreConfig returns a success status code 400.
1877 Failure: A failed PreConfig returns a failure code 401 and the failure
1883 PreEvacuate LCM action using the PreEvacuate playbook. This is limited
1886 A successful PreEvacuate request returns a success response.
1888 A failed PreEvacuate action returns a failure response code and the
1889 specific failure message in the response block.
1892 ====================== ===================================================
1893 **Target URL** /restconf/operations/appc-provider-lcm: PreEvacuate
1894 ====================== ===================================================
1895 **Action** PreEvacuate
1896 **Action-Identifiers** vnf-id
1897 **Payload Parameters** See table
1898 **Revision History** New in Frankfurt
1899 ====================== ===================================================
1901 ========================= ========================================================================================================= ============= =====================================================================================================
1902 **Payload Parameter** **Description** **Required?** **Example**
1903 ========================= ========================================================================================================= ============= =====================================================================================================
1904 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1905 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1906 ========================= ========================================================================================================= ============= =====================================================================================================
1908 PreEvacuate Response:
1909 ~~~~~~~~~~~~~~~~~~~~~
1911 Success: A successful PreEvacuate returns a success status code 400.
1913 Failure: A failed PreEvacuate returns a failure code 401 and the failure
1919 PreMigrate LCM action using the PreMigrate playbook. This is limited to
1922 A successful PreMigrate request returns a success response.
1924 A failed PreMigrate action returns a failure response code and the
1925 specific failure message in the response block.
1927 ====================== ==================================================
1928 **Target URL** /restconf/operations/appc-provider-lcm: PreMigrate
1929 ====================== ==================================================
1930 **Action** PreMigrate
1931 **Action-Identifiers** vnf-id
1932 **Payload Parameters** See table
1933 **Revision History** New in Frankfurt
1934 ====================== ==================================================
1936 ========================= ========================================================================================================= ============= =====================================================================================================
1937 **Payload Parameter** **Description** **Required?** **Example**
1938 ========================= ========================================================================================================= ============= =====================================================================================================
1939 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1940 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1941 ========================= ========================================================================================================= ============= =====================================================================================================
1943 PreMigrate Response:
1944 ~~~~~~~~~~~~~~~~~~~~
1946 Success: A successful PreMigrate returns a success status code 400.
1948 Failure: A failed PreMigrate returns a failure code 401 and the failure
1955 PreRebuild LCM action using the PreRebuild playbook. This is limited to
1958 A successful PreRebuild request returns a success response.
1960 A failed PreRebuild action returns a failure response code and the
1961 specific failure message in the response block.
1964 ====================== ==================================================
1965 **Target URL** /restconf/operations/appc-provider-lcm: PreRebuild
1966 ====================== ==================================================
1967 **Action** PreRebuild
1968 **Action-Identifiers** vnf-id
1969 **Payload Parameters** See table
1970 **Revision History** New in Frankfurt
1971 ====================== ==================================================
1973 ========================= ========================================================================================================= ============= =====================================================================================================
1974 **Payload Parameter** **Description** **Required?** **Example**
1975 ========================= ========================================================================================================= ============= =====================================================================================================
1976 request- parameters Not used. This request is limited to Ansible only. No "payload" : "{\"configuration-parameters\":{\"vnf_name\":\"xxxxxx\",\"vm_name\":\"135.21.178.100\"}}"
1977 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
1978 ========================= ========================================================================================================= ============= =====================================================================================================
1980 PreRebuild Response:
1981 ~~~~~~~~~~~~~~~~~~~~
1983 Success: A successful PreRebuild returns a success status code 400.
1985 Failure: A failed PreRebuild returns a failure code 401 and the failure
1992 For Provisioning LCM action, invoke the Provisioning playbook. This is
1995 A successful Provisioning request returns a success response.
1997 A failed Provisioning action returns a failure response code and the
1998 specific failure message in the response block.
2001 ====================== ===================================================
2002 **Target URL** /restconf/operations/appc-provider-lcm:Provisioning
2003 ====================== ===================================================
2004 **Action** Provisioning
2005 **Action-Identifiers** vnf-id
2006 **Payload Parameters** See table
2007 **Revision History** New in Frankfurt
2008 ====================== ===================================================
2010 ========================= ========================================================================================================= ============= =========================
2011 **Payload Parameter** **Description** **Required?** **Example**
2012 ========================= ========================================================================================================= ============= =========================
2013 request- parameters Not used. This request is limited to Ansible only. No "action": "Provisioning",
2015 "action-identifiers": {
2017 "vnf-id": "rarf9901v"
2022 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2023 ========================= ========================================================================================================= ============= =========================
2025 Provisioning Response\ **:**
2026 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2028 Success: A successful Provisioning returns a success status code 400.
2030 Failure: A failed Provisioning returns a failure code 401 and the
2038 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.
2040 This command is executed using an Ansible playbook or Chef cookbook.
2044 +--------------------------+----------------------------------------------------------+
2045 | **Target URL** | /restconf/operations/appc-provider-lcm:quiesce-traffic |
2046 +--------------------------+----------------------------------------------------------+
2047 | **Action** | QuiesceTraffic |
2048 +--------------------------+----------------------------------------------------------+
2049 | **Action-identifiers** | vnf-id |
2050 +--------------------------+----------------------------------------------------------+
2051 | **Payload Parameters** | operations-timeout |
2052 +--------------------------+----------------------------------------------------------+
2053 | **Revision History** | New in Beijing |
2054 +--------------------------+----------------------------------------------------------+
2056 Request Payload Parameters:
2058 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2059 | **Parameter** | **Description** | **Required?** | **Example** |
2060 +=======================+======================================================================================================================================================================================================+=====================+================================================+
2061 | 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": |
2062 | | | | "{\\"operations-timeout\\": \\"3600\\"}” |
2063 +-----------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+------------------------------------------------+
2065 QuiesceTraffic Response
2066 ^^^^^^^^^^^^^^^^^^^^^^^
2068 The response does not include any payload parameters.
2070 **Success:** A successful quiesce returns a success status code 400 after all traffic has been quiesced.
2072 If a quiesce command is executed and the traffic has been previously quiesced, it should return a success status.
2074 **Failure:** A failed quiesce returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2076 A specific error message is returned if there is a timeout error.
2081 The Reboot is used to reboot a VM.
2084 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.
2086 **NOTE:** The command implementation is based on OpenStack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2088 +------------------------------+-----------------------------------------------------------------------------------------------+
2089 | **Input Block** | api-ver should be set to 2.00 for current version of Reboot |
2090 +------------------------------+-----------------------------------------------------------------------------------------------+
2091 | **Target URL** | /restconf/operations/appc-provider-lcm:reboot |
2092 +------------------------------+-----------------------------------------------------------------------------------------------+
2093 | **Action** | Reboot |
2094 +------------------------------+-----------------------------------------------------------------------------------------------+
2095 | **Action-identifiers** | Vnf-id, vserver-id |
2096 +------------------------------+-----------------------------------------------------------------------------------------------+
2097 | **Payload Parameters** | See table below |
2098 +------------------------------+-----------------------------------------------------------------------------------------------+
2099 | **Revision History** | New in R3 release. |
2100 +------------------------------+-----------------------------------------------------------------------------------------------+
2104 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2105 | **Parameter** | **Description** | **Required?** | **Example** |
2106 +=================+===============================================+=================+=========================================+
2107 | type | The type of reboot. Values are | No | |
2108 | | HARD and SOFT. If not | | |
2109 | | specified, SOFT reboot is | | "payload": |
2110 | | performed. | | "{\\"type\\": \\"HARD\\", |
2111 | | | | \\"vm-id\\": \\"<VM-ID>\\", |
2112 | | | | \\"identity-url\\": |
2113 | | | | \\"<IDENTITY-URL>\\" |
2115 +-----------------+-----------------------------------------------+-----------------+ |
2116 | vm-id | The unique identifier (UUID) of | Yes | |
2117 | | the resource. For backwards- | | |
2118 | | compatibility, this can be the self- | | |
2119 | | link URL of the VM. | | |
2124 +-----------------+-----------------------------------------------+-----------------+ |
2125 | identity-url | The identity url used to access the | Yes | |
2127 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2132 **Success:** A successful Rebuild returns a success status code 400.
2134 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2139 Recreates a target VM instance to a known, stable state.
2141 Rebuild calls an OpenStack command immediately and therefore does not expect any prerequisite operations to be performed, such as shutting off a VM.
2143 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.
2145 APPC rejects a rebuild request if it determines the VM boots from a Cinder Volume
2148 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2151 +------------------------------+-----------------------------------------------------------------------------------------------+
2152 | **Input Block** | api-ver should be set to 2.00 for current version of Rebuild |
2153 +------------------------------+-----------------------------------------------------------------------------------------------+
2154 | **Target URL** | /restconf/operations/appc-provider-lcm:rebuild |
2155 +------------------------------+-----------------------------------------------------------------------------------------------+
2156 | **Action** | Rebuild |
2157 +------------------------------+-----------------------------------------------------------------------------------------------+
2158 | **Action-identifiers** | Vnf-id, vserver-id |
2159 +------------------------------+-----------------------------------------------------------------------------------------------+
2160 | **Payload Parameters** | See table below |
2161 +------------------------------+-----------------------------------------------------------------------------------------------+
2162 | **Revision History** | Unchanged in this release. |
2163 +------------------------------+-----------------------------------------------------------------------------------------------+
2168 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2169 | **Parameter** | **Description** | **Required?** | **Example** |
2170 +=================+===============================================+=================+=========================================+
2171 | vm-id | The unique identifier (UUID) of | Yes | |
2172 | | the resource. For backwards- | | |
2173 | | compatibility, this can be the self- | | "payload": |
2174 | | link URL of the VM. | | "{\\"vm-id\\": \\"<VM-ID> |
2176 | | | | \\"identity-url\\": |
2177 | | | | \\"<IDENTITY-URL>\\", |
2178 | | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" |
2179 +-----------------+-----------------------------------------------+-----------------+ \\"snapshot-id\\": \\"<SNAPSHOT- ID>\\" |
2180 | identity- url | The identity url used to access the | Yes | }" |
2182 +-----------------+-----------------------------------------------+-----------------+ |
2183 | tenant-id | The id of the provider tenant that owns | Yes | |
2184 | | the resource. | | |
2185 +-----------------+-----------------------------------------------+-----------------+ |
2186 | snapshot-id | The snapshot-id of a previously saved image. | No | |
2187 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2192 **Success:** A successful Rebuild returns a success status code 400.
2194 **Failure:** A failed Rebuild returns a failure code 401 and the failure message.
2199 Use the Restart command to restart a VM.
2201 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2202 | **Input Block** | api-ver should be set to 2.00 for current version of Restart |
2203 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2204 | **Target URL** | /restconf/operations/appc-provider-lcm:restart |
2205 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2206 | **Action** | Restart |
2207 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2208 | **Action-identifiers** | vnf-id and vserver-id are required |
2209 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2210 | **Payload Parameters** | See table below |
2211 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2212 | **Revision History** | Unchanged in this release |
2213 +------------------------------+-----------------------------------------------------------------------------------------------------------------+
2215 Payload Parameters for **VM Restart**
2217 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2218 | **Parameter** | **Description** | **Required?** | **Example** |
2219 +=====================+=========================================================================+=====================+====================================+
2220 | vm-id | The unique identifier (UUID) of | Yes | |
2221 | | the resource. For backwards- compatibility, this can be the self- | | |
2222 | | link URL of the VM | | "payload": |
2223 | | | | "{\\"vm-id\\": \\"<VM-ID>\\", |
2224 | | | | \\"identity-url\\": |
2225 +---------------------+-------------------------------------------------------------------------+---------------------+ \\"<IDENTITY-URL>\\", |
2226 | identity- url | The identity url used to access the resource | No | \\"tenant-id\\": \\"<TENANT- |
2228 +---------------------+-------------------------------------------------------------------------+---------------------+ |
2229 | tenant-id | The id of the provider tenant that owns the resource | No | |
2230 +---------------------+-------------------------------------------------------------------------+---------------------+------------------------------------+
2235 The ResumeTraffic LCM action resumes processing traffic on a VNF that has been previously quiesced.
2237 This command is executed using an Ansible playbook or Chef cookbook.
2239 Request Structure: The payload does not have any parameters.
2241 +--------------------------+---------------------------------------------------------+
2242 | **Target URL** | /restconf/operations/appc-provider-lcm:resume-traffic |
2243 +--------------------------+---------------------------------------------------------+
2244 | **Action** | ResumeTraffic |
2245 +--------------------------+---------------------------------------------------------+
2246 | **Action-identifiers** | vnf-id |
2247 +--------------------------+---------------------------------------------------------+
2248 | **Payload Parameters** | |
2249 +--------------------------+---------------------------------------------------------+
2250 | **Revision History** | New in Beijing |
2251 +--------------------------+---------------------------------------------------------+
2253 ResumeTraffic Response
2254 ^^^^^^^^^^^^^^^^^^^^^^
2256 **Success:** A successful ResumeTraffic returns a success status code 400 after traffic has been resumed.
2258 If a ResumeTraffic command is executed and the traffic is currently being processed, it should return a success status
2260 **Failure:** A failed ResumeTraffic returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2266 Creates a snapshot of a VM.
2268 The Snapshot command returns a customized response containing a reference to the newly created snapshot instance if the action is successful.
2270 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.
2272 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.
2274 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2276 +------------------------------+-----------------------------------------------------------------------------------------------------+
2277 | **Target URL** | /restconf/operations/appc-provider-lcm:snapshot |
2278 +------------------------------+-----------------------------------------------------------------------------------------------------+
2279 | **Action** | Snapshot |
2280 +------------------------------+-----------------------------------------------------------------------------------------------------+
2281 | **Action-identifiers** | vnf-id, vserver-id |
2282 +------------------------------+-----------------------------------------------------------------------------------------------------+
2283 | **Payload Parameters** | vm-id, identity-url, tenant-id |
2284 +------------------------------+-----------------------------------------------------------------------------------------------------+
2285 | **Revision History** | Unchanged in this release. |
2286 +------------------------------+-----------------------------------------------------------------------------------------------------+
2290 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2291 | **Parameter** | **Description** | **Required?** | **Example** |
2292 +=====================+=========================================================================+=====================+========================================+
2293 | vm-id | The self-link URL of the VM | Yes | |
2294 | | | | "payload": |
2295 | | | | "{\\"vm-id\\": \\"<VM-ID>\\", |
2296 | | | | \\"identity-url\\": |
2297 | | | | \\"<IDENTITY-URL>\\", |
2298 | | | | \\"tenant-id\\":\\"<TENANT-ID>\\"}"|
2299 +---------------------+-------------------------------------------------------------------------+---------------------+ |
2300 | identity- url | The identity url used to access the resource | No | |
2302 +---------------------+-------------------------------------------------------------------------+---------------------+ |
2303 | tenant-id | The id of the provider tenant that owns the resource | No | |
2304 +---------------------+-------------------------------------------------------------------------+---------------------+----------------------------------------+
2309 The Snapshot command returns an extended version of the LCM response.
2311 The Snapshot response conforms to the standard response format.
2317 Use the Start command to start a VM that is stopped.
2319 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2321 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2322 | **Target URL** | /restconf/operations/appc-provider-lcm:start |
2323 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2324 | **Action** | Start |
2325 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2326 | **Action-identifiers** | vnf-id and vserver-id are required |
2327 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2328 | **Payload Parameters** | See table below |
2329 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2330 | **Revision History** | Unchanged in this release |
2331 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2335 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2336 | **Parameter** | **Description** | **Required?** | **Example** |
2337 +=================+===============================================+=================+=========================================+
2338 | vm-id | The unique identifier (UUID) of | Yes | |
2339 | | the resource. For backwards- | | "payload": |
2340 | | compatibility, this can be the self- | | "{\\"vm-id\\": \\"<VM-ID> |
2341 | | link URL of the VM. | | \\", |
2342 | | | | \\"identity-url\\": |
2343 | | | | \\"<IDENTITY-URL>\\", |
2344 | | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" |
2345 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2346 | identity- url | The identity url used to access the | No | |
2348 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2349 | tenant-id | The id of the provider tenant that owns | No | |
2350 | | the resource | | |
2351 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2357 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.
2359 A successful StartApplication request returns a success response.
2361 A failed StartApplication action returns a failure response code and the specific failure message in the response block.
2363 +------------------------------+---------------------------------------------------------------+
2364 | **Target URL** | /restconf/operations/appc-provider-lcm:start-application |
2365 +------------------------------+---------------------------------------------------------------+
2366 | **Action** | StartApplication |
2367 +------------------------------+---------------------------------------------------------------+
2368 | **Action-Identifiers** | Vnf-id |
2369 +------------------------------+---------------------------------------------------------------+
2370 | **Payload Parameters** | See table below |
2371 +------------------------------+---------------------------------------------------------------+
2372 | **Revision History** | Unchanged in this release. |
2373 +------------------------------+---------------------------------------------------------------+
2377 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2378 | **Payload Parameter** | **Description** | **Required?** | **Example** |
2379 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2380 | | | | "payload": |
2381 | 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>\\"} |
2382 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2384 StartApplication Response
2385 ^^^^^^^^^^^^^^^^^^^^^^^^^
2387 The StartApplication response returns an indication of success or failure of the request.
2392 For StartTraffic LCM action, invoke the StartTraffic playbook. This is
2395 A successful StartTraffic request returns a success response.
2397 A failed StartTraffic action returns a failure response code and the
2398 specific failure message in the response block.
2401 ====================== ===================================================
2402 **Target URL** /restconf/operations/appc-provider-lcm:StartTraffic
2403 ====================== ===================================================
2404 **Action** StartTraffic
2405 **Action-Identifiers** vnf-id
2406 **Payload Parameters** See table
2407 **Revision History** New in Frankfurt
2408 ====================== ===================================================
2410 ========================= ========================================================================================================= ============= =========================
2411 **Payload Parameter** **Description** **Required?** **Example**
2412 ========================= ========================================================================================================= ============= =========================
2413 request- parameters Not used. This request is limited to Ansible only. No "action": "StartTraffic",
2415 "action-identifiers": {
2417 "vnf-id": "rarf9901v"
2422 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2423 ========================= ========================================================================================================= ============= =========================
2425 StartTraffic Response\ **:**
2426 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2428 Success: A successful StartTraffic returns a success status code 400.
2430 Failure: A failed StartTraffic returns a failure code 401 and the
2438 For StatusTraffic LCM action, invoke the StatusTraffic playbook. This is
2441 A successful StatusTraffic request returns a success response.
2443 A failed StatusTraffic action returns a failure response code and the
2444 specific failure message in the response block.
2446 ====================== ====================================================
2447 **Target URL** /restconf/operations/appc-provider-lcm:StatusTraffic
2448 ====================== ====================================================
2449 **Action** StatusTraffic
2450 **Action-Identifiers** vnf-id
2451 **Payload Parameters** See table
2452 **Revision History** New in Frankfurt
2453 ====================== ====================================================
2455 ========================= ========================================================================================================= ============= ==========================
2456 **Payload Parameter** **Description** **Required?** **Example**
2457 ========================= ========================================================================================================= ============= ==========================
2458 request- parameters Not used. This request is limited to Ansible only. No "action": "StatusTraffic",
2460 "action-identifiers": {
2462 "vnf-id": "rarf9901v"
2467 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2468 ========================= ========================================================================================================= ============= ==========================
2470 StatusTraffic Response\ **:**
2471 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2473 Success: A successful StatusTraffic returns a success status code 400.
2475 Failure: A failed StatusTraffic returns a failure code 401 and the
2482 Use the Stop command to stop a VM that was running.
2484 **NOTE:** The command implementation is based on Openstack functionality. For further details, see http://developer.openstack.org/api-ref/compute/.
2486 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2487 | **Target URL** | /restconf/operations/appc-provider-lcm:stop |
2488 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2489 | **Action** | Stop |
2490 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2491 | **Action-identifiers** | vnf-id and vserver-id are required. |
2492 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2493 | **Payload Parameters** | See table below |
2494 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2495 | **Revision History** | Unchanged in this release |
2496 +------------------------------+--------------------------------------------------------------------------------------------------------------------------------+
2500 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2501 | **Parameter** | **Description** | **Required?** | **Example** |
2502 +=================+===============================================+=================+=========================================+
2503 | vm-id | The unique identifier (UUID) of | Yes | |
2504 | | the resource. For backwards- | | "payload": |
2505 | | compatibility, this can be the self- | | "{\\"vm-id\\": \\"<VM-ID> |
2506 | | link URL of the VM. | | \\", |
2507 | | | | \\"identity-url\\": |
2508 | | | | \\"<IDENTITY-URL>\\", |
2509 | | | | \\"tenant-id\\": \\"<TENANT- ID>\\"}" |
2510 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2511 | identity- url | The identity url used to access the | No | |
2513 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2514 | tenant-id | The id of the provider tenant that owns | No | |
2515 | | the resource | | |
2516 +-----------------+-----------------------------------------------+-----------------+-----------------------------------------+
2522 Stops the VNF application gracefully (not lost traffic), if needed, prior to a Stop command. Supported using Chef cookbook or Ansible playbook only.
2524 A successful StopApplication request returns a success response.
2526 A failed StopApplication action returns a failure response code and the specific failure message in the response block.
2528 +------------------------------+--------------------------------------------------------------+
2529 | **Target URL** | /restconf/operations/appc-provider-lcm:stop-application |
2530 +------------------------------+--------------------------------------------------------------+
2531 | **Action** | StopApplication |
2532 +------------------------------+--------------------------------------------------------------+
2533 | **Action-Identifiers** | Vnf-id |
2534 +------------------------------+--------------------------------------------------------------+
2535 | **Payload Parameters** | See table below |
2536 +------------------------------+--------------------------------------------------------------+
2537 | **Revision History** | Unchanged in this release |
2538 +------------------------------+--------------------------------------------------------------+
2542 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2543 | **Payload Parameter** | **Description** | **Required?** | **Example** |
2544 +=================================+====================================================================================================================================================================================+=====================+=================================================================+
2545 | configuration- parameters | A set of instance specific configuration parameters should be specified, as required by the Chef cookbook or Ansible playbook. | No | "payload": |
2546 | | | | \\"configuration- parameters\\": {\\"<CONFIG- PARAMS>\\"} |
2547 +---------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+-----------------------------------------------------------------+
2550 StopApplication Response
2551 ^^^^^^^^^^^^^^^^^^^^^^^^
2553 The StopApplication response returns an indication of success or failure of the request.
2558 For StopTraffic LCM action, invoke the StopTraffic playbook. This is
2561 A successful StopTraffic request returns a success response.
2563 A failed StopTraffic action returns a failure response code and the
2564 specific failure message in the response block.
2567 ====================== ==================================================
2568 **Target URL** /restconf/operations/appc-provider-lcm:StopTraffic
2569 ====================== ==================================================
2570 **Action** Provisioning
2571 **Action-Identifiers** vnf-id
2572 **Payload Parameters** See table
2573 **Revision History** New in Frankfurt
2574 ====================== ==================================================
2576 ========================= ========================================================================================================= ============= ========================================================================
2577 **Payload Parameter** **Description** **Required?** **Example**
2578 ========================= ========================================================================================================= ============= ========================================================================
2579 request- parameters Not used. This request is limited to Ansible only. No "action": "StopTraffic",
2581 "action-identifiers": {
2583 "vnf-id": "rarf9901v"
2587 "payload": "{\"configuration-parameters\":{\"vnf_name\":\"rarf9901v\"}}"
2588 configuration- parameters A set of instance specific configuration parameters should be specified, as required by Ansible playbook. No
2589 ========================= ========================================================================================================= ============= ========================================================================
2591 StopTraffic Response\ **:**
2592 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
2594 Success: A successful StopTraffic returns a success status code 400.
2596 Failure: A failed StopTraffic returns a failure code 401 and the failure
2603 The Sync action updates the current configuration in the APPC store with the running configuration from the device.
2605 A successful Sync returns a success status.
2607 A failed Sync returns a failure response status and failure messages in the response payload block.
2609 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).
2611 +------------------------------+---------------------------------------------------+
2612 | **Target URL** | /restconf/operations/appc-provider-lcm:sync |
2613 +------------------------------+---------------------------------------------------+
2614 | **Action** | Sync |
2615 +------------------------------+---------------------------------------------------+
2616 | **Action-identifiers** | Vnf-id |
2617 +------------------------------+---------------------------------------------------+
2618 | **Payload Parameters** | See below |
2619 +------------------------------+---------------------------------------------------+
2620 | **Revision History** | Unchanged in this release. |
2621 +------------------------------+---------------------------------------------------+
2623 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2624 | **Parameter** | **Description** | **Required?** | **Example** |
2625 +======================+===========================================================================================================================================================+=====================+==================================+
2626 | 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>" |
2628 | | \* If the publish\-config field is set to N in the payload, then running configuration is not written to the file | | |
2630 +----------------------+-----------------------------------------------------------------------------------------------------------------------------------------------------------+---------------------+----------------------------------+
2636 Run the Unlock command to release the lock on a VNF and allow other clients to perform LCM commands on that VNF.
2638 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.
2640 The Unlock command will result in success if the VNF successfully unlocked or if it was already unlocked, otherwise commands will be rejected.
2642 The Unlock command will only return success if the VNF was locked with same request-id.
2644 The Unlock command returns only one final response with the status of the request processing.
2646 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.
2648 +------------------------------+-----------------------------------------------------+
2649 | **Target URL** | /restconf/operations/appc-provider-lcm:unlock |
2650 +------------------------------+-----------------------------------------------------+
2651 | **Action** | Unlock |
2652 +------------------------------+-----------------------------------------------------+
2653 | **Action-identifiers** | Vnf-id |
2654 +------------------------------+-----------------------------------------------------+
2655 | **Payload Parameters** | see table below |
2656 +------------------------------+-----------------------------------------------------+
2657 | **Revision History** | Unchanged in this release. |
2658 +------------------------------+-----------------------------------------------------+
2662 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2663 | **Payload Parameter** | **Description** | **Required?** | **Example** |
2664 +=================================+=========================================================================+=====================+==================================+
2665 | request-id | Request id from the previously submitted request | Yes | "request-id": "123456789" |
2666 +---------------------------------+-------------------------------------------------------------------------+---------------------+----------------------------------+
2672 The UpgradeBackout LCM action does a backout after an UpgradeSoftware is completed (either successfully or unsuccessfully).
2674 This command is executed using an Ansible playbook or Chef cookbook.
2676 Request Structure: The request payload includes an upgrade identifier.
2678 +--------------------------+----------------------------------------------------------+
2679 | **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-backout |
2680 +--------------------------+----------------------------------------------------------+
2681 | **Action** | UpgradeBackout |
2682 +--------------------------+----------------------------------------------------------+
2683 | **Action-identifiers** | vnf-id |
2684 +--------------------------+----------------------------------------------------------+
2685 | **Payload Parameters** | existing-software-version, new-software-version |
2686 +--------------------------+----------------------------------------------------------+
2687 | **Revision History** | New in Beijing |
2688 +--------------------------+----------------------------------------------------------+
2690 Request Payload Parameters:
2692 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2693 | **Parameter** | **Description** | **Required?** | **Example** |
2694 +=======================+=====================================+=====================+===============================================================================================+
2695 | existing-software- | The existing software version | Yes | "payload": |
2696 | version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” |
2697 +-----------------------+-------------------------------------+---------------------+ |
2698 | new-software- | The new software | Yes | |
2699 | version | version after the | | |
2701 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2703 UpgradeBackout Response
2704 ^^^^^^^^^^^^^^^^^^^^^^^
2706 **Success:** A successful backout returns a success status code 400.
2708 **Failure:** A failed backout returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2713 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.
2715 This command is executed using an Ansible playbook or Chef cookbook.
2717 Request Structure: The payload does not have any parameters required.
2719 +--------------------------+---------------------------------------------------------+
2720 | **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-backup |
2721 +--------------------------+---------------------------------------------------------+
2722 | **Action** | UpgradeBackup |
2723 +--------------------------+---------------------------------------------------------+
2724 | **Action-identifiers** | vnf-id |
2725 +--------------------------+---------------------------------------------------------+
2726 | **Payload Parameters** | existing-software-version, new-software-version |
2727 +--------------------------+---------------------------------------------------------+
2728 | **Revision History** | New in Beijing. |
2729 +--------------------------+---------------------------------------------------------+
2731 Request Payload Parameters:
2733 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2734 | **Parameter** | **Description** | **Required?** | **Example** |
2735 +=======================+=====================================+=====================+===============================================================================================+
2736 | existing-software- | The existing software version | Yes | "payload": |
2737 | version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” |
2738 +-----------------------+-------------------------------------+---------------------+ |
2739 | new-software- | The new software | Yes | |
2740 | version | version after the | | |
2741 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2743 UpgradeBackup Response
2744 ^^^^^^^^^^^^^^^^^^^^^^
2746 **Success:** A successful backup returns a success status code 400.
2748 **Failure:** A failed backup returns a failure code 401 and the failure message from the Ansible or Chef server in the response payload block.
2753 The UpgradePostCheck LCM action checks that the VNF upgrade has been successful completed and all processes are running properly.
2755 This command is executed using an Ansible playbook or Chef cookbook.
2759 +--------------------------+-------------------------------------------------------------+
2760 | **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-post-check |
2761 +--------------------------+-------------------------------------------------------------+
2762 | **Action** | UpgradePostCheck |
2763 +--------------------------+-------------------------------------------------------------+
2764 | **Action-identifiers** | vnf-id |
2765 +--------------------------+-------------------------------------------------------------+
2766 | **Payload Parameters** | existing-software-version, new-software-version |
2767 +--------------------------+-------------------------------------------------------------+
2768 | **Revision History** | New in Beijing |
2769 +--------------------------+-------------------------------------------------------------+
2771 Request Payload Parameters:
2773 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2774 | **Parameter** | **Description** | **Required?** | **Example** |
2775 +=======================+=====================================+=====================+===============================================================================================+
2776 | existing- software- | The existing software version | Yes | "payload": |
2777 | version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” |
2778 +-----------------------+-------------------------------------+---------------------+ |
2779 | new-software- | The new software | Yes | |
2780 | version | version after the | | |
2781 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2783 UpgradePostCheck Response
2784 ^^^^^^^^^^^^^^^^^^^^^^^^^
2786 **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).
2788 Response Payload Parameters:
2790 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2791 | **Parameter** | **Description** |**Required?**| **Example** |
2792 +===============+=============================+=============+==============================================================================+
2793 | Upgrade- | Returns the status | Yes | |
2794 | Status | of the upgradw | | "payload": |
2795 | | post-check. Indicates | | "{\\"upgrade-status\\": \\"Completed\\"}” |
2796 | | Completed or Failed | | "payload": "{\\"upgrade-status\\": |
2797 | | | | \\"Failed\\",\\"message\\": \\"Version 3.2 is not running properly\\" }” |
2798 +---------------+-----------------------------+-------------+ |
2799 | Message | If Not Available, | | |
2800 | | message contains | | |
2801 | | explanation. | | |
2802 +---------------+-----------------------------+-------------+------------------------------------------------------------------------------+
2804 **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.
2809 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).
2811 This command is executed using an Ansible playbook or Chef cookbook.
2815 +--------------------------+------------------------------------------------------------+
2816 | **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-pre-check |
2817 +--------------------------+------------------------------------------------------------+
2818 | **Action** | UpgradePreCheck |
2819 +--------------------------+------------------------------------------------------------+
2820 | **Action-identifiers** | vnf-id |
2821 +--------------------------+------------------------------------------------------------+
2822 | **Payload Parameters** | existing-software-version, new-software-version |
2823 +--------------------------+------------------------------------------------------------+
2824 | **Revision History** | New in Beijing |
2825 +--------------------------+------------------------------------------------------------+
2827 Request Payload Parameters:
2829 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2830 | **Parameter** | **Description** | **Required?** | **Example** |
2831 +=======================+=====================================+=====================+===============================================================================================+
2832 | existing-software- | The existing software version | Yes | "payload": |
2833 | version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” |
2834 +-----------------------+-------------------------------------+---------------------+ |
2835 | new-software- | The new software | Yes | |
2836 | version | version after the | | |
2838 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2840 UpgradePreCheck Response
2841 ^^^^^^^^^^^^^^^^^^^^^^^^
2843 **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).
2845 Response Payload Parameters:
2847 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2848 | **Parameter** | **Description** | **Required?** | **Example** |
2849 +=================+===========================+=====================+==================================================================================================================================+
2850 | upgrade-status | Returns the status | Yes | |
2851 | | of the upgrade pre- | | "payload": |
2852 | | check. Indicates | | "{\\"upgrade-status\\": \\"Available\\"}” |
2853 | | Available or Not | | |
2854 | | Available | | "payload": |
2855 | | | | "{\\"upgrade-status\\": \\"Not Available\\",\\"message\\": \\"Current software version 2.9 cannot be upgraded to 3.1\\" }” |
2856 +-----------------+---------------------------+---------------------+ |
2857 | message | If Not Available, | | |
2858 | | message contains | | |
2859 | | explanation. | | |
2860 +-----------------+---------------------------+---------------------+----------------------------------------------------------------------------------------------------------------------------------+
2862 **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.
2867 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).
2869 This command is executed using an Ansible playbook or Chef cookbook.
2871 Request Structure: The request payload includes the new-software-version.
2873 +--------------------------+-----------------------------------------------------------+
2874 | **Target URL** | /restconf/operations/appc-provider-lcm:upgrade-software |
2875 +--------------------------+-----------------------------------------------------------+
2876 | **Action** | UpgradeSoftware |
2877 +--------------------------+-----------------------------------------------------------+
2878 | **Action-identifiers** | vnf-id |
2879 +--------------------------+-----------------------------------------------------------+
2880 | **Payload Parameters** | existing-software-version, new-software-version |
2881 +--------------------------+-----------------------------------------------------------+
2882 | **Revision History** | New in Beijing |
2883 +--------------------------+-----------------------------------------------------------+
2885 Request Payload Parameters:
2887 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2888 | **Parameter** | **Description** | **Required?** | **Example** |
2889 +=======================+=====================================+=====================+===============================================================================================+
2890 | existing- software- | The existing software version | Yes | "payload": |
2891 | version | prior to the upgrade | | "{\\"existing-software-version\\": \\"3.1\\", "{\\"new-software-version\\": \\"3.2\\"}” |
2892 +-----------------------+-------------------------------------+---------------------+ |
2893 | new-software | The new software | Yes | |
2894 | version | version after the | | |
2896 +-----------------------+-------------------------------------+---------------------+-----------------------------------------------------------------------------------------------+
2898 UpgradeSoftware Response
2899 ^^^^^^^^^^^^^^^^^^^^^^^^
2901 **Success:** A successful upgrade returns a success status code 400.
2903 If an UpgradeSoftware command is executed and the software has been previously upgraded to this version, it should return a success status.
2905 **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.
2907 Notes regarding the Upgrade commands
2908 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
2909 Ansible playbooks / Chef cookbooks:
2911 - All Ansible playbooks/cookbooks for the Upgrade commands will be
2912 stored in the same directory on the server. The directory name will
2915 {existing-software-version_new-software-version}.
2917 The path to the directory is the same for all upgrades (for example: vnf-type/softwareupgrade).
2919 - The playbooks for upgrades should use a standard naming convention
2920 (for example: SoftwareUpgrade_{existing-software-version_new-software-version}).
2922 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.
2924 - The template will contain the directory path/playbook name which
2925 would be parameterized.
2927 {vnf-type}/UpgradeSoftware/${existing_software_version}_${new-software-version}/
2928 SoftwareUpgrade_{existing-software-version_new-software-version}.
Code Review / appc.git / blob