1 # Copyright 2018 ZTE Corporation.
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
7 # http://www.apache.org/licenses/LICENSE-2.0
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.
15 from rest_framework import serializers
18 class InstVnfReqSerializer(serializers.Serializer):
19 vnfIndex = serializers.CharField(help_text="Index of VNF", required=True)
20 nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
21 additionalParamForVnf = serializers.CharField(help_text="Additional param for VNF", required=False, allow_null=True)
24 class InstVnfRespSerializer(serializers.Serializer):
25 vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
26 jobId = serializers.CharField(help_text="ID of Job", required=True)
29 class GetVnfRespSerializer(serializers.Serializer):
30 vnfInstId = serializers.CharField(help_text="ID of VNF instance", required=True)
31 vnfName = serializers.CharField(help_text="Name of VNF instance", required=True)
32 vnfStatus = serializers.CharField(help_text="Status of VNF instance", required=True)
35 class TerminateVnfReqSerializer(serializers.Serializer):
36 terminationType = serializers.CharField(help_text="Termination Type", required=False, allow_null=True)
37 gracefulTerminationTimeout = serializers.CharField(help_text="Graceful Termination Timeout", required=False, allow_null=True)
40 class TerminateVnfRespSerializer(serializers.Serializer):
41 jobId = serializers.CharField(help_text="ID of Job", required=True)
44 class ResourceChangeSerializer(serializers.Serializer):
45 type = serializers.ChoiceField(help_text="Change Type", choices=["VDU"], required=True)
46 resourceDefinitionId = serializers.CharField(help_text="Identifier of resource", required=False, allow_null=True)
47 vdu = serializers.CharField(help_text="Identifier identifier of VDU", required=False, allow_null=True)
50 class GrantVnfReqSerializer(serializers.Serializer):
51 vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=True)
52 vnfDescriptorId = serializers.CharField(help_text="ID of VNF Descriptor", required=False, allow_null=True)
53 lifecycleOperation = serializers.ChoiceField(
54 help_text="Lifecycle Operation",
55 choices=["Terminal", "Instantiate", "Scalein", "Scaleout", "Scaledown", "Scaleup", "Heal"],
58 jobId = serializers.CharField(help_text="ID of Job", required=False, allow_null=True)
59 addResource = ResourceChangeSerializer(help_text="Add resources", many=True)
60 removeResource = ResourceChangeSerializer(help_text="Remove resources", many=True)
61 additionalParam = serializers.DictField(
62 help_text="Additional parameters passed to the NFVO, specific to the VNF and the LCM operation. The currently interpreted keys are the following: vimId",
63 child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
69 class AccessinfoSerializer(serializers.Serializer):
70 tenant = serializers.CharField(help_text="Name of tenant", required=True)
73 class VimSerializer(serializers.Serializer):
74 vimid = serializers.CharField(help_text="ID of VIM", required=True)
75 accessinfo = AccessinfoSerializer(help_text="Access Info", required=True)
78 class GrantVnfRespSerializer(serializers.Serializer):
79 vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=False, allow_null=True)
80 vim = VimSerializer(help_text="VIM Info", required=True)
83 class AffectedVnfcSerializer(serializers.Serializer):
84 vnfcInstanceId = serializers.CharField(help_text="ID of VNFC instance", required=False, allow_null=True)
85 vduId = serializers.CharField(help_text="ID of VDU in VNFD", required=False, allow_null=True)
86 changeType = serializers.ChoiceField(
87 help_text="Type of Change",
88 choices=["added", "removed", "modified"],
91 vimId = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)
92 vmId = serializers.CharField(help_text="ID of virtual machine", required=False, allow_null=True)
93 vmName = serializers.CharField(help_text="Name of virtual machine", required=False, allow_null=True)
96 class NetworkResourceSerializer(serializers.Serializer):
97 resourceType = serializers.ChoiceField(
98 help_text="Type of Resource",
99 choices=["network", "port"],
102 resourceId = serializers.CharField(help_text="ID of network resource", required=False, allow_null=True)
103 resourceName = serializers.CharField(help_text="Name of network resource", required=False, allow_null=True)
106 class AffectedVirtualLinkSerializer(serializers.Serializer):
107 vlInstanceId = serializers.CharField(help_text="ID of VL instance", required=False, allow_null=True)
108 vldId = serializers.CharField(help_text="ID of VLD in VNFD", required=False, allow_null=True)
109 changeType = serializers.ChoiceField(
110 help_text="Type of Change",
111 choices=["added", "removed", "modified"],
114 networkResource = NetworkResourceSerializer(help_text="Network Resource", required=False, allow_null=True)
117 class PortResourceSerializer(serializers.Serializer):
118 vimId = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)
119 resourceId = serializers.CharField(help_text="ID of Resource", required=False, allow_null=True)
120 resourceName = serializers.CharField(help_text="Name of Resource", required=False, allow_null=True)
121 tenant = serializers.CharField(help_text="ID of Tenant", required=False, allow_null=True)
122 ipAddress = serializers.CharField(help_text="IP address of port", required=False, allow_null=True)
123 macAddress = serializers.CharField(help_text="MAC address of port", required=False, allow_null=True)
124 instId = serializers.CharField(help_text="Instance id of server to which the port is attached to", required=False, allow_null=True)
127 class AffectedCpSerializer(serializers.Serializer):
128 changeType = serializers.ChoiceField(
129 help_text="Type of Change",
130 choices=["added", "removed", "modified"],
133 virtualLinkInstanceId = serializers.CharField(help_text="ID of VL instance", required=False, allow_null=True)
134 cpInstanceId = serializers.CharField(help_text="ID of CP instance", required=False, allow_null=True)
135 cpdId = serializers.CharField(help_text="ID of CPD in VNFD", required=False, allow_null=True)
136 ownerType = serializers.CharField(help_text="Type of Owner", required=False, allow_null=True)
137 ownerId = serializers.CharField(help_text="ID of Owner", required=False, allow_null=True)
138 portResource = PortResourceSerializer(help_text="Port Resource", required=False, allow_null=True)
141 class AffectedVirtualStorage(serializers.Serializer):
145 class NotifyLcmReqSerializer(serializers.Serializer):
146 status = serializers.ChoiceField(
147 help_text="Status of operation",
148 choices=["result", "start"],
151 operation = serializers.ChoiceField(
152 help_text="Lifecycle Operation",
153 choices=["Terminal", "Instantiate", "Scalein", "Scaleout", "Scaledown", "Scaleup", "Heal"],
156 jobId = serializers.CharField(help_text="ID of Job", required=False, allow_null=True)
157 vnfdmodule = serializers.CharField(help_text="VNFD Module", required=False, allow_null=True)
158 affectedVnfc = AffectedVnfcSerializer(help_text="Affected VNFC", many=True)
159 affectedVl = AffectedVirtualLinkSerializer(help_text="Affected VL", many=True)
160 affectedCp = AffectedCpSerializer(help_text="Affected CP", many=True)
161 affectedVirtualStorage = AffectedVirtualStorage(help_text="Affected Virtual Storage(Not supported)", many=True)
164 class ScaleVnfReqSerializer(serializers.Serializer):
165 type = serializers.ChoiceField(
166 help_text="Direction of the scaling",
167 choices=["SCALE_IN", "SCALE_OUT"],
170 aspectId = serializers.CharField(help_text="Aspect ID of the VNF that is requested to be scaled", required=False, allow_null=True)
171 numberOfSteps = serializers.CharField(help_text="Number of scaling steps to be executed as part of this ScaleVnf operation", required=False, allow_null=True)
172 additionalParam = serializers.DictField(
173 help_text="Additional parameters passed by the NFVO as input to the scaling process, specific to the VNF being scaled",
174 child=serializers.CharField(help_text="Additional parameters", allow_blank=True),
180 class ScaleVnfRespSerializer(serializers.Serializer):
181 jobId = serializers.CharField(help_text="ID of Job", required=True)
184 class VerifyVnfReqSerializer(serializers.Serializer):
185 PackageID = serializers.CharField(help_text="ID of Package", required=True)
188 class VerifyVnfRespSerializer(serializers.Serializer):
189 jobId = serializers.CharField(help_text="ID of Job", required=True)
192 class VnfmInfoRespSerializer(serializers.Serializer):
193 vnfmId = serializers.CharField(help_text="ID of VNFM", required=True)
194 name = serializers.CharField(help_text="Name of VNFM", required=True)
195 type = serializers.CharField(help_text="Type of VNFM", required=True)
196 vimId = serializers.CharField(help_text="ID of VIM", required=True)
197 vendor = serializers.CharField(help_text="Vendor of VNFM", required=False, allow_null=True, allow_blank=True)
198 version = serializers.CharField(help_text="Version of VNFM", required=False, allow_null=True, allow_blank=True)
199 description = serializers.CharField(help_text="Description of VNFM", required=False, allow_null=True, allow_blank=True)
200 certificateUrl = serializers.CharField(help_text="Certificate Url of VNFM", required=True)
201 url = serializers.CharField(help_text="url of VNFM", required=True)
202 userName = serializers.CharField(help_text="User Name of VNFM", required=True)
203 password = serializers.CharField(help_text="Password of VNFM", required=True)
204 createTime = serializers.CharField(help_text="Create Time of VNFM", required=False, allow_null=True, allow_blank=True)
207 class VimInfoRespSerializer(serializers.Serializer):
208 vimId = serializers.CharField(help_text="ID of VIM", required=True)
209 name = serializers.CharField(help_text="Name of VIM", required=True)
210 url = serializers.CharField(help_text="Url of VIM", required=True)
211 userName = serializers.CharField(help_text="User Name of VIM", required=True)
212 password = serializers.CharField(help_text="Password of VIM", required=True)
213 tenantId = serializers.CharField(help_text="Tenant ID of VIM", required=False, allow_null=True, allow_blank=True)
214 tenant = serializers.CharField(help_text="Default Tenant of VIM", required=False, allow_null=True, allow_blank=True)
215 vendor = serializers.CharField(help_text="Vendor of VIM", required=False, allow_null=True, allow_blank=True)
216 version = serializers.CharField(help_text="Version of VIM", required=False, allow_null=True, allow_blank=True)
217 description = serializers.CharField(help_text="Description of VIM", required=False, allow_null=True, allow_blank=True)
218 domain = serializers.CharField(help_text="Domain of VIM", required=False, allow_null=True, allow_blank=True)
219 type = serializers.CharField(help_text="Type of VIM", required=True)
220 createTime = serializers.CharField(help_text="Create Time of VIM", required=False, allow_null=True, allow_blank=True)
221 sslCacert = serializers.CharField(help_text="SSL Cacert of VIM", required=False, allow_null=True, allow_blank=True)
222 sslInsecure = serializers.CharField(help_text="SSL Insecure of VIM", required=False, allow_null=True, allow_blank=True)
223 status = serializers.CharField(help_text="Status of VIM", required=False, allow_null=True, allow_blank=True)