ProtectedPort API

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

• Get the name of the group for a given group ID.
• Set the name of the group for a given group ID.
• Get all the protected ports which are members of a given group ID.
• Get the group ID for a given interface.
• Get the next group and interface for a given group and interface.
• Add an interface to a protected port group.
• Delete an interface from a protected port group.
• Get the maximum number of protected port groups.
• Get the number of protected ports which are members of a given group ID.

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

protectedport_example

protectedport_example.c is a sample application that demonstrates the use of OpEN's ProtectedPort APIs. protectedport_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: ./protectedport_example <test#> <arg1> <arg2> ...
• Test 1: Get the name of the group for a given group ID: protectedport_example 1 <groupId>
• Test 2: Set the name of the group for a given group ID: protectedport_example 2 <groupId> <groupName>
• Test 3: Get all the protected ports which are members of a given group ID: protectedport_example 3 <groupId>
• Test 4: Get the group ID for a given interface: protectedport_example 4 <ifNum>
• Test 5: Get the next group and interface for a given group and interface: protectedport_example 5 <ifNum> <groupId>
• Test 6: Add an interface to a protected port group: protectedport_example 6 <ifNum> <groupId>
• Test 7: Delete an interface from a protected port group: protectedport_example 7 <ifNum> <groupId>
• Test 8: Get the maximum number of protected port groups: protectedport_example 8
• Test 9: Get the number of protected ports which are members of a given group ID: protectedport_example 9 <groupId>

ProtectedPort CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show switchport protected <group ID>	openapiProtectedPortGroupNameGet() openapiProtectedPortGroupIntfListGet() openapiProtectedPortNextGroupGet()
(Interface-Config Mode)# [no] switchport protected <group ID>	openapiProtectedPortGroupIntfAdd() openapiProtectedPortGroupIntfDelete()
(Config)# [no] switchport protected <group ID> name <groupName>	openapiProtectedPortGroupNameSet()
(Priv-User Mode)# show interfaces switchport <slot/port>	openapiProtectedPortGroupGet()