Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
IPv4 Device Tracking API

This document provides a brief description of the IPv4 Device Tracking OpEN APIs. It provides the following services:

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

ipv4_device_tracking_example

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

Sample Output

It exercises all the IPv4 Device Tracking OpEN APIs with appropriate arguments to manage the IPv4DT component in the ICOS main process (switchdrvr).

IPv4 Device Tracking CLI/API Cross Reference

CLI Command OpEN API Reference
(Config)#
[no] ip device tracking
openapiIpv4dtAdminModeSet()
(Config)#
[no] ip device tracking probe
openapiIpv4dtProbeModeSet()
(Config)#
[no] ip device tracking probe count <1-255>
openapiIpv4dtProbeCountSet()
(Config)#
[no] ip device tracking probe interval <30-300>
openapiIpv4dtProbeIntervalSet()
(Config)#
[no] ip device tracking probe delay <1-120>
openapiIpv4dtProbeDelaySet()
(Config)#
[no] ip device tracking probe auto-source <host-ip> <mask> override
openapiIpv4dtProbeAutoSourceSet()
(Interface 0/1)#
[no] ip device tracking maximum <0-10>
openapiIpv4dtIntfMaxSet()
#
show ip device tracking all
openapiIpv4dtAllEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
#
show ip device tracking all active
openapiIpv4dtActiveEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
#
show ip device tracking all inactive
openapiIpv4dtInactiveEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
#
show ip device tracking all count
openapiIpv4dtEntriesCount()
#
show ip device tracking ip <ip-address>
openapiIpv4dtIpEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
#
show ip device tracking mac <mac-address>
openapiIpv4dtMacEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
#
show ip device tracking interface <intf-name>
openapiIpv4dtInterfaceEntriesGetNext()
openapiIpv4dtAdminModeGet()
openapiIpv4dtProbeModeGet()
openapiIpv4dtProbeCountGet()
openapiIpv4dtProbeIntervalGet()
openapiIpv4dtProbeDelayGet()
openapiIpv4dtProbeAutoSourceGet()
openapiIpv4dtIntfMaxGet()
#
clear ip device tracking all
openapiIpv4dtClearEntriesAll()
#
clear ip device tracking ip <ip-address>
openapiIpv4dtClearEntriesIp()
#
clear ip device tracking mac <mac-address>
openapiIpv4dtClearEntriesMac()
#
clear ip device tracking interface <intf-name>
openapiIpv4dtClearEntriesInterface()