Tech-
invite
3GPP
space
IETF
space
21
22
23
24
25
26
27
28
29
31
32
33
34
35
36
37
38
4‑5x
Content for
TS 29.565
Word version: 18.6.0
1…
4…
4
Overview
5
Services offered by the TSCTSF
5.1
Introduction
5.2
Ntsctsf_TimeSynchronization Service
5.3
Ntsctsf_QoSandTSCAssistance Service
5.4
Ntsctsf_ASTI Service
6
API Definitions
6.1
Ntsctsf_TimeSynchronization Service API
6.2
Ntsctsf_QoSandTSCAssistance Service API
6.3
Ntsctsf_ASTI Service API
A
OpenAPI specification
A.1
General
A.2
Ntsctsf_TimeSynchronization API
A.3
Ntsctsf_QoSandTSCAssistance API
A.4
Ntsctsf_ASTI API
B
3GPP extensions for DetNet integration with 5GS
B.1
3GPP extensions for DetNet integration with 5GS
B.2
YANG Module Definitions
C
YANG module specification
C.1
General
C.2
YANG module _3gpp-5gs-detnet-node
$
Change history
4
Overview
p. 13
4.1
Introduction
p. 13
4.2
Service Architecture
p. 13
5
Services offered by the TSCTSF
p. 14
5.1
Introduction
p. 14
5.2
Ntsctsf_TimeSynchronization Service
p. 15
5.2.1
Service Description
p. 15
5.2.1.1
Overview
p. 15
5.2.1.2
Network Functions
p. 16
5.2.1.2.1
TSCTSF
p. 16
5.2.1.2.2
NF Service Consumers
p. 16
5.2.2
Service Operations
p. 16
5.2.2.1
Introduction
p. 16
5.2.2.2
Ntsctsf_TimeSynchronization_CapsSubscribe
p. 17
5.2.2.2.1
General
p. 17
5.2.2.2.2
Creating a new subscription
p. 17
5.2.2.2.3
Modifying an existing subscription
p. 20
5.2.2.3
Ntsctsf_TimeSynchronization_CapsUnsubscribe
p. 21
5.2.2.3.1
General
p. 21
5.2.2.3.2
Unsubscription from capability notifications
p. 21
5.2.2.4
Ntsctsf_TimeSynchronization_CapsNotify
p. 22
5.2.2.4.1
General
p. 22
5.2.2.4.2
Notification about the capability of time synchronization service
p. 22
5.2.2.5
Ntsctsf_TimeSynchronization_ConfigCreate
p. 23
5.2.2.5.1
General
p. 23
5.2.2.5.2
Creating a new configuration
p. 23
5.2.2.6
Ntsctsf_TimeSynchronization_ConfigUpdate
p. 26
5.2.2.6.1
General
p. 26
5.2.2.6.2
Updating an existing configuration
p. 26
5.2.2.7
Ntsctsf_TimeSynchronization_ConfigDelete
p. 30
5.2.2.7.1
General
p. 30
5.2.2.7.2
Deleting an existing configuration
p. 30
5.2.2.8
Ntsctsf_TimeSynchronization_ConfigUpdateNotify
p. 30
5.2.2.8.1
General
p. 30
5.2.2.8.2
Notifying the current state of an existing configuration
p. 31
5.3
Ntsctsf_QoSandTSCAssistance Service
p. 32
5.3.1
Service Description
p. 32
5.3.1.1
Overview
p. 32
5.3.1.2
Network Functions
p. 32
5.3.1.2.1
TSCTSF
p. 32
5.3.1.2.2
NF Service Consumers.
p. 32
5.3.2
Service Operations
p. 32
5.3.2.1
Introduction
p. 32
5.3.2.2
Ntsctsf_QoSandTSCAssistance_Create
p. 33
5.3.2.2.1
General
p. 33
5.3.2.2.2
Initial provisioning of TSC related service information
p. 33
5.3.2.2.3
Subscriptions to Service Data Flow QoS notification control
p. 37
5.3.2.2.4
Subscription to Service Data Flow Deactivation
p. 37
5.3.2.2.5
Subscription to resources allocation outcome
p. 37
5.3.2.2.6
Subscriptions to Service Data Flow QoS Monitoring Information
p. 37
5.3.2.2.7
Initial provisioning of sponsored connectivity information
p. 38
5.3.2.3
Ntsctsf_QoSandTSCAssistance_Update
p. 40
5.3.2.3.1
General
p. 40
5.3.2.3.2
Modification of TSC related service information
p. 40
5.3.2.3.3
Modification of Subscription to Service Data Flow QoS notification control
p. 43
5.3.2.3.4
Modification of Subscription to Service Data Flow Deactivation
p. 43
5.3.2.3.5
Modification of subscription to resources allocation outcome
p. 43
5.3.2.3.6
Modification of Subscription to Service Data Flow QoS Monitoring Information
p. 44
5.3.2.3.7
Modification of sponsored connectivity information
p. 44
5.3.2.3.9
Modification of Subscription to BAT offset notification
|R18|
p. 45
5.3.2.4
Ntsctsf_QoSandTSCAssistance_Delete
p. 45
5.3.2.4.1
General
p. 45
5.3.2.4.2
TSC AF application session context termination
p. 45
5.3.2.4.3
Reporting usage for sponsored data connectivity
p. 46
5.3.2.5
Ntsctsf_QoSandTSCAssistance_Notify
p. 47
5.3.2.5.1
General
p. 47
5.3.2.5.2
Notification about TSC application session context event
p. 47
5.2.2.5.3
Notification about TSC application session context termination
p. 48
5.3.2.5.4
Notification about Service Data Flow QoS notification control
p. 49
5.3.2.5.5
Notification about Service Data Flow Deactivation
p. 50
5.3.2.5.6
Notification about resources allocation outcome
p. 50
5.3.2.5.7
Notification about Service Data Flow QoS Monitoring control
p. 50
5.3.2.5.8
Reporting usage for sponsored data connectivity
p. 51
5.3.2.5.10
Notification about BAT offset
|R18|
p. 51
5.3.2.6
Ntsctsf_QoSandTSCAssistance_Subscribe
p. 52
5.3.2.6.1
General
p. 52
5.3.2.6.2
Handling of subscription to events for the existing TSC application session context
p. 52
5.3.2.6.3
Subscription to Service Data Flow QoS Monitoring Information
p. 54
5.3.2.6.4
Subscription to Usage Monitoring of Sponsored Data Connectivity
p. 54
5.3.2.7
Ntsctsf_QoSandTSCAssistance_Unsubscribe
p. 55
5.3.2.7.1
General
p. 55
5.3.2.7.2
Unsubscription to events
p. 55
5.4
Ntsctsf_ASTI Service
p. 56
5.4.1
Service Description
p. 56
5.4.1.1
Overview
p. 56
5.4.1.2
Network Functions
p. 56
5.4.1.2.1
TSCTSF
p. 56
5.4.1.2.2
NF Service Consumers
p. 57
5.4.2
Service Operations
p. 57
5.4.2.1
Introduction
p. 57
5.4.2.2
Ntsctsf_ASTI_Create
p. 57
5.4.2.2.1
General
p. 57
5.4.2.2.2
Creating a new configuration
p. 57
5.4.2.3
Ntsctsf_ASTI_Update
p. 60
5.4.2.3.1
General
p. 60
5.4.2.3.2
Updating an existing configuration
p. 60
5.4.2.4
Ntsctsf_ASTI_Delete
p. 62
5.4.2.4.1
General
p. 62
5.4.2.4.2
Delete an existing configuration
p. 62
5.4.2.5
Ntsctsf_ASTI_Get
p. 63
5.4.2.5.1
General
p. 63
5.4.2.5.2
Retrieve the status of access stratum time distribution
p. 63
5.4.2.6
Ntsctsf_ASTI_UpdateNotify
|R18|
p. 64
5.4.2.6.1
General
p. 64
5.4.2.6.2
Notification about the 5G access stratum time distribution events
p. 65
5.4.2.6.3
Notification about ASTI configuration changes due to UE presence in time synchronization coverage area
p. 65
5.4.2.6.4
Notification about the 5G access stratum time distribution status information
p. 66
6
API Definitions
p. 66
6.1
Ntsctsf_TimeSynchronization Service API
p. 66
6.1.1
Introduction
p. 66
6.1.2
Usage of HTTP
p. 67
6.1.2.1
General
p. 67
6.1.2.2
HTTP standard headers
p. 67
6.1.2.2.1
General
p. 67
6.1.2.2.2
Content type
p. 67
6.1.2.3
HTTP custom headers
p. 67
6.1.3
Resources
p. 67
6.1.3.1
Overview
p. 67
6.1.3.2
Resource: Time Synchronization Exposure Subscriptions
p. 69
6.1.3.2.1
Description
p. 69
6.1.3.2.2
Resource Definition
p. 69
6.1.3.2.3
Resource Standard Methods
p. 69
6.1.3.2.3.1
POST
p. 69
6.1.3.2.4
Resource Custom Operations
p. 70
6.1.3.3
Resource: Individual Time Synchronization Exposure Subscription
p. 70
6.1.3.3.1
Description
p. 70
6.1.3.3.2
Resource Definition
p. 70
6.1.3.3.3
Resource Standard Methods
p. 70
6.1.3.3.3.1
GET
p. 70
6.1.3.3.3.2
DELETE
p. 72
6.1.3.3.3.3
PUT
p. 73
6.1.3.3.4
Resource Custom Operations
p. 74
6.1.3.4
Resource: Time Synchronization Exposure Configurations
p. 74
6.1.3.4.1
Description
p. 74
6.1.3.4.2
Resource Definition
p. 74
6.1.3.4.3
Resource Standard Methods
p. 74
6.1.3.4.3.1
POST
p. 74
6.1.3.4.4
Resource Custom Operations
p. 76
6.1.3.5
Resource: Individual Time Synchronization Exposure Configuration
p. 76
6.1.3.5.1
Description
p. 76
6.1.3.5.2
Resource Definition
p. 76
6.1.3.5.3
Resource Standard Methods
p. 76
6.1.3.5.3.1
GET
p. 76
6.1.3.5.3.2
PUT
p. 77
6.1.3.5.3.3
DELETE
p. 78
6.1.3.5.4
Resource Custom Operations
p. 80
6.1.4
Custom Operations without associated resources
p. 80
6.1.5
Notifications
p. 80
6.1.5.1
General
p. 80
6.1.5.2
Time Synchronization Capability Notification
p. 80
6.1.5.2.1
Description
p. 80
6.1.5.2.2
Target URI
p. 80
6.1.5.2.3
Standard Methods
p. 80
6.1.5.3
Time Synchronization Configuration Notification
p. 81
6.1.5.3.1
Description
p. 81
6.1.5.3.2
Target URI
p. 81
6.1.5.3.3
Standard Methods
p. 82
6.1.5.3.3.1
POST
p. 82
6.1.6
Data Model
p. 82
6.1.6.1
General
p. 82
6.1.6.2
Structured data types
p. 84
6.1.6.2.1
Introduction
p. 84
6.1.6.2.2
Type: TimeSyncExposureSubsc
p. 85
6.1.6.2.3
Type: TimeSyncExposureSubsNotif
p. 87
6.1.6.2.4
Type SubsEventNotification
p. 87
6.1.6.2.5
Type: TimeSyncCapability
p. 88
6.1.6.2.6
Type: PtpCapabilitiesPerUe
p. 88
6.1.6.2.7
Type: TimeSyncExposureConfigNotif
p. 89
6.1.6.2.8
Type: StateOfConfiguration
p. 89
6.1.6.2.9
Type: TimeSyncExposureConfig
p. 90
6.1.6.2.10
Type: PtpInstance
p. 91
6.1.6.2.11
Type: ConfigForPort
p. 92
6.1.6.2.12
Type: StateOfDstt
p. 94
6.1.6.3
Simple data types and enumerations
p. 94
6.1.6.3.1
Introduction
p. 94
6.1.6.3.2
Simple data types
p. 94
6.1.7
Error Handling
p. 94
6.1.7.1
General
p. 94
6.1.7.2
Protocol Errors
p. 95
6.1.7.3
Application Errors
p. 95
6.1.8
Feature negotiation
p. 95
6.1.9
Security
p. 95
6.2
Ntsctsf_QoSandTSCAssistance Service API
p. 95
6.2.1
Introduction
p. 95
6.2.2
Usage of HTTP
p. 96
6.2.2.1
General
p. 96
6.2.2.2
HTTP standard headers
p. 96
6.2.2.2.1
General
p. 96
6.2.2.2.2
Content type
p. 96
6.2.2.3
HTTP custom headers
p. 96
6.2.3
Resources
p. 96
6.2.3.1
Overview
p. 96
6.2.3.2
Resource: TSC Application Sessions
p. 97
6.2.3.2.1
Description
p. 97
6.2.3.2.2
Resource Definition
p. 98
6.2.3.2.3
Resource Standard Methods
p. 98
6.2.3.2.3.1
POST
p. 98
6.2.3.2.4
Resource Custom Operations
p. 99
6.2.3.3
Resource: Individual TSC Application Session Context
p. 99
6.2.3.3.1
Description
p. 99
6.2.3.3.2
Resource Definition
p. 99
6.2.3.3.3
Resource Standard Methods
p. 99
6.2.3.3.3.1
GET
p. 99
6.2.3.3.3.2
PATCH
p. 100
6.2.3.3.4
Resource Custom Operations
p. 102
6.2.3.3.4.1
Overview
p. 102
6.2.3.3.4.2
Operation: delete
p. 102
6.2.3.3.4.2.1
Description
p. 102
6.2.3.3.4.2.2
Operation Definition
p. 102
6.2.3.4
Resource: Events Subscription (Document)
p. 103
6.2.3.4.1
Description
p. 103
6.2.3.4.2
Resource Definition
p. 104
6.2.3.4.3
Resource Standard Methods
p. 104
6.2.3.4.3.1
PUT
p. 104
6.2.3.4.3.2
DELETE
p. 105
6.2.3.4.4
Resource Custom Operations
p. 106
6.2.4
Custom Operations without associated resources
p. 106
6.2.5
Notifications
p. 106
6.2.5.1
General
p. 106
6.2.5.2
Event Notification
p. 107
6.2.5.2.1
Description
p. 107
6.2.5.2.2
Target URI
p. 107
6.2.5.2.3
Standard Methods
p. 107
6.2.5.2.3.1
POST
p. 107
6.2.5.3
Termination Request
p. 108
6.2.5.3.1
Description
p. 108
6.2.5.3.2
Target URI
p. 108
6.2.5.3.3
Standard Methods
p. 108
6.2.5.3.3.1
POST
p. 108
6.2.6
Data Model
p. 109
6.2.6.1
General
p. 109
6.2.6.2
Structured data types
p. 113
6.2.6.2.1
Introduction
p. 113
6.2.6.2.2
Type TscAppSessionContextData
p. 114
6.2.6.2.3
Type EventsSubscReqData
p. 116
6.2.6.2.4
Type TscAppSessionContextUpdateData
p. 117
6.2.6.2.5
Type EventsSubscReqDataRm
p. 117
6.2.6.2.6
Type EventsNotification
p. 118
6.2.6.2.7
Type EventNotification
p. 119
6.2.6.2.8
Type AdditionalInfoTsctsfQosTscac
|R18|
p. 119
6.2.6.3
Simple data types and enumerations
p. 120
6.2.6.3.1
Introduction
p. 120
6.2.6.3.2
Simple data types
p. 120
6.2.6.3.3
Enumeration: TscEvent
p. 120
6.2.6.4
Data types describing alternative data types or combinations of data types
|R18|
p. 121
6.2.6.4.1
Type: ProblemDetailsTsctsfQosTscac
p. 121
6.2.7
Error Handling
p. 121
6.2.7.1
General
p. 121
6.2.7.2
Protocol Errors
p. 121
6.2.7.3
Application Errors
p. 121
6.2.8
Feature negotiation
p. 121
6.2.9
Security
p. 122
6.3
Ntsctsf_ASTI Service API
p. 122
6.3.1
Introduction
p. 122
6.3.2
Usage of HTTP
p. 123
6.3.2.1
General
p. 123
6.3.2.2
HTTP standard headers
p. 123
6.3.2.2.1
General
p. 123
6.3.2.2.2
Content type
p. 123
6.3.2.3
HTTP custom headers
p. 123
6.3.3
Resources
p. 123
6.3.3.1
Overview
p. 123
6.3.3.2
Resource: ASTI Configurations
p. 124
6.3.3.2.1
Description
p. 124
6.3.3.2.2
Resource Definition
p. 124
6.3.3.2.3
Resource Standard Methods
p. 125
6.3.3.2.3.1
POST
p. 125
6.3.3.2.4
Resource Custom Operations
p. 126
6.3.3.2.4.1
Overview
p. 126
6.3.3.2.4.2
Operation: Retrieve
p. 126
6.3.3.2.4.2.1
Description
p. 126
6.3.3.2.4.2.2
Operation Definition
p. 126
6.3.3.3
Resource: Individual ASTI Configuration
p. 127
6.3.3.3.1
Description
p. 127
6.3.3.3.2
Resource Definition
p. 127
6.3.3.3.3
Resource Standard Methods
p. 127
6.3.3.3.3.2
PUT
p. 127
6.3.3.3.3.3
DELETE
p. 128
6.3.3.3.4
Resource Custom Operations
p. 129
6.3.4
Custom Operations without associated resources
p. 130
6.3.5
Notifications
p. 130
6.3.5.1
General
|R18|
p. 130
6.3.5.2
ASTI Notification
|R18|
p. 130
6.3.5.2.1
Description
p. 130
6.3.5.2.2
Target URI
p. 130
6.3.5.2.3
Standard Methods
p. 130
6.3.5.2.3.1
POST
p. 130
6.3.6
Data Model
p. 131
6.3.6.1
General
p. 131
6.3.6.2
Structured data types
p. 133
6.3.6.2.1
Introduction
p. 133
6.3.6.2.2
Type: AccessTimeDistributionData
p. 133
6.3.6.2.3
Type: AfAsTimeDistributionParam
p. 134
6.3.6.2.4
Type: StatusRequestData
p. 134
6.3.6.2.5
Type: StatusResponseData
p. 135
6.3.6.2.6
Type: ActiveUe
p. 135
6.3.6.2.7
Type AstiConfigNotification
|R18|
p. 135
6.3.6.2.8
Type AstiConfigStateNotification
|R18|
p. 136
6.3.6.3
Simple data types and enumerations
p. 136
6.3.6.3.1
Introduction
p. 136
6.3.6.3.2
Simple data types
p. 136
6.3.6.3.3
Enumeration: AstiEvent
|R18|
p. 136
6.3.7
Error Handling
p. 136
6.3.7.1
General
p. 136
6.3.7.2
Protocol Errors
p. 137
6.3.7.3
Application Errors
p. 137
6.3.8
Feature negotiation
p. 137
6.3.9
Security
p. 137
A
(Normative) OpenAPI specification
p. 138
A.1
General
p. 138
A.2
Ntsctsf_TimeSynchronization API
p. 138
A.3
Ntsctsf_QoSandTSCAssistance API
p. 149
A.4
Ntsctsf_ASTI API
p. 160
B
(Normative) 3GPP extensions for DetNet integration with 5GS
|R18|
p. 166
B.1
3GPP extensions for DetNet integration with 5GS
p. 166
B.1.1
Introduction
p. 166
B.1.2
3GPP Extension _3gpp-5gs-detnet-node
p. 167
B.1.2.1
Description
p. 167
B.1.2.2
Provisioning of 5GS specific traffic characteristics and requirements
p. 167
B.1.2.3
Report of 5GS DetNet flow(s) status
p. 168
B.1.2.4
Exposure of 5GS DetNet Node Identification
p. 168
B.2
YANG Module Definitions
p. 168
B.2.1
Introduction
p. 168
B.2.1.1
General
p. 168
B.2.1.2
Module name
p. 169
B.2.1.3
Header information
p. 169
B.2.1.3.1
<yang-version statement>
p. 169
B.2.1.3.2
<namespace statement>
p. 169
B.2.1.3.3
<prefix statement>
p. 169
B.2.1.4
Meta-information
p. 169
B.2.1.4.1
<organization statement>
p. 169
B.2.1.4.2
<contact statement>
p. 170
B.2.1.4.3
<description statement>
p. 170
B.2.1.4.4
<reference statement>
p. 170
B.2.1.4.5
<revision statement>
p. 170
B.2.1.5
Formatting rules
p. 171
B.2.2
_3gpp-5gs-detnet-node Module definition
p. 172
B.2.2.1
Introduction
p. 172
B.2.2.2
Data Model
p. 172
B.2.2.2.1
General
p. 172
B.2.2.2.2
Structured data types
p. 172
B.2.2.2.2.1
Introduction
p. 172
B.2.2.2.2.2
Type: _3gpp-5gs-node-requirements
p. 172
B.2.2.2.2.3
Type: _3gpp-5gs-node-configuration-outcome
p. 173
B.2.2.2.2.4
Type: _3gpp-5gs-node-identity
p. 173
B.2.2.2.3
Simple data types and enumerations
p. 174
B.2.2.2.3.1
Introduction
p. 174
B.2.2.2.3.2
Simple data types
p. 174
B.2.2.2.3.3
Enumeration: _3gpp-5gs-node-configuration-status
p. 174
C
(Normative) YANG module specification
|R18|
p. 175
C.1
General
p. 175
C.2
YANG module _3gpp-5gs-detnet-node
p. 175
$
Change history
p. 178