- Introduction
- gNBSim Block Diagram
- Supported Features
- Pending Features
- Support & Contributions
- License
- Deployment model
- Configuration
- Advanced Configuration/Features
This repository is part of the SD-Core project. SD-Core is open source 5G implementation of 5G Core Network. SD-Core provides a tool to simulate gNodeB and UE by generating NAS and NGAP messages for the configured UEs and call flows.
Supported 3gpp procedures:
- UE Registration
- UE Initiated PDU Session Establishment
- UE Initiated De-registration
- AN Release
- UE Initiated Service Request
- N/W triggered PDU Session Release
- UE Requested PDU Session Release
- N/W requested PDU Session Modification
- UE Requested PDU Session Modification (request and reject; the accept path is not modelled)
- N/W triggered UE Deregistration
- Support for N2 handover profile
Supported System level features
- Gnbsim can generate and send user data packets (ICMP echo request) and process downlink user data (ICMP echo response) over the established data plane path (N3 Tunnel)
- Executing all enabled profiles in parallel or in sequential order
- Timeout for each call flow within profile
- Logging summary result
- HTTP API to execute profile
- Configure number of data packets to be sent and time interval between consecutive packets
- Configure AS (Application Server) address. This is used to send data packets
- Run gNBSim with single Interface or multi interface
- Support of Custom Profiles
- Delay between Procedures
- Timeout for every profile
- Logic to calculate latency per transaction/ operation
- Support retransmission of Service Request Message
- Configurable refusal of a PDU Session Modification, either for named QoS flows or for the whole session, and withholding the PDU Session Modification Complete
- Support deployment of gNBSim as standalone container
- Reporting profile errors from all levels
- Provision data interface to gNBSim Container/POD/executable for data traffic testing
- [3gpp] Generating GTPU echo request & handle incoming GTPU response
- [3gpp] Handle incoming GTPu echo request & generate GTPu echo response
- [3gpp] Support to send Error indication Message
- [3gpp] Adding support for handling End Marker packet
- [3gpp] GUTI based registration
- [3gpp] Adding support for Resynchronization Profile
- Support to handle Paging Request
- Controlling Profiles - Adding support for aborting profile
- Controlling Profiles - Suspend & resume profiles
- Adding support for configurable rate of events
- HTTP APIs to fetch subscriber/profile status from gNBSim
- Adding Support for Xn Handover profile
- Dropping incoming messages based on configuration
- Sending negative responses to request/command type messages based on configuration
- Handling security mode failure message
- Triggering downlink data from gNB Sim (CI/CD feature as well)
- UI Support
- 3gpp Release Upgrade
- Extensive gnbsim documentation
- Command line options to send logs and/or events to file in specific format for post processing.
The gnbsim project welcomes new contributors. Feel free to propose a new feature or fix bugs!
Before contributing, please follow these guidelines:
- gNBSim documentation details here
- Please refer to the official SD-Core documentation for more details.
- #sdcore-dev channel in ONF Community Slack
- Raise Github issues
The project is licensed under the Apache License, version 2.0.