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

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: