dhcp-server

---

ip/dhcp-server

Package: dhcp
Type: Directory

Flag	Name	Description
D	dynamic	dynamic
X	disabled	disabled
I	invalid	invalid

Argument	Type	Description
name	string
interface ( mandatory )	iface_enum
relay	ipAddr
lease-time	time
address-pool	enum (static-only)
dynamic-lease-identifiers	ubit (client-mac, client-id, opt-82)
bootp-support	enum (none | static | dynamic)
bootp-lease-time	alt { , enum (lease-time | forever) { lease-time:0, forever:0xffffffff } , time }
delay-threshold	alt { enum (none) { none:0 } , time }
server-address	ipAddr
add-arp	bool
add-dns-entries	bool
add-dns-entries-suffix	string	Used only if add-dns-entries=yes. If non-empty, appends suffix to DNS entry and adds Option 15 (Domain Name) to responses.
authoritative	enum (no | after-10sec-delay | after-2sec-delay | yes)
always-broadcast	bool
use-radius	enum (no | yes | accounting)
client-mac-limit	enum (unlimited)	maximum leases one client MAC can get
conflict-detection	bool	use ARP and ICMP to test for IP conflict before issuing lease
use-framed-as-classless	bool
use-reconfigure	bool
lease-script	alt { , string }
insert-queue-before	enum (first | bottom)
parent-queue	enum (none)
dhcp-option-set	enum (none)
address-lists	multi { array-id, string }
allow-dual-stack-queue	bool
support-broadband-tr101	bool	Pass additional Option 82 Suboptions to RADIUS server as described in RFC 4679 and The Broadband Forum TR-101

ip/dhcp-server/alert

Package: dhcp
Type: Directory

Flag	Name	Description
X	disabled	disabled
I	invalid	invalid

Argument	Type	Description
interface ( mandatory )	iface_enum
valid-server	multi { macAddr }
on-alert	alt { , string }
alert-timeout	alt { enum (none) { none:0 } , time }

Read-only Argument	Type	Description
unknown-server	multi { macAddr }

ip/dhcp-server/alert/reset-alert

Package: dhcp
Type: Command

ip/dhcp-server/config

Package: dhcp
Type: Settings Directory

Argument	Type	Description
store-leases-disk	alt { enum (immediately | never) { immediately:0, never:0xffffffff } , time }
accounting	bool
interim-update	time
radius-password	alt { bool , string }

ip/dhcp-server/lease

Package: dhcp
Type: Directory

Flag	Name	Description
X	disabled	disabled
R	radius	radius
D	dynamic	dynamic
B	blocked	blocked

Argument	Type	Description
address	alt { ipAddr , enum }
mac-address	macAddr
use-src-mac	bool
client-id	string
rate-limit	string
routes	object { composite { , } { , } }	Routes that appear on the server when the client is connected
insert-queue-before	enum (bottom | first)
parent-queue	enum (none)
queue-type	enum
address-lists	multi { array-id, string }
server	enum (all)
block-access	bool
allow-dual-stack-queue	bool
lease-time	time
always-broadcast	bool
dhcp-option	multi { array-id, enum }
dhcp-option-set	enum (none)
agent-circuit-id	string	If non-empty, use it to match lease by Option 82 even if MAC or client-id differ
agent-remote-id	string	If non-empty, use it to match lease by Option 82 even if MAC or client-id differ

Read-only Argument	Type	Description
status	enum (waiting | testing | declined | offered | bound | authorizing | conflict)
expires-after	time
last-seen	alt { enum (never | sometime) { never:0xffffffff, sometime:0xfffffffe } , time }
age	time
active-address	ipAddr
active-mac-address	macAddr
active-client-id	string
active-server	enum
active-agent-circuit-id	string
active-agent-remote-id	string
host-name	string
class-id	string	DHCP option 60 from last received DHCP request
src-mac-address	macAddr
reconfigure-key	string
reconfigure-last-sent	string
reconfigure-status	string

ip/dhcp-server/lease/check-status

Package: dhcp
Type: Command

ip/dhcp-server/lease/make-static

Package: dhcp
Type: Command

ip/dhcp-server/lease/send-reconfigure

Package: dhcp
Type: Command

ip/dhcp-server/matcher

Package: dhcp
Type: Directory

Flag	Name	Description
X	disabled	disabled

Argument	Type	Description
name ( mandatory )	string
server ( mandatory )	enum (all)	global or single server
address-pool	enum (static-only)	pool used for this entry
option-set	enum (none)
code ( mandatory )	alt { num [1 .. 254] , enum (vendor-specific) { vendor-specific:43 } }
value ( mandatory )	string	contents of option to match as string or hex with 0x prefix
matching-type ( mandatory )	enum (exact | substring)

ip/dhcp-server/network

Package: dhcp
Type: Directory

Flag	Name	Description
D	dynamic	dynamic

Argument	Type	Description
address	composite { , }
gateway	multi { ipAddr }
netmask	num
dns-server	alt { , multi { ipAddr } { ipAddr } }
dns-none	bool	no servers will be sent to client
wins-server	multi { ipAddr }
ntp-server	alt { , multi { ipAddr } { ipAddr } }
ntp-none	bool	no servers will be sent to client
caps-manager	multi { ipAddr }
domain	string
next-server	ipAddr	siaddr for next bootstrap step
boot-file-name	string
dhcp-option	multi { array-id, enum }
dhcp-option-set	enum (none)

ip/dhcp-server/option

Package: dhcp
Type: Directory

Argument	Type	Description
name ( mandatory )	string
code ( mandatory )	alt { num [1 .. 254] , enum (vendor-specific) { vendor-specific:43 } }
value	string	0x - exact hex value, '' - string or IP address value
force	bool	always include this option in reply

Read-only Argument	Type	Description
raw-value	string

ip/dhcp-server/option/sets

Package: dhcp
Type: Directory

Argument	Type	Description
name ( mandatory )	string
options ( mandatory )	multi { array-id, enum }

ip/dhcp-server/setup

Package: dhcp
Type: Command

Read-only Argument	Type	Description
interface	iface_enum
network	composite { , }
gateway	ipAddr
relay	ipAddr
ippool	multi { , , composite { , } { , } }
send-dns	bool
dns-servers	multi { ipAddr }
lease-time	time