Config override keys

Reference only: the value type and limits for each documented config override key. Requests and responses use a generic {key, value} object, and this list may not include every key the API accepts or returns. See the Nebula config reference for what each option does.

`lighthouse.advertise_addrs`

Type: array of string

IP:port addresses to advertise to the lighthouse. A port of 0 uses the listening port.

Example: ["203.0.113.10:4242"]

`lighthouse.interval`

Type: integer

From 1 to 65535

`lighthouse.local_allow_list`

Type: map of boolean

Map of CIDRs to true (allow) or false (deny), plus an optional interfaces map of interface name regular expressions to booleans, which must all be the same value. If the rules for an address family mix true and false, a default rule for 0.0.0.0/0 or ::/0 is required.

Example: {"10.0.0.0/8":false,"0.0.0.0/0":true,"interfaces":{"docker.*":false}}

`lighthouse.remote_allow_list`

Type: map of boolean

Map of CIDRs to true (allow) or false (deny). If the rules for an address family mix true and false, a default rule for 0.0.0.0/0 or ::/0 is required.

Example: {"10.0.0.0/8":false,"0.0.0.0/0":true}

`listen.batch`

Type: integer

From 1 to 255

`listen.host`

Type: string

1 to 255 characters

`listen.read_buffer`

Type: integer (int64)

From 1 to 9223372036854776000

`listen.send_recv_error`

Type: string

One of always, never, private

`listen.so_mark`

Type: integer (int64)

From 1 to 4294967295

`listen.udp_offloads`

Type: boolean

`listen.write_buffer`

Type: integer (int64)

From 1 to 9223372036854776000

`logging.format`

Type: string

One of text, json

`logging.level`

Type: string

One of trace, debug, info, warning, error, fatal, panic

`logging.timestamp_format`

Type: string

1 to 255 characters

`preferred_ranges`

Type: array of string

CIDRs to prefer when choosing among a peer's underlay addresses.

Example: ["192.168.1.0/24"]

`punchy.delay`

Type: string

A positive duration such as 30s, 5m or 1h.

Example: "10m"

`punchy.respond_delay`

Type: string

A positive duration such as 30s, 5m or 1h.

Example: "10m"

`relay.use_relays`

Type: boolean

`routines`

Type: integer

From 1 to 255

`static_map.network`

Type: string

One of ip, ip4, ip6

`stats.host`

Type: string

1 to 255 characters

`stats.interval`

Type: string

A positive duration such as 30s, 5m or 1h.

Example: "10m"

`stats.lighthouse_metrics`

Type: boolean

`stats.listen`

Type: string

1 to 255 characters

`stats.message_metrics`

Type: boolean

`stats.namespace`

Type: string

Letters, digits and underscores, not starting with a digit or with __.

1 to 255 characters
Matches ^[a-zA-Z_][a-zA-Z0-9_]*$

`stats.path`

Type: string

1 to 255 characters

`stats.prefix`

Type: string

1 to 255 characters
Matches ^[A-Za-z0-9_-]+$

`stats.subsystem`

Type: string

Letters, digits and underscores, not starting with a digit or with __.

1 to 255 characters
Matches ^[a-zA-Z_][a-zA-Z0-9_]*$

`stats.type`

Type: string

One of graphite, prometheus, none

`tun.cpu_affinity`

Type: array of integer

Each item: At least 0

Example: [0,1]

`tun.dev`

Type: string

1 to 255 characters

`tun.disabled`

Type: boolean

`tun.mtu`

Type: integer

From 1200 to 10000

`tun.pin_threads`

Type: boolean

`tun.pin_threads_key`

Type: string

One of pid, port

`tun.tx_queue`

Type: integer

From 500 to 65535

`tun.use_offloads`

Type: boolean

`tunnels.drop_inactive`

Type: boolean

`tunnels.inactivity_timeout`

Type: string

A positive duration such as 30s, 5m or 1h.

Example: "10m"