2 * ============LICENSE_START=======================================================
4 * ================================================================================
5 * Copyright (C) 2017 AT&T Intellectual Property. All rights reserved.
6 * ================================================================================
7 * Copyright (C) 2017 Amdocs
8 * =============================================================================
9 * Licensed under the Apache License, Version 2.0 (the "License");
10 * you may not use this file except in compliance with the License.
11 * You may obtain a copy of the License at
13 * http://www.apache.org/licenses/LICENSE-2.0
15 * Unless required by applicable law or agreed to in writing, software
16 * distributed under the License is distributed on an "AS IS" BASIS,
17 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
18 * See the License for the specific language governing permissions and
19 * limitations under the License.
21 * ECOMP is a trademark and service mark of AT&T Intellectual Property.
22 * ============LICENSE_END=========================================================
26 * Yang model for the Application Controller (APP-C) component of ECOMP
28 * This model is used to define the data and services of the Application Controller
29 * component of ECOMP. The APP-C controller initiates the processing of directed
30 * graphs, which define the actual process implementations used. The name of the
31 * directed graph is set by properties and cannot be changed dynamically.
33 * The services exposed by this provider are:
36 * Used to request a restart of a virtual network function (a VM).
39 * Used to request a rebuild of a virtual network function (a VM).
43 module appc-provider-lcm {
46 namespace "org:openecomp:appc:lcm";
47 prefix appc-provider-lcm;
48 organization "Copyright 2017 AT&T Intellectual Property.";
51 "Defines the services and request/response requirements for the ECOMP APP-C component.";
54 * Note, the revision changes the package name of the generated java code. Do not
55 * change the revision unless you also update all references to the bindings.
57 revision "2016-01-08" {
59 "APP-C interface version 1.0.48";
62 /**********************************************************************************
63 * Data type definitions
65 * The following data type definitions are used to define common data structures,
66 * define constraints, or to impart special meanings to data objects related to the
67 * APP-C controller functions.
68 **********************************************************************************/
73 description "Define a common definition of a time stamp (expressed as a formatted
74 string) as follows yyyy-MM-ddTHH:mm:ss.SSSSSSSSZ";
77 pattern "[0-9]{4}-[0-9]{1,2}-[0-9]{1,2}T[0-9]{1,2}:[0-9]{1,2}:[0-9]{1,2}.[0-9]{1,6}Z";
83 description "The payload can be any valid JSON string value. Json escape characters need to be added when required to include an inner json within the payload to make it a valid json string value";
99 enum "SoftwareUpload";
108 enum "ConfigScaleOut";
109 enum "ConfigRestore";
111 enum "ConfigBackupDelete";
114 description "The action to be taken by APP-C, e.g. Restart, Rebuild, Migrate";
117 /**********************************************************************************
118 * All requests will include this standard header
120 * The standard request header is used to define a correlation identification for
121 * the request that is returned on all responses. This correlation identifier
122 * (called the service-request-id) is meaningful to the caller and is included on
123 * all responses from the services.
124 **********************************************************************************/
127 /**********************************************************************************
128 * Basic manipulation of a VNF (or VM) will typically include querying the current
129 * state, restarting, rebuilding, stopping, starting, etc. In all of these basic
130 * "state"-type operations, the services require the identification of the VNF to
131 * be operated on, and the region or LCP that contains that resource. This
132 * information is used across all of these services, so it has been defined as a
133 * common structure here and is referenced in the appropriate RPC definitions.
134 **********************************************************************************/
137 /**********************************************************************************
138 * All responses will include this standard header
140 * The standard response header includes the time of completion as well as a
141 * success|failure indication
142 **********************************************************************************/
146 /**********************************************************************************
147 * All requests/response will include this standard header
149 * The standard common header is used to define a correlation identification for
150 * the request that is returned on all responses.
151 **********************************************************************************/
155 grouping common-header {
156 description "A common header for all APP-C requests";
157 container common-header {
158 description "A common header for all APP-C requests";
160 description "timestamp is in ISO 8601 timestamp format ZULU offset";
166 description "api-ver is the API version identifier. A given release of APPC
167 should support all previous versions of APPC API (correlate with
168 general requirements)";
170 pattern "[2]\.\d\d" {
171 error-message "API Version 2.XX is supported at this end point";
178 description "originator-id an identifier of the calling system which can be
179 used addressing purposes, i.e. returning asynchronous response
180 to the proper destination over DMaaP (especially in case of multiple
181 consumers of APP-C APIs)";
187 description "UUID for the request ID. An OSS/BSS identifier for the request
188 that caused the current action. Multiple API calls may be made
189 with the same request-id The request-id shall be recorded throughout
190 the operations on a single request";
195 leaf sub-request-id {
196 description "Uniquely identifies a specific LCM action. It is persistent over
197 the life-cycle of a single request";
203 /**********************************************************************************
204 * Flags are generic flags that apply to any and all commands, all are optional
205 * force = TRUE/FALSE - Execute command even if target is in unstable (i.e. locked, transiting, etc) state. Specific behaviour of forced commands varies, but implies cancellation of previous command and an override by the new command. The FALSE value is used by default.
206 * ttl = <0....N> - The timeout value for command execution, expressed in seconds
207 * mode = EXCLUSIVE/NORMAL - defines execution mode as follows:
208 * - EXCLUSIVE ? on encountering an exclusive command, the APP-C will:
209 * * Cease accepting additional command requests
210 * * Complete execution of outstanding commands
211 * * Execute the exclusive command to completion
212 * * Optionally report the result of the command
213 * * Optionally resume command acceptance and processing
214 * - NORMAL - Obverse of EXCLUSIVE, the default one.
215 **********************************************************************************/
217 description "Flags are generic flags that apply to any and all commands, all
224 description "EXCLUSIVE (accept no queued requests on this VNF while processing)
225 or NORMAL (queue other requests until complete)";
233 description "TRUE/FALSE - Execute action even if target is in unstable (i.e.
234 locked, transiting, etc.) state";
238 description "<0....N> -Â The timeout value (expressed in seconds) for action
239 execution, between action being received by APPC and action initiation";
248 grouping action-identifiers {
249 description "A block containing the action arguments. These are used to specify
250 the object upon which APP-C LCM command is to operate";
251 container action-identifiers {
252 description "A block containing the action arguments. These are used to specify
253 the object upon which APP-C LCM command is to operate";
254 leaf service-instance-id {
255 description "identifies a specific service the command refers to. When multiple
256 APP-C instances are used and applied to a subset of services,
257 this will become significant . The field is mandatory when the
263 description "identifies the VNF to which this action is to be applied(vnf-id
264 uniquely identifies the service-instance referred to). Note that
265 some actions are applied to multiple VNFs in the same service.
266 When this is the case, vnf-id may be left out, but service-instance-id
267 must appear. The field is mandatory when service-instance-id is
273 description "identifies the VNFC to which this action is to be applied. Some
274 actions apply only to a component within a VNF (e.g. RESTART is
275 sometimes applied to on VM only). In such a case, the name of
276 the VNFC is used to search for the component within the VNF";
281 description "identifies a specific VM within the given service/vnf to which
282 this action is to be applied";
291 description "The specific response codes are to be aligned with ASDC reference doc (main table removed to avoid duplication and digression from main table). See ASDC and ECOMP Distribution Consumer Interface Agreement";
293 description "The specific response codes are to be aligned with ASDC reference doc (main table removed to avoid duplication and digression from main table). See ASDC and ECOMP Distribution Consumer Interface Agreement";
295 description "Response code";
300 description "Response message";
311 /**********************************************************************************
312 * Define the restart service
313 **********************************************************************************/
315 description "An operation to restart a virtual network function (or VM)";
322 uses action-identifiers;
334 /**********************************************************************************
335 * Define the rebuild service
336 **********************************************************************************/
338 description "An operation to rebuild a virtual network function (or VM)";
345 uses action-identifiers;
357 /**********************************************************************************
358 * Define the migrate service
359 **********************************************************************************/
361 description "An operation to migrate a virtual network function (or VM)";
368 uses action-identifiers;
380 /**********************************************************************************
381 * Define the evacuate service
382 **********************************************************************************/
384 description "An operation to evacuate a virtual network function (or VM)";
391 uses action-identifiers;
404 /**********************************************************************************
405 * Define the snapshot service
406 **********************************************************************************/
408 description "An operation to create a snapshot of a virtual network function (or VM)";
415 uses action-identifiers;
435 /**********************************************************************************
436 * Define the rollback service
437 **********************************************************************************/
439 description "An operation to rollback to particular snapshot of a virtual network function (or VM)";
446 uses action-identifiers;
467 /**********************************************************************************
468 * Additional RPCs added here...
469 **********************************************************************************/
472 /**********************************************************************************
473 * Define the sync service
474 **********************************************************************************/
476 description "An operation to sync the configurations of a virtual network function (or VM)";
483 uses action-identifiers;
499 /**********************************************************************************
500 * Define the terminate service
501 **********************************************************************************/
503 description "An operation to terminate the configurations of a virtual network function (or VM)";
510 uses action-identifiers;
524 description "An operation to configure the configurations of a virtual network
532 uses action-identifiers;
549 description "Use the ModifyConfig command when a full configuration cycle is either not required or is considered too costly. The ModifyConfig LCM action affects only a subset of the total configuration data of a VNF. The set of configuration parameters to be affected is a subset of the total configuration data of the target VNF type. The payload block must contain the configuration parameters to be modified and their values. A successful modify returns a success response. A failed modify returns a failure response and the specific failure messages in the response payload block";
556 uses action-identifiers;
572 rpc config-scaleout {
573 description "An operation to scaleout the configurations of a virtual network
581 uses action-identifiers;
598 description "An operation to restore the configurations of a virtual network
606 uses action-identifiers;
622 /**********************************************************************************
623 * Define the test service
624 **********************************************************************************/
626 description "An operation to test the configurations of a virtual network function (or VM)";
633 uses action-identifiers;
645 /**********************************************************************************
646 * Define the stop service
647 **********************************************************************************/
649 description "An operation to stop the configurations of a virtual network function (or VM)";
656 uses action-identifiers;
669 description "An operation to start a virtual network function (or VM)";
676 uses action-identifiers;
688 /**********************************************************************************
689 * Define the audit service
690 **********************************************************************************/
692 description "An operation to audit the configurations of a virtual network function (or VM)";
699 uses action-identifiers;
715 /**********************************************************************************
716 * Define the SoftwareUpload vSCP service
717 **********************************************************************************/
718 rpc software-upload {
719 description "An operation to upload a new version of vSCP image to vSCP for updating it";
726 uses action-identifiers;
740 /**********************************************************************************
741 * Define the PreHealthCheck vSCP service
742 **********************************************************************************/
744 description "An operation to perform health check of vSCP prior its upgrading";
751 uses action-identifiers;
765 /**********************************************************************************
766 * Define the Upgrade vSCP service
767 **********************************************************************************/
769 description "An operation to perform upgrade of vSCP";
776 uses action-identifiers;
789 /**********************************************************************************
790 * Define the VNF lock service
791 **********************************************************************************/
793 description "An operation to perform VNF lock operation";
800 uses action-identifiers;
812 /**********************************************************************************
813 * Define the VNF unlock service
814 **********************************************************************************/
816 description "An operation to perform VNF unlock operation";
823 uses action-identifiers;
835 /**********************************************************************************
836 * Define the VNF check lock service
837 **********************************************************************************/
839 description "An operation to check VNF lock status";
846 uses action-identifiers;
856 description "TRUE/FALSE - returns TRUE when the given VNF was locked, otherwise returns FALSE";
864 description "An operation to Backup configurations of a virtual network function
872 uses action-identifiers;
884 rpc config-backup-delete {
885 description "An operation to Delete backup configurations of a virtual network
893 uses action-identifiers;
906 description "An operation to Export configurations of a virtual network function
914 uses action-identifiers;
922 /**********************************************************************************
923 * Additional RPCs added here...
924 **********************************************************************************/