Skip to main content

DhcpServer

warning

This API is not documented yet.

Overview​

Core DHCP Server API implementation for Synology NAS.

This class provides methods to retrieve and manage DHCP server, PXE, TFTP, and network interface information.

Methods​

general_info​

Get general DHCP server information for a given interface.

Internal API​

SYNO.Network.DHCPServer

Parameters​

ifname str
Interface name. Defaults to 'ovs_eth0'.

Returns​

dict[str, object] or str
General DHCP server information.


vendor​

Get DHCP vendor information.

Internal API​

SYNO.Network.DHCPServer.Vendor

Returns​

dict[str, object] or str
DHCP vendor information.


pxe​

Get PXE server information.

Internal API​

SYNO.Network.DHCPServer.PXE

Returns​

dict[str, object] or str
PXE server information.


tftp​

Get TFTP server information.

Internal API​

SYNO.Core.TFTP

Returns​

dict[str, object] or str
TFTP server information.


network_bond​

Get network bond interface information.

Internal API​

SYNO.Core.Network.Bond

Returns​

dict[str, object] or str
Network bond interface information.


network_ethernet​

Get network ethernet interface information.

Internal API​

SYNO.Core.Network.Ethernet

Returns​

dict[str, object] or str
Network ethernet interface information.


dhcp_clientlist​

Get DHCP client list for a given interface.

Internal API​

SYNO.Network.DHCPServer.ClientList

Parameters​

ifname str
Interface name. Defaults to 'bond0'.

Returns​

dict[str, object] or str
DHCP client list.


dhcp_reservations​

Get DHCP reservations for a given interface.

Internal API​

SYNO.Network.DHCPServer.Reservation

Parameters​

ifname str
Interface name. Defaults to 'bond0'.

Returns​

dict[str, object] or str
DHCP reservations.