- Introduction
- gNBSim Block Diagram
- Using gNBSim
- Supported Features
- Pending Features
- Support & Contributions
- License
This repository is part of the SD-Core project. It provides a tool to simulate gNodeB and UE by generating NAS and NGAP messages for the configured UEs and call flows.
$ git clone git@github.com:omec-project/gnbsim.git
$ cd gnbsim
$ go build
Trigger call flow testing using following commands
$ ./gnbsim
Note: By default, the gNB Sim reads the configuration from /gnbsim/config/gnb.conf file. Please refer to the gNBSim configuration guide. To provide a different configuration file, use the below command
$ ./gnbsim --cfg config/gnbsim.yaml
section2 This repository is part of the SD-Core project. It provides a tool to simulate
$ git clone git@github.com:omec-project/gnbsim.git
$ cd gnbsim
$ make docker-build #this will create docker image
If you want to run gNBSim along with other SD-Core Network Functions then use aether onRamp to deploy all network functions. If you want to run gNBSim as a standalone tool then deploy gNBSim using onRamp. Enter gnbsim pod using kubectl exec command and run following commands,
All these steps are explained in detail on [AIAB documentation](https://docs.sd-core.opennetworking.org/master/developer/aiab.html)
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 triggered UE Deregistration
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
Data Testing Features
- Provision data interface to gNBSim Container/POD/executable for data traffic testing
- Triggering downlink data from gNB Sim (CI/CD feature as well)
3gpp features for gNodeB Simulator
- GUTI based registration
- Adding support for Resynchronization Profile
- Adding Support for N2 handover profile
- Adding Support for Xn Handover profile
- Adding support for handling end marker packet
- Generating GTPU echo request and handling incoming GTPU Request
- Support to send Error indication Message
- Support to handle Paging Request
Common features for gNodeB Simulator
- Controlling Profiles - Adding support for aborting profile
- Controlling Profiles - Suspend/Pause profiles
- Controlling Profiles - Resume Profile
- Adding support for configurable rate of events
CI/CD features
- Advanced logging
- Reporting profile errors from all levels
- HTTP APIs to fetch subscriber/profile status from gNBSim
Negative Testing features
- Dropping incoming messages based on configuration
- Sending negative responses to request/command type messages based on configuration
- Handling security mode failure message
gNBSim Deployment Features
- Support deployment of gNBSim as standalone container
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.