lease
ip/dhcp-server/lease
Type: Directory
Leases of the DHCP servers. Dynamic leases are created when clients get an address from a pool; static leases give a specific client a fixed address, a pool, or its own settings. For details, see DHCP Server.
| Flag | Name | Description |
|---|---|---|
| X | disabled | The lease is disabled. |
| R | radius | The lease was assigned by a RADIUS server. |
| D | dynamic | The lease is dynamic: it was created when a client got an address from the pool. Use make-static to turn it into a static lease. |
| B | blocked | The client is blocked (block-access=yes) and gets no reply from the server. |
| Argument | Type | Description |
|---|---|---|
| address | alt { ip-address: ipAddr , pool: enum } | IP address of a static lease, or the name of an IP pool to give the client an address from. With 0.0.0.0, the address pool of the server is used. |
| mac-address | macAddr | MAC address of the client the static lease is for. |
| use-src-mac | bool | Whether to identify the client by the source MAC address of its packets instead of the client hardware address field (chaddr) of the DHCP message. |
| client-id | string | Client identifier (option 61) of the client the static lease is for, in the format shown in active-client-id, for example 1:4e:97:a1:4c:d1:38. |
| rate-limit | string | Bandwidth limit for the client, as The server creates a dynamic simple queue named |
| routes | object { route: composite { dst-address: address (flags=4/) , gateway: [ composite { gateway: address (flags=46ivL) , distance: [ num [1 .. 255]] }] } } | Routes the server adds while the lease is bound, as dst-address/mask gateway distance entries separated by commas, for example 10.77.0.0/24 172.31.255.105 5. |
| insert-queue-before | enum (bottom | first) { bottom:0xffffffff, first:0 } | Where to place the dynamic simple queue created for this lease: first (default) at the top of /queue/simple, bottom at the end, or before the named queue. |
| parent-queue | enum (none) { none:0 } | Parent of the dynamic simple queue created for this lease. Default: none. |
| queue-type | enum | Queue type of the dynamic simple queue created for this lease. |
| address-lists | multi { array-id, address-list: string } | Firewall address lists to which the address of the lease is added while the lease is bound. |
| server | enum (all) { all:0 } | DHCP server the lease belongs to. With all, the static lease is valid on every server. |
| block-access | bool | Whether to block the client: the server does not answer it, and the lease gets the B flag. Default: no. |
| allow-dual-stack-queue | bool | Whether this lease and a DHCPv6 binding of the same client share one dynamic simple queue, which then contains both the IPv4 and the IPv6 address. Default: yes. |
| lease-time | time | Lease time for this client. When not set, or set to 0s, the lease-time of the server is used. |
| always-broadcast | bool | Whether to broadcast replies to this client even when it has not set the broadcast flag. Default: no. |
| dhcp-option | multi { array-id, option: enum } | Options (/ip/dhcp-server/option) to send to this client. They take precedence over the options of the server and of the network. |
| dhcp-option-set | enum (none) | Option set (/ip/dhcp-server/option/sets) to send to this client. It takes precedence over the options of the server and of the network. |
| agent-circuit-id | string | When set, the lease matches requests whose relay agent information (option 82) contains this circuit ID, even if the MAC address or client ID differ. |
| agent-remote-id | string | When set, the lease matches requests whose relay agent information (option 82) contains this remote ID, even if the MAC address or client ID differ. |
| Read-only Argument | Type | Description |
|---|---|---|
| status | enum (waiting | testing | declined | offered | bound | authorizing | conflict) { waiting:0, testing:1, declined:2, offered:3, bound:4, authorizing:5 } | State of the lease:
|
| expires-after | time | Time until the lease expires. |
| last-seen | alt { symbolic-names: enum (never | sometime) { never:0xffffffff, sometime:0xfffffffe } , time: time } | Time since the server last received a request from the client, or never. |
| age | time | Time since the lease was created. |
| active-address | ipAddr | IP address the client uses. |
| active-mac-address | macAddr | MAC address of the client that uses the lease. |
| active-client-id | string | Client identifier (option 61) of the client that uses the lease. |
| active-server | enum | DHCP server that serves the client. |
| active-agent-circuit-id | string | Circuit ID from the relay agent information (option 82) of the client's request, in hex. |
| active-agent-remote-id | string | Remote ID from the relay agent information (option 82) of the client's request, in hex. |
| active-agent-circuit-id-ascii | string | Circuit ID from the relay agent information (option 82) of the client's request, as text. |
| active-agent-remote-id-ascii | string | Remote ID from the relay agent information (option 82) of the client's request, as text. |
| host-name | string | Host name the client sent (option 12). |
| class-id | string | DHCP option 60 from last received DHCP request |
| src-mac-address | macAddr | Source MAC address of the client's last request. |
| reconfigure-key | string | Key the server gave the client, in its reply when the client bound, for authenticating Reconfigure messages (RFC 6704, HMAC-MD5). Requires use-reconfigure on the server. |
| reconfigure-last-sent | string | Replay-detection counter of the last Reconfigure message sent to the client. It increases with every Reconfigure message. |
| reconfigure-status | string |