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.
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.
Possible values: [lighthouse.advertise_addrs, lighthouse.interval, lighthouse.local_allow_list, lighthouse.remote_allow_list, listen.batch, listen.host, listen.read_buffer, listen.send_recv_error, listen.so_mark, listen.udp_offloads, listen.write_buffer, logging.format, logging.level, logging.timestamp_format, preferred_ranges, punchy.delay, punchy.respond_delay, relay.use_relays, routines, static_map.network, stats.host, stats.interval, stats.lighthouse_metrics, stats.listen, stats.message_metrics, stats.namespace, stats.path, stats.prefix, stats.subsystem, stats.type, tun.cpu_affinity, tun.dev, tun.disabled, tun.mtu, tun.pin_threads, tun.pin_threads_key, tun.tx_queue, tun.use_offloads, tunnels.drop_inactive, tunnels.inactivity_timeout]
- lighthouse.advertise_addrs
- lighthouse.interval
- lighthouse.local_allow_list
- lighthouse.remote_allow_list
- listen.batch
- listen.host
- listen.read_buffer
- listen.send_recv_error
- listen.so_mark
- listen.udp_offloads
- listen.write_buffer
- logging.format
- logging.level
- logging.timestamp_format
- preferred_ranges
- punchy.delay
- punchy.respond_delay
- relay.use_relays
- routines
- static_map.network
- stats.host
- stats.interval
- stats.lighthouse_metrics
- stats.listen
- stats.message_metrics
- stats.namespace
- stats.path
- stats.prefix
- stats.subsystem
- stats.type
- tun.cpu_affinity
- tun.dev
- tun.disabled
- tun.mtu
- tun.pin_threads
- tun.pin_threads_key
- tun.tx_queue
- tun.use_offloads
- tunnels.drop_inactive
- tunnels.inactivity_timeout
IP:port addresses to advertise to the lighthouse. A port of 0 uses the listening port.
["203.0.113.10:4242"]Possible values: >= 1 and <= 65535
value objectrequired
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.
interfaces object
value objectrequired
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.
Possible values: >= 1 and <= 255
Possible values: non-empty and <= 255 characters
Possible values: >= 1 and <= 9223372036854776000
Possible values: [always, never, private]
Possible values: >= 1 and <= 4294967295
Possible values: >= 1 and <= 9223372036854776000
Possible values: [text, json]
Possible values: [trace, debug, info, warning, error, fatal, panic]
Possible values: non-empty and <= 255 characters
CIDRs to prefer when choosing among a peer's underlay addresses.
["192.168.1.0/24"]A positive duration such as 30s, 5m or 1h.
10mA positive duration such as 30s, 5m or 1h.
10mPossible values: >= 1 and <= 255
Possible values: [ip, ip4, ip6]
Possible values: non-empty and <= 255 characters
A positive duration such as 30s, 5m or 1h.
10mPossible values: non-empty and <= 255 characters
Letters, digits and underscores, not starting with a digit or with __.
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z_][a-zA-Z0-9_]*$
Possible values: non-empty and <= 255 characters
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[A-Za-z0-9_-]+$
Letters, digits and underscores, not starting with a digit or with __.
Possible values: non-empty and <= 255 characters, Value must match regular expression ^[a-zA-Z_][a-zA-Z0-9_]*$
Possible values: [graphite, prometheus, none]
Possible values: >= 0
[0,1]Possible values: non-empty and <= 255 characters
Possible values: >= 1200 and <= 10000
Possible values: [pid, port]
Possible values: >= 500 and <= 65535
A positive duration such as 30s, 5m or 1h.
10m{
"key": "lighthouse.advertise_addrs",
"value": [
"203.0.113.10:4242"
]
}