blob: 7e7576c90fb4ba65359220e163c5ca5f0be8fbf0 [file] [log] [blame]
Michal Banka028e1c22021-05-10 11:00:39 +02001openapi: 3.0.1
2info:
3 title: Generic NRM
4 version: 16.6.0
5 description: >-
6 OAS 3.0.1 definition of the Generic NRM
7 © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
8 All rights reserved.
9externalDocs:
10 description: 3GPP TS 28.623 V16.5.0; Generic NRM
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
12paths: {}
13components:
14 schemas:
15
16#-------- Definition of types-----------------------------------------------------
17
18 RegistrationState:
19 type: string
20 enum:
21 - REGISTERED
22 - DEREGISTERED
23 VnfParameter:
24 type: object
25 properties:
26 vnfInstanceId:
27 type: string
28 vnfdId:
29 type: string
30 flavourId:
31 type: string
32 autoScalable:
33 type: boolean
34 SiteLatitude:
35 type: number
36 format: float
37 minimum: -90
38 maximum: 90
39 SiteLongitude:
40 type: number
41 format: float
42 minimum: -180
43 maximum: 180
44 PeeParameter:
45 type: object
46 properties:
47 siteIdentification:
48 type: string
49 siteDescription:
50 type: string
51 siteLatitude:
52 $ref: '#/components/schemas/SiteLatitude'
53 siteLongitude:
54 $ref: '#/components/schemas/SiteLongitude'
55 equipmentType:
56 type: string
57 environmentType:
58 type: string
59 powerInterface:
60 type: string
61 ThresholdInfo:
62 type: object
63 properties:
64 thresholdDirection:
65 type: string
66 enum:
67 - UP
68 - DOWN
69 - UP_AND_DOWN
70 thresholdValue:
71 oneOf:
72 - type: integer
73 - $ref: 'comDefs.yaml#/components/schemas/Float'
74 hysteresis:
75 oneOf:
76 - type: integer
77 minimum: 0
78 - type: number
79 format: float
80 minimum: 0
81 Operation:
82 type: object
83 properties:
84 name:
85 type: string
86 allowedNFTypes:
87 $ref: '#/components/schemas/NFType'
88 operationSemantics:
89 $ref: '#/components/schemas/OperationSemantics'
90 NFType:
91 type: string
92 description: ' NF name defined in TS 23.501'
93 enum:
94 - NRF
95 - UDM
96 - AMF
97 - SMF
98 - AUSF
99 - NEF
100 - PCF
101 - SMSF
102 - NSSF
103 - UDR
104 - LMF
105 - GMLC
106 - 5G_EIR
107 - SEPP
108 - UPF
109 - N3IWF
110 - AF
111 - UDSF
112 - DN
113 Fqdn:
114 type: string
115 OperationSemantics:
116 type: string
117 enum:
118 - REQUEST_RESPONSE
119 - SUBSCRIBE_NOTIFY
120 SAP:
121 type: object
122 properties:
123 host:
124 $ref: '#/components/schemas/HostAddr'
125 port:
126 type: integer
127 NFServiceType:
128 type: string
129 enum:
130 - Namf_Communication
131 - Namf_EventExposure
132 - Namf_MT
133 - Namf_Location
134 - Nsmf_PDUSession
135 - Nsmf_EventExposure
136 - Others
137 HostAddr:
138 oneOf:
139 - $ref: '#/components/schemas/Ipv4Addr'
140 - $ref: '#/components/schemas/Ipv6Addr'
141 - $ref: '#/components/schemas/Fqdn'
142 Ipv4Addr:
143 type: string
144 pattern: '^(([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])\.){3}([0-9]|[1-9][0-9]|1[0-9][0-9]|2[0-4][0-9]|25[0-5])$'
145 example: '198.51.100.1'
146 Ipv6Addr:
147 type: string
148 allOf:
149 - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))$'
150 - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
151 example: '2001:db8:85a3::8a2e:370:7334'
152 Ipv6Prefix:
153 type: string
154 allOf:
155 - pattern: '^((:|(0?|([1-9a-f][0-9a-f]{0,3}))):)((0?|([1-9a-f][0-9a-f]{0,3})):){0,6}(:|(0?|([1-9a-f][0-9a-f]{0,3})))(\/(([0-9])|([0-9]{2})|(1[0-1][0-9])|(12[0-8])))$'
156 - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
157 example: '2001:db8:abcd:12::0/64'
158 TransportProtocol:
159 anyOf:
160 - type: string
161 enum:
162 - TCP
163 - type: string
164 SupportedPerfMetricGroup:
165 type: object
166 properties:
167 performanceMetrics:
168 type: array
169 items:
170 type: string
171 granularityPeriods:
172 type: array
173 items:
174 type: integer
175 minimum: 1
176 reportingMethods:
177 type: array
178 items:
179 type: string
180 enum:
181 - FILE_BASED_LOC_SET_BY_PRODUCER
182 - FILE_BASED_LOC_SET_BY_CONSUMER
guillaume.lambert30ec3902021-09-14 12:32:24 +0200183 - STREAM_BASED
Michal Banka028e1c22021-05-10 11:00:39 +0200184 monitorGranularityPeriods:
185 type: array
186 items:
187 type: integer
188 minimum: 1
189 ReportingCtrl:
190 oneOf:
191 - type: object
192 properties:
193 fileReportingPeriod:
194 type: integer
195 - type: object
196 properties:
197 fileReportingPeriod:
198 type: integer
199 fileLocation:
200 $ref: 'comDefs.yaml#/components/schemas/Uri'
201 - type: object
202 properties:
203 streamTarget:
204 $ref: 'comDefs.yaml#/components/schemas/Uri'
205 Scope:
206 type: object
207 properties:
208 scopeType:
209 type: string
210 enum:
211 - BASE_ONLY
212 - BASE_ALL
213 - BASE_NTH_LEVEL
214 - BASE_SUBTREE
215 scopeLevel:
216 type: integer
217
218#-------- Definition of types used in Trace control NRM fragment------------------
guillaume.lambert30ec3902021-09-14 12:32:24 +0200219
Michal Banka028e1c22021-05-10 11:00:39 +0200220 tjJobType-Type:
221 type: string
222 description: Specifies whether the TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined Trace and MDT job. Applicable for Trace, MDT, RCEF and RLF reporting. See 3GPP TS 32.422 clause 5.9a for additional details.
223 enum:
224 - IMMEDIATE_MDT_ONLY
225 - LOGGED_MDT_ONLY
226 - TRACE_ONLY
227 - IMMEDIATE_MDT AND TRACE
228 - RLF_REPORT_ONLY
229 - RCEF_REPORT_ONLY
230 - LOGGED_MBSFN_MDT
231
232 tjListOfInterfaces-Type:
233 description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details.
234 type: object
235 properties:
236 MSCServerInterfaces:
237 type: array
238 items:
239 type: string
240 enum:
241 - A
242 - Iu-CS
243 - Mc
244 - MAP-G
245 - MAP-B
246 - MAP-E
247 - MAP-F
248 - MAP-D
249 - MAP-C
250 - CAP
251 MGWInterfaces:
252 type: array
253 items:
254 type: string
255 enum:
256 - Mc
257 - Nb-UP
258 - Iu-UP
259 RNCInterfaces:
260 type: array
261 items:
262 type: string
263 enum:
264 - Iu-CS
265 - Iu-PS
266 - Iur
267 - Iub
268 - Uu
269 SGSNInterfaces:
270 type: array
271 items:
272 type: string
273 enum:
274 - Gb
275 - Iu-PS
276 - Gn
277 - MAP-Gr
278 - MAP-Gd
279 - MAP-Gf
280 - Ge
281 - Gs
282 - S6d
283 - S4
284 - S3
285 - S13
286 GGSNInterfaces:
287 type: array
288 items:
289 type: string
290 enum:
291 - Gn
292 - Gi
293 - Gmb
294 S-CSCFInterfaces:
295 type: array
296 items:
297 type: string
298 enum:
299 - Mw
300 - Mg
301 - Mr
302 - Mi
303 P-CSCFInterfaces:
304 type: array
305 items:
306 type: string
307 enum:
308 - Gm
309 - Mw
310 I-CSCFInterfaces:
311 type: array
312 items:
313 type: string
314 enum:
315 - Cx
316 - Dx
317 - Mg
318 - Mw
319 MRFCInterfaces:
320 type: array
321 items:
322 type: string
323 enum:
324 - Mp
325 - Mr
326 MGCFInterfaces:
327 type: array
328 items:
329 type: string
330 enum:
331 - Mg
332 - Mj
333 - Mn
334 IBCFInterfaces:
335 type: array
336 items:
337 type: string
338 enum:
339 - Ix
340 - Mx
341 E-CSCFInterfaces:
342 type: array
343 items:
344 type: string
345 enum:
346 - Mw
347 - Ml
348 - Mm
349 - Mi/Mg
350 BGCFInterfaces:
351 type: array
352 items:
353 type: string
354 enum:
355 - Mi
356 - Mj
357 - Mk
358 ASInterfaces:
359 type: array
360 items:
361 type: string
362 enum:
363 - Dh
364 - Sh
365 - ISC
366 - Ut
367 HSSInterfaces:
368 type: array
369 items:
370 type: string
371 enum:
372 - MAP-C
373 - MAP-D
374 - Gc
375 - Gr
376 - Cx
377 - S6d
378 - S6a
379 - Sh
380 EIRInterfaces:
381 type: array
382 items:
383 type: string
384 enum:
385 - MAP-F
386 - S13
387 - MAP-Gf
388 BM-SCInterfaces:
389 type: array
390 items:
391 type: string
392 enum:
393 - Gmb
394 MMEInterfaces:
395 type: array
396 items:
397 type: string
398 enum:
399 - S1-MME
400 - S3
401 - S6a
402 - S10
403 - S11
404 - S13
405 SGWInterfaces:
406 type: array
407 items:
408 type: string
409 enum:
410 - S4
411 - S5
412 - S8
413 - S11
414 - Gxc
415 PDN_GWInterfaces:
416 type: array
417 items:
418 type: string
419 enum:
420 - S2a
421 - S2b
422 - S2c
423 - S5
424 - S6b
425 - Gx
426 - S8
427 - SGi
428 eNBInterfaces:
429 type: array
430 items:
431 type: string
432 enum:
433 - S1-MME
434 - X2
435 en-gNBInterfaces:
436 type: array
437 items:
438 type: string
439 enum:
440 - S1-MME
441 - X2
442 - Uu
443 - F1-C
444 - E1
445 AMFInterfaces:
446 type: array
447 items:
448 type: string
449 enum:
450 - N1
451 - N2
452 - N8
453 - N11
454 - N12
455 - N14
456 - N15
457 - N20
458 - N22
459 - N26
460 AUSFInterfaces:
461 type: array
462 items:
463 type: string
464 enum:
465 - N12
466 - N13
467 NEFInterfaces:
468 type: array
469 items:
470 type: string
471 enum:
472 - N29
473 - N30
474 - N33
475 NRFInterfaces:
476 type: array
477 items:
478 type: string
479 enum:
480 - N27
481 NSSFInterfaces:
482 type: array
483 items:
484 type: string
485 enum:
486 - N22
487 - N31
488 PCFInterfaces:
489 type: array
490 items:
491 type: string
492 enum:
493 - N5
494 - N7
495 - N15
496 SMFInterfaces:
497 type: array
498 items:
499 type: string
500 enum:
501 - N4
502 - N7
503 - N10
504 - N11
505 - S5-C
506 SMSFInterfaces:
507 type: array
508 items:
509 type: string
510 enum:
511 - N20
512 - N21
513 UDMInterfaces:
514 type: array
515 items:
516 type: string
517 enum:
518 - N8
519 - N10
520 - N13
521 - N21
522 UPFInterfaces:
523 type: array
524 items:
525 type: string
526 enum:
527 - N4
528 ng-eNBInterfaces:
529 type: array
530 items:
531 type: string
532 enum:
533 - NG-C
534 - Xn-C
535 - Uu
536 gNB-CU-CPInterfaces:
537 type: array
538 items:
539 type: string
540 enum:
541 - NG-C
542 - Xn-C
543 - Uu
544 - F1-C
545 - E1
546 - X2-C
547 gNB-CU-UPInterfaces:
548 type: array
549 items:
550 type: string
551 enum:
552 - E1
553 gNB-DUInterfaces:
554 type: array
555 items:
556 type: string
557 enum:
558 - F1-C
559
560 tjListOfNeTypes-Type:
561 description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details.
562 type: array
563 items:
564 type: string
565 enum:
566 - MSC_SERVER
567 - SGSN
568 - MGW
569 - GGSN
570 - RNC
571 - BM_SC
572 - MME
573 - SGW
574 - PGW
575 - ENB
576 - EN_GNB
577 - GNB_CU_CP
578 - GNB_CU_UP
579 - GNB_DU
580
581 tjPLMNTaget-Type:
582 type: object
583 description: The PLMN for which sessions shall be selected in the Trace Session in case of management based activation when several PLMNs are supported in the RAN (this means that shared cells and not shared cells are allowed for the specified PLMN. Note that the PLMN Target might differ from the PLMN specified in the Trace Reference, as that specifies the PLMN that is containing the management system requesting the Trace Session from the NE. See 3GPP TS 32.422 clause 5.9b for additional details.
584 properties:
585 mcc:
586 $ref: 'comDefs.yaml#/components/schemas/Mcc'
587 mnc:
588 $ref: 'comDefs.yaml#/components/schemas/Mnc'
589 required:
590 - mcc
591 - mnc
592
593 tjStreamingTraceConsumerURI-Type:
594 type: string
595 description: The URI of the Trace Reporting MnS consumer (see 3GPP TS 28.532) to which the Trace records shall be sent. See 3GPP TS 32.422 clause 5.9 for additional details.
596 format: uri
597
598 tjTraceCollectionEntityAddress-Type:
599 description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details.
600 oneOf:
601 - $ref: '#/components/schemas/Ipv4Addr'
602 - $ref: '#/components/schemas/Ipv6Addr'
603
604 tjTraceDepth-Type:
605 description: Specifies how detailed information should be recorded in the Network Element. The Trace Depth is a paremeter for Trace Session level, i.e., the Trace Depth is the same for all of the NEs to be traced in the same Trace Session. See 3GPP TS 32.422 clause 5.3 for additional details.
606 type: string
607 enum:
608 - MINIMUM
609 - MEDIUM
610 - MAXIMUM
611 - VENDORMINIMUM
612 - VENDORMEDIUM
613 - VENDORMAXIMUM
614
615 tjTraceReference-Type:
616 type: object
617 description: The Trace Reference parameter shall be globally unique, therefore the Trace Reference shall compose as follows - MCC+MNC+Trace ID, where the MCC and MNC are coming with the Trace activation request from the management system to identify one PLMN containing the management system, and Trace ID is a 3 byte Octet String. See 3GPP TS 32.422 clause 5.6 for additional details.
618 properties:
619 mcc:
620 $ref: 'comDefs.yaml#/components/schemas/Mcc'
621 mnc:
622 $ref: 'comDefs.yaml#/components/schemas/Mnc'
623 traceId:
624 type: integer
625 required:
626 - mcc
627 - mnc
628 - traceId
629
630 tjTraceReportingFormat-Type:
631 type: string
632 description: Specifies whether file-based or streaming reporting shall be used for this Trace Session. See 3GPP TS 32.422 clause 5.11 for additional details.
633 enum:
634 - FILE-BASED
635 - STREAMING
636
637 tjTraceTarget-Type:
638 type: object
639 description: Trace target conveying both the type and value of the target ID. For additional details see 3GPP TS 32.422
640 properties:
641 TargetIdType:
642 type: string
643 enum:
644 - IMSI
645 - IMEI
646 - IMEISV
647 - PUBLIC_ID
648 - UTRAN_CELL
649 - E-UTRAN_CELL
650 - NG-RAN_CELL
651 - eNB
652 - RNC
653 - gNB
654 - SUPI
655 TargetIdValue:
656 type: string
657 required:
658 - TargetIdType
659 - TargetIdValue
guillaume.lambert30ec3902021-09-14 12:32:24 +0200660
Michal Banka028e1c22021-05-10 11:00:39 +0200661 tjTriggeringEvent-Type:
662 type: object
663 description: Specifies when to start a Trace Recording Session and which message shall be recorded first, when to stop a Trace Recording Session and which message shall be recorded last respectively. See 3GPP TS 32.422 clause 5.1 for additional detials.
664 properties:
665 NetworkElement:
666 type: string
667 enum:
668 - MSC_SERVER
669 - SGSN
670 - MGW
671 - GGSN
672 - BM_SC
673 - MME
674 - SGW
675 - PGW
676 - AMF
677 - SMF
678 - PCF
679 - UPF
680 EventBitmap:
681 type: integer
682 required:
683 - NetworkElement
684 - EventBitmap
guillaume.lambert30ec3902021-09-14 12:32:24 +0200685
Michal Banka028e1c22021-05-10 11:00:39 +0200686 tjMDTAnonymizationOfData-Type:
687 description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12.
688 type: string
689 enum:
690 - NO_IDENTITY
691 - TAC_OF_IMEI
guillaume.lambert30ec3902021-09-14 12:32:24 +0200692
Michal Banka028e1c22021-05-10 11:00:39 +0200693 tjMDTAreaConfigurationForNeighCell-Type:
694 description: Used for logged NR MDT and defines the area for which UE is requested to perform measurement logging for neighbour cells which have list of frequencies. For additional details see 3GPP TS 32.422 clause 5.10.26.
695 type: array
696 items:
697 type: object
698 properties:
699 frequency:
700 type: string
701 cell:
702 type: string
guillaume.lambert30ec3902021-09-14 12:32:24 +0200703
Michal Banka028e1c22021-05-10 11:00:39 +0200704 tjMDTAreaScope-Type:
705 description: defines the area in terms or Cells or Tracking Area/Routing Area/Location Area where the MDT data collection shall take place. For additional details see 3GPP TS 32.422 clause 5.10.2.
706 allOf:
707 - $ref: 'comDefs.yaml#/components/schemas/DnList'
guillaume.lambert30ec3902021-09-14 12:32:24 +0200708
Michal Banka028e1c22021-05-10 11:00:39 +0200709 tjMDTCollectionPeriodRrmLte-Type:
710 description: See details in 3GPP TS 32.422 clause 5.10.20.
711 type: string
712 enum:
713 - 250ms
714 - 500ms
715 - 1000ms
716 - 2000ms
717 - 3000ms
718 - 4000ms
719 - 6000ms
720 - 8000ms
721 - 12000ms
722 - 16000ms
723 - 20000ms
724 - 24000ms
725 - 28000ms
726 - 32000ms
727 - 64000ms
728
729 tjMDTCollectionPeriodRrmUmts-Type:
730 description: See details in 3GPP TS 32.422 clause 5.10.21.
731 type: string
732 enum:
733 - 1024ms
734 - 1280ms
735 - 2048ms
736 - 2560ms
737 - 5120ms
738 - 10240ms
739 - 1min
guillaume.lambert30ec3902021-09-14 12:32:24 +0200740
Michal Banka028e1c22021-05-10 11:00:39 +0200741 tjMDTCollectionPeriodRrmNR-Type:
742 description: See details in 3GPP TS 32.422 clause 5.10.30.
743 type: string
744 enum:
745 - 1024ms
746 - 1280ms
747 - 2048ms
748 - 5120ms
749 - 10240ms
750 - 60000ms
751
752 tjMDTEventListForTriggeredMeasurement-Type:
753 description: See details in 3GPP TS 32.422 clause 5.10.28.
754 type: string
755 enum:
756 - OUT_OF_COVERAGE
757 - A2_EVENT
758
759 tjMDTEventThreshold-Type:
760 description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14.
761 type: object
762 properties:
763 EventThresholdRSRP:
764 type: integer
765 minimum: 0
766 maximum: 97
guillaume.lambert30ec3902021-09-14 12:32:24 +0200767 EventThresholdRSRQ:
Michal Banka028e1c22021-05-10 11:00:39 +0200768 type: integer
769 minimum: 0
770 maximum: 34
771 EventThreshold1F:
772 type: object
773 properties:
774 CPICH_RSCP:
775 type: integer
776 minimum: -120
777 maximum: 25
778 CPICH_EcNo:
779 type: integer
780 minimum: -24
781 maximum: 0
782 PathLoss:
783 type: integer
784 minimum: 30
785 maximum: 165
786 EventThreshold1I:
787 type: integer
788 minimum: -120
789 maximum: 25
790
791 tjMDTListOfMeasurements-Type:
792 description: See details in 3GPP TS 32.422 clause 5.10.3 for details.
793 type: object
794 properties:
795 UMTS:
796 type: array
797 items:
798 type: string
799 enum:
800 - M1
801 - M2
802 - M3
803 - M4
804 - M5
805 - M6_DL
806 - M6_UL
807 - M7_DL
808 - M7_UL
809 LTE:
810 type: array
811 items:
812 type: string
813 enum:
814 - M1
815 - M2
816 - M3
817 - M4
818 - M5
819 - M1_EVENT_TRIGGERED
820 - M6
821 - M7
822 - M8
823 - M9
824 NR:
825 type: array
826 items:
827 type: string
828 enum:
829 - M1
830 - M2
831 - M3
832 - M4
833 - M5
834 - M6
835 - M7
836 - M8
837 - M9
838
839 tjMDTLoggingDuration-Type:
840 description: See details in 3GPP TS 32.422 clause 5.10.9.
841 type: string
842 enum:
843 - 600s
844 - 1200s
845 - 2400s
846 - 3600s
847 - 5400s
848 - 7200s
guillaume.lambert30ec3902021-09-14 12:32:24 +0200849
Michal Banka028e1c22021-05-10 11:00:39 +0200850 tjMDTLoggingInterval-Type:
851 description: See details in 3GPP TS 32.422 clause 5.10.8.
852 type: string
853 enum:
854 - 1.28s
855 - 2.56s
856 - 5.12s
857 - 10.24s
858 - 20.48s
859 - 30.72s
860 - 40.96s
861 - 61.44s
862
863 tjMDTMBSFNAreaList-Type:
864 description: See details in 3GPP TS 32.422 clause 5.10.25.
865 type: array
866 items:
867 type: object
868 properties:
869 mbsfnAreaId:
870 type: integer
871 minimum: 1
872 earfcn:
873 type: integer
874 minimum: 1
875 required:
876 - mbsfnAreaId
877 - earfcn
878
879 tjMDTMeasurementPeriodLTE-Type:
880 description: See details in 3GPP TS 32.422 clause 5.10.23.
881 type: string
882 enum:
883 - 1024ms
884 - 1280ms
885 - 2048ms
886 - 2560ms
887 - 5120ms
888 - 10240ms
889 - 1min
890
891 tjMDTMeasurementPeriodUMTS-Type:
892 description: See details in 3GPP TS 32.422 clause 5.10.22.
893 type: string
894 enum:
895 - 250ms
896 - 500ms
897 - 1000ms
898 - 2000ms
899 - 3000ms
900 - 4000ms
901 - 6000ms
902 - 8000ms
903 - 12000ms
904 - 16000ms
905 - 20000ms
906 - 24000ms
907 - 28000ms
908 - 32000ms
909 - 64000ms
910
911 tjMDTMeasurementQuantity-Type:
912 description: See details in 3GPP TS 32.422 clause 5.10.15.
913 type: string
914 enum:
915 - CPICH_EcNo
916 - CPICH_RSCP
917 - PathLoss
918
919 tjMDTPLMList-Type:
920 description: See details in 3GPP TS 32.422 clause 5.10.24.
921 type: array
922 items:
923 type: object
924 properties:
925 mcc:
926 $ref: 'comDefs.yaml#/components/schemas/Mcc'
927 mnc:
928 $ref: 'comDefs.yaml#/components/schemas/Mnc'
929 required:
930 - mcc
931 - mnc
932 maxItems: 16
933
934 tjMDTPositioningMethod-Type:
935 description: See details in 3GPP TS 32.422 clause 5.10.19.
936 type: string
937 enum:
938 - GNSS
939 - E-CELL_ID
940
941 tjMDTReportAmount-Type:
942 description: See details in 3GPP TS 32.422 clause 5.10.6.
943 type: string
944 enum:
945 - 1
946 - 2
947 - 4
948 - 8
949 - 16
950 - 32
951 - 64
952 - INFINITY
953
954 tjMDTReportingTrigger-Type:
955 description: See details in 3GPP TS 32.422 clause 5.10.4.
956 type: array
957 items:
958 type: string
959 enum:
960 - PERIODICAL
961 - A2_FOR_LTE
962 - 1F_FOR_UMTS
963 - 1I_FOR_UMTS_MCPS_TDD
964 - A2_TRIGGERED_PERIODIC_FOR_LTE
965 - ALL_CONFIGURED_RRM_FOR_LTE
966 - ALL_CONFIGURED_RRM_FOR_UMTS
967
968 tjMDTReportInterval-Type:
969 description: See details in 3GPP TS 32.422 clause 5.10.5.
970 type: string
971 enum:
972 - 250ms
973 - 500ms
974 - 1000ms
975 - 2000ms
976 - 3000ms
977 - 4000ms
978 - 6000ms
979 - 8000ms
980 - 12000ms
981 - 16000ms
982 - 20000ms
983 - 24000ms
984 - 28000ms
985 - 32000ms
986 - 64000ms
987 - 120ms
988 - 240ms
989 - 480ms
990 - 640ms
991 - 1024ms
992 - 2048ms
993 - 5120ms
994 - 10240ms
995 - 60000ms
996 - 360000ms
997 - 720000ms
998 - 1800000ms
999 - 3600000ms
1000
1001 tjMDTReportType-Type:
1002 description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27.
1003 type: string
1004 enum:
1005 - PERIODICAL
1006 - EVENT_TRIGGERED
1007
1008 tjMDTSensorInformation-Type:
1009 description: See details in 3GPP TS 32.422 clause 5.10.29.
1010 type: array
1011 items:
1012 type: string
1013 enum:
1014 - BAROMETRIC_PRESSURE
1015 - UE_SPEED
1016 - UE_ORIENTATION
1017
1018 tjMDTTraceCollectionEntityID-Type:
1019 description: See details in 3GPP TS 32.422 clause 5.10.11. Only tceID value may be sent over the air to the UE being configured for Logged MDT.
1020 type: object
1021 properties:
1022 tceID:
1023 type: integer
1024 tcePLMN:
1025 type: object
1026 properties:
1027 mcc:
1028 $ref: 'comDefs.yaml#/components/schemas/Mcc'
1029 mnc:
1030 $ref: 'comDefs.yaml#/components/schemas/Mnc'
1031 required:
1032 - mcc
1033 - mnc
1034 tceAddress:
1035 oneOf:
1036 - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type'
1037 - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type'
1038 required:
1039 - tceID
1040 - tcePLMN
1041 - tceAddress
1042
1043
1044#-------- end of Definition of types used in Trace control NRM fragment ----------
1045
1046
1047#-------- Definition of abstract IOC Top -----------------------------------------
1048
1049 Top-Attr:
1050 # This definition will be deprecated, when all occurances of Top-Attr
1051 # are replaced by Top.
1052 type: object
1053 properties:
1054 id:
1055 type: string
1056 VsDataContainer:
1057 $ref: '#/components/schemas/VsDataContainer-Multiple'
1058 Top:
1059 type: object
1060 properties:
1061 id:
1062 type: string
1063 VsDataContainer:
1064 $ref: '#/components/schemas/VsDataContainer-Multiple'
1065
1066#-------- Definition of IOCs with new name-containments defined in other TS ------
1067
1068 SubNetwork-Attr:
1069 type: object
1070 properties:
1071 dnPrefix:
1072 type: string
1073 userLabel:
1074 type: string
1075 userDefinedNetworkType:
1076 type: string
1077 setOfMcc:
1078 type: array
1079 items:
1080 $ref: 'comDefs.yaml#/components/schemas/Mcc'
1081 priorityLabel:
1082 type: integer
1083 supportedPerfMetricGroups:
1084 type: array
1085 items:
1086 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1087 ManagedElement-Attr:
1088 type: object
1089 properties:
1090 dnPrefix:
1091 type: string
1092 managedElementTypeList:
1093 type: array
1094 items:
1095 type: string
1096 userLabel:
1097 type: string
1098 locationName:
1099 type: string
1100 managedBy:
1101 $ref: 'comDefs.yaml#/components/schemas/DnList'
1102 vendorName:
1103 type: string
1104 userDefinedState:
1105 type: string
1106 swVersion:
1107 type: string
1108 priorityLabel:
1109 type: integer
1110 supportedPerfMetricGroups:
1111 type: array
1112 items:
1113 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1114
1115 SubNetwork-ncO:
1116 type: object
1117 properties:
1118 ManagementNode:
1119 $ref: '#/components/schemas/ManagementNode-Multiple'
1120 MeContext:
1121 $ref: '#/components/schemas/MeContext-Multiple'
1122 PerfMetricJob:
1123 $ref: '#/components/schemas/PerfMetricJob-Multiple'
1124 ThresholdMonitor:
1125 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1126 NtfSubscriptionControl:
1127 $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
1128 TraceJob:
1129 $ref: '#/components/schemas/TraceJob-Multiple'
1130 AlarmList:
1131 $ref: '#/components/schemas/AlarmList-Single'
1132 ManagedElement-ncO:
1133 type: object
1134 properties:
1135 PerfMetricJob:
1136 $ref: '#/components/schemas/PerfMetricJob-Multiple'
1137 ThresholdMonitor:
1138 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1139 NtfSubscriptionControl:
1140 $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
1141 TraceJob:
1142 $ref: '#/components/schemas/TraceJob-Multiple'
1143 AlarmList:
1144 $ref: '#/components/schemas/AlarmList-Single'
1145
1146#-------- Definition of abstract IOCs --------------------------------------------
1147
1148 ManagedFunction-Attr:
1149 type: object
1150 properties:
1151 userLabel:
1152 type: string
1153 vnfParametersList:
1154 type: array
1155 items:
1156 $ref: '#/components/schemas/VnfParameter'
1157 peeParametersList:
1158 type: array
1159 items:
1160 $ref: '#/components/schemas/PeeParameter'
1161 priorityLabel:
1162 type: integer
1163 supportedPerfMetricGroups:
1164 type: array
1165 items:
1166 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1167 EP_RP-Attr:
1168 type: object
1169 properties:
1170 userLabel:
1171 type: string
1172 farEndEntity:
1173 type: string
1174 supportedPerfMetricGroups:
1175 type: array
1176 items:
1177 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1178
1179 TraceJob-Attr:
1180 type: object
1181 description: abstract class used as a container of all TraceJob attributes
1182 properties:
1183 tjJobType:
1184 $ref: '#/components/schemas/tjJobType-Type'
1185 tjListOfInterfaces:
guillaume.lambert30ec3902021-09-14 12:32:24 +02001186 $ref: '#/components/schemas/tjListOfInterfaces-Type'
Michal Banka028e1c22021-05-10 11:00:39 +02001187 tjListOfNeTypes:
1188 $ref: '#/components/schemas/tjListOfNeTypes-Type'
1189 tjPLMNTarget:
1190 $ref: '#/components/schemas/tjPLMNTaget-Type'
1191 tjTraceConsumer:
1192 oneOf:
1193 - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type'
1194 - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type'
1195 tjTraceDepth:
1196 $ref: '#/components/schemas/tjTraceDepth-Type'
1197 tjTraceReference:
1198 $ref: '#/components/schemas/tjTraceReference-Type'
1199 tjTraceReportingFormat:
1200 $ref: '#/components/schemas/tjTraceReportingFormat-Type'
1201 tjTraceTarget:
1202 $ref: '#/components/schemas/tjTraceTarget-Type'
1203 tjTriggeringEvent:
1204 $ref: '#/components/schemas/tjTriggeringEvent-Type'
1205 tjMDTAnonymizationOfData:
1206 $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type'
1207 tjMDTAreaConfigurationForNeighCell:
1208 $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type'
1209 tjMDTAreaScope:
1210 $ref: '#/components/schemas/tjMDTAreaScope-Type'
1211 tjMDTCollectionPeriodRrmLte:
1212 $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type'
1213 tjMDTCollectionPeriodRrmUmts:
1214 $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type'
1215 tjMDTCollectionPeriodRrmNR:
1216 $ref: '#/components/schemas/tjMDTCollectionPeriodRrmNR-Type'
1217 tjMDTEventListForTriggeredMeasurement:
1218 $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type'
1219 tjMDTEventThreshold:
1220 $ref: '#/components/schemas/tjMDTEventThreshold-Type'
1221 tjMDTListOfMeasurements:
1222 $ref: '#/components/schemas/tjMDTListOfMeasurements-Type'
1223 tjMDTLoggingDuration:
1224 $ref: '#/components/schemas/tjMDTLoggingDuration-Type'
1225 tjMDTLoggingInterval:
1226 $ref: '#/components/schemas/tjMDTLoggingInterval-Type'
1227 tjMDTMBSFNAreaList:
1228 $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type'
1229 tjMDTMeasurementPeriodLTE:
1230 $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type'
1231 tjMDTMeasurementPeriodUMTS:
1232 $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type'
1233 tjMDTMeasurementQuantity:
1234 $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type'
1235 tjMDTPLMList:
1236 $ref: '#/components/schemas/tjMDTPLMList-Type'
1237 tjMDTPositioningMethod:
1238 $ref: '#/components/schemas/tjMDTPositioningMethod-Type'
1239 tjMDTReportAmount:
1240 $ref: '#/components/schemas/tjMDTReportAmount-Type'
1241 tjMDTReportingTrigger:
1242 $ref: '#/components/schemas/tjMDTReportingTrigger-Type'
1243 tjMDTReportInterval:
1244 $ref: '#/components/schemas/tjMDTReportInterval-Type'
1245 tjMDTReportType:
1246 $ref: '#/components/schemas/tjMDTReportType-Type'
1247 tjMDTSensorInformation:
1248 $ref: '#/components/schemas/tjMDTSensorInformation-Type'
1249 tjMDTTraceCollectionEntityID:
1250 $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type'
1251 required:
1252 - tjJobType
1253 - tjTraceReference
1254 - tjTraceConsumer
1255 - tjTraceReportingFormat
1256 - tjTraceTarget
1257
1258 ManagedFunction-ncO:
1259 type: object
1260 properties:
1261 PerfMetricJob:
1262 $ref: '#/components/schemas/PerfMetricJob-Multiple'
1263 ThresholdMonitor:
1264 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1265 ManagedNFService:
1266 $ref: '#/components/schemas/ManagedNFService-Multiple'
1267 TraceJob:
1268 $ref: '#/components/schemas/TraceJob-Multiple'
1269
1270#-------- Definition of concrete IOCs --------------------------------------------
1271
1272 VsDataContainer-Single:
1273 type: object
1274 properties:
1275 id:
1276 type: string
1277 attributes:
1278 type: object
1279 properties:
1280 vsDataType:
1281 type: string
1282 vsDataFormatVersion:
1283 type: string
1284 vsData:
1285 nullable: true
1286 VsDataContainer:
1287 $ref: '#/components/schemas/VsDataContainer-Multiple'
1288 ManagedNFService-Single:
1289 allOf:
1290 - $ref: '#/components/schemas/Top'
1291 - type: object
1292 properties:
1293 attributes:
1294 type: object
1295 properties:
1296 userLabel:
1297 type: string
1298 nFServiceType:
1299 $ref: '#/components/schemas/NFServiceType'
1300 sAP:
1301 $ref: '#/components/schemas/SAP'
1302 operations:
1303 type: array
1304 items:
1305 $ref: '#/components/schemas/Operation'
1306 administrativeState:
1307 $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
1308 operationalState:
1309 $ref: 'comDefs.yaml#/components/schemas/OperationalState'
1310 usageState:
1311 $ref: 'comDefs.yaml#/components/schemas/UsageState'
1312 registrationState:
1313 $ref: '#/components/schemas/RegistrationState'
1314 ManagementNode-Single:
1315 allOf:
1316 - $ref: '#/components/schemas/Top'
1317 - type: object
1318 properties:
1319 attributes:
1320 type: object
1321 properties:
1322 userLabel:
1323 type: string
1324 managedElements:
1325 $ref: 'comDefs.yaml#/components/schemas/DnList'
1326 vendorName:
1327 type: string
1328 userDefinedState:
1329 type: string
1330 locationName:
1331 type: string
1332 swVersion:
1333 type: string
1334 MeContext-Single:
1335 allOf:
1336 - $ref: '#/components/schemas/Top'
1337 - type: object
1338 properties:
1339 attributes:
1340 type: object
1341 properties:
1342 dnPrefix:
1343 type: string
1344 PerfMetricJob-Single:
1345 allOf:
1346 - $ref: '#/components/schemas/Top'
1347 - type: object
1348 properties:
1349 attributes:
1350 type: object
1351 properties:
1352 administrativeState:
1353 $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
1354 operationalState:
1355 $ref: 'comDefs.yaml#/components/schemas/OperationalState'
1356 jobId:
1357 type: string
1358 performanceMetrics:
1359 type: array
1360 items:
1361 type: string
1362 granularityPeriod:
1363 type: integer
1364 minimum: 1
1365 objectInstances:
1366 $ref: 'comDefs.yaml#/components/schemas/DnList'
1367 rootObjectInstances:
1368 $ref: 'comDefs.yaml#/components/schemas/DnList'
1369 reportingCtrl:
1370 $ref: '#/components/schemas/ReportingCtrl'
1371 ThresholdMonitor-Single:
1372 allOf:
1373 - $ref: '#/components/schemas/Top'
1374 - type: object
1375 properties:
1376 attributes:
1377 type: object
1378 properties:
1379 administrativeState:
1380 $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
1381 operationalState:
1382 $ref: 'comDefs.yaml#/components/schemas/OperationalState'
1383 performanceMetrics:
1384 type: array
1385 items:
1386 type: string
1387 thresholdInfoList:
1388 type: array
1389 items:
1390 $ref: '#/components/schemas/ThresholdInfo'
1391 monitorGranularityPeriod:
1392 type: integer
1393 minimum: 1
1394 objectInstances:
1395 $ref: 'comDefs.yaml#/components/schemas/DnList'
1396 rootObjectInstances:
1397 $ref: 'comDefs.yaml#/components/schemas/DnList'
1398 NtfSubscriptionControl-Single:
1399 allOf:
1400 - $ref: '#/components/schemas/Top'
1401 - type: object
1402 properties:
1403 attributes:
1404 type: object
1405 properties:
1406 notificationRecipientAddress:
1407 $ref: 'comDefs.yaml#/components/schemas/Uri'
1408 notificationTypes:
1409 type: array
1410 items:
1411 $ref: 'comDefs.yaml#/components/schemas/NotificationType'
1412 scope:
1413 $ref: '#/components/schemas/Scope'
1414 notificationFilter:
1415 type: string
1416 HeartbeatControl:
1417 $ref: '#/components/schemas/HeartbeatControl-Single'
1418 HeartbeatControl-Single:
1419 allOf:
1420 - $ref: '#/components/schemas/Top'
1421 - type: object
1422 properties:
1423 attributes:
1424 type: object
1425 properties:
1426 heartbeatNtfPeriod:
1427 type: integer
1428 triggerHeartbeatNtf:
1429 type: boolean
1430 TraceJob-Single:
1431 allOf:
1432 - $ref: '#/components/schemas/Top'
1433 - type: object
1434 properties:
1435 attributes:
1436 $ref: '#/components/schemas/TraceJob-Attr'
1437
1438 AlarmList-Single:
1439 allOf:
1440 - $ref: '#/components/schemas/Top'
1441 - type: object
1442 properties:
1443 attributes:
1444 type: object
1445 properties:
1446 administrativeState:
1447 $ref: 'comDefs.yaml#/components/schemas/AdministrativeState'
1448 operationalState:
1449 $ref: 'comDefs.yaml#/components/schemas/OperationalState'
1450 numOfAlarmRecords:
1451 type: integer
1452 lastModification:
1453 $ref: 'comDefs.yaml#/components/schemas/DateTime'
1454 alarmRecords:
1455 description: >-
1456 This resource represents a map of alarm records.
1457 The alarmIds are used as keys in the map.
1458 type: object
1459 additionalProperties:
1460 $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord'
1461
1462#-------- Definition of YAML arrays for name-contained IOCs ----------------------
1463
1464 VsDataContainer-Multiple:
1465 type: array
1466 items:
1467 $ref: '#/components/schemas/VsDataContainer-Single'
1468 ManagedNFService-Multiple:
1469 type: array
1470 items:
1471 $ref: '#/components/schemas/ManagedNFService-Single'
1472 ManagementNode-Multiple:
1473 type: array
1474 items:
1475 $ref: '#/components/schemas/ManagementNode-Single'
1476 MeContext-Multiple:
1477 type: array
1478 items:
1479 $ref: '#/components/schemas/MeContext-Single'
1480 PerfMetricJob-Multiple:
1481 type: array
1482 items:
1483 $ref: '#/components/schemas/PerfMetricJob-Single'
1484 ThresholdMonitor-Multiple:
1485 type: array
1486 items:
1487 $ref: '#/components/schemas/ThresholdMonitor-Single'
1488 TraceJob-Multiple:
1489 type: array
1490 items:
1491 $ref: '#/components/schemas/TraceJob-Single'
1492 NtfSubscriptionControl-Multiple:
1493 type: array
1494 items:
1495 $ref: '#/components/schemas/NtfSubscriptionControl-Single'
1496
1497#-------- Definitions in TS 28.623 for TS 28.532 ---------------------------------
1498
1499 resources-genericNrm:
1500 oneOf:
1501
1502 - $ref: '#/components/schemas/VsDataContainer-Single'
1503
1504 - $ref: '#/components/schemas/ManagementNode-Single'
1505 - $ref: '#/components/schemas/MeContext-Single'
1506
1507 - $ref: '#/components/schemas/ManagedNFService-Single'
1508
1509 - $ref: '#/components/schemas/PerfMetricJob-Single'
1510 - $ref: '#/components/schemas/ThresholdMonitor-Single'
1511 - $ref: '#/components/schemas/TraceJob-Single'
1512
1513 - $ref: '#/components/schemas/NtfSubscriptionControl-Single'
1514 - $ref: '#/components/schemas/HeartbeatControl-Single'
1515
1516 - $ref: '#/components/schemas/AlarmList-Single'