5 Services offered by the UCMF

29.6733GPP5G SystemRelease 18Stage 3TSUE radio capability management services

Tools: ARFCN - Frequency Conversion for 5G NR/LTE/UMTS/GSM

5.1 Introduction

The UCMF supports the following services.

Table 5.1-1: NF Services provided by UCMF

Service Name	Description	Example Consumer
Nucmf_UECapabilityManagement	Allows the NF consumer to resolve UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) into the corresponding UE radio access capability and the corresponding UE Radio Capability for Paging. Allows the NF consumer to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability. Allows the NF consumer to subscribe or unsubscribe for notifications of UCMF dictionary entries. Allows the NF consumer to be notified about creation and deletion of UCMF dictionary entries.	AMF, MME

Service Name

Description

Example Consumer

Nucmf_UECapabilityManagement

Allows the NF consumer to resolve UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned) into the corresponding UE radio access capability and the corresponding UE Radio Capability for Paging.

Allows the NF consumer to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability.

Allows the NF consumer to subscribe or unsubscribe for notifications of UCMF dictionary entries.

Allows the NF consumer to be notified about creation and deletion of UCMF dictionary entries.

AMF, MME

5.2 Nucmf_UECapabilityManagement Service

5.2.1 Service Description

The Nucmf_UECapabilityManagement service operates on the dictionary entries for the mapping between UE Radio Capability ID and UE Radio Access Capability Information. The service operations exposed by this service allow service consumer NF, e.g. an AMF:

– to retrieve UE radio access capability information with a UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned);

– to obtain a PLMN-assigned UE Radio Capability ID for a specific UE radio access capability information;

– to subscribe or unsubscribe for notifications of UCMF dictionary entries;

– to be notified about creation and deletion of UCMF dictionary entries;

The Nucmf_UECapabilityManagement service supports the following service operations;

Table 5.2.1-1: Service operations supported by the Nucmf_UECapabilityManagement service

Service Operations	Description	Operation Semantics	Example Consumer(s)
Resolve	Retrieve UE radio access capability information from the dictionary entry identified by the UE Radio Capability ID (either Manufacturer-assigned or PLMN-assigned)	Request/Response	AMF, MME
Assign	Request to assign a UE Radio Capability ID by providing the UE Radio Capability Information. See 3GPP TS 23.502 clause 5.2.18.3.2.	Request/Response	AMF, MME
Subscribe	Subscribe for notifications of UCMF dictionary entries.	Subscribe/Notify	AMF, MME
Unsubscribe	Unsubscribe for notifications of UCMF dictionary entries.	Subscribe/Notify	AMF, MME
Notify	To be notified about creation and deletion of UCMF dictionary entries.	Subscribe/Notify	AMF, MME

5.2.2 Service Operations

5.2.2.1 Introduction

See Table 5.2.1-1 for an overview of the service operations supported by the Nucmf_UECapabilityManagement service.

5.2.2.2 Service Operation Resolve

5.2.2.2.1 General

The Resolve service operation shall be used to retrieve UE Radio Access Capability Information from a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when:

– it has received an unknown UE Radio Capability ID, which is either Manufacturer-assigned or PLMN-assigned;

The NF Service Consumer (e.g. AMF) shall retrieve UE Radio Access Capability Information by using the HTTP GET method as shown in Figure 5.2.2.2.1-1.

Figure: 5.2.2.2.1-1 Retrieve UE Radio Access Capability Information

1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to the resource URI Dictionary Entries collection resource. The query parameters are a Manufacturer-assigned or a PLMN-assigned UE Radio Capability ID, and the Coding format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided.

2a. On success, "200 OK" shall be returned. The response body shall contain UE Radio Access Capability Information in the requested Coding format stored in the dictionary entry that is matching the UE Radio Capability ID in query, and may contain a PLMN-assigned UE Radio Capability ID if the query parameter is a Manufacturer-assigned UE Radio Capability ID and if the PLMN-assigned UE Radio Capability ID mechanism is used in the network.

2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.3.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-2, where applicable.

5.2.2.2.2 Retrieve a Dictionary Entry

The Resolve service operation may be used to retrieve a dictionary entry stored in the UCMF, by a NF service consumer, e.g. an AMF, when it has the Dictionary Entry ID available.

The NF Service Consumer (e.g. AMF) shall retrieve a Dictionary Entry by using the HTTP GET method as shown in Figure 5.2.2.2.1-1.

Figure 5.2.2.2.1-1 Retrieve a dictionary entry

1. The NF Service Consumer, e.g. an AMF, shall send an HTTP GET request to an individual Dictionary Entry resource. The query parameter is the Coding Format (e.g. 5GS or EPS) in which UE Radio Access Capability Information needs to be provided.

2a. On success, "200 OK" shall be returned. The response body shall the dictionary entry information for the given Dictionary Entry ID.

5.2.2.3 Service Operation Assign

The Assign service operation shall be used by the service consumer NF (e.g. AMF) to obtain a PLMN-assigned UE Radio Capability ID from the UCMF for a specific UE radio access capability information. The UCMF shall create a new dictionary entry and assign a PLMN-assigned UE Radio Capability ID unless such dictionary entry already exists and a PLMN-assigned UE Radio Capability ID has already been assigned to the given UE radio access capability information in the UCMF. The NF service consumer, e.g. an AMF, may consume the service by providing the UE Radio Access Capability Information retrieved from the UE, and Type Allocation Code of PEI of the UE, e.g. when it hasn’t received any UE Radio Capability ID.

The NF Service Consumer (e.g. AMF) shall obtain the PLMN Assigned UE Radio Capability ID by using the HTTP POST method as shown in Figure 5.2.2.3.1-1.

Figure 5.2.2.3-1 Create a dictionary entry

1. The NF Service Consumer shall send a POST request to the resource representing the Dictionary Entries collection resource of the UCMF. The payload body of the POST request shall contain:

– the UE Radio Access Capability Information for the current radio configuration of the UE in 5GS format, or EPS format, or both the formats;

– the Type Allocation Code of the PEI of the UE.

2a. On success, the UCMF shall check whether for the provided input a dictionary entry already exists and a PLMN Assigned UE Radio Capability ID has already been assigned. If so "201 Created" shall be returned, the payload body of the POST response shall contain already assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the already existing resource. Otherwise a new dictionary entry shall be created and "201 Created" shall be returned, the payload body of the POST response shall contain the newly assigned PLMN Assigned UE Radio Capability ID included in DicEntryCreatedData and the "Location" header shall be present and shall contain the URI of the newly created resource.

2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.2.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.3.3.2-2, where applicable. A UCMF configured to operate in Mode of Operation A (3GPPP TS 23.501, Clause 5.4.4.1a) shall reject the operation if the request does not contain UE Radio Access Capability Information in both the formats and the UCMF is not able to find match of the received UE Radio Access Capability Information in its database.

5.2.2.4 Service Operation Subscribe

5.2.2.4.1 General

The Subscribe service operation shall be used by a NF Service Consumer, e.g. an AMF, to create a subscription in the UCMF, to get notifications for one or more new dictionary entries creation or for the deletion of one or more PLMN Assigned UE Radio Capability IDs.

The NF Service Consumer shall request to create a new subscription by using HTTP method POST with URI of the subscriptions collection, see clause 6.1.3.4. A ucmfNotificationUri shall be provided in the CreateSubscription to be used by the UCMF to send notifications later. See Figure 5.2.2.4.1-1.

Figure 5.2.2.4.1-1 Create a subscription

1. The NF Service Consumer shall send a POST request to create a subscription resource in the UCMF. The payload body of the POST request shall contain a representation of the individual subscription resource to be created. The request may contain an expiry time, suggested by the NF Service Consumer as a hint, representing the time upto which the subscription is desired to be kept active and the time after which the subscribed event(s) shall stop generating report.

2a. On success, the request is accepted, the UCMF shall include a HTTP Location header to provide the location of a newly created resource (subscription) together with the status code 201 indicating the requested resource is created in the response message. The UCMF may also include the highest dictionary entry ID which has been allocated.

The response, based on operator policy and taking into account the expiry time included in the request, may contain the expiry time, as determined by the UCMF, after which the subscription becomes invalid. Once the subscription expires, if the NF Service Consumer wants to keep receiving notifications, it shall create a new subscription in the UCMF. The UCMF shall not provide the same expiry time for many subscriptions in order to avoid all of them expiring and recreating the subscription at the same time. If the expiry time is not included in the response, the NF Service Consumer shall consider the subscription to be valid without an expiry time.

2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.4.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application errors listed in Table 6.1.3.4.3.1-3.

5.2.2.5 Unsubscribe

5.2.2.5.1 General

The Unsubscribe service operation is used by a NF Service Consumer, e.g. AMF, towards the UCMF, to remove an existing subscription previously created by itself at the UCMF.

The NF Service Consumer shall unsubscribe to the subscription by using HTTP method DELETE with the URI of the individual subscription resource (see clause 6.1.3.5) to be deleted. See Figure 5.2.2.5.1-1.

Figure 5.2.2.5.1-1 Unsubscribe a subscription

1. The NF Service Consumer shall send a DELETE request to delete an existing subscription resource in the UCMF.

2a. On success, the request is accepted, the UCMF shall reply with the status code 204 indicating the resource identified by subscription ID is successfully deleted in the response message.

2b. On failure or redirection, one of the HTTP status code listed in Table 6.1.3.5.3.2-3 shall be returned. For a 4xx/5xx response, the message body may contain a ProblemDetails structure with the "cause" attribute set to one of the application error listed in Table 6.1.3.5.3.2-3.

5.2.2.6 Notify

5.2.2.6.1 General

The Notify service operation is used by the UCMF, to send a notification, towards the notification URI, when certain event included in the subscription has taken place.

The UCMF shall use the HTTP method POST, using the notification URI received in the subscription creation as specified in clause 5.2.2.4.1. See Figure 5.2.2.6.1-1.

Figure 5.2.2.6.1-1 Notify

1. The AMF shall send a POST request to send a notification.

2a. On success, "204 No content" shall be returned by the NF Service Consumer.

2b. On failure or redirection, the appropriate HTTP status code listed in Table 6.1.5.2.3.1-3 shall be returned. For a 4xx/5xx response, the message body may contain appropriate additional error information.