diff --git a/OpenAPI/5gcNrm.yaml b/OpenAPI/5gcNrm.yaml deleted file mode 100644 index d5adbd23059852cd96e48106857e7159714de26c..0000000000000000000000000000000000000000 --- a/OpenAPI/5gcNrm.yaml +++ /dev/null @@ -1,1789 +0,0 @@ -openapi: 3.0.1 -info: - title: 3GPP 5GC NRM - version: 16.5.0 - description: >- - OAS 3.0.1 specification of the 5GC 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, 5GC NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - AmfIdentifier: - type: object - description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' - properties: - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - amfPointer: - $ref: '#/components/schemas/AmfPointer' - AmfRegionId: - type: integer - description: AmfRegionId is defined in TS 23.003 - maximum: 255 - AmfSetId: - type: string - description: AmfSetId is defined in TS 23.003 - maximum: 1023 - AmfPointer: - type: integer - description: AmfPointer is defined in TS 23.003 - maximum: 63 - IpEndPoint: - type: object - properties: - ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' - ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' - ipv6Prefix: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Prefix' - transport: - $ref: 'genericNrm.yaml#/components/schemas/TransportProtocol' - port: - type: integer - NFProfileList: - type: array - description: List of NF profile - items: - $ref: '#/components/schemas/NFProfile' - NFProfile: - type: object - description: 'NF profile stored in NRF, defined in TS 29.510' - properties: - nFInstanceId: - type: string - description: uuid of NF instance - nFType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - nFStatus: - $ref: '#/components/schemas/NFStatus' - plmn: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sNssais: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - nfServices: - type: array - items: - $ref: '#/components/schemas/NFService' - NFService: - type: object - description: NF Service is defined in TS 29.510 - properties: - serviceInstanceId: - type: string - serviceName: - type: string - version: - type: string - schema: - type: string - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - interPlmnFqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - ipEndPoints: - type: array - items: - $ref: '#/components/schemas/IpEndPoint' - apiPrfix: - type: string - allowedPlmns: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - allowedNfTypes: - type: array - items: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - allowedNssais: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - NFStatus: - type: string - description: any of enumrated value - enum: - - REGISTERED - - SUSPENDED - CNSIIdList: - type: array - items: - $ref: '#/components/schemas/CNSIId' - CNSIId: - type: string - description: CNSI Id is defined in TS 29.531, only for Core Network - TACList: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/NrTac' - WeightFactor: - type: integer - UdmInfo: - type: object - properties: - nFSrvGroupId: - type: string - AusfInfo: - type: object - properties: - nFSrvGroupId: - type: string - UpfInfo: - type: object - properties: - smfServingAreas: - type: string - AmfInfo: - type: object - properties: - priority: - type: integer - SupportedDataSetId: - type: string - description: any of enumrated value - enum: - - SUBSCRIPTION - - POLICY - - EXPOSURE - - APPLICATION - Udrinfo: - type: object - properties: - supportedDataSetIds: - type: array - items: - $ref: '#/components/schemas/SupportedDataSetId' - nFSrvGroupId: - type: string - NFInfo: - oneOf: - - $ref: '#/components/schemas/UdmInfo' - - $ref: '#/components/schemas/AusfInfo' - - $ref: '#/components/schemas/UpfInfo' - - $ref: '#/components/schemas/AmfInfo' - - $ref: '#/components/schemas/Udrinfo' - ManagedNFProfile: - type: object - properties: - nfInstanceID: - type: string - nfType: - $ref: 'genericNrm.yaml#/components/schemas/NFType' - authzInfo: - type: string - hostAddr: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - locality: - type: string - nFInfo: - $ref: '#/components/schemas/NFInfo' - capacity: - type: integer - SEPPType: - type: string - description: any of enumrated value - enum: - - CSEPP - - PSEPP - SupportedFunc: - type: object - properties: - function: - type: string - policy: - type: string - SupportedFuncList: - type: array - items: - $ref: '#/components/schemas/SupportedFunc' - CommModelType: - type: string - description: any of enumrated value - enum: - - DIRECT_COMMUNICATION_WO_NRF - - DIRECT_COMMUNICATION_WITH_NRF - - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY - - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY - CommModel: - type: object - properties: - groupId: - type: integer - commModelType: - $ref: '#/components/schemas/CommModelType' - targetNFServiceList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - commModelConfiguration: - type: string - CommModelList: - type: array - items: - $ref: '#/components/schemas/CommModel' - CapabilityList: - type: array - items: - type: string - FiveQiDscpMapping: - type: object - properties: - fiveQIValues: - type: array - items: - type: integer - dscp: - type: integer - - PacketErrorRate: - type: object - properties: - scalar: - type: integer - exponent: - type: integer - FiveQICharacteristics: - type: object - properties: - fiveQIValue: - type: integer - resourceType: - type: string - enum: - - GBR - - NonGBR - priorityLevel: - type: integer - packetDelayBudget: - type: integer - packetErrorRate: - $ref: '#/components/schemas/PacketErrorRate' - averagingWindow: - type: integer - maximumDataBurstVolume: - type: integer - - - GtpUPathDelayThresholdsType: - type: object - properties: - n3AveragePacketDelayThreshold: - type: integer - n3MinPacketDelayThreshold: - type: integer - n3MaxPacketDelayThreshold: - type: integer - n9AveragePacketDelayThreshold: - type: integer - n9MinPacketDelayThreshold: - type: integer - n9MaxPacketDelayThreshold: - type: integer - QFPacketDelayThresholdsType: - type: object - properties: - thresholdDl: - type: integer - thresholdUl: - type: integer - thresholdRtt: - type: integer - - -#-------- 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' - ManagedElement: - $ref: '#/components/schemas/ManagedElement-Multiple' - ExternalAmfFunction: - $ref: '#/components/schemas/ExternalAmfFunction-Multiple' - ExternalNrfFunction: - $ref: '#/components/schemas/ExternalNrfFunction-Multiple' - ExternalNssfFunction: - $ref: '#/components/schemas/ExternalNssfFunction-Multiple' - AmfSet: - $ref: '#/components/schemas/AmfSet-Multiple' - AmfRegion: - $ref: '#/components/schemas/AmfRegion-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - - ManagedElement-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-ncO' - - type: object - properties: - AmfFunction: - $ref: '#/components/schemas/AmfFunction-Multiple' - SmfFunction: - $ref: '#/components/schemas/SmfFunction-Multiple' - UpfFunction: - $ref: '#/components/schemas/UpfFunction-Multiple' - N3iwfFunction: - $ref: '#/components/schemas/N3iwfFunction-Multiple' - PcfFunction: - $ref: '#/components/schemas/PcfFunction-Multiple' - AusfFunction: - $ref: '#/components/schemas/AusfFunction-Multiple' - UdmFunction: - $ref: '#/components/schemas/UdmFunction-Multiple' - UdrFunction: - $ref: '#/components/schemas/UdrFunction-Multiple' - UdsfFunction: - $ref: '#/components/schemas/UdsfFunction-Multiple' - NrfFunction: - $ref: '#/components/schemas/NrfFunction-Multiple' - NssfFunction: - $ref: '#/components/schemas/NssfFunction-Multiple' - SmsfFunction: - $ref: '#/components/schemas/SmsfFunction-Multiple' - LmfFunction: - $ref: '#/components/schemas/LmfFunction-Multiple' - NgeirFunction: - $ref: '#/components/schemas/NgeirFunction-Multiple' - SeppFunction: - $ref: '#/components/schemas/SeppFunction-Multiple' - NwdafFunction: - $ref: '#/components/schemas/NwdafFunction-Multiple' - ScpFunction: - $ref: '#/components/schemas/ScpFunction-Multiple' - NefFunction: - $ref: '#/components/schemas/NefFunction-Multiple' - Configurable5QISet: - $ref: '#/components/schemas/Configurable5QISet-Multiple' - - AmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - sBIFqdn: - type: string - weightFactor: - $ref: '#/components/schemas/WeightFactor' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - amfSet: - $ref: 'genericNrm.yaml#/components/schemas/Dn' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N2: - $ref: '#/components/schemas/EP_N2-Multiple' - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N14: - $ref: '#/components/schemas/EP_N14-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N26: - $ref: '#/components/schemas/EP_N26-Multiple' - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - EP_NLG: - $ref: '#/components/schemas/EP_NLG-Multiple' - AmfSet-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfSetId: - $ref: '#/components/schemas/AmfSetId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - AmfRegion-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - amfRegionId: - $ref: '#/components/schemas/AmfRegionId' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - SmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - Configurable5QISetRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N11: - $ref: '#/components/schemas/EP_N11-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_S5C: - $ref: '#/components/schemas/EP_S5C-Multiple' - FiveQiDscpMappingSet: - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' - GtpUPathQoSMonitoringControl: - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - QFQoSMonitoringControl: - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - - UpfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - nRTACList: - $ref: '#/components/schemas/TACList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - EP_N6: - $ref: '#/components/schemas/EP_N6-Multiple' - EP_N9: - $ref: '#/components/schemas/EP_N9-Multiple' - EP_S5U: - $ref: '#/components/schemas/EP_S5U-Multiple' - N3iwfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N3: - $ref: '#/components/schemas/EP_N3-Multiple' - EP_N4: - $ref: '#/components/schemas/EP_N4-Multiple' - PcfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N5: - $ref: '#/components/schemas/EP_N5-Multiple' - EP_N7: - $ref: '#/components/schemas/EP_N7-Multiple' - EP_N15: - $ref: '#/components/schemas/EP_N15-Multiple' - EP_N16: - $ref: '#/components/schemas/EP_N16-Multiple' - EP_Rx: - $ref: '#/components/schemas/EP_Rx-Multiple' - AusfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N12: - $ref: '#/components/schemas/EP_N12-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdmFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N8: - $ref: '#/components/schemas/EP_N8-Multiple' - EP_N10: - $ref: '#/components/schemas/EP_N10-Multiple' - EP_N13: - $ref: '#/components/schemas/EP_N13-Multiple' - UdrFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - UdsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - NrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N27: - $ref: '#/components/schemas/EP_N27-Multiple' - NssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - cNSIIdList: - $ref: '#/components/schemas/CNSIIdList' - nFProfileList: - $ref: '#/components/schemas/NFProfileList' - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N22: - $ref: '#/components/schemas/EP_N22-Multiple' - EP_N31: - $ref: '#/components/schemas/EP_N31-Multiple' - SmsfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N20: - $ref: '#/components/schemas/EP_N20-Multiple' - EP_N21: - $ref: '#/components/schemas/EP_N21-Multiple' - EP_MAP_SMSC: - $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' - LmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_NLS: - $ref: '#/components/schemas/EP_NLS-Multiple' - NgeirFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N17: - $ref: '#/components/schemas/EP_N17-Multiple' - SeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPType: - $ref: '#/components/schemas/SEPPType' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - type: object - properties: - EP_N32: - $ref: '#/components/schemas/EP_N32-Multiple' - NwdafFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - commModelList: - $ref: '#/components/schemas/CommModelList' - ScpFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - supportedFuncList: - $ref: '#/components/schemas/SupportedFuncList' - address: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - NefFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - sBIFqdn: - type: string - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - managedNFProfile: - $ref: '#/components/schemas/ManagedNFProfile' - capabilityList: - $ref: '#/components/schemas/CapabilityList' - isINEF: - type: boolean - isCAPIFSup: - type: boolean - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-ncO' - - ExternalAmfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - amfIdentifier: - $ref: '#/components/schemas/AmfIdentifier' - ExternalNrfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalNssfFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - ExternalSeppFunction-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - plmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - sEPPId: - type: integer - fqdn: - $ref: 'genericNrm.yaml#/components/schemas/Fqdn' - - - EP_N2-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N3-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N4-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N5-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N6-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N7-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N8-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N9-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N10-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N11-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N12-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N13-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N14-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N15-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N16-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N17-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N20-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N21-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N22-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - EP_N26-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N27-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - - EP_N31-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_N32-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - remotePlmnId: - $ref: 'nrNrm.yaml#/components/schemas/PlmnId' - remoteSeppAddress: - $ref: 'genericNrm.yaml#/components/schemas/HostAddr' - remoteSeppId: - type: integer - n32cParas: - type: string - n32fPolicy: - type: string - withIPX: - type: boolean - - EP_S5C-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_S5U-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_Rx-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_MAP_SMSC-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLS-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - EP_NLG-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' - - type: object - properties: - localAddress: - $ref: 'nrNrm.yaml#/components/schemas/LocalAddress' - remoteAddress: - $ref: 'nrNrm.yaml#/components/schemas/RemoteAddress' - - FiveQiDscpMappingSet-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - FiveQiDscpMappingList: - type: array - items: - $ref: '#/components/schemas/FiveQiDscpMapping' - - Configurable5QISet-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - configurable5QIs: - type: array - items: - $ref: '#/components/schemas/FiveQICharacteristics' - GtpUPathQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - gtpUPathQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - gtpUPathMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - monitoredDSCPs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredGtpUPathMonitoringSupported: - type: boolean - isPeriodicGtpUMonitoringSupported: - type: boolean - isImmediateGtpUMonitoringSupported: - type: boolean - gtpUPathDelayThresholds: - $ref: '#/components/schemas/GtpUPathDelayThresholdsType' - gtpUPathMinimumWaitTime: - type: integer - gtpUPathMeasurementPeriod: - type: integer - - QFQoSMonitoringControl-Single: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - allOf: - - type: object - properties: - qFQoSMonitoringState: - type: string - enum: - - ENABLED - - DISABLED - qFMonitoredSNSSAIs: - type: array - items: - $ref: 'nrNrm.yaml#/components/schemas/Snssai' - qFMonitored5QIs: - type: array - items: - type: integer - minimum: 0 - maximum: 255 - isEventTriggeredQFMonitoringSupported: - type: boolean - isPeriodicQFMonitoringSupported: - type: boolean - isSessionReleasedQFMonitoringSupported: - type: boolean - qFPacketDelayThresholds: - $ref: '#/components/schemas/QFPacketDelayThresholdsType' - qFMinimumWaitTime: - type: integer - qFMeasurementPeriod: - type: integer - - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - SubNetwork-Multiple: - type: array - items: - $ref: '#/components/schemas/SubNetwork-Single' - ManagedElement-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedElement-Single' - AmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfFunction-Single' - SmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmfFunction-Single' - UpfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UpfFunction-Single' - N3iwfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/N3iwfFunction-Single' - PcfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/PcfFunction-Single' - AusfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/AusfFunction-Single' - UdmFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdmFunction-Single' - UdrFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdrFunction-Single' - UdsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/UdsfFunction-Single' - NrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NrfFunction-Single' - NssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NssfFunction-Single' - SmsfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SmsfFunction-Single' - LmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/LmfFunction-Single' - NgeirFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NgeirFunction-Single' - SeppFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/SeppFunction-Single' - NwdafFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NwdafFunction-Single' - ScpFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ScpFunction-Single' - NefFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/NefFunction-Single' - - ExternalAmfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalAmfFunction-Single' - ExternalNrfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNrfFunction-Single' - ExternalNssfFunction-Multiple: - type: array - items: - $ref: '#/components/schemas/ExternalNssfFunction-Single' - ExternalSeppFunction-Nultiple: - type: array - items: - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - AmfSet-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfSet-Single' - AmfRegion-Multiple: - type: array - items: - $ref: '#/components/schemas/AmfRegion-Single' - - EP_N2-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N2-Single' - EP_N3-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N3-Single' - EP_N4-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N4-Single' - EP_N5-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N5-Single' - EP_N6-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N6-Single' - EP_N7-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N7-Single' - EP_N8-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N8-Single' - EP_N9-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N9-Single' - EP_N10-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N10-Single' - EP_N11-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N11-Single' - EP_N12-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N12-Single' - EP_N13-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N13-Single' - EP_N14-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N14-Single' - EP_N15-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N15-Single' - EP_N16-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N16-Single' - EP_N17-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N17-Single' - - EP_N20-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N20-Single' - EP_N21-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N21-Single' - EP_N22-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N22-Single' - - EP_N26-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N26-Single' - EP_N27-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N27-Single' - - EP_N31-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N31-Single' - EP_N32-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_N32-Single' - - EP_S5C-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5C-Single' - EP_S5U-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_S5U-Single' - EP_Rx-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_Rx-Single' - EP_MAP_SMSC-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - EP_NLS-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLS-Single' - EP_NLG-Multiple: - type: array - items: - $ref: '#/components/schemas/EP_NLG-Single' - Configurable5QISet-Multiple: - type: array - items: - $ref: '#/components/schemas/Configurable5QISet-Single' - - -#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- - - resources-5gcNrm: - oneOf: - - $ref: '#/components/schemas/SubNetwork-Single' - - $ref: '#/components/schemas/ManagedElement-Single' - - $ref: '#/components/schemas/AmfFunction-Single' - - $ref: '#/components/schemas/SmfFunction-Single' - - $ref: '#/components/schemas/UpfFunction-Single' - - $ref: '#/components/schemas/N3iwfFunction-Single' - - $ref: '#/components/schemas/PcfFunction-Single' - - $ref: '#/components/schemas/AusfFunction-Single' - - $ref: '#/components/schemas/UdmFunction-Single' - - $ref: '#/components/schemas/UdrFunction-Single' - - $ref: '#/components/schemas/UdsfFunction-Single' - - $ref: '#/components/schemas/NrfFunction-Single' - - $ref: '#/components/schemas/NssfFunction-Single' - - $ref: '#/components/schemas/SmsfFunction-Single' - - $ref: '#/components/schemas/LmfFunction-Single' - - $ref: '#/components/schemas/NgeirFunction-Single' - - $ref: '#/components/schemas/SeppFunction-Single' - - $ref: '#/components/schemas/NwdafFunction-Single' - - $ref: '#/components/schemas/ScpFunction-Single' - - $ref: '#/components/schemas/NefFunction-Single' - - - $ref: '#/components/schemas/ExternalAmfFunction-Single' - - $ref: '#/components/schemas/ExternalNrfFunction-Single' - - $ref: '#/components/schemas/ExternalNssfFunction-Single' - - $ref: '#/components/schemas/ExternalSeppFunction-Single' - - - $ref: '#/components/schemas/AmfSet-Single' - - $ref: '#/components/schemas/AmfRegion-Single' - - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' - - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' - - - $ref: '#/components/schemas/EP_N2-Single' - - $ref: '#/components/schemas/EP_N3-Single' - - $ref: '#/components/schemas/EP_N4-Single' - - $ref: '#/components/schemas/EP_N5-Single' - - $ref: '#/components/schemas/EP_N6-Single' - - $ref: '#/components/schemas/EP_N7-Single' - - $ref: '#/components/schemas/EP_N8-Single' - - $ref: '#/components/schemas/EP_N9-Single' - - $ref: '#/components/schemas/EP_N10-Single' - - $ref: '#/components/schemas/EP_N11-Single' - - $ref: '#/components/schemas/EP_N12-Single' - - $ref: '#/components/schemas/EP_N13-Single' - - $ref: '#/components/schemas/EP_N14-Single' - - $ref: '#/components/schemas/EP_N15-Single' - - $ref: '#/components/schemas/EP_N16-Single' - - $ref: '#/components/schemas/EP_N17-Single' - - - $ref: '#/components/schemas/EP_N20-Single' - - $ref: '#/components/schemas/EP_N21-Single' - - $ref: '#/components/schemas/EP_N22-Single' - - - $ref: '#/components/schemas/EP_N26-Single' - - $ref: '#/components/schemas/EP_N27-Single' - - - $ref: '#/components/schemas/EP_N31-Single' - - $ref: '#/components/schemas/EP_N31-Single' - - - $ref: '#/components/schemas/EP_S5C-Single' - - $ref: '#/components/schemas/EP_S5U-Single' - - $ref: '#/components/schemas/EP_Rx-Single' - - $ref: '#/components/schemas/EP_MAP_SMSC-Single' - - $ref: '#/components/schemas/EP_NLS-Single' - - $ref: '#/components/schemas/EP_NLG-Single' - - $ref: '#/components/schemas/Configurable5QISet-Single' - - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' diff --git a/OpenAPI/PerDataFileReportMnS.yaml b/OpenAPI/PerDataFileReportMnS.yaml deleted file mode 100644 index dfacc14f8cbe8e923eda511cf2a0efd4bac081e9..0000000000000000000000000000000000000000 --- a/OpenAPI/PerDataFileReportMnS.yaml +++ /dev/null @@ -1,272 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Performance data file reporting Service - version: 16.4.0 - description: >- - OAS 3.0.1 specification of the Performance data file reporting Management Service © 2020, - 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All - rights reserved. -externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services - url: 'http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/' -servers: - - url: '{MnSRoot}/PerfDataFileReportMnS/v1640' - variables: - MnSRoot: - description: See subclause 4.4 of TS 32.158 - default: http://example.com/3GPPManagement -paths: - /Files: - get: - summary: Read resources of information of available files - description: 'With HTTP GET, resources of information of available files are read. The resources to be read are identified with the path component (base resource) and the query component (managementDataType, beginTime and endTime) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: managementDataType - in: query - description: This parameter identifies the type of management data that the file contains to select the resources from the collection resources identified with the path component of the URI. - required: true - $ref: '#/components/schemas/managementDataType-Type' - - name: beginTime - in: query - description: This parameter identifies the time stamp no later than which the file became available to select the resources from the collection resources identified with the path component of the URI. - required: true - $ref: '#/components/schemas/dateTime-Type' - - name: endTime - in: query - description: This parameter identifies the time stamp no earlier than which the file became available to select the resources from the collection resources identified with the path component of the URI. - required: true - $ref: '#/components/schemas/dateTime-Type' - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/fileInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - /subscriptions: - post: - summary: Create a subscription - description: To create a subscription the representation of the subscription is POSTed on the /subscriptions collection resource. - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/subscription-RequestType' - responses: - '201': - description: Success case ("201 Created"). The representation of the newly created subscription resource shall be returned. - content: - application/json: - schema: - $ref: '#/components/schemas/subscription-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - callbacks: - notifyFileReady: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyFileReady-NotifType' - responses: - '204': - description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - notifyFilePreparationError: - '{request.body#/consumerReference}': - post: - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyFilePreparationError-NotifType' - responses: - '204': - description: Success case ("204 No Content"). The notification is successfully delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: Delete all subscriptions made with a specific consumerReferenceId - description: The subscriptions are deleted by deleting the corresponding subscription resources. The resources to be deleted are identified with the path component of the URI pointing to the /subscription collection resource and filtering on the consumerReferenceId provided in the query part. - parameters: - - name: consumerReferenceId - in: query - description: Identifies the subscriptions to be deleted. - required: true - schema: - $ref: '#/components/schemas/consumerReferenceId-QueryType' - responses: - '204': - description: Success case ("204 No Content"). The subscription resources have been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/subscriptions/{subscriptionId}': - delete: - summary: Delete a single subscription - description: The subscription is deleted by deleting the corresponding subscription resource. The resource to be deleted is identified with the path component of the URI. - parameters: - - name: subscriptionId - in: path - description: Identifies the subscription to be deleted. - required: true - schema: - $ref: '#/components/schemas/subscriptionId-PathType' - responses: - '204': - description: Success case ("204 No Content"). The subscription resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - long-Type: - type: string - format: long - additionalText-Type: - type: string - reason-Type: - type: string - fileInfoRetrieval-ResponseType: - type: object - properties: - data: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - fileInfo-Type: - type: object - properties: - fileLocation: - $ref: '#/components/schemas/uri-Type' - fileSize: - $ref: '#/components/schemas/long-Type' - fileReadyTime: - $ref: '#/components/schemas/dateTime-Type' - fileExpirationTime: - $ref: '#/components/schemas/dateTime-Type' - fileCompression: - type: string - fileFormat: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - managementDataType-Type: - type: string - enum: - - PM - header-Type: - description: Header used in notifications as notification header - type: object - properties: - uri: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - subscriptionId-PathType: - type: string - filter-Type: - type: string - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyFileReady - - notifyFilePreparationError - subscription-ResourceType: - type: object - properties: - consumerReference: - $ref: '#/components/schemas/uri-Type' - timeTick: - $ref: '#/components/schemas/long-Type' - filter: - $ref: '#/components/schemas/filter-Type' - subscription-RequestType: - type: object - properties: - data: - $ref: '#/components/schemas/subscription-ResourceType' - subscription-ResponseType: - type: object - properties: - data: - $ref: '#/components/schemas/subscription-ResourceType' - consumerReferenceId-QueryType: - $ref: '#/components/schemas/uri-Type' - notifyFileReady-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - fileInfoList: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' - notifyFilePreparationError-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - fileInfoList: - type: array - items: - $ref: '#/components/schemas/fileInfo-Type' - reason: - $ref: '#/components/schemas/reason-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerThresMonMnS.yaml b/OpenAPI/PerThresMonMnS.yaml deleted file mode 100644 index 923640a11e3f578a9887d4a8699d3b8814085353..0000000000000000000000000000000000000000 --- a/OpenAPI/PerThresMonMnS.yaml +++ /dev/null @@ -1,102 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.532 Performance Threshold Monitoring Service - version: 16.4.0 - description: OAS 3.0.1 specification of the Performance Threshold Monitoring Service -servers: - - url: 'http://{monitoringNotifTarget}' - variables: - monitoringNotifTarget: - description: >- - The open API server of the performance threshold monitoring service is - located in the consumer side, see monitoringNotifTarget attribute of - the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. - default: example.com -paths: - /notificationSink: - post: - summary: Send notifications about performance threshold crossing - description: To send a notifyThresholdCrossing notification - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/notifyThresholdCrossing-NotifType' - responses: - '204': - description: >- - Success case ("204 No Content"). The notification is successfully - delivered. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - dateTime-Type: - type: string - format: date-Time - uri-Type: - type: string - long-Type: - type: string - format: long - thresholdLevel-Type: - type: integer - measurementTypeName-Type: - type: string - measurementValue-Type: - type: string - additionalText-Type: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - header-Type: - description: Header used in notifications as notification header - type: object - properties: - uri: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: - type: string - enum: - - notifyThresholdCrossing - notifyThresholdCrossing-NotifType: - type: object - properties: - header: - $ref: '#/components/schemas/header-Type' - body: - type: object - properties: - startOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - endOfMonitoringGP: - $ref: '#/components/schemas/dateTime-Type' - monitoredObjectInstance: - $ref: '#/components/schemas/uri-Type' - thresholdLevel: - $ref: '#/components/schemas/thresholdLevel-Type' - measurementTypeName: - $ref: '#/components/schemas/measurementTypeName-Type' - measurementValue: - $ref: '#/components/schemas/measurementValue-Type' - additionalText: - $ref: '#/components/schemas/additionalText-Type' diff --git a/OpenAPI/PerfDataStreamingMnS.yaml b/OpenAPI/PerfDataStreamingMnS.yaml deleted file mode 100644 index e040e14c80af94fc200a0b40424c35ddc6aa29eb..0000000000000000000000000000000000000000 --- a/OpenAPI/PerfDataStreamingMnS.yaml +++ /dev/null @@ -1,363 +0,0 @@ -openapi: 3.0.1 -info: - title: TS 28.550 Performance Data Streaming Service - version: 16.3.0 - description: OAS 3.0.1 specification of the Performance Data Streaming Service -servers: - - url: 'http://{streamTarget}/PerfDataStreamMnS/v1630' - description: This URL is used for posting the set of information about streams supported on the connection between the producer and the consumer. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com - - url: 'wss://{streamTarget}/PerfDataStreamMnS/v1630/streamingConnection' - description: This URL is used for establishing the WebSocket connection for the performance data streaming service. - variables: - streamTarget: - description: 'The open API server of the performance data streaming service is located in the consumer side,and the “streamTarget” part corresponds to the streamTarget parameter provided in the createMeasurementJob operation (see clause 6.1.1.2) or the streamTarget attribute of the MOI of MeasurementControlor MeasurementReader, see 3GPP TS 28.622 [5]).' - default: example.com -paths: - /streamInfoList: - post: - summary: The set of information about the streams sent from the producer to the consumer - description: To send the streamInfoList from the producer to the consumer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-RequestType' - responses: - '201': - description: Success case ("201 Posted"). The streamInfoList is successfully posted. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - '202': - description: Partial success case ("202 Partially posted"). The representation of the posted resource on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoListPost-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - get: - summary: Read resources of stream information from the streaming consumer - description: 'With HTTP GET, resources of stream information are read. The resources to be read are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be returned.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '200': - description: 'Success case ("200 OK"). The resources identified in the request for retrieval are returned in the response message body. In case the fields query parameter is used, the selected resources are returned.' - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - '202': - description: Partial success case ("202 Partially retrieved"). The representation of the retrieved resources on stream information. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update resources of stream information to the streaming consumer - description: 'With HTTP PATCH, resources of stream information are to be updated. The resources to be updated are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be updated.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources selected by the query parameter are updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - '202': - description: Partial success case ("202 Partially updated"). The representation of the updated resources on stream information - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The information of streams to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resources of stream information are to be deleted. The resources to be deleted are identified with the path component (base resource) and the query component (streamIdList) of the URI. The fields query component allows to select the resource properties to be deleted.' - parameters: - - name: streamIdList - in: query - description: This parameter identifies the list of streamId to select from the collection resources identified with the path component of the URI. - required: true - schema: - type: array - items: - type: integer - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - '/streamInfoList/{streamId}': - get: - summary: Read resource of the stream information from the streaming consumer - description: 'With HTTP GET, resource of stream information is read. The resource to be read is identified with the path component the URI.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be retrieved. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '200': - description: Success case ("200 OK"). The resource identified in the request for retrieval is returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/listOfStreamInfoRetrieval-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - patch: - summary: Update the resource of stream information to the streaming consumer - description: 'With HTTP PATCH, resource of stream information is to be updated. The resource to be updated is identified by the path component of the URI. ' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be updated. - required: true - schema: - $ref: '#/components/schemas/uri-Type' - requestBody: - required: true - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoToUpdate-RequestType' - responses: - '200': - description: Success case ("200 OK"). The resources identified by the path of the URI is updated and returned in the response message body. - content: - application/json: - schema: - $ref: '#/components/schemas/streamInfoUpdate-ResponseType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - delete: - summary: The stream information to be deleted by the producer to the consumer - description: 'With HTTP DELETE, resource of stream information identified by the path component of the URI is to be deleted.' - parameters: - - name: streamId - in: path - description: Identifies the stream for which the information is to be deleted - required: true - schema: - $ref: '#/components/schemas/uri-Type' - responses: - '204': - description: Success case ("204 No Content"). The stream information resource has been deleted. The response message body is absent. - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' - /streamConnection: - get: - summary: The connection for streaming from the producer to the consumer - description: To establish the WebSocket connection between the producer and the consumer. The HTTP version of this operation shall not be earlier than HTTP/1.1 - parameters: - - in: header - name: Upgrade - required: true - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - - in: header - name: Connection - required: true - schema: - $ref: '#/components/schemas/Connection-HeaderType' - - in: header - name: Sec-WebSocket-Key - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Key-HeaderType' - - in: header - name: Sec-WebSocket-Version - required: true - schema: - $ref: '#/components/schemas/Sec-WebSocket-Version-HeaderType' - responses: - '101': - description: Success case ("101 Switching Protocols "). The connection has been successfully switched to WebSocket. The response message body is absent. - headers: - Upgrade: - schema: - $ref: '#/components/schemas/Upgrade-HeaderType' - Connection: - schema: - $ref: '#/components/schemas/Connection-HeaderType' - Sec-WebSocket-Accept-HeaderType: - schema: - $ref: '#/components/schemas/Sec-WebSocket-Accept-HeaderType' - default: - description: Error case. - content: - application/json: - schema: - $ref: '#/components/schemas/error-ResponseType' -components: - schemas: - uri-Type: - type: string - streamInfoIn-Type: - type: object - properties: - streamId: - type: integer - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - streamInfoOut-Type: - type: object - properties: - streamId: - $ref: '#/components/schemas/uri-Type' - iOCInstance: - $ref: '#/components/schemas/uri-Type' - measTypes: - type: array - items: - type: string - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - streamInfoListPost-RequestType: - type: object - properties: - streamInfoList: - type: array - items: - $ref: '#/components/schemas/streamInfoIn-Type' - streamInfoListPost-ResponseType: - type: object - properties: - streamInfoListPosted: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoRetrieval-ResponseType: - type: object - properties: - streamInfoOut: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoRetrieval-ResponseType: - type: object - properties: - listOfStreamInfoOut: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - streamInfoToUpdatePropertyType: - type: object - properties: - iOCInstance: - description: 'The updated measured object instance, empty value means no update.' - allOf: - - $ref: '#/components/schemas/uri-Type' - measTypes: - description: 'The updated list of measurement type, empty value means no update.' - type: array - items: - type: string - streamInfoToUpdate-RequestType: - type: object - properties: - streamInfoToUpdate: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - listOfStreamInfoToUpdate-RequestType: - type: object - properties: - listOfStreamInfoToUpdate: - type: array - items: - $ref: '#/components/schemas/streamInfoToUpdatePropertyType' - streamInfoUpdate-ResponseType: - type: object - properties: - streamInfoUpdated: - $ref: '#/components/schemas/streamInfoOut-Type' - listOfStreamInfoUpdate-ResponseType: - type: object - properties: - listOfStreamInfoUpdated: - type: array - items: - $ref: '#/components/schemas/streamInfoOut-Type' - Upgrade-HeaderType: - type: string - enum: - - websocket - Connection-HeaderType: - type: string - enum: - - Upgrade - Sec-WebSocket-Key-HeaderType: - type: string - Sec-WebSocket-Version-HeaderType: - type: string - Sec-WebSocket-Accept-HeaderType: - type: string diff --git a/OpenAPI/README.md b/OpenAPI/README.md index 9de0574637bc23f14368359c96aeddb1a91c2321..d1b602dc18bfbcf2ce6987b0f7339e34371d0671 100644 --- a/OpenAPI/README.md +++ b/OpenAPI/README.md @@ -8,58 +8,78 @@ The links below will open the Swagger Editor/UI and auto-load the OpenAPI YAML f ## Network Resource Models (NRM) * Generic NRM (TS 28.623) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/genericNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/genericNrm.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_GenericNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_GenericNrm.yaml)) * Common NRM definitions (TS 28.623) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/comDefs.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/comDefs.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28623_ComDefs.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28623_ComDefs.yaml)) * NR NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/nrNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/nrNrm.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_NrNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28541_NrNrm.yaml)) * 5GC NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/5gcNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/5gcNrm.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_5GcNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28541_5GcNrm.yaml)) * Slice NRM (TS 28.541) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/sliceNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/sliceNrm.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28541_SliceNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28541_SliceNrm.yaml)) * Communication Service Assurance NRM (TS 28.536) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/coslaNrm.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/coslaNrm.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28536_CoslaNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28536_CoslaNrm.yaml)) + +* Intent NRM (TS 28.312) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28312_IntentNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28312_IntentNrm.yaml)) + +* Edge NRM (TS 28.538) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28538_EdgeNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28538_EdgeNrm.yaml)) + +* MDA NRM (TS 28.104) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28104_MdaNrm.yaml)) + +* MDA Report NRM (TS 28.104) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28104_MdaReport.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28104_MdaReport.yaml)) + +* AI/ML NRM (TS 28.105) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28105_AiMlNrm.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28105_AiMlNrm.yaml)) ## Management Services (MnS) * Provisioning MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/provMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/provMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_ProvMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_ProvMnS.yaml)) * Fault Supervision MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/faultMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/faultMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FaultMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_FaultMnS.yaml)) * Performance Measurement Job Control MnS (28.550) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerMeasJobCtlMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml)) -* Performance Data File Reporting MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerDataFileReportMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerDataFileReportMnS.yaml)) +* File Data Reporting MnS MnS (TS 28.532) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_FileDataReportingMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_FileDataReportingMnS.yaml)) * Performance Threshold Monitoring MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/PerThresMonMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/PerThresMonMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_PerfMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_PerfMnS.yaml)) * Heartbeat Notifications(TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/heartbeatNtf.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/heartbeatNtf.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_HeartbeatNtf.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_HeartbeatNtf.yaml)) * Streaming Data Reporting MnS (TS 28.532) -([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/streamingDataMnS.yaml)) -([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/streamingDataMnS.yaml)) +([Editor](https://forge.3gpp.org/swagger/tools/loader.html?yaml=OpenAPI/TS28532_StreamingDataMnS.yaml)) +([UI](https://forge.3gpp.org/swagger/tools/loader.html?action=ui&yaml=OpenAPI/TS28532_StreamingDataMnS.yaml)) ## Tools diff --git a/OpenAPI/TS28104_MdaNrm.yaml b/OpenAPI/TS28104_MdaNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..b74804c5e46cb48357410b41d6c2c9612b4ecbae --- /dev/null +++ b/OpenAPI/TS28104_MdaNrm.yaml @@ -0,0 +1,216 @@ +openapi: 3.0.1 +info: + title: MDA NRM + version: 17.0.0 + description: >- + OAS 3.0.1 specification of the MDA NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.104; MDA + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.104/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + MDATypes: + type: array + items: + type: string + + MDAOutputs: + type: array + items: + $ref: '#/components/schemas/MDAOutputPerMDAType' + + MDAOutputPerMDAType: + type: object + properties: + mDAType: + type: string + mDAOutputIEFilters: + type: array + items: + $ref: '#/components/schemas/MDAOutputIEFilter' + + MDAOutputIEFilter: + type: object + properties: + mDAOutputIEName: + type: string + filterValue: + type: string + threshold: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ThresholdInfo' + analyticsPeriod: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + timeOut: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + + ReportingMethod: + type: string + enum: + - FILE + - STREAMING + - NOTIFICATION + + ReportingTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + + AnalyticsScope: + oneOf: + - type: object + properties: + managedEntitiesScope: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + - type: object + properties: + areaScope: + $ref: '#/components/schemas/GeoAreaList' + + GeoAreaList: + type: array + items: + $ref: '#/components/schemas/GeoArea' + + GeoArea: + type: object + properties: + coordinates: + type: array + items: + $ref: '#/components/schemas/Coordinate' + altitude: + type: number + format: float + + Coordinate: + type: object + properties: + latitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Latitude' + longitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Longitude' + + +#-------- Definition of abstract IOCs -------------------------------------------- + + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + MDAFunction: + $ref: '#/components/schemas/MDAFunction-Multiple' + MDAReport: + $ref: '#/components/schemas/MDAReport-Multiple' + + + ManagedElement-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + MDAFunction: + $ref: '#/components/schemas/MDAFunction-Multiple' + + MDAFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + supportedMDACapabilities: + $ref: '#/components/schemas/MDATypes' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + MDARequest: + $ref: '#/components/schemas/MDARequest-Multiple' + + MDARequest-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + requestedMDAOutputs: + $ref: '#/components/schemas/MDAOutputs' + reportingMethod: + $ref: '#/components/schemas/ReportingMethod' + reportingTarget: + $ref: '#/components/schemas/ReportingTarget' + analyticsScope: + $ref: '#/components/schemas/AnalyticsScope' + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + + MDAReport-Single: + $ref: 'TS28104_MdaReport.yaml#/components/schemas/MDAReport' + + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + MDAFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/MDAFunction-Single' + MDARequest-Multiple: + type: array + items: + $ref: '#/components/schemas/MDARequest-Single' + + MDAReport-Multiple: + type: array + items: + $ref: '#/components/schemas/MDAReport-Single' + +#-------- Definitions in TS 28.104 for TS 28.532 --------------------------------- + + resources-mdaNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + + - $ref: '#/components/schemas/MDAFunction-Single' + - $ref: '#/components/schemas/MDARequest-Single' + - $ref: '#/components/schemas/MDAReport-Single' diff --git a/OpenAPI/TS28104_MdaReport.yaml b/OpenAPI/TS28104_MdaReport.yaml new file mode 100644 index 0000000000000000000000000000000000000000..3f8dcf23709d25f1601bf93a9c3335d48d8ebf04 --- /dev/null +++ b/OpenAPI/TS28104_MdaReport.yaml @@ -0,0 +1,66 @@ +openapi: 3.0.1 +info: + title: MDA Report + version: 17.0.0 + description: >- + OAS 3.0.1 specification of the MDA Report + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.104; MDA Report + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.104/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + MDAOutputs: + type: object + properties: + mDAType: + type: string + mdaOutputList: + type: array + items: + $ref: '#/components/schemas/MDAOutputEntry' + mDARequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + MDAOutputEntry: + type: object + properties: + mDAOutputIEName: + type: string + mdaOutputIEValue: {} + analyticsWindow: + $ref: '#/components/schemas/TimeWindow' + confidenceDegree: + type: number + format: float + + + TimeWindow: + type: object + properties: + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + + +#-------- Definition of MDA Report -------------------------------------------- + + MDAReport: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + mDAReportID: + type: string + mDAOutputs: + $ref: '#/components/schemas/MDAOutputs' diff --git a/OpenAPI/TS28105_AiMlNrm.yaml b/OpenAPI/TS28105_AiMlNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..a4afbb61980a9559233a8694183f95ddd92ff75f --- /dev/null +++ b/OpenAPI/TS28105_AiMlNrm.yaml @@ -0,0 +1,276 @@ +openapi: 3.0.1 +info: + title: AI/ML NRM + version: 17.0.0 + description: >- + OAS 3.0.1 specification of the AI/ML NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.105; AI/ML Management + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.105/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + AIMLEntityList: + type: array + items: + $ref: '#/components/schemas/AIMLEntity' + + AIMLEntity: + type: object + properties: + aIMLEntityId: + type: string + inferenceType: + type: string + aIMLEntityVersion: + type: string + expectedRunTimeContext: + type: string + trainingContext: + type: string + runTimeContext: + type: string + + RequestStatus: + type: string + enum: + - NOT_STARTED + - TRAINING_IN_PROGRESS + - SUSPENDED + - FINISHED + - CANCELLED + + PerformanceRequirements: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + + ModelPerformance: + type: object + properties: + inferenceOutputName: + type: string + performanceMetric: + type: string + performanceScore: + type: number + format: float + decisionConfidenceScore: + type: number + format: float + + TrainingProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type defined in “genericNrm.yaml” with specialisations for usage in the "AIMLTrainingProcess". + type: object + properties: + aIMLTrainingProcessId: + type: string + status: + type: string + enum: + - RUNNING + - CANCELLING + - CANCELLED + - SUSPENDED + - FINSHED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + enum: + - COLLECTING_DATA + - PREPARING_TRAINING_DATA + - TRAINING + resultStateInfo: + type: string + +#-------- Definition of abstract IOCs -------------------------------------------- + + + +#-------- Definition of concrete IOCs -------------------------------------------- + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + AIMLTrainingFunction: + $ref: '#/components/schemas/AIMLTrainingFunction-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AIMLTrainingFunction: + $ref: '#/components/schemas/AIMLTrainingFunction-Multiple' + + AIMLTrainingFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + aIMLEntityList: + $ref: '#/components/schemas/AIMLEntityList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + AIMLTrainingRequest: + $ref: '#/components/schemas/AIMLTrainingRequest-Multiple' + AIMLTrainingProcess: + $ref: '#/components/schemas/AIMLTrainingProcess-Multiple' + AIMLTrainingReport: + $ref: '#/components/schemas/AIMLTrainingReport-Multiple' + + AIMLTrainingRequest-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + aIMLEntityId: + type: string + candidateTraingDataSource: + type: array + items: + type: string + traingDataQualityScore: + type: number + format: float + trainingRequestSource: + type: string + requestStatus: + $ref: '#/components/schemas/RequestStatus' + expectedRuntimeContext: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + performanceRequirements: + $ref: '#/components/schemas/PerformanceRequirements' + cancelRequest: + type: boolean + suspendRequest: + type: boolean + + AIMLTrainingProcess-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + aIMLTrainingProcessId: + type: string + priority: + type: integer + terminationConditions: + type: string + progressStatus: + $ref: '#/components/schemas/TrainingProcessMonitor' + cancelProcess: + type: boolean + suspendProcess: + type: boolean + trainingRequestRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + trainingReportRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + + AIMLTrainingReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + aIMLEntityId: + type: string + areConsumerTrainingDataUsed: + type: boolean + usedConsumerTrainingData: + type: array + items: + type: string + confidenceIndication: + type: integer + modelPerformanceTraining: + type: array + items: + $ref: '#/components/schemas/ModelPerformance' + areNewTrainingDataUsed: + type: boolean + + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + AIMLTrainingFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLTrainingFunction-Single' + AIMLTrainingRequest-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLTrainingRequest-Single' + AIMLTrainingProcess-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLTrainingProcess-Single' + AIMLTrainingReport-Multiple: + type: array + items: + $ref: '#/components/schemas/AIMLTrainingReport-Single' + + +#-------- Definitions in TS 28.104 for TS 28.532 --------------------------------- + + resources-AiMlNrm: + oneOf: + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + + - $ref: '#/components/schemas/AIMLTrainingFunction-Single' + - $ref: '#/components/schemas/AIMLTrainingRequest-Single' + - $ref: '#/components/schemas/AIMLTrainingProcess-Single' + - $ref: '#/components/schemas/AIMLTrainingReport-Single' diff --git a/OpenAPI/TS28312_IntentNrm.yaml b/OpenAPI/TS28312_IntentNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..54a5bc02897db7b099b1c00c21218af54a66fe62 --- /dev/null +++ b/OpenAPI/TS28312_IntentNrm.yaml @@ -0,0 +1,645 @@ +openapi: 3.0.1 +info: + title: Intent NRM + version: 17.0.0 + description: >- + OAS 3.0.1 definition of the Intent NRM + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.312; Intent driven management services for mobile networks + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.312/ +paths: {} +components: + schemas: + + Intent-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + userLabel: + type: string + intentExpectations: + type: array + items: + $ref: "#/components/schemas/IntentExpectation" + intentContexts: + type: array + items: + $ref: "#/components/schemas/IntentContext" + intentFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + IntentExpectation: + type: object + properties: + expectationId: + type: string + expectationVerb: + $ref: "#/components/schemas/ExpectationVerb" + expectationObjects: + type: array + items: + $ref: "#/components/schemas/ExpectationObject" + expectationTargets: + type: array + items: + $ref: "#/components/schemas/ExpectationTarget" + expectationContexts: + type: array + items: + $ref: "#/components/schemas/ExpectationContext" + expectationfulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + ExpectationObject: + type: object + properties: + objectType: + type: string + enum: + - RAN_SubNetwrok #value for Radio Network Expectation--# + - Service_Support #value for Service Support Expectation--# + - TBD #-This will be added based on defined scenario specfic intent expectation-# + objectInstance: + $ref: "TS28623_ComDefs.yaml#/components/schemas/Dn" + objectContexts: + type: array + items: + $ref: "#/components/schemas/ObjectContext" + + ExpectationTarget: + oneOf: + #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # + - $ref: "#/components/schemas/WeakRSRPRatioTarget" + - $ref: "#/components/schemas/LowSINRRatioTarget" + - $ref: "#/components/schemas/AveULRANUEThptTarget" + - $ref: "#/components/schemas/AveDLRANUEThptTarget" + - $ref: "#/components/schemas/LowULRANUEThptRatioTarget" + - $ref: "#/components/schemas/LowDLRANUEThptRatioTarget" + #--ExpectationTargets defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)- # + #--ExpectationTargets defind for Service Support Expectation (ObjectType is ServiceSupport)- # + - $ref: "#/components/schemas/DLThptPerUETarget" + - $ref: "#/components/schemas/ULThptPerUETarget" + - $ref: "#/components/schemas/DLLatencyTarget" + - $ref: "#/components/schemas/ULLatencyTarget" + - $ref: "#/components/schemas/MaxNumberofUEsTarget" + - $ref: "#/components/schemas/ActivityFactorTarget" + - $ref: "#/components/schemas/UESpeedTarget" + #--ExpectationTargets defind for Service Support Expectation (ObjectType is ServiceSupport)- # + #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# + #--ExpectationTargets defind for other Scenario specific Expectation-----TBD---------------# + + + ObjectContext: + oneOf: + #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)-------# + - $ref: "#/components/schemas/CoverageAreaPolygonContext" + - $ref: "#/components/schemas/CoverageTACContext" + - $ref: "#/components/schemas/PLMNContext" + - $ref: "#/components/schemas/NRFqBandContext" + - $ref: "#/components/schemas/RATContext" + #--ObjectContext defind for Radio Network Expectation (ObjectType is RAN_SubNetwork)-------# + #--ObjectContext defind for Service Support Expectation (ObjectType is ServiceSupport)-------# + - $ref: "#/components/schemas/EdgeIdenfiticationIdContext" + - $ref: "#/components/schemas/EdgeIdenfiticationLocContext" + - $ref: "#/components/schemas/CoverageAreaTAContext" + #--ObjectContext defind for Service Support Expectation (ObjectType is ServiceSupport)-------# + + #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# + #--ObjectContext defind for other Scenario specific Expectation -----------TBD------------# + + + ExpectationContext: + oneOf: + #--ExpectationContext defind for Service Support Expectation (ObjectType is Service_Support)- # + - $ref: "#/components/schemas/ServiceStartTimeContext" + - $ref: "#/components/schemas/ServiceEndTimeContext" + - $ref: "#/components/schemas/UEMobilityLevelContext" + - $ref: "#/components/schemas/ResourceSharingLevelContext" + #--ExpectationContext defind for Service Support Expectation (ObjectType is Service_Support)- # + + IntentContext: + type: object + properties: + contextAttribute: + type: string + contextCondition: + $ref: "#/components/schemas/Condition" + contextValueRange: + type: array + items: + type: number + Condition: + type: string + enum: + - Is_equal_to + - Is_less_than + - Is_greater_than + - Is_within_the_range + + FulfilStatus: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + NotFulfilledState: + type: string + enum: + - ACKNOWLEDGED + - COMPLIANT + - DEGRADED + - SUSPENDED + - TERMINATED + - FULFILMENTFAILED + + FulfilmentInfo: + type: object + properties: + fulfilStatus: + $ref: "#/components/schemas/FulfilStatus" + notFullfilledState: + description: -> + An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo + $ref: "#/components/schemas/NotFulfilledState" + notFulfilledReasons: + description: -> + An attribute which is used when FulfilmentInfo is implemented for IntentFulfilmentInfo + type: string + + ExpectationVerb: + type: string + enum: + - DELIVER + - ENSURE + + #-------Definition of the concrete ExpectationTarget dataType----------# + WeakRSRPRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - WeakRSRPRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/WeakRSRPContext" + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + WeakRSRPContext: + type: object + properties: + contextAttribute: + type: string + enum: + - WeakRSRPThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + + LowSINRRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowSINRRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowSINRContext" + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + LowSINRContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowSINRThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: integer + + AveULRANUEThptTarget: + type: object + properties: + targetName: + type: string + enum: + - AveULRANUEThpt + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + type: integer + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + AveDLRANUEThptTarget: + type: object + properties: + targetName: + type: string + enum: + - AveDLRANUEThpt + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + type: integer + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + LowULRANUEThptRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowULRANUEThptRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowULRANUEThptContext" + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + LowULRANUEThptContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowULRANUEThptThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + + LowDLRANUEThptRatioTarget: + type: object + properties: + targetName: + type: string + enum: + - LowDLRANUEThptRatio + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + minimum: 0 + maximum: 100 + targetContexts: + $ref: "#/components/schemas/LowDLRANUEThptContext" + targetFulfilmentInfo: + $ref: "#/components/schemas/FulfilmentInfo" + + LowDLRANUEThptContext: + type: object + properties: + contextAttribute: + type: string + enum: + - LowDLRANUEThptThreshold + contextCondition: + type: string + enum: + - Is_less_than + contextValueRange: + type: number + DLThptPerUETarget: + type: object + properties: + targetName: + type: string + enum: + - DlThptPerUE + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + $ref: "TS28541_SliceNrm.yaml#/components/schemas/XLThpt" + ULThptPerUETarget: + type: object + properties: + targetName: + type: string + enum: + - UlThptPerUE + targetCondition: + type: string + enum: + - Is_greater_than + targetValueRange: + $ref: "TS28541_SliceNrm.yaml#/components/schemas/XLThpt" + DLLatencyTarget: + type: object + properties: + targetName: + type: string + enum: + - DlLatency + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + ULLatencyTarget: + type: object + properties: + targetName: + type: string + enum: + - UlLatency + targetCondition: + type: string + enum: + - Is_less_than + targetValueRange: + type: integer + MaxNumberofUEsTarget: + type: object + properties: + targetAttribute: + type: string + enum: + - maxNumberofUEs + targetCondition: + type: string + enum: + - Is_less _than + targetValueRange: + type: integer + ActivityFactorTarget: + type: object + properties: + targetAttribute: + type: string + enum: + - activityFactor + targetCondition: + type: string + enum: + - Is_equal _than + targetValueRange: + type: integer + UESpeedTarget: + type: object + properties: + targetAttribute: + type: string + enum: + - uESpeed + targetCondition: + type: string + enum: + - Is_less _than + targetValueRange: + type: integer + + #-------Definition of the concrete ExpectationTarget dataType----------# + + #-------Definition of the concrete ObjectTarget dataType----------------# + CoverageAreaPolygonContext: + type: object + properties: + contextAttribute: + type: string + enum: + - CoverageAreaPolygon + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "#/components/schemas/CoverageArea" + CoverageArea: + type: string + CoverageTACContext: + type: object + properties: + contextAttribute: + type: string + enum: + - CoverageAreaTac + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "TS28541_NrNrm.yaml#/components/schemas/NrTac" + + PLMNContext: + type: object + properties: + contextAttribute: + type: string + enum: + - PLMN + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "TS28541_NrNrm.yaml#/components/schemas/PlmnId" + + NRFqBandContext: + type: object + properties: + contextAttribute: + type: string + enum: + - NRFqBand + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + type: string + + RATContext: + type: object + properties: + contextAttribute: + type: string + enum: + - RAT + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + type: string + enum: + - UTRAN + - EUTRAN + - NR + EdgeIdenfiticationIdContext: + type: object + properties: + contextAttribute: + type: string + enum: + - edgeIdentificationId + contextCondition: + type: string + enum: + - Is_equal_than + contextValueRange: + type: array + items: + type: string + EdgeIdenfiticationLocContext: + type: object + properties: + contextAttribute: + type: string + enum: + - edgeIdentificationTarget + contextCondition: + type: string + enum: + - Is_equal_than + contextValueRange: + type: array + items: + type: string + CoverageAreaTAContext: + type: object + properties: + contextAttribute: + type: string + enum: + - coverageAreaTA + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "#/components/schemas/CoverageAreaTAList" + CoverageAreaTAList: + type: integer + + #-------Definition of the concrete ObjectTarget dataType----------------# + #-------Definition of the concrete ExpectionContext dataType----------------# + ServiceStartTimeContext: + type: object + properties: + contextAttribute: + type: string + enum: + - ServiceStartTime + contextCondition: + type: string + enum: + - Is_equal_than + contextValueRange: + type: string + ServiceEndTimeContext: + type: object + properties: + contextAttribute: + type: string + enum: + - ServiceEndTime + contextCondition: + type: string + enum: + - Is_equal_than + contextValueRange: + type: string + UEMobilityLevelContext: + type: object + properties: + contextAttribute: + type: string + enum: + - UEMobilityLevel + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "TS28541_SliceNrm.yaml#/components/schemas/MobilityLevel" + ResourceSharingLevelContext: + type: object + properties: + contextAttribute: + type: string + enum: + - ResourceSharingLevel + contextCondition: + type: string + enum: + - Is_within_the_range + contextValueRange: + type: array + items: + $ref: "TS28541_SliceNrm.yaml#/components/schemas/SharingLevel" + #-------Definition of the concrete ExpectionContext dataType----------------# + + + #------Definition of JSON arrays for name-contained IOCs ---------------# + + Intent-Multiple: + type: array + items: + $ref: '#/components/schemas/Intent-Single' + #------Definition of JSON arrays for name-contained IOCs ---------------# + + #----- Definitions in TS 28.312 for TS 28.532 --------------------------# + resources-intentNrm: + oneOf: + - $ref: '#/components/schemas/Intent-Single' + #----- Definitions in TS 28.312 for TS 28.532 --------------------------# diff --git a/OpenAPI/faultMnS.yaml b/OpenAPI/TS28532_FaultMnS.yaml old mode 100644 new mode 100755 similarity index 82% rename from OpenAPI/faultMnS.yaml rename to OpenAPI/TS28532_FaultMnS.yaml index 499123b903bd593face53928a3eb61b2f431afd4..ff66bf0043095d1d57465068342558bba5b52b88 --- a/OpenAPI/faultMnS.yaml +++ b/OpenAPI/TS28532_FaultMnS.yaml @@ -1,22 +1,22 @@ openapi: 3.0.1 info: title: Fault Supervision MnS - version: 16.4.0 + version: 17.1.0 description: >- OAS 3.0.1 definition of the Fault Supervision MnS - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services + description: 3GPP TS 28.532; Generic management services url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ servers: - - url: '{MnSRoot}/FaultSupervisionMnS/{version}' + - url: '{MnSRoot}/FaultSupervisionMnS/{MnSversion}' variables: MnSRoot: description: See subclause 4.4.3 of TS 32.158 default: http://example.com/3GPPManagement - version: - description: Versi on number of the OpenAPI definition + MnSversion: + description: Version number of the OpenAPI definition default: XXX paths: /alarms: @@ -35,12 +35,12 @@ paths: in: query required: false schema: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' - name: filter in: query required: false schema: - $ref: '#/components/schemas/Filter' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' responses: '200': description: >- @@ -57,7 +57,7 @@ paths: - type: object properties: lastNotificationHeader: - $ref: '#/components/schemas/NotificationHeader' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - $ref: '#/components/schemas/AlarmRecord' - type: object properties: @@ -68,7 +68,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' patch: summary: 'Clear, acknowledge or unacknowledge multiple alarms' description: >- @@ -130,7 +130,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' /alarms/{alarmId}: patch: summary: 'Clear, acknowledge or unacknowledge a single alarm' @@ -163,7 +163,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' /alarms/{alarmId}/comments: post: summary: Add a comment to a single alarm @@ -203,7 +203,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' /subscriptions: post: @@ -238,7 +238,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' callbacks: notifyNewAlarm: '{request.body#/consumerReference}': @@ -262,7 +262,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyClearedAlarm: '{request.body#/consumerReference}': post: @@ -283,7 +283,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyChangedAlarm: '{request.body#/consumerReference}': post: @@ -304,7 +304,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyChangedAlarmGeneral: '{request.body#/consumerReference}': post: @@ -327,7 +327,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyCorrelatedNotificationChanged: '{request.body#/consumerReference}': post: @@ -348,7 +348,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyAckStateChanged: '{request.body#/consumerReference}': post: @@ -369,7 +369,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyComments: '{request.body#/consumerReference}': post: @@ -390,7 +390,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyPotentialFaultyAlarmList: '{request.body#/consumerReference}': post: @@ -411,7 +411,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyAlarmListRebuilt: '{request.body#/consumerReference}': post: @@ -432,7 +432,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' /subscriptions/{subscriptionId}: delete: summary: Delete a subscription @@ -458,91 +458,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/ErrorResponse' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' components: schemas: - - #---- Definitions to be moved to comDefs.yaml --------------------------------------# - - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - - Dn: - type: string - Uri: - type: string - - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - - Filter: - type: string - SystemDN: - type: string - - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notification types - type: object - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: '#/components/schemas/AlarmNotificationTypes' - #- $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - - ErrorResponse: - description: >- - Default schema for the response message body in case the request is not - successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - - #---- End of definitions to be moved to comDefs.yaml -------------------------------# #---- Definition of AlarmRecord ----------------------------------------------------# @@ -608,46 +527,47 @@ components: high: oneOf: - type: integer - - $ref: '#/components/schemas/Float' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' low: - $ref: '#/components/schemas/Float' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' ThresholdLevelInd: - type: object - required: - - up - properties: - up: - $ref: '#/components/schemas/ThresholdHysteresis' - low: - $ref: '#/components/schemas/ThresholdHysteresis' + oneOf: + - type: object + properties: + up: + $ref: '#/components/schemas/ThresholdHysteresis' + - type: object + properties: + down: + $ref: '#/components/schemas/ThresholdHysteresis' ThresholdInfo: type: object - required: - - observedMeasurement - - observedValue properties: observedMeasurement: type: string observedValue: oneOf: - type: integer - - $ref: '#/components/schemas/Float' - thresholdLevelInd: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + thresholdLevel: $ref: '#/components/schemas/ThresholdLevelInd' armTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + required: + - observedMeasurement + - observedValue CorrelatedNotification: type: object - required: - - source - - notificationId properties: sourceObjectInstance: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' notificationIds: type: array items: - $ref: '#/components/schemas/NotificationId' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + required: + - sourceObjectInstance + - notificationIds CorrelatedNotifications: type: array items: @@ -667,15 +587,15 @@ components: # alarmId: # $ref: '#/components/schemas/AlarmId' objectInstance: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' notificationId: - $ref: '#/components/schemas/NotificationId' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' alarmRaisedTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' alarmChangedTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' alarmClearedTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' alarmType: $ref: '#/components/schemas/AlarmType' probableCause: @@ -687,7 +607,7 @@ components: backedUpStatus: type: boolean backUpObject: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' trendIndication: $ref: '#/components/schemas/TrendIndication' thresholdinfo: @@ -695,21 +615,21 @@ components: correlatedNotifications: $ref: '#/components/schemas/CorrelatedNotifications' stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' proposedRepairActions: type: string additionalText: type: string additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' rootCauseIndicator: type: boolean ackTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' ackUserId: type: string ackSystemId: @@ -740,7 +660,7 @@ components: - notifyCorrelatedNotificationChanged - notifyComments - notifyClearedAlarm - - notifyAlarmListRebuiltAlarm + - notifyAlarmListRebuilt - notifyPotentialFaultyAlarmList AlarmListAlignmentRequirement: type: string @@ -750,7 +670,7 @@ components: NotifyNewAlarm: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -771,7 +691,7 @@ components: backedUpStatus: type: boolean backUpObject: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' trendIndication: $ref: '#/components/schemas/TrendIndication' thresholdInfo: @@ -779,20 +699,20 @@ components: correlatedNotifications: $ref: '#/components/schemas/CorrelatedNotifications' stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' proposedRepairActions: type: string additionalText: type: string additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' rootCauseIndicator: type: boolean NotifyNewSecAlarm: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -816,7 +736,7 @@ components: additionalText: type: string additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' rootCauseIndicator: type: boolean serviceUser: @@ -827,7 +747,7 @@ components: type: string NotifyClearedAlarm: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -851,7 +771,7 @@ components: type: string NotifyChangedAlarm: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -869,14 +789,11 @@ components: $ref: '#/components/schemas/PerceivedSeverity' NotifyChangedAlarmGeneral: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId - alarmType - - probableCause - - perceivedSeverity - - changedAlarmAttributes properties: alarmId: $ref: '#/components/schemas/AlarmId' @@ -893,38 +810,35 @@ components: backedUpStatus: type: boolean backUpObject: - $ref: '#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' trendIndication: $ref: '#/components/schemas/TrendIndication' thresholdInfo: $ref: '#/components/schemas/ThresholdInfo' stateChangeDefinition: - $ref: '#/components/schemas/AttributeValueChangeSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' monitoredAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' proposedRepairActions: type: string additionalText: type: string additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' rootCauseIndicator: type: boolean changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' NotifyChangedSecAlarmGeneral: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId - alarmType - - probableCause - - perceivedSeverity - serviceUser - serviceProvider - securityAlarmDetector - - changedAlarmAttributes properties: alarmId: $ref: '#/components/schemas/AlarmId' @@ -939,7 +853,7 @@ components: additionalText: type: string additionalInformation: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' rootCauseIndicator: type: boolean serviceUser: @@ -949,10 +863,10 @@ components: securityAlarmDetector: type: string changedAlarmAttributes: - $ref: '#/components/schemas/AttributeNameValuePairSet' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' NotifyCorrelatedNotificationChanged: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -966,7 +880,7 @@ components: type: boolean NotifyAckStateChanged: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -992,7 +906,7 @@ components: type: string NotifyComments: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - alarmId @@ -1013,7 +927,7 @@ components: $ref: '#/components/schemas/Comments' NotifyPotentialFaultyAlarmList: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - reason @@ -1022,7 +936,7 @@ components: type: string NotifyAlarmListRebuilt: allOf: - - $ref: '#/components/schemas/NotificationHeader' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object required: - reason @@ -1119,7 +1033,7 @@ components: type: object properties: commentTime: - $ref: '#/components/schemas/DateTime' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' commentUserId: type: string commentSystemId: @@ -1137,8 +1051,8 @@ components: type: object properties: consumerReference: - $ref: '#/components/schemas/Uri' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' timeTick: - $ref: '#/components/schemas/Long' + type: integer filter: - $ref: '#/components/schemas/Filter' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' diff --git a/OpenAPI/TS28532_FileDataReportingMnS.yaml b/OpenAPI/TS28532_FileDataReportingMnS.yaml new file mode 100644 index 0000000000000000000000000000000000000000..7bf7ba0c8fc6c63fca864e8068ab201ccb8ef8e2 --- /dev/null +++ b/OpenAPI/TS28532_FileDataReportingMnS.yaml @@ -0,0 +1,229 @@ +openapi: 3.0.1 +info: + title: File Data Reporting MnS + version: 17.1.0 + description: >- + OAS 3.0.1 definition of the File Data Reporting MnS + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{MnSRoot}/fileDataReportingMnS/{MnSVersion}' + variables: + MnSRoot: + description: See clause 4.4.3 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX +paths: + /files: + get: + summary: Read information about available files + description: >- + Information about available files is read with HTTP GET. The files for + which information shall be returned are identified with the path + component (base resource) and the query component (fileDataType, beginTime, + endTime) of the URI. + parameters: + - name: fileDataType + in: query + description: >- + This parameter selects files based on the file data type. + required: true + schema: + $ref: '#/components/schemas/FileDataType' + - name: beginTime + in: query + description: >- + This parameter selects files based on the earliest time they + became available + required: false + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + - name: endTime + in: query + description: >- + This parameter selects files based on the latest time they + became available + required: false + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + responses: + '200': + description: >- + 'Success case ("200 OK"). + The resources identified in the request for retrieval are returned + in the response message body.' + content: + application/json: + schema: + type: array + items: + $ref: '#/components/schemas/FileInfo' + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + /subscriptions: + post: + summary: Create a subscription + description: >- + To create a subscription the representation of the subscription is + POSTed on the /subscriptions collection resource. + requestBody: + required: true + content: + application/json: + schema: + $ref: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription' + responses: + '201': + description: >- + Success case ("201 Created"). + The representation of the newly created subscription resource shall + be returned. + content: + application/json: + schema: + $ref: 'TS28532_FaultMnS.yaml#/components/schemas/Subscription' + headers: + Location: + description: URI of the newly created subscription resource + required: true + schema: + type: string + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + callbacks: + notifyFileReady: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyFileReady' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyFilePreparationError: + '{request.body#/consumerReference}': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyFilePreparationError' + responses: + '204': + description: >- + Success case ("204 No Content"). + The notification is successfully delivered. The response message + body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + /subscriptions/{subscriptionId}: + delete: + summary: Delete a subscription + description: >- + The subscription is deleted by deleting the corresponding subscription + resource. The resource to be deleted is identified with the path + component of the URI. + parameters: + - name: subscriptionId + in: path + description: Identifies the subscription to be deleted. + required: true + schema: + type: string + responses: + '204': + description: >- + Success case ("204 No Content"). + The subscription resource has been deleted. The response message body + is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' +components: + schemas: + FileDataType: + type: string + enum: + - Performance + - Trace + - Anatytics + - Proprietary + FileNotificationTypes: + type: string + enum: + - notifyFileReady + - notifyFilePreparationError + FileInfo: + type: object + properties: + fileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + fileSize: + type: integer + fileReadyTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileExpirationTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileCompression: + type: string + fileFormat: + type: string + fileDataType: + $ref: '#/components/schemas/FileDataType' + NotifyFileReady: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + fileInfoList: + type: array + items: + $ref: '#/components/schemas/FileInfo' + additionalText: + type: string + NotifyFilePreparationError: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + fileInfoList: + type: array + items: + $ref: '#/components/schemas/FileInfo' + reason: + type: string + additionalText: + type: string diff --git a/OpenAPI/heartbeatNtf.yaml b/OpenAPI/TS28532_HeartbeatNtf.yaml old mode 100644 new mode 100755 similarity index 52% rename from OpenAPI/heartbeatNtf.yaml rename to OpenAPI/TS28532_HeartbeatNtf.yaml index afde5066ddfea6ce040ebee2c28d490e53c6247a..4fb1f6d29f4edc6988b2485fc04895dfeebcd6bd --- a/OpenAPI/heartbeatNtf.yaml +++ b/OpenAPI/TS28532_HeartbeatNtf.yaml @@ -1,23 +1,25 @@ openapi: 3.0.1 info: title: Heartbeat notification - version: 16.3.0 + version: 17.1.0 description: >- - OAS 3.0.1 specification of the heartbeat notification + OAS 3.0.1 definition of the heartbeat notification © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.532 V16.3.0; Heartbeat notification + description: 3GPP TS 28.532; Generic management services url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.6532/ paths: {} components: schemas: - hearbeatNtfPeriod-Type: - type: integer - notifyHeartbeat-NotifType: + HeartbeatNotificationTypes: + type: string + enum: + - notifyHeartbeat + NotifyHeartbeat: allOf: - - $ref: 'provMnS.yaml#/components/schemas/header-Type' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object properties: heartbeatNtfPeriod: - $ref: '#/components/schemas/hearbeatNtfPeriod-Type' + type: integer diff --git a/OpenAPI/TS28532_PerfMnS.yaml b/OpenAPI/TS28532_PerfMnS.yaml new file mode 100644 index 0000000000000000000000000000000000000000..d75bcdc22ecd2ea00b1f39f3995e05af6a17c316 --- /dev/null +++ b/OpenAPI/TS28532_PerfMnS.yaml @@ -0,0 +1,76 @@ +openapi: 3.0.1 +info: + title: TS 28.532 Performance Threshold Monitoring MnS + version: 17.1.0 + description: >- + OAS 3.0.1 definition of the Performance Threshold Monitoring MnS + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.532; Generic management services + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ +servers: + - url: '{root}' + variables: + root: + description: >- + The open API server of the performance threshold monitoring service is + located in the consumer side, see monitoringNotifTarget attribute of + the IOC ThresholdMonitor defined in 3GPP TS 28.622 [11]. + default: http://example.com/3GPPManagement +paths: + /notificationSink: + post: + summary: Send notifications about performance threshold crossing + description: To send a notifyThresholdCrossing notification + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/NotifyThresholdCrossing' + responses: + '204': + description: >- + Success case ("204 No Content"). The notification is successfully + delivered. The response message body is absent. + default: + description: Error case. + content: + application/json: + schema: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' +components: + schemas: + PerfNotificationTypes: + type: string + enum: + - notifyThresholdCrossing + PerfMetricValue: + oneOf: + - type: integer + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + PerfMetricDirection: + type: string + enum: + - UP + - DOWN + NotifyThresholdCrossing: + allOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' + - type: object + properties: + observedPerfMetricName: + type: string + observedPerfMetricValue: + $ref: '#/components/schemas/PerfMetricValue' + observedPerfMetricDirection: + $ref: '#/components/schemas/PerfMetricDirection' + thresholdValue: + $ref: '#/components/schemas/PerfMetricValue' + hysteresis: + $ref: '#/components/schemas/PerfMetricValue' + monitorGranularityPeriod: + type: integer + additionalText: + type: string diff --git a/OpenAPI/provMnS.yaml b/OpenAPI/TS28532_ProvMnS.yaml old mode 100644 new mode 100755 similarity index 63% rename from OpenAPI/provMnS.yaml rename to OpenAPI/TS28532_ProvMnS.yaml index b2f84a4d2a55e09c0eff04207d290384fb9f59ed..fbe3805380da9e9edab64088d822f2ef87b1d197 --- a/OpenAPI/provMnS.yaml +++ b/OpenAPI/TS28532_ProvMnS.yaml @@ -1,25 +1,25 @@ openapi: 3.0.1 info: title: Provisioning MnS - version: 16.4.0 + version: 17.1.0 description: >- OAS 3.0.1 definition of the Provisioning MnS © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.532 V16.4.0; Generic management services + description: 3GPP TS 28.532; Generic management services url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.532/ servers: - - url: 'http://{URI-DN-prefix}/{root}/ProvMnS/v1640/{LDN-first-part}' + - url: '{MnSRoot}/ProvMnS/{MnSVersion}/{URI-LDN-first-part}' variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX + URI-LDN-first-part: + description: See clause 4.4.2 of TS 32.158 default: '' paths: '/{className}={id}': @@ -28,12 +28,12 @@ paths: in: path required: true schema: - $ref: '#/components/schemas/className-PathType' + type: string - name: id in: path required: true schema: - $ref: '#/components/schemas/id-PathType' + type: string put: summary: Replaces a complete single resource or creates it if it does not exist description: >- @@ -44,7 +44,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourcePut-RequestType' + $ref: '#/components/schemas/Resource' responses: '200': description: >- @@ -60,7 +60,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' + $ref: '#/components/schemas/Resource' '201': description: >- Success case ("201 Created"). @@ -70,7 +70,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceCreation-ResponseType' + $ref: '#/components/schemas/Resource' '204': description: >- Success case ("204 No Content"). @@ -82,7 +82,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' callbacks: notifyMOICreation: '{request.body#/notificationRecipientAddress}': @@ -92,7 +92,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/notifyMOICreation-NotifType' + $ref: '#/components/schemas/NotifyMoiCreation' responses: '204': description: >- @@ -104,7 +104,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyMOIDeletion: '{request.body#/notificationRecipientAddress}': post: @@ -113,7 +113,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/notifyMOIDeletion-NotifType' + $ref: '#/components/schemas/NotifyMoiDeletion' responses: '204': description: >- @@ -125,8 +125,8 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' - notifyMOIAttributeValueChange: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' + notifyMOIAttributeValueChanges: '{request.body#/notificationRecipientAddress}': post: requestBody: @@ -134,7 +134,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/notifyMOIAttributeValueChange-NotifType' + $ref: '#/components/schemas/NotifyMoiAttributeValueChanges' responses: '204': description: >- @@ -146,7 +146,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' notifyMOIChanges: '{request.body#/notificationRecipientAddress}': post: @@ -155,7 +155,10 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/notifyMOIChanges-NotifType' + $ref: '#/components/schemas/NotifyMoiChanges' + application/yang-data+json: + schema: + $ref: '#/components/schemas/NotifyMoiChanges' responses: '204': description: >- @@ -167,7 +170,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' get: summary: Reads one or multiple resources description: >- @@ -183,7 +186,7 @@ paths: mechanism is specified in the present document. required: false schema: - $ref: '#/components/schemas/scope-QueryType' + $ref: '#/components/schemas/Scope' style: form explode: true - name: filter @@ -196,7 +199,7 @@ paths: document. required: false schema: - $ref: '#/components/schemas/filter-QueryType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' - name: attributes in: query description: >- @@ -204,7 +207,9 @@ paths: are returned. required: true schema: - $ref: '#/components/schemas/attributes-QueryType' + type: array + items: + type: string style: form explode: false - name: fields @@ -214,7 +219,9 @@ paths: that are returned. required: false schema: - $ref: '#/components/schemas/fields-QueryType' + type: array + items: + type: string style: form explode: false responses: @@ -229,13 +236,13 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceRetrieval-ResponseType' + $ref: '#/components/schemas/Resource' default: description: Error case. content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' patch: summary: Patches one or multiple resources description: >- @@ -254,16 +261,20 @@ paths: content: application/merge-patch+json: schema: - $ref: '#/components/schemas/jsonMergePatch-RequestType' + $ref: '#/components/schemas/Resource' application/3gpp-merge-patch+json: schema: - $ref: '#/components/schemas/3gppJsonMergePatch-RequestType' + $ref: '#/components/schemas/Resource' application/json-patch+json: schema: - $ref: '#/components/schemas/jsonPatch-RequestType' + type: array + items: + type: object application/3gpp-json-patch+json: schema: - $ref: '#/components/schemas/3gppJsonPatch-RequestType' + type: array + items: + type: object responses: '200': description: >- @@ -276,7 +287,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceUpdate-ResponseType' + $ref: '#/components/schemas/Resource' '204': description: >- Success case ("204 No Content"). @@ -288,7 +299,7 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' delete: summary: Deletes one or multiple resources description: >- @@ -303,7 +314,9 @@ paths: mechanism is specified in the present document. required: false schema: - $ref: '#/components/schemas/scope-QueryType' + $ref: '#/components/schemas/Scope' + style: form + explode: true - name: filter in: query description: >- @@ -314,7 +327,7 @@ paths: document. required: false schema: - $ref: '#/components/schemas/filter-QueryType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' responses: '200': description: >- @@ -331,249 +344,169 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/resourceDeletion-ResponseType' + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' default: description: Error case. content: application/json: schema: - $ref: '#/components/schemas/error-ResponseType' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/ErrorResponse' components: schemas: - dateTime-Type: - type: string - format: date-time - long-Type: - type: integer - format: int64 - uri-Type: - type: string - correlatedNotification-Type: + CorrelatedNotification: type: object properties: source: - $ref: '#/components/schemas/uri-Type' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' notificationIds: type: array items: - $ref: '#/components/schemas/notificationId-Type' - notificationId-Type: - $ref: '#/components/schemas/long-Type' - notificationType-Type: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' + required: + - source + - notificationIds + CmNotificationTypes: type: string enum: - notifyMOICreation - notifyMOIDeletion - - notifyMOIAttributeValueChange - systemDN-Type: - type: string - additionalText-Type: + - notifyMOIAttributeValueChanges + - notifyMOIChanges + SourceIndicator: type: string - sourceIndicator-Type: + enum: + - RESOURCE_OPERATION + - MANAGEMENT_OPERATION + - SON_OPERATION + - UNKNOWN + Operation: type: string enum: - - resourceOperation - - mangementOperation - - sONOperation - - unknown - header-Type: - type: object - properties: - href: - $ref: '#/components/schemas/uri-Type' - notificationId: - $ref: '#/components/schemas/notificationId-Type' - notificationType: - $ref: '#/components/schemas/notificationType-Type' - eventTime: - $ref: '#/components/schemas/dateTime-Type' - systemDN: - $ref: '#/components/schemas/systemDN-Type' - required: - - href - - notificationId - - notificationType - - eventTime - - systemDN - scopeType-Type: + - add + - remove + - replace + ScopeType: type: string enum: - BASE_ONLY - BASE_NTH_LEVEL - BASE_SUBTREE - BASE_ALL - scopeLevel-Type: - type: integer - className-PathType: - type: string - id-PathType: - type: string - attributes-QueryType: - type: array - items: - type: string - fields-QueryType: - type: array - items: - type: string - filter-QueryType: - type: string - scope-QueryType: + Scope: type: object properties: scopeType: - $ref: '#/components/schemas/scopeType-Type' + $ref: '#/components/schemas/ScopeType' scopeLevel: - $ref: '#/components/schemas/scopeLevel-Type' + type: integer - resourcePut-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - 3gppJsonMergePatch-RequestType: - $ref: '#/components/schemas/resourceRepresentation-Type' - jsonPatch-RequestType: - type: array - items: - type: object - 3gppJsonPatch-RequestType: - type: array - items: - type: object - error-ResponseType: - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string - resourceRetrieval-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceCreation-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceUpdate-ResponseType: - $ref: '#/components/schemas/resourceRepresentation-Type' - resourceDeletion-ResponseType: - type: array - items: - $ref: '#/components/schemas/uri-Type' - - resourceRepresentation-Type: + Resource: oneOf: - type: object properties: id: type: string + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' attributes: type: object additionalProperties: type: array items: type: object + required: + - id - anyOf: - - $ref: 'genericNrm.yaml#/components/schemas/resources-genericNrm' - - $ref: 'nrNrm.yaml#/components/schemas/resources-nrNrm' - - $ref: '5gcNrm.yaml#/components/schemas/resources-5gcNrm' - - $ref: 'sliceNrm.yaml#/components/schemas/resources-sliceNrm' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/resources-genericNrm' + - $ref: 'TS28541_NrNrm.yaml#/components/schemas/resources-nrNrm' + - $ref: 'TS28541_5GcNrm.yaml#/components/schemas/resources-5gcNrm' + - $ref: 'TS28541_SliceNrm.yaml#/components/schemas/resources-sliceNrm' + - $ref: 'TS28312_IntentNrm.yaml#/components/schemas/resources-intentNrm' - mOIChange-Type: + MoiChange: type: object properties: notificationId: - $ref: '#/components/schemas/notificationId-Type' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationId' correlatedNotifications: type: array items: - $ref: '#/components/schemas/correlatedNotification-Type' + $ref: '#/components/schemas/CorrelatedNotification' additionalText: - $ref: '#/components/schemas/additionalText-Type' + type: string sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' + $ref: '#/components/schemas/SourceIndicator' + op: + $ref: '#/components/schemas/Operation' path: - $ref: '#/components/schemas/uri-Type' - operation: - type: string - enum: - - CREATE - - DELETE - - REPLACE - value: - oneOf: - - type: object - additionalProperties: - nullable: true - - type: array - items: - type: object - minItems: 1 - maxItems: 2 + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + value: {} + oldValue: {} + required: + - notificationId + - op + - path - notifyMOICreation-NotifType: + NotifyMoiCreation: allOf: - - $ref: '#/components/schemas/header-Type' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object properties: correlatedNotifications: type: array items: - $ref: '#/components/schemas/correlatedNotification-Type' + $ref: '#/components/schemas/CorrelatedNotification' additionalText: - $ref: '#/components/schemas/additionalText-Type' + type: string sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' + $ref: '#/components/schemas/SourceIndicator' attributeList: - type: object - additionalProperties: - nullable: true - notifyMOIDeletion-NotifType: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyMoiDeletion: allOf: - - $ref: '#/components/schemas/header-Type' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object properties: correlatedNotifications: type: array items: - $ref: '#/components/schemas/correlatedNotification-Type' + $ref: '#/components/schemas/CorrelatedNotification' additionalText: - $ref: '#/components/schemas/additionalText-Type' + type: string sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' + $ref: '#/components/schemas/SourceIndicator' attributeList: - type: object - additionalProperties: true - notifyMOIAttributeValueChange-NotifType: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeNameValuePairSet' + NotifyMoiAttributeValueChanges: allOf: - - $ref: '#/components/schemas/header-Type' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object properties: correlatedNotifications: type: array items: - $ref: '#/components/schemas/correlatedNotification-Type' + $ref: '#/components/schemas/CorrelatedNotification' additionalText: - $ref: '#/components/schemas/additionalText-Type' + type: string sourceIndicator: - $ref: '#/components/schemas/sourceIndicator-Type' - attributeValueChange: - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true + $ref: '#/components/schemas/SourceIndicator' + attributeListValueChanges: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AttributeValueChangeSet' required: - - attributeValueChange - notifyMOIChanges-NotifType: + - attributeListValueChanges + NotifyMoiChanges: allOf: - - $ref: '#/components/schemas/header-Type' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationHeader' - type: object properties: - mOIChanges: + moiChanges: type: array items: - $ref: '#/components/schemas/mOIChange-Type' + $ref: '#/components/schemas/MoiChange' required: - - mOIChanges + - moiChanges diff --git a/OpenAPI/streamingDataMnS.yaml b/OpenAPI/TS28532_StreamingDataMnS.yaml old mode 100644 new mode 100755 similarity index 93% rename from OpenAPI/streamingDataMnS.yaml rename to OpenAPI/TS28532_StreamingDataMnS.yaml index ab7f71d4a8f816fd13c14397c5e31270903613dd..3d1e82ef2baab8d5ba71713c50f9c0a9873601c8 --- a/OpenAPI/streamingDataMnS.yaml +++ b/OpenAPI/TS28532_StreamingDataMnS.yaml @@ -1,24 +1,20 @@ openapi: 3.0.1 info: title: TS 28.532 Streaming data reporting service - version: 16.4.0 - description: OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) + version: 17.1.0 + description: >- + OAS 3.0.1 specification for the Streaming data reporting service (Streaming MnS) + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. servers: - - url: '{protocol}://{root}/StreamingDataReportingMnS/{version}' + - url: '{MnSRoot}/StreamingDataReportingMnS/{MnSVersion}' variables: - protocol: - description: Protocol used - enum: - - http - - https - - wss - default: https - root: - description: Indicates the host name and optional port, and an optional sequence of path segments that together represent a prefix path. - default: example.com - version: - description: Indicates the current version of the specification - default: 16.4.0 + MnSRoot: + description: See clause 4.4.3 of TS 32.158. + default: https://example.com/3GPPManagement + MnSVersion: + description: See clause 4.4.3 of TS 32.158. + default: '' paths: '/connections': post: @@ -329,8 +325,8 @@ components: description: DN of the measured object instance (see 3GPP TS 28.550) allOf: - $ref: '#/components/schemas/systemDN-Type' - measTypes-Type: - description: an ordered list of measurement type or KPI whose measurement values or KPI result values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550) via this stream + performanceMetrics-Type: + description: an ordered list of performance metric names (see clause 4.4.1 of 3GPP TS 28.622[11]) whose values are to be reported by the Performance Data Stream Units (see Annex C of TS 28.550 [42]) via this stream. Performance metrics include measurement and KPI type: array items: type: string @@ -340,15 +336,13 @@ components: properties: measObjDn: $ref: '#/components/schemas/measObjDn-Type' - measTypes: - $ref: '#/components/schemas/measTypes-Type' - measurementReaderId: - $ref: '#/components/schemas/systemDN-Type' + performanceMetrics: + $ref: '#/components/schemas/performanceMetrics-Type' jobId: type: string required: - measObjDn - - measTypes + - performanceMetrics producerId-Type: description: DN of the streaming data reporting MnS producer. allOf: @@ -408,7 +402,7 @@ components: traceInfo-Type: description: Information specific to trace data reporting allOf: - - $ref: 'genericNrm.yaml#/components/schemas/TraceJob-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TraceJob-Attr' traceReference-Type: description: Trace Reference (see clause 5.6 of 3GPP TS 32.422) as stream identifier for streaming trace data reporting type: string diff --git a/OpenAPI/TS28536_CoslaNrm.yaml b/OpenAPI/TS28536_CoslaNrm.yaml new file mode 100755 index 0000000000000000000000000000000000000000..7545b12823df2b22a5b1b15047fe0f38f66fed60 --- /dev/null +++ b/OpenAPI/TS28536_CoslaNrm.yaml @@ -0,0 +1,254 @@ +openapi: 3.0.1 + +info: + title: coslaNrm + version: 17.3.0 + description: >- + OAS 3.0.1 specification of the Cosla NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 28.536 V17.3.0; Cosla NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ + +paths: {} + +components: + + schemas: + +#------------ Type definitions --------------------------------------------------- + + ControlLoopLifeCyclePhase: + type: string + enum: + - PREPARATION + - COMMISSIONING + - OPERATION + - DECOMMISSIONING + + ObservationTime: + type: integer + + AssuranceGoalStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceGoalStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusObserved: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetStatusPredicted: + type: string + enum: + - FULFILLED + - NOT_FULFILLED + + AssuranceTargetName: + type: string + + AssuranceTarget: + type: object + properties: + assuranceTargetName: + $ref: '#/components/schemas/AssuranceTargetName' + assuranceTargetValue: + type: string + + AssuranceTargetList: + type: array + items: + $ref: '#/components/schemas/AssuranceTarget' + + AssuranceGoalStatus: + type: object + properties: + assuranceGoalStatusId: + type: string + assuranceGoalId: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + assuranceGoalStatusObserved: + $ref: '#/components/schemas/AssuranceGoalStatusObserved' + assuranceGoalStatusPredicted: + $ref: '#/components/schemas/AssuranceGoalStatusPredicted' + assuranceGoalRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + AssuranceGoalStatusList: + type: array + items: + $ref: '#/components/schemas/AssuranceGoalStatus' + + AssuranceTargetStatus: + type: object + properties: + assuranceTargetStatusId: + type: string + assuranceTargetName: + $ref: '#/components/schemas/AssuranceTargetName' + assuranceTargetStatusObserved: + $ref: '#/components/schemas/AssuranceTargetStatusObserved' + assuranceTargetStatusPredicted: + $ref: '#/components/schemas/AssuranceTargetStatusPredicted' + + AssuranceTargetStatusList: + type: array + items: + $ref: '#/components/schemas/AssuranceTargetStatus' + + AttributeNameList: + type: array + items: + type: string + + ACCLDisallowedAttributes: + type: object + properties: + managedEntityIdentifier: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + attributeNameList: + $ref: '#/components/schemas/AttributeNameList' + + AssuranceScope: + type: object + properties: + taiList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' + +#-------- Definition of concrete IOCs -------------------------------------------- + MnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AssuranceClosedControlLoop: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Multiple' + + AssuranceClosedControlLoop-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + controlLoopLifeCyclePhase: + $ref: '#/components/schemas/ControlLoopLifeCyclePhase' + aCCLDisallowedList: + $ref: '#/components/schemas/ACCLDisallowedAttributes' + AssuranceGoal: + $ref: '#/components/schemas/AssuranceGoal-Multiple' + networkSliceRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + networkSliceSubnetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + AssuranceGoal-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + observationTime: + $ref: '#/components/schemas/ObservationTime' + assuranceTargetList: + $ref: '#/components/schemas/AssuranceTargetList' + assuranceScope: + $ref: '#/components/schemas/AssuranceScope' + serviceProfileId: + type: string + sliceProfileId: + type: string + + AssuranceReport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + assuranceGoalStatusList: + $ref: '#/components/schemas/AssuranceGoalStatusList' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + + AssuranceClosedControlLoop-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + + AssuranceGoal-Multiple: + type: array + items: + $ref: '#/components/schemas/AssuranceGoal-Single' + +#------------ Definitions in TS 28.536 for TS 28.623 ----------------------------- + + resources-coslaNrm: + oneOf: + - $ref: '#/components/schemas/MnS' + - $ref: '#/components/schemas/AssuranceClosedControlLoop-Single' + - $ref: '#/components/schemas/AssuranceGoal-Single' + - $ref: '#/components/schemas/AssuranceReport-Single' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' diff --git a/OpenAPI/TS28538_EdgeNrm.yaml b/OpenAPI/TS28538_EdgeNrm.yaml new file mode 100644 index 0000000000000000000000000000000000000000..62753ce70484acb535ea2f6fb4c73bcfb41749bd --- /dev/null +++ b/OpenAPI/TS28538_EdgeNrm.yaml @@ -0,0 +1,269 @@ +openapi: 3.0.1 +info: + title: 3GPP Edge NRM + version: 17.1.0 + description: >- + OAS 3.0.1 specification of the Edge NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.538; Edge NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.538/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + ServingLocation: + type: object + properties: + geographicalLocation: + $ref: '#/components/schemas/GeoLoc' + topologicalLocation: + $ref: '#/components/schemas/TopologicalServiceArea' + TopologicalServiceArea: + type: object + properties: + cellIdList: + type: array + items: + type: integer + trackingAreaIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/TaiList' + servingPLMN: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + GeoLoc: + type: object + properties: + geographicalCoordinates: + $ref: '#/components/schemas/GeographicalCoordinates' + civicLocation: + type: string + GeographicalCoordinates: + type: object + properties: + lattitude: + type: integer + longitude: + type: integer + EDNConnectionInfo: + type: object + properties: + dNN: + type: string + eDNServiceArea: + $ref: '#/components/schemas/ServingLocation' + AffinityAntiAffinity: + type: object + properties: + affinityEAS: + type: array + items: + type: string + antiAffinityEAS: + type: array + items: + type: string + VirtualResource: + type: object + properties: + virtualMemory: + type: integer + virtualDisk: + type: integer + virutalCPU: + type: string + SoftwareImageInfo: + type: object + properties: + minimumDisk: + type: integer + minimumRAM: + type: integer + discFormat: + type: string + operatingSystem: + type: string + swImageRef: + type: string + RegistrationInfo: + type: object + properties: + registrationExpiry: + type: string + registrationID: + type: string + secCredential: + type: string + +#-------- Definition of concrete IOCs -------------------------------------------- + MnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - type: object + properties: + Subnetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ECSFunction: + $ref: '#/components/schemas/ECSFunction-Multiple' + EdgeDataNetwork: + $ref: '#/components/schemas/EdgeDataNetwork-Multiple' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + + EdgeDataNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + ednIdentifier: + type: string + eDNConnectionInfo: + $ref: '#/components/schemas/EDNConnectionInfo' + - type: object + properties: + EASFunction: + $ref: '#/components/schemas/EASFunction-Multiple' + EESFunction: + $ref: '#/components/schemas/EESFunction-Multiple' + + EASFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eASIdentifier: + type: string + eESAddress: + type: array + items: + type: string + eASRequirementsRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + eESFunctionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + eASAddress: + type: array + items: + type: string + registrationInfo: + $ref: '#/components/schemas/RegistrationInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + EESFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eESIdentifier: + type: string + eESServingLocation: + type: array + items: + $ref: '#/components/schemas/ServingLocation' + eESAddress: + type: array + items: + type: string + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + serviceContinuitySupport: + type: boolean + eASFunctionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + registrationInfo: + $ref: '#/components/schemas/RegistrationInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + ECSFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + eCSAddress: + type: string + providerIdentifier: + type: string + edgeDataNetworkRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + eESFuncitonRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + + EASRequirements-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + requiredEASservingLocation: + $ref: '#/components/schemas/ServingLocation' + affinityAntiAffinity: + $ref: '#/components/schemas/AffinityAntiAffinity' + serviceContinuity: + type: boolean + virtualResource: + $ref: '#/components/schemas/VirtualResource' + softwareImageInfo: + $ref: '#/components/schemas/SoftwareImageInfo' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + EASFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/EASFunction-Single' + ECSFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ECSFunction-Single' + EESFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/EESFunction-Single' + EdgeDataNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/EdgeDataNetwork-Single' + +#--------------------------------- Definition ------------------------------------ + + resources-edgeNrm: + oneOf: + - $ref: '#/components/schemas/MnS' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/EASFunction-Single' + - $ref: '#/components/schemas/ECSFunction-Single' + - $ref: '#/components/schemas/EESFunction-Single' + - $ref: '#/components/schemas/EdgeDataNetwork-Single' + - $ref: '#/components/schemas/EASRequirements-Single' diff --git a/OpenAPI/TS28541_5GcNrm.yaml b/OpenAPI/TS28541_5GcNrm.yaml new file mode 100755 index 0000000000000000000000000000000000000000..b62b132c7e921824f551691254d5ed434d693281 --- /dev/null +++ b/OpenAPI/TS28541_5GcNrm.yaml @@ -0,0 +1,2565 @@ +openapi: 3.0.1 +info: + title: 3GPP 5GC NRM + version: 17.7.0 + description: >- + OAS 3.0.1 specification of the 5GC NRM + © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.541; 5G NRM, 5GC NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + AmfIdentifier: + type: object + description: 'AmfIdentifier comprise of amfRegionId, amfSetId and amfPointer' + properties: + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + amfPointer: + $ref: '#/components/schemas/AmfPointer' + AmfRegionId: + type: integer + description: AmfRegionId is defined in TS 23.003 + maximum: 255 + AmfSetId: + type: string + description: AmfSetId is defined in TS 23.003 + maximum: 1023 + AmfPointer: + type: integer + description: AmfPointer is defined in TS 23.003 + maximum: 63 + IpEndPoint: + type: object + properties: + ipv4Address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + ipv6Address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + ipv6Prefix: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Prefix' + transport: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/TransportProtocol' + port: + type: integer + NFProfileList: + type: array + description: List of NF profile + items: + $ref: '#/components/schemas/NFProfile' + NFProfile: + type: object + description: 'NF profile stored in NRF, defined in TS 29.510' + properties: + nFInstanceId: + type: string + description: uuid of NF instance + nFType: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NFType' + nFStatus: + $ref: '#/components/schemas/NFStatus' + plmn: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + sNssais: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + nfServices: + type: array + items: + $ref: '#/components/schemas/NFService' + NFService: + type: object + description: NF Service is defined in TS 29.510 + properties: + serviceInstanceId: + type: string + serviceName: + type: string + version: + type: string + schema: + type: string + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + interPlmnFqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + ipEndPoints: + type: array + items: + $ref: '#/components/schemas/IpEndPoint' + apiPrfix: + type: string + allowedPlmns: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + allowedNfTypes: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NFType' + allowedNssais: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + NFStatus: + type: string + description: any of enumrated value + enum: + - REGISTERED + - SUSPENDED + CNSIIdList: + type: array + items: + $ref: '#/components/schemas/CNSIId' + CNSIId: + type: string + description: CNSI Id is defined in TS 29.531, only for Core Network + TACList: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/NrTac' + WeightFactor: + type: integer + UdmInfo: + type: object + properties: + nFSrvGroupId: + type: string + AusfInfo: + type: object + properties: + nFSrvGroupId: + type: string + UpfInfo: + type: object + properties: + smfServingAreas: + type: string + SupportedDataSetId: + type: string + description: any of enumrated value + enum: + - SUBSCRIPTION + - POLICY + - EXPOSURE + - APPLICATION + Udrinfo: + type: object + properties: + supportedDataSetIds: + type: array + items: + $ref: '#/components/schemas/SupportedDataSetId' + nFSrvGroupId: + type: string + NFInfo: + oneOf: + - $ref: '#/components/schemas/UdmInfo' + - $ref: '#/components/schemas/AusfInfo' + - $ref: '#/components/schemas/UpfInfo' + - $ref: '#/components/schemas/Udrinfo' + NotificationType: + type: string + enum: + - N1_MESSAGES + - N2_INFORMATION + - LOCATION_NOTIFICATION + - DATA_REMOVAL_NOTIFICATION + - DATA_CHANGE_NOTIFICATION + - LOCATION_UPDATE_NOTIFICATION + - NSSAA_REAUTH_NOTIFICATION + - NSSAA_REVOC_NOTIFICATION + DefaultNotificationSubscription: + type: object + properties: + notificationType: + $ref: '#/components/schemas/NotificationType' + callbackURI: + type: string + n1MessageClass: + type: boolean + n2InfroamtionClass: + type: boolean + versions: + type: string + binding: + type: string + ManagedNFProfile: + type: object + properties: + nfInstanceID: + type: string + nfType: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NFType' + heartbeatTimer: + type: integer + authzInfo: + type: string + hostAddr: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + allowedPLMNs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + allowedSNPNs: + type: array + items: + $ref: '#/components/schemas/SnpnInfo' + allowedNfTypes: + type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/NFType' + allowedNfDomains: + type: array + items: + type: string + allowedNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + locality: + type: string + nFInfo: + $ref: '#/components/schemas/NFInfo' + capacity: + type: integer + nfSetIdList: + type: array + items: + type: string + servingScope: + type: array + items: + type: string + nfSetRecoveryTimeList: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + scpDomains: + type: array + items: + type: string + vendorId: + type: string + SEPPType: + type: string + description: any of enumrated value + enum: + - CSEPP + - PSEPP + SupportedFunc: + type: object + properties: + function: + type: string + policy: + type: string + SupportedFuncList: + type: array + items: + $ref: '#/components/schemas/SupportedFunc' + CommModelType: + type: string + description: any of enumrated value + enum: + - DIRECT_COMMUNICATION_WO_NRF + - DIRECT_COMMUNICATION_WITH_NRF + - INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY + - INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY + CommModel: + type: object + properties: + groupId: + type: integer + commModelType: + $ref: '#/components/schemas/CommModelType' + targetNFServiceList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + commModelConfiguration: + type: string + CommModelList: + type: array + items: + $ref: '#/components/schemas/CommModel' + CapabilityList: + type: array + items: + type: string + FiveQiDscpMapping: + type: object + properties: + fiveQIValues: + type: array + items: + type: integer + dscp: + type: integer + NetworkSliceInfo: + type: object + properties: + sNSSAI: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + cNSIId: + $ref: '#/components/schemas/CNSIId' + networkSliceRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + NetworkSliceInfoList: + type: array + items: + $ref: '#/components/schemas/NetworkSliceInfo' + + PacketErrorRate: + type: object + properties: + scalar: + type: integer + exponent: + type: integer + + GtpUPathDelayThresholdsType: + type: object + properties: + n3AveragePacketDelayThreshold: + type: integer + n3MinPacketDelayThreshold: + type: integer + n3MaxPacketDelayThreshold: + type: integer + n9AveragePacketDelayThreshold: + type: integer + n9MinPacketDelayThreshold: + type: integer + n9MaxPacketDelayThreshold: + type: integer + QFPacketDelayThresholdsType: + type: object + properties: + thresholdDl: + type: integer + thresholdUl: + type: integer + thresholdRtt: + type: integer + + QosData: + type: object + properties: + qosId: + type: string + fiveQIValue: + type: integer + maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + qosNotificationControl: + type: boolean + reflectiveQos: + type: boolean + sharingKeyDl: + type: string + sharingKeyUl: + type: string + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + + QosDataList: + type: array + items: + $ref: '#/components/schemas/QosData' + + SteeringMode: + type: object + properties: + steerModeValue: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteerModeValue' + active: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + threeGLoad: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + prioAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + + TrafficControlData: + type: object + properties: + tcId: + type: string + flowStatus: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + trafficSteeringPolIdDl: + type: string + nullable: true + trafficSteeringPolIdUl: + type: string + nullable: true + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + traffCorreInd: + type: boolean + upPathChgEvent: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + steerFun: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/MulticastAccessControl' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + + TrafficControlDataList: + type: array + items: + $ref: '#/components/schemas/TrafficControlData' + + PccRule: + type: object + properties: + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + flowInfoList: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowInformation' + applicationId: + type: string + appDescriptor: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ApplicationDescriptor' + contentVersion: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + isAppRelocatable: + type: boolean + isUeAddrPreserved: + type: boolean + qosData: + type: array + items: + $ref: '#/components/schemas/QosDataList' + altQosParams: + type: array + items: + $ref: '#/components/schemas/QosDataList' + trafficControlData: + type: array + items: + $ref: '#/components/schemas/TrafficControlDataList' + conditionData: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/ConditionData' + tscaiInputDl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + + SnssaiInfo: + type: object + properties: + plmnInfo: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfo' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + + NsacfInfoSnssai: + type: object + properties: + SnssaiInfo: + $ref: '#/components/schemas/SnssaiInfo' + isSubjectToNsac: + type: boolean + maxNumberofUEs: + type: integer + eACMode: + type: string + enum: + - INACTIVE + - ACTIVE + activeEacThreshhold: + type: integer + deactiveEacThreshhold: + type: integer + numberofUEs: + type: integer + uEIdList: + type: array + items: + type: string + maxNumberofPDUSessions: + type: integer + + NRTACRange: + type: object + properties: + nRTACstart: + type: string + nRTACend: + type: string + nRTACpattern: + type: string + + TaiRange: + type: object + properties: + plmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + nRTACRangelist: + type: array + items: + $ref: '#/components/schemas/NRTACRange' + + GUAMInfo: + type: object + properties: + pLMNId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + aMFIdentifier: + type: integer + + SupportedBMOList: + type: array + items: + type: string + + ECSAddrConfigInfo: + type: array + items: + type: string + + DnnSmfInfoItem: + type: object + properties: + dnn: + type: string + dnaiList: + type: array + items: + type: string + + SNssaiSmfInfoItem: + type: object + properties: + sNSSAI: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + dnnSmfInfoList: + type: array + items: + $ref: '#/components/schemas/DnnSmfInfoItem' + + IpAddr: + type: object + properties: + ipv4Addr: + type: string + ipv6Addr: + type: string + ipv6Prefix: + type: string + + 5GCNfConnEcmInfoList: + type: array + items: + $ref: '#/components/schemas/5GCNfConnEcmInfo' + 5GCNfConnEcmInfo: + type: object + description: 'Store the 5GC NF connection information' + properties: + 5GCNFType: + type: string + enum: + - PCF + - NEF + - SCEF + 5GCNFIpAddress: + type: string + 5GCNFRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + UPFConnectionInfo: + type: object + properties: + uPFIpAddress: + type: string + uPFRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + SnssaiList: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + SnpnId: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + nid: + type: string + SnpnInfo: + type: object + properties: + snpnId: + $ref: '#/components/schemas/SnpnId' + snssai: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + TaiList: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Tai' + +#-------- Definition of concrete IOCs -------------------------------------------- + ProvMnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + ExternalAmfFunction: + $ref: '#/components/schemas/ExternalAmfFunction-Multiple' + ExternalNrfFunction: + $ref: '#/components/schemas/ExternalNrfFunction-Multiple' + ExternalNssfFunction: + $ref: '#/components/schemas/ExternalNssfFunction-Multiple' + AmfSet: + $ref: '#/components/schemas/AmfSet-Multiple' + AmfRegion: + $ref: '#/components/schemas/AmfRegion-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + + ManagedElement-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' + - type: object + properties: + AmfFunction: + $ref: '#/components/schemas/AmfFunction-Multiple' + SmfFunction: + $ref: '#/components/schemas/SmfFunction-Multiple' + UpfFunction: + $ref: '#/components/schemas/UpfFunction-Multiple' + N3iwfFunction: + $ref: '#/components/schemas/N3iwfFunction-Multiple' + PcfFunction: + $ref: '#/components/schemas/PcfFunction-Multiple' + AusfFunction: + $ref: '#/components/schemas/AusfFunction-Multiple' + UdmFunction: + $ref: '#/components/schemas/UdmFunction-Multiple' + UdrFunction: + $ref: '#/components/schemas/UdrFunction-Multiple' + UdsfFunction: + $ref: '#/components/schemas/UdsfFunction-Multiple' + NrfFunction: + $ref: '#/components/schemas/NrfFunction-Multiple' + NssfFunction: + $ref: '#/components/schemas/NssfFunction-Multiple' + SmsfFunction: + $ref: '#/components/schemas/SmsfFunction-Multiple' + LmfFunction: + $ref: '#/components/schemas/LmfFunction-Multiple' + NgeirFunction: + $ref: '#/components/schemas/NgeirFunction-Multiple' + SeppFunction: + $ref: '#/components/schemas/SeppFunction-Multiple' + NwdafFunction: + $ref: '#/components/schemas/NwdafFunction-Multiple' + ScpFunction: + $ref: '#/components/schemas/ScpFunction-Multiple' + NefFunction: + $ref: '#/components/schemas/NefFunction-Multiple' + Configurable5QISet: + $ref: '#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: '#/components/schemas/Dynamic5QISet-Multiple' + EcmConnectionInfo: + $ref: '#/components/schemas/EcmConnectionInfo-Multiple' + + AmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + sBIFqdn: + type: string + interPlmnFQDN: + type: string + taiList: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + weightFactor: + $ref: '#/components/schemas/WeightFactor' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + gUAMIdList: + type: array + items: + $ref: '#/components/schemas/GUAMInfo' + backupInfoAmfFailure: + type: array + items: + $ref: '#/components/schemas/GUAMInfo' + backupInfoAmfRemoval: + type: array + items: + $ref: '#/components/schemas/GUAMInfo' + amfSetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N2: + $ref: '#/components/schemas/EP_N2-Multiple' + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N14: + $ref: '#/components/schemas/EP_N14-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N26: + $ref: '#/components/schemas/EP_N26-Multiple' + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + EP_NLG: + $ref: '#/components/schemas/EP_NLG-Multiple' + AmfSet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfSetId: + $ref: '#/components/schemas/AmfSetId' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + aMFRegionRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + aMFSetMemberList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + AmfRegion-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + amfRegionId: + $ref: '#/components/schemas/AmfRegionId' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + aMFSetListRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + SmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + pLMNInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + nRTACList: + $ref: '#/components/schemas/TACList' + sBIFqdn: + type: string + sNssaiSmfInfoList: + type: array + items: + $ref: '#/components/schemas/SNssaiSmfInfoItem' + taiList: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Tai' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + pwgFqdn: + type: string + pgwAddrList: + type: array + items: + $ref: '#/components/schemas/IpAddr' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + priority: + type: integer + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + vsmfSupportInd: + type: boolean + pwgFqdnList: + type: array + items: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N11: + $ref: '#/components/schemas/EP_N11-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_S5C: + $ref: '#/components/schemas/EP_S5C-Multiple' + FiveQiDscpMappingSet: + $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + GtpUPathQoSMonitoringControl: + $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + QFQoSMonitoringControl: + $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + UpfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + nRTACList: + $ref: '#/components/schemas/TACList' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + supportedBMOList: + $ref: '#/components/schemas/SupportedBMOList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + EP_N6: + $ref: '#/components/schemas/EP_N6-Multiple' + EP_N9: + $ref: '#/components/schemas/EP_N9-Multiple' + EP_S5U: + $ref: '#/components/schemas/EP_S5U-Multiple' + N3iwfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N3: + $ref: '#/components/schemas/EP_N3-Multiple' + EP_N4: + $ref: '#/components/schemas/EP_N4-Multiple' + PcfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + configurable5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + supportedBMOList: + $ref: '#/components/schemas/SupportedBMOList' + + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N5: + $ref: '#/components/schemas/EP_N5-Multiple' + EP_N7: + $ref: '#/components/schemas/EP_N7-Multiple' + EP_N15: + $ref: '#/components/schemas/EP_N15-Multiple' + EP_N16: + $ref: '#/components/schemas/EP_N16-Multiple' + EP_Rx: + $ref: '#/components/schemas/EP_Rx-Multiple' + PredefinedPccRuleSet: + $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + + AusfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N12: + $ref: '#/components/schemas/EP_N12-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdmFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + eCSAddrConfigInfo: + $ref: '#/components/schemas/ECSAddrConfigInfo' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N8: + $ref: '#/components/schemas/EP_N8-Multiple' + EP_N10: + $ref: '#/components/schemas/EP_N10-Multiple' + EP_N13: + $ref: '#/components/schemas/EP_N13-Multiple' + UdrFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + UdsfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + NrfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N27: + $ref: '#/components/schemas/EP_N27-Multiple' + NssfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + cNSIIdList: + $ref: '#/components/schemas/CNSIIdList' + nFProfileList: + $ref: '#/components/schemas/NFProfileList' + snssaiList: + $ref: '#/components/schemas/SnssaiList' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N22: + $ref: '#/components/schemas/EP_N22-Multiple' + EP_N31: + $ref: '#/components/schemas/EP_N31-Multiple' + SmsfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N20: + $ref: '#/components/schemas/EP_N20-Multiple' + EP_N21: + $ref: '#/components/schemas/EP_N21-Multiple' + EP_MAP_SMSC: + $ref: '#/components/schemas/EP_MAP_SMSC-Multiple' + LmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_NLS: + $ref: '#/components/schemas/EP_NLS-Multiple' + NgeirFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N17: + $ref: '#/components/schemas/EP_N17-Multiple' + SeppFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + sEPPType: + $ref: '#/components/schemas/SEPPType' + sEPPId: + type: integer + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N32: + $ref: '#/components/schemas/EP_N32-Multiple' + NwdafFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + networkSliceInfoList: + $ref: '#/components/schemas/NetworkSliceInfoList' + + ScpFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + supportedFuncList: + $ref: '#/components/schemas/SupportedFuncList' + address: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + NefFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + sBIFqdn: + type: string + snssaiList: + $ref: '#/components/schemas/SnssaiList' + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + capabilityList: + $ref: '#/components/schemas/CapabilityList' + isCAPIFSup: + type: boolean + taiList: + items: + $ref: '#/components/schemas/TaiList' + taiRangeList: + type: array + items: + $ref: '#/components/schemas/TaiRange' + dnai: + type: string + + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N33: + $ref: '#/components/schemas/EP_N33-Multiple' + NsacfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + nsacfInfoSnssai: + type: array + items: + $ref: '#/components/schemas/NsacfInfoSnssai' + taiList: + items: + $ref: '#/components/schemas/TaiList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_N60: + $ref: '#/components/schemas/EP_N60-Multiple' + + DDNMFFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + commModelList: + $ref: '#/components/schemas/CommModelList' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_Npc4: + $ref: '#/components/schemas/EP_Npc4-Multiple' + EP_Npc6: + $ref: '#/components/schemas/EP_Npc6-Multiple' + EP_Npc7: + $ref: '#/components/schemas/EP_Npc7-Multiple' + EP_Npc8: + $ref: '#/components/schemas/EP_Npc8-Multiple' + + EASDFFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + sBIFqdn: + type: string + managedNFProfile: + $ref: '#/components/schemas/ManagedNFProfile' + serverAddr: + type: string + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' + - type: object + properties: + EP_Nxx: + $ref: '#/components/schemas/EP_Nxx-Multiple' + + EcmConnectionInfo-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + eASServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eESServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eDNServiceArea: + $ref: 'TS28538_EdgeNrm.yaml#/components/schemas/ServingLocation' + eASIpAddress: + type: string + eESIpAddress: + type: string + eCSIpAddress: + type: string + ednIdentifier: + type: string + ecmConnectionType: + type: string + enum: + - USERPLANE + - CONTROLPLANE + - BOTH + 5GCNfConnEcmInfoList: + $ref: '#/components/schemas/5GCNfConnEcmInfoList' + uPFConnectionInfo: + $ref: '#/components/schemas/UPFConnectionInfo' + + + ExternalAmfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + amfIdentifier: + $ref: '#/components/schemas/AmfIdentifier' + ExternalNrfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + ExternalNssfFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnIdList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnIdList' + ExternalSeppFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' + - type: object + properties: + plmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + sEPPId: + type: integer + fqdn: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Fqdn' + + + EP_N2-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N3-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + EP_N4-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N5-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N6-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N7-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N8-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N9-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N10-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N11-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N12-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N13-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N14-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N15-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N16-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N17-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N20-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N21-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N22-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N26-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N27-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + + EP_N31-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_N32-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + remotePlmnId: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnId' + remoteSeppAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + remoteSeppId: + type: integer + n32cParas: + type: string + n32fPolicy: + type: string + withIPX: + type: boolean + EP_N33-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5C-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_S5U-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Rx-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_MAP_SMSC-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLS-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_NLG-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_N60-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc4-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc6-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc7-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + EP_Npc8-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + EP_Nxx-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' + - type: object + properties: + localAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/LocalAddress' + remoteAddress: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/RemoteAddress' + + FiveQiDscpMappingSet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + FiveQiDscpMappingList: + type: array + items: + $ref: '#/components/schemas/FiveQiDscpMapping' + + FiveQICharacteristics-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + fiveQIValue: + type: integer + resourceType: + type: string + enum: + - GBR + - NonGBR + priorityLevel: + type: integer + packetDelayBudget: + type: integer + packetErrorRate: + $ref: '#/components/schemas/PacketErrorRate' + averagingWindow: + type: integer + maximumDataBurstVolume: + type: integer + FiveQICharacteristics-Multiple: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Single' + Configurable5QISet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + configurable5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + Dynamic5QISet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + dynamic5QIs: + type: array + items: + $ref: '#/components/schemas/FiveQICharacteristics-Multiple' + + GtpUPathQoSMonitoringControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + gtpUPathQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + gtpUPathMonitoredSNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + monitoredDSCPs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredGtpUPathMonitoringSupported: + type: boolean + isPeriodicGtpUMonitoringSupported: + type: boolean + isImmediateGtpUMonitoringSupported: + type: boolean + gtpUPathDelayThresholds: + $ref: '#/components/schemas/GtpUPathDelayThresholdsType' + gtpUPathMinimumWaitTime: + type: integer + gtpUPathMeasurementPeriod: + type: integer + + QFQoSMonitoringControl-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + qFQoSMonitoringState: + type: string + enum: + - ENABLED + - DISABLED + qFMonitoredSNSSAIs: + type: array + items: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Snssai' + qFMonitored5QIs: + type: array + items: + type: integer + minimum: 0 + maximum: 255 + isEventTriggeredQFMonitoringSupported: + type: boolean + isPeriodicQFMonitoringSupported: + type: boolean + isSessionReleasedQFMonitoringSupported: + type: boolean + qFPacketDelayThresholds: + $ref: '#/components/schemas/QFPacketDelayThresholdsType' + qFMinimumWaitTime: + type: integer + qFMeasurementPeriod: + type: integer + + PredefinedPccRuleSet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + predefinedPccRules: + type: array + items: + $ref: '#/components/schemas/PccRule' + +#-------- Definition of JSON arrays for name-contained IOCs ---------------------- + + SubNetwork-Multiple: + type: array + items: + $ref: '#/components/schemas/SubNetwork-Single' + ManagedElement-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedElement-Single' + AmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfFunction-Single' + SmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmfFunction-Single' + UpfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UpfFunction-Single' + N3iwfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/N3iwfFunction-Single' + PcfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/PcfFunction-Single' + AusfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/AusfFunction-Single' + UdmFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdmFunction-Single' + UdrFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdrFunction-Single' + UdsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/UdsfFunction-Single' + NrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NrfFunction-Single' + NssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NssfFunction-Single' + SmsfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SmsfFunction-Single' + LmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/LmfFunction-Single' + NgeirFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NgeirFunction-Single' + SeppFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/SeppFunction-Single' + NwdafFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NwdafFunction-Single' + ScpFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ScpFunction-Single' + NefFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NefFunction-Single' + + NsacfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/NsacfFunction-Single' + + ExternalAmfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalAmfFunction-Single' + ExternalNrfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNrfFunction-Single' + ExternalNssfFunction-Multiple: + type: array + items: + $ref: '#/components/schemas/ExternalNssfFunction-Single' + ExternalSeppFunction-Nultiple: + type: array + items: + $ref: '#/components/schemas/ExternalSeppFunction-Single' + + AmfSet-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfSet-Single' + AmfRegion-Multiple: + type: array + items: + $ref: '#/components/schemas/AmfRegion-Single' + + EP_N2-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N2-Single' + EP_N3-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N3-Single' + EP_N4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N4-Single' + EP_N5-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N5-Single' + EP_N6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N6-Single' + EP_N7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N7-Single' + EP_N8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N8-Single' + EP_N9-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N9-Single' + EP_N10-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N10-Single' + EP_N11-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N11-Single' + EP_N12-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N12-Single' + EP_N13-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N13-Single' + EP_N14-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N14-Single' + EP_N15-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N15-Single' + EP_N16-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N16-Single' + EP_N17-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N17-Single' + + EP_N20-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N20-Single' + EP_N21-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N21-Single' + EP_N22-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N22-Single' + + EP_N26-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N26-Single' + EP_N27-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N27-Single' + + EP_N31-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N31-Single' + EP_N32-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N32-Single' + EP_N33-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N33-Single' + EP_S5C-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5C-Single' + EP_S5U-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_S5U-Single' + EP_Rx-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Rx-Single' + EP_MAP_SMSC-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_MAP_SMSC-Single' + EP_NLS-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLS-Single' + EP_NLG-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_NLG-Single' + EP_N60-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_N60-Single' + EP_Npc4-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc4-Single' + EP_Npc6-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc6-Single' + EP_Npc7-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc7-Single' + EP_Npc8-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Npc8-Single' + EP_Nxx-Multiple: + type: array + items: + $ref: '#/components/schemas/EP_Nxx-Single' + Configurable5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Configurable5QISet-Single' + Dynamic5QISet-Multiple: + type: array + items: + $ref: '#/components/schemas/Dynamic5QISet-Single' + EcmConnectionInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/EcmConnectionInfo-Single' + + + + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-5gcNrm: + oneOf: + - $ref: '#/components/schemas/ProvMnS' + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/ManagedElement-Single' + - $ref: '#/components/schemas/AmfFunction-Single' + - $ref: '#/components/schemas/SmfFunction-Single' + - $ref: '#/components/schemas/UpfFunction-Single' + - $ref: '#/components/schemas/N3iwfFunction-Single' + - $ref: '#/components/schemas/PcfFunction-Single' + - $ref: '#/components/schemas/AusfFunction-Single' + - $ref: '#/components/schemas/UdmFunction-Single' + - $ref: '#/components/schemas/UdrFunction-Single' + - $ref: '#/components/schemas/UdsfFunction-Single' + - $ref: '#/components/schemas/NrfFunction-Single' + - $ref: '#/components/schemas/NssfFunction-Single' + - $ref: '#/components/schemas/SmsfFunction-Single' + - $ref: '#/components/schemas/LmfFunction-Single' + - $ref: '#/components/schemas/NgeirFunction-Single' + - $ref: '#/components/schemas/SeppFunction-Single' + - $ref: '#/components/schemas/NwdafFunction-Single' + - $ref: '#/components/schemas/ScpFunction-Single' + - $ref: '#/components/schemas/NefFunction-Single' + - $ref: '#/components/schemas/NsacfFunction-Single' + - $ref: '#/components/schemas/DDNMFFunction-Single' + + - $ref: '#/components/schemas/ExternalAmfFunction-Single' + - $ref: '#/components/schemas/ExternalNrfFunction-Single' + - $ref: '#/components/schemas/ExternalNssfFunction-Single' + - $ref: '#/components/schemas/ExternalSeppFunction-Single' + + - $ref: '#/components/schemas/AmfSet-Single' + - $ref: '#/components/schemas/AmfRegion-Single' + - $ref: '#/components/schemas/QFQoSMonitoringControl-Single' + - $ref: '#/components/schemas/GtpUPathQoSMonitoringControl-Single' + + - $ref: '#/components/schemas/EP_N2-Single' + - $ref: '#/components/schemas/EP_N3-Single' + - $ref: '#/components/schemas/EP_N4-Single' + - $ref: '#/components/schemas/EP_N5-Single' + - $ref: '#/components/schemas/EP_N6-Single' + - $ref: '#/components/schemas/EP_N7-Single' + - $ref: '#/components/schemas/EP_N8-Single' + - $ref: '#/components/schemas/EP_N9-Single' + - $ref: '#/components/schemas/EP_N10-Single' + - $ref: '#/components/schemas/EP_N11-Single' + - $ref: '#/components/schemas/EP_N12-Single' + - $ref: '#/components/schemas/EP_N13-Single' + - $ref: '#/components/schemas/EP_N14-Single' + - $ref: '#/components/schemas/EP_N15-Single' + - $ref: '#/components/schemas/EP_N16-Single' + - $ref: '#/components/schemas/EP_N17-Single' + + - $ref: '#/components/schemas/EP_N20-Single' + - $ref: '#/components/schemas/EP_N21-Single' + - $ref: '#/components/schemas/EP_N22-Single' + + - $ref: '#/components/schemas/EP_N26-Single' + - $ref: '#/components/schemas/EP_N27-Single' + + - $ref: '#/components/schemas/EP_N31-Single' + - $ref: '#/components/schemas/EP_N32-Single' + - $ref: '#/components/schemas/EP_N33-Single' + - $ref: '#/components/schemas/EP_N60-Single' + - $ref: '#/components/schemas/EP_Nxx-Single' + + - $ref: '#/components/schemas/EP_Npc4-Single' + - $ref: '#/components/schemas/EP_Npc6-Single' + - $ref: '#/components/schemas/EP_Npc7-Single' + - $ref: '#/components/schemas/EP_Npc8-Single' + + - $ref: '#/components/schemas/EP_S5C-Single' + - $ref: '#/components/schemas/EP_S5U-Single' + - $ref: '#/components/schemas/EP_Rx-Single' + - $ref: '#/components/schemas/EP_MAP_SMSC-Single' + - $ref: '#/components/schemas/EP_NLS-Single' + - $ref: '#/components/schemas/EP_NLG-Single' + - $ref: '#/components/schemas/Configurable5QISet-Single' + - $ref: '#/components/schemas/FiveQiDscpMappingSet-Single' + - $ref: '#/components/schemas/PredefinedPccRuleSet-Single' + - $ref: '#/components/schemas/Dynamic5QISet-Single' + - $ref: '#/components/schemas/EASDFFunction-Single' + - $ref: '#/components/schemas/EcmConnectionInfo-Single' + diff --git a/OpenAPI/nrNrm.yaml b/OpenAPI/TS28541_NrNrm.yaml old mode 100644 new mode 100755 similarity index 68% rename from OpenAPI/nrNrm.yaml rename to OpenAPI/TS28541_NrNrm.yaml index 2061e69407216dd5b9a273afae6c8fb59128322d..81e0ffdb88d5cf4da1b083b21eb4f53320f4feae --- a/OpenAPI/nrNrm.yaml +++ b/OpenAPI/TS28541_NrNrm.yaml @@ -1,13 +1,13 @@ openapi: 3.0.1 info: title: NR NRM - version: 16.5.0 + version: 17.7.0 description: >- OAS 3.0.1 specification of the NR NRM © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.541 V16.5.0; 5G NRM, NR NRM + description: 3GPP TS 28.541; 5G NRM, NR NRM url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.541/ paths: {} components: @@ -43,10 +43,6 @@ components: $ref: '#/components/schemas/Sst' sd: type: string - SnssaiList: - type: array - items: - $ref: '#/components/schemas/Snssai' Mnc: type: string @@ -55,7 +51,7 @@ components: type: object properties: mcc: - $ref: 'genericNrm.yaml#/components/schemas/Mcc' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' mnc: $ref: '#/components/schemas/Mnc' PlmnIdList: @@ -65,7 +61,7 @@ components: PlmnInfo: type: object properties: - plmnId": + plmnId: $ref: '#/components/schemas/PlmnId' snssai: $ref: '#/components/schemas/Snssai' @@ -73,16 +69,39 @@ components: type: array items: $ref: '#/components/schemas/PlmnInfo' + cagId: + type: string + nid: + type: string + NpnIdentity: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + cagidList: + $ref: '#/components/schemas/cagId' + nidList: + $ref: '#/components/schemas/nid' + NpnIdentityList: + type: array + items: + $ref: '#/components/schemas/NpnIdentity' + GGnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' + GEnbId: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' GGnbIdList: type: array - items: string - pattern: '^[0-9]{3}[0-9]{2,3}-(22|23|24|25|26|27|28|29|30|31|32)-[0-9]{1,10}' + items: + $ref: '#/components/schemas/GGnbId' GEnbIdList: type: array - items: string - pattern: '^[0-9]{3}[0-9]{2,3}-(18|20|21|22)-[0-9]{1,7}' + items: + $ref: '#/components/schemas/GEnbId' NrPci: type: integer @@ -97,7 +116,10 @@ components: $ref: '#/components/schemas/PlmnId' nrTac: $ref: '#/components/schemas/NrTac' - + TaiList: + type: array + items: + $ref: '#/components/schemas/Tai' BackhaulAddress: type: object properties: @@ -166,7 +188,7 @@ components: timeDuration: type: integer - UeAccProbilityDistPerSSB: + UeAccProbilityDist: type: object properties: targetProbability: @@ -174,7 +196,7 @@ components: numberofpreamblessent: type: integer - UeAccDelayProbilityDistPerSSB: + UeAccDelayProbilityDist: type: object properties: targetProbability: @@ -199,6 +221,16 @@ components: minimum: -20 maximum: 20 + MaximumDeviationHoTriggerLow: + type: integer + minimum: -20 + maximum: 20 + + MaximumDeviationHoTriggerHigh: + type: integer + minimum: -20 + maximum: 20 + MinimumTimeBetweenHoTriggerChange: type: integer minimum: 0 @@ -240,11 +272,7 @@ components: - INITIAL - OTHER - SUL - QuotaType: - type: string - enum: - - STRICT - - FLOAT + IsESCoveredBy: type: string enum: @@ -262,18 +290,22 @@ components: type: array items: $ref: '#/components/schemas/RrmPolicyMember' - - LocalAddress: + AddressWithVlan: type: object properties: ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' vlanId: type: integer minimum: 0 maximum: 4096 + LocalAddress: + type: object + properties: + addressWithVlan: + $ref: '#/components/schemas/AddressWithVlan' port: type: integer minimum: 0 @@ -282,9 +314,9 @@ components: type: object properties: ipv4Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv4Addr' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' ipv6Address: - $ref: 'genericNrm.yaml#/components/schemas/Ipv6Addr' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' CellIndividualOffset: type: object @@ -411,11 +443,11 @@ components: rimRSSubcarrierSpacing: type: integer rIMRSBandwidth: - type: integer + type: integer nrofGlobalRIMRSFrequencyCandidates: type: integer rimRSCommonCarrierReferencePoint: - type: integer + type: integer rimRSStartingFrequencyOffsetIdList: type: array items: @@ -425,13 +457,13 @@ components: type: object properties: nrofRIMRSSequenceCandidatesofRS1: - type: integer + type: integer rimRSScrambleIdListofRS1: type: array items: type: integer nrofRIMRSSequenceCandidatesofRS2: - type: integer + type: integer rimRSScrambleIdListofRS2: type: array items: @@ -452,33 +484,33 @@ components: dlULSwitchingPeriod1: type: string enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 symbolOffsetOfReferencePoint1: - type: integer + type: integer dlULSwitchingPeriod2: type: string enum: - - MS0P5 - - MS0P625 - - MS1 - - MS1P25 - - MS2 - - MS2P5 - - MS3 - - MS4 - - MS5 - - MS10 - - MS20 + - MS0P5 + - MS0P625 + - MS1 + - MS1P25 + - MS2 + - MS2P5 + - MS3 + - MS4 + - MS5 + - MS10 + - MS20 symbolOffsetOfReferencePoint2: type: integer totalnrofSetIdofRS1: @@ -532,7 +564,7 @@ components: - ENABLE - DISABLE reportInterval: - type: integer + type: integer nrofRIMRSReportInfo: type: integer maxPropagationDelay: @@ -541,28 +573,68 @@ components: type: array items: $ref: '#/components/schemas/RimRSReportInfo' - + TceMappingInfo: + type: object + properties: + TceIPAddress: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + TceID: + type: integer + PlmnTarget: + $ref: '#/components/schemas/PlmnId' + TceMappingInfoList: + type: array + items: + $ref: '#/components/schemas/TceMappingInfo' + ResourceType: + type: string + enum: + - PRB + - PRB_UL + - PRB_DL + - RRC + - DRB + ParameterRange: + type: object + properties: + maxValue: + type: integer + minValue: + type: integer #-------- Definition of abstract IOCs -------------------------------------------- RrmPolicy_-Attr: type: object properties: resourceType: - type: string + $ref: '#/components/schemas/ResourceType' rRMPolicyMemberList: $ref: '#/components/schemas/RrmPolicyMemberList' #-------- Definition of concrete IOCs -------------------------------------------- + MnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' + - type: object + properties: + ManagedElement: + $ref: '#/components/schemas/ManagedElement-Multiple' + SubNetwork-Single: allOf: - - $ref: 'genericNrm.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-ncO' + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-ncO' - type: object properties: SubNetwork: @@ -583,6 +655,8 @@ components: $ref: '#/components/schemas/DRACHOptimizationFunction-Single' DMROFunction: $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' DPCIConfigurationFunction: $ref: '#/components/schemas/DPCIConfigurationFunction-Single' CPCIConfigurationFunction: @@ -590,17 +664,21 @@ components: CESManagementFunction: $ref: '#/components/schemas/CESManagementFunction-Single' Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' RimRSGlobal: $ref: '#/components/schemas/RimRSGlobal-Single' + Dynamic5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' + CCOFunction: + $ref: '#/components/schemas/CCOFunction-Single' ManagedElement-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: - $ref: 'genericNRM.yaml#/components/schemas/ManagedElement-Attr' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedElement-ncO' + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedElement-ncO' - type: object properties: GnbDuFunction: @@ -615,6 +693,8 @@ components: $ref: '#/components/schemas/DRACHOptimizationFunction-Single' DMROFunction: $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' DPCIConfigurationFunction: $ref: '#/components/schemas/DPCIConfigurationFunction-Single' CPCIConfigurationFunction: @@ -622,16 +702,18 @@ components: CESManagementFunction: $ref: '#/components/schemas/CESManagementFunction-Single' Configurable5QISet: - $ref: '5gcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Configurable5QISet-Multiple' + Dynamic5QISet: + $ref: 'TS28541_5GcNrm.yaml#/components/schemas/Dynamic5QISet-Multiple' GnbDuFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: gnbDuId: @@ -644,7 +726,7 @@ components: $ref: '#/components/schemas/GnbIdLength' rimRSReportConf: $ref: '#/components/schemas/RimRSReportConf' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: RRMPolicyRatio: @@ -659,14 +741,35 @@ components: $ref: '#/components/schemas/EP_F1C-Single' EP_F1U: $ref: '#/components/schemas/EP_F1U-Multiple' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + OperatorDU: + $ref: '#/components/schemas/OperatorDu-Multiple' + + OperatorDu-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + gnbId: + $ref: '#/components/schemas/GnbId' + gnbIdLength: + $ref: '#/components/schemas/GnbIdLength' + - type: object + properties: + EP_F1C: + $ref: '#/components/schemas/EP_F1C-Single' + EP_F1U: + $ref: '#/components/schemas/EP_F1U-Multiple' + GnbCuUpFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: gnbId: @@ -678,8 +781,10 @@ components: plmnInfoList: $ref: '#/components/schemas/PlmnInfoList' configurable5QISetRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: RRMPolicyRatio: @@ -698,12 +803,12 @@ components: $ref: '#/components/schemas/EP_S1U-Multiple' GnbCuCpFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: gnbId: @@ -721,16 +826,22 @@ components: x2WhiteList: $ref: '#/components/schemas/GGnbIdList' xnWhiteList: - $ref: '#/components/schemas/GGnbIdList ' - xnHOBlackList: - $ref: '#/components/schemas/GGnbIdList ' - x2HOBlackList: + $ref: '#/components/schemas/GGnbIdList' + x2XnHOBlackList: $ref: '#/components/schemas/GEnbIdList' mappingSetIDBackhaulAddress: $ref: '#/components/schemas/MappingSetIDBackhaulAddress' + tceMappingInfoList: + $ref: '#/components/schemas/TceMappingInfoList' configurable5QISetRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dynamic5QISetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + dCHOControl: + type: boolean + dDAPSHOControl: + type: boolean + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: RRMPolicyRatio: @@ -751,19 +862,19 @@ components: $ref: '#/components/schemas/DANRManagementFunction-Single' DESManagementFunction: $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' DMROFunction: $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' NrCellCu-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: cellLocalId: @@ -771,8 +882,8 @@ components: plmnInfoList: $ref: '#/components/schemas/PlmnInfoList' nRFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: RRMPolicyRatio: @@ -787,33 +898,37 @@ components: $ref: '#/components/schemas/EUtranFreqRelation-Multiple' DESManagementFunction: $ref: '#/components/schemas/DESManagementFunction-Single' - DRACHOptimizationFunction: - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' DMROFunction: $ref: '#/components/schemas/DMROFunction-Single' + DLBOFunction: + $ref: '#/components/schemas/DLBOFunction-Single' CESManagementFunction: $ref: '#/components/schemas/CESManagementFunction-Single' + DPCIConfigurationFunction: + $ref: '#/components/schemas/DPCIConfigurationFunction-Single' NrCellDu-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: administrativeState: - $ref: 'genericNRM.yaml#/components/schemas/AdministrativeState' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' operationalState: - $ref: 'genericNRM.yaml#/components/schemas/OperationalState' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' cellLocalId: type: integer cellState: $ref: '#/components/schemas/CellState' plmnInfoList: $ref: '#/components/schemas/PlmnInfoList' + npnIdentityList: + $ref: '#/components/schemas/NpnIdentityList' nrPci: $ref: '#/components/schemas/NrPci' nrTac: @@ -847,65 +962,100 @@ components: nrSectorCarrierRef: type: array items: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' bwpRef: type: array items: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + rimRSMonitoringStartTime: + type: string + rimRSMonitoringStopTime: + type: string + rimRSMonitoringWindowDuration: + type: integer + rimRSMonitoringWindowStartingOffset: + type: integer + rimRSMonitoringWindowPeriodicity: + type: integer + rimRSMonitoringOccasionInterval: + type: integer + rimRSMonitoringOccasionStartingOffset: + type: integer nRFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' victimSetRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' aggressorSetRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: RRMPolicyRatio: $ref: '#/components/schemas/RRMPolicyRatio-Multiple' - DPCIConfigurationFunction: - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' CPCIConfigurationFunction: $ref: '#/components/schemas/CPCIConfigurationFunction-Single' + DRACHOptimizationFunction: + $ref: '#/components/schemas/DRACHOptimizationFunction-Single' + NrOperatorCellDu: + $ref: '#/components/schemas/NrOperatorCellDu-Multiple' + + NrOperatorCellDu-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + cellLocalId: + type: integer + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + plmnInfoList: + $ref: '#/components/schemas/PlmnInfoList' + nrTac: + $ref: '#/components/schemas/NrTac' NRFrequency-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: - absoluteFrequencySSB: - type: integer - minimum: 0 - maximum: 3279165 - ssbSubCarrierSpacing: - $ref: '#/components/schemas/SsbSubCarrierSpacing' - multiFrequencyBandListNR: - type: integer - minimum: 1 - maximum: 256 - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + type: object + properties: + absoluteFrequencySSB: + type: integer + minimum: 0 + maximum: 3279165 + ssbSubCarrierSpacing: + $ref: '#/components/schemas/SsbSubCarrierSpacing' + multiFrequencyBandListNR: + type: integer + minimum: 1 + maximum: 256 EUtranFrequency-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + type: object + properties: + earfcnDL: + type: integer + minimum: 0 + maximum: 262143 + multiBandInfoListEutra: + type: integer + minimum: 1 + maximum: 256 NrSectorCarrier-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: txDirection: @@ -921,20 +1071,20 @@ components: bSChannelBwUL: type: integer sectorEquipmentFunctionRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: CommonBeamformingFunction: $ref: '#/components/schemas/CommonBeamformingFunction-Single' Bwp-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: bwpContext: @@ -949,10 +1099,10 @@ components: type: integer numberOfRBs: type: integer - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' CommonBeamformingFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -971,7 +1121,7 @@ components: $ref: '#/components/schemas/Beam-Multiple' Beam-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1002,7 +1152,7 @@ components: maximum: 1800 RRMPolicyRatio-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1019,7 +1169,7 @@ components: NRCellRelation-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1030,9 +1180,9 @@ components: cellIndividualOffset: $ref: '#/components/schemas/CellIndividualOffset' adjacentNRCellRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - nRFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + nRFreqRelationRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' isRemoveAllowed: type: boolean isHOAllowed: @@ -1041,22 +1191,24 @@ components: $ref: '#/components/schemas/IsESCoveredBy' isENDCAllowed: type: boolean + isMLBAllowed: + type: boolean EUtranCellRelation-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: adjacentEUtranCellRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' NRFreqRelation-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1064,13 +1216,13 @@ components: properties: offsetMO: $ref: '#/components/schemas/QOffsetRangeList' - blackListEntry: + blockListEntry: type: array items: type: integer minimum: 0 maximum: 1007 - blackListEntryIdleMode: + blockListEntryIdleMode: type: integer cellReselectionPriority: type: integer @@ -1116,23 +1268,73 @@ components: tReselectionNRSfMedium: $ref: '#/components/schemas/TReselectionNRSf' nRFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' EUtranFreqRelation-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: - allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' - - type: object - properties: + type: object + properties: + cellIndividualOffset: + $ref: '#/components/schemas/CellIndividualOffset' + blackListEntry: + type: array + items: + type: integer + minimum: 0 + maximum: 1007 + blackListEntryIdleMode: + type: integer + cellReselectionPriority: + type: integer + cellReselectionSubPriority: + type: number + minimum: 0.2 + maximum: 0.8 + multipleOf: 0.2 + pMax: + type: integer + minimum: -30 + maximum: 33 + qOffsetFreq: + $ref: '#/components/schemas/QOffsetFreq' + qQualMin: + type: number + qRxLevMin: + type: integer + minimum: -140 + maximum: -44 + threshXHighP: + type: integer + minimum: 0 + maximum: 62 + threshXHighQ: + type: integer + minimum: 0 + maximum: 31 + threshXLowP: + type: integer + minimum: 0 + maximum: 62 + threshXLowQ: + type: integer + minimum: 0 + maximum: 31 + tReselectionEutran: + type: integer + minimum: 0 + maximum: 7 + tReselectionNRSfHigh: + $ref: '#/components/schemas/TReselectionNRSf' + tReselectionNRSfMedium: + $ref: '#/components/schemas/TReselectionNRSf' eUTranFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' DANRManagementFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1145,7 +1347,7 @@ components: DESManagementFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1162,25 +1364,25 @@ components: esNotAllowedTimePeriod: $ref: "#/components/schemas/EsNotAllowedTimePeriod" interRatEsActivationOriginalCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + $ref: "#/components/schemas/InterRatEsActivationOriginalCellParameters" interRatEsActivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + $ref: "#/components/schemas/InterRatEsActivationCandidateCellParameters" interRatEsDeactivationCandidateCellParameters: - $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + $ref: "#/components/schemas/InterRatEsDeactivationCandidateCellParameters" isProbingCapable: type: string enum: - - yes - - no + - yes + - no energySavingState: type: string enum: - - isNotEnergySaving - - isEnergySaving + - isNotEnergySaving + - isEnergySaving DRACHOptimizationFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1188,15 +1390,15 @@ components: properties: drachOptimizationControl: type: boolean - ueAccProbilityDistPerSSB: - $ref: "#/components/schemas/UeAccProbilityDistPerSSB" - ueAccDelayProbilityDistPerSSB: - $ref: "#/components/schemas/UeAccDelayProbilityDistPerSSB" - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + ueAccProbilityDist: + $ref: "#/components/schemas/UeAccProbilityDist" + ueAccDelayProbilityDist: + $ref: "#/components/schemas/UeAccDelayProbilityDist" + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' DMROFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1204,16 +1406,32 @@ components: properties: dmroControl: type: boolean - maximumDeviationHoTrigger: - $ref: '#/components/schemas/MaximumDeviationHoTrigger' + maximumDeviationHoTriggerLow: + $ref: '#/components/schemas/MaximumDeviationHoTriggerLow' + maximumDeviationHoTriggerHigh: + $ref: '#/components/schemas/MaximumDeviationHoTriggerHigh' minimumTimeBetweenHoTriggerChange: $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' tstoreUEcntxt: $ref: '#/components/schemas/TstoreUEcntxt' + DLBOFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dlboControl: + type: boolean + maximumDeviationHoTrigger: + $ref: '#/components/schemas/MaximumDeviationHoTrigger' + minimumTimeBetweenHoTriggerChange: + $ref: '#/components/schemas/MinimumTimeBetweenHoTriggerChange' DPCIConfigurationFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1226,7 +1444,7 @@ components: CPCIConfigurationFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1239,7 +1457,7 @@ components: CESManagementFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1247,20 +1465,34 @@ components: properties: cesSwitch: type: boolean + intraRatEsActivationOriginalCellLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + intraRatEsActivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsActivationCandidateCellsLoadParameters" + intraRatEsDeactivationCandidateCellsLoadParameters: + $ref: "#/components/schemas/IntraRatEsDeactivationCandidateCellsLoadParameters" + esNotAllowedTimePeriod: + $ref: "#/components/schemas/EsNotAllowedTimePeriod" + interRatEsActivationOriginalCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsActivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" + interRatEsDeactivationCandidateCellParameters: + $ref: "#/components/schemas/IntraRatEsActivationOriginalCellLoadParameters" energySavingControl: type: string enum: - - toBeEnergySaving - - toBeNotEnergySaving + - toBeEnergySaving + - toBeNotEnergySaving energySavingState: type: string enum: - - isNotEnergySaving - - isEnergySaving + - isNotEnergySaving + - isEnergySaving RimRSGlobal-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1277,7 +1509,7 @@ components: RimRSSet-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: @@ -1287,38 +1519,24 @@ components: $ref: '#/components/schemas/RSSetId' setType: $ref: '#/components/schemas/RSSetType' - rimRSMonitoringStartTime: - type: string - rimRSMonitoringStopTime: - type: string - rimRSMonitoringWindowDuration: - type: integer - rimRSMonitoringWindowStartingOffset: - type: integer - rimRSMonitoringWindowPeriodicity: - type: integer - rimRSMonitoringOccasionInterval: - type: integer - rimRSMonitoringOccasionStartingOffset: - type: integer nRCellDURefs: - $ref: 'genericNRM.yaml#/components/schemas/DnList' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' ExternalGnbDuFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: gnbId: $ref: '#/components/schemas/GnbId' gnbIdLength: $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: EP_F1C: @@ -1327,19 +1545,19 @@ components: $ref: '#/components/schemas/EP_F1U-Multiple' ExternalGnbCuUpFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: gnbId: $ref: '#/components/schemas/GnbId' gnbIdLength: $ref: '#/components/schemas/GnbIdLength' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: EP_E1: @@ -1350,13 +1568,13 @@ components: $ref: '#/components/schemas/EP_XnU-Multiple' ExternalGnbCuCpFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - $ref: >- - genericNRM.yaml#/components/schemas/ManagedFunction-Attr + TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr - type: object properties: gnbId: @@ -1365,7 +1583,7 @@ components: $ref: '#/components/schemas/GnbIdLength' plmnId: $ref: '#/components/schemas/PlmnId' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: ExternalNrCellCu: @@ -1378,12 +1596,12 @@ components: $ref: '#/components/schemas/EP_F1C-Multiple' ExternalNrCellCu-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: cellLocalId: @@ -1393,47 +1611,47 @@ components: plmnIdList: $ref: '#/components/schemas/PlmnIdList' nRFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' ExternalENBFunction-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: eNBId: type: integer - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' - type: object properties: ExternalEUTranCell: $ref: '#/components/schemas/ExternalEUTranCell-Multiple' ExternalEUTranCell-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-Attr' - type: object properties: EUtranFrequencyRef: - $ref: 'genericNRM.yaml#/components/schemas/Dn' - - $ref: 'genericNRM.yaml#/components/schemas/ManagedFunction-ncO' + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ManagedFunction-ncO' EP_XnC-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1442,12 +1660,12 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_E1-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1456,12 +1674,12 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_F1C-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1470,12 +1688,12 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_NgC-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1484,12 +1702,12 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_X2C-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1498,12 +1716,12 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_XnU-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1512,40 +1730,46 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_F1U-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: $ref: '#/components/schemas/LocalAddress' remoteAddress: $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + EP_NgU-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: $ref: '#/components/schemas/LocalAddress' remoteAddress: $ref: '#/components/schemas/RemoteAddress' + epTransportRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + EP_X2U-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: @@ -1554,18 +1778,69 @@ components: $ref: '#/components/schemas/RemoteAddress' EP_S1U-Single: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/Top-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' - type: object properties: attributes: allOf: - - $ref: 'genericNRM.yaml#/components/schemas/EP_RP-Attr' + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/EP_RP-Attr' - type: object properties: localAddress: $ref: '#/components/schemas/LocalAddress' remoteAddress: $ref: '#/components/schemas/RemoteAddress' + CCOFunction-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + cCOControl: + type: boolean + cCOWeakCoverageParameters: + $ref: '#/components/schemas/CCOWeakCoverageParameters-Single' + cCOPilotPollutionParameters: + $ref: '#/components/schemas/CCOPilotPollutionParameters-Single' + cCOOvershootCoverageParameters-Single: + $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' + CCOParameters-Attr: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + coverageShapeList: + type: integer + downlinkTransmitPowerRange: + $ref: '#/components/schemas/ParameterRange' + antennaTiltRange: + $ref: '#/components/schemas/ParameterRange' + antennaAzimuthRange: + $ref: '#/components/schemas/ParameterRange' + digitalTiltRange: + $ref: '#/components/schemas/ParameterRange' + digitalAzimuthRange: + $ref: '#/components/schemas/ParameterRange' + + CCOWeakCoverageParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object + + CCOPilotPollutionParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object + + CCOOvershootCoverageParameters-Single: + allOf: + - $ref: '#/components/schemas/CCOParameters-Attr' + - type: object #-------- Definition of JSON arrays for name-contained IOCs ---------------------- @@ -1581,6 +1856,10 @@ components: type: array items: $ref: '#/components/schemas/GnbDuFunction-Single' + OperatorDu-Multiple: + type: array + items: + $ref: '#/components/schemas/OperatorDu-Single' GnbCuUpFunction-Multiple: type: array items: @@ -1594,6 +1873,12 @@ components: type: array items: $ref: '#/components/schemas/NrCellDu-Single' + + NrOperatorCellDu-Multiple: + type: array + items: + $ref: '#/components/schemas/NrOperatorCellDu-Single' + NrCellCu-Multiple: type: array items: @@ -1720,15 +2005,19 @@ components: resources-nrNrm: oneOf: + - $ref: '#/components/schemas/MnS' + - $ref: '#/components/schemas/SubNetwork-Single' - $ref: '#/components/schemas/ManagedElement-Single' - $ref: '#/components/schemas/GnbDuFunction-Single' - $ref: '#/components/schemas/GnbCuUpFunction-Single' - $ref: '#/components/schemas/GnbCuCpFunction-Single' + - $ref: '#/components/schemas/OperatorDu-Single' - $ref: '#/components/schemas/NrCellCu-Single' - $ref: '#/components/schemas/NrCellDu-Single' + - $ref: '#/components/schemas/NrOperatorCellDu-Single' - $ref: '#/components/schemas/NRFrequency-Single' - $ref: '#/components/schemas/EUtranFrequency-Single' @@ -1748,10 +2037,11 @@ components: - $ref: '#/components/schemas/DESManagementFunction-Single' - $ref: '#/components/schemas/DRACHOptimizationFunction-Single' - $ref: '#/components/schemas/DMROFunction-Single' + - $ref: '#/components/schemas/DLBOFunction-Single' - $ref: '#/components/schemas/DPCIConfigurationFunction-Single' - $ref: '#/components/schemas/CPCIConfigurationFunction-Single' - $ref: '#/components/schemas/CESManagementFunction-Single' - + - $ref: '#/components/schemas/RimRSGlobal-Single' - $ref: '#/components/schemas/RimRSSet-Single' @@ -1772,3 +2062,7 @@ components: - $ref: '#/components/schemas/EP_NgU-Single' - $ref: '#/components/schemas/EP_X2U-Single' - $ref: '#/components/schemas/EP_S1U-Single' + - $ref: '#/components/schemas/CCOFunction-Single' + - $ref: '#/components/schemas/CCOWeakCoverageParameters-Single' + - $ref: '#/components/schemas/CCOPilotPollutionParameters-Single' + - $ref: '#/components/schemas/CCOOvershootCoverageParameters-Single' diff --git a/OpenAPI/TS28541_SliceNrm.yaml b/OpenAPI/TS28541_SliceNrm.yaml new file mode 100755 index 0000000000000000000000000000000000000000..2ea8a2b41973b2b6806e8982a56e4dbc1ae7717b --- /dev/null +++ b/OpenAPI/TS28541_SliceNrm.yaml @@ -0,0 +1,827 @@ +openapi: 3.0.1 +info: + title: Slice NRM + version: 17.7.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; 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 + SynAvailability: + type: string + enum: + - NOT SUPPORTED + - BETWEEN BS AND UE + - BETWEEN BS AND UE & UE AND UE + PositioningAvailability: + type: array + items: + type: string + enum: + - CIDE-CID + - OTDOA + - RF FINGERPRINTING + - AECID + - HYBRID POSITIONING + - NET-RTK + Predictionfrequency: + type: string + enum: + - PERSEC + - PERMIN + - PERHOUR + SharingLevel: + type: string + enum: + - SHARED + - NON-SHARED + + NetworkSliceSharingIndicator: + type: string + enum: + - SHARED + - NON-SHARED + + ServiceType: + type: string + enum: + - eMBB + - RLLC + - MIoT + - V2X + SliceSimultaneousUse: + type: string + enum: + - ZERO + - ONE + - TWO + - THREE + - FOUR + 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 + XLThpt: + 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 + MaxNumberofPDUSessions: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nOofPDUSessions: + type: integer + KPIMonitoring: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + kPIList: + type: string + NBIoT: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + RadioSpectrum: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + nROperatingBands: + type: string + Synchronicity: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + SynchronicityRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/SynAvailability' + accuracy: + $ref: '#/components/schemas/Float' + Positioning: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + PositioningRANSubnet: + type: object + properties: + availability: + $ref: '#/components/schemas/PositioningAvailability' + predictionfrequency: + $ref: '#/components/schemas/Predictionfrequency' + accuracy: + $ref: '#/components/schemas/Float' + 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 + EmbbEEPerfReq: + type: object + properties: + kpiType: + type: string + enum: + - NUMOFBITS + - NUMOFBITS_RANBASED + req: + type: number + UrllcEEPerfReq: + type: object + properties: + kpiType: + type: string + enum: + - INVOFLATENCY + - NUMOFBITS_MULTIPLIED_INVOFLATENCY + req: + type: number + MIoTEEPerfReq: + type: object + properties: + kpiType: + type: string + enum: + - MAXREGSUBS + - MEANACTIVEUES + req: + type: number + EEPerfReq: + oneOf: + - $ref: '#/components/schemas/EmbbEEPerfReq' + - $ref: '#/components/schemas/UrllcEEPerfReq' + - $ref: '#/components/schemas/MIoTEEPerfReq' + EnergyEfficiency: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + performance: + $ref: '#/components/schemas/EEPerfReq' + NSSAASupport: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + support: + $ref: '#/components/schemas/Support' + SecFunc: + type: object + properties: + secFunId: + type: string + secFunType: + type: string + secRules: + type: array + items: + type: string + N6Protection: + type: object + properties: + servAttrCom: + $ref: '#/components/schemas/ServAttrCom' + secFuncList: + type: array + items: + $ref: '#/components/schemas/SecFunc' + + CNSliceSubnetProfile: + type: object + properties: + maxNumberofUEs: + type: integer + dLLatency: + type: number + uLLatency: + type: number + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + maxNumberOfPDUSessions: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + reliability: + type: number + energyEfficiency: + type: number + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: number + nssaaSupport: + $ref: '#/components/schemas/NSSAASupport' + n6Protection: + $ref: '#/components/schemas/N6Protection' + RANSliceSubnetProfile: + type: object + properties: + coverageAreaTAList: + type: integer + dLLatency: + type: number + uLLatency: + type: number + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + maxNumberofUEs: + type: integer + activityFactor: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uESpeed: + type: integer + reliability: + type: number + serviceType: + $ref: '#/components/schemas/ServiceType' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + nROperatingBands: + type: string + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/PositioningRANSubnet' + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + type: number + termDensity: + $ref: '#/components/schemas/TermDensity' + survivalTime: + type: number + synchronicity: + $ref: '#/components/schemas/SynchronicityRANSubnet' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + TopSliceSubnetProfile: + type: object + properties: + dLLatency: + type: integer + uLLatency: + type: integer + maxNumberofUEs: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + type: integer + uLMaxPktSize: + type: integer + maxNumberOfPDUSessions: + type: integer + nROperatingBands: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + $ref: '#/components/schemas/EnergyEfficiency' + synchronicity: + $ref: '#/components/schemas/Synchronicity' + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + positioning: + $ref: '#/components/schemas/Positioning' + termDensity: + $ref: '#/components/schemas/TermDensity' + activityFactor: + type: integer + coverageAreaTAList: + type: integer + resourceSharingLevel: + $ref: '#/components/schemas/SharingLevel' + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + uESpeed: + type: integer + reliability: + type: number + serviceType: + $ref: '#/components/schemas/ServiceType' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + survivalTime: + type: number + + ServiceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + maxNumberofUEs: + type: number + dLLatency: + type: number + uLLatency: + type: number + uEMobilityLevel: + $ref: '#/components/schemas/MobilityLevel' + sst: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/Sst' + networkSliceSharingIndicator: + $ref: '#/components/schemas/NetworkSliceSharingIndicator' + availability: + type: number + delayTolerance: + $ref: '#/components/schemas/DelayTolerance' + dLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + uLDeterministicComm: + $ref: '#/components/schemas/DeterministicComm' + dLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + dLThptPerUE: + $ref: '#/components/schemas/XLThpt' + uLThptPerSlice: + $ref: '#/components/schemas/XLThpt' + uLThptPerUE: + $ref: '#/components/schemas/XLThpt' + dLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + uLMaxPktSize: + $ref: '#/components/schemas/MaxPktSize' + maxNumberofPDUSessions: + $ref: '#/components/schemas/MaxNumberofPDUSessions' + kPIMonitoring: + $ref: '#/components/schemas/KPIMonitoring' + nBIoT: + $ref: '#/components/schemas/NBIoT' + radioSpectrum: + $ref: '#/components/schemas/RadioSpectrum' + synchronicity: + $ref: '#/components/schemas/Synchronicity' + positioning: + $ref: '#/components/schemas/Positioning' + 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: number + reliability: + type: number + maxDLDataVolume: + type: string + maxULDataVolume: + type: string + sliceSimultaneousUse: + $ref: '#/components/schemas/SliceSimultaneousUse' + energyEfficiency: + $ref: '#/components/schemas/EnergyEfficiency' + nssaaSupport: + $ref: '#/components/schemas/NSSAASupport' + n6Protection: + $ref: '#/components/schemas/N6Protection' + SliceProfile: + type: object + properties: + serviceProfileId: + type: string + plmnInfoList: + $ref: 'TS28541_NrNrm.yaml#/components/schemas/PlmnInfoList' + cNSliceSubnetProfile: + $ref: '#/components/schemas/CNSliceSubnetProfile' + rANSliceSubnetProfile: + $ref: '#/components/schemas/RANSliceSubnetProfile' + topSliceSubnetProfile: + $ref: '#/components/schemas/TopSliceSubnetProfile' + + IpAddress: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + + LogicalInterfaceInfo: + type: object + properties: + logicalInterfaceType: + type: string + enum: + - VLAN + - MPLS + - Segment + logicalInterfaceId: + type: string + + ServiceProfileList: + type: array + items: + $ref: '#/components/schemas/ServiceProfile' + + SliceProfileList: + type: array + items: + $ref: '#/components/schemas/SliceProfile' + FeasibilityResult: + description: -> + An attribute which specifies the feasibility check result for the feasibility check job. + type: string + enum: + - FEASIBLE + - INFEASIBLE + InFeasibleReason: + description: -> + An attribute that specifies the additional reason information if the feasibility check result is infeasible.The detailed ENUM value is FFS. + type: string + RecommendedRequirements: + description: -> + An attribute that specifies the recommended network slicing related requirements (i.e. ServiceProfile and SliceProfile information) which can be supported by the MnS producer.. + type: string + ResourceReservation: + description: -> + An attribute represents MnS consumer's requirements for resource reservation. + type: boolean + RequestedReservationExpiration: + description: -> + An attribute which specifes MnS consuner's requirements for the validity period of the resource reservation. + type: string + ResourceReservationStatus: + description: -> + An attribute which specifies the resource reservation result for the feasibility check job. + type: string + enum: + - RESERVED + - UNRESERVED + - USED + ReservationExpiration: + description: -> + An attribute which specifes the actual validity period of the resource reservation.. + type: string + ReservationFailureReason: + description: -> + An attribute that specifies the additional reason information if the reservation is failed. + type: string + + + +#------------ Definition of concrete IOCs ---------------------------------------- + + MnS: + oneOf: + - type: object + properties: + SubNetwork: + $ref: '#/components/schemas/SubNetwork-Multiple' +# - type: object +# properties: +# ManagedElement: +# $ref: '#/components/schemas/ManagedElement-Multiple' + + SubNetwork-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/SubNetwork-Attr' + - $ref: 'TS28623_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' + NetworkSliceSubnetProviderCapabilities: + $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Multiple' + FeasibilityCheckJob: + $ref: '#/components/schemas/FeasibilityCheckJob-Multiple' + + + NetworkSlice-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + networkSliceSubnetRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + serviceProfileList: + $ref: '#/components/schemas/ServiceProfileList' + + NetworkSliceSubnet-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + allOf: + - type: object + properties: + managedFunctionRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + networkSliceSubnetRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + nsInfo: + $ref: '#/components/schemas/NsInfo' + sliceProfileList: + $ref: '#/components/schemas/SliceProfileList' + epTransportRefList: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + priorityLabel: + type: integer + networkSliceSubnetType: + type: string + enum: + - TOP_SLICESUBNET + - RAN_SLICESUBNET + - CN_SLICESUBNET + + EP_Transport-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + ipAddress: + $ref: '#/components/schemas/IpAddress' + logicalInterfaceInfo: + $ref: '#/components/schemas/LogicalInterfaceInfo' + nextHopInfo: + type: string + qosProfile: + type: string + epApplicationRefs: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + + NetworkSliceSubnetProviderCapabilities-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dLlatency: + type: integer + uLlatency: + type: integer + dLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + uLThptPerSliceSubnet: + $ref: '#/components/schemas/XLThpt' + coverageAreaTAIList: + type: array + items: + type: string + FeasibilityCheckJob-Single: + allOf: + - $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + profile: + oneOf: + - $ref: '#/components/schemas/SliceProfile' + - $ref: '#/components/schemas/ServiceProfile' + resourceReservation: + $ref: '#/components/schemas/ResourceReservation' + requestedReservationExpiration: + $ref: '#/components/schemas/RequestedReservationExpiration' + processMonitor: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/ProcessMonitor' + feasibilityResult: + $ref: '#/components/schemas/FeasibilityResult' + inFeasibleReason: + $ref: '#/components/schemas/InFeasibleReason' + resourceReservationStatus: + $ref: '#/components/schemas/ResourceReservationStatus' + reservationFailureReason: + $ref: '#/components/schemas/ReservationFailureReason' + + reservationExpiration: + $ref: '#/components/schemas/ReservationExpiration' + recommendedRequirements: + $ref: '#/components/schemas/RecommendedRequirements' + +#-------- 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' + + NetworkSliceSubnetProviderCapabilities-Multiple: + type: array + items: + $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Single' + FeasibilityCheckJob-Multiple: + type: array + items: + $ref: '#/components/schemas/FeasibilityCheckJob-Single' + +#------------ Definitions in TS 28.541 for TS 28.532 ----------------------------- + + resources-sliceNrm: + oneOf: + - $ref: '#/components/schemas/MnS' + + - $ref: '#/components/schemas/SubNetwork-Single' + - $ref: '#/components/schemas/NetworkSlice-Single' + - $ref: '#/components/schemas/NetworkSliceSubnet-Single' + - $ref: '#/components/schemas/EP_Transport-Single' + - $ref: '#/components/schemas/NetworkSliceSubnetProviderCapabilities-Single' + - $ref: '#/components/schemas/FeasibilityCheckJob-Single' diff --git a/OpenAPI/PerMeasJobCtlMnS.yaml b/OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml old mode 100644 new mode 100755 similarity index 95% rename from OpenAPI/PerMeasJobCtlMnS.yaml rename to OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml index b6abe58b22ae893e3add0f00d1d7417fdcb95ca9..973f2820b95902601ac93fb0876af44d5cf8aa17 --- a/OpenAPI/PerMeasJobCtlMnS.yaml +++ b/OpenAPI/TS28550_PerfMeasJobCtrlMnS.yaml @@ -1,26 +1,23 @@ openapi: 3.0.1 info: title: TS 28.550 Performance Measurement Job Control Service - version: 16.5.0 + version: 17.1.0 description: >- OAS 3.0.1 specification of the Performance Measurement Job Control Service @ 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. externalDocs: - description: 3GPP TS 28.550 V16.5.0; Performance assurance + description: 3GPP TS 28.550 Performance assurance url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.550/ servers: - - url: 'http://{URI-DN-prefix}/{root}/PerfMeasJobCtrlMnS/v1650/{LDN-first-part}' + - url: '{MnSRoot}/PerfMeasJobCtrlMnS/{MnSVersion}' variables: - URI-DN-prefix: - description: See subclause 4.4 of TS 32.158 - default: example.com - root: - description: See subclause 4.4 of TS 32.158 - default: 3GPPManagement - LDN-first-part: - description: See subclause 4.4 of TS 32.158 - default: '' + MnSRoot: + description: See clause 4.4.2 of TS 32.158 + default: http://example.com/3GPPManagement + MnSVersion: + description: Version number of the OpenAPI definition + default: XXX paths: /measJobs: post: diff --git a/OpenAPI/TS28623_ComDefs.yaml b/OpenAPI/TS28623_ComDefs.yaml new file mode 100755 index 0000000000000000000000000000000000000000..b962d1032f47e37769bf31b3709346351b71fd59 --- /dev/null +++ b/OpenAPI/TS28623_ComDefs.yaml @@ -0,0 +1,224 @@ +openapi: 3.0.1 +info: + title: Common Type Definitions + version: 17.1.0 + description: >- + OAS 3.0.1 specification of common type definitions in the Generic NRM + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM; Common type definitions + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + + Float: + type: number + format: float + DateTime: + type: string + format: date-time + Latitude: + type: number + format: float + minimum: -90 + maximum: 90 + Longitude: + type: number + format: float + minimum: -180 + maximum: 180 + + Dn: + type: string + DnList: + type: array + items: + $ref: '#/components/schemas/Dn' + + Mcc: + type: string + pattern: '^[0-9]{3}$' + Mnc: + type: string + pattern: '^[0-9]{2,3}$' + Nid: + type: string + pattern: '^[A-Fa-f0-9]{11}$' + PlmnId: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + UtraCellId: + type: integer + EutraCellId: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + TimeWindow: + type: object + properties: + startTime: + $ref: '#/components/schemas/DateTime' + endTime: + $ref: '#/components/schemas/DateTime' + GeoCoordinate: + type: object + properties: + latitude: + $ref: '#/components/schemas/Latitude' + longitude: + $ref: '#/components/schemas/Longitude' + ConvexGeoPolygon: + type: array + items: + $ref: '#/components/schemas/GeoCoordinate' + GeoAreaToCellMapping: + type: object + properties: + convexGeoPolygon: + $ref: '#/components/schemas/ConvexGeoPolygon' + associationThreshold: + type: integer + AreaOfInterest: + oneOf: + - $ref: '#/components/schemas/GeoAreaToCellMapping' + - type: array + items: + $ref: 'TS28623_GenericNrm.yaml#/components/schemas/Tai' + - type: array + items: + $ref: '#/components/schemas/NrCellId' + - type: array + items: + $ref: '#/components/schemas/EutraCellId' + - type: array + items: + $ref: '#/components/schemas/UtraCellId' + + Fqdn: + type: string + Ipv4Addr: + type: string + 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])$' + example: '198.51.100.1' + Ipv6Addr: + type: string + allOf: + - 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})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + Ipv6Prefix: + type: string + allOf: + - 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])))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' + example: '2001:db8:abcd:12::0/64' + IpAddr: + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + HostAddr: + # This definition will be deprecated, when all occurances of HostAddr + # are replaced by Host. + oneOf: + - $ref: '#/components/schemas/Ipv4Addr' + - $ref: '#/components/schemas/Ipv6Addr' + - $ref: '#/components/schemas/Fqdn' + Host: + oneOf: + - $ref: '#/components/schemas/IpAddr' + - $ref: '#/components/schemas/Fqdn' + Uri: + type: string + + AdministrativeState: + type: string + enum: + - LOCKED + - UNLOCKED + OperationalState: + type: string + enum: + - ENABLED + - DISABLED + UsageState: + type: string + enum: + - IDEL + - ACTIVE + - BUSY + + AttributeNameValuePairSet: + description: >- + The key of this map is the attribute name, and the value the attribute value. + type: object + minProperties: 1 + additionalProperties: + nullable: true + AttributeValueChangeSet: + description: >- + The first array item contains the attribute name value pairs with the new values, + and the second array item the attribute name value pairs with the optional old values. + type: array + items: + $ref: '#/components/schemas/AttributeNameValuePairSet' + minItems: 1 + maxItems: 2 + + Filter: + description: >- + The filter format shall be compliant to XPath 1.0. + type: string + SystemDN: + type: string + + NotificationId: + type: integer + NotificationType: + oneOf: + - $ref: 'TS28532_FaultMnS.yaml#/components/schemas/AlarmNotificationTypes' + - $ref: 'TS28532_ProvMnS.yaml#/components/schemas/CmNotificationTypes' + - $ref: 'TS28532_PerfMnS.yaml#/components/schemas/PerfNotificationTypes' + - $ref: 'TS28532_HeartbeatNtf.yaml#/components/schemas/HeartbeatNotificationTypes' + - $ref: 'TS28532_FileDataReportingMnS.yaml#/components/schemas/FileNotificationTypes' + NotificationHeader: + type: object + properties: + href: + $ref: '#/components/schemas/Uri' + notificationId: + $ref: '#/components/schemas/NotificationId' + notificationType: + $ref: '#/components/schemas/NotificationType' + eventTime: + $ref: '#/components/schemas/DateTime' + systemDN: + $ref: '#/components/schemas/SystemDN' + required: + - href + - notificationId + - notificationType + - eventTime + - systemDN + + ErrorResponse: + description: >- + Default schema for the response message body in case the request + is not successful. + type: object + properties: + error: + type: object + properties: + errorInfo: + type: string diff --git a/OpenAPI/TS28623_GenericNrm.yaml b/OpenAPI/TS28623_GenericNrm.yaml new file mode 100755 index 0000000000000000000000000000000000000000..adfc72fd66f1a45414370888c8a627baa67bc801 --- /dev/null +++ b/OpenAPI/TS28623_GenericNrm.yaml @@ -0,0 +1,2123 @@ +openapi: 3.0.1 +info: + title: Generic NRM + version: 17.1.0 + description: >- + OAS 3.0.1 definition of the Generic NRM + © 2022, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 28.623; Generic NRM + url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ +paths: {} +components: + schemas: + +#-------- Definition of types----------------------------------------------------- + + RegistrationState: + type: string + enum: + - REGISTERED + - DEREGISTERED + VnfParameter: + type: object + properties: + vnfInstanceId: + type: string + vnfdId: + type: string + flavourId: + type: string + autoScalable: + type: boolean + PeeParameter: + type: object + properties: + siteIdentification: + type: string + siteDescription: + type: string + siteLatitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Latitude' + siteLongitude: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Longitude' + siteAltitude: + type: number + format: float + equipmentType: + type: string + environmentType: + type: string + powerInterface: + type: string + ThresholdInfo: + type: object + properties: + thresholdDirection: + type: string + enum: + - UP + - DOWN + - UP_AND_DOWN + thresholdValue: + oneOf: + - type: integer + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Float' + hysteresis: + oneOf: + - type: integer + minimum: 0 + - type: number + format: float + minimum: 0 + Operation: + type: object + properties: + name: + type: string + allowedNFTypes: + $ref: '#/components/schemas/NFType' + operationSemantics: + $ref: '#/components/schemas/OperationSemantics' + NFType: + type: string + description: ' NF name defined in TS 23.501' + enum: + - NRF + - UDM + - AMF + - SMF + - AUSF + - NEF + - PCF + - SMSF + - NSSF + - UDR + - LMF + - GMLC + - 5G_EIR + - SEPP + - UPF + - N3IWF + - AF + - UDSF + - DN + OperationSemantics: + type: string + enum: + - REQUEST_RESPONSE + - SUBSCRIBE_NOTIFY + SAP: + type: object + properties: + host: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/HostAddr' + port: + type: integer + NFServiceType: + type: string + enum: + - Namf_Communication + - Namf_EventExposure + - Namf_MT + - Namf_Location + - Nsmf_PDUSession + - Nsmf_EventExposure + - Others + TransportProtocol: + anyOf: + - type: string + enum: + - TCP + - type: string + SupportedPerfMetricGroup: + type: object + properties: + performanceMetrics: + type: array + items: + type: string + granularityPeriods: + type: array + items: + type: integer + minimum: 1 + reportingMethods: + type: array + items: + type: string + enum: + - FILE_BASED_LOC_SET_BY_PRODUCER + - FILE_BASED_LOC_SET_BY_CONSUMER + - STREAM_BASED + monitorGranularityPeriods: + type: array + items: + type: integer + minimum: 1 + ReportingCtrl: + oneOf: + - type: object + properties: + fileReportingPeriod: + type: integer + - type: object + properties: + fileReportingPeriod: + type: integer + fileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + - type: object + properties: + streamTarget: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + Scope: + type: object + properties: + scopeType: + type: string + enum: + - BASE_ONLY + - BASE_ALL + - BASE_NTH_LEVEL + - BASE_SUBTREE + scopeLevel: + type: integer + ProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type without specialisations. + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - PARTIALLY_FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + timer: + type: integer + FileDownloadJobProcessMonitor: + description: >- + This data type is the "ProcessMonitor" data type with specialisations + for usage in the "FileDownloadJob". + type: object + properties: + jobId: + type: string + status: + type: string + enum: + - NOT_STARTED + - RUNNING + - FINSHED + - FAILED + - CANCELLING + - CANCELLED + progressPercentage: + type: integer + minimum: 0 + maximum: 100 + progressStateInfo: + type: string + resultStateInfo: + oneOf: + - type: string + enum: + - NULL + - UNKNOWN + - NO_STORAGE + - LOW_MEMROY + - NO_CONNECTION_TO_REMOTE_SERVER + - FILE_NOT_AVAILABLE + - DNS_CANNOT_BE_RESOLVED + - TIMER_EXPIRED + - OTHER + - type: string + startTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + endTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + timer: + type: integer + AreaScope: + oneOf: + - type: array + items: + $ref: '#/components/schemas/EutraCellId' + - type: array + items: + $ref: '#/components/schemas/NrCellId' + - type: array + items: + $ref: '#/components/schemas/Tac' + - type: array + items: + $ref: '#/components/schemas/Tai' + Tai: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + tac: + $ref: '#/components/schemas/Tac' + AreaConfig: + type: object + properties: + freqInfo: + $ref: '#/components/schemas/FreqInfo' + pciList: + type: array + items: + type: integer + FreqInfo: + description: specifies the carrier frequency and bands used in a cell. + type: object + properties: + arfcn: + type: integer + freqBands: + type: array + items: + type: integer + MbsfnArea: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 1 + earfcn: + type: integer + minimum: 1 + Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + EutraCellId: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + IpAddr: + oneOf: + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv4Addr' + - $ref: 'TS28623_ComDefs.yaml#/components/schemas/Ipv6Addr' + + ManagementData: + oneOf: + - type: array + items: + type: string + enum: + - COVERAGE + - CAPACITY + - ENERGY_EFFICIENCY + - MOBILITY + - ACCESSIBILITY + - type: array + items: + type: string + NodeFilter: + type: object + properties: + areaOfInterest: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AreaOfInterest' + networkDomain: + type: string + enum: + - CN + - RAN + cpUpType: + type: string + enum: + - CP + - UP + sst: + type: integer + +#-------- Definition of types used in Trace control NRM fragment------------------ + + jobType-Type: + type: string + 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. + enum: + - IMMEDIATE_MDT_ONLY + - LOGGED_MDT_ONLY + - TRACE_ONLY + - IMMEDIATE_MDT AND TRACE + - RLF_REPORT_ONLY + - RCEF_REPORT_ONLY + - LOGGED_MBSFN_MDT + + listOfInterfaces-Type: + description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. + type: object + properties: + MSCServerInterfaces: + type: array + items: + type: string + enum: + - A + - Iu-CS + - Mc + - MAP-G + - MAP-B + - MAP-E + - MAP-F + - MAP-D + - MAP-C + - CAP + MGWInterfaces: + type: array + items: + type: string + enum: + - Mc + - Nb-UP + - Iu-UP + RNCInterfaces: + type: array + items: + type: string + enum: + - Iu-CS + - Iu-PS + - Iur + - Iub + - Uu + SGSNInterfaces: + type: array + items: + type: string + enum: + - Gb + - Iu-PS + - Gn + - MAP-Gr + - MAP-Gd + - MAP-Gf + - Ge + - Gs + - S6d + - S4 + - S3 + - S13 + GGSNInterfaces: + type: array + items: + type: string + enum: + - Gn + - Gi + - Gmb + S-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Mg + - Mr + - Mi + P-CSCFInterfaces: + type: array + items: + type: string + enum: + - Gm + - Mw + I-CSCFInterfaces: + type: array + items: + type: string + enum: + - Cx + - Dx + - Mg + - Mw + MRFCInterfaces: + type: array + items: + type: string + enum: + - Mp + - Mr + MGCFInterfaces: + type: array + items: + type: string + enum: + - Mg + - Mj + - Mn + IBCFInterfaces: + type: array + items: + type: string + enum: + - Ix + - Mx + E-CSCFInterfaces: + type: array + items: + type: string + enum: + - Mw + - Ml + - Mm + - Mi/Mg + BGCFInterfaces: + type: array + items: + type: string + enum: + - Mi + - Mj + - Mk + ASInterfaces: + type: array + items: + type: string + enum: + - Dh + - Sh + - ISC + - Ut + HSSInterfaces: + type: array + items: + type: string + enum: + - MAP-C + - MAP-D + - Gc + - Gr + - Cx + - S6d + - S6a + - Sh + - N70 + - N71 + - NU1 + EIRInterfaces: + type: array + items: + type: string + enum: + - MAP-F + - S13 + - MAP-Gf + BM-SCInterfaces: + type: array + items: + type: string + enum: + - Gmb + MMEInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - S3 + - S6a + - S10 + - S11 + - S13 + SGWInterfaces: + type: array + items: + type: string + enum: + - S4 + - S5 + - S8 + - S11 + - Gxc + PDN_GWInterfaces: + type: array + items: + type: string + enum: + - S2a + - S2b + - S2c + - S5 + - S6b + - Gx + - S8 + - SGi + eNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + en-gNBInterfaces: + type: array + items: + type: string + enum: + - S1-MME + - X2 + - Uu + - F1-C + - E1 + AMFInterfaces: + type: array + items: + type: string + enum: + - N1 + - N2 + - N8 + - N11 + - N12 + - N14 + - N15 + - N20 + - N22 + - N26 + AUSFInterfaces: + type: array + items: + type: string + enum: + - N12 + - N13 + NEFInterfaces: + type: array + items: + type: string + enum: + - N29 + - N30 + - N33 + NRFInterfaces: + type: array + items: + type: string + enum: + - N27 + NSSFInterfaces: + type: array + items: + type: string + enum: + - N22 + - N31 + PCFInterfaces: + type: array + items: + type: string + enum: + - N5 + - N7 + - N15 + SMFInterfaces: + type: array + items: + type: string + enum: + - N4 + - N7 + - N10 + - N11 + - S5-C + SMSFInterfaces: + type: array + items: + type: string + enum: + - N20 + - N21 + UDMInterfaces: + type: array + items: + type: string + enum: + - N8 + - N10 + - N13 + - N21 + - NU1 + UPFInterfaces: + type: array + items: + type: string + enum: + - N4 + ng-eNBInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + gNB-CU-CPInterfaces: + type: array + items: + type: string + enum: + - NG-C + - Xn-C + - Uu + - F1-C + - E1 + - X2-C + gNB-CU-UPInterfaces: + type: array + items: + type: string + enum: + - E1 + gNB-DUInterfaces: + type: array + items: + type: string + enum: + - F1-C + + listOfNeTypes-Type: + description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. + type: array + items: + type: string + enum: + - MSC_SERVER + - SGSN + - MGW + - GGSN + - RNC + - BM_SC + - MME + - SGW + - PGW + - ENB + - EN_GNB + - GNB_CU_CP + - GNB_CU_UP + - GNB_DU + - AMF + - PCF + - SMF + - UPF + - AUSF + - SMSF + - HSS + - UDM + + plmnTarget-Type: + type: object + 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. + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + required: + - mcc + - mnc + + traceDepth-Type: + 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. + type: string + enum: + - MINIMUM + - MEDIUM + - MAXIMUM + - VENDORMINIMUM + - VENDORMEDIUM + - VENDORMAXIMUM + + traceReference-Type: + type: object + 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. + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + traceId: + type: string + required: + - mcc + - mnc + - traceId + + traceReportingFormat-Type: + type: string + 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. + enum: + - FILE-BASED + - STREAMING + + traceTarget-Type: + type: object + description: Trace target conveying both the type and value of the target ID. For additional details see 3GPP TS 32.422 + properties: + TargetIdType: + type: string + enum: + - IMSI + - IMEI + - IMEISV + - PUBLIC_ID + - UTRAN_CELL + - E-UTRAN_CELL + - NG-RAN_CELL + - eNB + - RNC + - gNB + - SUPI + TargetIdValue: + type: string + required: + - TargetIdType + - TargetIdValue + + triggeringEvents-Type: + type: object + 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. + properties: + MSC_SERVER: + type: array + items: + type: string + enum: + - MO_MT_CALLS + - MO_MT_SMS + - LU_IMSIattach_IMSIdetach + - HANDOVER + - SS + SGSN: + type: array + items: + type: string + enum: + - PDPcontext + - MO_MT_SMS + - RAU_GPRSattach_GPRSdetach + - MBMScontext + MGW: + type: array + items: + type: string + enum: + - CONTEXT + GGSN: + type: array + items: + type: string + enum: + - PDPcontext + - MBMScontext + IMS: + type: array + items: + type: string + enum: + - SIPsession_StandaloneTransaction + BM_SC: + type: array + items: + type: string + enum: + - MBMSactivation + MME: + type: array + items: + type: string + enum: + - UEinitiatedPDNconnectivityRequest + - ServiceRequest + - InitialAttach_TAU_Detach + - UEinitiatedPDNdisconnection + - BearerActivationModificationDeletion + - Handover + SGW: + type: array + items: + type: string + enum: + - PDNconnectionCreation + - PDNconnectionTermination + - BearerActivationModificationDeletion + PGW: + type: array + items: + type: string + enum: + - PDNconnectionCreation + - PDNconnectionTermination + - BearerActivationModificationDeletion + AMF: + type: array + items: + type: string + enum: + - Registration + - ServiceRequest + - Handover + - UEderegistration + - NetworkDeregistration + - UEMobilityFromEPC + - UEMobilityToEPC + SMF: + type: array + items: + type: string + enum: + - PDUsessionEstablishment + - PDUsessionModification + - PDUsessionRelease + - PDUsessionUPactivationDeactivation + - MobilityBtw3gppAndN3gppTo5GC + - MobilityFromEpc + PCF: + type: array + items: + type: string + enum: + - AMpolicy + - SMpolicy + - Authorization + - BDTpolicy + UPF: + type: array + items: + type: string + enum: + - N4Session + AUSF: + type: array + items: + type: string + enum: + - UEauthentication + NEF: + type: array + items: + type: string + enum: + - EventExposure + - PFDmanagement + - ParameterProvision + - Trigger + NRF: + type: array + items: + type: string + enum: + - NFmanagement + - NFdiscovery + NSSF: + type: array + items: + type: string + enum: + - NSSelection + - NSSAI + SMSF: + type: array + items: + type: string + enum: + - SMservice + UDM: + type: array + items: + type: string + enum: + - UEcontext + - SubscriberData + - UEauthentication + - EventExposure + + anonymizationOfMdtData-Type: + description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. + type: string + enum: + - NO_IDENTITY + - TAC_OF_IMEI + + beamLevelMeasurement-Type: + description: Determines whether beam level measurements shall be included in case of immediate MDT M1 measurement in NR. For additional details see 3GPP TS 32.422 clause 5.10.40. + type: boolean + + collectionPeriodRrmLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.20. + type: string + enum: + - 100ms + - 1000ms + - 1024ms + - 1280ms + - 2048ms + - 2560ms + - 5120ms + - 10000ms + - 10240ms + - 60000ms + + collectionPeriodM6Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.32. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + + collectionPeriodM7Lte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.33. + type: integer + minimum: 1 + maximum: 60 + + collectionPeriodRrmUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.21. + type: string + enum: + - 100ms + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + + collectionPeriodRrmNr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.30. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + + collectionPeriodM6Nr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.34. + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 20480ms + - 40960ms + - 1min + - 6min + - 12min + - 30min + + collectionPeriodM7Nr-Type: + description: See details in 3GPP TS 32.422 clause 5.10.35. + type: integer + minimum: 1 + maximum: 60 + + eventListForEventTriggeredMeasurement-Type: + description: See details in 3GPP TS 32.422 clause 5.10.28. + type: string + enum: + - OUT_OF_COVERAGE + - A2_EVENT + + eventThreshold-Type: + description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. + type: object + properties: + EventThresholdRSRP: + oneOf: + - type: integer + minimum: 0 + maximum: 97 + - type: integer + minimum: 0 + maximum: 127 + EventThresholdRSRQ: + oneOf: + - type: integer + minimum: 0 + maximum: 34 + - type: integer + minimum: 0 + maximum: 127 + EventThreshold1F: + type: object + properties: + CPICH_RSCP: + type: integer + minimum: -120 + maximum: 25 + CPICH_EcNo: + type: integer + minimum: -24 + maximum: 0 + PathLoss: + type: integer + minimum: 30 + maximum: 165 + EventThreshold1I: + type: integer + minimum: -120 + maximum: 25 + + listOfMeasurements-Type: + description: See details in 3GPP TS 32.422 clause 5.10.3 for details. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6_DL + - M6_UL + - M7_DL + - M7_UL + LTE: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M1_EVENT_TRIGGERED + - M6 + - M7 + - M8 + - M9 + NR: + type: array + items: + type: string + enum: + - M1 + - M2 + - M3 + - M4 + - M5 + - M6 + - M7 + - M1_EVENT_TRIGGERED + - M8 + - M9 + + loggingDuration-Type: + description: See details in 3GPP TS 32.422 clause 5.10.9. + type: string + enum: + - 600s + - 1200s + - 2400s + - 3600s + - 5400s + - 7200s + + loggingInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.8. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + LTE: + type: array + items: + type: string + enum: + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + NR: + type: array + items: + type: string + enum: + - 0.32s + - 0.64s + - 1.28s + - 2.56s + - 5.12s + - 10.24s + - 20.48s + - 30.72s + - 40.96s + - 61.44s + - INFINITY + + eventThresholdL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.X. + type: object + properties: + RSRP: + type: integer + minimum: 0 + maximum: 127 + RSRQ: + type: integer + minimum: 0 + maximum: 127 + + hysteresisL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.Y. + type: integer + minimum: 0 + maximum: 30 + + timeToTriggerL1-Type: + description: See details in 3GPP TS 32.422 clause 5.10.Z. + type: string + enum: + - 0ms + - 40ms + - 64ms + - 80ms + - 100ms + - 128ms + - 160ms + - 256ms + - 320ms + - 480ms + - 512ms + - 640ms + - 1024ms + - 1280ms + - 2560ms + - 5120ms + + measurementPeriodLte-Type: + description: See details in 3GPP TS 32.422 clause 5.10.23. + type: string + enum: + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 1min + + measurementPeriodUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.22. + type: string + enum: + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + + measurementQuantity-Type: + description: See details in 3GPP TS 32.422 clause 5.10.15. + type: string + enum: + - CPICH_EcNo + - CPICH_RSCP + - PathLoss + + eventThresholdUphUmts-Type: + description: See details in 3GPP TS 32.422 clause 5.10.A. + type: integer + minimum: 0 + maximum: 31 + + plmnList-Type: + description: See details in 3GPP TS 32.422 clause 5.10.24. + type: array + items: + type: object + properties: + mcc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + mnc: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mnc' + required: + - mcc + - mnc + maxItems: 16 + + positioningMethod-Type: + description: See details in 3GPP TS 32.422 clause 5.10.19. + type: string + enum: + - GNSS + - E-CELL_ID + + reportAmount-Type: + description: See details in 3GPP TS 32.422 clause 5.10.6. + type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - INFINITY + + reportingTrigger-Type: + description: See details in 3GPP TS 32.422 clause 5.10.4. + type: array + items: + type: string + enum: + - PERIODICAL + - A2_FOR_LTE_NR + - 1F_FOR_UMTS + - 1I_FOR_UMTS_MCPS_TDD + - A2_TRIGGERED_PERIODIC_FOR_LTE_NR + - ALL_CONFIGURED_RRM_FOR_LTE_NR + - ALL_CONFIGURED_RRM_FOR_UMTS + + reportInterval-Type: + description: See details in 3GPP TS 32.422 clause 5.10.5. + type: object + properties: + UMTS: + type: array + items: + type: string + enum: + - 250ms + - 500ms + - 1000ms + - 2000ms + - 3000ms + - 4000ms + - 6000ms + - 8000ms + - 12000ms + - 16000ms + - 20000ms + - 24000ms + - 28000ms + - 32000ms + - 64000ms + LTE: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + - 3600000ms + NR: + type: array + items: + type: string + enum: + - 120ms + - 240ms + - 480ms + - 640ms + - 1024ms + - 2048ms + - 5120ms + - 10240ms + - 20480ms + - 40960ms + - 60000ms + - 360000ms + - 720000ms + - 1800000ms + + reportType-Type: + description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. + type: string + enum: + - PERIODICAL + - EVENT_TRIGGERED + + sensorInformation-Type: + description: See details in 3GPP TS 32.422 clause 5.10.29. + type: array + items: + type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + + traceCollectionEntityId-Type: + description: See details in 3GPP TS 32.422 clause 5.10.11. Only TCE Id value may be sent over the air to the UE being configured for Logged MDT. + type: integer + + +#-------- end of Definition of types used in Trace control NRM fragment ---------- + + +#-------- Definition of abstract IOC Top ----------------------------------------- + + Top-Attr: + # This definition will be deprecated, when all occurances of Top-Attr + # are replaced by Top. + type: object + properties: + id: + type: string + nullable: true + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + required: + - id + Top: + type: object + properties: + id: + type: string + nullable: true + objectClass: + type: string + objectInstance: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + required: + - id + +#-------- Definition of IOCs with new name-containments defined in other TS ------ + + SubNetwork-Attr: + type: object + properties: + dnPrefix: + type: string + userLabel: + type: string + userDefinedNetworkType: + type: string + setOfMcc: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Mcc' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + ManagedElement-Attr: + type: object + properties: + dnPrefix: + type: string + managedElementTypeList: + type: array + items: + type: string + userLabel: + type: string + locationName: + type: string + managedBy: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + swVersion: + type: string + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + + SubNetwork-ncO: + type: object + properties: + ManagementNode: + $ref: '#/components/schemas/ManagementNode-Multiple' + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + MeContext: + $ref: '#/components/schemas/MeContext-Multiple' + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + ManagementDataCollection: + $ref: '#/components/schemas/ManagementDataCollection-Multiple' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + FileDownloadJob: + $ref: '#/components/schemas/FileDownloadJob-Multiple' + Files: + $ref: '#/components/schemas/Files-Multiple' + MnsRegistry: + $ref: '#/components/schemas/MnsRegistry-Single' + ManagedElement-ncO: + type: object + properties: + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + NtfSubscriptionControl: + $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' + AlarmList: + $ref: '#/components/schemas/AlarmList-Single' + FileDownloadJob: + $ref: '#/components/schemas/FileDownloadJob-Multiple' + Files: + $ref: '#/components/schemas/Files-Multiple' + +#-------- Definition of abstract IOCs -------------------------------------------- + + ManagedFunction-Attr: + type: object + properties: + userLabel: + type: string + vnfParametersList: + type: array + items: + $ref: '#/components/schemas/VnfParameter' + peeParametersList: + type: array + items: + $ref: '#/components/schemas/PeeParameter' + priorityLabel: + type: integer + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + supportedTraceMetrics: + type: array + items: + type: string + EP_RP-Attr: + type: object + properties: + userLabel: + type: string + farEndEntity: + type: string + supportedPerfMetricGroups: + type: array + items: + $ref: '#/components/schemas/SupportedPerfMetricGroup' + + TraceJob-Attr: + type: object + description: abstract class used as a container of all TraceJob attributes + properties: + jobType: + $ref: '#/components/schemas/jobType-Type' + listOfInterfaces: + $ref: '#/components/schemas/listOfInterfaces-Type' + listOfNeTypes: + $ref: '#/components/schemas/listOfNeTypes-Type' + plmnTarget: + $ref: '#/components/schemas/plmnTarget-Type' + traceReportingConsumerUri: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + traceCollectionEntityIpAddress: + $ref: '#/components/schemas/IpAddr' + traceDepth: + $ref: '#/components/schemas/traceDepth-Type' + traceReference: + $ref: '#/components/schemas/traceReference-Type' + traceRecordingSessionReference: + type: string + jobId: + type: string + traceReportingFormat: + $ref: '#/components/schemas/traceReportingFormat-Type' + traceTarget: + $ref: '#/components/schemas/traceTarget-Type' + triggeringEvents: + $ref: '#/components/schemas/triggeringEvents-Type' + anonymizationOfMdtData: + $ref: '#/components/schemas/anonymizationOfMdtData-Type' + areaConfigurationForNeighCell: + $ref: '#/components/schemas/AreaConfig' + areaScope: + type: array + items: + $ref: '#/components/schemas/AreaScope' + beamLevelMeasurement: + $ref: '#/components/schemas/beamLevelMeasurement-Type' + collectionPeriodRrmLte: + $ref: '#/components/schemas/collectionPeriodRrmLte-Type' + collectionPeriodM6Lte: + $ref: '#/components/schemas/collectionPeriodM6Lte-Type' + collectionPeriodM7Lte: + $ref: '#/components/schemas/collectionPeriodM7Lte-Type' + collectionPeriodRrmUmts: + $ref: '#/components/schemas/collectionPeriodRrmUmts-Type' + collectionPeriodRrmNr: + $ref: '#/components/schemas/collectionPeriodRrmNr-Type' + collectionPeriodM6Nr: + $ref: '#/components/schemas/collectionPeriodM6Nr-Type' + collectionPeriodM7Nr: + $ref: '#/components/schemas/collectionPeriodM7Nr-Type' + eventListForEventTriggeredMeasurement: + $ref: '#/components/schemas/eventListForEventTriggeredMeasurement-Type' + eventThreshold: + $ref: '#/components/schemas/eventThreshold-Type' + listOfMeasurements: + $ref: '#/components/schemas/listOfMeasurements-Type' + loggingDuration: + $ref: '#/components/schemas/loggingDuration-Type' + loggingInterval: + $ref: '#/components/schemas/loggingInterval-Type' + eventThresholdL1: + $ref: '#/components/schemas/eventThresholdL1-Type' + hysteresisL1: + $ref: '#/components/schemas/hysteresisL1-Type' + timeToTriggerL1: + $ref: '#/components/schemas/timeToTriggerL1-Type' + mbsfnAreaList: + type: array + items: + $ref: '#/components/schemas/MbsfnArea' + measurementPeriodLte: + $ref: '#/components/schemas/measurementPeriodLte-Type' + measurementPeriodUmts: + $ref: '#/components/schemas/measurementPeriodUmts-Type' + measurementQuantity: + $ref: '#/components/schemas/measurementQuantity-Type' + eventThresholdUphUmts: + $ref: '#/components/schemas/eventThresholdUphUmts-Type' + plmnList: + $ref: '#/components/schemas/plmnList-Type' + positioningMethod: + $ref: '#/components/schemas/positioningMethod-Type' + reportAmount: + $ref: '#/components/schemas/reportAmount-Type' + reportingTrigger: + $ref: '#/components/schemas/reportingTrigger-Type' + reportInterval: + $ref: '#/components/schemas/reportInterval-Type' + reportType: + $ref: '#/components/schemas/reportType-Type' + sensorInformation: + $ref: '#/components/schemas/sensorInformation-Type' + traceCollectionEntityId: + $ref: '#/components/schemas/traceCollectionEntityId-Type' + + ManagedFunction-ncO: + type: object + properties: + PerfMetricJob: + $ref: '#/components/schemas/PerfMetricJob-Multiple' + ThresholdMonitor: + $ref: '#/components/schemas/ThresholdMonitor-Multiple' + ManagedNFService: + $ref: '#/components/schemas/ManagedNFService-Multiple' + TraceJob: + $ref: '#/components/schemas/TraceJob-Multiple' + + MnsRegistry-Single: + type: object + properties: + MnsInfo: + $ref: '#/components/schemas/MnsInfo-Multiple' + + +#-------- Definition of concrete IOCs -------------------------------------------- + + VsDataContainer-Single: + type: object + properties: + id: + type: string + attributes: + type: object + properties: + vsDataType: + type: string + vsDataFormatVersion: + type: string + vsData: + nullable: true + VsDataContainer: + $ref: '#/components/schemas/VsDataContainer-Multiple' + ManagedNFService-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + nFServiceType: + $ref: '#/components/schemas/NFServiceType' + sAP: + $ref: '#/components/schemas/SAP' + operations: + type: array + items: + $ref: '#/components/schemas/Operation' + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + usageState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/UsageState' + registrationState: + $ref: '#/components/schemas/RegistrationState' + ManagementNode-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + userLabel: + type: string + managedElements: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + vendorName: + type: string + userDefinedState: + type: string + locationName: + type: string + swVersion: + type: string + MnsAgent: + $ref: '#/components/schemas/MnsAgent-Multiple' + MnsAgent-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + systemDN: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + MeContext-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + dnPrefix: + type: string + PerfMetricJob-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + jobId: + type: string + performanceMetrics: + type: array + items: + type: string + granularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + reportingCtrl: + $ref: '#/components/schemas/ReportingCtrl' + Files: + $ref: '#/components/schemas/Files-Multiple' + ThresholdMonitor-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + performanceMetrics: + type: array + items: + type: string + thresholdInfoList: + type: array + items: + $ref: '#/components/schemas/ThresholdInfo' + monitorGranularityPeriod: + type: integer + minimum: 1 + objectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + rootObjectInstances: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DnList' + NtfSubscriptionControl-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + notificationTypes: + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/NotificationType' + scope: + $ref: '#/components/schemas/Scope' + notificationFilter: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Filter' + HeartbeatControl: + $ref: '#/components/schemas/HeartbeatControl-Single' + HeartbeatControl-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + heartbeatNtfPeriod: + type: integer + minimum: 0 + triggerHeartbeatNtf: + type: boolean + TraceJob-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + $ref: '#/components/schemas/TraceJob-Attr' + Files: + $ref: '#/components/schemas/Files-Multiple' + ManagementDataCollection-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + managementData: + $ref: '#/components/schemas/ManagementData' + targetNodeFilter: + $ref: '#/components/schemas/NodeFilter' + collectionTimeWindow: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/TimeWindow' + reportingCtrl: + type: string + dataScope: + type: string + enum: + - SNSSAI + - 5QI + AlarmList-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + administrativeState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/AdministrativeState' + operationalState: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/OperationalState' + numOfAlarmRecords: + type: integer + lastModification: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + alarmRecords: + description: >- + This resource represents a map of alarm records. + The alarmIds are used as keys in the map. + type: object + additionalProperties: + $ref: 'TS28532_FaultMnS.yaml#/components/schemas/AlarmRecord' + FileDownloadJob-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + type: string + notificationRecipientAddress: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + cancelJob: + type: string + enum: + - TRUE + - FALSE + jobMonitor: + $ref: '#/components/schemas/FileDownloadJobProcessMonitor' + Files-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + numberOfFiles: + type: integer + jobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + jobId: + type: string + File: + $ref: '#/components/schemas/File-Multiple' + File-Single: + allOf: + - $ref: '#/components/schemas/Top' + - type: object + properties: + attributes: + type: object + properties: + fileLocation: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + fileCompression: + type: string + fileSize: + type: integer + fileDataType: + type: string + enum: + - PERFORMANCE + - TRACE + - ANALYTICS + - PROPRIETARY + fileFormat: + type: string + fileReadyTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileExpirationTime: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/DateTime' + fileContent: + type: string + jobRef: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + jobId: + type: string + MnsInfo-Single: + type: object + properties: + mnsLabel: + type: string + mnsType: + type: string + enum: + - ProvMnS + - FaultSupervisionMnS + - StreamingDataReportingMnS + - FileDataReportingMnS + mnsVersion: + type: string + mnsAddress: + description: Resource URI as defined in the relevant Technical Specification + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Uri' + mnsScope: + description: >- + List of the managed object instances that can be accessed using the MnS. + If a complete SubNetwork can be accessed using the MnS, this attribute may contain the + DN of the SubNetwork instead of the DNs of the individual managed entities within the + SubNetwork. + type: array + items: + $ref: 'TS28623_ComDefs.yaml#/components/schemas/Dn' + +#-------- Definition of YAML arrays for name-contained IOCs ---------------------- + + VsDataContainer-Multiple: + type: array + items: + $ref: '#/components/schemas/VsDataContainer-Single' + ManagedNFService-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagedNFService-Single' + ManagementNode-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementNode-Single' + MnsAgent-Multiple: + type: array + items: + $ref: '#/components/schemas/MnsAgent-Single' + MeContext-Multiple: + type: array + items: + $ref: '#/components/schemas/MeContext-Single' + PerfMetricJob-Multiple: + type: array + items: + $ref: '#/components/schemas/PerfMetricJob-Single' + ThresholdMonitor-Multiple: + type: array + items: + $ref: '#/components/schemas/ThresholdMonitor-Single' + TraceJob-Multiple: + type: array + items: + $ref: '#/components/schemas/TraceJob-Single' + ManagementDataCollection-Multiple: + type: array + items: + $ref: '#/components/schemas/ManagementDataCollection-Single' + NtfSubscriptionControl-Multiple: + type: array + items: + $ref: '#/components/schemas/NtfSubscriptionControl-Single' + FileDownloadJob-Multiple: + type: array + items: + $ref: '#/components/schemas/FileDownloadJob-Single' + Files-Multiple: + type: array + items: + $ref: '#/components/schemas/Files-Single' + File-Multiple: + type: array + items: + $ref: '#/components/schemas/File-Single' + MnsInfo-Multiple: + type: array + items: + $ref: '#/components/schemas/MnsInfo-Single' + +#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- + + resources-genericNrm: + oneOf: + + - $ref: '#/components/schemas/VsDataContainer-Single' + + - $ref: '#/components/schemas/ManagementNode-Single' + - $ref: '#/components/schemas/MnsAgent-Single' + - $ref: '#/components/schemas/MeContext-Single' + + - $ref: '#/components/schemas/ManagedNFService-Single' + + - $ref: '#/components/schemas/PerfMetricJob-Single' + - $ref: '#/components/schemas/ThresholdMonitor-Single' + - $ref: '#/components/schemas/TraceJob-Single' + - $ref: '#/components/schemas/ManagementDataCollection-Single' + + - $ref: '#/components/schemas/NtfSubscriptionControl-Single' + - $ref: '#/components/schemas/HeartbeatControl-Single' + + - $ref: '#/components/schemas/AlarmList-Single' + + - $ref: '#/components/schemas/FileDownloadJob-Single' + - $ref: '#/components/schemas/Files-Single' + - $ref: '#/components/schemas/File-Single' + + - $ref: '#/components/schemas/MnsRegistry-Single' + - $ref: '#/components/schemas/MnsInfo-Single' diff --git a/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml b/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml new file mode 100644 index 0000000000000000000000000000000000000000..4bda109cd5b5b42a4513a62453c30ca548c55ead --- /dev/null +++ b/OpenAPI/TS29512_Npcf_SMPolicyControl.yaml @@ -0,0 +1,2187 @@ +##### Special note: CT R16 local copy for SA5 OAM Forge branch only, it shall not be used otherwise. S5-222029 on 4.4.2022 +# Partial commented out: (impacted attributes) +# RuleReport SmPolicyContextData SmPolicyUpdateContextData SmPolicyDecision +# PccRule TrafficControlData FlowInformation QosNotificationControlInfo ServingNfIdentity +# UsageMonitoringData AccuUsageReport +openapi: 3.0.0 +info: + title: Npcf_SMPolicyControl API + version: 1.1.7 + description: | + Session Management Policy Control Service + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. +externalDocs: + description: 3GPP TS 29.512 V16.11.0; 5G System; Session Management Policy Control Service. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.512/' +security: + - {} + - oAuth2Clientcredentials: + - npcf-smpolicycontrol +servers: + - url: '{apiRoot}/npcf-smpolicycontrol/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501 +paths: + /sm-policies: + post: + summary: Create a new Individual SM Policy + operationId: CreateSMPolicy + tags: + - SM Policies (Collection) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyContextData' + responses: + '201': + description: Created + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDecision' + headers: + Location: + description: 'Contains the URI of the newly created resource' + required: true + schema: + type: string + '308': + description: Permanent Redirect + headers: + Location: + description: 'Contains the URI of the PCF within the existing PCF binding information stored in the BSF for the same UE ID, S-NSSAI and DNN combination ' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + description: Not Found + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + SmPolicyUpdateNotification: + '{$request.body#/notificationUri}/update': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyNotification' + responses: + '200': + description: OK. The current applicable values corresponding to the policy control request trigger is reported + content: + application/json: + schema: + oneOf: + - $ref: '#/components/schemas/UeCampingRep' + - type: array + items: + $ref: '#/components/schemas/PartialSuccessReport' + minItems: 1 + - type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + '204': + description: No Content, Notification was succesfull + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + description: Bad Request. + content: + application/json: + schema: + $ref: '#/components/schemas/ErrorReport' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + SmPolicyControlTerminationRequestNotification: + '{$request.body#/notificationUri}/terminate': + post: + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationNotification' + responses: + '204': + description: No Content, Notification was successful + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /sm-policies/{smPolicyId}: + get: + summary: Read an Individual SM Policy + operationId: GetSMPolicy + tags: + - Individual SM Policy (Document) + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Resource representation is returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyControl' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /sm-policies/{smPolicyId}/update: + post: + summary: Update an existing Individual SM Policy + operationId: UpdateSMPolicy + tags: + - Individual SM Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyUpdateContextData' + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '200': + description: OK. Updated policies are returned + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDecision' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /sm-policies/{smPolicyId}/delete: + post: + summary: Delete an existing Individual SM Policy + operationId: DeleteSMPolicy + tags: + - Individual SM Policy (Document) + requestBody: + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/SmPolicyDeleteData' + parameters: + - name: smPolicyId + in: path + description: Identifier of a policy association + required: true + schema: + type: string + responses: + '204': + description: No content + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2Clientcredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-smpolicycontrol: Access to the Npcf_SMPolicyControl API + schemas: + SmPolicyControl: + type: object + properties: + context: + $ref: '#/components/schemas/SmPolicyContextData' + policy: + $ref: '#/components/schemas/SmPolicyDecision' + required: + - context + - policy + SmPolicyContextData: + type: object + properties: + accNetChId: + $ref: '#/components/schemas/AccNetChId' + chargEntityAddr: + $ref: '#/components/schemas/AccNetChargingAddress' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + invalidSupi: + type: boolean + description: When this attribute is included and set to true, it indicates that the supi attribute contains an invalid value.This attribute shall be present if the SUPI is not available in the SMF or the SUPI is unauthenticated. When present it shall be set to true for an invalid SUPI and false (default) for a valid SUPI. + interGrpIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + pduSessionId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionId' + pduSessionType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PduSessionType' + chargingcharacteristics: + type: string + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' +# dnnSelMode: +# $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/DnnSelectionMode' + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + addAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + ipDomain: + type: string + description: Indicates the IPv4 address domain + subsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + authProfIndex: + type: string + description: Indicates the DN-AAA authorization profile index + subsDefQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' +# vplmnQos: +# $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' + numOfPackFilter: + type: integer + description: Contains the number of supported packet filter for signalled QoS rules. + online: + type: boolean + description: If it is included and set to true, the online charging is applied to the PDU session. + offline: + type: boolean + description: If it is included and set to true, the offline charging is applied to the PDU session. + 3gppPsDataOffStatus: + type: boolean + description: If it is included and set to true, the 3GPP PS Data Off is activated by the UE. + refQosIndication: + type: boolean + description: If it is included and set to true, the reflective QoS is supported by the UE. + traceReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + qosFlowUsage: + $ref: '#/components/schemas/QosFlowUsage' + servNfId: + $ref: '#/components/schemas/ServingNfIdentity' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + smfId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + recoveryTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + maPduInd: + $ref: '#/components/schemas/MaPduIndication' + atsssCapab: + $ref: '#/components/schemas/AtsssCapability' + ipv4FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4AddrMask' + minItems: 1 + ipv6FrameRouteList: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + minItems: 1 + required: + - supi + - pduSessionId + - pduSessionType + - dnn + - notificationUri + - sliceInfo + SmPolicyDecision: + type: object + properties: + sessRules: + type: object + additionalProperties: + $ref: '#/components/schemas/SessionRule' + minProperties: 1 + description: A map of Sessionrules with the content being the SessionRule as described in subclause 5.6.2.7. + pccRules: + type: object + additionalProperties: + $ref: '#/components/schemas/PccRule' + minProperties: 1 + description: A map of PCC rules with the content being the PCCRule as described in subclause 5.6.2.6. + nullable: true + pcscfRestIndication: + type: boolean + description: If it is included and set to true, it indicates the P-CSCF Restoration is requested. + qosDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/QosData' + minProperties: 1 + description: Map of QoS data policy decisions. + chgDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/ChargingData' + minProperties: 1 + description: Map of Charging data policy decisions. + nullable: true + chargingInfo: + $ref: '#/components/schemas/ChargingInformation' + traffContDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/TrafficControlData' + minProperties: 1 + description: Map of Traffic Control data policy decisions. + umDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/UsageMonitoringData' + minProperties: 1 + description: Map of Usage Monitoring data policy decisions. + nullable: true + qosChars: + type: object + additionalProperties: + $ref: '#/components/schemas/QosCharacteristics' + minProperties: 1 + description: Map of QoS characteristics for non standard 5QIs. This map uses the 5QI values as keys. + qosMonDecs: + type: object + additionalProperties: + $ref: '#/components/schemas/QosMonitoringData' + minProperties: 1 + description: Map of QoS Monitoring data policy decisions. + nullable: true + reflectiveQoSTimer: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + conds: + type: object + additionalProperties: + $ref: '#/components/schemas/ConditionData' + minProperties: 1 + description: A map of condition data with the content being as described in subclause 5.6.2.9. + nullable: true + revalidationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + offline: + type: boolean + description: Indicates the offline charging is applicable to the PDU session when it is included and set to true. + online: + type: boolean + description: Indicates the online charging is applicable to the PDU session when it is included and set to true. + policyCtrlReqTriggers: + type: array + items: + $ref: '#/components/schemas/PolicyControlRequestTrigger' + minItems: 1 + description: Defines the policy control request triggers subscribed by the PCF. + nullable: true + lastReqRuleData: + type: array + items: + $ref: '#/components/schemas/RequestedRuleData' + minItems: 1 + description: Defines the last list of rule control data requested by the PCF. + lastReqUsageData: + $ref: '#/components/schemas/RequestedUsageData' + praInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfoRm' + minProperties: 1 + description: Map of PRA information. + nullable: true +# ipv4Index: +# $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' +# ipv6Index: +# $ref: 'TS29519_Policy_Data.yaml#/components/schemas/IpIndex' + qosFlowUsage: + $ref: '#/components/schemas/QosFlowUsage' + relCause: + $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + tsnBridgeManCont: + $ref: '#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: '#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: '#/components/schemas/PortManagementContainer' + minItems: 1 + redSessIndication: + type: boolean + description: Indicates whether the PDU session is a redundant PDU session. If absent it means the PDU session is not a redundant PDU session. + SmPolicyNotification: + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + smPolicyDecision: + $ref: '#/components/schemas/SmPolicyDecision' + PccRule: + type: object + properties: + flowInfos: + type: array + items: + $ref: '#/components/schemas/FlowInformation' + minItems: 1 + description: An array of IP flow packet filter information. + appId: + type: string + description: A reference to the application detection filter configured at the UPF. + appDescriptor: + $ref: '#/components/schemas/ApplicationDescriptor' +# contVer: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + pccRuleId: + type: string + description: Univocally identifies the PCC rule within a PDU session. + precedence: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + afSigProtocol: + $ref: '#/components/schemas/AfSigProtocol' + appReloc: + type: boolean + description: Indication of application relocation possibility. + refQosData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to the QosData policy decision type. It is the qosId described in subclause 5.6.2.8. + refAltQosParams: + type: array + items: + type: string + minItems: 1 + description: A Reference to the QosData policy decision type for the Alternative QoS parameter sets of the service data flow. + refTcData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to the TrafficControlData policy decision type. It is the tcId described in subclause 5.6.2.10. + refChgData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to the ChargingData policy decision type. It is the chgId described in subclause 5.6.2.11. + nullable: true + refChgN3gData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to the ChargingData policy decision type only applicable to Non-3GPP access if "ATSSS" feature is supported. It is the chgId described in subclause 5.6.2.11. + nullable: true + refUmData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to UsageMonitoringData policy decision type. It is the umId described in subclause 5.6.2.12. + nullable: true + refUmN3gData: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to UsageMonitoringData policy decision type only applicable to Non-3GPP access if "ATSSS" feature is supported. It is the umId described in subclause 5.6.2.12. + nullable: true + refCondData: + type: string + description: A reference to the condition data. It is the condId described in subclause 5.6.2.9. + nullable: true + refQosMon: + type: array + items: + type: string + minItems: 1 + maxItems: 1 + description: A reference to the QosMonitoringData policy decision type. It is the qmId described in subclause 5.6.2.40. + nullable: true + addrPreserInd: + type: boolean + nullable: true +# tscaiInputDl: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' +# tscaiInputUl: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/TscaiInputContainer' + ddNotifCtrl: + $ref: '#/components/schemas/DownlinkDataNotificationControl' + ddNotifCtrl2: + $ref: '#/components/schemas/DownlinkDataNotificationControlRm' + disUeNotif: + type: boolean + nullable: true + required: + - pccRuleId + nullable: true + SessionRule: + type: object + properties: + authSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + authDefQos: + $ref: '#/components/schemas/AuthorizedDefaultQos' + sessRuleId: + type: string + description: Univocally identifies the session rule within a PDU session. + refUmData: + type: string + description: A reference to UsageMonitoringData policy decision type. It is the umId described in subclause 5.6.2.12. + nullable: true + refUmN3gData: + type: string + description: A reference to UsageMonitoringData policy decision type to apply for Non-3GPP access. It is the umId described in subclause 5.6.2.12. + nullable: true + refCondData: + type: string + description: A reference to the condition data. It is the condId described in subclause 5.6.2.9. + nullable: true + required: + - sessRuleId + nullable: true + QosData: + type: object + properties: + qosId: + type: string + description: Univocally identifies the QoS control policy data within a PDU session. + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + qnc: + type: boolean + description: Indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow. + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + maxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' + reflectiveQos: + type: boolean + description: Indicates whether the QoS information is reflective for the corresponding service data flow. + sharingKeyDl: + type: string + description: Indicates, by containing the same value, what PCC rules may share resource in downlink direction. + sharingKeyUl: + type: string + description: Indicates, by containing the same value, what PCC rules may share resource in uplink direction. + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + defQosFlowIndication: + type: boolean + description: Indicates that the dynamic PCC rule shall always have its binding with the QoS Flow associated with the default QoS rule + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + required: + - qosId + nullable: true + ConditionData: + type: object + properties: + condId: + type: string + description: Uniquely identifies the condition data within a PDU session. + activationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + deactivationTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + required: + - condId + nullable: true + TrafficControlData: + type: object + properties: + tcId: + type: string + description: Univocally identifies the traffic control policy data within a PDU session. +# flowStatus: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/FlowStatus' + redirectInfo: + $ref: '#/components/schemas/RedirectInformation' + addRedirectInfo: + type: array + items: + $ref: '#/components/schemas/RedirectInformation' + minItems: 1 + muteNotif: + type: boolean + description: Indicates whether applicat'on's start or stop notification is to be muted. + trafficSteeringPolIdDl: + type: string + description: Reference to a pre-configured traffic steering policy for downlink traffic at the SMF. + nullable: true + trafficSteeringPolIdUl: + type: string + description: Reference to a pre-configured traffic steering policy for uplink traffic at the SMF. + nullable: true + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + description: A list of location which the traffic shall be routed to for the AF request + traffCorreInd: + type: boolean + upPathChgEvent: + $ref: '#/components/schemas/UpPathChgEvent' + steerFun: + $ref: '#/components/schemas/SteeringFunctionality' + steerModeDl: + $ref: '#/components/schemas/SteeringMode' + steerModeUl: + $ref: '#/components/schemas/SteeringMode' + mulAccCtrl: + $ref: '#/components/schemas/MulticastAccessControl' + required: + - tcId + nullable: true + ChargingData: + type: object + properties: + chgId: + type: string + description: Univocally identifies the charging control policy data within a PDU session. + meteringMethod: + $ref: '#/components/schemas/MeteringMethod' + offline: + type: boolean + description: Indicates the offline charging is applicable to the PCC rule when it is included and set to true. + online: + type: boolean + description: Indicates the online charging is applicable to the PCC rule when it is included and set to true. + sdfHandl: + type: boolean + description: Indicates whether the service data flow is allowed to start while the SMF is waiting for the response to the credit request. + ratingGroup: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatingGroup' + reportingLevel: + $ref: '#/components/schemas/ReportingLevel' + serviceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ServiceId' + sponsorId: + type: string + description: Indicates the sponsor identity. + appSvcProvId: + type: string + description: Indicates the application service provider identity. + afChargingIdentifier: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + afChargId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + required: + - chgId + nullable: true + UsageMonitoringData: + type: object + properties: + umId: + type: string + description: Univocally identifies the usage monitoring policy data within a PDU session. +# volumeThreshold: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' +# volumeThresholdUplink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' +# volumeThresholdDownlink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' +# timeThreshold: +# $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' +# monitoringTime: +# $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTimeRm' +# nextVolThreshold: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' +# nextVolThresholdUplink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' +# nextVolThresholdDownlink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/VolumeRm' + nextTimeThreshold: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + inactivityTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + exUsagePccRuleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the PCC rule identifier(s) which corresponding service data flow(s) shall be excluded from PDU Session usage monitoring. It is only included in the UsageMonitoringData instance for session level usage monitoring. + nullable: true + required: + - umId + nullable: true + RedirectInformation: + type: object + properties: + redirectEnabled: + type: boolean + description: Indicates the redirect is enable. + redirectAddressType: + $ref: '#/components/schemas/RedirectAddressType' + redirectServerAddress: + type: string + description: Indicates the address of the redirect server. If "redirectAddressType" attribute indicates the IPV4_ADDR, the encoding is the same as the Ipv4Addr data type defined in 3GPP TS 29.571.If "redirectAddressType" attribute indicates the IPV6_ADDR, the encoding is the same as the Ipv6Addr data type defined in 3GPP TS 29.571.If "redirectAddressType" attribute indicates the URL or SIP_URI, the encoding is the same as the Uri data type defined in 3GPP TS 29.571. + FlowInformation: + type: object + properties: + flowDescription: + $ref: '#/components/schemas/FlowDescription' +# ethFlowDescription: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/EthFlowDescription' + packFiltId: + type: string + description: An identifier of packet filter. + packetFilterUsage: + type: boolean + description: The packet shall be sent to the UE. + tosTrafficClass: + type: string + description: Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field. + nullable: true + spi: + type: string + description: the security parameter index of the IPSec packet. + nullable: true + flowLabel: + type: string + description: the Ipv6 flow label header field. + nullable: true + flowDirection: + $ref: '#/components/schemas/FlowDirectionRm' + SmPolicyDeleteData: + type: object + properties: + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfoTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ranNasRelCauses: + type: array + items: + $ref: '#/components/schemas/RanNasRelCause' + minItems: 1 + description: Contains the RAN and/or NAS release cause. + accuUsageReports: + type: array + items: + $ref: '#/components/schemas/AccuUsageReport' + minItems: 1 + description: Contains the usage report + pduSessRelCause: + $ref: '#/components/schemas/PduSessionRelCause' + qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + QosCharacteristics: + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + resourceType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/QosResourceType' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevel' + packetDelayBudget: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + packetErrorRate: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketErrRate' + averagingWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' + required: + - 5qi + - resourceType + - priorityLevel + - packetDelayBudget + - packetErrorRate + ChargingInformation: + type: object + properties: + primaryChfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + secondaryChfAddress: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + primaryChfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + primaryChfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + secondaryChfSetId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfSetId' + secondaryChfInstanceId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + required: + - primaryChfAddress + - secondaryChfAddress + AccuUsageReport: + type: object + properties: + refUmIds: + type: string + description: An id referencing UsageMonitoringData objects associated with this usage report. +# volUsage: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +# volUsageUplink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +# volUsageDownlink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +# timeUsage: +# $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' +# nextVolUsage: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +# nextVolUsageUplink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' +# nextVolUsageDownlink: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/Volume' + nextTimeUsage: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + required: + - refUmIds + SmPolicyUpdateContextData: + type: object + properties: + repPolicyCtrlReqTriggers: + type: array + items: + $ref: '#/components/schemas/PolicyControlRequestTrigger' + minItems: 1 + description: The policy control reqeust trigges which are met. + accNetChIds: + type: array + items: + $ref: '#/components/schemas/AccNetChId' + minItems: 1 + description: Indicates the access network charging identifier for the PCC rule(s) or whole PDU session. + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + addAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: '#/components/schemas/AdditionalAccessInfo' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + relIpv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv4Address: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipDomain: + type: string + description: Indicates the IPv4 address domain + ipv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + relIpv6AddressPrefix: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + addIpv6AddrPrefixes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + addRelIpv6AddrPrefixes: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Prefix' + relUeMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + subsSessAmbr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ambr' + authProfIndex: + type: string + description: Indicates the DN-AAA authorization profile index + subsDefQos: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SubscribedDefaultQos' +# vplmnQos: +# $ref: 'TS29502_Nsmf_PDUSession.yaml#/components/schemas/VplmnQos' + vplmnQosNotApp: + type: boolean + description: If it is included and set to true, indicates that the QoS constraints in the VPLMN are not applicable. + numOfPackFilter: + type: integer + description: Contains the number of supported packet filter for signalled QoS rules. + accuUsageReports: + type: array + items: + $ref: '#/components/schemas/AccuUsageReport' + minItems: 1 + description: Contains the usage report + 3gppPsDataOffStatus: + type: boolean + description: If it is included and set to true, the 3GPP PS Data Off is activated by the UE. + appDetectionInfos: + type: array + items: + $ref: '#/components/schemas/AppDetectionInfo' + minItems: 1 + description: Report the start/stop of the application traffic and detected SDF descriptions if applicable. + ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: Used to report the PCC rule failure. + sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: Used to report the session rule failure. + qncReports: + type: array + items: + $ref: '#/components/schemas/QosNotificationControlInfo' + minItems: 1 + description: QoS Notification Control information. + qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + userLocationInfoTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + repPraInfos: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + description: Reports the changes of presence reporting area. + ueInitResReq: + $ref: '#/components/schemas/UeInitiatedResourceRequest' + refQosIndication: + type: boolean + description: If it is included and set to true, the reflective QoS is supported by the UE. If it is included and set to false, the reflective QoS is revoked by the UE. + qosFlowUsage: + $ref: '#/components/schemas/QosFlowUsage' + creditManageStatus: + $ref: '#/components/schemas/CreditManagementStatus' + servNfId: + $ref: '#/components/schemas/ServingNfIdentity' + traceReq: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TraceData' + maPduInd: + $ref: '#/components/schemas/MaPduIndication' + atsssCapab: + $ref: '#/components/schemas/AtsssCapability' + tsnBridgeInfo: + $ref: '#/components/schemas/TsnBridgeInfo' + tsnBridgeManCont: + $ref: '#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: '#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: '#/components/schemas/PortManagementContainer' + minItems: 1 + mulAddrInfos: + type: array + items: + $ref: '#/components/schemas/IpMulticastAddressInfo' + minItems: 1 + policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. + trafficDescriptors: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DddTrafficDescriptor' + minItems: 1 + pccRuleId: + type: string + description: Contains the identifier of the PCC rule which is used for traffic detection of event. + interGrpIds: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/GroupId' + minItems: 1 + typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + UpPathChgEvent: + type: object + properties: + notificationUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifCorreId: + type: string + description: It is used to set the value of Notification Correlation ID in the notification sent by the SMF. + dnaiChgType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DnaiChangeType' + afAckInd: + type: boolean + required: + - notificationUri + - notifCorreId + - dnaiChgType + nullable: true + TerminationNotification: + type: object + properties: + resourceUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + cause: + $ref: '#/components/schemas/SmPolicyAssociationReleaseCause' + required: + - resourceUri + - cause + AppDetectionInfo: + type: object + properties: + appId: + type: string + description: A reference to the application detection filter configured at the UPF + instanceId: + type: string + description: Identifier sent by the SMF in order to allow correlation of application Start and Stop events to the specific service data flow description, if service data flow descriptions are deducible. + sdfDescriptions: + type: array + items: + $ref: '#/components/schemas/FlowInformation' + minItems: 1 + description: Contains the detected service data flow descriptions if they are deducible. + required: + - appId + AccNetChId: + type: object + properties: + accNetChaIdValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + refPccRuleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the identifier of the PCC rule(s) associated to the provided Access Network Charging Identifier. + sessionChScope: + type: boolean + description: When it is included and set to true, indicates the Access Network Charging Identifier applies to the whole PDU Session + required: + - accNetChaIdValue + AccNetChargingAddress: + description: Describes the network entity within the access network performing charging + type: object + anyOf: + - required: [anChargIpv4Addr] + - required: [anChargIpv6Addr] + properties: + anChargIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anChargIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + RequestedRuleData: + type: object + properties: + refPccRuleIds: + type: array + items: + type: string + minItems: 1 + description: An array of PCC rule id references to the PCC rules associated with the control data. + reqData: + type: array + items: + $ref: '#/components/schemas/RequestedRuleDataType' + minItems: 1 + description: Array of requested rule data type elements indicating what type of rule data is requested for the corresponding referenced PCC rules. + required: + - refPccRuleIds + - reqData + RequestedUsageData: + type: object + properties: + refUmIds: + type: array + items: + type: string + minItems: 1 + description: An array of usage monitoring data id references to the usage monitoring data instances for which the PCF is requesting a usage report. This attribute shall only be provided when allUmIds is not set to true. + allUmIds: + type: boolean + description: This boolean indicates whether requested usage data applies to all usage monitoring data instances. When it's not included, it means requested usage data shall only apply to the usage monitoring data instances referenced by the refUmIds attribute. + UeCampingRep: + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + servNfId: + $ref: '#/components/schemas/ServingNfIdentity' + servingNetwork: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + userLocationInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' + netLocAccSupp: + $ref: '#/components/schemas/NetLocAccessSupport' + RuleReport: + type: object + properties: + pccRuleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the identifier of the affected PCC rule(s). + ruleStatus: + $ref: '#/components/schemas/RuleStatus' +# contVers: +# type: array +# items: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' +# minItems: 1 +# description: Indicates the version of a PCC rule. + failureCode: + $ref: '#/components/schemas/FailureCode' +# finUnitAct: +# $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' + ranNasRelCauses: + type: array + items: + $ref: '#/components/schemas/RanNasRelCause' + minItems: 1 + description: indicates the RAN or NAS release cause code information. + required: + - pccRuleIds + - ruleStatus + RanNasRelCause: + type: object + properties: + ngApCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NgApCause' + 5gMmCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5GMmCause' + 5gSmCause: + $ref: '#/components/schemas/5GSmCause' + epsCause: + $ref: '#/components/schemas/EpsRanNasRelCause' + UeInitiatedResourceRequest: + type: object + properties: + pccRuleId: + type: string + ruleOp: + $ref: '#/components/schemas/RuleOperation' + precedence: + type: integer + packFiltInfo: + type: array + items: + $ref: '#/components/schemas/PacketFilterInfo' + minItems: 1 + reqQos: + $ref: '#/components/schemas/RequestedQos' + required: + - ruleOp + - packFiltInfo + PacketFilterInfo: + type: object + properties: + packFiltId: + type: string + description: An identifier of packet filter. + packFiltCont: + $ref: '#/components/schemas/PacketFilterContent' + tosTrafficClass: + type: string + description: Contains the Ipv4 Type-of-Service and mask field or the Ipv6 Traffic-Class field and mask field. + spi: + type: string + description: The security parameter index of the IPSec packet. + flowLabel: + type: string + description: The Ipv6 flow label header field. + flowDirection: + $ref: '#/components/schemas/FlowDirection' + RequestedQos: + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + required: + - 5qi + QosNotificationControlInfo: + type: object + properties: + refPccRuleIds: + type: array + items: + type: string + minItems: 1 + description: An array of PCC rule id references to the PCC rules associated with the QoS notification control info. +# notifType: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/QosNotifType' +# contVer: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/ContentVersion' + altQosParamId: + type: string + required: + - refPccRuleIds + - notifType + PartialSuccessReport: + type: object + properties: + failureCause: + $ref: '#/components/schemas/FailureCause' + ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: Information about the PCC rules provisioned by the PCF not successfully installed/activated. + sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: Information about the session rules provisioned by the PCF not successfully installed. + ueCampingRep: + $ref: '#/components/schemas/UeCampingRep' + policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. + required: + - failureCause + AuthorizedDefaultQos: + type: object + properties: + 5qi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5Qi' + arp: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Arp' + priorityLevel: + $ref: 'TS29571_CommonData.yaml#/components/schemas/5QiPriorityLevelRm' + averWindow: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AverWindowRm' + maxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MaxDataBurstVolRm' + maxbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + gbrDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + extMaxDataBurstVol: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + ErrorReport: + type: object + properties: + error: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + ruleReports: + type: array + items: + $ref: '#/components/schemas/RuleReport' + minItems: 1 + description: Used to report the PCC rule failure. + sessRuleReports: + type: array + items: + $ref: '#/components/schemas/SessionRuleReport' + minItems: 1 + description: Used to report the session rule failure. + polDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Used to report failure of the policy decision and/or condition data. + altQosParamId: + type: string + SessionRuleReport: + type: object + properties: + ruleIds: + type: array + items: + type: string + minItems: 1 + description: Contains the identifier of the affected session rule(s). + ruleStatus: + $ref: '#/components/schemas/RuleStatus' + sessRuleFailureCode: + $ref: '#/components/schemas/SessionRuleFailureCode' + policyDecFailureReports: + type: array + items: + $ref: '#/components/schemas/PolicyDecisionFailureCode' + minItems: 1 + description: Contains the type(s) of failed policy decision and/or condition data. + required: + - ruleIds + - ruleStatus + ServingNfIdentity: + type: object + properties: + servNfInstId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/NfInstanceId' + guami: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Guami' +# anGwAddr: +# $ref: 'TS29514_Npcf_PolicyAuthorization.yaml#/components/schemas/AnGwAddress' + SteeringMode: + type: object + properties: + steerModeValue: + $ref: '#/components/schemas/SteerModeValue' + active: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + standby: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessTypeRm' + 3gLoad: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + prioAcc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + required: + - steerModeValue + AdditionalAccessInfo: + type: object + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + required: + - accessType + QosMonitoringData: + type: object + properties: + qmId: + type: string + description: Univocally identifies the QoS monitoring policy data within a PDU session. + reqQosMonParams: + type: array + items: + $ref: '#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + description: indicates the UL packet delay, DL packet delay and/or round trip packet delay between the UE and the UPF is to be monitored when the QoS Monitoring for URLLC is enabled for the service data flow. + repFreqs: + type: array + items: + $ref: '#/components/schemas/ReportingFrequency' + minItems: 1 + repThreshDl: + type: integer + description: Indicates the period of time in units of miliiseconds for DL packet delay. + nullable: true + repThreshUl: + type: integer + description: Indicates the period of time in units of miliiseconds for UL packet delay. + nullable: true + repThreshRp: + type: integer + description: Indicates the period of time in units of miliiseconds for round trip packet delay. + nullable: true + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSecRm' + notifyUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + notifyCorreId: + type: string + required: + - qmId + - reqQosMonParams + - repFreqs + nullable: true + QosMonitoringReport: + type: object + properties: + refPccRuleIds: + type: array + items: + type: string + minItems: 1 + description: An array of PCC rule id references to the PCC rules associated with the QoS monitoring report. + ulDelays: + type: array + items: + type: integer + minItems: 1 + dlDelays: + type: array + items: + type: integer + minItems: 1 + rtDelays: + type: array + items: + type: integer + minItems: 1 + required: + - refPccRuleIds +# + TsnBridgeInfo: + type: object + properties: + bridgeId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint64' + dsttAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + dsttPortNum: + $ref: '#/components/schemas/TsnPortNumber' + dsttResidTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' +# + PortManagementContainer: + type: object + properties: + portManCont: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + portNum: + $ref: '#/components/schemas/TsnPortNumber' + required: + - portManCont + - portNum + BridgeManagementContainer: + type: object + properties: + bridgeManCont: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + required: + - bridgeManCont + IpMulticastAddressInfo: + type: object + properties: + srcIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv4MulAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + srcIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ipv6MulAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + DownlinkDataNotificationControl: + description: Contains the downlink data notification control information. + type: object + properties: + notifCtrlInds: + type: array + items: + $ref: '#/components/schemas/NotificationControlIndication' + minItems: 1 + typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + DownlinkDataNotificationControlRm: + description: this data type is defined in the same way as the DownlinkDataNotificationControl data type, but with the OpenAPI nullable property set to true. + type: object + properties: + notifCtrlInds: + type: array + items: + $ref: '#/components/schemas/NotificationControlIndication' + minItems: 1 + nullable: true + typesOfNotif: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DlDataDeliveryStatus' + minItems: 1 + nullable: true + nullable: true + 5GSmCause: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + EpsRanNasRelCause: + type: string + description: Defines the EPS RAN/NAS release cause. + PacketFilterContent: + type: string + description: Defines a packet filter for an IP flow. + FlowDescription: + type: string + description: Defines a packet filter for an IP flow. + TsnPortNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + ApplicationDescriptor: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Bytes' + FlowDirection: + anyOf: + - type: string + enum: + - DOWNLINK + - UPLINK + - BIDIRECTIONAL + - UNSPECIFIED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - DOWNLINK: The corresponding filter applies for traffic to the UE. + - UPLINK: The corresponding filter applies for traffic from the UE. + - BIDIRECTIONAL: The corresponding filter applies for traffic both to and from the UE. + - UNSPECIFIED: The corresponding filter applies for traffic to the UE (downlink), but has no specific direction declared. The service data flow detection shall apply the filter for uplink traffic as if the filter was bidirectional. The PCF shall not use the value UNSPECIFIED in filters created by the network in NW-initiated procedures. The PCF shall only include the value UNSPECIFIED in filters in UE-initiated procedures if the same value is received from the SMF. + FlowDirectionRm: + anyOf: + - $ref: '#/components/schemas/FlowDirection' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + ReportingLevel: + anyOf: + - type: string + enum: + - SER_ID_LEVEL + - RAT_GR_LEVEL + - SPON_CON_LEVEL + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - SER_ID_LEVEL: Indicates that the usage shall be reported on service id and rating group combination level. + - RAT_GR_LEVEL: Indicates that the usage shall be reported on rating group level. + - SPON_CON_LEVEL: Indicates that the usage shall be reported on sponsor identity and rating group combination level. + MeteringMethod: + anyOf: + - type: string + enum: + - DURATION + - VOLUME + - DURATION_VOLUME + - EVENT + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - DURATION: Indicates that the duration of the service data flow traffic shall be metered. + - VOLUME: Indicates that volume of the service data flow traffic shall be metered. + - DURATION_VOLUME: Indicates that the duration and the volume of the service data flow traffic shall be metered. + - EVENT: Indicates that events of the service data flow traffic shall be metered. + PolicyControlRequestTrigger: + anyOf: + - type: string + enum: + - PLMN_CH + - RES_MO_RE + - AC_TY_CH + - UE_IP_CH + - UE_MAC_CH + - AN_CH_COR + - US_RE + - APP_STA + - APP_STO + - AN_INFO + - CM_SES_FAIL + - PS_DA_OFF + - DEF_QOS_CH + - SE_AMBR_CH + - QOS_NOTIF + - NO_CREDIT + - REALLO_OF_CREDIT + - PRA_CH + - SAREA_CH + - SCNN_CH + - RE_TIMEOUT + - RES_RELEASE + - SUCC_RES_ALLO + - RAT_TY_CH + - REF_QOS_IND_CH + - NUM_OF_PACKET_FILTER + - UE_STATUS_RESUME + - UE_TZ_CH + - AUTH_PROF_CH + - QOS_MONITORING + - SCELL_CH + - EPS_FALLBACK + - MA_PDU + - TSN_BRIDGE_INFO + - 5G_RG_JOIN + - 5G_RG_LEAVE + - DDN_FAILURE + - DDN_DELIVERY_STATUS + - GROUP_ID_LIST_CHG + - DDN_FAILURE_CANCELLATION + - DDN_DELIVERY_STATUS_CANCELLATION + - VPLMN_QOS_CH + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - PLMN_CH: PLMN Change + - RES_MO_RE: A request for resource modification has been received by the SMF. The SMF always reports to the PCF. + - AC_TY_CH: Access Type Change + - UE_IP_CH: UE IP address change. The SMF always reports to the PCF. + - UE_MAC_CH: A new UE MAC address is detected or a used UE MAC address is inactive for a specific period + - AN_CH_COR: Access Network Charging Correlation Information + - US_RE: The PDU Session or the Monitoring key specific resources consumed by a UE either reached the threshold or needs to be reported for other reasons. + - APP_STA: The start of application traffic has been detected. + - APP_STO: The stop of application traffic has been detected. + - AN_INFO: Access Network Information report + - CM_SES_FAIL: Credit management session failure + - PS_DA_OFF: The SMF reports when the 3GPP PS Data Off status changes. The SMF always reports to the PCF. + - DEF_QOS_CH: Default QoS Change. The SMF always reports to the PCF. + - SE_AMBR_CH: Session AMBR Change. The SMF always reports to the PCF. + - QOS_NOTIF: The SMF notify the PCF when receiving notification from RAN that QoS targets of the QoS Flow cannot be guranteed or gurateed again. + - NO_CREDIT: Out of credit + - REALLO_OF_CREDIT: Reallocation of credit + - PRA_CH: Change of UE presence in Presence Reporting Area + - SAREA_CH: Location Change with respect to the Serving Area + - SCNN_CH: Location Change with respect to the Serving CN node + - RE_TIMEOUT: Indicates the SMF generated the request because there has been a PCC revalidation timeout + - RES_RELEASE: Indicate that the SMF can inform the PCF of the outcome of the release of resources for those rules that require so. + - SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation. + - RAT_TY_CH: RAT Type Change. + - REF_QOS_IND_CH: Reflective QoS indication Change + - NUM_OF_PACKET_FILTER: Indicates that the SMF shall report the number of supported packet filter for signalled QoS rules + - UE_STATUS_RESUME: Indicates that the UE’s status is resumed. + - UE_TZ_CH: UE Time Zone Change + - AUTH_PROF_CH: The DN-AAA authorization profile index has changed + - QOS_MONITORING: Indicate that the SMF notifies the PCF of the QoS Monitoring information. + - SCELL_CH: Location Change with respect to the Serving Cell. + - EPS_FALLBACK: EPS Fallback report is enabled in the SMF. + - MA_PDU: UE Indicates that the SMF notifies the PCF of the MA PDU session request + - TSN_BRIDGE_INFO: 5GS Bridge information available + - 5G_RG_JOIN: The 5G-RG has joined to an IP Multicast Group. + - 5G_RG_LEAVE: The 5G-RG has left an IP Multicast Group. + - DDN_FAILURE: Event subscription for DDN Failure event received. + - DDN_DELIVERY_STATUS: Event subscription for DDN Delivery Status received. + - GROUP_ID_LIST_CHG: UE Internal Group Identifier(s) has changed: the SMF reports that UDM provided list of group Ids has changed. + - DDN_FAILURE_CANCELLATION: The event subscription for DDN Failure event is cancelled. + - DDN_DELIVERY_STATUS_CANCELLATION: The event subscription for DDD STATUS is cancelled. + - VPLMN_QOS_CH: Change of the QoS supported in the VPLMN. + RequestedRuleDataType: + anyOf: + - type: string + enum: + - CH_ID + - MS_TIME_ZONE + - USER_LOC_INFO + - RES_RELEASE + - SUCC_RES_ALLO + - EPS_FALLBACK + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - CH_ID: Indicates that the requested rule data is the charging identifier. + - MS_TIME_ZONE: Indicates that the requested access network info type is the UE's timezone. + - USER_LOC_INFO: Indicates that the requested access network info type is the UE's location. + - RES_RELEASE: Indicates that the requested rule data is the result of the release of resource. + - SUCC_RES_ALLO: Indicates that the requested rule data is the successful resource allocation. + - EPS_FALLBACK: Indicates that the requested rule data is the report of QoS flow rejection due to EPS fallback. + RuleStatus: + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - ACTIVE: Indicates that the PCC rule(s) are successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF), or the session rule(s) are successfully installed + - INACTIVE: Indicates that the PCC rule(s) are removed (for those provisioned from PCF) or inactive (for those pre-defined in SMF) or the session rule(s) are removed. + FailureCode: + anyOf: + - type: string + enum: + - UNK_RULE_ID + - RA_GR_ERR + - SER_ID_ERR + - NF_MAL + - RES_LIM + - MAX_NR_QoS_FLOW + - MISS_FLOW_INFO + - RES_ALLO_FAIL + - UNSUCC_QOS_VAL + - INCOR_FLOW_INFO + - PS_TO_CS_HAN + - APP_ID_ERR + - NO_QOS_FLOW_BOUND + - FILTER_RES + - MISS_REDI_SER_ADDR + - CM_END_USER_SER_DENIED + - CM_CREDIT_CON_NOT_APP + - CM_AUTH_REJ + - CM_USER_UNK + - CM_RAT_FAILED + - UE_STA_SUSP + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - UNK_RULE_ID: Indicates that the pre-provisioned PCC rule could not be successfully activated because the PCC rule identifier is unknown to the SMF. + - RA_GR_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Rating Group specified within the Charging Data policy decision which the PCC rule refers to is unknown or, invalid. + - SER_ID_ERR: Indicate that the PCC rule could not be successfully installed or enforced because the Service Identifier specified within the Charging Data policy decision which the PCC rule refers to is invalid, unknown, or not applicable to the service being charged. + - NF_MAL: Indicate that the PCC rule could not be successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction. + - RES_LIM: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF. + - MAX_NR_QoS_FLOW: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to the fact that the maximum number of QoS flows has been reached for the PDU session. + - MISS_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or enforced because neither the "flowInfos" attribute nor the "appId" attribute is specified within the PccRule data structure by the PCF during the first install request of the PCC rule. + - RES_ALLO_FAIL: Indicate that the PCC rule could not be successfully installed or maintained since the QoS flow establishment/modification failed, or the QoS flow was released. + - UNSUCC_QOS_VAL: indicate that the QoS validation has failed or when Guaranteed Bandwidth > Max-Requested-Bandwidth. + - INCOR_FLOW_INFO: Indicate that the PCC rule could not be successfully installed or modified at the SMF because the provided flow information is not supported by the network (e.g. the provided IP address(es) or Ipv6 prefix(es) do not correspond to an IP version applicable for the PDU session). + - PS_TO_CS_HAN: Indicate that the PCC rule could not be maintained because of PS to CS handover. + - APP_ID_ERR: Indicate that the rule could not be successfully installed or enforced because the Application Identifier is invalid, unknown, or not applicable to the application required for detection. + - NO_QOS_FLOW_BOUND: Indicate that there is no QoS flow which the SMF can bind the PCC rule(s) to. + - FILTER_RES: Indicate that the Flow Information within the "flowInfos" attribute cannot be handled by the SMF because any of the restrictions defined in subclause 5.4.2 of 3GPP TS 29.212 was not met. + - MISS_REDI_SER_ADDR: Indicate that the PCC rule could not be successfully installed or enforced at the SMF because there is no valid Redirect Server Address within the Traffic Control Data policy decision which the PCC rule refers to provided by the PCF and no preconfigured redirection address for this PCC rule at the SMF. + - CM_END_USER_SER_DENIED: Indicate that the charging system denied the service request due to service restrictions (e.g. terminate rating group) or limitations related to the end-user, for example the end-user's account could not cover the requested service. + - CM_CREDIT_CON_NOT_APP: Indicate that the charging system determined that the service can be granted to the end user but no further credit control is needed for the service (e.g. service is free of charge or is treated for offline charging). + - CM_AUTH_REJ: Indicate that the charging system denied the service request in order to terminate the service for which credit is requested. + - CM_USER_UNK: Indicate that the specified end user could not be found in the charging system. + - CM_RAT_FAILED: Indicate that the charging system cannot rate the service request due to insufficient rating input, incorrect AVP combination or due to an attribute or an attribute value that is not recognized or supported in the rating. + - UE_STA_SUSP: Indicates that the UE is in suspend state. + AfSigProtocol: + anyOf: + - type: string + enum: + - NO_INFORMATION + - SIP + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - NO_INFORMATION: Indicate that no information about the AF signalling protocol is being provided. + - SIP: Indicate that the signalling protocol is Session Initiation Protocol. + RuleOperation: + anyOf: + - type: string + enum: + - CREATE_PCC_RULE + - DELETE_PCC_RULE + - MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS + - MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS + - MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS + - MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - CREATE_PCC_RULE: Indicates to create a new PCC rule to reserve the resource requested by the UE. + - DELETE_PCC_RULE: Indicates to delete a PCC rule corresponding to reserve the resource requested by the UE. + - MODIFY_PCC_RULE_AND_ADD_PACKET_FILTERS: Indicates to modify the PCC rule by adding new packet filter(s). + - MODIFY_ PCC_RULE_AND_REPLACE_PACKET_FILTERS: Indicates to modify the PCC rule by replacing the existing packet filter(s). + - MODIFY_ PCC_RULE_AND_DELETE_PACKET_FILTERS: Indicates to modify the PCC rule by deleting the existing packet filter(s). + - MODIFY_PCC_RULE_WITHOUT_MODIFY_PACKET_FILTERS: Indicates to modify the PCC rule by modifying the QoS of the PCC rule. + RedirectAddressType: + anyOf: + - type: string + enum: + - IPV4_ADDR + - IPV6_ADDR + - URL + - SIP_URI + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - IPV4_ADDR: Indicates that the address type is in the form of "dotted-decimal" IPv4 address. + - IPV6_ADDR: Indicates that the address type is in the form of IPv6 address. + - URL: Indicates that the address type is in the form of Uniform Resource Locator. + - SIP_URI: Indicates that the address type is in the form of SIP Uniform Resource Identifier. + QosFlowUsage: + anyOf: + - type: string + enum: + - GENERAL + - IMS_SIG + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - GENERAL: Indicate no specific QoS flow usage information is available. + - IMS_SIG: Indicate that the QoS flow is used for IMS signalling only. + FailureCause: + anyOf: + - type: string + enum: + - PCC_RULE_EVENT + - PCC_QOS_FLOW_EVENT + - RULE_PERMANENT_ERROR + - RULE_TEMPORARY_ERROR + - POL_DEC_ERROR + - type: string + CreditManagementStatus: + anyOf: + - type: string + enum: + - END_USER_SER_DENIED + - CREDIT_CTRL_NOT_APP + - AUTH_REJECTED + - USER_UNKNOWN + - RATING_FAILED + - type: string + SessionRuleFailureCode: + anyOf: + - type: string + enum: + - NF_MAL + - RES_LIM + - UNSUCC_QOS_VAL + - UE_STA_SUSP + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - NF_MAL: Indicate that the PCC rule could not be successfully installed (for those provisioned from the PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to SMF/UPF malfunction. + - RES_LIM: Indicate that the PCC rule could not be successfully installed (for those provisioned from PCF) or activated (for those pre-defined in SMF) or enforced (for those already successfully installed) due to a limitation of resources at the SMF/UPF. + - UNSUCC_QOS_VAL: indicate that the QoS validation has failed. + - UE_STA_SUSP: Indicates that the UE is in suspend state. + SteeringFunctionality: + anyOf: + - type: string + enum: + - MPTCP + - ATSSS_LL + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - MPTCP: Indicates that PCF authorizes the MPTCP functionality to support traffic steering, switching and splitting. + - ATSSS_LL: Indicates that PCF authorizes the ATSSS-LL functionality to support traffic steering, switching and splitting. + SteerModeValue: + anyOf: + - type: string + enum: + - ACTIVE_STANDBY + - LOAD_BALANCING + - SMALLEST_DELAY + - PRIORITY_BASED + - type: string + MulticastAccessControl: + anyOf: + - type: string + enum: + - ALLOWED + - NOT_ALLOWED + - type: string + RequestedQosMonitoringParameter: + anyOf: + - type: string + enum: + - DOWNLINK + - UPLINK + - ROUND_TRIP + - type: string + ReportingFrequency: + anyOf: + - type: string + enum: + - EVENT_TRIGGERED + - PERIODIC + - SESSION_RELEASE + - type: string + SmPolicyAssociationReleaseCause: + anyOf: + - type: string + enum: + - UNSPECIFIED + - UE_SUBSCRIPTION + - INSUFFICIENT_RES + - VALIDATION_CONDITION_NOT_MET + - type: string + PduSessionRelCause: + anyOf: + - type: string + enum: + - PS_TO_CS_HO + - type: string + MaPduIndication: + anyOf: + - type: string + enum: + - MA_PDU_REQUEST + - MA_PDU_NETWORK_UPGRADE_ALLOWED + - type: string + AtsssCapability: + anyOf: + - type: string + enum: + - MPTCP_ATSSS_LL_WITH_ASMODE_UL + - MPTCP_ATSSS_LL_WITH_EXSDMODE_DL_ASMODE_UL + - MPTCP_ATSSS_LL_WITH_ASMODE_DLUL + - ATSSS_LL + - MPTCP_ATSSS_LL + - type: string +# + NetLocAccessSupport: + anyOf: + - type: string + enum: + - ANR_NOT_SUPPORTED + - TZR_NOT_SUPPORTED + - LOC_NOT_SUPPORTED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - ANR_NOT_SUPPORTED: Indicates that the access network does not support the report of access network information. + - TZR_NOT_SUPPORTED: Indicates that the access network does not support the report of UE time zone. + - LOC_NOT_SUPPORTED: Indicates that the access network does not support the report of UE Location (or PLMN Id). + PolicyDecisionFailureCode: + anyOf: + - type: string + enum: + - TRA_CTRL_DECS_ERR + - QOS_DECS_ERR + - CHG_DECS_ERR + - USA_MON_DECS_ERR + - QOS_MON_DECS_ERR + - CON_DATA_ERR + - type: string +# + NotificationControlIndication: + anyOf: + - type: string + enum: + - DDN_FAILURE + - DDD_STATUS + - type: string +# diff --git a/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml b/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml new file mode 100644 index 0000000000000000000000000000000000000000..a56d94f1fdd6a44fd671881c579bec90d1e3d679 --- /dev/null +++ b/OpenAPI/TS29514_Npcf_PolicyAuthorization.yaml @@ -0,0 +1,1790 @@ +##### Special note: CT R16 local copy for SA5 OAM Forge branch only, it shall not be used otherwise. S5-222029 on 4.4.2022 +# Partial commented out: (impacted attributes) +# AppSessionContextReqData AppSessionContextUpdateData EventsSubscReqData +# EventsSubscReqDataRm EventsNotification OutOfCreditInformation +openapi: 3.0.0 +info: + title: Npcf_PolicyAuthorization Service API + version: 1.1.5 + description: | + PCF Policy Authorization Service. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.514 V16.10.0; 5G System; Policy Authorization Service;Stage 3. + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.514/' +# +servers: + - url: '{apiRoot}/npcf-policyauthorization/v1' + variables: + apiRoot: + default: https://example.com + description: apiRoot as defined in subclause 4.4 of 3GPP TS 29.501 + +security: + - {} + - oAuth2ClientCredentials: + - npcf-policyauthorization +paths: + /app-sessions: + post: + summary: Creates a new Individual Application Session Context resource + operationId: PostAppSessions + tags: + - Application Sessions (Collection) + requestBody: + description: Contains the information for the creation the resource + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + responses: + '201': + description: Successful creation of the resource + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + headers: + Location: + description: 'Contains the URI of the created individual application session context resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId} or the URI of the created events subscription sub-resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription}' + required: true + schema: + type: string + '303': + description: See Other. The result of the HTTP POST request would be equivalent to the existing Application Session Context. + headers: + Location: + description: 'Contains the URI of the existing individual Application Session Context resource.' + required: true + schema: + type: string + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: 'Indicates the time the AF has to wait before making a new request. It can be a non-negative integer (decimal number) indicating the number of seconds the AF has to wait before making a new request or an HTTP-date after which the AF can retry a new request.' + schema: + anyOf: + - type: integer + - type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + terminationRequest: + '{$request.body#/ascReqData/notifUri}/terminate': + post: + requestBody: + description: Request of the termination of the Individual Application Session Context + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/TerminationInfo' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + eventNotification: + '{$request.body#/ascReqData/evSubsc/notifUri}/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + detected5GsBridgeForPduSession: + '{$request.body#/ascReqData/evSubsc/notifUri}/new-bridge': + post: + requestBody: + description: Notification of a new 5GS Bridge detected in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PduSessionTsnBridge' + responses: + '204': + description: The receipt of the notification is acknowledged + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + /app-sessions/pcscf-restoration: + post: + summary: "Indicates P-CSCF restoration and does not create an Individual Application Session Context" + operationId: PcscfRestoration + tags: + - PCSCF Restoration Indication + requestBody: + description: PCSCF Restoration Indication + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/PcscfRestorationRequestData' + responses: + '204': + description: The deletion is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# + /app-sessions/{appSessionId}: + get: + summary: "Reads an existing Individual Application Session Context" + operationId: GetAppSession + tags: + - Individual Application Session Context (Document) + parameters: + - name: appSessionId + description: string identifying the resource + in: path + required: true + schema: + type: string + responses: + '200': + description: A representation of the resource is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '406': + $ref: 'TS29571_CommonData.yaml#/components/responses/406' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + patch: + summary: "Modifies an existing Individual Application Session Context" + operationId: ModAppSession + tags: + - Individual Application Session Context (Document) + parameters: + - name: appSessionId + description: string identifying the resource + in: path + required: true + schema: + type: string + requestBody: + description: modification of the resource. + required: true + content: + application/merge-patch+json: + schema: + $ref: '#/components/schemas/AppSessionContextUpdateDataPatch' + responses: + '200': + description: successful modification of the resource and a representation of that resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The successful modification + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ExtendedProblemDetails' + headers: + Retry-After: + description: 'Indicates the time the AF has to wait before making a new request. It can be a non-negative integer (decimal number) indicating the number of seconds the AF has to wait before making a new request or an HTTP-date after which the AF can retry a new request.' + schema: + anyOf: + - type: integer + - type: string + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{$request.body#/ascReqData/evSubsc/notifUri}/notify': + post: + requestBody: + description: Notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# +# + /app-sessions/{appSessionId}/delete: + post: + summary: "Deletes an existing Individual Application Session Context" + operationId: DeleteAppSession + tags: + - Individual Application Session Context (Document) + parameters: + - name: appSessionId + description: string identifying the Individual Application Session Context resource + in: path + required: true + schema: + type: string + requestBody: + description: deletion of the Individual Application Session Context resource, req notification + required: false + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '200': + description: The deletion of the resource is confirmed and a resource is returned + content: + application/json: + schema: + $ref: '#/components/schemas/AppSessionContext' + '204': + description: The deletion is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +# + /app-sessions/{appSessionId}/events-subscription: + put: + summary: "creates or modifies an Events Subscription subresource" + operationId: updateEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: string identifying the Events Subscription resource + in: path + required: true + schema: + type: string + requestBody: + description: Creation or modification of an Events Subscription resource. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscReqData' + responses: + '201': + description: The creation of the Events Subscription resource is confirmed and its representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' + headers: + Location: + description: 'Contains the URI of the created Events Subscription resource, according to the structure: {apiRoot}/npcf-policyauthorization/v1/app-sessions/{appSessionId}/events-subscription}' + required: true + schema: + type: string + '200': + description: The modification of the Events Subscription resource is confirmed its representation is returned. + content: + application/json: + schema: + $ref: '#/components/schemas/EventsSubscPutData' + '204': + description: The modification of the Events Subscription subresource is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + callbacks: + eventNotification: + '{$request.body#/notifUri}/notify': + post: + requestBody: + description: Contains the information for the notification of an event occurrence in the PCF. + required: true + content: + application/json: + schema: + $ref: '#/components/schemas/EventsNotification' + responses: + '204': + description: The receipt of the notification is acknowledged. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '411': + $ref: 'TS29571_CommonData.yaml#/components/responses/411' + '413': + $ref: 'TS29571_CommonData.yaml#/components/responses/413' + '415': + $ref: 'TS29571_CommonData.yaml#/components/responses/415' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' + delete: + summary: deletes the Events Subscription subresource + operationId: DeleteEventsSubsc + tags: + - Events Subscription (Document) + parameters: + - name: appSessionId + description: string identifying the Individual Application Session Context resource + in: path + required: true + schema: + type: string + responses: + '204': + description: The deletion of the of the Events Subscription sub-resource is confirmed without returning additional data. + '307': + $ref: 'TS29571_CommonData.yaml#/components/responses/307' + '308': + $ref: 'TS29571_CommonData.yaml#/components/responses/308' + '400': + $ref: 'TS29571_CommonData.yaml#/components/responses/400' + '401': + $ref: 'TS29571_CommonData.yaml#/components/responses/401' + '403': + $ref: 'TS29571_CommonData.yaml#/components/responses/403' + '404': + $ref: 'TS29571_CommonData.yaml#/components/responses/404' + '429': + $ref: 'TS29571_CommonData.yaml#/components/responses/429' + '500': + $ref: 'TS29571_CommonData.yaml#/components/responses/500' + '503': + $ref: 'TS29571_CommonData.yaml#/components/responses/503' + default: + $ref: 'TS29571_CommonData.yaml#/components/responses/default' +components: + securitySchemes: + oAuth2ClientCredentials: + type: oauth2 + flows: + clientCredentials: + tokenUrl: '{nrfApiRoot}/oauth2/token' + scopes: + npcf-policyauthorization: Access to the Npcf_PolicyAuthorization API + schemas: + AppSessionContext: + description: Represents an Individual Application Session Context resource. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextReqData' + ascRespData: + $ref: '#/components/schemas/AppSessionContextRespData' + evsNotif: + $ref: '#/components/schemas/EventsNotification' + AppSessionContextReqData: + description: Identifies the service requirements of an Individual Application Session Context. + type: object + required: + - notifUri + - suppFeat + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + - required: [ueMac] + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afChargId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ApplicationChargingId' + afReqData: + $ref: '#/components/schemas/AfRequestedData' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + aspId: + $ref: '#/components/schemas/AspId' +# bdtRefId: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqData' + mcpttId: + description: indication of MCPTT service request + type: string + mcVideoId: + description: indication of MCVideo service request + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + minProperties: 1 + ipDomain: + type: string + mpsId: + description: indication of MPS service request + type: string + mcsId: + description: indication of MCS service request + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformation' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + servUrn: + $ref: '#/components/schemas/ServiceUrn' + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + sponId: + $ref: '#/components/schemas/SponId' + sponStatus: + $ref: '#/components/schemas/SponsoringStatus' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + ueMac: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + AppSessionContextRespData: + description: Describes the authorization data of an Individual Application Session Context created by the PCF. + type: object + properties: + servAuthInfo: + $ref: '#/components/schemas/ServAuthInfo' + ueIds: + type: array + items: + $ref: '#/components/schemas/UeIdentityInfo' + minItems: 1 + suppFeat: + $ref: 'TS29571_CommonData.yaml#/components/schemas/SupportedFeatures' + AppSessionContextUpdateDataPatch: + description: Identifies the modifications to an Individual Application Session Context and/or the modifications to the sub-resource Events Subscription. + type: object + properties: + ascReqData: + $ref: '#/components/schemas/AppSessionContextUpdateData' + AppSessionContextUpdateData: + description: Identifies the modifications to the "ascReqData" property of an Individual Application Session Context which may include the modifications to the sub-resource Events Subscription. + type: object + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + aspId: + $ref: '#/components/schemas/AspId' +# bdtRefId: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/BdtReferenceId' + evSubsc: + $ref: '#/components/schemas/EventsSubscReqDataRm' + mcpttId: + description: indication of MCPTT service request + type: string + mcVideoId: + description: indication of modification of MCVideo service + type: string + medComponents: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponentRm' + minProperties: 1 + mpsId: + description: indication of MPS service request + type: string + mcsId: + description: indication of MCS service request + type: string + preemptControlInfo: + $ref: '#/components/schemas/PreemptionControlInformationRm' + resPrio: + $ref: '#/components/schemas/ReservPriority' + servInfStatus: + $ref: '#/components/schemas/ServiceInfoStatus' + sipForkInd: + $ref: '#/components/schemas/SipForkingIndication' + sponId: + $ref: '#/components/schemas/SponId' + sponStatus: + $ref: '#/components/schemas/SponsoringStatus' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + EventsSubscReqData: + description: Identifies the events the application subscribes to. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + minItems: 1 + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformation' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 +# usgThres: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThreshold' + notifCorreId: + type: string + EventsSubscReqDataRm: + description: this data type is defined in the same way as the EventsSubscReqData data type, but with the OpenAPI nullable property set to true. + type: object + required: + - events + properties: + events: + type: array + items: + $ref: '#/components/schemas/AfEventSubscription' + notifUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + reqQosMonParams: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RequestedQosMonitoringParameter' + minItems: 1 + qosMon: + $ref: '#/components/schemas/QosMonitoringInformationRm' + reqAnis: + type: array + items: + $ref: '#/components/schemas/RequiredAccessInfo' + minItems: 1 +# usgThres: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/UsageThresholdRm' + notifCorreId: + type: string + nullable: true + MediaComponent: + description: Identifies a media component. + type: object + required: + - medCompN + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirement' + qosReference: + type: string + disUeNotif: + type: boolean + altSerReqs: + type: array + items: + type: string + minItems: 1 + contVer: + $ref: '#/components/schemas/ContentVersion' + codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Float' + flusId: + type: string + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + medCompN: + type: integer + medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponent' + minProperties: 1 + medType: + $ref: '#/components/schemas/MediaType' + minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapability' + preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerability' + prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' + resPrio: + $ref: '#/components/schemas/ReservPriority' + rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32' + tsnQos: + $ref: '#/components/schemas/TsnQosContainer' + tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: '#/components/schemas/TscaiInputContainer' + MediaComponentRm: + description: This data type is defined in the same way as the MediaComponent data type, but with the OpenAPI nullable property set to true + type: object + required: + - medCompN + properties: + afAppId: + $ref: '#/components/schemas/AfAppId' + afRoutReq: + $ref: '#/components/schemas/AfRoutingRequirementRm' + qosReference: + type: string + nullable: true + altSerReqs: + type: array + items: + type: string + minItems: 1 + nullable: true + disUeNotif: + type: boolean + contVer: + $ref: '#/components/schemas/ContentVersion' + codecs: + type: array + items: + $ref: '#/components/schemas/CodecData' + minItems: 1 + maxItems: 2 + desMaxLatency: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' + desMaxLoss: + $ref: 'TS29571_CommonData.yaml#/components/schemas/FloatRm' + flusId: + type: string + nullable: true + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxPacketLossRateDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxPacketLossRateUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketLossRateRm' + maxSuppBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + maxSuppBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + medCompN: + type: integer + medSubComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaSubComponentRm' + minProperties: 1 + medType: + $ref: '#/components/schemas/MediaType' + minDesBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + minDesBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + mirBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + preemptCap: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionCapabilityRm' + preemptVuln: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PreemptionVulnerabilityRm' + prioSharingInd: + $ref: '#/components/schemas/PrioritySharingIndicator' + resPrio: + $ref: '#/components/schemas/ReservPriority' + rrBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + rsBw: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + sharingKeyDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + sharingKeyUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uint32Rm' + tsnQos: + $ref: '#/components/schemas/TsnQosContainerRm' + tscaiInputDl: + $ref: '#/components/schemas/TscaiInputContainer' + tscaiInputUl: + $ref: '#/components/schemas/TscaiInputContainer' + nullable: true + MediaSubComponent: + description: Identifies a media subcomponent + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethfDescs: + type: array + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClass' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + MediaSubComponentRm: + description: This data type is defined in the same way as the MediaSubComponent data type, but with the OpenAPI nullable property set to true. Removable attributes marBwDl and marBwUl are defined with the corresponding removable data type. + type: object + required: + - fNum + properties: + afSigProtocol: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AfSigProtocol' + ethfDescs: + type: array + items: + $ref: '#/components/schemas/EthFlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + fNum: + type: integer + fDescs: + type: array + items: + $ref: '#/components/schemas/FlowDescription' + minItems: 1 + maxItems: 2 + nullable: true + fStatus: + $ref: '#/components/schemas/FlowStatus' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRateRm' + tosTrCl: + $ref: '#/components/schemas/TosTrafficClassRm' + flowUsage: + $ref: '#/components/schemas/FlowUsage' + nullable: true + EventsNotification: + description: describes the notification of a matched event + type: object + required: + - evSubsUri + - evNotifs + properties: + accessType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/AccessType' + addAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + relAccessInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AdditionalAccessInfo' + anChargAddr: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/AccNetChargingAddress' + anChargIds: + type: array + items: + $ref: '#/components/schemas/AccessNetChargingIdentifier' + minItems: 1 + anGwAddr: + $ref: '#/components/schemas/AnGwAddress' + evSubsUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + evNotifs: + type: array + items: + $ref: '#/components/schemas/AfEventNotification' + minItems: 1 + failedResourcAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 + succResourcAllocReports: + type: array + items: + $ref: '#/components/schemas/ResourcesAllocationInfo' + minItems: 1 + noNetLocSupp: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/NetLocAccessSupport' + outOfCredReports: + type: array + items: + $ref: '#/components/schemas/OutOfCreditInformation' + minItems: 1 + plmnId: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PlmnIdNid' + qncReports: + type: array + items: + $ref: '#/components/schemas/QosNotificationControlInfo' + minItems: 1 + qosMonReports: + type: array + items: + $ref: '#/components/schemas/QosMonitoringReport' + minItems: 1 + ranNasRelCauses: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/RanNasRelCause' + minItems: 1 + description: Contains the RAN and/or NAS release cause. + ratType: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RatType' + ueLoc: + $ref: 'TS29571_CommonData.yaml#/components/schemas/UserLocation' + ueLocTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + ueTimeZone: + $ref: 'TS29571_CommonData.yaml#/components/schemas/TimeZone' +# usgRep: +# $ref: 'TS29122_CommonData.yaml#/components/schemas/AccumulatedUsage' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + AfEventSubscription: + description: describes the event information delivered in the subscription + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + notifMethod: + $ref: '#/components/schemas/AfNotifMethod' + repPeriod: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + waitTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DurationSec' + AfEventNotification: + description: describes the event information delivered in the notification + type: object + required: + - event + properties: + event: + $ref: '#/components/schemas/AfEvent' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + TerminationInfo: + description: indicates the cause for requesting the deletion of the Individual Application Session Context resource + type: object + required: + - termCause + - resUri + properties: + termCause: + $ref: '#/components/schemas/TerminationCause' + resUri: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uri' + AfRoutingRequirement: + description: describes the event information delivered in the subscription + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + spVal: + $ref: '#/components/schemas/SpatialValidity' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 + upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + addrPreserInd: + type: boolean + SpatialValidity: + description: describes explicitly the route to an Application location + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + SpatialValidityRm: + description: this data type is defined in the same way as the SpatialValidity data type, but with the OpenAPI nullable property set to true + type: object + required: + - presenceInfoList + properties: + presenceInfoList: + type: object + additionalProperties: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PresenceInfo' + minProperties: 1 + nullable: true + AfRoutingRequirementRm: + description: this data type is defined in the same way as the AfRoutingRequirement data type, but with the OpenAPI nullable property set to true and the spVal and tempVals attributes defined as removable. + type: object + properties: + appReloc: + type: boolean + routeToLocs: + type: array + items: + $ref: 'TS29571_CommonData.yaml#/components/schemas/RouteToLocation' + minItems: 1 + nullable: true + spVal: + $ref: '#/components/schemas/SpatialValidityRm' + tempVals: + type: array + items: + $ref: '#/components/schemas/TemporalValidity' + minItems: 1 + nullable: true + upPathChgSub: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/UpPathChgEvent' + addrPreserInd: + type: boolean + nullable: true + nullable: true + AnGwAddress: + description: describes the address of the access network gateway control node + type: object + anyOf: + - required: [anGwIpv4Addr] + - required: [anGwIpv6Addr] + properties: + anGwIpv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + anGwIpv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + Flows: + description: Identifies the flows + type: object + required: + - medCompN + properties: + contVers: + type: array + items: + $ref: '#/components/schemas/ContentVersion' + minItems: 1 + fNums: + type: array + items: + type: integer + minItems: 1 + medCompN: + type: integer + EthFlowDescription: + description: Identifies an Ethernet flow + type: object + required: + - ethType + properties: + destMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + ethType: + type: string + fDesc: + $ref: '#/components/schemas/FlowDescription' + fDir: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/FlowDirection' + sourceMacAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + vlanTags: + type: array + items: + type: string + minItems: 1 + maxItems: 2 + srcMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + destMacAddrEnd: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + + + ResourcesAllocationInfo: + description: describes the status of the PCC rule(s) related to certain media components. + type: object + properties: + mcResourcStatus: + $ref: '#/components/schemas/MediaComponentResourcesStatus' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string + TemporalValidity: + description: Indicates the time interval(s) during which the AF request is to be applied + type: object + properties: + startTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + stopTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' +# + QosNotificationControlInfo: + description: Indicates whether the QoS targets for a GRB flow are not guaranteed or guaranteed again + type: object + required: + - notifType + properties: + notifType: + $ref: '#/components/schemas/QosNotifType' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + altSerReq: + type: string +# + AcceptableServiceInfo: + description: Indicates the maximum bandwidth that shall be authorized by the PCF. + type: object + properties: + accBwMedComps: + type: object + additionalProperties: + $ref: '#/components/schemas/MediaComponent' + minProperties: 1 + marBwUl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + marBwDl: + $ref: 'TS29571_CommonData.yaml#/components/schemas/BitRate' + + UeIdentityInfo: + description: Represents 5GS-Level UE identities. + type: object + anyOf: + - required: [gpsi] + - required: [pei] + - required: [supi] + properties: + gpsi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Gpsi' + pei: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Pei' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' +# + AccessNetChargingIdentifier: + description: Describes the access network charging identifier. + type: object + required: + - accNetChaIdValue + properties: + accNetChaIdValue: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ChargingId' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 +# + OutOfCreditInformation: + description: Indicates the SDFs without available credit and the corresponding termination action. + type: object + required: + - finUnitAct + properties: +# finUnitAct: +# $ref: 'TS32291_Nchf_ConvergedCharging.yaml#/components/schemas/FinalUnitAction' + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 +# + QosMonitoringInformation: + description: Indicates the QoS Monitoring information to report, i.e. UL and/or DL and or round trip delay. + type: object + properties: + repThreshDl: + type: integer + repThreshUl: + type: integer + repThreshRp: + type: integer +# +# + PduSessionTsnBridge: + description: Contains the new 5GS Bridge information and may contain the DS-TT port and/or NW-TT port management information. + type: object + required: + - tsnBridgeInfo + properties: + tsnBridgeInfo: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/TsnBridgeInfo' + tsnBridgeManCont: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/BridgeManagementContainer' + tsnPortManContDstt: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + tsnPortManContNwtts: + type: array + items: + $ref: 'TS29512_Npcf_SMPolicyControl.yaml#/components/schemas/PortManagementContainer' + minItems: 1 + +# + QosMonitoringInformationRm: + description: this data type is defined in the same way as the QosMonitoringInformation data type, but with the OpenAPI nullable property set to true. + type: object + properties: + repThreshDl: + type: integer + repThreshUl: + type: integer + repThreshRp: + type: integer + nullable: true +# + PcscfRestorationRequestData: + description: Indicates P-CSCF restoration. + type: object + oneOf: + - required: [ueIpv4] + - required: [ueIpv6] + properties: + dnn: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Dnn' + ipDomain: + type: string + sliceInfo: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Snssai' + supi: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Supi' + ueIpv4: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ueIpv6: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + +# +# + QosMonitoringReport: + description: QoS Monitoring reporting information + type: object + properties: + flows: + type: array + items: + $ref: '#/components/schemas/Flows' + minItems: 1 + ulDelays: + type: array + items: + type: integer + minItems: 1 + dlDelays: + type: array + items: + type: integer + minItems: 1 + rtDelays: + type: array + items: + type: integer + minItems: 1 +# + TsnQosContainer: + description: Indicates TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVol' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudget' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevel' +# +# + TsnQosContainerRm: + description: Indicates removable TSC Traffic QoS. + type: object + properties: + maxTscBurstSize: + $ref: 'TS29571_CommonData.yaml#/components/schemas/ExtMaxDataBurstVolRm' + tscPackDelay: + $ref: 'TS29571_CommonData.yaml#/components/schemas/PacketDelBudgetRm' + tscPrioLevel: + $ref: '#/components/schemas/TscPriorityLevelRm' + nullable: true +# + TscaiInputContainer: + description: Indicates TSC Traffic pattern. + type: object + properties: + periodicity: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + burstArrivalTime: + $ref: 'TS29571_CommonData.yaml#/components/schemas/DateTime' + nullable: true +# +# + EventsSubscPutData: + description: Identifies the events the application subscribes to within an Events Subscription sub-resource data. It may contain the notification of the already met events + anyOf: + - $ref: '#/components/schemas/EventsSubscReqData' + - $ref: '#/components/schemas/EventsNotification' +# +# EXTENDED PROBLEMDETAILS +# + ExtendedProblemDetails: + description: Extends ProblemDetails to also include the acceptable service info. + allOf: + - $ref: 'TS29571_CommonData.yaml#/components/schemas/ProblemDetails' + - type: object + properties: + acceptableServInfo: + $ref: '#/components/schemas/AcceptableServiceInfo' + +# +# SIMPLE DATA TYPES +# + AfAppId: + description: Contains an AF application identifier. + type: string + AspId: + description: Contains an identity of an application service provider. + type: string + CodecData: + description: Contains codec related information. + type: string + ContentVersion: + description: Represents the content version of some content. + type: integer + FlowDescription: + description: Defines a packet filter of an IP flow. + type: string + SponId: + description: Contains an identity of a sponsor. + type: string + ServiceUrn: + description: Contains values of the service URN and may include subservices. + type: string + TosTrafficClass: + description: 2-octet string, where each octet is encoded in hexadecimal representation. The first octet contains the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet contains the ToS/Traffic Class mask field. + type: string + TosTrafficClassRm: + description: this data type is defined in the same way as the TosTrafficClass data type, but with the OpenAPI nullable property set to true + type: string + nullable: true + TscPriorityLevel: + type: integer + minimum: 1 + maximum: 8 + TscPriorityLevelRm: + type: integer + minimum: 1 + maximum: 8 + nullable: true +# +# ENUMERATIONS DATA TYPES +# + MediaType: + anyOf: + - type: string + enum: + - AUDIO + - VIDEO + - DATA + - APPLICATION + - CONTROL + - TEXT + - MESSAGE + - OTHER + - type: string +# + ReservPriority: + anyOf: + - type: string + enum: + - PRIO_1 + - PRIO_2 + - PRIO_3 + - PRIO_4 + - PRIO_5 + - PRIO_6 + - PRIO_7 + - PRIO_8 + - PRIO_9 + - PRIO_10 + - PRIO_11 + - PRIO_12 + - PRIO_13 + - PRIO_14 + - PRIO_15 + - PRIO_16 + - type: string +# + ServAuthInfo: + anyOf: + - type: string + enum: + - TP_NOT_KNOWN + - TP_EXPIRED + - TP_NOT_YET_OCURRED + - type: string +# + SponsoringStatus: + anyOf: + - type: string + enum: + - SPONSOR_DISABLED + - SPONSOR_ENABLED + - type: string +# + AfEvent: + anyOf: + - type: string + enum: + - ACCESS_TYPE_CHANGE + - ANI_REPORT + - CHARGING_CORRELATION + - EPS_FALLBACK + - FAILED_RESOURCES_ALLOCATION + - OUT_OF_CREDIT + - PLMN_CHG + - QOS_MONITORING + - QOS_NOTIF + - RAN_NAS_CAUSE + - REALLOCATION_OF_CREDIT + - SUCCESSFUL_RESOURCES_ALLOCATION + - TSN_BRIDGE_INFO + - USAGE_REPORT + - type: string +# + AfNotifMethod: + anyOf: + - type: string + enum: + - EVENT_DETECTION + - ONE_TIME + - PERIODIC + - PDU_SESSION_RELEASE + - type: string +# + QosNotifType: + anyOf: + - type: string + enum: + - GUARANTEED + - NOT_GUARANTEED + - type: string +# + TerminationCause: + anyOf: + - type: string + enum: + - ALL_SDF_DEACTIVATION + - PDU_SESSION_TERMINATION + - PS_TO_CS_HO + - type: string +# + MediaComponentResourcesStatus: + anyOf: + - type: string + enum: + - ACTIVE + - INACTIVE + - type: string +# +# + FlowUsage: + anyOf: + - type: string + enum: + - NO_INFO + - RTCP + - AF_SIGNALLING + - type: string + + + FlowStatus: + anyOf: + - type: string + enum: + - ENABLED-UPLINK + - ENABLED-DOWNLINK + - ENABLED + - DISABLED + - REMOVED + - type: string +# + RequiredAccessInfo: + anyOf: + - type: string + enum: + - USER_LOCATION + - UE_TIME_ZONE + - type: string +# + SipForkingIndication: + anyOf: + - type: string + enum: + - SINGLE_DIALOGUE + - SEVERAL_DIALOGUES + - type: string +# + AfRequestedData: + anyOf: + - type: string + enum: + - UE_IDENTITY + - type: string +# + ServiceInfoStatus: + anyOf: + - type: string + enum: + - FINAL + - PRELIMINARY + - type: string +# + PreemptionControlInformation: + anyOf: + - type: string + enum: + - MOST_RECENT + - LEAST_RECENT + - HIGHEST_BW + - type: string +# + PrioritySharingIndicator: + anyOf: + - type: string + enum: + - ENABLED + - DISABLED + - type: string +# + PreemptionControlInformationRm: + anyOf: + - $ref: '#/components/schemas/PreemptionControlInformation' + - $ref: 'TS29571_CommonData.yaml#/components/schemas/NullValue' diff --git a/OpenAPI/TS29571_CommonData.yaml b/OpenAPI/TS29571_CommonData.yaml new file mode 100644 index 0000000000000000000000000000000000000000..76cf71d6161d3745e69d2ff48a24c8ff6a674696 --- /dev/null +++ b/OpenAPI/TS29571_CommonData.yaml @@ -0,0 +1,2866 @@ +##### Special note: CT R16 local copy for SA5 OAM Forge branch only, it shall not be used otherwise. S5-222029 on 4.4.2022 +openapi: 3.0.0 + +info: + version: '1.2.6' + title: 'Common Data Types' + description: | + Common Data Types for Service Based Interfaces. + © 2021, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). + All rights reserved. + +externalDocs: + description: 3GPP TS 29.571 Common Data Types for Service Based Interfaces, version 16.10.0 + url: 'http://www.3gpp.org/ftp/Specs/archive/29_series/29.571/' + +paths: {} +components: + schemas: + +# +# Common Data Types for Generic usage definitiones as defined in clause 5.2 +# + +# +# COMMON SIMPLE DATA TYPES +# + Binary: + format: binary + type: string + BinaryRm: + format: binary + type: string + nullable: true + Bytes: + format: byte + type: string + BytesRm: + format: byte + type: string + nullable: true + Date: + format: date + type: string + DateRm: + format: date + type: string + nullable: true + DateTime: + format: date-time + type: string + DateTimeRm: + format: date-time + type: string + nullable: true + DiameterIdentity: + type: string + pattern: '^([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}$' + DiameterIdentityRm: + type: string + pattern: '^([A-Za-z0-9]+([-A-Za-z0-9]+)\.)+[a-z]{2,}$' + nullable: true + Double: + format: double + type: number + DoubleRm: + format: double + type: number + nullable: true + DurationSec: + type: integer + DurationSecRm: + type: integer + nullable: true + Float: + format: float + type: number + FloatRm: + format: float + type: number + nullable: true + Int32: + format: int32 + type: integer + Int32Rm: + format: int32 + type: integer + nullable: true + Int64: + type: integer + format: int64 + Int64Rm: + format: int64 + type: integer + nullable: true + Ipv4Addr: + type: string + 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])$' + example: '198.51.100.1' + Ipv4AddrRm: + type: string + 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])$' + example: '198.51.100.1' + nullable: true + Ipv4AddrMask: + type: string + 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])(\/([0-9]|[1-2][0-9]|3[0-2]))$' + example: '198.51.0.0/16' + Ipv4AddrMaskRm: + type: string + 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])(\/([0-9]|[1-2][0-9]|3[0-2]))$' + example: '198.51.0.0/16' + nullable: true + Ipv6Addr: + type: string + allOf: + - 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})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + Ipv6AddrRm: + type: string + allOf: + - 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})))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' + example: '2001:db8:85a3::8a2e:370:7334' + nullable: true + Ipv6Prefix: + type: string + allOf: + - 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])))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' + example: '2001:db8:abcd:12::0/64' + Ipv6PrefixRm: + type: string + allOf: + - 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])))$' + - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' + nullable: true + MacAddr48: + type: string + pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$' + MacAddr48Rm: + type: string + pattern: '^([0-9a-fA-F]{2})((-[0-9a-fA-F]{2}){5})$' + nullable: true + SupportedFeatures: + type: string + pattern: '^[A-Fa-f0-9]*$' + Uinteger: + type: integer + minimum: 0 + UintegerRm: + type: integer + minimum: 0 + nullable: true + Uint16: + type: integer + minimum: 0 + maximum: 65535 + Uint16Rm: + type: integer + minimum: 0 + maximum: 65535 + nullable: true + Uint32: + type: integer + minimum: 0 + maximum: 4294967295 #(2^32)-1 + Uint32Rm: + format: int32 + type: integer + minimum: 0 + maximum: 4294967295 #(2^32)-1 + nullable: true + Uint64: + type: integer + minimum: 0 + maximum: 18446744073709551615 #(2^64)-1 + Uint64Rm: + type: integer + minimum: 0 + maximum: 18446744073709551615 #(2^64)-1 + nullable: true + Uri: + type: string + UriRm: + type: string + nullable: true + VarUeId: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$' + VarUeIdRm: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|gci-.+|gli-.+|.+)$' + nullable: true + TimeZone: + type: string + TimeZoneRm: + type: string + nullable: true + StnSr: + type: string + StnSrRm: + type: string + nullable: true + CMsisdn: + type: string + pattern: '^[0-9]{5,15}$' + CMsisdnRm: + type: string + pattern: '^[0-9]{5,15}$' + nullable: true + DayOfWeek: + type: integer + minimum: 1 + maximum: 7 + description: integer between and including 1 and 7 denoting a weekday. 1 shall indicate Monday, and the subsequent weekdays shall be indicated with the next higher numbers. 7 shall indicate Sunday. + TimeOfDay: + type: string + description: String with format partial-time or full-time as defined in clause 5.6 of IETF RFC 3339. Examples, 20:15:00, 20:15:00-08:00 (for 8 hours behind UTC). +# +# COMMON ENUMERATED DATA TYPES +# + + PatchOperation: + anyOf: + - type: string + enum: + - add + - copy + - move + - remove + - replace + - test + - type: string + UriScheme: + anyOf: + - type: string + enum: + - http + - https + - type: string + ChangeType: + anyOf: + - type: string + enum: + - ADD + - MOVE + - REMOVE + - REPLACE + - type: string + HttpMethod: + anyOf: + - type: string + enum: + - GET + - POST + - PUT + - DELETE + - PATCH + - OPTIONS + - HEAD + - CONNECT + - TRACE + - type: string + NullValue: + enum: + - null + +# +# COMMON STRUCTURED DATA TYPES +# +#### +##### Note: this datatype is commented out as to removed extra inference to TS29510_Nnrf_AccessToken.yaml +##### only 1st and this four lines are added, line 298- 301 are commented out simply. By S on 4.4.2022 +#### + ProblemDetails: + type: object + properties: + type: + $ref: '#/components/schemas/Uri' + title: + type: string + status: + type: integer + detail: + type: string + instance: + $ref: '#/components/schemas/Uri' + cause: + type: string + invalidParams: + type: array + items: + $ref: '#/components/schemas/InvalidParam' + minItems: 1 + supportedFeatures: + $ref: '#/components/schemas/SupportedFeatures' +# accessTokenError: +# $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenErr' +# accessTokenRequest: +# $ref: 'TS29510_Nnrf_AccessToken.yaml#/components/schemas/AccessTokenReq' + nrfId: + type: string + Link: + type: object + properties: + href: + $ref: '#/components/schemas/Uri' + LinkRm: + type: object + properties: + href: + $ref: '#/components/schemas/Uri' + nullable: true + PatchItem: + type: object + properties: + op: + $ref: '#/components/schemas/PatchOperation' + path: + type: string + from: + type: string + value: {} + required: + - op + - path + LinksValueSchema: + oneOf: + - type: array + items: + $ref: '#/components/schemas/Link' + minItems: 1 + - $ref: '#/components/schemas/Link' + SelfLink: + type: object + properties: + self: + $ref: '#/components/schemas/Link' + required: + - self + InvalidParam: + type: object + properties: + param: + type: string + reason: + type: string + required: + - param + ChangeItem: + type: object + properties: + op: + $ref: '#/components/schemas/ChangeType' + path: + type: string + from: + type: string + origValue: {} + newValue: {} + required: + - op + - path + NotifyItem: + type: object + required: + - resourceId + - changes + properties: + resourceId: + $ref: '#/components/schemas/Uri' + changes: + type: array + items: + $ref: '#/components/schemas/ChangeItem' + minItems: 1 + ComplexQuery: + oneOf: + - $ref: '#/components/schemas/Cnf' + - $ref: '#/components/schemas/Dnf' + Cnf: + type: object + required: + - cnfUnits + properties: + cnfUnits: + type: array + items: + $ref: '#/components/schemas/CnfUnit' + minItems: 1 + Dnf: + type: object + required: + - dnfUnits + properties: + dnfUnits: + type: array + items: + $ref: '#/components/schemas/DnfUnit' + minItems: 1 + CnfUnit: + type: object + required: + - cnfUnit + properties: + cnfUnit: + type: array + items: + $ref: '#/components/schemas/Atom' + minItems: 1 + DnfUnit: + type: object + required: + - dnfUnit + properties: + dnfUnit: + type: array + items: + $ref: '#/components/schemas/Atom' + minItems: 1 + Atom: + type: object + required: + - attr + - value + properties: + attr: + type: string + value: {} + negative: + type: boolean + PatchResult: + type: object + required: + - report + properties: + report: + type: array + items: + $ref: '#/components/schemas/ReportItem' + minItems: 1 + ReportItem: + type: object + required: + - path + properties: + path: + type: string + HalTemplate: + type: object + required: + - method + properties: + title: + type: string + method: + $ref: '#/components/schemas/HttpMethod' + contentType: + type: string + properties: + type: array + items: + $ref: '#/components/schemas/Property' + minItems: 1 + Property: + type: object + required: + - name + properties: + name: + type: string + required: + type: boolean + regex: + type: string + value: + type: string + RedirectResponse: + type: object + properties: + cause: + type: string + targetScp: + $ref: '#/components/schemas/Uri' + targetSepp: + $ref: '#/components/schemas/Uri' + + + + +# +# Data Types related to Subscription, Identification and Numbering as defined in clause 5.3 +# + +# +# SIMPLE DATA TYPES +# + Dnn: + type: string + DnnRm: + type: string + nullable: true + WildcardDnn: + type: string + pattern: '^[*]$' + WildcardDnnRm: + type: string + pattern: '^[*]$' + nullable: true + Gpsi: + type: string + pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$' + GpsiRm: + type: string + pattern: '^(msisdn-[0-9]{5,15}|extid-[^@]+@[^@]+|.+)$' + nullable: true + GroupId: + type: string + pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' + GroupIdRm: + type: string + pattern: '^[A-Fa-f0-9]{8}-[0-9]{3}-[0-9]{2,3}-([A-Fa-f0-9][A-Fa-f0-9]){1,10}$' + nullable: true + ExternalGroupId: + type: string + pattern: '^extgroupid-[^@]+@[^@]+$' + ExternalGroupIdRm: + type: string + pattern: '^extgroupid-[^@]+@[^@]+$' + nullable: true + Pei: + type: string + pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' + PeiRm: + type: string + pattern: '^(imei-[0-9]{15}|imeisv-[0-9]{16}|mac((-[0-9a-fA-F]{2}){6})(-untrusted)?|eui((-[0-9a-fA-F]{2}){8})|.+)$' + nullable: true + Supi: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$' + SupiRm: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gci-.+|gli-.+|.+)$' + nullable: true + NfInstanceId: + type: string + format: uuid + AmfId: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + AmfRegionId: + type: string + pattern: '^[A-Fa-f0-9]{2}$' + AmfSetId: + type: string + pattern: '^[0-3][A-Fa-f0-9]{2}$' + RfspIndex: + type: integer + minimum: 1 + maximum: 256 + RfspIndexRm: + type: integer + minimum: 1 + maximum: 256 + nullable: true + NfGroupId: + type: string + MtcProviderInformation: + type: string + CagId: + type: string + pattern: '^[A-Fa-f0-9]{8}$' + SupiOrSuci: + type: string + pattern: '^(imsi-[0-9]{5,15}|nai-.+|gli-.+|gci-.+|suci-(0-[0-9]{3}-[0-9]{2,3}|[1-7]-.+)-[0-9]{1,4}-(0-0-.+|[a-fA-F1-9]-([1-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])-[a-fA-F0-9]+)|.+)$' + +# +# STRUCTURED DATA TYPES +# + Guami: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnIdNid' + amfId: + $ref: '#/components/schemas/AmfId' + required: + - plmnId + - amfId + GuamiRm: + anyOf: + - $ref: '#/components/schemas/Guami' + - $ref: '#/components/schemas/NullValue' + NetworkId: + type: object + properties: + mnc: + $ref: '#/components/schemas/Mnc' + mcc: + $ref: '#/components/schemas/Mcc' + + +# +# Data Types related to 5G Network as defined in clause 5.4 +# + +# +# SIMPLE DATA TYPES +# + ApplicationId: + type: string + ApplicationIdRm: + type: string + nullable: true + PduSessionId: + type: integer + minimum: 0 + maximum: 255 + Mcc: + type: string + pattern: '^\d{3}$' + MccRm: + type: string + pattern: '^\d{3}$' + nullable: true + Mnc: + type: string + pattern: '^\d{2,3}$' + MncRm: + type: string + pattern: '^\d{2,3}$' + nullable: true + Tac: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + TacRm: + type: string + pattern: '(^[A-Fa-f0-9]{4}$)|(^[A-Fa-f0-9]{6}$)' + nullable: true + EutraCellId: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + EutraCellIdRm: + type: string + pattern: '^[A-Fa-f0-9]{7}$' + nullable: true + NrCellId: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + NrCellIdRm: + type: string + pattern: '^[A-Fa-f0-9]{9}$' + nullable: true + Dnai: + type: string + DnaiRm: + type: string + nullable: true + 5GMmCause: + $ref: '#/components/schemas/Uinteger' + AmfName: + type: string + AreaCode: + type: string + AreaCodeRm: + type: string + nullable: true + N3IwfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + WAgfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + TngfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + NgeNbId: + type: string + pattern: '^(MacroNGeNB-[A-Fa-f0-9]{5}|LMacroNGeNB-[A-Fa-f0-9]{6}|SMacroNGeNB-[A-Fa-f0-9]{5})$' + Nid: + type: string + pattern: '^[A-Fa-f0-9]{11}$' + NidRm: + type: string + pattern: '^[A-Fa-f0-9]{11}$' + nullable: true + NfSetId: + type: string + NfServiceSetId: + type: string + PlmnAssiUeRadioCapId: + $ref: '#/components/schemas/Bytes' + ManAssiUeRadioCapId: + $ref: '#/components/schemas/Bytes' + TypeAllocationCode: + type: string + pattern: '^[0-9]{8}$' + HfcNId: + type: string + maxLength: 6 + HfcNIdRm: + type: string + maxLength: 6 + nullable: true + ENbId: + type: string + pattern: '^(MacroeNB-[A-Fa-f0-9]{5}|LMacroeNB-[A-Fa-f0-9]{6}|SMacroeNB-[A-Fa-f0-9]{5}|HomeeNB-[A-Fa-f0-9]{7})$' + Gli: + $ref: '#/components/schemas/Bytes' + Gci: + type: string + +# +# ENUMERATED DATA TYPES +# + + AccessType: + type: string + enum: + - 3GPP_ACCESS + - NON_3GPP_ACCESS + AccessTypeRm: + anyOf: + - $ref: '#/components/schemas/AccessType' + - $ref: '#/components/schemas/NullValue' + RatType: + anyOf: + - type: string + enum: + - NR + - EUTRA + - WLAN + - VIRTUAL + - NBIOT + - WIRELINE + - WIRELINE_CABLE + - WIRELINE_BBF + - LTE-M + - NR_U + - EUTRA_U + - TRUSTED_N3GA + - TRUSTED_WLAN + - UTRA + - GERA + - type: string + RatTypeRm: + anyOf: + - $ref: '#/components/schemas/RatType' + - $ref: '#/components/schemas/NullValue' + PduSessionType: + anyOf: + - type: string + enum: + - IPV4 + - IPV6 + - IPV4V6 + - UNSTRUCTURED + - ETHERNET + - type: string + PduSessionTypeRm: + anyOf: + - $ref: '#/components/schemas/PduSessionType' + - $ref: '#/components/schemas/NullValue' + UpIntegrity: + anyOf: + - type: string + enum: + - REQUIRED + - PREFERRED + - NOT_NEEDED + - type: string + UpIntegrityRm: + anyOf: + - $ref: '#/components/schemas/UpIntegrity' + - $ref: '#/components/schemas/NullValue' + UpConfidentiality: + anyOf: + - type: string + enum: + - REQUIRED + - PREFERRED + - NOT_NEEDED + - type: string + UpConfidentialityRm: + anyOf: + - $ref: '#/components/schemas/UpConfidentiality' + - $ref: '#/components/schemas/NullValue' + SscMode: + anyOf: + - type: string + enum: + - SSC_MODE_1 + - SSC_MODE_2 + - SSC_MODE_3 + - type: string + SscModeRm: + anyOf: + - $ref: '#/components/schemas/SscMode' + - $ref: '#/components/schemas/NullValue' + DnaiChangeType: + anyOf: + - type: string + enum: + - EARLY + - EARLY_LATE + - LATE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - EARLY: Early notification of UP path reconfiguration. + - EARLY_LATE: Early and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event. + - LATE: Late notification of UP path reconfiguration. + DnaiChangeTypeRm: + anyOf: + - $ref: '#/components/schemas/DnaiChangeType' + - $ref: '#/components/schemas/NullValue' + RestrictionType: + anyOf: + - type: string + enum: + - ALLOWED_AREAS + - NOT_ALLOWED_AREAS + - type: string + RestrictionTypeRm: + anyOf: + - $ref: '#/components/schemas/RestrictionType' + - $ref: '#/components/schemas/NullValue' + CoreNetworkType: + anyOf: + - type: string + enum: + - 5GC + - EPC + - type: string + CoreNetworkTypeRm: + anyOf: + - $ref: '#/components/schemas/CoreNetworkType' + - $ref: '#/components/schemas/NullValue' + PresenceState: + anyOf: + - type: string + enum: + - IN_AREA + - OUT_OF_AREA + - UNKNOWN + - INACTIVE + - type: string + StationaryIndication: + anyOf: + - type: string + enum: + - STATIONARY + - MOBILE + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - STATIONARY: Identifies the UE is stationary + - MOBILE: Identifies the UE is mobile + StationaryIndicationRm: + anyOf: + - $ref: '#/components/schemas/StationaryIndication' + - $ref: '#/components/schemas/NullValue' + ScheduledCommunicationType: + anyOf: + - type: string + enum: + - DOWNLINK_ONLY + - UPLINK_ONLY + - BIDIRECTIONAL + - type: string + ScheduledCommunicationTypeRm: + anyOf: + - $ref: '#/components/schemas/ScheduledCommunicationType' + - $ref: '#/components/schemas/NullValue' + TrafficProfile: + anyOf: + - type: string + enum: + - SINGLE_TRANS_UL + - SINGLE_TRANS_DL + - DUAL_TRANS_UL_FIRST + - DUAL_TRANS_DL_FIRST + - MULTI_TRANS + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - SINGLE_TRANS_UL: Uplink single packet transmission. + - SINGLE_TRANS_DL: Downlink single packet transmission. + - DUAL_TRANS_UL_FIRST: Dual packet transmission, firstly uplink packet transmission with subsequent downlink packet transmission. + - DUAL_TRANS_DL_FIRST: Dual packet transmission, firstly downlink packet transmission with subsequent uplink packet transmission. + TrafficProfileRm: + anyOf: + - $ref: '#/components/schemas/TrafficProfile' + - $ref: '#/components/schemas/NullValue' + LcsServiceAuth: + anyOf: + - type: string + enum: + - "LOCATION_ALLOWED_WITH_NOTIFICATION" + - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION" + - "LOCATION_ALLOWED_WITHOUT_RESPONSE" + - "LOCATION_RESTRICTED_WITHOUT_RESPONSE" + - "NOTIFICATION_ONLY" + - "NOTIFICATION_AND_VERIFICATION_ONLY" + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - "LOCATION_ALLOWED_WITH_NOTIFICATION": Location allowed with notification + - "LOCATION_ALLOWED_WITHOUT_NOTIFICATION": Location allowed without notification + - "LOCATION_ALLOWED_WITHOUT_RESPONSE": Location with notification and privacy verification; location allowed if no response + - "LOCATION_RESTRICTED_WITHOUT_RESPONSE": Location with notification and privacy verification; location restricted if no response + - "NOTIFICATION_ONLY": Notification only + - "NOTIFICATION_AND_VERIFICATION_ONLY": Notification and privacy verification only + UeAuth: + anyOf: + - type: string + enum: + - AUTHORIZED + - NOT_AUTHORIZED + - type: string + DlDataDeliveryStatus: + anyOf: + - type: string + enum: + - BUFFERED + - TRANSMITTED + - DISCARDED + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - BUFFERED: The first downlink data is buffered with extended buffering matching the source of the downlink traffic. + - TRANSMITTED: The first downlink data matching the source of the downlink traffic is transmitted after previous buffering or discarding of corresponding packet(s) because the UE of the PDU Session becomes ACTIVE, and buffered data can be delivered to UE. + - DISCARDED: The first downlink data matching the source of the downlink traffic is discarded because the Extended Buffering time, as determined by the SMF, expires or the amount of downlink data to be buffered is exceeded. + DlDataDeliveryStatusRm: + anyOf: + - $ref: '#/components/schemas/DlDataDeliveryStatus' + - $ref: '#/components/schemas/NullValue' + AuthStatus: + anyOf: + - type: string + enum: + - EAP_SUCCESS + - EAP_FAILURE + - PENDING + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - "EAP_SUCCESS": The NSSAA status is EAP-Success. + - "EAP_FAILURE": The NSSAA status is EAP-Failure. + - "PENDING": The NSSAA status is Pending. + TransportProtocol: + anyOf: + - type: string + enum: + - UDP + - TCP + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - UDP: User Datagram Protocol. + - TCP: Transmission Control Protocol. + +# +# STRUCTURED DATA TYPES +# + + Snssai: + type: object + properties: + sst: + type: integer + minimum: 0 + maximum: 255 + sd: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + required: + - sst + + PlmnId: + type: object + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + required: + - mcc + - mnc + PlmnIdRm: + anyOf: + - $ref: '#/components/schemas/PlmnId' + - $ref: '#/components/schemas/NullValue' + Tai: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + tac: + $ref: '#/components/schemas/Tac' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - tac + TaiRm: + anyOf: + - $ref: '#/components/schemas/Tai' + - $ref: '#/components/schemas/NullValue' + Ecgi: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + # PLMN Identity + eutraCellId: + $ref: '#/components/schemas/EutraCellId' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - eutraCellId + EcgiRm: + anyOf: + - $ref: '#/components/schemas/Ecgi' + - $ref: '#/components/schemas/NullValue' + Ncgi: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + nrCellId: + $ref: '#/components/schemas/NrCellId' + nid: + $ref: '#/components/schemas/Nid' + required: + - plmnId + - nrCellId + NcgiRm: + anyOf: + - $ref: '#/components/schemas/Ncgi' + - $ref: '#/components/schemas/NullValue' + UserLocation: + type: object + properties: + eutraLocation: + $ref: '#/components/schemas/EutraLocation' + nrLocation: + $ref: '#/components/schemas/NrLocation' + n3gaLocation: + $ref: '#/components/schemas/N3gaLocation' + utraLocation: + $ref: '#/components/schemas/UtraLocation' + geraLocation: + $ref: '#/components/schemas/GeraLocation' + EutraLocation: + type: object + properties: + tai: + $ref: '#/components/schemas/Tai' + ignoreTai: + type: boolean + default: false + ecgi: + $ref: '#/components/schemas/Ecgi' + ignoreEcgi: + type: boolean + default: false + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + globalNgenbId: + $ref: '#/components/schemas/GlobalRanNodeId' + globalENbId: + $ref: '#/components/schemas/GlobalRanNodeId' + required: + - tai + - ecgi + EutraLocationRm: + anyOf: + - $ref: '#/components/schemas/EutraLocation' + - $ref: '#/components/schemas/NullValue' + NrLocation: + type: object + properties: + tai: + $ref: '#/components/schemas/Tai' + ncgi: + $ref: '#/components/schemas/Ncgi' + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + globalGnbId: + $ref: '#/components/schemas/GlobalRanNodeId' + required: + - tai + - ncgi + NrLocationRm: + anyOf: + - $ref: '#/components/schemas/NrLocation' + - $ref: '#/components/schemas/NullValue' + N3gaLocation: + type: object + properties: + n3gppTai: + $ref: '#/components/schemas/Tai' + n3IwfId: + type: string + pattern: '^[A-Fa-f0-9]+$' + ueIpv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + ueIpv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + portNumber: + $ref: '#/components/schemas/Uinteger' + tnapId: + $ref: '#/components/schemas/TnapId' + protocol: + $ref: '#/components/schemas/TransportProtocol' + twapId: + $ref: '#/components/schemas/TwapId' + hfcNodeId: + $ref: '#/components/schemas/HfcNodeId' + gli: + $ref: '#/components/schemas/Gli' + w5gbanLineType: + $ref: '#/components/schemas/LineType' + gci: + $ref: '#/components/schemas/Gci' + UpSecurity: + type: object + properties: + upIntegr: + $ref: '#/components/schemas/UpIntegrity' + upConfid: + $ref: '#/components/schemas/UpConfidentiality' + required: + - upIntegr + - upConfid + UpSecurityRm: + anyOf: + - $ref: '#/components/schemas/UpSecurity' + - $ref: '#/components/schemas/NullValue' + NgApCause: + type: object + properties: + group: + $ref: '#/components/schemas/Uinteger' + value: + $ref: '#/components/schemas/Uinteger' + required: + - group + - value + BackupAmfInfo: + type: object + properties: + backupAmf: + $ref: '#/components/schemas/AmfName' + guamiList: + type: array + items: + $ref: '#/components/schemas/Guami' + minItems: 1 + required: + - backupAmf + RefToBinaryData: + type: object + properties: + contentId: + type: string + required: + - contentId + RefToBinaryDataRm: + anyOf: + - $ref: '#/components/schemas/RefToBinaryData' + - $ref: '#/components/schemas/NullValue' + RouteToLocation: + type: object + properties: + dnai: + $ref: '#/components/schemas/Dnai' + routeInfo: + $ref: '#/components/schemas/RouteInformation' + routeProfId: + type: string + nullable: true + required: + - dnai + anyOf: + - required: [ routeInfo ] + - required: [ routeProfId ] + nullable: true + RouteInformation: + type: object + properties: + ipv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + portNumber: + $ref: '#/components/schemas/Uinteger' + required: + - portNumber + nullable: true + SubscribedDefaultQos: + type: object + required: + - 5qi + - arp + properties: + 5qi: + $ref: '#/components/schemas/5Qi' + arp: + $ref: '#/components/schemas/Arp' + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + Area: + type: object + oneOf: + - required: + - tacs + - required: + - areaCode + properties: + tacs: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + areaCode: + $ref: '#/components/schemas/AreaCode' + ServiceAreaRestriction: + type: object + properties: + restrictionType: + $ref: '#/components/schemas/RestrictionType' + areas: + type: array + items: + $ref: '#/components/schemas/Area' + maxNumOfTAs: + $ref: '#/components/schemas/Uinteger' + maxNumOfTAsForNotAllowedAreas: + $ref: '#/components/schemas/Uinteger' + allOf: + # + # 1st condition: restrictionType and areas attributes shall be either both absent + # or both present + # + - oneOf: + - not: + required: [ restrictionType ] + - required: [ areas ] + # + # 2nd condition: if restrictionType takes value NOT_ALLOWED_AREAS, + # then maxNumOfTAs shall be absent + # + - anyOf: + - not: + required: [ restrictionType ] + properties: + restrictionType: + type: string + enum: [ NOT_ALLOWED_AREAS ] + - not: + required: [ maxNumOfTAs ] + # + # 3rd condition: if restrictionType takes value ALLOWED_AREAS, + # then maxNumOfTAsForNotAllowedAreas shall be absent + # + - anyOf: + - not: + required: [ restrictionType ] + properties: + restrictionType: + type: string + enum: [ ALLOWED_AREAS ] + - not: + required: [ maxNumOfTAsForNotAllowedAreas ] + WirelineArea: + type: object + properties: + globalLineIds: + type: array + items: + $ref: '#/components/schemas/Gli' + minItems: 1 + hfcNIds: + type: array + items: + $ref: '#/components/schemas/HfcNId' + minItems: 1 + areaCodeB: + $ref: '#/components/schemas/AreaCode' + areaCodeC: + $ref: '#/components/schemas/AreaCode' + WirelineServiceAreaRestriction: + type: object + properties: + restrictionType: + $ref: '#/components/schemas/RestrictionType' + areas: + type: array + items: + $ref: '#/components/schemas/WirelineArea' + PresenceInfo: + type: object + properties: + praId: + type: string + additionalPraId: + type: string + presenceState: + $ref: '#/components/schemas/PresenceState' + trackingAreaList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 1 + ecgiList: + type: array + items: + $ref: '#/components/schemas/Ecgi' + minItems: 1 + ncgiList: + type: array + items: + $ref: '#/components/schemas/Ncgi' + minItems: 1 + globalRanNodeIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + minItems: 1 + globaleNbIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + minItems: 1 + PresenceInfoRm: + type: object + properties: + praId: + type: string + additionalPraId: + type: string + presenceState: + $ref: '#/components/schemas/PresenceState' + trackingAreaList: + type: array + items: + $ref: '#/components/schemas/Tai' + minItems: 0 + ecgiList: + type: array + items: + $ref: '#/components/schemas/Ecgi' + minItems: 0 + ncgiList: + type: array + items: + $ref: '#/components/schemas/Ncgi' + minItems: 0 + globalRanNodeIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + globaleNbIdList: + type: array + items: + $ref: '#/components/schemas/GlobalRanNodeId' + minItems: 1 + nullable: true + GlobalRanNodeId: + type: object + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + n3IwfId: + $ref: '#/components/schemas/N3IwfId' + gNbId: + $ref: '#/components/schemas/GNbId' + ngeNbId: + $ref: '#/components/schemas/NgeNbId' + wagfId: + $ref: '#/components/schemas/WAgfId' + tngfId: + $ref: '#/components/schemas/TngfId' + nid: + $ref: '#/components/schemas/Nid' + eNbId: + $ref: '#/components/schemas/ENbId' + oneOf: + - required: [ n3IwfId ] + - required: [ gNbId ] + - required: [ ngeNbId ] + - required: [ wagfId ] + - required: [ tngfId ] + - required: [ eNbId ] + required: + - plmnId + GNbId: + type: object + properties: + bitLength: + type: integer + minimum: 22 + maximum: 32 + gNBValue: + type: string + pattern: '^[A-Fa-f0-9]{6,8}$' + required: + - bitLength + - gNBValue + AtsssCapability: + type: object + properties: + atsssLL: + type: boolean + default: false + mptcp: + type: boolean + default: false + rttWithoutPmf: + type: boolean + default: false + PlmnIdNid: + type: object + required: + - mcc + - mnc + properties: + mcc: + $ref: '#/components/schemas/Mcc' + mnc: + $ref: '#/components/schemas/Mnc' + nid: + $ref: '#/components/schemas/Nid' + SmallDataRateStatus: + type: object + properties: + remainPacketsUl: + type: integer + minimum: 0 + remainPacketsDl: + type: integer + minimum: 0 + validityTime: + $ref: '#/components/schemas/DateTime' + remainExReportsUl: + type: integer + minimum: 0 + remainExReportsDl: + type: integer + minimum: 0 + ApnRateStatus: + type: object + properties: + remainPacketsUl: + type: integer + minimum: 0 + remainPacketsDl: + type: integer + minimum: 0 + validityTime: + $ref: '#/components/schemas/DateTime' + remainExReportsUl: + type: integer + minimum: 0 + remainExReportsDl: + type: integer + minimum: 0 + HfcNodeId: + type: object + required: + - hfcNId + properties: + hfcNId: + $ref: '#/components/schemas/HfcNId' + HfcNodeIdRm: + anyOf: + - $ref: '#/components/schemas/HfcNodeId' + - $ref: '#/components/schemas/NullValue' + ScheduledCommunicationTime: + type: object + properties: + daysOfWeek: + type: array + items: + $ref: '#/components/schemas/DayOfWeek' + minItems: 1 + maxItems: 6 + description: Identifies the day(s) of the week. If absent, it indicates every day of the week. + timeOfDayStart: + $ref: '#/components/schemas/TimeOfDay' + timeOfDayEnd: + $ref: '#/components/schemas/TimeOfDay' + ScheduledCommunicationTimeRm: + anyOf: + - $ref: '#/components/schemas/ScheduledCommunicationTime' + - $ref: '#/components/schemas/NullValue' + BatteryIndication: + type: object + properties: + batteryInd: + type: boolean + replaceableInd: + type: boolean + rechargeableInd: + type: boolean + BatteryIndicationRm: + anyOf: + - $ref: '#/components/schemas/BatteryIndication' + - $ref: '#/components/schemas/NullValue' + AcsInfo: + type: object + properties: + acsUrl: + $ref: '#/components/schemas/Uri' + acsIpv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + acsIpv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + AcsInfoRm: + anyOf: + - $ref: '#/components/schemas/AcsInfo' + - $ref: '#/components/schemas/NullValue' + NrV2xAuth: + type: object + properties: + vehicleUeAuth: + $ref: '#/components/schemas/UeAuth' + pedestrianUeAuth: + $ref: '#/components/schemas/UeAuth' + LteV2xAuth: + type: object + properties: + vehicleUeAuth: + $ref: '#/components/schemas/UeAuth' + pedestrianUeAuth: + $ref: '#/components/schemas/UeAuth' + Pc5QoSPara: + type: object + required: + - pc5QosFlowList + properties: + pc5QosFlowList: + type: array + items: + $ref: '#/components/schemas/Pc5QosFlowItem' + pc5LinkAmbr: + $ref: '#/components/schemas/BitRate' + Pc5QosFlowItem: + type: object + required: + - pqi + properties: + pqi: + $ref: '#/components/schemas/5Qi' + pc5FlowBitRates: + $ref: '#/components/schemas/Pc5FlowBitRates' + range: + $ref: '#/components/schemas/Uinteger' + Pc5FlowBitRates: + type: object + properties: + guaFbr: + $ref: '#/components/schemas/BitRate' + maxFbr: + $ref: '#/components/schemas/BitRate' + UtraLocation: + type: object + oneOf: + - required: + - cgi + - required: + - sai + - required: + - rai + properties: + cgi: + $ref: '#/components/schemas/CellGlobalId' + sai: + $ref: '#/components/schemas/ServiceAreaId' + lai: + $ref: '#/components/schemas/LocationAreaId' + rai: + $ref: '#/components/schemas/RoutingAreaId' + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + GeraLocation: + type: object + oneOf: + - required: + - cgi + - required: + - sai + - required: + - rai + - required: + - lai + properties: + locationNumber: + type: string + cgi: + $ref: '#/components/schemas/CellGlobalId' + rai: + $ref: '#/components/schemas/RoutingAreaId' + sai: + $ref: '#/components/schemas/ServiceAreaId' + lai: + $ref: '#/components/schemas/LocationAreaId' + vlrNumber: + type: string + mscNumber: + type: string + ageOfLocationInformation: + type: integer + minimum: 0 + maximum: 32767 + ueLocationTimestamp: + $ref: '#/components/schemas/DateTime' + geographicalInformation: + type: string + pattern: '^[0-9A-F]{16}$' + geodeticInformation: + type: string + pattern: '^[0-9A-F]{20}$' + CellGlobalId: + type: object + required: + - plmnId + - lac + - cellId + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + cellId: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + ServiceAreaId: + type: object + required: + - plmnId + - lac + - sac + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + sac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + LocationAreaId: + type: object + required: + - plmnId + - lac + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + RoutingAreaId: + type: object + required: + - plmnId + - lac + - rac + properties: + plmnId: + $ref: '#/components/schemas/PlmnId' + lac: + type: string + pattern: '^[A-Fa-f0-9]{4}$' + rac: + type: string + pattern: '^[A-Fa-f0-9]{2}$' + DddTrafficDescriptor: + type: object + properties: + ipv4Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv4Addr' + ipv6Addr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Ipv6Addr' + portNumber: + $ref: 'TS29571_CommonData.yaml#/components/schemas/Uinteger' + macAddr: + $ref: 'TS29571_CommonData.yaml#/components/schemas/MacAddr48' + MoExpDataCounter: + type: object + required: + - counter + properties: + counter: + type: integer + timeStamp: + $ref: '#/components/schemas/DateTime' + NssaaStatus: + type: object + required: + - snssai + - status + properties: + snssai: + $ref: '#/components/schemas/Snssai' + status: + $ref: '#/components/schemas/AuthStatus' + NssaaStatusRm: + anyOf: + - $ref: '#/components/schemas/NssaaStatus' + - $ref: '#/components/schemas/NullValue' + TnapId: + type: object + properties: + ssId: + type: string + bssId: + type: string + civicAddress: + $ref: '#/components/schemas/Bytes' + TnapIdRm: + anyOf: + - $ref: '#/components/schemas/TnapId' + - $ref: '#/components/schemas/NullValue' + TwapId: + type: object + required: + - ssId + properties: + ssId: + type: string + bssId: + type: string + civicAddress: + $ref: '#/components/schemas/Bytes' + TwapIdRm: + anyOf: + - $ref: '#/components/schemas/TwapId' + - $ref: '#/components/schemas/NullValue' + LineType: + anyOf: + - type: string + enum: + - DSL + - PON + - type: string + description: > + This string provides forward-compatibility with future + extensions to the enumeration but is not used to encode + content defined in the present version of this API. + description: > + Possible values are + - DSL: Identifies a DSL line + - PON: Identifies a PON line + LineTypeRm: + anyOf: + - $ref: '#/components/schemas/LineType' + - $ref: '#/components/schemas/NullValue' + + SnssaiExtension: + description: Extensions to the Snssai data type, sdRanges and wildcardSd shall not be present simultaneously + type: object + not: + required: + - sdRanges + - wildcardSd + properties: + sdRanges: + description: When present, it shall contain the range(s) of Slice Differentiator values supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type + type: array + items: + $ref: '#/components/schemas/SdRange' + minItems: 1 + wildcardSd: + description: When present, it shall be set to true, to indicate that all SD values are supported for the Slice/Service Type value indicated in the sst attribute of the Snssai data type + type: boolean + enum: + - true + + SdRange: + description: A range of SDs (Slice Differentiators) + type: object + properties: + start: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + end: + type: string + pattern: '^[A-Fa-f0-9]{6}$' + +# +# Data types describing alternative data types or combinations of data types +# + ExtSnssai: + allOf: + - $ref: '#/components/schemas/Snssai' + - $ref: '#/components/schemas/SnssaiExtension' + +# +# Data Types related to 5G QoS as defined in clause 5.5 +# + +# +# SIMPLE DATA TYPES +# +# + Qfi: + type: integer + minimum: 0 + maximum: 63 + QfiRm: + type: integer + minimum: 0 + maximum: 63 + nullable: true + 5Qi: + type: integer + minimum: 0 + maximum: 255 + 5QiRm: + type: integer + minimum: 0 + maximum: 255 + nullable: true + BitRate: + type: string + pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' + BitRateRm: + type: string + pattern: '^\d+(\.\d+)? (bps|Kbps|Mbps|Gbps|Tbps)$' + nullable: true + ArpPriorityLevelRm: + type: integer + minimum: 1 + maximum: 15 + nullable: true + ArpPriorityLevel: + type: integer + minimum: 1 + maximum: 15 + nullable: true + description: nullable true shall not be used for this attribute + 5QiPriorityLevel: + type: integer + minimum: 1 + maximum: 127 + 5QiPriorityLevelRm: + type: integer + minimum: 1 + maximum: 127 + nullable: true + PacketDelBudget: + type: integer + minimum: 1 + PacketDelBudgetRm: + type: integer + minimum: 1 + nullable: true + PacketErrRate: + type: string + pattern: '^([0-9]E-[0-9])$' + PacketErrRateRm: + type: string + pattern: '^([0-9]E-[0-9])$' + nullable: true + PacketLossRate: + type: integer + minimum: 0 + maximum: 1000 + PacketLossRateRm: + type: integer + minimum: 0 + maximum: 1000 + nullable: true + AverWindow: + type: integer + minimum: 1 + maximum: 4095 + default: 2000 + AverWindowRm: + type: integer + maximum: 4095 + default: 2000 + minimum: 1 + nullable: true + MaxDataBurstVol: + type: integer + minimum: 1 + maximum: 4095 + MaxDataBurstVolRm: + type: integer + minimum: 1 + maximum: 4095 + nullable: true + SamplingRatio: + type: integer + minimum: 1 + maximum: 100 + SamplingRatioRm: + type: integer + minimum: 1 + maximum: 100 + nullable: true + RgWirelineCharacteristics: + $ref: '#/components/schemas/Bytes' + RgWirelineCharacteristicsRm: + anyOf: + - $ref: '#/components/schemas/RgWirelineCharacteristics' + - $ref: '#/components/schemas/NullValue' + ExtMaxDataBurstVol: + type: integer + minimum: 4096 + maximum: 2000000 + ExtMaxDataBurstVolRm: + type: integer + minimum: 4096 + maximum: 2000000 + nullable: true + ExtPacketDelBudget: + type: integer + minimum: 1 + ExtPacketDelBudgetRm: + type: integer + minimum: 1 + nullable: true + +# +# ENUMERATED DATA TYPES +# + + PreemptionCapability: + anyOf: + - type: string + enum: + - NOT_PREEMPT + - MAY_PREEMPT + - type: string + PreemptionCapabilityRm: + anyOf: + - $ref: '#/components/schemas/PreemptionCapability' + - $ref: '#/components/schemas/NullValue' + PreemptionVulnerability: + anyOf: + - type: string + enum: + - NOT_PREEMPTABLE + - PREEMPTABLE + - type: string + PreemptionVulnerabilityRm: + anyOf: + - $ref: '#/components/schemas/PreemptionVulnerability' + - $ref: '#/components/schemas/NullValue' + ReflectiveQoSAttribute: + anyOf: + - type: string + enum: + - RQOS + - NO_RQOS + - type: string + ReflectiveQoSAttributeRm: + anyOf: + - $ref: '#/components/schemas/ReflectiveQoSAttribute' + - $ref: '#/components/schemas/NullValue' + NotificationControl: + anyOf: + - type: string + enum: + - REQUESTED + - NOT_REQUESTED + - type: string + NotificationControlRm: + anyOf: + - $ref: '#/components/schemas/NotificationControl' + - $ref: '#/components/schemas/NullValue' + QosResourceType: + anyOf: + - type: string + enum: + - NON_GBR + - NON_CRITICAL_GBR + - CRITICAL_GBR + - type: string + QosResourceTypeRm: + anyOf: + - $ref: '#/components/schemas/QosResourceType' + - $ref: '#/components/schemas/NullValue' + AdditionalQosFlowInfo: + anyOf: + - anyOf: + - type: string + enum: + - MORE_LIKELY + - type: string + - $ref: '#/components/schemas/NullValue' +# + +# +# STRUCTURED DATA TYPES +# + + Arp: + type: object + properties: + priorityLevel: + $ref: '#/components/schemas/ArpPriorityLevel' + preemptCap: + $ref: '#/components/schemas/PreemptionCapability' + preemptVuln: + $ref: '#/components/schemas/PreemptionVulnerability' + required: + - priorityLevel + - preemptCap + - preemptVuln + ArpRm: + anyOf: + - $ref: '#/components/schemas/Arp' + - $ref: '#/components/schemas/NullValue' + Ambr: + type: object + properties: + uplink: + $ref: '#/components/schemas/BitRate' + downlink: + $ref: '#/components/schemas/BitRate' + required: + - uplink + - downlink + AmbrRm: + anyOf: + - $ref: '#/components/schemas/Ambr' + - $ref: '#/components/schemas/NullValue' + Dynamic5Qi: + type: object + properties: + resourceType: + $ref: '#/components/schemas/QosResourceType' + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + packetDelayBudget: + $ref: '#/components/schemas/PacketDelBudget' + packetErrRate: + $ref: '#/components/schemas/PacketErrRate' + averWindow: + $ref: '#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: '#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: '#/components/schemas/ExtMaxDataBurstVol' + extPacketDelBudget: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetDl: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetUl: + $ref: '#/components/schemas/ExtPacketDelBudget' + required: + - resourceType + - priorityLevel + - packetDelayBudget + - packetErrRate + NonDynamic5Qi: + type: object + properties: + priorityLevel: + $ref: '#/components/schemas/5QiPriorityLevel' + averWindow: + $ref: '#/components/schemas/AverWindow' + maxDataBurstVol: + $ref: '#/components/schemas/MaxDataBurstVol' + extMaxDataBurstVol: + $ref: '#/components/schemas/ExtMaxDataBurstVol' + cnPacketDelayBudgetDl: + $ref: '#/components/schemas/ExtPacketDelBudget' + cnPacketDelayBudgetUl: + $ref: '#/components/schemas/ExtPacketDelBudget' + minProperties: 0 + +# +# Data Types related to 5G Trace as defined in clause 5.6 +# + +# +# SIMPLE DATA TYPES +# + PhysCellId: + type: integer + minimum: 0 + maximum: 1007 + ArfcnValueNR: + type: integer + minimum: 0 + maximum: 3279165 +# +# +# Enumerations +# + TraceDepth: + anyOf: + - type: string + enum: + - MINIMUM + - MEDIUM + - MAXIMUM + - MINIMUM_WO_VENDOR_EXTENSION + - MEDIUM_WO_VENDOR_EXTENSION + - MAXIMUM_WO_VENDOR_EXTENSION + - type: string + TraceDepthRm: + anyOf: + - $ref: '#/components/schemas/TraceDepth' + - $ref: '#/components/schemas/NullValue' + JobType: + anyOf: + - type: string + enum: + - IMMEDIATE_MDT_ONLY + - LOGGED_MDT_ONLY + - TRACE_ONLY + - IMMEDIATE_MDT_AND_TRACE + - RLF_REPORTS_ONLY + - RCEF_REPORTS_ONLY + - LOGGED_MBSFN_MDT + - type: string + ReportTypeMdt: + anyOf: + - type: string + enum: + - PERIODICAL + - EVENT_TRIGGED + - type: string + MeasurementLteForMdt: + anyOf: + - type: string + enum: + - M1 + - M2 + - M3 + - M4_DL + - M4_UL + - M5_DL + - M5_UL + - M6_DL + - M6_UL + - M7_DL + - M7_UL + - M8 + - M9 + - type: string + MeasurementNrForMdt: + anyOf: + - type: string + enum: + - M1 + - M2 + - M3 + - M4_DL + - M4_UL + - M5_DL + - M5_UL + - M6_DL + - M6_UL + - M7_DL + - M7_UL + - M8 + - M9 + - type: string + SensorMeasurement: + anyOf: + - type: string + enum: + - BAROMETRIC_PRESSURE + - UE_SPEED + - UE_ORIENTATION + - type: string + ReportingTrigger: + anyOf: + - type: string + enum: + - PERIODICAL + - EVENT_A2 + - EVENT_A2_PERIODIC + - ALL_RRM_EVENT_TRIGGERS + - type: string + ReportIntervalMdt: + anyOf: + - type: string + enum: + - 120 + - 240 + - 480 + - 640 + - 1024 + - 2048 + - 5120 + - 10240 + - 60000 + - 360000 + - 720000 + - 1800000 + - 3600000 + - type: string + ReportAmountMdt: + anyOf: + - type: string + enum: + - 1 + - 2 + - 4 + - 8 + - 16 + - 32 + - 64 + - infinity + - type: string + EventForMdt: + anyOf: + - type: string + enum: + - OUT_OF_COVERAG + - A2_EVENT + - type: string + LoggingIntervalMdt: + anyOf: + - type: string + enum: + - 128 + - 256 + - 512 + - 1024 + - 2048 + - 3072 + - 4096 + - 6144 + - type: string + LoggingDurationMdt: + anyOf: + - type: string + enum: + - 600 + - 1200 + - 2400 + - 3600 + - 5400 + - 7200 + - type: string + PositioningMethodMdt: + anyOf: + - type: string + enum: + - GNSS + - E_CELL_ID + - type: string + CollectionPeriodRmmLteMdt: + anyOf: + - type: string + enum: + - 1024 + - 1280 + - 2048 + - 2560 + - 5120 + - 10240 + - 60000 + - type: string + MeasurementPeriodLteMdt: + anyOf: + - type: string + enum: + - 1024 + - 1280 + - 2048 + - 2560 + - 5120 + - 10240 + - 60000 + - type: string + + ReportIntervalNrMdt: + anyOf: + - type: string + enum: + - 120 + - 240 + - 480 + - 640 + - 1024 + - 2048 + - 5120 + - 10240 + - 20480 + - 40960 + - 60000 + - 360000 + - 720000 + - 1800000 + - 3600000 + - type: string + + LoggingIntervalNrMdt: + anyOf: + - type: string + enum: + - 128 + - 256 + - 512 + - 1024 + - 2048 + - 3072 + - 4096 + - 6144 + - 320 + - 640 + - infinity + - type: string + + CollectionPeriodRmmNrMdt: + anyOf: + - type: string + enum: + - 1024 + - 2048 + - 5120 + - 10240 + - 60000 + - type: string + + LoggingDurationNrMdt: + anyOf: + - type: string + enum: + - 600 + - 1200 + - 2400 + - 3600 + - 5400 + - 7200 + - type: string +# +# STRUCTURED DATA TYPES +# + TraceData: + type: object + nullable: true + properties: + traceRef: + type: string + pattern: '^[0-9]{3}[0-9]{2,3}-[A-Fa-f0-9]{6}$' + traceDepth: + $ref: '#/components/schemas/TraceDepth' + neTypeList: + type: string + pattern: '^[A-Fa-f0-9]+$' + eventList: + type: string + pattern: '^[A-Fa-f0-9]+$' + collectionEntityIpv4Addr: + $ref: '#/components/schemas/Ipv4Addr' + collectionEntityIpv6Addr: + $ref: '#/components/schemas/Ipv6Addr' + interfaceList: + type: string + pattern: '^[A-Fa-f0-9]+$' + required: + - traceRef + - traceDepth + - neTypeList + - eventList + MdtConfiguration: + type: object + required: + - jobType + properties: + jobType: + $ref: '#/components/schemas/JobType' + reportType: + $ref: '#/components/schemas/ReportTypeMdt' + areaScope: + $ref: '#/components/schemas/AreaScope' + measurementLteList: + type: array + items: + $ref: '#/components/schemas/MeasurementLteForMdt' + measurementNrList: + type: array + items: + $ref: '#/components/schemas/MeasurementNrForMdt' + minItems: 1 + sensorMeasurementList: + type: array + items: + $ref: '#/components/schemas/SensorMeasurement' + minItems: 1 + reportingTriggerList: + type: array + items: + $ref: '#/components/schemas/ReportingTrigger' + minItems: 1 + reportInterval: + $ref: '#/components/schemas/ReportIntervalMdt' + reportIntervalNr: + $ref: '#/components/schemas/ReportIntervalNrMdt' + reportAmount: + $ref: '#/components/schemas/ReportAmountMdt' + eventThresholdRsrp: + type: integer + minimum: 0 + maximum: 97 + eventThresholdRsrpNr: + type: integer + minimum: 0 + maximum: 127 + eventThresholdRsrq: + type: integer + minimum: 0 + maximum: 34 + eventThresholdRsrqNr: + type: integer + minimum: 0 + maximum: 127 + eventList: + type: array + items: + $ref: '#/components/schemas/EventForMdt' + minItems: 1 + loggingInterval: + $ref: '#/components/schemas/LoggingIntervalMdt' + loggingIntervalNr: + $ref: '#/components/schemas/LoggingIntervalNrMdt' + loggingDuration: + $ref: '#/components/schemas/LoggingDurationMdt' + loggingDurationNr: + $ref: '#/components/schemas/LoggingDurationNrMdt' + positioningMethod: + $ref: '#/components/schemas/PositioningMethodMdt' + addPositioningMethodList: + type: array + items: + $ref: '#/components/schemas/PositioningMethodMdt' + minItems: 1 + collectionPeriodRmmLte: + $ref: '#/components/schemas/CollectionPeriodRmmLteMdt' + collectionPeriodRmmNr: + $ref: '#/components/schemas/CollectionPeriodRmmNrMdt' + measurementPeriodLte: + $ref: '#/components/schemas/MeasurementPeriodLteMdt' + mdtAllowedPlmnIdList: + type: array + items: + $ref: '#/components/schemas/PlmnId' + minItems: 1 + maxItems: 16 + mbsfnAreaList: + type: array + items: + $ref: '#/components/schemas/MbsfnArea' + minItems: 1 + maxItems: 8 + interFreqTargetList: + type: array + items: + $ref: '#/components/schemas/InterFreqTargetInfo' + minItems: 1 + maxItems: 8 + AreaScope: + type: object + properties: + eutraCellIdList: + type: array + items: + $ref: '#/components/schemas/EutraCellId' + minItems: 1 + nrCellIdList: + type: array + items: + $ref: '#/components/schemas/NrCellId' + minItems: 1 + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + tacInfoPerPlmn: + type: object + additionalProperties: + $ref: '#/components/schemas/TacInfo' + TacInfo: + type: object + required: + - tacList + properties: + tacList: + type: array + items: + $ref: '#/components/schemas/Tac' + minItems: 1 + MbsfnArea: + type: object + properties: + mbsfnAreaId: + type: integer + minimum: 0 + maximum: 255 + carrierFrequency: + type: integer + minimum: 0 + maximum: 262143 + + InterFreqTargetInfo: + required: + - dlCarrierFreq + type: object + properties: + dlCarrierFreq: + $ref: '#/components/schemas/ArfcnValueNR' + cellIdList: + type: array + items: + $ref: '#/components/schemas/PhysCellId' + minItems: 1 + maxItems: 32 + + +# Data Types related to 5G ODB as defined in clause 5.7 + +# +# SIMPLE DATA TYPES +# +# +# +# Enumerations +# + RoamingOdb: + anyOf: + - type: string + enum: + - OUTSIDE_HOME_PLMN + - OUTSIDE_HOME_PLMN_COUNTRY + - type: string + + OdbPacketServices: + anyOf: + - anyOf: + - type: string + enum: + - ALL_PACKET_SERVICES + - ROAMER_ACCESS_HPLMN_AP + - ROAMER_ACCESS_VPLMN_AP + - type: string + - $ref: '#/components/schemas/NullValue' + +# +# STRUCTURED DATA TYPES +# + + OdbData: + type: object + properties: + roamingOdb: + $ref: '#/components/schemas/RoamingOdb' + +# +# Data Types related to Charging as defined in clause 5.8 +# + +# +# SIMPLE DATA TYPES +# +# + ChargingId: + $ref: '#/components/schemas/Uint32' + + ApplicationChargingId: + type: string + + RatingGroup: + $ref: '#/components/schemas/Uint32' + + ServiceId: + $ref: '#/components/schemas/Uint32' + + +# +# Enumerations +# + +# +# STRUCTURED DATA TYPES +# + SecondaryRatUsageReport: + type: object + properties: + secondaryRatType: + $ref: '#/components/schemas/RatType' + qosFlowsUsageData: + type: array + items: + $ref: '#/components/schemas/QosFlowUsageReport' + minItems: 1 + required: + - secondaryRatType + - qosFlowsUsageData + + QosFlowUsageReport: + type: object + properties: + qfi: + $ref: '#/components/schemas/Qfi' + startTimeStamp: + $ref: '#/components/schemas/DateTime' + endTimeStamp: + $ref: '#/components/schemas/DateTime' + downlinkVolume: + $ref: '#/components/schemas/Int64' + uplinkVolume: + $ref: '#/components/schemas/Int64' + required: + - qfi + - startTimeStamp + - endTimeStamp + - downlinkVolume + - uplinkVolume + + SecondaryRatUsageInfo: + type: object + properties: + secondaryRatType: + $ref: '#/components/schemas/RatType' + qosFlowsUsageData: + type: array + items: + $ref: '#/components/schemas/QosFlowUsageReport' + minItems: 1 + pduSessionUsageData: + type: array + items: + $ref: '#/components/schemas/VolumeTimedReport' + minItems: 1 + required: + - secondaryRatType + + VolumeTimedReport: + type: object + properties: + startTimeStamp: + $ref: '#/components/schemas/DateTime' + endTimeStamp: + $ref: '#/components/schemas/DateTime' + downlinkVolume: + $ref: '#/components/schemas/Int64' + uplinkVolume: + $ref: '#/components/schemas/Int64' + required: + - startTimeStamp + - endTimeStamp + - downlinkVolume + - uplinkVolume + + +# +# HTTP responses +# + + responses: + '307': + description: Temporary Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + 3gpp-Sbi-Target-Nf-Id: + description: 'Identifier of target NF (service) instance towards which the request is redirected' + schema: + type: string + '308': + description: Permanent Redirect + content: + application/json: + schema: + $ref: '#/components/schemas/RedirectResponse' + headers: + Location: + description: 'The URI pointing to the resource located on the redirect target' + required: true + schema: + type: string + 3gpp-Sbi-Target-Nf-Id: + description: 'Identifier of target NF (service) instance towards which the request is redirected' + schema: + type: string + '400': + description: Bad request + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '401': + description: Unauthorized + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '403': + description: Forbidden + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '404': + description: Not Found + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '405': + description: Method Not Allowed + '408': + description: Request Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '406': + description: 406 Not Acceptable + '409': + description: Conflict + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '410': + description: Gone + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '411': + description: Length Required + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '412': + description: Precondition Failed + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '413': + description: Payload Too Large + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '414': + description: URI Too Long + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '415': + description: Unsupported Media Type + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '429': + description: Too Many Requests + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '500': + description: Internal Server Error + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '501': + description: Not Implemented + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '503': + description: Service Unavailable + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + '504': + description: Gateway Timeout + content: + application/problem+json: + schema: + $ref: '#/components/schemas/ProblemDetails' + default: + description: Generic Error diff --git a/OpenAPI/comDefs.yaml b/OpenAPI/comDefs.yaml deleted file mode 100644 index 04ab6516149335f8742cb617e1acec43bbeac2a4..0000000000000000000000000000000000000000 --- a/OpenAPI/comDefs.yaml +++ /dev/null @@ -1,84 +0,0 @@ -openapi: 3.0.1 -info: - title: Common Type Definitions - version: 16.3.0 - description: >- - OAS 3.0.1 specification of common type definitions in the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.3.0; Generic NRM, Common Type Definitions - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - Long: - type: string - format: long - Float: - type: string - format: float - DateTime: - type: string - format: date-Time - Dn: - type: string - Uri: - type: string - AttributeNameValuePairSet: - type: object - minProperties: 1 - AttributeValueChangeSet: - description: >- - The key in this map is the attribute name. The value of each key is an array. - When only one item is present in the array, it carries the new attribute - value. If two items are present, then the first item carries the old value - and the second item the new value. The items can be of any type including null. - type: object - additionalProperties: - type: array - minItems: 1 - maxItems: 2 - items: - nullable: true - Filter: - type: string - SystemDN: - type: string - NotificationId: - type: integer - NotificationHeader: - description: >- - Header used for all notifications types - type: object - required: - - uri - - notificationId - - notificationType - - eventTime - - systemDn - properties: - uri: - $ref: '#/components/schemas/Uri' - notificationId: - $ref: '#/components/schemas/NotificationId' - notificationType: - oneOf: - - $ref: 'faultMnS.yaml#/components/schemas/AlarmNotificationTypes' - #- $ref: 'provMnS.yaml#/components/schemas/CmNotificationTypes' - # more to be added - eventTime: - $ref: '#/components/schemas/DateTime' - systemDN: - $ref: '#/components/schemas/SystemDN' - ErrorResponse: - description: >- - Default schema for the response message body in case the request - is not successful. - type: object - properties: - error: - type: object - properties: - errorInfo: - type: string diff --git a/OpenAPI/coslaNrm.yaml b/OpenAPI/coslaNrm.yaml deleted file mode 100644 index 1892b8fb3ee95d82109a62a4c8689a1c706fab0b..0000000000000000000000000000000000000000 --- a/OpenAPI/coslaNrm.yaml +++ /dev/null @@ -1,131 +0,0 @@ -openapi: 3.0.3 - -info: - title: coslaNrm - version: 16.4.0 - description: - OAS 3.0.1 specification of the Cosla NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. - -externalDocs: - description: 3GPP TS 28.536 V16.4.0; 5G NRM, Slice NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.536/ - -paths: {} - -components: - - schemas: - -#------------ Type definitions --------------------------------------------------- - - ControlLoopLifeCyclePhase: - anyOf: - - type: string - enum: - - PREPARATION - - COMMISSIONING - - OPERATION - - DECOMMISSIONING - - type: string - - TimeUnit: - anyOf: - - type: string - enum: - - SECOND - - MINUTE - - HOUR - - DAY - - type: string - - OperationalState: - anyOf: - - type: string - enum: - - ENABLED - - DISABLED - - type: string - - AdministrativeState: - anyOf: - - type: string - enum: - - LOCKED - - SHUTTING_DOWN - - UNLOCKED - - type: string - - ObservationTime: - type: integer - - ObservationTimePeriod: - type: object - - AssuranceControlLoopGoal: - type: object - - AssuranceGoalStatus: - type: object - - AssuranceGoalStatusObserved: - type: object - - AssuranceGoalStatusPredicted: - type: object - -#-------- Definition of concrete IOCs -------------------------------------------- - - AssuranceControlLoop-Single: - allOf: - - $ref: 'genericNrm.yaml#/components/schemas/SubNetwork-Attr' - - type: object - properties: - operationalState: - $ref: '#/components/schemas/OperationalState' - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - controlLoopLifeCyclePhase: - $ref: '#/components/schemas/ControlLoopLifeCyclePhase' - observationTimePeriod: - allOf: - - $ref: '#/components/schemas/ObservationTimePeriod' - - type: object - properties: - observationTime: - $ref: '#/components/schemas/ObservationTime' - timeUnit: - $ref: '#/components/schemas/TimeUnit' - AssuranceGoalStatus: - allOf: - - $ref: '#/components/schemas/AssuranceGoalStatus' - - type: object - properties: - assuranceGoalStatusObserved: - $ref: '#/components/schemas/AssuranceGoalStatusObserved' - assuranceGoalStatusPredicted: - $ref: '#/components/schemas/AssuranceGoalStatusPredicted' - managedEntity-Multiple: - $ref: '#/components/schemas/ManagedEntity-Multiple' - assuranceControlLoopGoal: - $ref: '#/components/schemas/AssuranceControlLoopGoal' - - ManagedEntity-Single: - oneOf: - - $ref: 'sliceNrm.yaml#/components/schemas/NetworkSlice' - - $ref: 'sliceNrm.yaml#/components/schemas/NetworkSliceSubnet' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedFunction-Attr' - - $ref: 'genericNrm.yaml#/components/schemas/ManagedElement-Attr' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - AssuranceControlLoop-Multiple: - type: array - items: - $ref: '#/components/schemas/AssuranceControlLoop-Single' - - ManagedEntity-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedEntity-Single' diff --git a/OpenAPI/genericNrm.yaml b/OpenAPI/genericNrm.yaml deleted file mode 100644 index e3b71407f4ee0e5483d6bbcec7a7b4c984f52348..0000000000000000000000000000000000000000 --- a/OpenAPI/genericNrm.yaml +++ /dev/null @@ -1,1590 +0,0 @@ -openapi: 3.0.1 -info: - title: Generic NRM - version: 16.4.0 - description: >- - OAS 3.0.1 specification of the Generic NRM - © 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). - All rights reserved. -externalDocs: - description: 3GPP TS 28.623 V16.4.0; Generic NRM - url: http://www.3gpp.org/ftp/Specs/archive/28_series/28.623/ -paths: {} -components: - schemas: - -#-------- Definition of types----------------------------------------------------- - - DateTime: - type: string - format: date-time - Dn: - type: string - maxLength: 400 - DnList: - type: array - items: - $ref: '#/components/schemas/Dn' - Mcc: - type: string - pattern: '^[0-9]{3}$' - Mnc: - type: string - pattern: '^[0-9]{2,3}$' - AdministrativeState: - type: string - enum: - - LOCKED - - UNLOCKED - OperationalState: - type: string - enum: - - ENABLED - - DISABLED - UsageState: - type: string - enum: - - IDEL - - ACTIVE - - BUSY - RegistrationState: - type: string - enum: - - REGISTERED - - DEREGISTERED - SetOfMcc: - type: array - items: - $ref: '#/components/schemas/Mcc' - ManagedElementType: - type: string - ManagedElementTypeList: - type: array - items: - $ref: '#/components/schemas/ManagedElementType' - VnfParameter: - type: object - properties: - vnfInstanceId: - type: string - vnfdId: - type: string - flavourId: - type: string - autoScalable: - type: boolean - VnfParametersList: - type: array - items: - $ref: '#/components/schemas/VnfParameter' - SiteLatitude: - type: number - format: float - minimum: -90 - maximum: 90 - SiteLongitude: - type: number - format: float - minimum: -180 - maximum: 180 - PeeParameter: - type: object - properties: - siteIdentification: - type: string - siteDescription: - type: string - siteLatitude: - $ref: '#/components/schemas/SiteLatitude' - siteLongitude: - $ref: '#/components/schemas/SiteLongitude' - equipmentType: - type: string - environmentType: - type: string - powerInterface: - type: string - PeeParametersList: - type: array - items: - $ref: '#/components/schemas/PeeParameter' - MonitoringGPList: - type: array - items: - type: integer - ThresholdInfoList: - type: array - items: - $ref: '#/components/schemas/ThresholdInfo' - ThresholdInfo: - type: object - properties: - measurementType: - type: string - direction: - $ref: '#/components/schemas/Direction' - thresholdPack: - $ref: '#/components/schemas/ThresholdPack' - Direction: - enum: - - Increasing - - Decreasing - ThresholdPack: - type: array - items: - $ref: '#/components/schemas/ThresholdPackElement' - ThresholdPackElement: - type: object - properties: - thresholdLevel: - type: integer - thresholdValue: - type: number - hysteresis: - type: number - Operation: - type: object - properties: - name: - type: string - allowedNFTypes: - $ref: '#/components/schemas/NFType' - operationSemantics: - $ref: '#/components/schemas/OperationSemantics' - OperationList: - type: array - items: - $ref: '#/components/schemas/Operation' - NFType: - type: string - description: ' NF name defined in TS 23.501' - enum: - - NRF - - UDM - - AMF - - SMF - - AUSF - - NEF - - PCF - - SMSF - - NSSF - - UDR - - LMF - - GMLC - - 5G_EIR - - SEPP - - UPF - - N3IWF - - AF - - UDSF - - DN - Fqdn: - type: string - OperationSemantics: - type: string - enum: - - REQUEST_RESPONSE - - SUBSCRIBE_NOTIFY - SAP: - type: object - properties: - host: - $ref: '#/components/schemas/HostAddr' - port: - type: integer - NFServiceType: - type: string - enum: - - Namf_Communication - - Namf_EventExposure - - Namf_MT - - Namf_Location - - Nsmf_PDUSession - - Nsmf_EventExposure - - Others - HostAddr: - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - $ref: '#/components/schemas/Fqdn' - Ipv4Addr: - type: string - 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])$' - example: '198.51.100.1' - Ipv4AddrRm: - type: string - 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])$' - example: '198.51.100.1' - nullable: true - Ipv6Addr: - type: string - allOf: - - 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})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - Ipv6AddrRm: - type: string - allOf: - - 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})))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))$' - example: '2001:db8:85a3::8a2e:370:7334' - nullable: true - Ipv6Prefix: - type: string - allOf: - - 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])))$' - - pattern: '^((([^:]+:){7}([^:]+))|((([^:]+:)*[^:]+)?::(([^:]+:)*[^:]+)?))(\/.+)$' - example: '2001:db8:abcd:12::0/64' - Uri: - type: string - TransportProtocol: - anyOf: - - type: string - enum: - - TCP - - type: string - SupportedPerfMetricGroup: - type: object - properties: - performanceMetrics: - type: array - items: - type: string - granularityPeriods: - type: array - items: - type: integer - minimum: 1 - reportingMethods: - type: array - items: - type: string - enum: - - FILE_BASED_LOC_SET_BY_PRODUCER - - FILE_BASED_LOC_SET_BY_CONSUMER - - STREAM_BASED - ReportingCtrl: - oneOf: - - type: object - properties: - fileReportingPeriod: - type: integer - - type: object - properties: - fileReportingPeriod: - type: integer - fileLocation: - $ref: '#/components/schemas/Uri' - - type: object - properties: - streamTarget: - $ref: '#/components/schemas/Uri' - Scope: - type: object - properties: - scopeType: - type: string - enum: - - BASE_ONLY - - BASE_ALL - - BASE_NTH_LEVEL - - BASE_SUBTREE - scopeLevel: - type: integer - NotificationType: - type: string - enum: - - notifyMOICreation - - notifyMOIDeletion - - notifyMOIAttributeValueChanges - - notifyEvent - - notifyNewAlarm - - notifyChangedAlarm - - notifyAckStateChanged - - notifyComments - - notifyCorrelatedNotificationChanged - - notifyChangedAlarmGeneral - - notifyAlarmListRebuilt - - notifyPotentialFaultyAlarmList - - notifyFileReady - - notifyFilePreparationError - - notifyThresholdCrossing - NotificationTypes: - type: array - items: - $ref: '#/components/schemas/NotificationType' - -#-------- Definition of types used in Trace control NRM fragment------------------ - - tjJobType-Type: - type: string - 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. - enum: - - IMMEDIATE_MDT_ONLY - - LOGGED_MDT_ONLY - - TRACE_ONLY - - IMMEDIATE_MDT AND TRACE - - RLF_REPORT_ONLY - - RCEF_REPORT_ONLY - - LOGGED_MBSFN_MDT - - tjListOfInterfaces-Type: - description: The interfaces to be recorded in the Network Element. See 3GPP TS 32.422 clause 5.5 for additional details. - type: object - properties: - MSCServerInterfaces: - type: array - items: - type: string - enum: - - A - - Iu-CS - - Mc - - MAP-G - - MAP-B - - MAP-E - - MAP-F - - MAP-D - - MAP-C - - CAP - MGWInterfaces: - type: array - items: - type: string - enum: - - Mc - - Nb-UP - - Iu-UP - RNCInterfaces: - type: array - items: - type: string - enum: - - Iu-CS - - Iu-PS - - Iur - - Iub - - Uu - SGSNInterfaces: - type: array - items: - type: string - enum: - - Gb - - Iu-PS - - Gn - - MAP-Gr - - MAP-Gd - - MAP-Gf - - Ge - - Gs - - S6d - - S4 - - S3 - - S13 - GGSNInterfaces: - type: array - items: - type: string - enum: - - Gn - - Gi - - Gmb - S-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Mg - - Mr - - Mi - P-CSCFInterfaces: - type: array - items: - type: string - enum: - - Gm - - Mw - I-CSCFInterfaces: - type: array - items: - type: string - enum: - - Cx - - Dx - - Mg - - Mw - MRFCInterfaces: - type: array - items: - type: string - enum: - - Mp - - Mr - MGCFInterfaces: - type: array - items: - type: string - enum: - - Mg - - Mj - - Mn - IBCFInterfaces: - type: array - items: - type: string - enum: - - Ix - - Mx - E-CSCFInterfaces: - type: array - items: - type: string - enum: - - Mw - - Ml - - Mm - - Mi/Mg - BGCFInterfaces: - type: array - items: - type: string - enum: - - Mi - - Mj - - Mk - ASInterfaces: - type: array - items: - type: string - enum: - - Dh - - Sh - - ISC - - Ut - HSSInterfaces: - type: array - items: - type: string - enum: - - MAP-C - - MAP-D - - Gc - - Gr - - Cx - - S6d - - S6a - - Sh - EIRInterfaces: - type: array - items: - type: string - enum: - - MAP-F - - S13 - - MAP-Gf - BM-SCInterfaces: - type: array - items: - type: string - enum: - - Gmb - MMEInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - S3 - - S6a - - S10 - - S11 - - S13 - SGWInterfaces: - type: array - items: - type: string - enum: - - S4 - - S5 - - S8 - - S11 - - Gxc - PDN_GWInterfaces: - type: array - items: - type: string - enum: - - S2a - - S2b - - S2c - - S5 - - S6b - - Gx - - S8 - - SGi - eNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - en-gNBInterfaces: - type: array - items: - type: string - enum: - - S1-MME - - X2 - - Uu - - F1-C - - E1 - AMFInterfaces: - type: array - items: - type: string - enum: - - N1 - - N2 - - N8 - - N11 - - N12 - - N14 - - N15 - - N20 - - N22 - - N26 - AUSFInterfaces: - type: array - items: - type: string - enum: - - N12 - - N13 - NEFInterfaces: - type: array - items: - type: string - enum: - - N29 - - N30 - - N33 - NRFInterfaces: - type: array - items: - type: string - enum: - - N27 - NSSFInterfaces: - type: array - items: - type: string - enum: - - N22 - - N31 - PCFInterfaces: - type: array - items: - type: string - enum: - - N5 - - N7 - - N15 - SMFInterfaces: - type: array - items: - type: string - enum: - - N4 - - N7 - - N10 - - N11 - - S5-C - SMSFInterfaces: - type: array - items: - type: string - enum: - - N20 - - N21 - UDMInterfaces: - type: array - items: - type: string - enum: - - N8 - - N10 - - N13 - - N21 - UPFInterfaces: - type: array - items: - type: string - enum: - - N4 - ng-eNBInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - gNB-CU-CPInterfaces: - type: array - items: - type: string - enum: - - NG-C - - Xn-C - - Uu - - F1-C - - E1 - - X2-C - gNB-CU-UPInterfaces: - type: array - items: - type: string - enum: - - E1 - gNB-DUInterfaces: - type: array - items: - type: string - enum: - - F1-C - - tjListOfNeTypes-Type: - description: The Network Element types where Trace Session activation is needed. See 3GPP TS 32.422 clause 5.4 for additional details. - type: array - items: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - RNC - - BM_SC - - MME - - SGW - - PGW - - ENB - - EN_GNB - - GNB_CU_CP - - GNB_CU_UP - - GNB_DU - - tjPLMNTaget-Type: - type: object - 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. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - - tjStreamingTraceConsumerURI-Type: - type: string - 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. - format: uri - - tjTraceCollectionEntityAddress-Type: - description: The IP address to which the Trace records shall be transferred. See 3GPP TS 32.422 clause 5.9 for additional details. - oneOf: - - $ref: '#/components/schemas/Ipv4Addr' - - $ref: '#/components/schemas/Ipv6Addr' - - tjTraceDepth-Type: - 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. - type: string - enum: - - MINIMUM - - MEDIUM - - MAXIMUM - - VENDORMINIMUM - - VENDORMEDIUM - - VENDORMAXIMUM - - tjTraceReference-Type: - type: object - 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. - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - traceId: - type: integer - required: - - mcc - - mnc - - traceId - - tjTraceReportingFormat-Type: - type: string - 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. - enum: - - FILE-BASED - - STREAMING - - tjTraceTarget-Type: - type: string - description: Type of trace target. For additional details see 3GPP TS 32.422. - enum: - - IMSI - - IMEI - - IMEISV - - PUBLIC_ID - - UTRAN_CELL - - E-UTRAN_CELL - - NG-RAN_CELL - - eNB - - RNC - - gNB - - tjTriggeringEvent-Type: - type: object - 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. - properties: - NetworkElement: - type: string - enum: - - MSC_SERVER - - SGSN - - MGW - - GGSN - - BM_SC - - MME - - SGW - - PGW - - AMF - - SMF - - PCF - - UPF - EventBitmap: - type: integer - required: - - NetworkElement - - EventBitmap - - tjMDTAnonymizationOfData-Type: - description: Specifies level of MDT anonymization. For additional details see 3GPP TS 32.422 clause 5.10.12. - type: string - enum: - - NO_IDENTITY - - TAC_OF_IMEI - - tjMDTAreaConfigurationForNeighCell-Type: - 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. - type: array - items: - type: object - properties: - frequency: - type: string - cell: - type: string - - tjMDTAreaScope-Type: - 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. - allOf: - - $ref: '#/components/schemas/DnList' - - tjMDTCollectionPeriodRrmLte-Type: - description: See details in 3GPP TS 32.422 clause 5.10.20. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTCollectionPeriodRrmUmts-Type: - description: See details in 3GPP TS 32.422 clause 5.10.21. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTEventListForTriggeredMeasurement-Type: - description: See details in 3GPP TS 32.422 clause 5.10.28. - type: string - enum: - - OUT_OF_COVERAGE - - A2_EVENT - - tjMDTEventThreshold-Type: - description: See details in 3GPP TS 32.422 clause 5.10.7, 5.10.7a, 5.10.13 and 5.10.14. - type: object - properties: - EventThresholdRSRP: - type: integer - minimum: 0 - maximum: 97 - EventThresholdRSRQ: - type: integer - minimum: 0 - maximum: 34 - EventThreshold1F: - type: object - properties: - CPICH_RSCP: - type: integer - minimum: -120 - maximum: 25 - CPICH_EcNo: - type: integer - minimum: -24 - maximum: 0 - PathLoss: - type: integer - minimum: 30 - maximum: 165 - EventThreshold1I: - type: integer - minimum: -120 - maximum: 25 - - tjMDTListOfMeasurements-Type: - description: See details in 3GPP TS 32.422 clause 5.10.3 for details. - type: object - properties: - UMTS: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6_DL - - M6_UL - - M7_DL - - M7_UL - LTE: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M1_EVENT_TRIGGERED - - M6 - - M7 - - M8 - - M9 - NR: - type: array - items: - type: string - enum: - - M1 - - M2 - - M3 - - M4 - - M5 - - M6 - - M7 - - M8 - - M9 - - tjMDTLoggingDuration-Type: - description: See details in 3GPP TS 32.422 clause 5.10.9. - type: string - enum: - - 600s - - 1200s - - 2400s - - 3600s - - 5400s - - 7200s - - tjMDTLoggingInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.8. - type: string - enum: - - 1.28s - - 2.56s - - 5.12s - - 10.24s - - 20.48s - - 30.72s - - 40.96s - - 61.44s - - tjMDTMBSFNAreaList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.25. - type: array - items: - type: object - properties: - mbsfnAreaId: - type: integer - minimum: 1 - earfcn: - type: integer - minimum: 1 - required: - - mbsfnAreaId - - earfcn - - tjMDTMeasurementPeriodLTE-Type: - description: See details in 3GPP TS 32.422 clause 5.10.23. - type: string - enum: - - 1024ms - - 1280ms - - 2048ms - - 2560ms - - 5120ms - - 10240ms - - 1min - - tjMDTMeasurementPeriodUMTS-Type: - description: See details in 3GPP TS 32.422 clause 5.10.22. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - tjMDTMeasurementQuantity-Type: - description: See details in 3GPP TS 32.422 clause 5.10.15. - type: string - enum: - - CPICH_EcNo - - CPICH_RSCP - - PathLoss - - tjMDTPLMList-Type: - description: See details in 3GPP TS 32.422 clause 5.10.24. - type: array - items: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - maxItems: 16 - - tjMDTPositioningMethod-Type: - description: See details in 3GPP TS 32.422 clause 5.10.19. - type: string - enum: - - GNSS - - E-CELL_ID - - tjMDTReportAmount-Type: - description: See details in 3GPP TS 32.422 clause 5.10.6. - type: string - enum: - - 1 - - 2 - - 4 - - 8 - - 16 - - 32 - - 64 - - INFINITY - - tjMDTReportingTrigger-Type: - description: See details in 3GPP TS 32.422 clause 5.10.4. - type: array - items: - type: string - enum: - - PERIODICAL - - A2_FOR_LTE - - 1F_FOR_UMTS - - 1I_FOR_UMTS_MCPS_TDD - - A2_TRIGGERED_PERIODIC_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_LTE - - ALL_CONFIGURED_RRM_FOR_UMTS - - tjMDTReportInterval-Type: - description: See details in 3GPP TS 32.422 clause 5.10.5. - type: string - enum: - - 250ms - - 500ms - - 1000ms - - 2000ms - - 3000ms - - 4000ms - - 6000ms - - 8000ms - - 12000ms - - 16000ms - - 20000ms - - 24000ms - - 28000ms - - 32000ms - - 64000ms - - 120ms - - 240ms - - 480ms - - 640ms - - 1024ms - - 2048ms - - 5120ms - - 10240ms - - 60000ms - - 360000ms - - 720000ms - - 1800000ms - - 3600000ms - - tjMDTReportType-Type: - description: Report type for logged NR MDT. See details in 3GPP TS 32.422 clause 5.10.27. - type: string - enum: - - PERIODICAL - - EVENT_TRIGGERED - - tjMDTSensorInformation-Type: - description: See details in 3GPP TS 32.422 clause 5.10.29. - type: array - items: - type: string - enum: - - BAROMETRIC_PRESSURE - - UE_SPEED - - UE_ORIENTATION - - tjMDTTraceCollectionEntityID-Type: - 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. - type: object - properties: - tceID: - type: integer - tcePLMN: - type: object - properties: - mcc: - $ref: '#/components/schemas/Mcc' - mnc: - $ref: '#/components/schemas/Mnc' - required: - - mcc - - mnc - tceAddress: - oneOf: - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - required: - - tceID - - tcePLMN - - tceAddress - - -#-------- end of Definition of types used in Trace control NRM fragment ---------- - - -#-------- Definition of abstract IOC Top ----------------------------------------- - - Top-Attr: - # This definition will be deprecated, when all occurances of Top-Attr - # are replaced by Top. - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - Top: - type: object - properties: - id: - type: string - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - -#-------- Definition of IOCs with new name-containments defined in other TS ------ - - SubNetwork-Attr: - type: object - properties: - dnPrefix: - type: string - userLabel: - type: string - userDefinedNetworkType: - type: string - setOfMcc: - $ref: '#/components/schemas/SetOfMcc' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - ManagedElement-Attr: - type: object - properties: - dnPrefix: - type: string - managedElementTypeList: - $ref: '#/components/schemas/ManagedElementTypeList' - userLabel: - type: string - locationName: - type: string - managedBy: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - swVersion: - type: string - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - SubNetwork-ncO: - type: object - properties: - ManagementNode: - $ref: '#/components/schemas/ManagementNode-Multiple' - MeContext: - $ref: '#/components/schemas/MeContext-Multiple' - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - ManagedElement-ncO: - type: object - properties: - PerfMetricJob: - $ref: '#/components/schemas/PerfMetricJob-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - NtfSubscriptionControl: - $ref: '#/components/schemas/NtfSubscriptionControl-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - AlarmList: - $ref: '#/components/schemas/AlarmList-Single' - -#-------- Definition of abstract IOCs -------------------------------------------- - - ManagedFunction-Attr: - type: object - properties: - userLabel: - type: string - vnfParametersList: - $ref: '#/components/schemas/VnfParametersList' - peeParametersList: - $ref: '#/components/schemas/PeeParametersList' - priorityLabel: - type: integer - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - EP_RP-Attr: - type: object - properties: - userLabel: - type: string - farEndEntity: - type: string - supportedPerfMetricGroups: - type: array - items: - $ref: '#/components/schemas/SupportedPerfMetricGroup' - - TraceJob-Attr: - type: object - description: abstract class used as a container of all TraceJob attributes - properties: - tjJobType: - $ref: '#/components/schemas/tjJobType-Type' - tjListOfInterfaces: - $ref: '#/components/schemas/tjListOfInterfaces-Type' - tjListOfNeTypes: - $ref: '#/components/schemas/tjListOfNeTypes-Type' - tjPLMNTarget: - $ref: '#/components/schemas/tjPLMNTaget-Type' - tjTraceConsumer: - oneOf: - - $ref: '#/components/schemas/tjStreamingTraceConsumerURI-Type' - - $ref: '#/components/schemas/tjTraceCollectionEntityAddress-Type' - tjTraceDepth: - $ref: '#/components/schemas/tjTraceDepth-Type' - tjTraceReference: - $ref: '#/components/schemas/tjTraceReference-Type' - tjTraceReportingFormat: - $ref: '#/components/schemas/tjTraceReportingFormat-Type' - tjTraceTarget: - $ref: '#/components/schemas/tjTraceTarget-Type' - tjTriggeringEvent: - $ref: '#/components/schemas/tjTriggeringEvent-Type' - tjMDTAnonymizationOfData: - $ref: '#/components/schemas/tjMDTAnonymizationOfData-Type' - tjMDTAreaConfigurationForNeighCell: - $ref: '#/components/schemas/tjMDTAreaConfigurationForNeighCell-Type' - tjMDTAreaScope: - $ref: '#/components/schemas/tjMDTAreaScope-Type' - tjMDTCollectionPeriodRrmLte: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmLte-Type' - tjMDTCollectionPeriodRrmUmts: - $ref: '#/components/schemas/tjMDTCollectionPeriodRrmUmts-Type' - tjMDTEventListForTriggeredMeasurement: - $ref: '#/components/schemas/tjMDTEventListForTriggeredMeasurement-Type' - tjMDTEventThreshold: - $ref: '#/components/schemas/tjMDTEventThreshold-Type' - tjMDTListOfMeasurements: - $ref: '#/components/schemas/tjMDTListOfMeasurements-Type' - tjMDTLoggingDuration: - $ref: '#/components/schemas/tjMDTLoggingDuration-Type' - tjMDTLoggingInterval: - $ref: '#/components/schemas/tjMDTLoggingInterval-Type' - tjMDTMBSFNAreaList: - $ref: '#/components/schemas/tjMDTMBSFNAreaList-Type' - tjMDTMeasurementPeriodLTE: - $ref: '#/components/schemas/tjMDTMeasurementPeriodLTE-Type' - tjMDTMeasurementPeriodUMTS: - $ref: '#/components/schemas/tjMDTMeasurementPeriodUMTS-Type' - tjMDTMeasurementQuantity: - $ref: '#/components/schemas/tjMDTMeasurementQuantity-Type' - tjMDTPLMList: - $ref: '#/components/schemas/tjMDTPLMList-Type' - tjMDTPositioningMethod: - $ref: '#/components/schemas/tjMDTPositioningMethod-Type' - tjMDTReportAmount: - $ref: '#/components/schemas/tjMDTReportAmount-Type' - tjMDTReportingTrigger: - $ref: '#/components/schemas/tjMDTReportingTrigger-Type' - tjMDTReportInterval: - $ref: '#/components/schemas/tjMDTReportInterval-Type' - tjMDTReportType: - $ref: '#/components/schemas/tjMDTReportType-Type' - tjMDTSensorInformation: - $ref: '#/components/schemas/tjMDTSensorInformation-Type' - tjMDTTraceCollectionEntityID: - $ref: '#/components/schemas/tjMDTTraceCollectionEntityID-Type' - required: - - tjJobType - - tjTraceReference - - tjTraceConsumer - - tjTraceReportingFormat - - tjTraceTarget - - ManagedFunction-ncO: - type: object - properties: - MeasurementControl: - $ref: '#/components/schemas/MeasurementControl-Multiple' - ThresholdMonitor: - $ref: '#/components/schemas/ThresholdMonitor-Multiple' - ThresholdMonitoringCapability: - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - ManagedNFService: - $ref: '#/components/schemas/ManagedNFService-Multiple' - TraceJob: - $ref: '#/components/schemas/TraceJob-Multiple' - -#-------- Definition of concrete IOCs -------------------------------------------- - - VsDataContainer-Single: - type: object - properties: - id: - type: string - attributes: - type: object - properties: - vsDataType: - type: string - vsDataFormatVersion: - type: string - vsData: - nullable: true - VsDataContainer: - $ref: '#/components/schemas/VsDataContainer-Multiple' - ManagedNFService-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - nFServiceType: - $ref: '#/components/schemas/NFServiceType' - sAP: - $ref: '#/components/schemas/SAP' - operations: - $ref: '#/components/schemas/OperationList' - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - usageState: - $ref: '#/components/schemas/UsageState' - registrationState: - $ref: '#/components/schemas/RegistrationState' - ManagementNode-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - userLabel: - type: string - managedElements: - $ref: '#/components/schemas/DnList' - vendorName: - type: string - userDefinedState: - type: string - locationName: - type: string - swVersion: - type: string - MeContext-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - dnPrefix: - type: string - PerfMetricJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - perfMetricJobGroupId: - type: string - performanceMetrics: - type: array - items: - type: string - granularityPeriod: - type: integer - minimum: 1 - objectInstances: - $ref: '#/components/schemas/DnList' - rootObjectInstances: - $ref: '#/components/schemas/DnList' - reportingCtrl: - $ref: '#/components/schemas/ReportingCtrl' - ThresholdMonitoringCapability-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - supportedMonitoringGPs: - $ref: '#/components/schemas/MonitoringGPList' - ThresholdMonitor-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - thresholdInfoList: - $ref: '#/components/schemas/ThresholdInfoList' - monitoringGP: - type: integer - monitoringNotifTarget: - type: string - monitoredIOCName: - type: string - monitoredObjectDNs: - $ref: '#/components/schemas/DnList' - NtfSubscriptionControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - notificationRecipientAddress: - $ref: '#/components/schemas/Uri' - notificationTypes: - $ref: '#/components/schemas/NotificationTypes' - scope: - $ref: '#/components/schemas/Scope' - notificationFilter: - type: string - HeartbeatControl: - $ref: '#/components/schemas/HeartbeatControl-Single' - HeartbeatControl-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - heartbeatNtfPeriod: - type: integer - triggerHeartbeatNtf: - type: boolean - TraceJob-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - $ref: '#/components/schemas/TraceJob-Attr' - - AlarmList-Single: - allOf: - - $ref: '#/components/schemas/Top-Attr' - - type: object - properties: - attributes: - type: object - properties: - administrativeState: - $ref: '#/components/schemas/AdministrativeState' - operationalState: - $ref: '#/components/schemas/OperationalState' - numOfAlarmRecords: - type: integer - lastModification: - $ref: '#/components/schemas/DateTime' - alarmRecords: - description: >- - This resource represents a map of alarm records. - The alarmIds are used as keys in the map. - type: object - additionalProperties: - $ref: 'faultMnS.yaml#/components/schemas/AlarmRecord' - -#-------- Definition of JSON arrays for name-contained IOCs ---------------------- - - VsDataContainer-Multiple: - type: array - items: - $ref: '#/components/schemas/VsDataContainer-Single' - ManagedNFService-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagedNFService-Single' - ManagementNode-Multiple: - type: array - items: - $ref: '#/components/schemas/ManagementNode-Single' - MeContext-Multiple: - type: array - items: - $ref: '#/components/schemas/MeContext-Single' - PerfMetricJob-Multiple: - type: array - items: - $ref: '#/components/schemas/MetricProdJob-Single' - ThresholdMonitor-Multiple: - type: array - items: - $ref: '#/components/schemas/ThresholdMonitor-Single' - NtfSubscriptionControl-Multiple: - type: array - items: - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - TraceJob-Multiple: - type: array - items: - $ref: '#/components/schemas/TraceJob-Single' - -#-------- Definitions in TS 28.623 for TS 28.532 --------------------------------- - - resources-genericNrm: - oneOf: - - - $ref: '#/components/schemas/VsDataContainer-Single' - - - $ref: '#/components/schemas/ManagementNode-Single' - - $ref: '#/components/schemas/MeContext-Single' - - - $ref: '#/components/schemas/ManagedNFService-Single' - - - $ref: '#/components/schemas/PerfMetricJob-Single' - - - $ref: '#/components/schemas/ThresholdMonitoringCapability-Single' - - $ref: '#/components/schemas/ThresholdMonitor-Single' - - - $ref: '#/components/schemas/NtfSubscriptionControl-Single' - - $ref: '#/components/schemas/HeartbeatControl-Single' - - $ref: '#/components/schemas/TraceJob-Single' - - - $ref: '#/components/schemas/AlarmList-Single' diff --git a/OpenAPI/sliceNrm.yaml b/OpenAPI/sliceNrm.yaml deleted file mode 100644 index 03aec3d79aba5de6411d6822c80891a63ea3a744..0000000000000000000000000000000000000000 --- a/OpenAPI/sliceNrm.yaml +++ /dev/null @@ -1,328 +0,0 @@ -openapi: 3.0.1 -info: - title: Slice NRM - version: 16.4.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 - Category: - type: string - enum: - - CHARACTER - - SCALABILITY - Tagging: - 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 - SupportedAccessTech: - type: object - properties: - servAttrCom: - $ref: '#/components/schemas/ServAttrCom' - accTechList: - type: integer - 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 - ServiceProfileList: - type: object - additionalProperties: - type: object - properties: - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - maxNumberofUEs: - type: number - latency: - type: number - uEMobilityLevel: - $ref: '#/components/schemas/MobilityLevel' - sst: - $ref: 'nrNrm.yaml#/components/schemas/Sst' - resourceSharingLevel: - $ref: '#/components/schemas/SharingLevel' - 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' - supportedAccessTech: - $ref: '#/components/schemas/SupportedAccessTech' - 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 - SliceProfileList: - type: object - additionalProperties: - type: object - properties: - snssaiList: - $ref: 'nrNrm.yaml#/components/schemas/SnssaiList' - plmnIdList: - $ref: 'nrNrm.yaml#/components/schemas/PlmnIdList' - 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' - -#------------ Definition of concrete IOCs ---------------------------------------- - - NetworkSlice: - 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: 'genericNrm.yaml#/components/schemas/Dn' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - serviceProfileList: - $ref: '#/components/schemas/ServiceProfileList' - - NetworkSliceSubnet: - 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: 'genericNrm.yaml#/components/schemas/DnList' - networkSliceSubnetRefList: - $ref: 'genericNrm.yaml#/components/schemas/DnList' - operationalState: - $ref: 'genericNrm.yaml#/components/schemas/OperationalState' - administrativeState: - $ref: 'genericNrm.yaml#/components/schemas/AdministrativeState' - nsInfo: - $ref: '#/components/schemas/NsInfo' - sliceProfileList: - $ref: '#/components/schemas/SliceProfileList' - EPTransport: - $ref: '#/components/schemas/EP_Transport-Multiple' - - 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 - - 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/NetworkSlice' - - $ref: '#/components/schemas/NetworkSliceSubnet' diff --git a/README.md b/README.md index 01615e11b3a5c85c221eafec37bdd5ef1d9fa2e2..d48cceab2b334389757d4ede3e3dcd52e487d41c 100644 --- a/README.md +++ b/README.md @@ -2,16 +2,14 @@ The Rel-16 branch represents the latest Rel-16 content approved and published after each TSG SA plenary. -The Rel-17 branch represents the latest Rel-17 content approved and published after each TSG SA plenary. - -Master branch represents the current working in progress release status. +Rel17-draft branch represents the current working in progress release status. (c) 2020, 3GPP Organizational Partners (ARIB, ATIS, CCSA, ETSI, TSDSI, TTA, TTC). All rights reserved. -Branch {+Master+} validation status: +Branch {+Rel17-draft+} validation status: -[![pipeline status](https://forge.3gpp.org/rep/SA5/data-models/badges/master/pipeline.svg)](https://forge.3gpp.org/rep/SA5/data-models/commits/master) +[![pipeline status](https://forge.3gpp.org/rep/SA5/MnS/badges/Rel17-draft/pipeline.svg)](https://forge.3gpp.org/rep/SA5/MnS/commits/Rel17-draft) ## Data models validation diff --git a/xsd/README.md b/xsd/README.md index 1a3ad739d3da628f25939e38f4dba40064d792f2..ce4d0be026bedfe88dc3fdb7024626b55d96e1bd 100755 --- a/xsd/README.md +++ b/xsd/README.md @@ -8,14 +8,6 @@ * Generic NRM (TS 28.623) 3GPP TS 28.623 Generic Network Resources IRP Bulk CM Configuration data file NRM-specific XML schema genericNrm.xsd -* NR NRM (TS 28.541) - 3GPP TS 28.541 NR Network Resource Model XML schema definition nrNrm.xsd - -* 5GC NRM (TS 28.541) - 3GPP TS 28.541 5GC Network Resource Model XML schema definition ngcNrm.xsd - -* Slice NRM (TS 28.541) - 3GPP TS 28.541 5GC network slice Network Resource Model XML schema definition sliceNrm.xsd ## Management Services (MnS) diff --git a/xsd/genericNrm.xsd b/xsd/genericNrm.xsd deleted file mode 100644 index 538b99641bfc6ec8837ef9c3e8e967acf1be8fec..0000000000000000000000000000000000000000 --- a/xsd/genericNrm.xsd +++ /dev/null @@ -1,759 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/xsd/ngcNrm.xsd b/xsd/ngcNrm.xsd deleted file mode 100644 index 2e877d87133195f0d659bc78ca322d4e8568b3f1..0000000000000000000000000000000000000000 --- a/xsd/ngcNrm.xsd +++ /dev/null @@ -1,1716 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - diff --git a/xsd/nrNrm.xsd b/xsd/nrNrm.xsd deleted file mode 100644 index 72574626da52e179e41ff4092aff7b6a99170ec3..0000000000000000000000000000000000000000 --- a/xsd/nrNrm.xsd +++ /dev/null @@ -1,1244 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/xsd/sliceNrm.xsd b/xsd/sliceNrm.xsd deleted file mode 100644 index 1681328758054f97438c617e6b309f1807146218..0000000000000000000000000000000000000000 --- a/xsd/sliceNrm.xsd +++ /dev/null @@ -1,296 +0,0 @@ - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/yang-models/README.md b/yang-models/README.md index eb452b55ac2b7f1005a27fad1db1e25097b8185a..ca997ac327191ac1ba2538d99a7fa5381fe74a2f 100755 --- a/yang-models/README.md +++ b/yang-models/README.md @@ -1,7 +1,8 @@ Folder for all 3GPP SA5 YANG modules and submodules (YAMs) -A subfolder for used external YANG modules is included. +A subfolder for used external YANG modules is included. All commited YANG modules MUST pass the "pyang --strict -p external-yams _3gpp-*.yang" - validation command without errors. - + validation command without errors. + + diff --git a/yang-models/_3gpp-5g-common-yang-types.yang b/yang-models/_3gpp-5g-common-yang-types.yang index 4227463e99347c4444f687c7b7a6eebcb3fb240a..7101b213ce2ab4223a9fc8457f3d47ff96ba58f2 100755 --- a/yang-models/_3gpp-5g-common-yang-types.yang +++ b/yang-models/_3gpp-5g-common-yang-types.yang @@ -7,16 +7,50 @@ module _3gpp-5g-common-yang-types { import _3gpp-common-yang-types { prefix types3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "The model defines common types for 5G networks and network slicing."; reference "3GPP TS 28.541"; - revision 2019-10-20 { - description "Initial version."; - reference "Based on - 3GPP TS 28.541 V16.X.XX"; - } + revision 2021-08-05 { reference S5-214053/CR-0518; } + revision 2020-11-05 { reference CR-0412 ; } + revision 2019-10-20 { reference "Initial version."; } + grouping SNssai { + description + "Single Network Slice Selection Assistance Information(S-NSSAI)"; + reference "3GPP TS 23.003"; + + leaf sd { + description "Slice Differentiator + If not needed, the value can be set to FFFFFF."; + type string{ + length 6; + pattern '[a-fA-F0-9]*'; + } + reference "3GPP TS 23.003"; + } + + leaf sst { + type uint8; + description "Slice/Service Type. + Values 0 to 127 belong to standardized SST range and are defined in + 3GPP TS 23.501. Values 128 to 255 belong to operator-specific range."; + } + } + + grouping PLMNInfo { + description "The PLMNInfo data type define a S-NSSAI member in a specific + PLMNId, and it have two attributes PLMNId and S-NSSAI (PLMNId, S-NSSAI). + The PLMNId represents a data type that is comprised of mcc + (mobile country code) and mnc (mobile network code), (See TS 23.003 + subclause 2.2 and 12.1) and S-NSSAI represents an data type, that is + comprised of an SST (Slice/Service type) and an optional + SD (Slice Differentiator) field"; + uses types3gpp:PLMNId; + uses SNssai; + } + typedef CommModelType { reference "3GPP TS 23501"; type enumeration { @@ -27,17 +61,20 @@ module _3gpp-5g-common-yang-types { enum DIRECT_COMMUNICATION_WITH_NRF { value 1; - description "Directly communicate to other NF service discovered by NRF."; + description "Directly communicate to other NF service discovered + by NRF."; } - + enum INDIRECT_COMMUNICATION_WO_DEDICATED_DISCOVERY { value 2; - description "Communicate to pre-configured other NF service through SCP as a proxy."; + description "Communicate to pre-configured other NF service through + SCP as a proxy."; } enum INDIRECT_COMMUNICATION_WITH_DEDICATED_DISCOVERY { value 3; - description "Communication to NF service discovered by NRF through SCP as a proxy."; + description "Communication to NF service discovered by NRF through SCP + as a proxy."; } } @@ -48,14 +85,13 @@ module _3gpp-5g-common-yang-types { type uint16; } leaf commModelType { - type CommModelType; + type CommModelType; } - leaf-list targetNFServiceList { - - type types3gpp:DistinguishedName; + leaf-list targetNFServiceList { + type types3gpp:DistinguishedName; } leaf commModelConfiguration { - type string; + type string; } } @@ -64,8 +100,49 @@ module _3gpp-5g-common-yang-types { type string; } leaf policy { - type string; + type string; } } + typedef EnergySavingLoadThresholdT { + type uint32 { + range 0..10000; + } + units 1/10000; + } + + typedef EnergySavingTimeDurationT { + type uint32 { + range 0..900; + } + units seconds; + } + + typedef PhysCellID { + type uint32 { + range "0..1007"; + } + reference "clause 7.4.2 of TS 38.211"; + } + + typedef UTC24TimeOfDayT { + description "Time of day in HH:MM or H:MM 24-hour format per UTC + time zone."; + type string { + pattern "(([01]?[0-9])|(2[0-3])):([0-5][0-9])"; + } + } + + typedef DayOfWeekT { + type enumeration { + enum Monday; + enum Tuesday; + enum Wednesday; + enum Thursday; + enum Friday; + enum Saturday; + enum Sunday; + } + } + } \ No newline at end of file diff --git a/yang-models/_3gpp-5gc-nrm-FiveQiDscpMappingSet.yang b/yang-models/_3gpp-5gc-nrm-FiveQiDscpMappingSet.yang index fabfe4336b0717345d89d6e0b329a09fce36bcf9..c3ebfe7a30144ee0f2bd5ea67bad17b05880fef2 100755 --- a/yang-models/_3gpp-5gc-nrm-FiveQiDscpMappingSet.yang +++ b/yang-models/_3gpp-5gc-nrm-FiveQiDscpMappingSet.yang @@ -22,7 +22,7 @@ module _3gpp-5gc-nrm-FiveQiDscpMappingSet { range 0..255 ; } min-elements 1; - description " Identifies the 5QI values that are mapped to a same DSCP, as specified in TS 28.541."; + description " Identifies the 5QI values that are mapped to a same DSCP"; } leaf dscp { diff --git a/yang-models/_3gpp-5gc-nrm-GtpUPathQoSMonitoringControl.yang b/yang-models/_3gpp-5gc-nrm-GtpUPathQoSMonitoringControl.yang index 491226a18c978110b75f07a048743812bbc9ff6b..d29d6d21adf478adb3b430af6e7319ffde39d37c 100755 --- a/yang-models/_3gpp-5gc-nrm-GtpUPathQoSMonitoringControl.yang +++ b/yang-models/_3gpp-5gc-nrm-GtpUPathQoSMonitoringControl.yang @@ -5,8 +5,8 @@ module _3gpp-5gc-nrm-GtpUPathQoSMonitoringControl { prefix gtpUPathQMCtrl3gpp; import _3gpp-common-managed-element { prefix me3gpp; } - import _3gpp-common-yang-types { prefix types3gpp; } - import _3gpp-5gc-nrm-smffunction { prefix smf3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + import _3gpp-5gc-nrm-smffunction { prefix smf3gpp; } import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; @@ -15,10 +15,15 @@ module _3gpp-5gc-nrm-GtpUPathQoSMonitoringControl { of GTP-U path QoS monitoring defined in 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } + revision 2020-09-30 { reference "CR-0393"; } revision 2020-08-03 { reference "CR-0321"; } revision 2020-04-10 { reference "S5-202103"; } grouping GtpUPathDelayThresholdsType { + description "Thresholds for reporting the packet delay for GTP-U path QoS + monitoring "; + reference "3GPP TS 29.244"; leaf n3AveragePacketDelayThreshold { mandatory true; type uint32; @@ -57,11 +62,12 @@ module _3gpp-5gc-nrm-GtpUPathQoSMonitoringControl { } } - leaf-list gtpUPathMonitoredSNSSAIs { + list gtpUPathMonitoredSNSSAIs { + key "sd sst"; description "The S-NSSAIs for which the the GTP-U path QoS monitoring is to be performed."; reference "3GPP TS 23.003"; - type types3gpp:SNssai; + uses types5g3gpp:SNssai; } leaf-list monitoredDSCPs { @@ -116,7 +122,7 @@ module _3gpp-5gc-nrm-GtpUPathQoSMonitoringControl { description "It specifies the period (in seconds) for reporting the packet delay for GTP-U path QoS monitoring."; type uint32; - } + } } augment "/me3gpp:ManagedElement/smf3gpp:SMFFunction" { diff --git a/yang-models/_3gpp-5gc-nrm-QFQoSMonitoringControl.yang b/yang-models/_3gpp-5gc-nrm-QFQoSMonitoringControl.yang index 0d814b663993694b106fbe8413603565ba4d1415..a7290eb818034aa64431d8cb86046b6506a004ee 100755 --- a/yang-models/_3gpp-5gc-nrm-QFQoSMonitoringControl.yang +++ b/yang-models/_3gpp-5gc-nrm-QFQoSMonitoringControl.yang @@ -5,20 +5,23 @@ module _3gpp-5gc-nrm-QFQoSMonitoringControl { prefix qFQMCtrl3gpp; import _3gpp-common-managed-element { prefix me3gpp; } - import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-5gc-nrm-smffunction { prefix smf3gpp; } import _3gpp-common-top { prefix top3gpp; } - + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + organization "3gpp SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "This IOC represents the capabilities and properties for control - of QoS monitoring per QoS flow per UE for URLLC service defined - in 3GPP TS 23.501."; + of QoS monitoring per QoS flow per UE for URLLC service defined + +in 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-03 { reference "CR-0321"; } revision 2020-04-10 { reference "S5-202101"; } grouping QFPacketDelayThresholdsTypeGrp { + description "Represents the QFPacketDelayThresholdsType"; leaf thresholdDl { type uint32; units milliseconds; @@ -51,12 +54,12 @@ module _3gpp-5gc-nrm-QFQoSMonitoringControl { } } - leaf-list qFMonitoredSNSSAIs { + list qFMonitoredSNSSAIs { description "The S-NSSAIs for which the QoS monitoring per QoS flow per UE is to be performed."; reference "3GPP TS 23.003"; - type types3gpp:SNssai; - } + key "sd sst"; + uses types5g3gpp:SNssai;} leaf-list qFMonitored5QIs { description "The 5QIs for which the QoS monitoring per QoS flow @@ -110,9 +113,10 @@ module _3gpp-5gc-nrm-QFQoSMonitoringControl { } leaf qFMeasurementPeriod { - description "It specifies the period (in seconds) for reporting the packet delay for QoS monitoring per QoS flow per UE."; + description "It specifies the period (in seconds) for reporting the + packet delay for QoS monitoring per QoS flow per UE."; type uint32; - } + } } augment "/me3gpp:ManagedElement/smf3gpp:SMFFunction" { diff --git a/yang-models/_3gpp-5gc-nrm-amffunction.yang b/yang-models/_3gpp-5gc-nrm-amffunction.yang index 46eb9fbfa18071823fe5932840afbf2b3aa73d4c..ef7b462fafa0cd878e6f22c59fd2d5b1fd6aab6e 100755 --- a/yang-models/_3gpp-5gc-nrm-amffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-amffunction.yang @@ -10,58 +10,67 @@ module _3gpp-5gc-nrm-amffunction { import ietf-inet-types { prefix inet; } import _3gpp-common-top { prefix top3gpp; } + organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "AMFFunction derived from basic ManagedFunction."; - + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-193518"; } - revision 2019-05-31 { - description "Ericsson refactoring."; - } - - revision 2018-08-07 { - description "Initial revision"; - } + revision 2019-05-31 { reference "Ericsson refactoring."; } + revision 2018-08-07 { reference "Initial revision"; } grouping AMFFunctionGrp { + description "Represents the AMFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { min-elements 1; - description "A list of PLMN identifiers (Mobile Country Code and Mobile Network Code)."; + description "A list of PLMN identifiers (Mobile Country Code and Mobile + Network Code)."; key "mcc mnc"; uses types3gpp:PLMNId; } container aMFIdentifier { presence true; - description "An AMF identifier, comprising an AMF Region ID, an AMF Set ID and an AMF Pointer."; + description "An AMF identifier, comprising an AMF Region ID, an + AMF Set ID and an AMF Pointer."; uses types3gpp:AmfIdentifier; } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the + service-based interface."; type inet:domain-name; } - leaf-list sNSSAIList { - min-elements 0; // conditionally mandatory if network slicing feature is supported + list sNSSAIList { + min-elements 1; description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } diff --git a/yang-models/_3gpp-5gc-nrm-amfregion.yang b/yang-models/_3gpp-5gc-nrm-amfregion.yang index 5a42f2aa7a546dc93dd9ae66c8e6db39160cf432..5a9d9891456f66dbf2ecbef57b4f709dd9ec777a 100755 --- a/yang-models/_3gpp-5gc-nrm-amfregion.yang +++ b/yang-models/_3gpp-5gc-nrm-amfregion.yang @@ -7,20 +7,28 @@ module _3gpp-5gc-nrm-amfregion { import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-managed-function { prefix mf3gpp; } - - description "This IOC represents the AMF Region which consists one or multiple AMF Sets."; + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + + organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the AMF Region which consists one or + multiple AMF Sets."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-06-11 { - description "Ericsson refactoring."; - } + revision 2019-06-11 { reference ""; } grouping AMFRegionGrp { + description "Represents the AMFRegion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) + and a Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -37,14 +45,15 @@ module _3gpp-5gc-nrm-amfregion { type types3gpp:Tac; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //conditional support only if the network slicing feature is supported. reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } leaf aMFRegionId { diff --git a/yang-models/_3gpp-5gc-nrm-amfset.yang b/yang-models/_3gpp-5gc-nrm-amfset.yang index 325584cfaeccb7018c2fd303970a26154687bdd3..9394f45e486e069c477d02e3def056d3bbac54e2 100755 --- a/yang-models/_3gpp-5gc-nrm-amfset.yang +++ b/yang-models/_3gpp-5gc-nrm-amfset.yang @@ -7,20 +7,27 @@ module _3gpp-5gc-nrm-amfset { import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-managed-function { prefix mf3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } - description "This IOC represents the AMF Set which consists of some AMFs that serve a given area and Network Slice."; + organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the AMF Set which consists of some AMFs + that serve a given area and Network Slice."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-06-11 { - description "Ericsson refactoring."; - } + revision 2019-06-11 { reference "Ericsson refactoring."; } grouping AMFSetGrp { + description "Represents the AMFSet IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). The PLMN Identifier is composed + of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -30,21 +37,22 @@ module _3gpp-5gc-nrm-amfset { leaf-list nRTACList { description "List of Tracking Area Codes (legacy TAC or extended TAC) - where the represented management function is serving."; - reference "TS 38.413 clause 9.3.3.10"; + where the represented management function is serving."; + reference "TS 38.413 clause 9.3.3.10"; min-elements 1; config false; type types3gpp:Tac; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. - (Single Network Slice Selection Assistance Information) - An S-NSSAI has an SST (Slice/Service type) and an optional SD - (Slice Differentiator) field."; + (Single Network Slice Selection Assistance Information) + An S-NSSAI has an SST (Slice/Service type) and an optional SD + (Slice Differentiator) field."; //conditional support only if the network slicing feature is supported. reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } leaf aMFRegion { diff --git a/yang-models/_3gpp-5gc-nrm-ausffunction.yang b/yang-models/_3gpp-5gc-nrm-ausffunction.yang index 16c0b5e01b70665e9cadd6d4f6765ab8c11171e7..526aaf86fc8a10b9538a41fd75be30cc97a29b52 100755 --- a/yang-models/_3gpp-5gc-nrm-ausffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-ausffunction.yang @@ -12,22 +12,26 @@ module _3gpp-5gc-nrm-ausffunction { import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; - description "This IOC represents the AUSF function in 5GC. For more information about the AUSF, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the AUSF function in 5GC. For more + information about the AUSF, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; - + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-193518"; } - revision 2019-05-22 { - description "initial revision"; - } + revision 2019-05-22 {reference "initial revision"; } grouping AUSFFuntionGrp { + description "Represents the AUSFFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and + a Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -36,23 +40,26 @@ module _3gpp-5gc-nrm-ausffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the + service-based interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. - (Single Network Slice Selection Assistance Information) - An S-NSSAI has an SST (Slice/Service type) and an optional SD - (Slice Differentiator) field."; + (Single Network Slice Selection Assistance Information) + An S-NSSAI has an SST (Slice/Service type) and an optional SD + (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } @@ -60,6 +67,9 @@ module _3gpp-5gc-nrm-ausffunction { list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } } diff --git a/yang-models/_3gpp-5gc-nrm-configurable5qiset.yang b/yang-models/_3gpp-5gc-nrm-configurable5qiset.yang index 2a402a96e132ee0484b07316b3fe07f70c6abfc9..9561ede161dfd0b172a2c1cd434824d50d1a4c27 100755 --- a/yang-models/_3gpp-5gc-nrm-configurable5qiset.yang +++ b/yang-models/_3gpp-5gc-nrm-configurable5qiset.yang @@ -10,12 +10,14 @@ module _3gpp-5gc-nrm-configurable5qiset { organization "3gpp SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "This IOC represents the non-standardized 5QIs, including + description "This IOC represents the configurable 5QIs, including their QoS characteristics, that need to be pre-configured (and configurable) to the 5G NFs."; reference "3GPP TS 28.541"; - revision 2020-08-03 { reference "CR-0321"; } + revision 2022-04-29 { reference "CR-0729"; } + revision 2022-01-07 { reference CR-0643; } + revision 2020-08-04 { reference "CR-0321"; } revision 2020-06-03 { reference "CR-0286"; } grouping PacketErrorRate { @@ -37,7 +39,13 @@ module _3gpp-5gc-nrm-configurable5qiset { } } - grouping FiveQICharacteristics { + grouping FiveQICharacteristicsGrp { + description "Represents the FiveQICharacteristics IOC."; + reference "3GPP TS 28.541"; + } + + list configurableFiveQIs { + key fiveQIValue; leaf fiveQIValue { type uint32 { range 0..255 ; @@ -72,7 +80,6 @@ module _3gpp-5gc-nrm-configurable5qiset { list packetErrorRate { key "scalar exponent"; - min-elements 0; max-elements 1; uses PacketErrorRate; reference "TS 23.501"; @@ -92,14 +99,28 @@ module _3gpp-5gc-nrm-configurable5qiset { } units byte; } +} + + grouping FiveQiCharacteristicsSubtree { + description "Represents the FiveQICharacterics IOC."; + list FiveQICharacteristics { + key id; + uses top3gpp:Top_Grp; + container attributes { + uses FiveQICharacteristicsGrp; + } + } } grouping Configurable5QISetGrp { description "Represents the Configurable5QISet IOC."; list configurable5QIs { - key "fiveQIValue"; - uses FiveQICharacteristics; - } + key id; + uses top3gpp:Top_Grp; + container attributes { + uses FiveQICharacteristicsGrp; + } + } } grouping Configurable5QISetSubtree { @@ -112,7 +133,7 @@ module _3gpp-5gc-nrm-configurable5qiset { container attributes { uses Configurable5QISetGrp; } - } + } } augment "/subnet3gpp:SubNetwork" { @@ -122,4 +143,4 @@ module _3gpp-5gc-nrm-configurable5qiset { augment "/me3gpp:ManagedElement" { uses Configurable5QISetSubtree; } -} \ No newline at end of file +} diff --git a/yang-models/_3gpp-5gc-nrm-dynamic5qiset.yang b/yang-models/_3gpp-5gc-nrm-dynamic5qiset.yang index 3668cea21ee82bda9918122c4ee3911153b26ed3..b19c9f6d790f12a90fa7b6ff6727c819cbf0a877 100755 --- a/yang-models/_3gpp-5gc-nrm-dynamic5qiset.yang +++ b/yang-models/_3gpp-5gc-nrm-dynamic5qiset.yang @@ -11,20 +11,27 @@ module _3gpp-5gc-nrm-dynamic5qiset { organization "3gpp SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "This IOC represents the dynamic 5QIs including their QoS characteristics."; + description "This IOC represents the dynamic 5QIs including their QoS + characteristics."; reference "3GPP TS 28.541"; + revision 2022-01-07 { reference CR-0643; } + revision 2020-10-01 { reference "CR-0393"; } revision 2020-08-06 { reference "CR-0333"; } grouping Dynamic5QISetGrp { description "Represents the Dynamic5QISet IOC."; list dynamic5QIs { - key "fiveQIValue"; - uses Conf5QIs3gpp:FiveQICharacteristics; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses Conf5QIs3gpp:FiveQICharacteristicsGrp; + } } } grouping Dynamic5QISetSubtree { + description "Helps augmenting Dynamic5QISet into multiple places."; list Dynamic5QISet { description "Specifies the dynamic 5QIs including their QoS characteristics, see 3GPP TS 23.501."; diff --git a/yang-models/_3gpp-5gc-nrm-neffunction.yang b/yang-models/_3gpp-5gc-nrm-neffunction.yang index f079e568f5f815d944108d68dbd4624f98ceb23f..cdbf93c49d59ec94470aaf772046099996ea3172 100755 --- a/yang-models/_3gpp-5gc-nrm-neffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-neffunction.yang @@ -7,44 +7,43 @@ module _3gpp-5gc-nrm-neffunction { import _3gpp-common-managed-function { prefix mf3gpp; } import _3gpp-common-managed-element { prefix me3gpp; } import ietf-inet-types { prefix inet; } - import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-common-top { prefix top3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; - description "This IOC represents the NEF function in 5GC. For more information about the NEF, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the NEF function in 5GC. For more + information about the NEF, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; - revision 2019-10-20 { - description "initial revision"; - reference "Based on - 3GPP TS 28.541 V16.X.XX"; - } + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } + revision 2019-10-20 { reference "initial revision"; } grouping NEFFunctionGrp { + description "Represents the NEFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the + service-based interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. - (Single Network Slice Selection Assistance Information) - An S-NSSAI has an SST (Slice/Service type) and an optional SD - (Slice Differentiator) field."; - type types3gpp:SNssai; + (Single Network Slice Selection Assistance Information) + An S-NSSAI has an SST (Slice/Service type) and an optional SD + (Slice Differentiator) field."; + key "sd sst"; + uses types5g3gpp:SNssai; } - + leaf-list capabilityList { description "List of supported capabilities of the NEF."; reference "3GPP TS 23.003"; type string; } - - leaf isINEF { - type boolean; - } leaf isCAPIFSup { type boolean; diff --git a/yang-models/_3gpp-5gc-nrm-nfservice.yang b/yang-models/_3gpp-5gc-nrm-nfservice.yang index 8685e8e8eff88c4f441aa8bea44265835616d70a..3d385693181cffee145202bf291220f164aeb813 100755 --- a/yang-models/_3gpp-5gc-nrm-nfservice.yang +++ b/yang-models/_3gpp-5gc-nrm-nfservice.yang @@ -7,18 +7,22 @@ module _3gpp-5gc-nrm-nfservice { import _3gpp-common-yang-types { prefix types3gpp; } import ietf-yang-types { prefix yang; } import ietf-inet-types { prefix inet; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "NF service class."; reference "3GPP TS 29.510"; - revision 2019-06-17 { - description "initial revision"; - } + revision 2021-01-25 { reference CR-0454 ; } + revision 2020-11-05 { reference CR-0412 ; } + revision 2019-06-17 { reference "initial revision"; } grouping NFServiceGrp { + description "Represents the NFService IOC"; leaf serviceInstanceID { - description "Unique ID of the service instance within a given NF Instance."; + description + "Unique ID of the service instance within a given NF Instance."; mandatory true; type string; } @@ -30,7 +34,8 @@ module _3gpp-5gc-nrm-nfservice { } list versions { //check in review if key is ok (unique) - description "API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service."; + description "API versions supported by the NF Service and if available, + the corresponding retirement date of the NF Service."; min-elements 1; key "apiVersionInUri apiFullVersion"; uses NFServiceVersion; @@ -55,15 +60,16 @@ module _3gpp-5gc-nrm-nfservice { } leaf interPlmnFqdn { - description "If the NF service needs to be discoverable by other NFs in a different PLMN, - then an FQDN that is used for inter PLMN routing."; + description "If the NF service needs to be discoverable by other NFs in a + different PLMN, then an FQDN that is used for inter PLMN routing."; //optional support type inet:domain-name; } list ipEndPoints { - description "IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) - where the service is listening for incoming service requests."; + description "IP address(es) and port information of the Network Function + (including IPv4 and/or IPv6 address)where the service is listening + for incoming service requests."; //optional support key idx; @@ -75,7 +81,8 @@ module _3gpp-5gc-nrm-nfservice { } leaf apiPrefix { - description "Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs."; + description "Optional path segment(s) used to construct the {apiRoot} + variable of the different API URIs."; //optional support type string; } @@ -90,7 +97,8 @@ module _3gpp-5gc-nrm-nfservice { list allowedPlmns { description "PLMNs allowed to access the service instance. - The absence of this attribute indicates that any PLMN is allowed to access the service instance."; + The absence of this attribute indicates that any PLMN is allowed to + access the service instance."; min-elements 1; //optional support @@ -100,7 +108,8 @@ module _3gpp-5gc-nrm-nfservice { leaf-list allowedNfTypes { description "Type of the NFs allowed to access the service instance. - The absence of this attribute indicates that any NF type is allowed to access the service instance."; + The absence of this attribute indicates that any NF type is allowed + to access the service instance."; min-elements 1; //optional support @@ -114,29 +123,34 @@ module _3gpp-5gc-nrm-nfservice { type string; } - leaf-list allowedNssais { + list allowedNssais { description "S-NSSAI of the allowed slices to access the service instance. - The absence of this attribute indicates that any slice is allowed to access the service instance."; + The absence of this attribute indicates that any slice is allowed to + access the service instance."; min-elements 1; //optional support - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } leaf priority { - description "Priority (relative to other services of the same type) in the range of 0-65535, - to be used for NF Service selection; lower values indicate a higher priority."; + description "Priority (relative to other services of the same type) + in the range of 0-65535, to be used for NF Service selection; lower + values indicate a higher priority."; //optional support type uint16; } leaf capacity { - description "Static capacity information in the range of 0-65535, expressed as a weight relative to other services of the same type."; + description "Static capacity information in the range of 0-65535, + expressed as a weight relative to other services of the same type."; //optional support type uint16; } leaf load { - description "Dynamic load information, ranged from 0 to 100, indicates the current load percentage of the NF Service."; + description "Dynamic load information, ranged from 0 to 100, indicates + the current load percentage of the NF Service."; //optional support type types3gpp:Load; } @@ -272,13 +286,15 @@ module _3gpp-5gc-nrm-nfservice { grouping ChfServiceInfo { leaf primaryChfServiceInstance { - description "Shall be present if the CHF service instance serves as a secondary CHF instance of another primary CHF service instance."; + description "Shall be present if the CHF service instance serves as a + secondary CHF instance of another primary CHF service instance."; //conditional to support type string; } leaf secondaryChfServiceInstance { - description "Shall be present if the CHF service instance serves as a primary CHF instance of another secondary CHF service instance."; + description "Shall be present if the CHF service instance serves as a + primary CHF instance of another secondary CHF service instance."; //conditional to support type string; } diff --git a/yang-models/_3gpp-5gc-nrm-ngeirfunction.yang b/yang-models/_3gpp-5gc-nrm-ngeirfunction.yang index 8f1ce2fb05e840809536bd7665d44e34a5cb3e3d..f9b7638ea0e1a7e79aa8557c36d5ebd0172f7366 100755 --- a/yang-models/_3gpp-5gc-nrm-ngeirfunction.yang +++ b/yang-models/_3gpp-5gc-nrm-ngeirfunction.yang @@ -11,23 +11,26 @@ module _3gpp-5gc-nrm-ngeirfunction { import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; - description "This IOC represents the 5G-EIR function in 5GC. For more information about the 5G-EIR, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the 5G-EIR function in 5GC. For more + information about the 5G-EIR, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2022-01-07 { reference CR-0643; } + revision 2020-11-06 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - revision 2019-05-15 { - description "initial revision"; - reference "Based on - 3GPP TS 28.541 V15.X.XX"; - } + revision 2019-05-15 {reference "initial revision"; } grouping NGEIRFunctionGrp { + description "Represents the NGEIRFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and + a Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -35,25 +38,30 @@ module _3gpp-5gc-nrm-ngeirfunction { uses types3gpp:PLMNId; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } } diff --git a/yang-models/_3gpp-5gc-nrm-nrffunction.yang b/yang-models/_3gpp-5gc-nrm-nrffunction.yang index d9754bd457451e9844e60f64e67583665e36aeab..62e0ca74cce7cc84a2d1beea319c9eae958366e3 100755 --- a/yang-models/_3gpp-5gc-nrm-nrffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-nrffunction.yang @@ -10,22 +10,28 @@ module _3gpp-5gc-nrm-nrffunction { import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-5gc-nrm-nfprofile { prefix nfp3gpp; } import _3gpp-common-top { prefix top3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "This IOC represents the NRF function in 5GC. For more information about the NRF, see 3GPP TS 23.501 [2]."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-03 { reference "CR-0321"; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-05-15 { description "initial revision"; } + revision 2019-05-15 { reference "initial revision"; } grouping NRFFunctionGrp { + description "Represents the NRFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -34,7 +40,8 @@ module _3gpp-5gc-nrm-nrffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } @@ -47,14 +54,15 @@ module _3gpp-5gc-nrm-nrffunction { type string; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list nFProfileList { diff --git a/yang-models/_3gpp-5gc-nrm-nssffunction.yang b/yang-models/_3gpp-5gc-nrm-nssffunction.yang index 7d9407b0f84cd12aaea26d491fee30c6c5c63c52..b68d988ecf5de2be280cbcbebf06f2f424e30c1f 100755 --- a/yang-models/_3gpp-5gc-nrm-nssffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-nssffunction.yang @@ -9,17 +9,21 @@ module _3gpp-5gc-nrm-nssffunction { import ietf-inet-types { prefix inet; } import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-common-top { prefix top3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "This IOC represents the NSSF function in 5GC. For more information about the NSSF, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-03 { reference "CR-0321"; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - revision 2019-05-15 { description "initial revision"; } + revision 2019-05-15 { reference "initial revision"; } grouping NSSFFunctionGrp { + description "Represents the NSSFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { @@ -34,19 +38,21 @@ module _3gpp-5gc-nrm-nssffunction { uses types3gpp:PLMNId; } - leaf sBIFQDN { description "The FQDN of the registered NF instance in the service-based + leaf sBIFQDN { + description "The FQDN of the registered NF instance in the service-based interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } leaf-list cNSIIdList { @@ -61,6 +67,7 @@ module _3gpp-5gc-nrm-nssffunction { list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } } diff --git a/yang-models/_3gpp-5gc-nrm-nwdaffunction.yang b/yang-models/_3gpp-5gc-nrm-nwdaffunction.yang index 813b3bdeb0607129438fdd92543ea0c5044c7a2a..bf143ba350e6b91599f8f3fd8d7ad39a732049ee 100755 --- a/yang-models/_3gpp-5gc-nrm-nwdaffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-nwdaffunction.yang @@ -12,23 +12,24 @@ module _3gpp-5gc-nrm-nwdaffunction { import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "This IOC represents the NWDAF function in 5GC. For more information about the NWDAF, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - revision 2019-05-15 { - description "initial revision"; - reference "Based on - 3GPP TS 28.541 V15.X.XX"; - } + revision 2019-05-15 {reference "initial revision"; } grouping NWDAFFunctionGrp { + description "Represents the NWDAFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -37,29 +38,35 @@ module _3gpp-5gc-nrm-nwdaffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } } diff --git a/yang-models/_3gpp-5gc-nrm-pcffunction.yang b/yang-models/_3gpp-5gc-nrm-pcffunction.yang index b9eaf0e0ae701918405b72d63c7fafd00f7ba0ad..a7f9bd152503fd84b45d5709f5744f13c3608871 100755 --- a/yang-models/_3gpp-5gc-nrm-pcffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-pcffunction.yang @@ -12,25 +12,26 @@ module _3gpp-5gc-nrm-pcffunction { import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; - description "This IOC represents the PCF function in 5GC. For more information about the PCF, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the PCF function in 5GC. For more + information about the PCF, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-06 { reference "CR-0333"; } - - revision 2020-08-06 {reference "CR-0331"; } - - revision 2019-10-25 {reference "S5-194457 S5-193518"; } - - revision 2019-05-22 { - description "initial revision"; - } + revision 2020-08-06 { reference "CR-0331"; } + revision 2019-10-25 { reference "S5-194457 S5-193518"; } + revision 2019-05-22 { reference "initial revision"; } grouping PCFFuntionGrp { + description "Represents the PCFFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -39,37 +40,45 @@ module _3gpp-5gc-nrm-pcffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } leaf dynamic5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Dynamic5QISet that the PCFFunction supports (is associated to)."; + description "DN of the Dynamic5QISet that the PCFFunction supports + (is associated to)."; } leaf configurable5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Configurable5QISet that the PCFFunction supports (is associated to)."; + description "DN of the Configurable5QISet that the PCFFunction supports + (is associated to)."; } } diff --git a/yang-models/_3gpp-5gc-nrm-predefinedpccruleset.yang b/yang-models/_3gpp-5gc-nrm-predefinedpccruleset.yang index b8ea9c8003e314a56d91bca55f3c13600a7010e0..ac3faf5c6a071aea4f808a82edb886b6b2a1a643 100755 --- a/yang-models/_3gpp-5gc-nrm-predefinedpccruleset.yang +++ b/yang-models/_3gpp-5gc-nrm-predefinedpccruleset.yang @@ -12,22 +12,28 @@ module _3gpp-5gc-nrm-predefinedpccruleset { organization "3gpp SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "This IOC represents the predefined PCC rules, which are configured to SMF and referenced by PCF."; + description "This IOC represents the predefined PCC rules, which are + configured to SMF and referenced by PCF."; reference "3GPP TS 28.541"; + revision 2020-09-30 { reference "CR-0393"; } revision 2020-08-21 { reference "CR-0330"; } grouping TscaiInputContainer { - description "It specifies the transports TSCAI input parameters for TSC traffic at the ingress interface of the DS-TT/UE for a PCC rule, see TS 29.512 [60]"; + description "It specifies the transports TSCAI input parameters for TSC + traffic at the ingress interface of the DS-TT/UE for a PCC rule."; + reference " 3GPP TS 29.512"; leaf periodicity { type uint32; - mandatory false; - description "It identifies the time period between the start of two bursts in reference to the TSN GM, see TS 29.571 [61]."; + description "It identifies the time period between the start of two bursts + in reference to the TSN GM."; + reference "3GPP TS 29.571."; } leaf burstArrivalTime { type yang:date-and-time; - mandatory false; - description "It Indicates the arrival time (in date-time format) of the data burst in reference to the TSN GM, see TS 29.571 [61]."; + description "It Indicates the arrival time (in date-time format) of the + data burst in reference to the TSN GM."; + reference "3GPP,TS 29.571."; } } @@ -40,21 +46,24 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } leaf activationTime { type yang:date-and-time; - mandatory false; - description " It indicates the time (in date-time format) when the decision data shall be activated, see TS 29.512 [60] and TS 29.571 [61]."; + description " It indicates the time (in date-time format) when the decision + data shall be activated."; + reference "3GPP29.512 and TS 29.571."; } leaf deactivationTime { type yang:date-and-time; - mandatory false; - description "It indicates the time (in date-time format) when the decision data shall be deactivated, see TS 29.512 [60] and TS 29.571 [81]."; + description "It indicates the time (in date-time format) when the decision + data shall be deactivated."; + reference "3GPPTS 29.512 and TS 29.571."; } leaf accessType { type enumeration { enum 3GPP_ACCESS; enum NON_3GPP_ACCESS; } - mandatory false; - description "It provides the condition of access type of the UE when the session AMBR shall be enforced, see TS 29.512 [60]."; + description "It provides the condition of access type of the UE when the + session AMBR shall be enforced."; + reference "3GPPTS 29.512."; } leaf ratType { type enumeration { @@ -74,13 +83,14 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum UTRA; enum GERA; } - mandatory false; - description "It provides the condition of RAT type of the UE when the session AMBR shall be enforced, see TS 29.512 [60] and TS 29.571 [61]."; + description "It provides the condition of RAT type of the UE when the + session AMBR shall be enforced."; + reference "3GPPTS 29.512 and TS 29.571."; } } grouping SteeringMode { - description "It specifies the traffic distribution rule, see TS 29.512 [60]."; + description "It specifies the traffic distribution rule, see TS 29.512."; leaf steerModeValue { type enumeration { enum ACTIVE_STANDBY; @@ -89,52 +99,54 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum PRIORITY_BASED; } mandatory true; - description "It indicates the value of the steering mode, see TS 29.512 [60]."; + description "It indicates the value of the steering mode, see TS 29.512."; } leaf active { type enumeration { enum 3GPP_ACCESS; enum NON_3GPP_ACCESS; } - mandatory false; - description "It indicates the active access, see TS 29.571 [61]."; + description "It indicates the active access, see TS 29.571."; } leaf standby { type enumeration { enum 3GPP_ACCESS; enum NON_3GPP_ACCESS; } - mandatory false; - description "It indicates the Standby access, see TS 29.571 [61]."; + description "It indicates the Standby access, see TS 29.571."; } leaf threeGLoad { type uint8 { range 0..100; } - mandatory false; - description "It indicates the traffic load to steer to the 3GPP Access expressed in one percent."; + description "It indicates the traffic load to steer to the 3GPP Access + expressed in one percent."; } leaf prioAcc { type enumeration { enum 3GPP_ACCESS; enum NON_3GPP_ACCESS; } - mandatory false; - description "It indicates the high priority access, see TS 29.571 [61]."; + description "It indicates the high priority access."; + reference "3GPPTS 29.571"; } } grouping UpPathChgEvent { - description "It specifies the information about the AF subscriptions of the UP path change, see TS 29.512 [60]"; + description "It specifies the information about the AF subscriptions of the + UP path change."; + reference "3GPPTS 29.512"; leaf notificationUri { type string; mandatory true; - description "It provides notification address (Uri) of AF receiving the event notification."; + description "It provides notification address (Uri) of AF receiving the + event notification."; } leaf notifCorreId { type string; mandatory true; - description "It is used to set the value of Notification Correlation ID in the notification sent by the SMF, see TS 29.512 [60]."; + description "It is used to set the value of Notification Correlation ID in + the notification sent by the SMF, see TS 29.512"; } leaf dnaiChgType { type enumeration { @@ -143,13 +155,13 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum LATE; } mandatory true; - description "It indicates the type of DNAI change, see TS 29.512 [60]."; + description "It indicates the type of DNAI change, see TS 29.512"; } leaf afAckInd { type boolean; default false; - mandatory false; - description "It identifies whether the AF acknowledgement of UP path event notification is expected."; + description "It identifies whether the AF acknowledgement of UP path + event notification is expected."; } } @@ -157,27 +169,30 @@ module _3gpp-5gc-nrm-predefinedpccruleset { description "It specifies the traffic routing information."; leaf ipv4Addr { type string; - mandatory false; - description "It defines the Ipv4 address of the tunnel end point in the data network, formatted in the dotted decimal notation."; + description "It defines the Ipv4 address of the tunnel end point in the + data network, formatted in the dotted decimal notation."; } leaf ipv6Addr { type string; - mandatory false; - description "It defines the Ipv6 address of the tunnel end point in the data network."; + description "It defines the Ipv6 address of the tunnel end point in the + data network."; } leaf portNumber { type uint32; mandatory true; - description " It defines the UDP port number of the tunnel end point in the data network, see TS 29.571 [61]."; + description " It defines the UDP port number of the tunnel end point in + the data network, see TS 29.571"; } } grouping RouteToLocation { - description "It specifies a list of location which the traffic shall be routed to for the AF request."; + description "It specifies a list of location which the traffic shall be + routed to for the AF request."; leaf dnai { type string; mandatory true; - description "It represents the DNAI (Data network access identifier), see 3GPP TS 23.501 [2]."; + description "It represents the DNAI (Data network access identifier)."; + reference "3GPP 3GPP TS 23.501"; } container routeInfo{ description "It provides the traffic routing information."; @@ -185,13 +200,13 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } leaf routeProfId { type string; - mandatory false; description "It identifies the routing profile."; } } grouping RedirectInformaton { - description "It specifies the redirect information for traffic control in the PCC rule."; + description "It specifies the redirect information for traffic control in + the PCC rule."; leaf redirectEnabled { type boolean; mandatory true; @@ -205,7 +220,8 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum SIP_URI; } mandatory true; - description "It indicates the type of redirect address, see TS 29.512 [60]."; + description "It indicates the type of redirect address."; + reference "3GPPTS 29.512"; } leaf redirectServerAddress { type string; @@ -215,11 +231,13 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } grouping TrafficControlDataInformation { - description "It specifies the traffic control data for a service flow of a PCC rule."; + description "It specifies the traffic control data for a service + flow of a PCC rule."; leaf tcId { type string; mandatory true; - description "It univocally identifies the traffic control policy data within a PDU session."; + description "It univocally identifies the traffic control policy data + within a PDU session."; } leaf flowStatus { type enumeration { @@ -230,40 +248,49 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum REMOVED; } mandatory true; - description "It represents whether the service data flow(s) are enabled or disabled."; + description "It represents whether the service data flow(s) are enabled + or disabled."; } container redirectInfo { - description "It contains the redirect information indicating whether the detected application traffic should be redirected to another controlled address."; + description "It contains the redirect information indicating whether the + detected application traffic should be redirected to another controlled + address."; uses RedirectInformaton; } container addRedirectInfo { - description "It contains the additional redirect information indicating whether the detected application traffic should be redirected to another controlled address."; + description "It contains the additional redirect information indicating + whether the detected application traffic should be redirected to another + controlled address."; list redirectInfo { - description "The list of redirect information indicating whether the detected application traffic should be redirected to another controlled address."; + description "The list of redirect information indicating whether the + detected application traffic should be redirected to another + controlled address."; key "redirectServerAddress"; uses RedirectInformaton; } } leaf muteNotif { type boolean; - mandatory false; default false; - description "It indicates whether applicat'on's start or stop notification is to be muted."; + description "It indicates whether applicat'on's start or stop notification + is to be muted."; } leaf trafficSteeringPolIdDl { type string; - mandatory false; - description "It references to a pre-configured traffic steering policy for downlink traffic at the SMF, see TS 29.512 [60]."; + description "It references to a pre-configured traffic steering policy for downlink traffic at the SMF, see TS 29.512"; } leaf trafficSteeringPolIdUl { type string; mandatory false; - description "It references to a pre-configured traffic steering policy for uplink traffic at the SMF, see TS 29.512 [60]."; + description "It references to a pre-configured traffic steering policy for + uplink traffic at the SMF, see TS 29.512"; } container routeToLocs { - description "It provides a list of location which the traffic shall be routed to for the AF request."; + description "It provides a list of location which the traffic shall be + routed to for the AF request."; list routeToLoc { - description "The list of location which the traffic shall be routed to for the AF request."; + description "The list of location which the traffic shall be routed to + for the AF request."; key "dnai"; uses RouteToLocation; } @@ -274,11 +301,12 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum MPTCP; enum ATSSS_LL; } - mandatory false; - description "It indicates the applicable traffic steering functionality, see TS 29.512 [60]."; + description "It indicates the applicable traffic steering functionality."; + reference "3GPPTS 29.512"; } container steerModeDl { - description "It provides the traffic distribution rule across 3GPP and Non-3GPP accesses to apply for downlink traffic."; + description "It provides the traffic distribution rule across 3GPP and + Non-3GPP accesses to apply for downlink traffic."; uses SteeringMode; } container steerModeUl { @@ -290,7 +318,6 @@ module _3gpp-5gc-nrm-predefinedpccruleset { enum ALLOWED; enum NOT_ALLOWED; } - mandatory false; description "It indicates whether the service data flow, corresponding to the service data flow template, is allowed or not allowed."; } } @@ -338,67 +365,56 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } leaf maxbrUl { type string; - mandatory false; description "It represents the maximum uplink bandwidth."; } leaf maxbrDl { type string; - mandatory false; description "It represents the maximum downlink bandwidth."; } leaf gbrUl { type string; - mandatory false; description "It represents the guaranteed uplink bandwidth."; } leaf gbrDl { type string; - mandatory false; description "It represents the guaranteed downlink bandwidth."; } uses ARP; leaf qosNotificationControl { type boolean; default false; - mandatory false; description "It indicates whether notifications are requested from 3GPP NG-RAN when the GFBR can no longer (or again) be guaranteed for a QoS Flow during the lifetime of the QoS Flow."; } leaf reflectiveQos { type boolean; default false; - mandatory false; description "Indicates whether the QoS information is reflective for the corresponding non-GBR service data flow"; } leaf sharingKeyDl { type string; - mandatory false; description "It indicates, by containing the same value, what PCC rules may share resource in downlink direction."; } leaf sharingKeyUl { type string; - mandatory false; description "It indicates, by containing the same value, what PCC rules may share resource in uplink direction."; } leaf maxPacketLossRateDl { type uint16 { range 0..1000; } - mandatory false; description "It indicates the downlink maximum rate for lost packets that can be tolerated for the service data flow."; } leaf maxPacketLossRateUl { type uint16 { range 0..1000; } - mandatory false; description "It indicates the uplink maximum rate for lost packets that can be tolerated for the service data flow."; } leaf extMaxDataBurstVol { type uint32 { range 4096..2000000; } - mandatory false; - description "It denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB, see TS 29.512 [60]."; + description "It denotes the largest amount of data that is required to be transferred within a period of 5G-AN PDB, see TS 29.512"; } } @@ -407,16 +423,18 @@ module _3gpp-5gc-nrm-predefinedpccruleset { leaf destMacAddr { type string; mandatory true; - description "It specifies the destination MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of IETF RFC 7042 [63]."; + description "It specifies the destination MAC address formatted in the + hexadecimal ."; + reference "clause 1.1 and clause 2.1 of IETF RFC"; } leaf ethType { type string; mandatory true; - description "A two-octet string that represents the Ethertype, as described in IEEE 802.3 [64] and IETF RFC 7042 [63] in hexadecimal representation."; + description "A two-octet string that represents the Ethertype."; + reference "IEEE 802.3 and IETF RFC 7042 in hexadecimal representation."; } leaf fDesc { type string; - mandatory false; description "It contains the flow description for the Uplink or Downlink IP flow. It shall be present when the ethtype is IP."; } leaf fDir { @@ -430,20 +448,24 @@ module _3gpp-5gc-nrm-predefinedpccruleset { leaf sourceMacAddr { type string; mandatory true; - description "It specifies the source MAC address formatted in the hexadecimal notation according to clause 1.1 and clause 2.1 of IETF RFC 7042 [63]."; + description "It specifies the source MAC address formatted in the + hexadecimal notation."; + reference "clause 1.1 and clause 2.1 of IETF RFC 7042"; } leaf-list vlanTags { type string; - description "It specifies the Customer-VLAN and/or Service-VLAN tags containing the VID, PCP/DEI fields as defined in IEEE 802.1Q [65] and IETF RFC 7042 [63]. The first/lower instance in the array stands for the Customer-VLAN tag and the second/higher instance in the array stands for the Service-VLAN tag."; + description "It specifies the Customer-VLAN and/or Service-VLAN tags + containing the VID, PCP/DEI fields as defined in IEEE 802.1Q and + IETF RFC 7042. The first/lower instance in the array stands for the + Customer-VLAN tag and the second/higher instance in the array stands + for the Service-VLAN tag."; } leaf srcMacAddrEnd { type string; - mandatory false; description "It specifies the source MAC address end. If this attribute is present, the sourceMacAddr attribute specifies the source MAC address start. E.g. srcMacAddrEnd with value 00-10-A4-23-3E-FE and sourceMacAddr with value 00-10-A4-23-3E-02 means all MAC addresses from 00-10-A4-23-3E-02 up to and including 00-10-A4-23-3E-FE."; } leaf destMacAddrEnd { type string; - mandatory false; description "It specifies the destination MAC address end. If this attribute is present, the destMacAddr attribute specifies the destination MAC address start."; } } @@ -474,11 +496,11 @@ module _3gpp-5gc-nrm-predefinedpccruleset { leaf spi { type string; mandatory true; - description "It is the security parameter index of the IPSec packet, see IETF RFC 4301 [66]"; + description "It is the security parameter index of the IPSec packet."; + reference "IETF RFC 4301"; } leaf flowLabel { type string; - mandatory false; description "It specifies the Ipv6 flow label header field."; } leaf flowDirection { @@ -494,7 +516,7 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } grouping PccRule { - description "It specifies the PCC rule, see TS 29.512 [60]."; + description "It specifies the PCC rule, see TS 29.512"; leaf pccRuleId { type string; mandatory true; @@ -511,44 +533,42 @@ module _3gpp-5gc-nrm-predefinedpccruleset { leaf applicationId { type string; default false; - mandatory false; - description "A reference to the application detection filter configured at the UPF."; + description "A reference to the application detection filter configured + at the UPF."; } leaf appDescriptor { type string; - mandatory false; description "It is the ATSSS rule application descriptor."; } leaf contentVersion { type uint8; - mandatory false; description "Indicates the content version of the PCC rule."; } leaf precedence { type uint8 { range 0..255; } - mandatory false; - description "It indicates the order in which this PCC rule is applied relative to other PCC rules within the same PDU session."; + description "It indicates the order in which this PCC rule is applied + relative to other PCC rules within the same PDU session."; } leaf afSigProtocol { type enumeration { enum NO_INFORMATION; enum SIP; } - mandatory false; - description "Indicates the protocol used for signalling between the UE and the AF, the default value is NO_INFORMATION."; + description "Indicates the protocol used for signalling between the UE + and the AF, the default value is NO_INFORMATION."; } leaf isAppRelocatable { type boolean; default false; mandatory false; - description "It indicates the application relocation possibility, the default value is NO_INFORMATION."; + description "It indicates the application relocation possibility, the + default value is NO_INFORMATION."; } leaf isUeAddrPreserved { type boolean; default false; - mandatory false; description "It Indicates whether UE IP address should be preserved."; } container qosData { @@ -560,7 +580,8 @@ module _3gpp-5gc-nrm-predefinedpccruleset { } } container altQosParams { - description "It contains the QoS control policy data for the Alternative QoS parameter sets of the service data flow."; + description "It contains the QoS control policy data for the Alternative + QoS parameter sets of the service data flow."; list qosDataInfo { description "The list of QoS control policy data."; key "qosId"; diff --git a/yang-models/_3gpp-5gc-nrm-smffunction.yang b/yang-models/_3gpp-5gc-nrm-smffunction.yang index 3fe49264dfec6bf1064db541e389bb6dadd080cf..04659fb7177c0faa018a10b85ac6eea4b630428c 100755 --- a/yang-models/_3gpp-5gc-nrm-smffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-smffunction.yang @@ -10,25 +10,25 @@ module _3gpp-5gc-nrm-smffunction { import ietf-inet-types { prefix inet; } import _3gpp-common-top { prefix top3gpp; } + organization "3gpp SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "SMFFunction derived from basic ManagedFunction."; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-06 { reference "CR-0333"; } revision 2020-06-03 { reference "CR-0286"; } revision 2019-10-25 { reference "S5-194457 S5-193518"; } - revision 2019-05-31 { - description "Ericsson refactoring."; - } - - revision 2018-08-07 { - description "Initial revision"; - } + revision 2019-05-31 {reference "Ericsson refactoring."; } + revision 2018-08-07 { reference "Initial revision";} grouping SMFFunctionGrp { + description "Represents the SMFFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { min-elements 1; - description "A list of PLMN identifiers (Mobile Country Code and Mobile Network Code)."; + description "A list of PLMN identifiers (Mobile Country Code and Mobile + Network Code)."; key "mcc mnc"; uses types3gpp:PLMNId; } @@ -43,40 +43,47 @@ module _3gpp-5gc-nrm-smffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } - leaf-list sNSSAIList { - min-elements 0; + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } leaf configurable5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Configurable5QISet that the SMFFunction supports (is associated to)."; + description "DN of the Configurable5QISet that the SMFFunction supports + (is associated to)."; } leaf dynamic5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Dynamic5QISet that the SMFFunction supports (is associated to)."; + description "DN of the Dynamic5QISet that the SMFFunction supports + (is associated to)."; } } diff --git a/yang-models/_3gpp-5gc-nrm-udmfunction.yang b/yang-models/_3gpp-5gc-nrm-udmfunction.yang index 5e2a32f829e1ef2eb4ec3fa0b9a7667540457f39..74965272afb49cd82bef6c063cd0815e141fc157 100755 --- a/yang-models/_3gpp-5gc-nrm-udmfunction.yang +++ b/yang-models/_3gpp-5gc-nrm-udmfunction.yang @@ -12,21 +12,24 @@ module _3gpp-5gc-nrm-udmfunction { import _3gpp-common-top { prefix top3gpp; } organization "3gpp SA5"; - description "This IOC represents the UDM function in 5GC. For more information about the UDM, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the UDM function in 5GC. For more + information about the UDM, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - - revision 2019-05-22 { - description "initial revision"; - } + revision 2019-05-22 { reference "initial revision";} grouping UDMFuntionGrp { + description "Represents the UDMFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -35,29 +38,35 @@ module _3gpp-5gc-nrm-udmfunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } list commModelList { min-elements 1; key "groupId"; + description "Specifies a list of commModel. It can be used by NF and + NF services to interact with each other in 5G Core network "; + reference "3GPP TS 23.501"; uses types5g3gpp:CommModel; } } diff --git a/yang-models/_3gpp-5gc-nrm-udrfunction.yang b/yang-models/_3gpp-5gc-nrm-udrfunction.yang index 49e433a49bbb971935540e635228942680accdd9..5eabaac8b2eafee0b8dbfb53a595821b2dd990ff 100755 --- a/yang-models/_3gpp-5gc-nrm-udrfunction.yang +++ b/yang-models/_3gpp-5gc-nrm-udrfunction.yang @@ -9,23 +9,28 @@ module _3gpp-5gc-nrm-udrfunction { import ietf-inet-types { prefix inet; } import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-common-top { prefix top3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; - description "This IOC represents the UDR function in 5GC. For more information about the UDR, see 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the UDR function in 5GC. For more information + about the UDR, see 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - revision 2019-05-22 { - description "initial revision"; - } + revision 2019-05-22 {reference "initial revision"; } grouping UDRFuntionGrp { + description "Representse the UDRFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -34,23 +39,26 @@ module _3gpp-5gc-nrm-udrfunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the service-based + interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; uses types3gpp:ManagedNFProfile; } } diff --git a/yang-models/_3gpp-5gc-nrm-udsffunction.yang b/yang-models/_3gpp-5gc-nrm-udsffunction.yang index f17d130dc51cee443d2b9c3b1f372a505243fa80..c0ef6f2176a74924cbc62eba684453c4a6cd239c 100755 --- a/yang-models/_3gpp-5gc-nrm-udsffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-udsffunction.yang @@ -9,24 +9,28 @@ module _3gpp-5gc-nrm-udsffunction { import ietf-inet-types { prefix inet; } import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-common-top { prefix top3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3gpp SA5"; - description "This IOC represents the UDSF function which can be interacted with any other 5GC NF defined in 3GPP TS 23.501."; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "This IOC represents the UDSF function which can be interacted + with any other 5GC NF defined in 3GPP TS 23.501."; reference "3GPP TS 28.541"; + revision 2020-11-05 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-195427 S5-193518"; } - revision 2019-05-22 { - description "initial revision"; - - } + revision 2019-05-22 { reference "initial revision"; } grouping UDSFFuntionGrp { + description "Represents the UDSFFuntion IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "List of at most six entries of PLMN Identifiers, but at least one (the primary PLMN Id). - The PLMN Identifier is composed of a Mobile Country Code (MCC) and a Mobile Network Code (MNC)."; + description "List of at most six entries of PLMN Identifiers, but at + least one (the primary PLMN Id). + The PLMN Identifier is composed of a Mobile Country Code (MCC) and a + Mobile Network Code (MNC)."; min-elements 1; max-elements 6; @@ -35,23 +39,28 @@ module _3gpp-5gc-nrm-udsffunction { } leaf sBIFQDN { - description "The FQDN of the registered NF instance in the service-based interface."; + description "The FQDN of the registered NF instance in the + service-based interface."; type inet:domain-name; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; //optional support reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; + description "Managed Network Function profile"; + reference "3GPP TS 23.501"; uses types3gpp:ManagedNFProfile; } } diff --git a/yang-models/_3gpp-5gc-nrm-upffunction.yang b/yang-models/_3gpp-5gc-nrm-upffunction.yang index 2ca20b923523f591a91ce69a9ecee8abef7901db..1443942e5bcdc28914c0404296b2736dad2f2505 100755 --- a/yang-models/_3gpp-5gc-nrm-upffunction.yang +++ b/yang-models/_3gpp-5gc-nrm-upffunction.yang @@ -9,22 +9,23 @@ module _3gpp-5gc-nrm-upffunction { import _3gpp-5g-common-yang-types { prefix types5g3gpp; } import _3gpp-common-top { prefix top3gpp; } + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "UPFFunction derived from basic ManagedFunction."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2020-11-05 { reference CR-0412 ; } revision 2019-10-25 { reference "S5-194457 S5-193518"; } - revision 2019-05-31 { - description "Ericsson refactoring."; - } - - revision 2018-08-07 { - description "Initial revision"; - } + revision 2019-05-31 { reference "Ericsson refactoring."; } + revision 2018-08-07 { reference "Initial revision"; } grouping UPFFunctionGrp { + description "Represents the UPFFunction IOC"; uses mf3gpp:ManagedFunctionGrp; list pLMNIdList { - description "A list of PLMN identifiers (Mobile Country Code and Mobile Network Code)."; + description "A list of PLMN identifiers (Mobile Country Code and Mobile + Network Code)."; min-elements 1; key "mcc mnc"; uses types3gpp:PLMNId; @@ -39,26 +40,28 @@ module _3gpp-5gc-nrm-upffunction { type types3gpp:Tac; } - leaf-list sNSSAIList { + list sNSSAIList { description "List of S-NSSAIs the managed object is capable of supporting. (Single Network Slice Selection Assistance Information) An S-NSSAI has an SST (Slice/Service type) and an optional SD (Slice Differentiator) field."; - min-elements 0; reference "3GPP TS 23.003"; - type types3gpp:SNssai; + key "sd sst"; + uses types5g3gpp:SNssai; } list managedNFProfile { key idx; min-elements 1; + max-elements 1; + reference "3GPP TS 23.003"; uses types3gpp:ManagedNFProfile; } - list commModelList { - min-elements 1; - key "groupId"; - uses types5g3gpp:CommModel; + leaf-list supportedBMOList { + type string; + description "List of supported BMOs (Bridge Managed Objects) required + for integration with TSN system."; } } diff --git a/yang-models/_3gpp-common-filemanagement.yang b/yang-models/_3gpp-common-filemanagement.yang new file mode 100644 index 0000000000000000000000000000000000000000..39dc1093f5a8fce96ae811e71294f2a51f28f54b --- /dev/null +++ b/yang-models/_3gpp-common-filemanagement.yang @@ -0,0 +1,95 @@ +module _3gpp-common-filemanagement { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-common-filemanagement"; + prefix "filemgmt3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-yang-types { prefix yang3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the FileDownloadJob Information Object + Class (IOC) that is part of the Generic Network Resource Model (NRM)."; + reference "3GPP TS 28.623 Generic Network Resource Model (NRM)"; + + revision 2022-02-10 { reference "Initial revision, S5-221757"; } + + grouping FileDownloadProcessMonitor { + description "Provides specialisations of the ProcessMonitor datatype."; + uses yang3gpp:ProcessMonitor { + refine resultStateInfo { + description "If status is FAILED resultStateInfo will be one of + the following or empty."; + must '../status != "FAILED" + or . = "UNKNOWN" + or . = "NO_STORAGE" + or . = "LOW_MEMORY" + or . = "NO_CONNECTION_TO_REMOTE_SERVER" + or . = "FILE_NOT_AVAILABLE" + or . = "DNS_CANNOT_BE_RESOLVED" + or . = "TIMER_EXPIRED" + or . = "OTHER" + or . = "NULL" '; + } + refine status { + description "Status must not be 'PARTIALLY_FAILED'."; + must '. != "PARTIALLY_FAILED" '; + } + } + } + + grouping FileDownloadJobGrp { + description "Represents the FileDownloadJob IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + + leaf fileLocation { + description "Provides the location of a file. + allowedValues: File URI (See RFC 8089)"; + mandatory true; + type string; + } + + leaf notificationRecipientAddress { + description "Address of the notification recipient."; + type string; + } + + leaf cancelJob { + description "Setting this attribute to TRUE cancels the file download job. + As specified in the definition of ProcessMonitor, cancellation is possible in + the NOT_STARTED and RUNNING state. Setting the attribute to FALSE has no + observable result."; + type boolean; + mandatory true; + } + + list jobMonitor { + key "id"; + description "Provides monitoring for the file download job."; + uses FileDownloadProcessMonitor; + } + } + + grouping FileDownloadJobSubtree { + description "Helps augmenting FileDownloadJob into multiple places."; + list FileDownloadJob { + description "Specifies the FileDownloadJob IOC, see 3GPP TS 28.622."; + key "id"; + uses top3gpp:Top_Grp; + container attributes { + uses FileDownloadJobGrp; + } + } + } + + augment "/subnet3gpp:SubNetwork" { + uses FileDownloadJobSubtree; + } + + augment "/me3gpp:ManagedElement" { + uses FileDownloadJobSubtree; + } +} diff --git a/yang-models/_3gpp-common-fm.yang b/yang-models/_3gpp-common-fm.yang index 10ea1a9c3a3c3e51f7f04cfe5e4d49e484c7eede..1399a086f6524651ae881b78af17a5c673927bf4 100755 --- a/yang-models/_3gpp-common-fm.yang +++ b/yang-models/_3gpp-common-fm.yang @@ -1,184 +1,186 @@ module _3gpp-common-fm { - yang-version 1.1; + yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-common-fm"; prefix "fm3gpp"; - + import ietf-yang-types { prefix yang; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-yang-types { prefix types3gpp; } organization "3GPP SA5"; - contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines a Fault Management model"; - + reference "3GPP TS 28.623 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions - + 3GPP TS 28.622 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)"; + revision 2021-08-08 { reference "CR-0132"; } + revision 2021-06-02 { reference "CR-0130"; } revision 2020-06-03 { reference "CR-0091"; } revision 2020-02-24 { reference "S5-201365"; } - - typedef eventType { - type enumeration { - enum COMMUNICATIONS_ALARM { - value 2; - } - - enum QUALITY_OF_SERVICE_ALARM { - value 3; - } - - enum PROCESSING_ERROR_ALARM { - value 4; - } - - enum EQUIPMENT_ALARM { - value 5; - } - - enum ENVIRONMENTAL_ALARM { - value 6; - } - - enum INTEGRITY_VIOLATION { - value 7; - } - - enum OPERATIONAL_VIOLATION { - value 8; - } - - enum PHYSICAL_VIOLATIONu { - value 9; - } - - enum SECURITY_SERVICE_OR_MECHANISM_VIOLATION { - value 10; - } - - enum TIME_DOMAIN_VIOLATION { - value 11; - } - } - - description "General category for the alarm."; - } - - typedef severity-level { - type enumeration { - enum CRITICAL { value 3; } - enum MAJOR { value 4; } - enum MINOR { value 5; } - enum WARNING { value 6; } - enum INDETERMINATE { value 7; } - enum CLEARED { value 8; } - } - - description "The possible alarm serverities. - Aligned with ERICSSON-ALARM-MIB."; - } - - grouping AlarmRecordGrp { - description "Contains alarm information of an alarmed object instance. - A new record is created in the alarm list when an alarmed object - instance generates an alarm and no alarm record exists with the same - values for objectInstance, alarmType, probableCause and specificProblem. - When a new record is created the MnS producer creates an alarmId, that + + typedef eventType { + type enumeration { + enum COMMUNICATIONS_ALARM { + value 2; + } + + enum QUALITY_OF_SERVICE_ALARM { + value 3; + } + + enum PROCESSING_ERROR_ALARM { + value 4; + } + + enum EQUIPMENT_ALARM { + value 5; + } + + enum ENVIRONMENTAL_ALARM { + value 6; + } + + enum INTEGRITY_VIOLATION { + value 7; + } + + enum OPERATIONAL_VIOLATION { + value 8; + } + + enum PHYSICAL_VIOLATIONu { + value 9; + } + + enum SECURITY_SERVICE_OR_MECHANISM_VIOLATION { + value 10; + } + + enum TIME_DOMAIN_VIOLATION { + value 11; + } + } + + description "General category for the alarm."; + } + + typedef severity-level { + type enumeration { + enum CRITICAL { value 3; } + enum MAJOR { value 4; } + enum MINOR { value 5; } + enum WARNING { value 6; } + enum INDETERMINATE { value 7; } + enum CLEARED { value 8; } + } + + description "The possible alarm serverities. + Aligned with ERICSSON-ALARM-MIB."; + } + + grouping AlarmRecordGrp { + description "Contains alarm information of an alarmed object instance. + A new record is created in the alarm list when an alarmed object + instance generates an alarm and no alarm record exists with the same + values for objectInstance, alarmType, probableCause and specificProblem. + When a new record is created the MnS producer creates an alarmId, that unambiguously identifies an alarm record in the AlarmList. - Alarm records are maintained only for active alarms. Inactive alarms are - automatically deleted by the MnS producer from the AlarmList. - Active alarms are alarms whose - a) perceivedSeverity is not CLEARED, or whose - b) perceivedSeverity is CLEARED and its ackState is not ACKNOWLEDED."; - + Alarm records are maintained only for active alarms. Inactive alarms are + automatically deleted by the MnS producer from the AlarmList. + Active alarms are alarms whose + a) perceivedSeverity is not CLEARED, or whose + b) perceivedSeverity is CLEARED and its ackState is not ACKNOWLEDED."; + leaf alarmId { type string; mandatory true; description "Identifies the alarmRecord"; } - + leaf objectInstance { type string; config false ; mandatory true; } - + leaf notificationId { - type string; + type int32; config false ; mandatory true; } - + leaf alarmRaisedTime { type yang:date-and-time ; config false ; } - + leaf alarmChangedTime { - type yang:date-and-time ; + type yang:date-and-time ; config false ; description "not applicable if related alarm has not changed"; } - + leaf alarmClearedTime { type yang:date-and-time ; config false ; description "not applicable if related alarm was not cleared"; } - + leaf alarmType { type eventType; config false ; - description "General category for the alarm."; + description "General category for the alarm."; } - + leaf probableCause { type string; config false ; } - + leaf specificProblem { type string; config false ; reference "ITU-T Recommendation X.733 clause 8.1.2.2."; } - + leaf perceivedSeverity { type severity-level; - description "This is Writable only if producer supports consumer + description "This is Writable only if producer supports consumer to set perceivedSeverity to CLEARED"; } - + leaf backedUpStatus { type string; config false ; - description "Indicates if an object (the MonitoredEntity) has a back + description "Indicates if an object (the MonitoredEntity) has a back up. See definition in ITU-T Recommendation X.733 clause 8.1.2.4."; } - + leaf backUpObject { type string; config false ; } - + leaf trendIndication { type string; config false ; - description "Indicates if some observed condition is getting better, + description "Indicates if some observed condition is getting better, worse, or not changing. "; reference "ITU-T Recommendation X.733 clause 8.1.2.6."; } - + grouping ThresholdPackGrp { leaf thresholdLevel { type string; @@ -188,21 +190,21 @@ module _3gpp-common-fm { } leaf hysteresis { type string; - description "The hysteresis has a threshold high and a threshold - low value that are different from the threshold value. - A hysteresis, therefore, defines the threshold-high and - threshold-low levels within which the measurementType value is - allowed to oscillate without triggering the threshold crossing + description "The hysteresis has a threshold high and a threshold + low value that are different from the threshold value. + A hysteresis, therefore, defines the threshold-high and + threshold-low levels within which the measurementType value is + allowed to oscillate without triggering the threshold crossing notification."; } } - + grouping ThresholdInfoGrp { leaf measurementType { type string; mandatory true; } - + leaf direction { type enumeration { enum INCREASING; @@ -210,149 +212,149 @@ module _3gpp-common-fm { } mandatory true; description " - If it is 'Increasing', the threshold crossing notification is - triggered when the measurement value equals or exceeds a + If it is 'Increasing', the threshold crossing notification is + triggered when the measurement value equals or exceeds a thresholdValue. - - If it is 'Decreasing', the threshold crossing notification is - triggered when the measurement value equals or below a + + If it is 'Decreasing', the threshold crossing notification is + triggered when the measurement value equals or below a thresholdValue."; } - + uses ThresholdPackGrp; } - - list thresholdInfo { + + list thresholdInfo { config false ; uses ThresholdInfoGrp; } - + leaf stateChangeDefinition { type string; config false ; - description "Indicates MO attribute value changes. See definition + description "Indicates MO attribute value changes. See definition in ITU-T Recommendation X.733 clause 8.1.2.11."; } - + leaf monitoredAttributes { type string; config false ; - description "Indicates MO attributes whose value changes are being - monitored. See definition in ITU-T Recommendation X.733 clause 8.1.2.11."; + description "Indicates MO attributes whose value changes are being + monitored."; + reference "ITU-T Recommendation X.733 clause 8.1.2.11."; } - + leaf proposedRepairActions { type string; config false ; - description "Indicates proposed repair actions. See definition in + description "Indicates proposed repair actions. See definition in ITU-T Recommendation X.733 clause 8.1.2.12."; } - + leaf additionalText { type string; config false ; } - - leaf additionalInformation { - type string; + + anydata additionalInformation { config false ; } - + leaf rootCauseIndicator { type enumeration { enum YES; enum NO; } config false ; - description "It indicates that this AlarmInformation is the root cause - of the events captured by the notifications whose identifiers are in + description "It indicates that this AlarmInformation is the root cause + of the events captured by the notifications whose identifiers are in the related CorrelatedNotification instances."; } - + leaf ackTime { type yang:date-and-time ; config false ; - description "It identifies the time when the alarm has been - acknowledged or unacknowledged the last time, i.e. it registers the + description "It identifies the time when the alarm has been + acknowledged or unacknowledged the last time, i.e. it registers the time when ackState changes."; } - + leaf ackUserId { type string; - description "It identifies the last user who has changed the + description "It identifies the last user who has changed the Acknowledgement State."; } - + leaf ackSystemId { type string; - description "It identifies the system (Management System) that last - changed the ackState of an alarm, i.e. acknowledged or unacknowledged + description "It identifies the system (Management System) that last + changed the ackState of an alarm, i.e. acknowledged or unacknowledged the alarm."; } - + leaf ackState { type enumeration { enum ACKNOWLEDGED { description "The alarm has been acknowledged."; } enum UNACKNOWLEDGED { - description "The alarm has unacknowledged or the alarm has never + description "The alarm has unacknowledged or the alarm has never been acknowledged."; } } } - + leaf clearUserId { type string; - description "Carries the identity of the user who invokes the + description "Carries the identity of the user who invokes the clearAlarms operation."; } - + leaf clearSystemId { type string; } - + leaf serviceUser { type string; config false ; - description "It identifies the service-user whose request for service - provided by the serviceProvider led to the generation of the + description "It identifies the service-user whose request for service + provided by the serviceProvider led to the generation of the security alarm."; } - + leaf serviceProvider { type string; config false ; - description "It identifies the service-provider whose service is - requested by the serviceUser and the service request provokes the + description "It identifies the service-provider whose service is + requested by the serviceUser and the service request provokes the generation of the security alarm."; } - + leaf securityAlarmDetector { type string; config false ; - } + } } - + grouping AlarmListGrp { description "Represents the AlarmList IOC."; - + leaf administrativeState { type types3gpp:AdministrativeState ; default LOCKED; - description "When set to UNLOCKED, the alarm list is updated. - When the set to LOCKED, the existing alarm records are not + description "When set to UNLOCKED, the alarm list is updated. + When the set to LOCKED, the existing alarm records are not updated, and new alarm records are not added to the alarm list."; } - + leaf operationalState { type types3gpp:OperationalState ; default DISABLED; config false; - description "The producer sets this attribute to ENABLED, indicating - that it has the resource and ability to record alarm in AlarmList - else, it sets the attribute to DISABLED."; - } + description "The producer sets this attribute to ENABLED, indicating + that it has the resource and ability to record alarm in AlarmList + else, it sets the attribute to DISABLED."; + } leaf numOfAlarmRecords { type uint32 ; @@ -360,49 +362,49 @@ module _3gpp-common-fm { mandatory true; description "The number of alarm records in the AlarmList"; } - + leaf lastModification { type yang:date-and-time ; config false; description "The last time when an alarm record was modified"; - } - + } + list alarmRecords { key alarmId; description "List of alarmRecords"; uses AlarmRecordGrp; - } + } } - + grouping FmSubtree { - description "Contains FM related classes. - Should be used in all classes (or classes inheriting from) + description "Contains FM related classes. + Should be used in all classes (or classes inheriting from) - SubNetwork - ManagedElement - - If some YAM wants to augment these classes/list/groupings they must + + If some YAM wants to augment these classes/list/groupings they must augment all user classes!"; - + list AlarmList { - key id; + key id; max-elements 1; - description "The AlarmList represents the capability to store and manage - alarm records. The management scope of an AlarmList is defined by all - descendant objects of the base managed object, which is the object + description "The AlarmList represents the capability to store and manage + alarm records. The management scope of an AlarmList is defined by all + descendant objects of the base managed object, which is the object name-containing the AlarmList, and the base object itself. - - AlarmList instances are created by the system or are pre-installed. + + AlarmList instances are created by the system or are pre-installed. They cannot be created nor deleted by MnS consumers. - - When the alarm list is locked or disabled, the existing alarm records + + When the alarm list is locked or disabled, the existing alarm records are not updated, and new alarm records are not added to the alarm list"; - - uses top3gpp:Top_Grp ; + + uses top3gpp:Top_Grp ; container attributes { uses AlarmListGrp ; - } + } } } - + } \ No newline at end of file diff --git a/yang-models/_3gpp-common-managed-element.yang b/yang-models/_3gpp-common-managed-element.yang index 9c94add88d03d266312af5a4c90e2be4c18fbc41..33acde382acf356b414420ce624d7a6d6409c953 100755 --- a/yang-models/_3gpp-common-managed-element.yang +++ b/yang-models/_3gpp-common-managed-element.yang @@ -6,11 +6,13 @@ module _3gpp-common-managed-element { import _3gpp-common-yang-types { prefix types3gpp ; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-measurements { prefix meas3gpp; } + import _3gpp-common-subscription-control { prefix subscr3gpp; } import _3gpp-common-fm { prefix fm3gpp; } import _3gpp-common-trace { prefix trace3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines ManagedElement which will be augmented by other IOCs"; reference "3GPP TS 28.623 @@ -26,18 +28,25 @@ module _3gpp-common-managed-element { 3GPP TS 28.620 Umbrella Information Model (UIM)"; + revision 2021-01-16 { reference "CR-0120"; } revision 2020-08-06 { reference "CR-0102"; } revision 2020-08-03 { reference "CR-0095"; } revision 2020-06-08 { reference "CR-0092"; } revision 2020-05-12 { reference "CR0084"; } revision 2020-02-24 { reference "S5-201365"; } revision 2019-06-17 { reference " S5-203316"; } - revision 2019-05-08 { description "Initial revision"; } + revision 2019-05-08 { reference "Initial revision"; } feature MeasurementsUnderManagedElement { - description "The MeasurementSubtree shall be contained under ManagedElement"; + description "The MeasurementSubtree shall be contained under + ManagedElement"; } + feature SubscriptionControlUnderManagedElement { + description "The SubscriptionControlSubtree shall be contained under + ManagedElement"; + } + feature FmUnderManagedElement { description "The FmSubtree shall be contained under ManagedElement"; } @@ -45,30 +54,41 @@ module _3gpp-common-managed-element { feature TraceUnderManagedElement { description "The TraceSubtree shall be contained under ManageElement"; } - + feature DESManagementFunction { - description "Classs representing Distributed SON or Domain-Centralized SON Energy Saving feature. The DESManagementFunction shall be contained under ManagedElement."; + description "Class representing Distributed SON or Domain-Centralized SON + Energy Saving feature. The DESManagementFunction shall be contained under + ManagedElement."; } feature DMROFunction { - description "Classs representing D-SON function of MRO feature. The DMROFunction shall be contained under ManagedElement."; + description "Class representing D-SON function of MRO feature. The + DMROFunction shall be contained under ManagedElement."; } - + feature DRACHOptimizationFunction { - description "Classs representing D-SON function of RACH optimization feature. The DRACHOptimizationFunction shall be contained under ManagedElement."; + description "Class representing D-SON function of RACH optimization + feature. The DRACHOptimizationFunction shall be contained under + ManagedElement."; } - + feature DPCIConfigurationFunction { - description "Classs representing Distributed SON or Domain-Centralized SON function of PCI configuration feature. The DPCIConfigurationFunction shall be contained under ManagedElement."; + description "Class representing Distributed SON or Domain-Centralized SON + function of PCI configuration feature. The DPCIConfigurationFunction shall + be contained under ManagedElement."; } - + feature CPCIConfigurationFunction { - description "Classs representing Cross Domain-Centralized SON function of PCI configuration feature. The CPCIConfigurationFunction shall be contained under ManagedElement."; + description "Class representing Cross Domain-Centralized SON function of PCI + configuration feature. The CPCIConfigurationFunction shall be contained + under ManagedElement."; } - + feature CESManagementFunction { - description "Classs representing Cross Domain-Centralized SON Energy Saving feature. The CESManagementFunction shall be contained under ManagedElement."; - } + description "Class representing Cross Domain-Centralized SON Energy Saving + feature. The CESManagementFunction shall be contained under + ManagedElement."; + } grouping ManagedElement_Grp { description "Abstract class representing telecommunications resources. @@ -140,9 +160,7 @@ module _3gpp-common-managed-element { and/or service to the subscriber."; uses ManagedElement_Grp; - uses meas3gpp:SupportedPerfMetricGroupGrp { - if-feature MeasurementsUnderManagedElement ; - } + uses meas3gpp:SupportedPerfMetricGroupGrp; leaf vendorName { config false; @@ -166,40 +184,43 @@ module _3gpp-common-managed-element { } list ManagedElement { - description "Represents telecommunications equipment or - TMN entities within the telecommunications network providing support - and/or service to the subscriber. - An ManagedElement IOC is used to represent a Network Element defined - in TS 32.101 including virtualizeation or non-virtualization scenario. - An ManagedElement instance is used for communicating with a manager (directly or indirectly) - over one or more management interfaces for the purpose of being monitored and/or - controlled. ManagedElement may or may not additionally perform element management - functionality. - An ManagedElement contains equipment that may or may not be geographically - distributed. - A telecommunication equipment has software and hardware components. - The ManagedElement IOC described above represents following two case: - - In the case when the when the software component - is designed to run on dedicated hardware component, the ManagedElement IOC - description includes both software and hardware components. - - In the case when the Software is designed to run on ETSI NFV defined NFVI [15], the - ManagedElement - IOC description would exclude the NFVI component supporting the above - mentioned subject software. A ManagedElement may be contained in either a SubNetwork or in a - MeContext instance. A single ManagedElement may also - exist stand-alone with no parent at all. - The relation of ManagedElement IOC and ManagedFunction IOC can be described as following: - - A ManaagedElement instance may have 1..1 containment relationship to a ManagedFunction - instance. In this case, the ManagedElement IOC may be used to represent a NE with signgle - functionality. For example, a ManagedElement is used to represent the 3GPP defined RNC - node; - - A ManagedElement instance may have 1..N containment relationship to multiple - ManagedFunction IOC instances. In this case, the ManagedElement IOC may be used to represent - a NE with combined ManagedFunction funcationality (as indicated by the managedElementType - attribute and the contained - instances of different ManagedFunction IOCs).For example, a - ManagedElement is used to represent the combined functionality of 3GPP defined - gNBCUCPFuntion,gNBCUUPFunction and gNBDUFunction"; + description "Represents telecommunications equipment or TMN entities within + the telecommunications network providing support and/or service to the + subscriber. An ManagedElement IOC is used to represent a Network Element + defined in TS 32.101 including virtualizeation or non-virtualization + scenario. An ManagedElement instance is used for communicating with a + manager (directly or indirectly) over one or more management interfaces + for the purpose of being monitored and/or controlled. ManagedElement may + or may not additionally perform element management functionality. + An ManagedElement contains equipment that may or may not be geographically + distributed. + + A telecommunication equipment has software and hardware components. The + ManagedElement IOC described above represents following two case: + - In the case when the software component is designed to run on dedicated + hardware component, the ManagedElement IOC description includes both + software and hardware components. + - In the case when the software is designed to run on ETSI NFV defined + NFVI [15], the ManagedElement IOC description would exclude the NFVI + component supporting the above mentioned subject software. + + A ManagedElement may be contained in either a SubNetwork or in a MeContext + instance. A single ManagedElement may also exist stand-alone with no + parent at all. + + The relation of ManagedElement IOC and ManagedFunction IOC can be + described as following: + - A ManaagedElement instance may have 1..1 containment relationship to a + ManagedFunction instance. In this case, the ManagedElement IOC may be + used to represent a NE with single functionality. For example, a + ManagedElement is used to represent the 3GPP defined RNC node; + - A ManagedElement instance may have 1..N containment relationship to + multiple ManagedFunction IOC instances. In this case, the ManagedElement + IOC may be used to represent a NE with combined ManagedFunction + funcationality (as indicated by the managedElementType attribute and the + contained instances of different ManagedFunction IOCs).For example, a + ManagedElement is used to represent the combined functionality of 3GPP + defined gNBCUCPFuntion, gNBCUUPFunction and gNBDUFunction"; key id; uses top3gpp:Top_Grp; @@ -208,15 +229,19 @@ module _3gpp-common-managed-element { } uses meas3gpp:MeasurementSubtree { - if-feature MeasurementsUnderManagedElement ; + if-feature MeasurementsUnderManagedElement; + } + + uses subscr3gpp:SubscriptionControlSubtree { + if-feature SubscriptionControlUnderManagedElement; } uses fm3gpp:FmSubtree { - if-feature FmUnderManagedElement ; + if-feature FmUnderManagedElement; } uses trace3gpp:TraceSubtree { - if-feature TraceUnderManagedElement ; + if-feature TraceUnderManagedElement; } } diff --git a/yang-models/_3gpp-common-managed-function.yang b/yang-models/_3gpp-common-managed-function.yang index 34415c24fbd355fd5d4bdec93459071ffb474774..57d745917952e3185b514c928e762d2da64771fb 100755 --- a/yang-models/_3gpp-common-managed-function.yang +++ b/yang-models/_3gpp-common-managed-function.yang @@ -10,7 +10,8 @@ module _3gpp-common-managed-function { organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "The module defines a base class/grouping for major 3GPP functions."; + description "The module defines a base class/grouping for major 3GPP + functions."; reference "3GPP TS 28.622 Generic Network Resource Model (NRM) @@ -19,14 +20,16 @@ module _3gpp-common-managed-function { 3GPP TS 28.620 Umbrella Information Model (UIM)"; - + revision 2022-01-07 { reference "CR-0146"; } + revision 2021-01-25 { reference "CR-0122"; } + revision 2020-09-30 { reference "CR-bbbb"; } revision 2020-08-06 { reference "CR-0102"; } revision 2020-08-03 { reference "CR-0095"; } revision 2020-06-23 { reference "CR-085"; } revision 2020-06-08 { reference "CR-0092"; } revision 2019-11-21 { reference "S5-197275, S5-197735"; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-06-18 { description "Initial revision"; } + revision 2019-06-18 { reference "Initial revision"; } feature MeasurementsUnderManagedFunction { description "The MeasurementSubtree shall be contained under ManageElement"; @@ -37,6 +40,7 @@ module _3gpp-common-managed-function { } grouping Operation { + description "This data type represents an Operation."; reference "3gpp TS 28.622"; leaf name { @@ -125,7 +129,7 @@ module _3gpp-common-managed-function { enum DEREGISTERED; } config false; - } +} } grouping Function_Grp { @@ -154,16 +158,19 @@ module _3gpp-common-managed-function { uses Function_Grp; - container vnfParametersList { + list vnfParametersList { + key vnfInstanceId; description "Contains the parameter set of the VNF - instance(s) corresponding to an NE."; - presence "The presence of this container indicates that the ManagedFunction + instance(s) corresponding to an NE. + The presence of this list indicates that the ManagedFunction represented is realized by one or more VNF instance(s). Otherwise it - shall be absent."; + shall be absent. + The presence of a vnfParametersList entry, whose vnfInstanceId with a + string length of zero, in createMO operation can trigger the + instantiation of the related VNF/VNFC instances."; leaf vnfInstanceId { type string ; - mandatory true; description "VNF instance identifier"; reference "ETSI GS NFV-IFA 008 v2.1.1: Network Functions Virtualisation (NFV); Management and Orchestration; @@ -192,12 +199,10 @@ module _3gpp-common-managed-function { description "Identifier of the VNF Deployment Flavour applied to this VNF instance."; reference "ETSI GS NFV-IFA 008 v2.1.1: - Network Functions Virtualisation (NFV); Management and Orchestration; - Ve-Vnfm reference point - Interface and Information Model Specification - section 9.4.3"; + Network Functions Virtualisation (NFV) Management and Orchestration"; } - - leaf autoScalable { + + leaf autoScalable { type boolean ; mandatory true; description "Indicator of whether the auto-scaling of this @@ -205,13 +210,14 @@ module _3gpp-common-managed-function { } } - container peeParametersList { + list peeParametersList { + key idx; description "Contains the parameter set for the control and monitoring of power, energy and environmental parameters of ManagedFunction instance(s)."; - presence "Present supported if the control and monitoring of PEE - parameters is supported by the ManagedFunction or sub-class instance."; - + + leaf idx { type uint32; } + leaf siteIdentification { type string; mandatory true; @@ -227,8 +233,9 @@ module _3gpp-common-managed-function { description "The latitude of the site where the ManagedFunction instance resides, based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to - the northern hemisphere. This attribute is optional in case of - BTSFunction and RNCFunction instance(s)."; + the northern hemisphere. This attribute is optional + for BTSFunction, RNCFunction, GNBDUFunction and + NRSectorCarrier instance(s)."; } leaf siteLongitude { @@ -239,9 +246,22 @@ module _3gpp-common-managed-function { description "The longitude of the site where the ManagedFunction instance resides, based on World Geodetic System (1984 version) global reference frame (WGS 84). Positive values correspond to - degrees east of 0 degrees longitude. This attribute is optional in - case of BTSFunction and RNCFunction instance(s)."; + degrees east of 0 degrees longitude. This attribute is optional + for BTSFunction, RNCFunction, GNBDUFunction and + NRSectorCarrier + instance(s)."; + } + + leaf siteAltitude { + type decimal64 { + fraction-digits 4; + } + description "The altitude of the site where the ManagedFunction + instance resides, in the unit of meter. This attribute is + optional for BTSFunction, RNCFunction, GNBDUFunction and + NRSectorCarrier instance(s)."; } + leaf siteDescription { type string; @@ -296,10 +316,10 @@ module _3gpp-common-managed-function { uses meas3gpp:MeasurementSubtree { if-feature MeasurementsUnderManagedFunction ; - } + } uses trace3gpp:TraceSubtree { if-feature TraceUnderManagedFunction ; } } -} \ No newline at end of file +} diff --git a/yang-models/_3gpp-common-measurements.yang b/yang-models/_3gpp-common-measurements.yang index b9fc0d644fb66893c087ef79ea110741fa02c83f..96893e6c393426eef89f311c6b2c8e53c1fa8487 100755 --- a/yang-models/_3gpp-common-measurements.yang +++ b/yang-models/_3gpp-common-measurements.yang @@ -1,83 +1,85 @@ module _3gpp-common-measurements { - yang-version 1.1; + yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-common-measurements"; prefix "meas3gpp"; - + import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-yang-types { prefix types3gpp; } organization "3GPP SA5"; - contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines Measurement and KPI related groupings Any list/class intending to use this should include 2 or 3 uses statements controlled by a feature: - - A) + + A) +++ feature MeasurementsUnderMyClass { -+++ description 'Indicates whether measurements and/or KPIs are supported ++++ description 'Indicates whether measurements and/or KPIs are supported +++ for this class.'; +++ } - - B) include the attribute measurementsList and/or kPIsList indicating the - supported measurment and KPI types and GPs. Note that for classes - inheriting from ManagedFunction, EP_RP or SubNetwork these attributes are + + B) include the attribute measurementsList and/or kPIsList indicating the + supported measurment and KPI types and GPs. Note that for classes + inheriting from ManagedFunction, EP_RP or SubNetwork these attributes are already inherited, so there is no need to include them once more. E.g. - + +++ grouping MyClassGrp { +++ uses meas3gpp:SupportedPerfMetricGroup; +++ } - - C) include the class PerfmetricJob to control the measurements/KPIs. E.g. - + + C) include the class PerfmetricJob to control the measurements/KPIs. E.g. + list MyClass { container attributes { uses MyClassGrp; } +++ uses meas3gpp:MeasurementSubtree { +++ if-feature MeasurementsUnderMyClass ; -+++ } ++++ } } - + Measurements can be contained under ManagedElement, SubNetwork, or - any list representing a class inheriting from Subnetwork or + any list representing a class inheriting from Subnetwork or ManagedFunction. Note: KPIs will only be supported under SubNetwork"; - + reference "3GPP TS 28.623 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions - + 3GPP TS 28.622 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)"; - revision 2020-09-04 { reference "CR-000107"; } - revision 2020-06-08 { reference "CR-0092"; } + revision 2021-07-22 { reference "CR-0137"; } + revision 2020-11-06 { reference "CR-0118"; } + revision 2020-09-04 { reference "CR-000107"; } + revision 2020-06-08 { reference "CR-0092"; } revision 2020-05-31 { reference "CR-0084"; } revision 2020-03-11 { reference "S5-201581, SP-200229"; } revision 2019-11-21 { reference "S5-197275, S5-197735"; } revision 2019-10-28 { reference "S5-193516"; } - revision 2019-06-17 { } - + revision 2019-06-17 { reference " "; } + grouping ThresholdInfoGrp { description "Defines a single threshold level."; - + leaf-list measurementTypes { type string; - description "The Measurement type can be those specified in TS 28.552, - TS 32.404 and can be those specified by other SDOs or can be + description "The Measurement type can be those specified in TS 28.552, + TS 32.404 and can be those specified by other SDOs or can be vendor-specific."; } - + leaf thresholdLevel { type uint64; mandatory true; - description "Number (key) for a single threshold in the threshold list + description "Number (key) for a single threshold in the threshold list applicable to the monitored performance metric."; } - + leaf thresholdDirection { type enumeration { enum UP; @@ -85,32 +87,32 @@ module _3gpp-common-measurements { enum UP_AND_DOWN; } must '. = "UP_AND_DOWN" or not(../hysteresis)' { - error-message "In case a threshold with hysteresis is configured, the " + error-message "In case a threshold with hysteresis is configured, the " +"threshold direction attribute shall be set to 'UP_AND_DOWN'."; } mandatory true; - description "Direction of a threshold indicating the direction for which + description "Direction of a threshold indicating the direction for which a threshold crossing triggers a threshold. - When the threshold direction is configured to 'UP', the associated - treshold is triggered only when the performance metric value is going - up upon reaching or crossing the threshold value. The treshold is not - triggered, when the performance metric is going down upon reaching or + When the threshold direction is configured to 'UP', the associated + treshold is triggered only when the performance metric value is going + up upon reaching or crossing the threshold value. The treshold is not + triggered, when the performance metric is going down upon reaching or crossing the threshold value. - Vice versa, when the threshold direction is configured to 'DOWN', the - associated treshold is triggered only when the performance metric is - going down upon reaching or crossing the threshold value. The treshold - is not triggered, when the performance metric is going up upon reaching + Vice versa, when the threshold direction is configured to 'DOWN', the + associated treshold is triggered only when the performance metric is + going down upon reaching or crossing the threshold value. The treshold + is not triggered, when the performance metric is going up upon reaching or crossing the threshold value. - When the threshold direction is set to 'UP_AND_DOWN' the treshold is + When the threshold direction is set to 'UP_AND_DOWN' the treshold is active in both direcions. - In case a threshold with hysteresis is configured, the threshold + In case a threshold with hysteresis is configured, the threshold direction attribute shall be set to 'UP_AND_DOWN'."; } - + leaf thresholdValue { type union { type int64; @@ -119,10 +121,10 @@ module _3gpp-common-measurements { } } mandatory true; - description "Value against which the monitored performance metric is + description "Value against which the monitored performance metric is compared at a threshold level in case the hysteresis is zero"; } - + leaf hysteresis { type union { type uint64; @@ -131,63 +133,65 @@ module _3gpp-common-measurements { range "0..max"; } } - description "Hysteresis of a threshold. If this attribute is present - the monitored performance metric is not compared against the - threshold value as specified by the thresholdValue attribute but + description "Hysteresis of a threshold. If this attribute is present + the monitored performance metric is not compared against the + threshold value as specified by the thresholdValue attribute but against a high and low threshold value given by threshold-high = thresholdValue + hysteresis threshold-low = thresholdValue - hysteresis - When going up, the threshold is triggered when the performance metric - reaches or crosses the high threshold value. When going down, the - hreshold is triggered when the performance metric reaches or crosses + When going up, the threshold is triggered when the performance metric + reaches or crosses the high threshold value. When going down, the + hreshold is triggered when the performance metric reaches or crosses the low threshold value. - A hysteresis may be present only when the monitored performance - metric is not of type counter that can go up only. If present + A hysteresis may be present only when the monitored performance + metric is not of type counter that can go up only. If present for a performance metric of type counter, it shall be ignored."; } } - - grouping SupportedPerfMetricGroupGrp { + + grouping SupportedPerfMetricGroupGrp { list SupportedPerfMetricGroup { config false; - description "Captures a group of supported performance metrics and + description "Captures a group of supported performance metrics and associated parameters related to their production and reporting. - A SupportedPerfMetricGroup attribute which is part of an MOI may - define performanceMetrics for any MOI under the subtree contained - under that MOI, e.g. SupportedPerfMetricGroup on a ManagedElement - can specify supported metrics for contained ManagedFunctions + A SupportedPerfMetricGroup attribute which is part of an MOI may + define performanceMetrics for any MOI under the subtree contained + under that MOI, e.g. SupportedPerfMetricGroup on a ManagedElement + can specify supported metrics for contained ManagedFunctions like a GNBDUFunction."; - + leaf-list performanceMetrics { type string; min-elements 1; - description "Performance metrics include measurements defined in - TS 28.552 and KPIs defined in TS 28.554. Performance metrics can - also be those specified by other SDOs or vendor specific metrics. - Performance metrics are identfied with their names. A name can also - identify a vendor specific group of performance metrics. + description "Performance metrics include measurements defined in + TS 28.552 and KPIs defined in TS 28.554. Performance metrics can + also be specified by other SDOs or be vendor specific. + Performance metrics are identfied with their names. - For measurements defined in TS 28.552 the name is constructed as + For measurements defined in TS 28.552 the name is constructed as follows: - - 'family.measurementName.subcounter' for measurement types with + - 'family.measurementName.subcounter' for measurement types with subcounters - 'family.measurementName' for measurement types without subcounters - 'family' for measurement families - For KPIs defined in TS 28.554 the name is defined in the KPI - definitions template as the component designated with e)."; + For KPIs defined in TS 28.554 the name is defined in the KPI + definitions template as the component designated with e). + + A name can also identify a vendor specific performance metric or a + group of vendor specific performance metrics."; } - + leaf-list granularityPeriods { type uint32 { range 1..max ; } units seconds; } - + leaf-list reportingMethods { type enumeration { enum FILE_BASED_LOC_SET_BY_PRODUCER; @@ -196,13 +200,13 @@ module _3gpp-common-measurements { } min-elements 1; } - + leaf-list monitorGranularityPeriods { type uint32 { range 1..max ; } units seconds; - description "Granularity periods supported for the monitoring of + description "Granularity periods supported for the monitoring of associated measurement types for thresholds"; } } @@ -210,120 +214,111 @@ module _3gpp-common-measurements { grouping PerfMetricJobGrp { description "Represents the attributtes of the IOC PerfMetricJob"; - + leaf administrativeState { default UNLOCKED; type types3gpp:AdministrativeState ; description "Enable or disables production of the metrics"; } - + leaf operationalState { config false; mandatory true; type types3gpp:OperationalState ; description "Indicates whether the PerfMetricJob is working."; - } + } - leaf perfMetricJobGroupId { + leaf jobId { type string; - description "Identifies members of a PerfMetricJob group. For the - stream based reporting method this reference shall be present."; + description "Id for a PerfMetricJob job."; } - leaf-list performanceMetrics { + leaf-list performanceMetrics { type string; min-elements 1; - description "Performance metrics include measurements defined in - TS 28.552 and KPIs defined in TS 28.554. Performance metrics can - also be those specified by other SDOs or vendor specific metrics. - Performance metrics are identfied with their names. A name can also + description "Performance metrics include measurements defined in + TS 28.552 and KPIs defined in TS 28.554. Performance metrics can + also be those specified by other SDOs or vendor specific metrics. + Performance metrics are identfied with their names. A name can also identify a vendor specific group of performance metrics. - For measurements defined in TS 28.552 the name is constructed as + For measurements defined in TS 28.552 the name is constructed as follows: - - 'family.measurementName.subcounter' for measurement types with + - 'family.measurementName.subcounter' for measurement types with subcounters - 'family.measurementName' for measurement types without subcounters - 'family' for measurement families - For KPIs defined in TS 28.554 the name is defined in the KPI + For KPIs defined in TS 28.554 the name is defined in the KPI definitions template as the component designated with e)."; } - + leaf granularityPeriod { type uint32 { range 1..max ; } units seconds; mandatory true; - description "Granularity period used to produce measurements. The value - must be one of the supported granularity periods for the metric. - - For measurements of type counter this is the period at which samples - of the internal counter value, that is incremented with every event - occurance, are taken. - - For measurements of type gauge, this is period, over which the mean - value of the measured variable is calculated. The mean value is - then taken as sample."; + description "Granularity period used to produce measurements. The value + must be one of the supported granularity periods for the metric."; } leaf-list objectInstances { type types3gpp:DistinguishedName; } - + leaf-list rootObjectInstances { type types3gpp:DistinguishedName; - description "Each object instance designates the root of a subtree that + description "Each object instance designates the root of a subtree that contains the root object and all descendant objects."; } - + choice reportingCtrl { mandatory true; - description "This choice defines the method for reporting collected - performance metrics to MnS consumers as well as the parameters for - configuring the reporting function. It is a choice between the control - parameter required for the reporting methods, whose presence selects + description "This choice defines the method for reporting collected + performance metrics to MnS consumers as well as the parameters for + configuring the reporting function. It is a choice between the control + parameter required for the reporting methods, whose presence selects the reporting method as follows: - - When only the fileReportingPeriod attribute is present, the MnS - producer shall store files on the MnS producer at a location selected - by the MnS producer and inform the MnS consumer about the availability - of new files and the file location using the notifyFileReady + - When only the fileReportingPeriod attribute is present, the MnS + producer shall store files on the MnS producer at a location selected + by the MnS producer and inform the MnS consumer about the availability + of new files and the file location using the notifyFileReady notification. - - When only the fileReportingPeriod and fileLocation attributes are - present, the MnS producer shall store the files on the MnS consumer at - the location specified by fileLocation. No notification is emitted by + - When only the fileReportingPeriod and fileLocation attributes are + present, the MnS producer shall store the files on the MnS consumer at + the location specified by fileLocation. No notification is emitted by the MnS producer. - - When only the streamTarget attribute is present, the MnS producer + - When only the streamTarget attribute is present, the MnS producer shall stream the data to the location specified by streamTarget. - - For the file-based reporting methods the fileReportingPeriod attribute - specifies the time window during which collected measurements are stored + + For the file-based reporting methods the fileReportingPeriod attribute + specifies the time window during which collected measurements are stored into the same file before the file is closed and a new file is opened."; - + case file-based-reporting { leaf fileReportingPeriod { type uint32 { range 1..max; } - units minutes"; + units minutes; must '(number(.)*"60") mod number(../granularityPeriod) = "0"' { - error-message - "The time-period must be a multiple of the granularityPeriod."; - } + error-message + "The time-period must be a multiple of the granularityPeriod."; + } mandatory true; - description "For the file-based reporting method this is the time - window during which collected measurements are stored into the same - file before the file is closed and a new file is opened. + description "For the file-based reporting method this is the time + window during which collected measurements are stored into the same + file before the file is closed and a new file is opened. The time-period must be a multiple of the granularityPeriod. - + Applicable when the file-based reporting method is supported"; } - - leaf fileLocation { + + leaf fileLocation { type string ; - description "Applicable and must be present when the file-based - reporting method is supported, and the files are stored on the MnS + description "Applicable and must be present when the file-based + reporting method is supported, and the files are stored on the MnS consumer."; } } @@ -331,17 +326,17 @@ module _3gpp-common-measurements { leaf streamTarget { type string; mandatory true; - description "Applicable when stream-based reporting method is + description "Applicable when stream-based reporting method is supported."; } } } } - + grouping ThresholdMonitorGrp { - description "A threshold monitor that is created by the consumer for - the monitored entities whose measurements are required by consumer + description "A threshold monitor that is created by the consumer for + the monitored entities whose measurements are required by consumer to monitor."; leaf administrativeState { @@ -349,198 +344,221 @@ module _3gpp-common-measurements { type types3gpp:AdministrativeState ; description "Enables or disables the ThresholdMonitor."; } - + leaf operationalState { config false; mandatory true; type types3gpp:OperationalState ; description "Indicates whether the ThresholdMonitor is working."; - } + } list thresholdInfoList { - key idx; + key idx; min-elements 1; leaf idx { type uint32 ; } - uses ThresholdInfoGrp; + uses ThresholdInfoGrp; } - + leaf monitorGranularityPeriod { type uint32 { range "1..max"; } units second; - mandatory true; - description " Granularity period used to monitor measurements for + mandatory true; + description " Granularity period used to monitor measurements for threshold crossings. "; } - + leaf-list objectInstances { type types3gpp:DistinguishedName; } - + leaf-list rootObjectInstances { type types3gpp:DistinguishedName; - description "Each object instance designates the root of a subtree that + description "Each object instance designates the root of a subtree that contains the root object and all descendant objects."; - } + } } - + grouping MeasurementSubtree { - description "Contains classes that define measurements. - Should be used in all classes (or classes inheriting from) + description "Contains classes that define measurements. + Should be used in all classes (or classes inheriting from) - SubNnetwork - ManagedElement - ManagedFunction - - If a YANG module wants to augment these classes/list/groupings they must + + If a YANG module wants to augment these classes/list/groupings they must augment all user classes! - - If a class uses this grouping in its list it shall also use the - grouping SupportedPerfMetricGroupGrp to add SupportedPerfMetricGroup as + + If a class uses this grouping in its list it shall also use the + grouping SupportedPerfMetricGroupGrp to add SupportedPerfMetricGroup as an attribute to its grouping"; - + list PerfMetricJob { - description "This IOC represents a performance metric production job. It + description "This IOC represents a performance metric production job. It can be name-contained by SubNetwork, ManagedElement, or ManagedFunction. - - To activate the production of the specified performance metrics, a MnS - consumer needs to create a PerfMetricJob instance on the MnS producer - and ensure that the adminState is sUNLOCKED>. - For ultimate deactivation of metric production, the MnS consumer should + + To activate the production of the specified performance metrics, a MnS + consumer needs to create a PerfMetricJob instance on the MnS producer. + For ultimate deactivation of metric production, the MnS consumer should delete the job to free up resources on the MnS producer. - - For temporary suspension of metric production, the MnS consumer can - manipulate the value of the administrative state attribute. The MnS - producer may disable metric production as well, for example in overload - situations. This situation is indicated by the MnS producer with setting - the operational state attribute to disabled. When production is resumed - the operational state is set again to enabled. - - The perfMetricJobGroupId is a common reference across all members of a - PerfMetricJob group. A group contains related PerfMetricJob instances. - - The attribute performanceMetrics defines the performance metrics to be - produced and the attribute granularityPeriod defines the granularity - period to be applied. - - All object instances below and including the instance name-containing - the PerfMetricJob (base object instance) are scoped for performance - metric production. Performance metrics are produced only on those object - instances whose object class matches the object class associated to the + + For temporary suspension of metric production, the MnS consumer can + manipulate the value of the administrative state attribute. The MnS + producer may disable metric production as well, for example in overload + situations. This situation is indicated by the MnS producer with setting + the operational state attribute to disabled. When production is resumed + the operational state is set back to enabled. + + The jobId attribute can be used to associate metrics from multiple + PerfMetricJob instances. The jobId can be included when reporting + performance metrics to allow a MnS consumer to associate received + metrics for the same purpose. For example, it is possible to configure + the same jobId value for multiple PerfMetricJob instances required to + produce the measurements for a specific KPI. + + The attribute performanceMetrics defines the performance metrics to be + produced and the attribute granularityPeriod defines the granularity + period to be applied. + + All object instances below and including the instance name-containing + the PerfMetricJob (base object instance) are scoped for performance + metric production. Performance metrics are produced only on those object + instances whose object class matches the object class associated to the performance metrics to be produced. - The attributes objectInstances and rootObjectInstances allow to restrict - the scope. When the attribute objectInstances is present, only the object - instances identified by this attribute are scoped. When the attribute - rootObjectInstances is present, then the subtrees whose root objects are - identified by this attribute are scoped. Both attributes may be present - at the same time meaning the total scope is equal to the sum of both - scopes. Object instances may be scoped by both the objectInstances and - rootObjectInstances attributes. This shall not be considered as an error - by the MnS producer. - - When the performance metric requires performance metric production on - multiple managed objects, which is for example the case for KPIs, the - MnS consumer needs to ensure all required objects are scoped. Otherwise + The attributes objectInstances and rootObjectInstances allow to restrict + the scope. When the attribute objectInstances is present, only the object + instances identified by this attribute are scoped. When the attribute + rootObjectInstances is present, then the subtrees whose root objects are + identified by this attribute are scoped. Both attributes may be present + at the same time meaning the total scope is equal to the sum of both + scopes. Object instances may be scoped by both the objectInstances and + rootObjectInstances attributes. This shall not be considered as an error + by the MnS producer. + + When the performance metric requires performance metric production on + multiple managed objects, which is for example the case for KPIs, the + MnS consumer needs to ensure all required objects are scoped. Otherwise a PerfMetricJob creation request shall fail. - The attribute reportingCtrl specifies the method and associated control - parameters for reporting the produced measurements to MnS consumers. - Three methods are available: file-based reporting with selection of the - file location by the MnS producer, file-based reporting with selection + The attribute reportingCtrl specifies the method and associated control + parameters for reporting the produced measurements to MnS consumers. + Three methods are available: file-based reporting with selection of the + file location by the MnS producer, file-based reporting with selection of the file location by the MnS consumer and stream-based reporting. - A PerfMetricJob creation request shall fail, when the requested - performance metrics, the requested granularity period, the requested - repoting method, or the requested combination thereof is not supported + For file-based reporting, all performance metrics that are produced + related to a 'PerfMetricJob' instance for a reporting period shall be + stored in a single reporting file. + + When the administrative state is set to 'UNLOCKED' after the creation + of a 'PerfMetricJob' the first granularity period shall start. When + the administrative state is set to 'LOCKED' or the operational state + to 'DISABLED', the ongoing reporting period shall be aborted, for + streaming the ongoing granularity period. When the administrative + state is set back to 'UNLOCKED' or the operational state to 'ENABLED' + a new reporting period period shall start, in case of streaming a new + granularity period. + + Changes of all other configurable attributes shall take effect only at + the beginning of the next reporting period, for streaming at the + beginning of the next granularity period. + + When the 'PerfMetricJob' is deleted, the ongoing reporting period shall + be aborted, for streaming the ongoing granularity period. + + A PerfMetricJob creation request shall fail, when the requested + performance metrics, the requested granularity period, the requested + repoting method, or the requested combination thereof is not supported by the MnS producer. - Creation and deletion of PerfMetricJob instances by MnS consumers is - optional; when not supported, PerfMetricJob instances may be created and + Creation and deletion of PerfMetricJob instances by MnS consumers is + optional; when not supported, PerfMetricJob instances may be created and deleted by the system or be pre-installed."; - key id; - uses top3gpp:Top_Grp ; + key id; + uses top3gpp:Top_Grp ; container attributes { uses PerfMetricJobGrp ; - } + } } - + list ThresholdMonitor { - key id; - description "Represents a threshold monitor for performance metrics. - It can be contained by SubNetwork, ManagedElement, or ManagedFunction. - A threshold monitor checks for threshold crossings of performance metric + key id; + description "Represents a threshold monitor for performance metrics. + It can be contained by SubNetwork, ManagedElement, or ManagedFunction. + A threshold monitor checks for threshold crossings of performance metric values and generates a notification when that happens. - To activate threshold monitoring, a MnS consumer needs to create a - ThresholdMonitor instance on the MnS producer. For ultimate deactivation - of threshold monitoring, the MnS consumer should delete the monitor to + To activate threshold monitoring, a MnS consumer needs to create a + ThresholdMonitor instance on the MnS producer. For ultimate deactivation + of threshold monitoring, the MnS consumer should delete the monitor to free up resources on the MnS producer. - For temporary suspension of threshold monitoring, the MnS consumer can - manipulate the value of the administrative state attribute. The MnS - producer may disable threshold monitoring as well, for example in - overload situations. This situation is indicated by the MnS producer with - setting the operational state attribute to disabled. When monitoring is + For temporary suspension of threshold monitoring, the MnS consumer can + manipulate the value of the administrative state attribute. The MnS + producer may disable threshold monitoring as well, for example in + overload situations. This situation is indicated by the MnS producer with + setting the operational state attribute to disabled. When monitoring is resumed the operational state is set again to enabled. - All object instances below and including the instance containing the - ThresholdMonitor (base object instance) are scoped for performance - metric production. Performance metrics are monitored only on those - object instances whose object class matches the object class associated + All object instances below and including the instance containing the + ThresholdMonitor (base object instance) are scoped for performance + metric production. Performance metrics are monitored only on those + object instances whose object class matches the object class associated to the performance metrics to be monitored. - - The optional attributes objectInstances and rootObjectInstances allow to - restrict the scope. When the attribute objectInstances is present, only - the object instances identified by this attribute are scoped. When the - attribute rootObjectInstances is present, then the subtrees whose root - objects are identified by this attribute are scoped. Both attributes may - be present at the same time meaning the total scope is equal to the sum - of both scopes. Object instances may be scoped by both the objectInstances - and rootObjectInstances attributes. This shall not be considered as an + + The optional attributes objectInstances and rootObjectInstances allow to + restrict the scope. When the attribute objectInstances is present, only + the object instances identified by this attribute are scoped. When the + attribute rootObjectInstances is present, then the subtrees whose root + objects are identified by this attribute are scoped. Both attributes may + be present at the same time meaning the total scope is equal to the sum + of both scopes. Object instances may be scoped by both the objectInstances + and rootObjectInstances attributes. This shall not be considered as an error by the MnS producer. - Multiple thresholds can be defined for multiple performance metric sets - in a single monitor using thresholdInfoList. The attribute + Multiple thresholds can be defined for multiple performance metric sets + in a single monitor using thresholdInfoList. The attribute monitorGranularityPeriod defines the granularity period to be applied. - Each threshold is identified with a number (key) called thresholdLevel. - A threshold is defined using the attributes thresholdValue , + Each threshold is identified with a number (key) called thresholdLevel. + A threshold is defined using the attributes thresholdValue , thresholdDirection and hysteresis. - When hysteresis is absent or carries no information, a threshold is - triggered when the thresholdValue is reached or crossed. When hysteresis - is present, two threshold values are specified for the threshold as - follows: A high treshold value equal to the threshold value plus the - hysteresis value, and a low threshold value equal to the threshold value - minus the hysteresis value. When the monitored performance metric - increases, the threshold is triggered when the high threshold value is - reached or crossed. When the monitored performance metric decreases, the - threshold is triggered when the low threshold value is reached or crossed. - The hsyteresis ensures that the performance metric value can oscillate - around a comparison value without triggering each time the threshold when + When hysteresis is absent or carries no information, a threshold is + triggered when the thresholdValue is reached or crossed. When hysteresis + is present, two threshold values are specified for the threshold as + follows: A high treshold value equal to the threshold value plus the + hysteresis value, and a low threshold value equal to the threshold value + minus the hysteresis value. When the monitored performance metric + increases, the threshold is triggered when the high threshold value is + reached or crossed. When the monitored performance metric decreases, the + threshold is triggered when the low threshold value is reached or crossed. + The hsyteresis ensures that the performance metric value can oscillate + around a comparison value without triggering each time the threshold when the threshold value is crossed. - Using the thresholdDirection attribute a threshold can be configured in - such a manner that it is triggered only when the monitored performance + Using the thresholdDirection attribute a threshold can be configured in + such a manner that it is triggered only when the monitored performance metric is going up or down upon reaching or crossing the threshold. - A ThresholdMonitor creation request shall be rejected, if the performance - metrics requested to be monitored, the requested granularity period, or - the requested combination thereof is not supported by the MnS producer. - A creation request may fail, when the performance metrics requested to be + A ThresholdMonitor creation request shall be rejected, if the performance + metrics requested to be monitored, the requested granularity period, or + the requested combination thereof is not supported by the MnS producer. + A creation request may fail, when the performance metrics requested to be monitored are not produced by a PerfMetricJob. - Creation and deletion of ThresholdMonitor instances by MnS consumers is - optional; when not supported, ThresholdMonitor instances may be created + Creation and deletion of ThresholdMonitor instances by MnS consumers is + optional; when not supported, ThresholdMonitor instances may be created and deleted by the system or be pre-installed."; - - uses top3gpp:Top_Grp ; + + uses top3gpp:Top_Grp ; container attributes { uses ThresholdMonitorGrp ; - } + } } - } + } } \ No newline at end of file diff --git a/yang-models/_3gpp-common-mnsregistry.yang b/yang-models/_3gpp-common-mnsregistry.yang new file mode 100755 index 0000000000000000000000000000000000000000..df01996aa3ae3bb09054e9aba515dc2bd9165b8c --- /dev/null +++ b/yang-models/_3gpp-common-mnsregistry.yang @@ -0,0 +1,74 @@ +module _3gpp-common-mnsregistry { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-common-mnsregistry"; + prefix "mnsregist3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the MNSRegistry Information Object + Class (IOC) that is part of the Generic Network Resource Model (NRM)."; + reference "3GPP TS 28.623 Generic Network Resource Model (NRM)"; + + revision 2021-11-23 { reference "S5-216090"; } + revision 2021-10-18 { reference "S5-215263"; } + revision 2021-08-29 { reference "Initial revision, S5-214388"; } + + grouping MNSInfoGrp { + description "Represents the MNSInfo IOC."; + reference "3GPP TS 28.622"; + leaf mnsLabel { + description "Human-readable name of management service."; + mandatory true; + type string; + } + + leaf mnsType { + description "Type of management service."; + type enumeration { + enum ProvMnS; + enum FaultSupervisionMnS; + enum StreamingDataReportingMnS; + enum FileDataReportingMnS; + } + } + + leaf mnsVersion { + description "Version of management service."; + type string; + } + + leaf mnsAddress { + description "Addressing information for Management Service operations."; + mandatory true; + type string; + } + + leaf-list mnsScope { + description "List of the managed object instances that can be accessed using the MnS. If a complete SubNetwork can be accessed using the MnS, this attribute may contain the DN of the SubNetwork instead of the DNs of the individual managed entities within the SubNetwork."; + min-elements 1; + type types3gpp:DistinguishedName; + } + + } + + augment "/subnet3gpp:SubNetwork" { + list MNSRegistry { + description "Represents the MNSRegistry IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + key id; + max-elements 1; + list MNSInfo { + description "Represents the MNSInfo IOC."; + reference "3GPP TS 28.622"; + uses top3gpp:Top_Grp; + key "mnsType mnsVersion mnsAddress"; + uses MNSInfoGrp; + } + } + } +} diff --git a/yang-models/_3gpp-common-subnetwork.yang b/yang-models/_3gpp-common-subnetwork.yang index ced4207391c98f7de97ccf4dfd3cff559bd31458..53739e61ca3705cca1c3e57219deb1deb03766a2 100755 --- a/yang-models/_3gpp-common-subnetwork.yang +++ b/yang-models/_3gpp-common-subnetwork.yang @@ -6,6 +6,7 @@ module _3gpp-common-subnetwork { import _3gpp-common-yang-types { prefix types3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-measurements { prefix meas3gpp; } + import _3gpp-common-subscription-control { prefix subscr3gpp; } import _3gpp-common-fm { prefix fm3gpp; } import _3gpp-common-trace { prefix trace3gpp; } import ietf-yang-schema-mount { prefix yangmnt; } @@ -27,6 +28,7 @@ module _3gpp-common-subnetwork { 3GPP TS 28.620 Umbrella Information Model (UIM)"; + revision 2021-01-16 { reference "CR-0120"; } revision 2020-08-06 { reference "CR-0102"; } revision 2020-06-08 { reference "CR-0092"; } revision 2020-05-08 { @@ -44,21 +46,24 @@ module _3gpp-common-subnetwork { } revision 2019-06-17 { - description "Initial revision"; + reference "Initial revision"; } feature ExternalsUnderSubNetwork { - description "Classes representing external entities like EUtranFrequency, ExternalGNBCUCPFunction, ExternalENBFunction are contained under a Subnetwork list/class."; } feature MeasurementsUnderSubNetwork { - description "The MeasurementSubtree shall be contained under SubNetwork - indicating the support of Measurements and/or KPIs"; + description "The MeasurementSubtree shall be contained under SubNetwork"; } + feature SubscriptionControlUnderSubNetwork { + description "The SubscriptionControlSubtree shall be contained under + SubNetwork"; + } + feature FmUnderSubNetwork { description "The FmSubtree shall be contained under SubNetwork"; } @@ -68,27 +73,36 @@ module _3gpp-common-subnetwork { } feature DESManagementFunction { - description "Classs representing Distributed SON or Domain-Centralized SON Energy Saving feature. The DESManagementFunction shall be contained under subnetwork."; + description "Class representing Distributed SON or Domain-Centralized SON + Energy Saving feature. The DESManagementFunction shall be contained under + SubNetwork."; } feature DMROFunction { - description "Classs representing D-SON function of MRO feature. The DMROFunction shall be contained under subnetwork."; + description "Class representing D-SON function of MRO feature. The + DMROFunction shall be contained under SubNetwork."; } feature DRACHOptimizationFunction { - description "Classs representing D-SON function of RACH optimization feature. The DRACHOptimizationFunction shall be contained under subnetwork."; + description "Class representing D-SON function of RACH optimization feature. + The DRACHOptimizationFunction shall be contained under SubNetwork."; } feature DPCIConfigurationFunction { - description "Classs representing Distributed SON or Domain-Centralized SON function of PCI configuration feature. The DPCIConfigurationFunction shall be contained under subnetwork."; + description "Class representing Distributed SON or Domain-Centralized SON + function of PCI configuration feature. The DPCIConfigurationFunction shall + be contained under SubNetwork."; } feature CPCIConfigurationFunction { - description "Classs representing Cross Domain-Centralized SON function of PCI configuration feature. The CPCIConfigurationFunction shall be contained under subnetwork."; + description "Class representing Cross Domain-Centralized SON function of PCI + configuration feature. The CPCIConfigurationFunction shall be contained + under SubNetwork."; } feature CESManagementFunction { - description "Classs representing Cross Domain-Centralized SON Energy Saving feature. The CESManagementFunction shall be contained under subnetwork."; + description "Class representing Cross Domain-Centralized SON Energy Saving + feature. The CESManagementFunction shall be contained under SubNetwork."; } grouping Domain_Grp { @@ -175,15 +189,19 @@ module _3gpp-common-subnetwork { } uses meas3gpp:MeasurementSubtree { - if-feature MeasurementsUnderSubNetwork ; + if-feature MeasurementsUnderSubNetwork; + } + + uses subscr3gpp:SubscriptionControlSubtree { + if-feature SubscriptionControlUnderSubNetwork; } uses fm3gpp:FmSubtree { - if-feature FmUnderSubNetwork ; + if-feature FmUnderSubNetwork; } uses trace3gpp:TraceSubtree { - if-feature TraceUnderSubNetwork ; + if-feature TraceUnderSubNetwork; } yangmnt:mount-point children-of-SubNetwork { diff --git a/yang-models/_3gpp-common-subscription-control.yang b/yang-models/_3gpp-common-subscription-control.yang index d37938d28b3ba952df79b876efd71504072ea096..25bde6927d08e51784ebcf38167c8ebcb7e36419 100755 --- a/yang-models/_3gpp-common-subscription-control.yang +++ b/yang-models/_3gpp-common-subscription-control.yang @@ -4,10 +4,9 @@ module _3gpp-common-subscription-control { prefix "subscr3gpp"; import _3gpp-common-top { prefix top3gpp; } - import _3gpp-common-subnetwork { prefix subnet3gpp; } - import _3gpp-common-managed-element { prefix me3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines IOCs for subscription and heartbeat control."; reference "3GPP TS 28.623 @@ -16,6 +15,7 @@ module _3gpp-common-subscription-control { Solution Set (SS) definitions 3GPP TS 28.623"; + revision 2021-01-16 { reference "CR-0120"; } revision 2020-08-26 { reference "CR-0106"; } revision 2019-11-29 { reference "S5-197648 S5-197647 S5-197829 S5-197828"; } @@ -90,11 +90,11 @@ module _3gpp-common-subscription-control { } grouping HeartbeatControlGrp { - description "Attributes of HeartbeatControl. Note the triggerHeartbeatNtf attribute - has no mapping in the present release."; + description "Attributes of HeartbeatControl. Note the triggerHeartbeatNtf + attribute has no mapping in the present release."; leaf heartbeatNtfPeriod { - type uint32 ; + type uint32; mandatory true; units seconds; description "Specifies the periodicity of heartbeat notification emission. @@ -103,7 +103,15 @@ module _3gpp-common-subscription-control { } } - grouping NtfSubscriptionControlWrapper { + grouping SubscriptionControlSubtree { + description "Contains notification subscription related classes. + Should be used in all classes (or classes inheriting from) + - SubNetwork + - ManagedElement + + If some YAM wants to augment these classes/list/groupings they must + augment all user classes!"; + list NtfSubscriptionControl { description "A NtfSubscriptionControl instance represents the notification subscription of a particular notification recipient. @@ -138,57 +146,57 @@ module _3gpp-common-subscription-control { instance. Creation and deletion of NtfSubscriptionControl instances by MnS consumers is optional; when not supported, the NtfSubscriptionControl - instances may be created and deleted by the system or be pre-installed."; + instances may be created and deleted by the system or be + pre-installed."; key id; - uses top3gpp:Top_Grp; + uses top3gpp:Top_Grp; container attributes { uses NtfSubscriptionControlGrp; } list HeartbeatControl { - min-elements 1; - max-elements 1; - description "MnS consumers (i.e. notification recipients) use heartbeat - notifications to monitor the communication channels between them and - data reporting MnS producers emitting notifications such as - notifyNewAlarm and notifyFileReady. + description "MnS consumers (i.e. notification recipients) use heartbeat + notifications to monitor the communication channels between them and + data reporting MnS producers emitting notifications such as + notifyNewAlarm and notifyFileReady. - A HeartbeatControl instance allows controlling the emission of - heartbeat notifications by MnS producers. The recipients of heartbeat - notifications are specified by the notificationRecipientAddress - attribute of the NtfSubscriptionControl instance containing the + A HeartbeatControl instance allows controlling the emission of + heartbeat notifications by MnS producers. The recipients of heartbeat + notifications are specified by the notificationRecipientAddress + attribute of the NtfSubscriptionControl instance containing the HeartbeatControl instance. - - Note that the MnS consumer managing the HeartbeatControl instance - and the MnS consumer receiving the heartbeat notifications may not be + Note that the MnS consumer managing the HeartbeatControl instance + and the MnS consumer receiving the heartbeat notifications may not be the same. - As a pre-condition for the emission of heartbeat notifications, a - HeartbeatControl instance needs to be created. Creation of an instance - with an initial non-zero value of the heartbeatNtfPeriod attribute - triggers an immediate heartbeat notification emission. Creation of an - instance with an initial zero value of the heartbeatPeriod attribute - does not trigger an emission of a heartbeat notification. Deletion of + As a pre-condition for the emission of heartbeat notifications, a + HeartbeatControl instance needs to be created. Creation of an instance + with an initial non-zero value of the heartbeatNtfPeriod attribute + triggers an immediate heartbeat notification emission. Creation of an + instance with an initial zero value of the heartbeatPeriod attribute + does not trigger an emission of a heartbeat notification. Deletion of an instance does not trigger an emission of a heartbeat notification. - Once the instance is created, heartbeat notifications are emitted with - a periodicity defined by the value of the heartbeatNtfPeriod attribute. - No heartbeat notifications are emitted if the value is equal to zero. - Setting a zero value to a non zero value, or a non zero value to a - different non zero value, triggers an immediate heartbeat notification, - that is the base for the new heartbeat period. Setting a non zero value - to a zero value stops emitting heartbeats immediately; no final - heartbeat notification is sent. + Once the instance is created, heartbeat notifications are emitted with + a periodicity defined by the value of the heartbeatNtfPeriod + attribute. No heartbeat notifications are emitted if the value is + equal to zero. Setting a zero value to a non zero value, or a non zero + value to a different non zero value, triggers an immediate heartbeat + notification, that is the base for the new heartbeat period. Setting a + non zero value to a zero value stops emitting heartbeats immediately; + no final heartbeat notification is sent. - Creation and deletion of HeartbeatControl instances by MnS Consumers is - optional; when not supported, the HeartbeatControl instances may be + Creation and deletion of HeartbeatControl instances by MnS Consumers + is optional; when not supported, the HeartbeatControl instances may be created and deleted by the system or be pre-installed. - - Whether and when to emit heartbeat notifications is controlled by - HeartbeatControl. Subscription for heartbeat is not supported via the + + Whether and when to emit heartbeat notifications is controlled by + HeartbeatControl. Subscription for heartbeat is not supported via the NtfSubscriptionControl."; + + max-elements 1; key id; uses top3gpp:Top_Grp; @@ -198,12 +206,4 @@ module _3gpp-common-subscription-control { } } } - - augment /subnet3gpp:SubNetwork { - uses NtfSubscriptionControlWrapper; - } - - augment /me3gpp:ManagedElement { - uses NtfSubscriptionControlWrapper; - } } \ No newline at end of file diff --git a/yang-models/_3gpp-common-trace.yang b/yang-models/_3gpp-common-trace.yang index c2eb08f015a4f4bd2d106dcdf111bf1c664913f1..8051893e7a276d0ebdd857711f952eb198bf6cb1 100755 --- a/yang-models/_3gpp-common-trace.yang +++ b/yang-models/_3gpp-common-trace.yang @@ -1,29 +1,34 @@ module _3gpp-common-trace { - yang-version 1.1; + yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-common-trace"; prefix "trace3gpp"; - + import _3gpp-common-top { prefix top3gpp; } import _3gpp-common-yang-types {prefix types3gpp; } import ietf-inet-types { prefix inet; } organization "3GPP SA5"; - contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - - description " "; - + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + + description "Trace handling"; + reference "3GPP TS 28.623 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Solution Set (SS) definitions - + 3GPP TS 28.622 Generic Network Resource Model (NRM) Integration Reference Point (IRP); Information Service (IS)"; - revision 2020-08-06 { reference "CR-0102"; } - + revision 2022-04-27 { reference "CR-0159"; } + revision 2021-10-18 { reference "CR-0139"; } + revision 2021-07-22 { reference "CR-0137"; } + revision 2021-01-25 { reference "CR-0122"; } + revision 2020-11-16 { reference "CR-0117"; } + revision 2020-08-06 { reference "CR-0102"; } + grouping TraceJobGrp { leaf tjJobType { type enumeration { @@ -36,14 +41,14 @@ module _3gpp-common-trace { enum LOGGED_MBSFN_MDT; } default TRACE_ONLY; - description "Specifies the MDT mode and it specifies also whether the - TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined - Trace and MDT job. The attribute is applicable for Trace, MDT, RCEF and - RLF reporting."; - reference "Clause 5.9a of 3GPP TS 32.422 for additional details on the + description "Specifies the MDT mode and it specifies also whether the + TraceJob represents only MDT, Logged MBSFN MDT, Trace or a combined + Trace and MDT job. The attribute is applicable for Trace, MDT, RCEF and + RLF reporting."; + reference "Clause 5.9a of 3GPP TS 32.422 for additional details on the allowed values."; } - + list tjListOfInterfaces { key idx; must 'count(MSCServerInterfaces)+count(MGWInterfaces)+count(RNCInterfaces)' @@ -57,16 +62,17 @@ module _3gpp-common-trace { +'+count(NEFInterfaces)+count(NRFInterfaces)+count(NSSFInterfaces)' +'+count(PCFInterfaces)+count(SMFInterfaces)+count(SMSFInterfaces)' +'+count(UDMInterfaces)+count(UPFInterfaces)+count(ng-eNBInterfaces)' - +'+count(gNB-CU-CPInterfaces)+count(gNB-CU-UPInterfaces)+count(gNB-DUInterfaces)'; - - description "Specifies the interfaces that need to be traced in the given - ManagedEntityFunction.The attribute is applicable only for Trace. In + +'+count(gNB-CU-CPInterfaces)+count(gNB-CU-UPInterfaces)' + +'+count(gNB-DUInterfaces)'; + + description "Specifies the interfaces that need to be traced in the given + ManagedEntityFunction.The attribute is applicable only for Trace. In case this attribute is not used, it carries a null semantic."; - reference "Clause 5.5 of 3GPP TS 32.422 for additional details on the + reference "Clause 5.5 of 3GPP TS 32.422 for additional details on the allowed values."; - - leaf idx { type uint32 ; } - + + leaf idx { type uint32 ; } + leaf-list MSCServerInterfaces { type enumeration { enum A ; @@ -373,78 +379,88 @@ module _3gpp-common-trace { enum GNB_CU_UP; enum GNB_DU; } - description "Specifies in which type of ManagedFunction the trace should - be activated. The attribute is applicable only for Trace with - Signalling Based Trace activation. In case this attribute is not used, + description "Specifies in which type of ManagedFunction the trace should + be activated. The attribute is applicable only for Trace with + Signalling Based Trace activation. In case this attribute is not used, it carries a null semantic"; - reference "Clause 5.4 of 3GPP TS 32.422 for additional details on the + reference "Clause 5.4 of 3GPP TS 32.422 for additional details on the allowed values"; } - + leaf tjPLMNTarget { type string; mandatory true; - description "Specifies which PLMN that the subscriber of the session to - be recorded uses as selected PLMN. PLMN Target might differ from the + description "Specifies which PLMN that the subscriber of the session to + be recorded uses as selected PLMN. PLMN Target might differ from the PLMN specified in the Trace Reference"; reference "Clause 5.9b of 3GPP TS 32.422"; } - + leaf tjStreamingTraceConsumerURI { - when './tjTraceReportingFormat = "STREAMING"'; + when '../tjTraceReportingFormat = "STREAMING"'; type inet:uri; mandatory true; - description "URI of the Streaming Trace data reporting MnS consumer - (a.k.a. streaming target). - This attribute shall be present if file based trace data reporting is - supported and tjTraceReportingFormat set to 'file based' or when + description "URI of the Streaming Trace data reporting MnS consumer + (a.k.a. streaming target). + This attribute shall be present if file based trace data reporting is + supported and tjTraceReportingFormat set to 'file based' or when tjJobType is set to Logged MDT or Logged MBSFN MDT."; reference "Clause 5.9 of 3GPP TS 32.422"; } - + leaf tjTraceCollectionEntityAddress { - when './tjTraceReportingFormat = "FILE_BASED" or ' - +'./tjJobType = "LOGGED_MDT_ONLY" or ./tjJobType = "LOGGED_MBSFN_MDT"'; + when '../tjTraceReportingFormat = "FILE_BASED" or ' + +'../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; type union { type inet:uri; type inet:ip-address; } mandatory true; - description "Specifies the address of the Trace Collection Entity when - the attribute tjTraceReportingFormat is configured for the file-based + description "Specifies the address of the Trace Collection Entity when + the attribute tjTraceReportingFormat is configured for the file-based reporting. The attribute is applicable for both Trace and MDT."; reference "Clause 5.9 of 3GPP TS 32.422"; } - + leaf tjTraceDepth { - when './tjJobType = "TRACE_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "TRACE_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type enumeration { enum MINIMUM; enum MEDIUM; enum MAXIMUM; enum VENDORMINIMUM; enum VENDORMEDIUM; - enum VENDORMAXIMUM; + enum VENDORMAXIMUM; } default MAXIMUM; - 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 + 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. - The attribute is applicable only for Trace, otherwise it carries a null + The attribute is applicable only for Trace, otherwise it carries a null semantic."; reference "Clause 5.3 of 3GPP TS 32.422"; } - + leaf tjTraceReference { type uint64; mandatory true; - description "A globally unique identifier, which uniquely identifies the - Trace Session that is created by the TraceJob. - In case of shared network, it is the MCC and MNC of the Participating + description "A globally unique identifier, which uniquely identifies the + Trace Session that is created by the TraceJob. + In case of shared network, it is the MCC and MNC of the Participating Operator that request the trace session that shall be provided. The attribute is applicable for both Trace and MDT."; } + + leaf tjTraceRecordSessionReference { + type string; + mandatory true; + description "An identifier, which identifies the Trace Recording Session. + The attribute is applicable for both Trace and MDT. + See the clause 5.7 of 3GPP TS 32.422 for additional details on the + allowed values."; + } leaf tjTraceReportingFormat { type enumeration { @@ -452,79 +468,90 @@ module _3gpp-common-trace { enum STREAMING; } default FILE_BASED; - description "Specifies the trace reporting format - streaming trace + description "Specifies the trace reporting format - streaming trace reporting or file-based trace reporting"; reference "3GPP TS 32.422 clause 5.11"; } - - leaf tjTraceTarget { - type enumeration { - enum IMSI; - enum IMEI; - enum IMEISV; - enum PUBLIC_ID; - enum UTRAN_CELL; - enum E_UTRAN_CELL; - enum NG_RAN_CELL; - enum ENB; - enum RNC; - enum GNB; + list tjTraceTarget { + key "targetIdType targetIdValue"; + max-elements 1; + + leaf targetIdType { + type enumeration { + enum IMSI; + enum IMEI; + enum IMEISV; + enum PUBLIC_ID; + enum UTRAN_CELL; + enum E_UTRAN_CELL; + enum NG_RAN_CELL; + enum ENB; + enum RNC; + enum GNB; + enum SUPI; + } } - mandatory true; - description "Specifies the target object of the Trace and MDT. The - attribute is applicable for both Trace and MDT. This attribute + + leaf targetIdValue { + type string; + } + + description "Specifies the target object of the Trace and MDT. The + attribute is applicable for both Trace and MDT. This attribute includes the ID type of the target as an enumeration and the ID value. - - The tjTraceTarget shall be public ID in case of a Management Based - Activation is done to an ScscfFunction. The tjTraceTarget shall be - cell only in case of the UTRAN cell traffic trace function. - The tjTraceTarget shall be E-UtranCell only in case of E-UTRAN cell - traffic trace function.The tjTraceTarget shall be either IMSI or - IMEI(SV) if the Trace Session is activated to any of the following + The tjTraceTarget shall be public ID in case of a Management Based + Activation is done to an ScscfFunction. The tjTraceTarget shall be + cell only in case of the UTRAN cell traffic trace function. + + The tjTraceTarget shall be E-UtranCell only in case of E-UTRAN cell + traffic trace function.The tjTraceTarget shall be either IMSI or + IMEI(SV) if the Trace Session is activated to any of the following ManagedEntity(ies): - - HssFunction - - MscServerFunction - - SgsnFunction - - GgsnFunction - - BmscFunction - - RncFunction - - MmeFunction - - The tjTraceTarget shall be IMSI if the Trace Session is activated to a + - HssFunction + - MscServerFunction + - SgsnFunction + - GgsnFunction + - BmscFunction + - RncFunction + - MmeFunction + + The tjTraceTarget shall be IMSI if the Trace Session is activated to a ManagedEntity playing a role of ServinGWFunction. - In case of signaling based MDT, the tjTraceTarget attribute shall be - able to carry (IMSI or IMEI(SV)), the tjMDTAreaScope attribute shall be - able to carry a list of (cell or EUtranCell or TA/LA/RA). + In case of signaling based Trace/MDT, the tjTraceTarget attribute shall + be able to carry (IMSI or IMEI(SV)or SUPI), the tjMDTAreaScope attribute + shall be able to carry a list of (cell or E-UtranCell or NRCellDU or + TA/LA/RA). - In case of management based Immediate MDT, the tjTraceTarget attribute - shall be null value, the tjMDTAreaScope attribute shall carry a list of - (Utrancell or E-UtranCell). + In case of management based Immediate MDT, the tjTraceTarget attribute + shall be null value, the tjMDTAreaScope attribute shall carry a list of + (Utrancell or E-UtranCell or NRCellDU). - In case of management based Logged MDT, the tjTraceTarget attribute - shall carry an eNodeBs or a RNC. The Logged MDT should be initiated on - the specified eNodeB/RNC in tjTraceTarget. The tjMDTAreaScope attribute - shall carry a list of (Utrancell or E-UtranCell or TA/LA/RA). + In case of management based Logged MDT, the tjTraceTarget attribute + shall carry an eBs or a RNC or gNBs. The Logged MDT should be initiated + on the specified eNB or RNC or gNB in tjTraceTarget. The tjMDTAreaScope + attribute shall carry a list of (Utrancell or E-UtranCell or NRCellDU or + TA/LA/RA). - In case of RLF reporting, or RCEF reporting, the tjTraceTarget attribute - shall be null value, the tjMDTAreaScope attribute shall carry one or - list of eNBs"; + In case of RLF reporting, or RCEF reporting, the tjTraceTarget + attribute shall be null value, the tjMDTAreaScope attribute shall carry + one or list of eNBs/gNBs"; reference "3GPP TS 32.422"; } leaf tjTriggeringEvent { - when './tjJobType = "TRACE" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "TRACE_ONLY" or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type string ; mandatory true; - description "Specifies the triggering event parameter of the trace session. - The attribute is applicable only for Trace. In case this attribute is + description "Specifies the triggering event parameter of the trace session. + The attribute is applicable only for Trace. In case this attribute is not used, it carries a null semantic."; reference "Clause 5.1 of 3GPP TS 32.422"; } leaf tjMDTAnonymizationOfData { - when ./tjMDTAreaScope ; + when ../tjMDTAreaScope ; type enumeration { enum NO_IDENTITY; enum TAC_OF_IMEI; @@ -535,23 +562,23 @@ module _3gpp-common-trace { } list tjMDTAreaConfigurationForNeighCell { - when './tjJobType = "LOGGED_MDT_ONLY"'; + when '../tjJobType = "LOGGED_MDT_ONLY"'; key "idx"; min-elements 1; leaf idx { type uint32 ; } - - description "It specifies the area for which UE is requested to perform - measurement logging for neighbour cells which have list of frequencies. - If it is not configured, the UE shall perform measurement logging for + + description "It specifies the area for which UE is requested to perform + measurement logging for neighbour cells which have list of frequencies. + If it is not configured, the UE shall perform measurement logging for all the neighbour cells. Applicable only to NR Logged MDT."; reference "3GPP TS 32.422 clause 5.10.26."; - + leaf frequency { type string; } - + leaf cell { type string; } @@ -559,13 +586,13 @@ module _3gpp-common-trace { leaf-list tjMDTAreaScope { type string; - description "specifies MDT area scope when activates an MDT job. + description "specifies MDT area scope when activates an MDT job. - For RLF and RCEF reporting it specifies the eNB or list of eNBs where the + For RLF and RCEF reporting it specifies the eNB or list of eNBs where the RLF or RCEF reports should be collected. - List of cells/TA/LA/RA for signaling based MDT or management based Logged + List of cells/TA/LA/RA for signaling based MDT or management based Logged MDT. List of cells for management based Immediate MDT. @@ -575,174 +602,314 @@ module _3gpp-common-trace { One or list of eNBs for RLF and RCEFreporting"; reference "Clause 5.10.2 of 3GPP TS 32.422"; } - + leaf tjMDTCollectionPeriodRrmLte { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type uint32 { range "250|500|1000|2000|3000|4000|6000|8000|12000|16000|20000|" +"24000|28000|32000|64000"; } units milliseconds; - description "Specifies the collection period for collecting RRM configured - measurement samples for M2, M3 in LTE. The attribute is applicable only - for Immediate MDT. In case this attribute is not used, it carries a + description "Specifies the collection period for collecting RRM configured + measurement samples for M2, M3 in LTE. The attribute is applicable only + for Immediate MDT. In case this attribute is not used, it carries a null semantic."; reference "Clause 5.10.20 of 3GPP TS 32.422"; } + leaf tjMDTCollectionPeriodM6Lte { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type uint32 { + range "1024|2048|5120|10240"; + } + units milliseconds; + description "Specifies the collection period for the Packet Delay + measurement (M6) for MDT taken by the eNB. The attribute is applicable + only for Immediate MDT. In case this attribute is not used, + it carries a null semantic."; + reference "Clause 5.10.32 of TS 32.422 "; + } + + leaf tjMDTCollectionPeriodM7Lte { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type uint16 { + range 1..60 ; + } + description "It specifies the collection period for the Data Volume (M6) + and Throughput measurements (M7) for UMTS MDT taken by RNC. The + attribute is applicable only for Immediate MDT. In case this attribute + is not used, it carries a null semantic."; + reference "Clause 5.10.22 of TS 32.422 ."; + } + leaf tjMDTCollectionPeriodRrmUmts { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type uint32 { range "1024|1280|2048|2560|5120|" +"10240|60000"; } units milliseconds; - description "Specifies the collection period for collecting RRM configured - measurement samples for M3, M4, M5 in UMTS. The attribute is applicable - only for Immediate MDT. In case this attribute is not used, it carries + description "Specifies the collection period for collecting RRM configured + measurement samples for M3, M4, M5 in UMTS. The attribute is applicable + only for Immediate MDT. In case this attribute is not used, it carries a null semantic"; reference "Clause 5.10.21 of 3GPP TS 32.422"; } + + leaf tjMDTCollectionPeriodRrmNR { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type uint32 { + range "1024|2048|5120|10240|60000"; + } + units milliseconds; + description "Specifies the collection period for collecting RRM + configured measurement samples for M4, M5 in NR. The attribute is + applicable only for Immediate MDT. In case this attribute is not + used, it carries a null semantic."; + reference "Clause 5.10.30 of 3GPP TS 32.422"; + } + + leaf tjMDTCollectionPeriodM6NR { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type enumeration { + enum 120ms; + enum 240ms; + enum 480ms; + enum 640ms; + enum 1024ms; + enum 2048ms; + enum 5120ms; + enum 10240ms; + enum 20480ms; + enum 40960ms; + enum 1min; + enum 6min; + enum 12min; + enum 30min; + } + description "It specifies the collection period for the Packet Delay + measurement (M6) for NR MDT taken by the gNB. The attribute is + applicable only for Immediate MDT. In case this attribute is not used, + it carries a null semantic."; + reference "clause 5.10.34 of TS 32.422"; + } + + leaf tjMDTCollectionPeriodM7NR { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type uint32 { + range "1..60"; + } + description "It specifies the collection period for the Packet Loss Rate + measurement (M7) for NR MDT taken by the gNB. The attribute is + applicable only for Immediate MDT. In case this attribute is not used, + it carries a null semantic."; + reference "clause 5.10.35 of TS 32.422"; + } leaf tjMDTEventListForTriggeredMeasurement { - when './tjJobType = "LOGGED_MDT_ONLY"'; + when '../tjJobType = "LOGGED_MDT_ONLY"'; type enumeration { enum OUT_OF_COVERAGE ; enum A2_EVENT ; } mandatory true; - description "Specifies event types for event triggered measurement in the - case of logged NR MDT. Each trace session may configure at most one - event. The UE shall perform logging of measurements only upon certain + description "Specifies event types for event triggered measurement in the + case of logged NR MDT. Each trace session may configure at most one + event. The UE shall perform logging of measurements only upon certain condition being fulfilled: - - Out of coverage. - - A2 event."; + - Out of coverage. + - A2 event."; reference "Clause 5.10.28 of 3GPP TS 32.422"; } - + leaf tjMDTEventThreshold { type int64; - description "Specifies the threshold which should trigger the reporting - in case A2 event reporting in LTE or 1F/1l event in UMTS. The attribute - is applicable only for Immediate MDT and when reportingTrigger is - configured for A2 event in LTE or 1F event or 1l event in UMTS. In + description "Specifies the threshold which should trigger the reporting + in case A2 event reporting in LTE or 1F/1l event in UMTS. The attribute + is applicable only for Immediate MDT and when reportingTrigger is + configured for A2 event in LTE or 1F event or 1l event in UMTS. In case this attribute is not used, it carries a null semantic."; reference "Clauses 5.10.7 and 5.10.7a of 3GPP TS 32.422"; } - + leaf tjMDTListOfMeasurements { - when './tjJobType = "IMMEDIATE_MDT"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"'; type int64; mandatory true; - description "It specifies the UE measurements that shall be collected in - an Immediate MDT job. The attribute is applicable only for Immediate MDT. + description "It specifies the UE measurements that shall be collected in + an Immediate MDT job. The attribute is applicable only for Immediate MDT. In case this attribute is not used, it carries a null semantic."; reference "3GPP TS 32.422 clause 5.10.3"; } - + leaf tjMDTLoggingDuration { - when './tjJobType = "LOGGED_MDT_ONLY" or ./tjJobType = "LOGGED_MBSFN_MDT"'; + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; type uint32 { range "600|1200|2400|3600|5400|7200"; } units seconds; mandatory true; - description "Specifies how long the MDT configuration is valid at the - UE in case of Logged MDT. The attribute is applicable only for - Logged MDT and Logged MBSFN MDT. In case this attribute is not used, it + description "Specifies how long the MDT configuration is valid at the + UE in case of Logged MDT. The attribute is applicable only for + Logged MDT and Logged MBSFN MDT. In case this attribute is not used, it carries a null semantic."; reference "5.10.9 of 3GPP TS 32.422"; } - + leaf tjMDTLoggingInterval { - when './tjJobType = "LOGGED_MDT_ONLY" or ./tjJobType = "LOGGED_MBSFN_MDT"'; + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; type uint32 { range "1280|2560|5120|10240|20480|" +"30720|40960|61440"; } units milliseconds; mandatory true; - description "Specifies the periodicty for Logged MDT. The attribute is - applicable only for Logged MDT and Logged MBSFN MDT. In case this + description "Specifies the periodicty for Logged MDT. The attribute is + applicable only for Logged MDT and Logged MBSFN MDT. In case this attribute is not used, it carries a null semantic"; reference "5.10.8 of 3GPP TS 32.422"; } + + leaf tjMDTLoggingEventThreshold { + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; + type uint32 { + range "0..127"; + } + description "It specifies the threshold which should trigger + the reporting in case of event based reporting of logged NR MDT. + The attribute is applicable only for Logged MDT and when tjMDTReportType + is configured for event triggered reporting and when + tjMDTEventListForTriggeredMeasurement is configured for L1 event. + In case this attribute is not used, it carries a null semantic."; + reference "clause 5.10.36 of TS 32.422"; + } + + leaf tjMDTLoggedHysteresis { + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; + type uint32 { + range "0..30"; + } + description "It specifies the hysteresis used within the entry and leave + condition of the L1 event based reporting of logged NR MDT. + The attribute is applicable only for Logged MDT, when tjMDTReportType + is configured for event triggered reporting and when + tjMDTEventListForTriggeredMeasurement is configured for L1 event. + In case this attribute is not used, it carries a null semantic."; + reference "clause 5.10.37 of TS 32.422"; + } + + leaf tjMDTLoggedTimeToTrigger { + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; + type int32 ; + description "It specifies the threshold which should trigger + the reporting in case of event based reporting of logged NR MDT. + The attribute is applicable only for Logged MDT, when tjMDTReportType + is configured for event triggered reporting and when + tjMDTEventListForTriggeredMeasurement is configured for L1 event. + In case this attribute is not used, it carries a null semantic."; + reference "clauses 5.10.38 of TS 32.422"; + } leaf-list tjMDTMBSFNAreaList { - when './tjJobType = "LOGGED_MBSFN_MDT"'; + when '../tjJobType = "LOGGED_MBSFN_MDT"'; type string; min-elements 1; max-elements 8; - description "The MBSFN Area consists of a MBSFN Area ID and Carrier - Frequency (EARFCN). The target MBSFN area List can have up to 8 entries. + description "The MBSFN Area consists of a MBSFN Area ID and Carrier + Frequency (EARFCN). The target MBSFN area List can have up to 8 entries. This parameter is applicable only if the job type is Logged MBSFN MDT."; reference "5.10.25 of 3GPP TS 32.422"; } leaf tjMDTMeasurementPeriodLTE { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type uint32 { range "1024|1280|2048|2560|5120|" +"10240|60000"; } units milliseconds; mandatory true; - description "It specifies the measurement period for the Data Volume and - Scheduled IP throughput measurements for MDT taken by the eNB. - The attribute is applicable only for Immediate MDT. In case this + description "It specifies the measurement period for the Data Volume and + Scheduled IP throughput measurements for MDT taken by the eNB. + The attribute is applicable only for Immediate MDT. In case this attribute is not used, it carries a null semantic."; reference "Clause 5.10.23 of 3GPP TS 32.422"; } leaf tjMDTMeasurementPeriodUMTS { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + 'or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type uint32 { range "250|500|1000|2000|3000|4000|6000|8000|12000|16000|20000|" +"24000|28000|32000|64000"; } units milliseconds; mandatory true; - description "It specifies the measurement period for the Data Volume and - Throughput measurements for MDT taken by RNC. - The attribute is applicable only for Immediate MDT. In case this + description "It specifies the measurement period for the Data Volume and + Throughput measurements for MDT taken by RNC. + The attribute is applicable only for Immediate MDT. In case this attribute is not used, it carries a null semantic."; reference "Clause 5.10.22 of 3GPP TS 32.422"; } - + leaf tjMDTMeasurementQuantity { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type uint64 ; mandatory true; - description "It specifies the measurements that are collected in an MDT + description "It specifies the measurements that are collected in an MDT job for a UMTS MDT configured for event triggered reporting."; reference "Clause 5.10.15 of 3GPP TS 32.422"; } + + leaf tjMDTM4ThresholdUmts { + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + type uint16 { + range 0..31 ; + } + description "It specifies the threshold which should trigger + the reporting in case of event-triggered periodic reporting for M4 + (UE power headroom measurement) in UMTS. In case this attribute is + not used, it carries a null semantic."; + reference "3GPP TS 32.422 clause 5.10.A"; + } list tjMDTPLMList { - when './tjJobType = "LOGGED_MDT_ONLY"'; + when '../tjJobType = "LOGGED_MDT_ONLY"'; key "mcc mnc"; uses types3gpp:PLMNId; min-elements 1; max-elements 16; - description "It indicates the PLMNs where measurement collection, status + description "It indicates the PLMNs where measurement collection, status indication and log reporting is allowed."; reference "Clause 5.10.24 of 3GPP TS 32.422"; } leaf tjMDTPositioningMethod { - when './tjJobType = "IMMEDIATE_MDT_ONLY" or ./tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' or ../tjJobType = "IMMEDIATE_MDT_AND_TRACE"'; type enumeration { enum GNSS; enum E_CELL_ID; } mandatory true; - description "It specifies what positioning method should be used in the + description "It specifies what positioning method should be used in the MDT job."; reference "Clause 5.10.19 of 3GPP TS 32.422"; } - + leaf tjMDTReportAmount { - when './tjJobType = "IMMEDIATE_MDT_ONLY" and ./tjMDTReportingTrigger = "PERIODICAL"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' and ../tjMDTReportingTrigger = "PERIODICAL"'; type union { type uint32 { range "1|4|8|16|32|64" ; @@ -752,16 +919,16 @@ module _3gpp-common-trace { } } mandatory true; - description "It specifies the number of measurement reports that shall be - taken for periodic reporting while the UE is in connected. - The attribute is applicable only for Immediate MDT and when - tjMDTReportingTrigger is configured for periodical measurements. In + description "It specifies the number of measurement reports that shall be + taken for periodic reporting while the UE is in connected. + The attribute is applicable only for Immediate MDT and when + tjMDTReportingTrigger is configured for periodical measurements. In case this attribute is not used, it carries a null semantic."; reference "Clause 5.10.6 of 3GPP TS 32.422"; } - + leaf tjMDTReportingTrigger { - when './tjJobType = "IMMEDIATE_MDT_ONLY"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"'; type enumeration { enum PERIODICAL; enum A2_FOR_LTE; @@ -771,17 +938,18 @@ module _3gpp-common-trace { enum ALL_CONFIGURED_RRM_FOR_LTE; enum ALL_CONFIGURED_RRM_FOR_UMTS; } - description "It specifies whether periodic or event based measurements - should be collected. - The attribute is applicable only for Immediate MDT and when the - tjMDTListOfMeasurements is configured for M1 (for both UMTS and LTE) - or M2 (only for UMTS). In case this attribute is not used, it carries + description "It specifies whether periodic or event based measurements + should be collected. + The attribute is applicable only for Immediate MDT and when the + tjMDTListOfMeasurements is configured for M1 (for both UMTS and LTE) + or M2 (only for UMTS). In case this attribute is not used, it carries a null semantic."; reference "Clause 5.10.4 of 3GPP TS 32.422"; } - + leaf tjMDTReportInterval { - when './tjJobType = "IMMEDIATE_MDT_ONLY" and ./tjMDTReportingTrigger = "PERIODICAL"'; + when '../tjJobType = "IMMEDIATE_MDT_ONLY"' + + ' and ../tjMDTReportingTrigger = "PERIODICAL"'; type uint32 { range "120|240|250|480|500|640|1000|1024|2000|2048|3000|4000|" +"5120|6000|8000|10240|12000|16000|20000|" @@ -790,16 +958,16 @@ module _3gpp-common-trace { } units milliseconds; mandatory true; - description "It specifies the interval between the periodical measurements - that shall be taken when the UE is in connected mode. - The attribute is applicable only for Immediate MDT and when - tjMDTReportingTrigger is configured for periodical measurements. In case + description "It specifies the interval between the periodical measurements + that shall be taken when the UE is in connected mode. + The attribute is applicable only for Immediate MDT and when + tjMDTReportingTrigger is configured for periodical measurements. In case this attribute is not used, it carries a null semantic."; reference "5.10.5 of 3GPP TS 32.422"; - } - + } + leaf tjMDTReportType { - when './tjJobType = "LOGGED_MDT_ONLY"'; + when '../tjJobType = "LOGGED_MDT_ONLY"'; type enumeration { enum PERIODICAL; enum EVENT_TRIGGERED; @@ -808,7 +976,7 @@ module _3gpp-common-trace { description "It specifies report type for logged NR MDT"; reference "Clause 5.10.27 of 3GPP TS 32.422"; } - + leaf tjMDTSensorInformation { type bits { bit BAROMETRIC_PRESSURE; @@ -816,56 +984,137 @@ module _3gpp-common-trace { bit UE_ORIENTATION; } default ""; - description "It specifies which sensor information shall be included in - logged NR MDT and immediate NR MDT measurement if they are available. - The following sensor measurement can be included or excluded for the UE."; + description "It specifies which sensor information shall be included in + logged NR MDT and immediate NR MDT measurement if they are available. + The following sensor measurement can be included or excluded for + the UE."; reference "Clause 5.10.29 of 3GPP TS 32.422"; } - + leaf tjMDTTraceCollectionEntityID { - when './tjJobType = "LOGGED_MDT_ONLY" or ./tjJobType = "LOGGED_MBSFN_MDT"'; + when '../tjJobType = "LOGGED_MDT_ONLY" or ../tjJobType = "LOGGED_MBSFN_MDT"'; type uint8; mandatory true; - description "It specifies the TCE Id which is sent to the UE in Logged MDT."; + description "It specifies the TCE Id which is sent to the UE in + Logged MDT."; reference "Clause 5.10.11 of 3GPP TS 32.422"; } } - + grouping TraceSubtree { - description "Contains classes that manage Tracing. - Should be used in all classes (or classes inheriting from) + description "Contains classes that manage Tracing. + Should be used in all classes (or classes inheriting from) - SubNnetwork - ManagedElement - ManagedFunction - - If a YANG module wants to augment these classes/list/groupings they must + + If a YANG module wants to augment these classes/list/groupings they must augment all user classes!"; - + list TraceJob { - description "Represents the Trace Control and Configuration parameters of a + description "Represents the Trace Control and Configuration parameters of a particular Trace Job (see TS 32.421 and TS 32.422 for details). - - To activate Trace Jobs, a MnS consumer has to create TraceJob object - instances on the MnS producer. A MnS consumer can activate a Trace Job - for another MnS consumer since it is not required the value of - tjTraceCollectionEntityAddress or tjStreamingTraceConsumerUri to be his + It can be name-contained by SubNetwork, ManagedElement, ManagedFunction + or NetworkSliceSubnet. + + To activate Trace Jobs, a MnS consumer has to create TraceJob object + instances on the MnS producer. A MnS consumer can activate a Trace Job + for another MnS consumer since it is not required the value of + tjTraceCollectionEntityAddress or tjStreamingTraceConsumerUri to be his own. - - When a MnS consumer wishes to deactivate a Trace Job, the MnS consumer - shall delete the corresponding TraceJob instance. - - For details of management Trace Job activation/deactivation see clause + + When a MnS consumer wishes to deactivate a Trace Job, the MnS consumer + shall delete the corresponding TraceJob instance. + + For details of management Trace Job activation/deactivation see clause 4.1.1.1.2 of TS 32.422. - Creation and deletion of TraceJob instances by MnS consumers is optional; - when not supported, the TraceJob instances may be created and deleted by + The attribute tjJobType specifies the kind of data to collect. Dependent + on the selected type various parameters shall be available. The + attributes tjJobType, tjTraceReference, tjTraceRecordSessionReference, + tjTraceCollectionEntityAddress and tjTraceReportingFormat are mandatory + for all job types. If streaming reporting is selected for + tjTraceReportingFormat, tjStreamingTraceConsumerURI shall be present + additionally. The attribute tjPLMNTarget shall be present if trace + activation method is management based. + + For the different job types the attributes are differentiated as follows: + - In case of TRACE_ONLY additionally the following attributes shall be + available: tjListOfNeTypes, tjTraceDepth, tjTraceTarget and + tjTriggeringEvent. + + For this case the optional attribute tjListOfInterfaces allows to + specify the interfaces to be recorded. + + - In case of IMMEDIATE_MDT_ONLY additionally the following attributes + shall be available: + - tjTraceTarget + - tjMDTAnonymizationOfData, + - tjMDTListOfMeasurements, + - tjMDTCollectionPeriodRrmUmts (conditional for M3, M4 and M5 in UMTS), + - tjMDTMeasurementPeriodUMTS (conditional for M6 and M7 in UMTS), + - tjMDTCollectionPeriodRrmLte (conditional for M2 and M3 in LTE), + - tjMDTMeasurementPeriodLTE (conditional for M4 and M5 in LTE), + - tjMDTCollectionPeriodM6Lte (conditional for M6 in LTE), + - tjMDTCollectionPeriodM7Lte (conditional for M7 in LTE), + - tjMDTCollectionPeriodRrmNR (conditional for M4 and M5 in NR), + - tjMDTCollectionPeriodM6NR (conditional for M6 in NR), + - tjMDTCollectionPeriodM7NR (conditional for M7 in NR), + - tjMDTReportInterval (conditional for M1 in LTE or NR and M1/M2 in + UMTS), + - tjMDTReportAmount (conditional for M1 in LTE or NR and M1/M2 in + UMTS), + - tjMDTReportingTrigger (conditional for M1 in LTE or NR and M1/M2 in + UMTS), + - tjMDTEventThreshold (conditional for A2 event reporting or A2 event + triggered periodic reporting), + - tjMDTMeasurementQuantity (conditional for 1F event reporting). + + For this case the optional attribute tjMDTAreaScope allows to specify + the area in terms of cells or Tracking Area/Routing Area/Location area + where the MDT data collection shall take place and the optional + attributes tjMDTPositioningMethod, tjMDTSensorInformation allow to + specify the positioning methods to use or the sensor information to + include. + + - In case of IMMEDIATE_MDT_AND_TRACE both additional attributes of + TRACE_ONLY and IMMEDIATE_MDT_ONLY shall apply. + + - In case of LOGGED_MDT_ONLY additionally the following attributes + shall be available: tjTraceTarget, tjMDTAnonymizationOfData, + tjMDTTraceCollectionEntityID, tjMDTLoggingInterval, + tjMDTLoggingDuration, tjMDTReportType, + tjMDTEventListForTriggeredMeasurements. + + For this case the optional attribute tjMDTAreaScope allows to specify + the area in terms of cells or Tracking Area/Routing Area/Location area + where the MDT data collection shall take place, the optional attribute + tjMDTPLMNList allows to specify the PLMNs where measurement collection, + status indication and log reporting is allowed, the optional attribute + tjMDTAreaConfigurationForNeighCell allows to specify the area for + which UE is requested to perform measurements logging for neighbour + cells which have list of frequencies and the optional attribute + tjMDTSensorInformation allows to specify the sensor information to + include. + + - In case of RLF_REPORT_ONLY and RCEF_REPORT_ONLY additionally the + attribute tjTraceTarget shall be available, the optional attribute + tjMDTAreaScope allows to specify the eNB or list of eNBs or gNB or + list of gNBs where the reports should be collected. + + - In case of LOGGED_MBSFN_MDT additionally the following attributes + shall be available: tjMDTAnonymizationOfData, tjMDTLoggingInterval, + tjMDTLoggingDuration, tjMDTMBSFNAreaList. + + Creation and deletion of TraceJob instances by MnS consumers is optional; + when not supported, the TraceJob instances may be created and deleted by the system or be pre-installed."; - - key id; - uses top3gpp:Top_Grp ; + + key id; + uses top3gpp:Top_Grp ; container attributes { uses TraceJobGrp ; - } + } } } -} \ No newline at end of file +} diff --git a/yang-models/_3gpp-common-yang-types.yang b/yang-models/_3gpp-common-yang-types.yang index 56ad2e9780abfcb927ebcd6902d0c9221c0b06a6..18084a2ebc95c6d1ed2090b6778e4ad9016b3f6a 100755 --- a/yang-models/_3gpp-common-yang-types.yang +++ b/yang-models/_3gpp-common-yang-types.yang @@ -7,10 +7,23 @@ module _3gpp-common-yang-types { import ietf-yang-types { prefix yang; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "The model defines a YANG mapping of the top level information classes used for management of 5G networks and network slicing."; - reference "3GPP TS 28.541"; + reference "3GPP TS 28.623"; + + revision 2022-02-09 { reference "CR-0144"; } + revision 2021-11-01 { reference "CR-0141"; } + revision 2021-09-30 { + description "Added Longitude, Latitude, TenthOfDegrees, OnOff."; + reference "CR-0138"; + } + + revision 2020-11-06 { + description "Removed incorrect S-NSSAI definitions."; + reference "CR-0118"; + } revision 2020-03-10 { description "Removed faulty when statements."; @@ -28,9 +41,210 @@ module _3gpp-common-yang-types { } revision 2019-06-23 { - description "Initial version."; + reference "Initial version."; + } + + typedef EnabledDisabled { + type enumeration { + enum DISABLED ; + enum ENABLED ; + } } + + grouping ProcessMonitor { + description "Provides attributes to monitor the progress of processes + with specific purpose and limited lifetime running on MnS producers. + It may be used as data type for dedicated progress monitor attributes + when specifying the management representation of these processes. + The attributes in this clause are defined in a generic way. + For some attributes specialisations may be provided when specifying a + concrete process representation. + + If a management operation on some IOCs triggers an associated + asynchronous process (whose progress shall be monitored), this should + also result in creating an attribute named 'processMonitor' (of type + 'ProcessMonitor') in these IOC(s). The processMonitor attribute may be + accompanied by use-case specific additional data items. + + The progress of the process is described by the 'status' and + 'progressPercentage' attributes. Additional textual qualifications for + the 'status' attribute may be provided by the 'progessStateInfo' and + 'resultStateInfo' attributes. + + When the process is instantiated, the 'status' is set to 'NOT_RUNNING' + and the 'progressPercentage' to '0'. The MnS producer decides when to + start executing the process and to transition into the 'RUNNING' state. + This time is captured in the 'startTime' attribute. Alternatively, the + process may start to execute directly upon its instantiation. One + alternative must be selected when using this data type. + + During the 'RUNNING' state the 'progressPercentage' attribute may be + repeatedly updated. The exact semantic of this attribute is subject to + further specialisation. The 'progessInfo' attribute may be used to + provide additional textual information in the 'NOT_RUNNING', 'CANCELLING' + and 'RUNNING' states. Further specialisation of + 'progressStateInfo' may be provided where this data type is + used. + + Upon successful completion of the process, the 'status' attribute is set + to 'FINISHED', the 'progressPercentage' to 100%. The time is captured in + the 'endTime' attribute. Additional textual information may be provided + in the 'resultStateInfo' attribute. The type of + 'resultStateInfo' in this data type definition is 'String'. + Further specialisation of 'resultStateInfo' may be provided + where this data type is used. + + In case the process fails to complete successfully, the 'status' + attribute is set to 'FAILED' or 'PARTIALLY_FAILED', the current value of + 'progressPercentage' is frozen, and the time captured in 'endTime'. The + 'resultStateInfo' specifies the reason for the failure. + Specific failure reasons may be specified where the data type defined in + this clause is used. The exact semantic of failure may be subject for + further specialisation as well. + + In case the process is cancelled, the 'status' attribute is first set to + 'CANCELLING' and when the process is really cancelled then to 'CANCELLED'. + The transition to 'CANCELLED' is captured in the 'endTime' attribute. + The value of 'progressPercentage' is frozen. Additional textual + information may be provided in the 'resultStateInfo' attribute. + + The 'resultStateInfo' attribute is provided only for additional textual + qualification of the states 'FINISHED', 'FAILED', 'PARTIALLY_FAILED' or + 'CANCELLED'. It shall not be used for making the outcome, that the + process may produce in case of success, available. + + The process may have to be completed within a certain time after its + creation, for example because required data may not be available any + more after a certain time, or the process outcome is needed until a + certain time and when not provided by this time is not needed any more. + The time until the MnS producer automatically cancels the process is + indicated by the 'timer' attribute."; + + leaf id { + type string; + mandatory true; + description "Id of the process. It is unique within a single + multivalue attribute of type ProcessMonitor."; + } + + leaf status { + type enumeration { + enum NOT_STARTED ; + enum RUNNING ; + enum CANCELLING ; + enum FINISHED ; + enum FAILED ; + enum PARTIALLY_FAILED ; + enum CANCELLED ; + } + config false; + default RUNNING; + description "Represents the status of the associated process, + whether it fails, succeeds etc. + It does not represent the returned values of a successfully finished + process. "; + } + + leaf progressPercentage { + type uint8 { + range 0..100; + } + config false; + description "Progress of the associated process as percentage"; + } + + leaf-list progressStateInfo { + type string; + config false; + description "Additional textual qualification of the states + 'NOT_STARTED', 'CANCELLING' and 'RUNNING'. + + For specific processes, specific well-defined strings (e.g. string + patterns or enums) may be defined as a specialisation."; + } + + leaf resultStateInfo { + type string; + config false; + description "Additional textual qualification of the states + 'FINISHED', 'FAILED', 'PARTIALLY_FAILED and 'CANCELLED'. + For example, in the 'FAILED' or 'PARTIALLY_FAILED' state this + attribute may be used to provide error reasons. + This attribute shall not be used to make the outcome of the process + available for retrieval, if any. For this purpose, dedicated + attributes shall be specified when specifying the representation of + a specific process. + + For specific processes, specific well-defined strings (e.g. string + patterns or enums) may be defined as a specialisation."; + } + + leaf startTime { + type yang:date-and-time; + config false; + description "Start time of the associated process, i.e. the time when the + status changed from 'NOT_STARTED' to 'RUNNING'."; + } + + leaf endTime { + type yang:date-and-time; + config false; + description "Date and time when status changed to 'SUCCESS', 'CANCELLED', + 'FAILED' or 'PARTIALLY_FAILED'. + + If the time is in the future, it is the estimated time + the process will end."; + } + + leaf timer { + type uint32; + units minutes; + description "Time until the associated process is automatically cancelled. + If set, the system decreases the timer with time. When it reaches zero + the cancellation of the associated process is initiated by the + MnS_Producer. + If not set, there is no time limit for the process. + + Once the timer is set, the consumer can not change it anymore. + If the consumer has not set the timer the MnS Producer may set it."; + } + } + + typedef TenthOfDegrees { + type uint16 { + range 0..3600; + } + units "0.1 degrees"; + description "A single integral value corresponding to an angle in degrees + between 0 and 360 with a resolution of 0.1 degrees."; + } + + typedef Latitude { + type decimal64 { + fraction-digits 4; + range "-90.0000..+90.0000"; + } + description "Latitude values"; + } + + typedef Longitude { + type decimal64 { + fraction-digits 4; + range "-180.0000..+180.0000"; + } + description "Longitude values"; + } + + typedef OnOff { + type enumeration { + enum ON; + enum OFF; + } + } + + // grouping ManagedNFProfile will be removed as it is + // being moved to _3gpp-5gc-nrm-nfprofile grouping ManagedNFProfile { description "Defines profile for managed NF"; reference "3GPP TS 23.501"; @@ -263,27 +477,6 @@ module _3gpp-common-yang-types { } } - typedef SNssai { - type union { - type Sst; - //optional support - type Sd; - } - description "Single Network Slice Selection Assistance Information."; - reference "TS 23.501 clause 5.15.2"; - } - - typedef Sst { - type uint8; - } - - typedef Sd { - type string{ - length 6; - pattern '[a-fA-F0-9]*'; - } - } - typedef Nrpci { type uint32; description "Physical Cell Identity (PCI) of the NR cell."; diff --git a/yang-models/_3gpp-nr-nrm-beam.yang b/yang-models/_3gpp-nr-nrm-beam.yang index 1ad71599263f0e5d40cb4be8e508d6e86052b2ed..64cdd8dcf78e613dc55c4a99215330119a10d333 100755 --- a/yang-models/_3gpp-nr-nrm-beam.yang +++ b/yang-models/_3gpp-nr-nrm-beam.yang @@ -1,6 +1,6 @@ module _3gpp-nr-nrm-beam { yang-version 1.1; - namespace "urn:3gpp:sa5:_3gpp-nr-nrm-nrnetwork-beam"; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-beam"; prefix "beam3gpp"; import _3gpp-nr-nrm-commonbeamformingfunction { prefix cbeamff3gpp; } @@ -11,6 +11,7 @@ module _3gpp-nr-nrm-beam { import _3gpp-nr-nrm-nrsectorcarrier { prefix nrsectcarr3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines the YANG mapping of the Beam Information Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; @@ -39,23 +40,30 @@ module _3gpp-nr-nrm-beam { leaf beamType { description "The type of the beam. "; - mandatory false; type BeamType; } leaf beamAzimuth { - description "The azimuth of a beam transmission, which means the horizontal beamforming pointing angle (beam peak direction) in the (Phi) f-axis in 1/10th degree resolution. The pointing angle is the direction equal to the geometric centre of the half-power contour of the beam relative to the reference plane. Zero degree implies explicit antenna bearing (boresight). Positive angle implies clockwise from the antenna bearing."; + description "The azimuth of a beam transmission, which means the + horizontal beamforming pointing angle (beam peak direction) in the + Phi-axis in 1/10th degree resolution. The pointing angle is the + direction equal to the geometric centre of the half-power contour + of the beam relative to the reference plane. Zero degree implies + explicit antenna bearing (boresight). Positive angle implies clockwise + from the antenna bearing."; reference "3GPP TS 38.104, TS 38.901, TS 28.662"; - mandatory false; type int32 { range "-1800..1800"; } units "0.1"; } leaf beamTilt { - description "The tilt of a beam transmission, which means the vertical beamforming pointing angle (beam peak direction) in the (Theta) ?-axis in 1/10th degree resolution. -The pointing angle is the direction equal to the geometric centre of the half-power contour of the beam relative to the reference plane. Positive value implies downtilt."; + description "The tilt of a beam transmission, which means the vertical + beamforming pointing angle (beam peak direction) in the Theta-axis in + 1/10th degree resolution. + The pointing angle is the direction equal to the geometric centre of + the half-power contour of the beam relative to the reference plane. + Positive value implies downtilt."; reference "3GPP TS 38.104, TS 38.901, TS 28.662"; - mandatory false; type int32 { range "-900..900"; } units "0.1"; } @@ -63,28 +71,33 @@ The pointing angle is the direction equal to the geometric centre of the half-po leaf beamHorizWidth { - description " The Horizontal beamWidth of a beam transmission, which means the horizontal beamforming half-power (3dB down) beamwidth in the (Phi) f-axis in 1/10th degree resolution."; + description " The Horizontal beamWidth of a beam transmission, which + means the horizontal beamforming half-power (3dB down) beamwidth in the + Phi-axis in 1/10th degree resolution."; reference "3GPP TS 38.104, TS 38.901"; - mandatory false; type int32 { range "0..3599"; } units "0.1"; } leaf beamVertWidth { - description " The Vertical beamWidth of a beam transmission, which means the vertical beamforming half-power (3dB down) beamwidth in the (Theta) ?-axis in 1/10th degree resolution."; + description " The Vertical beamWidth of a beam transmission, which means + the vertical beamforming half-power (3dB down) beamwidth in the + Theta-axis in 1/10th degree resolution."; reference "3GPP TS 38.104, TS 38.901"; - mandatory false; type int32 { range "0..1800"; } units "0.1"; } + } - - } - - augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/nrsectcarr3gpp:NRSectorCarrier/cbeamff3gpp:CommonBeamformingFunction" { + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/" + + "nrsectcarr3gpp:NRSectorCarrier/cbeamff3gpp:CommonBeamformingFunction" { list Beam { - description "Represents the per-Beam information required for, e.g. beam performance management utilizing measurements generated in the RAN. Can have spatial attributes of horizontal/azimuth (ie: Phi f-axis) and vertical/tilt (ie: Theta ?-axis) beam pointing direction and beam width attributes."; + description "Represents the per-Beam information required for, + e.g. beam performance management utilizing measurements generated in + the RAN. Can have spatial attributes of horizontal/azimuth + (ie: Phi-axis) and vertical/tilt (ie: Theta-axis) beam pointing + direction and beam width attributes."; reference "3GPP TS 28.541"; key id; uses top3gpp:Top_Grp; diff --git a/yang-models/_3gpp-nr-nrm-bwp.yang b/yang-models/_3gpp-nr-nrm-bwp.yang index cd28affd790bee6da6217816a142e14ff773e50c..bd18865a6f14962bf475d2dbe20dc988b40aa3ed 100755 --- a/yang-models/_3gpp-nr-nrm-bwp.yang +++ b/yang-models/_3gpp-nr-nrm-bwp.yang @@ -9,14 +9,14 @@ module _3gpp-nr-nrm-bwp { import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines the YANG mapping of the BWP Information Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2020-11-17 { reference CR-0410 ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-06-17 { - description "Initial revision"; - } + revision 2019-06-17 { reference "Initial revision"; } typedef CyclicPrefix { type enumeration { @@ -32,7 +32,6 @@ module _3gpp-nr-nrm-bwp { enum SUL; } } - typedef IsInitialBwp { type enumeration { enum INITIAL; @@ -63,12 +62,12 @@ module _3gpp-nr-nrm-bwp { description "Subcarrier spacing configuration for a BWP."; reference "3GPP TS 38.104"; mandatory true; - type uint32 { range "5 | 30 | 60 | 120"; } + type uint32 { range "15 | 30 | 60 | 120"; } units kHz; } leaf cyclicPrefix { - description "Cyclic prefix, which may be normal or extended."; + description "Cyclic prefix, which may be normal or extended."; reference "3GPP TS 38.211"; mandatory true; type CyclicPrefix; diff --git a/yang-models/_3gpp-nr-nrm-cesmanagementfunction.yang b/yang-models/_3gpp-nr-nrm-cesmanagementfunction.yang index 8aa498d81f783f515353dec752e7c008d32ecf18..f438d0b2263dc088d84a1307150db004f29b9b9b 100755 --- a/yang-models/_3gpp-nr-nrm-cesmanagementfunction.yang +++ b/yang-models/_3gpp-nr-nrm-cesmanagementfunction.yang @@ -1,64 +1,269 @@ module _3gpp-nr-nrm-cesmanagementfunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-cesmanagementfunction"; - prefix "cesmanagementfunction3gpp"; + prefix "cesmf3gpp"; import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } import _3gpp-common-managed-element { prefix me3gpp; } - + import _3gpp-5g-common-yang-types { prefix type5g3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the CESManagementFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Defines the YANG mapping of the CESManagementFunction + Information Object Class (IOC) that is part of the NR Network Resource Model + (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-08-05 { reference S5-214053/CR-0518; } revision 2020-05-08 { reference S5-203316; } + grouping loadTimeThresholdGrp { + description "Represents the the traffic load threshold and the time + duration."; + leaf loadThreshold { + description "This attribute is used by distributed ES algorithms to allow + a cell to enter the energySaving state."; + type type5g3gpp:EnergySavingLoadThresholdT; + } + leaf timeDuration { + description "The time duration indicates how long the traffic load + (either for UL or DL) in the cell needs to have been above the + threshold to wake up one or more original cells which have been + provided backup coverage by the candidate cell."; + type type5g3gpp:EnergySavingLoadThresholdT; + } + } grouping CESManagementFunctionGrp { description "Represents the CESManagementFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; leaf cesSwitch { - description "This attribute determines whether the Cross Domain-Centralized SON energy saving function is enabled or disabled."; - type boolean; + description "This attribute determines whether the Centralized SON energy + saving function is enabled or disabled."; + type boolean; + default true; + } + list intraRatEsActivationOriginalCellLoadParameters { + description "This attributes is relevant, if the cell acts as an original + cell.This attribute indicates the traffic load threshold and the time + duration, which are used by distributed ES algorithms to allow a cell + to enter the energySaving state. The time duration indicates how long + the load needs to have been below the threshold."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; } - leaf energySavingState { - description "Specifies the status regarding the energy saving in the cell. If the value of energySavingControl is toBeEnergySaving, then it shall be tried to achieve the value isEnergySaving for the energySavingState. If the value of energySavingControl is toBeNotEnergySaving, then it shall be tried to achieve the value isNotEnergySaving for the energySavingState. "; - type enumeration{ - enum isNotEnergySaving; - enum isEnergySaving; - } + list intraRatEsActivationCandidateCellsLoadParameters { + description "This attributes is relevant, if the cell acts as a candidate + cell. This attribute indicates the traffic load threshold and the time + duration, which are used by distributed ES algorithms level to allow an + 'original' cell to enter the energySaving state. Threshold and duration + are applied to the candidate cell(s) which will provides coverage + backup of an original cell when it is in the energySaving state. The + threshold applies in the same way for a candidate cell, no matter for + which original cell it will provide backup coverage. + The time duration indicates how long the traffic in the candidate cell + needs to have been below the threshold before any original cells which + will be provided backup coverage by the candidate cell enters energy + saving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list intraRatEsDeactivationCandidateCellsLoadParameters { + description "This attributes is relevant, if the cell acts as a candidate + cell. This attribute indicates the traffic load threshold and the time + duration which is used by distributed ES algorithms to allow a cell to + leave the energySaving state. Threshold and time duration are applied + to the candidate cell when it which provides coverage backup for the + cell in energySaving state. The threshold applies in the same way for a + candidate cell, no matter for which original cell it provides backup + coverage. + The time duration indicates how long the traffic in the candidate cell + needs to have been above the threshold to wake up one or more original + cells which have been provided backup coverage by the candidate cell."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list esNotAllowedTimePeriod { + description "This is a list of time periods during which + inter-RAT energy saving is not allowed"; + key idx; + + leaf idx { + type uint32; + } + uses EsNotAllowedTimePeriodGrp; + } + + list interRatEsActivationOriginalCellParameters { + description "This attribute is relevant, if the cell acts as an original + cell. This attribute indicates the traffic load threshold and the time + duration, which are used by distributed inter-RAT ES algorithms to + allow an original cell to enter the energySaving state. The time + duration indicates how long the traffic load (both for UL and DL) needs + to have been below the threshold. + + In case the original cell is an EUTRAN cell, the load information + refers to Composite Available Capacity Group IE (see 3GPP TS 36.413 + [12] Annex B.1.5) and the following applies: + Load = (100 - 'Capacity Value' ) * 'Cell Capacity Class Value', + where 'Capacity Value' and 'Cell Capacity Class Value' are defined in + 3GPP TS 36.423 [7]. + + In case the original cell is a UTRAN cell, the load information refers + to Cell Load Information Group IE (see 3GPP TS 36.413 [12] Annex B.1.5) + and the following applies: + Load= 'Load Value' * 'Cell Capacity Class Value', where 'Load Value' + and 'Cell Capacity Class Value' are defined in 3GPP TS 25.413 [19]. + + If the 'Cell Capacity Class Value' is not known, then 'Cell Capacity + Class Value' should be set to 1 when calculating the load, and the load + threshold should be set in range of 0..100."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list interRatEsActivationCandidateCellParameters { + description "This attribute is relevant, if the cell acts as a candidate + cell. This attribute indicates the traffic load threshold and the time + duration, which are used by distributed inter-RAT ES algorithms to + allow an original cell to enter the energySaving state. Threshold and + time duration are applied to the candidate cell(s) which will provides + coverage backup of an original cell when it is in the energySaving + state. The time duration indicates how long the traffic load (both for + UL and DL) in the candidate cell needs to have been below the threshold + before any original cells which will be provided backup coverage by the + candidate cell enters energySaving state. + + In case the candidate cell is a UTRAN or GERAN cell, the load + information refers to Cell Load Information Group IE (see 3GPP TS + 36.413 [12] Annex B.1.5) and the following applies: + Load= 'Load Value' * 'Cell Capacity Class Value', where 'Load Value' + and 'Cell Capacity Class Value' are defined in 3GPP TS 25.413 [19] + (for UTRAN) / TS 48.008 [20] (for GERAN). + + If the 'Cell Capacity Class Value' is not known, then 'Cell Capacity + Class Value' should be set to 1 when calculating the load, and the load + threshold should be set in range of 0..100."; + min-elements 1; + max-elements 1; + key loadThreshold; + uses loadTimeThresholdGrp; } + list interRatEsDeactivationCandidateCellParameters { + description "This attribute is relevant, if the cell acts as a candidate + cell. This attribute indicates the traffic load threshold and the time + duration which is used by distributed inter-RAT ES algorithms to allow + an original cell to leave the energySaving state. Threshold and time + duration are applied to the candidate cell which provides coverage + backup for the cell in energySaving state. + The time duration indicates how long the traffic load (either for UL or + DL) in the candidate cell needs to have been above the threshold to + wake up one or more original cells which have been provided backup + coverage by the candidate cell. + + For the load see the definition of + interRatEsActivationCandidateCellParameters. + + This attribute indicates the traffic load threshold and the time + duration which is used by distributed inter-RAT ES algorithms to allow + an original cell to leave the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + leaf energySavingState { + description "Specifies the status regarding the energy saving in the + cell. If the value of energySavingControl is toBeEnergySaving, then it + shall be tried to achieve the value isEnergySaving for the + energySavingState. If the value of energySavingControl is + toBeNotEnergySaving, then it shall be tried to achieve the value + isNotEnergySaving for the energySavingState. "; + type enumeration{ + enum isNotEnergySaving; + enum isEnergySaving; + } + } leaf energySavingControl { - description "This attribute allows the Cross Domain-Centralized SON energy saving function to initiate energy saving activation or deactivation."; - type enumeration{ - enum toBeEnergySaving; - enum toBeNotEnergySaving; - } + description "This attribute allows the Cross Domain-Centralized SON + energy saving function to initiate energy saving activation or + deactivation."; + type enumeration{ + enum toBeEnergySaving; + enum toBeNotEnergySaving; + } } + } - + grouping EsNotAllowedTimePeriodGrp { + leaf startTime { + description "Start of not allowed time period in UTC time zone. + If set, the endTime must also be set. If not set, this is + interpreted as around the clock."; + must ../endTime; + type type5g3gpp:UTC24TimeOfDayT; + } + leaf endTime { + description "If endTime has a lower value than startTime, it will + be interpreted as referring to the following day."; + must ../startTime; + type type5g3gpp:UTC24TimeOfDayT; + } + leaf-list daysOfWeek { + description "Specifies that the not allowed periods are only + applicable to the specified days in UTC timezone. Every day if + not set."; + type type5g3gpp:DayOfWeekT; + } } - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/nrcellcu3gpp:NRCellCU" { - if-feature nrcellcu3gpp:CESManagementFunction; - uses CESManagementFunctionGrp; + grouping CESManagementFunctionSubtree { + list CESManagementFunction { + description "This IOC represents the management capabilities of + Centralized SON Energy Saving (ES) functions. This is provided for + Energy Saving purposes. + + In the case where multiple CESManagement MOIs exist at different + levels of the containment tree, the CESManagement MOI at the lower + level overrides the CESManagement MOIs at higher level(s) of the + same containment tree."; + reference "clause 6.2.2 in TS 28.310"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses CESManagementFunctionGrp; + } } - augment "/me3gpp:ManagedElement" { + } + + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { + if-feature nrcellcu3gpp:CESManagementFunction; + uses CESManagementFunctionSubtree; + } + augment /me3gpp:ManagedElement { if-feature me3gpp:CESManagementFunction; - uses CESManagementFunctionGrp; - } - augment "/subnet3gpp:SubNetwork" { + uses CESManagementFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { if-feature subnet3gpp:CESManagementFunction; - uses CESManagementFunctionGrp; - } + uses CESManagementFunctionSubtree; + } } \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-common.yang b/yang-models/_3gpp-nr-nrm-common.yang deleted file mode 100755 index aa2343f6a5ea6a6ce4a0228372aadaa88e352a43..0000000000000000000000000000000000000000 --- a/yang-models/_3gpp-nr-nrm-common.yang +++ /dev/null @@ -1,29 +0,0 @@ -module _3gpp-nr-nrm-common { - yang-version 1.1; - namespace "urn:3gpp:sa5:3gpp-nr-nrm-common"; - prefix "nrcommon3gpp"; - - import _3gpp-common-yang-types { prefix types3gpp; } - - organization "3GPP SA5"; - description "Defines the YANG mapping of comon parts for 3GPP TS 28.541."; - reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; - - revision 2020-02-14 { - description "Initial revision"; - } - - - grouping PLMNInfo { - description "The PLMNInfo data type define a S-NSSAI member in a specific PLMNId, and it have - two attributes PLMNId and S-NSSAI (PLMNId, S-NSSAI). The PLMNId represents a data type that - is comprised of mcc (mobile country code) and mnc (mobile network code), (See TS 23.003 - subclause 2.2 and 12.1) and S-NSSAI represents an data type, that is comprised of an SST - (Slice/Service type) and an optional SD (Slice Differentiator) field, (See TS 23.003 [13])."; - uses types3gpp:PLMNId; - leaf sNssai { - type types3gpp:SNssai; - } - } - -} \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-cpciconfigurationfunction.yang b/yang-models/_3gpp-nr-nrm-cpciconfigurationfunction.yang index 1437acece70c3f883c48a21a66547f036f816e51..2a704d3aa3ba65aa3aee253797a9b4e3f4b6b021 100755 --- a/yang-models/_3gpp-nr-nrm-cpciconfigurationfunction.yang +++ b/yang-models/_3gpp-nr-nrm-cpciconfigurationfunction.yang @@ -1,7 +1,7 @@ module _3gpp-nr-nrm-cpciconfigurationfunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-cpciconfigurationfunction"; - prefix "cpciconfigurationfunction3gpp"; + prefix "cpcicf3gpp"; import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } @@ -11,57 +11,64 @@ module _3gpp-nr-nrm-cpciconfigurationfunction { organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the CPCIConfigurationFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Represents the CPCIConfigurationFunction Information Object + Class(IOC) that is part of the NR Network Resource Model."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-08-05 { reference S5-214053/CR-0518; } revision 2020-05-08 { reference S5-203316; } - grouping CPCIConfigurationFunctionGrp { - description "Represents the CPCICONFIGURATIONFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - - - list cSonPciList { - key NRPci; - description " This holds a list of physical cell identities that can be assigned to the pci attribute by gNB. The assignment algorithm is not specified. This attribute shall be supported if and only if the C-SON PCI configuration is supported."; - leaf NRPci {type int32;} - container attributes { - uses CSonPciListGrp; - } - } - + description "Represents the CPCIConfigurationFunction IOC."; leaf cPciConfigurationControl { - description "This attribute determines whether the Cross Domain-Centralized SON PCI configuration function is enabled or disabled."; + description "This attribute determines whether the Centralized SON + PCI configuration function is enabled or disabled."; type boolean; + mandatory true; } + leaf-list cSonPciList { + type int32 { range "0..1007"; } + min-elements 1; + description "Holds a list of physical cell identities that can be + assigned to the pci attribute by gNB. The assignment algorithm is not + specified. + See TS 38.211 clause 7.4.2.1 for legal values of pci. + This attribute shall be supported if and only if the C-SON PCI + configuration is supported."; + reference "See TS 38.211 clause 7.4.2.1"; + } } - grouping CSonPciListGrp { - description "Represents the C-SON PCI list for the PCI configuration function."; - - leaf NRPci { - description "This attribute determines the NR PCI."; - type int32 { range "0..1007"; } - units "1"; + grouping CPCIConfigurationFunctionSubtree { + list CPCIConfigurationFunction { + description "This IOC contains attributes to support the Cross + Domain-Centralized SON function of PCI configuration + + In the case where multiple CPCIConfiguration MOIs exist at different + levels of the containment tree, the CPCIConfiguration MOI at the lower + level overrides the CPCIConfiguration MOIs at higher level(s) of the + same containment tree."; + reference "clause 7.2.1 in TS 28.313"; + key id; + uses top3gpp:Top_Grp ; + container attributes { + uses CPCIConfigurationFunctionGrp ; + } } } - - augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/nrcelldu3gpp:NRCellDU" { + augment /me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/nrcelldu3gpp:NRCellDU { if-feature nrcelldu3gpp:CPCIConfigurationFunction; - uses CPCIConfigurationFunctionGrp; - } - augment "/me3gpp:ManagedElement" { + uses CPCIConfigurationFunctionSubtree; + } + augment /me3gpp:ManagedElement { if-feature me3gpp:CPCIConfigurationFunction; - uses CPCIConfigurationFunctionGrp; - } - augment "/subnet3gpp:SubNetwork" { + uses CPCIConfigurationFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { if-feature subnet3gpp:CPCIConfigurationFunction; - uses CPCIConfigurationFunctionGrp; - } + uses CPCIConfigurationFunctionSubtree; + } } \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-desmanagementfunction.yang b/yang-models/_3gpp-nr-nrm-desmanagementfunction.yang index b4b86d2b00dd57e362b5690967ba67c6e9873028..6df736c4d0f227717bf97fc07617c4098b8fb8aa 100755 --- a/yang-models/_3gpp-nr-nrm-desmanagementfunction.yang +++ b/yang-models/_3gpp-nr-nrm-desmanagementfunction.yang @@ -1,261 +1,200 @@ module _3gpp-nr-nrm-desmanagementfunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-desmanagementfunction"; - prefix "desmanagementfunction3gpp"; - + prefix "desmf3gpp"; import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } import _3gpp-common-subnetwork { prefix subnet3gpp; } - + import _3gpp-5g-common-yang-types { prefix type5g3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the DESManagementFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Defines the YANG mapping of the DESManagementFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-08-05 { reference S5-214053/CR-0518; } revision 2020-05-08 { reference S5-203316; } - - grouping DESManagementFunctionGrp { - description "Represents the DESManagementFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - - leaf desSwitch { - description "This attribute determines whether the Distributed SON or Domain-Centralized SON energy saving function is enabled or disabled."; - type boolean; - } - - list intraRatEsActivationOriginalCellLoadParameters { - key loadThreshold; - description "This attributes is relevant, if the cell acts as an original cell.This attribute indicates the traffic load threshold and the time duration, which are used by distributed ES algorithms to allow a cell to enter the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses IntraRatEsActivationOriginalCellLoadParametersGrp; - } - } - - - list intraRatEsActivationCandidateCellsLoadParameters { - key loadThreshold; - description "This attribute indicates the traffic load threshold and the time duration, which are used by distributed ES algorithms level to allow a n 'original' cell to enter the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses IntraRatEsActivationCandidateCellsLoadParametersGrp; - } - } - - list intraRatEsDeactivationCandidateCellsLoadParameters { - key loadThreshold; - description "This attributes is relevant, if the cell acts as a candidate cell.This attribute indicates the traffic load threshold and the time duration which is used by distributed ES algorithms to allow a cell to leave the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses IntraRatEsDeactivationCandidateCellsLoadParametersGrp; - } - } - - list esNotAllowedTimePeriod { - key startTimeandendTime; - description "This attribute indicates a list of time periods during which inter-RAT energy saving is not allowed."; - leaf startTimeandendTime {type string;} - container attributes { - uses EsNotAllowedTimePeriodGrp; - } - } - - list interRatEsActivationOriginalCellParameters { - key loadThreshold; - description "This attribute indicates the traffic load threshold and the time duration, which are used by distributed inter-RAT ES algorithms to allow an original cell to enter the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses InterRatEsActivationOriginalCellParametersGrp; - } - } - - list interRatEsActivationCandidateCellParameters { - key loadThreshold; - description "This attribute indicates the traffic load threshold and the time duration, which are used by distributed inter-RAT ES algorithms to allow an original cell to enter the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses InterRatEsActivationCandidateCellParametersGrp; - } - } - - list interRatEsDeactivationCandidateCellParameters { - key loadThreshold; - description "This attribute indicates the traffic load threshold and the time duration which is used by distributed inter-RAT ES algorithms to allow an original cell to leave the energySaving state."; - leaf loadThreshold {type int32;} - container attributes { - uses InterRatEsDeactivationCandidateCellParametersGrp; - } - } - - leaf energySavingState { - description "Specifies the status regarding the energy saving in the cell."; - type enumeration { - enum isNotEnergySaving; - enum isEnergySaving; - } - } - - leaf isProbingCapable { - description " This attribute indicates whether this cell is capable of performing the ES probing procedure."; - type enumeration{ - enum yes; - enum no; - } - } - - } - - grouping IntraRatEsActivationOriginalCellLoadParametersGrp { - description "Represents the the traffic load threshold and the time duration."; + grouping loadTimeThresholdGrp { + description "Represents the the traffic load threshold and the time + duration."; leaf loadThreshold { - description "This attribute is used by distributed ES algorithms to allow a cell to enter the energySaving state."; - type int32 { range "0..10000"; } - units "1"; + description "This attribute is used by distributed ES algorithms to allow + a cell to enter the energySaving state."; + type type5g3gpp:EnergySavingLoadThresholdT; } - - leaf timeDuration { - description " The time duration indicates how long the load needs to have been below the threshold."; - type int32 { range "0..900"; } - units "1"; + description "The time duration indicates how long the traffic load + (either for UL or DL) in the cell needs to have been above the + threshold to wake up one or more original cells which have been + provided backup coverage by the candidate cell."; + type type5g3gpp:EnergySavingTimeDurationT; } } - grouping IntraRatEsActivationCandidateCellsLoadParametersGrp { - description "Represents the the traffic load threshold and the time duration."; - - leaf loadThreshold { - description "This attribute is used by distributed ES algorithms to allow a cell to enter the energySaving state."; - type int32 { range "0..10000"; } - units "1"; - } - + grouping DESManagementFunctionGrp { + description "Represents the DESManagementFunction IOC."; - leaf timeDuration { - description " The time duration indicates how long the load needs to have been below the threshold."; - type int32 { range "0..900"; } - units "1"; + leaf desSwitch { + description "This attribute determines whether the Distributed SON + energy saving function is enabled or disabled."; + type boolean; + } + + list intraRatEsActivationOriginalCellLoadParameters { + description "This attributes is relevant, if the cell acts as an original + cell. This attribute indicates the traffic load threshold and the time + duration, which are used by distributed ES algorithms to allow a cell + to enter the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list intraRatEsActivationCandidateCellsLoadParameters { + description "This attribute indicates the traffic load threshold and the + time duration, which are used by distributed ES algorithms level to + allow an 'original' cell to enter the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list intraRatEsDeactivationCandidateCellsLoadParameters { + description "This attributes is relevant, if the cell acts as a candidate + cell.This attribute indicates the traffic load threshold and the time + duration which is used by distributed ES algorithms to allow a cell to + leave the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list esNotAllowedTimePeriod { + description "This is a list of time periods during which + inter-RAT energy saving is not allowed"; + key idx; + + leaf idx { + type uint32; + } + uses EsNotAllowedTimePeriodGrp; + } + + list interRatEsActivationOriginalCellParameters { + description "This attribute indicates the traffic load threshold and the + time duration, which are used by distributed inter-RAT ES algorithms to + allow an original cell to enter the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list interRatEsActivationCandidateCellParameters { + description "This attribute indicates the traffic load threshold and the + time duration, which are used by distributed inter-RAT ES algorithms to + allow an original cell to enter the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; + } + + list interRatEsDeactivationCandidateCellParameters { + description "This attribute indicates the traffic load threshold and the + time duration which is used by distributed inter-RAT ES algorithms to + allow an original cell to leave the energySaving state."; + key loadThreshold; + min-elements 1; + max-elements 1; + uses loadTimeThresholdGrp; } - } - - grouping IntraRatEsDeactivationCandidateCellsLoadParametersGrp { - description "Represents the the traffic load threshold and the time duration."; - leaf loadThreshold { - description "This attribute is used by distributed ES algorithms to allow a cell to enter the energySaving state."; - type int32 { range "0..10000"; } - units "1"; + leaf energySavingState { + description "Specifies the status regarding the energy saving in the + cell."; + type enumeration { + enum isNotEnergySaving; + enum isEnergySaving; + } } - - leaf timeDuration { - description " The time duration indicates how long the load needs to have been below the threshold."; - type int32 { range "0..900"; } - units "1"; - } + leaf isProbingCapable { + description "This attribute indicates whether this cell is capable of + performing the ES probing procedure."; + type enumeration{ + enum yes; + enum no; + } + } } grouping EsNotAllowedTimePeriodGrp { - description "Represents the the traffic load threshold and the time duration."; - - leaf startTimeandendTime { - description "This field indicate valid UTC time."; - type string; - } - - - leaf periodOfDay { - description "This field indicate the period of day."; - type string; - } - - leaf daysOfWeekList { - description "This field indicate the list of weekday."; - type string; - } - - leaf listoftimeperiods { - description "This field indicate the list of time periods."; - type string; - } - - } - - grouping InterRatEsActivationOriginalCellParametersGrp { - description "Represents the the traffic load threshold and the time duration."; - - leaf loadThreshold { - description "The time duration indicates how long the traffic load (both for UL and DL) needs to have been below the threshold."; - type int32 { range "0..10000"; } - units "1"; - } - - - leaf timeDuration { - description " The time duration indicates how long the load needs to have been below the threshold."; - type int32 { range "0..900"; } - units "1"; - } - } - - grouping InterRatEsActivationCandidateCellParametersGrp { - description "Represents the the traffic load threshold and the time duration."; - - leaf loadThreshold { - description "This attribute is used by distributed ES algorithms to allow a cell to enter the energySaving state."; - type int32 { range "0..10000"; } - units "1"; - } - - - leaf timeDuration { - description "The time duration indicates how long the traffic load (both for UL and DL) in the candidate cell needs to have been below the threshold before any original cells which will be provided backup coverage by the candidate cell enters energySaving state."; - type int32 { range "0..900"; } - units "1"; + leaf startTime { + description "Start of not allowed time period in UTC time zone. + If set, the endTime must also be set. If not set, this is + interpreted as around the clock."; + must ../endTime; + type type5g3gpp:UTC24TimeOfDayT; + } + leaf endTime { + description "If endTime has a lower value than startTime, it will + be interpreted as referring to the following day."; + type type5g3gpp:UTC24TimeOfDayT; + must ../startTime; + } + leaf-list daysOfWeek { + description "Specifies that the not allowed periods are only + applicable to the specified days in UTC timezone. Every day if + not set."; + type type5g3gpp:DayOfWeekT; } } - grouping InterRatEsDeactivationCandidateCellParametersGrp { - description "Represents the the traffic load threshold and the time duration."; - - leaf loadThreshold { - description "This attribute is used by distributed ES algorithms to allow a cell to enter the energySaving state."; - type int32 { range "0..10000"; } - units "1"; - } - - - leaf timeDuration { - description "The time duration indicates how long the traffic load (either for UL or DL) in the candidate cell needs to have been above the threshold to wake up one or more original cells which have been provided backup coverage by the candidate cell."; - type int32 { range "0..900"; } - units "1"; + grouping DESManagementFunctionSubtree { + list DESManagementFunction { + description "This IOC represents the management capabilities of + Distributed SON Energy Saving (ES) functions. This is provided for + Energy Saving purposes. + + In the case where multiple DESManagement MOIs exist at different + levels of the containment tree, the DESManagement MOI at the lower + level overrides the DESManagement MOIs at higher level(s) of the same + containment tree."; + reference "clause 6.2.3.0 in TS 28.310"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DESManagementFunctionGrp; + } } } - - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/nrcellcu3gpp:NRCellCU" { + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { if-feature nrcellcu3gpp:DESManagementFunction; - uses DESManagementFunctionGrp; - } - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction" { + uses DESManagementFunctionSubtree; + } + augment /me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction { if-feature gnbcucp3gpp:DESManagementFunction; - uses DESManagementFunctionGrp; - } - augment "/me3gpp:ManagedElement" { + uses DESManagementFunctionSubtree; + } + augment /me3gpp:ManagedElement { if-feature me3gpp:DESManagementFunction; - uses DESManagementFunctionGrp; - } - augment "/subnet3gpp:SubNetwork" { + uses DESManagementFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { if-feature subnet3gpp:DESManagementFunction; - uses DESManagementFunctionGrp; - } - + uses DESManagementFunctionSubtree; + } } \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-dlbofunction.yang b/yang-models/_3gpp-nr-nrm-dlbofunction.yang new file mode 100644 index 0000000000000000000000000000000000000000..a9915f7f3d0905bc477599d83ecdb5b8853c1856 --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-dlbofunction.yang @@ -0,0 +1,100 @@ +module _3gpp-nr-nrm-dlbofunction { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-dlbofunction"; + prefix "dlbof3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the DLBOFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2022-03-25 { reference "CR-XXXX"; } + revision 2021-10-22 { reference "CR-0577"; } + + feature DLBOUnderGNBCUCPFunction { + description "The DLBOFunction shall be available under + GNBCUCPFunction"; + } + + feature DLBOUnderManagedElement { + description "The DLBOFunction shall be available under + ManagedElement"; + } + + feature DLBOUnderSubNetwork { + description "The DLBOFunction shall be available under + SubNetwork"; + } + grouping DLBOFunctionGrp { + description "Represents the DLBOFunction IOC."; + + leaf dlboControl { + description "This attribute determines whether the LBO function is + enabled or disabled."; + type boolean; + } + + leaf maximumDeviationHoTriggerLow { + description "This parameter defines the maximum allowed lower + deviation of the Handover Trigger, from the default point of + operation."; + type int32 { range "-20..20"; } + units "0.5 dB"; + } + leaf maximumDeviationHoTriggerHigh { + description "This parameter defines the maximum allowed upper + deviation of the Handover Trigger, from the default point of + operation."; + type int32 { range "-20..20"; } + units "0.5 dB"; + } + + leaf minimumTimeBetweenHoTriggerChange { + description "This parameter defines the minimum allowed time interval + between two Handover Trigger change performed by MRO. This is used + to control the stability and convergence of the algorithm."; + type int32 { range "0..604800"; } + units "1"; + } + + } + + grouping DLBOFunctionSubtree { + list DLBOFunction { + description "This IOC contains attributes to support the D-SON function + of LBO. + + In the case where multiple DLBO MOIs exist at different levels of the + containment tree, the DLBO MOI at the lower level overrides the DLBO + MOIs at higher level(s) of the same containment tree."; + reference "clause 7.1.2 in TS 28.313"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DLBOFunctionGrp; + } + } + } + + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { + if-feature DLBOUnderGNBCUCPFunction; + uses DLBOFunctionSubtree; + } + augment /me3gpp:ManagedElement { + if-feature DLBOUnderManagedElement; + uses DLBOFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { + if-feature DLBOUnderSubNetwork; + uses DLBOFunctionSubtree; + } +} diff --git a/yang-models/_3gpp-nr-nrm-dmrofunction.yang b/yang-models/_3gpp-nr-nrm-dmrofunction.yang index c657f1587b453f779496346ff77b4501bb292d6d..f56ee70128359f01dcca3cfcd75b31ff1af5bf8b 100755 --- a/yang-models/_3gpp-nr-nrm-dmrofunction.yang +++ b/yang-models/_3gpp-nr-nrm-dmrofunction.yang @@ -1,7 +1,7 @@ module _3gpp-nr-nrm-dmrofunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-dmrofunction"; - prefix "dmrofunction3gpp"; + prefix "dmrof3gpp"; import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } @@ -9,62 +9,93 @@ module _3gpp-nr-nrm-dmrofunction { import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } - organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the DMROFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Defines the YANG mapping of the DMROFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2022-01-07 { reference CR-0633; } + revision 2021-08-05 { reference S5-214053/CR-0518; } revision 2020-05-08 { reference S5-203316; } - grouping DMROFunctionGrp { description "Represents the DMROFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - leaf maximumDeviationHoTrigger { - description "This parameter defines the maximum allowed absolute deviation of the Handover Trigger, from the default point of operation."; - type int32 { range "-20..20"; } - units "0.5"; + + leaf maximumDeviationHoTriggerLow { + description "This parameter defines the maximum allowed lower + deviation of the Handover Trigger, from the default point of + operation."; + type int32 {range "-20..20";} + units "0.5 dB"; + } + + leaf maximumDeviationHoTriggerHigh { + description "This parameter defines the maximum allowed upper + deviation of the Handover Trigger, from the default point of + operation."; + type int32 {range "-20..20";} + units "0.5 dB"; } leaf minimumTimeBetweenHoTriggerChange { - description "This parameter defines the minimum allowed time interval between two Handover Trigger change performed by MRO. This is used to control the stability and convergence of the algorithm."; - type int32 { range "0..604800"; } - units "1"; + description "This parameter defines the minimum allowed time interval + between two Handover Trigger change performed by MRO. This is used to + control the stability and convergence of the algorithm."; + type uint32 { + range 0..604800; // <= 1 week + } + units seconds; } - leaf tstoreUEcntxt { - description "The timer used for detection of too early HO, too late HO and HO to wrong cell."; - type int32 { range "0..1023"; } - units "100"; + description "The timer used for detection of too early HO, too late HO + and HO to wrong cell."; + type uint32 { + range 0..1023; + } + units "100 milliseconds"; } - - leaf dmroControl { - description " This attribute determines whether the MRO function is enabled or disabled."; - type boolean; + description "This attribute determines whether the MRO function is + enabled or disabled."; + type boolean; } - } + grouping DMROFunctionSubtree { + list DMROFunction { + description "This IOC contains attributes to support the D-SON function + of MRO. - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/nrcellcu3gpp:NRCellCU" { - if-feature nrcellcu3gpp:DMROFunction; - uses DMROFunctionGrp; + In the case where multiple DMRO MOIs exist at different levels of the + containment tree, the DMRO MOI at the lower level overrides the DMRO + MOIs at higher level(s) of the same containment tree."; + reference "clause 7.1.2 in TS 28.313"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DMROFunctionGrp; + } } - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction" { + } + + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { + if-feature nrcellcu3gpp:DMROFunction; + uses DMROFunctionSubtree; + } + augment /me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction { if-feature gnbcucp3gpp:DMROFunction; - uses DMROFunctionGrp; - } - augment "/me3gpp:ManagedElement" { + uses DMROFunctionSubtree; + } + augment /me3gpp:ManagedElement { if-feature me3gpp:DMROFunction; - uses DMROFunctionGrp; - } - augment "/subnet3gpp:SubNetwork" { + uses DMROFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { if-feature subnet3gpp:DMROFunction; - uses DMROFunctionGrp; - } -} \ No newline at end of file + uses DMROFunctionSubtree; + } +} diff --git a/yang-models/_3gpp-nr-nrm-dpciconfigurationfunction.yang b/yang-models/_3gpp-nr-nrm-dpciconfigurationfunction.yang index 0d25d5076783966a9fc4289db4d13205bca46352..806b0d6597c2c8dbee90923be44f8e0e9316444c 100755 --- a/yang-models/_3gpp-nr-nrm-dpciconfigurationfunction.yang +++ b/yang-models/_3gpp-nr-nrm-dpciconfigurationfunction.yang @@ -1,67 +1,76 @@ module _3gpp-nr-nrm-dpciconfigurationfunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-dpciconfigurationfunction"; - prefix "dpciconfigurationfunction3gpp"; + prefix "dpcicf3gpp"; import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } - import _3gpp-nr-nrm-nrcelldu { prefix nrcelldu3gpp; } - import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } + import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } + import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-5g-common-yang-types { prefix type5g3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the DPCIConfigurationFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Defines the YANG mapping of the DPCIConfigurationFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-08-05 { reference S5-214053/CR-0518; } + revision 2021-01-25 { reference CR-0454 ; } + revision 2020-11-25 { reference CR-0386 ; } revision 2020-05-08 { reference S5-203316; } - grouping DPCIConfigurationFunctionGrp { description "Represents the DPCICONFIGURATIONFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - list nRPciList { + description "This holds a list of physical cell identities that can be + assigned to the NR cells. This attribute shall be supported if D-SON + PCI configuration function is supported."; key NRPci; - description "This holds a list of physical cell identities that can be assigned to the NR cells. This attribute shall be supported if D-SON PCI configuration or domain Centralized SON PCI configuration function is supported."; - leaf NRPci {type int32;} - container attributes { - uses NRPciListGrp; - } + leaf NRPci { + type type5g3gpp:PhysCellID; + } } - leaf dPciConfigurationControl { - description " This attribute determines whether the Distributed SON or Domain-Centralized SON PCI configuration Function is enabled or disabled."; - type boolean; + description "This attribute determines whether the Distributed SON PCI + configuration Function is enabled or disabled."; + type boolean; } - } - grouping NRPciListGrp { - description "Represents the NR PCI list for the PCI configuration function."; + grouping DPCIConfigurationFunctionSubtree { + list DPCIConfigurationFunction { + description "This IOC contains attributes to support the Distributed SON + function of PCI configuration. - leaf NRPci { - description "This attribute determines the NR PCI."; - type int32 { range "0..1007"; } - units "1"; + In the case where multiple DPCIConfiguration MOIs exist at different + levels of the containment tree, the DPCIConfiguration MOI at the lower + level overrides the DPCIConfiguration MOIs at higher level(s) of the + same containment tree."; + reference "clause 7.1.3 in TS 28.313"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DPCIConfigurationFunctionGrp; + } } } - - augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/nrcelldu3gpp:NRCellDU" { - if-feature nrcelldu3gpp:DPCIConfigurationFunction; - uses DPCIConfigurationFunctionGrp; - } - augment "/me3gpp:ManagedElement" { + augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/"+ + "nrcellcu3gpp:NRCellCU" { + if-feature nrcellcu3gpp:DPCIConfigurationFunction; + uses DPCIConfigurationFunctionSubtree; + } + augment /me3gpp:ManagedElement { if-feature me3gpp:DPCIConfigurationFunction; - uses DPCIConfigurationFunctionGrp; - } - augment "/subnet3gpp:SubNetwork" { + uses DPCIConfigurationFunctionSubtree; + } + augment /subnet3gpp:SubNetwork { if-feature subnet3gpp:DPCIConfigurationFunction; - uses DPCIConfigurationFunctionGrp; - } + uses DPCIConfigurationFunctionSubtree; + } } \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-drachoptimizationfunction.yang b/yang-models/_3gpp-nr-nrm-drachoptimizationfunction.yang index 8135d1409beb6bc960e59b1dd8407c6b63cc371c..314372c389a588cb25d712592141966cfb923005 100755 --- a/yang-models/_3gpp-nr-nrm-drachoptimizationfunction.yang +++ b/yang-models/_3gpp-nr-nrm-drachoptimizationfunction.yang @@ -1,120 +1,116 @@ module _3gpp-nr-nrm-drachoptimizationfunction { yang-version 1.1; namespace "urn:3gpp:sa5:_3gpp-nr-nrm-drachoptimizationfunction"; - prefix "drachoptimizationfunction3gpp"; + prefix "dracho3gpp"; import _3gpp-common-subnetwork { prefix subnet3gpp; } import _3gpp-common-top { prefix top3gpp; } - import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } import _3gpp-common-managed-element { prefix me3gpp; } - import _3gpp-nr-nrm-nrcellcu { prefix nrcellcu3gpp; } - + import _3gpp-nr-nrm-nrcelldu { prefix nrcelldu3gpp; } + import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; - description "Defines the YANG mapping of the DRACHOptimizationFunction Information Object Class - (IOC) that is part of the NR Network Resource Model (NRM)."; + description "Defines the YANG mapping of the DRACHOptimizationFunction + Information Object Class (IOC) that is part of the NR Network Resource + Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-08-05 { reference S5-214053/CR-0518; } + revision 2021-01-25 { reference CR-0454 ; } + revision 2020-10-02 { reference "CR-0384, CR-0382" ; } revision 2020-05-08 { reference S5-203316; } - - grouping DRACHOptimizationFunctionGrp { - description "Represents the DRACHOptimizationFunction IOC."; - reference "3GPP TS 28.541"; - uses top3gpp:Top_Grp; - - list ueAccProbilityDistPerSSB { - key targetProbability; - description "This is a list of target Access Probability (APn) for the RACH optimization function."; - leaf targetProbability {type TargetProbability;} - container attributes { - uses UeAccProbilityDistPerSSBGrp; - } - } - - list ueAccDelayProbilityDistPerSSB { - key targetProbability; - description "This is a list of target Access Delay probability (ADP) for the RACH optimization function."; - leaf targetProbability {type TargetProbability;} - container attributes { - uses UeAccDelayProbilityDistPerSSBGrp; - } - } - - leaf drachOptimizationControl { - description "This attribute determines whether the RACH Optimization function is enabled or disabled."; - type boolean; - } - } - typedef TargetProbability { - type enumeration { + typedef TargetProbabilityT { + type enumeration { enum 25; enum 50; enum 75; enum 90; } } - - typedef Numberofpreamblessent { - type int32 { range "1..200"; } - units "1"; + typedef NumberofpreamblessentT { + type uint32 { + range "1..200"; + } } - - typedef Accessdelay { - type int32 { range "10..560"; } - units "1"; + typedef AccessdelayT { + type uint32 { + range "10..560"; + } } - - - grouping UeAccProbilityDistPerSSBGrp { - description "Represents the target Access Probability (APn) for the RACH optimization function."; + grouping NumPreableAccessDelayGrp { + description "Represents the target Access Probability (APn) for the RACH + optimization function."; leaf targetProbability { - description "This attribute determines the target Probability."; - mandatory true; - type TargetProbability; + description "This attribute determines the target Probability."; + mandatory true; + type TargetProbabilityT; } - - leaf numberofpreamblessent { - description "This attribute determines the number of preambles sent."; - mandatory true; - type Numberofpreamblessent; + description "This attribute determines the number of preambles sent."; + mandatory true; + type NumberofpreamblessentT; } } - grouping UeAccDelayProbilityDistPerSSBGrp { - description "Represents the target Access Delay probability (ADP) for the RACH optimization function."; + grouping DRACHOptimizationFunctionGrp { + description "Represents the DRACHOptimizationFunction IOC."; - leaf targetProbability { - description "This attribute determines the target Probability."; - mandatory true; - type TargetProbability; + list ueAccProbilityDist { + description "This is a list of target Access Probability (APn) for the + RACH optimization function."; + key "targetProbability numberofpreamblessent"; + uses NumPreableAccessDelayGrp; } - - - leaf accessdelay { - description "This attribute determines the access delay."; - mandatory true; - type Accessdelay; + list ueAccDelayProbilityDist { + description "This is a list of target Access Delay probability (ADP) + for the RACH optimization function."; + key "targetProbability numberofpreamblessent"; + uses NumPreableAccessDelayGrp; + } + leaf drachOptimizationControl { + description "This attribute determines whether the RACH Optimization + function is enabled or disabled."; + type boolean; } } - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/nrcellcu3gpp:NRCellCU" { - if-feature nrcellcu3gpp:DRACHOptimizationFunction; - uses DRACHOptimizationFunctionGrp; - } - augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction" { - if-feature gnbcucp3gpp:DRACHOptimizationFunction; - uses DRACHOptimizationFunctionGrp; + grouping DRACHOptimizationFunctionSubtree { + list DRACHOptimizationFunction { + description "This IOC represents the management capabilities of + Centralized SON Energy Saving (ES) functions. This is provided for + Energy Saving purposes. + + In the case where multiple CESManagement MOIs exist at different + levels of the containment tree, the CESManagement MOI at the lower + level overrides the CESManagement MOIs at higher level(s) of the + same containment tree."; + reference "clause 6.2.2 in TS 28.310"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses DRACHOptimizationFunctionGrp; + } } + } + + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/"+ + "nrcelldu3gpp:NRCellDU" { + if-feature nrcelldu3gpp:DRACHOptimizationFunction; + uses DRACHOptimizationFunctionSubtree; + } + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { + if-feature gnbdu3gpp:DRACHOptimizationFunction; + uses DRACHOptimizationFunctionSubtree; + } augment "/me3gpp:ManagedElement" { if-feature me3gpp:DRACHOptimizationFunction; - uses DRACHOptimizationFunctionGrp; - } + uses DRACHOptimizationFunctionSubtree; + } augment "/subnet3gpp:SubNetwork" { - if-feature nrcellcu3gpp:DRACHOptimizationFunction; - uses DRACHOptimizationFunctionGrp; - } + if-feature nrcelldu3gpp:DRACHOptimizationFunction; + uses DRACHOptimizationFunctionSubtree; + } } \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-ep.yang b/yang-models/_3gpp-nr-nrm-ep.yang index 5f5187b1857d4373aa23a5bf39234e0094ed9349..f36653ea700dd8b272144f14753feea5041efdb2 100755 --- a/yang-models/_3gpp-nr-nrm-ep.yang +++ b/yang-models/_3gpp-nr-nrm-ep.yang @@ -11,16 +11,32 @@ module _3gpp-nr-nrm-ep { import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines the YANG mapping of the NR related endpoint Information Object Classes (IOCs) that are part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; - revision 2020-03-02 { reference S5-201191"; } - revision 2019-06-17 { - description "Initial revision"; + revision 2022-01-07 { reference CR-0643; } + revision 2021-05-01 { reference CR-0490; } + revision 2021-03-03 { reference CR-0435 ; } + revision 2021-02-17 { reference CR-0470; } + revision 2020-11-17 { reference CR-0410 ; } + revision 2020-03-02 { reference S5-201191; } + revision 2019-06-17 { reference "Initial revision"; } + + feature EPClassesUnderGNBCUCPFunction { + description "Endpoint classes shall be contained under GNBCUCPFunction"; + } + + feature EPClassesUnderGNBCUUPFunction { + description "Endpoint classes shall be contained under GNBCUUPFunction"; + } + + feature EPClassesUnderGNBDUFunction { + description "Endpoint classes shall be contained under GNBDUFunction"; } - + grouping EP_E1Grp { description "Represents the EP_E1 IOC."; reference "3GPP TS 28.541, 3GPP TS 38.401"; @@ -35,7 +51,7 @@ module _3gpp-nr-nrm-ep { grouping EP_F1UGrp { description "Represents the EP_F1U IOC."; - reference "3GPP TS 28.541, 3GPP TS 38.470"; + reference "3GPP TS 28.541, 3GPP TS 38.470"; uses eprp3gpp:EP_Common; } @@ -82,6 +98,7 @@ module _3gpp-nr-nrm-ep { } augment "/me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction" { + if-feature EPClassesUnderGNBCUCPFunction; list EP_E1 { description "Represents the local end point of the logical link, @@ -96,7 +113,7 @@ module _3gpp-nr-nrm-ep { list EP_F1C { description "Represents the local end point of the control plane - interface (F1-C) between the DU and CU or CU-CP."; + interface (F1-C) between the gNB-DU and gNB-CU or gNB-CU-CP."; reference "3GPP TS 28.541, 3GPP TS 38.470"; key id; uses top3gpp:Top_Grp; @@ -107,7 +124,7 @@ module _3gpp-nr-nrm-ep { list EP_NgC { description "Represents the local end point of the control plane - interface (NG-C) between the gNB and NG-Core entity."; + interface (NG-C) between the gNB and AMF."; reference "3GPP TS 28.541, 3GPP TS 38.470"; key id; uses top3gpp:Top_Grp; @@ -143,6 +160,7 @@ module _3gpp-nr-nrm-ep { } augment "/me3gpp:ManagedElement/gnbcuup3gpp:GNBCUUPFunction" { + if-feature EPClassesUnderGNBCUUPFunction; list EP_E1 { description "Represents the local end point of the logical link, @@ -157,7 +175,7 @@ module _3gpp-nr-nrm-ep { list EP_F1U { description "Represents the local end point of the user plane - interface (F1-U) between the DU and CU or CU-UP."; + interface (F1-U) between the gNB-DU and gNB-CU or gNB-CU-UP."; reference "3GPP TS 28.541, 3GPP TS 38.470"; key id; uses top3gpp:Top_Grp; @@ -168,7 +186,7 @@ module _3gpp-nr-nrm-ep { list EP_NgU { description "Represents the local end point of the NG user plane - (NG-U) interface between the gNB and the UPGW."; + (NG-U) interface between the gNB and UPF."; reference "3GPP TS 28.541, 3GPP TS 38.470"; key id; uses top3gpp:Top_Grp; @@ -213,6 +231,7 @@ module _3gpp-nr-nrm-ep { } augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { + if-feature EPClassesUnderGNBDUFunction; list EP_F1C { description "Represents the local end point of the control plane @@ -228,7 +247,7 @@ module _3gpp-nr-nrm-ep { list EP_F1U { description "Represents the local end point of the user plane interface (F1-U) between the DU and CU or CU-UP."; - reference "3GPP TS 28.541, 3GPP TS 38.470"; + reference "3GPP TS 28.541, 3GPP TS 38.470"; key id; uses top3gpp:Top_Grp; container attributes { diff --git a/yang-models/_3gpp-nr-nrm-externaleutrancell.yang b/yang-models/_3gpp-nr-nrm-externaleutrancell.yang index d3dd888029bfd68836fdb618b39cdfe5ecc2d321..df62f1c5fcc11709217b9d6b1ff3a027f1770afb 100755 --- a/yang-models/_3gpp-nr-nrm-externaleutrancell.yang +++ b/yang-models/_3gpp-nr-nrm-externaleutrancell.yang @@ -53,10 +53,10 @@ module _3gpp-nr-nrm-externaleutrancell { uses types3gpp:PLMNId; } - leaf cellLocalId { + leaf cellLocalId { description "Unambiguously identifies a cell within an eNodeB."; reference "NCI defined in 3GPP TS 38.300"; - type int32 {range "0..255"; } + type int32 {range "0..255"; } } leaf eNBId { diff --git a/yang-models/_3gpp-nr-nrm-externalnrcellcu.yang b/yang-models/_3gpp-nr-nrm-externalnrcellcu.yang index 2bfe38bb34a66ba81c8b32bcaf74cf05519e0dcb..78e4671f065d5fb68369c371ceb1b784303d69af 100755 --- a/yang-models/_3gpp-nr-nrm-externalnrcellcu.yang +++ b/yang-models/_3gpp-nr-nrm-externalnrcellcu.yang @@ -26,12 +26,12 @@ module _3gpp-nr-nrm-externalnrcellcu { reference "3GPP TS 28.541"; uses mf3gpp:ManagedFunctionGrp; - leaf cellLocalId { + leaf cellLocalId { description "Identifies an NR cell of a gNB. Together with corresponding gNB ID it forms the NR Cell Identifier (NCI)."; reference "NCI in 3GPP TS 38.300"; mandatory true; - type int32 {range "0..16383"; } + type int32 {range "0..16383"; } } leaf nRPCI { diff --git a/yang-models/_3gpp-nr-nrm-gnbcucpfunction.yang b/yang-models/_3gpp-nr-nrm-gnbcucpfunction.yang index 685ac9517f073d3f9a511cbe0e2d435f608071ff..4c4cee4d639b0c079c1c5540374c16ebdd481f8a 100755 --- a/yang-models/_3gpp-nr-nrm-gnbcucpfunction.yang +++ b/yang-models/_3gpp-nr-nrm-gnbcucpfunction.yang @@ -15,6 +15,9 @@ module _3gpp-nr-nrm-gnbcucpfunction { Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-11-06 { reference "CR-0611" ; } + revision 2021-11-05 { reference "CR-0609"; } + revision 2020-10-02 { reference CR-0384 ; } revision 2020-08-06 { reference "CR-0333"; } revision 2020-08-03 { reference "CR-0321"; } revision 2020-06-03 { reference "CR-0286"; } @@ -27,16 +30,13 @@ module _3gpp-nr-nrm-gnbcucpfunction { } feature DESManagementFunction { - description "Classs representing Distributed SON or Domain-Centralized SON Energy Saving feature"; + description "Classs representing Distributed SON Energy Saving feature"; } feature DANRManagementFunction { description "Classs representing D-SON function of ANR Management feature"; } - feature DRACHOptimizationFunction { - description "Classs representing D-SON function of RACH optimization feature"; - } feature DMROFunction { description "Classs representing D-SON function of MRO feature"; @@ -116,6 +116,17 @@ module _3gpp-nr-nrm-gnbcucpfunction { type types3gpp:DistinguishedName; description "DN of the Dynamic5QISet that the GNBCUCPFunction supports (is associated to)."; } + + leaf dCHOControl { + type boolean; + description "This attribute determines whether the CHO function is enabled or disabled."; + } + + leaf dDAPSHOControl { + type boolean; + description "This attribute determines whether the DAPS handover function + is enabled or disabled."; + } } augment "/me3gpp:ManagedElement" { diff --git a/yang-models/_3gpp-nr-nrm-gnbcuupfunction.yang b/yang-models/_3gpp-nr-nrm-gnbcuupfunction.yang index 98b7b4a7b6a89f7a7b73d6213260cc72a7c0989b..944da20a724d15754008acab41b0e533da5859be 100755 --- a/yang-models/_3gpp-nr-nrm-gnbcuupfunction.yang +++ b/yang-models/_3gpp-nr-nrm-gnbcuupfunction.yang @@ -8,7 +8,7 @@ module _3gpp-nr-nrm-gnbcuupfunction { import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-rrmpolicy { prefix nrrrmpolicy3gpp; } - import _3gpp-nr-nrm-common { prefix nrcommon3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; @@ -16,6 +16,7 @@ module _3gpp-nr-nrm-gnbcuupfunction { Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2020-11-05 { reference CR-0412 ; } revision 2020-08-06 { reference "CR-0333"; } revision 2020-08-03 { reference "CR-0321"; } revision 2020-06-03 { reference "CR-0286"; } @@ -23,15 +24,14 @@ module _3gpp-nr-nrm-gnbcuupfunction { revision 2020-03-12 { reference "SP-200233 S5-201547"; } revision 2020-02-14 { reference S5-20XXXX ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-08-21 { - description "Initial revision"; - } + revision 2019-08-21 { reference "Initial revision"; } grouping TAIGrp { description "Tracking Area Identity"; list pLMNId { key "mcc mnc"; + description "PLMN IDs for the Tracking area"; uses types3gpp:PLMNId; } @@ -39,12 +39,12 @@ module _3gpp-nr-nrm-gnbcuupfunction { type int64; description "Identity of the common Tracking Area Code for the PLMNs allowedValues: - a) It is the TAC or Extended-TAC. - b) A cell can only broadcast one TAC or Extended-TAC. + a) It is the TAC or Extended-TAC. + b) A cell can only broadcast one TAC or Extended-TAC. See TS 36.300, subclause 10.1.7 (PLMNID and TAC relation). - c) TAC is defined in subclause 19.4.2.3 of 3GPP TS 23.003 and + c) TAC is defined in subclause 19.4.2.3 of 3GPP TS 23.003 and Extended-TAC is defined in subclause 9.3.1.29 of 3GPP TS 38.473. - d) For a 5G SA (Stand Alone), it has a non-null value."; + d) For a 5G SA (Stand Alone), it has a non-null value."; } } @@ -127,28 +127,32 @@ module _3gpp-nr-nrm-gnbcuupfunction { } list pLMNInfoList { - description "The PLMNInfoList is a list of PLMNInfo data type. It defines which PLMNs that - can be served by the GNBCUUPFunction and which S-NSSAIs can be supported by the - GNBCUUPFunction for corresponding PLMN in case of network slicing feature is supported"; - key "mcc mnc"; - uses nrcommon3gpp:PLMNInfo; - } + description "The PLMNInfoList is a list of PLMNInfo data type. It + defines which PLMNs that can be served by the GNBCUUPFunction and + which S-NSSAIs can be supported by the GNBCUUPFunction for + corresponding PLMN in case of network slicing feature is supported"; + key "mcc mnc sd sst"; + uses types5g3gpp:PLMNInfo; + } list mappingSetIDBackhaulAddressList { key idx; description "Specifies a list of mappingSetIDBackhaulAddress used to retrieve the backhaul address of the victim set. - Must be present if Remote Interference Management function is supported."; + Must be present if Remote Interference Management function is + supported."; uses MappingSetIDBackhaulAddressGrp; } leaf configurable5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Configurable5QISet that the GNBCUUPFunction supports (is associated to)."; + description "DN of the Configurable5QISet that the GNBCUUPFunction + supports (is associated to)."; } leaf dynamic5QISetRef { type types3gpp:DistinguishedName; - description "DN of the Dynamic5QISet that the GNBCUUPFunction supports (is associated to)."; + description "DN of the Dynamic5QISet that the GNBCUUPFunction + supports (is associated to)."; } } diff --git a/yang-models/_3gpp-nr-nrm-gnbdufunction.yang b/yang-models/_3gpp-nr-nrm-gnbdufunction.yang index 654d99dca25863ee34e0e7af019ccc791ef523e5..c52250c6dae466682ce850b82a1e195f1c1682c9 100755 --- a/yang-models/_3gpp-nr-nrm-gnbdufunction.yang +++ b/yang-models/_3gpp-nr-nrm-gnbdufunction.yang @@ -7,28 +7,135 @@ module _3gpp-nr-nrm-gnbdufunction { import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-rrmpolicy { prefix nrrrmpolicy3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; description "Defines the YANG mapping of the GNBDUFunction Information Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-10-28 { reference CR-0607 ; } + revision 2021-04-30 { reference CR-0490 ; } + revision 2020-10-02 { reference CR-0384 ; } revision 2020-03-12 { reference "SP-200233 S5-201547" ; } revision 2020-02-14 { reference S5-20XXXX ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-08-21 { - description "Initial revision."; + revision 2019-08-21 {reference "Initial revision."; } + + feature DRACHOptimizationFunction { + description "Class representing D-SON function of RACH optimization + feature"; + } + + grouping RimRSReportInfoGrp { + description "This data type defines necessary reporting information + derived from the detected RIM-RS, including + 1) The detected set ID; + 2) Propagation delay in number of OFDM symbols + 3) Functionality of the RS (RS-1 or RS-2, Enough or Not enough + mitigation for RS-1). + + RS-1 is equivalent to RIM-RS type 1 (see 38.211, subclause 7.4.1.6). + RS-2 is equivalent to RIM-RS type 2 (see 38.211, subclause 7.4.1.6). + Enough mitigation for RS-1 means 'Enough' / 'Not enough' indication + functionality is enabled for RIM RS-1 and RIM-RS type 1 is used to + indicate 'enough mitigation' functionality. + Not enough mitigation for RS-1 means 'Enough' / 'Not enough' indication + functionality is enabled for RIM RS-1 and RIM-RS type 1 is used to + indicate 'Not enough mitigation' functionality."; + + leaf detectedSetID { + type uint32 ; + description "Set ID of the detected RIM-RS + allowedValues: 0,1...max{totalnrofSetIdofRS1, totalnrofSetIdofRS2}"; + } + + leaf propagationDelay { + type uint32 ; + must '. <= ../../maxPropagationDelay' { + error-message "allowedValues: 0, 1.. maxPropagationDelay"; + } + description "This attribute indicates the propagation delay of the + detected RIM-RS, in number of OFDM symbol."; + } + + leaf functionalityOfRIMRS { + type enumeration { + enum RS1; + enum RS2; + enum RS1_FOR_ENOUGH_MITIGATION; + enum RS1_FOR_NOT_ENOUGH_MITIGATION; + } + mandatory true; + description "Indicates the functionality of the detected RIM-RS. + If the indication of enableEnoughNotEnoughIndication is 'enabled', + valid values are {RS2, RS1forEnoughMitigation, + RS1forNotEnoughMitigation}; + If the indication of enableEnoughNotEnoughIndication is 'disabled', + valid values are {RS1, RS2}. + + RS1forEnoughMitigation means RIM-RS type 1 is used to indicate + 'enough mitigation' functionality. + RS1forNotEnoughMitigation means RIM-RS type 1 is used to indicate + 'Not enough mitigation' functionality."; + } + } + + grouping RimRSReportConfGrp { + description "Defines RIM-RS reporting configuration"; + + leaf reportIndicator { + type types3gpp:EnabledDisabled; + default DISABLED; + description "Used to enable or disable the RS report on a gNB. + If the indication is 'enable', the gNB starts to periodically report + necessary information derived from the detected RIM-RS to OAM. + If the indication is 'disable', the gNB stops reporting."; + } + + leaf reportInterval { + type uint32; + mandatory true; + units ms; + description "Used to define reporting interval of a gNB in ms."; + } + + leaf nrofRIMRSReportInfo { + type uint32; + mandatory true; + description "Used to define the maximum number of RIMRSReportInfo in + a single report."; + } + + leaf maxPropagationDelay { + type uint32 { + range "0..327679"; + } + mandatory true; + description "Used to define the maximum reported OFDM symbol number for + the propagation delay of the detected RIM-RS in each RIMRSReportInfo. + + allowedValues: 0, 1..20**2*maxNrofSymbols-1, where maxNrofSymbols=14."; + } + + list RimRSReportInfoList { + key detectedSetID; + description "Represents a list (the length of the list is + nrofRIMRSReportInfo) of necessary information derived from the + detected RIM-RS."; + uses RimRSReportInfoGrp; + } } grouping GNBDUFunctionGrp { description "Represents the GNBDUFunction IOC."; reference "3GPP TS 28.541"; - uses mf3gpp:ManagedFunctionGrp; + uses mf3gpp:ManagedFunctionGrp; uses nrrrmpolicy3gpp:RRMPolicy_Grp; leaf gNBId { type int64 { range "0..4294967295"; } - config false; mandatory true; description "Identifies a gNB within a PLMN. The gNB Identifier (gNB ID) is part of the NR Cell Identifier (NCI) of the gNB cells."; @@ -48,26 +155,21 @@ module _3gpp-nr-nrm-gnbdufunction { description "Uniquely identifies the DU at least within a gNB."; reference "3GPP TS 38.473"; } - + leaf gNBDUName { type string { length "1..150"; } description "Identifies the Distributed Unit of an NR node"; reference "3GPP TS 38.473"; - } - - leaf aggressorSetID { - type uint32 { range "0..4194304"; } - config false; - description "Indicates the associated aggressor gNB Set ID of the cell - Valid when Remote Interference Management function is supported."; - reference "3GPP TS 38.211 subclause 7.4.1.6"; } - leaf victimSetID { - type uint32 { range "0..4194304"; } + + list rimRSReportConf { + key reportInterval; config false; - description "Indicates the associated victim gNB Set ID of the cell - Valid when Remote Interference Management function is supported."; - reference "3GPP TS 38.211 subclause 7.4.1.6"; + min-elements 1; + max-elements 1; + description "Used to configure gNBs to report the all necessary + information derived from the detected RIM-RS to OAM."; + uses RimRSReportConfGrp; } } diff --git a/yang-models/_3gpp-nr-nrm-nrcellcu.yang b/yang-models/_3gpp-nr-nrm-nrcellcu.yang index c533ff3fafae181cb3987ff54497d06864d4837d..a0a3e9889e85044c145efcceda3c18cc4b5cfca0 100755 --- a/yang-models/_3gpp-nr-nrm-nrcellcu.yang +++ b/yang-models/_3gpp-nr-nrm-nrcellcu.yang @@ -8,7 +8,7 @@ module _3gpp-nr-nrm-nrcellcu { import _3gpp-common-managed-element { prefix me3gpp; } import _3gpp-nr-nrm-gnbcucpfunction { prefix gnbcucp3gpp; } import _3gpp-common-top { prefix top3gpp; } - import _3gpp-nr-nrm-common { prefix nrcommon3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } organization "3GPP SA5"; contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; @@ -16,27 +16,32 @@ module _3gpp-nr-nrm-nrcellcu { Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-01-25 { reference CR-0454 ; } + revision 2020-11-25 { reference CR-0386 ; } + revision 2020-11-05 { reference CR-0412 ; } + revision 2020-10-02 { reference CR-0384 ; } revision 2020-05-08 { reference S5-203316 ; } revision 2020-02-14 { reference S5-20XXXX ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-06-17 { - description "Initial revision"; - } + revision 2019-06-17 { reference "Initial revision"; } - feature DESManagementFunction { - description "Classs representing Distributed SON or Domain-Centralized SON Energy Saving feature"; + feature DPCIConfigurationFunction { + description "Class representing Distributed SON + function of PCI configuration feature"; } - feature DRACHOptimizationFunction { - description "Classs representing D-SON function of RACH optimization feature"; + feature DESManagementFunction { + description "Class representing Distributed SON + Energy Saving feature"; } feature DMROFunction { - description "Classs representing D-SON function of MRO feature"; + description "Class representing D-SON function of MRO feature"; } feature CESManagementFunction { - description "Classs representing Cross Domain-Centralized SON Energy Saving feature"; + description "Class representing Centralized SON Energy Saving + feature"; } grouping NRCellCUGrp { @@ -44,23 +49,24 @@ module _3gpp-nr-nrm-nrcellcu { reference "3GPP TS 28.541"; uses mf3gpp:ManagedFunctionGrp; - leaf cellLocalId { + leaf cellLocalId { description "Identifies an NR cell of a gNB. Together with corresponding gNB ID it forms the NR Cell Identifier (NCI)."; mandatory true; - type int32 { range "0..16383"; } + type int32 { range "0..16383"; } } list pLMNInfoList { - description "The PLMNInfoList is a list of PLMNInfo data type. It defines which PLMNs - that can be served by the NR cell, and which S-NSSAIs that can be supported by the - NR cell for corresponding PLMN in case of network slicing feature is supported."; - // Note: Whether the attribute pLMNId in the pLMNInfo can be writable depends on the implementation. - key "mcc mnc"; + description "The PLMNInfoList is a list of PLMNInfo data type. It defines + which PLMNs that can be served by the NR cell, and which S-NSSAIs that + can be supported by the NR cell for corresponding PLMN in case of + network slicing feature is supported."; + // Note: Whether the attribute pLMNId in the pLMNInfo can be writable + // depends on the implementation. + key "mcc mnc sd sst"; min-elements 1; - uses nrcommon3gpp:PLMNInfo; + uses types5g3gpp:PLMNInfo; } - leaf nRFrequencyRef { description "Reference to corresponding NRFrequency instance."; diff --git a/yang-models/_3gpp-nr-nrm-nrcelldu.yang b/yang-models/_3gpp-nr-nrm-nrcelldu.yang index 6be5a2ceb999ace1695e43357bfb8ce5ac4ce37c..0cb6dce0c84718a82dd025e4f6102ae711bb9779 100755 --- a/yang-models/_3gpp-nr-nrm-nrcelldu.yang +++ b/yang-models/_3gpp-nr-nrm-nrcelldu.yang @@ -9,7 +9,8 @@ module _3gpp-nr-nrm-nrcelldu { import _3gpp-common-top { prefix top3gpp; } import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } import _3gpp-nr-nrm-rrmpolicy { prefix nrrrmpolicy3gpp; } - import _3gpp-nr-nrm-common { prefix nrcommon3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + import ietf-yang-types { prefix yang; } organization "3GPP SA5"; @@ -18,21 +19,65 @@ module _3gpp-nr-nrm-nrcelldu { Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-10-28 { reference CR-0607 ; } + revision 2021-01-25 { reference CR-0454 ; } + revision 2020-11-25 { reference CR-0386 ; } + revision 2020-11-05 { reference CR-0412 ; } + revision 2020-10-02 { reference CR-0384 ; } revision 2020-05-08 { reference S5-203316 ; } revision 2020-02-14 { reference S5-20XXXX ; } revision 2019-10-28 { reference S5-193518 ; } - revision 2019-09-03 { - description "Initial revision"; - } + revision 2019-09-03 { reference "Initial revision"; } - feature DPCIConfigurationFunction { - description "Classs representing Distributed SON or Domain-Centralized SON function of PCI configuration feature"; + feature DRACHOptimizationFunction { + description "Class representing D-SON function of RACH optimization + feature"; } feature CPCIConfigurationFunction { - description "Classs representing Cross Domain-Centralized SON function of PCI configuration feature"; + description "Class representing Centralized SON function of + PCI configuration feature"; } + grouping NPNIdentityGrp { + description "Represents the NPN supported by the <> using this + <> as one of its attributes in case of the cell is a + NPN-only cell."; + + list plmnid { + key "mcc mnc"; + min-elements 1; + description "PLMNId"; + uses types3gpp:PLMNId; + } + + leaf cAGIdList { + type string; + mandatory true; + description "It identifies a CAG list containing up to 12 CAG-identifiers + per PLMN Identity, see TS 38.331. + + CAG is used for the PNI-NPNs to prevent UE(s), which are not allowed + to access the NPN via the associated cell(s), from automatically + selecting and accessing the associated CAG cell(s). + + CAG ID is used to combine with PLMN ID to identify a PNI-NPN. + + Exist if the cell is a NPN-only cell see TS 38.331"; + } + + leaf nIDList { + type string; + mandatory true; + description "It identifies a list of NIDs containing up to 12 NIDs per + PLMN Identity, see TS 38.331. + + NID is used to combine with PLMN ID to identify an SNPN. + + Exist if the cell is a NPN-only cell see TS 38.331"; + } + } + grouping NRCellDUGrp { description "Represents the NRCellDU IOC."; reference "3GPP TS 28.541"; @@ -74,16 +119,30 @@ module _3gpp-nr-nrm-nrcelldu { } list pLMNInfoList { - description "The PLMNInfoList is a list of PLMNInfo data type. It defines which PLMNs that - can be served by the NR cell, and which S-NSSAIs that can be supported by the NR cell for - corresponding PLMN in case of network slicing feature is supported. The plMNId of the first - entry of the list is the PLMNId used to construct the nCGI for the NR cell."; - key "mcc mnc"; + description "The PLMNInfoList is a list of PLMNInfo data type. It + defines which PLMNs that can be served by the NR cell, and which + S-NSSAIs that can be supported by the NR cell for corresponding PLMN + in case of network slicing feature is supported. The plMNId of the + first entry of the list is the PLMNId used to construct the nCGI for + the NR cell."; + key "mcc mnc sd sst"; min-elements 1; - uses nrcommon3gpp:PLMNInfo; + ordered-by user; + uses types5g3gpp:PLMNInfo; } - + list nPNIdentityList { + key idx ; + min-elements 1; + ordered-by user; + description "It defines which NPNs that can be served by the NR cell, + and which CAG IDs or NIDs can be supported by the NR cell for + corresponding PNI-NPN or SNPN in case of the cell is NPN-only cell."; + reference "3GPP TS 38.331"; + leaf idx { type uint32 ; } + uses NPNIdentityGrp; + } + leaf nRPCI { description "The Physical Cell Identity (PCI) of the NR cell."; reference "3GPP TS 36.211"; @@ -126,20 +185,122 @@ module _3gpp-nr-nrm-nrcelldu { units MHz; } - leaf bSChannelBwUL { - description "Base station channel bandwidth for uplink."; - reference "3GPP TS 38.104"; - type int32; - units MHz; - } + leaf rimRSMonitoringStartTime { + type yang:date-and-time ; + mandatory true; + description "Configures the UTC time when the gNB attempts to start + RIM-RS monitoring."; + } + + leaf rimRSMonitoringStopTime { + type yang:date-and-time ; + mandatory true; + description "Configures the UTC time when the gNB stops RIM-RS + monitoring."; + } + + leaf rimRSMonitoringWindowDuration { + type uint32 { + range 1..16384 ; + } + mandatory true; + description "Configures a duration of the monitoring window in which + gNB monitors the RIM-RS, in unit of P_t, where P_t is the RIM-RS + transmission periodicity in units of uplink-downlink switching period ( + see 38.211 subclause 7.4.1.6). - leaf bSChannelBwSUL { - description "Base station channel bandwidth for supplementary uplink."; - reference "3GPP TS 38.104"; - mandatory false; - type int32; - units MHz; - } + This field is configured together with rimRSMonitoringInterval, + rimRSMonitoringWindowStartingOffset, rimRSMonitoringOccasionInterval + and rimRSMonitoringOccasionStartingOffset. + The duration of the monitoring window is expected to be larger than + or equal to M*P_t, where M is the interval between adjacent monitoring + occasions within the monitoring window + (configured by rimRSMonitoringInterval). + The absolute duration of the monitoring window is not expected to be + larger than the periodicity of the monitoring window (configured by + rimRSMonitoringWindowPeriodicity). + + See 3GPP TS 28.541 attribute descrition rimRSMonitoringWindowDuration + for the exact math formulas. + + Only the earliest N_T consecutive detection durations in each RIM-RS + transmission periodicity (P_t) in the monitoring window are taken as + valid time for monitoring potential interference, and they are + consecutively monitored in the monitoring window, while the residual + part of each RIM-RS transmission periodicity is not used for + discovering potential interference, where, a consecutive detection + duration spans P1*R1 (if only P1 is configured) or ((P1+P2))/2*R1 ( + if both P1 and P2 are configured), where, + R1 is the number of consecutive uplink-downlinkswitching periods + for RS-1 (configured by nrofConsecutiveRIMRS1), + P1 is the first uplink-downlinkswitching period (configured by + dlULSwitchingPeriod1), + P2 is the second uplink-downlink switching period (configured by + dlULSwitchingPeriod2), and + N_T= + ((N_setID # RIM,1)/(N_f # RI N_s # RIM,1) + if enableEnoughNotEnoughIndication is 'disable' + + (2N_setID # RIM,1)/(N_f # RIM N_s # RIM,1) + if enableEnoughNotEnoughIndication is 'enable' + + N_setID # 'RIM,1' is the total number of set IDs for RIM RS-1 + (configured by totalnrofSetIdofRS1), + N_f # RIM is the number of candidate frequency resources in the whole + network (configured by nrofGlobalRIMRSFrequencyCandidates), and + N_s # 'RIM,1' is the number of candidate sequences assigned for + RIM RS-1 (configured by nrofRIMRSSequenceCandidatesofRS1)."; + } + + leaf rimRSMonitoringWindowStartingOffset { + type uint8 { + range 0..23 ; + } + mandatory true; + units hours; + description "Configures the start offset of the first monitoring window + within one day, in unit of hours."; + } + + leaf rimRSMonitoringWindowPeriodicity { + type uint8 { + range 1|2|3|4|6|8|12|24 ; + } + units hours; + mandatory true; + description "Configures the periodicity of the monitoring window, in + unit of hours"; + } + + leaf rimRSMonitoringOccasionInterval { + type uint32 { + range 1..max ; + } + mandatory true; + description "Configures the interval between adjacent monitoring + occasions (M) within the monitoring window, in unit of consecutive + detection duration. + M is expected to be prime to N_T, where N_T is given in above + attribute rimRSMonitoringWindowDuration. + allowedValues: 1,2..N_T-1"; + } + + leaf rimRSMonitoringOccasionStartingOffset { + type uint32 ; + mandatory true; + description "Configures the start offset of the first monitoring occasions + within the monitoring window (S_M), in unit of consecutive detection + duration. + gNB starts monitoring potential interference from the S_M-th consecutive + detection duration in the first complete RIM-RS transmission + periodicity (P_t) within the monitoring window. + + allowedValues: 0,1,2..M-1 + + where M is the the interval between adjacent monitoring occasions + within the monitoring window + (configured by rimRSMonitoringOccasionInterval)"; + } leaf ssbFrequency { description "Indicates cell defining SSB frequency domain position. @@ -188,30 +349,83 @@ module _3gpp-nr-nrm-nrcelldu { units "subframes (ms)"; } + leaf bSChannelBwUL { + description "Base station channel bandwidth for uplink."; + reference "3GPP TS 38.104"; + type int32; + units MHz; + } + + leaf bSChannelBwSUL { + description "Base station channel bandwidth for supplementary uplink."; + reference "3GPP TS 38.104"; + type int32; + units MHz; + } + leaf-list nRSectorCarrierRef { description "Reference to corresponding NRSectorCarrier instance."; min-elements 1; - type types3gpp:DistinguishedName; + type types3gpp:DistinguishedName; } leaf-list bWPRef { description "Reference to corresponding BWP instance."; - min-elements 0; - type types3gpp:DistinguishedName; + type types3gpp:DistinguishedName; } leaf-list nRFrequencyRef { description "Reference to corresponding NRFrequency instance."; - min-elements 0; - type types3gpp:DistinguishedName; + type types3gpp:DistinguishedName; + } + + leaf victimSetRef { + type types3gpp:DistinguishedName; + mandatory true; + description "DN of a victim Set (RimRSSet) + Implemented if RIM feature is supported"; + } + + leaf aggressorSetRef { + type types3gpp:DistinguishedName; + mandatory true; + description "DN of an aggressor Set (RimRSSet)"; } } augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { list NRCellDU { - description "Represents the information of a cell known by DU."; - reference "3GPP TS 28.541"; + description "This IOC represents the part of NR cell information that + describes s the specific resources instances. + + An NR cell transmits SS/PBCH block and always requires downlink + transmission at a certain carrier frequency with a certain channel + bandwidth. Transmission may be performed from multiple sector-carriers + using different transmission points, and these may be configured with + different carrier frequencies and channel bandwidths, as long as they + are aligned to the cell's downlink resource grids as defined in + subclause 4.4 in TS 38.211. The values of arfcnDL and bSChannelBwDL + attributes define the resource grids which each sector-carrier needs to + be aligned to. See subclauses 5.3 and 5.4.2 of TS 38.104 for definitions + of BS channel bandwidth and NR-ARFCN, respectively. + + An NR cell requires an uplink in order to provide initial access. In + case of TDD, the values of arfcnUL and bSChannelBwUL have to always be + set to the same values as for the corresponding DL attributes. For both + FDD and TDD, the arfcnUL and bSChannelBwUL define uplink resource grids + to which each sector-carrier needs to align to. + + An NR cell can in addition be configured with a supplementary uplink, + which has its own arfcnSUL and bSChannelBwSUL, which define resource + grids for supplementary uplink sector-carriers. + + Each of downlink, uplink and supplementary uplink (if configured) need + an initial bandwidth part (BWP), which defines resources to be used by + UEs during and immediately after initial access. Additional BWPs can be + either configured or calculated by gNB internally and be applied to UEs + dynamically by gNB based on e.g. UE capability and bandwidth need of + each UE."; key id; uses top3gpp:Top_Grp; container attributes { diff --git a/yang-models/_3gpp-nr-nrm-nrcellrelation.yang b/yang-models/_3gpp-nr-nrm-nrcellrelation.yang index f9757380e973d006d2e025b6aa56427260679a61..6e2a77b91f1efa13784d9fa48e2cc19319e1cfdb 100755 --- a/yang-models/_3gpp-nr-nrm-nrcellrelation.yang +++ b/yang-models/_3gpp-nr-nrm-nrcellrelation.yang @@ -15,6 +15,7 @@ module _3gpp-nr-nrm-nrcellrelation { Object Class (IOC) that is part of the NR Network Resource Model (NRM)."; reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + revision 2021-01-25 { reference CR-0454 ; } revision 2020-06-03 { reference S5-202333 ; } revision 2020-04-23 { reference CR0281 ; } revision 2019-10-28 { reference S5-193518 ; } @@ -35,11 +36,11 @@ module _3gpp-nr-nrm-nrcellrelation { description "Represents the NRCellRelation IOC."; reference "3GPP TS 28.541"; - leaf nRTCI { + leaf nRTCI { description "Target NR Cell Identifier. It consists of NR Cell Identifier (NCI) and Physical Cell Identifier of the target NR cell (nRPCI)."; - type uint64; + type uint64; } container cellIndividualOffset { @@ -86,13 +87,13 @@ module _3gpp-nr-nrm-nrcellrelation { } } - leaf nRFreqRelationRef { + leaf nRFreqRelationRef { description "Reference to a corresponding NRFreqRelation instance."; mandatory true; type types3gpp:DistinguishedName; } - leaf adjacentNRCellRef { + leaf adjacentNRCellRef { description "Reference to an adjacent NR cell (NRCellCU or ExternalNRCellCU)."; mandatory true; @@ -110,7 +111,6 @@ module _3gpp-nr-nrm-nrcellrelation { default true; description "True if handovers are allowed over this relation."; } - } leaf isESCoveredBy { description "Indicates whether the adjacent cell @@ -124,6 +124,7 @@ module _3gpp-nr-nrm-nrcellrelation { changed to energy saving state."; type EnergySavingCoverage; } + } augment /me3gpp:ManagedElement/gnbcucp3gpp:GNBCUCPFunction/nrcellcu3gpp:NRCellCU { diff --git a/yang-models/_3gpp-nr-nrm-nrfreqrelation.yang b/yang-models/_3gpp-nr-nrm-nrfreqrelation.yang index 18ac8edec753e492b9cf7435ae96d831ea6b9dcd..3d25d85d05bdaba7a313347b3ef7d8f49c032fbd 100755 --- a/yang-models/_3gpp-nr-nrm-nrfreqrelation.yang +++ b/yang-models/_3gpp-nr-nrm-nrfreqrelation.yang @@ -191,15 +191,15 @@ module _3gpp-nr-nrm-nrfreqrelation { units dB; } - leaf tReselectionNR { + leaf tReselectionNR { description "Cell reselection timer for NR."; reference "TreselectionRAT for NR in 3GPP TS 38.331"; mandatory true; type int32 { range "0..7"; } - units s; + units s; } - leaf tReselectionNRSfHigh { + leaf tReselectionNRSfHigh { description "The attribute tReselectionNr (parameter TreselectionNR in 3GPP TS 38.304) is multiplied with this scaling factor if the UE is in high mobility state."; @@ -210,7 +210,7 @@ module _3gpp-nr-nrm-nrfreqrelation { units %; } - leaf tReselectionNRSfMedium { + leaf tReselectionNRSfMedium { description "The attribute tReselectionNr (parameter TreselectionNR in 3GPP TS 38.304) multiplied with this scaling factor if the UE is in medium mobility state."; @@ -221,7 +221,7 @@ module _3gpp-nr-nrm-nrfreqrelation { units %; } - leaf nRFrequencyRef { + leaf nRFrequencyRef { description "Reference to a corresponding NRFrequency instance."; mandatory true; type types3gpp:DistinguishedName; diff --git a/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang b/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang new file mode 100755 index 0000000000000000000000000000000000000000..ac362452022728e0dff4c5dff21e8767a968fe62 --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-nroperatorcelldu.yang @@ -0,0 +1,81 @@ +module _3gpp-nr-nrm-nroperatorcelldu { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-nroperatorcelldu"; + prefix "nropcelld3gpp"; + + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-operatordu { prefix operdu3gpp; } + import _3gpp-5g-common-yang-types { prefix types5g3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } + import _3gpp-nr-nrm-gnbdufunction { prefix gnbdu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the OperatorDU Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-01 { reference "Initial revision"; } + + grouping NROperatorCellDUGrp { + description "Represents the NROperatorCellDU IOC."; + reference "3GPP TS 28.541"; + uses operdu3gpp:OperatorDUGrp; + + leaf cellLocalId { + description "Identifies an NR cell of a gNB. Together with the + corresponding gNB identifier in forms the NR Cell Identity (NCI)."; + reference "NCI in 3GPP TS 38.300"; + type int32 { range "0..16383"; } + } + + leaf administrativeState { + description "Administrative state of the NROperatorCellDU. Indicates the + permission to use or prohibition against using the cell, imposed + through the OAM services."; + type types3gpp:AdministrativeState; + default LOCKED; + } + + list pLMNInfoList { + description "The PLMNInfoList is a list of PLMNInfo data type. It + defines which PLMNs that can be served by the NR cell, and which + S-NSSAIs that can be supported by the NR cell for corresponding PLMN + in case of network slicing feature is supported. The plMNId of the + first entry of the list is the PLMNId used to construct the nCGI for + the NR cell."; + key "mcc mnc sd sst"; + min-elements 1; + ordered-by user; + uses types5g3gpp:PLMNInfo; + } + + leaf nRTAC { + description "The common 5GS Tracking Area Code for the PLMNs."; + reference "3GPP TS 23.003, 3GPP TS 38.473"; + type types3gpp:Tac; + } + + leaf-list nRCellDURef { + description "Reference to corresponding NRCellDU instance."; + type types3gpp:DistinguishedName; + } + + } + + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction/operdu3gpp:OperatorDU" + { + + list NROperatorCellDU { + description "Contains attributes to support 5G MOCN network sharing."; + reference "3GPP TS 28.541"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses NROperatorCellDUGrp; + } + uses gnbdu3gpp:GNBDUFunctionGrp; + } + } +} \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-nrsectorcarrier.yang b/yang-models/_3gpp-nr-nrm-nrsectorcarrier.yang index 6153b045870cc901447140db6e624c2e7577b263..2f55cf1db689d2b290826ca6c390945ccb1a8db4 100755 --- a/yang-models/_3gpp-nr-nrm-nrsectorcarrier.yang +++ b/yang-models/_3gpp-nr-nrm-nrsectorcarrier.yang @@ -98,7 +98,7 @@ module _3gpp-nr-nrm-nrsectorcarrier { instance."; reference "3GPP TS 23.622"; mandatory true; - type types3gpp:DistinguishedName; + type types3gpp:DistinguishedName; } } diff --git a/yang-models/_3gpp-nr-nrm-operatordu.yang b/yang-models/_3gpp-nr-nrm-operatordu.yang new file mode 100755 index 0000000000000000000000000000000000000000..f0214a3bbb4edbf85e4a7581904f7af2b9c5513c --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-operatordu.yang @@ -0,0 +1,44 @@ +module _3gpp-nr-nrm-operatordu { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-operatordu"; + prefix "operdu3gpp"; + + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-managed-element { prefix me3gpp; } + import _3gpp-nr-nrm-gnbdufunction {prefix gnbdu3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the OperatorDU Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-01 { reference "Initial revision"; } + + grouping OperatorDUGrp { + description "Represents the OperatorDU IOC."; + reference "3GPP TS 28.541"; + uses gnbdu3gpp:GNBDUFunctionGrp { + refine gNBId { + mandatory true; + } + refine gNBIdLength { + mandatory true; + } + } + } + + augment "/me3gpp:ManagedElement/gnbdu3gpp:GNBDUFunction" { + + list OperatorDU { + description "Contains attributes to support the 5G MOCN network sharing."; + reference "3GPP TS 28.541"; + key id; + uses top3gpp:Top_Grp; + container attributes { + uses OperatorDUGrp; + } + uses gnbdu3gpp:GNBDUFunctionGrp; + } + } +} \ No newline at end of file diff --git a/yang-models/_3gpp-nr-nrm-rimrsset.yang b/yang-models/_3gpp-nr-nrm-rimrsset.yang new file mode 100755 index 0000000000000000000000000000000000000000..9f285a6239336d7cff36c033f19b9cd56fa6bef1 --- /dev/null +++ b/yang-models/_3gpp-nr-nrm-rimrsset.yang @@ -0,0 +1,497 @@ +module _3gpp-nr-nrm-rimrsset { + yang-version 1.1; + namespace "urn:3gpp:sa5:_3gpp-nr-nrm-rimrsset"; + prefix "rrsset3gpp"; + + import _3gpp-common-subnetwork { prefix subnet3gpp; } + import _3gpp-common-top { prefix top3gpp; } + import _3gpp-common-yang-types { prefix types3gpp; } + + organization "3GPP SA5"; + contact "https://www.3gpp.org/DynaReport/TSG-WG--S5--officials.htm?Itemid=464"; + description "Defines the YANG mapping of the RimRSSet Information Object + Class (IOC) that is part of the NR Network Resource Model (NRM)."; + reference "3GPP TS 28.541 5G Network Resource Model (NRM)"; + + revision 2021-10-28 { reference CR-0607 ; } + + grouping FrequencyDomainParaGrp { + description "Configuration parameters of frequency domain resource to + support RIM RS. "; + + leaf rimRSSubcarrierSpacing { + type uint8 { + range 0|1 ; + } + mandatory true; + description + "It is the subcarrier spacing configuration (u) for the RIM-RS. + Subcarrier spacing delta-f=2^u*15 kHz. (see 38.211 subclause 5.3.3)."; + } + + leaf rIMRSBandwidth { + type uint8 { + range 1..96 ; + } + mandatory true; + description "It is the bandwidth of the RIM-RS in resource blocks + (see 38.211 subclause 5.3.3). + For carrier bandwidth larger than 20MHz, this attribute should be + 96 if subcarrier spacing is15kHz + 48 or 96 if subcarrier spacing is 30kHz + For carrier bandwidth smaller than or equal to 20MHz, this attribute + should be + Minimum of {96 , bandwidth of downlink carrier in number of PRBs} if + subcarrier spacing is15kHz + Minimum of {48, bandwidth of downlink carrier in number of PRBs } if + subcarrier spacing is 30kHz"; + } + + leaf nrofGlobalRIMRSFrequencyCandidates { + type uint8 { + range 1|2|4 ; + } + mandatory true; + description "The number of candidate frequency resources in the whole + network (N_f^RIM ) (see 38.211 subclause 7.4.1.6)."; + } + + leaf-list rimRSCommonCarrierReferencePoint { + type int32 ; + } + + leaf rimRSStartingFrequencyOffsetIdList { + type uint32 { + range 0..550; + } + must 'count(.) = ../nrofGlobalRIMRSFrequencyCandidates' { + error-message + "The multiplicity must be equal to nrofGlobalRIMRSFrequencyCandidates"; + } + description "List of configured frequency offsets in units of resource + blocks, where each element is the frequency offset relative to a + configured reference point for RIM-RS. The size of the list is + nrofGlobalRIMRSFrequencyCandidates and the resulting frequency resource + blocks of RIM-RS corresponding to different configured frequency offset + have no overlapping bandwidth. (see 38.211 subclause 7.4.1.6). + + allowedValues: 0..maxNrofPhysicalResourceBlocks-1 where + maxNrofPhysicalResourceBlocks = 550"; + } + } + + grouping SequenceDomainParaGrp { + description "Configuration parameters of sequence domain resource to + support RIM RS. "; + + leaf nrofRIMRSSequenceCandidatesofRS1 { + type uint8 { + range 1..8 ; + } + mandatory true; + description "The number of candidate sequences assigned for RIM RS-1 + (N_s^RIM,1) (see 38.211 [subclause 7.4.1.6). It should be even when + enableEnoughNotEnoughIndication for RS-1 is ON"; + } + + leaf-list rimRSScrambleIdListofRS1 { + type uint32 { + range 0..1023 ; + } + must 'count(.) = ../nrofRIMRSSequenceCandidatesofRS1' { + error-message + "The multiplicity must be equal to nrofRIMRSSequenceCandidatesofRS1"; + } + description "List of configured scrambling identities for RIM RS-1 ( + see 38.211 [subclause 7.4.1.6). The size of the list is + nrofRIMRSSequenceCandidatesofRS1."; + } + + leaf nrofRIMRSSequenceCandidatesofRS2 { + type uint8 { + range 1..8 ; + } + mandatory true; + description "The number of candidate sequences assigned for RIM RS-2 + (N_s^RIM,2) (see 38.211 subclause 7.4.1.6)."; + } + + leaf rimRSScrambleIdListofRS2 { + type uint32 { + range 0..1023 ; + } + must 'count(.) = ../nrofRIMRSSequenceCandidatesofRS2' { + error-message + "The multiplicity must be equal to nrofRIMRSSequenceCandidatesofRS2"; + } + description "List of configured scrambling identities for RIM RS-2 ( + see 38.211 subclause 7.4.1.6). + The size of the list is nrofRIMRSSequenceCandidatesofRS2."; + } + + leaf enableEnoughNotEnoughIndication { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether 'Enough'/'Not enough' indication + functionality is enabled for RIM RS-1 (see 38.211 subclause 7.4.1.6). + + If the indication is 'ENABLED', the first half of + nrofRIMRSSequenceCandidatesofRS1 sequences indicates 'Not enough + mitigation', and the second half indicates 'Enough mitigation', where, + 'Enough mitigation' indicates that IoT going back to certain level at + victim side and/or no further interference mitigation actions are + needed at aggressor side + 'Not enough mitigation' indicates that IoT exceeding certain level at + victim side and/or further interference mitigation actions are needed + at aggressor side + + enableEnoughNotEnoughIndication is equivalent to EnoughIndication + (see 38.211 subclause 7.4.1.6)"; + } + + leaf RIMRSScrambleTimerMultiplier { + type uint32 { + range 0..2147483647; + } + mandatory true; + description "It is parameter multiplier factor gamma for initialization + seed of the pseudo-random sequence c~(i) + (see 38.211 subclause 7.4.1.6.2). + allowedValues: 0,1...2^31-1"; + } + + leaf RIMRSScrambleTimerOffset { + type uint32 { + range 0..2147483647; + } + mandatory true; + description "It is parameter offset delta for initialization seed of + the pseudo-random sequence c~(i) (see 38.211 subclause 7.4.1.6.2). + allowedValues: 0,1...2^31-1"; + } + } + + grouping TimeDomainParaGrp { + description "Configuration parameters of time domain resource to + support RIM RS. "; + + leaf dlULSwitchingPeriod1 { + type enumeration { + enum MS0P5; + enum MS0P625; + enum MS1; + enum MS1P25; + enum MS2; + enum MS2P5; + enum MS3; + enum MS4; + enum MS5; + enum MS10; + enum MS20; + } + mandatory true; + description "This attribute is used to configure the first uplink-downlink + switching period (P1) for RIM RS transmission in the network, where one + RIM RS is configured in one uplink-downlink switching period. + (see 38.211 subclause 7.4.1.6). + + When only one TDD-UL-DL-Pattern is configured, only + dl-UL-SwitchingPeriod1 is configured, where P1 equals to the + transmission periodicity of the TDD-UL-DL-Pattern. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources is configured only in one of the TDD patterns, only + dl-UL-SwitchingPeriod1 is configured, where P1 equals to the addition + of the concatenated transmission periodicity of the two + TDD-UL-DL-Patterns. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, both + dl-UL-SwitchingPeriod1 and dl-UL-SwitchingPeriod2 are configured, + where P1 equals to the transmission periodicity of the first + TDD-UL-DL-Pattern. + + P1 is equivalent to T_(per,1)^RIM (see 38.211, subclause 7.4.1.6). + + allowedValues: + MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS4, MS5, MS10, MS20, + if a single uplink-downlink period is configured for RIM-RS purposes; + MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS3, MS4, MS5, MS10, MS20, + if two uplink-downlink periods are configured for RIM-RS purposes."; + } + + leaf symbolOffsetOfReferencePoint1 { + type uint32 { + range 2..327679 ; + } + mandatory true; + description "This attribute is used to configure the reference point in + the first uplink-downlink switching period, which is the symbols offset + of the reference point after the starting boundary of the first + uplink-downlink switching period. It's Configured together with + dl-UL-SwitchingPeriod1 (see 38.211 subclause 7.4.1.6). + + When only one TDD-UL-DL-Pattern is configured, the reference point + configured for the first uplink-downlink switching period is the DL + transmission boundary of the TDD-UL-DL-Pattern. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources is configured only in one of the TDD patterns, the reference + point configured for the first uplink-downlink switching period is the + DL transmission boundary of the TDD-UL-DL-Pattern where the RIM-RS + resource is configured. + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, the reference points + configured for first uplink-downlink switching period is the DL + transmission boundary of the first TDD-UL-DL-Pattern. + + allowedValues: 2, 3..20*2*maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf dlULSwitchingPeriod2 { + type enumeration { + enum MS0P5; + enum MS0P625; + enum MS1; + enum MS1P25; + enum MS2; + enum MS2P5; + enum MS3; + enum MS4; + enum MS5; + enum MS10; + } + mandatory true; + description "Used to configure the second uplink-downlink switching + period (P2) for RIM RS transmission in the network, where one RIM RS is + configured in one uplink-downlink switching period + (see 38.211 subclause 7.4.1.6). + + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, both + dl-UL-SwitchingPeriod1 and dl-UL-SwitchingPeriod2 are configured, + where P2 equals to the transmission periodicity of the second + TDD-UL-DL-Pattern, and where (P1 + P2) divides 20 ms. + + allowedValues: MS0P5, MS0P625, MS1, MS1P25, MS2, MS2P5, MS3, MS4, MS5, + MS10 + + P2 is equivalent to T_(per,2)^RIM (see 38.211 subclause 7.4.1.6)"; + } + + leaf symbolOffsetOfReferencePoint2 { + type uint32 { + range 2..327679 ; + } + mandatory true; + description "This attribute is used to configure the reference point in + the second uplink-downlink switching period, which is the symbol offset + of the reference point after starting boundary of the second + uplink-downlink switching period. Configured together with + dl-UL-SwitchingPeriod2 (see 38.211 subclause 7.4.1.6). + When two concatenated TDD-UL-DL-Patterns are configured, and RIM-RS + resources are configured in both TDD patterns, the reference points + configured for second uplink-downlink switching period is the + DL transmission boundary of the second TDD-UL-DL-Pattern. + + allowedValues: 2, 3..20*2*maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf totalnrofSetIdofRS1 { + type uint32 { + range 0..4194303 ; + } + mandatory true; + description "It is the total number of set IDs for RIM RS-1 + (N_setID ^RIM,1) (see 38.211 subclause 7.4.1.6). + + allowedValues: 0,1...2^22-1"; + } + + leaf totalnrofSetIdofRS2 { + type uint32 { + range 0..4194304 ; + } + mandatory true; + description "It is the total number of set IDs for RIM RS-2 + (N_setID^RIM,2) (see 38.211 subclause 7.4.1.6). + + allowedValues: 0,1...2^22"; + } + + leaf nrofConsecutiveRIMRS1 { + type uint8 { + range 1|2|4|8 ; + } + mandatory true; + description "It is the number of consecutive uplink-downlink switching + periods for RS-1 (R1) for repetition/near-far indication:. + (see 38.211 subclause 7.4.1.6). + + allowedValues: 1,2,4,8"; + } + + leaf nrofConsecutiveRIMRS2 { + type uint8 { + range 1|2|4|8 ; + } + mandatory true; + description "It is the number of consecutive uplink-downlink switching + periods for RS-2 (R2) for repetition/near-far indication. + (see 38.211 subclause 7.4.1.6). + + allowedValues: 1,2,4,8"; + } + + leaf-list consecutiveRIMRS1List { + type uint32 { + range 2..327679 ; + } + description "It is used to configure the OFDM symbol position(s) of RIM + RS-1 within the uplink-downlink switching period. It is a list of symbol + offset of RIM RS-1 (N_symb,ref^(RIM,1)) before the reference point. + The size of the list is nrofConsecutiveRIMRS1 + (see 38.211 subclause 7.4.1.6). + The resulting RIM RS-1 symbols and its reference point shall belong to + the same 10ms frame. + + allowedValues: 2,3..20*2**maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf-list consecutiveRIMRS2List { + type uint32 { + range 2..327679 ; + } + description "It is used to configure the OFDM symbol position(s) of + RIM RS-2 within the uplink-downlink switching period. It is a list of + symbol offset of RIM RS-2 (N_symb,ref^(RIM,2)) before the reference + point. The size of the list is nrofConsecutiveRIMRS2 + (see 38.211 subclause 7.4.1.6). + The resulting RIM RS-2 symbols and its reference point shall belong to + the same 10ms frame. + + allowedValues: 2,3..20*2**maxNrofSymbols-1, where maxNrofSymbols=14"; + } + + leaf enablenearfarIndicationRS1 { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether near-far functionality is enabled + for RIM RS1. + + If the indication is 'ENABLED', + the first half of nrofConsecutiveRIMRS1 (R1) consecutive uplink-downlink + switching period is for 'Near' indication with R1/2 repetitions, + the second half of R1 consecutive uplink-downlink switching period is + for 'Far' indication with R1/2 repetitions."; + } + + leaf enablenearfarIndicationRS2 { + type types3gpp:EnabledDisabled; + default DISABLED; + description "It is indication of whether near-far functionality is enabled + for RIM RS2. + + If the indication is 'enable', + the first half of nrofConsecutiveRIMRS2 (R2) consecutive uplink-downlink + switching period is for 'Near' indication with R2/2 repetitions, + the second half of R2 consecutive uplink-downlink switching period is + for 'Far' indication with R2/2 repetitions."; + } + } + + grouping RimRSGlobalGrp { + description "Represents the RimRSGlobal IOC."; + + list frequencyDomainPara { + key rimRSSubcarrierSpacing; + min-elements 1; + max-elements 1; + description "Configuration parameters of frequency domain resource to + support RIM RS. "; + uses FrequencyDomainParaGrp; + } + + list sequenceDomainPara { + key nrofRIMRSSequenceCandidatesofRS1; + min-elements 1; + max-elements 1; + description "Configuration parameters of sequence domain resource to + support RIM RS. "; + uses SequenceDomainParaGrp; + } + + list timeDomainPara { + key dlULSwitchingPeriod1; + min-elements 1; + max-elements 1; + description "Configuration parameters of time domain resource to + support RIM RS. "; + uses TimeDomainParaGrp; + } + } + + grouping RimRSSetGrp { + description "Represents the RimRSSet IOC."; + + leaf setId { + type uint32 { + range 0..4194303 ; + } + mandatory true; + description "This specifies the set ID of a victim Set (RIM-RS1 Set) or + aggressor Set (RIM-RS2 set). (See subclause 7.4.1.6 in TS 38.211). + + allowedValues: The bit length of the set ID is maximum 22bit."; + } + + leaf setType { + type enumeration { + enum RS1; + enum RS2; + } + mandatory true; + description "The attribute specifies type of a RIM-RS Set . + RIM RS1 is generated and transmitted by victim to indicate its suffering + remote interference, and RIM RS2 is generated and transmitted by + aggressor to measure if Remote Interference still exist + + If the attribute value is 'RS1', the RIM-RS Set is victim set. + If the attribute value is 'RS2', the RIM-RS Set is aggressor set."; + } + + leaf-list nRCellDURef { + type types3gpp:DistinguishedName; + config false; + description "This attribute contains the DN of a NR Cell (NRCellDU)"; + } + } + + augment "/subnet3gpp:SubNetwork" { + list RimRSGlobal { + description "Represents global/common Remote Interference Management (RIM) + Reference Signal (RS) resource allocated for the whole network. + Resource for RIM-RS transmission is defined by Sequence domain resource, + Time domain resource and Frequency resource. The configure parameters + of the RIM RS resource are applied to all Sets of RIM RS Resource + across gNBs/cells in the network."; + key id; + max-elements 1; + uses top3gpp:Top_Grp; + container attributes { + uses RimRSGlobalGrp; + } + + list RimRSSet { + description "Represents aggressor or victim Set organized by OAM. + The RIM RS Resource is assigned to each Set, which is identified by + triple indices set of +