DHCP Server API

This document provides a brief description of the DHCP Server OpEN APIs. It provides the following services:

• Get lease data for a specific IP address in default VRF.
• Get lease data for a specific VRF and IP address.
• Get pool entries.
• Given a pool name, get lease entries.
• Given a pool name, get pool type.
• Display DHCP server statistics.
• Test DHCP server OpEN API Sanity.
• Add an excluded IP-address range for a specific VRF.
• Delete an excluded IP-address range for a specific VRF.
• Set the VRF name for a DHCP server pool.
• Reset the VRF name to default VRF's name for a DHCP server pool.
• Get excluded addresses range entries.
• Clear all lease data of a VRF.
• Clear lease data for VRF and ipaddr.
• Clear all lease data of a pool.
• Clear lease data for a specific pool and IP address.
• Clear all lease data across all VRFs.

Example C Application dhcp_server_example

Initialization

In the main function, the sample application initializes the OpEN API RPC service by calling openapiClientRegister() and waits for the RPC service in switchdrvr to start. A Client Handle is returned by openapiClientRegister() which is used while invoking the OpEN APIs. The application then exercises the associated OpEN APIs and logs informational and/or error messages on the console. The example application runs to its completion and exits.

dhcp_server_example

dhcp_server_example.c is a sample application that demonstrates the use of OpEN's DHCP Server APIs. dhcp_server_example is started from the command line and can be used to exercise the various APIs by specifying arguments on the command line.

Sample Output

• Usage: dhcps_example <test#> <arg1> <arg2> ...
• Test 1: Get lease data for ipaddr in default VRF: dhcps_example 1 <ipaddr>
• Test 2: Get lease data for VRF and ipaddr: dhcps_example 2 <vrf-name> <ipaddr>
• Test 3: Get pool entries: dhcps_example 3
• Test 4: Given a pool name, get lease entries: dhcps_example 4 <pool name>="">
• Test 5: Given a pool name, get pool type: dhcps_example 5 <pool name>="">
• Test 6: Display DHCP server statistics: dhcps_example 6
• Test 7: Test DHCP server OpEN API Sanity: dhcps_example 7
• Test 8: Add an excluded IP-address range for a VRF: dhcps_example 8 <low-ipaddr> <high-ipaddr> <vrf-name>
• Test 9: Delete an excluded IP-address range for a VRF: dhcps_example 9 <low-ipaddr> <high-ipaddr> <vrf-name>
• Test 10: Set the VRF name for a DHCP server pool: dhcps_example 10 <pool-name> <vrf-name>
• Test 11: Reset the VRF name to default VRF's name for a DHCP server pool: dhcps_example 11 <pool-name>
• Test 12: Get excluded addresses range entries: dhcps_example 12
• Test 13: Clear all lease data of a VRF: dhcps_example 13 <vrf-name>
• Test 14: Clear lease data for VRF and ipaddr: dhcps_example 14 <vrf-name> <ipaddr>
• Test 15: Clear all lease data of a pool: dhcps_example 15 <pool-name>
• Test 16: Clear lease data for pool and ipaddr: dhcps_example 16 <pool-name> <ipaddr>
• Test 17: Clear all lease data across all VRFs: dhcps_example 17

It exercises all the DHCP Server OpEN APIs with appropriate arguments to manage the DHCP-Server component in the EFOS main process (switchdrvr).

DHCP Server CLI/API Cross Reference

CLI Command | OpEN API Reference ---------— | ---------------— (Priv-User Mode)##
show ip dhcp pool configuration all | openapiDhcpServerPoolEntryFirstGet() | openapiDhcpServerPoolEntryNextGet (Priv-User Mode)##
show ip dhcp binding all | openapiDhcpServerLeaseEntryFirstGet
openapiDhcpServerLeaseEntryNextGet()
openapiDhcpServerLeaseDataGet() (Priv-User Mode)##
show ip dhcp binding vrf <vrf-name> <ipaddress> | openapiDhcpServerVrfIpAddrLeaseDataGet() (Priv-User Mode)##
show ip dhcp server statistics | openapiDhcpServerStatGet() (Priv-User Mode)##
show ip dhcp pool configuration <pool-name> | openapiDhcpServerPoolVrfNameGet()
openapiDhcpServerPoolTypeGet() (Config-dhcp-pool)##
vrf <vrf-name> | openapiDhcpServerPoolVrfNameSet() (Config-dhcp-pool)##
no vrf | openapiDhcpServerPoolVrfNameSetToDefaultVrf() (Priv-User Mode)##
show ip dhcp global configuration | openapiDhcpServerExcludedAddressRangeEntryFirstGet()
openapiDhcpServerExcludedAddressRangeEntryNextGet() (Config)##
ip dhcp excluded-address vrf <vrf-name> <low-address> <high-address> | openapiDhcpServerExcludedAddressRangeAdd() (Config)##
no ip dhcp excluded-address vrf <vrf-name> <low-address> <high-address> | openapiDhcpServerExcludedAddressRangeDelete() (Priv-User Mode)##
openapiDhcpServerVrfIpAddrLeaseDataGet() (Priv-User Mode)##
clear ip dhcp binding vrf <vrf-name> <ipaddress> | openapiDhcpServerVrfIpAddrLeaseDataClear() (Priv-User Mode)##
clear ip dhcp binding pool <pool-name> | <ipaddress> | openapiDhcpServerPoolIpAddrLeaseDataClear() (Priv-User Mode)##
clear ip dhcp binding vrf <vrf-name> | openapiDhcpServerVrfLeaseDataClear() (Priv-User Mode)##
clear ip dhcp binding pool <pool-name> | openapiDhcpServerPoolLeaseDataClear() (Priv-User Mode)##
clear ip dhcp binding * | openapiDhcpServerAllLeaseDataClear()