Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

smf.ctf.enabled

CTF (Charging Trigger Function) configuration.

Controls whether charging information is collected:

  • auto: Automatically determine based on configuration (default)
  • yes: Force enable CTF
  • no: 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 errors
  • error: Log errors and fatal messages
  • warn: Log warnings, errors, and fatal messages
  • info: Default level, includes informational messages
  • debug: Verbose logging for debugging
  • trace: 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: