Tech-invite  3GPPspace  IETFspace
◀  ▶  21  22  23  24  25  26  27  28  29  31  32  33  34  35  36  37  38  4‑5x

Content for  TS 29.571  Word version:  19.4.0

Top   Top   Up   Prev   Next
1…   5…   5.3…   5.4…   5.5…   5.6…   5.7…   5.8…   5.9…   5.10…   5.11…   5.12…   A… 
5.4 Data Types related to 5G Network  5.4.1 Introduction  5.4.2 Simple Data Types  5.4.3 Enumerations  5.4.4 Structured Data Types  5.4.5 Data types describing alternative data types or combinations of data types 
...

 

5.4  Data Types related to 5G Network  p. 43

5.4.1  Introduction  p. 43

This clause defines common data types related to 5G Network (other than related to 5G QoS).

5.4.2  Simple Data Types  p. 43

This clause specifies common simple data types.
Type Name Type Definition Description
ApplicationIdstringString providing an application identifier.
ApplicationIdRmstring This data type is defined in the same way as the "ApplicationId" data type, but with the OpenAPI "nullable: true" property.
PduSessionIdintegerUnsigned integer identifying a PDU session, within the range 0 to 255, as specified in clause 11.2.3.1b of TS 24.007, bits 1 to 8. If the PDU Session ID is allocated by the Core Network for UEs not supporting N1 mode, reserved range 64 to 95 is used. PDU Session ID within the reserved range is only visible in the Core Network (NOTE 1).
MccstringMobile Country Code part of the PLMN, comprising 3 digits, as defined in clause 9.3.3.5 of TS 38.413.
Pattern: '^[0-9]{3}$'
MccRmstring This data type is defined in the same way as the "Mcc" data type, but with the OpenAPI "nullable: true" property.
MncstringMobile Network Code part of the PLMN, comprising 2 or 3 digits, as defined in clause 9.3.3.5 of TS 38.413. (NOTE 2)
Pattern: '^[0-9]{2,3}$'
MncRmstring This data type is defined in the same way as the "Mnc" data type, but with the OpenAPI "nullable: true" property.
Tacstring 2 or 3-octet string identifying a tracking area code as specified in clause 9.3.3.10 or 9.3.3.16 of TS 38.413, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TAC shall appear first in the string, and the character representing the 4 least significant bit of the TAC shall appear last in the string.
Examples:
A legacy TAC 0x4305 shall be encoded as "4305".
An extended TAC 0x63F84B shall be encoded as "63F84B"
TacRmstring This data type is defined in the same way as the "Tac" data type, but with the OpenAPI "nullable: true" property.
EutraCellIdstring 28-bit string identifying an E-UTRA Cell Id as specified in clause 9.3.1.9 of TS 38.413, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.
Pattern: '^[A-Fa-f0-9]{7}$'
Example:
An E-UTRA Cell Id 0x5BD6007 shall be encoded as "5BD6007".
EutraCellIdRmstring This data type is defined in the same way as the "EutraCellId" data type, but with the OpenAPI "nullable: true" property.
NrCellIdstring 36-bit string identifying an NR Cell Id as specified in clause 9.3.1.7 of TS 38.413, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the Cell Id shall appear first in the string, and the character representing the 4 least significant bit of the Cell Id shall appear last in the string.
Pattern: '^[A-Fa-f0-9]{9}$'
Example:
An NR Cell Id 0x225BD6007 shall be encoded as "225BD6007".
NrCellIdRmstring This data type is defined in the same way as the "NrCellId" data type, but with the OpenAPI "nullable: true" property.
DnaistringDNAI (Data network access identifier), see clause 5.6.7 of TS 23.501.
DnaiRmstring This data type is defined in the same way as the "Dnai" data type, but with the OpenAPI "nullable: true" property.
5GMmCauseUintegerThis represents the 5GMM cause code values as specified in TS 24.501.
AreaCodeRmstring This data type is defined in the same way as the "AreaCode" data type, but with the OpenAPI "nullable: true" property.
AmfNameFqdnFQDN (Fully Qualified Domain Name) of the AMF as defined in clause 28.3.2.5 of TS 23.003.
AreaCodestringValues are operator specific.
N3IwfIdstring This represents the identifier of the N3IWF ID as specified in clause 9.3.1.57 of TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.
Pattern: '^[A-Fa-f0-9]+$'
Example:
The N3IWF Id 0x5BD6 shall be encoded as "5BD6".
WAgfIdstring This represents the identifier of the W-AGF ID as specified in clause 9.3.1.162 of TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the W-AGF ID shall appear first in the string, and the character representing the 4 least significant bit of the W-AGF ID shall appear last in the string.
Pattern: '^[A-Fa-f0-9]+$'
Example:
The W-AGF Id 0x5BD6 shall be encoded as "5BD6".
TngfIdstring This represents the identifier of the TNGF ID as specified in clause 9.3.1.161 of TS 38.413 in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the TNGF ID shall appear first in the string, and the character representing the 4 least significant bit of the TNGF ID shall appear last in the string.
Pattern: '^[A-Fa-f0-9]+$'
Example:
The TNGF Id 0x5BD6 shall be encoded as "5BD6".
NgeNbIdstringThis represents the identifier of the ng-eNB ID as specified in clause 9.3.1.8 of TS 38.413.
The string shall be formatted with following pattern:
Pattern: '^('MacroNGeNB-[A-Fa-f0-9]{5}|
LMacroNGeNB-[A-Fa-f0-9]{6}|
SMacroNGeNB-[A-Fa-f0-9]{5})$'
The value of the ng-eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the ng-eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the ng-eNB ID (to form a nibble) shall appear last in the string.
Examples:
"SMacroNGeNB-34B89" indicates a Short Macro NG-eNB ID with value 0x34B89.
NidstringThis represents the Network Identifier, which together with a PLMN ID is used to identify an SNPN (see TS 23.003 and clause 5.30.2.1 of TS 23.501).
Pattern: '^[A-Fa-f0-9]{11}$'
NidRmstring This data type is defined in the same way as the "Nid" data type, but with the OpenAPI "nullable: true" property.
NfSetIdstringNF Set Identifier (see clause 28.12 of TS 23.003), formatted as the following string:
"set<Set ID>.<nftype>set.5gc.mnc<MNC>.mcc<MCC>", or
"set<SetID>.<NFType>set.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"
with
<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)
<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$'
<NFType> encoded as a value defined in Table 6.1.6.3.3-1 of TS 29.510 but with lower case characters
<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.
Pattern: '^([A-Za-z0-9\-]*[A-Za-z0-9])$'
Examples:
"setxyz.smfset.5gc.mnc012.mcc345"
"set12.pcfset.5gc.mnc012.mcc345"
As specified for NF Set ID in clause 28.12 of TS 23.003, NF Set ID shall be handled as case-insensitive string.
NfServiceSetIdstringNF Service Set Identifier (see clause 28.13 of TS 23.003) formatted as the following string:
"set<Set ID>.sn<Service Name>.nfi<NF Instance ID>.5gc.mnc<MNC>.mcc<MCC>", or
"set<SetID>.sn<ServiceName>.nfi<NFInstanceID>.5gc.nid<NID>.mnc<MNC>.mcc<MCC>"
with
<MCC> encoded as defined in clause 5.4.2 ("Mcc" data type definition)
<MNC> encoding the Mobile Network Code part of the PLMN, comprising 3 digits. If there are only 2 significant digits in the MNC, one "0" digit shall be inserted at the left side to fill the 3 digits coding of MNC. Pattern: '^[0-9]{3}$'
<NID> encoded as defined in clause 5.4.2 ("Nid" data type definition)
<NFInstanceId> encoded as defined in clause 5.3.2
<ServiceName> encoded as defined in TS 29.510
<Set ID> encoded as a string of characters consisting of alphabetic characters (A-Z and a-z), digits (0-9) and/or the hyphen (-) and that shall end with either an alphabetic character or a digit.
Pattern: '^([A-Za-z0-9\-]*[A-Za-z0-9])$'
Examples:
"setxyz.snnsmf-pdusession.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"
"set2.snnpcf-smpolicycontrol.nfi54804518-4191-46b3-955c-ac631f953ed8.5gc.mnc012.mcc345"
As specified for NF Service Set ID in clause 28.13 of TS 23.003, NF Service Set ID shall be handled as case-insensitive string.
PlmnAssiUeRadioCapIdBytes String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of TS 24.501 (starting from octet 1).
ManAssiUeRadioCapIdBytes String with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, encoding the "UE radio capability ID" IE as specified in clause 9.11.3.68 of TS 24.501 (starting from octet 1).
TypeAllocationCodestringType Allocation Code (TAC) of the UE, comprising the initial eight-digit portion of the 15-digit IMEI and 16-digit IMEISV codes. See clause 6.2 of TS 23.003.
Pattern: '^[0-9]{8}$'
HfcNIdstring This IE represents the identifier of the HFC node Id as specified in CableLabs WR-TR-5WWC-ARCH [32]. It is provisioned by the wireline operator as part of wireline operations and may contain up to six characters.
HfcNIdRmstring This data type is defined in the same way as the "HfcNId" data type, but with the OpenAPI "nullable: true" property.
ENbIdstringThis represents the identifier of the eNB ID as specified in clause 9.2.1.37 of TS 36.413.
The string shall be formatted with following pattern:
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})$'
The value of the eNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, so the most significant character representing the padding 0 if required together with the 4 most significant bits of the eNB ID shall appear first in the string, and the character representing the 4 least significant bit of the eNB ID (to form a nibble) shall appear last in the string.
Examples:
"SMacroeNB-34B89" indicates a Short Macro eNB ID with value 0x34B89.
GliBytesGlobal Line Identifier uniquely identifying the line connecting the 5G-BRG or FN-BRG to the 5GS. See clause 28.16.3 of TS 23.003.
This shall be encoded as a string with format "byte" as defined in OpenAPI Specification [3], i.e. base64-encoded characters, representing the GLI value (up to 150 bytes) encoded as specified in BBF WT-470 [37].
GcistringGlobal Cable Identifier uniquely identifying the connection between the 5G-CRG or FN-CRG to the 5GS. See clause 28.15.4 of TS 23.003.
This shall be encoded as a string per clause 28.15.4 of TS 23.003, and compliant with the syntax specified in Section 2.2 of RFC 7542 for the username part of a NAI. The GCI value is specified in CableLabs WR-TR-5WWC-ARCH [32].
NsSrgstringString representing Network Slice Simultaneous Registration Group (see clause 5.15.12 of TS 23.501)
NsSrgRmstring This data type is defined in the same way as the "NsSrg" data type, but with the OpenAPI "nullable: true" property.
RelayServiceCodeintegerRelay Service Code to identify a connectivity service provided by the UE-to-Network relay or the UE-to-UE relay.
Integer type as defined in OpenAPI Specification [3], with value range from 0 to 16777215 (decimal).
Minimum = 0. Maximum = 16777215.
5GPrukIdstringProse Remote User Key ID over Control Plane
A string carrying the CP-PRUK ID of the the 5G ProSe Remote UE or the 5G ProSe End UE as specified in TS 33.503.
The CP-PRUK ID is a string in NAI format as specified in clause 28.7.11 of TS 23.003.
pattern: "^rid[0-9]{1,4}\.pid[0-9a-fA-F]+\@prose-cp\.5gc\.mnc[0-9]{2,3}\.mcc[0-9]{3}\.3gppnetwork\.org$"
NsagIdintegerContaining a Network Slice AS Group ID, see TS 38.413.
Values between 0 and 255 are allowed for this data type in this release.
NsagIdRminteger This data type is defined in the same way as the "NsagId" data type, but with the OpenAPI "nullable: true" property.
GeoSatelliteIdstringUnique identifier of a GEO satellite. See e.g. clause 5.43.2 in TS 23.501.
OffloadIdentifierstringOffload identifier uniquely identifying a VPLMN offloading policy information instance of the HPLMN (for HR-SBO) or uniquely identifying a Local Offloading Management Policy information instance of the PLMN (for I-SMF based local offloading management).
For HR-SBO, it shall comprise the PLMN ID of the HPLMN providing the VPLMN offloading policy and a unique identifier of the VPLMN offloading policy instance in the HPLMN.
For I-SMF based Local Offloading management, it shall comprise the PLMN ID of the PLMN providing the local offloading management policy information and a unique identifier of the Local Offloading Management Policy information in this PLMN.
The PLMN ID shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc" and shall match the following pattern: '[0-9]{3}-[0-9]{2,3}'
The unique identifier shall match the following pattern:
'[A-Fa-f0-9]{8}'
It may further contain the version number (between 0 and 99) of the VPLMN or Local offloading policy instance in the HPLMN or PLMN. A VPLMN or Local Offloading Information provided by the H-SMF with a higher version number will overwrite the one with lower version number. When present, the version number shall match the following pattern: '-v[0-9]{1,2}'
Pattern: '^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{8}(-v[0-9]{1,2}){0,1}$'
Examples (with and without a version number):
"262-01-00A17C01-v3"
"302-720-00A17C01"
OpConfiguredCapabilitystringThe operator configurable capability supported by the UPF.
SatelliteIdstringUnique identifier of a satellite. See e.g. clause 5.4.14 in TS 23.501.
EnergySavingIndicatorUintegerEnergy Saving Indicator. See clause 4.2.2.2.2 of TS 23.502 and clause 5.51.5 of TS 23.501.
OverloadControlInfostring String representing the Overload Control Information.
The string shall be encoded as the value part of the "Overload Control Information" header defined in clause 5.2.3.2.9 of TS 29.500.
EXAMPLE:
"Timestamp: "Tue, 04 Feb 2020 08:49:37 GMT"; Period-of-Validity: 75s; Overload-Reduction-Metric: 50%; NF-Instance: 54804518-4191-46b3-955c-ac631f953ed8"
NOTE 1:
For a PDN connection established via MME/S4-SGSN, the PDU Session ID value is set to 64 plus the EPS bearer ID of the default EPS bearer of the PDN connection; for a PDN connection established via ePDG, the PDU Session ID value is set to 80 plus the EPS bearer ID of the default EPS bearer of the PDN connection; for a PDN connection established via Gn-SGSN, the PDU Session ID value is set to 64 plus the NSAPI of the primary PDP Context of the PDN connection.
NOTE 2:
When sending a 2-digit MNC value over the SBI interface it can happen that the sender erroneously adds a leading "0". The receiver can detect such error by analysing the MCC value: If only 2-digit MNCs are allocated for the country the MCC is pointing to, then the receiver can remove the leading "0" and continue processing with the 2-digit MNC.
Up

5.4.3  Enumerations  p. 51

5.4.3.1  Enumeration: AccessType  p. 51

Enumeration value Description
"3GPP_ACCESS"3GPP access
"NON_3GPP_ACCESS"Non-3GPP access

5.4.3.2  Enumeration: RatType  p. 52

Enumeration value Description
"NR"New Radio
"EUTRA"(WB) Evolved Universal Terrestrial Radio Access
"WLAN"Untrusted Wireless LAN (IEEE 802.11) access
"VIRTUAL"Virtual (see NOTE 1)
"NBIOT"NB IoT
"WIRELINE"Wireline access
"WIRELINE_CABLE"Wireline Cable access
"WIRELINE_BBF"Wireline BBF access
"LTE-M"LTE-M (see NOTE 2)
"NR_U"New Radio in unlicensed bands
"EUTRA_U"(WB) Evolved Universal Terrestrial Radio Access in unlicensed bands
"TRUSTED_N3GA"Trusted Non-3GPP access
"TRUSTED_WLAN"Trusted Wireless LAN (IEEE 802.11) access
"UTRA"UMTS Terrestrial Radio Access
"GERA"GSM EDGE Radio Access Network
"NR_LEO"NR (LEO) satellite access type
"NR_MEO"NR (MEO) satellite access type
"NR_GEO"NR (GEO) satellite access type
"NR_OTHER_SAT"NR (OTHERSAT) satellite access type
"NR_REDCAP"NR RedCap access type (see NOTE 3)
"WB_E_UTRAN_LEO"WB-E-UTRAN (LEO) satellite access type
"WB_E_UTRAN_MEO"WB-E-UTRAN (MEO) satellite access type
"WB_E_UTRAN_GEO"WB-E-UTRAN (GEO) satellite access type
"WB_E_UTRAN_OTHERSAT"WB-E-UTRAN (OTHERSAT) satellite access type
"NB_IOT_LEO"NB-IoT (LEO) satellite access type (NOTE 5)
"NB_IOT_MEO"NB-IoT (MEO) satellite access type (NOTE 5)
"NB_IOT_GEO"NB-IoT (GEO) satellite access type (NOTE 5)
"NB_IOT_OTHERSAT"NB-IoT (OTHERSAT) satellite access type
"LTE_M_LEO"LTE-M (LEO) satellite access type (NOTE 6)
"LTE_M_MEO"LTE-M (MEO) satellite access type (NOTE 6)
"LTE_M_GEO"LTE-M (GEO) satellite access type (NOTE 6)
"LTE_M_OTHERSAT"LTE-M (OTHERSAT) satellite access type (NOTE 6)
"NR_EREDCAP"NR eRedCap access type (NOTE 4)
"HSPA_EVOLUTION"HSPA Evolution
NOTE 1:
Virtual shall be used if the N3IWF does not know the access technology used for an untrusted non-3GPP access.
NOTE 2:
This RAT type value is used only in the Core Network; it shall be used when a Category M UE using E-UTRA has provided a Category M indication to the NG-RAN.
NOTE 3:
This RAT type value is used only in the Core Network; it shall be used only for an UE using NR with reduced radio capability (RedCap) provided to the NG-RAN.
NOTE 4:
This RAT type value is used only in the Core Network; it shall be used only for an UE using NR with enhanced reduced radio capability (eRedCap) provided to the NG-RAN.
NOTE 5:
This RAT type value shall not be used as list of restricted RAT when the UDM provide the mobility restriction information to AMF.
NOTE 6:
This RAT type value is used only in the Core Network; it shall be used only to allow the AMF to provide it to MME in the case of mobility from 5GS to EPS.
Up

5.4.3.3  Enumeration: PduSessionType  p. 52

The enumeration PduSessionType indicates the type of a PDU session. It shall comply with the provisions defined in Table 5.4.3.3-1.
Enumeration value Description
"IPV4"IPv4
"IPV6"IPv6
"IPV4V6"IPv4v6 (see clause 5.8.2.2.1 of TS 23.501)
"UNSTRUCTURED"Unstructured
"ETHERNET"Ethernet
Up

5.4.3.4  Enumeration: UpIntegrity  p. 53

The enumeration UpIntegrity indicates whether UP integrity protection is required, preferred or not needed for all the traffic on the PDU Session. It shall comply with the provisions defined in Table 5.4.3.4-1.
Enumeration value Description
"REQUIRED"UP integrity protection shall apply for all the traffic on the PDU Session.
"PREFERRED"UP integrity protection should apply for all the traffic on the PDU Session.
"NOT_NEEDED"UP integrity protection shall not apply on the PDU Session.
Up

5.4.3.5  Enumeration: UpConfidentiality  p. 53

The enumeration UpConfidentiality indicates whether UP confidentiality protection is required, preferred or not needed for all the traffic on the PDU Session. It shall comply with the provisions defined in Table 5.4.3.5-1.
Enumeration value Description
"REQUIRED"UP confidentiality protection shall apply for all the traffic on the PDU Session.
"PREFERRED"UP confidentiality protection should apply for all the traffic on the PDU Session.
"NOT_NEEDED"UP confidentiality protection shall not apply on the PDU Session.
Up

5.4.3.6  Enumeration: SscMode  p. 53

The enumeration SscMode represents the service and session continuity mode.
Enumeration value Description
"SSC_MODE_1"see TS 23.501
"SSC_MODE_2"see TS 23.501
"SSC_MODE_3"see TS 23.501
Up

5.4.3.7  Enumeration: DnaiChangeType  p. 53

The enumeration DnaiChangeType represents the type of a DNAI change. A NF service consumer may subscribe to "EARLY", "LATE" or "EARLY_LATE" types of DNAI change. The types of observed DNAI change the SMF may notify are "EARLY" or "LATE". The DnaiChangeType data type shall comply with the provisions defined in Table 5.4.3.7-1.
Enumeration value Description Applicability
EARLYEarly notification of UP path reconfiguration.
EARLY_LATEEarly and late notification of UP path reconfiguration. This value shall only be present in the subscription to the DNAI change event.
LATELate notification of UP path reconfiguration.
Up

5.4.3.8  Enumeration: RestrictionType  p. 54

Enumeration value Description
"ALLOWED_AREAS"This value indicates that areas are allowed.
"NOT_ALLOWED_AREAS"This value indicates that areas are not allowed.

5.4.3.9  Enumeration: CoreNetworkType  p. 54

Enumeration value Description
"5GC"5G Core
"EPC"Evolved Packet Core

5.4.3.10  Enumeration: AccessTypeRm  p. 54

This enumeration is defined in the same way as the "AccessType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.11  Enumeration: RatTypeRm  p. 54

This enumeration is defined in the same way as the "RatType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.12  Enumeration: PduSessionTypeRm  p. 54

This enumeration is defined in the same way as the "PduSessionType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.13  Enumeration: UpIntegrityRm  p. 54

This enumeration is defined in the same way as the "UpIntegrity" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.14  Enumeration: UpConfidentialityRm  p. 54

This enumeration is defined in the same way as the "UpConfidentiality" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.15  Enumeration: SscModeRm  p. 54

This data type is defined in the same way as the "SscMode" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.17  Enumeration: DnaiChangeTypeRm  p. 55

This data type is defined in the same way as the "DnaiChangeType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.18  Enumeration: RestrictionTypeRm  p. 55

This data type is defined in the same way as the "RestrictionType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.19  Enumeration: CoreNetworkTypeRm  p. 55

This data type is defined in the same way as the "CoreNetworkType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.20  Enumeration: PresenceState  p. 55

Enumeration value Description
"IN_AREA"Indicates that the UE is inside or enters the presence reporting area.
"OUT_OF_AREA"Indicates that the UE is outside or leaves the presence reporting area.
"UNKNOWN"Indicates it is unknown whether the UE is in the presence reporting area or not.
"INACTIVE"Indicates that the presence reporting area is inactive in the serving node.
Up

5.4.3.21  Enumeration: StationaryIndication |R16|  p. 55

Enumeration value Description
"STATIONARY"Identifies the UE is stationary
"MOBILE"Identifies the UE is mobile

5.4.3.22  Enumeration: StationaryIndicationRm |R16|  p. 55

This enumeration is defined in the same way as the "StationaryIndication" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.23  Enumeration: ScheduledCommunicationType |R16|  p. 55

Enumeration value Description
"DOWNLINK_ONLY"Downlink only
"UPLINK_ONLY"Uplink only
"BIDIRECTIONAL"Bi-directional

5.4.3.24  Enumeration: ScheduledCommunicationTypeRm |R16|  p. 55

This enumeration is defined in the same way as the "ScheduledCommunicationType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.25  Enumeration: TrafficProfile |R16|  p. 56

Enumeration value Description
"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.
"MULTI_TRANS"Multiple packet transmission.
Up

5.4.3.26  Enumeration: TrafficProfileRm |R16|  p. 56

This enumeration is defined in the same way as the "TrafficProfile" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.27  Enumeration: LcsServiceAuth |R16|  p. 56

Enumeration value Description
"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
Up

5.4.3.28  Enumeration: UeAuth |R16|  p. 56

Enumeration value Description
"AUTHORIZED"Indicates that the UE is authorized.
"NOT_AUTHORIZED"Indicates that the UE is not authorized.

5.4.3.29  Enumeration: DlDataDeliveryStatus |R16|  p. 57

Enumeration value Description
"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.
Up

5.4.3.30  Enumeration: DlDataDeliveryStatusRm |R16|  p. 57

This enumeration is defined in the same way as the "DlDataDeliveryStatus" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.31  Void

5.4.3.32  Enumeration: AuthStatus |R16|  p. 57

Enumeration value Description
"EAP_SUCCESS"The NSSAA status is EAP-Success.
"EAP_FAILURE"The NSSAA status is EAP-Failure.
"PENDING"The NSSAA status is Pending, i.e. the NSSAA procedure is ongoing.
Up

5.4.3.33  Enumeration: LineType |R16|  p. 57

Enumeration value Description
"DSL"DSL line
"PON"PON line

5.4.3.34  Enumeration: LineTypeRm |R16|  p. 57

This enumeration is defined in the same way as the "LineType" enumeration, but with the OpenAPI "nullable: true" property.

5.4.3.35  Void

5.4.3.36  Void

5.4.3.37  Enumeration: NotificationFlag |R16|  p. 58

Enumeration value Description Applicability
ACTIVATEThe event notification is activated.
DEACTIVATEThe event notification is deactivated and shall be muted. The available event(s) shall be stored.
RETRIEVALThe event notification shall be sent to the NF service consumer(s), after that, is muted again.
(See NOTE)
NOTE:
The value "RETRIEVAL" shall not be provided during the creating subscription procedure.
Up

5.4.3.38  Enumeration: TransportProtocol |R17|  p. 58

Enumeration value Description
"UDP"User Datagram Protocol
"TCP"Transmission Control Protocol

5.4.3.39  Enumeration: SatelliteBackhaulCategory |R17|  p. 58

Enumeration value Description
"GEO"Indicates Geostationary satellite backhaul category.
"MEO"Indicates Medium Earth Orbit satellite backhaul category.
"LEO"Indicates Low Earth Orbit satellite backhaul category.
"OTHER_SAT"Indicates other satellite backhaul category.
"DYNAMIC_GEO"Indicates dynamic Geostationary satellite backhaul category.
"DYNAMIC_MEO"Indicates dynamic Medium Earth Orbit satellite backhaul category.
"DYNAMIC_LEO"Indicates dynamic Low Earth Orbit satellite backhaul category.
"DYNAMIC_OTHER_SAT"Indicates dynamic other satellite backhaul category.
"NON_SATELLITE"Indicates non satellite backhaul. (NOTE)
NOTE:
This value indicates that there is no longer any satellite backhaul towards the 5G AN currently serving the UE.
Up

5.4.3.40  Enumeration: SatelliteBackhaulCategoryRm |R17|  p. 58

This data type is defined in the same way as the "SatelliteBackhaulCategory" data type, but with the OpenAPI "nullable: true" property.

5.4.3.41  Enumeration: BufferedNotificationsAction |R18|  p. 59

Enumeration value Description
"SEND_ALL"The NF Service Producer should send all the reports of the stored events to the NF service consumer.
"DISCARD_ALL"The NF Service Producer should discard all the reports of the stored events for the NF service consumer.
"DROP_OLD"The NF Service Producer should drop the old reports of the stored events for the NF service consumer when new event reports need to be stored.
Up

5.4.3.42  Enumeration: SubscriptionAction |R18|  p. 59

Enumeration value Description
"CLOSE"The subscription to the event notification should be terminated if an exception occurs at the NF Service Producer.
"CONTINUE_WITH_MUTING"The subscription to the event notification should be continued with muting if an exception occurs at the NF Service Producer.
"CONTINUE_WITHOUT_MUTING"The subscription to the event notification should be continued without muting if an exception occurs at the NF Service Producer.
Up

5.4.3.43  Enumeration: SnssaiStatus |R18|  p. 59

Enumeration value Description
"AVAILABLE"This value is used when the S-NSSAI becomes available.
"UNAVAILABLE"This value is used when the S-NSSAI becomes unavailable.

5.4.3.44  Enumeration: TerminationIndication |R18|  p. 59

Enumeration value Description
"NEW_UES_TERMINATION"It indicates that Network Slice Replacement is terminated for new UEs.
"ALL_UES_TERMINATION"It indicates that Network Slice Replacement is terminated for all UEs and PDU sessions shall move back from the alternative S-NSSAI to the S-NSSAI.
Up

5.4.3.45  Enumeration: DelayMeasurementProtocol |R19|  p. 60

Enumeration value Description
"TWAMP" A Two-Way Active Measurement Protocol (see RFC 5357)
"OWAMP" A One-way Active Measurement Protocol (see RFC 4656
"STAMP" Simple Two-Way Active Measurement Protocol (see RFC 8762)
"OTHER"Measurement protocol for which no specific value exists in this enumeration
Up

5.4.3.46  Enumeration: CagProvisionOperation |R19|  p. 60

Enumeration value Description
"ADD"To add/append the indicated CAG ID list to the previously configured CAG ID list (if any).
"REPLACE"To replace the previously configured CAG ID list (if any) with the newly provisioned CAG ID list.
"REMOVE"To remove the indicated CAG ID list from the previously configured CAG ID list.
Up

5.4.4  Structured Data Types  p. 60

5.4.4.1  Type: SubscribedDefaultQos  p. 60

Attribute name Data type P Cardina­lity Description
5qi5QiM1Default 5G QoS identifier; see clause 5.7.2.7 of TS 23.501.
arpArpM1Default Allocation and Retention Priority; see clause 5.7.2.7 of TS 23.501.
priorityLevel5QiPriorityLevelO0..1Defines the 5QI Priority Level.
When present, it contains the 5QI Priority Level value that overrides the standardized or pre-configured value as described in TS 23.501.
Up

5.4.4.2  Type: Snssai  p. 61

Attribute name Data type P Cardina­lity Description
sstintegerM1Integer, within the range 0 to 255, representing the Slice/Service Type. It indicates the expected Network Slice behaviour in terms of features and services.
Values 0 to 127 correspond to the standardized SST range. Values 128 to 255 correspond to the Operator-specific range. See clause 28.4.2 of TS 23.003.
Standardized values are defined in clause 5.15.2.2 of TS 23.501.
sdstringO0..1 3-octet string, representing the Slice Differentiator, in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the SD shall appear first in the string, and the character representing the 4 least significant bit of the SD shall appear last in the string.
This is an optional parameter that complements the Slice/Service type(s) to allow to differentiate amongst multiple Network Slices of the same Slice/Service type. This IE shall be absent if no SD value is associated with the SST.
Pattern: '^[A-Fa-f0-9]{6}$'
When Snssai needs to be converted to string (e.g. when used in maps as key), the string shall be composed of one to three digits "sst" optionally followed by "-" and 6 hexadecimal digits "sd", and shall match the following pattern:
^([0-9]|[1-9][0-9]|1[0-9][0-9]|2([0-4][0-9]|5[0-5]))(-[A-Fa-f0-9]{6})?$
Example 1: "255-19CDE0"
Example 2: "29"
Up

5.4.4.3  Type: PlmnId  p. 61

Attribute name Data type P Cardina­lity Description
mccMccM1Mobile Country Code
mncMncM1Mobile Network Code
When PlmnId needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc", and shall match the following pattern:
^[0-9]{3}-[0-9]{2,3}$
Example 1: "262-01"
Example 2: "302-720"
Up

5.4.4.4  Type: Tai  p. 62

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
tacTacM1Tracking Area Code
nidNidO0..1Network Identifier, shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the TA belongs to.
Up

5.4.4.5  Type: Ecgi  p. 62

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
eutraCellIdEutraCellIdM1E-UTRA Cell Identity
nidNidO0..1Network Identifier
Up

5.4.4.6  Type: Ncgi  p. 62

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
nrCellIdNrCellIdM1NR Cell Identity
nidNidC0..1Network Identifier, shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the NR cell belongs to.
Up

5.4.4.7  Type: UserLocation  p. 63

Attribute name Data type P Cardina­lity Description
eutraLocationEutraLocationC0..1E-UTRA user location (see NOTE).
nrLocationNrLocationC0..1NR user location (see NOTE).
n3gaLocationN3gaLocationC0..1Non-3GPP access user location (see NOTE).
utraLocationUtraLocationC0..1UTRAN access user location (see NOTE).
geraLocationGeraLocationC0..1GERAN access user location (see NOTE).
NOTE:
At least one of eutraLocation, nrLocation, n3gaLocation, utraLocation and geraLocation shall be present. Several of them may be present.
Up

5.4.4.8  Type: EutraLocation  p. 64

Attribute name Data type P Cardina­lity Description
taiTaiM1Tracking Area Identity.
The TAC of the TAI shall be set to one reserved value (e.g. 0x0000, see clause 19.4.2.3 of TS 23.003) if the TAI information is not available.
ignoreTaibooleanO0..1This flag when present shall indicate that the Tai shall be ignored.
    When present, it shall be set as follows:
  • true: tai shall be ignored.
  • false (default): tai shall not be ignored.
ecgiEcgiM1E-UTRA Cell Identity
ignoreEcgibooleanO0..1This flag when present shall indicate that the Ecgi shall be ignored.
When present, it shall be set as follows:
  • true: ecgi shall be ignored.
  • false (default): ecgi shall not be ignored.
ageOfLocationInformationintegerO0 1The value represents the elapsed time in minutes since the last network contact of the mobile station.
Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the eNB when the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See clause 17.7.8 of TS 29.002.
ueLocationTimestampDateTimeO0..1The value represents the UTC time when the UeLocation information was acquired.
geographicalInformationstringO0..1Refer to geographical Information.
See clause 7.3.2 of TS 23.032. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F;
geodeticInformationstringO0..1Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F.
globalNgenbIdGlobalRanNodeIdO0..1It indicates the global identity of the ng-eNodeB in which the UE is currently located.
See clause 9.3.1.8 of TS 38.413.
globalENbIdGlobalRanNodeIdO0..1It indicates the global identity of the eNodeB in which the UE is currently located.
See clause 9.2.1.37 of TS 36.413.
NOTE:
Either the "globalNgenbId" attribute or the "globalENbId" attribute shall be included in the "EutraLocation" data type.
Up

5.4.4.9  Type: NrLocation  p. 65

Attribute name Data type P Cardina­lity Description
taiTaiM1Tracking Area Identity
When NTN TAI Information with UE Location Derived TAC was received from satellite NG-RAN, this IE shall carry the value of the UE Location Derived TAC; if NTN TAI Information without UE Location Derived TAC was received, this IE shall carry the value of the first TAC that is not restricted to the UE, in the list of TAC(s) broadcast in the cell.
ncgiNcgiM1NR Cell Identity
ignoreNcgibooleanO0..1This flag when present shall indicate that the Ncgi shall be ignored.
When present, it shall be set as follows:
  • true: ncgi shall be ignored.
  • false (default): ncgi shall not be ignored.
ageOfLocationInformationintegerO0 1The value represents the elapsed time in minutes since the last network contact of the mobile station.
Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful NG-RAN location reporting procedure with the gNB when the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See clause 17.7.8 of TS 29.002.
ueLocationTimestampDateTimeO0..1The value represents the UTC time when the UeLocation information was acquired.
geographicalInformationstringO0..1Refer to geographical Information.
See clause 7.3.2 of TS 23.032. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F;
geodeticInformationstringO0..1Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F.
globalGnbIdGlobalRanNodeIdO0..1It indicates the global identity of the gNodeB in which the UE is currently located.
See clause 9.3.1.6 of TS 38.413.
ntnTaiInfoNtnTaiInfoO0..1Contains NR NTN TAI Information.
When this IE is present and supported, the tai attribute shall be ignored by the receiver, see clause 9.3.3.53 of TS 38.413.
Up

5.4.4.10  Type: N3gaLocation  p. 66

Attribute name Data type P Cardina­lity Description
n3gppTaiTaiC0..1This IE shall be present over the 3GPP PLMN internal interfaces, but it shall not be present over the N5 interface, nor on the N7/N40 interface in EPC interworking scenario. When present, it shall contain the TAI reported by the N3IWF, TNGF, TWIF or W-AGF for the non-3GPP access.
n3IwfIdstringC0..1 This IE shall contain the N3IWF identifier received over NGAP and shall be encoded as a string of hexadecimal characters. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The most significant character representing the 4 most significant bits of the N3IWF ID shall appear first in the string, and the character representing the 4 least significant bit of the N3IWF ID shall appear last in the string.
Pattern: '^[A-Fa-f0-9]+$'
Example:
The N3IWF Id 0x5BD6 shall be encoded as "5BD6".
It shall be present over the 3GPP PLMN internal interfaces if the UE is accessing the 5GC via an untrusted non-3GPP access, but shall not be present over the N5 interface, nor on the N7/N40 interface in EPC interworking scenario.
ueIpv4AddrIpv4AddrC0..1UE/N5CW device local IPv4 address (used to reach the N3IWF, TNGF or TWIF, or ePDG).
The ueIpv4Addr or the ueIpv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available.
ueIpv6AddrIpv6AddrC0..1UE/N5CW device local IPv6 address (used to reach the N3IWF, TNGF or TWIF, or ePDG).
The ueIpv4Addr or the ueIpv6Addr shall be present if the UE is accessing the 5GC via a trusted or untrusted non-3GPP access and the information is available.
portNumberUintegerC0..1UDP or TCP source port number. It shall be present if the UE/N5CW is accessing the 5GC via a trusted or untrusted non-3GPP access and NAT is detected and the information is available.
protocolTransportProtocolO0..1This IE may be present if portNumber is present.
When present, this IE shall indicate the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access and NAT is detected.
The absence of this IE indicates that the transport protocol used by the UE to access the core network via a trusted or untrusted non-3GPP access is not specified, i.e. could be UDP or TCP.
tnapIdTnapIdC0..1This IE shall contain the TNAP Identifier, see clause 5.6.2 of TS 23.501.
twapIdTwapIdC0..1In the scenario of accessing 5GC from N5CW device, this IE shall contain the TWAP Identifier, see clause 4.2.8.5.3 of TS 23.501.
In the scenario of interworking between ePDG/EPC and 5GS, this IE shall contain the WLAN location information, see clause 4.5.7.2.8 of TS 23.402.
hfcNodeIdHfcNodeIdC0..1This IE shall contain the HFC Node Identifier received over NGAP. It shall be present for a 5G-CRG/FN-CRG accessing the 5GC via wireline access network, and for a AUN3 device connected behind the 5G-CRG (see clause 7.2.8.1 of TS 23.316).
gliGliC0..1This IE shall contain the Global Line Identifier. It shall be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network, and for a AUN3 device connected behind a 5G-BRG.
w5gbanLineTypeLineTypeO0..1This IE may be present for a 5G-BRG/FN-BRG accessing the 5GC via wireline access network.
When present, it shall indicate the type of the wireline (DSL or PON).
gciGciC0..1This IE shall contain the Global Cable Identifier. It shall be present for the N5GC device accessing the 5GC via wireline access network(see clause 4.10a of TS 23.316), and for a AUN3 device connected behind the 5G-CRG (see clause 7.2.8.1 of TS 23.316).
Up

5.4.4.11  Type: UpSecurity  p. 68

Attribute name Data type P Cardina­lity Description
upIntegrUpIntegrityM1This IE shall indicate whether UP integrity protection is required, preferred or not needed for all the traffic on the PDU Session.
upConfidUpConfidentialityM1This IE shall indicate whether UP confidentiality protection is required, preferred or not needed for all the traffic on the PDU Session.
Up

5.4.4.12  Type: NgApCause  p. 68

Attribute name Data type P Cardina­lity Description
groupUintegerM1This IE shall indicate the group of the NGAP cause. The value of this IE shall equal to the ASN.1 value of the specified NGAP cause group.
NGAP supports following cause groups defined as separate enumerations, as specified in clause 9.4.5 of TS 38.413, with following values:
  • 0 radioNetwork
  • 1 transport
  • 2 nas
  • 3 protocol
  • 4 misc
valueUintegerM1This IE shall carry the NG AP cause value in specific cause group identified by the "group" attribute, as specified in clause 9.4.5 of TS 38.413.
Up

5.4.4.13  Type: BackupAmfInfo  p. 69

Attribute name Data type P Cardina­lity Description
backupAmfAmfNameM1This IE shall contain the AMF name of the backup AMF that can serve the specific GUAMI(s) supported by the primary AMF (see clause 5.21.2.3 of TS 23.501).
guamiListarray(Guami)C1..NIf present, this IE shall contain the list of GUAMI(s) (supported by the primary AMF) which the backup AMF can serve.
If this IE is absent, it indicates that the backup AMF can serve all the GUAMI(s) supported by the primary AMF.
Up

5.4.4.14  Type: RefToBinaryData  p. 69

Attribute name Data type P Cardina­lity Description
contentIdstringM1This IE shall contain the value of the Content-ID header of the referenced binary body part.
Up

5.4.4.15  Type RouteToLocation  p. 69

Attribute name Data type P Cardina­lity Description
dnaiDnaiM1Identifies the location of the application.
routeInfoRouteInformationC0..1Includes the traffic routing information.
routeProfIdstringC0..1Identifies the routing profile Id.
NOTE:
At least one of the "routeInfo" attribute and the "routeProfId" attribute shall be included in the "RouteToLocation" data type.
Up

5.4.4.16  Type RouteInformation  p. 69

Attribute name Data type P Cardina­lity Description
ipv4AddrIpv4AddrC0..1Ipv4address of the tunnel end point in the data network.
ipv6AddrIpv6AddrC0..1Ipv6 address of the tunnel end point in the data network.
portNumberUintegerM1UDP port number of the tunnel end point in the data network.
NOTE:
At least one of the "ipv4Addr" attribute and the "ipv6Addr" attribute shall be included in the "RouteInformation" data type.
Up

5.4.4.17  Type: Area  p. 70

Attribute name Data type P Cardina­lity Description
tacsarray(Tac)C1..NList of TACs; shall be present if and only if areaCode is absent.
areaCodeAreaCodeC0..1Area Code; shall be present if and only if tacs is absent.
Up

5.4.4.18  Type: ServiceAreaRestriction  p. 70

Attribute name Data type P Cardina­lity Description
restrictionTypeRestrictionTypeC0..1string "ALLOWED_AREAS" or "NOT_ALLOWED_AREAS" shall be present if and only if the areas attribute is present
areasarray(Area)O0..N (NOTE)A list of Areas.
These areas are:
  • allowed areas if RestrictionType is "ALLOWED_AREAS"
  • not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS"
maxNumOfTAsUintegerC0..1 Maximum number of allowed tracking areas for use when restrictionType indicates "ALLOWED_AREAS".
This attribute shall be absent when attribute "restrictionType" takes the value "NOT_ALLOWED_AREAS".
maxNumOfTAsForNotAllowedAreasUintegerC0..1 Maximum number of allowed tracking areas for use when restrictionType indicates "NOT_ALLOWED_AREAS".
This attribute shall be absent when attribute "restrictionType" takes the value "ALLOWED_AREAS".
NOTE:
The empty array is used when service is allowed/restricted nowhere.
Up

5.4.4.19  Type: PlmnIdRm  p. 70

This data type is defined in the same way as the "PlmnId" data type, but with the OpenAPI "nullable: true" property.

5.4.4.20  Type: TaiRm  p. 70

This data type is defined in the same way as the "Tai" data type, but with the OpenAPI "nullable: true" property.

5.4.4.21  Type: EcgiRm  p. 70

This data type is defined in the same way as the "Ecgi" data type, but with the OpenAPI "nullable: true" property.

5.4.4.22  Type: NcgiRm  p. 70

This data type is defined in the same way as the "Ncgi" data type, but with the OpenAPI "nullable: true" property.

5.4.4.23  Type: EutraLocationRm  p. 70

This data type is defined in the same way as the "EutraLocation" data type, but with the OpenAPI "nullable: true" property.

5.4.4.24  Type: NrLocationRm  p. 71

This data type is defined in the same way as the "NrLocation" data type, but with the OpenAPI "nullable: true" property.

5.4.4.25  Type: UpSecurityRm  p. 71

This data type is defined in the same way as the "UpSecurity" data type, but with the OpenAPI "nullable: true" property.

5.4.4.26  Type: RefToBinaryDataRm  p. 71

This data type is defined in the same way as the "RefToBinaryData" data type, but with the OpenAPI "nullable: true" property.

5.4.4.27  Type: PresenceInfo  p. 72

Attribute name Data type P Cardina­lity Description
praIdstringC0..1Represents an identifier of the Presence Reporting Area (see clause 28.10 of TS 23.003). This IE shall be present if the Area of Interest subscribed or reported is a Presence Reporting Area or a Set of Core Network predefined Presence Reporting Areas.
When present, it shall be encoded as a string representing an integer in the following ranges:
0 to 8 388 607 for UE-dedicated PRA
8 388 608 to 16 777 215 for Core Network predefined PRA.
Examples:
PRA ID 123 is encoded as "123"
PRA ID 11 238 660 is encoded as "11238660"
additionalPraIdstringC0..1This IE may be present if the praId IE is present and if it contains a PRA identifier referring to a set of Core Network predefined Presence Reporting Areas.
When present, this IE shall contain a PRA Identifier of an individual PRA within the Set of Core Network predefined Presence Reporting Areas indicated by the praId IE.
presenceStatePresenceStateC0..1Indicates whether the UE is inside or outside of the area of interest (e.g presence reporting area or the LADN area), or if the presence reporting area is inactive in the serving node. (NOTE)
trackingAreaListarray(Tai)C1..NRepresents the list of tracking areas that constitutes the area. This IE shall be present if the subscription or the event report is for tracking UE presence in the tracking areas. For non 3GPP access the TAI shall be the N3GPP TAI.
ecgiListarray(Ecgi)C1..NRepresents the list of EUTRAN cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of EUTRAN cell Ids.
ncgiListarray(Ncgi)C1..NRepresents the list of NR cell Ids that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NR cell Ids.
globalRanNodeIdListarray(GlobalRanNodeId)C1..NRepresents the list of NG RAN node identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of NG RAN node identifiers.
globaleNbIdListarray(GlobalRanNodeId)C1..NRepresents the list of eNodeB identifiers that constitutes the area. This IE shall be present if the Area of Interest subscribed is a list of eNodeB identifiers.
NOTE:
If the additionalPraId IE is present, this IE shall state the presence information of the UE for the individual PRA identified by the additionalPraId IE; If the additionalPraId IE is not present, this IE shall state the presence information of the UE for the PRA identified by the praId IE.
Up

5.4.4.28  Type: GlobalRanNodeId  p. 73

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1Indicates the identity of the PLMN that the RAN node belongs to.
n3IwfIdN3IwfIdC0..1This IE shall be included if the AN node represents a N3IWF. When present, this IE shall contain the identifier of the N3IWF.
(NOTE 1).
gNbIdGNbIdC0..1This IE shall be included if the RAN Node Id represents a gNB. When present, this IE shall contain the identifier of the gNB. (NOTE 1).
ngeNbIdNgeNbIdC0..1This IE shall be included if the RAN Node Id represents a NG-eNB. When present, this IE shall contain the identifier of an NG-eNB.
(NOTE 1).
wagfIdWAgfIdC0..1This IE shall be included if the AN node represents a W-AGF. When present, this IE shall contain the identifier of the W-AGF.
(NOTE 1).
tngfIdTngfIdC0..1This IE shall be included if the AN node represents a TNGF. When present, this IE shall contain the identifier of the TNGF.
(NOTE 1).
nidNidO0..1Network Identifier shall be present in case of SNPN, PlmnId together with Nid indicates the identity of the SNPN to which the RanNode belongs to.
eNbIdENbIdC0..1This IE shall be included if the RAN Node Id represents an eNB. When present, this IE shall contain the identifier of an eNB.
(NOTE 1, NOTE 2).
NOTE 1:
One of the six attributes n3IwfId, gNbIdm, ngeNbId, wagfId, tngfId, eNbId shall be present.
NOTE 2:
For UEs with 5GS subscription but without 5G NAS support, eNbId is used on N7 instead of n3IwfId, gNbIdm, ngeNbId.
Up

5.4.4.29  Type: GNbId  p. 74

Attribute name Data type P Cardina­lity Description
bitLengthintegerM1Unsigned integer representing the bit length of the gNB ID as defined in clause 9.3.1.6 of TS 38.413, within the range 22 to 32
gNBValuestringM1This represents the identifier of the gNB.
The string shall be formatted with following pattern:
'^[A-Fa-f0-9]{6,8}$'
The value of the gNB ID shall be encoded in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and shall represent 4 bits. The padding 0 shall be added to make multiple nibbles, the most significant character representing the padding 0 if required together with the 4 most significant bits of the gNB ID shall appear first in the string, and the character representing the 4 least significant bit of the gNB ID shall appear last in the string.
Examples:
A 30 bit value "382A3F47" indicates a gNB ID with value 0x382A3F47
A 22 bit value "2A3F47" indicates a gNB ID with value 0x2A3F47
Up

5.4.4.30  Type: PresenceInfoRm  p. 74

This data type is defined in the same way as the "PresenceInfo" data type, but with the OpenAPI "nullable: true" property.

5.4.4.31  Void

5.4.4.32  Type: AtsssCapability |R16|  p. 75

Attribute name Data type P Cardina­lity Description
atsssLLbooleanO0..1 Indicates the support of Access Traffic Steering, Switching and Splitting procedures using the ATSSS-LL steering functionality (see clauses 4.2.10, 5.32 of TS 23.501).
true: Supported
false (default): Not Supported
mptcpbooleanO0..1 Indicates the support of Access Traffic Steering, Switching and Splitting procedures using the MPTCP steering functionality (see clauses 4.2.10, 5.32 of TS 23.501).
true: Supported
false (default): Not Supported
mpquicbooleanO0..1 Indicates the support of Access Traffic Steering, Switching and Splitting procedures using the MPQUIC-UDP steering functionality (see clauses 4.2.10, 5.32 of TS 23.501).
true: Supported
false (default): Not Supported
rttWithoutPmfbooleanO0..1 This IE is only used by the UPF to indicate whether the UPF supports RTT measurement without PMF (see clauses 5.32.2, 6.3.3.3 of TS 23.501).
If this attribute is present and set to true, the mptcp attribute shall also be present and set to true.
true: Supported
false (default): Not Supported.
mpquicIpbooleanO0..1 Indicates the support of Access Traffic Steering, Switching and Splitting procedures using the MPQUIC-IP steering functionality (see clauses 4.2.10, 5.32 of TS 23.501).
true: Supported
false (default): Not Supported
mpquicEbooleanO0..1 Indicates the support of Access Traffic Steering, Switching and Splitting procedures using the MPQUIC-E steering functionality (see clauses 4.2.10, 5.32 of TS 23.501).
true: Supported
false (default): Not Supported
Up

5.4.4.33  Type: PlmnIdNid |R16|  p. 75

Attribute name Data type P Cardina­lity Description
mccMccM1Mobile Country Code
mncMncM1Mobile Network Code
nidNidC0..1 Network Identity; Shall be present if PlmnIdNid identifies an SNPN (see clauses 5.30.2.3, 5.30.2.9, 6.3.4, and 6.3.8 in TS 23.501). Otherwise, this attribute shall be absent.
When PlmnIdNid needs to be converted to string (e.g. when used in maps as key), the string shall be composed of three digits "mcc" followed by "-" and two or three digits "mnc" followed by "-" and 11 digits "nid", and shall match the following pattern:
^[0-9]{3}-[0-9]{2,3}-[A-Fa-f0-9]{11}$
Example 1: "262-01-000007ed9d5"
Example 2: "302-720-000007ed9d5"
Up

5.4.4.34  Type: PlmnIdNidRm |R16|  p. 76

This data type is defined in the same way as the "PlmnIdNid" data type, but with the OpenAPI "nullable: true" property.

5.4.4.35  Type: SmallDataRateStatus |R16|  p. 76

Attribute name Data type P Cardina­lity Description
remainPacketsUlintegerC0..1This IE shall be included if available.
When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of TS 23.501).
remainPacketsDlintegerC0..1This IE shall be included if available.
When present it shall contain the number of packets the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 of TS 23.501).
validityTimeDateTimeC0..1This IE shall be included if available.
When present, it shall indicate the period of time during which the small data rate control status will remain valid (see clause 5.31.14.3 of TS 23.501).
remainExReportsUlintegerC0..1This IE shall be included if available.
When present, it shall indicate number of additional exception reports the UE is allowed to send uplink in the given time unit for the given PDU session (see clause 5.31.14.3 of TS 23.501).
remainExReportsDlintegerC0..1This IE shall be included if available.
When present, it shall indicate number of additional exception reports the AF is allowed to send downlink in the given time unit for the given PDU session (see clause 5.31.14.3 in TS 23.501).
Up

5.4.4.36  Type: HfcNodeId |R16|  p. 76

Attribute name Data type P Cardina­lity Description Applica­bility
hfcNIdHfcNIdM1HFC Node Id.
Up

5.4.4.37  Type: HfcNodeIdRm |R16|  p. 76

This data type is defined in the same way as the "HfcNodeId" data type, but with the OpenAPI "nullable: true" property.

5.4.4.38  Type: WirelineArea |R16|  p. 77

Attribute name Data type P Cardina­lity Description Applica­bility
globalLineIdsarray(Gli)C1..NList of Global Line Identifiers, for a 5G-BRG or an AUN3 device behind 5G-BRG accessing the 5GC via wireline access network.
hfcNIdsarray(HfcNId)C1..NList of HFC Node Ids, for a 5G-CRG/FN-CRG is accessing the 5GC via wireline access network.
areaCodeBAreaCodeC0..1Area Code for 5G-BRG or an AUN3 device behind 5G-BRG accessing via wireline access network
areaCodeCAreaCodeC0..1Area Code for 5G-CRG/FN-CRG is accessing via wireline access network
combGciAndHfcNIdsarray(CombGciAndHfcNIds)C1..NList of combinations of GCI and HFC Node ID, for a 5G-CRG or an AUN3 device behind the 5G-CRG accessing the 5GC via wireline access network.
NOTE:
One and only one of the "globLineIds", "hfcNIds", "areaCodeB", "areaCodeC" and combGciAndHfcNIds attributes shall be included in a WirelineArea data structure.
Up

5.4.4.39  Type: WirelineServiceAreaRestriction |R16|  p. 77

Attribute name Data type P Cardina­lity Description
restrictionTypeRestrictionTypeC0..1string
"ALLOWED_AREAS" or
"NOT_ALLOWED_AREAS"
(NOTE 1)
areasarray(WirelineArea)C0..NA list of Areas.
These areas are:
  • allowed areas if RestrictionType is "ALLOWED_AREAS"
  • not allowed areas if RestrictionType is "NOT_ALLOWED_AREAS"
(NOTE 1) (NOTE 2)
NOTE 1:
The "restrictionType" attribute and the "areas" attribute shall be either both present or absent.
NOTE 2:
The empty array is used when service is allowed/restricted nowhere.
Up

5.4.4.40  Type: ApnRateStatus |R16|  p. 78

Attribute name Data type P Cardina­lity Description
remainPacketsUlintegerC0..1This IE shall be included if available.
When present, it shall contain the number of packets the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN see clause 4.7.7.3 in TS 23.401).
remainPacketsDlintegerC0..1This IE shall be included if available.
When present, it shall contain the number of packets, which the UE is allowed to send downlink for the given time unit period of time and for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in TS 23.401).
validityTimeDateTimeC0..1This IE shall be included if available.
When present, it shall indicate the period of time during which the APN rate control status will remain valid.
remainExReportsUlintegerC0..1This IE shall be included if available.
When present, it shall indicate the number of additional exception reports the UE is allowed to send uplink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in TS 23.401).
remainExReportsDlintegerC0..1This IE shall be included if available.
When present, it shall indicate the number of additional exception reports the AF is allowed to send downlink in the given time unit for the given APN (all PDN connections of the UE to this APN, see clause 4.7.7.3 in TS 23.401).
Up

5.4.4.41  Type: ScheduledCommunicationTime |R16|  p. 78

Attribute name Data type P Cardina­lity Description
daysOfWeekarray(DayOfWeek)O1..6Identifies the day(s) of the week. If absent, it indicates every day of the week.
timeOfDayStartTimeOfDayO0..1Identifies the start time of the day.
timeOfDayEndTimeOfDayO0..1Identifies the end time of the day.
Up

5.4.4.42  Type: ScheduledCommunicationTimeRm |R16|  p. 78

This data type is defined in the same way as the "ScheduledCommunicationTime" data type, but with the OpenAPI "nullable: true" property.

5.4.4.43  Type: BatteryIndication |R16|  p. 79

Attribute name Data type P Cardina­lity Description
batteryIndbooleanO0..1When present, this IE shall indicate whether the UE is battery powered or not.
true: the UE is battery powered;
false or absent: the UE is not battery powered.
replaceableIndbooleanO0..1When present, this IE shall indicate whether the battery of the UE is replaceable or not.
true: the battery of the UE is replaceable;
false or absent: the battery of the UE is not replaceable.
rechargeableIndbooleanO0..1When present, this IE shall indicate whether the battery of the UE is rechargeable or not.
true: the battery of UE is rechargeable;
false or absent: the battery of the UE is not rechargeable.
NOTE:
Parameters "replaceableInd" and "rechargeableInd" are only included if the value of Parameter "batteryInd" is true.
Up

5.4.4.44  Type: BatteryIndicationRm |R16|  p. 79

This data type is defined in the same way as the "BatteryIndication" data type, but with the OpenAPI "nullable: true" property.

5.4.4.45  Type: AcsInfo |R16|  p. 79

Attribute name Data type P Cardina­lity Description
acsUrlUriO0..1 This IE may contain the URL of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE)
acsIpv4AddrIpv4AddrO0..1 This IE may contain the IPv4 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE)
acsIpv6AddrIpv6AddrO0..1 This IE may contain the IPv6 address of the ACS, see BBF TR-069 [34] or BBF TR-369 [35].
(NOTE)
NOTE:
At least one of acsUrl, acsIpv4Addr, acsIpv6Addr shall be included.
Up

5.4.4.46  Type: AcsInfoRm |R16|  p. 79

This data type is defined in the same way as the "AcsInfo" data type, but with the OpenAPI "nullable: true" property.

5.4.4.47  Type: NrV2xAuth |R16|  p. 79

Attribute name Data type P Cardina­lity Description
vehicleUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE.
pedestrianUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE.
Up

5.4.4.48  Type: LteV2xAuth |R16|  p. 80

Attribute name Data type P Cardina­lity Description
vehicleUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Vehicle UE.
pedestrianUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as Pedestrian UE.
Up

5.4.4.49  Type: Pc5QoSPara |R16|  p. 80

Attribute name Data type P Cardina­lity Description
pc5QosFlowListarray(Pc5QosFlowItem)M1..NThis IE shall contain the set of PC5 flow(s).
pc5LinkAmbrBitRateC0..1This IE shall be present if available. When present, it shall represent the PC5 Link Aggregated Bit Rates for all the Non-GBR QoS Flows (see clause 5.4.2.3 of TS 23.287).
Up

5.4.4.50  Type: Pc5QosFlowItem |R16|  p. 80

Attribute name Data type P Cardina­lity Description
pqi5QiM1PQI is a special 5QI (see clause 5.4.2.1 of TS 23.287).
pc5FlowBitRatesPc5FlowBitRatesC0..1This IE shall be present if available. When present, it shall represent the PC5 Flow Bit Rates (see clause 5.4.2.2 of TS 23.287).
rangeUintegerC0..1This IE shall be present if available. When present, it shall represent the Range in the unit of meters (see clause 5.4.2.4 of TS 23.287).
Up

5.4.4.51  Type: Pc5FlowBitRates |R16|  p. 80

Attribute name Data type P Cardina­lity Description
guaFbrBitRateC0..1This IE shall be present if available. When present, it shall contain the guaranteed Bit Rate for the PC5 QoS flow.
maxFbrBitRateC0..1This IE shall be present if available. When present, it shall contain the maximum Bit Rate for the PC5 QoS flow.
Up

5.4.4.52  Type: UtraLocation |R16|  p. 81

Attribute name Data type P Cardina­lity Description
cgiCellGlobalIdO0..1Cell Global Identification. See clause 4.3.1 of TS 23.003
(NOTE 1)
saiServiceAreaIdO0..1Service Area Identifier. See clause 12.5 of TS 23.003
(NOTE 1)
laiLocationAreaIdO0..1Location area identification. See clause 4.1 of TS 23.003
(NOTE 1)
raiRoutingAreaIdO0..1Routing Area Identification. See clause 4.2 of TS 23.003
ageOfLocationInformationintegerO0..1The value represents the elapsed time in minutes since the last network contact of the mobile station.
Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See clause 17.7.8 of TS 29.002.
ueLocationTimestampDateTimeO0..1The value represents the UTC time when the UeLocation information was acquired.
geographicalInformationstringO0..1Refer to geographical Information.
See clause 7.3.2 of TS 23.032. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F;
geodeticInformationstringO0..1Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F.
NOTE 1:
Exactly one of cgi, sai or lai shall be present.
Up

5.4.4.53  Type: GeraLocation |R16|  p. 82

Attribute name Data type P Cardina­lity Description
locationNumberstringO0..1Location number within the PLMN. See clause 4.5 of TS 23.003.
cgiCellGlobalIdO0..1Cell Global Identification. See clause 4.3.1 of TS 23.003
(NOTE 1)
saiServiceAreaIdO0..1Service Area Identifier. See clause 12.5 of TS 23.003
(NOTE 1)
laiLocationAreaIdO0..1Location Area identification. See clause 4.1 of TS 23.003
(NOTE 1)
raiRoutingAreaIdO0..1Routing Area Identification. See clause 4.2 of TS 23.003
vlrNumberstringO0..1VLR number. See clause 5.1 of TS 23.003.
mscNumberstringO0..1MSC number. See clause 5.1 of TS 23.003.
ageOfLocationInformationintegerO0..1The value represents the elapsed time in minutes since the last network contact of the mobile station.
Value "0" indicates that the location information was obtained after a successful paging procedure for Active Location Retrieval when the UE is in idle mode or after a successful location reporting procedure the UE is in connected mode.
Any other value than "0" indicates that the location information is the last known one.
See clause 17.7.8 of TS 29.002.
ueLocationTimestampDateTimeO0..1The value represents the UTC time when the UeLocation information was acquired.
geographicalInformationstringO0..1Refer to geographical Information.
See clause 7.3.2 of TS 23.032. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F;
geodeticInformationstringO0..1Refers to Calling Geodetic Location.
See ITU-T Recommendation Q.763 (1999) [24] clause 3.88.2. Only the description of an ellipsoid point with uncertainty circle is allowed to be used.
Allowed characters are 0-9 and A-F.
NOTE 1:
Exactly one of cgi, sai or lai shall be present.
Up

5.4.4.54  Type: CellGlobalId |R16|  p. 82

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
lacstringM1Location Area Code
Pattern: '^[A-Fa-f0-9]{4}$'
cellIdstringM1Cell Identity
Pattern: '^[A-Fa-f0-9]{4}$'
Up

5.4.4.55  Type: ServiceAreaId |R16|  p. 83

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
lacstringM1Location Area Code
Pattern: '^[A-Fa-f0-9]{4}$'
sacstringM1Service Area Code
Pattern: '^[A-Fa-f0-9]{4}$'
Up

5.4.4.56  Type: LocationAreaId |R16|  p. 83

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
lacstringM1Location Area Code
Pattern: '^[A-Fa-f0-9]{4}$'
Up

5.4.4.57  Type: RoutingAreaId |R16|  p. 83

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdM1PLMN Identity
lacstringM1Location Area Code Pattern: '^[A-Fa-f0-9]{4}$'
racstringM1Routing Area Code Pattern: '^[A-Fa-f0-9]{2}$'
Up

5.4.4.58  Type: DddTrafficDescriptor |R16|  p. 83

Attribute name Data type P Cardina­lity Description
ipv4AddrIpv4AddrC0..1Ipv4 address of the source of downlink data.
ipv6AddrIpv6AddrC0..1Ipv6 address of the source of downlink data.
portNumberUintegerO0..1Port number of the source of downlink data.
macAddrMacAddr48C0..1Source MAC address.
NOTE:
Either IP address (at least one of the "ipv4Addr" attribute or the "ipv6Addr" attribute) or MAC address (the "macAddr" attribute) shall be included.
Up

5.4.4.59  Type: MoExpDataCounter |R16|  p. 83

Attribute name Data type P Cardina­lity Description
counterintegerM1Unsigned integer identifying the MO Exception Data Counter, as specified in clause 5.31.14.3 of TS 23.501.
timeStampDateTimeO0..1UTC time indicating the time at which the counter value increased from 0 to 1.
Up

5.4.4.60  Type: NssaaStatus |R16|  p. 84

Attribute name Data type P Cardina­lity Description
snssaiSnssaiM1Subscribed S-NSSAI
statusAuthStatusM1This flag when present shall indicate the NSSAA status of the related Snssai.
Up

5.4.4.61  Type: NssaaStatusRm |R16|  p. 84

This data type is defined in the same way as the "NssaaStatus" data type, but with the OpenAPI "nullable: true" property.

5.4.4.62  Type: TnapId |R16|  p. 84

Attribute name Data type P Cardina­lity Description
ssIdstringC0..1This IE shall be present if the UE is accessing the 5GC via a trusted WLAN access network.
When present, it shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].
bssIdstringC0..1This IE shall be present if available and if the UE is accessing the 5GC via a trusted WLAN access network.
When present, it shall contain the BSSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].
civicAddressBytesC0..1This IE shall be present if available and if the UE is accessing the 5GC via a trusted WLAN access network.
This IE shall also be present if the UE behind the 5G-RG is accessing the 5GC via a trusted WLAN access network.
When present, it shall contain the civic address information of the TNAP/5G-RG to which the UE is attached, including the Location-Information Attribute and / or Location-Data Attribute as defined in RFC 5580.
Up

5.4.4.63  Type: TnapIdRm |R16|  p. 84

This data type is defined in the same way as the "TnapId" data type, but with the OpenAPI "nullable: true" property.

5.4.4.64  Type: TwapId |R16|  p. 85

Attribute name Data type P Cardina­lity Description
ssIdstringM1 This IE shall contain the SSID of the access point to which the UE is attached, that is received over NGAP, see IEEE Std 802.11-2012 [31].
bssIdstringC0..1 This IE shall be present if available.
When present, it shall contain the BSSID of the access point to which the UE is attached, for trusted WLAN access, see IEEE Std 802.11-2012 [31].
civicAddressBytesC0..1 This IE shall be present if available.
When present, it shall contain the civic address information of the TWAP to which the UE is attached, for trusted WLAN access. This IE shall include the Location-Information Attribute and / or Location-Data Attribute as defined in RFC 5580.
Up

5.4.4.65  Type: TwapIdRm |R16|  p. 85

This data type is defined in the same way as the "TwapId" data type, but with the OpenAPI "nullable: true" property.

5.4.4.66  Type: SnssaiExtension |R16|  p. 85

Attribute name Data type P Cardina­lity Description
sdRangesarray(SdRange)C1..NWhen 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 (see clause 5.4.4.2).
wildcardSdbooleanC0..1When 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 (see clause 5.4.4.2).
NOTE 1:
sdRanges and wildcardSd shall not be present simultaneously.
NOTE 2:
An SdRange may include the value "FFFFFF"; similarly, if wildcardSd is set to true, the SD value "FFFFFF" is one of the supported values. In both cases the SST without associated SD is one of the supported SNSSAIs, as the value "FFFFFF" indicates "no SD value associated with the SST" (see TS 23.003).
Up

5.4.4.67  Type: SdRange |R16|  p. 85

Attribute name Data type P Cardina­lity Description
startstringM1First value identifying the start of an SD range.
This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.
endstringM1Last value identifying the end of an SD range.
This string shall be formatted as specified for the sd attribute of the Snssai data type in clause 5.4.4.2.
EXAMPLE:
SD range from 023400 to 023499 (hexadecimal)
JSON: { "start": "023400", "end": "023499" }
Up

5.4.4.68  Type: ProseServiceAuth |R17|  p. 87

Attribute name Data type P Cardina­lity Description
proseDirectDiscoveryAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Discovery.
proseDirectCommunicationAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use ProSe Direct Communication.
proseL2RelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 UE-to-Network Relay.
proseL3RelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-Network Relay.
proseL2RemoteAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 Remote UE.
proseL3RemoteAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 Remote UE.
proseMultipathComL2RemoteAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to use multi-path communication via direct Uu path and via 5G ProSe Layer-2 UE-to-Network Relay as a 5G ProSe Layer-2 Remote UE.
proseL2UeRelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 UE-to-UE Relay.
proseL3UeRelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-UE Relay.
proseL2EndAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 End UE.
proseL3EndAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 End UE.
proseL3IntermediateRelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 Intermediate UE-to-Network Relay.
proseL3RemoteMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 Remote UE supporting Multi-hop 5G ProSe Layer-3 UE-to-Network Relay.
proseL3RelayMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-Network Relay supporting Multi-hop 5G ProSe Layer-3 UE-to-Network Relay.
proseL3UeRelayMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 UE-to-UE Relay supporting Multi-hop 5G ProSe Layer-3 UE-to-UE Relay.
proseL3EndMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-3 End UE supporting Multi-hop 5G ProSe Layer-3 UE-to-UE Relay.
proseL2IntermediateRelayAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 Intermediate UE-to-Network Relay.
proseL2RemoteMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 Remote UE supporting Multi-hop 5G ProSe Layer-2 UE-to-Network Relay.
proseL2RelayMultihopAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as 5G ProSe Layer-2 UE-to-Network Relay supporting Multi-hop 5G ProSe Layer-2 UE-to-Network Relay.
Up

5.4.4.69  Type: EcsServerAddr |R17|  p. 89

Attribute name Data type P Cardina­lity Description
ecsFqdnListarray(Fqdn)C1..NThis IE shall be included if available.
When present, it shall contain the list of FQDN(s) of Edge Configuration Server(s).
ecsIpAddressListarray(IpAddr)C1..NThis IE shall be included if available.
When present, it shall contain the list of IP Address (es) of Edge Configuration Server(s).
ecsUriListarray(Uri)C1..NThis IE shall be included if available.
When present, it shall contain the list of URI(s) of the Edge Configuration Server(s).
ecsProviderIdstringC0..1This IE shall be included if available.
When present, it shall contain the identifier of the Edge Configuration Server Provider.
Up

5.4.4.70  Type: EcsServerAddrRm |R17|  p. 89

This data type is defined in the same way as the "EcsServerAddr" data type, but with the OpenAPI "nullable: true" property.

5.4.4.71  Type: IpAddr |R17|  p. 89

Attribute name Data type P Cardina­lity Description
ipv4AddrIpv4AddrC0..1When present, it shall contain the IPv4 address.
ipv6AddrIpv6AddrC0..1When present, it shall contain the IPv6 address.
ipv6PrefixIpv6PrefixC0..1When present, it shall contain the IPv6 Prefix.
NOTE:
Either ipv4Addr, or ipv6Addr, or ipv6Prefix shall be present.
Up

5.4.4.72  Type: SACInfo |R17|  p. 90

Attribute name Data type P Cardina­lity Description
numericValNumUesintegerC0..1This attribute may be present in the following cases:
  • to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;
  • to report the network slice status for the current number of registered UEs.
When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of registered UEs expressed in a numerical value.
When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.
For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was previously configured in the form of a numerical value, this attribute shall contain the current number of registered UEs in the concerned network slice expressed in a numerical value.
numericValNumPduSessintegerC0..1This attribute may be present in the following cases:
  • to configure the monitoring threshold for the reporting of the number established PDU session for a network slice identified by an S-NSSAI;
  • to report the network slide status for the number of established PDU sessions.
When used to configure the monitoring threshold for an S-NSSAI, it shall contain the configured event monitoring threshold value for monitoring the number of established PDU sessions expressed in a numerical value.
When used to report the network slice status for an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.
For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured in the form of a numerical value,, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed in a numerical value.
percValueNumUesintegerC0..1This attribute may be present in the following cases:
  • to configure the monitoring threshold for the reporting of the number of registered UEs for a network slice identified by an S-NSSAI;
  • to report the network slice status for the number of registered UEs .
When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of registered UEs expressed in percentage format.
When used to report the network slice status for an S-NSSAI, it shall contain the current number of registered UEs in the concerned network slice expressed as a percentage. For threshold based reporting and the threshold value for the number of registered UEs in the concerned network slice was previously configured as a percentage, this attribute shall contain the current number of registered UEs in the concerned network slice expressed as a percentage.
Minimum = 0. Maximum = 100.
percValueNumPduSessintegerC0..1This IE may be present in the following cases:
  • to configure the monitoring threshold for the reporting of the number of established PDU sessions for a network slice identified by an S-NSSAI;
  • to report the network slice status for the number of established PDU sessions.
When used to configure the monitoring threshold for an S-NSSAI, it shall contain an unsigned integer indicating the event monitoring threshold value for the number of established PDU sessions expressed in percentage format.
When used to report the status of an S-NSSAI, it shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.
For threshold based reporting and the threshold value for the number of established PDU sessions in the concerned network slice was previously configured as a percentage, this attribute shall contain the current number of established PDU sessions in the concerned network slice expressed as a percentage.
Minimum = 0. Maximum = 100.
uesWithPduSessionIndbooleanC0..1This IE may be present if the numericValNumUes IE or the percValueNumUes IE is present, when reporting the network slice status for an S-NSSAI.
When present, it shall be set as follows:
  • True: the numericValNumUes and percValueNumUes report the number of UEs with at least one PDU session/PDN connection.
  • False (default): the numericValNumUes and percValueNumUes report the current number of registered UEs.
Up

5.4.4.73  Type: SACEventStatus |R17|  p. 93

Attribute name Data type P Cardina­lity Description
reachedNumUesSACInfoO0..1Contains a confirmation that the requested threshold for the number of registered UEs in the concerned network slice was reached, when threshold based reporting is used, or the current number of registered UEs in the concerned network slice, when periodic reporting / immediate reporting is used.
reachedNumPduSessSACInfoO0..1Contains a confirmation that the requested threshold for the number of established PDU session in the concerned network slice was reached, when threshold based reporting is used, or the current number of established PDU sessions in the concerned network slice, when periodic reporting / immediate reporting is used.
Up

5.4.4.74  Type: SpatialValidityCond |R17|  p. 93

Attribute name Data type P Cardina­lity Description
trackingAreaListarray(Tai)C1..NThis IE shall be included if available.
When present, it shall contain the list of tracking areas identities.
countriesarray(Mcc)O1..NWhen present, it shall contain the list of Mobile Country Codes.
geographicalServiceAreaGeoServiceAreaO0..1Geographical Service Area; see clause 7.3.3.3 of TS 23.558.
Up

5.4.4.75  Type: SpatialValidityCondRm |R17|  p. 93

This data type is defined in the same way as the "SpatialValidityCond" data type, but with the OpenAPI "nullable: true" property.

5.4.4.76  Type: ServerAddressingInfo |R17|  p. 93

Table 5.4.4.76 -1: Definition of type ServerAddressingInfo
Attribute name Data type P Cardina­lity Description
ipv4Addressesarray(Ipv4Addr)C1..NIPv4 address(es) of the server (NOTE).
ipv6Addressesarray(Ipv6Addr)C1..NIPv6 address(es) of the server (NOTE).
fqdnListarray(Fqdn)C1..NList of FQDNs (Fully Qualified Domain Names) of the server (NOTE).
NOTE:
At least one of the addressing parameters (ipv4addresses, ipv6adresses or fqdnList) shall be included in the ServerAddressingInfo; all addressing parameters in this data type shall be understood as referring to a same sever.
Up

5.4.4.77  Type PcfUeCallbackInfo |R17|  p. 94

Attribute name Data type P Cardina­lity Description Applica­bility
callbackUriUriM1This IE shall contain the Callback URI on the PCF for a UE to receive the SM Policy Association Establishment and Termination Event Notifications from the PCF for a PDU session.
bindingInfostringO0..1This IE shall be present, if available. When present, this IE shall contain the Binding indications of the Callback URI on the PCF for a UE indicated by callbackUri IE and set to the value of the 3gpp-Sbi-Binding header defined in clause 5.2.3.2.6 of TS 29.500, without the header name.
Up

5.4.4.78  Type PduSessionInfo |R17|  p. 94

Attribute name Data type P Cardina­lity Description Applica­bility
snssaiSnssaiM1This IE shall indicate the S-NSSAI in the serving PLMN of a PDU session.
dnnDnnM1This IE shall Indicate the DNN of a PDU session.
If DNN replacement if applicable for the PDU session, this IE shall indicate the DNN of the PDU session after DNN replacement.
Up

5.4.4.79  Type EasIpReplacementInfo |R17|  p. 94

Attribute name Data type P Cardina­lity Description Applica­bility
sourceEasServerAddressM1Address of the source EAS, i.e., address that shall be used for the traffic on the N3 side of the UPF(s).
targetEasServerAddressM1Address of the target EAS, i.e., address that shall be used for the traffic on the N6 side of the UPF(s).
Up

5.4.4.80  Type EasServerAddress |R17|  p. 94

Attribute name Data type P Cardina­lity Description Applica­bility
ipIpAddrM1IP address information.
portUintegerM1IP port number.
Up

5.4.4.81  Type RoamingRestrictions |R17|  p. 95

Attribute name Data type P Cardina­lity Description Applica­bility
accessAllowedbooleanC0..1Indicates if access is allowed to a given serving network, e.g. a PLMN (MCC, MNC) or an SNPN (MCC, MNC, NID). NOTE
NOTE:
The actual query determines if the 'accessAllowed' attribute refers to an SNPN or to a PLMN.
Up

5.4.4.82  Type: GeoServiceArea |R17|  p. 95

Attribute name Data type P Cardina­lity Description
geographicAreaListarray(GeographicArea)O1..NIdentifies a list of geographic area specified by different shapes.
civicAddressListarray(CivicAddress)O1..NIdentifies a list of civic address.
Up

5.4.4.83  Type: MutingExceptionInstructions |R18|  p. 95

Attribute name Data type P Cardina­lity Description
bufferedNotifsBufferedNotificationsActionO0..1When present, it shall indicate the action required by the NF Service Consumer to the NF Service Producer on the buffered notifications if an exception occurs while the event is muted.
subscriptionSubscriptionActionO0..1When present, it shall indicate the action required by the NF Service Consumer to the NF Service Producer on the subscription if an exception occurs while the event is muted.
Up

5.4.4.84  Type: MutingNotificationsSettings |R18|  p. 95

Attribute name Data type P Cardina­lity Description
maxNoOfNotifintegerO0..1Maximum number of notifications that can be stored by the Event producer NF.
durationBufferedNotifDurationSecO0..1Maximum duration during which notifications can be buffered by the Event producer NF.
Up

5.4.4.85  Type: VplmnOffloadingInfo |R18|  p. 96

Attribute name Data type P Cardina­lity Description
offloadIdentifierOffloadIdentifierO0..1Offload Identifier uniquely identifying the VPLMN Offloading information provided by the HPLMN.
vplmnIdPlmnIdO0..1V-PLMN ID. When absent, the PLMN ID of the PLMN serving the UE shall be assumed.
allowedTrafficbooleanO0..1When present, this IE shall be set as follows:
  • true (default): the VplmnOffloadingInfo describes the traffic allowed to be offloaded
  • false: the VplmnOffloadingInfo describes the traffic disallowed to be offloaded
ipv4AddressRangesarray(Ipv4AddressRange)O1..NList of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN
ipv4AddrMasksarray(Ipv4AddrMask)O1..NList of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN, whereby each range of IPv4 addresses corresponds to the IPv4 addresses of an IPv4 subnet defined by an IPv4 address and subnet mask.
ipv6AddressRangesarray(Ipv6AddressRange)O1..NList of ranges of IPv6 addresses allowed (or disallowed) to be routed to the local part of DN in the VPLMN
ipv6PrefixRangesarray(Ipv6PrefixRange)O1..NList of ranges of IPv6 prefixes allowed (or disallowed) to be routed to the local part of DN in the VPLMN
fqdnListarray(Fqdn)O1..NList of FQDNs allowed (or disallowed) to be routed to the local part of DN in the VPLMN
fqdnPatternsarray(FqdnPatternMatchingRule)O1..NList of FQDN patterns of FQDNs allowed (or disallowed) to be routed to the local part of DN in the VPLMN
NOTE:
If none of the ipv4AddressRanges, ipv4AddrMasks, ipv6AddressRanges, ipv6PrefixRanges, fqdnList and fqdnPatterns IEs is present, all the traffic of the PDU session is allowed to be routed to the local part of DN in the VPLMN. At least one of these IEs shall be present when the allowedTraffic IE is set to false.
Up

5.4.4.86  Type: PartiallyAllowedSnssai |R18|  p. 96

Attribute name Data type P Cardina­lity Description
snssaiSnssaiM1This IE shall indicate the S-NSSAI that is partially allowed in the Registration Area.
allowedTaiListarray(Tai)M1..NThis IE shall contain the list of TAI(s) in the Registration Area where the indicated S-NSSAI is allowed.
Up

5.4.4.87  Type: VarRepPeriod |R18|  p. 97

Attribute name Data type P Cardina­lity Description
repPeriodDurationSecM1This IE describes the period time for the variable event reports.
percValueNfLoadUintegerC0..1This IE shall be present if the variable reporting periodicity is based on the load of NF service producer (see clause 4.15.1 of TS 23.502).
When present, this IE indicates the load percentage of NF service producer, within the range 0 to 100.
NOTE:
The reporting periodicity is changed depending on the load of NF service producer, if the load of NF service producer is equal or greater than several values in array of VarRepPeriod, the repPeriod related to the highest value of nfLoad shall be applied.
Up

5.4.4.88  Type: RangingSlPosAuth |R18|  p. 97

Attribute name Data type P Cardina­lity Description
rgSlPosPc5AuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to perform Ranging/Sidelink Positioning over PC5.
rgSlPosLocAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as Located UE.
rgSlPosClientAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as SL Positioning Client UE.
rgSlPosServerAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized to act as SL Positioning Server UE.
Up

5.4.4.89  Type: NrA2xAuth |R18|  p. 97

Attribute name Data type P Cardina­lity Description
uavUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as UAV UE.
Up

5.4.4.90  Type: LteA2xAuth |R18|  p. 97

Attribute name Data type P Cardina­lity Description
uavUeAuthUeAuthC0..1This IE shall be present if available. When present, it shall indicate whether the UE is authorized as UAV UE.
Up

5.4.4.91  Type: SliceUsageControlInfo |R18|  p. 98

Attribute name Data type P Cardina­lity Description
sNssaiSnssaiM1S-NSSAI
deregInactTimerDurationSecC0..1Identifies the slice deregistration inactivity timer for the Network Slice identified by the sNssai IE (see clause 5.15.15.3 of TS 23.501)
The value shall be applied to both 3GPP access and Non-3GPP access.
(NOTE)
sessInactTimerDurationSecC0..1Identifies the PDU Session inactivity timer for the Network Slice identified by the sNssai IE (see clause 5.15.15.3 of TS 23.501)
The value shall be applied to both 3GPP access and Non-3GPP access.
(NOTE)
NOTE:
At least deregInactTimer or sessInactTimer shall be present.
Up

5.4.4.92  Type: CombGciAndHfcNIds |R18|  p. 98

Attribute name Data type P Cardina­lity Description Applica­bility
globalCableIdGciC0..1Global Cable Identifier, for an AUN3 device behind 5G-CRG accessing the 5GC via wireline access network.
hfcNIdHfcNIdC0..1HFC Node Id, for an AUN3 device behind 5G-CRG is accessing the 5GC via wireline access network.
Up

5.4.4.93  Type: SnssaiDnnItem |R18|  p. 98

Attribute name Data type P Cardina­lity Description
snssaiListarray(ExtSnssai)C1..NList of S-NSSAIs
dnnListarray(Dnn)C1..NList of DNNs
NOTE:
At least one of the snssaiList and dnnList IEs shall be present.
If the dnnList IE is absent, this indicates that all DNNs of the provided S-NSSAIs are considered.
If the sNssaiList IE is absent, this indicates that all S-NSSAIs of the provided DNNs are considered.
If both IEs are present, this indicates that the provided DNNs for the provided S-NSSAIs are considered.
Up

5.4.4.94  Type: NtnTaiInfo |R18|  p. 98

Attribute name Data type P Cardina­lity Description
plmnIdPlmnIdNidM1UE's serving PLMN Identity.
tacListarray(Tac)M1..NTAC list received from satellite NG-RAN without the forbidden TAIs for the UE.
derivedTacTacO0..1This attribute may be present if Derived TAC is received from satellite NG-RAN.
Up

5.4.4.95  Type: MitigationInfo |R18|  p. 99

Attribute name Data type P Cardina­lity Description
percValueNumUesintegerC0..1This IE shall be present if available.
When present, it shall contain an unsigned integer indicating the number of registered UEs expressed in percentage format applied for Network Slice Replacement.
Minimum = 0. Maximum = 100.
newUesIndbooleanC0..1This IE shall be present if available. When present, it shall be set to true to indicate the Network Slice Replacement is applied for new UEs.
NOTE:
Either the percValueNumUes IE or the newUesInd IE shall be present.
Up

5.4.4.96  Type: VplmnDlAmbr |R18|  p. 99

Attribute name Data type P Cardina­lity Description
vplmnIdPlmnIdM1V-PLMN ID.
sessionDlAmbrBitRateM1Authorized DL Session AMBR for Offloading, i.e. DL Aggregate Maximum Bit Rate for the Non-GBR QoS Flows of the PDU Session authorized for offloading to the local part of DN in VPLMN.
Up

5.4.4.97  Type: LocalOffloadingManagementInfo |R19|  p. 100

Attribute name Data type P Cardina­lity Description
offloadIdentifierOffloadIdentifierC0..1When present, this IE shall uniquely identify the Local Offloading Management information within a PLMN. (NOTE 1) (NOTE 2)
allowedTrafficbooleanO0..1When present, this IE shall be set as follows:
  • true (default): the LocalOffloadingInfo describes the traffic allowed to be offloaded
  • false: the LocalOffloadingInfo describes the traffic disallowed to be offloaded
ipv4AddressRangesarray(Ipv4AddressRange)C1..NList of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN. (NOTE 2)
ipv4AddrMasksarray(Ipv4AddrMask)C1..NList of ranges of IPv4 addresses allowed (or disallowed) to be routed to the local part of DN, whereby each range of IPv4 addresses corresponds to the IPv4 addresses of an IPv4 subnet defined by an IPv4 address and subnet mask. (NOTE 2)
ipv6AddressRangesarray(Ipv6AddressRange)C1..NList of ranges of IPv6 addresses allowed (or disallowed) to be routed to the local part of DN. (NOTE 2)
ipv6PrefixRangesarray(Ipv6PrefixRange)C1..NList of ranges of IPv6 prefixes allowed (or disallowed) to be routed to the local part of DN. (NOTE 2)
fqdnListarray(Fqdn)C1..NList of FQDNs allowed (or disallowed) to be routed to the local part of DN. (NOTE 2)
fqdnPatternsarray(FqdnPatternMatchingRule)C1..NList of FQDN patterns of FQDNs allowed (or disallowed) to be routed to the local part of DN. (NOTE 2)
NOTE 1:
If none of the ipv4AddressRanges, ipv4AddrMasks, ipv6AddressRanges, ipv6PrefixRanges, fqdnList and fqdnPatterns IEs is present, whether the traffic of the PDU session is allowed to be routed to the local part of DN is determined based on the stored or pre-configured Local Offloading Management Policy identified by offload identifier.
NOTE 1:
At least one of the "offloadIdentifier", "ipv4AddressRanges", "ipv4AddrMasks", "ipv6AddressRanges", "ipv6PrefixRanges", "fqdnList" and "fqdnPatterns" attributes shall be included.
Up

5.4.4.98  Type: CagProvisionInformation |R19|  p. 101

Attribute name Data type P Cardina­lity Description
cagInfoarray(CagId)M1..NIndicates a list of CAG ID(s) identifying the CAG(s) which are allowed for a UE or for a list of UEs.
commonValidTimePeriodListarray(ValidTimePeriod)C0..N This IE shall be present in the following cases:
  • the provisionOperation attribute is not present; or
  • the provisionOperation attribute is present with the value of "ADD" or "REPLACE".
When present, it indicates the time periods during which the UE can access CAG cells.
The time periods present in this IE shall be applied to all CAG ID(s) listed in the cagInfo attribute.
An empty array indicates no common time periods are configured to those CAG ID(s).
additionalValidTimePeriodListmap(array(ValidTimePeriod))O1..M(1..N)A map (list of key-value pairs) where CAG ID converted to string serves as key, and the value is an array of time periods associated with the CAG ID.
This IE may be present if some CAG ID(s) are configured with additional time periods that are different from the time periods in the commonValidTimePeriodList attribute.
provisionOperationCagProvisionOperationO0..1Indicates the CAG provision operation applied to the CAG ID list present in the cagInfo attribute.
If this attribute is not present, it indicates the CAG ID list indicated in the cagInfo attribute is used to replace the previously configured CAG ID list, if any.
NOTE:
If a CAG ID is not associated to any validity time period(s) (i.e. neither the commonValidTimePeriodList is present with non-empty time periods nor the corresponding CAG ID is present in the additionalValidTimePeriodList attribute), the CAG shall be permanently allowed.
Up

5.4.5  Data types describing alternative data types or combinations of data types |R16|  p. 101

5.4.5.1  Type: ExtSnssai  p. 101

Data type Cardina­lity Description
Snssai1Common data type defined in clause 5.4.4.2.
SnssaiExtension1Extensions to the Snssai common data type defined in clause 5.4.4.66.
NOTE:
The sdRanges and wildcardSd attributes shall be exclusive from each other. If one of these attributes is present, the sd attribute shall also be present and it shall contain one Slice Differentiator value within the range of SD (if the sdRanges attribute is present) or with any value (if the wildcardSd attribute is present).
Up

5.4.5.2  Type: SnssaiReplaceInfo |R18|  p. 102

Attribute name Data type P Cardina­lity Description
snssaiSnssaiM1Indicates the impacted S-NSSAI.
statusSnssaiStatusC0..1It shall be present, if the status of the S-NSSAI indicated in the snssai IE changes.
When present, it indicates the availability status of the S-NSSAI indicated in the snssai IE.
altSnssaiSnssaiC0..1It shall be present, if the alternative S-NSSAI is requested to replace the S-NSSAI indicated in snssai IE.
When present, this IE shall indicate the alternative S-NSSAI NSSAI to the impacted S-NSSAI indicated by the "snssai" attribute.
In the case of roaming it shall indicate:
  • the alternative VPLMN S-NSSAI for replacement of the impacted VPLMN S-NSSAI, when the snssai IE contains a VPLMN S-NSSAI; or
  • the alternative HPLMN S-NSSAI for replacement of the impacted HPLMN S-NSSAI, when the snssai IE contains an HPLMN S-NSSAI.
nsReplTerminIndTerminationIndicationC0..1This IE shall be present for a notification of termination of Network Slice Replacement.
plmnIdPlmnIdC0..1This IE shall be present in roaming scenarios, if the impacted S-NSSAI indicated by the snssai IE is an HPLMN S-NSSAI. It may be present otherwise.
When present, it shall indicate the PLMN ID of the impacted S-NSSAI (and alternative S-NSSAI).
mitigationInfoMitigationInfoO0..1This IE may be present for a notification of Network Slice Replacement. When present, it shall include the congestion mitigation information (see clause 5.2.16.3.3 of TS 23.502).
If absent, Network Slice Replacement shall be applied for all the registered UEs and new UEs.
Up

Up   Top   ToC