6.1.6 Data Model
29.5103GPP5G SystemNetwork function repository servicesRelease 18Stage 3TS
6.1.6.1 General
This clause specifies the application data model supported by the API.
Table 6.1.6.1-1 specifies the data types defined for the Nnrf_NFManagement service-based interface protocol.
Table 6.1.6.1-1: Nnrf_NFManagement specific Data Types
Data type |
Clause defined |
Description |
NFProfile |
6.1.6.2.2 |
Information of an NF Instance registered in the NRF. |
NFService |
6.1.6.2.3 |
Information of a given NF Service Instance; it is part of the NFProfile of an NF Instance. |
DefaultNotificationSubscription |
6.1.6.2.4 |
Data structure for specifying the notifications the NF service subscribes by default along with callback URI. |
IpEndPoint |
6.1.6.2.5 |
IP addressing information of a given NFService; it consists on, e.g. IP address, TCP port, transport protocol… |
UdrInfo |
6.1.6.2.6 |
Information of an UDR NF Instance. |
UdmInfo |
6.1.6.2.7 |
Information of an UDM NF Instance. |
AusfInfo |
6.1.6.2.8 |
Information of an AUSF NF Instance. |
SupiRange |
6.1.6.2.9 |
A range of SUPIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. |
IdentityRange |
6.1.6.2.10 |
A range of subscriber identities, either based on a numeric range, or based on regular-expression matching. |
AmfInfo |
6.1.6.2.11 |
Information of an AMF NF Instance. |
SmfInfo |
6.1.6.2.12 |
Information of an SMF NF Instance. |
UpfInfo |
6.1.6.2.13 |
Information of an UPF NF Instance. |
SnssaiUpfInfoItem |
6.1.6.2.14 |
Set of parameters supported by UPF for a given S-NSSAI. |
DnnUpfInfoItem |
6.1.6.2.15 |
Set of parameters supported by UPF for a given DNN. |
SubscriptionData |
6.1.6.2.16 |
Information of a subscription to notifications to NRF events, included in subscription requests and responses. |
NotificationData |
6.1.6.2.17 |
Data sent in notifications from NRF to subscribed NF Instances. |
NFServiceVersion |
6.1.6.2.19 |
Contains the version details of an NF service. |
PcfInfo |
6.1.6.2.20 |
Information of a PCF NF Instance. |
BsfInfo |
6.1.6.2.21 |
Information of a BSF NF Instance. |
Ipv4AddressRange |
6.1.6.2.22 |
Range of IPv4 addresses. |
Ipv6PrefixRange |
6.1.6.2.23 |
Range of IPv6 prefixes. |
InterfaceUpfInfoItem |
6.1.6.2.24 |
Information of a given IP interface of an UPF. |
UriList |
6.1.6.2.25 |
Set of URIs following 3GPP hypermedia format (containing a "_links" attribute). |
N2InterfaceAmfInfo |
6.1.6.2.26 |
AMF N2 interface information |
TaiRange |
6.1.6.2.27 |
Range of TAIs (Tracking Area Identities). |
TacRange |
6.1.6.2.28 |
Range of TACs (Tracking Area Codes). |
SnssaiSmfInfoItem |
6.1.6.2.29 |
Set of parameters supported by SMF for a given S-NSSAI. |
DnnSmfInfoItem |
6.1.6.2.30 |
Set of parameters supported by SMF for a given DNN. |
NrfInfo |
6.1.6.2.31 |
Information of an NRF NF Instance, used in hierarchical NRF deployments. |
ChfInfo |
6.1.6.2.32 |
Information of a CHF NF Instance. |
PlmnRange |
6.1.6.2.34 |
Range of PLMN IDs. |
SubscrCond |
6.1.6.2.35 |
Condition to determine the set of NFs to monitor under a certain subscription in NRF. |
NfInstanceIdCond |
6.1.6.2.36 |
Subscription to a given NF Instance Id. |
NfTypeCond |
6.1.6.2.37 |
Subscription to a set of NFs based on their NF Type. |
ServiceNameCond |
6.1.6.2.38 |
Subscription to a set of NFs based on their support for a given Service Name. |
AmfCond |
6.1.6.2.39 |
Subscription to a set of AMFs, based on AMF Set Id and/or AMF Region Id. |
GuamiListCond |
6.1.6.2.40 |
Subscription to a set of AMFs, based on their GUAMIs. |
NetworkSliceCond |
6.1.6.2.41 |
Subscription to a set of NFs, based on the slices (S-NSSAI and NSI) they support . |
NfGroupCond |
6.1.6.2.42 |
Subscription to a set of NFs based on their Group Id. |
NotifCondition |
6.1.6.2.43 |
Condition (list of attributes in the NF Profile) to determine whether a notification must be sent by NRF. |
PlmnSnssai |
6.1.6.2.44 |
List of network slices (S-NSSAIs) for a given PLMN ID. |
NwdafInfo |
6.1.6.2.45 |
Information of a NWDAF NF Instance. |
LmfInfo |
6.1.6.2.46 |
Information of an LMF NF Instance. |
GmlcInfo |
6.1.6.2.47 |
Information of a GMLC NF Instance. |
NefInfo |
6.1.6.2.48 |
Information of an NEF NF Instance. |
PfdData |
6.1.6.2.49 |
List of Application IDs and/or AF IDs managed by a given NEF Instance. |
AfEventExposureData |
6.1.6.2.50 |
AF Event Exposure data managed by a given NEF Instance. |
WAgfInfo |
6.1.6.2.51 |
Information of the W-AGF endpoints. |
TngfInfo |
6.1.6.2.52 |
Information of the TNGF endpoints. |
PcscfInfo |
6.1.6.2.53 |
Information of a P-CSCF NF Instance. |
NfSetCond |
6.1.6.2.54 |
Subscription to a set of NFs based on their Set Id. |
NfServiceSetCond |
6.1.6.2.55 |
Subscription to a set of NFs based on their Service Set Id. |
NfInfo |
6.1.6.2.56 |
Information of a generic NF Instance. |
HssInfo |
6.1.6.2.57 |
Information of an HSS NF Instance. |
ImsiRange |
6.1.6.2.58 |
A range of IMSIs (subscriber identities), either based on a numeric range, or based on regular-expression matching. |
InternalGroupIdRange |
6.1.6.2.59 |
A range of Group IDs (internal group identities), either based on a numeric range, or based on regular-expression matching. |
UpfCond |
6.1.6.2.60 |
Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). |
TwifInfo |
6.1.6.2.61 |
Addressing information (IP addresses, FQDN) of the TWIF. |
VendorSpecificFeature |
6.1.6.2.62 |
Information about a vendor-specific feature |
UdsfInfo |
6.1.6.2.63 |
Information related to UDSF |
ScpInfo |
6.1.6.2.65 |
Information of an SCP Instance |
ScpDomainInfo |
6.1.6.2.66 |
SCP domain information |
ScpDomainCond |
6.1.6.2.67 |
Subscription to an SCP domain |
OptionsResponse |
6.1.6.2.68 |
Communication options of the NRF |
NwdafCond |
6.1.6.2.69 |
Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. |
NefCond |
6.1.6.2.70 |
Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. |
SuciInfo |
6.1.6.2.71 |
SUCI information containing Routing Indicator and Home Network Public Key ID. |
SeppInfo |
6.1.6.2.72 |
Information of a SEPP Instance |
AanfInfo |
6.1.6.2.73 |
Information of an AAnF NF Instance. |
5GDdnmfInfo |
6.1.6.2.74 |
Information of a 5G DDNMF NF Instance. |
MfafInfo |
6.1.6.2.75 |
Information of the MFAF NF Instance. |
NwdafCapability |
6.1.6.2.76 |
Indicates the capability supported by the NWDAF. |
DccfInfo |
6.1.6.2.80 |
Information of a DCCF NF Instance. |
NsacfInfo |
6.1.6.2.81 |
Information of an NSACF NF Instance. |
NsacfCapability |
6.1.6.2.82 |
NSACF service capability. |
DccfCond |
6.1.6.2.83 |
Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. |
MlAnalyticsInfo |
6.1.6.2.84 |
ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service |
MbSmfInfo |
6.1.6.2.85 |
Information of a MB-SMF NF Instance |
TmgiRange |
6.1.6.2.86 |
Range of TMGIs |
MbsSession |
6.1.6.2.87 |
MBS Session served by an MB-SMF |
SnssaiMbSmfInfoItem |
6.1.6.2.88 |
Parameters supported by an MB-SMF for a given S-NSSAI |
DnnMbSmfInfoItem |
6.1.6.2.89 |
Parameters supported by an MB-SMF for a given DNN |
TsctsfInfo |
6.1.6.2.91 |
Information of a TSCTSF NF Instance. |
SnssaiTsctsfInfoItem |
6.1.6.2.92 |
Set of parameters supported by TSCTSF for a given S-NSSAI. |
DnnTsctsfInfoItem |
6.1.6.2.93 |
Set of parameters supported by TSCTSF for a given DNN. |
MbUpfInfo |
6.1.6.2.94 |
Information of a MB-UPF NF Instance. |
UnTrustAfInfo |
6.1.6.2.95 |
Information of a untrusted AF Instance. |
TrustAfInfo |
6.1.6.2.96 |
Information of a trusted AF Instance |
SnssaiInfoItem |
6.1.6.2.97 |
Set of parameters supported by NF for a given S-NSSAI. |
DnnInfoItem |
6.1.6.2.98 |
Set of parameters supported by NF for a given DNN. |
CollocatedNfInstance |
6.1.6.2.99 |
Information related to collocated NF type(s) and corresponding NF Instance(s) when the NF is collocated with NFs supporting other NF types. |
ServiceNameListCond |
6.1.6.2.100 |
Subscription to a set of NF Instances that offer a service name in the Service Name list. |
NfGroupListCond |
6.1.6.2.101 |
Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. |
PlmnOauth2 |
6.1.6.2.102 |
Per PLMN Oauth2.0 indication. |
V2xCapability |
6.1.6.2.103 |
Indicate the supported V2X Capability by the PCF. |
NssaafInfo |
6.1.6.2.104 |
Information of a NSSAAF NF Instance. |
ProSeCapability |
6.1.6.2.105 |
Indicate the supported ProSe Capability by the PCF. |
SharedDataIdRange |
6.1.6.2.106 |
|
SubscriptionContext |
6.1.6.2.107 |
Context data related to a created subscription, to be included in notifications sent by NRF. |
IwmscInfo |
6.1.6.2.108 |
Information of a SMS-IWMSC NF Instance. |
MnpfInfo |
6.1.6.2.109 |
Information of an MNPF Instance. |
DefSubServiceInfo |
6.1.6.2.110 |
Service Specific Information for Default Notification Subscription. |
LocalityDescriptionItem |
6.1.6.2.111 |
Description of locality information item |
LocalityDescription |
6.1.6.2.112 |
Description of locality information comprising one or more locality information items |
NefId |
6.1.6.3.2 |
Identity of the NEF. |
VendorId |
6.1.6.3.2 |
Vendor ID of the NF Service instance (Private Enterprise Number assigned by IANA) |
WildcardDnai |
6.1.6.3.2 |
Wildcard DNAI |
NFType |
6.1.6.3.3 |
NF types known to NRF. |
NotificationType |
6.1.6.3.4 |
Types of notifications used in Default Notification URIs in the NF Profile of an NF Instance. |
TransportProtocol |
6.1.6.3.5 |
Types of transport protocol used in a given IP endpoint of an NF Service Instance. |
NotificationEventType |
6.1.6.3.6 |
Types of events sent in notifications from NRF to subscribed NF Instances. |
NFStatus |
6.1.6.3.7 |
Status of a given NF Instance stored in NRF. |
DataSetId |
6.1.6.3.8 |
Types of data sets stored in UDR. |
UPInterfaceType |
6.1.6.3.9 |
Types of User-Plane interfaces of the UPF. |
ServiceName |
6.1.6.3.11 |
Service names known to NRF. |
NFServiceStatus |
6.1.6.3.12 |
Status of a given NF Service Instance of an NF Instance stored in NRF. |
AnNodeType |
6.1.6.3.13 |
Access Network Node Type (gNB, ng-eNB…). |
ConditionEventType |
6.1.6.3.14 |
Indicates whether a notification is due to the NF Instance to start or stop being part of a condition for a subscription to a set of NFs |
IpReachability |
6.1.6.3.15 |
Indicates the type(s) of IP addresses reachable via an SCP. |
CollocatedNfType |
6.1.6.3.17 |
Possible NF types supported by a collocated NF. |
LocalityType |
6.1.6.3.18 |
Type of Locality description item. |
Table 6.1.6.1-2 specifies data types re-used by the Nnrf_NFManagement service-based interface protocol from other specifications, including a reference to their respective specifications and when needed, a short description of their use within the Nnrf_NFManagement service-based interface.
Table 6.1.6.1-2: Nnrf_NFManagement re-used Data Types
Data type |
Reference |
Comments |
N1MessageClass |
3GPP TS 29.518 [6] |
The N1 message type |
N2InformationClass |
3GPP TS 29.518 [6] |
The N2 information type |
IPv4Addr |
3GPP TS 29.571 [7] |
|
IPv6Addr |
3GPP TS 29.571 [7] |
|
IPv6Prefix |
3GPP TS 29.571 [7] |
|
Uri |
3GPP TS 29.571 [7] |
|
Dnn |
3GPP TS 29.571 [7] |
|
SupportedFeatures |
3GPP TS 29.571 [7] |
|
Snssai |
3GPP TS 29.571 [7] |
|
PlmnId |
3GPP TS 29.571 [7] |
|
Guami |
3GPP TS 29.571 [7] |
|
Tai |
3GPP TS 29.571 [7] |
|
NfInstanceId |
3GPP TS 29.571 [7] |
|
LinksValueSchema |
3GPP TS 29.571 [7] |
3GPP Hypermedia link |
UriScheme |
3GPP TS 29.571 [7] |
|
AmfName |
3GPP TS 29.571 [7] |
|
DateTime |
3GPP TS 29.571 [7] |
|
Dnai |
3GPP TS 29.571 [7] |
|
ChangeItem |
3GPP TS 29.571 [7] |
|
DiameterIdentity |
3GPP TS 29.571 [7] |
|
AccessType |
3GPP TS 29.571 [7] |
|
NfGroupId |
3GPP TS 29.571 [7] |
Network Function Group Id |
AmfRegionId |
3GPP TS 29.571 [7] |
|
AmfSetId |
3GPP TS 29.571 [7] |
|
PduSessionType |
3GPP TS 29.571 [7] |
|
AtsssCapability |
3GPP TS 29.571 [7] |
Capability to support procedures related to Access Traffic Steering, Switching, Splitting. |
Nid |
3GPP TS 29.571 [7] |
|
PlmnIdNid |
3GPP TS 29.571 [7] |
|
NfSetId |
3GPP TS 29.571 [7] |
NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) |
NfServiceSetId |
3GPP TS 29.571 [7] |
NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) |
GroupId |
3GPP TS 29.571 [7] |
Internal Group Identifier |
RatType |
3GPP TS 29.571 [7] |
RAT Type |
DurationSec |
3GPP TS 29.571 [7] |
|
RedirectResponse |
3GPP TS 29.571 [7] |
Response body of the redirect response message. |
ExtSnssai |
3GPP TS 29.571 [7] |
|
AreaSessionId |
3GPP TS 29.571 [7] |
Area Session Identifier used for an MBS session with location dependent content |
MbsSessionId |
3GPP TS 29.571 [7] |
MBS Session Identifier |
MbsServiceArea |
3GPP TS 29.571 [7] |
MBS Service Area |
IpAddr |
3GPP TS 29.571 [7] |
IP Address |
MbsServiceAreaInfo |
3GPP TS 29.571 [7] |
MBS Service Area Information for Location dependent MBS session |
Fqdn |
3GPP TS 29.571 [7] |
Fully Qualified Domain Name |
EventId |
3GPP TS 29.520 [32] |
Defined in Nnwdaf_AnalyticsInfo API. |
NwdafEvent |
3GPP TS 29.520 [32] |
Defined in Nnwdaf_EventsSubscription API. |
ExternalClientType |
3GPP TS 29.572 [33] |
|
LMFIdentification |
3GPP TS 29.572 [33] |
LMF Identification |
AfEvent |
3GPP TS 29.517 [35] |
Defined in Naf_EventExposure API |
SupportedGADShapes |
3GPP TS 29.572 [33] |
Supported GAD Shapes |
NetworkNodeDiameterAddress |
3GPP TS 29.503 [36] |
Diameter Address of a Network Node |
IpIndex |
3GPP TS 29.503 [36] |
IP Index |
6.1.6.2 Structured data types
6.1.6.2.1 Introduction
This clause defines the structures to be used in resource representations.
6.1.6.2.2 Type: NFProfile
Table 6.1.6.2.2-1: Definition of type NFProfile
Attribute name |
Data type |
P |
Cardinality |
Description |
nfInstanceId |
NfInstanceId |
M |
1 |
Unique identity of the NF Instance. |
nfType |
NFType |
M |
1 |
Type of Network Function |
nfStatus |
NFStatus |
M |
1 |
Status of the NF Instance (NOTE 5) (NOTE 16) |
collocatedNfInstances |
array(CollocatedNfInstance) |
O |
1..N |
Information related to collocated NF type(s) and corresponding NF Instances when the NF is collocated with NFs supporting other NF types. (NOTE 21) In this release of the specification, following collocation scenarios are supported (see clause 6.1.6.2.99): – a MB-UPF collocated with a UPF. |
nfInstanceName |
string |
O |
0..1 |
Human readable name of the NF Instance |
heartBeatTimer |
integer |
C |
0..1 |
Time in seconds expected between 2 consecutive heart-beat messages from an NF Instance to the NRF. It may be included in the registration request. When present in the request it shall contain the heartbeat time proposed by the NF service consumer. It shall be included in responses from NRF to registration requests (PUT) or in NF profile updates (PUT or PATCH). If the proposed heartbeat time is acceptable by the NRF based on the local configuration, it shall use the same value as in the registration request; otherwise the NRF shall override the value using a preconfigured value. |
plmnList |
array(PlmnId) |
C |
1..N |
PLMN(s) of the Network Function (NOTE 7). This IE shall be present if this information is available for the NF. If not provided, PLMN ID(s) of the PLMN of the NRF are assumed for the NF. |
snpnList |
array(PlmnIdNid) |
C |
1..N |
SNPN(s) of the Network Function. This IE shall be present if the NF pertains to one or more SNPNs. |
sNssais |
array(ExtSnssai) |
O |
1..N |
S-NSSAIs of the Network Function. If not provided, and if the perPlmnSnssaiList attribute is not present, the NF can serve any S-NSSAI. When present this IE represents the list of S-NSSAIs supported in all the PLMNs listed in the plmnList IE. If the sNSSAIs attribute is provided in at least one NF Service, the S-NSSAIs supported by the NF Profile shall be the set or a superset of the S-NSSAIs of the NFService(s). |
perPlmnSnssaiList |
array(PlmnSnssai) |
O |
1..N |
This IE may be included when the list of S-NSSAIs supported by the NF for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the Network Function for each PLMN supported by the Network Function. When present, this IE shall override sNssais IE. (NOTE 9) If the perPlmnSnssaiList attribute is provided in at least one NF Service, the S-NSSAIs supported per PLMN in the NF Profile shall be the set or a superset of the perPlmnSnssaiList of the NFService(s). |
nsiList |
array(string) |
O |
1..N |
NSI identities of the Network Function. If not provided, the NF can serve any NSI. |
fqdn |
Fqdn |
C |
0..1 |
FQDN of the Network Function (NOTE 1) (NOTE 2) (NOTE 18). For AMF, the FQDN registered with the NRF shall be that of the AMF Name (see 3GPP TS 23.003 [12] clause 28.3.2.5). |
interPlmnFqdn |
Fqdn |
C |
0..1 |
If the NF needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter-PLMN routing as specified in 3GPP TS 23.003 [12] shall be registered with the NRF (NOTE 8). A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute. |
ipv4Addresses |
array(Ipv4Addr) |
C |
1..N |
IPv4 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) |
ipv6Addresses |
array(Ipv6Addr) |
C |
1..N |
IPv6 address(es) of the Network Function (NOTE 1) (NOTE 2) (NOTE 18) |
allowedPlmns |
array(PlmnId) |
O |
1..N |
PLMNs allowed to access the NF instance. If not provided, any PLMN is allowed to access the NF. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) |
allowedSnpns |
array(PlmnIdNid) |
O |
1..N |
SNPNs allowed to access the NF instance. If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile, is allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) |
allowedNfTypes |
array(NFType) |
O |
1..N |
Type of the NFs allowed to access the NF instance. If not provided, any NF type is allowed to access the NF. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) |
allowedNfDomains |
array(string) |
O |
1..N |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the NF instance. If not provided, any NF domain is allowed to access the NF. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) |
allowedNssais |
array(ExtSnssai) |
O |
1..N |
S-NSSAI of the allowed slices to access the NF instance. If not provided, any slice is allowed to access the NF. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 17) |
priority |
integer |
O |
0..1 |
Priority (relative to other NFs of the same type) within the range 0 to 65535, to be used for NF selection; lower values indicate a higher priority. Priority may or may not be present in the nfServiceList parameters, xxxInfo parameters and in this attribute. Priority in the nfServiceList has precedence over the priority in this attribute (NOTE 4). Priority in xxxInfo parameter shall only be used to determine the relative priority among NF instances with the same priority at NFProfile/NFService. The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. |
capacity |
integer |
O |
0..1 |
Static capacity information within the range 0 to 65535, expressed as a weight relative to other NF instances of the same type; if capacity is also present in the nfServiceList parameters, those will have precedence over this value. (NOTE 4). |
load |
integer |
O |
0..1 |
Dynamic load information, within the range 0 to 100, indicates the current load percentage of the NF. |
loadTimeStamp |
DateTime |
O |
0..1 |
It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Profile) was generated at the NF Instance. If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information. |
locality |
string |
O |
0..1 |
Operator defined information about the location of the NF instance (e.g. geographic location, data center) (NOTE 3) |
extLocality |
map(string) |
O |
1..N |
Operator defined information about the location of the NF instance. (NOTE 3) The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters, representing a type of locality as defined in clause 6.1.6.3.x. Example: { "DATA_CENTER": "dc-123", "CITY": "Los Angeles", "STATE": "California" } |
udrInfo |
UdrInfo |
O |
0..1 |
Specific data for the UDR (ranges of SUPI, group ID …) |
udrInfoList |
map(UdrInfo) |
O |
1..N |
Multiple entries of UdrInfo. This attribute provides additional information to the udrInfo. udrInfoList may be present even if the udrInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
udmInfo |
UdmInfo |
O |
0..1 |
Specific data for the UDM (ranges of SUPI, group ID…) |
udmInfoList |
map(UdmInfo) |
O |
1..N |
Multiple entries of UdmInfo. This attribute provides additional information to the udmInfo. udmInfoList may be present even if the udmInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
ausfInfo |
AusfInfo |
O |
0..1 |
Specific data for the AUSF (ranges of SUPI, group ID…) |
ausfInfoList |
map(AusfInfo) |
O |
1..N |
Multiple entries of AusfInfo. This attribute provides additional information to the ausfInfo. ausfInfoList may be present even if the ausfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
amfInfo |
AmfInfo |
O |
0..1 |
Specific data for the AMF (AMF Set ID, …) |
amfInfoList |
map(AmfInfo) |
O |
1..N |
Multiple entries of AmfInfo. This attribute provides additional information to the amfInfo. amfInfoList may be present even if the amfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
smfInfo |
SmfInfo |
O |
0..1 |
Specific data for the SMF (DNN’s, …). (NOTE 12) |
smfInfoList |
map(SmfInfo) |
O |
1..N |
Multiple entries of SmfInfo. This attribute provides additional information to the smfInfo. smfInfoList may be present even if the smfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 12) |
upfInfo |
UpfInfo |
O |
0..1 |
Specific data for the UPF (S-NSSAI, DNN, SMF serving area, interface…) |
upfInfoList |
map(UpfInfo) |
O |
1..N |
Multiple entries of UpfInfo. This attribute provides additional information to the upfInfo. upfInfoList may be present even if the upfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
pcfInfo |
PcfInfo |
O |
0..1 |
Specific data for the PCF. |
pcfInfoList |
map(PcfInfo) |
O |
1..N |
Multiple entries of PcfInfo. This attribute provides additional information to the pcfInfo. pcfInfoList may be present even if the pcfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
bsfInfo |
BsfInfo |
O |
0..1 |
Specific data for the BSF. |
bsfInfoList |
map(BsfInfo) |
O |
1..N |
Multiple entries of BsfInfo. This attribute provides additional information to the bsfInfo. bsfInfoList may be present even if the bsfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
chfInfo |
ChfInfo |
O |
0..1 |
Specific data for the CHF. |
chfInfoList |
map(ChfInfo) |
O |
1..N |
Multiple entries of ChfInfo. This attribute provides additional information to the chfInfo. chfInfoList may be present even if the chfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
nefInfo |
NefInfo |
O |
0..1 |
Specific data for the NEF. |
nrfInfo |
NrfInfo |
O |
0..1 |
Specific data for the NRF. |
udsfInfo |
UdsfInfo |
O |
0..1 |
Specific data for the UDSF. |
udsfInfoList |
map(UdsfInfo) |
O |
1..N |
Multiple entries of udsfInfo. This attribute provides additional information to the udsfInfo. udsfInfoList may be present even if the udsfInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
nwdafInfo |
NwdafInfo |
O |
0..1 |
Specific data for the NWDAF. |
nwdafInfoList |
map(NwdafInfo) |
O |
1..N |
Multiple entries of nwdafInfo. This attribute provides additional information to the nwdafInfo. nwdafInfoList may be present even if the nwdafInfo is absent. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
pcscfInfoList |
map(PcscfInfo) |
O |
1..N |
Specific data for the P-CSCF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 11) |
hssInfoList |
map(HssInfo) |
O |
1..N |
Specific data for the HSS. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
customInfo |
object |
O |
0..1 |
Specific data for custom Network Functions |
recoveryTime |
DateTime |
O |
0..1 |
Timestamp when the NF was (re)started (NOTE 5) (NOTE 6) |
nfServicePersistence |
boolean |
O |
0..1 |
– true: If present, and set to true, it indicates that the different service instances of a same NF Service in this NF instance, supporting a same API version, are capable to persist their resource state in shared storage and therefore these resources are available after a new NF service instance supporting the same API version is selected by a NF Service Consumer (see 3GPP TS 23.527 [27]). – false (default): Otherwise, it indicates that the NF Service Instances of a same NF Service are not capable to share resource state inside the NF Instance. |
nfServices |
array(NFService) |
O |
1..N |
List of NF Service Instances. It shall include the services produced by the NF that can be discovered by other NFs, if any. (NOTE 15) This attribute is deprecated; the attribute "nfServiceList" should be used instead. |
nfServiceList |
map(NFService) |
O |
1..N |
Map of NF Service Instances, where the "serviceInstanceId" attribute of the NFService object shall be used as the key of the map. (NOTE 15) It shall include the services produced by the NF that can be discovered by other NFs, if any. |
nfProfileChangesSupportInd |
boolean |
O |
0..1 |
NF Profile Changes Support Indicator. See Annex B. This IE may be present in the NFRegister or NFUpdate (NF Profile Complete Replacement) request and shall be absent in the response. true: the NF Service Consumer supports receiving NF Profile Changes in the response. false (default): the NF Service Consumer does not support receiving NF Profile Changes in the response. Write-Only: true |
nfProfileChangesInd |
boolean |
O |
0..1 |
NF Profile Changes Indicator. See Annex B. This IE shall be absent in the request to the NRF and may be included by the NRF in NFRegister or NFUpdate (NF Profile Complete Replacement) response. true: the NF Profile contains NF Profile changes. false (default): complete NF Profile. Read-Only: true |
defaultNotificationSubscriptions |
array(DefaultNotificationSubscription) |
O |
1..N |
Notification endpoints for different notification types. (NOTE 10) |
lmfInfo |
LmfInfo |
O |
0..1 |
Specific data for the LMF. |
gmlcInfo |
GmlcInfo |
O |
0..1 |
Specific data for the GMLC. |
nfSetIdList |
array(NfSetId) |
C |
1..N |
NF Set ID defined in clause 28.12 of 3GPP TS 23.003 [12]. At most one NF Set ID shall be indicated per PLMN-ID or SNPN of the NF. This information shall be present if available. (NOTE 22) (NOTE 23) |
servingScope |
array(string) |
O |
1..N |
The served area(s) of the NF instance. The absence of this attribute does not imply that the NF instance can serve every area in the PLMN. (NOTE 13) |
lcHSupportInd |
boolean |
O |
0..1 |
This IE indicates whether the NF supports Load Control based on LCI Header (see clause 6.3 of 3GPP TS 29.500 [4]). – true: the NF supports the feature. – false (default): the NF does not support the feature. |
olcHSupportInd |
boolean |
O |
0..1 |
This IE indicates whether the NF supports Overload Control based on OCI Header (see clause 6.4 of 3GPP TS 29.500 [4]). – true: the NF supports the feature. – false (default): the NF does not support the feature. |
nfSetRecoveryTimeList |
map(DateTime) |
O |
1..N |
Map of recovery time, where the key of the map is the NfSetId of NF Set(s) that the NF instance belongs to. When present, the value of each entry of the map shall be the recovery time of the NF Set indicated by the key. |
serviceSetRecoveryTimeList |
map(DateTime) |
O |
1..N |
Map of recovery time, where the key of the map is the NfServiceSetId of the NF Service Set(s) configured in the NF instance. When present, the value of each entry of the map shall be the recovery time of the NF Service Set indicated by the key. |
scpDomains |
array(string) |
O |
1..N |
When present, this IE shall carry the list of SCP domains the SCP belongs to, or the SCP domain the NF (other than SCP) or the SEPP belongs to. (NOTE 14) |
scpInfo |
ScpInfo |
O |
0..1 |
Specific data for the SCP. |
seppInfo |
SeppInfo |
O |
0..1 |
Specific data for the SEPP. |
vendorId |
VendorId |
O |
0..1 |
Vendor ID of the NF instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. |
supportedVendorSpecificFeatures |
map(array(VendorSpecificFeature)) |
O |
1..N(1..M) |
Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 19) |
aanfInfoList |
map(AanfInfo) |
O |
1..N |
Multiple entries of AanfInfo. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
5gDdnmfInfo |
5GDdnmfInfo |
O |
0..1 |
Specific data for the 5G DDNMF (5G DDNMF ID, …) |
mfafInfo |
MfafInfo |
O |
0..1 |
Specific data for the MFAF |
easdfInfoList |
map(EasdfInfo) |
O |
1..N |
EASDF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. (NOTE 20) |
dccfInfo |
DccfInfo |
O |
0..1 |
Specific data for the DCCF. |
nsacfInfoList |
map(NsacfInfo) |
O |
1..N |
Specific data for the NSACF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
mbSmfInfoList |
map(MbSmfInfo) |
O |
1..N |
MB-SMF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
tsctsfInfoList |
map(TsctsfInfo) |
O |
1..N |
Specific data for the TSCTSF. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
mbUpfInfoList |
map(MbUpfInfo) |
O |
1..N |
MB-UPF specific data. The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
trustAfInfo |
TrustAfInfo |
O |
0..1 |
Specific data for the trusted AF. |
nssaafInfo |
NssaafInfo |
O |
0..1 |
Specific data for the NSSAAF. |
hniList |
arrary(Fqdn) |
C |
1..N |
Identifications of Credentials Holder or Default Credentials Server. This IE shall be present if the NFs are available for the case of access to an SNPN using credentials owned by a Credentials Holder or for the case of SNPN Onboarding using a DCS. |
iwmscInfo |
IwmscInfo |
O |
0..1 |
Specific data for the SMS-IWMSC. |
mnpfInfo |
MnpfInfo |
O |
0..1 |
Specific data for the MNPF. |
smsfInfo |
SmsfInfo |
O |
0..1 |
Specific data for the SMSF. |
NOTE 1: At least one of the addressing parameters (fqdn, ipv4address or ipv6adress) shall be included in the NF Profile. If the NF supports the NF services with "https" URI scheme (i.e use of TLS is mandatory), then the FQDN shall be provided in the NF Profile or the NF Service profile (see clause 6.1.6.2.3) and it shall be used to construct the target URI (unless overriden by a NFService-specific FQDN). See NOTE 1 of Table 6.1.6.2.3-1 for the use of these parameters. If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Profile, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. NOTE 2: If the type of Network Function is UPF or MB-UPF, the addressing information is for the UPF N4 interface or MB-UPF N4mb interface respectively. If the type of Network Function is a P-CSCF and if no Gm FQDN or IP addresses are registered in the pcscfInfoList attribute, the addressing information is also used for the P-CSCF Gm interface. NOTE 3: A requester NF may use this information to select a NF instance (e.g. a NF instance preferably located in the same data center). NOTE 4: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. NOTE 5: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the NF recoveryTime or the nfStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. NOTE 6: A requester NF may consider that all the resources created in the NF before the NF recovery time have been lost. This may be used to detect a restart of a NF and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. NOTE 7: A NF may register multiple PLMN IDs in its profile within a PLMN comprising multiple PLMN IDs. If so, all the attributes of the NF Profile shall apply to each PLMN ID registered in the plmnList. As an exception, attributes including a PLMN ID, e.g. IMSI-based SUPI ranges, TAIs and GUAMIs, are specific to one PLMN ID and the NF may register in its profile multiple occurrences of such attributes for different PLMN IDs (e.g. the UDM may register in its profile SUPI ranges for different PLMN IDs). NOTE 8: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. NOTE 10: For notification types that may be associated with a specifc service of the NF Instance receiving the notification (see clause 6.1.6.3.4), if notification endpoints are present both in the profile of the NF instance (NFProfile) and in some of its NF Services (NFService) for a same notification type, the notification endpoint(s) of the NF Services shall be used for this notification type. The defaultNotificationSubscriptions attribute may contain multiple default subscriptions for a same notification type; in that case, those default subscriptions are used as alternative notification endpoints so, for each notification event that needs to be sent, the NF Service Consumer shall select one of such subscriptions and use it to send the notification. NOTE 11: The absence of the pcscfInfoList attribute in a P-CSCF profile indicates that the P-CSCF can be selected for any DNN and Access Type, and that the P-CSCF Gm addressing information is the same as the addressing information registered in the fqdn, ipv4Addresses and ipv4Addresses attributes of the NF profile. NOTE 12: The absence of both the smfInfo and smfInfoList attributes in an SMF profile indicates that the SMF can be selected for any S-NSSAI listed in the sNssais and perPlmnSnssaiList IEs, or for any S-NSSAI if neither the sNssais IE nor the perPlmnSnssaiList IE are present, and for any DNN, TAI and access type. NOTE 13: The servingScope attribute may indicate geographical areas, It may be used e.g. to discover and select NFs in centralized Data Centers that are expected to serve users located in specific region(s) or province(s). It may also be used to reduce the large configuration of TAIs in the NF instances. NOTE 14: An NF (other than a SCP) can register at most one SCP domain in NF profile, i.e. the NF can belong to only one SCP domain. If an NF (other than a SCP) includes this information in its profile, this indicates that the services produced by this NF should be accessed preferably via an SCP from the SCP domain the NF belongs to. NOTE 15: If the NF Service Consumer that issues an NF profile retrieval request indicates support for the "Service-Map" feature, the NRF shall return in the NF profile retrieval response the list of NF Service Instances in the "nfServiceList" map attribute. Otherwise, the NRF shall return the list of NF Service Instances in the "nfServices" array attribute. NOTE 16: The nfStatus also indicate the Status of the NF instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF instance and the NF Service Producer (or SCP) has been aware that the NF instance is not operative from the nfStatus in its NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF instances shall not be selected as target. NOTE 17: A change of this attribute shall trigger a "NF_PROFILE_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. NOTE 18: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN of the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the NFProfile; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if no service-specific FQDN or IP address is provided in the NFService data and if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. NOTE 19: When present, this attribute allows an NF requesting NF Discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an NF Service Producer), so as to select an appropriate NF with specific capability, or to include or not the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent messages towards a certain NF. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. NOTE 20: The absence of the easdfInfoList attribute in an EASDF profile indicates that the EASDF can be selected for any S-NSSAI, DNN, DNAI or PSA UPF N6 IP address. NOTE 21: The NF service consumer when invoking NF services offered by collocated NF service producers shall follow the respective service API in the same manner as if they were not collocated with any other NF type. The NF service consumer shall not assume any optimization of signaling between the NF service consumer and the collocated NF service producers. NOTE 22: The nfSetIdList attribute shall be present only if all NF service instance(s) of the NF instance are redundant at NF Set level. I.e. any NF service instance shall be redundant (i.e. functionally equivalent, inter-changeable and sharing contexts) with equivalent service instance(s) of every other NF instance(s) within the indicated NF Set or, if the NF service instance belongs to an NF service set, it shall be redundant with NF service instance(s) in an equivalent NF service set of every other NF instance(s) within the indicated NF set. NOTE 23: The NF Instance shall be removed from an NF set or re-assigned to another NF set ONLY when there is NO ongoing resource/context associated with the NF instance. |
6.1.6.2.3 Type: NFService
Table 6.1.6.2.3-1: Definition of type NFService
Attribute name |
Data type |
P |
Cardinality |
Description |
serviceInstanceId |
string |
M |
1 |
Unique ID of the service instance within a given NF Instance |
serviceName |
ServiceName |
M |
1 |
Name of the service instance (e.g. "nudm-sdm") |
versions |
array(NFServiceVersion) |
M |
1..N |
The API versions supported by the NF Service and if available, the corresponding retirement date of the NF Service. The different array elements shall have distinct unique values for "apiVersionInUri", and consequently, the values of "apiFullVersion" shall have a unique first digit version number. |
scheme |
UriScheme |
M |
1 |
URI scheme (e.g. "http", "https") |
nfServiceStatus |
NFServiceStatus |
M |
1 |
Status of the NF Service Instance (NOTE 3) (NOTE 12) |
fqdn |
Fqdn |
O |
0..1 |
FQDN of the NF Service Instance (NOTE 1) (NOTE 8) (NOTE 14) The FQDN provided as part of the NFService information has precedence over the FQDN and IP addresses provided as part of the NFProfile information (see clause 6.1.6.2.2). |
interPlmnFqdn |
Fqdn |
O |
0..1 |
If the NF service needs to be discoverable by other NFs in a different PLMN, then an FQDN that is used for inter PLMN routing as specified in 3GPP TS 23.003 [12] may be registered with the NRF (NOTE 1) (NOTE 6). A change of this attribute shall result in triggering a "NF_PROFILE_CHANGED" notification from NRF towards subscribing NFs located in the same or a different PLMN, but in the latter case the new value shall be notified as a change of the "fqdn" attribute. |
ipEndPoints |
array(IpEndPoint) |
O |
1..N |
IP address(es) and port information of the Network Function (including IPv4 and/or IPv6 address) where the service is listening for incoming service requests (NOTE 1) (NOTE 7) (NOTE 14). IP addresses provided in ipEndPoints have precedence over IP addresses provided as part of the NFProfile information and, when using the HTTP scheme, over FQDN provided as part of the NFProfile information (see clause 6.1.6.2.2). |
apiPrefix |
string |
O |
0..1 |
Optional path segment(s) used to construct the {apiRoot} variable of the different API URIs, as described in 3GPP TS 29.501 [5], clause 4.4.1 |
defaultNotificationSubscriptions |
array(DefaultNotificationSubscription) |
O |
1..N |
Notification endpoints for different notification types. (See also NOTE 10 in clause 6.1.6.2.2) |
allowedPlmns |
array(PlmnId) |
O |
1..N |
PLMNs allowed to access the service instance (NOTE 5). The absence of this attribute indicates that any PLMN is allowed to access the service instance. When included, the allowedPlmns attribute needs not include the PLMN ID(s) registered in the plmnList attribute of the NF Profile, i.e. the PLMN ID(s) registered in the NF Profile shall be considered to be allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13) |
allowedSnpns |
array(PlmnIdNid) |
O |
1..N |
SNPNs allowed to access the service instance. If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in both the NFService and in the NF profile indicates that no SNPN, other than the SNPN(s) registered in the snpnList attribute of the NF Profile, is allowed to access the service instance. When included, the allowedSnpns attribute needs not include the PLMN ID/NID(s) registered in the snpnList attribute of the NF Profile, i.e. the SNPNs registered in the NF Profile shall be considered to be allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13) |
allowedNfTypes |
array(NFType) |
O |
1..N |
Type of the NFs allowed to access the service instance (NOTE 5). The absence of this attribute indicates that any NF type is allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13) |
allowedNfDomains |
array(string) |
O |
1..N |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the NF domain names within the PLMN of the NRF allowed to access the service instance (NOTE 5). The absence of this attribute indicates that any NF domain is allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13) |
allowedNssais |
array(ExtSnssai) |
O |
1..N |
S-NSSAI of the allowed slices to access the service instance (NOTE 5). The absence of this attribute indicates that any slice is allowed to access the service instance. This attribute shall not be included in profile change notifications to subscribed NFs, unless the subscribing entity explicitly requested so, in the "completeProfileSubscription" attribute in the subscription request message, and the NRF authorized such a request (see clauses 5.2.2.6.2 and 6.1.6.2.17). (NOTE 13) |
allowedOperationsPerNfType |
map(array(string)) |
C |
1..N(1..M) |
Map of allowed operations on resources for each type of NF; the key of the map is the NF Type, and the value is an array of scopes. The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute). In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF type of NF service consumer. In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber’s NF type. When present, this IE should only contain the key-value pair of the map matching the subscriber’s NF type. (NOTE 11) |
allowedOperationsPerNfInstance |
map(array(string)) |
C |
1..N(1..M) |
Map of allowed operations on resources for a given NF Instance; the key of the map is the NF Instance Id, and the value is an array of scopes. The scopes shall be any of those defined in the API that defines the current service (identified by the "serviceName" attribute). In an NFRegister (or NFUpdate) procedure, this IE should be present if the NF service instance supports and is configured to use resource/operation specific scope(s) for at least one NF instance of NF service consumer. In an NFStatusNotify procedure, this IE should be present, if it is present in the registered NF service instance and if the map contains a key matching the subscriber’s NF Instance ID. When present, this IE should only contain the key-value pair of the map matching the subscriber’s NF Instance ID. (NOTE 11) |
allowedOperationsPerNfInstanceOverrides |
boolean |
O |
0..1 |
This IE, when present and set to true, indicates that the scopes defined in attribute "allowedOperationsPerNfInstance" for a given NF Instance ID take precedence over the scopes defined in attribute "allowedOperationsPerNfType" for the corresponding NF type of the NF Instance associated to such NF Instance ID. If the IE is not present, or set to false (default), it indicates that the allowed scopes are any of the scopes present either in "allowedOperationsPerNfType" or in "allowedOperationsPerNfInstance" for the NF Type and NF Instance ID of the NF Service Consumer. (NOTE 11) |
priority |
integer |
O |
0..1 |
Priority (relative to other services of the same type) in the range of 0-65535, to be used for NF Service selection; lower values indicate a higher priority. (NOTE 2). The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. |
capacity |
integer |
O |
0..1 |
Static capacity information in the range of 0-65535, expressed as a weight relative to other services of the same type. (NOTE 2). |
load |
integer |
O |
0..1 |
Dynamic load information, ranged from 0 to 100, indicates the current load percentage of the NF Service. |
loadTimeStamp |
DateTime |
O |
0..1 |
It indicates the point in time in which the latest load information (sent by the NF in the "load" attribute of the NF Service) was generated at the NF Service Instance. If the NF did not provide a timestamp, the NRF should set it to the instant when the NRF received the message where the NF provided the latest load information. |
recoveryTime |
DateTime |
O |
0..1 |
Timestamp when the NF service was (re)started (NOTE 3) (NOTE 4) |
supportedFeatures |
SupportedFeatures |
O |
0..1 |
Supported Features of the NF Service instance |
nfServiceSetIdList |
array(NfServiceSetId) |
C |
1..N |
NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) At most one NF Service Set ID shall be indicated per PLMN-ID or SNPN of the NF. This information shall be present if available. (NOTE 15) |
sNssais |
array(ExtSnssai) |
O |
1..N |
S-NSSAIs of the NF Service. This may be a subset of the S-NSSAIs supported by the NF (see sNssais attribute in NFProfile). When present, this IE shall represent the list of S-NSSAIs supported by the NF Service in all the PLMNs listed in the plmnList IE and it shall prevail over the list of S-NSSAIs supported by the NF instance. |
perPlmnSnssaiList |
array(PlmnSnssai) |
O |
1..N |
S-NSSAIs of the NF Service per PLMN. This may be a subset of the S-NSSAIs supported per PLMN by the NF (see perPlmnSnssaiList attribute in NFProfile). This IE may be included when the list of S-NSSAIs supported by the NF Service for each PLMN it is supporting is different. When present, this IE shall include the S-NSSAIs supported by the NF Service for each PLMN and it shall prevail over the list of S-NSSAIs supported per PLMN by the NF instance. When present, this IE shall override the sNssais IE. (NOTE 9) |
vendorId |
VendorId |
O |
0..1 |
Vendor ID of the NF Service instance, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. |
supportedVendorSpecificFeatures |
map(array(VendorSpecificFeature)) |
O |
1..N(1..M) |
Map of Vendor-Specific features, where the key of the map is the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. The string used as key of the map shall contain 6 decimal digits; if the SMI code has less than 6 digits, it shall be padded with leading digits "0" to complete a 6-digit string value. The value of each entry of the map shall be a list (array) of VendorSpecificFeature objects. (NOTE 10) |
oauth2Required |
boolean |
O |
0..1 |
It indicates whether the NF Service Instance requires Oauth2-based authorization. Absence of this IE means that the NF Service Producer has not provided any indication about its usage of Oauth2 for authorization. |
perPlmnOauth2ReqList |
PlmnOauth2 |
O |
0..1 |
When present, this IE shall include the Oauth2-based authorization requirement supported by the NF Service Instance per PLMN of the NF Service Consumer. This IE may be included when the Oauth2.0 authorization requirement supported by the NF Service Instance for different PLMN is different. When the requester PLMN Id is available in perPlmnOauth2ReqList IE, this IE shall override the oauth2Required IE. If the requester PLMN ID is not present in perPlmnOauth2ReqList IE, then the value of oauth2Required IE shall be applicable if available. |
NOTE 1: The NF Service Consumer will construct the API URIs of the service using: NOTE 2: The capacity and priority parameters, if present, are used for NF selection and load balancing. The priority and capacity attributes shall be used for NF selection in the same way that priority and weight are used for server selection as defined in IETF RFC 2782 [23]. NOTE 3: The NRF shall notify NFs subscribed to receiving notifications of changes of the NF profile, if the recoveryTime or the nfServiceStatus is changed. See clause 6.2 of 3GPP TS 23.527 [27]. NOTE 4: A requester NF subscribed to NF status changes may consider that all the resources created in the NF service before the NF service recovery time have been lost. This may be used to detect a restart of a NF service and to trigger appropriate actions, e.g. release local resources. See clause 6.2 of 3GPP TS 23.527 [27]. NOTE 5: If this attribute is present in the NFService and in the NF profile, the attribute from the NFService shall prevail. The absence of this attribute in the NFService and in the NFProfile indicates that there is no corresponding restriction to access the service instance. If this attribute is absent in the NF Service, but it is present in the NF Profile, the attribute from the NF Profile shall be applied. NOTE 6: Other NFs are in a different PLMN if they belong to none of the PLMN ID(s) configured for the PLMN of the NRF. NOTE 7: If multiple ipv4 addresses and/or ipv6 addresses are included in the NF Service, the NF Service Consumer of the discovery service shall select one of these addresses randomly, unless operator defined local policy of IP address selection, in order to avoid overload for a specific ipv4 address and/or ipv6 address. NOTE 8: If the URI scheme registered for the NF service is "https" then FQDN shall be provided in the NF Service profile or in NF Profile (see clause 6.1.6.2.2). NOTE 9: This is for the use case where an NF (e.g. AMF) supports multiple PLMNs and the slices supported in each PLMN are different. See clause 9.2.6.2 of 3GPP TS 38.413 [29]. NOTE 10: When present, this attribute allows the NF requesting NF discovery (e.g. an NF Service Consumer) to determine which vendor-specific extensions are supported in a given NF (e.g. an Service Producer) in order to select an appropriate NF, or to include or not include the vendor-specific attributes (see 3GPP TS 29.500 [4] clause 6.6.3) required for a given feature in subsequent service requests towards a certain service instance of the NF Service Producer. One given vendor-specific feature shall not appear in both NF Profile and NF Service Profile. If one vendor-specific feature is service related, it shall only be included in the NF Service Profile. NOTE 11: These attributes are used in order to determine whether a given resource/operation-level scope shall be granted to an NF Service Consumer that requested an Oauth2 access token with a specific scope. If attribute "allowedOperationsPerNfInstanceOverrides" is absent, or set to false, the NRF shall only grant such scope in the access token, if the scope is present in either "allowedOperationsPerNfType", for the specific NF type of the NF Service Consumer, or in "allowedOperationsPerNfInstance", for the specific NF instance ID of the NF Service Consumer. If attribute "allowedOperationsPerNfInstanceOverrides" is present and set to true, the NRF shall grant such scope in the access token, if the scope is included in the "allowedOperationsPerNfInstance" attribute for the NF Instance ID of the NF Service Consumer. If attribute "allowedOperationPerNfInstanceOverrides" is present and set to true, but the NF Instance ID of the NF Service Consumer is not included in attribute "allowedOperationPerNfInstance", the NRF shall grant such scope if it is present in the "allowedOperationsPerNfType" for the specific NF type of the NF Service Consumer. Example: if an NF service instance is configured to enable an NF type X to access all service operations including resource/operations defined with resource/operation specific scopes and an NF type Y to allowedOperationsPerNfType: { NOTE 12: The nfServiceStatus also indicate the Status of the NF service instance as NF Service Consumer for notification delivery. When a notification is to be delivered to the NF service instance and the NF Service Producer (or SCP) has been aware that the NF service instance is not operative from the nfServiceStatus in the NF profile, the NF Service producer (or SCP) shall reselect another NF Service Consumer as target if possible, e.g. using binding indication or discovery factors previously provided for the notification. When selecting or reselecting an NF Service Consumer for notification delivery, not operative NF (service) instances shall not be selected as target. NOTE 13: A change of this attribute shall trigger a "NF_PROFILE_CHANGED" notification from NRF, if the change of the NF Profile results in that the NF Instance starts or stops being authorized to be accessed by an NF having subscribed to be notified about NF profile changes. NOTE 14: For API URIs constructed with an FQDN, the NF Service Consumer may use the FQDN in the target URI to do a DNS query and obtain the IP address(es) to setup the TCP connection, and ignore the IP addresses that may be present in the ipEndPoints attribute; alternatively, the NF Service Consumer may use those IP addresses to setup the TCP connection, if the NF Service Consumer supports to indicate specific IP address(es) to establish an HTTP/2 connection with an FQDN in the target URI. NOTE 15: The NF service Instance shall be removed from an NF service set or re-assigned to another NF service set ONLY when there is NO ongoing resource/context associated with the NF service instance. |
6.1.6.2.4 Type: DefaultNotificationSubscription
Table 6.1.6.2.4-1: Definition of type DefaultNotificationSubscription
Attribute name |
Data type |
P |
Cardinality |
Description |
notificationType |
NotificationType |
M |
1 |
Type of notification for which the corresponding callback URI is provided. |
callbackUri |
Uri |
M |
1 |
This attribute contains a default notification endpoint to be used by a NF Service Producer towards an NF Service Consumer that has not registered explicitly a callback URI in the NF Service Producer (e.g. as a result of an implicit subscription). |
n1MessageClass |
N1MessageClass |
C |
0..1 |
If the notification type is N1_MESSAGES, this IE shall be present and shall identify the class of N1 messages to be notified. |
n2InformationClass |
N2InformationClass |
C |
0..1 |
If the notification type is N2_INFORMATION, this IE shall be present and shall identify the class of N2 information to be notified. |
versions |
array(string) |
O |
1..N |
API versions (e.g. "v1") supported for the default notification type. (NOTE 3) |
binding |
string |
O |
0..1 |
When present, this IE shall contain the value of the Binding Indication for the default subscription notification (i.e. the value part of "3gpp-Sbi-Binding" header), as specified in clause 6.12.4 of 3GPP TS 29.500 [4]. (NOTE 1) |
acceptedEncoding |
string |
O |
0..1 |
Content encodings that are accepted by a NF Service Consumer when receiving a notification related to a default notification subscription. The value of this attribute shall be formatted as the value of the Accept-Encoding header defined in IETF RFC 7231 [40] clause 5.3.4 (e.g. acceptedEncoding: "gzip;q=1.0, identity;q=0.5, *;q=0") The absence of this IE shall not be interpreted as indicating that no specific encodings isare supported, but the NF Service Consumer did not register the encodings it may support. |
supportedFeatures |
SupportedFeatures |
O |
0..1 |
When present, this attribute shall indicate the features of the service corresponding to the subscribed default notification, which are supported by the NF (Service) instance acting as NF service consumer. (NOTE 2, NOTE 3) |
serviceInfoList |
map(DefSubServiceInfo) |
O |
1..N |
This IE may be present when the notification request of the notification type may be generated by multiple services, i.e. notifications from different services may be received by the subscription. When present, this IE shall contain a map of service specific information. The name of the corresponding service (as specified in ServiceName data type, see clause 6.1.6.3.11) is the key of the map and the value of the map is the specific information for the indicated service supported by the NF (Service) instance acting as NF service consumer. For example, when the NF subscribes to default notification of "LOCATION_NOTIFICATION" type which may be sent by Namf_Location service and Nlmf_Location service, the NF may provide service specific information as below: { "namf-loc" : { "versions" : [ "v1" ], "supportedFeatures" : "AB" }, "nlmf-loc" : { "versions" : [ "v1" ], "supportedFeatures" : "12" } } (NOTE 3, NOTE 4) |
NOTE 1: The binding indication for default subscription may be used by a NF service producer to reselect an alternative NF service consumer instance, when delivering a notification for a default subscription towards a specific NF consumer but the latter is not reachable. E.g. an AMF notifies corresponding uplink LPP/NRPPa messages via default subscription, to the LMF instance who previously sent downlink LPP/NRPPa message during a location procedure, If the original LMF instance is not reachable, the AMF selects an alternative LMF instance using the binding indication and delivers the notification towards the selected LMF instance. NOTE 2: When sending notifications towards the subscribed NF service consumer, the NF service producer shall generate the default notifications according to the supported features indicated in this attribute, e.g. to include the attributes or enumerated values related to particular features only if the corresponding features are supported, as specified in clause 6.6.2 of 3GPP TS 29.500 [4]. NOTE 3: When the serviceInfoList IE is present, the versions IE and the supportedFeatures IE shall be absent. NOTE 4: When the serviceInfoList IE is present, the NF producer shall determine whether the service of the default notification is supported, i.e. whether the service is listed in the map keys. If supported, the NF producer shall generate the default notification according to the specific information of the service, i.e. the corresponding map value. |
6.1.6.2.5 Type: IpEndPoint
Table 6.1.6.2.5-1: Definition of type IpEndPoint
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4Address |
Ipv4Addr |
C |
0..1 |
IPv4 address (NOTE 1) |
ipv6Address |
Ipv6Addr |
C |
0..1 |
IPv6 address (NOTE 1) |
transport |
TransportProtocol |
O |
0..1 |
Transport protocol |
port |
integer |
O |
0..1 |
Port number (NOTE 2) Minimum: 0 Maximum: 65535 |
NOTE 1: At most one occurrence of either ipv4Address or ipv6Address shall be included in this data structure. NOTE 2: If the port number is absent from the ipEndPoints attribute (see clause 6.1.6.2.3), i.e. there is no "port" attribute in any of the IpEndPoints objects of the ipEndPoints array, the NF service consumer shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 7540 [9] when invoking the service. NOTE 3: If the "port" attribute is present, but the ipv4Address and ipv6Address attributes are absent, the NF service consumer shall use such port number along with the FQDN or IP address parameters present in the NFService or NFProfile data types to construct the target URI where the NF Service Producer is listening for incoming service requests. NOTE 4: If the "port" attribute is present with any ipv4Address and ipv6Address attributes and the HTTP scheme of the service is "https", the NF service consumer shall use such port number along with the FQDN parameter present in the NFService or NFProfile data types to construct the target URI where the NF Service Producer is listening for incoming service requests. NOTE 5: If the HTTP scheme of the service (see clause 6.1.6.2.3) is "https", the operator should not configure IpEndPoints having pairs of IP addresses and ports, with different "port" values in each entry. This is so because the authority of the target URI shall consist of an FQDN (due to the "https" scheme), and it is not always possible to ensure which IP address will be used by the HTTP/2 stack after the DNS resolution has been performed. |
6.1.6.2.6 Type: UdrInfo
Table 6.1.6.2.6-1: Definition of type UdrInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the UDR group that is served by the UDR instance. If not provided, the UDR instance does not pertain to any UDR group. (NOTE 1) |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPI’s whose profile data is available in the UDR instance (NOTE 1) |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of GPSIs whose profile data is available in the UDR instance (NOTE 1) |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of external groups whose profile data is available in the UDR instance (NOTE 1) |
supportedDataSets |
array(DataSetId) |
O |
1..N |
List of supported data sets in the UDR instance. If not provided, the UDR supports all data sets. |
sharedDataIdRanges |
array(SharedDataIdRange) |
O |
1..N |
List of ranges of Shared Data IDs that identify shared data available in the UDR instance (NOTE 1) |
NOTE 1: If none of these parameters are provided, the UDR can serve any external group and any SUPI or GPSI and any SharedData managed by the PLMN of the UDR instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDR instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). |
6.1.6.2.7 Type: UdmInfo
Table 6.1.6.2.7-1: Definition of type UdmInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the UDM group that is served by the UDM instance. If not provided, the UDM instance does not pertain to any UDM group. (NOTE 1) |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs whose profile data is available in the UDM instance (NOTE 1) |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of GPSIs whose profile data is available in the UDM instance (NOTE 1) |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of external groups whose profile data is available in the UDM instance (NOTE 1) |
routingIndicators |
array(string) |
O |
1..N |
List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the UDM instance. If not provided, the UDM can serve any Routing Indicator. Pattern: ‘^[0-9]{1,4}$’ |
internalGroupIdentifiersRanges |
array(InternalGroupIdRange) |
O |
1..N |
List of ranges of Internal Group Identifiers whose profile data is available in the UDM instance. If not provided, it does not imply that the UDM supports all internal groups. |
suciInfos |
array(SuciInfo) |
O |
1..N |
List of SuciInfo. A SUCI that matches this information can be served by the UDM . (NOTE 2, NOTE 3) A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. |
NOTE 1: If none of these parameters are provided, the UDM can serve any external group and any SUPI or GPSI managed by the PLMN of the UDM instance. If "supiRanges", "gpsiRanges" and "externalGroupIdentifiersRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs / ExternalGroups served by this UDM instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, may be used as criteria for UDM discovery. In this release, the usage of Home Network Public Key identifier for UDM discovery is limited to the scenario where the UDM NF consumers belong to the same PLMN as UDM. NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. |
6.1.6.2.8 Type: AusfInfo
Table 6.1.6.2.8-1: Definition of type AusfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the AUSF group. If not provided, the AUSF instance does not pertain to any AUSF group. (NOTE 1) |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs that can be served by the AUSF instance. (NOTE 1) |
routingIndicators |
array(string) |
O |
1..N |
List of Routing Indicator information that allows to route network signalling with SUCI (see 3GPP TS 23.003 [12]) to the AUSF instance. If not provided, the AUSF can serve any Routing Indicator. Pattern: ‘^[0-9]{1,4}$’ |
suciInfos |
array(SuciInfo) |
O |
1..N |
List of SuciInfo. A SUCI that matches this information can be served by the AUSF. (NOTE 2, NOTE 3) A SUCI that matches all attributes of at least one entry in this array shall be considered as a match of this information. |
NOTE 1: If none of these parameters are provided, the AUSF can serve any SUPI managed by the PLMN of the AUSF instance. If "supiRanges" attribute is absent, and "groupId" is present, the SUPIs served by this AUSF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). NOTE 2: The combination of SUCI informations, e.g. Routing Indicator and Home Network Public Key Id, can be used as criteria for AUSF discovery. In this release, the usage of Home Network Public Key identifier for AUSF discovery is limited to the scenario where the AUSF NF consumers belong to the same PLMN as AUSF. NOTE 3: If the suciInfos attribute is present and contains the routingInds sub-attribute, then the routingIndicators attribute shall also be present. |
6.1.6.2.9 Type: SupiRange
Table 6.1.6.2.9-1: Definition of type SupiRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
string |
O |
0..1 |
First value identifying the start of a SUPI range, to be used when the range of SUPI’s can be represented as a numeric range (e.g., IMSI ranges). This string shall consist only of digits. Pattern: "^[0-9]+$" |
end |
string |
O |
0..1 |
Last value identifying the end of a SUPI range, to be used when the range of SUPI’s can be represented as a numeric range (e.g. IMSI ranges). This string shall consist only of digits. Pattern: "^[0-9]+$" |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SUPI’s belonging to this range. A SUPI value is considered part of the range if and only if the SUPI string fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
EXAMPLE 1: IMSI range. From: 123 45 6789040000 To: 123 45 6789059999 (i.e., 20,000 IMSI numbers)
JSON: { "start": "123456789040000", "end": "123456789059999" }
EXAMPLE 2: IMSI range. From: 123 45 6789040000 To: 123 45 6789049999 (i.e., 10,000 IMSI numbers)
JSON: { "pattern": "^imsi-12345678904[0-9]{4}$" }, or
JSON: { "start": "123456789040000", "end": "123456789049999" }
EXAMPLE 3: NAI range. "smartmeter-{factoryID}@company.com" where "{factoryID}" can be any string.
JSON: { "pattern": "^nai-smartmeter-.+@company\.com$" }
6.1.6.2.10 Type: IdentityRange
Table 6.1.6.2.10-1: Definition of type IdentityRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
string |
O |
0..1 |
First value identifying the start of an identity range, to be used when the range of identities can be represented as a numeric range (e.g., MSISDN ranges). This string shall consist only of digits. Pattern: "^[0-9]+$" |
end |
string |
O |
0..1 |
Last value identifying the end of an identity range, to be used when the range of identities can be represented as a numeric range (e.g. MSISDN ranges). This string shall consist only of digits. Pattern: "^[0-9]+$" |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
6.1.6.2.11 Type: AmfInfo
Table 6.1.6.2.11-1: Definition of type AmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
amfRegionId |
AmfRegionId |
M |
1 |
AMF region identifier |
amfSetId |
AmfSetId |
M |
1 |
AMF set identifier. |
guamiList |
array(Guami) |
M |
1..N |
List of supported GUAMIs |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the AMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the AMF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the AMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the AMF can be selected for any TAI in the serving network. |
backupInfoAmfFailure |
array(Guami) |
O |
1..N |
List of GUAMIs for which the AMF acts as a backup for AMF failure |
backupInfoAmfRemoval |
array(Guami) |
O |
1..N |
List of GUAMIs for which the AMF acts as a backup for planned AMF removal |
n2InterfaceAmfInfo |
N2InterfaceAmfInfo |
O |
0..1 |
N2 interface information of the AMF. This information needs not be sent in NF Discovery responses. It may be used by the NRF to update the DNS for AMF discovery by the 5G Access Network. The procedures for updating the DNS are out of scope of this specification. |
amfOnboardingCapability |
boolean |
O |
0..1 |
When present, this IE indicates the AMF supports SNPN Onboarding capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clause 5.30.2.10). – false (default): AMF does not support SNPN Onboarding; – true: AMF supports SNPN Onboarding. |
The "backupInfoAmfFailure" attribute and "backupInfoAmfRemoval" attribute indicates the GUAMIs for which the AMF can act as Backup, when the serving AMF has failed or under planned removal.
EXAMPLE:
When AMF-A, AMF-B and AMF-C registered their NF profiles for PLMN (e.g. MCC = 234, MNC = 15) as following:
AMF-A NF Profile:
{
"amfInfo": {
"guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000001"}],
"backupInfoAmfFailure": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}]
}
}
AMF-B NF Profile:
{
"amfInfo": {
"guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000002"}],
"backupInfoAmfRemoval": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}]
}
}
AMF-C NF Profile:
{
"amfInfo": {
"guamiList": [{ "plmnId": { "mcc": "234", "mnc": "15" }, "amfId": "000003"}]
}
}
When one NF consumer queries NRF with a GUAMI served by AMF-C (i.e. {"plmnId":{"mcc":"234","mnc": "15"},"amfId":"000003"}), then
– if the NRF detects the AMF-C has failed, e.g. using heartbeat, the NRF shall return AMF-A instance as backup AMF; or
– if the NRF detects AMF-C has entered planned removal, i.e. received a de-registration request from AMF-C, the NRF shall return AMF-B instance as backup AMF.
6.1.6.2.12 Type: SmfInfo
Table 6.1.6.2.12-1: Definition of type SmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiSmfInfoList |
array(SnssaiSmfInfoItem) |
M |
1..N |
List of parameters supported by the SMF per S-NSSAI (NOTE 1). |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the SMF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the SMF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the SMF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the SMF can be selected for any TAI in the serving network. |
pgwFqdn |
Fqdn |
O |
0..1 |
The FQDN of the PGW if the SMF is a combined SMF/PGW-C. |
pgwIpAddrList |
array(IpAddr) |
O |
1..N |
The PGW IP addresses of the combined SMF/PGW-C. This IE allows the NF Service consumer to find the target combined SMF/PGW-C by PGW IP Address, e.g. when only PGW IP Address is available. |
accessType |
array(AccessType) |
C |
1..2 |
If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the SMF. If not included, it shall be assumed the both access types are supported. |
priority |
integer |
O |
0..1 |
Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the SmfInfo; lower values indicate a higher priority. The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. Absence of this attribute equals to having the same smfInfo priority as the priority defined at NFProfile/NFService level. (NOTE 2) |
vsmfSupportInd |
boolean |
O |
0..1 |
This IE may be used by an SMF to explicitly indicate the support of V-SMF capability and its preference to be selected as V-SMF. When present, this IE shall indicate whether the V-SMF capability are supported by the SMF: – true: V-SMF capability supported by the SMF – false: V-SMF capability not supported by the SMF. Absence of this IE indicates the V-SMF capability support of the SMF is not specified. (NOTE 3) |
ismfSupportInd |
boolean |
O |
0..1 |
This IE may be used by an SMF to explicitly indicate the support of I-SMF capability and its preference to be selected as I-SMF. When present, this IE shall indicate whether the I-SMF capability are supported by the SMF: – true: I-SMF capability supported by the SMF – false: I-SMF capability not supported by the SMF. Absence of this IE indicates the I-SMF capability support of the SMF is not specified. (NOTE 3) |
pgwFqdnList |
array(Fqdn) |
O |
1..N |
When present, this attribute provides additional FQDNs to the FQDN indicated in the pgwFqdn attribute. The pgwFqdnList attribute may be present if the pgwFqdn attribute is present. |
smfOnboardingCapability |
boolean |
O |
0..1 |
When present, this IE indicates the SMF supports SNPN Onboarding capability and User Plane Remote Provisioning. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2). – false (default): SMF does not support SNPN Onboarding; – true: SMF supports SNPN Onboarding. (NOTE 4) |
smfUPRPCapability |
boolean |
O |
0..1 |
When present, this IE indicates the SMF supports User Plane Remote Provisioning (UPRP) capability. This is used for the case of Onboarding of UEs for SNPNs (see 3GPP TS 23.501 [2], clauses 5.30.2.10 and 6.2.6.2). – false (default): SMF does not support UPRP; – true: SMF supports UPRP. |
NOTE 1: If this S-NSSAIs is present in the SmfInfo and in the NFprofile, the S-NSSAIs from the SmfInfo shall prevail. NOTE 2: An SMF profile may e.g. contain multiple SmfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the SMF based on the user location. The priority in SmfInfo applies between SMFs or SMF Services with the same priority. NOTE 3: The IE should only be registered when the SMF is configured to be preferably selected as V-SMF/I-SMF. NOTE 4: The IE is deprecated and replaced by smfUPRPCapability attribute. |
6.1.6.2.13 Type: UpfInfo
Table 6.1.6.2.13-1: Definition of type UpfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiUpfInfoList |
array(SnssaiUpfInfoItem) |
M |
1..N |
List of parameters supported by the UPF per S-NSSAI (NOTE 1) |
smfServingArea |
array(string) |
O |
1..N |
The SMF service area(s) the UPF can serve. If not provided, the UPF can serve any SMF service area. |
interfaceUpfInfoList |
array(InterfaceUpfInfoItem) |
O |
1..N |
List of User Plane interfaces configured on the UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. SMF) may use this information for UPF selection. |
iwkEpsInd |
boolean |
O |
0..1 |
Indicates whether interworking with EPS is supported by the UPF. true: Supported |
sxaInd |
boolean |
O |
0..1 |
Indicates whether the UPF is configured to support Sxa interface. true: Supported false: Not Supported |
pduSessionTypes |
array(PduSessionType) |
O |
1..N |
List of PDU session type(s) supported by the UPF. The absence of this attribute indicates that the UPF can be selected for any PDU session type. |
atsssCapability |
AtsssCapability |
C |
0..1 |
If present, this IE shall indicate the ATSSS capability of the UPF. If not present, the UPF shall be regarded with no ATSSS capability. |
ueIpAddrInd |
boolean |
O |
0..1 |
Indicates whether the UPF supports allocating UE IP addresses/prefixes. true: supported |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the UPF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the UPF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicates that the UPF can serve the whole SMF service area defined by the smfServingArea attribute. (NOTE 6) |
wAgfInfo |
WAgfInfo |
C |
0..1 |
If present, this IE shall indicate that the UPF is collocated with W-AGF. If not present, the UPF is not collocated with W-AGF. |
tngfInfo |
TngfInfo |
C |
0..1 |
If present, this IE shall indicate that the UPF is collocated with TNGF. If not present, the UPF is not collocated with TNGF. |
twifInfo |
TwifInfo |
C |
0..1 |
If present, this IE shall indicate that the UPF is collocated with TWIF. If not present, the UPF is not collocated with TWIF. |
priority |
integer |
O |
0..1 |
Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the UpfInfo; lower values indicate a higher priority. See the precedence rules in the description of the priority attribute in NFProfile, if Priority is also present in NFProfile. The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. (NOTE 2) |
redundantGtpu |
boolean |
O |
0..1 |
Indicates whether the UPF supports redundant GTP-U path. true: supported |
ipups |
boolean |
O |
0..1 |
Indicates whether the UPF is configured for IPUPS. (NOTE 3) true: the UPF is configured for IPUPS. false (default): the UPF is not configured for IPUPS. |
dataForwarding |
boolean |
O |
0..1 |
Indicates whether the UPF is configured for data forwarding. (NOTE 4) When present, this IE shall be set as following: – true: the UPF is configured for data forwarding – false (default): the UPF is not configured for data forwarding If the UPF is configured for data forwarding, it shall support UP network interface with type "DATA_FORWARDING". |
supportedPfcpFeatures |
string |
O |
0..1 |
Supported PFCP Features. A string used to indicate the PFCP features supported by the UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet. (NOTE 5) |
NOTE 1: If this S-NSSAIs is present in the UpfInfo and in the NFprofile, the S-NSSAIs from the UpfInfo shall prevail. NOTE 2: An UPF profile may e.g. contain multiple UpfInfo entries, with each entry containing a different list of TAIs and a different priority, to differentiate the priority to select the UPF based on the user location. The priority in UpfInfo has the least precedence, i.e. it applies between UPFs with the same priority. NOTE 3: Any UPF can support the IPUPS functionality. In network deployments where specific UPFs are used to provide IPUPS, UPFs configured for providing IPUPS services shall be selected to provide IPUPS. NOTE 4: Based on operator policies, if dedicated UPFs are preferred to be used for indirect data forwarding during handover scenarios, when setting up the indirect data forwarding tunnel, the SMF should preferably select a UPF configured for data forwarding and use the network instance indicated in the Network Instance ID associated to the DATA_FORWARDING interface type in the interfaceUpfInfoList attribute. NOTE 5: The supportedPfcpFeatures shall be provisioned in addition and be consistent with the existing UPF features (atsssCapability, ueIpAddrInd, redundantGtpu and ipups) in the upfInfo, e.g. if the ueIpAddrInd is set to "true", then the UEIP flag shall also be set to "1" in the supportedPfcpFeatures. NOTE 6: This attribute should only be used by the UPF if, based on specific operator’s deployment, the NRF and the SMFs intended to interwork with this UPF, have been upgraded to support this feature (i.e. to understand the definition of TAIs in the UPF profile based on ranges of TAIs). |
6.1.6.2.14 Type: SnssaiUpfInfoItem
Table 6.1.6.2.14-1: Definition of type SnssaiUpfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
Supported S-NSSAI (NOTE) |
dnnUpfInfoList |
array(DnnUpfInfoItem) |
M |
1..N |
List of parameters supported by the UPF per DNN |
redundantTransport |
boolean |
O |
0..1 |
Indicates whether the UPF supports redundant transport path on the transport layer in the corresponding network slice. true: supported |
NOTE: A UPF may register SD ranges or a wildcard SD if the NRF and all consumers of the UPF profile have been upgraded to support SD ranges and wildcard SD in this attribute. |
6.1.6.2.15 Type: DnnUpfInfoItem
Table 6.1.6.2.15-1: Definition of type DnnUpfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
dnaiList |
array(Dnai) |
O |
1..N |
List of Data network access identifiers supported by the UPF for this DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any DNAI. |
pduSessionTypes |
array(PduSessionType) |
O |
1..N |
List of PDU session type(s) supported by the UPF for a specific DNN. The absence of this attribute indicates that the UPF can be selected for this DNN for any PDU session type supported by the UPF (see clause 6.1.6.2.13). |
ipv4AddressRanges |
array(Ipv4AddressRange) |
O |
1..N |
List of ranges of IPv4 addresses handled by UPF. (NOTE 1) |
ipv6PrefixRanges |
array(Ipv6PrefixRange) |
O |
1..N |
List of ranges of IPv6 prefixes handled by the UPF. (NOTE 1) |
ipv4IndexList |
array(IpIndex) |
O |
1..N |
List of Ipv4 Index supported by the UPF. (NOTE 3) |
ipv6IndexList |
array(IpIndex) |
O |
1..N |
List of Ipv6 Index supported by the UPF. (NOTE 3) |
networkInstance |
string |
O |
0..1 |
The N6 Network Instance (See 3GPP TS 29.244 [21]) associated with the S-NSSAI and DNN. |
dnaiNwInstanceList |
map(string) |
O |
1..N |
Map of a network instance per DNAI for the DNN, where the key of the map is the DNAI. When present, the value of each entry of the map shall contain a N6 network instance that is configured for the DNAI indicated by the key. (NOTE 2) |
NOTE 1: The list of ranges of IPv4/v6 address may be used by the SMF to select a UPF which supports a UE static IP address received in user subscription, or when the UE IP address is to be allocated by an external server, e.g. AAA/Radius Server. NOTE 2: This IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI, DNN and DNAI. If this IE is not present, the SMF needs to be configured with corresponding information. NOTE 3: The list of IPv4/v6 Indexes may be used by the SMF to select a UPF which supports a specific IP Index received from the UDM or the PCF for a UE’s PDU session. NOTE 4: The networkInstance IE and the dnaiNwInstanceList shall not be present simutanously. The networkInstance IE may be used by the SMF to determine the Network Instance associated to a given S-NSSAI and DNN where DNAI(s) are not configured, i.e. the dnaiNwInstanceList is not present. If this IE is not present and the dnaiNwInstanceList is also not present, the SMF needs to be configured with corresponding information. A network instance can be associated with multiple network slices if the UP function supports the "Per Slice UP Resource Management" feature as specified in clause 5.35.1 of 3GPP TS 29.244 [21]. |
6.1.6.2.16 Type: SubscriptionData
Table 6.1.6.2.16-1: Definition of type SubscriptionData
Attribute name |
Data type |
P |
Cardinality |
Description |
nfStatusNotificationUri |
Uri |
M |
1 |
Callback URI where the NF Service Consumer will receive the notifications from NRF. |
reqNfInstanceId |
NfInstanceId |
O |
0..1 |
If present, this IE shall contain the NF instance id of the NF service consumer. |
subscrCond |
SubscrCond |
O |
0..1 |
If present, this attributed shall contain the conditions identifying the set of NF Instances whose status is requested to be monitored. If this attribute is not present, it means that the NF Service Consumer requests a subscription to all NFs in the NRF (NOTE 1). |
subscriptionId |
string |
C |
0..1 |
Subscription ID for the newly created resource. This parameter shall be absent in the request to the NRF and shall be included by NRF in the response to the subscription creation request. Read-Only: true Pattern: "^([0-9]{5,6}-)?[^-]+$" |
validityTime |
DateTime |
C |
0..1 |
Time instant after which the subscription becomes invalid. This parameter may be sent by the client, as a hint to the server, but it shall be always sent back by the server (regardless of the presence of the attribute in the request) in the response to the subscription creation request. |
reqNotifEvents |
array(NotificationEventType) |
O |
1..N |
If present, this attribute shall contain the list of event types that the NF Service Consumer is interested in receiving. If this attribute is not present, it means that notifications for all event types are requested. |
reqNfType |
NFType |
C |
0..1 |
An NF Service Consumer complying with this version of the specification shall include this IE. If included, this IE shall contain the NF type of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-type" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). |
reqNfFqdn |
Fqdn |
O |
0..1 |
This IE may be present for a subscription request within the same PLMN as the NRF. If included, this IE shall contain the FQDN of the NF Service Consumer that is requesting the creation of the subscription. The NRF shall use it for authorizing the request, in the same way as the "requester-nf-instance-fqdn" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). This IE shall be ignored by the NRF if it is received from a requester NF belonging to a different PLMN. When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). |
reqSnssais |
array(ExtSnssai) |
O |
0..1 |
If included, this IE shall contain the list of S-NSSAIs of the NF Service Consumer that is requesting the creation of the subscription. If this IE is included in a subscription request in a different PLMN, the requester NF shall provide S-NSSAI values of the target PLMN, that correspond to the S-NSSAI values of the requester NF. The NRF shall use it for authorizing the request, in the same way as the "requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). |
reqPerPlmnSnssais |
array(PlmnSnssai) |
O |
1..N |
If included, this IE shall indicate the list of S-NSSAIs supported by the NF Service Consumer in each of the PLMNs it supports. The NRF shall use it for authorizing the request, in the same way as the "per-plmn-requester-snssais" is used in the NF Discovery service (see Table 6.2.3.2.3.1-1). When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services (NOTE 2). |
plmnId |
PlmnId |
O |
0..1 |
If present, this attribute contains the target PLMN ID of the NF Instance(s) whose status is requested to be monitored. (NOTE 7) |
nid |
Nid |
O |
0..1 |
If present, this attribute contains the target NID that, together with the plmnId attribute, identifies the SNPN of the NF Instance(s) whose status is requested to be monitored. |
onboardingCapability |
boolean |
O |
0..1 |
If present, this attribute indicates the NF Instance(s) whose status is requested to be monitored support SNPN Onboarding capability. |
notifCondition |
NotifCondition |
O |
0..1 |
If present, this attribute contains the conditions that trigger a notification from NRF; this attribute shall only be present if the NF Service Consumer has subscribed to changes on the NF Profile (i.e., reqNotifEvents contains the value "NF_PROFILE_CHANGED", or reqNotifEvents attribute is absent) (NOTE 3). If this attribute is absent, it means that the NF Service Consumer does not indicate any restriction, or condition, on which attributes of the NF Profile shall trigger a notification from NRF. (NOTE 5). |
reqPlmnList |
array(PlmnId) |
C |
1..N |
This IE shall be included when subscribing to NF services in a different PLMN. When included, this IE shall contain the PLMN ID(s) of the requester NF. (NOTE 2) |
reqSnpnList |
array(PlmnIdNid) |
C |
1..N |
This IE shall be included when the subscribing NF belongs to one or several SNPNs and it subscribes to NF services of a specific SNPN. When included, this IE shall contain the SNPN ID(s) of the requester NF. When the subscription is for a set of NF Instances, the subscription may be accepted by NRF, but it shall only generate notifications from NF Instances whose authorization parameters allow the NF Service Consumer to access their services. (NOTE 2) |
servingScope |
array(string) |
O |
1..N |
If present, this attribute indicates the target served area(s) of the NF instance(s) whose status is required to be monitored. (NOTE 4) |
requesterFeatures |
SupportedFeatures |
C |
0..1 |
Nnrf_NFManagement features supported by the NF Service Consumer that is invoking the Nnrf_NFManagement service. See clause 6.1.9. This IE shall be included if at least one feature is supported by the NF Service Consumer. Write-Only: true (NOTE 6) |
nrfSupportedFeatures |
SupportedFeatures |
C |
0..1 |
Features supported by the NRF in the Nnrf_NFManagement service. See clause 6.1.9. This IE shall be included if at least one feature is supported by the NRF. Read-Only: true |
hnrfUri |
Uri |
C |
0..1 |
If included, this IE shall contain the API URI of the NFManagement Service (see clause 6.1.1) of the home NRF. It shall be included if the NF Service Consumer has previously received such API URI from the NSSF in the home PLMN (see clause 6.1.6.2.11 of 3GPP TS 29.531 [42]). |
targetHni |
Fqdn |
O |
0..1 |
If present, this attribute shall contain the identification of the Default Credentials Server or the identification of the Credentials Hoder. |
preferredLocality |
string |
O |
0..1 |
Preferred target NF location (e.g. geographic location, data center). When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the preferred-locality in Table 6.2.3.2.3.1-1. |
extPreferredLocality |
map(array(LocalityDescription)) |
O |
1..N(1..M) |
Preferred target NF location (e.g. geographic location, data center). The key of the map shall represent the relative priority, for the requester, of each locality description among the list of locality descriptions in this attribute, encoded as "1" (highest priority"), "2", "3",… ,"n" (lowest priority). See examples in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1. When present, the NRF should set a priority for the monitored NF instance in the notification as specified in the description of the ext-preferred-locality in Table 6.2.3.2.3.1-1. |
completeProfileSubscription |
boolean |
O |
0..1 |
This IE may be included by an SCP with the value true to request to monitor, and to be notified of, changes on the complete profile of the NF Instance (including authorization attributes such as the "allowedXXX" attributes of NFProfile and NFService data types). See clause 5.2.2.5.2. Write-Only: true |
NOTE 1: The "subscription to all NFs" may be quite demanding in terms of resources in NRF and also in terms of network traffic of the resulting notifications, so it should be authorized by NRF under very strict policies (e.g. only to a specific requesting NF, as indicated by reqNfType and reqNfFqdn attributes). NOTE 2: The authorization parameters in NF Profile are those used by NRF to determine whether a given NF Instance / NF Service Instance can be discovered by an NF Service Consumer in order to consume its offered services (e.g. "allowedNfTypes", "allowedNfDomains", etc.). Based on operator’s policies, a subscription request not including the requester’s information necessary to validate the authorization parameters in NF Profiles may be rejected or may be accepted but with only generating notifications from NF Instances whose authorization parameters allow any NF Service Consumer to access their services. NOTE 3: The subscription to load changes may be quite demanding in terms of network traffic of the resulting notifications, thus it may be limited by the NRF via appropriate configuration (e.g. granularity threshold) NOTE 4: An NF instance may explicitly indicate the served areas in the NF profile when registered to NRF. When this IE is present, the NRF shall only monitor the NF instance(s) indicating at least one of the served areas in the list. If an NF instance has not indicated any served area in its NF profile, it shall not be monitored. NOTE 5: If the attributes to be monitored or excluded from monitoring, included as part of the "notifCondition" attribute, refer to a specific element of an array (e.g. they refer to a specifc array index of the "nfServices" attribute of the NFProfile), the NRF shall apply the same condition to all elements of the same array. NOTE 6: If the NF Service Consumer that issued the subscription request indicated support for the "Service-Map" feature, the NRF shall send notifications of profile changes (see clause 6.1.6.2.17) affecting the list of NF Service Instances, as modifications of specific attributes of the "nfServiceList" map. Otherwise, the NRF shall send those notifications as a complete replacement of the "nfServices" array attribute. NOTE 7: The PLMN ID should be used by the NRF as an additional subscription condition to monitor the change of target NF profile, unless the subscription is specific to one or a list of NF(s) explicitly indicated by their NF Instance ID(s), e.g. using the NfInstanceIdCond or NfInstanceIdListCond, in which case the NRF shall not use the PLMN ID provided in the subscription (if any) as an additional subscription condition to monitor the change of target NF profile. |
6.1.6.2.17 Type: NotificationData
Table 6.1.6.2.17-1: Definition of type NotificationData
Attribute name |
Data type |
P |
Cardinality |
Description |
event |
NotificationEventType |
M |
1 |
Notification type. It shall take the values "NF_REGISTERED", "NF_DEREGISTERED" or "NF_PROFILE_CHANGED". |
nfInstanceUri |
Uri |
M |
1 |
Uri of the NF Instance (see clause 6.1.3.3.2) associated to the notification event. |
nfProfile |
NFProfile |
C |
0..1 |
New NF Profile or Updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED". (NOTE 3) This IE, if present, shall not contain authorization attributes (such as the "allowedXXX" attributes of the NFProfile or NFService data types). |
profileChanges |
array(ChangeItem) |
C |
1..N |
List of changes on the profile of the NF Instance associated to the notification event; it may be present when the notification type is "NF_PROFILE_CHANGED" (see NOTE 1, NOTE 2). |
conditionEvent |
ConditionEventType |
C |
0..1 |
Type of event indicating wether a change of NF Profile results in that the NF Instance starts or stops being part of a given set of NF Instances, as indicated in the subscription condition (see attribute "subscrCond" in clause 6.1.6.2.16). It can take the value "NF_ADDED" (if the NF Instance starts being part of a given set) or "NF_REMOVED" (if the NF Instance stops being part of a given set). (NOTE 3) |
subscriptionContext |
SubscriptionContext |
C |
0..1 |
It shall contain data related to the subscription to which this notification belongs to, such as the subscription ID and the subscription conditions. An NRF complying with this release of the specification shall include this attribute, to facilitate to the subscribing entity the identification of the subscription data, or context, that triggered this notification. |
completeNfProfile |
NFProfile |
C |
0..1 |
Complete new NF Profile or updated NF Profile; it shall be present when the notification type is "NF_REGISTERED" and it may be present when the notification type is "NF_PROFILE_CHANGED". (NOTE 3) This IE shall only be present if the NRF supports the "Complete-Profile-Subscription" feature, the "completeProfileSubscription" attribute is present and set to true in the request (see clause 6.1.6.2.16) and if the requesting entity is authorized to subscribe to the complete profile of NF instances. This IE, if present, should contain the complete set of attributes (including, e.g. the "allowedXXX" attributes of the NFProfile or NFService data types). |
NOTE 1: If "event" attribute takes the value "NF_PROFILE_CHANGED", then either "nfProfile" or "profileChanges" attributes shall be present, but not both. NOTE 2: The NRF shall notify about NF Profile changes affecting attributes of type "array" only as a complete replacement of the whole array (i.e. it shall not notify about changes of individual array elements). NOTE 3: When a change in an NF Profile results in an NF to start being part of a given set, the NRF shall indicate such condition by including the "conditionEvent" attribute with value "NF_ADDED", and it shall include in the notification the "nfProfile" attribute with the full NF Profile of the NF Instance; the "profileChanges" attribute shall not be included. |
EXAMPLE: Notification payload sent from NRF when an NF Instance has changed its profile by updating the value of the "recoveryTime" attribute of its NF Profile, and updated any attribute of any of its NF Service Instances:
{
"event": "NF_PROFILE_CHANGED",
"nfInstanceUri": "…/nf-instances/4947a69a-f61b-4bc1-b9da-47c9c5d14b64",
"profileChanges": [
{
"op": "REPLACE",
"path": "/recoveryTime",
"newValue": "2018-12-30T23:20:50Z"
},
{
"op": "REPLACE",
"path": "/nfServices",
"newValue": [ …new array content… ]
}
]
}
6.1.6.2.18 Void
6.1.6.2.19 Type: NFServiceVersion
Table 6.1.6.2.19-1: Definition of type NFServiceVersion
Attribute name |
Data type |
P |
Cardinality |
Description |
apiVersionInUri |
string |
M |
1 |
Version of the service instance to be used in the URI for accessing the API (e.g. "v1"). |
apiFullVersion |
string |
M |
1 |
Full version number of the API as specified in clause 4.3.1 of 3GPP TS 29.501 [5]. |
expiry |
DateTime |
O |
0..1 |
Expiry date and time of the NF service. This represents the planned retirement date as specified in clause 4.3.1.5 of 3GPP TS 29.501 [5]. |
6.1.6.2.20 Type: PcfInfo
Table 6.1.6.2.20-1: Definition of type PcfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the PCF group that is served by the PCF instance. If not provided, the PCF instance does not pertain to any PCF group. (NOTE) |
dnnList |
array(Dnn) |
O |
1..N |
DNNs supported by the PCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. If not provided, the PCF can serve any DNN. |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs that can be served by the PCF instance. (NOTE) |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of GPSIs that can be served by the PCF instance. (NOTE) |
rxDiamHost |
DiameterIdentity |
C |
0..1 |
This IE shall be present if the PCF supports Rx interface. When present, this IE shall indicate the Diameter host of the Rx interface for the PCF. |
rxDiamRealm |
DiameterIdentity |
C |
0..1 |
This IE shall be present if the PCF supports Rx interface. When present, this IE shall indicate the Diameter realm of the Rx interface for the PCF. |
v2xSupportInd |
boolean |
O |
0..1 |
Indicates whether V2X Policy/Parameter provisioning is supported by the PCF. true: Supported |
proseSupportInd |
boolean |
O |
0..1 |
Indicates whether ProSe capability is supported by the PCF. true: Supported |
proseCapability |
ProseCapability |
C |
0..1 |
This IE shall be present if the PCF supports ProSe Capability. When present, this IE shall indicate the supported ProSe Capability by the PCF. |
v2xCapability |
V2xCapability |
C |
0..1 |
This IE shall be present if the PCF supports V2X Capability. When present, this IE shall indicate the supported V2X Capability by the PCF. |
NOTE: If none of these parameters are provided, the PCF can serve any SUPI or GPSI managed by the PLMN of the PCF instance. If "supiRanges" and "gpsiRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this PCF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). |
6.1.6.2.21 Type: BsfInfo
Table 6.1.6.2.21-1: Definition of type BsfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4AddressRanges |
array(Ipv4AddressRange) |
O |
1..N |
List of ranges of IPv4 addresses handled by BSF. If not provided, the BSF can serve any IPv4 address. |
dnnList |
array(Dnn) |
O |
1..N |
List of DNNs handled by the BSF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. If not provided, the BSF can serve any DNN. |
ipDomainList |
array(string) |
O |
1..N |
List of IPv4 address domains, as described in clause 6.2 of 3GPP TS 29.513 [28], handled by the BSF. If not provided, the BSF can serve any IP domain. |
ipv6PrefixRanges |
array(Ipv6PrefixRange) |
O |
1..N |
List of ranges of IPv6 prefixes handled by the BSF. If not provided, the BSF can serve any IPv6 prefix. |
rxDiamHost |
DiameterIdentity |
C |
0..1 |
This IE shall be present if the BSF supports Rx interface. When present, this IE shall indicate the Diameter host of the Rx interface for the BSF. |
rxDiamRealm |
DiameterIdentity |
C |
0..1 |
This IE shall be present if the BSF supports Rx interface. When present, this IE shall indicate the Diameter realm of the Rx interface for the BSF. |
groupId |
NfGroupId |
O |
0..1 |
Identity of the BSF group that is served by the BSF instance. If not provided, the BSF instance does not pertain to any BSF group. (NOTE) |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPI’s served by the BSF instance (NOTE) |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of GPSIs served by the BSF instance (NOTE) |
NOTE: If none of these parameters are provided, the BSF can serve any SUPI or GPSI managed by the PLMN of the BSF instance. If "supiRanges" and "gpsiRanges" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this BSF instance is determined by the NRF. |
6.1.6.2.22 Type: Ipv4AddressRange
Table 6.1.6.2.22-1: Definition of type IPv4AddressRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
Ipv4Addr |
M |
1 |
First value identifying the start of an IPv4 address range |
end |
Ipv4Addr |
M |
1 |
Last value identifying the end of an IPv4 address range |
6.1.6.2.23 Type: Ipv6PrefixRange
Table 6.1.6.2.23-1: Definition of type IPv6PrefixRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
Ipv6Prefix |
M |
1 |
First value identifying the start of an IPv6 prefix range |
end |
Ipv6Prefix |
M |
1 |
Last value identifying the end of an IPv6 prefix range |
NOTE: When Ipv6PrefixRange is used to identify a range of IPv6 addresses served by certain NF (e.g. BSF), the range of IPv6 addresses identified by the IPv6PrefixRange shall include the entire IPv6 addresses represented by the "start" and "end" IPv6 prefixes. For example, if the "start" attribute is set to "240e:006a:0000:0000::/32" and the "end" attribute is set to "250e:006a:0000:0000::/32", the Ipv6PrefixRange identifies all the IPv6 addresses from the start IPv6 address "240e:006a:0000:0000::/32" to the end IPv6 address "250e:006a:ffff:ffff:ffff:ffff:ffff:ffff/32". |
6.1.6.2.24 Type: InterfaceUpfInfoItem
Table 6.1.6.2.24-1: Definition of type InterfaceUpfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
interfaceType |
UPInterfaceType |
M |
1 |
User Plane interface type |
ipv4EndpointAddresses |
array(Ipv4Addr) |
C |
1..N |
Available endpoint IPv4 address(es) of the User Plane interface (NOTE 1) (NOTE 2) |
ipv6EndpointAddresses |
array(Ipv6Addr) |
C |
1..N |
Available endpoint IPv6 address(es) of the User Plane interface (NOTE 1) (NOTE 2) |
endpointFqdn |
Fqdn |
C |
0..1 |
FQDN of available endpoint of the User Plane interface (NOTE 1) (NOTE 2) |
networkInstance |
string |
O |
0..1 |
Network Instance (See 3GPP TS 29.244 [21]) associated to the User Plane interface |
NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the InterfaceUpfInfoItem. NOTE 2: When interfaceType is "DATA_FORWARDING", the SMF shall ignore these IEs. The UPF shall register a dummy FQDN or IP address for interfaceType "DATA_FORWARDING" (for backward compatibility reason). |
6.1.6.2.25 Type: UriList
Table 6.1.6.2.25-1: Definition of type UriList
Attribute name |
Data type |
P |
Cardinality |
Description |
_links |
map(LinksValueSchema) |
O |
1..N |
See clause 4.9.4 of 3GPP TS 29.501 [5] for the description of the members. In this map, the key "item", if present, shall contain an array of objects, where each object contains an "href" attribute containing the URI of the NF Instance. If the response contains no URIs to return, the "_links" attribute may be absent; if it is included, it shall only contain the "self" key (i.e. the "item" key shall be absent), and the "totalItemCount" attribute shall be set to 0. |
totalItemCount |
integer |
C |
0..1 |
This attribute should be included in the response and it shall contain the total number of items matching the input filter criteria of the request (e.g. "nf-type"). |
6.1.6.2.26 Type: N2InterfaceAmfInfo
Table 6.1.6.2.26-1: Definition of type N2InterfaceAmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4EndpointAddress |
array(Ipv4Addr) |
C |
1..N |
Available AMF endpoint IPv4 address(es) for N2 (see NOTE 1) |
ipv6EndpointAddress |
array(Ipv6Addr) |
C |
1..N |
Available AMF endpoint IPv6 address(es) for N2 (see NOTE 1) |
amfName |
AmfName |
O |
0..1 |
AMF Name FQDN as defined in clause 28.3.2.5 of 3GPP TS 23.003 [12]. |
NOTE 1: At least one of the addressing parameters (ipv4address or ipv6adress) shall be included. |
6.1.6.2.27 Type: TaiRange
Table 6.1.6.2.27-1: Definition of type TaiRange
Attribute name |
Data type |
P |
Cardinality |
Description |
plmnId |
PlmnId |
M |
1 |
PLMN ID related to the TacRange. |
tacRangeList |
array(TacRange) |
M |
1..N |
The range of the TACs |
nid |
Nid |
O |
0..1 |
NID related to the TacRange, for an SNPN |
6.1.6.2.28 Type: TacRange
Table 6.1.6.2.28-1: Definition of type TacRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
string |
O |
0..1 |
First value identifying the start of a TAC range, to be used when the range of TAC’s can be represented as a hexadecimal range (e.g., TAC ranges). 3-octet string identifying a tracking area code, each character in the string shall take a value of "0" to "9" 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. Pattern: "^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$" |
end |
string |
O |
0..1 |
Last value identifying the end of a TAC range, to be used when the range of TAC’s can be represented as a hexadecimal range (e.g. TAC ranges). 3-octet string identifying a tracking area code, each character in the string shall take a value of "0" to "9" 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. Pattern: "^([A-Fa-f0-9]{4}|[A-Fa-f0-9]{6})$" |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of TAC’s belonging to this range. A TAC value is considered part of the range if and only if the TAC string fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
EXAMPLE 1: TAC range. From: 543000 To: 5433E7 (i.e., 1000 TAC numbers)
JSON: { "start": "543000", "end": "5433E7" }
EXAMPLE 2: TAC range. From: 54E000 To: 54EFFF (i.e., 4096 TAC numbers)
JSON: { "pattern": "^54E[0-9a-fA-F]{3}$" }, or
JSON: { "start": "54E000", "end": "54EFFF" }
6.1.6.2.29 Type: SnssaiSmfInfoItem
Table 6.1.6.2.29-1: Definition of type SnssaiSmfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
Supported S-NSSAI (NOTE) |
dnnSmfInfoList |
array(DnnSmfInfoItem) |
M |
1..N |
List of parameters supported by the SMF per DNN |
NOTE: An SMF may register SD ranges or a wildcard SD if the SMF profile is not discoverable from other PLMNs and if the NRF and all consumers of the SMF profile in the same PLMN have been upgraded to support SD ranges and wildcard SD in this attribute. |
6.1.6.2.30 Type: DnnSmfInfoItem
Table 6.1.6.2.30-1: Definition of type DnnSmfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN (NOTE) or Wildcard DNN if the SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
dnaiList |
array(Dnai) |
O |
1..N |
List of DNAIs or Wildcard DNAI supported by the SMF for this DNN. (See NOTE 2) |
NOTE 1: For a SMF which only supports the I-SMF related functionalities, the dnn attribute may be an invalid DNN according to operator’s local policy. NOTE 2: The Wildcard DNAI included in the "dnaiList" attribute indicates that the SMF can be selected for this DNN for any DNAI. The absence of "dnaiList" attribute does not mean that the SMF (e.g. pre-Rel-17 compliant) does not support any DNAI, but the SMF did not indicate which DNAIs it may support. |
6.1.6.2.31 Type: NrfInfo
Table 6.1.6.2.31-1: Definition of type NrfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
servedUdrInfo |
map(UdrInfo) |
O |
1..N |
This attribute contains all the udrInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the udrInfo belongs to. |
servedUdrInfoList |
map(map(UdrInfo)) |
O |
1..N(1..M) |
This attribute contains the udrInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedUdmInfo |
map(UdmInfo) |
O |
1..N |
This attribute contains all the udmInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the udmInfo belongs to. |
servedUdmInfoList |
map(map(UdmInfo)) |
O |
1..N(1..M) |
This attribute contains the udmInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedAusfInfo |
map(AusfInfo) |
O |
1..N |
This attribute contains all the ausfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the ausfInfo belongs to. |
servedAusfInfoList |
map(map(AusfInfo)) |
O |
1..N(1..M) |
This attribute contains the ausfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedAmfInfo |
map(AmfInfo) |
O |
1..N |
This attribute contains all the amfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the amfInfo belongs to. |
servedAmfInfoList |
map(map(AmfInfo)) |
O |
1..N(1..M) |
This attribute contains the amfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedSmfInfo |
map(SmfInfo) |
O |
1..N |
This attribute contains all the smfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the smfInfo belongs to. |
servedSmfInfoList |
map(map(SmfInfo)) |
O |
1..N(1..M) |
This attribute contains the smfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedUpfInfo |
map(UpfInfo) |
O |
1..N |
This attribute contains all the upfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the upfInfo belongs to. |
servedUpfInfoList |
map(map(UpfInfo)) |
O |
1..N(1..M) |
This attribute contains the upfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedPcfInfo |
map(PcfInfo) |
O |
1..N |
This attribute contains all the pcfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the pcfInfo belongs to. |
servedPcfInfoList |
map(map(PcfInfo)) |
O |
1..N(1..M) |
This attribute contains the pcfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedBsfInfo |
map(BsfInfo) |
O |
1..N |
This attribute contains all the bsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the bsfInfo belongs to. |
servedBsfInfoList |
map(map(BsfInfo)) |
O |
1..N(1..M) |
This attribute contains the bsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedChfInfo |
map(ChfInfo) |
O |
1..N |
This attribute contains all the chfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the chfInfo belongs to. |
servedChfInfoList |
map(map(ChfInfo)) |
O |
1..N(1..M) |
This attribute contains the chfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedNefInfo |
map(NefInfo) |
O |
1..N |
This attribute contains all the nefInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the nefInfo belongs to. |
servedNwdafInfo |
map(NwdafInfo) |
O |
1..N |
This attribute contains all the nwdafInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the nwdafInfo belongs to. |
servedNwdafInfoList |
map(map(NwdafInfo)) |
O |
1..N |
This attribute contains all the nwdafInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedPcscfInfoList |
map(map(PcscfInfo)) |
O |
1..N(1..M) |
This attribute contains all the pcscfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedGmlcInfo |
map(GmlcInfo) |
O |
1..N |
This attribute contains all the gmlcInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the gmlcInfo belongs to. |
servedLmfInfo |
map(LmfInfo) |
O |
1..N |
This attribute contains all the lmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the lmfInfo belongs to. |
servedNfInfo |
map(NfInfo) |
O |
1..N |
This attribute contains information of other NFs without corresponding NF type specific Info extensions locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of the NF. |
servedHssInfoList |
map(map(HssInfo)) |
O |
1..N(1..M) |
This attribute contains all the hssInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedUdsfInfo |
map(UdsfInfo) |
O |
1..N |
This attribute contains all the udsfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedUdsfInfoList |
map(map(UdsfInfo)) |
O |
1..N(1..M) |
This attribute contains the udsfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedScpInfoList |
map(ScpInfo) |
O |
1..N |
This attribute contains the scpInfo attribute locally configured in the NRF or that the NRF received during SCP registration. The key of the map is the nfInstanceId to which the scpInfo belongs to. |
servedSeppInfoList |
map(SeppInfo) |
O |
1..N |
This attribute contains the seppInfo attribute locally configured in the NRF or that the NRF received during SEPP registration. The key of the map is the nfInstanceId to which the seppInfo belongs to. |
servedAanfInfoList |
map(map(AanfInfo)) |
O |
1..N(1..M) |
This attribute contains the aanfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
served5gDdnmfInfo |
map(5GDdnmfInfo) |
O |
1..N |
This attribute contains all the 5GDdnmfInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the 5GDdnmfInfo belongs to. |
servedMfafInfoList |
map(MfafInfo) |
O |
1..N |
This attribute contains the mfafInfo attribute locally configured in the NRF or that the NRF received during MFAF registration. The key of the map is the nfInstanceId to which the mfafInfo belongs to. |
servedEasdfInfoList |
map(map(EasdfInfo)) |
O |
1..N(1..M) |
This attribute contains the easdfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedDccfInfoList |
map(DccfInfo) |
O |
1..N |
This attribute contains the dccfInfo attribute locally configured in the NRF or that the NRF received during DCCF registration. The key of the map is the nfInstanceId to which the dccfInfo belongs to. |
servedMbSmfInfoList |
map(map(MbSmfInfo)) |
O |
1..N(1..M) |
This attribute contains the mbSmfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedTsctsfInfoList |
map(map(TsctsfInfo)) |
O |
1..N(1..M) |
This attribute contains the tsctsfInfoList attribute locally configured in the NRF or that the NRF received during TSCTSF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedMbUpfInfoList |
map(map(MbUpfInfo)) |
O |
1..N(1..M) |
This attribute contains the mbUpfInfoList attribute locally configured in the NRF or that the NRF received during NF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedTrustAfInfo |
map(TrustAfInfo) |
O |
1..N |
This attribute contains the trustAfInfo attribute locally configured in the NRF or that the NRF received during AF registration. The key of the map is the nfInstanceId to which the map entry belongs to. |
servedNssaafInfo |
map(NssaafInfo) |
O |
1..N |
This attribute contains all the nssaafInfo attributes locally configured in the NRF or the NRF received during NF registration. The key of the map is the nfInstanceId of which the nssaafInfo belongs to. |
NOTE 1: The absence of these parameters means the NRF is able to serve any NF discovery request. NOTE 2: For any of the servedxxxInfo/servedxxxInfoList attributes (other than servedNfInfo), if the data type definition of the corresponding xxxInfo attribute allows to use an empty JSON object, the registering NRF shall include in the servedxxxInfo/servedxxxInfoList a map entry with an empty JSON object as value, to indicate the registration of an NF Instance that did not include any xxxInfo/xxxInfoList attributes; otherwise, the registering NRF shall check the support of the feature "Empty-Objects-Nrf-Info" (see clause 6.1.9) in the target NRF and, if the feature is not supported, it shall use the generic servedNfInfo attribute (instead of the servedxxxInfo corresponding to its NF type) to signal the registration of such NF instance with absent xxxInfo/xxxInfoList attributes. |
6.1.6.2.32 Type: ChfInfo
Table 6.1.6.2.32-1: Definition of type ChfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
supiRangeList |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs that can be served by the CHF instance. (NOTE 1) |
gpsiRangeList |
array(IdentityRange) |
O |
1..N |
List of ranges of GPSI that can be served by the CHF instance. (NOTE 1) |
plmnRangeList |
array(PlmnRange) |
O |
1..N |
List of ranges of PLMNs (including the PLMN IDs of the CHF instance) that can be served by the CHF instance. If not provided, the CHF can serve any PLMN. |
groupId |
NfGroupId |
O |
0..1 |
Identity of the CHF group that is served by the CHF instance. If not provided, the CHF instance does not pertain to any CHF group. (NOTE 1) |
primaryChfInstance |
NfInstanceId |
C |
0..1 |
This IE shall be present if the CHF instance serves as a secondary CHF instance of another primary CHF instance. When present, it shall be set to the NF Instance Id of the primary CHF instance. This IE shall be absent if the secondaryChfInstance is present. (NOTE 2, NOTE 3) |
secondaryChfInstance |
NfInstanceId |
C |
0..1 |
This IE shall be present if the CHF instance serves as a primary CHF instance of another secondary CHF instance. When present, it shall be set to the NF Instance Id of the secondary CHF instance. This IE shall be absent if the primaryChfInstance is present. (NOTE 2, NOTE 3) |
NOTE 1: If none of these parameters are provided, the CHF can serve any SUPI or GPSI managed by the PLMN of the CHF instance. If "supiRangeList" and "gpsiRangeList" attributes are absent, and "groupId" is present, the SUPIs / GPSIs served by this CHF instance is determined by the NRF (see 3GPP TS 23.501 [2], clause 6.2.6.2). NOTE 2: The NF Service Consumer of the CHF may use these attributes as primary/secondary redundancy mechanism, or alternatively, it may also rely on the availability of an NF Set (or NF Service Set) of CHF Instances (or CHF Service Instances) for the same purpose. NOTE 3: If the CHF does not provide NF set ID or NF Service Set ID in NFProfile, it shall provide one of these attributes. These attributes may be present if the CHF registers an NF set ID or NF service set ID. |
6.1.6.2.33 Void
6.1.6.2.34 Type: PlmnRange
Table 6.1.6.2.34-1: Definition of type PlmnRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
string |
O |
0..1 |
First value identifying the start of a PLMN range. The string shall be encoded as follows: <MCC><MNC> Pattern: ‘^[0-9]{3}[0-9]{2,3}$’ |
end |
string |
O |
0..1 |
Last value identifying the end of a PLMN range. The string shall be encoded as follows: <MCC><MNC> Pattern: ‘^[0-9]{3}[0-9]{2,3}$’ |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of PLMNs belonging to this range. A PLMN value is considered part of the range if and only if the PLMN string (formatted as <MCC><MNC>) fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
EXAMPLE 1: PLMN range. MCC 123, any MNC
JSON: { "start": "12300", "end": "123999" }
EXAMPLE 2: PLMN range. MCC 123, MNC within range 45 to 49
JSON: { "pattern": "^1234[5-9]$" }, or
JSON: { "start": "12345", "end": "12349" }
EXAMPLE 3: PLMN range. MCC within range 123 to 257, any MNC
JSON: { "start": "12300", "end": "257999" }
6.1.6.2.35 Type: SubscrCond
Table 6.1.6.2.35-1: Definition of type SubscrCond as a list of mutually exclusive alternatives
Data type |
Cardinality |
Description |
NfInstanceIdCond |
1 |
Subscription to a given NF Instance |
NfInstanceIdListCond |
1 |
Subscription to a list of NF Instances |
NfTypeCond |
1 |
Subscription to a set of NF Instances, identified by their NF Type |
ServiceNameCond |
1 |
Subscription to a set of NF Instances that offer a certain service name |
ServiceNameListCond |
1 |
Subscription to a set of NF Instances that offer a service name in the Service Name list. |
AmfCond |
1 |
Subscription to a set of NF Instances (AMFs), belonging to a certain AMF Set and/or belonging to a certain AMF Region. |
GuamiListCond |
1 |
Subscription to a set of NF Instances (AMFs) identified by their Guamis (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). |
NetworkSliceCond |
1 |
Subscription to a set of NF Instances, identified by S-NSSAI(s) and NSI ID(s). |
NfGroupCond |
1 |
Subscription to a set of NF Instances, identified by a NF (UDM, AUSF, PCF, CHF, HSS or UDR) Group Identity. |
NfGroupListCond |
1 |
Subscription to a set of NF Instances, identified by a NF Group Identity in the NF Group Identity list. |
NfSetCond |
1 |
Subscription to a set of NF Instances belonging to a certain NF Set. |
NfServiceSetCond |
1 |
Subscription to a set of NF Service Instances, or to a set of equivalent NF Service Instances. |
UpfCond |
1 |
Subscription to a set of NF Instances (UPFs), able to serve a certain service area (i.e. SMF serving area or TAI list). |
ScpDomainCond |
1 |
Subscription to a set of NF, SCP or SEPP instances belonging to certain SCP domains. |
NwdafCond |
1 |
Subscription to a set of NF Instances (NWDAFs), identified by Analytics ID(s), S-NSSAI(s) or NWDAF Serving Area information, i.e. list of TAIs for which the NWDAF can provide analytics. |
NefCond |
1 |
Subscription to a set of NF Instances (NEFs), identified by Event ID(s) provided by AF, S-NSSAI(s), AF Instance ID, Application Identifier, External Identifier, External Group Identifier, or domain name. |
DccfCond |
1 |
Subscription to a set of NF Instances (DCCFs), identified by NF types, NF Set Id(s) or DCCF Serving Area information, i.e. list of TAIs served by the DCCF. |
6.1.6.2.36 Type: NfInstanceIdCond
Table 6.1.6.2.36-1: Definition of type NfInstanceIdCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfInstanceId |
NfInstanceId |
M |
1 |
NF Instance ID of the NF Instance whose status is requested to be monitored. |
6.1.6.2.37 Type: NfTypeCond
Table 6.1.6.2.37-1: Definition of type NfTypeCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfType |
NFType |
M |
1 |
NF type of the NF Instances whose status is requested to be monitored. |
NOTE: This type shall not contain the attribute "nfGroupId", to avoid that this type has a matching definition with "NfGroupCond" type. |
6.1.6.2.38 Type: ServiceNameCond
Table 6.1.6.2.38-1: Definition of type ServiceNameCond
Attribute name |
Data type |
P |
Cardinality |
Description |
serviceName |
ServiceName |
M |
1 |
Service name offered by the NF Instances whose status is requested to be monitored. |
6.1.6.2.39 Type: AmfCond
Table 6.1.6.2.39-1: Definition of type AmfCond
Attribute name |
Data type |
P |
Cardinality |
Description |
amfSetId |
AmfSetId |
C |
1 |
AMF Set ID of the NF Instances (AMF) whose status is requested to be monitored. |
amfRegionId |
AmfRegionId |
C |
1 |
AMF Region ID of the NF Instances (AMF) whose status is requested to be monitored. |
NOTE 1: At least amfSetId or amfRegionId shall be present; if both the amfRegionId and amfSetId attributes are present in the SubscriptionData, this indicates a subscription for notifications satisfying both attributes (i.e. notifications for NFs from that amfRegionId and amfSetId). NOTE 2: The PLMN ID (or PLMN ID and NID) of the AMF Region and AMF Set of the NF Instances (AMF) whose status is requested to be monitored may be indicated in the plmnId attribute (or plmnid and nid attributes) in the SubscriptionData. |
6.1.6.2.40 Type: GuamiListCond
Table 6.1.6.2.40-1: Definition of type GuamiListCond
Attribute name |
Data type |
P |
Cardinality |
Description |
guamiList |
array(Guami) |
M |
1..N |
Guamis of the NF Instances (AMFs) whose status is requested to be monitored (i.e. whose guamiList IE in the amfInfo or amfInfoList IE matches at least one of the GUAMI in the guamiList IE of the subscription). |
6.1.6.2.41 Type: NetworkSliceCond
Table 6.1.6.2.41-1: Definition of type NetworkSliceCond
Attribute name |
Data type |
P |
Cardinality |
Description |
snssaiList |
array(Snssai) |
M |
1..N |
S -NSSAIs of the NF Instances whose status is requested to be monitored. |
nsiList |
array(string) |
O |
1..N |
NSI IDs of the NF Instances whose status is requested to be monitored. |
6.1.6.2.42 Type: NfGroupCond
Table 6.1.6.2.42-1: Definition of type NfGroupCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfType |
string |
M |
1 |
NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. |
nfGroupId |
NfGroupId |
M |
1 |
Group ID of the NF Instances whose status is requested to be monitored. |
6.1.6.2.43 Type: NotifCondition
Table 6.1.6.2.43-1: Definition of type NotifCondition
Attribute name |
Data type |
P |
Cardinality |
Description |
monitoredAttributes |
array(string) |
C |
1..N |
List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile. If this attribute is present, the NRF shall send notification only for changes in the attributes included in this list (see NOTE 1). |
unmonitoredAttributes |
array(string) |
C |
1..N |
List of JSON Pointers (as specified in IETF RFC 6901 [14]) of attributes in the NF Profile. If this attribute is present, the NRF shall send notification for changes on any attribute, except for those included in this list (see NOTE 1). |
NOTE 1: Attributes "monitoredAttributes" and "unmonitoredAttributes" shall not be included simultaneously |
EXAMPLE 1: The following JSON object would represent a monitoring condition where the client requests to be notified of all changes on the NF Profile, except "load" attribute.
{
"unmonitoredAttributes": [ "/load" ]
}
EXAMPLE 2: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on attribute "nfStatus":
{
"monitoredAttributes": [ "/nfStatus" ]
}
EXAMPLE 3: The following JSON object would represent a monitoring condition where the client requests to be notified only of changes on the first item of "nfServices":
{
"monitoredAttributes": [ "/nfServices/0" ]
}
6.1.6.2.44 Type: PlmnSnssai
Table 6.1.6.2.44-1: Definition of type PlmnSnssai
Attribute name |
Data type |
P |
Cardinality |
Description |
plmnId |
PlmnId |
M |
1 |
PLMN ID for which list of supported S-NSSAI(s) is provided. |
sNssaiList |
array(ExtSnssai) |
M |
1..N |
The specific list of S-NSSAIs supported by the given PLMN or SNPN. |
nid |
Nid |
O |
0..1 |
NID for which list of supported S-NSSAI(s) is provided. |
6.1.6.2.45 Type: NwdafInfo
Table 6.1.6.2.45-1: Definition of type NwdafInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
eventIds |
array(EventId) |
C |
1..N |
EventId(s) supported by the Nnwdaf_AnalyticsInfo service, if none are provided the NWDAF can serve any eventId. |
nwdafEvents |
array(NwdafEvent) |
C |
1..N |
Event(s) supported by the Nnwdaf_EventsSubscription service, if none are provided the NWDAF can serve any nwdafEvent. |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the NWDAF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NWDAF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the NWDAF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the NWDAF can be selected for any TAI in the serving network. |
nwdafCapability |
NwdafCapability |
O |
0..1 |
If present, this IE shall indicate the capability of the NWDAF. If not present, the NWDAF shall be regarded with no capability. |
analyticsDelay |
DurationSec |
O |
0..1 |
Supported Analytics Delay related to the eventIds and nwdafEvents. |
servingNfTypeList |
array(NFType) |
O |
1..N |
If present, this IE shall contain the list of NF type(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF type. |
servingNfSetIdList |
array(NfSetId) |
O |
1..N |
If present, this IE shall contain the list of NF Set Id(s) from which the NWDAF NF can collect data. The absence of this attribute indicates that the NWDAF can collect data from any NF Set. |
mlAnalyticsList |
array(MlAnalyticsInfo) |
C |
1..N |
ML Analytics Filter information supported by the Nnwdaf_MLModelProvision service. |
6.1.6.2.46 Type: LmfInfo
Table 6.1.6.2.46-1: Definition of type LmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
servingClientTypes |
array(ExternalClientType) |
C |
1..N |
This IE shall be present if the LMF is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this LMF instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list. Absence of this IE means the LMF is not dedicated to serve specific client types. |
lmfId |
LMFIdentification |
C |
0..1 |
When present, this ID shall indicate the LMF identification. |
servingAccessTypes |
array(AccessType) |
C |
1..N |
If included, this IE shall contain the access type (i.e. 3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the LMF. If not included, it shall be assumed that all access types are supported. |
servingAnNodeTypes |
array(AnNodeType) |
C |
1..N |
If included, this IE shall contain the AN node type (i.e. gNB or NG-eNB) supported by the LMF. If not included, it shall be assumed that all AN node types are supported. |
servingRatTypes |
array(RatType) |
C |
1..N |
If included, this IE shall contain the RAT type (e.g. 5G NR, eLTE or any of the RAT Types specified for NR satellite access) supported by the LMF. If not included, it shall be assumed that all RAT types are supported. |
taiList |
array(Tai) |
O |
1..N |
When present, this IE shall contain TAI list that the LMF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the LMF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
When present, this IE shall contain TAI range list that the LMF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the LMF can be selected for any TAI in the serving network. |
supportedGADShapes |
array(SupportedGADShapes) |
O |
1..N |
If included, this IE shall contain the GAD shapes supported by the LMF. If not included, it doesn’t indicate that the LMF doesn’t support any GAD shapes. |
6.1.6.2.47 Type: GmlcInfo
Table 6.1.6.2.47-1: Definition of type GmlcInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
servingClientTypes |
array(ExternalClientType) |
C |
1..N |
This IE shall be present if the GMLC is dedicated to serve the listed external client type(s), e.g. emergency client. The NRF should only include this GMLC instance to NF discovery with "client-type" query parameter indicating one of the external client types in the list. Absence of this IE means the GMLC is not dedicated to serve specific client types. |
gmlcNumbers |
array(string) |
O |
1..N |
This IE shall be present if the GMLC is configured with a number of GMLC Numbers. When present, each item of the array shall carry an OctetString indicating the ISDN number of the GMLC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string. Pattern for each iterm of the array: "^[0-9]{5,15}$" |
6.1.6.2.48 Type: NefInfo
Table 6.1.6.2.48-1: Definition of type NefInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
nefId |
NefId |
C |
0..1 |
This IE shall be present and contain the NEF ID of the NEF if NIDD service is supported. |
pfdData |
PfdData |
O |
0..1 |
PFD data, containing the list of internal application identifiers and/or the list of application function identifiers for which the PFDs can be provided. Absence of this attribute indicates that the PFDs for any internal application identifier and for any application function identifier can be provided. |
afEeData |
AfEventExposureData |
O |
0..1 |
The AF provided event exposure data. The NEF registers such information in the NRF on behalf of the AF. |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
Range(s) of External Identifiers |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
Range(s) of External Group Identifiers |
servedFqdnList |
array(string) |
O |
1..N |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names served by the NEF |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the NEF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicates that the NEF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the NEF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicates that the NEF can be selected for any TAI in the serving network. |
dnaiList |
array(Dnai) |
O |
1..N |
List of Data network access identifiers supported by the NEF. The absence of this attribute indicates that the NEF can be selected for any DNAI. |
unTrustAfInfoList |
array(UnTrustAfInfo) |
O |
1..N |
List of information corresponding to the AFs. |
uasNfFunctionalityInd |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the NEF supports UAS NF functionality: – true: UAS NF functionality is supported by the NEF – false (default): UAS NF functionality is not supported by the NEF. |
6.1.6.2.49 Type: PfdData
Table 6.1.6.2.49-1: Definition of type PfdData
Attribute name |
Data type |
P |
Cardinality |
Description |
appIds |
array(string) |
O |
1..N |
List of internal application identifiers of the managed PFDs. |
afIds |
array(string) |
O |
1..N |
List of application function identifiers of the managed PFDs. |
6.1.6.2.50 Type: AfEventExposureData
Table 6.1.6.2.50-1: Definition of type AfEventExposureData
Attribute name |
Data type |
P |
Cardinality |
Description |
afEvents |
array(AfEvent) |
M |
1..N |
AF Event(s) exposed by the NEF after registration of the AF(s) at the NEF. |
afIds |
array(string) |
O |
1..N |
Associated AF identifications to the AfEvents. The absence of this attribute indicate that the NEF can be selected for any AF. |
appIds |
array(string) |
O |
1..N |
The list of Application ID(s) the AF(s) connected to the NEF supports. The absence of this attribute indicate that the NEF can be selected for any Application. |
6.1.6.2.51 Type: WAgfInfo
Table 6.1.6.2.51-1: Definition of type WAgfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4EndpointAddresses |
array(Ipv4Addr) |
C |
1..N |
Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). |
ipv6EndpointAddresses |
array(Ipv6Addr) |
C |
1..N |
Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). |
endpointFqdn |
Fqdn |
C |
0..1 |
Available endpoint FQDN of the N3 terminations (NOTE 1). |
NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the WAgfInfo. |
6.1.6.2.52 Type: TngfInfo
Table 6.1.6.2.52-1: Definition of type TngfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4EndpointAddresses |
array(Ipv4Addr) |
C |
1..N |
Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1). |
ipv6EndpointAddresses |
array(Ipv6Addr) |
C |
1..N |
Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1). |
endpointFqdn |
Fqdn |
C |
0..1 |
Available endpoint FQDN of the N3 terminations (NOTE 1). |
NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the TngfInfo. |
6.1.6.2.53 Type: PcscfInfo
Table 6.1.6.2.53-1: Definition of type PcscfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
accessType |
array(AccessType) |
C |
1..N |
If included, this IE shall contain the access type (3GPP_ACCESS and/or NON_3GPP_ACCESS) supported by the P-CSCF. If not included, it shall be assumed that all access types are supported. |
dnnList |
array(Dnn) |
O |
1..N |
DNNs supported by the P-CSCF. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. If not provided, the P-CSCF can serve any DNN. |
gmFqdn |
Fqdn |
O |
0..1 |
FQDN of the P-CSCF for the Gm interface |
gmIpv4Addresses |
array(Ipv4Addr) |
O |
1..N |
IPv4 address(es) of the P-CSCF for the Gm interface |
gmIpv6Addresses |
array(Ipv6Addr) |
O |
1..N |
IPv6 address(es) of the P-CSCF for the Gm interface |
mwFqdn |
Fqdn |
O |
0..1 |
FQDN of the P-CSCF for the Mw interface (NOTE) |
mwIpv4Addresses |
array(Ipv4Addr) |
O |
1..N |
IPv4 address(es) of the P-CSCF for the Mw interface (NOTE) |
mwIpv6Addresses |
array(Ipv6Addr) |
O |
1..N |
IPv6 address(es) of the P-CSCF for the Mw interface (NOTE) |
servedIpv4AddressRanges |
array(Ipv4AddressRange) |
O |
1..N |
List of ranges of UE IPv4 addresses used on the Gm interface, served by P-CSCF. The absence of this attribute does not mean the P-CSCF can serve any IPv4 address. |
servedIpv6PrefixRanges |
array(Ipv6PrefixRange) |
O |
1..N |
List of ranges of UE IPv6 prefixes used on the Gm interface, served by P-CSCF. The absence of this attribute does not mean the P-CSCF can serve any IPv6 prefix. |
NOTE: The Mw addressing information of the P-CSCF may be used by other NFs (e.g., SMF) in P-CSCF restoration scenarios (see 3GPP TS 23.380 [45], clause 5.8.4.2 and clause 5.8.5.2), where a mapping between Gm and Mw addresses may be used to determine the updated list of P-CSCFs to be sent to the UE, after excluding those P-CSCF instances that have been deemed as failed by the S-CSCF. |
6.1.6.2.54 Type: NfSetCond
Table 6.1.6.2.54-1: Definition of type NfSetCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfSetId |
NfSetId |
M |
1 |
NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]) of NF Instances whose status is requested to be monitored. |
6.1.6.2.55 Type: NfServiceSetCond
Table 6.1.6.2.55-1: Definition of type NfServiceSetCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfServiceSetId |
NfServiceSetId |
M |
1 |
NF Service Set ID (see clause 28.13 of 3GPP TS 23.003 [12]) of NF service instances whose status is requested to be monitored. |
nfSetId |
NfSetId |
C |
0..1 |
NF Set ID (see clause 28.12 of 3GPP TS 23.003 [12]). This attribute shall be included if the consumer requests to monitor the status of all equivalent NF Service Instances in the provided NF Set ID and NF Service Set ID. |
6.1.6.2.56 Type: NfInfo
Table 6.1.6.2.56-1: Definition of type NfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
nfType |
NFType |
M |
1 |
This IE shall indicate the type of the NF. |
6.1.6.2.57 Type: HssInfo
Table 6.1.6.2.57-1: Definition of type HssInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the HSS group that is served by the HSS instance. If not provided, the HSS instance does not pertain to any HSS group. (NOTE 1) |
imsiRanges |
array(ImsiRange) |
O |
1..N |
List of ranges of IMSIs whose profile data is available in the HSS instance (NOTE 1) |
imsPrivateIdentityRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of IMS Private Identities whose profile data is available in the HSS instance (NOTE 1, NOTE 2) |
imsPublicIdentityRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of IMS Public Identities whose profile data is available in the HSS instance (NOTE 1) |
msisdnRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of MSISDNs whose profile data is available in the HSS instance (NOTE 1) |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of external group IDs that can be served by this HSS instance. If not provided, the HSS instance does not serve any external groups. |
hssDiameterAddress |
NetworkNodeDiameterAddress |
O |
0..1 |
Diameter Address of the HSS |
additionalDiamAddresses |
array(NetworkNodeDiameterAddress) |
O |
1..N |
Additional Diameter Addresses of the HSS; may be present if hssDiameterAddress is present |
NOTE 1: If none of these parameters are provided, the HSS can serve any IMSI or IMS Private Identity or IMS Public Identity or MSISDN managed by the PLMN of the HSS instance. If "imsiRanges", "imsPrivateIdentityRanges", "imsPublicIdentityRanges" and "msisdnRanges" attributes are absent, and "groupId" is present, the IMSIs / IMS Private Identities / IMS Public Identities / MSISDNs served by this HSS instance is determined by the NRF. NOTE 2: In deployments where the users IMPIs are derived from their IMSIs (see 3GPP TS 23.003 [12], clause 13.3, the HSS shall only register imsiRanges in NRF. |
6.1.6.2.58 Type: ImsiRange
Table 6.1.6.2.58-1: Definition of type ImsiRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
string |
O |
0..1 |
First value identifying the start of a IMSI range. Pattern: "^[0-9]+$" |
end |
string |
O |
0..1 |
Last value identifying the end of a IMSI range. Pattern: "^[0-9]+$" |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of IMSIs belonging to this range. An IMSI value is considered part of the range if and only if the IMSI string fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
6.1.6.2.59 Type: InternalGroupIdRange
Table 6.1.6.2.59-1: Definition of type InternalGroupIdRange
Attribute name |
Data type |
P |
Cardinality |
Description |
start |
GroupId |
O |
0..1 |
First value identifying the start of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. |
end |
GroupId |
O |
0..1 |
Last value identifying the end of an identity range, to be used when the range of identities can be represented as a consecutive numeric range. |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of identities belonging to this range. An identity value is considered part of the range if and only if the identity string fully matches the regular expression. |
NOTE: Either the start and end attributes, or the pattern attribute, shall be present. |
6.1.6.2.60 Type: UpfCond
Table 6.1.6.2.60-1: Definition of type UpfCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "UPF_COND". |
smfServingArea |
array(string) |
C |
1..N |
SMF service area(s) of the UPF whose status is requested to be monitored. This IE shall be present if the monitored granularity is SMF service area(s). |
taiList |
array(Tai) |
C |
1..N |
TAI(s) of the UPF whose status is requested to be monitored. This IE shall be present if the monitored granularity is TAI list. |
6.1.6.2.61 Type: TwifInfo
Table 6.1.6.2.61-1: Definition of type TwifInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
ipv4EndpointAddresses |
array(Ipv4Addr) |
C |
1..N |
Available endpoint IPv4 address(es) of the N3 terminations (NOTE 1) |
ipv6EndpointAddresses |
array(Ipv6Addr) |
C |
1..N |
Available endpoint IPv6 address(es) of the N3 terminations (NOTE 1) |
endpointFqdn |
Fqdn |
C |
0..1 |
Available endpoint FQDN of the N3 terminations (NOTE 1) |
NOTE 1: At least one of the addressing parameters (ipv4address, ipv6adress or endpointFqdn) shall be included in the TwifInfo. |
6.1.6.2.62 Type: VendorSpecificFeature
Table 6.1.6.2.62-1: Definition of type VendorSpecificFeature
Attribute name |
Data type |
P |
Cardinality |
Description |
featureName |
string |
M |
1 |
String representing a proprietary feature specific to a given vendor. It is recommended that the case convention for these strings is the same as for enumerated data types (i.e. UPPER_WITH_UNDERSCORE; see 3GPP TS 29.501 [5], clause 5.1.1). |
featureVersion |
string |
M |
1 |
String representing the version of the feature. It is recommended that the versioning system follows the Semantic Versioning Specification [39]. |
6.1.6.2.63 Type: UdsfInfo
Table 6.1.6.2.63-1: Definition of type UdsfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
groupId |
NfGroupId |
O |
0..1 |
Identity of the UDSF group that is served by the UDSF instance. If not provided, the UDSF instance does not pertain to any UDSF group. |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs whose profile data is available in the UDSF instance (NOTE 1) |
storageIdRanges |
map(array(IdentityRange)) |
C |
1..N(1..M) |
A map (list of key-value pairs) where realmId serves as key and each value in the map is an array of IdentityRanges. Each IdentityRange is a range of storageIds. A UDSF complying with this version of the specification shall include this IE. Absence indicates that the UDSF’s supported realms and storages are determined by the UDSF’s consumer by other means such as local provisioning. |
NOTE 1: If this parameter is not provided, then the UDSF can serve any SUPI range. |
6.1.6.2.64 Type: NfInstanceIdListCond
Table 6.1.6.2.64-1: Definition of type NfInstanceIdListCond
Attribute name |
Data type |
P |
Cardinality |
Description |
nfInstanceIdList |
array(NfInstanceId) |
C |
1..N |
A list of NF Instances whose status is requested to be monitored. |
6.1.6.2.65 Type: ScpInfo
Table 6.1.6.2.65-1: Definition of type ScpInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
scpDomainInfoList |
map(ScpDomainInfo) |
O |
1..N |
SCP domain specific information of the SCP that differs from the common information in NFProfile data type. The key of the map shall be the string identifying an SCP domain. |
scpPrefix |
string |
O |
0..1 |
Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4]. |
scpPorts |
map(integer) |
C |
1..N |
SCP port number(s) for HTTP and/or HTTPS (NOTE 1) This attribute shall be present if the SCP uses non-default HTTP and/or HTTPS ports and if the SCP does not provision port information within ScpDomainInfo for each SCP domain it belongs to. When present, it shall contain the HTTP and/or HTTPS ports. The key of the map shall be "http" or "https". The value shall indicate the port number for HTTP or HTTPS respectively. Minimum: 0 Maximum: 65535 |
addressDomains |
array(string) |
O |
1..N |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the address domain names reachable through the SCP. Absence of this IE indicates the SCP can reach any address domain names in the SCP domain(s) it belongs to. |
ipv4Addresses |
array(Ipv4Addr) |
O |
1..N |
List of IPv4 addresses reachable through the SCP. This IE may be present if IPv4 addresses are reachable via the SCP. If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4AddrRanges IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to. |
ipv6Prefixes |
array(Ipv6Prefix) |
O |
1..N |
List of IPv6 prefixes reachable through the SCP. This IE may be present if IPv6 addresses are reachable via the SCP. If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6PrefixRanges IE indicates the SCP can reach any IPv6 prefixes in the SCP domain(s) it belongs to. |
ipv4AddrRanges |
array(Ipv4AddressRange) |
O |
1..N |
List of IPv4 addresses ranges reachable through the SCP. This IE may be present if IPv4 addresses are reachable via the SCP. If IPv4 addresses are reachable via the SCP, absence of both this IE and ipv4Addresses IE indicates the SCP can reach any IPv4 addresses in the SCP domain(s) it belongs to. |
ipv6PrefixRanges |
array(Ipv6PrefixRange) |
O |
1..N |
List of IPv6 prefixes ranges reachable through the SCP. This IE may be present if IPv6 addresses are reachable via the SCP. If IPv6 addresses are reachable via the SCP, absence of both this IE and ipv6Prefixes IE indicates the SCP can reach any IPv6 prefixes in the SCP domain(s) it belongs to. |
servedNfSetIdList |
array(NfSetId) |
O |
1..N |
List of NF set ID of NFs served by the SCP. Absence of this IE indicates the SCP can reach any NF set in the SCP domain(s) it belongs to. |
remotePlmnList |
array(PlmnId) |
O |
1..N |
List of remote PLMNs reachable through the SCP. Absence of this IE indicates that no remote PLMN is reachable through the SCP. |
remoteSnpnList |
array(PlmnIdNid) |
O |
1..N |
List of remote SNPNs reachable through the SCP. The absence of this IE indicates that no remote SNPN is reachable through the SCP. |
ipReachability |
IpReachability |
O |
0..1 |
This IE may be present to indicate the type(s) of IP addresses reachable via the SCP in the SCP domain(s) it belongs to. Absence of this IE indicates that the SCP can be used to reach both IPv4 addresses and IPv6 addresses in the SCP domain(s) it belongs to. |
scpCapabilities |
array(ScpCapability) |
C |
0..N |
List of SCP capabilities supported by the SCP. This IE shall be present if the SCP supports at least one SCP capability. It may be present otherwise, with an empty array, to indicate that the SCP does not support any capability of the ScpCapability data type. The absence of this attribute shall not be interpreted as an SCP that does not support any capability; this only means that the SCP (e.g. pre-Rel-17 SCP) did not register the capabilities it may support. (NOTE 2) |
NOTE 1: If no SCP port information is present in ScpInfo or in ScpDomainInfo for a specific SCP domain, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 7540 [9] when sending a request to the SCP within the specific SCP domain. NOTE 2: This IE may be used by another SCP (e.g. SCP-c) to determine whether next hops’ SCP(s) (e.g. SCP-p) supports Indirect Communication with Delegated Discovery, e.g. in scenarios with more than one SCP between an NF service consumer and NF service producer. This information is not intended for NF service consumers. This information shall not be used for selecting a next hop SCP. It may only be used by an SCP, once a next hop SCP is selected, to learn the capabilities of the selected SCP, and based on local policy, to determine whether to delegate the selection of the target NF service producer instance to the next hop SCP or not. |
6.1.6.2.66 Type: ScpDomainInfo
Table 6.1.6.2.66-1: Definition of type ScpDomainInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
scpFqdn |
Fqdn |
C |
0..1 |
FQDN of the SCP (NOTE) |
scpIpEndPoints |
array(IpEndPoint) |
C |
1..N |
IP address(es) and port information of the SCP. If port information is present in this attribute, it applies to any scheme (i.e. HTTP and HTTPS). (NOTE) |
scpPorts |
map(integer) |
C |
1..N |
SCP port number(s) for HTTP and/or HTTPS. This attribute shall be present if the SCP uses different ports for HTTP and HTTPS and at least one port is not the default HTTP or HTTPS port, for this SCP domain. This attribute shall be absent if port information is present in the scpIpEndPoints. When present, it shall contain the HTTP and/or HTTPS ports. The key of the map shall be "http" or "https". The value shall indicate the port number for HTTP or HTTPS respectively. Minimum: 0 Maximum: 65535 If this attribute is present, it has precedence over the scpPorts attribute of ScpInfo. |
scpPrefix |
string |
O |
0..1 |
Optional deployment specific string used to construct the apiRoot of the next hop SCP, as described in clause 6.10 of 3GPP TS 29.500 [4]. If the scpPrefix attribute is present in ScpInfo and in ScpDomainInfo for a specific SCP domain, the attribute in ScpDomainInfo shall prevail for this SCP domain. |
NOTE: If any of these attributes is present for a given SCP domain, it shall apply instead of the attributes fqdn, Ipv4Addresses and Ipv6Addresses within the NFProfile data type for the corresponding SCP Domain. If none of these attributes is present for a given SCP domain, the attributes fqdn, Ipv4Addresses, and Ipv6Addresses within the NFProfile data type shall apply for the corresponding SCP Domain. |
6.1.6.2.67 Type: ScpDomainCond
Table 6.1.6.2.67-1: Definition of type ScpDomainCond
Attribute name |
Data type |
P |
Cardinality |
Description |
scpDomains |
array(string) |
M |
1..N |
SCP domains of NF, SCP or SEPP instances whose status is requested to be monitored. |
nfTypeList |
array(NFType) |
C |
1..N |
This IE shall be present if available. When present, it shall contain the type of the NF Instances or Network Entities (pertaining to any SCP domain in the scpDomains attribute) whose status is requested to be monitored. If not present, it means that the NF Service Consumer requests a subscription to all NF, SCP and SEPP instances pertaining to any SCP domain in the scpDomains attribute. |
6.1.6.2.68 Type: OptionsResponse
Table 6.1.6.2.68-1: Definition of type OptionsResponse
Attribute name |
Data type |
P |
Cardinality |
Description |
supportedFeatures |
SupportedFeatures |
C |
0..1 |
Supported features of the NRF, for the nf-instances store resource. See clause 6.1.9. This IE shall be included if at least one Nnrf_NFManagement feature is supported by the NRF. |
6.1.6.2.69 Type: NwdafCond
Table 6.1.6.2.69-1: Definition of type NwdafCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "NWDAF_COND". |
analyticsIds |
array(string) |
O |
1..N |
Analytics Id(s) provided by consumers of NWDAF. In this data type, it shall take the value as defined in NwdafEvent IE and EventId IE in nwdafInfo. |
snssaiList |
array(Snssai) |
O |
1..N |
S-NSSAIs of the NWDAF whose status is requested to be monitored. |
taiList |
array(Tai) |
O |
1..N |
TAI(s) of the NWDAF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs of the NWDAF whose status is requested to be monitored. It may contain non-3GPP access TAIs. |
servingNfTypeList |
array(NFType) |
O |
1..N |
NF type(s) served by the NWDAF whose status is requested to be monitored. |
servingNfSetIdList |
array(NfSetId) |
O |
1..N |
NF Set Id(s) served by the NWDAF whose status is requested to be monitored. |
mlAnalyticsList |
array(MlAnalyticsInfo) |
C |
1..N |
The list of ML Analytics Filter information per Analytics ID(s) supported by the NWDAF, whose status is requested to be monitored. |
6.1.6.2.70 Type: NefCond
Table 6.1.6.2.70-1: Definition of type NefCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "NEF_COND". |
afEvents |
array(AfEvent) |
O |
1..N |
EventId(s) supported by the AFs. |
snssaiList |
array(Snssai) |
O |
1..N |
S-NSSAIs of the NEF whose status is requested to be monitored. |
pfdData |
PfdData |
O |
0..1 |
PFD data of the NEF whose status is requested to be monitored. |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
Range(s) of External Identifiers of the NEF whose status is requested to be monitored. |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
Range(s) of External Group Identifiers of the NEF whose status is requested to be monitored. |
servedFqdnList |
array(string) |
O |
1..N |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the Domain names of the NEF whose status is requested to be monitored. |
6.1.6.2.71 Type: SuciInfo
Table 6.1.6.2.71-1: Definition of type SuciInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
routingInds |
array(string) |
O |
1..N |
Indicating served Routing Indicator (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any Routing Indicator. |
hNwPubKeyIds |
array(integer) |
O |
1..N |
Indicating served Home Network Public Key (see 3GPP TS 23.003 [12], clause 2.2B). If not provided, the AUSF/UDM can serve any public key. |
NOTE: Any combination of any routingInds value and any hNwPubKeyIds value is valid. |
6.1.6.2.72 Type: SeppInfo
Table 6.1.6.2.72-1: Definition of type SeppInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
seppPrefix |
string |
O |
0..1 |
Optional deployment specific string used to construct the apiRoot of the next hop SEPP, as described in clause 6.10 of 3GPP TS 29.500 [4]. |
seppPorts |
map(integer) |
C |
1..N |
SEPP port number(s) for HTTP and/or HTTPS (NOTE 1) This attribute shall be present if the SEPP uses non-default HTTP and/or HTTPS ports. When present, it shall contain the HTTP and/or HTTPS ports. The key of the map shall be "http" or "https". The value shall indicate the port number for HTTP or HTTPS respectively. Minimum: 0 Maximum: 65535 |
remotePlmnList |
array(PlmnId) |
O |
1..N |
List of remote PLMNs reachable through the SEPP. The absence of this attribute indicates that any PLMN is reachable through the SEPP. |
remoteSnpnList |
array(PlmnIdNid) |
O |
1..N |
List of remote SNPNs reachable through the SEPP. The absence of this attribute indicates that no SNPN is reachable through the SEPP. |
n32Purposes |
array(N32Purpose) |
C |
1..N |
This IE should be present if the SEPP is configured to support specific N32 purposes. When present, it shall contain the list of N32 purposes supported by the SEPP. The absence of this IE indicates that the SEPP can be selected for any N32 purpose. |
NOTE 1: If no SEPP port information is present in SeppInfo, the HTTP client shall use the default HTTP port number, i.e. TCP port 80 for "http" URIs or TCP port 443 for "https" URIs as specified in IETF RFC 7540 [9] when sending a request to the SEPP. NOTE 2: The attributes fqdn, ipv4Addresses and ipv6Addresses within the NFProfile data type shall be used to determine the SEPP address. |
6.1.6.2.73 Type: AanfInfo
Table 6.1.6.2.73-1: Definition of type AanfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
routingIndicators |
array(string) |
O |
1..N |
List of Routing Indicators supported by the AAnf instance. If not provided, the AAnf can serve any Routing Indicator. Pattern: ‘^[0-9]{1,4}$’ |
6.1.6.2.74 Type: 5GDdnmfInfo
Table 6.1.6.2.74-1: Definition of type 5GDdnmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
plmnId |
PlmnId |
M |
1 |
PLMN ID of the PLMN which the 5G DDNMF served. |
6.1.6.2.75 Type: MfafInfo
Table 6.1.6.2.75-1: Definition of type MfafInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
servingNfTypeList |
array(NFType) |
O |
1..N |
If present, this IE shall contain the list of NF type(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF type |
servingNfSetIdList |
array(NfSetId) |
O |
1..N |
If present, this IE shall contain the list of NF Set Id(s) served by MFAF NF. The absence of this attribute indicates that the MFAF can be selected for any NF Set Id. |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the MFAF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the MFAF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the MFAF can be selected for any TAI in the serving network. |
6.1.6.2.76 Type: NwdafCapability
Table 6.1.6.2.76-1: Definition of type NwdafCapability
Attribute name |
Data type |
P |
Cardinality |
Description |
analyticsAggregation |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the NWDAF supports analytics aggregation: – true: analytics aggregation capability is supported by the NWDAF – false (default): analytics aggregation capability is not supported by the NWDAF. |
analyticsMetadataProvisioning |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the NWDAF supports analytics metadata provisioning: – true: analytics metadata provisioning capability is supported by the NWDAF – false (default): analytics metadata provisioning capability is not supported by the NWDAF. |
6.1.6.2.77 Type: EasdfInfo
Table 6.1.6.2.77-1: Definition of type EasdfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiEasdfInfoList |
array(SnssaiEasdfInfoItem) |
O |
1..N |
List of parameters supported by the EASDF per S-NSSAI (NOTE) |
easdfN6IpAddressList |
array(IpAddr) |
O |
1..N |
N6 IP addresses of the EASDF |
upfN6IpAddressList |
array(IpAddr) |
O |
1..N |
N6 IP addresses of PSA UPFs |
NOTE: If S-NSSAIs are present in the EasdfInfo and in the NFprofile, the S-NSSAIs from the EasdfInfo shall prevail. |
6.1.6.2.78 Type: SnssaiEasdfInfoItem
Table 6.1.6.2.78-1: Definition of type SnssaiEasdfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
S-NSSAI |
dnnEasdfInfoList |
array(DnnEasdfInfoItem) |
M |
1..N |
List of parameters supported by the EASDF per DNN |
6.1.6.2.79 Type: DnnEasdfInfoItem
Table 6.1.6.2.79-1: Definition of type DnnEasdfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN or Wildcard DNN if the EASDF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
dnaiList |
array(Dnai) |
O |
1..N |
List of Data network access identifiers supported by the EASDF for this DNN. The absence of this attribute indicates that the EASDF can be selected for this DNN for any DNAI. |
6.1.6.2.80 Type: DccfInfo
Table 6.1.6.2.80-1: Definition of type DccfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
servingNfTypeList |
array(NFType) |
O |
1..N |
If present, this IE shall contain the list of NF type(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF type. |
servingNfSetIdList |
array(NfSetId) |
O |
1..N |
If present, this IE shall contain the list of NF Set Id(s) from which the DCCF NF can collect data. The absence of this attribute indicates that the DCCF can collect data from any NF Set. |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAIs. The absence of both this attribute and the taiRangeList attribute indicates that the DCCF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the DCCF can serve. It may contain one or more non-3GPP access TAI ranges. The absence of both this attribute and the taiList attribute indicates that the DCCF can be selected for any TAI in the serving network. |
6.1.6.2.81 Type: NsacfInfo
Table 6.1.6.2.81-1: Definition of type NsacfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
nsacfCapability |
NsacfCapability |
M |
1 |
NSACF service capability. |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the NSACF can serve. It may contain one or more non-3GPP access TAIs. The absence of this attribute and the taiRangeList attribute indicate that the NSACF can be selected for any TAI in the serving network. (NOTE 1) |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the NSACF can serve. It may contain non-3GPP access TAIs. The absence of this attribute and the taiList attribute indicate that the NSACF can be selected for any TAI in the serving network. (NOTE 1) |
NOTE 1: When NSACF serving area is configured with TAI list, the serving area of the NSACF should be configured to cover the complete serving area of any of its AMF and SMF consumers, i.e. the TAI list served by NSACF should include all the TAIs served by its AMF and SMF consumers. This can avoid NSACF reselection when the UE moves within the serving area of the NF consumer, e.g. avoid NSACF reselection during intra-AMF UE mobility NOTE 2: Locality of NSACF may be configured to allow the NSACF consumers to discover and select candidate NSACF based on Locality information, instead of using serving TAIs. See NOTE 25 of Table 6.2.3.2.3.1-1. |
6.1.6.2.82 Type: NsacfCapability
Table 6.1.6.2.82-1: Definition of type NsacfCapability
Attribute name |
Data type |
P |
Cardinality |
Description |
supportUeSAC |
boolean |
C |
0..1 |
Indicates the service capability of the NSACF to monitor and control the number of registered UEs per network slice for the network slice that is subject to NSAC. true: Supported |
supportPduSAC |
boolean |
C |
0..1 |
Indicates the service capability of the NSACF to monitor and control the number of established PDU sessions per network slice for the network slice that is subject to NSAC. true: Supported |
6.1.6.2.83 Type: DccfCond
Table 6.1.6.2.83-1: Definition of type DccfCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "DCCF_COND". |
taiList |
array(Tai) |
O |
1..N |
TAI(s) of the DCCF whose status is requested to be monitored. It may contain one or more non-3GPP access TAIs. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs of the DCCF whose status is requested to be monitored. It may contain non-3GPP access TAIs. |
servingNfTypeList |
array(NFType) |
O |
1..N |
The list of NF type(s) served by DCCF whose status is requested to be monitored. |
servingNfSetIdList |
array(NfSetId) |
O |
1..N |
The list of NF Set Id(s) served by DCCF whose status is requested to be monitored. |
6.1.6.2.84 Type: MlAnalyticsInfo
Table 6.1.6.2.84-1: Definition of type MlAnalyticsInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
mlAnalyticsIds |
array(NwdafEvent) |
C |
1..N |
Analytics Id(s) supported by the Nnwdaf_MLModelProvision service, if none are provided the NWDAF can serve any mlAnalyticsId. |
snssaiList |
array(Snssai) |
O |
1..N |
S-NSSAIs of the ML model, if none are provided the ML model for the analytics can apply to any snssai. |
trackingAreaList |
array(Tai) |
O |
1..N |
Area of Interest of the ML model, if none are provided the ML model for the analytics can apply to any TAIs. If present, this IE represents the list of TAIs, it may contain one or more non-3GPP access TAIs. |
6.1.6.2.85 Type: MbSmfInfo
Table 6.1.6.2.85-1: Definition of type MbSmfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiInfoList |
map(SnssaiMbSmfInfoItem) |
O |
1..N |
S-NSSAIs and DNNs supported by the MB-SMF (NOTE 1) The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
tmgiRangeList |
map(TmgiRange) |
O |
1..N |
TMGI range(s) supported by the MB-SMF The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
taiList |
array(Tai) |
O |
1..N |
List of TAIs the MB-SMF can serve. The absence of this attribute and the taiRangeList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the MB-SMF can serve. The absence of this attribute and the taiList attribute indicates that the MB-SMF can be selected for any TAI in the serving network. |
mbsSessionList |
map(MbsSession) |
O |
1..N |
List of MBS sessions currently served by the MB-SMF The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
NOTE 1: If S-NSSAIs are present in MbSmfInfo and in the NFprofile, the S-NSSAIs from MbSmfInfo shall prevail. |
6.1.6.2.86 Type: TmgiRange
Table 6.1.6.2.86-1: Definition of type TmgiRange
Attribute name |
Data type |
P |
Cardinality |
Description |
mbsServiceIdStart |
string |
M |
1 |
First MBS Service ID value identifying the start of a TMGI range. The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7]. Pattern: ‘^[A-Fa-f0-9]{6}$’ |
mbsServiceIdEnd |
string |
M |
1 |
Last MBS Service ID value identifying the end of a TMGI range. The value shall be coded as defined for the mbsServiceId attribute of the Tmgi data type defined in 3GPP TS 29.571 [7]. Pattern: ‘^[A-Fa-f0-9]{6}$’ |
plmnId |
PlmnId |
M |
1 |
PLMN ID |
nid |
Nid |
O |
0..1 |
Network Identity used for SNPN |
6.1.6.2.87 Type: MbsSession
Table 6.1.6.2.87-1: Definition of type MbsSession
Attribute name |
Data type |
P |
Cardinality |
Description |
mbsSessionId |
MbsSessionId |
M |
1 |
MBS session identifier |
mbsAreaSessions |
map(MbsServiceAreaInfo) |
C |
1..N |
Map of Area Session Id and related MBS Service Area information used for MBS session with location dependent content. The Area Session ID together with the mbsSessionId (TMGI) uniquely identifies the MBS session in a specific MBS service area. For an MBS session with location dependent content, one map entry shall be registered for each MBS Service Area served by the MBS session. The key of the map shall be the areaSessionId. |
6.1.6.2.88 Type: SnssaiMbSmfInfoItem
Table 6.1.6.2.88-1: Definition of type SnssaiMbSmfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
Supported S-NSSAI |
dnnInfoList |
array(DnnMbSmfInfoItem) |
M |
1..N |
List of parameters supported by the MB-SMF per DNN |
6.1.6.2.89 Type: DnnMbSmfInfoItem
Table 6.1.6.2.89-1: Definition of type DnnMbSmfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN or Wildcard DNN if the MB-SMF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
6.1.6.2.90 Void
6.1.6.2.91 Type: TsctsfInfo
Table 6.1.6.2.91-1: Definition of type TsctsfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiInfoList |
map(SnssaiTsctsfInfoItem) |
O |
1..N |
S-NSSAIs and DNNs supported by the TSCTSF (NOTE 1) The key of the map shall be a (unique) valid JSON string per clause 7 of IETF RFC 8259 [22], with a maximum of 32 characters. |
externalGroupIdentifiersRanges |
array(IdentityRange) |
O |
1..N |
Ranges of External Group Identifiers that can be served by the TSCTSF. The absence of this IE indicates that the TSCTSF can serve any external group managed by the PLMN (or SNPN) of the TSCTSF instance. |
supiRanges |
array(SupiRange) |
O |
1..N |
Ranges of SUPIs that can be served by the TSCTSF instance. (NOTE 2) |
gpsiRanges |
array(IdentityRange) |
O |
1..N |
Ranges of GPSIs that can be served by the TSCTSF instance. (NOTE 2) |
internalGroupIdentifiersRanges |
array(InternalGroupIdRange) |
O |
1..N |
Ranges of Internal Group Identifiers that can be served by the TSCTSF instance. The absence of this IE indicates that the TSCTSF can serve any internal group managed by the PLMN (or SNPN) of the TSCTSF instance. |
NOTE 1: If S-NSSAIs are present in TsctsfInfo and in the NFprofile, the S-NSSAIs from TsctsfInfo shall prevail. Only one TSCTSF instance, or only the TSCTSF instances belonging to one TSCTSF Set, shall be configured in the PLMN (or SNPN) to serve a specific DNN and S-NSSAI combination. NOTE 2: If both parameters are not provided, the TSCTSF can serve any SUPI or GPSI managed by the PLMN (or SNPN) of the TSCTSF instance. |
6.1.6.2.92 Type: SnssaiTsctsfInfoItem
Table 6.1.6.2.92-1: Definition of type SnssaiTsctsfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
Supported S-NSSAI. |
dnnInfoList |
array(DnnTsctsfInfoItem) |
M |
1..N |
List of parameters supported by the TSCTSF per DNN for the indicated S-NSSAI. |
6.1.6.2.93 Type: DnnTsctsfInfoItem
Table 6.1.6.2.93-1: Definition of type DnnTsctsfInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN or Wildcard DNN if the TSCTSF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
6.1.6.2.94 Type: MbUpfInfo
Table 6.1.6.2.94-1: Definition of type MbUpfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiMbUpfInfoList |
array(SnssaiUpfInfoItem) |
M |
1..N |
List of parameters supported by the MB-UPF per S-NSSAI. (NOTE) |
mbSmfServingArea |
array(string) |
O |
1..N |
The MB-SMF service area(s) the MB-UPF can serve. If not provided, the MB-UPF can serve any MB-SMF service area. |
interfaceMbUpfInfoList |
array(InterfaceUpfInfoItem) |
O |
1..N |
List of User Plane interfaces configured on the MB-UPF. When this IE is provided in the NF Discovery response, the NF Service Consumer (e.g. MB-SMF) may use this information for MB-UPF selection. |
taiList |
array(Tai) |
O |
1..N |
The list of TAIs the MB-UPF can serve. The absence of this attribute and the taiRangeList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the MB-UPF can serve. The absence of this attribute and the taiList attribute indicates that the MB-UPF can serve the whole MB-SMF service area defined by the MbSmfServingArea attribute. |
priority |
integer |
O |
0..1 |
Priority (relative to other NFs of the same type) in the range of 0-65535, to be used for NF selection for a service request matching the attributes of the MbUpfInfo; lower values indicate a higher priority. See the precedence rules in the description of the priority attribute in NFProfile, if Priority is also present in NFProfile. The NRF may overwrite the received priority value when exposing an NFProfile with the Nnrf_NFDiscovery service. |
supportedPfcpFeatures |
string |
O |
0..1 |
Supported PFCP Features. A string used to indicate the PFCP features supported by the MB-UPF, which encodes the "UP Function Features" IE as specified in Table 8.2.25-1 of 3GPP TS 29.244 [21] (starting from Octet 5), in hexadecimal representation. Each character in the string shall take a value of "0" to "9", "a" to "f" or "A" to "F" and each two characters shall represent one octet of "UP Function Features" IE (starting from Octet 5, to higher octets). For each two characters representing one octet, the first character representing the 4 most significant bits of the octet and the second character the 4 least significant bits of the octet. |
NOTE : If this S-NSSAIs is present in the MbUpfInfo and in the NFprofile, the S-NSSAIs from the MbUpfInfo shall prevail. |
6.1.6.2.95 Type: UnTrustAfInfo
Table 6.1.6.2.95-1: Definition of type UnTrustAfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
afId |
string |
M |
1 |
Associated AF id. |
sNssaiInfoList |
array(SnssaiInfoItem) |
O |
1..N |
S-NSSAIs and DNNs supported by the AF. |
mappingInd |
boolean |
O |
0..1 |
When present, this IE indicates whether the AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. GPSI). true: the AF supports mapping between UE IP address and UE ID; false (default): the AF does not support mapping between UE IP address and UE ID. |
6.1.6.2.96 Type: TrustAfInfo
Table 6.1.6.2.96-1: Definition of type TrustAfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssaiInfoList |
array(SnssaiInfoItem) |
O |
1..N |
S-NSSAIs and DNNs supported by the trusted AF (NOTE 1). |
afEvents |
array(AfEvent) |
O |
1..N |
AF Event(s) supported by the trusted AF. |
appIds |
array(string) |
O |
1..N |
The list of Application ID(s) supported by the trusted AF. The absence of this attribute indicate that the AF can be selected for any Application. |
internalGroupId |
array(GroupId) |
O |
1..N |
List of Internal Group Identifiers supported by the trusted AF. If not provided, it does not imply that the AF supports all internal groups. |
mappingInd |
boolean |
O |
0..1 |
When present, this IE indicates whether the trusted AF supports mapping between UE IP address (IPv4 address or IPv6 prefix) and UE ID (i.e. SUPI). true: the trusted AF supports mapping between UE IP address and UE ID; false (default): the trusted AF does not support mapping between UE IP address and UE ID. |
NOTE 1: If S-NSSAIs are present in TrustAfInfo and in the NFprofile, the S-NSSAIs from TrustAfInfo shall prevail. |
6.1.6.2.97 Type: SnssaiInfoItem
Table 6.1.6.2.97-1: Definition of type SnssaiInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
sNssai |
ExtSnssai |
M |
1 |
Supported S-NSSAI |
dnnInfoList |
array(DnnInfoItem) |
M |
1..N |
List of parameters supported by the NF per DNN |
6.1.6.2.98 Type: DnnInfoItem
Table 6.1.6.2.98-1: Definition of type DnnInfoItem
Attribute name |
Data type |
P |
Cardinality |
Description |
dnn |
Dnn |
M |
1 |
Supported DNN or Wildcard DNN if the NF supports all DNNs for the related S-NSSAI. The DNN shall contain the Network Identifier and it may additionally contain an Operator Identifier. If the Operator Identifier is not included, the DNN is supported for all the PLMNs in the plmnList of the NF Profile. |
6.1.6.2.99 Type: CollocatedNfInstance
Table 6.1.6.2.99-1: Definition of type CollocatedNfInstance
Attribute name |
Data type |
P |
Cardinality |
Description |
nfInstanceId |
NfInstanceId |
M |
1 |
Unique identity of the NF Instance for a collocated NF type. |
nfType |
CollocatedNfType |
M |
1 |
Possible NF types supported by a collocated NF. (NOTE 1, NOTE 2) |
NOTE 1: Whether NFs of any NF types are collocated or not, is an implementation and/or deployment issue and needs not be known in general to the NF service consumers and therefore needs not be registered in the NF profile. This data type is only intended for specific scenarios where the discovery and selection of a combined NF service producer by a NF service consumer can allow specific optimizations. In order to retrieve the NFProfile of the collocated NF instance, the NF service consumer shall trigger a separate discovery procedure using the nfType and nfInstanceId in the CollocatedNfInstance data type. NOTE 2: The supported collocated NF types in this release of the specification may only be one of the following: |
6.1.6.2.100 Type: ServiceNameListCond
Table 6.1.6.2.100-1: Definition of type ServiceNameListCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "SERVICE_NAME_LIST_COND". |
serviceNameList |
array(ServiceName) |
M |
1..N |
Service names offered by the NF Instances whose status is requested to be monitored. |
6.1.6.2.101 Type: NfGroupListCond
Table 6.1.6.2.101-1: Definition of type NfGroupListCond
Attribute name |
Data type |
P |
Cardinality |
Description |
conditionType |
string |
M |
1 |
This attribute serves as discriminator, to make all data types defined in Table 6.1.6.2.35-1 mutually exclusive. In this data type, it shall take the value "NF_GROUP_LIST_COND". |
nfType |
string |
M |
1 |
NF type (UDM, AUSF, PCF, UDR, HSS or CHF) of the NF Instances whose status is requested to be monitored. |
nfGroupIdList |
array(NfGroupId) |
M |
1..N |
Group IDs of the NF Instances whose status is requested to be monitored. |
6.1.6.2.102 Type: PlmnOauth2
Table 6.1.6.2.102-1: Definition of type PlmnOauth2
Attribute name |
Data type |
P |
Cardinality |
Description |
oauth2RequiredPlmnIdList |
array(PlmnId) |
O |
1..N |
It shall indicate the consumer PLMN ID list for which NF Service Instance requires Oauth2-based authorization. (See NOTE 1) |
oauth2NotRequiredPlmnIdList |
array(PlmnId) |
O |
1..N |
It shall indicate the consumer PLMN ID list for which NF Service Instance does not require Oauth2-based authorization. (See NOTE 1) |
NOTE 1: The same PLMN Id shall not be present in both oauth2RequiredPlmnIdList and oauth2NotRequiredPlmnIdList. |
6.1.6.2.103 Type: V2xCapability
Table 6.1.6.2.103-1: Definition of type V2xCapability
Attribute name |
Data type |
P |
Cardinality |
Description |
lteV2x |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports LTE V2X capability: – true: LTE V2X capability is supported by the PCF – false (default): LTE V2X capability is not supported by the PCF. |
nrV2x |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports NR V2X capability: – true: NR V2X capability is supported by the PCF – false (default): NR V2X capability is not supported by the PCF. |
6.1.6.2.104 Type: NssaafInfo
Table 6.1.6.2.104-1: Definition of type NssaafInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs that can be served by the NSSAAF instance. |
internalGroupIdentifiersRanges |
array(InternalGroupIdRange) |
O |
1..N |
List of ranges of Internal Group Identifiers that can be served by the NSSAAF instance.If not provided, it does not imply that the NSSAAF supports all internal groups. |
6.1.6.2.105 Type: ProSeCapability
Table 6.1.6.2.105-1: Definition of type ProSeCapability
Attribute name |
Data type |
P |
Cardinality |
Description |
proseDirectDiscovey |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Direct Discovery: – true: ProSe Direct Discovery is supported by the PCF – false (default): ProSe Direct Discovery is not supported by the PCF. |
proseDirectCommunication |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Direct Communication: – true: ProSe Direct Communication is supported by the PCF – false (default): ProSe Direct Communication is not supported by the PCF. |
proseL2UetoNetworkRelay |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Layer-2 UE-to-Network Relay: – true: ProSe Layer-2 UE-to-Network Relay is supported by the PCF – false (default): ProSe Layer-2 UE-to-Network Relay is not supported by the PCF. |
proseL3UetoNetworkRelay |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Layer-3 UE-to-Network Relay: – true: ProSe Layer-3 UE-to-Network Relay is supported by the PCF – false (default): ProSe Layer-3 UE-to-Network Relay is not supported by the PCF. |
proseL2RemoteUe |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Layer-2 Remote UE: – true: ProSe Layer-2 Remote UE is supported by the PCF – false (default): ProSe Layer-2 Remote UE is not supported by the PCF. |
proseL3RemoteUe |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the PCF supports ProSe Layer-3 Remote UE: – true: ProSe Layer-3 Remote UE is supported by the PCF – false (default): ProSe Layer-3 Remote UE is not supported by the PCF. |
6.1.6.2.106 Type: SharedDataIdRange
Table 6.1.6.2.106-1: Definition of type ShardDataIdRange
Attribute name |
Data type |
P |
Cardinality |
Description |
pattern |
string |
O |
0..1 |
Pattern (regular expression according to the ECMA-262 dialect [8]) representing the set of SharedDataIds belonging to this range. A SharedDataId value is considered part of the range if and only if the SharedDataId string fully matches the regular expression. |
EXAMPLE: SharedDataId range. "123456-sharedAmData{localID}" where "123456" is the HPLMN id (i.e. MCC followed by MNC) and "{localID}" can be any string.
JSON: { "pattern": "^123456-sharedAmData.+$" }
6.1.6.2.107 Type: SubscriptionContext
Table 6.1.6.2.107-1: Definition of type SubscriptionContext
Attribute name |
Data type |
P |
Cardinality |
Description |
subscriptionId |
string |
M |
1 |
Subscription ID of the corresponding subscription resource that originated the notification. |
subscrCond |
SubscrCond |
O |
0..1 |
If present, this attribute shall contain the conditions identifying the set of NF Instances whose status was requested to be monitored in the corresponding subscription that originated this notification. |
6.1.6.2.108 Type: IwmscInfo
Table 6.1.6.2.108-1: Definition of type IwmscInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
msisdnRanges |
array(IdentityRange) |
O |
1..N |
List of ranges of MSISDNs supported by the SMS-IWMSC. See NOTE. |
supiRanges |
array(SupiRange) |
O |
1..N |
List of ranges of SUPIs supported by the SMS-IWMSC. See NOTE. |
taiRangeList |
array(TaiRange) |
O |
1..N |
The range of TAIs the SMS-IWMSC can serve. The absence of this attribute indicates that the SMS-IWMSC can serve any TA. |
scNumber |
string |
O |
0..1 |
When present, this IE carry an OctetString indicating the ISDN number of the SC in international number format as described in ITU-T Rec. E.164 [44] and shall be encoded as a TBCD-string. Pattern: "^[0-9]{5,15}$" |
NOTE: If both parameters are not provided, the SMS-IWMSC can serve any SUPI or MSISDN. |
6.1.6.2.109 Type: MnpfInfo
Table 6.1.6.2.109-1: Definition of type MnpfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
msisdnRanges |
array(IdentityRange) |
M |
1..N |
List of ranges of MSISDNs whose portability status is available in the MNPF |
6.1.6.2.110 Type: DefSubServiceInfo
Table 6.1.6.2.110-1: Definition of type DefSubServiceInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
versions |
array(string) |
O |
1..N |
When present, this attribute shall indicate the API version (e.g. "v1") of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. |
supportedFeatures |
SupportedFeatures |
O |
0..1 |
When present, this attribute shall indicate the features of the indicated service which are supported by the NF (Service) instance acting as NF service consumer. |
6.1.6.2.111 Type: LocalityDescriptionItem
Table 6.1.6.2.111-1: Definition of type LocalityDescriptionItem
Attribute name |
Data type |
P |
Cardinality |
Description |
localityType |
LocalityType |
M |
1 |
Type of locality description |
localityValue |
string |
M |
1 |
Locality value |
6.1.6.2.112 Type: LocalityDescription
Table 6.1.6.2.112-1: Definition of type LocalityDescription
Attribute name |
Data type |
P |
Cardinality |
Description |
localityType |
LocalityType |
M |
1 |
Type of locality description |
localityValue |
string |
M |
1 |
Locality value |
addlLocDescrItems |
array(LocalityDescriptionItem) |
O |
0..1 |
Additional locality description items This IE may be present to express a preferred locatity as a set of locality description items to match with an "AND" relationship, e.g. to express a preference for NF profiles that are located in a given city and state. This may be used e.g. when a locality value of a given locality type may not be unique within the PLMN, such as cities with the same name in different states. |
6.1.6.2.113 Type: SmsfInfo
Table 6.1.6.2.113-1: Definition of type SmsfInfo
Attribute name |
Data type |
P |
Cardinality |
Description |
roamingUeInd |
boolean |
O |
0..1 |
When present, this IE shall indicate whether the SMSF can serve roaming UE: – true: the SMSF can support roaming UEs. – false: the SMSF can not support roaming UEs. Absence of this IE indicates whether the SMSF can serve roaming UEs is not specified. |
remotePlmnRangeList |
array(PlmnRange) |
O |
1..N |
This IE maybe present when the roamingUeInd IE is present with the value "true". When present, this IE shall indicate the list of ranges of remote PLMNs served by the SMSF, i.e. the SMSF can serve the roaming UEs which belong to the indicated remote PLMNs. |
NOTE: If the roamingUeInd IE is present with the value "true", absence of remotePlmnRangeList IE indicates that the SMSF can serve roaming UEs from any remote PLMN. |
6.1.6.3 Simple data types and enumerations
6.1.6.3.1 Introduction
This clause defines simple data types and enumerations that can be referenced from data structures defined in the previous clauses.
6.1.6.3.2 Simple data types
The simple data types defined in table 6.1.6.3.2-1 shall be supported.
Table 6.1.6.3.2-1: Simple data types
Type Name |
Type Definition |
Description |
NefId |
string |
The NEF ID as specified in clause 4.25.2 of 3GPP TS 23.502 [3]. For combined SCEF+NEF, the NEF ID shall contain the SCEF ID encoded as specified in clause 8.4.5 of 3GPP TS 29.336 [37]. |
VendorId |
string |
Vendor ID, according to the IANA-assigned "SMI Network Management Private Enterprise Codes" [38]. It shall be formatted as a fixed 6-digit string, padding with leading digits "0" to complete a 6-digit length. Pattern: "^[0-9]{6}$" |
WildcardDnai |
string |
String representing the Wildcard DNAI. It shall contain the string "*". Pattern: ‘^[*]$’ |
6.1.6.3.3 Enumeration: NFType
The enumeration NFType represents the different types of Network Functions or Network Entities that can be found in the 5GC.
Table 6.1.6.3.3-1: Enumeration NFType
Enumeration value |
Description |
"NRF" |
Network Function: NRF |
"UDM" |
Network Function: UDM |
"AMF" |
Network Function: AMF |
"SMF" |
Network Function: SMF |
"AUSF" |
Network Function: AUSF |
"NEF" |
Network Function: NEF |
"PCF" |
Network Function: PCF |
"SMSF" |
Network Function: SMSF |
"NSSF" |
Network Function: NSSF |
"UDR" |
Network Function: UDR |
"LMF" |
Network Function: LMF |
"GMLC" |
Network Function: GMLC |
"5G_EIR" |
Network Function: 5G-EIR |
"SEPP" |
Network Entity: SEPP |
"UPF" |
Network Function: UPF |
"N3IWF" |
Network Function and Entity: N3IWF |
"AF" |
Network Function: AF |
"UDSF" |
Network Function: UDSF |
"BSF" |
Network Function: BSF |
"CHF" |
Network Function: CHF |
"NWDAF" |
Network Function: NWDAF |
"PCSCF" |
Network Function: P-CSCF |
"CBCF" |
Network Function: CBCF |
"UCMF" |
Network Function: UCMF |
"HSS" |
Network Function: HSS |
"SOR_AF" |
Network Function: SOR-AF |
"SPAF" |
Network Function: SP-AF |
"MME" |
Network Function: MME |
"SCSAS" |
Network Function: SCS/AS |
"SCEF" |
Network Function: SCEF |
"SCP" |
Network Entity: SCP |
"NSSAAF" |
Network Function: NSSAAF |
"ICSCF" |
Network Function: I-CSCF |
"SCSCF" |
Network Function: S-CSCF |
"DRA" |
Network Function: DRA |
"IMS_AS" |
Network Function: IMS-AS |
"AANF" |
Network Function: AAnF |
"5G_DDNMF" |
Network Function: 5G DDNMF |
"NSACF" |
Network Function: NSACF |
"MFAF" |
Network Function: MFAF |
"EASDF" |
Network Function: EASDF |
"DCCF" |
Network Function: DCCF |
"MB_SMF" |
Network Function: MB-SMF |
"TSCTSF" |
Network Function: TSCTSF |
"ADRF" |
Network Function: ADRF |
"GBA_BSF" |
Network Function: GBA BSF |
"CEF" |
Network Function: CEF |
"MB_UPF" |
Network Function: MB-UPF |
"NSWOF" |
Network Function: NSWOF |
"PKMF" |
Network Function: PKMF |
"MNPF" |
Network Function: MNPF |
"SMS_GMSC" |
Network Function: SMS-GMSC |
"SMS_IWMSC" |
Network Function: SMS-IWMSC |
"MBSF" |
Network Function: MBSF |
"MBSTF" |
Network Function: MBSTF |
"PANF" |
Network Function: PANF |
6.1.6.3.4 Enumeration: NotificationType
Table 6.1.6.3.4-1: Enumeration NotificationType
Enumeration value |
Description |
"N1_MESSAGES" |
Notification of N1 messages. This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance. If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service. If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service. |
"N2_INFORMATION" |
Notification of N2 information. This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance. If the AMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "namf-comm" or with a custom service. If the LMF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nlmf-loc" or with a custom service. |
"LOCATION_NOTIFICATION" |
Notification of Location Information sent by AMF/LMF towards NF Service Consumers (e.g GMLC). This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance. If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service. |
"DATA_REMOVAL_NOTIFICATION" |
Notification of Data Removal sent by UDR (e.g., removal of UE registration data upon subscription withdrawal). This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2). |
"DATA_CHANGE_NOTIFICATION" |
Notification of Data Changes sent by UDR. This notification type shall be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2). |
"LOCATION_UPDATE_NOTIFICATION" |
Notification of UE Location Information Update sent by GMLC towards NF Service Consumers (e.g. H-GMLC, NEF), during MO_LR procedure. This notification type may be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2) or as part of a specific service instance. If the the GMLC registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "ngmlc-loc" or with a custom service. If the the NEF registers a default notification subscription with this notification type in an NF Service Instance, it may be associated with the service "nnef-eventexposure" or with a custom service. |
"NSSAA_REAUTH_NOTIFICATION" |
Re-authentication notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service Consumers (e.g. AMF). This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
"NSSAA_REVOC_NOTIFICATION" |
Revocation notification for slice-specific authentication and authorization sent by NSSAAF towards NF Service Consumers (e.g. AMF). This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
"MATCH_INFO_NOTIFICATION" |
Notification of a matching result, and the information that can be used for charging purpose by 5G DDNMF towards NF Service Consumers (e.g. 5G DDNMF), during Discovery Reporting procedures. This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
"DATA_RESTORATION_NOTIFICATION" |
Notification by UDR to its NF Service Consumers (e.g. UDM, PCF, NEF…) or by UDM to its NF Service Consumers (e.g. AMF, SMF, SMSF…) of a potential data-loss event originated at UDR. The content of the notification shall be as described in 3GPP TS 29.503 [36], clause 5.3.2.12.2 and 6.2.5.4. This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
"TSCTS_NOTIFICATION" |
Notification sent by PCF to TSCTSF of TSC user-plane node information. The content of the notification is described in 3GPP TS 29.514 [47], clause 4.2.5.16. This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
"LCS_KEY_DELIVERY_NOTIFICATION" |
Notification sent by LMF to AMF to deliver cipering key information. This notification type should be registered by the NF Instance in a default notification subscription at NFProfile level (see clause 6.1.6.2.2); otherwise, it may be registered in a custom service instance. |
6.1.6.3.5 Enumeration: TransportProtocol
Table 6.1.6.3.5-1: Enumeration TransportProtocol
Enumeration value |
Description |
"TCP" |
Transport protocol: TCP |
6.1.6.3.6 Enumeration: NotificationEventType
Table 6.1.6.3.6-1: Enumeration NotificationEventType
Enumeration value |
Description |
"NF_REGISTERED" |
The NF Instance has been registered in NRF |
"NF_DEREGISTERED" |
The NF Instance has been deregistered from NRF |
"NF_PROFILE_CHANGED" |
The profile of the NF Instance has been modified |
6.1.6.3.7 Enumeration: NFStatus
Table 6.1.6.3.7-1: Enumeration NFStatus
Enumeration value |
Description |
"REGISTERED" |
The NF Instance is registered in NRF and can be discovered by other NFs. |
"SUSPENDED" |
The NF Instance is registered in NRF but it is not operative and cannot be discovered by other NFs. This status may result from a NF Heart-Beat failure (see clause 5.2.2.3.2) or a NF failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). |
"UNDISCOVERABLE" |
The NF instance is registered in NRF, is operative but cannot be discovered by other NFs. This status may be set by the NF e.g. in shutting down scenarios where the NF is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. |
6.1.6.3.8 Enumeration: DataSetId
The enumeration DataSetId represents the different types of data sets supported by an UDR instance.
Table 6.1.6.3.8-1: Enumeration DataSetId
Enumeration value |
Description |
"SUBSCRIPTION" |
Data set: Subscription data |
"POLICY" |
Data set: Policy data (including all defined subsets) |
"EXPOSURE" |
Data set: Structured data for exposure |
"APPLICATION" |
Data set: Application data (including all defined subsets) |
"A_PFD" |
ApplicationData subset: Packet Flow Descriptions |
"A_AFTI" |
ApplicationData subset: AF Traffic Influence Data |
"A_IPTV" |
ApplicationData subset: IPTV Config Data |
"A_BDT" |
ApplicationData subset: Background Data Transfer |
"A_SPD" |
ApplicationData subset: Service Parameter Data |
"A_EASD" |
ApplicationData subset: EAS Deployment Information |
"A_AMI" |
ApplicationData subset: AM Influence Data |
"P_UE" |
PolicyData subset: UE Specific Data |
"P_SCD" |
PolicyData subset: Sponsored Connectivity Data |
"P_BDT" |
PolicyData subset: Background Data Transfer |
"P_PLMNUE" |
PolicyData subset: PLMN specific UE policy data |
"P_NSSCD" |
PolicyData subset: Network Slice Specific Control Data |
NOTE: Enumeration values identifying an ApplicationData subset or PolicyData subset should not be used in NF discovery requests unless UDR and NRF have been upgraded to support these values. |
6.1.6.3.9 Enumeration: UPInterfaceType
Table 6.1.6.3.9-1: Enumeration UPInterfaceType
Enumeration value |
Description |
"N3" |
User Plane Interface: N3 |
"N6" |
User Plane Interface: N6 |
"N9" |
User Plane Interface: N9 |
"DATA_FORWARDING" |
User Plane Interface for indirect data forwarding. (NOTE 1) |
"N6MB" |
User Plane Interface: N6mb |
"N19MB" |
User Plane Interface: N19mb |
"N3MB" |
User Plane Interface: N3mb |
"NMB9" |
User Plane Interface: Nmb9 |
NOTE 1: This interface type may be used when a dedicated network instance is deployed for data forwarding. |
6.1.6.3.10 Relation Types
6.1.6.3.10.1 General
This clause describes the possible relation types defined within NRF API. See clause 4.7.5.2 of 3GPP TS 29.501 [5] for the description of the relation types.
Table 6.1.6.3.10.1-1: supported registered relation types
Relation Name |
self |
item |
6.1.6.3.11 Enumeration: ServiceName
Table 6.1.6.3.11-1: Enumeration ServiceName
Enumeration value |
Description |
"nnrf-nfm" |
Nnrf_NFManagement Service offered by the NRF |
"nnrf-disc" |
Nnrf_NFDiscovery Service offered by the NRF |
"nnrf-oauth2" |
Nnrf_AccessToken Service offered by the NRF |
"nudm-sdm" |
Nudm_SubscriberDataManagement Service offered by the UDM |
"nudm-uecm" |
Nudm_UEContextManagement Service offered by the UDM |
"nudm-ueau" |
Nudm_UEAuthentication Service offered by the UDM |
"nudm-ee" |
Nudm_EventExposure Service offered by the UDM |
"nudm-pp" |
Nudm_ParameterProvision Service offered by the UDM |
"nudm-niddau" |
Nudm_NIDDAuthorization Service offered by the UDM |
"nudm-mt" |
Nudm_MT Service offered by the UDM |
"nudm-ssau" |
Nudm_ServiceSpecificAuthorization Service offered by the UDM |
"nudm-rsds" |
Nudm_ReportSMDeliveryStatus Service offered by the UDM |
"namf-comm" |
Namf_Communication Service offered by the AMF |
"namf-evts" |
Namf_EventExposure Service offered by the AMF |
"namf-mt" |
Namf_MT Service offered by the AMF |
"namf-loc" |
Namf_Location Service offered by the AMF |
"namf-mbs-comm" |
Namf_MBSCommunication Service offered by AMF |
"namf-mbs-bc" |
Namf_MBSBroadcast Service offered by AMF |
"nsmf-pdusession" |
Nsmf_PDUSession Service offered by the SMF |
"nsmf-event-exposure" |
Nsmf_EventExposure Service offered by the SMF |
"nsmf-nidd" |
Nsmf_NIDD Service offered by the SMF |
"nausf-auth" |
Nausf_UEAuthentication Service offered by the AUSF |
"nausf-sorprotection" |
Nausf_SoRProtection Service offered by the AUSF |
"nausf-upuprotection" |
Nausf_UPUProtection Service offered by the AUSF |
"nnef-pfdmanagement" |
Nnef_PFDManagement offered by the NEF |
"nnef-smcontext" |
Nnef_SMContext Service offered by the NEF |
"nnef-eventexposure" |
Nnef_EventExposure Service offered by the NEF |
"nnef-eas-deployment-info" |
Nnef_EASDeployment InfoService offered by the NEF. This is the southbound part of the API (e.g. the service operations used by the SMF) |
"3gpp-cp-parameter-provisioning" |
Nnef_ParameterProvision Service offered by the NEF |
"3gpp-device-triggering" |
Nnef_Trigger Service offered by the NEF |
"3gpp-bdt" |
Nnef_BDTPNegotiation Service offered by the NEF |
"3gpp-traffic-influence" |
Nnef_TrafficInfluence Service offered by the NEF |
"3gpp-chargeable-party" |
Nnef_ChargeableParty Service offered by the NEF |
"3gpp-as-session-with-qos" |
Nnef_AFsessionWithQoS Service offered by the NEF |
"3gpp-msisdn-less-mo-sms" |
Nnef_MSISDN-less_MO_SMS Service offered by the NEF |
"3gpp-service-parameter" |
Nnef_ServiceParameter Service offered by the NEF |
"3gpp-monitoring-event" |
Nnef_APISupportCapability Service offered by the NEF |
"3gpp-nidd-configuration-trigger" |
Nnef_NIDDConfiguration Service offered by the NEF |
"3gpp-nidd" |
Nnef_NIDD Service offered by the NEF |
"3gpp-analyticsexposure" |
Nnef_AnalyticsExposure Service offered by the NEF |
"3gpp-racs-parameter-provisioning" |
Nnef_UCMFProvisioning Service offered by the NEF |
"3gpp-ecr-control" |
Nnef_ECRestriction Service offered by the NEF |
"3gpp-applying-bdt-policy" |
Nnef_ApplyPolicy Service offered by the NEF |
"3gpp-mo-lcs-notify" |
Nnef_Location Service offered by the NEF |
"3gpp-time-sync" |
Nnef_TimeSynchronization Service offered by the NEF |
"3gpp-am-influence" |
Nnef_AMInfluence Service offered by the NEF |
"3gpp-am-policyauthorization" |
Nnef_AMPolicyAuthorization |
"3gpp-akma" |
Nnef_AKMA Service offered by the NEF |
"3gpp-eas-deployment" |
Nnef_EASDeployment Service offered by the NEF. This is the northbound part (e.g. the service operations used by the AF). |
"3gpp-iptvconfiguration" |
Nnef_IPTV_configuration Service offered by the NEF |
"3gpp-mbs-tmgi" |
Nnef_MBSTMGI Service offered by the NEF |
"3gpp-mbs-session" |
Nnef_MBSSession Service offered by the NEF |
"3gpp-authentication" |
Nnef_Authentication Service offered by the NEF |
"3gpp-asti" |
Nnef_ASTI Service offered by the NEF |
"npcf-am-policy-control" |
Npcf_AMPolicyControl Service offered by the PCF |
"npcf-smpolicycontrol" |
Npcf_SMPolicyControl Service offered by the PCF |
"npcf-policyauthorization" |
Npcf_PolicyAuthorization Service offered by the PCF |
"npcf-bdtpolicycontrol" |
Npcf_BDTPolicyControl Service offered by the PCF |
"npcf-eventexposure" |
Npcf_EventExposure Service offered by the PCF |
"npcf-ue-policy-control" |
Npcf_UEPolicyControl Service offered by the PCF |
"npcf-am-policyauthorization" |
Npcf_AM_PolicyAuthorization Service offered by the PCF |
"nsmsf-sms" |
Nsmsf_SMService Service offered by the SMSF |
"nnssf-nsselection" |
Nnssf_NSSelection Service offered by the NSSF |
"nnssf-nssaiavailability" |
Nnssf_NSSAIAvailability Service offered by the NSSF |
"nudr-dr" |
Nudr_DataRepository Service offered by the UDR |
"nudr-group-id-map" |
Nudr_GroupIDmap Service offered by the UDR |
"nlmf-loc" |
Nlmf_Location Service offered by the LMF |
"n5g-eir-eic" |
N5g-eir_EquipmentIdentityCheck Service offered by the 5G-EIR |
"nbsf-management" |
Nbsf_Management Service offered by the BSF |
"nchf-spendinglimitcontrol" |
Nchf_SpendingLimitControl Service offered by the CHF |
"nchf-convergedcharging" |
Nchf_Converged_Charging Service offered by the CHF |
"nchf-offlineonlycharging" |
Nchf_OfflineOnlyCharging Service offered by the CHF |
"nnwdaf-eventssubscription" |
Nnwdaf_EventsSubscription Service offered by the NWDAF |
"nnwdaf-analyticsinfo" |
Nnwdaf_AnalyticsInfo Service offered by the NWDAF |
"nnwdaf-datamanagement" |
Nnwdaf_DataManagement Service offered by the NWDAF |
"nnwdaf-mlmodelprovision" |
Nnwdaf_MLModelProvision Service offered by the NWDAF |
"ngmlc-loc" |
Ngmlc_Location Service offered by GMLC |
"nucmf-provisioning" |
Nucmf_Provisioning Service offered by UCMF |
"nucmf-uecapabilitymanagement" |
Nucmf_UECapabilityManagement Service offered by UCMF |
"nhss-sdm" |
Nhss_SubscriberDataManagement Service offered by the HSS |
"nhss-uecm" |
Nhss_UEContextManagement Service offered by the HSS |
"nhss-ueau" |
Nhss_UEAuthentication Service offered by the HSS |
"nhss-ee" |
Nhss_EventExposure Service offered by the HSS |
"nhss-ims-sdm" |
Nhss_imsSubscriberDataManagement Service offered by the HSS |
"nhss-ims-uecm" |
Nhss_imsUEContextManagement Service offered by the HSS |
"nhss-ims-ueau" |
Nhss_imsUEAuthentication Service offered by the HSS |
"nhss-gba-sdm" |
Nhss_gbaSubscriberDataManagement Service offered by the HSS |
"nhss-gba-ueau" |
Nhss_gbaUEAuthentication Service offered by the HSS |
"nsepp-telescopic" |
Nsepp_Telescopic_FQDN_Mapping Service offered by the SEPP |
"nsoraf-sor" |
Nsoraf_SteeringOfRoaming Service offered by the SOR-AF |
"nspaf-secured-packed" |
Nspaf_SecuredPacket Service offered by the SP-AF |
"nudsf-dr" |
Nudsf Data Repository service offered by the UDSF. |
"nudsf-timer" |
Nudsf Timer service offered by the UDSF |
"nnssaaf-nssaa" |
Nnssaaf_NSSAA service offered by the NSSAAF. |
"nnssaaf-aiw" |
Nnssaaf_AIW service offered by the NSSAAF. |
"naanf-akma" |
Naanf_AKMA service offered by the AAnF. |
"n5gddnmf-discovery" |
N5g-ddnmf_Discovery service offered by 5G DDNMF |
"nmfaf-3dadm" |
Nmfaf 3daDataManagement service offered by the MFAF. |
"nmfaf-3cadm" |
Nmfaf 3caDataManagement service offered by the MFAF. |
"neasdf-dnscontext" |
Neasdf_DNSContext service offered by the EASDF |
"neasdf-baselinednspattern" |
Neasdf_BaselineDNSPattern service offered by the EASDF |
"ndccf-dm" |
Ndccf_DataManagement service offered by the DCCF. |
"ndccf-cm" |
Ndccf_ContextManagement service offered by the DCCF. |
"nnsacf-nsac" |
Nnsacf_NSAC service offered by the NSACF. |
"nnsacf-slice-ee" |
Nnsacf_SliceEventExposure service offered by the NSACF. |
"nmbsmf-tmgi" |
Nmbsmf TMGI service offered by the MB-SMF |
"nmbsmf-mbssession" |
Nmbsmf MBSSession service offered by the MB-SMF |
"nadrf-dm" |
Nadrf_DataManagement service offered by the ADRF. |
"nbsp-gba" |
Nbsp_GBA service offered by the GBA BSF. |
"ntsctsf-time-sync" |
Ntsctsf_TimeSynchronization service offered by the TSCTSF |
"ntsctsf-qos-tscai" |
Ntsctsf_QoSandTSCAssistance service offered by the TSCTSF |
"ntsctsf-asti" |
Ntsctsf_ASTI service offered by the TSCTSF |
"npkmf-keyrequest" |
Npkmf_PKMFKeyRequest service offered by the PKMF |
"nmnpf-npstatus" |
Nmnpf_NPStatus service offered by the MNPF |
"niwmsc-smservice" |
Niwmsc_SMService service offered by the SMS-IWMSC |
"nmbsf-mbsuserserv" |
Nmbsf_MBSUserService service offered by the MBSF |
"nmbsf-mbsuserdataing" |
Nmbsf_MBSUserDataIngestSession service offered by the MBSF |
"nmbstf-distsession" |
Nmbstf_MBSDistributionSession service offered by the MBSTF |
"npanf-prosekey" |
Npanf_ProseKey service offered by the PANF |
NOTE: The services defined in this table are those defined by 3GPP NFs in 5GC; however, in order to support custom services offered by standard and custom NFs, the NRF shall also accept the registration of NF Services with other service names. |
6.1.6.3.12 Enumeration: NFServiceStatus
Table 6.1.6.3.12-1: Enumeration NFServiceStatus
Enumeration value |
Description |
"REGISTERED" |
The NF Service Instance is registered in NRF and can be discovered by other NFs. |
"SUSPENDED" |
The NF Service Instance is registered in NRF but it is not operative and cannot be discovered by other NFs. This status may result from a NF Service failure and may trigger restoration procedures (see clause 6.2 of 3GPP TS 23.527 [27]). |
"UNDISCOVERABLE" |
The NF Service instance is registered in NRF, is operative but cannot be discovered by other NFs. This status may be set by the NF e.g. in shutting down scenarios where the NF service is still able to process requests for existing resources or sessions but cannot accept new resource creation or session establishment. |
NOTE: An NF service cannot be discovered by other NFs if the NF status is set to "SUSPENDED" or "UNDISCOVERABLE", regardless of the NF service status. |
6.1.6.3.13 Enumeration: AnNodeType
Table 6.1.6.3.13-1: Enumeration AnNodeType
Enumeration value |
Description |
"GNB" |
gNB |
"NG_ENB" |
NG-eNB |
6.1.6.3.14 Enumeration: ConditionEventType
Table 6.1.6.3.14-1: Enumeration ConditionEventType
Enumeration value |
Description |
"NF_ADDED" |
The NF Instance notified by NRF starts being part of a condition for a subscription on a set of NFs. |
"NF_REMOVED" |
The NF Instance notified by NRF stops being part of a condition for a subscription on a set of NFs. |
6.1.6.3.15 Enumeration: IpReachability
Table 6.1.6.3.15-1: Enumeration IpReachability
Enumeration value |
Description |
"IPV4" |
Only IPv4 addresses are reachable. |
"IPV6" |
Only IPv6 addresses are reachable. |
"IPV4V6" |
Both IPv4 addresses and IPv6 addresses are reachable. |
6.1.6.3.16 Enumeration: ScpCapability
Table 6.1.6.3.16-1: Enumeration ScpCapability
Enumeration value |
Description |
"INDIRECT_COM_WITH_DELEG_DISC" |
Indirect communication with delegated discovery supported |
6.1.6.3.17 Enumeration: CollocatedNfType
Table 6.1.6.3.17-1: Enumeration CollocatedNfType
Enumeration value |
Description |
"UPF" |
Network function: UPF |
"SMF" |
Network function: SMF |
"MB_UPF" |
Network function: MB-UPF |
"MB_SMF" |
Network function: MB-SMF |
6.1.6.3.18 Enumeration: LocalityType
Table 6.1.6.3.18-1: Enumeration LocalityType
Enumeration value |
Description |
"DATA_CENTER" |
Data center |
"CITY" |
City |
"COUNTY" |
County |
"DISTRICT" |
District |
"STATE" |
State |
"CANTON" |
Canton |
"REGION" |
Region |
"PROVINCE" |
Province |
"PREFECTURE" |
Prefecture |
"COUNTRY" |
Country |
NOTE 1: An operator may define custom locality types other than those defined in this table. The NRF and NFs shall accept locality types defined with custom locality type values. NOTE 2: The NRF needs not understand the semantic of the LocalityType enumeration values. The LocalityType information is used by the NRF to correlate a locality description received in the ext-preferred-locality query parameter with a locality description registered in the extLocality attribute of NFProfile with a matching LocalityType. |