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

Get the snooping fast leave auto-assignment global mode.
Set the global mode for the fast leave auto-assignment.
Get the IGMP plus mode.
Set the IGMP plus mode.
Get the VLAN list on which static mrouter is enabled.
Set the VLAN list on which static mrouter is enabled.
Get the interface based fast leave auto-assignment mode.
Set the fast leave auto-assignment mode on an interface.
Get the multicast router expiry time value on an interface.
Set the multicast router expiry time value on an interface.
Get the Multicast Router Detected mode on a specified vlan, interface.
Set the specified interface as a multicast router interface.
Get the Multicast Router Detected status for the specified interface.
To check if Auto-Video feature is supported and enabled.
To check if mrouter ports are excluded from the forwarding list.
Configure to exclude mrouter ports from the forwarding list.
Get the next supported protocol family given the family.
Get the last detected Querier MAC Address on a vlan.
Get the global mode based on which Reports will be flooded.
Set the global mode based on which Reports will be flooded.
Get whether router alert checking in IGMP frames is enabled.
Set if router alert checking in IGMP frames to be enabled.
Get the igmp plus vlan mode.
Set the igmp plus vlan mode.
Get the configured IGMP Snooping Mcast Router Expiry Time for the VLAN.
Set the configured IGMP Snooping Mcast Router Expiry Time for the VLAN.
Get the static and dynamic Mrouter interface list.
Get the VLAN mode for excluding mrouter ports.
Set the VLAN mode for excluding mrouter ports.
Get the report flood mode in the VLAN.
Set the report flood mode in the VLAN.
Get the IGMP static mcast router attached status for the specified interface/VLAN.

Example C Application openapi_snooping_example_ext

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.

openapi_snooping_example_ext

openapi_snooping_example_ext.c is a sample application that demonstrates the use of OpEN's openapi_snooping_ext APIs. openapi_snooping_example_ext 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: ./openapi_snooping_example_ext <test#> <arg1> <arg2> ...
Test 1: Get the snooping fast leave auto-assignment global mode: openapi_snooping_example_ext 1 <family>
Test 2: Set the global mode for the fast leave auto-assignment: openapi_snooping_example_ext 2 <family> <mode>
Test 3: Get the IGMP plus mode: openapi_snooping_example_ext 3 <family>
Test 4: Set the IGMP plus mode: openapi_snooping_example_ext 4 <family> <mode>
Test 5: Get the VLAN list on which static mrouter is enabled: openapi_snooping_example_ext 5 <family> <ifNum>
Test 6: Set the status of static mrouter enabled/disabled on an interface: openapi_snooping_example_ext 6 <family> <ifNum> <status>
Test 7: Get the interface based fast leave auto-assignment mode: openapi_snooping_example_ext 7 <family> <ifNum>
Test 8: Set the fast leave auto-assignment mode on an interface: openapi_snooping_example_ext 8 <family> <ifNum> <mode>
Test 9: Get the multicast router expiry time value on an interface: openapi_snooping_example_ext 9 <family> <ifNum>
Test 10: Set the multicast router expiry time value on an interface: openapi_snooping_example_ext 10 <family> <ifNum> <expiryTime>
Test 11: Get the Multicast Router Detected mode on a specified vlan, interface: openapi_snooping_example_ext 11 <family> <ifNum> <vlanId>
Test 12: Set the specified interface as a multicast router interface: openapi_snooping_example_ext 12 <family> <ifNum> <mode>
Test 13: Get the Multicast Router Detected status for the specified interface: openapi_snooping_example_ext 13 <family> <ifNum>
Test 14: To check if Auto-Video feature is supported and enabled: openapi_snooping_example_ext 14 <vlanId>
Test 15: To check if mrouter ports are excluded from the forwarding list: openapi_snooping_example_ext 15 <family>
Test 16: Configure to exclude mrouter ports from the forwarding list: openapi_snooping_example_ext 16 <family> <mode>
Test 17: Get the next supported protocol family given the family: openapi_snooping_example_ext 17 <family>
Test 18: Get the last detected Querier MAC Address: openapi_snooping_example_ext 18 <family> <vlan>
Test 19: Get the global mode based on which Reports will be flooded: openapi_snooping_example_ext 19 <family>
Test 20: Set the global mode based on which Reports will be flooded: openapi_snooping_example_ext 20 <family> <mode>
Test 21: Get whether router alert checking in IGMP frames is enabled: openapi_snooping_example_ext 21 <family>
Test 22: Set if router alert checking in IGMP frames to be enabled: openapi_snooping_example_ext 22 <family> <checkRtrAlert>
Test 23: Get the igmp plus vlan mode: openapi_snooping_example_ext 23 <family> <vlan>
Test 24: Set the igmp plus vlan mode: openapi_snooping_example_ext 24 <family> <vlan> <mode>
Test 25: Get the configured IGMP Snooping Mcast Router Expiry Time for the VLAN: openapi_snooping_example_ext 25 <family> <vlan>
Test 26: Set the configured IGMP Snooping Mcast Router Expiry Time for the VLAN: openapi_snooping_example_ext 26 <family> <vlan> <expiryTime>
Test 27: Get the static and dynamic Mrouter interface list: openapi_snooping_example_ext 27 <family> <vlan>
Test 28: Get the VLAN mode for excluding mrouter ports: openapi_snooping_example_ext 28 <family> <vlan>
Test 29: Set the VLAN mode for excluding mrouter ports: openapi_snooping_example_ext 29 <family> <vlan> <mode>
Test 30: Get the report flood mode in the VLAN: openapi_snooping_example_ext 30 <family> <vlan>
Test 31: Set the report flood mode in the VLAN: openapi_snooping_example_ext 31 <family> <vlan> <mode>
Test 32: Get the IGMP static mcast router attached status for the specified interface/VLAN: openapi_snooping_example_ext 32 <family> <vlan> <ifNum>

openapi_snooping_ext CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# [no] set igmp fast-leave auto-assignment	openapiSnoopFastLeaveAutoAssignmentModeSet
(Config)# [no] set igmp-plus	openapiSnoopIgmpPlusModeSet
(Config)# [no] set mld-plus	openapiSnoopIgmpPlusModeSet
(Interface-Config Mode)# set igmp fast-leave <intf>	openapiSnoopIntfFastLeaveOperModeSet
(Interface-Config Mode)# set mld fast-leave <intf>	openapiSnoopIntfFastLeaveOperModeSet
(Interface-Config Mode)# set igmp mcrtrexpiretime <intf>	openapiSnoopIntfMcastRtrExpiryTimeSet
(Interface-Config Mode)# set mld mcrtrexpiretime <intf>	openapiSnoopIntfMcastRtrExpiryTimeSet
(Interface-Config Mode)# set igmp mrouter <intf>	openapiSnoopIntfMrouterSet
(Interface-Config Mode)# set mld mrouter <intf>	openapiSnoopIntfMrouterSet
(Interface-Config Mode)# set igmp exclude-mrouter-intf <intf>	openapiSnoopMrtrExcludeModeSet
(Interface-Config Mode)# set mld exclude-mrouter-intf <intf>	openapiSnoopMrtrExcludeModeSet
(Config)# [no] set igmp flood-report	openapiSnoopReportFloodModeSet
(VLAN-Config Mode)# [no] set igmp-plus <vlan-id>	openapiSnoopVlanIgmpPlusModeSet
(VLAN-Config Mode)# [no] set mld-plus <vlan-id>	openapiSnoopVlanIgmpPlusModeSet
(VLAN-Config Mode)# [no] set igmp mcrtrexpiretime <vlan-id>	openapiSnoopVlanMcastRtrExpiryTimeSet
(VLAN-Config Mode)# [no] set mld mcrtrexpiretime <vlan-id>	openapiSnoopVlanMcastRtrExpiryTimeSet
(VLAN-Config Mode)# [no] set igmp exclude-mrouter-intf <vlan-id><intf>	openapiSnoopVlanMrtrExcludeModeSet
(VLAN-Config Mode)# [no] set mld exclude-mrouter-intf <vlan-id><intf>	openapiSnoopVlanMrtrExcludeModeSet
(VLAN-Config Mode)# [no] set igmp flood-report <vlan-id>	openapiSnoopVlanReportFloodModeSet