aboutsummaryrefslogtreecommitdiffstats
path: root/lcm/ns/serializers/ns_serializers.py
blob: 041948bb55c6f147046c8a7052695ff62b673cba (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
# Copyright 2018 ZTE Corporation.
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#         http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.

from rest_framework import serializers
from lcm.ns_pnfs.serializers.pnf_serializer import PnfInstanceSerializer


class ContextSerializer(serializers.Serializer):
    globalCustomerId = serializers.CharField(help_text="Global customer ID", required=False, allow_null=True)
    serviceType = serializers.CharField(help_text="Service type", required=False, allow_null=True)


class CreateNsReqSerializer(serializers.Serializer):
    csarId = serializers.CharField(help_text="Package ID of NS", required=False, allow_null=True)
    nsName = serializers.CharField(help_text="Name of NS", required=False, allow_null=True)
    description = serializers.CharField(help_text="Description of NS", required=False, allow_null=True)
    context = ContextSerializer(help_text="Context of NS", required=False)


class CreateNsRespSerializer(serializers.Serializer):
    nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)


class VnfInstSerializer(serializers.Serializer):
    vnfInstanceId = serializers.CharField(help_text="ID of VNF instance", required=True)
    vnfInstanceName = serializers.CharField(help_text="Name of VNF instance", required=False, allow_null=True)
    vnfdId = serializers.CharField(help_text="ID of VNFD", required=False, allow_null=True)


class CpInstInfoSerializer(serializers.Serializer):
    cpInstanceId = serializers.CharField(help_text="ID of CP instance", required=True)
    cpInstanceName = serializers.CharField(help_text="Name of CP instance", required=False, allow_null=True)
    cpdId = serializers.CharField(help_text="ID of CPD", required=False, allow_null=True)


class VlInstSerializer(serializers.Serializer):
    vlInstanceId = serializers.CharField(help_text="ID of VL instance", required=True)
    vlInstanceName = serializers.CharField(help_text="Name of VL instance", required=False, allow_null=True)
    vldId = serializers.CharField(help_text="ID of VLD", required=False, allow_null=True)
    relatedCpInstanceId = CpInstInfoSerializer(help_text="Related CP instances", many=True)


class VnffgInstSerializer(serializers.Serializer):
    vnffgInstanceId = serializers.CharField(help_text="ID of VNFFG instance", required=True)
    vnfdId = serializers.CharField(help_text="ID of VNFD", required=False, allow_null=True)
    pnfId = serializers.CharField(help_text="ID of PNF", required=False, allow_null=True)
    virtualLinkId = serializers.CharField(help_text="ID of virtual link", required=False, allow_null=True)
    cpdId = serializers.CharField(help_text="ID of CPD", required=False, allow_null=True)
    nfp = serializers.CharField(help_text="nfp", required=False, allow_null=True)


class QueryNsRespSerializer(serializers.Serializer):
    nsInstanceId = serializers.CharField(help_text="ID of NS instance", required=True)
    nsName = serializers.CharField(help_text="Name of NS instance", required=False, allow_null=True)
    description = serializers.CharField(help_text="Description of NS instance", required=False, allow_null=True)
    nsdId = serializers.CharField(help_text="ID of NSD", required=True)
    vnfInfo = VnfInstSerializer(help_text="VNF instances", many=True, required=False, allow_null=True)
    pnfInfo = PnfInstanceSerializer(help_text="PNF instances", many=True, required=False, allow_null=True)
    vlInfo = VlInstSerializer(help_text="VL instances", many=True, required=False, allow_null=True)
    vnffgInfo = VnffgInstSerializer(help_text="VNFFG instances", many=True, required=False, allow_null=True)
    nsState = serializers.CharField(help_text="State of NS instance", required=False, allow_null=True)


class VimSerializer(serializers.Serializer):
    vimId = serializers.CharField(help_text="ID of VIM", required=False, allow_null=True)


class LocationConstraintSerializer(serializers.Serializer):
    vnfProfileId = serializers.CharField(help_text="ID of VNF profile", required=False, allow_null=True)
    locationConstraints = VimSerializer(help_text="Location constraint", required=False, allow_null=True)


class AddressRange(serializers.Serializer):
    minAddress = serializers.IPAddressField(help_text="Lowest IP address belonging to the range.", required=True)
    maxAddress = serializers.IPAddressField(help_text="Highest IP address belonging to the range.", required=True)


class IpAddress(serializers.Serializer):
    type = serializers.ChoiceField(help_text="The type of the IP addresses.", required=True, choices=["IPV4", "IPV6"])
    fixedAddresses = serializers.ListField(child=serializers.CharField(help_text="Fixed addresses to assign."), required=False)
    numDynamicAddresses = serializers.IntegerField(help_text="Number of dynamic addresses to assign.", required=False)
    addressRange = AddressRange(help_text="An IP address range to be used.", required=False)
    subnetId = serializers.CharField(help_text="Subnet defined by the identifier of the subnet resource in the VIM.", required=False)


class IpOverEthernetAddressData(serializers.Serializer):
    macAddress = serializers.CharField(help_text="MAC address.", required=False)
    ipAddresses = IpAddress(help_text="List of IP addresses to assign to the extCP instance.", required=False, many=True)


class CpProtocolInfoSerializer(serializers.Serializer):
    layerProtocol = serializers.ChoiceField(
        help_text="The identifier of layer(s) and protocol(s) associated to the network address information.",
        choices=["IP_OVER_ETHERNET"],
        required=True,
        allow_null=False)
    ipOverEthernet = IpOverEthernetAddressData(
        help_text="IP addresses over Ethernet to assign to the extCP instance.",
        required=False,
        allow_null=True)


class PnfExtCpData(serializers.Serializer):
    cpInstanceId = serializers.CharField(help_text="Identifier of the CP", required=False, allow_null=False)
    cpdId = serializers.CharField(help_text="Identifier of the Connection Point Descriptor", required=False, allow_null=False)
    cpProtocolData = CpProtocolInfoSerializer(help_text="Address assigned for this CP", required=True, allow_null=False, many=True)


class AddPnfData(serializers.Serializer):
    pnfId = serializers.CharField(help_text="Identifier of the PNF", required=True, allow_null=False)
    pnfName = serializers.CharField(help_text="Name of the PNF", required=True, allow_null=True)
    pnfdId = serializers.CharField(help_text="Identifier of the PNFD", required=True, allow_null=False)
    pnfProfileId = serializers.CharField(help_text="Identifier of related PnfProfile in the NSD", required=True, allow_null=False)
    cpData = PnfExtCpData(help_text="Address assigned for the PNF external CP", required=False, many=True)


class InstantNsReqSerializer(serializers.Serializer):
    locationConstraints = LocationConstraintSerializer(help_text="Location constraints", required=False, many=True)
    additionalParamForNs = serializers.DictField(
        help_text="Additional param for NS",
        child=serializers.CharField(help_text="KeyValue Pairs", allow_blank=True),
        required=False,
        allow_null=True
    )
    addpnfData = AddPnfData(help_text="Information on the PNF", required=False, many=True)


class NsOperateJobSerializer(serializers.Serializer):
    jobId = serializers.CharField(help_text="ID of NS operate job", required=True)


class TerminateNsReqSerializer(serializers.Serializer):
    terminationType = serializers.CharField(help_text="Type of NS termination", required=False, allow_null=True)
    gracefulTerminationTimeout = serializers.CharField(help_text="Timeout of NS graceful termination", required=False, allow_null=True)


class ActionVmSerializer(serializers.Serializer):
    vmid = serializers.CharField(help_text="ID of VM", required=False, allow_null=True)
    vduid = serializers.CharField(help_text="ID of vdu", required=False, allow_null=True)
    vmname = serializers.CharField(help_text="Name of VM", required=False, allow_null=True)


class HealNsAdditionalParamsSerializer(serializers.Serializer):
    action = serializers.CharField(help_text="Action of NS heal", required=False, allow_null=True)
    actionvminfo = ActionVmSerializer(help_text="VM info of action", required=False, allow_null=True)


class HealVnfDataSerializer(serializers.Serializer):
    vnfInstanceId = serializers.CharField(help_text="ID of VNF Instance", required=True)
    cause = serializers.CharField(help_text="Cause of NS heal", required=False, allow_null=True)
    additionalParams = HealNsAdditionalParamsSerializer(help_text="Additional params of NS heal", required=False, allow_null=True)


class HealNsDataSerializer(serializers.Serializer):
    degreeHealing = serializers.ChoiceField(help_text="degree of healing", choices=["HEAL_RESTORE", "HEAL_QOS", "HEAL_RESET", "PARTIAL_HEALING"], required=True)
    actionsHealing = serializers.ListField(
        help_text="A list of actions",
        child=serializers.CharField(help_text="One action", required=True),
        required=False)
    healScript = serializers.CharField(help_text="script of NS heal", required=False, allow_null=True)
    additionalParamsforNs = serializers.CharField(help_text="Addition params of NS heal", required=False, allow_null=True)


class HealNsReqSerializer(serializers.Serializer):
    healVnfData = HealVnfDataSerializer(help_text="Data of heal VNF", required=False, allow_null=True)
    healNsData = HealNsDataSerializer(help_text="Data of heal NS", required=False, allow_null=True)


class InstNsPostDealReqSerializer(serializers.Serializer):
    status = serializers.CharField(help_text="Status of NS Inst", required=True)


class ScaleNsByStepsSerializer(serializers.Serializer):
    aspectId = serializers.CharField(help_text="ID of aspect", required=True)
    numberOfSteps = serializers.CharField(help_text="Number of steps", required=True)
    scalingDirection = serializers.CharField(help_text="Scaling direction", required=True)


class ScaleNsDataSerializer(serializers.Serializer):
    scaleNsByStepsData = ScaleNsByStepsSerializer(help_text="Scale NS by steps data", many=True)


class ManualScaleNsReqSerializer(serializers.Serializer):
    scaleType = serializers.CharField(help_text="Type of NS Scale", required=True)
    scaleNsData = ScaleNsDataSerializer(help_text="Scale NS data", many=True)