pcrf.db_uri
MongoDB database URI for PCRF.
Type: string
Default:
"mongodb://localhost/open5gs"
Example:
"mongodb://localhost/open5gs"
Declared by:
pcrf.generated
Path to generated pcrf.yaml
Type: absolute path
Declared by:
pcrf.global.max.peer
Maximum number of peer connections.
Type: null or (positive integer, meaning >0)
Default:
null
Example:
64
Declared by:
pcrf.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:
pcrf.logger.file.path
Path to the PCRF log file.
Type: string
Default:
"/var/log/open5gs/pcrf.log"
Example:
"/var/log/open5gs/pcrf.log"
Declared by:
pcrf.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:
pcrf.pcrf.freeDiameter
Path to freeDiameter configuration file for PCRF (without /nix/store hash).
Type: string
Default:
"@sysconfdir@/freeDiameter/pcrf.conf"
Example:
"open5gs-unstable/etc/freeDiameter/pcrf.conf"
Declared by:
pcrf.pcrf.metrics.server
Metrics server configuration for PCRF.
Type: list of (submodule)
Default:
[
{
address = "127.0.0.9";
port = 9090;
}
]
Declared by:
pcrf.pcrf.metrics.server.*.address
Metrics server address
Type: string
Example:
"127.0.0.9"
Declared by:
pcrf.pcrf.metrics.server.*.port
Metrics server port
Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)
Example:
9090
Declared by:
pcrf.policy
PCRF Policy Configuration: SUPI Range Based Policies.
This configuration applies policies based solely on the UE’s SUPI range. Each policy defines one or more SUPI ranges and associated session configurations for different DNNs (Data Network Names).
Example:
policy = [
{
supi_range = [
"999700000000001-999709999999999"
"315010000000001-315010999999999"
];
session = [
{
name = "internet";
type = 3; # IPv4v6
ambr = {
downlink = { value = 1; unit = 3; }; # 1 Gbps
uplink = { value = 1; unit = 3; };
};
qos = {
index = 9;
arp = {
priority_level = 8;
pre_emption_vulnerability = 1;
pre_emption_capability = 1;
};
};
}
];
}
];
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session
Session configurations based on DNN/APN
Type: list of (submodule)
Declared by:
pcrf.policy.*.session.*.ambr
Aggregate Maximum Bit Rate configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.ambr.downlink
Aggregate Maximum Bit Rate (AMBR) for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.ambr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
3
Declared by:
pcrf.policy.*.session.*.ambr.downlink.value
Downlink bandwidth value
Type: positive integer, meaning >0
Example:
1
Declared by:
pcrf.policy.*.session.*.ambr.uplink
Aggregate Maximum Bit Rate (AMBR) for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.ambr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
3
Declared by:
pcrf.policy.*.session.*.ambr.uplink.value
Uplink bandwidth value
Type: positive integer, meaning >0
Example:
1
Declared by:
pcrf.policy.*.session.*.name
Data Network Name (DNN/APN)
Type: string
Example:
"internet"
Declared by:
pcrf.policy.*.session.*.pcc_rule
Policy and Charging Control (PCC) rules for the session. Defines detailed QoS, flow filtering, and bandwidth policies.
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow
Flow rules for the PCC rule
Type: null or (list of (submodule))
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow.*.description
Flow description using IPFilterRule format. Examples:
- “permit out icmp from any to assigned”
- “permit out udp from 10.200.136.98/32 23455 to assigned 1-65535”
Type: string
Example:
"permit out icmp from any to assigned"
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.flow.*.direction
Flow direction: 1=downlink, 2=uplink
Type: one of 1, 2
Example:
2
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos
QoS configuration for the PCC rule
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp
Allocation and Retention Priority (ARP)
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.pre_emption_capability
Pre-emption capability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.arp.priority_level
Priority level (1-15)
Type: integer between 1 and 15 (both inclusive)
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr
Guaranteed Bit Rate (GBR) configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink
Guaranteed Bit Rate for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.downlink.value
Guaranteed Bit Rate downlink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink
Guaranteed Bit Rate for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.gbr.uplink.value
Guaranteed Bit Rate uplink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.index
QoS Class Identifier (QCI/5QI)
Type: one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 65, 66, 67, 69, 70, 71, 72, 73, 74, 75, 76, 79, 80, 82, 83, 84, 85, 86
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr
Maximum Bit Rate (MBR) configuration
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink
Maximum Bit Rate for downlink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.downlink.value
Maximum Bit Rate downlink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink
Maximum Bit Rate for uplink
Type: submodule
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink.unit
Unit: 0=bps, 1=Kbps, 2=Mbps, 3=Gbps, 4=Tbps
Type: one of 0, 1, 2, 3, 4
Example:
1
Declared by:
pcrf.policy.*.session.*.pcc_rule.*.qos.mbr.uplink.value
Maximum Bit Rate uplink value
Type: positive integer, meaning >0
Example:
82
Declared by:
pcrf.policy.*.session.*.qos
QoS configuration for the session
Type: null or (submodule)
Default:
null
Declared by:
pcrf.policy.*.session.*.qos.arp
Allocation and Retention Priority (ARP)
Type: submodule
Declared by:
pcrf.policy.*.session.*.qos.arp.pre_emption_capability
Pre-emption capability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.qos.arp.pre_emption_vulnerability
Pre-emption vulnerability: 1=Disabled, 2=Enabled
Type: one of 1, 2
Example:
1
Declared by:
pcrf.policy.*.session.*.qos.arp.priority_level
Priority level (1-15)
Type: integer between 1 and 15 (both inclusive)
Example:
8
Declared by:
pcrf.policy.*.session.*.qos.index
QoS Class Identifier (QCI/5QI). Allowed values: 1,2,3,4,65,66,67,75,71,72,73,74,76,5,6,7,8,9,69,70,79,80,82,83,84,85,86
Type: one of 1, 2, 3, 4, 5, 6, 7, 8, 9, 65, 66, 67, 69, 70, 71, 72, 73, 74, 75, 76, 79, 80, 82, 83, 84, 85, 86
Example:
9
Declared by:
pcrf.policy.*.session.*.type
IP type: 1 = IPv4, 2 = IPv6, 3 = IPv4v6
Type: one of 1, 2, 3
Example:
3
Declared by:
pcrf.policy.*.supi_range
One or more ranges of SUPIs (IMSI) to which this policy applies. Format: start-end (e.g., “999700000000001-999709999999999”)
Type: list of string
Example:
[
"999700000000001-999709999999999"
"315010000000001-315010999999999"
]
Declared by: