Tech-invite3GPPspaceIETF RFCsSIP
Quick21222324252627282931323334353637384‑5x

Content for  TS 23.286  Word version:  17.3.0

Top   Top   Up   Prev   Next
0…   4…   6…   7…   9…   9.2…   9.4…   9.6…   9.9…   9.11…   9.14…   9.17…   10…   A…

 

10  VAE layer APIsWord‑p. 95

10.1  GeneralWord‑p. 95

The following VAE capabilities are offered as APIs:
  • VAE server APIs;
The following SEAL service APIs are specified in TS 23.434:
  • Group management server APIs;
  • Location management server APIs;
  • Configuration management server APIs;
  • Identity management server APIs; and
  • Key management server APIs.

10.2  VAE server APIsWord‑p. 95

10.2.1  GeneralWord‑p. 95

Table 10.2.1-1 illustrates the VAE server APIs.
API Name API Operations Known Consumer(s) Communication Type
The SEAL server(s) APIs available via SEAL-S reference point as specified in TS 23.434 are consumed by the V2X application specific server via the VAE server (acting as a VAL server) over the Vs reference point. When V2X application specific server invokes a SEAL server API via the VAE server over the Vs reference point, the VAE server shall interact with the corresponding SEAL server over the SEAL-S reference point for the API invocation request and response.
Up

10.2.2  VAE_MessageDelivery APIWord‑p. 96

10.2.2.1  GeneralWord‑p. 96

API description: This API enables the V2X application specific server to subscribe/unsubscribe to the VAE server and communicate with the VAE server to send and receive V2X messages to and from the V2X UEs (including V2X groups).

10.2.2.2  Deliver_DL_Message operationWord‑p. 96

API operation name:
Deliver_DL_Message
Description:
Delivers the V2X messages to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Refer subclause 9.4.2.1, 9.4.2.3.
Outputs:
None.
See subclause 9.4.3 and subclause 9.4.4 for the details of usage of this API operation.

10.2.2.3  Deliver_UL_Message operationWord‑p. 96

API operation name:
Deliver_UL_Message
Description:
Delivers the uplink V2X messages from the V2X UEs to the V2X application specific server.
Known Consumers:
V2X application specific server.
Inputs:
None
Outputs:
See subclause 9.4.5 for the details of usage of this API operation.

10.2.2.4  V2X_MessageDelivery_Subscribe operationWord‑p. 96

API operation name:
V2X_MessageDelivery_Subscribe
Description:
Subscribe to the VAE server for sending and receiving V2X messages.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.4.6 for the details of usage of this API operation.

10.2.2.5  V2X_MessageDelivery_Unsubscribe operationWord‑p. 96

API operation name:
V2X_MessageDelivery_Unsubscribe
Description:
Unsubscribe to the VAE server for sending and receiving V2X messages.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.4.6 for the details of usage of this API operation.

10.2.3  VAE_FileDistribution APIWord‑p. 97

10.2.3.1  GeneralWord‑p. 97

API description: This API enables the V2X application specific server to communicate with the VAE server to initiate file distribution to the V2X UEs.

10.2.3.2  Distribute_File operationWord‑p. 97

API operation name:
Distribute_File
Description:
Distributes files to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.5.2 for the details of usage of this API operation.

10.2.4  VAE_ApplicationRequirement APIWord‑p. 97

10.2.4.1  GeneralWord‑p. 97

API description: This API enables the V2X application specific server to communicate with the VAE server to provide V2X application requirement to the underlying 3GPP network.

10.2.4.2  Reserve_NetworkResource operationWord‑p. 97

API operation name:
Reserve_NetworkResource
Description:
Provides V2X application requirement to underlying 3GPP network.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.11.3 for the details of usage of this API operation.

10.2.4.3  Notify_NetworkResource operationWord‑p. 97

API operation name:
Notify_NetworkResource
Description:
Notify the result of network resource adaptation corresponding to the V2X application requirement.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None
See subclause 9.11.3 for the details of usage of this API operation.

10.2.5  VAE_DynamicGroup APIWord‑p. 98

10.2.5.1  GeneralWord‑p. 98

API description: This API enables the V2X application specific server to communicate with the VAE server to configure dynamic group information.

10.2.5.2  Configure_DynamicGroup operationWord‑p. 98

API operation name:
Configure_DynamicGroup
Description:
Configures the dynamic group information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.12.3 for the details of usage of this API operation.

10.2.5.3  Notify_DynamicGroup operationWord‑p. 98

API operation name:
Notify_DynamicGroup
Description:
Notify the dynamic group information (i.e. group member joins or leaves) at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None.
See subclause 9.12.5 for the details of usage of this API operation.

10.2.6  VAE_ServiceContinuity APIWord‑p. 98

10.2.6.1  GeneralWord‑p. 98

API description: This API enables the VAE server to query whether the target VAE server can serve the GEO ID and V2X Service ID for service continuity.

10.2.6.2  Query_ServiceContinuity operationWord‑p. 98

API operation name:
Query_ServiceContinuity
Description:
Query the service continuity information.
Known Consumers:
VAE server.
Inputs:
Outputs:
See subclause 9.10.3 for the details of usage of this API operation.

10.2.7  VAE_HDMapDynamicInfo API |R17|Word‑p. 99

10.2.7.1  GeneralWord‑p. 99

API description:
This API enables the V2X application specific server to communicate with the VAE server to subscribe and receive notifications for HD map dynamic information.

10.2.7.2  Subscribe_HDMapDynamicInfo operationWord‑p. 99

API operation name:
Subscribe_HDMapDynamicInfo
Description:
Subscribes for the HD map dynamic information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.16.3 for the details of usage of this API operation.

10.2.7.3  Notify_HDMapDynamicInfo operationWord‑p. 99

API operation name:
Notify_HDMapDynamicInfo
Description:
Notify the HD map dynamic information at the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None.
See subclause 9.16.6 for the details of usage of this API operation.

10.2.8  VAE_SessionOrientedService API |R17|Word‑p. 99

10.2.8.1  GeneralWord‑p. 99

API description:
This API enables the V2X application specific server to communicate with the VAE server to trigger establishment, update and termination of session-oriented service.

10.2.8.2  Establish_Session operationWord‑p. 99

API operation name:
Establish_Session
Description:
Triggers the establishment of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.19.4.2 for the details of usage of this API operation.

10.2.8.3  Notify_Establish_Session operationWord‑p. 99

API operation name:
Notify_Establish_Session
Description:
Notification about the establishment of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None.
See subclause 9.19.5.2 for the details of usage of this API operation.

10.2.8.4  Update_Session operationWord‑p. 100

API operation name:
Update_Session
Description:
Triggers the update to the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.19.4.3 for the details of usage of this API operation.

10.2.8.5  Notify_Update_Session operationWord‑p. 100

API operation name:
Notify_Update_Session
Description:
Notification about the update to the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None.
See subclause 9.19.5.3 for the details of usage of this API operation.

10.2.8.6  Terminate_Session operationWord‑p. 100

API operation name:
Terminate_Session
Description:
Triggers the termination of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.19.5.4 for the details of usage of this API operation.

10.2.8.7  Notify_Terminate_Session operationWord‑p. 100

API operation name:
Notify_Terminate_Session
Description:
Notification about the termination of the session-oriented service by the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None.
See subclause 9.19.5.4 for the details of usage of this API operation.

10.2.9  VAE_PC5ProvisioningRequirement API |R17|Word‑p. 101

10.2.9.1  GeneralWord‑p. 101

API description:
This API enables the V2X application specific server to communicate with the VAE server to request from VAE server the PC5 provisionng service in multi-operator V2X scenarios.

10.2.9.2  Config_PC5ProvisioningRequirement operationWord‑p. 101

API operation name:
Config_PC5ProvisioningRequirement
Description:
The V2X application specific server provides a V2X PC5 provisioning requirement to the VAE server.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
Acknowledgement message.
See subclause 9.15.3 for the details of usage of this API operation.

10.2.9.3  Notify_PC5ProvisioningRequirement operationWord‑p. 101

API operation name:
Notify_ PC5ProvisioningRequirement
Description:
Notify the result of multi operation PC5 provisioning requirement to the V2X UEs.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
None
See subclause 9.15.3 for the details of usage of this API operation.

10.2.10  VAE_V2VConfigRequirement API |R17|Word‑p. 101

10.2.10.1  GeneralWord‑p. 101

API description:
This API enables the V2X application specific server to provide a V2V configuration requirement to the VAE server to manage the UE-to-UE broadcast/groupcast communication.

10.2.10.2  Request_V2VConfigRequirement operationWord‑p. 101

API operation name:
Request_V2VConfigRequirement
Description:
The V2X application specific server provides a V2V configuration requirement request to the VAE server to manage the UE-to-UE broadcast/groupcast communication.
Known Consumers:
V2X application specific server.
Inputs:
Outputs:
See subclause 9.17.3 for the details of usage of this API operation.

Up   Top   ToC