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

amf.access_control

Access control configuration

Type: list of (submodule)

Default:

[ ]

Declared by:

amf.access_control.*.default_reject_cause

Default Reject cause

Type: null or signed integer

Default:

null

Example:

13

Declared by:

amf.access_control.*.plmn_id

PLMN ID entry

Type: null or (submodule)

Default:

null

Declared by:

amf.access_control.*.plmn_id.mcc

Mobile Country Code

Type: null or string

Default:

null

Example:

"999"

Declared by:

amf.access_control.*.plmn_id.mnc

Mobile Network Code

Type: null or string

Default:

null

Example:

"70"

Declared by:

amf.amf_name

AMF name

Type: string

Default:

"open5gs-amf0"

Example:

"open5gs-amf0"

Declared by:

amf.generated

Path to generated amf.yaml

Type: absolute path

Declared by:

amf.global.max.peer

Maximum number of peer connections.

Type: null or (positive integer, meaning >0)

Default:

null

Example:

64

Declared by:

amf.global.max.ue

Maximum number of UE connections.

Type: positive integer, meaning >0

Default:

1024

Example:

2048

Declared by:

amf.guami

GUAMI configuration.

Type: submodule

Default:

{
  amf_id = {
    region = 2;
    set = 1;
  };
  plmn_id = {
    mcc = "999";
    mnc = "70";
  };
}

Declared by:

amf.guami.amf_id

AMF ID

Type: submodule

Declared by:

amf.guami.amf_id.region

AMF region

Type: signed integer

Example:

2

Declared by:

amf.guami.amf_id.set

AMF set

Type: signed integer

Example:

1

Declared by:

amf.guami.plmn_id

PLMN ID

Type: submodule

Declared by:

amf.guami.plmn_id.mcc

Mobile Country Code

Type: null or string

Example:

"999"

Declared by:

amf.guami.plmn_id.mnc

Mobile Network Code

Type: null or string

Example:

"70"

Declared by:

amf.logger.file.path

Path to the AMF log file.

Type: string

Default:

"/var/log/open5gs/amf.log"

Example:

"/var/log/open5gs/amf.log"

Declared by:

amf.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:

amf.metrics.server

Metrics server configuration.

Type: list of (submodule)

Default:

[
  {
    address = "127.0.0.5";
    port = 9090;
  }
]

Declared by:

amf.metrics.server.*.address

Metrics server address

Type: string

Example:

"127.0.0.5"

Declared by:

amf.metrics.server.*.port

Metrics server port

Type: 16 bit unsigned integer; between 0 and 65535 (both inclusive)

Example:

9090

Declared by:

amf.network_name.full

Full network name

Type: string

Default:

"Open5GS"

Example:

"Open5GS"

Declared by:

amf.network_name.short

Short network name

Type: string

Default:

"Next"

Example:

"Next"

Declared by:

amf.ngap.server

NGAP server configuration.

Type: list of (submodule)

Default:

[
  {
    address = "127.0.0.5";
  }
]

Declared by:

amf.ngap.server.*.address

NGAP server address

Type: null or string

Default:

null

Example:

"127.0.0.5"

Declared by:

amf.ngap.server.*.dev

Network device for NGAP server

Type: null or string

Default:

null

Example:

"eth0"

Declared by:

amf.plmn_support

PLMN support configuration.

Type: submodule

Default:

{
  plmn_id = {
    mcc = "999";
    mnc = "70";
  };
  s_nssai = [
    {
      sst = 1;
    }
  ];
}

Declared by:

amf.plmn_support.plmn_id

PLMN ID

Type: submodule

Declared by:

amf.plmn_support.plmn_id.mcc

Mobile Country Code

Type: null or string

Example:

"999"

Declared by:

amf.plmn_support.plmn_id.mnc

Mobile Network Code

Type: null or string

Example:

"70"

Declared by:

amf.plmn_support.s_nssai

Supported S-NSSAI list

Type: list of (submodule)

Declared by:

amf.plmn_support.s_nssai.*.sd

Slice Differentiator

Type: null or signed integer

Default:

null

Example:

10000

Declared by:

amf.plmn_support.s_nssai.*.sst

Slice/Service Type

Type: null or signed integer

Example:

1

Declared by:

amf.sbi.client.delegated

Delegation options for SBI client

Type: null or (submodule)

Default:

null

Declared by:

amf.sbi.client.delegated.nrf

NRF delegation options

Type: null or (submodule)

Default:

null

Declared by:

amf.sbi.client.delegated.nrf.disc

Delegate discovery to SCP

Type: null or boolean

Default:

null

Example:

true

Declared by:

amf.sbi.client.delegated.nrf.nfm

Directly communicate NRF management functions

Type: null or boolean

Default:

null

Example:

false

Declared by:

amf.sbi.client.delegated.scp

SCP delegation options

Type: null or (submodule)

Default:

null

Declared by:

amf.sbi.client.delegated.scp.next

Delegate to SCP for next-hop communications

Type: null or boolean

Default:

null

Example:

true

Declared by:

amf.sbi.client.nrf

SBI client NRF URIs.

Type: null or (list of (submodule))

Default:

null

Declared by:

amf.sbi.client.nrf.*.uri

NRF URI for SBI client

Type: string

Example:

"http://127.0.0.10:7777"

Declared by:

amf.sbi.client.scp

SBI client SCP URIs.

Type: null or (list of (submodule))

Default:

[
  {
    uri = "http://127.0.0.200:7777";
  }
]

Declared by:

amf.sbi.client.scp.*.uri

SCP URI for SBI client

Type: string

Example:

"http://127.0.0.200:7777"

Declared by:

amf.sbi.server

SBI server configuration.

Type: list of (submodule)

Default:

[
  {
    address = "127.0.0.5";
    port = 7777;
  }
]

Declared by:

amf.sbi.server.*.address

SBI server address

Type: string

Example:

"127.0.0.5"

Declared by:

amf.sbi.server.*.advertise

Advertise address for SBI server

Type: null or string

Default:

null

Example:

"open5gs-amf.svc.local"

Declared by:

amf.sbi.server.*.dev

Network device for SBI server

Type: null or string

Default:

null

Example:

"eth0"

Declared by:

amf.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:

amf.security.ciphering_order

Ciphering algorithm order

Type: list of string

Default:

[
  "NEA0"
  "NEA1"
  "NEA2"
]

Example:

[
  "NEA0"
  "NEA1"
  "NEA2"
]

Declared by:

amf.security.integrity_order

Integrity algorithm order

Type: list of string

Default:

[
  "NIA2"
  "NIA1"
  "NIA0"
]

Example:

[
  "NIA2"
  "NIA1"
  "NIA0"
]

Declared by:

amf.tai

TAI configuration.

Type: submodule

Default:

{
  plmn_id = {
    mcc = "999";
    mnc = "70";
  };
  tac = 1;
}

Declared by:

amf.tai.plmn_id

PLMN ID

Type: submodule

Declared by:

amf.tai.plmn_id.mcc

Mobile Country Code

Type: null or string

Example:

"999"

Declared by:

amf.tai.plmn_id.mnc

Mobile Network Code

Type: null or string

Example:

"70"

Declared by:

amf.tai.tac

Tracking Area Code

Type: signed integer or list of signed integer

Example:

1

Declared by:

amf.time.t3502

T3502 timer configuration

Type: null or (submodule)

Default:

null

Declared by:

amf.time.t3502.value

T3502 timer value

Type: signed integer

Example:

720

Declared by:

amf.time.t3512

T3512 timer configuration

Type: submodule

Default:

{
  value = 540;
}

Declared by:

amf.time.t3512.value

T3512 timer value

Type: signed integer

Default:

540

Example:

540

Declared by: