6 OAS 3.0.1 specification of the Generic NRM
7 © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC).
10 description: 3GPP TS 28.623 V16.4.0; Generic NRM
11 url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/
16 #-------- Definition of types-----------------------------------------------------
27 $ref: '#/components/schemas/Dn'
33 pattern: '^[0-9]{2,3}$'
58 $ref: '#/components/schemas/Mcc'
61 ManagedElementTypeList:
64 $ref: '#/components/schemas/ManagedElementType'
79 $ref: '#/components/schemas/VnfParameter'
98 $ref: '#/components/schemas/SiteLatitude'
100 $ref: '#/components/schemas/SiteLongitude'
110 $ref: '#/components/schemas/PeeParameter'
118 $ref: '#/components/schemas/ThresholdInfo'
125 $ref: '#/components/schemas/Direction'
127 $ref: '#/components/schemas/ThresholdPack'
135 $ref: '#/components/schemas/ThresholdPackElement'
136 ThresholdPackElement:
151 $ref: '#/components/schemas/NFType'
153 $ref: '#/components/schemas/OperationSemantics'
157 $ref: '#/components/schemas/Operation'
160 description: ' NF name defined in TS 23.501'
192 $ref: '#/components/schemas/HostAddr'
207 - $ref: '#/components/schemas/Ipv4Addr'
208 - $ref: '#/components/schemas/Ipv6Addr'
209 - $ref: '#/components/schemas/Fqdn'
212 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])$'
213 example: '198.51.100.1'
216 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])$'
217 example: '198.51.100.1'
222 - 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})))$'
223 - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
224 example: '2001:db8:85a3::8a2e:370:7334'
228 - 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})))$'
229 - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$'
230 example: '2001:db8:85a3::8a2e:370:7334'
235 - 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])))$'
236 - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$'
237 example: '2001:db8:abcd:12::0/64'
246 SupportedPerfMetricGroup:
263 - FILE_BASED_LOC_SET_BY_PRODUCER
264 - FILE_BASED_LOC_SET_BY_CONSUMER
277 $ref: '#/components/schemas/Uri'
281 $ref: '#/components/schemas/Uri'
299 - notifyMOIAttributeValueChanges
303 - notifyAckStateChanged
305 - notifyCorrelatedNotificationChanged
306 - notifyChangedAlarmGeneral
307 - notifyAlarmListRebuilt
308 - notifyPotentialFaultyAlarmList
310 - notifyFilePreparationError
311 - notifyThresholdCrossing
315 $ref: '#/components/schemas/NotificationType'
317 #-------- Definition of types used in Trace control NRM fragment------------------
321 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.
326 - IMMEDIATE_MDT AND TRACE
331 tjListOfInterfaces-Type:
332 description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details.
659 tjListOfNeTypes-Type:
660 description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details.
682 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.
685 $ref: '#/components/schemas/Mcc'
687 $ref: '#/components/schemas/Mnc'
692 tjStreamingTraceConsumerURI-Type:
694 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.
697 tjTraceCollectionEntityAddress-Type:
698 description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details.
700 - $ref: '#/components/schemas/Ipv4Addr'
701 - $ref: '#/components/schemas/Ipv6Addr'
704 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.
714 tjTraceReference-Type:
716 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.
719 $ref: '#/components/schemas/Mcc'
721 $ref: '#/components/schemas/Mnc'
729 tjTraceReportingFormat-Type:
731 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.
738 description: Type of trace target. For additional details see 3GPP TS 32.422.
751 tjTriggeringEvent-Type:
753 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.
776 tjMDTAnonymizationOfData-Type:
777 description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12.
783 tjMDTAreaConfigurationForNeighCell-Type:
784 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.
795 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.
797 - $ref: '#/components/schemas/DnList'
799 tjMDTCollectionPeriodRrmLte-Type:
800 description: See details in 3GPP TS 32.422 clause 5.10.20.
819 tjMDTCollectionPeriodRrmUmts-Type:
820 description: See details in 3GPP TS 32.422 clause 5.10.21.
831 tjMDTEventListForTriggeredMeasurement-Type:
832 description: See details in 3GPP TS 32.422 clause 5.10.28.
838 tjMDTEventThreshold-Type:
839 description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14.
870 tjMDTListOfMeasurements-Type:
871 description: See details in 3GPP TS 32.422 clause 5.10.3 for details.
918 tjMDTLoggingDuration-Type:
919 description: See details in 3GPP TS 32.422 clause 5.10.9.
929 tjMDTLoggingInterval-Type:
930 description: See details in 3GPP TS 32.422 clause 5.10.8.
942 tjMDTMBSFNAreaList-Type:
943 description: See details in 3GPP TS 32.422 clause 5.10.25.
958 tjMDTMeasurementPeriodLTE-Type:
959 description: See details in 3GPP TS 32.422 clause 5.10.23.
970 tjMDTMeasurementPeriodUMTS-Type:
971 description: See details in 3GPP TS 32.422 clause 5.10.22.
990 tjMDTMeasurementQuantity-Type:
991 description: See details in 3GPP TS 32.422 clause 5.10.15.
999 description: See details in 3GPP TS 32.422 clause 5.10.24.
1005 $ref: '#/components/schemas/Mcc'
1007 $ref: '#/components/schemas/Mnc'
1013 tjMDTPositioningMethod-Type:
1014 description: See details in 3GPP TS 32.422 clause 5.10.19.
1020 tjMDTReportAmount-Type:
1021 description: See details in 3GPP TS 32.422 clause 5.10.6.
1033 tjMDTReportingTrigger-Type:
1034 description: See details in 3GPP TS 32.422 clause 5.10.4.
1042 - 1I_FOR_UMTS_MCPS_TDD
1043 - A2_TRIGGERED_PERIODIC_FOR_LTE
1044 - ALL_CONFIGURED_RRM_FOR_LTE
1045 - ALL_CONFIGURED_RRM_FOR_UMTS
1047 tjMDTReportInterval-Type:
1048 description: See details in 3GPP TS 32.422 clause 5.10.5.
1080 tjMDTReportType-Type:
1081 description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27.
1087 tjMDTSensorInformation-Type:
1088 description: See details in 3GPP TS 32.422 clause 5.10.29.
1093 - BAROMETRIC_PRESSURE
1097 tjMDTTraceCollectionEntityID-Type:
1098 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.
1107 $ref: '#/components/schemas/Mcc'
1109 $ref: '#/components/schemas/Mnc'
1115 - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type'
1116 - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type'
1123 #-------- end of Definition of types used in Trace control NRM fragment ----------
1126 #-------- Definition of abstract IOC Top -----------------------------------------
1129 # This definition will be deprecated, when all occurances of Top-Attr
1130 # are replaced by Top.
1136 $ref: '#/components/schemas/VsDataContainer-Multiple'
1143 $ref: '#/components/schemas/VsDataContainer-Multiple'
1145 #-------- Definition of IOCs with new name-containments defined in other TS ------
1154 userDefinedNetworkType:
1157 $ref: '#/components/schemas/SetOfMcc'
1160 supportedPerfMetricGroups:
1163 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1164 ManagedElement-Attr:
1169 managedElementTypeList:
1170 $ref: '#/components/schemas/ManagedElementTypeList'
1176 $ref: '#/components/schemas/DnList'
1185 supportedPerfMetricGroups:
1188 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1194 $ref: '#/components/schemas/ManagementNode-Multiple'
1196 $ref: '#/components/schemas/MeContext-Multiple'
1198 $ref: '#/components/schemas/PerfMetricJob-Multiple'
1200 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1201 ThresholdMonitoringCapability:
1202 $ref: '#/components/schemas/ThresholdMonitoringCapability-Single'
1203 NtfSubscriptionControl:
1204 $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
1206 $ref: '#/components/schemas/TraceJob-Multiple'
1208 $ref: '#/components/schemas/AlarmList-Single'
1213 $ref: '#/components/schemas/PerfMetricJob-Multiple'
1215 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1216 ThresholdMonitoringCapability:
1217 $ref: '#/components/schemas/ThresholdMonitoringCapability-Single'
1218 NtfSubscriptionControl:
1219 $ref: '#/components/schemas/NtfSubscriptionControl-Multiple'
1221 $ref: '#/components/schemas/TraceJob-Multiple'
1223 $ref: '#/components/schemas/AlarmList-Single'
1225 #-------- Definition of abstract IOCs --------------------------------------------
1227 ManagedFunction-Attr:
1233 $ref: '#/components/schemas/VnfParametersList'
1235 $ref: '#/components/schemas/PeeParametersList'
1238 supportedPerfMetricGroups:
1241 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1249 supportedPerfMetricGroups:
1252 $ref: '#/components/schemas/SupportedPerfMetricGroup'
1256 description: abstract class used as a container of all TraceJob attributes
1259 $ref: '#/components/schemas/tjJobType-Type'
1261 $ref: '#/components/schemas/tjListOfInterfaces-Type'
1263 $ref: '#/components/schemas/tjListOfNeTypes-Type'
1265 $ref: '#/components/schemas/tjPLMNTaget-Type'
1268 - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type'
1269 - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type'
1271 $ref: '#/components/schemas/tjTraceDepth-Type'
1273 $ref: '#/components/schemas/tjTraceReference-Type'
1274 tjTraceReportingFormat:
1275 $ref: '#/components/schemas/tjTraceReportingFormat-Type'
1277 $ref: '#/components/schemas/tjTraceTarget-Type'
1279 $ref: '#/components/schemas/tjTriggeringEvent-Type'
1280 tjMDTAnonymizationOfData:
1281 $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type'
1282 tjMDTAreaConfigurationForNeighCell:
1283 $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type'
1285 $ref: '#/components/schemas/tjMDTAreaScope-Type'
1286 tjMDTCollectionPeriodRrmLte:
1287 $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type'
1288 tjMDTCollectionPeriodRrmUmts:
1289 $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type'
1290 tjMDTEventListForTriggeredMeasurement:
1291 $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type'
1292 tjMDTEventThreshold:
1293 $ref: '#/components/schemas/tjMDTEventThreshold-Type'
1294 tjMDTListOfMeasurements:
1295 $ref: '#/components/schemas/tjMDTListOfMeasurements-Type'
1296 tjMDTLoggingDuration:
1297 $ref: '#/components/schemas/tjMDTLoggingDuration-Type'
1298 tjMDTLoggingInterval:
1299 $ref: '#/components/schemas/tjMDTLoggingInterval-Type'
1301 $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type'
1302 tjMDTMeasurementPeriodLTE:
1303 $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type'
1304 tjMDTMeasurementPeriodUMTS:
1305 $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type'
1306 tjMDTMeasurementQuantity:
1307 $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type'
1309 $ref: '#/components/schemas/tjMDTPLMList-Type'
1310 tjMDTPositioningMethod:
1311 $ref: '#/components/schemas/tjMDTPositioningMethod-Type'
1313 $ref: '#/components/schemas/tjMDTReportAmount-Type'
1314 tjMDTReportingTrigger:
1315 $ref: '#/components/schemas/tjMDTReportingTrigger-Type'
1316 tjMDTReportInterval:
1317 $ref: '#/components/schemas/tjMDTReportInterval-Type'
1319 $ref: '#/components/schemas/tjMDTReportType-Type'
1320 tjMDTSensorInformation:
1321 $ref: '#/components/schemas/tjMDTSensorInformation-Type'
1322 tjMDTTraceCollectionEntityID:
1323 $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type'
1328 - tjTraceReportingFormat
1331 ManagedFunction-ncO:
1335 $ref: '#/components/schemas/MeasurementControl-Multiple'
1337 $ref: '#/components/schemas/ThresholdMonitor-Multiple'
1338 ThresholdMonitoringCapability:
1339 $ref: '#/components/schemas/ThresholdMonitoringCapability-Single'
1341 $ref: '#/components/schemas/ManagedNFService-Multiple'
1343 $ref: '#/components/schemas/TraceJob-Multiple'
1345 #-------- Definition of concrete IOCs --------------------------------------------
1347 VsDataContainer-Single:
1357 vsDataFormatVersion:
1362 $ref: '#/components/schemas/VsDataContainer-Multiple'
1363 ManagedNFService-Single:
1365 - $ref: '#/components/schemas/Top-Attr'
1374 $ref: '#/components/schemas/NFServiceType'
1376 $ref: '#/components/schemas/SAP'
1378 $ref: '#/components/schemas/OperationList'
1379 administrativeState:
1380 $ref: '#/components/schemas/AdministrativeState'
1382 $ref: '#/components/schemas/OperationalState'
1384 $ref: '#/components/schemas/UsageState'
1386 $ref: '#/components/schemas/RegistrationState'
1387 ManagementNode-Single:
1389 - $ref: '#/components/schemas/Top-Attr'
1398 $ref: '#/components/schemas/DnList'
1409 - $ref: '#/components/schemas/Top-Attr'
1417 PerfMetricJob-Single:
1419 - $ref: '#/components/schemas/Top-Attr'
1425 administrativeState:
1426 $ref: '#/components/schemas/AdministrativeState'
1428 $ref: '#/components/schemas/OperationalState'
1429 perfMetricJobGroupId:
1439 $ref: '#/components/schemas/DnList'
1440 rootObjectInstances:
1441 $ref: '#/components/schemas/DnList'
1443 $ref: '#/components/schemas/ReportingCtrl'
1444 ThresholdMonitoringCapability-Single:
1446 - $ref: '#/components/schemas/Top-Attr'
1452 supportedMonitoringGPs:
1453 $ref: '#/components/schemas/MonitoringGPList'
1454 ThresholdMonitor-Single:
1456 - $ref: '#/components/schemas/Top-Attr'
1463 $ref: '#/components/schemas/ThresholdInfoList'
1466 monitoringNotifTarget:
1471 $ref: '#/components/schemas/DnList'
1472 NtfSubscriptionControl-Single:
1474 - $ref: '#/components/schemas/Top-Attr'
1480 notificationRecipientAddress:
1481 $ref: '#/components/schemas/Uri'
1483 $ref: '#/components/schemas/NotificationTypes'
1485 $ref: '#/components/schemas/Scope'
1489 $ref: '#/components/schemas/HeartbeatControl-Single'
1490 HeartbeatControl-Single:
1492 - $ref: '#/components/schemas/Top-Attr'
1500 triggerHeartbeatNtf:
1504 - $ref: '#/components/schemas/Top-Attr'
1508 $ref: '#/components/schemas/TraceJob-Attr'
1512 - $ref: '#/components/schemas/Top-Attr'
1518 administrativeState:
1519 $ref: '#/components/schemas/AdministrativeState'
1521 $ref: '#/components/schemas/OperationalState'
1525 $ref: '#/components/schemas/DateTime'
1528 This resource represents a map of alarm records.
1529 The alarmIds are used as keys in the map.
1531 additionalProperties:
1532 $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord'
1534 #-------- Definition of JSON arrays for name-contained IOCs ----------------------
1536 VsDataContainer-Multiple:
1539 $ref: '#/components/schemas/VsDataContainer-Single'
1540 ManagedNFService-Multiple:
1543 $ref: '#/components/schemas/ManagedNFService-Single'
1544 ManagementNode-Multiple:
1547 $ref: '#/components/schemas/ManagementNode-Single'
1551 $ref: '#/components/schemas/MeContext-Single'
1552 PerfMetricJob-Multiple:
1555 $ref: '#/components/schemas/MetricProdJob-Single'
1556 ThresholdMonitor-Multiple:
1559 $ref: '#/components/schemas/ThresholdMonitor-Single'
1560 NtfSubscriptionControl-Multiple:
1563 $ref: '#/components/schemas/NtfSubscriptionControl-Single'
1567 $ref: '#/components/schemas/TraceJob-Single'
1569 #-------- Definitions in TS 28.623 for TS 28.532 ---------------------------------
1571 resources-genericNrm:
1574 - $ref: '#/components/schemas/VsDataContainer-Single'
1576 - $ref: '#/components/schemas/ManagementNode-Single'
1577 - $ref: '#/components/schemas/MeContext-Single'
1579 - $ref: '#/components/schemas/ManagedNFService-Single'
1581 - $ref: '#/components/schemas/PerfMetricJob-Single'
1583 - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single'
1584 - $ref: '#/components/schemas/ThresholdMonitor-Single'
1586 - $ref: '#/components/schemas/NtfSubscriptionControl-Single'
1587 - $ref: '#/components/schemas/HeartbeatControl-Single'
1588 - $ref: '#/components/schemas/TraceJob-Single'
1590 - $ref: '#/components/schemas/AlarmList-Single'