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 OAM component of Application Controller (APP-C) component of ONAP
28 * This model is used to define the data and services of the OAM component of APP-C.
30 * The services exposed by this component are:
33 * Used to retrieve current metric data from APP-C.
40 namespace "org:onap:appc:oam";
42 organization "Copyright 2017 AT&T Intellectual Property.";
45 "Defines the services and request/response requirements for the
46 APP-C OAM component.";
49 * Note, the revision changes the package name of the generated java code. Do not
50 * change the revision unless you also update all references to the bindings.
52 revision "2017-03-03" {
54 "APP-C OAM interface version 1.5.00";
57 grouping common-header {
58 description "A common header for all APP-C requests";
59 container common-header {
60 description "A common header for all APP-C requests";
63 description "originator-id an identifier of the calling system which can be
64 used addressing purposes, i.e. returning asynchronous response
65 to the proper destination over UEB (especially in case of multiple
66 consumers of APP-C APIs)";
72 description "UUID for the request ID. An OSS/BSS identifier for the request
73 that caused the current action. Multiple API calls may be made
74 with the same request-id The request-id shall be recorded throughout
75 the operations on a single request";
81 leaf request-timeout {
82 description "The allowed time in seconds to perform the request. If the request cannot
83 be completed in this amount of time, the request is aborted with OAM state set
84 to Error. If set to zero, no timeout exists and the request will be handled
85 continue until operation completes or fails. If omitted, the default value of
95 description "The specific response codes are to be aligned with SDC reference
96 doc (main table removed to avoid duplication and digression from
97 main table). See SDC and ECOMP Distribution Consumer Interface
100 description "The specific response codes are to be aligned with SDC reference
101 doc (main table removed to avoid duplication and digression from
102 main table). See SDC and ECOMP Distribution Consumer Interface
105 description "Response code";
110 description "Response message";
121 enum "Not_Instantiated"; // Equivalent to Bundle's UNINSTALL
122 enum "Instantiated"; // Equivalent to Bundle's INSTALL
125 enum "EnteringMaintenanceMode";
126 enum "MaintenanceMode";
131 description "Refers to the various states an APP-C instance can be in";
135 description "An operation to get list of registered Metrics in APP-C";
139 description "KPI metrics definition";
141 description "metrics name";
145 leaf last-reset-time {
146 description "Last reset time";
152 description "KPI properties in form of key value pairs";
154 description "KPI property name";
158 description "KPI property value";
166 rpc maintenance-mode {
167 description "An operation that disables appc-provider-lcm so that it no longer accepts LCM request. This
168 operation has no impact on queued and currently executing LCM request. A notification will be
169 sent out indicating the APP-C is idle once all LCM request have completed execution.";
180 description "An operation that enables appc-provider-lcm so that it can begin to accepts LCM request. This
181 includes starting any appc bundles which are stopped.";
192 description "Returns the current state of the running APPC LCM instance";
201 description "Force stops the APPC bundles that accept LCM requests";
202 // Note: OAM feature bundles and it's dependencies (Appc-common and LifeCycle Manager) would continue to run
213 description "An operation that restarts APPC by invoking the stop rpc followed by the start rpc.";