Newer
Older
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
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
{
"type": "array",
"items": {
"type": "object",
"properties": {
"deviceAuthenticationInfo": {
"description": "Information needed for secondary authentication of the IoT device to the data network - see ETSI TS 129 561 [i.4] and ETSI TS 129 061 [i.5] for 5G and LTE procedures, respectively. This attribute is implementation dependent and should be logically linked to the identifiers of the IoT device listed hereafter.",
"type": "string"
},
"deviceMetadata": {
"description": "Additional information about the IoT device. This attribute is implementation dependent and may be expressed as an array of keyvalue pairs. ",
"type": "array",
"items": {
"description": "Key-value pairs for device metadata",
"type": "object",
"properties": {
"key": {
"type": "string"
},
"value": {
"type": "string"
}
}
}
},
"gpsi": {
"description": "GPSI of the IoT device if 5G-enabled (see note 1).",
"type": "string"
},
"pei": {
"description": "PEI of the IoT device if 5G-enabled (see note 1).",
"type": "string"
},
"supi": {
"description": "SUPI of the IoT device if 5G-enabled (see note 1).",
"type": "string"
},
"msisdn": {
"description": "MSISDN of the IoT device if LTE-enabled (see note 1).",
"type": "string"
},
"imei": {
"description": "IMEI of the IoT device if LTE-enabled (see note 1).",
"type": "string"
},
"imsi": {
"description": "IMSI of the IoT device if LTE-enabled (see note 1).",
"type": "string"
},
"iccid": {
"description": "ICCID of the IoT device (see note 1).",
"type": "string"
},
"deviceId": {
"description": "Human-readable identifier of the IoT device.",
"type": "string"
},
"requestedMecTrafficRule": {
"description": "MEC traffic rules the IoT device is requested to be associated to (see note 2). The data type definition is as per ETSI GS MEC 010-2 [i.6].",
"type": "array",
"items": {
"title": "TrafficRuleDescriptor",
"type": "object",
"properties": {
"trafficRuleId": {
"description": "Identifies the traffic rule.",
"type": "string"
},
"filterType": {
"type": "string",
"description": "Definition of filter type: per FLOW or PACKET\n\nIf it is per FLOW, the filter matches upstream (e.g. UE->EPC) packets and downstream (e.g. EPC->UE) packets are handled by the same context.\n",
"enum": [
"per FLOW",
"per PACKET"
]
},
"priority": {
"description": "Priority of this traffic rule within the range 0 to 255. If traffic rule conflicts, the one with higher priority take precedence. See note 1.",
"type": "integer"
},
"trafficFilter": {
"description": "The filter used to identify specific flow/packets that need to be handled by the MEC host.",
"type": "array",
"items": {
"title": "TrafficFilter",
"type": "object",
"properties": {
"srcAddress": {
"description": "An IP address or a range of IP addresses.\nFor IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.\nFor IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
"type": "array",
"items": {
"type": "string"
}
},
"dstAddress": {
"description": "An IP address or a range of IP addresses.\nFor IPv4, the IP address could be an IP address plus mask, or an individual IP address, or a range of IP addresses.\nFor IPv6, the IP address could be an IP prefix, or a range of IP prefixes.",
"type": "array",
"items": {
"type": "string"
}
},
"srcPort": {
"description": "A port or a range of ports.",
"type": "array",
"items": {
"type": "string"
}
},
"dstPort": {
"description": "A port or a range of ports.",
"type": "array",
"items": {
"type": "string"
}
},
"protocol": {
"description": "Specify the protocol of the traffic filter.",
"type": "array",
"items": {
"type": "string"
}
},
"tag": {
"description": "Used for tag based traffic rule.",
"type": "array",
"items": {
"type": "string"
}
},
"uri": {
"description": "An URI label, in application layer, i.e. in HTTP message, is used to filter the traffic.",
"type": "array",
"items": {
"type": "string"
}
},
"packetLabel": {
"description": "A customized packet label in network layer, as defined by the owner of the MEC platform, is used to filter the traffic.",
"type": "array",
"items": {
"type": "string"
}
},
"srcTunnelAddress": {
"description": "Used for GTP tunnel based traffic rule.",
"type": "array",
"items": {
"type": "string"
}
},
"tgtTunnelAddress": {
"description": "Used for GTP tunnel based traffic rule.",
"type": "array",
"items": {
"type": "string"
}
},
"srcTunnelPort": {
"description": "Used for GTP tunnel based traffic rule.",
"type": "array",
"items": {
"type": "string"
}
},
"dstTunnelPort": {
"description": "Used for GTP tunnel based traffic rule.",
"type": "array",
"items": {
"type": "string"
}
},
"qCI": {
"description": "Used to match all packets that have the same QCI.",
"type": "integer"
},
"dSCP": {
"description": "Used to match all IPv4 packets that have the same DSCP.",
"type": "integer"
},
"tC": {
"description": "Used to match all IPv6 packets that have the same TC.",
"type": "integer"
}
}
}
},
"action": {
"type": "string",
"description": "Identifies the action of the MEC host data plane, when a packet matches the trafficFilter, the example actions include:\nDROP,\nFORWARD_DECAPSULATED,\nFORWARD_ENCAPSULATED,\nPASSTHROUGH,\nDUPLICATE_DECAPSULATED,\nDUPLICATE_ENCAPSULATED ",
"enum": [
"SEE_DESCRIPTION"
]
},
"dstInterface": {
"description'": "Describes the destination interface information. If the action is FORWARD_DECAPSULATED, FORWARD_ENCAPSULATED or PASSTHROUGH, one value shall be provided. If the action is DUPLICATE_DECAPSULATED or DUPLICATE_ENCAPSULATED, two values shall be provided. See note 2. If the action is DROP, no value shall be provided.",
"title": "InterfaceDescriptor",
"type": "object",
"properties": {
"interfaceType": {
"type": "string",
"description": "Type of interface: TUNNEL, MAC, IP, etc.",
"enum": [
"TUNNEL",
"MAC",
"IP"
]
},
"tunnelInfo": {
"description'": "Included only if the destination address type is tunnel.",
"title": "TunnelInfo",
"type": "object",
"properties": {
"tunnelType": {
"type": "string",
"description": "Type of tunnel: GTP-U, GRE, etc.",
"enum": [
"GTP-U",
"GRE"
]
},
"tunnelDstAddress": {
"description": "Destination address of the tunnel.",
"type": "string"
},
"tunnelSrcAddress": {
"description": "Source address of the tunnel.",
"type": "string"
},
"tunnelSpecificData": {
"description": "Parameters specific to the tunnel.",
"type": "string"
}
},
"required": [
"tunnelType",
"tunnelDstAddress",
"tunnelSrcAddress"
]
},
"srcMACAddress": {
"description": "If the interface type is MAC, the source address identifies the MAC address of the interface.",
"type": "string"
},
"dstMACAddress": {
"description": "If the interface type is MAC, the destination address identifies the MAC address of the destination. Only used for dstInterface.",
"type": "string"
},
"dstIPAddress": {
"description": "If the interface type is IP, the destination address identifies the IP address of the destination. Only used for dstInterface.",
"type": "string"
}
},
"required": [
"interfaceType"
]
}
},
"required": [
"trafficRuleId",
"filterType",
"priority",
"trafficFilter",
"action"
],
"description": "NOTE 1: Value indicates the priority in descending order, i.e. with 0 as the highest priority and 255 as the lowest\n priority.\nNOTE 2: Some applications (like inline/tap) require two interfaces. The first interface in the case of inline/tap is on the\n client (e.g. UE) side and the second on the core network (e.g. EPC) side. \n"
}
},
"requestedIotPlatformId": {
"description": "IoT platform to which the IoT device is requested to be associated to (see note 2).",
"type": "string"
},
"requestedUserTransportId": {
"description": "User transport to which the IoT device is requested to be associated to (see note 2).",
"type": "string"
},
"deviceSpecificMessageFormats": {
"description": "Format of the messages to be published by the MEC IoTS on the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device.",
"type": "object",
"properties": {
"eventMsgFormat": {
"description'": "Event message format configuration.",
"title": "EventMsg",
"type": "object",
"properties": {
"eventTopic": {
"description": "Topic where the message containing application-specific information should be published. ",
"type": "string"
},
"selectedSerializer": {
"description'": "Type of serializer to be used for the topic as per ETSI GS MEC 011 [i.2].",
"type": "string",
"description": "The enumeration SerializerType represents types of serializers.",
"enum": [
"JSON",
"XML",
"PROTOBUF3"
]
},
"includeDeviceAddr": {
"description": "Indication whether to include the IP address of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeDeviceMetadata": {
"description": "Indication whether to include the metadata about the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includePei": {
"description": "Indication whether to include the PEI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeSupi": {
"description": "Indication whether to include the SUPI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeImei": {
"description": "Indication whether to include the IMEI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeImsi": {
"description": "Indication whether to include the IMSI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeIccid": {
"description": "Indication whether to include the ICCID of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeDeviceId": {
"description": "Indication whether to include the human-readable identified of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
}
},
"required": [
"eventTopic",
"selectedSerializer"
]
},
"uplinkMsgFormat": {
"description'": "Uplink message format configuration.",
"title": "UplinkMsg",
"type": "object",
"properties": {
"uplinkTopic": {
"description": "Topic where the message containing the data generated by the IoT device(s) should be published, in order to be consumed by the end IoT application(s).",
"type": "string"
},
"selectedSerializer": {
"description'": "Type of serializer to be used for the topic as per ETSI GS MEC 011 [i.2].",
"type": "string",
"description": "The enumeration SerializerType represents types of serializers.",
"enum": [
"JSON",
"XML",
"PROTOBUF3"
]
},
"includeDevicePort": {
"description": "Indication whether to include the UDP port of the remote IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeDeviceAddr": {
"description": "Indication whether to include the IP address of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeDeviceMetadata": {
"description": "Indication whether to include the metadata about the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includePei": {
"description": "Indication whether to include the PEI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeSupi": {
"description": "Indication whether to include the SUPI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeImei": {
"description": "Indication whether to include the IMEI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeImsi": {
"description": "Indication whether to include the IMSI of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeIccid": {
"description": "Indication whether to include the ICCID of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
},
"includeDeviceId": {
"description": "Indication whether to include the human-readable identified of the IoT device (TRUE) or not (FALSE).",
"type": "boolean"
}
},
"required": [
"uplinkTopic",
"selectedSerializer"
]
}
}
},
"downlinkInfo": {
"description": "Downlink communication configuration of the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device.",
"type": "object",
"properties": {
"downlinkTopic": {
"description": "Topic associated to the IoT device. This topic should be used by an end IoT application to send downlink data to the IoT device.",
"type": "string"
},
"devicePort": {
"description": "UDP port to be used by the MEC IoTS for the outgoing downlink packets towards the IoT device. In case a default value is used, this attribute is optional.",
"type": "integer"
}
}
},
"clientCertificate": {
"description": "Client-side SSL/TLS certificate to be used by the MEC IoTS to interact with the user transport provided by the associated IoT platform in case the MEC IoTS acts on behalf of the IoT device.",
"type": "string"
},
"enabled": {
"description": "Indication whether the IoT device has a valid associated traffic rule (TRUE) or not (FALSE). See note 3.",
"type": "boolean"
}
},
"required": [
"deviceAuthenticationInfo",
"deviceId",
"enabled"
],
"description": "NOTE 1: At least one attribute among gpsi, pei, supi, msisdn, imei, imsi, and iccid should be provided. Sufficient security\n measures shall be put in place when any attribute among PEI, SUPI, IMEI, and IMSI is disclosed over the API.\nNOTE 2: Until a valid traffic rule is not provided, the device will not be able to use the IoTS. A valid traffic rule is provided\n by one of the following options:\n the requestedMecTrafficRule attribute;\n the requestedIotPlatformId attribute when the IoT platform offers only one user transport;\n the combination of requestedIotPlatformId and requestedUserTransportId.\nNOTE 3: Enabled is a pseudo-attribute which needs to be maintained by the IoTS based on the presence or not of a valid\n traffic rule associated to the device. It cannot be set directly by the service consumer. \n"
}
}