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

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: