create_dhcp_reservation
Reserve an IPv4 address for a MAC address on a FortiGate DHCP server, automatically selecting the matching server and rejecting duplicate IP or MAC reservations.
Instructions
Reserve an IP address for a MAC address on a FortiGate DHCP server.
The DHCP server is selected by dhcp_server_id, else by interface, else automatically by the server whose range/subnet contains the IP. Duplicate IP or MAC reservations are rejected before anything is written.
Parameters:
device_id: Identifier of the FortiGate device
ip: IPv4 address to reserve
mac: MAC address (aa:bb:cc:dd:ee:ff)
description: Optional description (e.g. hostname / owner)
dhcp_server_id: Optional DHCP server ID (see list_dhcp_servers)
interface: Optional interface name whose DHCP server should hold the reservation
vdom: Virtual Domain name (optional)
Returns:
Creation status with the chosen DHCP server
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| ip | Yes | IPv4 address to reserve | |
| mac | Yes | MAC address (aa:bb:cc:dd:ee:ff) | |
| vdom | No | Virtual Domain | |
| device_id | Yes | FortiGate device identifier | |
| interface | No | Interface whose DHCP server to use | |
| description | No | Description | |
| dhcp_server_id | No | DHCP server ID |