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

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:

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:

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:

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:

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:

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:

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: