NixCore Configuration Documentation
Welcome to the NixCore Configuration Documentation.
This documentation covers configuration options for Open5GS, OpenAirInterface, and Free5GC core network components, managed through Nix modules with type safety and validation.
You can now use Flake Builder to build your own core.
Quick Links
- Getting Started - Learn how to use this configuration system
- Examples - Real-world configuration examples
- Search Options - Fast search across all components
- All Options - Browse options across every supported core implementation
- Open5GS Options - Open5GS 5G core and 4G EPC options
- OpenAirInterface Options - OAI core options
- Free5GC Options - Free5GC core options
Features
- 🎯 Type-safe: All options are strongly typed using NixOS module system
- 📚 Well-documented: Every option includes detailed descriptions and examples
- 🔍 Searchable: Fast search across all components
- 🔧 Flexible: Easy to override defaults
- ✅ Validated: Configuration is validated at build time
- 🔗 Integrated: NF Configurations work together seamlessly
Getting Started
Installation
Add this flake to your Nix configuration:
{
inputs = {
nixpkgs.url = "github:nixos/nixpkgs/nixos-unstable";
smf-config.url = "git+https://gitlab.flux.utah.edu/mugahed/nixcore_doc";
};
outputs = { self, nixpkgs, smf-config }: {
# Your configuration here
};
}
Basic Usage
Using Default Configuration
The simplest way to generate the default smf.yaml:
let
pkgs = import <nixpkgs> {};
# Evaluate with defaults
smfConfig = (pkgs.lib.evalModules {
modules = [ smf-config.lib.mkSMFConfig ];
}).config.smf.generated;
in
smfConfig
Customizing Options
Override specific options:
{
smf = {
global.max.ue = 2048;
logger.level = "debug";
mtu = 1500;
metrics.server = {
address = "0.0.0.0";
port = 9091;
};
};
}
Enabling Optional Features
{
smf = {
# Enable NRF connection
sbi.client.nrf.uri = "http://127.0.0.10:7777";
# Configure P-CSCF for IMS
pCscf = [ "127.0.0.1" "::1" ];
# Enable CTF
ctf.enabled = "yes";
};
}
Building Documentation Locally
# Build the documentation
nix build .#docs
# Serve locally
nix run .#serve
# Open http://localhost:8000
Configuration Examples
Complete 5G Core Setup
{
description = "Open5GS AMF YAML generator";
inputs = {
nixpkgs.url = "github:NixOS/nixpkgs/nixos-unstable";
nixcore = {
url = "git+https://gitlab.flux.utah.edu/nixcore/nixcore.git";
inputs.nixpkgs.follows = "nixpkgs";
};
};
outputs = {
nixpkgs,
nixcore,
...
}: let
config = {
open5gs.common.plmn = {
mcc = "888";
mnc = "33";
};
amf.tai.tac = 1;
amf.plmn_support = {
s_nssai = [{sst = 1;}];
};
};
systems = [
"x86_64-linux"
"aarch64-linux"
"x86_64-darwin"
"aarch64-darwin"
];
forAllSystems = nixpkgs.lib.genAttrs systems;
in {
packages = forAllSystems (system: let
ogs = nixcore.packages.${system}.mkOgsPkg config;
in {
inherit ogs;
default = ogs;
});
};
}
NixCore Configuration Options
Browse options by core network implementation. NixCore currently generates typed option references for Open5GS, OpenAirInterface, and Free5GC.
Core Network Implementations
- Open5GS - Open5GS 5G core and 4G EPC options
- OpenAirInterface - OAI core options
- Free5GC - Free5GC core options
Open5GS
- 5G Network Functions:
- SMF (Session Management Function) - Configure the SMF component
- UPF (User Plane Function) - Configure the UPF component
- UDR (Unified Data Repository) - Configure the UDR component
- UDM (Unified Data Management) - Configure the UDM component
- AUSF (Authentication Server Function) - Configure the AUSF component
- NRF (Network Repository Function) - Configure the NRF component
- AMF (Access and Mobility Management Function) - Configure the AMF component
- NSSF (Network Slice Selection Function) - Configure the NSSF component
- PCF (Policy Control Function) - Configure the PCF
- PCRF (Policy and Charging Rules Function) - Configure the PCRF component
- SCP (Service Communication Proxy) - Configure the SCP component
- SEPP1 (Security Edge Protection Proxy) - Configure the SEPP1 component
- SEPP2 (Security Edge Protection Proxy) - Configure the SEPP2 component
- 4G Network Functions:
- HSS (Home Subscriber Server) - Configure the HSS component
- MME (Mobility Management Entity) - Configure the MME component
- SGWC (Serving Gateway Control Plane) - Configure the SGWC component
- SGWU (Serving Gateway User Plane) - Configure the SGWU component
OpenAirInterface
- Common Options
- AMF Options
- SMF Options
- UPF Options
- AUSF Options
- UDM Options
- UDR Options
- NRF Options
- NSSF Options
- PCF Options
- LMF Options
Free5GC
- Common Options
- AMF Options
- AUSF Options
- BSF Options
- CHF Options
- N3IWF Options
- NEF Options
- NRF Options
- NSSF Options
- PCF Options
- SMF Options
- TNGF Options
- UDM Options
- UDR Options
- UEROUTING Options
- UPF Options
- WEBUI Options
Quick Search
Use the Options Search to find options across every supported implementation.
Open5GS Configuration Options
Browse Open5GS 5G core and 4G EPC configuration options.
5G Network Functions
- AMF Options
- AUSF Options
- BSF Options
- NRF Options
- NSSF Options
- PCF Options
- PCRF Options
- SCP Options
- SEPP1 Options
- SEPP2 Options
- SMF Options
- UDM Options
- UDR Options
- UPF Options
4G Network Functions
Open5GS 5G Configuration Options
Browse all available configuration options for Open5GS components:
Components
- 5G Network Functions:
- SMF (Session Management Function) - Configure the SMF component
- UPF (User Plane Function) - Configure the UPF component
- UDR (Unified Data Repository) - Configure the UDR component
- UDM (Unified Data Management) - Configure the UDM component
- AUSF (Authentication Server Function) - Configure the AUSF component
- NRF (Network Repository Function) - Configure the NRF component
- AMF (Access and Mobility Management Function) - Configure the AMF component
- NSSF (Network Slice Selection Function) - Configure the NSSF component
- PCF (Policy Control Function) - Configure the PCF
- PCRF (Policy and Charging Rules Function) - Configure the PCRF component
- SCP (Service Communication Proxy) - Configure the SCP component
- SEPP1 (Security Edge Protection Proxy) - Configure the SEPP1 component
- SEPP2 (Security Edge Protection Proxy) - Configure the SEPP2 component
Quick Search
Use the Options Search to quickly find specific options across all components.
AMF Options
amf.access_control
Access control configuration
Type: list of (submodule)
Default:
[ ]
Declared by:
amf.access_control.*.default_reject_cause
Default Reject cause
Type: null or signed integer
Default:
null
Example:
13
Declared by:
amf.access_control.*.plmn_id
PLMN ID entry
Type: null or (submodule)
Default:
null
Declared by:
amf.access_control.*.plmn_id.mcc
Mobile Country Code
Type: null or string
Default:
null
Example:
"999"
Declared by:
amf.access_control.*.plmn_id.mnc
Mobile Network Code
Type: null or string
Default:
null
Example:
"70"
Declared by:
amf.amf_name
AMF name
Type: string
Default:
"open5gs-amf0"
Example:
"open5gs-amf0"
Declared by:
amf.generated
Path to generated amf.yaml
Type: absolute path
Declared by:
amf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
amf.global.max.ue
Maximum number of UE connections.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
amf.guami
GUAMI configuration.
Type: submodule
Default:
{
amf_id = {
region = 2;
set = 1;
};
plmn_id = {
mcc = "999";
mnc = "70";
};
}
Declared by:
amf.guami.amf_id
AMF ID
Type: submodule
Declared by:
amf.guami.amf_id.region
AMF region
Type: signed integer
Example:
2
Declared by:
amf.guami.amf_id.set
AMF set
Type: signed integer
Example:
1
Declared by:
amf.guami.plmn_id
PLMN ID
Type: submodule
Declared by:
amf.guami.plmn_id.mcc
Mobile Country Code
Type: null or string
Example:
"999"
Declared by:
amf.guami.plmn_id.mnc
Mobile Network Code
Type: null or string
Example:
"70"
Declared by:
amf.logger.file.path
Path to the AMF log file.
Type: string
Default:
"/var/log/open5gs/amf.log"
Example:
"/var/log/open5gs/amf.log"
Declared by:
amf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
amf.metrics.server
Metrics server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.5";
port = 9090;
}
]
Declared by:
amf.metrics.server.*.address
Metrics server address
Type: string
Example:
"127.0.0.5"
Declared by:
amf.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
9090
Declared by:
amf.network_name.full
Full network name
Type: string
Default:
"Open5GS"
Example:
"Open5GS"
Declared by:
amf.network_name.short
Short network name
Type: string
Default:
"Next"
Example:
"Next"
Declared by:
amf.ngap.server
NGAP server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.5";
}
]
Declared by:
amf.ngap.server.*.address
NGAP server address
Type: null or string
Default:
null
Example:
"127.0.0.5"
Declared by:
amf.ngap.server.*.dev
Network device for NGAP server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
amf.plmn_support
PLMN support configuration.
Type: submodule
Default:
{
plmn_id = {
mcc = "999";
mnc = "70";
};
s_nssai = [
{
sst = 1;
}
];
}
Declared by:
amf.plmn_support.plmn_id
PLMN ID
Type: submodule
Declared by:
amf.plmn_support.plmn_id.mcc
Mobile Country Code
Type: null or string
Example:
"999"
Declared by:
amf.plmn_support.plmn_id.mnc
Mobile Network Code
Type: null or string
Example:
"70"
Declared by:
amf.plmn_support.s_nssai
Supported S-NSSAI list
Type: list of (submodule)
Declared by:
amf.plmn_support.s_nssai.*.sd
Slice Differentiator
Type: null or signed integer
Default:
null
Example:
10000
Declared by:
amf.plmn_support.s_nssai.*.sst
Slice/Service Type
Type: null or signed integer
Example:
1
Declared by:
amf.sbi.client.delegated
Delegation options for SBI client
Type: null or (submodule)
Default:
null
Declared by:
amf.sbi.client.delegated.nrf
NRF delegation options
Type: null or (submodule)
Default:
null
Declared by:
amf.sbi.client.delegated.nrf.disc
Delegate discovery to SCP
Type: null or boolean
Default:
null
Example:
true
Declared by:
amf.sbi.client.delegated.nrf.nfm
Directly communicate NRF management functions
Type: null or boolean
Default:
null
Example:
false
Declared by:
amf.sbi.client.delegated.scp
SCP delegation options
Type: null or (submodule)
Default:
null
Declared by:
amf.sbi.client.delegated.scp.next
Delegate to SCP for next-hop communications
Type: null or boolean
Default:
null
Example:
true
Declared by:
amf.sbi.client.nrf
SBI client NRF URIs.
Type: null or (list of (submodule))
Default:
null
Declared by:
amf.sbi.client.nrf.*.uri
NRF URI for SBI client
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
amf.sbi.client.scp
SBI client SCP URIs.
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
amf.sbi.client.scp.*.uri
SCP URI for SBI client
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
amf.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.5";
port = 7777;
}
]
Declared by:
amf.sbi.server.*.address
SBI server address
Type: string
Example:
"127.0.0.5"
Declared by:
amf.sbi.server.*.advertise
Advertise address for SBI server
Type: null or string
Default:
null
Example:
"open5gs-amf.svc.local"
Declared by:
amf.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
amf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
amf.security.ciphering_order
Ciphering algorithm order
Type: list of string
Default:
[
"NEA0"
"NEA1"
"NEA2"
]
Example:
[
"NEA0"
"NEA1"
"NEA2"
]
Declared by:
amf.security.integrity_order
Integrity algorithm order
Type: list of string
Default:
[
"NIA2"
"NIA1"
"NIA0"
]
Example:
[
"NIA2"
"NIA1"
"NIA0"
]
Declared by:
amf.tai
TAI configuration.
Type: submodule
Default:
{
plmn_id = {
mcc = "999";
mnc = "70";
};
tac = 1;
}
Declared by:
amf.tai.plmn_id
PLMN ID
Type: submodule
Declared by:
amf.tai.plmn_id.mcc
Mobile Country Code
Type: null or string
Example:
"999"
Declared by:
amf.tai.plmn_id.mnc
Mobile Network Code
Type: null or string
Example:
"70"
Declared by:
amf.tai.tac
Tracking Area Code
Type: signed integer or list of signed integer
Example:
1
Declared by:
amf.time.t3502
T3502 timer configuration
Type: null or (submodule)
Default:
null
Declared by:
amf.time.t3502.value
T3502 timer value
Type: signed integer
Example:
720
Declared by:
amf.time.t3512
T3512 timer configuration
Type: submodule
Default:
{
value = 540;
}
Declared by:
amf.time.t3512.value
T3512 timer value
Type: signed integer
Default:
540
Example:
540
Declared by:
AUSF Options
ausf.default.tls
Default TLS configuration for both server and client.
Enables HTTPS scheme with TLS encryption for secure communication.
Type: null or (submodule)
Default:
null
Declared by:
ausf.default.tls.client
Client TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
ausf.default.tls.client.cacert
Path to CA certificate
Type: string
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
ausf.default.tls.client.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ausf.crt"
Declared by:
ausf.default.tls.client.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ausf.key"
Declared by:
ausf.default.tls.client.scheme
Client scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
ausf.default.tls.client.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/ausf-client-sslkeylog.log"
Declared by:
ausf.default.tls.server
Server TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
ausf.default.tls.server.cert
Path to server certificate
Type: string
Example:
"open5gs-unstable/etc/open5gs/tls/ausf.crt"
Declared by:
ausf.default.tls.server.private_key
Path to server private key
Type: string
Example:
"open5gs-unstable/etc/open5gs/tls/ausf.key"
Declared by:
ausf.default.tls.server.scheme
Server scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
ausf.default.tls.server.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/ausf-server-sslkeylog.log"
Declared by:
ausf.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Declared by:
ausf.default.tls.server.verify_client_cacert
CA certificate for client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
ausf.generated
Path to generated config.yaml
Type: absolute path
Declared by:
ausf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
ausf.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
ausf.logger.file.path
Path to the AUSF log file.
Type: string
Default:
"/var/log/open5gs/ausf.log"
Example:
"/var/log/open5gs/ausf.log"
Declared by:
ausf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
ausf.sbi.client.delegated
Delegation configuration for NRF and SCP communication.
- If not set: AUTO delegation (all communications delegated to SCP)
- Set explicitly to control which functions are delegated
Type: null or (submodule)
Default:
null
Example:
{
nrf = {
nfm = "no"; # Directly communicate NRF management
disc = "yes"; # Delegate discovery to SCP
};
scp = {
next = "yes"; # Delegate next-hop to SCP
};
}
Declared by:
ausf.sbi.client.delegated.nrf
NRF delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
ausf.sbi.client.delegated.nrf.disc
Delegate NRF discovery (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
ausf.sbi.client.delegated.nrf.nfm
Delegate NRF management functions (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"no"
Declared by:
ausf.sbi.client.delegated.scp
SCP delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
ausf.sbi.client.delegated.scp.next
Delegate to SCP for next-hop (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
ausf.sbi.client.nrf
NRF (Network Repository Function) URIs for direct communication.
Type: null or (list of (submodule))
Default:
null
Example:
[{ uri = "http://127.0.0.10:7777"; }]
Declared by:
ausf.sbi.client.nrf.*.uri
NRF URI for direct communication
Type: string
Declared by:
ausf.sbi.client.scp
SCP (Service Communication Proxy) URIs for indirect communication.
Type: list of (submodule)
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
ausf.sbi.client.scp.*.uri
SCP URI for indirect communication
Type: string
Declared by:
ausf.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.11";
port = 7777;
}
]
Declared by:
ausf.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.11"
Declared by:
ausf.sbi.server.*.advertise
Advertised address (can include port)
Type: null or string
Default:
null
Example:
"open5gs-ausf.svc.local"
Declared by:
ausf.sbi.server.*.dev
Network device to bind to
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
ausf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
BSF Options
bsf.bsf.sbi.client.delegated
Delegation options for SBI client.
Type: null or (submodule)
Default:
null
Declared by:
bsf.bsf.sbi.client.delegated.nrf
Delegation options for NRF
Type: null or (submodule)
Default:
null
Declared by:
bsf.bsf.sbi.client.delegated.nrf.disc
Delegate NRF discovery
Type: null or boolean
Default:
null
Example:
false
Declared by:
bsf.bsf.sbi.client.delegated.nrf.nfm
Delegate NRF management functions
Type: null or boolean
Default:
null
Example:
false
Declared by:
bsf.bsf.sbi.client.delegated.scp
Delegation options for SCP
Type: null or (submodule)
Default:
null
Declared by:
bsf.bsf.sbi.client.delegated.scp.next
Delegate to SCP for next-hop communications
Type: null or boolean
Default:
null
Example:
false
Declared by:
bsf.bsf.sbi.client.nrf
NRF URIs for SBI client.
Type: null or (list of (submodule))
Default:
null
Example:
[{ uri = "http://127.0.0.10:7777"; }]
Declared by:
bsf.bsf.sbi.client.nrf.*.uri
NRF URI for SBI client
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
bsf.bsf.sbi.client.scp
SCP URIs for SBI client.
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Example:
[{ uri = "http://127.0.0.200:7777"; }]
Declared by:
bsf.bsf.sbi.client.scp.*.uri
SCP URI for SBI client
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
bsf.bsf.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.15";
port = 7777;
}
]
Declared by:
bsf.bsf.sbi.server.*.address
SBI server address
Type: string
Example:
"127.0.0.15"
Declared by:
bsf.bsf.sbi.server.*.advertise
Advertise address for SBI server
Type: null or string
Default:
null
Example:
"open5gs-bsf.svc.local"
Declared by:
bsf.bsf.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
bsf.bsf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
bsf.default.tls.client.cacert
Path to CA certificate for client
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
bsf.default.tls.client.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/bsf.crt"
Declared by:
bsf.default.tls.client.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/bsf.key"
Declared by:
bsf.default.tls.client.client_sslkeylogfile
Path to SSL key log file for client
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/bsf-client-sslkeylog.log"
Declared by:
bsf.default.tls.client.scheme
TLS client scheme
Type: null or string
Default:
null
Example:
"https"
Declared by:
bsf.default.tls.server.cert
Path to server certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/bsf.crt"
Declared by:
bsf.default.tls.server.private_key
Path to server private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/bsf.key"
Declared by:
bsf.default.tls.server.scheme
TLS server scheme
Type: null or string
Default:
null
Example:
"https"
Declared by:
bsf.default.tls.server.sslkeylogfile
Path to SSL key log file for server
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/bsf-server-sslkeylog.log"
Declared by:
bsf.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
bsf.default.tls.server.verify_client_cacert
Path to CA certificate for client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
bsf.generated
Path to generated bsf.yaml
Type: absolute path
Declared by:
bsf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
bsf.global.max.ue
Maximum number of UE connections.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
bsf.logger.file.path
Path to the BSF log file.
Type: string
Default:
"/var/log/open5gs/bsf.log"
Example:
"/var/log/open5gs/bsf.log"
Declared by:
bsf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
NRF Options
nrf.default.tls.client.cacert
Path to CA certificate for client (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
nrf.default.tls.client.client_cert
Path to client certificate (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/nrf.crt"
Declared by:
nrf.default.tls.client.client_private_key
Path to client private key (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/nrf.key"
Declared by:
nrf.default.tls.client.client_sslkeylogfile
Path to SSL key log file for client. Allows capturing SSL/TLS session keys for debugging with Wireshark.
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/nrf-client-sslkeylog.log"
Declared by:
nrf.default.tls.client.scheme
TLS scheme for client
Type: null or string
Default:
null
Example:
"https"
Declared by:
nrf.default.tls.server.cert
Path to server certificate (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/nrf.crt"
Declared by:
nrf.default.tls.server.private_key
Path to server private key (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/nrf.key"
Declared by:
nrf.default.tls.server.scheme
TLS scheme for server
Type: null or string
Default:
null
Example:
"https"
Declared by:
nrf.default.tls.server.sslkeylogfile
Path to SSL key log file for server. Allows capturing SSL/TLS session keys for debugging with Wireshark.
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/nrf-server-sslkeylog.log"
Declared by:
nrf.default.tls.server.verify_client
Enable client verification for TLS
Type: null or boolean
Default:
null
Example:
true
Declared by:
nrf.default.tls.server.verify_client_cacert
Path to CA certificate for client verification (without /nix/store hash)
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
nrf.generated
Path to generated nrf.yaml
Type: absolute path
Declared by:
nrf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
nrf.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
nrf.logger.file.path
Path to the NRF log file.
Type: string
Default:
"/var/log/open5gs/nrf.log"
Example:
"/var/log/open5gs/nrf.log"
Declared by:
nrf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
nrf.sbi.server
SBI server configuration.
Examples:
- Bind to eth0 and advertise:
[{ dev = "eth0"; advertise = "open5gs-nrf.svc.local"; }] - Custom port:
[{ address = "nrf.localdomain"; port = 7777; }] - Bind and advertise:
[{ address = "127.0.0.10"; port = 7777; advertise = "open5gs-nrf.svc.local"; }]
Type: list of (submodule)
Default:
[
{
address = "127.0.0.10";
port = 7777;
}
]
Declared by:
nrf.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.10"
Declared by:
nrf.sbi.server.*.advertise
Advertise address for SBI server
Type: null or string
Default:
null
Example:
"open5gs-nrf.svc.local"
Declared by:
nrf.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
nrf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
nrf.serving
List of PLMN IDs for NRF serving. 5G roaming requires PLMN in NRF.
Type: list of (submodule)
Default:
[
{
plmn_id = {
mcc = "999";
mnc = "70";
};
}
]
Declared by:
nrf.serving.*.plmn_id
PLMN ID for NRF serving (5G roaming requires PLMN in NRF)
Type: submodule
Declared by:
nrf.serving.*.plmn_id.mcc
Mobile Country Code
Type: string
Example:
"999"
Declared by:
nrf.serving.*.plmn_id.mnc
Mobile Network Code
Type: string
Example:
"70"
Declared by:
NSSF Options
nssf.generated
Path to generated nssf.yaml
Type: absolute path
Declared by:
nssf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
nssf.global.max.ue
Maximum number of UE connections.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
nssf.logger.file.path
Path to the NSSF log file.
Type: string
Default:
"/var/log/open5gs/nssf.log"
Example:
"/var/log/open5gs/nssf.log"
Declared by:
nssf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
nssf.sbi.client.delegated
Delegation options for SBI client
Type: null or (submodule)
Default:
null
Declared by:
nssf.sbi.client.delegated.nrf
NRF delegation options
Type: null or (submodule)
Default:
null
Declared by:
nssf.sbi.client.delegated.nrf.disc
Delegate discovery to SCP
Type: null or boolean
Default:
null
Example:
true
Declared by:
nssf.sbi.client.delegated.nrf.nfm
Directly communicate NRF management functions
Type: null or boolean
Default:
null
Example:
false
Declared by:
nssf.sbi.client.delegated.scp
SCP delegation options
Type: null or (submodule)
Default:
null
Declared by:
nssf.sbi.client.delegated.scp.next
Delegate to SCP for next-hop communications
Type: null or boolean
Default:
null
Example:
true
Declared by:
nssf.sbi.client.nrf
SBI client NRF URIs.
Type: null or (list of (submodule))
Default:
null
Declared by:
nssf.sbi.client.nrf.*.uri
NRF URI for SBI client
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
nssf.sbi.client.nsi
SBI client NSI URIs.
Type: null or (list of (submodule))
Default:
[
{
s_nssai = {
sd = null;
sst = 1;
};
uri = "http://127.0.0.10:7777";
}
]
Declared by:
nssf.sbi.client.nsi.*.s_nssai
S-NSSAI
Type: submodule
Declared by:
nssf.sbi.client.nsi.*.s_nssai.sd
Slice Differentiator
Type: null or string
Default:
null
Example:
"000080"
Declared by:
nssf.sbi.client.nsi.*.s_nssai.sst
Slice/Service Type
Type: null or signed integer
Example:
1
Declared by:
nssf.sbi.client.nsi.*.uri
NSI URI for SBI client
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
nssf.sbi.client.scp
SBI client SCP URIs.
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
nssf.sbi.client.scp.*.uri
SCP URI for SBI client
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
nssf.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.14";
port = 7777;
}
]
Declared by:
nssf.sbi.server.*.address
SBI server address
Type: string
Example:
"127.0.0.14"
Declared by:
nssf.sbi.server.*.advertise
Advertise address for SBI server
Type: null or string
Default:
null
Example:
"open5gs-nssf.svc.local"
Declared by:
nssf.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
nssf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
PCF Options
pcf.db_uri
MongoDB URI for PCF database
Type: string
Default:
"mongodb://localhost/open5gs"
Example:
"mongodb://localhost/open5gs"
Declared by:
pcf.default.tls.client.cacert
TLS client CA certificate path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
pcf.default.tls.client.client_cert
TLS client certificate path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/pcf.crt"
Declared by:
pcf.default.tls.client.client_private_key
TLS client private key path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/pcf.key"
Declared by:
pcf.default.tls.client.client_sslkeylogfile
TLS client SSL key log file path
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/pcf-client-sslkeylog.log"
Declared by:
pcf.default.tls.client.scheme
TLS client scheme
Type: null or string
Default:
null
Example:
"https"
Declared by:
pcf.default.tls.server.cert
TLS server certificate path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/pcf.crt"
Declared by:
pcf.default.tls.server.private_key
TLS server private key path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/pcf.key"
Declared by:
pcf.default.tls.server.scheme
TLS server scheme
Type: null or string
Default:
null
Example:
"https"
Declared by:
pcf.default.tls.server.sslkeylogfile
TLS server SSL key log file path
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/pcf-server-sslkeylog.log"
Declared by:
pcf.default.tls.server.verify_client
Enable TLS client verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
pcf.default.tls.server.verify_client_cacert
TLS client CA certificate path
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
pcf.generated
Path to generated config.yaml
Type: absolute path
Declared by:
pcf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
pcf.global.max.ue
Maximum number of UE connections.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
pcf.logger.file.path
Path to the PCF log file.
Type: string
Default:
"/var/log/open5gs/pcf.log"
Example:
"/var/log/open5gs/pcf.log"
Declared by:
pcf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
pcf.pcf.metrics.server
Metrics server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.13";
port = 9090;
}
]
Declared by:
pcf.pcf.metrics.server.*.address
Metrics server address
Type: string
Default:
"127.0.0.13"
Example:
"0.0.0.0"
Declared by:
pcf.pcf.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
9090
Example:
9091
Declared by:
pcf.pcf.policy
PCF policy configuration for UE Home PLMN and SUPI range based policies.
Type: null or (list of (submodule))
Default:
null
Declared by:
pcf.pcf.policy.*.plmn_id
Filter policies by home PLMN-ID.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.plmn_id.mcc
Mobile Country Code
Type: string
Example:
"999"
Declared by:
pcf.pcf.policy.*.plmn_id.mnc
Mobile Network Code
Type: string
Example:
"70"
Declared by:
pcf.pcf.policy.*.slice
Slice configurations for this policy.
Type: list of (submodule)
Default:
[ ]
Declared by:
pcf.pcf.policy.*.slice.*.default_indicator
Whether this is the default slice.
Type: null or boolean
Default:
null
Example:
true
Declared by:
pcf.pcf.policy.*.slice.*.sd
Slice Differentiator.
Type: null or string
Default:
null
Example:
"000001"
Declared by:
pcf.pcf.policy.*.slice.*.session
Session configurations for this slice.
Type: list of (submodule)
Default:
[ ]
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr
Aggregate Maximum Bit Rate.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.downlink
Downlink AMBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.downlink.unit
Downlink AMBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
3
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.downlink.value
Downlink AMBR value.
Type: positive integer, meaning >0
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.uplink
Uplink AMBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.uplink.unit
Uplink AMBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
3
Declared by:
pcf.pcf.policy.*.slice.*.session.*.ambr.uplink.value
Uplink AMBR value.
Type: positive integer, meaning >0
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.name
DNN/APN name.
Type: string
Example:
"internet"
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule
PCC rules for this session.
Type: null or (list of (submodule))
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.flow
Flow filters for PCC rule.
Type: null or (list of (submodule))
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.flow.*.description
Flow filter description.
Type: string
Example:
"permit out icmp from any to assigned"
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.flow.*.direction
Flow direction. 1: UL, 2: DL.
Type: integer between 1 and 2 (both inclusive)
Example:
2
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos
QoS parameters for PCC rule.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.arp
Allocation and Retention Priority for PCC rule.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.arp.pre_emption_capability
Pre-emption capability. 1: Disabled, 2: Enabled.
Type: integer between 1 and 2 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability. 1: Disabled, 2: Enabled.
Type: integer between 1 and 2 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.arp.priority_level
ARP priority level (1-15).
Type: integer between 1 and 15 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr
Guaranteed Bit Rate for PCC rule.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.downlink
Downlink GBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.downlink.unit
Downlink GBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.downlink.value
Downlink GBR value.
Type: positive integer, meaning >0
Example:
82
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.uplink
Uplink GBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.uplink.unit
Uplink GBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.gbr.uplink.value
Uplink GBR value.
Type: positive integer, meaning >0
Example:
82
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.index
5QI value for PCC rule.
Type: signed integer
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr
Maximum Bit Rate for PCC rule.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.downlink
Downlink MBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.downlink.unit
Downlink MBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.downlink.value
Downlink MBR value.
Type: positive integer, meaning >0
Example:
82
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.uplink
Uplink MBR.
Type: submodule
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.uplink.unit
Uplink MBR unit. 0: bps, 1: Kbps, 2: Mbps, 3: Gbps, 4: Tbps.
Type: integer between 0 and 4 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.pcc_rule.*.qos.mbr.uplink.value
Uplink MBR value.
Type: positive integer, meaning >0
Example:
82
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos
QoS parameters.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos.arp
Allocation and Retention Priority.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos.arp.pre_emption_capability
Pre-emption capability. 1: Disabled, 2: Enabled.
Type: integer between 1 and 2 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability. 1: Disabled, 2: Enabled.
Type: integer between 1 and 2 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos.arp.priority_level
ARP priority level (1-15).
Type: integer between 1 and 15 (both inclusive)
Example:
8
Declared by:
pcf.pcf.policy.*.slice.*.session.*.qos.index
5QI value.
Type: signed integer
Example:
9
Declared by:
pcf.pcf.policy.*.slice.*.session.*.type
PDU session type. 1: IPv4, 2: IPv6, 3: IPv4v6.
Type: integer between 1 and 3 (both inclusive)
Example:
3
Declared by:
pcf.pcf.policy.*.slice.*.sst
Slice/Service Type. Allowed values: 1, 2, 3, 4.
Type: integer between 1 and 4 (both inclusive)
Example:
1
Declared by:
pcf.pcf.policy.*.supi_range
Filter policies by SUPI range. Maximum 16 ranges.
Type: null or (list of string)
Default:
null
Example:
[
"999700000000001-999709999999999"
"315010000000001-315010999999999"
]
Declared by:
pcf.pcf.sbi.client.delegated
Delegation configuration for SBI client.
Type: null or (submodule)
Default:
null
Declared by:
pcf.pcf.sbi.client.delegated.nrf
NRF delegation options
Type: submodule
Default:
{ }
Declared by:
pcf.pcf.sbi.client.delegated.nrf.disc
Delegate NRF discovery
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
pcf.pcf.sbi.client.delegated.nrf.nfm
Delegate NRF management functions
Type: null or one of “yes”, “no”
Default:
null
Example:
"no"
Declared by:
pcf.pcf.sbi.client.delegated.scp
SCP delegation options
Type: submodule
Default:
{ }
Declared by:
pcf.pcf.sbi.client.delegated.scp.next
Delegate to SCP for next-hop
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
pcf.pcf.sbi.client.nrf
PCF SBI client NRF URIs.
Type: null or (list of (submodule))
Default:
null
Example:
[{ uri = "http://127.0.0.10:7777"; }]
Declared by:
pcf.pcf.sbi.client.nrf.*.uri
NRF URI for PCF SBI client
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
pcf.pcf.sbi.client.scp
PCF SBI client SCP URIs.
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Example:
[{ uri = "http://127.0.0.200:7777"; }]
Declared by:
pcf.pcf.sbi.client.scp.*.uri
SCP URI for PCF SBI client
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
pcf.pcf.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.13";
port = 7777;
}
]
Declared by:
pcf.pcf.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.13"
Declared by:
pcf.pcf.sbi.server.*.advertise
Advertise address for SBI server
Type: null or string
Default:
null
Example:
"open5gs-pcf.svc.local"
Declared by:
pcf.pcf.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
pcf.pcf.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
PCRF Options
pcrf.db_uri
MongoDB database URI for PCRF.
Type: string
Default:
"mongodb://localhost/open5gs"
Example:
"mongodb://localhost/open5gs"
Declared by:
pcrf.generated
Path to generated pcrf.yaml
Type: absolute path
Declared by:
pcrf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
pcrf.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
pcrf.logger.file.path
Path to the PCRF log file.
Type: string
Default:
"/var/log/open5gs/pcrf.log"
Example:
"/var/log/open5gs/pcrf.log"
Declared by:
pcrf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
pcrf.pcrf.freeDiameter
Path to freeDiameter configuration file for PCRF (without /nix/store hash).
Type: string
Default:
"@sysconfdir@/freeDiameter/pcrf.conf"
Example:
"open5gs-unstable/etc/freeDiameter/pcrf.conf"
Declared by:
pcrf.pcrf.metrics.server
Metrics server configuration for PCRF.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.9";
port = 9090;
}
]
Declared by:
pcrf.pcrf.metrics.server.*.address
Metrics server address
Type: string
Example:
"127.0.0.9"
Declared by:
pcrf.pcrf.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
9090
Declared by:
pcrf.policy
PCRF Policy Configuration: SUPI Range Based Policies.
This configuration applies policies based solely on the UE’s SUPI range. Each policy defines one or more SUPI ranges and associated session configurations for different DNNs (Data Network Names).
Example:
policy = [
{
supi_range = [
"999700000000001-999709999999999"
"315010000000001-315010999999999"
];
session = [
{
name = "internet";
type = 3; # IPv4v6
ambr = {
downlink = { value = 1; unit = 3; }; # 1 Gbps
uplink = { value = 1; unit = 3; };
};
qos = {
index = 9;
arp = {
priority_level = 8;
pre_emption_vulnerability = 1;
pre_emption_capability = 1;
};
};
}
];
}
];
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session
Session configurations based on DNN/APN
Type: list of (submodule)
Declared by:
pcrf.policy.*.session.*.ambr
Aggregate Maximum Bit Rate configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.ambr.downlink
Aggregate Maximum Bit Rate (AMBR) for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.ambr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
3
Declared by:
pcrf.policy.*.session.*.ambr.downlink.value
Downlink bandwidth value
Type: positive integer, meaning >0
Example:
1
Declared by:
pcrf.policy.*.session.*.ambr.uplink
Aggregate Maximum Bit Rate (AMBR) for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.ambr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
3
Declared by:
pcrf.policy.*.session.*.ambr.uplink.value
Uplink bandwidth value
Type: positive integer, meaning >0
Example:
1
Declared by:
pcrf.policy.*.session.*.name
Data Network Name (DNN/APN)
Type: string
Example:
"internet"
Declared by:
pcrf.policy.*.session.*.pcc_rule
Policy and Charging Control (PCC) rules for the session. Defines detailed QoS, flow filtering, and bandwidth policies.
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow
Flow rules for the PCC rule
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow.*.description
Flow description using IPFilterRule format. Examples:
- “permit out icmp from any to assigned”
- “permit out udp from 10.200.136.98/32 23455 to assigned 1-65535”
Type: string
Example:
"permit out icmp from any to assigned"
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow.*.direction
Flow direction: 1=downlink, 2=uplink
Type: one of 1, 2
Example:
2
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos
QoS configuration for the PCC rule
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp
Allocation and Retention Priority (ARP)
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.pre_emption_capability
Pre-emption capability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.priority_level
Priority level (1-15)
Type: integer between 1 and 15 (both inclusive)
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr
Guaranteed Bit Rate (GBR) configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink
Guaranteed Bit Rate for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink.value
Guaranteed Bit Rate downlink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink
Guaranteed Bit Rate for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink.value
Guaranteed Bit Rate uplink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.index
QoS Class Identifier (QCI/5QI)
Type: one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 65, 66, 67, 69, 70, 71, 72, 73, 74, 75, 76, 79, 80, 82, 83, 84, 85, 86
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr
Maximum Bit Rate (MBR) configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink
Maximum Bit Rate for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink.value
Maximum Bit Rate downlink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink
Maximum Bit Rate for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink.value
Maximum Bit Rate uplink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.qos
QoS configuration for the session
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.qos.arp
Allocation and Retention Priority (ARP)
Type: submodule
Declared by:
pcrf.policy.*.session.*.qos.arp.pre_emption_capability
Pre-emption capability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.qos.arp.priority_level
Priority level (1-15)
Type: integer between 1 and 15 (both inclusive)
Example:
8
Declared by:
pcrf.policy.*.session.*.qos.index
QoS Class Identifier (QCI/5QI). Allowed values: 1,2,3,4,65,66,67,75,71,72,73,74,76,5,6,7,8,9,69,70,79,80,82,83,84,85,86
Type: one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 65, 66, 67, 69, 70, 71, 72, 73, 74, 75, 76, 79, 80, 82, 83, 84, 85, 86
Example:
9
Declared by:
pcrf.policy.*.session.*.type
IP type: 1 = IPv4, 2 = IPv6, 3 = IPv4v6
Type: one of 1, 2, 3
Example:
3
Declared by:
pcrf.policy.*.supi_range
One or more ranges of SUPIs (IMSI) to which this policy applies. Format: start-end (e.g., “999700000000001-999709999999999”)
Type: list of string
Example:
[
"999700000000001-999709999999999"
"315010000000001-315010999999999"
]
Declared by:
SCP Options
scp.default.tls.client.cacert
Path to CA certificate for server verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
scp.default.tls.client.client_cert
Path to client TLS certificate for mutual TLS
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/scp.crt"
Declared by:
scp.default.tls.client.client_private_key
Path to client TLS private key for mutual TLS
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/scp.key"
Declared by:
scp.default.tls.client.client_sslkeylogfile
Path to SSL key log file for client connections debugging. Captures SSL/TLS session keys for analysis.
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/scp-client-sslkeylog.log"
Declared by:
scp.default.tls.client.scheme
Default client scheme (http or https)
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
scp.default.tls.server.cert
Path to server TLS certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/scp.crt"
Declared by:
scp.default.tls.server.private_key
Path to server TLS private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/scp.key"
Declared by:
scp.default.tls.server.scheme
Default server scheme (http or https)
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
scp.default.tls.server.sslkeylogfile
Path to SSL key log file for Wireshark debugging. Captures SSL/TLS session keys for analysis.
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/scp-server-sslkeylog.log"
Declared by:
scp.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
scp.default.tls.server.verify_client_cacert
CA certificate for client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
scp.generated
Path to generated scp.yaml
Type: absolute path
Declared by:
scp.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
scp.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
scp.info.domain
SCP domain configuration with port numbers. Port configuration here takes precedence over global scpPorts.
Type: null or (list of (submodule))
Default:
null
Declared by:
scp.info.domain.*.fqdn
Fully Qualified Domain Name for the SCP domain
Type: string
Example:
"scp.localdomain"
Declared by:
scp.info.domain.*.name
SCP Domain name
Type: string
Example:
"SCP_Domain_1"
Declared by:
scp.info.domain.*.port.http
HTTP port for this SCP domain (overrides global port)
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
3333
Declared by:
scp.info.domain.*.port.https
HTTPS port for this SCP domain (overrides global port)
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
4444
Declared by:
scp.info.port.http
HTTP port number for SCP. If not present, defaults to TCP port 80 for “http” URIs.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
scp.info.port.https
HTTPS port number for SCP. If not present, defaults to TCP port 443 for “https” URIs.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8888
Declared by:
scp.logger.file.path
Path to the SCP log file.
Type: string
Default:
"/var/log/open5gs/scp.log"
Example:
"/var/log/open5gs/scp.log"
Declared by:
scp.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
scp.sbi.client.delegated.scp.next
Control delegation to SCP for next-hop communications.
- null: AUTO delegation (all communications delegated to Next-SCP)
- true: Delegate to SCP for next-hop
- false: Do not delegate to SCP for next-hop
Type: null or boolean
Default:
null
Example:
true
Declared by:
scp.sbi.client.nrf
NRF client configuration for direct communication or indirect without delegation.
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.10:7777";
}
]
Example:
[{ uri = "http://127.0.0.10:7777"; }]
Declared by:
scp.sbi.client.nrf.*.uri
NRF URI for direct or indirect communication
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
scp.sbi.client.scp
SCP client configuration for delegating to next-hop SCP.
Type: null or (list of (submodule))
Default:
null
Example:
[{ uri = "http://127.0.0.200:7777"; }]
Declared by:
scp.sbi.client.scp.*.uri
Next-hop SCP URI for indirect communication
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
scp.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.200";
port = 7777;
}
]
Declared by:
scp.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.200"
Declared by:
scp.sbi.server.*.advertise
Override address (and optionally port) to be advertised
Type: null or string
Default:
null
Example:
"open5gs-scp.svc.local:8888"
Declared by:
scp.sbi.server.*.dev
Network device for SBI server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
scp.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
SEPP1 Options
sepp1.client.sepp
SEPP client configuration
Type: null or (list of (submodule))
Default:
[
{
n32f = {
resolve = "127.0.2.252";
uri = "https://sepp2.localdomain:7777";
};
receiver = "sepp2.localdomain";
resolve = "127.0.2.251";
uri = "https://sepp2.localdomain:7777";
}
]
Declared by:
sepp1.client.sepp.*.cacert
Path to CA certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.client.sepp.*.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.crt"
Declared by:
sepp1.client.sepp.*.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.key"
Declared by:
sepp1.client.sepp.*.n32f
N32 forwarding client configuration
Type: null or (submodule)
Default:
null
Declared by:
sepp1.client.sepp.*.n32f.cacert
Path to CA certificate for N32F
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.client.sepp.*.n32f.client_cert
Path to N32F client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1-n32f.crt"
Declared by:
sepp1.client.sepp.*.n32f.client_private_key
Path to N32F client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1-n32f.key"
Declared by:
sepp1.client.sepp.*.n32f.resolve
IP address to resolve the N32F URI to
Type: null or string
Default:
null
Example:
"127.0.2.252"
Declared by:
sepp1.client.sepp.*.n32f.uri
N32F URI
Type: string
Example:
"https://sepp2.localdomain:7777"
Declared by:
sepp1.client.sepp.*.receiver
Receiver domain name
Type: string
Example:
"sepp2.localdomain"
Declared by:
sepp1.client.sepp.*.resolve
IP address to resolve the URI to
Type: null or string
Default:
null
Example:
"127.0.2.251"
Declared by:
sepp1.client.sepp.*.uri
SEPP URI
Type: string
Example:
"https://sepp2.localdomain:7777"
Declared by:
sepp1.default.tls.client.cacert
Path to CA certificate file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/ca.crt"
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.default.tls.client.client_cert
Path to client certificate file
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.crt"
Declared by:
sepp1.default.tls.client.client_private_key
Path to client private key file
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.key"
Declared by:
sepp1.default.tls.client.client_sslkeylogfile
Path to client SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/sepp1-client-sslkeylog.log"
Declared by:
sepp1.default.tls.server.cert
Path to server certificate file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/sepp1.crt"
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.crt"
Declared by:
sepp1.default.tls.server.private_key
Path to server private key file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/sepp1.key"
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.key"
Declared by:
sepp1.default.tls.server.sslkeylogfile
Path to SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/sepp1-server-sslkeylog.log"
Declared by:
sepp1.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp1.default.tls.server.verify_client_cacert
Path to CA certificate for client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.generated
Path to generated sepp1.yaml
Type: absolute path
Declared by:
sepp1.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
sepp1.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
sepp1.info.port.http
SEPP HTTP port number. Present if SEPP uses non-default HTTP port.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp1.info.port.https
SEPP HTTPS port number. Present if SEPP uses non-default HTTPS port.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8888
Declared by:
sepp1.logger.file.path
Path to the SEPP1 log file.
Type: string
Default:
"/var/log/open5gs/sepp1.log"
Example:
"/var/log/open5gs/sepp1.log"
Declared by:
sepp1.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
sepp1.n32.server
N32 server configuration
Type: list of (submodule)
Default:
[
{
address = "127.0.1.251";
n32f = {
address = "127.0.1.252";
port = 7777;
scheme = "https";
};
port = 7777;
scheme = "https";
sender = "sepp1.localdomain";
}
]
Declared by:
sepp1.n32.server.*.address
N32 server address
Type: null or string
Default:
null
Example:
"127.0.1.251"
Declared by:
sepp1.n32.server.*.cert
Path to N32 server certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.crt"
Declared by:
sepp1.n32.server.*.n32f
N32 forwarding configuration
Type: null or (submodule)
Default:
null
Declared by:
sepp1.n32.server.*.n32f.address
N32 forwarding address
Type: string
Example:
"127.0.1.252"
Declared by:
sepp1.n32.server.*.n32f.cert
Path to N32F certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1-n32f.crt"
Declared by:
sepp1.n32.server.*.n32f.port
N32 forwarding port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp1.n32.server.*.n32f.private_key
Path to N32F private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1-n32f.key"
Declared by:
sepp1.n32.server.*.n32f.scheme
URI scheme for N32 forwarding
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
sepp1.n32.server.*.n32f.verify_client
Enable N32F client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp1.n32.server.*.n32f.verify_client_cacert
Path to CA certificate for N32F client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.n32.server.*.port
N32 server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp1.n32.server.*.private_key
Path to N32 server private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp1.key"
Declared by:
sepp1.n32.server.*.scheme
URI scheme for N32 server
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
sepp1.n32.server.*.sender
Sender domain name
Type: string
Example:
"sepp1.localdomain"
Declared by:
sepp1.n32.server.*.verify_client
Enable N32 client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp1.n32.server.*.verify_client_cacert
Path to CA certificate for N32 client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp1.sbi.client.nrf
NRF client configuration
Type: null or (list of (submodule))
Default:
null
Declared by:
sepp1.sbi.client.nrf.*.uri
NRF URI
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
sepp1.sbi.client.scp
SCP client configuration
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
sepp1.sbi.client.scp.*.uri
SCP URI
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
sepp1.sbi.server
SBI server configuration
Type: list of (submodule)
Default:
[
{
address = "127.0.1.250";
port = 7777;
}
]
Declared by:
sepp1.sbi.server.*.address
SBI server address
Type: string
Example:
"127.0.1.250"
Declared by:
sepp1.sbi.server.*.port
SBI server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
7777
Declared by:
SEPP2 Options
sepp2.client.sepp
SEPP client configuration
Type: null or (list of (submodule))
Default:
[
{
n32f = {
resolve = "127.0.1.252";
uri = "https://sepp1.localdomain:7777";
};
receiver = "sepp1.localdomain";
resolve = "127.0.1.251";
uri = "https://sepp1.localdomain:7777";
}
]
Declared by:
sepp2.client.sepp.*.cacert
Path to CA certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.client.sepp.*.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.crt"
Declared by:
sepp2.client.sepp.*.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.key"
Declared by:
sepp2.client.sepp.*.n32f
N32 forwarding client configuration
Type: null or (submodule)
Default:
null
Declared by:
sepp2.client.sepp.*.n32f.cacert
Path to CA certificate for N32F
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.client.sepp.*.n32f.client_cert
Path to N32F client certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2-n32f.crt"
Declared by:
sepp2.client.sepp.*.n32f.client_private_key
Path to N32F client private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2-n32f.key"
Declared by:
sepp2.client.sepp.*.n32f.resolve
IP address to resolve the N32F URI to
Type: null or string
Default:
null
Example:
"127.0.2.252"
Declared by:
sepp2.client.sepp.*.n32f.uri
N32F URI
Type: string
Example:
"https://sepp2.localdomain:7777"
Declared by:
sepp2.client.sepp.*.receiver
Receiver domain name
Type: string
Example:
"sepp2.localdomain"
Declared by:
sepp2.client.sepp.*.resolve
IP address to resolve the URI to
Type: null or string
Default:
null
Example:
"127.0.2.251"
Declared by:
sepp2.client.sepp.*.uri
SEPP URI
Type: string
Example:
"https://sepp2.localdomain:7777"
Declared by:
sepp2.default.tls.client.cacert
Path to CA certificate file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/ca.crt"
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.default.tls.client.client_cert
Path to client certificate file
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.crt"
Declared by:
sepp2.default.tls.client.client_private_key
Path to client private key file
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.key"
Declared by:
sepp2.default.tls.client.client_sslkeylogfile
Path to client SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/sepp2-client-sslkeylog.log"
Declared by:
sepp2.default.tls.server.cert
Path to server certificate file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/sepp2.crt"
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.crt"
Declared by:
sepp2.default.tls.server.private_key
Path to server private key file
Type: null or string
Default:
"@sysconfdir@/open5gs/tls/sepp2.key"
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.key"
Declared by:
sepp2.default.tls.server.sslkeylogfile
Path to SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/sepp2-server-sslkeylog.log"
Declared by:
sepp2.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp2.default.tls.server.verify_client_cacert
Path to CA certificate for client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.generated
Path to generated sepp2.yaml
Type: absolute path
Declared by:
sepp2.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
sepp2.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
sepp2.info.port.http
SEPP HTTP port number. Present if SEPP uses non-default HTTP port.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp2.info.port.https
SEPP HTTPS port number. Present if SEPP uses non-default HTTPS port.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8888
Declared by:
sepp2.logger.file.path
Path to the SEPP2 log file.
Type: string
Default:
"/var/log/open5gs/sepp2.log"
Example:
"/var/log/open5gs/sepp2.log"
Declared by:
sepp2.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
sepp2.n32.server
N32 server configuration
Type: list of (submodule)
Default:
[
{
address = "127.0.2.251";
n32f = {
address = "127.0.2.252";
port = 7777;
scheme = "https";
};
port = 7777;
scheme = "https";
sender = "sepp2.localdomain";
}
]
Declared by:
sepp2.n32.server.*.address
N32 server address
Type: null or string
Default:
null
Example:
"127.0.2.251"
Declared by:
sepp2.n32.server.*.cert
Path to N32 server certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.crt"
Declared by:
sepp2.n32.server.*.n32f
N32 forwarding configuration
Type: null or (submodule)
Default:
null
Declared by:
sepp2.n32.server.*.n32f.address
N32 forwarding address
Type: string
Example:
"127.0.2.252"
Declared by:
sepp2.n32.server.*.n32f.cert
Path to N32F certificate
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2-n32f.crt"
Declared by:
sepp2.n32.server.*.n32f.port
N32 forwarding port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp2.n32.server.*.n32f.private_key
Path to N32F private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2-n32f.key"
Declared by:
sepp2.n32.server.*.n32f.scheme
URI scheme for N32 forwarding
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
sepp2.n32.server.*.n32f.verify_client
Enable N32F client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp2.n32.server.*.n32f.verify_client_cacert
Path to CA certificate for N32F client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.n32.server.*.port
N32 server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
sepp2.n32.server.*.private_key
Path to N32 server private key
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/sepp2.key"
Declared by:
sepp2.n32.server.*.scheme
URI scheme for N32 server
Type: null or one of “http”, “https”
Default:
null
Example:
"https"
Declared by:
sepp2.n32.server.*.sender
Sender domain name
Type: string
Example:
"sepp2.localdomain"
Declared by:
sepp2.n32.server.*.verify_client
Enable N32 client certificate verification
Type: null or boolean
Default:
null
Example:
true
Declared by:
sepp2.n32.server.*.verify_client_cacert
Path to CA certificate for N32 client verification
Type: null or string
Default:
null
Example:
"open5gs-unstable/etc/open5gs/tls/ca.crt"
Declared by:
sepp2.sbi.client.nrf
NRF client configuration
Type: null or (list of (submodule))
Default:
null
Declared by:
sepp2.sbi.client.nrf.*.uri
NRF URI
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
sepp2.sbi.client.scp
SCP client configuration
Type: null or (list of (submodule))
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
sepp2.sbi.client.scp.*.uri
SCP URI
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
sepp2.sbi.server
SBI server configuration
Type: list of (submodule)
Default:
[
{
address = "127.0.2.250";
port = 7777;
}
]
Declared by:
sepp2.sbi.server.*.address
SBI server address
Type: string
Example:
"127.0.2.250"
Declared by:
sepp2.sbi.server.*.port
SBI server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
7777
Declared by:
SMF Options
smf.ctf.enabled
CTF (Charging Trigger Function) configuration.
Controls whether charging information is collected:
auto: Automatically determine based on configuration (default)yes: Force enable CTFno: Disable CTF
Type: null or one of “auto”, “yes”, “no”
Default:
null
Example:
"auto"
Declared by:
smf.dns
DNS servers for UE sessions.
List of DNS server addresses that will be provided to user equipment. Supports both IPv4 and IPv6 addresses.
Type: list of string
Default:
[
"8.8.8.8"
"8.8.4.4"
"2001:4860:4860::8888"
"2001:4860:4860::8844"
]
Example:
[
"1.1.1.1"
"1.0.0.1"
]
Declared by:
smf.freeDiameter
Path to freeDiameter configuration file.
freeDiameter is used for Diameter protocol communication, typically for charging and policy control.
Type: string
Default:
"@sysconfdir@/freeDiameter/smf.conf"
Example:
"@sysconfdir@/freeDiameter/smf.conf"
Declared by:
smf.generated
Path to generated config.yaml
Type: absolute path
Declared by:
smf.global.max.peer
Maximum number of peer connections.
This limits the number of simultaneous peer connections the SMF can maintain.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
smf.global.max.ue
Maximum number of User Equipment (UE) connections.
The number of UE can be increased depending on available memory size. Each UE connection consumes system resources, so this should be tuned based on your hardware capabilities.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
smf.gtpc.server.address
GTP-C (GPRS Tunneling Protocol Control) server address.
Used for control plane signaling in the core network.
Type: string
Default:
"127.0.0.4"
Example:
"192.168.0.4"
Declared by:
smf.gtpu.server.address
GTP-U (GPRS Tunneling Protocol User) server address.
Used for user plane data forwarding.
Type: string
Default:
"127.0.0.4"
Example:
"192.168.0.4"
Declared by:
smf.logger.file.path
Path to the SMF log file.
This specifies where the SMF (Session Management Function) will write its logs.
Type: string
Default:
"/var/log/open5gs/smf.log"
Example:
"/var/log/open5gs/smf.log"
Declared by:
smf.logger.level
Log level for the SMF.
Controls the verbosity of logging output:
fatal: Only log fatal errorserror: Log errors and fatal messageswarn: Log warnings, errors, and fatal messagesinfo: Default level, includes informational messagesdebug: Verbose logging for debuggingtrace: Most verbose logging level
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"debug"
Declared by:
smf.metrics.server.address
Metrics server address.
Address where Prometheus-compatible metrics will be exposed.
Type: string
Default:
"127.0.0.4"
Example:
"0.0.0.0"
Declared by:
smf.metrics.server.port
Metrics server port.
Port where Prometheus-compatible metrics will be exposed.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
9090
Example:
9091
Declared by:
smf.mtu
Maximum Transmission Unit (MTU) for UE sessions.
Defines the maximum packet size for user plane traffic. Common values are 1400 (for GTP overhead) or 1500 (standard Ethernet).
Type: positive integer, meaning >0
Default:
1400
Example:
1500
Declared by:
smf.pCscf
P-CSCF (Proxy Call Session Control Function) addresses.
Used for IMS (IP Multimedia Subsystem) services. Leave null if IMS is not deployed.
Type: null or (list of string)
Default:
null
Example:
[
"127.0.0.1"
"::1"
]
Declared by:
smf.pfcp.client.upf
List of UPF (User Plane Function) addresses.
The addresses of the UPFs that this SMF will control via PFCP.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.7";
}
]
Example:
[
{
address = "192.168.0.7";
}
]
Declared by:
smf.pfcp.client.upf.*.address
UPF (User Plane Function) address.
The address of the UPF that this SMF will control via PFCP.
Type: string
Example:
"192.168.0.7"
Declared by:
smf.pfcp.server
Server Addresses
Type: list of (submodule)
Default:
[
{
address = "127.0.0.4";
}
]
Example:
[
{
address = "127.0.0.4";
}
]
Declared by:
smf.pfcp.server.*.address
PFCP (Packet Forwarding Control Protocol) server address.
The address where the SMF’s PFCP server will listen for connections from UPFs.
Type: string
Example:
"127.0.0.4"
Declared by:
smf.sbi.client.nrf.uri
NRF (Network Repository Function) URI.
If specified, the SMF will register with and discover services through the NRF. Leave null to disable direct NRF connection (useful when using SCP).
Type: null or string
Default:
null
Example:
"http://127.0.0.10:7777"
Declared by:
smf.sbi.client.scp.uri
SCP (Service Communication Proxy) URI.
The SMF will route service discovery and communication through this SCP. This is an alternative to direct NRF communication.
Type: string
Default:
"http://127.0.0.200:7777"
Example:
"http://scp.5gc.mnc070.mcc999.3gppnetwork.org:7777"
Declared by:
smf.sbi.server.address
SBI (Service Based Interface) server address.
This is the address where the SMF’s SBI server will listen for connections.
Type: string
Default:
"127.0.0.4"
Example:
"smf.5gc.mnc001.mcc001.3gppnetwork.org"
Declared by:
smf.sbi.server.port
SBI server port.
The port number where the SMF’s SBI server will listen for connections.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
7777
Example:
7777
Declared by:
smf.session
Session configuration for UE IP address allocation.
Defines one or more IP subnets and their gateways for allocating IP addresses to user equipment during PDU session establishment.
Type: list of (submodule)
Default:
[
{
gateway = "10.45.0.1";
subnet = "10.45.0.0/16";
}
{
gateway = "2001:db8:cafe::1";
subnet = "2001:db8:cafe::/48";
}
]
Declared by:
smf.session.*.gateway
Gateway IP address for the session subnet.
This is the gateway address that UE devices will use for the corresponding subnet.
Type: string
Example:
"10.45.0.1"
Declared by:
smf.session.*.subnet
IP subnet for UE sessions.
Defines the IP address range that will be allocated to user equipment. Supports both IPv4 and IPv6 CIDR notation.
Type: string
Example:
"10.45.0.0/16"
Declared by:
UDM Options
udm.default.tls
Default TLS configuration for both server and client.
Type: null or (submodule)
Default:
null
Declared by:
udm.default.tls.client
Client TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
udm.default.tls.client.cacert
Path to CA certificate
Type: string
Example:
"@sysconfdir@/open5gs/tls/ca.crt"
Declared by:
udm.default.tls.client.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/udm.crt"
Declared by:
udm.default.tls.client.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/udm.key"
Declared by:
udm.default.tls.client.scheme
Client scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
udm.default.tls.client.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/udm-client-sslkeylog.log"
Declared by:
udm.default.tls.server
Server TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
udm.default.tls.server.cert
Path to server certificate
Type: string
Example:
"@sysconfdir@/open5gs/tls/udm.crt"
Declared by:
udm.default.tls.server.private_key
Path to server private key
Type: string
Example:
"@sysconfdir@/open5gs/tls/udm.key"
Declared by:
udm.default.tls.server.scheme
Server scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
udm.default.tls.server.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"open5gs-unstable/var/log/open5gs/tls/udm-server-sslkeylog.log"
Declared by:
udm.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Declared by:
udm.default.tls.server.verify_client_cacert
CA certificate for client verification
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/ca.crt"
Declared by:
udm.generated
Path to generated config.yaml
Type: absolute path
Declared by:
udm.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
udm.global.max.ue
Maximum number of User Equipment (UE) connections.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
udm.hnet
Home Network Public Key configuration.
Type: list of (submodule)
Default:
[
{
id = 1;
key = "@sysconfdir@/open5gs/hnet/curve25519-1.key";
scheme = 1;
}
{
id = 2;
key = "@sysconfdir@/open5gs/hnet/secp256r1-2.key";
scheme = 2;
}
{
id = 3;
key = "@sysconfdir@/open5gs/hnet/curve25519-3.key";
scheme = 1;
}
{
id = 4;
key = "@sysconfdir@/open5gs/hnet/secp256r1-4.key";
scheme = 2;
}
{
id = 5;
key = "@sysconfdir@/open5gs/hnet/curve25519-5.key";
scheme = 1;
}
{
id = 6;
key = "@sysconfdir@/open5gs/hnet/secp256r1-6.key";
scheme = 2;
}
]
Declared by:
udm.hnet.*.id
Home network public key identifier (PKI) value.
Type: positive integer, meaning >0
Example:
1
Declared by:
udm.hnet.*.key
Path to the private key file.
Type: string
Example:
"@sysconfdir@/open5gs/hnet/curve25519-1.key"
Declared by:
udm.hnet.*.scheme
Protection scheme identifier.
Type: positive integer, meaning >0
Example:
1
Declared by:
udm.logger.file.path
Path to the UDM log file.
Type: string
Default:
"/var/log/open5gs/udm.log"
Example:
"/var/log/open5gs/udm.log"
Declared by:
udm.logger.level
Log level for the UDM.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
udm.sbi.client.delegated
Delegation configuration for NRF and SCP communication.
Type: null or (submodule)
Default:
null
Declared by:
udm.sbi.client.delegated.nrf
NRF delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
udm.sbi.client.delegated.nrf.disc
Delegate NRF discovery (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
udm.sbi.client.delegated.nrf.nfm
Delegate NRF management functions (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"no"
Declared by:
udm.sbi.client.delegated.scp
SCP delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
udm.sbi.client.delegated.scp.next
Delegate to SCP for next-hop (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
udm.sbi.client.nrf
NRF (Network Repository Function) URIs for direct communication.
Type: null or (list of (submodule))
Default:
null
Declared by:
udm.sbi.client.nrf.*.uri
NRF URI for direct communication
Type: string
Example:
"http://127.0.0.10:7777"
Declared by:
udm.sbi.client.scp
SCP (Service Communication Proxy) URIs for indirect communication.
Type: list of (submodule)
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
udm.sbi.client.scp.*.uri
SCP URI for indirect communication
Type: string
Example:
"http://127.0.0.200:7777"
Declared by:
udm.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.12";
port = 7777;
}
]
Declared by:
udm.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.12"
Declared by:
udm.sbi.server.*.advertise
Advertised address (can include port)
Type: null or string
Default:
null
Example:
"open5gs-udm.svc.local"
Declared by:
udm.sbi.server.*.dev
Network device to bind to
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
udm.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
UDR Options
udr.db_uri
MongoDB database URI for UDR.
Connection string for the MongoDB database where UDR stores subscriber data.
Type: string
Default:
"mongodb://localhost/open5gs"
Example:
"mongodb://mongo.example.com:27017/open5gs"
Declared by:
udr.default.tls
Default TLS configuration for both server and client.
Enables HTTPS scheme with TLS encryption for secure communication.
Type: null or (submodule)
Default:
null
Declared by:
udr.default.tls.client
Client TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
udr.default.tls.client.cacert
Path to CA certificate
Type: string
Example:
"@sysconfdir@/open5gs/tls/ca.crt"
Declared by:
udr.default.tls.client.client_cert
Path to client certificate
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/udr.crt"
Declared by:
udr.default.tls.client.client_private_key
Path to client private key
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/udr.key"
Declared by:
udr.default.tls.client.scheme
Client scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
udr.default.tls.client.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"@localstatedir@/log/open5gs/tls/udr-client-sslkeylog.log"
Declared by:
udr.default.tls.server
Server TLS configuration
Type: null or (submodule)
Default:
null
Declared by:
udr.default.tls.server.cert
Path to server certificate
Type: string
Example:
"@sysconfdir@/open5gs/tls/udr.crt"
Declared by:
udr.default.tls.server.private_key
Path to server private key
Type: string
Example:
"@sysconfdir@/open5gs/tls/udr.key"
Declared by:
udr.default.tls.server.scheme
Server scheme (http/https)
Type: one of “http”, “https”
Default:
"https"
Declared by:
udr.default.tls.server.sslkeylogfile
SSL key log file for Wireshark debugging
Type: null or string
Default:
null
Example:
"@localstatedir@/log/open5gs/tls/udr-server-sslkeylog.log"
Declared by:
udr.default.tls.server.verify_client
Enable client certificate verification
Type: null or boolean
Default:
null
Declared by:
udr.default.tls.server.verify_client_cacert
CA certificate for client verification
Type: null or string
Default:
null
Example:
"@sysconfdir@/open5gs/tls/ca.crt"
Declared by:
udr.generated
Path to generated config.yaml
Type: absolute path
Declared by:
udr.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
udr.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
udr.logger.file.path
Path to the UDR log file.
Type: string
Default:
"/var/log/open5gs/udr.log"
Example:
"/var/log/open5gs/udr.log"
Declared by:
udr.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
udr.sbi.client.delegated
Delegation configuration for NRF and SCP communication.
- If not set: AUTO delegation (all communications delegated to SCP)
- Set explicitly to control which functions are delegated
Type: null or (submodule)
Default:
null
Example:
{
nrf = {
nfm = "no"; # Directly communicate NRF management
disc = "yes"; # Delegate discovery to SCP
};
scp = {
next = "yes"; # Delegate next-hop to SCP
};
}
Declared by:
udr.sbi.client.delegated.nrf
NRF delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
udr.sbi.client.delegated.nrf.disc
Delegate NRF discovery (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
udr.sbi.client.delegated.nrf.nfm
Delegate NRF management functions (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"no"
Declared by:
udr.sbi.client.delegated.scp
SCP delegation configuration
Type: null or (submodule)
Default:
null
Declared by:
udr.sbi.client.delegated.scp.next
Delegate to SCP for next-hop (yes/no)
Type: null or one of “yes”, “no”
Default:
null
Example:
"yes"
Declared by:
udr.sbi.client.nrf
NRF (Network Repository Function) URIs for direct communication.
Type: null or (list of (submodule))
Default:
null
Example:
[{ uri = "http://127.0.0.10:7777"; }]
Declared by:
udr.sbi.client.nrf.*.uri
NRF URI for direct communication
Type: string
Declared by:
udr.sbi.client.scp
SCP (Service Communication Proxy) URIs for indirect communication.
Type: list of (submodule)
Default:
[
{
uri = "http://127.0.0.200:7777";
}
]
Declared by:
udr.sbi.client.scp.*.uri
SCP URI for indirect communication
Type: string
Declared by:
udr.sbi.server
SBI server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.20";
port = 7777;
}
]
Declared by:
udr.sbi.server.*.address
SBI server address
Type: null or string
Default:
null
Example:
"127.0.0.20"
Declared by:
udr.sbi.server.*.advertise
Advertised address (can include port)
Type: null or string
Default:
null
Example:
"open5gs-udr.svc.local"
Declared by:
udr.sbi.server.*.dev
Network device to bind to
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
udr.sbi.server.*.port
SBI server port
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
7777
Declared by:
UPF Options
upf.generated
Path to generated config.yaml
Type: absolute path
Declared by:
upf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
upf.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
upf.gtpu.server
GTP-U server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.7";
}
]
Declared by:
upf.gtpu.server.*.address
GTP-U server address(es)
Type: null or string or list of string
Default:
null
Example:
["127.0.0.7" "::1"]
Declared by:
upf.gtpu.server.*.advertise
Override GTP-U address to be advertised inside S1AP messages
Type: null or string
Default:
null
Example:
"upf1.5gc.mnc001.mcc001.3gppnetwork.org"
Declared by:
upf.gtpu.server.*.dev
Network device for GTP-U server
Type: null or string
Default:
null
Example:
"ens3"
Declared by:
upf.gtpu.server.*.network_instance
Network instance identifier
Type: null or string
Default:
null
Example:
"internet"
Declared by:
upf.gtpu.server.*.source_interface
Source interface (0 = Access, 1 = Core)
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
0
Declared by:
upf.gtpu.server.*.teid_range
TEID range value
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
10
Declared by:
upf.gtpu.server.*.teid_range_indication
TEID range indication for User Plane IP Resource information
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
4
Declared by:
upf.logger.file.path
Path to the UPF log file.
Type: string
Default:
"/var/log/open5gs/upf.log"
Example:
"/var/log/open5gs/upf.log"
Declared by:
upf.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
upf.metrics.server.address
Metrics server address
Type: string
Default:
"127.0.0.7"
Example:
"0.0.0.0"
Declared by:
upf.metrics.server.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
9090
Example:
9091
Declared by:
upf.pfcp.client.smf
UPF PFCP Client tries to associate with these SMF PFCP Servers.
Type: null or (list of (submodule))
Default:
null
Example:
[{ address = "127.0.0.4"; }]
Declared by:
upf.pfcp.client.smf.*.address
SMF address for UPF PFCP client to associate
Type: string
Declared by:
upf.pfcp.server
PFCP server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.7";
}
]
Declared by:
upf.pfcp.server.*.address
PFCP server address
Type: null or string
Default:
null
Example:
"127.0.0.7"
Declared by:
upf.pfcp.server.*.advertise
Override PFCP address to be advertised to SMF
Type: null or string
Default:
null
Example:
"open5gs-upf.svc.local"
Declared by:
upf.pfcp.server.*.dev
Network device for PFCP server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
upf.session
Session configuration for UE IP address allocation.
Configure the corresponding network interfaces before use:
sudo ip addr add 10.45.0.1/16 dev ogstun
sudo ip addr add 2001:db8:cafe::1/48 dev ogstun2
Type: list of (submodule)
Default:
[
{
gateway = "10.45.0.1";
subnet = "10.45.0.0/16";
}
{
gateway = "2001:db8:cafe::1";
subnet = "2001:db8:cafe::/48";
}
]
Declared by:
upf.session.*.dev
Network device/interface name
Type: null or string
Default:
null
Example:
"ogstun2"
Declared by:
upf.session.*.dnn
Data Network Name (DNN/APN)
Type: null or string
Default:
null
Example:
"internet"
Declared by:
upf.session.*.gateway
Gateway IP address
Type: null or string
Default:
null
Example:
"10.45.0.1"
Declared by:
upf.session.*.subnet
IP subnet for UE sessions (CIDR notation)
Type: string
Example:
"10.45.0.0/16"
Declared by:
Open5GS 4G Configuration Options
Browse all available configuration options for Open5GS components:
Components
- 4G Network Functions:
- HSS (Home Subscriber Server) - Configure the HSS component
- MME (Mobility Management Entity) - Configure the MME component
- SGWC (Serving Gateway Control Plane) - Configure the SGWC component
- SGWU (Serving Gateway User Plane) - Configure the SGWU component
Quick Search
Use the Options Search to quickly find specific options across all components.
HSS Options
hss.db_uri
MongoDB connection URI for HSS database.
Type: string
Default:
"mongodb://localhost/open5gs"
Example:
"mongodb://localhost/open5gs"
Declared by:
hss.freeDiameter
Path to freeDiameter configuration file for HSS. Path is relative to the nix store package root.
Type: string
Default:
"@sysconfdir@/freeDiameter/hss.conf"
Example:
"@sysconfdir@/freeDiameter/hss.conf"
Declared by:
hss.generated
Path to generated config.yaml
Type: absolute path
Declared by:
hss.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
hss.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
hss.logger.file.path
Path to the HSS log file.
Type: string
Default:
"/var/log/open5gs/hss.log"
Example:
"/var/log/open5gs/hss.log"
Declared by:
hss.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
hss.metrics.server
Metrics server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.8";
port = 9090;
}
]
Declared by:
hss.metrics.server.*.address
Metrics server address
Type: string
Example:
"127.0.0.8"
Declared by:
hss.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
9090
Declared by:
hss.sms_over_ims
SMS over IMS configuration URI.
Type: null or string
Default:
null
Example:
"sip:smsc.mnc001.mcc001.3gppnetwork.org:7060;transport=tcp"
Declared by:
hss.use_mongodb_change_stream
Enable MongoDB change stream for real-time updates.
Type: null or boolean
Default:
null
Example:
true
Declared by:
MME Options
mme.access_control
Access control configuration
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.access_control.*.default_reject_cause
Default reject cause
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
13
Declared by:
mme.access_control.*.plmn_id
PLMN-specific access control
Type: null or (submodule)
Default:
null
Declared by:
mme.access_control.*.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
999
Declared by:
mme.access_control.*.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
70
Declared by:
mme.access_control.*.plmn_id.reject_cause
Reject cause for this PLMN
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
15
Declared by:
mme.freeDiameter
Path to freeDiameter configuration file for MME.
Type: string
Default:
"@sysconfdir@/freeDiameter/mme.conf"
Example:
"@sysconfdir@/freeDiameter/mme.conf"
Declared by:
mme.generated
Path to generated mme.yaml
Type: absolute path
Declared by:
mme.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
mme.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
mme.gtpc.client.sgsn
SGSN client configuration for 2G/3G interworking.
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.gtpc.client.sgsn.*.address
SGSN address(es)
Type: string or list of string
Example:
["127.0.0.3", "fd69:f21d:873c:fa::2"]
Declared by:
mme.gtpc.client.sgsn.*.default_route
Use as default route if no matching RAI+CI found
Type: null or boolean
Default:
null
Example:
true
Declared by:
mme.gtpc.client.sgsn.*.name
SGSN name
Type: null or string
Default:
null
Example:
"sgsn.open5gs.org"
Declared by:
mme.gtpc.client.sgsn.*.routes
Routing information for SGSN selection
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.gtpc.client.sgsn.*.routes.*.ci
Cell Identity
Type: unsigned integer, meaning >=0
Example:
1223
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai
Routing Area Identification
Type: submodule
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.lai
Location Area Identification
Type: submodule
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.lai.lac
Location Area Code
Type: unsigned integer, meaning >=0
Example:
43690
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.lai.plmn_id
PLMN ID
Type: submodule
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.lai.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.lai.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.gtpc.client.sgsn.*.routes.*.rai.rac
Routing Area Code
Type: unsigned integer, meaning >=0
Example:
187
Declared by:
mme.gtpc.client.sgwc
SGW-C client configuration. MME connects to SGW-C via GTP-C.
Type: null or (list of (submodule))
Default:
[
{
address = "127.0.0.3";
}
]
Example:
[{ address = "127.0.0.3"; }]
Declared by:
mme.gtpc.client.sgwc.*.address
SGW-C address
Type: string
Example:
"127.0.0.3"
Declared by:
mme.gtpc.client.sgwc.*.e_cell_id
E-UTRAN Cell ID(s) for SGW-C selection (hex, 28bit)
Type: null or string or list of string
Default:
null
Example:
["abcde01", "12345"]
Declared by:
mme.gtpc.client.sgwc.*.tac
Tracking Area Code(s) for SGW-C selection (decimal)
Type: null or unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Default:
null
Example:
[26000, 27000]
Declared by:
mme.gtpc.client.smf
SMF client configuration for interworking with 5G core.
Type: null or (list of (submodule))
Default:
[
{
address = "127.0.0.4";
}
]
Example:
[{ address = "127.0.0.4"; }]
Declared by:
mme.gtpc.client.smf.*.address
SMF address
Type: string
Example:
"127.0.0.4"
Declared by:
mme.gtpc.client.smf.*.apn
APN for SMF selection
Type: null or string
Default:
null
Example:
"internet"
Declared by:
mme.gtpc.client.smf.*.e_cell_id
E-UTRAN Cell ID(s) for SMF selection (hex, 28bit)
Type: null or string or list of string
Default:
null
Example:
["abcde01", "12345"]
Declared by:
mme.gtpc.client.smf.*.tac
Tracking Area Code(s) for SMF selection (decimal)
Type: null or unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Default:
null
Example:
[26000, 27000]
Declared by:
mme.gtpc.server
GTP-C server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.2";
}
]
Declared by:
mme.gtpc.server.*.address
GTP-C server address
Type: null or string
Default:
null
Example:
"127.0.0.2"
Declared by:
mme.gtpc.server.*.dev
Network device for GTP-C server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
mme.gummei
Globally Unique MME Identity (GUMMEI) configuration.
Type: submodule
Default:
{
mme_code = 1;
mme_gid = 2;
plmn_id = {
mcc = 999;
mnc = 70;
};
}
Declared by:
mme.gummei.mme_code
MME Code(s)
Type: unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Example:
1
Declared by:
mme.gummei.mme_gid
MME Group ID(s)
Type: unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Example:
2
Declared by:
mme.gummei.plmn_id
PLMN ID(s)
Type: (submodule) or list of (submodule)
Declared by:
mme.hss_map
HSS selection mapping by PLMN
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.hss_map.*.host
HSS host
Type: null or string
Default:
null
Example:
"hss.localdomain"
Declared by:
mme.hss_map.*.plmn_id
PLMN ID
Type: submodule
Declared by:
mme.hss_map.*.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
999
Declared by:
mme.hss_map.*.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
70
Declared by:
mme.hss_map.*.realm
HSS realm (auto-generated from PLMN if not provided)
Type: null or string
Default:
null
Example:
"localdomain"
Declared by:
mme.logger.file.path
Path to the MME log file.
Type: string
Default:
"/var/log/open5gs/mme.log"
Example:
"/var/log/open5gs/mme.log"
Declared by:
mme.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
mme.metrics.server
Metrics server configuration
Type: list of (submodule)
Default:
[
{
address = "127.0.0.2";
port = 9090;
}
]
Declared by:
mme.metrics.server.*.address
Metrics server address
Type: string
Example:
"127.0.0.2"
Declared by:
mme.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
9090
Declared by:
mme.mme_name
MME name
Type: string
Default:
"open5gs-mme0"
Example:
"mme1"
Declared by:
mme.network_name.full
Full network name
Type: string
Default:
"Open5GS"
Example:
"My Network"
Declared by:
mme.network_name.short
Short network name
Type: string
Default:
"Next"
Example:
"MyNet"
Declared by:
mme.relative_capacity
Relative capacity for load balancing
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
100
Declared by:
mme.s1ap.server
S1AP server configuration for eNodeB connections.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.2";
}
]
Declared by:
mme.s1ap.server.*.address
S1AP server address
Type: null or string
Default:
null
Example:
"127.0.0.2"
Declared by:
mme.s1ap.server.*.dev
Network device for S1AP server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
mme.security.ciphering_order
NAS ciphering algorithm preference order.
Type: list of (one of “EEA0”, “EEA1”, “EEA2”, “EEA3”)
Default:
[
"EEA0"
"EEA1"
"EEA2"
]
Declared by:
mme.security.integrity_order
NAS integrity protection algorithm preference order.
Type: list of (one of “EIA0”, “EIA1”, “EIA2”, “EIA3”)
Default:
[
"EIA2"
"EIA1"
"EIA0"
]
Declared by:
mme.sgsap.client
SGs Application Part (SGsAP) client for MSC/VLR connection.
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.sgsap.client.*.address
MSC/VLR SCTP server address(es)
Type: string or list of string
Example:
["127.0.0.88", "10.0.0.88"]
Declared by:
mme.sgsap.client.*.local_address
Local SCTP address(es) to bind in MME
Type: null or string or list of string
Default:
null
Example:
["127.0.0.2", "192.168.1.4"]
Declared by:
mme.sgsap.client.*.map
TAI to LAI mapping
Type: null or (list of (submodule))
Default:
null
Declared by:
mme.sgsap.client.*.map.*.lai
Location Area Identity
Type: submodule
Declared by:
mme.sgsap.client.*.map.*.lai.lac
Location Area Code
Type: unsigned integer, meaning >=0
Example:
43691
Declared by:
mme.sgsap.client.*.map.*.lai.plmn_id
PLMN ID
Type: submodule
Declared by:
mme.sgsap.client.*.map.*.lai.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.sgsap.client.*.map.*.lai.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.sgsap.client.*.map.*.tai
Tracking Area Identity
Type: submodule
Declared by:
mme.sgsap.client.*.map.*.tai.plmn_id
PLMN ID
Type: submodule
Declared by:
mme.sgsap.client.*.map.*.tai.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.sgsap.client.*.map.*.tai.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
1
Declared by:
mme.sgsap.client.*.map.*.tai.tac
Tracking Area Code
Type: unsigned integer, meaning >=0
Example:
4131
Declared by:
mme.tai
Tracking Area Identity (TAI) configuration.
Type: submodule
Default:
{
plmn_id = {
mcc = 999;
mnc = 70;
};
tac = 1;
}
Declared by:
mme.tai.plmn_id
PLMN ID
Type: submodule
Declared by:
mme.tai.plmn_id.mcc
Mobile Country Code
Type: unsigned integer, meaning >=0
Example:
999
Declared by:
mme.tai.plmn_id.mnc
Mobile Network Code
Type: unsigned integer, meaning >=0
Example:
70
Declared by:
mme.tai.tac
Tracking Area Code(s)
Type: unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Example:
1
Declared by:
mme.time.t3402.value
T3402 timer value in seconds (Periodic TAU)
Type: null or (positive integer, meaning >0)
Default:
null
Example:
720
Declared by:
mme.time.t3412.value
T3412 timer value in seconds (Periodic TAU)
Type: null or (positive integer, meaning >0)
Default:
null
Example:
3240
Declared by:
mme.time.t3423.value
T3423 timer value in seconds
Type: null or (positive integer, meaning >0)
Default:
null
Example:
720
Declared by:
SGWC Options
sgwc.generated
Path to generated sgwc.yaml
Type: absolute path
Declared by:
sgwc.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
sgwc.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
sgwc.gtpc.server
GTP-C server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.3";
}
]
Declared by:
sgwc.gtpc.server.*.address
GTP-C server address
Type: null or string
Default:
null
Example:
"127.0.0.3"
Declared by:
sgwc.gtpc.server.*.dev
Network device for GTP-C server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
sgwc.logger.file.path
Path to the SGW-C log file.
Type: string
Default:
"/var/log/open5gs/sgwc.log"
Example:
"/var/log/open5gs/sgwc.log"
Declared by:
sgwc.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
sgwc.pfcp.client.sgwu
SGW-U client configuration. SGW-C tries to associate with these SGW-U PFCP servers.
Type: null or (list of (submodule))
Default:
[
{
address = "127.0.0.6";
}
]
Example:
[{ address = "127.0.0.6"; }]
Declared by:
sgwc.pfcp.client.sgwu.*.address
SGW-U address
Type: string
Example:
"127.0.0.6"
Declared by:
sgwc.pfcp.client.sgwu.*.apn
APN(s) for SGW-U selection
Type: null or string or list of string
Default:
null
Example:
["ims", "internet", "web"]
Declared by:
sgwc.pfcp.client.sgwu.*.e_cell_id
E-UTRAN Cell ID(s) for SGW-U selection (hex, 28bit)
Type: null or string or list of string
Default:
null
Example:
["463", "123456789", "9413"]
Declared by:
sgwc.pfcp.client.sgwu.*.tac
Tracking Area Code(s) for SGW-U selection (decimal)
Type: null or unsigned integer, meaning >=0, or (list of (unsigned integer, meaning >=0))
Default:
null
Example:
[1, 3, 5, 8]
Declared by:
sgwc.pfcp.server
PFCP server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.3";
}
]
Declared by:
sgwc.pfcp.server.*.address
PFCP server address
Type: null or string
Default:
null
Example:
"127.0.0.3"
Declared by:
sgwc.pfcp.server.*.advertise
Override PFCP address to be advertised to SGW-U
Type: null or string
Default:
null
Example:
"open5gs-sgwc.svc.local"
Declared by:
sgwc.pfcp.server.*.dev
Network device for PFCP server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
SGWU Options
sgwu.generated
Path to generated sgwu.yaml
Type: absolute path
Declared by:
sgwu.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
sgwu.global.max.ue
Maximum number of UE connections. Can be increased depending on memory size.
Type: positive integer, meaning >0
Default:
1024
Example:
2048
Declared by:
sgwu.gtpu.server
GTP-U server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.6";
}
]
Declared by:
sgwu.gtpu.server.*.address
GTP-U server address(es)
Type: null or string or list of string
Default:
null
Example:
["127.0.0.6", "127.0.10.4"]
Declared by:
sgwu.gtpu.server.*.advertise
Override SGW-U GTP-U address to be advertised inside S1AP messages
Type: null or string
Default:
null
Example:
"sgw1.epc.mnc001.mcc001.3gppnetwork.org"
Declared by:
sgwu.gtpu.server.*.dev
Network device for GTP-U server
Type: null or string
Default:
null
Example:
"ens3"
Declared by:
sgwu.gtpu.server.*.network_instance
Network instance identifier
Type: null or string
Default:
null
Example:
"internet"
Declared by:
sgwu.gtpu.server.*.source_interface
Source interface (0 = Access, 1 = Core)
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
0
Declared by:
sgwu.gtpu.server.*.teid_range
TEID range value
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
10
Declared by:
sgwu.gtpu.server.*.teid_range_indication
TEID range indication for User Plane IP Resource information
Type: null or (unsigned integer, meaning >=0)
Default:
null
Example:
4
Declared by:
sgwu.logger.file.path
Path to the SGW-U log file.
Type: string
Default:
"/var/log/open5gs/sgwu.log"
Example:
"/var/log/open5gs/sgwu.log"
Declared by:
sgwu.logger.level
Log level: fatal, error, warn, info (default), debug, or trace.
Type: null or one of “fatal”, “error”, “warn”, “info”, “debug”, “trace”
Default:
null
Example:
"info"
Declared by:
sgwu.pfcp.client.sgwc
SGW-U PFCP Client tries to associate with these SGW-C PFCP Servers.
Type: null or (list of (submodule))
Default:
null
Example:
[{ address = "127.0.0.3"; }]
Declared by:
sgwu.pfcp.client.sgwc.*.address
SGW-C address for SGW-U PFCP client to associate
Type: string
Example:
"127.0.0.3"
Declared by:
sgwu.pfcp.server
PFCP server configuration.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.6";
}
]
Declared by:
sgwu.pfcp.server.*.address
PFCP server address
Type: null or string
Default:
null
Example:
"127.0.0.6"
Declared by:
sgwu.pfcp.server.*.advertise
Override PFCP address to be advertised to SGW-C
Type: null or string
Default:
null
Example:
"open5gs-sgwu.svc.local"
Declared by:
sgwu.pfcp.server.*.dev
Network device for PFCP server
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
OpenAirInterface Configuration Options
Browse OpenAirInterface core configuration options.
Shared Options
Network Functions
- AMF Options
- AUSF Options
- LMF Options
- NRF Options
- NSSF Options
- PCF Options
- SMF Options
- UDM Options
- UDR Options
- UPF Options
Common Options
oai.common.amf.amf_name
AMF name
Type: string
Default:
"OAI-AMF"
Example:
"OAI-AMF"
Declared by:
oai.common.amf.emergency_support
Emergency support flag
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.amf.pid_directory
PID directory path
Type: null or string
Default:
"/var/run"
Example:
"/var/run"
Declared by:
oai.common.amf.plmn_support_list
PLMN support list with TAC and NSSAI
Type: list of (submodule)
Default:
[
{
mcc = "208";
mnc = "95";
nssai = [
{
sst = 1;
}
{
sd = 1;
sst = 1;
}
{
sd = 123;
sst = 222;
}
];
tac = 40960;
}
]
Declared by:
oai.common.amf.plmn_support_list.*.mcc
Mobile Country Code
Type: string
Example:
"208"
Declared by:
oai.common.amf.plmn_support_list.*.mnc
Mobile Network Code
Type: string
Example:
"95"
Declared by:
oai.common.amf.plmn_support_list.*.nssai
Network Slice Selection Assistance Information
Type: list of (submodule)
Example:
[
{
sst = 1;
}
{
sd = "000001";
sst = 1;
}
]
Declared by:
oai.common.amf.plmn_support_list.*.nssai.*.sd
Slice Differentiator (hex string, optional)
Type: null or signed integer or string
Default:
null
Example:
"000001"
Declared by:
oai.common.amf.plmn_support_list.*.nssai.*.sst
Slice/Service Type
Type: signed integer
Example:
1
Declared by:
oai.common.amf.plmn_support_list.*.tac
Tracking Area Code (can be hex with 0x prefix)
Type: signed integer or string
Example:
"0xa000"
Declared by:
oai.common.amf.relative_capacity
AMF relative capacity
Type: signed integer
Default:
30
Example:
30
Declared by:
oai.common.amf.served_guami_list
List of GUAMIs served by this AMF
Type: list of (submodule)
Default:
[
{
amf_pointer = 1;
amf_region_id = 128;
amf_set_id = 1;
mcc = "208";
mnc = "95";
}
{
amf_pointer = 1;
amf_region_id = 10;
amf_set_id = 1;
mcc = "460";
mnc = "11";
}
]
Example:
[
{
amf_pointer = "01";
amf_region_id = "01";
amf_set_id = "001";
mcc = "208";
mnc = "95";
}
]
Declared by:
oai.common.amf.served_guami_list.*.amf_pointer
AMF Pointer
Type: signed integer or string
Example:
"01"
Declared by:
oai.common.amf.served_guami_list.*.amf_region_id
AMF Region ID
Type: signed integer or string
Example:
"01"
Declared by:
oai.common.amf.served_guami_list.*.amf_set_id
AMF Set ID
Type: signed integer or string
Example:
"001"
Declared by:
oai.common.amf.served_guami_list.*.mcc
Mobile Country Code
Type: string
Example:
"208"
Declared by:
oai.common.amf.served_guami_list.*.mnc
Mobile Network Code
Type: string
Example:
"95"
Declared by:
oai.common.amf.statistics_timer_interval
Statistics timer interval in seconds
Type: signed integer
Default:
20
Example:
20
Declared by:
oai.common.amf.support_features_options.enable_advanced_features
Enable advanced features such as SUCI support, SMF Selection Subscription Data Retrieval, UE Context in SMF Data Retrieval, AMF Registration for 3GPP Access
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.amf.support_features_options.enable_nssf
Enable NSSF support
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.amf.support_features_options.enable_simple_scenario
Enable minimalist deployment scenario (AMF/SMF/UPF only). Set to true to use internal AUSF/UDM inside AMF without NRF.
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.amf.support_features_options.enable_smf_selection
Enable SMF selection capability
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.amf.supported_encryption_algorithms
List of supported encryption algorithms
Type: list of string
Default:
[
"NEA0"
"NEA1"
"NEA2"
]
Example:
[
"NEA0"
"NEA1"
"NEA2"
]
Declared by:
oai.common.amf.supported_integrity_algorithms
List of supported integrity algorithms
Type: list of string
Default:
[
"NIA0"
"NIA1"
"NIA2"
]
Example:
[
"NIA0"
"NIA1"
"NIA2"
]
Declared by:
oai.common.database.connection_timeout
Database connection timeout in seconds
Type: signed integer
Default:
300
Example:
300
Declared by:
oai.common.database.database_name
Database name
Type: string
Default:
"oai_db"
Example:
"oai_db"
Declared by:
oai.common.database.generate_random
Generate random data for testing
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.database.host
Database host
Type: string
Default:
"mysql"
Example:
"mysql"
Declared by:
oai.common.database.password
Database password
Type: string
Default:
"test"
Example:
"test"
Declared by:
oai.common.database.type
Database type
Type: string
Default:
"mysql"
Example:
"mysql"
Declared by:
oai.common.database.user
Database user
Type: string
Default:
"test"
Example:
"test"
Declared by:
oai.common.dnns
DNN configuration list
Type: list of (submodule)
Default:
[
{
dnn = "oai";
ipv4_pool = "12.1.1.151 - 12.1.1.253";
ipv4_subnet = "12.1.1.128/25";
pdu_session_type = "IPV4";
}
{
dnn = "oai.ipv4";
ipv4_pool = "12.1.1.51 - 12.1.1.150";
ipv4_subnet = "12.1.1.64/26";
pdu_session_type = "IPV4";
}
{
dnn = "default";
ipv4_pool = "12.1.1.2 - 12.1.1.50";
ipv4_subnet = "12.1.1.0/26";
pdu_session_type = "IPV4";
}
{
dnn = "ims";
ipv4_pool = "14.1.1.2 - 14.1.1.253";
ipv4_subnet = "14.1.1.0/24";
pdu_session_type = "IPV4V6";
}
]
Declared by:
oai.common.dnns.*.dnn
Data Network Name
Type: string
Example:
"oai"
Declared by:
oai.common.dnns.*.ipv4_pool
IPv4 address pool range (used in AMF configs)
Type: null or string
Default:
null
Example:
"12.1.1.151 - 12.1.1.253"
Declared by:
oai.common.dnns.*.ipv4_subnet
IPv4 subnet in CIDR notation (used in UPF/SMF configs)
Type: null or string
Default:
null
Example:
"12.1.1.128/25"
Declared by:
oai.common.dnns.*.pdu_session_type
PDU session type (IPV4, IPV6, IPV4V6)
Type: string
Example:
"IPV4"
Declared by:
oai.common.http_request_timeout
HTTP request timeout in milliseconds
Type: signed integer
Default:
5000
Example:
5000
Declared by:
oai.common.http_version
HTTP version for SBI interfaces
Type: signed integer
Default:
2
Example:
2
Declared by:
oai.common.lmf.gnb_id_bits_count
Number of bits used for gNB ID
Type: signed integer
Default:
28
Example:
28
Declared by:
oai.common.lmf.http_threads_count
Number of HTTP worker threads for LMF
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.lmf.measurement_wait_ms
Timeout in milliseconds to wait for measurement response
Type: signed integer
Default:
10000
Example:
10000
Declared by:
oai.common.lmf.num_gnb
Number of gNBs for positioning
Type: signed integer
Default:
1
Example:
1
Declared by:
oai.common.lmf.positioning_wait_ms
Timeout in milliseconds to wait for positioning response
Type: signed integer
Default:
10000
Example:
10000
Declared by:
oai.common.lmf.support_features.determine_num_gnb
Automatically determine number of gNBs
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.lmf.support_features.request_trp_info
Enable TRP (Transmission Reception Point) info request
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.lmf.trp_info_wait_ms
Timeout in milliseconds to wait for TRP info response
Type: signed integer
Default:
10000
Example:
10000
Declared by:
oai.common.log_level.general
Log level for all network functions
Type: one of “trace”, “debug”, “info”, “warn”, “error”, “fatal”
Default:
"debug"
Example:
"debug"
Declared by:
oai.common.nfs.amf.host
AMF hostname
Type: string
Default:
"oai-amf"
Declared by:
oai.common.nfs.amf.n2.interface_name
AMF N2 interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.amf.n2.port
AMF N2 port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
38412
Declared by:
oai.common.nfs.amf.sbi.api_version
AMF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.amf.sbi.interface_name
AMF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.amf.sbi.port
AMF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.ausf.host
AUSF hostname
Type: string
Default:
"oai-ausf"
Declared by:
oai.common.nfs.ausf.sbi.api_version
AUSF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.ausf.sbi.interface_name
AUSF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.ausf.sbi.port
AUSF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.lmf.host
LMF hostname
Type: string
Default:
"oai-lmf"
Declared by:
oai.common.nfs.lmf.sbi.api_version
LMF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.lmf.sbi.interface_name
LMF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.lmf.sbi.port
LMF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.nrf.host
NRF hostname
Type: string
Default:
"oai-nrf"
Declared by:
oai.common.nfs.nrf.sbi.api_version
NRF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.nrf.sbi.interface_name
NRF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.nrf.sbi.port
NRF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.nssf.host
NSSF hostname
Type: string
Default:
"oai-nssf"
Declared by:
oai.common.nfs.nssf.sbi.api_version
NSSF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.nssf.sbi.interface_name
NSSF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.nssf.sbi.port
NSSF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.pcf.host
PCF hostname
Type: string
Default:
"oai-pcf"
Declared by:
oai.common.nfs.pcf.sbi.api_version
PCF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.pcf.sbi.interface_name
PCF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.pcf.sbi.port
PCF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.smf.host
SMF hostname
Type: string
Default:
"oai-smf"
Declared by:
oai.common.nfs.smf.n4.interface_name
SMF N4 interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.smf.n4.port
SMF N4 port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8805
Declared by:
oai.common.nfs.smf.sbi.api_version
SMF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.smf.sbi.interface_name
SMF SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.smf.sbi.port
SMF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.udm.host
UDM hostname
Type: string
Default:
"oai-udm"
Declared by:
oai.common.nfs.udm.sbi.api_version
UDM SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.udm.sbi.interface_name
UDM SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.udm.sbi.port
UDM SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.udr.host
UDR hostname
Type: string
Default:
"oai-udr"
Declared by:
oai.common.nfs.udr.sbi.api_version
UDR SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.udr.sbi.interface_name
UDR SBI interface name
Type: string
Default:
"eth0"
Declared by:
oai.common.nfs.udr.sbi.port
UDR SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nfs.upf.host
UPF hostname
Type: string
Default:
"oai-upf"
Declared by:
oai.common.nfs.upf.n3.interface_name
UPF N3 interface name
Type: string
Default:
"demo-n3"
Declared by:
oai.common.nfs.upf.n3.port
UPF N3 port (GTP-U)
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
2152
Declared by:
oai.common.nfs.upf.n4.interface_name
UPF N4 interface name
Type: string
Default:
"demo-oai"
Declared by:
oai.common.nfs.upf.n4.port
UPF N4 port (PFCP)
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8805
Declared by:
oai.common.nfs.upf.n6.interface_name
UPF N6 interface name (Data Network)
Type: string
Default:
"demo-n6"
Declared by:
oai.common.nfs.upf.n9.interface_name
UPF N9 interface name (inter-UPF)
Type: string
Default:
"demo-n9"
Declared by:
oai.common.nfs.upf.n9.port
UPF N9 port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
2152
Declared by:
oai.common.nfs.upf.sbi.api_version
UPF SBI API version
Type: string
Default:
"v1"
Declared by:
oai.common.nfs.upf.sbi.interface_name
UPF SBI interface name
Type: string
Default:
"demo-oai"
Declared by:
oai.common.nfs.upf.sbi.port
UPF SBI port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8080
Declared by:
oai.common.nrf.heartbeat
NRF heartbeat interval in seconds
Type: signed integer
Default:
10
Example:
10
Declared by:
oai.common.nrf.suspended_nf_interval
Suspended NF cleanup interval in seconds
Type: signed integer
Default:
20
Example:
20
Declared by:
oai.common.nssf.slice_config_path
Path to NSSF slice configuration file
Type: string
Default:
"/openair-nssf/etc/nssf_slice_config.yaml"
Example:
"/openair-nssf/etc/nssf_slice_config.yaml"
Declared by:
oai.common.pcf.enable_policy_provisioning_api
Use database instead of YAML, enables dynamic PCC rule creation via API
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.pcf.local_policy.pcc_rules_path
Path to PCC rules directory
Type: string
Default:
"/openair-pcf/policies/pcc_rules"
Example:
"/openair-pcf/policies/pcc_rules"
Declared by:
oai.common.pcf.local_policy.policy_decisions_path
Path to policy decisions directory
Type: string
Default:
"/openair-pcf/policies/policy_decisions"
Example:
"/openair-pcf/policies/policy_decisions"
Declared by:
oai.common.pcf.local_policy.qos_data_path
Path to QoS data directory
Type: string
Default:
"/openair-pcf/policies/qos_data"
Example:
"/openair-pcf/policies/qos_data"
Declared by:
oai.common.pcf.local_policy.traffic_rules_path
Path to traffic rules directory
Type: string
Default:
"/openair-pcf/policies/traffic_rules"
Example:
"/openair-pcf/policies/traffic_rules"
Declared by:
oai.common.register_nf.general
If enabled, NFs will use NRF discovery mechanism
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.smf.ims.pcscf_ipv4
P-CSCF IPv4 address for IMS
Type: string
Default:
"127.0.0.1"
Example:
"127.0.0.1"
Declared by:
oai.common.smf.ims.pcscf_ipv6
P-CSCF IPv6 address for IMS
Type: string
Default:
"fe80::7915:f408:1787:db8b"
Example:
"fe80::7915:f408:1787:db8b"
Declared by:
oai.common.smf.local_subscription_infos
Local subscription information list
Type: list of (submodule)
Default:
[
{
dnn = "oai";
qos_profile = {
"5qi" = 9;
session_ambr_dl = "400Mbps";
session_ambr_ul = "200Mbps";
};
single_nssai = {
sd = null;
sst = 1;
};
}
{
dnn = "oai.ipv4";
qos_profile = {
"5qi" = 9;
session_ambr_dl = "200Mbps";
session_ambr_ul = "100Mbps";
};
single_nssai = {
sd = 1;
sst = 1;
};
}
{
dnn = "default";
qos_profile = {
"5qi" = 9;
session_ambr_dl = "100Mbps";
session_ambr_ul = "50Mbps";
};
single_nssai = {
sd = 123;
sst = 222;
};
}
]
Declared by:
oai.common.smf.local_subscription_infos.*.dnn
Data Network Name
Type: string
Example:
"oai"
Declared by:
oai.common.smf.local_subscription_infos.*.qos_profile.“5qi”
5G QoS Identifier
Type: signed integer
Example:
9
Declared by:
oai.common.smf.local_subscription_infos.*.qos_profile.session_ambr_dl
Session AMBR downlink
Type: string
Example:
"400Mbps"
Declared by:
oai.common.smf.local_subscription_infos.*.qos_profile.session_ambr_ul
Session AMBR uplink
Type: string
Example:
"200Mbps"
Declared by:
oai.common.smf.local_subscription_infos.*.single_nssai.sd
Slice Differentiator (optional)
Type: null or signed integer or string
Default:
null
Example:
1
Declared by:
oai.common.smf.local_subscription_infos.*.single_nssai.sst
Slice/Service Type
Type: signed integer
Example:
1
Declared by:
oai.common.smf.ngap.send_default_qos_characteristics
Send default QoS characteristics via NGAP
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.smf.support_features.use_local_pcc_rules
Use local PCC rules instead of PCF
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.smf.support_features.use_local_subscription_info
Use local subscription info instead of UDM
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.smf.ue_dns.primary_ipv4
Primary IPv4 DNS server for UE
Type: string
Default:
"172.21.3.100"
Example:
"172.21.3.100"
Declared by:
oai.common.smf.ue_dns.primary_ipv6
Primary IPv6 DNS server for UE
Type: string
Default:
"2001:4860:4860::8888"
Example:
"2001:4860:4860::8888"
Declared by:
oai.common.smf.ue_dns.secondary_ipv4
Secondary IPv4 DNS server for UE
Type: string
Default:
"8.8.8.8"
Example:
"8.8.8.8"
Declared by:
oai.common.smf.ue_dns.secondary_ipv6
Secondary IPv6 DNS server for UE
Type: string
Default:
"2001:4860:4860::8888"
Example:
"2001:4860:4860::8888"
Declared by:
oai.common.smf.ue_mtu
UE MTU size
Type: signed integer
Default:
1500
Example:
1500
Declared by:
oai.common.smf.upfs
List of UPFs configured for SMF
Type: list of (submodule)
Default:
[
{
config = {
enable_qers = false;
enable_upf_wo_nf_discovery = false;
enable_usage_reporting = false;
};
host = "oai-spgwu";
}
]
Declared by:
oai.common.smf.upfs.*.config.enable_qers
Enable QoS Enforcement Rules (QER)
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.smf.upfs.*.config.enable_upf_wo_nf_discovery
Enable UPF without NF discovery (SMF will initiate PFCP association)
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.smf.upfs.*.config.enable_usage_reporting
Enable usage reporting
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.smf.upfs.*.host
UPF hostname
Type: string
Example:
"oai-spgwu"
Declared by:
oai.common.snssais
Network Slice Selection Assistance Information (YAML anchors for UPF/SMF/LMF)
Type: list of (submodule)
Default:
[
{
sst = 1;
}
{
sd = 1;
sst = 1;
}
{
sd = "00007B";
sst = 222;
}
]
Declared by:
oai.common.snssais.*.sd
Slice Differentiator (hex string, optional)
Type: null or signed integer or string
Default:
null
Example:
"000001"
Declared by:
oai.common.snssais.*.sst
Slice/Service Type
Type: signed integer
Example:
1
Declared by:
oai.common.udm.subscriber_profiles
UDM subscriber encryption profiles from 3GPP TS 33.501
Type: list of (submodule)
Default:
[
{
home_network_private_key = "c53c22208b61860b06c62e5406a7b330c2b577aa5558981510d128247d38bd1d";
home_network_public_key = "5a8d38864820197c3394b92613b20b91633cbd897119273bf8e4a6f4eec0a650";
home_network_public_key_id = 1;
protection_scheme = 1;
}
{
home_network_private_key = "F1AB1074477EBCC7F554EA1C5FC368B1616730155E0041AC447D6301975FECDA";
home_network_public_key = "0472DA71976234CE833A6907425867B82E074D44EF907DFB4B3E21C1C2256EBCD15A7DED52FCBB097A4ED250E036C7B9C8C7004C4EEDC4F068CD7BF8D3F900E3B4";
home_network_public_key_id = 2;
protection_scheme = 2;
}
]
Declared by:
oai.common.udm.subscriber_profiles.*.home_network_private_key
Home Network Private Key for ECIES
Type: string
Example:
"c53c22208b61860b06c62e5406a7b330c2b577aa5558981510d128247d38bd1d"
Declared by:
oai.common.udm.subscriber_profiles.*.home_network_public_key
Home Network Public Key for ECIES
Type: string
Example:
"5a8d38864820197c3394b92613b20b91633cbd897119273bf8e4a6f4eec0a650"
Declared by:
oai.common.udm.subscriber_profiles.*.home_network_public_key_id
Home Network Public Key Identifier for ECIES
Type: signed integer
Example:
1
Declared by:
oai.common.udm.subscriber_profiles.*.protection_scheme
Protection Scheme ID: 0 for Null-scheme, 1 for Profile A, 2 for Profile B
Type: signed integer
Example:
1
Declared by:
oai.common.upf.datapath_configuration.max_application_ids_per_session
Maximum Application IDs per session
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.upf.datapath_configuration.max_arp_entries
Maximum ARP/Neighbor Discovery entries
Type: signed integer
Default:
256
Example:
256
Declared by:
oai.common.upf.datapath_configuration.max_bars_per_pdu_session
Maximum BARs (Buffering Action Rules) per PDU session
Type: signed integer
Default:
2
Example:
2
Declared by:
oai.common.upf.datapath_configuration.max_ethernet_packet_filters_per_session
Maximum Ethernet packet filters per session
Type: signed integer
Default:
4
Example:
4
Declared by:
oai.common.upf.datapath_configuration.max_fars_per_pdu_session
Maximum FARs (Forwarding Action Rules) per PDU session
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.upf.datapath_configuration.max_pdrs_per_pdu_session
Maximum PDRs (Packet Detection Rules) per PDU session
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.upf.datapath_configuration.max_pdu_sessions
Maximum concurrent PFCP sessions (PDU sessions)
Type: signed integer
Default:
100
Example:
100
Declared by:
oai.common.upf.datapath_configuration.max_qers_per_pdu_session
Maximum QERs (QoS Enforcement Rules) per PDU session
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.upf.datapath_configuration.max_redundant_transmission_params_per_session
Maximum redundant transmission parameters per session (URLLC)
Type: unsigned integer, meaning >=0
Default:
0
Example:
0
Declared by:
oai.common.upf.datapath_configuration.max_sdf_filter_string_length
Maximum string length for SDF filter descriptions (bytes)
Type: signed integer
Default:
512
Example:
512
Declared by:
oai.common.upf.datapath_configuration.max_sdf_filters_per_pdu_session
Maximum SDF (Service Data Flow) filters per PDU session
Type: signed integer
Default:
8
Example:
8
Declared by:
oai.common.upf.datapath_configuration.max_traffic_endpoints_per_session
Maximum Traffic Endpoints per session (multi-access)
Type: signed integer
Default:
2
Example:
2
Declared by:
oai.common.upf.datapath_configuration.max_upf_interfaces
Maximum network interfaces UPF can manage
Type: signed integer
Default:
4
Example:
4
Declared by:
oai.common.upf.datapath_configuration.max_upf_redirect_interfaces
Maximum interfaces for traffic redirection
Type: signed integer
Default:
2
Example:
2
Declared by:
oai.common.upf.datapath_configuration.max_urrs_per_pdu_session
Maximum URRs (Usage Reporting Rules) per PDU session
Type: signed integer
Default:
4
Example:
4
Declared by:
oai.common.upf.remote_n6_gw
Remote N6 gateway (Data Network gateway) for ARP resolution
Type: string
Default:
"oai-ext-dn"
Example:
"oai-ext-dn"
Declared by:
oai.common.upf.support_features.enable_bar
Enable Buffering Action Rules (BAR) - not implemented yet
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.support_features.enable_bpf_datapath
Use eBPF/XDP for high-performance packet processing
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.upf.support_features.enable_eth_pdu
Enable Ethernet PDU Sessions (Layer 2 support)
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.support_features.enable_fr
Enable Framed Routing (route traffic based on UE IP pools)
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.support_features.enable_mar
Enable Multi-Access Rules (MAR) - not implemented yet
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.support_features.enable_qos
Enable QoS Enforcement Rules (QER) using TC-BPF
Type: boolean
Default:
true
Example:
true
Declared by:
oai.common.upf.support_features.enable_snat
Enable Source NAT (translate UE IP to N6 interface IP)
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.support_features.enable_urr
Enable Usage Reporting Rules (URR) - not implemented yet
Type: boolean
Default:
false
Example:
false
Declared by:
oai.common.upf.upf_info.sNssaiUpfInfoList
UPF capabilities advertised to NRF for SMF discovery
Type: list of (submodule)
Default:
[
{
dnnUpfInfoList = [
{
dnn = "oai";
}
];
sNssai = {
sd = null;
sst = 1;
};
}
{
dnnUpfInfoList = [
{
dnn = "oai.ipv4";
}
];
sNssai = {
sd = 1;
sst = 1;
};
}
{
dnnUpfInfoList = [
{
dnn = "default";
}
];
sNssai = {
sd = "00007B";
sst = 222;
};
}
]
Declared by:
oai.common.upf.upf_info.sNssaiUpfInfoList.*.dnnUpfInfoList
List of DNNs for this slice
Type: list of (submodule)
Example:
[
{
dnn = "oai";
}
]
Declared by:
oai.common.upf.upf_info.sNssaiUpfInfoList.*.dnnUpfInfoList.*.dnn
Data Network Name
Type: string
Example:
"oai"
Declared by:
oai.common.upf.upf_info.sNssaiUpfInfoList.*.sNssai.sd
Slice Differentiator (optional)
Type: null or signed integer or string
Default:
null
Example:
"000001"
Declared by:
oai.common.upf.upf_info.sNssaiUpfInfoList.*.sNssai.sst
Slice/Service Type
Type: signed integer
Example:
1
Declared by:
AMF Options
oai.amf.nfs.amf.host
Override AMF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-amf"
Declared by:
oai.amf.nfs.amf.n2.interface_name
Override AMF N2 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.amf.nfs.amf.n2.port
Override AMF N2 port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
38412
Declared by:
oai.amf.nfs.amf.sbi.api_version
Override AMF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.amf.nfs.amf.sbi.interface_name
Override AMF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.amf.nfs.amf.sbi.port
Override AMF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
AUSF Options
oai.ausf.nfs.ausf.host
Override AUSF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-ausf"
Declared by:
oai.ausf.nfs.ausf.sbi.api_version
Override AUSF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.ausf.nfs.ausf.sbi.interface_name
Override AUSF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.ausf.nfs.ausf.sbi.port
Override AUSF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
LMF Options
oai.lmf.nfs.lmf.host
Override LMF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-lmf"
Declared by:
oai.lmf.nfs.lmf.sbi.api_version
Override LMF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.lmf.nfs.lmf.sbi.interface_name
Override LMF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.lmf.nfs.lmf.sbi.port
Override LMF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
NRF Options
oai.nrf.nfs.nrf.host
Override NRF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-nrf"
Declared by:
oai.nrf.nfs.nrf.sbi.api_version
Override NRF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.nrf.nfs.nrf.sbi.interface_name
Override NRF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.nrf.nfs.nrf.sbi.port
Override NRF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
NSSF Options
oai.nssf.nfs.nssf.host
Override NSSF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-nssf"
Declared by:
oai.nssf.nfs.nssf.sbi.api_version
Override NSSF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.nssf.nfs.nssf.sbi.interface_name
Override NSSF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.nssf.nfs.nssf.sbi.port
Override NSSF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
PCF Options
oai.pcf.nfs.pcf.host
Override PCF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-pcf"
Declared by:
oai.pcf.nfs.pcf.sbi.api_version
Override PCF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.pcf.nfs.pcf.sbi.interface_name
Override PCF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.pcf.nfs.pcf.sbi.port
Override PCF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
SMF Options
oai.smf.amf.enable_smf_selection
Override enable_smf_selection for SMF config
Type: null or boolean
Default:
null
Example:
true
Declared by:
oai.smf.amf.pid_directory
Override AMF pid_directory for SMF config
Type: null or string
Default:
null
Example:
"/var/run"
Declared by:
oai.smf.nfs.smf.host
Override SMF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-smf"
Declared by:
oai.smf.nfs.smf.n4.interface_name
Override SMF N4 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.smf.nfs.smf.n4.port
Override SMF N4 port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8805
Declared by:
oai.smf.nfs.smf.sbi.api_version
Override SMF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.smf.nfs.smf.sbi.interface_name
Override SMF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.smf.nfs.smf.sbi.port
Override SMF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
oai.smf.smf.ngap
SMF-specific NGAP settings
Type: null or (submodule)
Default:
null
Declared by:
oai.smf.smf.ngap.send_default_qos_characteristics
Send default QoS characteristics via NGAP
Type: boolean
Example:
false
Declared by:
oai.smf.smf.smf_info
SMF info section (SMF-specific)
Type: null or (submodule)
Default:
null
Declared by:
oai.smf.smf.smf_info.sNssaiSmfInfoList
SMF info list
Type: list of (attribute set)
Declared by:
oai.smf.smf.upfs
Override UPF list for SMF config
Type: null or (list of (submodule))
Default:
null
Declared by:
oai.smf.smf.upfs.*.config.enable_qers
Enable QERs
Type: boolean
Declared by:
oai.smf.smf.upfs.*.config.enable_upf_wo_nf_discovery
Enable UPF without NF discovery
Type: boolean
Declared by:
oai.smf.smf.upfs.*.config.enable_usage_reporting
Enable usage reporting
Type: boolean
Declared by:
oai.smf.smf.upfs.*.host
UPF hostname
Type: string
Declared by:
UDM Options
oai.udm.nfs.udm.host
Override UDM hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-udm"
Declared by:
oai.udm.nfs.udm.sbi.api_version
Override UDM SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.udm.nfs.udm.sbi.interface_name
Override UDM SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.udm.nfs.udm.sbi.port
Override UDM SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
UDR Options
oai.udr.nfs.udr.host
Override UDR hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-udr"
Declared by:
oai.udr.nfs.udr.sbi.api_version
Override UDR SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.udr.nfs.udr.sbi.interface_name
Override UDR SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.udr.nfs.udr.sbi.port
Override UDR SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
oai.udr.udr_name
UDR name
Type: null or string
Default:
null
Example:
"oai-udr"
Declared by:
UPF Options
oai.upf.amf.enable_smf_selection
Override enable_smf_selection for UPF config
Type: null or boolean
Default:
null
Example:
true
Declared by:
oai.upf.amf.supported_integrity_algorithms
Override supported integrity algorithms for UPF config
Type: null or (list of string)
Default:
null
Example:
[
"NIA1"
"NIA0"
"NIA2"
]
Declared by:
oai.upf.nfs.upf.host
Override UPF hostname for this generated NF config only.
Type: null or string
Default:
null
Example:
"oai-upf"
Declared by:
oai.upf.nfs.upf.n3.interface_name
Override UPF N3 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"demo-n3"
Declared by:
oai.upf.nfs.upf.n3.port
Override UPF N3 port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
2152
Declared by:
oai.upf.nfs.upf.n4.interface_name
Override UPF N4 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"demo-oai"
Declared by:
oai.upf.nfs.upf.n4.port
Override UPF N4 port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8805
Declared by:
oai.upf.nfs.upf.n6.interface_name
Override UPF N6 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"demo-n6"
Declared by:
oai.upf.nfs.upf.n9.interface_name
Override UPF N9 interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"demo-n9"
Declared by:
oai.upf.nfs.upf.n9.port
Override UPF N9 port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
2152
Declared by:
oai.upf.nfs.upf.sbi.api_version
Override UPF SBI API version for this generated NF config only.
Type: null or string
Default:
null
Example:
"v1"
Declared by:
oai.upf.nfs.upf.sbi.interface_name
Override UPF SBI interface name for this generated NF config only.
Type: null or string
Default:
null
Example:
"eth0"
Declared by:
oai.upf.nfs.upf.sbi.port
Override UPF SBI port for this generated NF config only.
Type: null or 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
null
Example:
8080
Declared by:
oai.upf.smf.smf_info
SMF info section (UPF-specific)
Type: null or (submodule)
Default:
null
Declared by:
oai.upf.smf.smf_info.sNssaiSmfInfoList
SMF info list
Type: list of (attribute set)
Declared by:
oai.upf.smf.upfs
Override UPF list for UPF config
Type: null or (list of (submodule))
Default:
null
Declared by:
oai.upf.smf.upfs.*.config.enable_qers
Enable QERs
Type: boolean
Declared by:
oai.upf.smf.upfs.*.config.enable_usage_reporting
Enable usage reporting
Type: boolean
Declared by:
oai.upf.smf.upfs.*.host
UPF hostname
Type: string
Declared by:
oai.upf.smf.use_local_pcc_rules
Override use_local_pcc_rules for UPF config
Type: null or boolean
Default:
null
Example:
false
Declared by:
oai.upf.smf.use_local_subscription_info
Override use_local_subscription_info for UPF config
Type: null or boolean
Default:
null
Example:
false
Declared by:
Free5GC Configuration Options
Browse Free5GC core configuration options.
Shared Options
Network Functions
- AMF Options
- AUSF Options
- BSF Options
- CHF Options
- N3IWF Options
- NEF Options
- NRF Options
- NSSF Options
- PCF Options
- SMF Options
- TNGF Options
- UDM Options
- UDR Options
- UEROUTING Options
- UPF Options
- WEBUI Options
Common Options
free5gc.common.amf.ngap.addresses
Default AMF NGAP addresses.
Type: list of string
Default:
[
"127.0.0.18"
]
Declared by:
free5gc.common.amf.ngap.port
Default AMF NGAP SCTP port.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
38412
Declared by:
free5gc.common.cert.dir
Default directory for generated Free5GC certificate paths.
Type: string
Default:
"cert"
Declared by:
free5gc.common.dnnList
Default DNN names.
Type: list of string
Default:
[
"internet"
]
Declared by:
free5gc.common.locality
Default Free5GC locality value.
Type: string
Default:
"area1"
Declared by:
free5gc.common.logger.enable
Default logger enable flag for Free5GC network functions.
Type: boolean
Default:
true
Declared by:
free5gc.common.logger.level
Default logger level for Free5GC network functions.
Type: one of “trace”, “debug”, “info”, “warn”, “error”, “fatal”, “panic”
Default:
"info"
Declared by:
free5gc.common.logger.reportCaller
Default logger caller reporting flag.
Type: boolean
Default:
false
Declared by:
free5gc.common.mongodb.name
Default MongoDB database name.
Type: string
Default:
"free5gc"
Declared by:
free5gc.common.mongodb.url
Default MongoDB URL.
Type: string
Default:
"mongodb://127.0.0.1:27017"
Declared by:
free5gc.common.nrf.certPem
Default NRF certificate path used by NRF clients.
Type: string
Default:
"cert/nrf.pem"
Declared by:
free5gc.common.nrf.nfmUri
Default NRF NF-management endpoint URI.
Type: string
Default:
"http://127.0.0.10:8000/nnrf-nfm/v1/nf-instances"
Declared by:
free5gc.common.nrf.uri
Default NRF URI used by NRF clients.
Type: string
Default:
"http://127.0.0.10:8000"
Declared by:
free5gc.common.plmn.mcc
Default Mobile Country Code.
Type: string
Default:
"208"
Declared by:
free5gc.common.plmn.mnc
Default Mobile Network Code.
Type: string
Default:
"93"
Declared by:
free5gc.common.sbi.port
Default Free5GC SBI port.
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Default:
8000
Declared by:
free5gc.common.sbi.scheme
Default Free5GC SBI scheme.
Type: one of “http”, “https”
Default:
"http"
Declared by:
free5gc.common.snssaiList
Default S-NSSAI list shared by AMF, SMF, NSSF, N3IWF, and TNGF.
Type: list of (submodule)
Default:
[
{
sd = "010203";
sst = 1;
}
{
sd = "112233";
sst = 1;
}
]
Declared by:
free5gc.common.snssaiList.*.sd
Slice differentiator as a 3-byte hex string.
Type: null or string
Default:
null
Example:
"010203"
Declared by:
free5gc.common.snssaiList.*.sst
Slice/service type.
Type: integer between 0 and 255 (both inclusive)
Example:
1
Declared by:
free5gc.common.tai.tac
Default Tracking Area Code.
Type: string
Default:
"000001"
Declared by:
AMF Options
free5gc.amf.amfName
AMF name.
Type: string
Default:
"AMF"
Declared by:
free5gc.amf.generated
Path to generated amfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.amf.sbi.bindingIPv4
AMF SBI bind IP.
Type: string
Default:
"127.0.0.18"
Declared by:
free5gc.amf.sbi.registerIPv4
AMF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.18"
Declared by:
AUSF Options
free5gc.ausf.generated
Path to generated ausfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.ausf.sbi.bindingIPv4
AUSF SBI bind IP.
Type: string
Default:
"127.0.0.9"
Declared by:
free5gc.ausf.sbi.registerIPv4
AUSF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.9"
Declared by:
BSF Options
free5gc.bsf.bsfName
BSF name.
Type: string
Default:
"BSF"
Declared by:
free5gc.bsf.generated
Path to generated bsfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.bsf.sbi.bindingIPv4
BSF SBI bind IP.
Type: string
Default:
"127.0.0.15"
Declared by:
free5gc.bsf.sbi.registerIPv4
BSF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.15"
Declared by:
CHF Options
free5gc.chf.chfName
CHF name.
Type: string
Default:
"CHF"
Declared by:
free5gc.chf.generated
Path to generated chfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.chf.sbi.bindingIPv4
CHF SBI bind IP.
Type: string
Default:
"127.0.0.113"
Declared by:
free5gc.chf.sbi.registerIPv4
CHF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.113"
Declared by:
N3IWF Options
free5gc.n3iwf.generated
Path to generated n3iwfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.n3iwf.ikeBindAddress
N3IWF IKE bind address.
Type: string
Default:
"172.16.2.100"
Declared by:
free5gc.n3iwf.n3iwfGtpBindAddress
N3IWF N3 GTP bind address.
Type: string
Default:
"127.0.0.33"
Declared by:
NEF Options
free5gc.nef.generated
Path to generated nefcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.nef.sbi.bindingIPv4
NEF SBI bind IP.
Type: string
Default:
"127.0.0.5"
Declared by:
free5gc.nef.sbi.registerIPv4
NEF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.5"
Declared by:
NRF Options
free5gc.nrf.generated
Path to generated nrfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.nrf.sbi.bindingIPv4
NRF SBI bind IP.
Type: string
Default:
"127.0.0.10"
Declared by:
free5gc.nrf.sbi.registerIPv4
NRF SBI registered IP.
Type: string
Default:
"127.0.0.10"
Declared by:
NSSF Options
free5gc.nssf.generated
Path to generated nssfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.nssf.nssfName
NSSF name.
Type: string
Default:
"NSSF"
Declared by:
free5gc.nssf.sbi.bindingIPv4
NSSF SBI bind IP.
Type: string
Default:
"127.0.0.31"
Declared by:
free5gc.nssf.sbi.registerIPv4
NSSF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.31"
Declared by:
PCF Options
free5gc.pcf.generated
Path to generated pcfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.pcf.pcfName
PCF name.
Type: string
Default:
"PCF"
Declared by:
free5gc.pcf.sbi.bindingIPv4
PCF SBI bind IP.
Type: string
Default:
"127.0.0.7"
Declared by:
free5gc.pcf.sbi.registerIPv4
PCF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.7"
Declared by:
SMF Options
free5gc.smf.generated
Path to generated smfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.smf.pfcp.address
SMF PFCP address.
Type: string
Default:
"127.0.0.1"
Declared by:
free5gc.smf.sbi.bindingIPv4
SMF SBI bind IP.
Type: string
Default:
"127.0.0.2"
Declared by:
free5gc.smf.sbi.registerIPv4
SMF SBI IP registered to NRF.
Type: string
Default:
"127.0.0.2"
Declared by:
free5gc.smf.smfName
SMF name.
Type: string
Default:
"SMF"
Declared by:
free5gc.smf.upf.n3Address
Default UPF N3 address used by SMF.
Type: string
Default:
"127.0.0.8"
Declared by:
free5gc.smf.upf.n4Address
Default UPF N4 address used by SMF.
Type: string
Default:
"127.0.0.8"
Declared by:
TNGF Options
free5gc.tngf.GTPBindAddress
TNGF GTP bind address.
Type: string
Default:
"127.0.0.33"
Declared by:
free5gc.tngf.IKEBindAddress
TNGF IKE bind address.
Type: string
Default:
"192.168.1.102"
Declared by:
free5gc.tngf.generated
Path to generated tngfcfg.yaml.
Type: absolute path (read only)
Declared by:
UDM Options
free5gc.udm.generated
Path to generated udmcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.udm.sbi.bindingIPv4
UDM SBI bind IP.
Type: string
Default:
"127.0.0.3"
Declared by:
free5gc.udm.sbi.registerIPv4
UDM SBI IP registered to NRF.
Type: string
Default:
"127.0.0.3"
Declared by:
UDR Options
free5gc.udr.generated
Path to generated udrcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.udr.sbi.bindingIPv4
UDR SBI bind IP.
Type: string
Default:
"127.0.0.4"
Declared by:
free5gc.udr.sbi.registerIPv4
UDR SBI IP registered to NRF.
Type: string
Default:
"127.0.0.4"
Declared by:
UEROUTING Options
free5gc.uerouting.generated
Path to generated uerouting.yaml.
Type: absolute path (read only)
Declared by:
UPF Options
free5gc.upf.generated
Path to generated upfcfg.yaml.
Type: absolute path (read only)
Declared by:
free5gc.upf.gtpu.address
UPF N3 GTP-U address.
Type: string
Default:
"127.0.0.8"
Declared by:
free5gc.upf.pfcp.address
UPF PFCP listen address and node ID.
Type: string
Default:
"127.0.0.8"
Declared by:
WEBUI Options
free5gc.webui.generated
Path to generated webuicfg.yaml.
Type: absolute path (read only)
Declared by: