MVRP API

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

• Get the global MVRP mode.
• set the global MVRP mode.
• Gets the MVRP periodic state machine mode.
• Sets the MVRP periodic state machine mode.
• Get the MVRP mode for the specified interface.
• Set the MVRP mode for the given interface.
• Check if the current interface is valid for MVRP.
• Given the current interface, get the next valid MVRP interface.
• Get the value of specified MVRP counter.
• Get the value of specified MVRP counter for an interface.
• Get MVRP VLAN array in the system.
• Get MVRP VLAN array on an interface.
• Clear MVRP traffic counters on specified interface.
• Clear global MVRP traffic counters.
• Clear all MVRP traffic counters.

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

mvrp_example

mvrp_example.c is a sample application that demonstrates the use of OpEN's mvrp APIs. mvrp_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: ./mvrp_example <test#> <arg1> <arg2> ...
• Test 1: Get the global MVRP mode: mvrp_example 1
• Test 2: set the global MVRP mode: mvrp_example 2 <mode>
• Test 3: Gets the MVRP periodic state machine mode: mvrp_example 3
• Test 4: Sets the MVRP periodic state machine mode: mvrp_example 4 <mode>
• Test 5: Get the MVRP mode for the specified interface: mvrp_example 5 <intIfNum>
• Test 6: Set the MVRP mode for the given interface: mvrp_example 6 <intIfNum> <mode>
• Test 7: Check if the current interface is valid for MVRP: mvrp_example 7 <intIfNum>
• Test 8: Given the current interface, get the next valid MVRP interface: mvrp_example 8 <intIfNum>
• Test 9: Get the value of specified MVRP counter: mvrp_example 9 <type>
• Test 10: Get the value of specified MVRP counter for an interface: mvrp_example 10 <intIfNum> <type>
• Test 11: Get MVRP VLAN array in the system: mvrp_example 11 <vlanType>
• Test 12: Get MVRP VLAN array on an interface: mvrp_example 12 <intIfNum> <vlanType>
• Test 13: Clear MVRP traffic counters on specified interface: mvrp_example 13 <intIfNum>
• Test 14: Clear global MVRP traffic counters: mvrp_example 14
• Test 15: Clear all MVRP traffic counters: mvrp_example 15
• Test 16: Run API sanity checks: mvrp_example 16

mvrp CLI/API Cross Reference

CLI Command	OpEN API Reference
show mvrp summary	openapiMvrpModeGet() openapiMvrpPeriodicStateMachineModeGet() openapiMvrpVlanArrayGet()
show mvrp interface <slot-port/all>	openapiMvrpIntfModeGet() openapiMvrpIsValidIntfGet() openapiMvrpValidIntfNextGet() openapiMvrpIntfVlanArrayGet()
mvrp	openapiMvrpModeSet()
mvrp periodic state machine	openapiMvrpPeriodicStateMachineModeSet()
clear mvrp statistics	openapiMvrpTrafficCountersPerIfClear() openapiMvrpTrafficCountersClear() openapiMvrpTrafficGlobalCountersClear()