MBS Distribution sessions collection

/dist-sessions

POST

Create

Individual MBS Distribution session

/dist-sessions/{distSessionRef}

PATCH

Update

GET

Retrieve

DELETE

Destroy

Subscriptions collection for MBS Distribution sessions

/dist-sessions/{distSessionRef}/subscriptions

POST

StatusSubscribe

(to create a subscription)

Individual subscription for an MBS Distribution session

/dist-sessions/{distSessionRef}/subscriptions/{subscriptionId}

DELETE

StatusUnsubscribe

PATCH

StatusSubscribe

(to update or renew a subscription)

apiRoot

string

See clause 6.1.1

apiVersion

string

See clause 6.1.1

n/a

CreateReqData

M

1

Representation of the MBS distribution session to be created in the MBSTF

CreateRspData

M

1

201 Created

Successful creation of an MBS session

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmbstf-distSession/<apiVersion>/dist-sessions/{distSessionRef}

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

apiRoot

String

See clause 6.1.1

apiVersion

String

See clause 6.1.1

distSessionRef

String

MBS distribution session reference assigned by the MBSTF during the Create service operation

n/a

array(PatchItem)

M

1

List of changes to be made to the MBS session resource, according to the JSON PATCH format specified in IETF RFC 6902 [16].

n/a

204 No Content

Successful response

DistSession

M

1

200 OK

Upon success, a response body containing the updated representation of Distribution Session shall be returned

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the PATCH method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

String

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

String

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

n/a

n/a

n/a

204 No Content

Successful response

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the DELETE method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MB-STF (service) instance ID towards which the request is redirected

n/a

n/a

DistSession

M

1

200 OK

Successful response containing representation of the MBS Distribution Session

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the GET method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

apiRoot

string

See clause 6.1.1

apiVersion

string

See clause 6.1.1

distSessionRef

string

MBS distribution session reference assigned by the MBSTF during the Create service operation

n/a

StatusSubscribeReqData

M

1

Data within the StatusSubscribe Request

StatusSubscribeRspData

M

1

201 Created

Data within the StatusSubscribe Response

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

Contains the URI of the newly created resource, according to the structure: {apiRoot}/nmbstf-distSession/<apiVersion>/dist-sessions/{distSessionRef}/subscriptions/{subscriptionId}

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

apiRoot

string

See clause 6.1.1

apiVersion

string

See clause 6.1.1

distSessionRef

string

MBS distribution session reference assigned by the MBSTF during the Create service operation

subscriptionId

string

Subscription identifier assigned by the MBSTF during the creation of the subscription

n/a

n/a

n/a

204 No Content

Successful deletion

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

n/a

array(PatchItem)

M

1

It shall contain the list of changes to be made to the Status Subscription (i.e. DistSessionSubscription data type), according to the JSON PATCH format specified in IETF RFC 6902 [16].

DistSessionSubscription

M

1

200 OK

Upon success, a response body shall be returned containing the updated Status Subscription.

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The response shall include a Location header field containing a different URI, or the same URI if a request is redirected to the same target resource via a different SCP. In the former case, the URI shall be an alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

(NOTE 2)

NOTE 1: The mandatory HTTP error status code for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

NOTE 2: RedirectResponse may be inserted by an SCP, see clause 6.10.9.1 of 3GPP TS 29.500 [4].

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Location

string

M

1

An alternative URI of the resource located on an alternative service instance within the same MBSTF or MBSTF (service) set.

Or the same URI, if a request is redirected to the same target resource via a different SCP.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target MBSTF (service) instance ID towards which the request is redirected

Event Notification

NotifUri

POST

StatusNotify

notifUri

String formatted as URI with the Callback Uri

StatusNotifyReqData

M

1

Data within the StatusNotify Request

n/a

204 No Content

Successful response

RedirectResponse

O

0..1

307 Temporary Redirect

Temporary redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

RedirectResponse

O

0..1

308 Permanent Redirect

Permanent redirection. The NF service consumer shall generate a Location header field containing a URI pointing to the endpoint of another NF service consumer to which the notification should be sent.

If an SCP redirects the message to another SCP then the location header field shall contain the same URI or a different URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

NOTE: The mandatory HTTP error status codes for the POST method listed in Table 5.2.7.1-1 of 3GPP TS 29.500 [4] also apply.

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

Location

string

M

1

A URI pointing to the endpoint of the NF service consumer to which the notification should be sent.

3gpp-Sbi-Target-Nf-Id

string

O

0..1

Identifier of the target NF (service) instance ID towards which the request is redirected

CreateReqData

6.1.6.2.2

Data within the Create Request

CreateRspData

6.1.6.2.3

Data within the Create Response

DistSession

6.1.6.2.4

Data specific to distribution session

ObjDistributionData

6.1.6.2.5

Data specific to Object Distribution Method

PktDistributionData

6.1.6.2.6

Data specific to Packet Distribution Method

StatusSubscribeReqData

6.1.6.2.7

Data within Subscription creation request

StatusSubscribeRspData

6.1.6.2.8

Data within Subscription creation response

StatusNotifyReqData

6.1.6.2.9

Data within Notification request

DistSessionSubscription

6.1.6.2.10

Data specific to subscription request

DistSessionEventReportList

6.1.6.2.11

MBS distribution session event report list

DistSessionEventReport

6.1.6.2.12

MBS distribution session event report

UpTrafficFlowInfo

6.1.6.2.13

IP Multicast Address and Port Number

MbStfIngestAddr

6.1.6.2.14

MBSTF Ingest Addresses

ExtSsm

6.1.6.2.15

SSM and Port Number

DistSessionState

6.1.6.3.3

MBS distribution session state

ObjDistributionOperatingMode

6.1.6.3.4

Operating Mode for Object distribution method

ObjAcquisitionMethod

6.1.6.3.5

Object acquisition method

PktDistributionOperatingMode

6.1.6.3.6

Operating Mode for Packet distribution method

DistSessionEventType

6.1.6.3.7

MBS distribution session event type

PktIngestMethod

6.1.6.3.8

Packet Ingest Method

TunnelAddress

3GPP TS 29.571 [16]

Tunnel Address (UDP/IP)

BitRate

3GPP TS 29.571 [16]

Bit Rate

PacketDelBudget

3GPP TS 29.571 [16]

Maximum Delay

Uri

3GPP TS 29.571 [16]

Uniform resource identifier

DateTime

3GPP TS 29.571 [16]

Data and Time

NfInstanceId

3GPP TS 29.571 [16]

NF Instance Identifier

Uinteger

3GPP TS 29.571 [16]

Unsigned Integer

IpAddr

3GPP TS 29.571 [16]

IP Address

Ssm

3GPP TS 29.571 [16]

Source Specific Multicast Address

MbsSecurityContext

3GPP TS 29.571 [16]

MBS Security Context

FECConfig

3GPP TS 29.580 [18]

FEC Configuration

distSession

DistSession

M

1

MBS Distribution Session to be created.

distSession

DistSession

M

1

Representation of the created MBS session

distSessionId

string

M

1

An identifier for this MBS Distribution Session assigned by the MBSF that is unique within the scope of the MBS User Service (see clause 4.5.3 of 3GPP TS 26.502)

distSessionState

DistSessionState

M

1

The current state of the MBS Distribution Session (see clause 4.6.1 of 3GPP TS 26.502)

mbUpfTunAddr

TunnelAddress

M

1

The tunnel endpoint address of the MB‑UPF that supports this MBS Distribution Session at reference point Nmb9 or the tunnel endpoint address of the MBMS-GW at reference point SGi-mb.

Write-Only: true

mbmsGwTunAddr

TunnelAddress

O

0..1

This IE may be present to contain the tunnel endpoint address of the MBMS-GW at reference point SGi-mb when the mbUpfTunAddr is also present which contains the tunnel endpoint address of the MB‑UPF that supports this MBS Distribution Session at reference point Nmb9.

Write-Only: true

upTrafficFlowInfo

UpTrafficFlowInfo

C

0..1

Details of the traffic flow to be used by the MBSTF for this MBS Distribution Session, including the multicast group destination address and port number.

Shall be present in case of Object Distribution Method and Packet Distribution Method in Packet Proxy Mode.

Write-Only: true

mbr

BitRate

M

1

The maximum bit rate for this MBS Distribution Session

Write-Only: true

maxDelay

PacketDelBudget

O

0..1

The maximum end-to-end distribution delay that is tolerated for this MBS Distribution Session by the MBS Application Provider

Write-Only: true

objDistributionData

ObjDistributionData

C

0..1

Additional MBS Distribution Session parameters for Object Distribution Method (NOTE 1)

pktDistributionData

PktDistributionData

C

0..1

Additional MBS Distribution Session parameters for Packet Distribution Method (NOTE 1)

fecInformation

FECConfig

O

0..1

Configuration for FEC information added by the MBSTF to protect this MBS Distribution Session.

dscpMarking

string

O

0..1

DSCP Marking to be applied to outgoing traffic.

It shall be encoded as two octet string in hexadecimal representation. The first octet shall contain the DSCP value in the IPv4 Type-of-Service or the IPv6 Traffic-Class field and the second octet shall contain the ToS/Traffic Class mask field, which shall be set to "0xFC".

Write-Only: true

mbsSecurityContext

MbsSecurityContext

O

0..1

This IE may be present if security protection is applied to the MBS Session.

When present, it shall contain:

– the security context containing MBS Service Key (MSK), MSK lifetime and the corresponding key IDs in request from MBSF.

– the security context containing MBS Service Key (MSK), MBS Traffic Key (MTK) and the corresponding key IDs in response or notification from MBSTF.

NOTE 1: Either the objDistributionData IE or the pktDistributionData IE shall be present in a request/response.

objDistributionOperatingMode

ObjDistributionOperatingMode

M

1

Operating Mode for the Object distribution method

objAcquisitionMethod

ObjAcquisitionMethod

M

1

Indicates whether the objects(s) are to be pushed into the MBSTF by the MBS Application Provider or whether they are to be pulled from the MBS Application Provider by the MBSTF

objAcquisitionIdsPull

array(Uri)

C

0..1

In case or PULL method, it identifies the object(s) to be ingested and distributed by the MBSTF during this MBS Distribution Session.

objAcquisitionIdPush

Uri

C

0..1

In case or PUSH method, it identifies the URL endpoint on the MBSTF used to ingest objects by the application provider. This may be present only in the response to the Create or Retrieve request

Read-Only: true

objIngestBaseUrl

Uri

C

0..1

A URL prefix substituted by the MBSTF with the Object distribution base URL prior to distribution of ingested objects.

Shall be present if Object Distribution base URL is present.

Shall be present only in case of PUSH Method.

objDistributionBaseUrl

Uri

O

0..1

A URL prefix substituted by the MBSTF in place of the Object ingest base URL prior to distribution of ingested objects.

Shall be present only in case of PUSH Method.

objRepairBaseUrl

Uri

O

0..1

A URL prefix substituted by the MBSTF in place of the Object Distribution base URL when repairing objects not received completely intact from this MBS Distribution Session.

Present only when object repair is provisioned for this MBS Distribution Session.

Shall be present only in case of PUSH Method.

pktDistributionOperatingMode

PktDistributionOperatingMode

M

1

Operating Mode for the Packet distribution method

pktIngestMethod

PktIngestMethod

C

1

Indicates whether packets are ingested using multicast or unicast ingest. It shall be present if operating mode of the packet distribution method is set to "PACKET_PROXY".

mbStfIngestAddr

MbStfIngestAddr

M

1

The endpoint addresses used by the MBS Application Provider and MBSTF to establish a connection at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session.

subscription

DistSessionSubscription

M

1

Subscription to be created

subscription

DistSessionSubscription

M

1

Subscription created

reportList

DistSessionEventReportList

C

0..1

Immediate event reports, if requested in the request and if corresponding information is available.

reportList

DistSessionEventReportList

M

1

Reported MBS session events

eventList

array(DistSessionEventType)

M

1..N

List of MBS distribution session events subscribed

notifyUri

Uri

M

1

URI where the NF service consumer requests to receive notifications.

Write-Only: true

notifyCorrelationId

string

O

0..1

Notification Correlation ID

Write-Only: true

expiryTime

DateTime

O

0..1

When present in the subscription creation request, it shall indicate the time up to which the subscription is desired to be kept active and after which the subscribed events shall stop generating notifications.

When present in a subscription response, it shall indicate the expiry time after which the subscription becomes invalid.

nfcInstanceId

NfInstanceId

C

0..1

NF Instance ID of the NF Service Consumer

This IE shall be present if available.

Write-Only: true

distSessionSubscUri

Uri

C

0..1

This IE shall be present in the response to an MBS distribution session creation request that includes a subscription to events about the MBS session and the subscription was created successfully. When present, it shall contain the URI of the individual subscription resource.

Read-Only: true

(NOTE)

NOTE: When an MBS distribution session status subscription is created separately (i.e. after) an MBS distribution session creation, the Location header returned in the MBS distribution session status subscription creation response contains the URI of the created subscription.

eventReportList

array(DistSessionEventReport)

M

1..N

List of MBS distribution session events to report

notifyCorrelationId

string

C

0..1

Notification Correlation ID.

This IE shall be present if a Notification Correlation ID is available in the subscription.

eventType

DistSessionEventType

M

1

MBS distribution session event type

timeStamp

DateTime

C

0..1

This IE shall contain the time at which the event is generated. This IE should be present, if available.

mbsSecurityContext

MbsSecurityContext

C

0..1

This IE shall be present if the eventType IE indicates "MTK_UPDATE" or "MSK_REQUEST".

destIpAddr

IpAddr

M

1

Multicast group destination Address

portNumber

Uinteger

M

1

Port Number

afEgressTunAddr

TunnelAddress

C

0..1

AF side endpoint address and port for establishment of unicast tunnel at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session.

The MBSTF shall use this information to validate the source IP address and port of incoming packets pertaining to the MBS User Data Ingest Session from the MBS Application Provider.

This IE shall be included if the packet distribution method is used and when the operating mode is set to "PACKET_FORWARD_ONLY", or when the operating mode is set to "PACKET_PROXY" while the packet ingest method is set to unicast.

This shall be present only in the Create request.

Write-Only: true

mbStfIngressTunAddr

TunnelAddress

C

0..1

MBSTF side endpoint address and port for establishment of unicast tunnel at reference point Nmb8 prior to the commencement of MBS User Data Ingest Session.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_FORWARD_ONLY".

This shall be present only in the response to the Create (or Retrieve) request.

Read-Only: true

afSsm

ExtSsm

C

0..1

AF side Source specific multicast address and port to which MBSTF issues an IGMP Join to ingest multicast UDP/IP datagrams.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_PROXY" and packet ingest method is set to "MULTICAST".

This shall be present only in the Create request.

Write-Only: true

mbStfListenAddr

TunnelAddress

C

0..1

MBSTF side endpoint address and port for to receive unicast-addressed UDP/IP datagrams.

It is applicable only if operating mode of the packet distribution method is set to "PACKET_PROXY" and packet ingest method is set to "UNICAST".

This shall be present only in the response to the Create (or Retrieve) request.

Read-Only: true

ssm

Ssm

M

1

Source Specific Multicast Address consisting of multicast source IP address and the destination multicast address

portNumber

Uinteger

M

1

Source Port

"INACTIVE"

Distribution Session in Inactive

"ESTABLISHED"

Distribution Session in Established

"ACTIVE"

Distribution Session in Active

"DEACTIVATING"

Distribution Session in Released

"SINGLE"

Each object ingested by the MBSTF is distributed once

"COLLECTION"

A set of objects described by a manifest is ingested by the MBSTF and distributed once

Not used with Push-based ingest

"CAROUSEL"

A set of one or more objects described by a manifest is ingested by the MBSTF and distributed according to a repetition pattern specified in the manifest

Not used with Push-based ingest

"STREAMING"

A sequence of objects is ingested by the MBSTF and streamed in real time

"PULL"

MBSTF Pulls objects from AF/AS

"PUSH"

AF/AS Pushes objects into MBSTF

"PACKET_PROXY"

The payloads of UDP packets ingested by the MBSTF are forwarded to the MB-UPF in new UDP packets (Layer 4 proxying)

"PACKET_FORWARD_ONLY"

The payloads of IP packets ingested by the MBSTF are forwarded to the MB-UPF in new IP packets (Layer 3 proxying)

"DATA_INGEST_FAILURE"

MBSTF failed to ingest data from AF/AS

"SESSION_DEACTIVATED"

Session released in MBSTF

"SESSION_ACTIVATED"

Delivery started towards MB-UPF

"MULTICAST"

Multicast Ingest Mode

"UNICAST"

Unicast Ingest Mode