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 Start, Stop & Rebuild */
189 export interface StartStopRebuild {
191 operateVnfData: OPERATEVNFDATA;
194 /** Interface for operateVnfData in Start, Stop and Rebuild */
195 export interface OPERATEVNFDATA {
196 additionalParam: ADDITIONALPARAMS;
197 vnfInstanceId: string;
198 changeStateTo: string;
201 /** Interface for additionalParam in Start, Stop and Rebuild */
202 export interface ADDITIONALPARAMS {
205 'count-index': string;
208 /** Interface for VerticalScaling */
209 export interface VerticalScaling {
210 lcmOperationType: string;
211 verticalScale: string;
212 nsInstanceId: string;
213 changeVnfFlavorData: CHANGEVNFFLAVORDATAPARAM;
216 /** Interface for changeVnfFlavorData in Vertical Scaling */
217 export interface CHANGEVNFFLAVORDATAPARAM {
218 vnfInstanceId: string;
219 additionalParams: ADDITIONALPARAM;
223 /** Interface for additionalParam in Vertical Scaling */
224 export interface ADDITIONALPARAM {
226 vduCountIndex: string;
227 virtualMemory: number;
228 sizeOfStorage: number;
229 numVirtualCpu: number;
233 /** Interface for InstantiateParam */
234 interface InstantiateParam {
237 nsDescription: string;
238 vimAccountId: string;
241 /** Interface for AdditionalParamForN */
242 interface AdditionalParamForN {
244 'ns-instance-config-ref': string;
245 'crete-time': string;
248 /** interface for the History nsdInstanceData */
249 export interface NSDInstanceData {
251 lcmOperationType?: string;
252 operationState?: string;
254 statusEnteredTime?: number;
258 OperationalStatus: string;
259 ConfigStatus: string;
260 DetailedStatus: string;
265 adminDetails?: object;
268 operationParams?: OPERATIONPARAMS;
272 /** Interface for the operationparams */
273 export interface OPERATIONPARAMS {
275 scaleVnfData?: SCALEVNFDATA;
278 /** Interface for the scaleVnfData */
279 export interface SCALEVNFDATA {
280 scaleVnfType?: string;
281 scaleByStepData?: SCALEBYSTEPDATA;
284 /** Interface for the scaleByStepData */
285 export interface SCALEBYSTEPDATA {
286 'scaling-group-descriptor'?: string;
287 'member-vnf-index'?: string;
290 /** Interface for the nsInfo */
291 export interface NSINFO {
292 nsInstanceID: string;
294 nsOperationalStatus: string;
295 nsConfigStatus: string;
296 nsDetailedStatus: string;
297 nsResourceOrchestrator: string;
300 /** Interface for the NSINSTANCENODES */
301 export interface NSINSTANCENODES {
303 nodeTypeRef?: string;
307 vimNetworkName?: string;
309 cp?: CONNECTIONPOINT[];
317 memberIndex?: string;
325 /** Interface for the connection-point */
326 export interface CONNECTIONPOINT {
327 'connection-point-id': string;
332 /** Interface for Exec NS Primitive */
333 export interface NSPrimitive {
335 'primitive_params': NSPrimitiveParams[];
336 'member_vnf_index': string;
339 /** Interface for Exec NS Primitive Params */
340 export interface NSPrimitiveParams {
341 primitive_params_name: string;
342 primitive_params_value: string;
345 /** Interface Nodes Creation */
346 export interface COMPOSERNODES {
358 vimNetworkName?: string;
361 memberIndex?: string;
369 /** Interface for the Virtual Link Info */
370 export interface VLINFO {
375 vimNetworkName: string;
378 /** Interface for the VNFR Info */
379 export interface VNFRINFO {