2 Copyright 2020 TATA ELXSI
4 Licensed under the Apache License, Version 2.0 (the 'License');
5 you may not use this file except in compliance with the License.
6 You may obtain a copy of the License at
8 http://www.apache.org/licenses/LICENSE-2.0
10 Unless required by applicable law or agreed to in writing, software
11 distributed under the License is distributed on an "AS IS" BASIS,
12 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 See the License for the specific language governing permissions and
14 limitations under the License.
16 Author: KUMARAN M (kumaran.m@tataelxsi.co.in), RAJESH S (rajesh.s@tataelxsi.co.in), BARATH KUMAR R (barath.r@tataelxsi.co.in)
19 * @file Model for NS Instance related information.
21 // tslint:disable: completed-docs
22 import { DF, VLD } from 'NSDModel';
23 import { VNFDAdminDetails } from 'VNFDModel';
25 /** Interface for NSInstanceDetails */
26 export interface NSInstanceDetails {
27 'orchestration-progress': JSON;
28 'constituent-vnfr-ref': string[];
29 'operational-events': string[];
31 'ssh-authorized-key': string;
33 'admin-status': string;
34 'operational-status': string;
41 'nsd-name-ref': string;
43 'detailed-status': string;
44 'config-status': string;
45 'resource-orchestrator': string;
48 instantiate_params: InstantiateParam;
49 additionalParamsForNs: AdditionalParamForN;
54 /** Interface for Admin */
56 deployed: DeployedAdmin;
59 /** Interface for DeployedAdmin */
60 interface DeployedAdmin {
64 /** Interface for ROAdmin */
69 /** Interface for _Admin */
70 // tslint:disable-next-line:class-name
72 'projects_write': string[];
73 deployed: DeployedAdmin;
77 projects_read: string[];
81 /** Interface for Deployed_Admin */
82 interface DeployedAdmin {
87 /** Interface for RO_Admin */
95 /** Interface for VNFD */
97 'member-vnf-index': number;
101 /** Interface for NSD */
102 export interface NSD {
104 _admin: VNFDAdminDetails;
111 'connection-point': CONNECTIONPOINT[];
112 'virtual-link-desc': NSDVLD[];
116 /** Interface for _AdminDetails */
117 // tslint:disable-next-line:class-name
118 export interface _AdminDetails {
120 projects_write: string[];
121 projects_read: string[];
122 operationalState: string;
125 onboardingState: string;
126 userDefinedData: JSON;
130 /** Interface for Storage */
140 /** Interface for NSDVLD */
141 export interface NSDVLD {
143 'status-detailed': string;
146 'vim-network-name': string;
152 /** Interface for Vm Migration */
153 export interface VMMIGRATION {
154 lcmOperationType: string;
155 vnfInstanceId: string;
156 migrateToHost?: string;
160 /** Interface for vdu for Vm Migration */
161 export interface VDUPARAM {
163 vduCountIndex?: string;
166 /** Interface for Ns Update */
167 export interface NSUPDATE {
168 lcmOperationType: string;
170 nsInstanceId: string;
171 changeVnfPackageData: CHANGEVNFDATA;
174 /** Interface for changeVnfPackageData in Ns Update */
175 export interface CHANGEVNFDATA {
177 vnfInstanceId: string;
180 /** Interface for terminate vnf in Ns Update */
181 export interface TERMINATEVNF {
182 lcmOperationType: string;
184 nsInstanceId: string;
185 removeVnfInstanceId: string;
188 /** Interface for InstantiateParam */
189 interface InstantiateParam {
192 nsDescription: string;
193 vimAccountId: string;
196 /** Interface for AdditionalParamForN */
197 interface AdditionalParamForN {
199 'ns-instance-config-ref': string;
200 'crete-time': string;
203 /** interface for the History nsdInstanceData */
204 export interface NSDInstanceData {
206 lcmOperationType?: string;
207 operationState?: string;
209 statusEnteredTime?: number;
213 OperationalStatus: string;
214 ConfigStatus: string;
215 DetailedStatus: string;
220 adminDetails?: object;
223 operationParams?: OPERATIONPARAMS;
227 /** Interface for the operationparams */
228 export interface OPERATIONPARAMS {
230 scaleVnfData?: SCALEVNFDATA;
233 /** Interface for the scaleVnfData */
234 export interface SCALEVNFDATA {
235 scaleVnfType?: string;
236 scaleByStepData?: SCALEBYSTEPDATA;
239 /** Interface for the scaleByStepData */
240 export interface SCALEBYSTEPDATA {
241 'scaling-group-descriptor'?: string;
242 'member-vnf-index'?: string;
245 /** Interface for the nsInfo */
246 export interface NSINFO {
247 nsInstanceID: string;
249 nsOperationalStatus: string;
250 nsConfigStatus: string;
251 nsDetailedStatus: string;
252 nsResourceOrchestrator: string;
255 /** Interface for the NSINSTANCENODES */
256 export interface NSINSTANCENODES {
258 nodeTypeRef?: string;
262 vimNetworkName?: string;
264 cp?: CONNECTIONPOINT[];
272 memberIndex?: string;
280 /** Interface for the connection-point */
281 export interface CONNECTIONPOINT {
282 'connection-point-id': string;
287 /** Interface for Exec NS Primitive */
288 export interface NSPrimitive {
290 'primitive_params': NSPrimitiveParams[];
291 'member_vnf_index': string;
294 /** Interface for Exec NS Primitive Params */
295 export interface NSPrimitiveParams {
296 primitive_params_name: string;
297 primitive_params_value: string;
300 /** Interface Nodes Creation */
301 export interface COMPOSERNODES {
313 vimNetworkName?: string;
316 memberIndex?: string;
324 /** Interface for the Virtual Link Info */
325 export interface VLINFO {
330 vimNetworkName: string;
333 /** Interface for the VNFR Info */
334 export interface VNFRINFO {