config system dhcp server
Configure DHCP servers.
config system dhcp server
Description: Configure DHCP servers.
edit <id>
set status [disable|enable]
set lease-time {integer}
set mac-acl-default-action [assign|block]
set forticlient-on-net-status [disable|enable]
set dns-service [local|default|...]
set dns-server1 {ipv4-address}
set dns-server2 {ipv4-address}
set dns-server3 {ipv4-address}
set dns-server4 {ipv4-address}
set wifi-ac-service [specify|local]
set wifi-ac1 {ipv4-address}
set wifi-ac2 {ipv4-address}
set wifi-ac3 {ipv4-address}
set ntp-service [local|default|...]
set ntp-server1 {ipv4-address}
set ntp-server2 {ipv4-address}
set ntp-server3 {ipv4-address}
set domain {string}
set wins-server1 {ipv4-address}
set wins-server2 {ipv4-address}
set default-gateway {ipv4-address}
set next-server {ipv4-address}
set netmask {ipv4-netmask}
set interface {string}
config ip-range
Description: DHCP IP range configuration.
edit <id>
set start-ip {ipv4-address}
set end-ip {ipv4-address}
set vci-match [disable|enable]
set vci-string <vci-string1>, <vci-string2>, ...
set uci-match [disable|enable]
set uci-string <uci-string1>, <uci-string2>, ...
set lease-time {integer}
next
end
set timezone-option [disable|default|...]
set timezone {string}
set tftp-server <tftp-server1>, <tftp-server2>, ...
set filename {string}
config options
Description: DHCP options.
edit <id>
set code {integer}
set type [hex|string|...]
set value {string}
set ip {user}
set vci-match [disable|enable]
set vci-string <vci-string1>, <vci-string2>, ...
set uci-match [disable|enable]
set uci-string <uci-string1>, <uci-string2>, ...
next
end
set server-type [regular|ipsec]
set ip-mode [range|usrgrp]
set conflicted-ip-timeout {integer}
set ipsec-lease-hold {integer}
set auto-configuration [disable|enable]
set dhcp-settings-from-fortiipam [disable|enable]
set auto-managed-status [disable|enable]
set ddns-update [disable|enable]
set ddns-update-override [disable|enable]
set ddns-server-ip {ipv4-address}
set ddns-zone {string}
set ddns-auth [disable|tsig]
set ddns-keyname {string}
set ddns-key {password_aes256}
set ddns-ttl {integer}
set vci-match [disable|enable]
set vci-string <vci-string1>, <vci-string2>, ...
config exclude-range
Description: Exclude one or more ranges of IP addresses from being assigned to clients.
edit <id>
set start-ip {ipv4-address}
set end-ip {ipv4-address}
set vci-match [disable|enable]
set vci-string <vci-string1>, <vci-string2>, ...
set uci-match [disable|enable]
set uci-string <uci-string1>, <uci-string2>, ...
set lease-time {integer}
next
end
set shared-subnet [disable|enable]
set relay-agent {ipv4-address}
config reserved-address
Description: Options for the DHCP server to assign IP settings to specific MAC addresses.
edit <id>
set type [mac|option82]
set ip {ipv4-address}
set mac {mac-address}
set action [assign|block|...]
set circuit-id-type [hex|string]
set circuit-id {string}
set remote-id-type [hex|string]
set remote-id {string}
set description {var-string}
next
end
next
end
config system dhcp server
|
Parameter |
Description |
Type |
Size |
Default |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||
|
status |
Enable/disable this DHCP configuration. |
option |
- |
enable |
||||||||
|
|
|
|||||||||||
|
lease-time |
Lease time in seconds, 0 means unlimited. |
integer |
Minimum value: 300 Maximum value: 8640000 |
604800 |
||||||||
|
mac-acl-default-action |
MAC access control default action (allow or block assigning IP settings). |
option |
- |
assign |
||||||||
|
|
|
|||||||||||
|
forticlient-on-net-status |
Enable/disable FortiClient-On-Net service for this DHCP server. |
option |
- |
enable |
||||||||
|
|
|
|||||||||||
|
dns-service |
Options for assigning DNS servers to DHCP clients. |
option |
- |
specify |
||||||||
|
|
|
|||||||||||
|
dns-server1 |
DNS server 1. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
dns-server2 |
DNS server 2. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
dns-server3 |
DNS server 3. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
dns-server4 |
DNS server 4. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
wifi-ac-service |
Options for assigning WiFi access controllers to DHCP clients. |
option |
- |
specify |
||||||||
|
|
|
|||||||||||
|
wifi-ac1 |
WiFi Access Controller 1 IP address (DHCP option 138, RFC 5417). |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
wifi-ac2 |
WiFi Access Controller 2 IP address (DHCP option 138, RFC 5417). |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
wifi-ac3 |
WiFi Access Controller 3 IP address (DHCP option 138, RFC 5417). |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
ntp-service |
Options for assigning Network Time Protocol (NTP) servers to DHCP clients. |
option |
- |
specify |
||||||||
|
|
|
|||||||||||
|
ntp-server1 |
NTP server 1. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
ntp-server2 |
NTP server 2. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
ntp-server3 |
NTP server 3. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
domain |
Domain name suffix for the IP addresses that the DHCP server assigns to clients. |
string |
Maximum length: 35 |
|
||||||||
|
wins-server1 |
WINS server 1. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
wins-server2 |
WINS server 2. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
default-gateway |
Default gateway IP address assigned by the DHCP server. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
next-server |
IP address of a server (for example, a TFTP sever) that DHCP clients can download a boot file from. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
netmask |
Netmask assigned by the DHCP server. |
ipv4-netmask |
Not Specified |
0.0.0.0 |
||||||||
|
interface |
DHCP server can assign IP configurations to clients connected to this interface. |
string |
Maximum length: 15 |
|
||||||||
|
timezone-option |
Options for the DHCP server to set the client's time zone. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
timezone |
Select the time zone to be assigned to DHCP clients. |
string |
Maximum length: 63 |
|
||||||||
|
tftp-server |
One or more hostnames or IP addresses of the TFTP servers in quotes separated by spaces. TFTP server. |
string |
Maximum length: 63 |
|
||||||||
|
filename |
Name of the boot file on the TFTP server. |
string |
Maximum length: 127 |
|
||||||||
|
server-type |
DHCP server can be a normal DHCP server or an IPsec DHCP server. |
option |
- |
regular |
||||||||
|
|
|
|||||||||||
|
ip-mode |
Method used to assign client IP. |
option |
- |
range |
||||||||
|
|
|
|||||||||||
|
conflicted-ip-timeout |
Time in seconds to wait after a conflicted IP address is removed from the DHCP range before it can be reused. |
integer |
Minimum value: 60 Maximum value: 8640000 |
1800 |
||||||||
|
ipsec-lease-hold |
DHCP over IPsec leases expire this many seconds after tunnel down (0 to disable forced-expiry). |
integer |
Minimum value: 0 Maximum value: 8640000 |
60 |
||||||||
|
auto-configuration |
Enable/disable auto configuration. |
option |
- |
enable |
||||||||
|
|
|
|||||||||||
|
dhcp-settings-from-fortiipam |
Enable/disable populating of DHCP server settings from FortiIPAM. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
auto-managed-status |
Enable/disable use of this DHCP server once this interface has been assigned an IP address from FortiIPAM. |
option |
- |
enable |
||||||||
|
|
|
|||||||||||
|
ddns-update |
Enable/disable DDNS update for DHCP. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
ddns-update-override |
Enable/disable DDNS update override for DHCP. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
ddns-server-ip |
DDNS server IP. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
ddns-zone |
Zone of your domain name (ex. DDNS.com). |
string |
Maximum length: 64 |
|
||||||||
|
ddns-auth |
DDNS authentication mode. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
ddns-keyname |
DDNS update key name. |
string |
Maximum length: 64 |
|
||||||||
|
ddns-key |
DDNS update key (base 64 encoding). |
password_aes256 |
Not Specified |
|
||||||||
|
ddns-ttl |
TTL. |
integer |
Minimum value: 60 Maximum value: 86400 |
300 |
||||||||
|
vci-match |
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
vci-string |
One or more VCI strings in quotes separated by spaces. VCI strings. |
string |
Maximum length: 255 |
|
||||||||
|
shared-subnet |
Enable/disable shared subnet. |
option |
- |
disable |
||||||||
|
|
|
|||||||||||
|
relay-agent |
Relay agent IP. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
config ip-range
|
Parameter |
Description |
Type |
Size |
Default |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||
|
start-ip |
Start of IP range. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
|
end-ip |
End of IP range. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
|
vci-match |
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. |
option |
- |
disable |
||||||
|
|
|
|||||||||
|
vci-string |
One or more VCI strings in quotes separated by spaces. VCI strings. |
string |
Maximum length: 255 |
|
||||||
|
uci-match |
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. |
option |
- |
disable |
||||||
|
|
|
|||||||||
|
uci-string |
One or more UCI strings in quotes separated by spaces. UCI strings. |
string |
Maximum length: 255 |
|
||||||
|
lease-time |
Lease time in seconds, 0 means default lease time. |
integer |
Minimum value: 300 Maximum value: 8640000 |
0 |
||||||
config options
|
Parameter |
Description |
Type |
Size |
Default |
||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||||
|
code |
DHCP option code. |
integer |
Minimum value: 0 Maximum value: 255 |
0 |
||||||||||
|
type |
DHCP option type. |
option |
- |
hex |
||||||||||
|
|
|
|||||||||||||
|
value |
DHCP option value. |
string |
Maximum length: 312 |
|
||||||||||
|
ip |
DHCP option IPs. |
user |
Not Specified |
|
||||||||||
|
vci-match |
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this option. |
option |
- |
disable |
||||||||||
|
|
|
|||||||||||||
|
vci-string |
One or more VCI strings in quotes separated by spaces. VCI strings. |
string |
Maximum length: 255 |
|
||||||||||
|
uci-match |
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this option. |
option |
- |
disable |
||||||||||
|
|
|
|||||||||||||
|
uci-string |
One or more UCI strings in quotes separated by spaces. UCI strings. |
string |
Maximum length: 255 |
|
||||||||||
config exclude-range
|
Parameter |
Description |
Type |
Size |
Default |
||||||
|---|---|---|---|---|---|---|---|---|---|---|
|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||
|
start-ip |
Start of IP range. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
|
end-ip |
End of IP range. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||
|
vci-match |
Enable/disable vendor class identifier (VCI) matching. When enabled only DHCP requests with a matching VCI are served with this range. |
option |
- |
disable |
||||||
|
|
|
|||||||||
|
vci-string |
One or more VCI strings in quotes separated by spaces. VCI strings. |
string |
Maximum length: 255 |
|
||||||
|
uci-match |
Enable/disable user class identifier (UCI) matching. When enabled only DHCP requests with a matching UCI are served with this range. |
option |
- |
disable |
||||||
|
|
|
|||||||||
|
uci-string |
One or more UCI strings in quotes separated by spaces. UCI strings. |
string |
Maximum length: 255 |
|
||||||
|
lease-time |
Lease time in seconds, 0 means default lease time. |
integer |
Minimum value: 300 Maximum value: 8640000 |
0 |
||||||
config reserved-address
|
Parameter |
Description |
Type |
Size |
Default |
||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
id |
ID. |
integer |
Minimum value: 0 Maximum value: 4294967295 |
0 |
||||||||
|
type |
DHCP reserved-address type. |
option |
- |
mac |
||||||||
|
|
|
|||||||||||
|
ip |
IP address to be reserved for the MAC address. |
ipv4-address |
Not Specified |
0.0.0.0 |
||||||||
|
mac |
MAC address of the client that will get the reserved IP address. |
mac-address |
Not Specified |
00:00:00:00:00:00 |
||||||||
|
action |
Options for the DHCP server to configure the client with the reserved MAC address. |
option |
- |
reserved |
||||||||
|
|
|
|||||||||||
|
circuit-id-type |
DHCP option type. |
option |
- |
string |
||||||||
|
|
|
|||||||||||
|
circuit-id |
Option 82 circuit-ID of the client that will get the reserved IP address. |
string |
Maximum length: 312 |
|
||||||||
|
remote-id-type |
DHCP option type. |
option |
- |
string |
||||||||
|
|
|
|||||||||||
|
remote-id |
Option 82 remote-ID of the client that will get the reserved IP address. |
string |
Maximum length: 312 |
|
||||||||
|
description |
Description. |
var-string |
Maximum length: 255 |
|
||||||||