7 Network Function services
26.5023GPP5G Multicast-Broadcast User Service ArchitectureRelease 17TS
7.1 General
The Network Function Services exposed by the MBSF and the MBSTF are defined in this clause.
7.2 MBSF Services
7.2.1 General
The following table illustrates the set of Network Function services exposed by the MBSF.
Table 7.2-1: NF services provided by MBSF
|
Service name |
Service operation name |
Operation semantics |
Example consumer(s) (see NOTE) |
|
Nmbsf_MBSUserService |
Create |
Request/Response |
AF, NEF |
|
Retrieve |
Request/Response |
AF, NEF |
|
|
Update |
Request/Response |
AF, NEF |
|
|
Destroy |
Request/Response |
AF, NEF |
|
|
Nmbsf_MBSUserDataIngestSession |
Create |
Request/Response |
AF, NEF |
|
Retrieve |
Request/Response |
AF, NEF |
|
|
Update |
Request/Response |
AF, NEF |
|
|
Destroy |
Request/Response |
AF, NEF |
|
|
StatusSubscribe |
Subscribe/Notify |
AF, NEF |
|
|
StatusUnsubscribe |
AF, NEF |
||
|
StatusNotify |
AF, NEF |
||
|
StatusSubscribeMod |
AF, NEF |
||
|
NOTE: When the MBS Application Provider (AF/AS) lies outside the trusted DN, these services shall be exposed via the NEF (N33+Nmb5) as Nnef_MBSUserService and Nnef_MBSUserDataIngestSession respectively, as specified in clauses 4.4.29.5 and 4.4.29.6 respectively of TS 29.522 [15]. |
|||
7.2.2 Nmbsf MBS User Service operations
7.2.2.1 Nmbsf_MBSUserService_Create service operation
Service operation name: Nmbsf_MBSUserService_Create
Description: Provision a new MBS User Service. The general data model is illustrated in figure 4.5.2-1.
Input parameters (Required): Parameters in table 4.5.3-1 assigned by the MBS Application Provider.
Output parameters: Result indication. MBS User Service identifier assigned by the MBSF.
7.2.2.2 Nmbsf_MBSUserService_Retrieve service operation
Service operation name: Nmbsf_MBSUserService_Retrieve
Description: Used by the NF/NEF to retrieve the properties of an existing MBS User Service.
Input parameters (Required): MBS User Service Identifier in request URL.
Output parameters: Result indication. MBS User Service resource entity, including parameters in table 4.5.3-1.
7.2.2.3 Nmbsf_MBSUserService_Update service operation
Service operation name: Nmbsf_MBSUserService_Update
Description: Update the properties of an existing MBS User Service.
Input parameters (Required, Optional): MBS User Service Identifier. Parameters in table 4.5.3-1 assigned by the MBS Application Provider.
Output parameters(Required: Result indication.
Output parameters (Optional): MBS User Service resource entity, including parameters in table 4.5.3-1.
7.2.2.4 Nmbsf_MBSUserService_Destroy service operation
Service operation name: Nmbsf_MBSUserService_Destroy
Description: Release the resources of the associated MBS User Service.
Input parameters (Required): MBS User Service Identifier.
Output parameters: Result indication.
7.2.3 Nmbsf MBS User Data Ingest Session operation
7.2.3.1 Nmbsf_MBSUserDataIngestSession_Create service operation
Service operation name: Nmbsf_MBSUserDataIngestSession_Create
Description: Create an MBS User Data Ingest Session, including a set of subordinate MBS Distribution Session(s).
Input parameters (Required, Optional): Parameters in table 4.5.5‑1 and table 4.5.6‑1, and either table 4.5.6‑2 or table 4.5.6‑3 assigned by the MBS Application Provider, depending on the distribution method.
Output parameters: Result indication. MBS User Data Ingest Session Identifier assigned by the MBSF.
7.2.3.2 Nmbsf_MBSUserDataIngestSession_Retrieve service operation
Service operation name: Nmbsf_MBSUserDataIngestSession_Retrieve
Description: Used by the AF/NEF to retrieve the properties of an existing MBS User Data Ingest Session.
Input parameters (Required): User Data Ingest Session Identifier in request URL.
Output parameters: Result indication. MBS User Data Ingest Session resource entity, including parameters in table 4.5.5‑1 and table 4.5.6‑1, and either table 4.5.6‑2 or table 4.5.6‑3, depending on the distribution method.
7.2.3.3 Nmbsf_MBSUserDataIngestSession_Update service operation
Service operation name: Nmbsf_MBSUserDataIngestSession_Update
Description: Update the properties of an existing MBS User Data Ingest Session and its set of subordinate MBS Distribtion Session(s).
Input parameters (Required, Optional): MBS User Data Ingest Session Identifier. Parameters in table 4.5.5‑1 and table 4.5.6‑1, and either table 4.5.6‑2 or table 4.5.6‑3, depending on the distribution method.
Output parameters (Required): Result indication.
Output parameters (Optional): MBS User Data Ingest Session resource entity, including subordinate MBS Distribution Session data entities(s).
7.2.3.4 Nmbsf_MBSUserDataIngestSession_Destroy service operation
Service operation name: Nmbsf_MBSUserDataIngestSession_Destroy
Description: Destroy an MBS User Data Ingest Session along with its subordinate MBS Distribution Session(s).
Input parameters (Required): MBS User Data Ingest Session Identifier.
Output parameters: Result indication.
7.2.3.5 Nmbsf_MBSUserDataIngestSession_StatusSubscribe operation
Service operation name: Nmbsf_MBSUserDataIngestSession_StatusSubscribe
Description: Invoked by AF/NEF on the MBSF when it needs to create a subscription to monitor at least one event relevant to the MBS User Data Ingest Session. The AF may subscribe to multiple events in a subscription.
Input parameters (Required): MBS User Data Ingest Session Identifier, Event ID(s) as described in table 4.6.2-1, notification target address.
Output parameters (Required, Optional): When the subscription is accepted: Subscription correlation ID.
7.2.3.6 Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe operation
Service operation name: Nmbsf_MBSUserDataIngestSession_StatusUnsubscribe
Description: Remove an existing subscription.
Input parameters (Required): Subscription correlation ID.
Output parameters: Result Indication.
7.2.3.7 Nmbsf_MBSUserDataIngestSession_StatusNotify operation
Service operation name: Nmbsf_MBSUserDataIngestSession_StatusNotify
Description: Used by the MBSF to notify the MBS Application Provider (AF/AS) or NEF about the status change of the MBS User Data Ingest Session.
Input parameters (Required): MBS User Data Ingest Session Identifier, Event ID(s) as described in table 4.6.2-1, informative message.
Output parameters: Result indication.
7.2.3.8 Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod operation
Service operation name: Nmbsf_MBSUserDataIngestSession_StatusSubscribeMod
Description: Invoked by an MBS Application Provider (AF/AS) or NEF on the MBSF to modify an existing status subscription.
Input parameters (Required): Subscription correlation ID.
Input parameters (Optional): Event ID(s) as described in table 4.6.2-1, notification target address, subscription expiration time.
Output parameters (Required, Optional): Result indication.
7.3 MBSTF Services
7.3.1 General
The following table illustrates the set of NF services exposed by the MBSTF.
Table 7.3-1: NF services provided by MBSTF
|
Service name |
Service operation name |
Operation semantics |
Example consumer(s) |
|
Nmbstf_MBSDistributionSession |
Create |
Request/Response |
MBSF |
|
Retrieve |
Request/Response |
MBSF |
|
|
Update |
Request/Response |
MBSF |
|
|
Destroy |
Request/Response |
MBSF |
|
|
StatusSubscribe |
Subscribe/Notify |
MBSF |
|
|
StatusUnsubscribe |
MBSF |
||
|
StatusNotify |
MBSF |
||
|
StatusSubscribeMod |
MBSF |
7.3.2 Nmbstf_MBSDistributionSession service
7.3.2.1 Nmbstf_MBSDistributionSession_Create service operation
Service operation name: Nmbstf_MBSDistributionSession_Create
Description: Create a new MBS Distribution Session within the MBSTF.
Input parameters (Required, Optional): Parameters in table 4.5.6‑1 and either table 4.5.6‑2 or table 4.5.6‑3, depending on the distribution method.
Output parameters: Result indication.
7.3.2.2 Nmbstf_MBSDistributionSession_Retrieve service operation
Service operation name: Nmbstf_MBSDistributionSession_Retrieve
Description: Retrieve the parameters of an existing MBS Distribution Session.
Input parameters (Required): Distribution Session Identifier in request URL.
Output parameters: MBS Distribution Session resource entity, including parameters in table 4.5.6‑1 and either table 4.5.6‑2 or table 4.5.6‑3, depending on the distribution method.
7.3.2.3 Nmbstf_MBSDistributionSession_Update service operation
Service operation name: Nmbstf_MBSDistributionSession_Update
Description: Update an existing MBS Distribution Session, for example to change the session stop time, object delivery session, application session, packets delivery session, files, and ancillary information.
Input parameters (Required, Optional): MBS Distribution Session Identifier. Parameters in table 4.5.6‑1 and either table 4.5.6‑2 or table 4.5.6‑3, depending on the distribution method.
Output parameters (Required): Result indication.
Output parameters (Optional): MBS Distribution Session resource entity.
7.3.2.4 Nmbstf_MBSDistribtutionSession_Destroy service operation
Service operation name: Nmbstf_MBSDistributionSession_Update
Description: Destroy an existing MBS Distribution Session.
Input parameters (Required): MBS Distribution Session Identifier.
Output parameters: Result indication.
7.3.2.5 Nmbstf_MBSDistributionSession_StatusSubscribe operation
Service operation name: Nmbstf_MBSDistributionSession_StatusSubscribe
Description: Invoked by MBSF on the MBSTF when it needs to monitor at least one event relevant to the MBS Distribution session. The MBSF may subscribe to multiple events in a subscription.
Input parameters (Required): MBS Distribution Session Identifier, Event ID(s) as described in table 4.6.2-1, notification target address.
Output parameters: When the subscription is accepted: Subscription correlation ID.
7.3.2.6 Nmbstf_MBSDistributionSession_StatusUnsubscribe operation
Service operation name: Nmbstf_MBSDistributionSession_StatusUnsubscribe
Description: Remove an existing subscription.
Input parameters (Required): Subscription correlation ID.
Output parameters: Result indication.
7.3.2.7 Nmbstf_MBSDistributionSession_StatusNotify operation
Service operation name: Nmbstf_MBSDistributionSession_StatusNotify
Description: Used by the MBSTF to notify the MBSF about the status change of the MBS Distribution Session.
Input parameters (Required): MBS Distribution Session Identifier, Event ID(s) as described in table 4.6.2-1, informative message.
Output parameters: Result indication.
7.3.2.8 Nmbstf_MBSDistributionSession_StatusSubscribeMod operation
Service operation name: Nmbstf_MBSDistributionSession_StatusSubscribeMod
Description: Invoked by the MBSF on the MBSTF to modify an existing status subscription.
Input parameters (Required): Subscription correlation ID.
Input parameters (Optional): Event ID(s) as described in table 4.6.2-1, notification target address, subscription expiration time.
Output parameters (Required, Optional): Result indication.
Annex A (informative):
Deployment and Collaboration Models