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

Get the GMRP global status.
Set the GMRP global status.
Get the GMRP interface status.
Set the GMRP interface status.
Get the GVRP global status.
Set the GVRP global status.
Get the GVRP interface status.
Set the GVRP interface status.
Get the GARP Join Time.
Set the GARP Join Time.
Get the GARP Leave Time.
Set the GARP Leave Time.
Get the GARP Leave All Time.
Set the GARP Leave All Time.

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

garp_example

garp_example.c is a sample application that demonstrates the use of OpEN's GARP APIs. garp_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: ./garp_example <test#> <arg1> <arg2> ...
Test 1: Get the GMRP global status: garp_example 1 <globalGmrpStatus>
Test 2: Set the GMRP global status. enable(1) and disable (0): garp_example 2 <globalGmrpStatus>
Test 3: Get the GMRP interface status: garp_example 3 <ifNum> <intfGmrpStatus>
Test 4: Set the GMRP interface status. enable(1) and disable (0): garp_example 4 <ifNum> <intfGmrpStatus>
Test 5: Get the GVRP global status: garp_example 5 <globalGvrpStatus>
Test 6: Set the GVRP global status. enable(1) and disable (0): garp_example 6 <globalGvrpStatus>
Test 7: Get the GVRP interface status: garp_example 7 <ifNum> <intfGvrpStatus>
Test 8: Set the GVRP interface status. enable(1) and disable (0): garp_example 8 <ifNum> <intfGvrpStatus>
Test 9: Get the GARP Join Time: garp_example 9 <ifNum> <joinTime>
Test 10: Set the GARP Join Time: garp_example 10 <ifNum> <joinTime>
Test 11: Get the GARP Leave Time: garp_example 11 <ifNum> <leaveTime>
Test 12: Set the GARP Leave Time: garp_example 12 <ifNum> <joinTime>
Test 13: Get the GARP Leave All Time: garp_example 13 <ifNum> <leaveAllTime>
Test 14: Set the GARP Leave All Time: garp_example 14 <ifNum> <joinTime>
Test 15: Run API sanity checks: garp_example 15

GARP CLI/API Cross Reference

CLI Command	OpEN API Reference
(Privileged exec Mode)# set gmrp adminmode	openapiGarpGmrpEnableSet()
(Privileged exec Mode)# set gvrp adminmode	openapiGarpGvrpEnableSet()
(Privileged exec Mode)# no set gmrp adminmode	openapiGarpGmrpEnableSet()
(Privileged exec Mode)# no set gvrp adminmode	openapiGarpGvrpEnableSet()
(Priv-User Mode)# show garp	openapiGarpGmrpEnableGet() openapiGarpGvrpEnableGet()
(Interface Mode)# set gmrp interfacemode	openapiGarpGmrpPortEnableSet()
(Interface Mode)# set gvrp interfacemode	openapiGarpGvrpPortEnableSet()
(Interface Mode)# set garp timer join <joinTime>	openapiGarpJoinTimeSet()
(Interface Mode)# set garp timer leave <leaveTime>	openapiGarpLeaveTimeSet()
(Interface Mode)# set garp timer leaveall <leaveAllTime>	openapiGarpLeaveAllTimeSet()
(Interface Mode)# no set gmrp interfacemode	openapiGarpGmrpPortEnableSet()
(Interface Mode)# no set gvrp interfacemode	openapiGarpGvrpPortEnableSet()
(Interface Mode)# no set garp timer join	openapiGarpJoinTimeSet()
(Interface Mode)# no set garp timer leave	openapiGarpLeaveTimeSet()
(Interface Mode)# no set garp timer leaveall	openapiGarpLeaveAllTimeSet()
(Priv-User Mode)# show gmrp configuration {all \| <interface-id>}	openapiGarpGmrpPortEnableGet() openapiGarpJoinTimeGet() openapiGarpLeaveTimeGet() openapiGarpLeaveAllTimeGet()
(Priv-User Mode)# show gvrp configuration {all \| <interface-id>}	openapiGarpGvrpPortEnableGet() openapiGarpJoinTimeGet() openapiGarpLeaveTimeGet() openapiGarpLeaveAllTimeGet()