ae2866aae76023035698d68e938d99e1c303ba57
[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 StorageResourceSerializer(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=True)
35     storageResource = StorageResourceSerializer(help_text="storageResource", required=True)
36
37
38 class virtualLinkResourceInfoSerializer(serializers.Serializer):
39     pass
40
41
42 class vnfcResourceInfoSerializer(serializers.Serializer):
43     pass
44
45
46 class accessInfoSerializer(serializers.Serializer):
47     tenant = serializers.CharField(help_text="tenant", required=True)
48     username = serializers.CharField(help_text="username", required=True)
49     password = serializers.CharField(help_text="password", required=True)
50
51
52 class InterfaceInfoSerializer(serializers.Serializer):
53     vimType = serializers.CharField(help_text="vimType", required=True)
54     apiVersion = serializers.CharField(help_text="apiVersion", required=True)
55     protocolType = serializers.ChoiceField(help_text="protocolType", choices=['http', 'https'], required=True)
56
57
58 class vimInfoSerializer(serializers.Serializer):
59     vimInfoId = serializers.CharField(help_text="vimInfoId", required=True)
60     vimId = serializers.CharField(help_text="vimId", required=True)
61     interfaceEndpoint = serializers.CharField(help_text="interfaceEndpoint", required=True)
62     interfaceInfo = InterfaceInfoSerializer(help_text="vimInfoId", required=True)
63     accessInfo = accessInfoSerializer(help_text="accessInfo", required=True)
64
65
66 class monitoringParametersSerializer(serializers.Serializer):
67     pass
68
69
70 class linkPortsSerializer(serializers.Serializer):
71     resourceId = serializers.CharField(help_text="resourceId", required=True)
72     vimId = serializers.CharField(help_text="vimId", required=False)
73
74
75 class resourceHandleSerializer(serializers.Serializer):
76     resourceId = serializers.CharField(help_text="resourceId", required=True)
77     vimId = serializers.CharField(help_text="vimId", required=False)
78     resourceProviderId = serializers.CharField(help_text="resourceProviderId", required=False)
79
80
81 class ExtVirtualLinkInfoSerializer(serializers.Serializer):
82     extVirtualLinkId = serializers.CharField(help_text="extVirtualLinkId", required=True)
83     resourceHandle = resourceHandleSerializer(help_text="iPAddress", required=True)
84     linkPorts = linkPortsSerializer(help_text="iPAddress", many=True, allow_null=True)
85
86
87 class l3AddressDataSerializer(serializers.Serializer):
88     iPAddressType = serializers.ChoiceField(help_text="iPAddressType", choices=['IPv4', 'IPv6'], required=True)
89     iPAddress = serializers.CharField(help_text="iPAddress", required=True)
90
91
92 class NetworkAddressSerializer(serializers.Serializer):
93     addressType = serializers.ChoiceField(help_text="addressType", choices=['MAC', 'IP'], required=True)
94     l2AddressData = serializers.CharField(help_text="l2AddressData", required=False)
95     l3AddressData = l3AddressDataSerializer(help_text="addresses", required=False)
96
97
98 class extCpInfoSerializer(serializers.Serializer):
99     cpInstanceId = serializers.CharField(help_text="cpInstanceId", required=True)
100     cpdId = serializers.IntegerField(help_text="cpdId", required=True)
101     addresses = NetworkAddressSerializer(help_text="addresses", many=True, allow_null=True)
102
103
104 class ScaleInfoSerializer(serializers.Serializer):
105     aspectId = serializers.CharField(help_text="aspectId", required=True)
106     scaleLevel = serializers.IntegerField(help_text="scaleLevel", required=True)
107
108
109 class instantiatedVnfInfoSerializer(serializers.Serializer):
110     flavourId = serializers.CharField(help_text="flavour Id", required=True, allow_null=True)
111     vnfState = serializers.ChoiceField(help_text="vnf State", choices=['STARTED', 'STOPPED'], required=True, allow_null=True)
112     scaleStatus = ScaleInfoSerializer(help_text="scaleStatus", many=True)
113     extCpInfo = extCpInfoSerializer(help_text="extCpInfo", many=True)
114     extVirtualLink = ExtVirtualLinkInfoSerializer(help_text="extVirtualLink", many=True)
115     monitoringParameters = monitoringParametersSerializer(help_text="monitoringParameters", allow_null=True)
116     vimInfo = vimInfoSerializer(help_text="vimInfo", many=True)
117     vnfcResourceInfo = vnfcResourceInfoSerializer(help_text="vnfcResourceInfo", many=True)
118     virtualLinkResourceInfo = virtualLinkResourceInfoSerializer(help_text="virtualLinkResourceInfo", many=True)
119     virtualStorageResourceInfo = virtualStorageResourceInfoSerializer(help_text="virtualStorageResourceInfo", many=True)
120     pass
121
122
123 class VnfInfoSerializer(serializers.Serializer):
124     vnfInstanceId = serializers.CharField(help_text="vnf Instance Id", required=True)
125     vnfInstanceName = serializers.CharField(help_text="vnf Instance Name", required=True)
126     onboardedVnfPkgInfoId = serializers.CharField(help_text="onboarded Vnf Pkg Info Id", required=False,
127                                                   allow_null=True)
128     vnfdVersion = serializers.CharField(help_text="vnfd Version", required=False, allow_null=True)
129     vnfProvider = serializers.CharField(help_text="vnf Provider", required=False, allow_null=True)
130     instantiatedVnfInfo = instantiatedVnfInfoSerializer(help_text="instantiatedVnfInfo", required=True)
131
132
133 class VnfsInfoSerializer(serializers.ListSerializer):
134     child = VnfInfoSerializer()