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

Test 1: Gets the MVR admin mode.
Test 2: Sets the MVR admin mode.
Test 3: Gets the MVR query time.
Test 4: Sets the MVR query time.
Test 5: Gets the MVR mode type.
Test 6: Sets the MVR mode type.
Test 7: Gets the MVR multicast vlan.
Test 8: Sets the MVR multicast vlan.
Test 9: Check if receivers participate in specific vlan.
Test 10: Gets the MVR interface mode.
Test 11: Sets the MVR interface mode.
Test 12: Gets the interface MVR type of a specified interface.
Test 13: Sets the interface MVR type of a specified interface.
Test 14: Gets the immediate leave mode of a specified interface.
Test 15: Sets the immediate leave mode of a specified interface.
Test 16: Add static group IP address.
Test 17: Delete static group IP address.
Test 18: Add specified interface to the group.
Test 19: Delete specified interface from the group.
Test 20: Display MVR group entries.
Test 21: List MVR members.
Test 22: Get next MVR interface.
Test 23: Get the number of the group entries.
Test 24: Get the group IDs registered on specified interface.
Test 25: Get the group IPs statically registered on specified interface.
Test 26: Get the global PDU counter values.

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

mvr_example

mvr_example.c is a sample application that demonstrates the use of OpEN's MVR APIs. mvr_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: s <test#> <arg1> <arg2> ...
Test 1: Gets the MVR admin mode: s 1
Test 2: Sets the MVR admin mode: s 2 <adminMode>
Test 3: Gets the MVR query time: s 3
Test 4: Sets the MVR query time: s 4 <queryTime>
Test 5: Gets the MVR mode type: s 5
Test 6: Sets the MVR mode type: s 6 <modeType>
Test 7: Gets the MVR multicast vlan: s 7
Test 8: Sets the MVR multicast vlan: s 8 <multicastVlan>
Test 9: Check if receivers participate in specific vlan: s 9 <vlanId>
Test 10: Gets the MVR interface mode: s 10 <ifNum>
Test 11: Sets the MVR interface mode: s 11 <ifNum> <intfMode>
Test 12: Gets the interface MVR type of a specified interface: s 12 <ifNum>
Test 13: Sets the interface MVR type of a specified interface: s 13 <ifNum> <intfMvrType>
Test 14: Gets the immediate leave mode of a specified interface: s 14 <ifNum>
Test 15: Sets the immediate leave mode of a specified interface: s 15 <ifNum> <immediateMode>
Test 16: Add static group IP address: s 16 <groupIp>
Test 17: Delete static group IP address: s 17 <groupIp>
Test 18: Add specified interface to the group: s 18 <ifNum> <groupIp>
Test 19: Delete specified interface from the group: s 19 <ifNum> <groupIp>
Test 20: Display MVR group entries: s 20
Test 21: List MVR members: s 21
Test 22: Get next MVR interface: s 22 <ifNum>
Test 23: Get the number of the group entries: s 23
Test 24: Get the group IDs registered on specified interface: s 24 <ifNum>
Test 25: Get the group IPs statically registered on specified interface: s 25 <ifNum>
Test 26: Get the global PDU counter values: s 26

MVR CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show mvr	openapiMvrAdminModeGet() openapiMvrQueryTimeGet() openapiMvrModeTypeGet() openapiMvrModeTypeGet() openapiMvrMulticastVlanGet() openapiMvrGroupNumGet()
(Config)# [no] mvr	openapiMvrAdminModeSet()
(Config)# [no] mvr querytime <query time>	openapiMvrQueryTimeSet()
(Config)# [no] mvr mode {compatible \| dynamic}	openapiMvrModeTypeSet()
(Config)# [no] mvr vlan <vlanId>	openapiMvrMulticastVlanSet()
(Interface-Config Mode)# [no] mvr	openapiMvrIntfModeSet()
(Priv-User Mode)# show mvr interface	openapiMvrIntfMvrTypeGet()
(Interface-Config Mode)# [no] mvr type {receiver \| source}	openapiMvrIntfMvrTypeSet()
(Priv-User Mode)# show mvr interface <slot/port>	openapiMvrIntfImmediateModeGet()
(Interface-Config Mode)# [no] mvr immediate	openapiMvrIntfImmediateModeSet()
(Config)# mvr group <A.B.C.D>	openapiMvrGroupIpAdd()
(Config)# [no] mvr group <A.B.C.D>	openapiMvrGroupIpDelete()
(Interface-Config Mode)# mvr vlan <multicast VLAN> group <A.B.C.D>	openapiMvrIntfGroupIpAdd()
(Interface-Config Mode)# [no] mvr vlan <multicast VLAN> group <A.B.C.D>	openapiMvrIntfGroupIpDelete()
(Priv-User Mode)# show mvr members	openapiMvrEntryGetNext() openapiMvrIntfGroupGetNext() openapiMvrGroupStatusGet() openapiMvrGroupIdGet()
(Priv-User Mode)# show mvr interface	openapiMvrGroupIpGet() openapiMvrIntfGetNext() openapiMvrIntfGroupIdGetNext()
(Priv-User Mode)# show mvr interface <slot/port>	openapiMvrIntfEntryTypeGet()
(Priv-User Mode)# show mvr traffic	openapiMvrPduCounterGet()