f4348d9bab241cb769c18796845277c4e13eba74
[vfc/gvnfm/vnflcm.git] / lcm / lcm / nf / vnfs / 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 CreateVnfReqSerializer(serializers.Serializer):
19     vnfdId = serializers.CharField(help_text="vnfd Id", required=True)
20     vnfInstanceName = serializers.CharField(help_text="vnf Instance Name", required=True)
21     vnfInstanceDescription = serializers.CharField(help_text="vnf Instance Description", required=False, allow_null=True)
22
23
24 class CreateVnfRespSerializer(serializers.Serializer):
25     vnfInstanceId = serializers.CharField(help_text="vnf Instance Id", required=True)
26
27
28 class ResourceSerializer(serializers.Serializer):
29     resourceId = serializers.CharField(help_text="resourceId", required=True)
30     vimId = serializers.CharField(help_text="vimId", required=True)
31
32
33 class VirtualStorageResourceInfoSerializer(serializers.Serializer):
34     virtualStorageInstanceId = serializers.CharField(help_text="virtualStorageInstanceId", required=False, allow_null=True)
35     virtualStorageDescId = serializers.CharField(help_text="virtualStorageDescId", required=False, allow_null=True)
36     storageResource = ResourceSerializer(help_text="storageResource", required=False, allow_null=True)
37
38
39 class VirtualLinkResourceInfoSerializer(serializers.Serializer):
40     virtualLinkInstanceId = serializers.IntegerField(help_text="virtualLinkInstanceId", required=False, allow_null=True)
41     virtualLinkDescId = serializers.IntegerField(help_text="virtualLinkDescId", required=False, allow_null=True)
42     networkResource = ResourceSerializer(help_text="networkResource", required=False, allow_null=True)
43
44
45 class VnfcResourceInfoSerializer(serializers.Serializer):
46     vnfcInstanceId = serializers.IntegerField(help_text="vnfcInstanceId", required=False, allow_null=True)
47     vduId = serializers.IntegerField(help_text="vduId", required=False, allow_null=True)
48     storageResourceIds = serializers.IntegerField(help_text="storageResourceIds", required=False, allow_null=True)
49     computeResource = ResourceSerializer(help_text="computeResource", required=False, allow_null=True)
50
51
52 class AccessInfoSerializer(serializers.Serializer):
53     tenant = serializers.CharField(help_text="tenant", required=True)
54     username = serializers.CharField(help_text="username", required=True)
55     password = serializers.CharField(help_text="password", required=True)
56
57
58 class InterfaceInfoSerializer(serializers.Serializer):
59     vimType = serializers.CharField(help_text="vimType", required=True)
60     apiVersion = serializers.CharField(help_text="apiVersion", required=True)
61     protocolType = serializers.ChoiceField(help_text="protocolType", choices=['http', 'https'], required=True)
62
63
64 class VimInfoSerializer(serializers.Serializer):
65     vimInfoId = serializers.CharField(help_text="vimInfoId", required=False, allow_null=True)
66     vimId = serializers.CharField(help_text="vimId", required=False, allow_null=True)
67     interfaceEndpoint = serializers.CharField(help_text="interfaceEndpoint", required=False, allow_null=True)
68     interfaceInfo = InterfaceInfoSerializer(help_text="vimInfoId", required=False, allow_null=True)
69     accessInfo = AccessInfoSerializer(help_text="accessInfo", required=False, allow_null=True)
70
71
72 class LinkPortsSerializer(serializers.Serializer):
73     resourceId = serializers.CharField(help_text="resourceId", required=True)
74     vimId = serializers.CharField(help_text="vimId", required=False)
75
76
77 class ResourceHandleSerializer(serializers.Serializer):
78     resourceId = serializers.CharField(help_text="resourceId", required=True)
79     vimId = serializers.CharField(help_text="vimId", required=False)
80     resourceProviderId = serializers.CharField(help_text="resourceProviderId", required=False)
81
82
83 class ExtVirtualLinkInfoSerializer(serializers.Serializer):
84     extVirtualLinkId = serializers.CharField(help_text="extVirtualLinkId", required=True)
85     resourceHandle = ResourceHandleSerializer(help_text="iPAddress", required=True)
86     linkPorts = LinkPortsSerializer(help_text="iPAddress", many=True, allow_null=True)
87
88
89 class L3AddressDataSerializer(serializers.Serializer):
90     iPAddressType = serializers.ChoiceField(help_text="iPAddressType", choices=['IPv4', 'IPv6'], required=True)
91     iPAddress = serializers.CharField(help_text="iPAddress", required=True)
92
93
94 class NetworkAddressSerializer(serializers.Serializer):
95     addressType = serializers.ChoiceField(help_text="addressType", choices=['MAC', 'IP'], required=True)
96     l2AddressData = serializers.CharField(help_text="l2AddressData", required=False)
97     l3AddressData = L3AddressDataSerializer(help_text="addresses", required=False)
98
99
100 class ExtCpInfoSerializer(serializers.Serializer):
101     cpInstanceId = serializers.CharField(help_text="cpInstanceId", required=False, allow_null=True)
102     cpdId = serializers.IntegerField(help_text="cpdId", required=True)
103     numDynamicAddresses = serializers.IntegerField(help_text="numDynamicAddresses", required=False, allow_null=True)
104     addresses = NetworkAddressSerializer(help_text="addresses", many=True, allow_null=True)
105
106
107 class ScaleInfoSerializer(serializers.Serializer):
108     aspectId = serializers.CharField(help_text="aspectId", required=True)
109     scaleLevel = serializers.IntegerField(help_text="scaleLevel", required=True)
110
111
112 class instantiatedVnfInfoSerializer(serializers.Serializer):
113     flavourId = serializers.CharField(help_text="flavour Id", required=True, allow_null=True)
114     vnfState = serializers.ChoiceField(help_text="vnf State", choices=['STARTED', 'STOPPED'], required=True, allow_null=True)
115     scaleStatus = ScaleInfoSerializer(help_text="scaleStatus", many=True)
116     extCpInfo = ExtCpInfoSerializer(help_text="extCpInfo", many=True)
117     extVirtualLink = ExtVirtualLinkInfoSerializer(help_text="extVirtualLink", many=True)
118     monitoringParameters = serializers.DictField(help_text="monitoringParameters",
119                                                  child=serializers.CharField(allow_blank=True), required=False,
120                                                  allow_null=True)
121     vimInfo = VimInfoSerializer(help_text="vimInfo", many=True)
122     vnfcResourceInfo = VnfcResourceInfoSerializer(help_text="vnfcResourceInfo", many=True)
123     virtualLinkResourceInfo = VirtualLinkResourceInfoSerializer(help_text="virtualLinkResourceInfo", many=True)
124     virtualStorageResourceInfo = VirtualStorageResourceInfoSerializer(help_text="virtualStorageResourceInfo", many=True)
125
126
127 class VnfInfoSerializer(serializers.Serializer):
128     vnfInstanceId = serializers.CharField(help_text="vnf Instance Id", required=True)
129     vnfInstanceName = serializers.CharField(help_text="vnf Instance Name", required=True)
130     onboardedVnfPkgInfoId = serializers.CharField(help_text="onboarded Vnf Pkg Info Id", required=False,
131                                                   allow_null=True)
132     vnfdVersion = serializers.CharField(help_text="vnfd Version", required=False, allow_null=True)
133     vnfProvider = serializers.CharField(help_text="vnf Provider", required=False, allow_null=True)
134     instantiatedVnfInfo = instantiatedVnfInfoSerializer(help_text="instantiatedVnfInfo", required=True)
135
136
137 class VnfsInfoSerializer(serializers.ListSerializer):
138     child = VnfInfoSerializer()
139
140
141 class ExtVirtualLinkSerizlizer(serializers.Serializer):
142     vlInstanceId = serializers.CharField(help_text="vlInstanceId", required=False, allow_null=True)
143     resourceSubnetId = serializers.CharField(help_text="resourceSubnetId", required=False, allow_null=True)
144     cpdId = serializers.CharField(help_text="cpdId", required=False, allow_null=True)
145     resourceId = serializers.CharField(help_text="resourceId", required=False, allow_null=True)
146     vim = VimInfoSerializer(help_text="vim", required=False, allow_null=True)
147     extCps = ExtCpInfoSerializer(help_text="extCps", many=True, required=False, allow_null=True)
148
149
150 class ExtVirtualLinksSerializer(serializers.ListSerializer):
151     child = ExtVirtualLinkSerizlizer(help_text="extVirtualLink", required=False, allow_null=True)
152
153
154 class AdditionalParamsSerializer(serializers.Serializer):
155     inputs = serializers.DictField(
156         help_text="inputs",
157         child=serializers.CharField(help_text="but i needed to test these 2 fields somehow", allow_blank=True),
158         required=False,
159         allow_null=True
160     )
161     extVirtualLinks = ExtVirtualLinksSerializer(help_text="extVirtualLinks", required=False, allow_null=True)
162
163
164 class InstantiateVnfRequestSerializer(serializers.Serializer):
165     flavourId = serializers.CharField(help_text="flavourId", required=True)
166     instantiationLevelId = serializers.CharField(help_text="instantiationLevelId", required=True, allow_null=True)
167     localizationLanguage = serializers.CharField(help_text="localizationLanguage", required=True, allow_null=True)
168     extVirtualLinks = ExtVirtualLinksSerializer(help_text="extVirtualLinks", required=False, allow_null=True)
169     additionalParams = AdditionalParamsSerializer(help_text="additionalParams", required=False, allow_null=True)
170
171
172 class InstantiateVnfResponseSerializer(serializers.Serializer):
173     jobId = serializers.CharField(help_text="jobId", required=True)