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

Get the DHCP Vendor Option Mode.
Set the DHCP Vendor Option Mode.
Get the DHCP Vendor Class Option string.
Set the DHCP Vendor Class Option string.
Get the DHCP server IP address on a management interface
Get the current state of the DHCP client for specified interface or management port
Get the current state of the DHCP client for specified interface or management port
Get the transaction ID of the DHCP client for specified interface
Get the transaction ID of the DHCP client for specified interface or management port
Get the lease time information of the DHCP client for specified interface
Get the lease time information of the DHCP client for specified interface or management port
Get the retry count of the DHCP client for specified interface.
Get the retry count of the DHCP client for specified interface or management port
Get the generated client identifier on the interface.
Get the DHCP Client Statistics on an interface.
Clear the DHCP Client Statistics on an interface.

Example C Application ip4dhcpclient_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.

ip4dhcpclient_example

ip4dhcpclient_example.c is a sample application that demonstrates the use of OpEN's IP4DHCPClient APIs. ip4dhcpclient_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: ./ip4dhcpclient_example <test#> <arg1> <arg2> ...
Test 1: Get the DHCP Vendor Option Mode: ip4dhcpclient_example 1
Test 2: Set the DHCP Vendor Option Mode: ip4dhcpclient_example 2 <mode> <actImmediate>
Test 3: Get the DHCP Vendor Class Option string: ip4dhcpclient_example 3
Test 4: Set the DHCP Vendor Class Option string: ip4dhcpclient_example 4 <option-string> <actImmediateFlag>
Test 5: Get the DHCP server IP address on a management interface: ip4dhcpclient_example 5 <ifNum> <mgmtPortType>
Test 6: Get the current state of the DHCP client for specified interface or management port: ip4dhcpclient_example 6 <ifNum> <mgmtPortType>
Test 7: Get the transaction ID of the DHCP client for specified interface or management port: ip4dhcpclient_example 7 <ifNum> <mgmtPortType>
Test 8: Get the lease time information of the DHCP client for specified interface or management port: ip4dhcpclient_example 8 <ifNum> <mgmtPortType>
Test 9: Get the retry count of the DHCP client for specified interface or management port: ip4dhcpclient_example 9 <ifNum> <mgmtPortType>
Test 10: Get the generated client identifier on the management interface: ip4dhcpclient_example 10 <ifNum> <mgmtPortType>
Test 11: Get the DHCP Client Statistics on an interface: ip4dhcpclient_example 11 <ifNum>
Test 12: Clear the DHCP Client Statistics on an interface: ip4dhcpclient_example 12 <ifNum>
Test 13: Run API sanity checks: ip4dhcpclient_example 13

IP4DHCPClient CLI/API Cross Reference

CLI Command	OpEN API Reference
(Privileged exec Mode)# show dhcp client vendor-id-option	openapiDhcpVendorClassOptionAdminModeGet()
(localhost)(Interface vlan 10)# dhcp client vendor-id-option	openapiDhcpVendorClassOptionAdminModeSet()
(Privileged exec Mode)# show dhcp client vendor-id-option	openapiDhcpVendorClassOptionStringGet()
(localhost)(Interface vlan 10)# dhcp client vendor-id-option-string <string>	openapiDhcpVendorClassOptionStringSet()
(Privileged exec Mode)# show dhcp lease interface out-of-band	openapiIpDhcpClientDhcpServerIntfIPAddressGet()
(Privileged exec Mode)# show dhcp lease interface out-of-band	openapiIpDhcpClientIntfStateGet()
(Privileged exec Mode)# show dhcp lease interface out-of-band	openapiIpDhcpClientTransactionIntfIdGet()
(Privileged exec Mode)# show dhcp lease interface out-of-band	openapiIpDhcpClientLeaseTimeIntfInfoGet()
(Privileged exec Mode)# show dhcp lease interface out-of-band	openapiIpDhcpClientIntfRetryCountGet()
(Privileged exec Mode)# show network show serviceport show ip interface <u/s/p>	openapiIpDhcpClientIdGeneratedGet()
(Privileged exec Mode)# show ip dhcp client statistics [interface <u/s/p>]	openapiDhcpClientStatsGet()
(Privileged exec Mode)# clear ip dhcp client statistics [interface <u/s/p>]	openapiDhcpClientStatsClear()