Content for TS 23.434 Word version: 19.4.2
0…
6…
8…
9…
9.3…
9.3.3…
9.3.8…
9.3.13…
9.3.20…
9.3.23…
9.4…
10…
10.3…
10.3.3…
10.3.7…
10.4…
11…
12…
13…
14…
14.3…
14.3.3
14.3.4
14.3.4A…
14.3.4A.5…
14.3.4A.8…
14.3.5…
14.3.9…
14.4…
15…
17…
18…
A…
11 Configuration management
11.1 General
11.2 Functional model for configuration management
11.2.1 General
11.2.2 On-network functional model description
11.2.3 Off-network functional model description
11.2.4 Functional entities description
11.2.5 Reference points description
11.3 Procedures and information flows for configuration management
11.3.1 General
11.3.2 Information flows
11.3.3 VAL UE configuration data
11.3.4 VAL user profile data
11.3.5 VAL service data
11.4 SEAL APIs for configuration management
11.4.1 General
11.4.2 SS_UserProfileRetrieval API
11.4.3 SS_UserProfileEvent API
11.4.4 SS_VALServiceData API
...
...
11 Configuration management p. 168
11.1 General p. 168
The configuration management is a SEAL service that offers the configuration management related capabilities to one or more vertical applications.
11.2 Functional model for configuration management p. 169
11.2.1 General p. 169
The functional model for the configuration management is based on the generic functional model specified in clause 6. It is organized into functional entities to describe a functional architecture which addresses the support for configuration management aspects for vertical applications. The on-network and off-network functional model is specified in this clause.
11.2.2 On-network functional model description p. 169
Figure 11.2.2-1 illustrates the generic on-network functional model for configuration management.
The configuration management client communicates with the configuration management server over the CM-UU reference point. The configuration management client provides the support for configuration management functions to the VAL client(s) over CM-C reference point. The VAL server(s) communicate with the configuration management server over the CM-S reference point. The configuration management server communicates with the VAL user database over the CM-VAL-UDB reference point.
11.2.3 Off-network functional model description p. 169
Figure 11.2.3-1 illustrates the off-network functional model for configuration management.
The configuration management client of the UE1 communicates with the configuration management client of the UE2 over the CM-PC5 reference point.
11.2.4 Functional entities description p. 170
11.2.4.1 General p. 170
The functional entities for configuration management SEAL service are described in the following subclauses.
11.2.4.2 Configuration management client p. 170
The configuration management client functional entity acts as the application client for configuration related transactions. The configuration management client interacts with the configuration management server and provides and receives configuration data. The configuration management client also supports interactions with the corresponding configuration management client between the two UEs.
The configuration management client functional entity is supported by the signalling user agent and HTTP client functional entities of the signalling control plane.
11.2.4.3 Configuration management server p. 170
The configuration management server is a functional entity used to configure one or more vertical applications with 3GPP system related vertical applications provisioning information and configure data on the configuration management client. The configuration management server manages vertical application configuration supported within the vertical's service provider. The configuration management server acts as CAPIF's API exposing function as specified in TS 23.222. The configuration management server also supports interactions with the corresponding configuration management server in distributed SEAL deployments.
The configuration management server functional entity is supported by the SIP AS and HTTP server functional entities of the signalling control plane.
11.2.5 Reference points description p. 170
11.2.5.1 General p. 170
The reference points for the functional model for configuration management are described in the following subclauses.
11.2.5.2 CM-UU p. 171
The interactions related to configuration management functions between the configuration management client and the configuration management server are supported by CM-UU reference point. This reference point utilizes Uu reference point as described in TS 23.401 and TS 23.501.
The CM-UU reference point provides the configuration information required for VAL services and supports:
- configuration of the VAL UE by the VAL service; and
- configuration of the VAL application with the VAL service related information e.g. policy information by the VAL UE.
11.2.5.3 CM-PC5 p. 171
The interactions related to configuration management functions between the configuration management clients located in different VAL UEs are supported by CM-PC5 reference point. This reference point utilizes PC5 reference point as described in TS 23.303.
11.2.5.4 CM-C p. 171
The interactions related to configuration management functions between the VAL client(s) and the configuration management client within a VAL UE are supported by CM-C reference point.
11.2.5.5 CM-S p. 171
The interactions related to configuration management functions between the VAL server(s) and the configuration management server are supported by CM-S reference point. The CM-S reference point supports VAL server to obtain the VAL service related vertical applications provisioning information. This reference point is an instance of CAPIF-2 reference point as specified in TS 23.222.
The CM-S reference point shall use HTTP-1/ HTTP-2 reference points for transport and routing of configuration management related signalling. The CM-S reference point shall use SIP-2 reference point for subscription / notification related signalling.
11.2.5.6 CM-E p. 171
The interactions related to configuration management functions between the configuration management servers in a distributed deployment are supported by CM-E reference point.
11.2.5.7 Reference point CM-VAL-UDB (between the configuration management server and the VAL user database) p. 171
The CM-VAL-UDB reference point is an instance of VAL-UDB reference point, which exists between the VAL user database and the configuration management server, is used for:
- the configuration management server to store the user profile data in the specific VAL user database;
- the configuration management server to obtain the user profile from the specific VAL user database for further configuration in the VAL UE;
- the configuration management server to update the user profile data in the specific VAL user database; and
- the configuration management server to delete the user profile data from the specific VAL user database
11.3 Procedures and information flows for configuration management p. 172
11.3.1 General p. 172
The procedures related to the configuration management are described in the following subclauses.
11.3.2 Information flows p. 172
11.3.2.1 Get VAL UE configuration request p. 172
Table 11.3.2.1-1 describes the information flow get VAL UE configuration request from the configuration management client to the configuration management server.
| Information Element | Status | Description |
|---|---|---|
| VAL UE ID | M | Identify of the VAL UE requesting the configuration information |
| VAL service ID | O
(see NOTE 1) | Identify of the VAL service for which the configuration information is requested |
| VAL UE Information (see NOTE 2) | O | Additional UE related information required to identify the configuration data (e.g. device type, device vendor, etc) |
|
NOTE 1:
If the VAL service ID information element is not present, then the default service is service.
NOTE 2:
The VAL service provider can configure the VAL UE with different configuration data based on this IE.
|
||
11.3.2.2 Get VAL UE configuration response p. 172
Table 11.3.2.2-1 describes the information flow get VAL UE configuration response from the configuration management server to the configuration management client.
| Information Element | Status | Description |
|---|---|---|
| Result | M | Indicates the success or failure of getting the configuration information |
| VAL UE configuration data | O
(see NOTE) | The VAL UE configuration data as specified in the corresponding VAL service specification and outside the scope of the present document |
|
NOTE:
If the Result information element indicates failure then VAL UE configuration data information element is not included.
|
||
11.3.2.3 Get VAL user profile request p. 172
Table 11.3.2.3-1 describes the information flow get VAL user profile request from the configuration management client or VAL server to the configuration management server.
| Information Element | Status | Description |
|---|---|---|
| Requester Identity | M | The identity of the configuration management client or VAL server performing the request. |
| Identity | M | The VAL user ID of the VAL user or VAL UE ID. |
11.3.2.4 Get VAL user profile response p. 173
Table 11.3.2.4-1 describes the information flow get VAL user profile response from the configuration management server to the configuration management client or VAL server.
| Information Element | Status | Description |
|---|---|---|
| VAL user profile data | M
(see NOTE) | One or more VAL user profiles associated with the VAL user ID or VAL UE ID provided in the associated get VAL user profile request |
| Result | M | Indicates the success or failure for the operation |
|
NOTE:
If the Result information element indicates failure then the value of VAL user profile data information element has no meaning.
|
||
11.3.2.5 Notification for VAL user profile data update p. 173
Table 11.3.2.5-1 describes the information flow notification for VAL user profile data update from the configuration management server to the configuration management client.
| Information Element | Status | Description |
|---|---|---|
| Pointer to modified VAL user profile data | M | Pointer to the modified VAL user profile data |
11.3.2.6 Get updated VAL user profile data request p. 173
Table 11.3.2.6-1 describes the information flow get updated VAL user profile data request from the configuration management client to the configuration management server.
| Information Element | Status | Description |
|---|---|---|
| Identity | M | The VAL user ID of the originating VAL user or VAL UE ID |
| Pointer to modified VAL user profile data | M | Pointer to the modified VAL user profile data |
11.3.2.7 Get updated VAL user profile data response p. 173
Table 11.3.2.7-1 describes the information flow get updated VAL user profile data response from the configuration management server to the configuration management client.
| Information Element | Status | Description |
|---|---|---|
| Updated VAL user profile data | M
(see NOTE) | VAL user profile data that has been modified |
| Result | M | Indicates the success or failure for the operation |
|
NOTE:
If the Result information element indicates failure then the value of Updated VAL user profile data information element has no meaning.
|
||
11.3.2.8 Update VAL user profile data request p. 173
Table 11.3.2.8-1 describes the information flow update VAL user profile data request from the configuration management client to the configuration management server.
| Information Element | Status | Description |
|---|---|---|
| Identity | M | The VAL user ID of the originating VAL user or VAL UE ID |
| Updated VAL user profile data | M | The contents of the user profile data to be updated |
11.3.2.9 Update VAL user profile data response p. 174
Table 11.3.2.9-1 describes the information flow update VAL user profile data response from the configuration management server to the configuration management client.
| Information Element | Status | Description |
|---|---|---|
| Result | M | Indicates the success or failure |
11.3.2.10 Updated user profile subscription request p. 174
Table 11.3.2.10-1 describes the information flow from the VAL server to the configuration management server for updated user profile subscription request.
| Information Element | Status | Description |
|---|---|---|
| Requester Identity | M | The identity of the VAL server performing the request |
| Identities list | M | List of VAL users or VAL UEs whose updates on user profile is requested |
| Time between consecutive user profile updates | M | It indicates the interval time between consecutive user profile updates |
11.3.2.11 Updated user profile subscription response p. 174
Table 11.3.2.11-1 describes the information flow from the configuration management server to the VAL server for updated user profile subscription response.
| Information Element | Status | Description |
|---|---|---|
| Subscription status | M
(see NOTE) | It indicates the subscription result |
| Result | M | Indicates the success or failure for the operation |
|
NOTE:
If the Result information element indicates failure then the value of the Subscription status information element has no meaning.
|
||
11.3.2.12 Updated user profile notification p. 174
Table 11.3.2.12-1 describes the information flow updated user profile notification from the configuration management server to the VAL server.
| Information Element | Status | Description |
|---|---|---|
| Identities list | M | List of VAL users or VAL UEs whose user profile is modified |
| Updated user profile data | M | User profile data that has been modified |
11.3.2.13 Get VAL service request |R18| p. 175
Table 11.3.2.13-1 describes the information flow get VAL service request from the consumer (e.g. group management) server to the configuration management server.
| Information element | Status | Description |
|---|---|---|
| Requester Identity | M | The identity of the entity performing the request. |
| Identity list | O
(see NOTE) | The VAL user IDs or VAL UE IDs. |
| VAL service ID list | O
(see NOTE) | The requested VAL service IDs for the identity list. |
|
NOTE:
At least one of Identity list or VAL service ID list shall be included. With both Identity list and VAL service ID in the request, the response only contains common VAL services (as requested) for the requested VAL users or VAL UEs.
|
||
11.3.2.14 Get VAL service response |R18| p. 175
Table 11.3.2.14-1 describes the information flow get VAL service response from the configuration management server to the consumer (e.g. group management server).
| Information element | Status | Description |
|---|---|---|
| A list of VAL service data | O
(see NOTE 1) | One or more VAL service data associated with the VAL user ID or VAL UE ID. |
| > Identity | M | The VAL user ID or VAL UE ID. |
| > VAL service IDs | M | The supported VAL service IDs. |
| > VAL service specific information | O
(see NOTE 2) | Placeholder for VAL service specific information. |
| Result | M | Indicates the success or failure for the operation. |
|
NOTE 1:
It is valid when the Result information element indicates success.
NOTE 2:
The details of this information element are specified in VAL service specific specification and are out of scope of the present document.
|
||
11.3.3 VAL UE configuration data p. 175
11.3.3.1 General p. 175
The VAL UE configuration data has to be known by the VAL UE before it can use the VAL service.
11.3.3.2 Procedures p. 175
The procedure for VAL UE obtaining the VAL UE related configuration data is illustrated in Figure 11.3.3.2-1.
Pre-conditions:
- The VAL UE has the secure access to the configuration management server.
Step 1.
The configuration management client sends a get VAL UE configuration request to the configuration management server for obtaining VAL UE configuration data.
Step 2.
The configuration management server sends get VAL UE configuration response to the configuration management client. This message carries the VAL UE configuration data.
11.3.3.3 Structure of VAL UE configuration data p. 176
11.3.4 VAL user profile data p. 176
11.3.4.1 General p. 176
The VAL user profile procedures are described in the following subclauses.
11.3.4.2 Obtaining the VAL user profile(s) from the network p. 176
11.3.4.2.1 Obtaining the VAL user profile(s) in primary VAL system p. 176
The procedure for the VAL user or VAL server obtaining VAL user profiles in the primary VAL system of that VAL user is illustrated in Figure 11.3.4.2.1-1.
Pre-conditions:
- The VAL user has performed user authentication in the identity management server.
- The VAL UE or VAL server has secure access to the configuration management server.
Step 1.
The configuration management client or VAL server sends a get VAL user profile request message to the configuration management server, which includes the VAL user ID or VAL UE ID.
Step 2.
The configuration management server obtains the VAL user profile information.
Step 3.
The configuration management server sends get VAL user profile response message to the configuration management client or VAL server. When a download is necessary, this message includes all VAL user profiles that are associated with the VAL user ID or VAL UE ID.
11.3.4.2.2 VAL user receiving VAL service from a partner VAL system p. 177
Figure 11.3.4.2.2-1 below illustrates mechanism for the configuration management client to retrieve the VAL user profile for the migrating VAL user from the partner VAL system.
Preconditions
- The VAL user is permitted to migrate to the partner VAL system, and the relevant authorizations are configured in both the primary and partner VAL systems of that VAL user
- The VAL user has performed VAL user authentication in the partner VAL system, and has received the necessary credentials to retrieve configuration information and to request service authorization.
- The VAL UE has been provided with addressing information to allow the configuration management client in the VAL UE to access the configuration management server in the partner VAL system.
Step 1.
The configuration management client in the VAL UE of the migrating VAL user requests the VAL user profile for migration from the configuration management server in the partner VAL system.
Step 2.
The configuration management server in the partner VAL system requests the VAL user profile from the configuration management server in the primary VAL system of the VAL user.
Step 3.
The configuration management server in the primary VAL system of the VAL user retrieves the VAL user profile from the VAL user database in that primary VAL system. The identification of the partner VAL system to which the VAL user is attempting to migrate is used to determine which VAL user profile is retrieved for that VAL user for migration to that partner VAL system.
Step 4.
The configuration management server in the primary VAL system provides the VAL user profile to the configuration management server in the partner VAL system of the VAL user, optionally requesting validation of the modified VAL user profile.
Step 5.
The partner VAL system of the VAL user modifies the VAL user profile according to local configuration information and stores the modified VAL user profile in the VAL user database in the partner VAL system.
Step 6.
If the primary VAL system requested validation of the VAL user profile in step 4, the configuration management server in the partner VAL system of the migrating VAL user may send the modified VAL user profile to the configuration management server of the primary VAL system of the VAL user to allow the primary VAL system of the VAL user to validate the modified VAL user profile.
Step 7.
The primary VAL system of the migrated VAL user validates the modified VAL service profile of the migrated VAL user.
Step 8.
The primary VAL system of the migrated VAL user responds to the partner VAL system with the results of the validation process.
Step 9.
The configuration management server in the partner VAL system provides the VAL user profile to the configuration management client of the migrating VAL user,
11.3.4.3 VAL user receives updated VAL user profile data from the network p. 178
The procedure for VAL user obtaining updated VAL user profile data that is initiated by the network is illustrated in Figure 11.3.4.3-1.
Pre-conditions:
- The VAL user has performed user authentication in identity management server.
- The VAL UE has secure access to the configuration management server.
- The VAL UE has already obtained one or more VAL user profiles.
- The configuration management server has access to the VAL user profile(s) associated with the VAL user ID of the VAL user or VAL UE ID.
Step 1.
The configuration management server obtains updated VAL user profile data.
Step 2.
The configuration management server sends a notification for VAL user profile data update to the configuration management client.
Step 3.
The configuration management client sends get updated VAL user profile data request to the configuration management server, which includes the VAL user ID or VAL UE ID.
Step 4.
The configuration management server sends get updated VAL user profile data response to the configuration management client which includes the updated VAL user profile data requested in step 3.
11.3.4.4 VAL user updates VAL user profile data to the network p. 179
The procedure for VAL user updating the VAL user profile data is illustrated in Figure 11.3.4.4-1.
Pre-conditions:
- The VAL user has performed user authentication in identity management server.
- The VAL UE has secure access to the configuration management server.
- The VAL UE has already obtained one or more VAL user profiles.
Step 1.
The configuration management client is triggered (e.g. by user interaction operation) to update the VAL user profile data on the configuration management server.
Step 2.
The configuration management client sends update VAL user profile data request to the configuration management server, which includes the VAL user profile data to be updated.
Step 3.
The configuration management server stores the received VAL user profile data.
Step 4.
The configuration management server sends update VAL user profile data response to the configuration management client to confirm the VAL user profile data update is complete.
11.3.4.5 Updated user profile subscription procedure p. 180
Figure 11.3.4.5-1 illustrates the high level procedure for obtaining updated user profile data based on subscription request.
Step 1.
Figure 11.3.4.5-2 illustrates the high level procedure of updated user profile notification event.
Configuration management client or VAL server sends an updated user profile subscription request to the configuration management server to subscribe any updates to user profile of one or more VAL users or VAL UEs.
Step 2.
The configuration management server shall check if the configuration management client or VAL server is authorized to initiate the updated user profile subscription request.
Step 3.
The configuration management server replies with a updated user profile subscription response indicating the subscription status.
Step 1.
The configuration management server sends the updated user profile notification including the changes to user profile of one or more VAL users or VAL UEs to the configuration management client or VAL server.
11.3.5 VAL service data |R18| p. 181
11.3.5.1 General p. 181
The VAL service data related procedures are described in the following subclauses.
11.3.5.2 Procedures p. 181
The procedure for consumer (e.g. group management server) obtaining the VAL service data is illustrated in Figure 11.3.5.2-1.
Pre-conditions:
- The consumer has the secure access to the configuration management server.
- The configuration management server has VAL service data maintained for VAL UE or user.
Step 1.
The consumer (e.g. group management server) sends a get VAL service request to the configuration management server for obtaining VAL service data. The request includes a list of VAL UE IDs or VAL user IDs and/or a VAL service ID list as service data retrieval filters.
Step 2.
The configuration server retrieves the VAL service data for the requested VAL UEs or users or VAL services and sends get VAL service response to the consumer (e.g. group management server) with the discovered list of VAL service data.
11.4 SEAL APIs for configuration management p. 182
11.4.1 General p. 182
Table 11.4.1-1 illustrates the SEAL APIs for configuration management.
| API Name | API Operations | Known Consumer(s) | Communication Type |
|---|---|---|---|
|
SS_ | Obtain_User_Profile | VAL server | Request/Response |
|
SS_ | Subscribe_User_Profile_Update | VAL server | Subscribe/Notify |
| Notify_User_Profile_Update | VAL server | ||
|
SS_ | Obtain_VAL_Service_Data | group management server | Request/Response |
11.4.2 SS_UserProfileRetrieval API p. 182
11.4.2.1 General p. 182
API description:
This API enables the VAL server to communicate with the configuration management server for obtaining user profile over CM-S.
11.4.2.2 Obtain_User_Profile operation p. 182
API operation name:
Obtain_User_Profile
Description:
Obtaining user profile.
Known Consumers:
VAL server.
Inputs:
Outputs:
See subclause 11.3.4.2 for the details of usage of this API operation.
11.4.3 SS_UserProfileEvent API p. 182
11.4.3.1 General p. 182
API description:
This API enables the VAL server to communicate with the configuration management server for obtaining updated user profile over CM-S.
11.4.3.2 Subscribe_User_Profile_Update operation p. 182
API operation name:
Subscribe_User_Profile_Update
Description:
Subscribing to changes to user profile.
Known Consumers:
VAL server.
Inputs:
Outputs:
See subclause 11.3.4.5 for the details of usage of this API operation.
11.4.3.3 Notify_User_Profile_Update operation p. 183
API operation name:
Notify_User_Profile_Update
Description:
Notification for changes to user profile.
Known Consumers:
VAL server.
Inputs:
Outputs:
See subclause 11.3.4.5 for the details of usage of this API operation.
11.4.4 SS_VALServiceData API |R18| p. 183
11.4.4.1 General p. 183
API description:
This API enables the group management server to communicate with the configuration management server for obtaining VAL service data over SEAL-X.
11.4.4.2 Obtain_VAL_Service_Data operation p. 183
API operation name:
Obtain_VAL_Service_Data
Description:
Obtaining VAL service data.
Known Consumers:
group management server.
Inputs:
Outputs:
See subclause 11.3.5.2 for the details of usage of this API operation.
