9 Supported Query Parameters
Table 9-1 Supported Query Parameter
| Name | Data Type | Subscribe Id(Yes or No) | P | Description |
|---|---|---|---|---|
| target-nf-type | NFType | No | M | This Information Element (IE) contains the NF type of the target NF being discovered. |
| requester-nf-type | NFType | No | M | This IE contains the NF type of the Requester NF invoking the Nnrf_NFDiscovery service. |
| requester-nf-instance-id | NfInstanceId | No | O | If present, this IE contains the NF instance ID of the Requester NF. |
| service-names | array(ServiceName) | No | O |
If this IE is included, it will contain an array of service names for which the NRF is requested to provide the list of NF profiles. The NRF will return the NF profiles that have at least one NF service matching the service names specified in this list. The returned NF service names from the NRF will be an interclause of the requested NF service names and the NF service names registered in the NF profile. If this IE is not included, the NRF will return all the NF service names registered in the NF profile. The list contains unique items. |
| requester-nf-instance-fqdn | Fqdn | No | O | This IE might be present for an NF discovery request within the same PLMN as the NRF. If included, this IE must contain the Fully Qualified Domain Name (FQDN) of the Requester NF that is invoking the Nnrf_NFDiscovery service. The NRF must use this to return only those NF profiles that include at least one NF service containing an entry in the 'allowedNfDomains' list (see clause 6.1.6.2.3) that matches the domain of the requester NF. This IE is ignored by the NRF if received from a requester NF belonging to a different PLMN. |
| target-plmn-list | array(PlmnId) | No | C |
This IE is included when NF services in a different PLMN, or NF services of specific PLMN IDs in the same PLMN comprising multiple PLMN IDs, need to be discovered. When included, this IE will contain the target NF's PLMN ID. If more than one PLMN ID is included, NFs from any PLMN ID present in the list match the query parameter. When inter-PLMN service discovery occurs, the list should contain no more than one PLMN ID. This ID should appear in the service discovery request from the NF in the source PLMN to the NRF in the same PLMN, but it might not appear in the service discovery request from the source NRF to the target NRF. In such a case, if the NRF receives more than 1 PLMN ID, it will only consider the first element of the array and ignore the rest. |
| requester-plmn-list | array(PlmnId) | No | C | This IE is included when NF services in a different PLMN need to be discovered. When included, this IE shall contain the PLMN ID(s) of the requester NF. |
| requester-snpn-list | array(PlmnIdNid) | No | C |
This IE is included when the requester NF belongs to one or several SNPNs and the NF services of a specific SNPN need to be discovered. When present, this IE shall contain the requester NF's SNPN ID(s). The NRF uses this to return only those NF profiles of NF instances that are allowed to be discovered from the SNPNs identified by this IE, according to the "allowedSnpns" list in the NF Profile and NF Service (see clauses 6.1.6.2.2 and 6.1.6.2.3). |
| target-nf-instance-id | NfInstanceId | No | O | Identity of the NF instance being discovered. |
| target-nf-fqdn | Fqdn | No | O | FQDN of the target NF instance being discovered. |
| hnrf-uri | Uri | No | C | If included, this IE shall contain the API URI of the home NRF's NFDiscovery Service (see clause 6.2.1). It shall be included if the Requester NF has previously received such an API URI to be used for service discovery (e.g., from the NSSF in the home PLMN). |
| snssais | array(Snssai) | No | O |
If included, this IE shall contain the list of S-NSSAIs that are served by the NF (service) instances being discovered. The NRF shall return those NF profiles or NF services of NF (service) instances that have at least one of the S-NSSAIs in this list. The S-NSSAIs included in the NF profiles or NF services of NF (service) instances returned by the NRF shall be an interclause of the S-NSSAIs requested and the S-NSSAIs supported by those NF (service) instances. (NOTE 10) When the NF Profile of the NF Instances being discovered has defined the list of supported S-NSSAis in the "perPlmnSnssaiList", the discovered NF Instances shall be those having any of the S-NSSAIs included in this "snssais" parameter in any of the PLMNs included in the "target-plmn-list" attribute, if present; if the "target-plmn-list" is not included, the NRF shall assume that the discovery request is for any of the PLMNs it supports. |
| requester-snssais | array(Snssai) | No | O |
If included, this IE shall contain the list of S-NSSAI of the requester NF. If this IE is included in a service discovery 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 this to return only those NF profiles of NF instances allowed to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" list in the NF Profile and NF Service (see clauses 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12) |
| plmn-specific-snssai-list | array(PlmnSnssai) | No | O | If included, this IE shall contain the list of S-NSSAI that are served by the NF service being discovered for the corresponding PLMN provided. The NRF shall use this to identify the NF services that have registered their support for the S-NSSAIs for the corresponding PLMN given. The NRF shall return the NF profiles that have at least one S-NSSAI supported in any of the PLMNs provided in this list. The per PLMN list of S-NSSAIs included in the NF profile returned by the NRF shall be an interclause of the list requested and the list registered in the NF profile. (NOTE 10). |
| requester-plmn-specific-snssai-list | array(PlmnSnssai) | No | O | If included, this IE shall contain the list of S-NSSAI of the requester NF for each of the PLMNs it supports. The NRF shall use this to return only those NF profiles of NF instances allowed to be discovered from at least one network slice identified by this IE, according to the "allowedNssais" and "allowedPlmns" attributes in the NF Profile and NF Service (see clauses 6.1.6.2.2 and 6.1.6.2.3). (NOTE 12) |
| nsi-list | array(string) | No | O | If included, this IE shall contain the list of NSI IDs that are served by the services being discovered. |
| dnn | Dnn | - | O |
If included, this IE shall contain the DNN for which NF services serving that DNN were discovered. DNN may be included if the target NF type is, for example, "BSF," "SMF," "PCF," "PCSCF," or "UPF.". The DNN shall contain the network identifier, and it may additionally contain an operator identifier. (NOTE 11). If the Snssai(s) are also included, the NF services serving the DNN will be available in the network slice(s) identified by the Snssai(s). |
| smf-serving-area | string | No | O | If included, this IE shall contain the serving area of the SMF. It may be included if the target NF type is "UPF.". |
| tai | Tai | No | O | Tracking Area Identity. |
| amf-region-id | AmfRegionId | No | O | AMF Region Identity. |
| amf-set-id | AmfSetId | No | O | AMF Set Identity. |
| guami | Guami | No | O |
Guami used to search for an appropriate AMF. (NOTE 1) |
| supi | Supi | Yes | O | If included, this IE shall contain the SUPI of the requester UE to search for an appropriate NF. SUPI may be included if the target NF type is, for example, "PCF," "CHF," "AUSF," "UDM," or "UDR." |
| ue-ipv4-address | Ipv4Addr | Yes | O | The IPv4 address of the UE for which a BSF or P-CSCF needs to be discovered. |
| ip-domain | string | Yes | O | The IPv4 address domain of the UE for which a BSF needs to be discovered. |
| ue-ipv6-prefix | Ipv6Prefix | Yes | O | The IPv6 prefix of the UE for which a BSF or P-CSCF needs to be discovered. |
| pgw-ind | boolean | No | O |
When present, this IE indicates whether a combined SMF/PGW-C or a standalone SMF needs to be discovered. true: A combined SMF/PGW-C is requested to be discovered; false: A standalone SMF is requested to be discovered. |
| pgw | Fqdn | No | O | If included, this IE shall contain the PGW FQDN, which is received by the AMF from the MME to find the combined SMF or PGW. |
| gpsi | Gpsi | Yes | If included, this IE shall contain the GPSI of the requester UE to search for an appropriate NF. GPSI may be included if the target NF type is "CHF," "PCF," "UDM," or "UDR." | |
| external-group-identity | ExtGroupId | Yes | O | If included, this IE shall contain the external group identifier of the requester UE to search for an appropriate NF. This may be included if the target NF type is "UDM" or "UDR." |
| pfd-data | PfdData | No | O |
When present, this IE shall contain the application identifiers and/or application function identifiers in PFD management. This may be included if the target NF type is "NEF.". The NRF shall return those NEF instances that can provide the PFDs for at least one of the provided application identifiers or for at least one of the provided application function identifiers. |
| data-set | DataSetId | No | O | Indicates the data set to be supported by the NF to be discovered. May be included if the target NF type is "UDR." |
| routing-indicator | string | Yes | O |
Routing indicator information that allows to route network signaling with SUCI (see 3GPP 23.003 [12]) to an AUSF and UDM instance capable of serving the subscriber. May be included if the target NF type is "AUSF" or "UDM." Pattern: "^[0-9]{1,4}$" |
| group-id-list | array(NfGroupId) | No | Identity of the groups of the NFs of the target NF type to be discovered. May be included if the target NF type is "UDR," "UDM," "HSS," "PCF," "AUSF," or "CHF." | |
| dnai-list | array(Dnai) | No | If included, this IE shall contain the data network access identifiers. It may be included if the target NF type is "UPF." | |
| upf-iwk-eps-ind | Boolean | No | O |
When present, this IE indicates whether a UPF supporting interworking with EPS needs to be discovered. true: A UPF supporting interworking with EPS is requested to be discovered; false: A UPF not supporting interworking with EPS is requested to be discovered. |
| chf-supported-plmn | PlmnId | No | O | If included, this IE shall contain the PLMN ID that a CHF supports (for example, in the PlmnRange of ChfInfo attribute in the NFProfile). This IE may be included when the target NF type is "CHF." |
| preferred-locality | string | No | O |
Preferred target NF location (for example, geographic location, data center). When present, the NRF shall prefer NF profiles with a locality attribute that matches the preferred locality. The NRF may return additional NFs in the response not matching the preferred target NF location, for example, if no NF profile is found matching the preferred target NF location. The NRF should set a lower priority for any additional NFs on the response not matching the preferred target NF location than those matching the preferred target NF location. (NOTE 6) |
| access-type | AccessType | No | C | If included, this IE shall contain the access type that is required to be supported by the target NF, such as SMF. |
| supported-features | SupportedFeatures | No | O |
List of features required to be supported by the target NF. This IE may be present only if the service-names attribute is present and if it contains a single service name. Otherwise, the NRF will ignore it. (NOTE 4) |
| required-features | array(SupportedFeatures) | No | O |
List of features required to be supported by the target Network Function, as defined by the supportedFeatures attribute in NFService (see clauses 6.1.6.2.3 and 6.2.6.2.4). This IE may be present only if the service-names attribute is present. When present, the required-features attribute shall contain as many entries as the number of entries in the service-names attribute. The nth entry in the required-features attribute shall correspond to the nth entry in the service-names attribute. An entry corresponding to a service for which no specific feature is required shall be encoded as "0." |
| complex-query | ComplexQuery | No | O | This query parameter is used to override the default logical relationship of query parameters. |
| limit | integer | No | O |
The maximum number of NFProfiles to be returned in the response. Minimum: 1 |
| max-payload-size | integer | No | O |
Maximum payload size (before compression, if any) of the response, expressed in kilo octets. When present, the NRF shall limit the number of NF profiles returned in the response so as not to exceed the maximum payload size indicated in the request. Default: 124. Maximum: 2000 (such as 2 million octets). |
| max-payload-size-ext | integer | No | O |
Maximum payload size (before compression, if any) of the response, expressed in kilo octets. When present, the NRF shall limit the number of NF profiles returned in the response so as not to exceed the maximum payload size indicated in the request. This query parameter is used when the consumer supports payload sizes larger than 2 million octets. Default: 124 |
| pdu-session-types | array(PduSessionType) | No | O | List of the PDU session types requested to be supported by the target Network Function (such as UPF). |
| event-id-list | array(EventId) | No | O | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf AnalyticsInfo Service, and the NRF shall return NF, which supports all the requested events. |
| nwdaf-event-list | array(NwdafEvent) | No | O | If present, this attribute shall contain the list of events requested to be supported by the Nnwdaf_EventsSubscription service, and the NRF shall return NF, which supports all the requested events. |
| atsss-capability | AtsssCapability | No | O | When present, this IE indicates the ATSSS capability of the target UPF needs to be supported. |
| upf-ue-ip-addr-ind | boolean | No | O |
When present, this IE indicates whether a UPF supporting allocating UE IP addresses or prefixes needs to be discovered. true: a UPF supporting UE IP addresses and prefixes is requested to be discovered; false: a UPF not supporting UE IP addresses or prefix allocation is requested to be discovered. |
| client-type | ExternalClientType | No | O |
When present, this IE indicates that NF(s) dedicatedly serving the specified client type need to be discovered. This IE may be included when the target NF type is "LMF" or "GMLC.". If no NF profile is found dedicatedly serving the requested client type, the NRF may return NF(s) not dedicatedly serving the requested client type in the response. |
| lmf-id | LMFIdentification | No | O | When present, this IE shall contain LMF identification to be discovered.This may be included if the target NF type is "LMF." |
| an-node-type | AnNodeType | No | O | If included, this IE shall contain the AN Node type, which is required to be supported by the target Network Function (such as LMF). |
| rat-type | RatType | No | O | If included, this IE shall contain the RAT type that is required to be supported by the target Network Function (such as LMF). |
| target-snpn | PlmnIdNid | No | C | This IE shall be included when the NF services of a specific SNPN need to be discovered. When included, this IE shall contain the PLMN ID and NID of the target NF. |
| af-ee-data | AfEventExposureData | No | O | When present, this shall contain the application events and, optionally, application function identifiers and application identifiers of the AF(s). This may be included if the target NF type is "NEF." |
| w-agf-info | WAgfInfo | No | O | If included, this IE shall contain the W-AGF identifiers of N3 terminations which is received by the SMF to find the combined W-AGF/UPF. |
| tngf-info | TngfInfo | No | O | If included, this IE shall contain the TNGF identifiers of N3 terminations which is received by the SMF to find the combined TNGF or UPF. |
| twif-info | TwifInfo | No | O | If included, this IE shall contain the TWIF identifiers of N3 terminations which is received by the SMF to find the combined TWIF or UPF. |
| target-nf-set-id | NfSetId | No | O |
When present, this IE shall contain the target NF Set ID (as defined in clause 28.12 of 3GPP TS 23.003 [12]) of the NF instances being discovered. |
| target-nf-service-set-id | NfServiceSetId | No | O | When present, this IE shall contain the target NF Service Set ID (as defined in clause 28.13 of 3GPP TS 23.003 [12]) of the NF service instances being discovered. |
| preferred-tai | Tai | No | O |
When present, the NRF shall prefer NF profiles that can serve the TAI, or the NRF shall return NF profiles not matching the TAI if no NF profile is found matching the TAI. (NOTE 5) |
| nef-id | NefId | No | O | When present, this IE shall contain the NEF ID of the NEF to be discovered. This may be included if the target NF type is "NEF." (NOTE 7) |
| preferred-nf-instances | array(NfInstanceId) | No | O | When present, this IE shall contain a list of preferred candidate NF instance IDs. (NOTE 8) |
| notification-type | NotificationType | No | O |
If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the notification-type parameter. (NOTE 9) |
| n1-msg-class | N1MessageClass | No | O |
This IE may be included when the "notification-type" IE is present with the value "N1_MESSAGES.". When included, this IE shall contain the N1 message class of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n1-msg-class parameter. (NOTE 9) |
| n2-info-class | N2InformationClass | No | O |
This IE may be included when the "notification-type" IE is present with the value "N2_INFORMATION.". If included, this IE shall contain the notification type of default notification subscriptions that shall be registered in the NFProfile or NFService of the NF Instances being discovered. The NF profiles returned by the NRF shall contain all the registered default notification subscriptions, including the one corresponding to the n2-info-class parameter. (NOTE 9) |
| serving-scope | array(string) | No | O | If present, this attribute shall contain the list of areas that can be served by the NF instances to be discovered. The NRF shall return NF profiles of NFs that can serve all the areas requested in this query parameter. |
| imsi | string | No | O |
If included, this IE shall contain the IMSI of the requester UE to search for an appropriate NF. IMSI may be included if the target NF type is "HSS.". pattern: "[0-9]{5,15}" |
| ims-private-identity | string | No | O | If included, this IE shall contain the IMS private identity of the requester UE to search for an appropriate NF. IMS Private Identity may be included if the target NF type is "HSS." |
| ims-public-identity | string | If included, this IE shall contain the IMS public identity of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS." | ||
| msisdn | string | If included, this IE shall contain the MSISDN of the requester UE to search for an appropriate NF. IMS Public Identity may be included if the target NF type is "HSS". | ||
| internal-group-identity | GroupId | No | O | If included, this IE shall contain the internal group identifier of the UE to search for an appropriate NF. This may be included if the target NF type is "UDM." |
| preferred-api-versions | map(string) | No | O |
When present, this IE indicates the preferred API version of the services that are supported by the target NF instances. The key of the map is the service name (see clause 6.1.6.3.11) for which the preferred API version is indicated. Each element carries the API version indication for the service indicated by the key. The NRF may return additional NFs in the response not matching the preferred API versions, for example, if no NF profile is found matching the preferred- API -versions. An API Version Indication is a string formatted as {operator}+{API Version}. The following operators will be supported:
Precedence between versions is identified by comparing the Major, Minor, and Patch version fields numerically, from left to right. If no operator or an unknown operator is provided in API Version Indication, "=" operator is applied. Example of API Version Indication: Case1: "=1.2.4.operator-ext" or "1.2.4.operator-ext" means matching the service with API version "1.2.4.operator-ext" Case2: ">1.2.4" means matching the service with API versions greater than "1.2.4" Case3: "^2.3.0" or "^2" means matching the service with all API versions with major version "2". |
| v2x-support-ind | boolean | No | O |
When present, this IE indicates whether a PCF supporting V2X policy or parameter provisioning needs to be discovered. true: a PCF supporting V2X policy or parameter provisioning is requested to be discovered; false: a PCF not supporting V2X policy or parameter provisioning is requested to be discovered. |
| redundant-gtpu | boolean | No | O |
When present, this IE indicates whether a UPF supporting redundant GTP-U paths needs to be discovered. true: a UPF supporting redundant GTP-U paths is requested to be discovered; false: a UPF not supporting redundant GTP-U paths is requested to be discovered. |
| redundant-transport | boolean | No | O |
When present, this IE indicates whether a UPF supporting redundant transport paths on the transport layer in the corresponding network slice needs to be discovered.
true: a UPF supporting redundant transport paths on the transport layer is requested to be discovered; false: a UPF not supporting redundant transport paths on the transport layer is requested to be discovered.
If the Snssai(s) are also included, the UPF supporting redundant transport paths on the transport layer shall be available in the network slice(s) identified by the Snssai(s). |
| ipups | boolean | No | O |
When present, this IE indicates whether a UPF that is configured for IPUPS is requested to be discovered. true: a UPF that is configured for IPUPS is requested to be discovered; false: a UPF that is not configured for IPUPS is requested to be discovered. |
| scp-domain-list | array(string) | No | O | When present, this IE shall contain the SCP domains the target NF or SCP belongs to. The NRF shall return NF or SCP profiles that belong to all the SCP domains provided in this list. |
| address-domain | Fqdn | No | O | If included, this IE shall contain the address domain that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP." |
| ipv4-addr | Ipv4Addr | No | O | If included, this IE shall contain the IPv4 address that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP." |
| ipv6-prefix | Ipv6Prefix | No | O | If included, this IE shall contain the IPv6 prefix that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". |
| served-nf-set-id | NfSetId | No | O | When present, this IE shall contain the NF Set ID that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". |
| remote-plmn-id | PlmnId | No | O | If included, this IE shall contain the remote PLMN ID that shall be reachable through the SCP. This IE may be included when the target NF type is "SCP". |
| data-forwarding | boolean | No | O |
This may be included if the target NF type is "UPF." (NOTE 13) When present, the IE indicates whether UPFs configured for data forwarding need to be discovered. true: UPF(s) configured for data forwarding are requested to be discovered; false: UPF(s) not configured for data forwarding are requested to be discovered. |
| preferred-full-plmn | boolean | No | O |
When present, the NRF shall prefer NF profile(s) that can serve the full PLMN (can serve any TAI in the PLMN), or the NRF shall return other NF profiles if no NF profile serving the full PLMN is found: true: NF instances serving the full PLMN are preferred; false: NF instances serving the full PLMN are not preferred. (NOTE 14) |
| requester-features | SupportedFeatures | No | C |
Nnrf_NFDiscovery features are supported by the Requester NF that is invoking the Nnrf_NFDiscovery service. The Requester NF shall include this IE if it supports at least one of the following features: - Service-Map This IE may be included elsewhere. |
| realm-id | string | No | O | May be included if the target NF type is "UDSF." If included, this IE shall contain the realm- ID for which a UDSF shall be discovered. |
| storage-id | string | No | O | May be included if the target NF type is "UDSF" and realm-id is included. If included, this IE shall contain the storage-id for the realm-id indicated in the realm-id IE for which a UDSF shall be discovered. |
| vsmf-support-ind | boolean | No | O |
If included, this IE shall indicate that target SMF(s) that support V-SMF capability are preferred. This IE may be included when the target NF type is "SMF." (NOTE 15) |
| gmlc-number | string | No | O |
If included, this IE shall contain the GMLC number, which should be supported by the target GMLC. It may be included if the target NF type is "GMLC.". Pattern: "^[0-9]{5,15}$" |