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

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: