DiffServ Class API

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

• Create the DiffServ class.
• Delete the DiffServ class.
• Get the DiffServ class index from class name.
• Get the DiffServ class name from class index.
• Get the DiffServ class info.
• Create the DiffServ Class Rule.
• Remove the referenced class from the specified class.
• Get the DiffServ class rule info.

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

diffserv_class_conf_example

diffserv_class_conf_example.c is a sample application that demonstrates the use of the DiffServ Class OpEN APIs. diffserv_class_conf_example is started from the command line and has the following usage syntax:

Sample Output

• Usage: diffserv_class_conf_example <test#> <arg1> <arg2> ...
• Test 1: Create the DiffServ class : diffserv_class_conf_example 1 <class-name> <class-type> <class-L3Protocol>
• Test 2: Delete the DiffServ class : diffserv_class_conf_example 2 <class-index>
• Test 3: Get the DiffServ class index from class name : diffserv_class_conf_example 3 <class-name>
• Test 4: Get the DiffServ class name from class index : diffserv_class_conf_example 4 <class-index>
• Test 5: Get the DiffServ class info : diffserv_class_conf_example 5
• Test 6: Create the DiffServ Class Rule : diffserv_class_conf_example 6 <class-index> <rule-type> <ruleVal1> <ruleVal2>
• Test 7: Remove the referenced class from the specified class : diffserv_class_conf_example 7 <class-index> <class-name>
• Test 8: Get the DiffServ class rule info : diffserv_class_conf_example 8 <class-name>
• Test 9: Run API sanity checks: diffserv_class_conf_example 9

DiffServ Class CLI/API Cross Reference

CLI Command	OpEN API Reference
(Config)# class-map [match-all | match-any] <class-map-name> [ipv4 | ipv6]	openapiDiffServClassCreate()
(Config)# no class-map <class-map-name>	openapiDiffServClassDelete()
(Config-classmap)# match [any | class-map <refclassname> | cos <0-7> | destination-address mac <address> <mac-mask> | dstip <ipaddr> <ipmask> | dstip6 <destination-ipv6-prefix/prefix-length> | dstl4port <0-65535> | <port-key> | ethertype <0x0600-0xffff> | <keyword> | ip [dscp |tos | precedence] | ip6flowlbl <label> | protocol <0-255> | secondary-cos <0-7> | secondary-vlan <1-4093> | source-address <address> <mac-mask> | srcip <ipaddr> <ipmask> | srcip6 <source-ipv6-prefix/prefix-length>| srcl4port <0-65535>| vlan <1-4093>]	openapiDiffServClassRuleCreate()
(Config-classmap)# no match class-map <refclassname>	openapiDiffServClassRuleMatchRefClassRemove()
(Priv-User Mode)# show class-map	openapiDiffServClassGetNext() openapiDiffServClassNameGet() openapiDiffServClassTypeGet() openapiDiffServClassL3ProtoGet()
(Priv-User Mode)# show class-map <class-name>	openapiDiffServClassNameToIndex() openapiDiffServClassTypeGet() openapiDiffServClassRuleCountGet() openapiDiffServClassRuleGetNext() openapiDiffServClassRuleMatchEntryTypeGet() openapiDiffServClassRuleMatchEntryValueGet()