52416f387cc7a6d5c095795c6bb8abff9ed5b8e8
[vfc/nfvo/lcm.git] / lcm / ns / serializers.py
1 # Copyright 2018 ZTE Corporation.
2 #
3 # Licensed under the Apache License, Version 2.0 (the "License");
4 # you may not use this file except in compliance with the License.
5 # You may obtain a copy of the License at
6 #
7 #         http://www.apache.org/licenses/LICENSE-2.0
8 #
9 # Unless required by applicable law or agreed to in writing, software
10 # distributed under the License is distributed on an "AS IS" BASIS,
11 # WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
12 # See the License for the specific language governing permissions and
13 # limitations under the License.
14
15 from rest_framework import serializers
16
17
18 class ContextSerializer(serializers.Serializer):
19     globalCustomerId = serializers.CharField(help_text="Global customer ID", required=False, allow_null=True)
20     serviceType = serializers.CharField(help_text="Service type", required=False, allow_null=True)
21
22
23 class CreateNsReqSerializer(serializers.Serializer):
24     csarId = serializers.CharField(help_text="Package ID of NS", required=False, allow_null=True)
25     nsName = serializers.CharField(help_text="Name of NS", required=False, allow_null=True)
26     description = serializers.CharField(help_text="Description of NS", required=False, allow_null=True)
27     context = ContextSerializer(help_text="Context of NS", required=False)
28
29
30 class CreateNsRespSerializer(serializers.Serializer):
31     nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
32
33
34 class VnfInstSerializer(serializers.Serializer):
35     vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=True)
36     vnfInstanceName = serializers.CharField(help_text="Name of VNF instance", required=False, allow_null=True)
37     vnfdId = serializers.CharField(help_text="ID of VNFD", required=False, allow_null=True)
38
39
40 class CpInstInfoSerializer(serializers.Serializer):
41     cpInstanceId = serializers.CharField(help_text="ID of CP instance", required=True)
42     cpInstanceName = serializers.CharField(help_text="Name of CP instance", required=False, allow_null=True)
43     cpdId = serializers.CharField(help_text="ID of CPD", required=False, allow_null=True)
44
45
46 class VlInstSerializer(serializers.Serializer):
47     vlInstanceId = serializers.CharField(help_text="ID of VL instance", required=True)
48     vlInstanceName = serializers.CharField(help_text="Name of VL instance", required=False, allow_null=True)
49     vldId = serializers.CharField(help_text="ID of VLD", required=False, allow_null=True)
50     relatedCpInstanceId = CpInstInfoSerializer(help_text="Related CP instances", many=True)
51
52
53 class VnffgInstSerializer(serializers.Serializer):
54     vnffgInstanceId = serializers.CharField(help_text="ID of VNFFG instance", required=True)
55     vnfdId = serializers.CharField(help_text="ID of VNFD", required=False, allow_null=True)
56     pnfId = serializers.CharField(help_text="ID of PNF", required=False, allow_null=True)
57     virtualLinkId = serializers.CharField(help_text="ID of virtual link", required=False, allow_null=True)
58     cpdId = serializers.CharField(help_text="ID of CPD", required=False, allow_null=True)
59     nfp = serializers.CharField(help_text="nfp", required=False, allow_null=True)
60
61
62 class QueryNsRespSerializer(serializers.Serializer):
63     nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
64     nsName = serializers.CharField(help_text="Name of NS instance", required=False, allow_null=True)
65     description = serializers.CharField(help_text="Description of NS instance", required=False, allow_null=True)
66     nsdId = serializers.CharField(help_text="ID of NSD", required=True)
67     vnfInfo = VnfInstSerializer(help_text="VNF instances", many=True, required=False, allow_null=True)
68     vlInfo = VlInstSerializer(help_text="VL instances", many=True, required=False, allow_null=True)
69     vnffgInfo = VnffgInstSerializer(help_text="VNFFG instances", many=True, required=False, allow_null=True)
70     nsState = serializers.CharField(help_text="State of NS instance", required=False, allow_null=True)
71
72
73 class VimSerializer(serializers.Serializer):
74     vimid = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)
75
76
77 class LocationConstraintSerializer(serializers.Serializer):
78     vnfProfileId = serializers.CharField(help_text="ID of VNF profile", required=False, allow_null=True)
79     locationConstraints = VimSerializer(help_text="Location constraints", required=False, allow_null=True)
80
81
82 class InstantNsReqSerializer(serializers.Serializer):
83     locationConstraints = LocationConstraintSerializer(required=False, allow_null=True)
84     # additionalParamForNs = serializers.CharField(help_text="Additional param for NS", required=False, allow_null=True)
85     additionalParamForNs = serializers.DictField(
86         help_text="Additional param for NS",
87         child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
88         required=False,
89         allow_null=True
90     )
91
92
93 class NsOperateJobSerializer(serializers.Serializer):
94     jobId = serializers.CharField(help_text="ID of NS operate job", required=True)
95
96
97 class TerminateNsReqSerializer(serializers.Serializer):
98     terminationType = serializers.CharField(help_text="Type of NS termination", required=False, allow_null=True)
99     gracefulTerminationTimeout = serializers.CharField(help_text="Timeout of NS graceful termination", required=False, allow_null=True)
100
101
102 class ActionVmSerializer(serializers.Serializer):
103     vmid = serializers.CharField(help_text="ID of VM", required=False, allow_null=True)
104     vmname = serializers.CharField(help_text="Name of VM", required=False, allow_null=True)
105
106
107 class HealNsAdditionalParamsSerializer(serializers.Serializer):
108     action = serializers.CharField(help_text="Action of NS heal", required=False, allow_null=True)
109     actionvminfo = ActionVmSerializer(help_text="VM info of action", required=False, allow_null=True)
110
111
112 class HealVnfDataSerializer(serializers.Serializer):
113     vnfInstanceId = serializers.CharField(help_text="ID of VNF Instance", required=True)
114     cause = serializers.CharField(help_text="Cause of NS heal", required=False, allow_null=True)
115     additionalParams = HealNsAdditionalParamsSerializer(help_text="Additional params of NS heal", required=False, allow_null=True)
116
117
118 class HealNsReqSerializer(serializers.Serializer):
119     healVnfData = HealVnfDataSerializer(help_text="Data of heal VNF", required=False, allow_null=True)
120
121
122 class InstNsPostDealReqSerializer(serializers.Serializer):
123     status = serializers.CharField(help_text="Status of NS Inst", required=True)
124
125
126 class ScaleNsByStepsSerializer(serializers.Serializer):
127     aspectId = serializers.CharField(help_text="ID of aspect", required=True)
128     numberOfSteps = serializers.CharField(help_text="Number of steps", required=True)
129     scalingDirection = serializers.CharField(help_text="Scaling direction", required=True)
130
131
132 class ScaleNsDataSerializer(serializers.Serializer):
133     scaleNsByStepsData = ScaleNsByStepsSerializer(help_text="Scale NS by steps data", many=True)
134
135
136 class ManualScaleNsReqSerializer(serializers.Serializer):
137     scaleType = serializers.CharField(help_text="Type of NS Scale", required=True)
138     scaleNsData = ScaleNsDataSerializer(help_text="Scale NS data", many=True)