summaryrefslogtreecommitdiffstats
path: root/kubernetes/dcaegen2-services/resources/external/schemas/sa91-rel16/sliceNrm.yaml
blob: 1fa8d70ff3068eef6e42bd9c66f83f941791fded (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
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
openapi: 3.0.1
info:
  title: Slice NRM
  version: 16.8.0
  description: >-
    OAS 3.0.1 specification of the Slice NRM
    @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
    All rights reserved.
externalDocs:
  description: 3GPP TS 28.541 V16.4.0; 5G NRM, Slice NRM
  url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/
paths: {}
components:
  schemas:

#------------ Type definitions ---------------------------------------------------

    Float:
      type: number
      format: float
    MobilityLevel:
      type: string
      enum:
        - STATIONARY
        - NOMADIC
        - RESTRICTED MOBILITY
        - FULLY MOBILITY
    SharingLevel:
      type: string
      enum:
        - SHARED
        - NON-SHARED
    NetworkSliceSharingIndicator:
      type: string
      enum:
        - SHARED
        - NON-SHARED
    PerfReqEmbb:
      type: object
      properties:
        expDataRateDL:
          type: number
        expDataRateUL:
          type: number
        areaTrafficCapDL:
          type: number
        areaTrafficCapUL:
          type: number
        userDensity:
          type: number
        activityFactor:
          type: number
    PerfReqEmbbList:
      type: array
      items:
        $ref: '#/components/schemas/PerfReqEmbb'
    PerfReqUrllc:
      type: object
      properties:
        cSAvailabilityTarget:
          type: number
        cSReliabilityMeanTime:
          type: string
        expDataRate:
          type: number
        msgSizeByte:
          type: string
        transferIntervalTarget:
          type: string
        survivalTime:
          type: string
    PerfReqUrllcList:
      type: array
      items:
        $ref: '#/components/schemas/PerfReqUrllc'
    PerfReq:
      oneOf:
        - $ref: '#/components/schemas/PerfReqEmbbList'
        - $ref: '#/components/schemas/PerfReqUrllcList'
    Category:
      type: string
      enum:
        - CHARACTER
        - SCALABILITY
    Tagging:
      type: array
      items:
        type: string
        enum:
          - PERFORMANCE
          - FUNCTION
          - OPERATION


    Exposure:
      type: string
      enum:
        - API
        - KPI
    ServAttrCom:
      type: object
      properties:
        category:
          $ref: '#/components/schemas/Category'
        tagging:
          $ref: '#/components/schemas/Tagging'
        exposure:
          $ref: '#/components/schemas/Exposure'
    Support:
      type: string
      enum:
        - NOT SUPPORTED
        - SUPPORTED
    DelayTolerance:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        support:
          $ref: '#/components/schemas/Support'
    DeterministicComm:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        availability:
          $ref: '#/components/schemas/Support'
        periodicityList:
          type: string
    DLThptPerSlice:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        guaThpt:
          $ref: '#/components/schemas/Float'
        maxThpt:
          $ref: '#/components/schemas/Float'
    DLThptPerUE:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        guaThpt:
          $ref: '#/components/schemas/Float'
        maxThpt:
          $ref: '#/components/schemas/Float'
    ULThptPerSlice:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        guaThpt:
          $ref: '#/components/schemas/Float'
        maxThpt:
          $ref: '#/components/schemas/Float'
    ULThptPerUE:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        guaThpt:
          $ref: '#/components/schemas/Float'
        maxThpt:
          $ref: '#/components/schemas/Float'
    MaxPktSize:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        maxsize:
          type: integer
    MaxNumberofConns:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        nOofConn:
          type: integer
    KPIMonitoring:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        kPIList:
          type: string
    UserMgmtOpen:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        support:
          $ref: '#/components/schemas/Support'
    V2XCommModels:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        v2XMode:
          $ref: '#/components/schemas/Support'
    TermDensity:
      type: object
      properties:
        servAttrCom:
          $ref: '#/components/schemas/ServAttrCom'
        density:
          type: integer
    NsInfo:
      type: object
      properties:
        nsInstanceId:
          type: string
        nsName:
          type: string
    ServiceProfile:
      type: object
      properties:
          serviceProfileId: 
            type: string
          plmnInfoList:
            $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList'
          maxNumberofUEs:
            type: number
          latency:
            type: number
          uEMobilityLevel:
            $ref: '#/components/schemas/MobilityLevel'
          sst:
            $ref: 'nrNrm.yaml#/components/schemas/Sst'
          networkSliceSharingIndicator:
            $ref: '#/components/schemas/NetworkSliceSharingIndicator'
          availability:
            type: number
          delayTolerance:
            $ref: '#/components/schemas/DelayTolerance'
          deterministicComm:
            $ref: '#/components/schemas/DeterministicComm'
          dLThptPerSlice:
            $ref: '#/components/schemas/DLThptPerSlice'
          dLThptPerUE:
            $ref: '#/components/schemas/DLThptPerUE'
          uLThptPerSlice:
            $ref: '#/components/schemas/ULThptPerSlice'
          uLThptPerUE:
            $ref: '#/components/schemas/ULThptPerUE'
          maxPktSize:
            $ref: '#/components/schemas/MaxPktSize'
          maxNumberofConns:
            $ref: '#/components/schemas/MaxNumberofConns'
          kPIMonitoring:
            $ref: '#/components/schemas/KPIMonitoring'
          userMgmtOpen:
            $ref: '#/components/schemas/UserMgmtOpen'
          v2XModels:
            $ref: '#/components/schemas/V2XCommModels'
          coverageArea:
            type: string
          termDensity:
            $ref: '#/components/schemas/TermDensity'
          activityFactor:
            $ref: '#/components/schemas/Float'
          uESpeed:
            type: integer
          jitter:
            type: integer
          survivalTime:
            type: string
          reliability:
            type: string
    SliceProfile:
      type: object
      properties:
          sliceProfileId:
            type: string

          plmnInfoList:
            $ref: 'nrNrm.yaml#/components/schemas/PlmnInfoList'
          perfReq:
            $ref: '#/components/schemas/PerfReq'
          maxNumberofUEs:
            type: number
          coverageAreaTAList:
            $ref: '5gcNrm.yaml#/components/schemas/TACList'
          latency:
            type: number
          uEMobilityLevel:
            $ref: '#/components/schemas/MobilityLevel'
          resourceSharingLevel:
            $ref: '#/components/schemas/SharingLevel'

    IpAddress:
      oneOf:
        - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr'
        - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr'
    ServiceProfileList:
       type: array
       items:
        $ref: '#/components/schemas/ServiceProfile'
            
    SliceProfileList:
      type: array
      items:
        $ref: '#/components/schemas/SliceProfile'

#------------ Definition of concrete IOCs ----------------------------------------

    SubNetwork-Single:
      allOf:
        - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
        - type: object
          properties:
            attributes:
              allOf:
                - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
        - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO'
        - type: object
          properties:
            SubNetwork:
              $ref: '#/components/schemas/SubNetwork-Multiple'
            NetworkSlice:
              $ref: '#/components/schemas/NetworkSlice-Multiple'
            NetworkSliceSubnet:
              $ref: '#/components/schemas/NetworkSliceSubnet-Multiple'
            EP_Transport:
              $ref: '#/components/schemas/EP_Transport-Multiple'

    NetworkSlice-Single:
      allOf:
        - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
        - type: object
          properties:
            attributes:
              allOf:
                - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
                - type: object
                  properties:
                    networkSliceSubnetRef:
                      $ref: 'comDefs.yaml#/components/schemas/Dn'
                    operationalState:
                      $ref: 'comDefs.yaml#/components/schemas/OperationalState'
                    administrativeState:
                      $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
                    serviceProfileList:
                      $ref: '#/components/schemas/ServiceProfileList'

    NetworkSliceSubnet-Single:
      allOf:
        - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
        - type: object
          properties:
            attributes:
              allOf:
                - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr'
                - type: object
                  properties:
                    managedFunctionRefList:
                      $ref: 'comDefs.yaml#/components/schemas/DnList'
                    networkSliceSubnetRefList:
                      $ref: 'comDefs.yaml#/components/schemas/DnList'
                    operationalState:
                      $ref: 'comDefs.yaml#/components/schemas/OperationalState'
                    administrativeState:
                      $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
                    nsInfo:
                      $ref: '#/components/schemas/NsInfo'
                    sliceProfileList:
                      $ref: '#/components/schemas/SliceProfileList'
                    epTransportRefList:
                      $ref: 'comDefs.yaml#/components/schemas/DnList'

    EP_Transport-Single:
      allOf:
        - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr'
        - type: object
          properties:
            attributes:
              type: object
              properties:
                ipAddress:
                  $ref: '#/components/schemas/IpAddress'
                logicInterfaceId:
                  type: string 
                nextHopInfo:
                  type: string 
                qosProfile:
                  type: string 
                epApplicationRefs:
                  $ref: 'comDefs.yaml#/components/schemas/DnList'
                      
#-------- Definition of JSON arrays for name-contained IOCs ----------------------
    SubNetwork-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/SubNetwork-Single'

    NetworkSlice-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/NetworkSlice-Single'

    NetworkSliceSubnet-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/NetworkSliceSubnet-Single'

    EP_Transport-Multiple:
      type: array
      items:
        $ref: '#/components/schemas/EP_Transport-Single'

#------------ Definitions in TS 28.541 for TS 28.532 -----------------------------

    resources-sliceNrm:
      oneOf:
       - $ref: '#/components/schemas/SubNetwork-Single'
       - $ref: '#/components/schemas/NetworkSlice-Single'
       - $ref: '#/components/schemas/NetworkSliceSubnet-Single'
       - $ref: '#/components/schemas/EP_Transport-Single'