diffServPolicy API

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

• Determine next sequential row in the policy Table.
• Get the policy name
• Set the policy name
• Translate a policy name into its associated policy Table index
• Check if class definition is suitable for inclusion by specified policy
• Get the current status of the specified policy Table row
• Create a new row in the policy Table for the specified index
• Delete a row from the policy Table for the specified index
• Get the type of policy definition
• Get the type of policy definition
• Obtain the next available index value to be used when creating a new row in the policy-Class Instance Table
• Get the L3 protocol of class definition
• Determine next sequential row in the policy-Class Instance Table
• Get the class index referenced as the policy class instance
• Set the class index referenced as the policy class instance
• Find the policy instance index from the policy and class indexes
• Create a new row in the policy-Class Instance Table for the specified index
• Delete a row from the policy-Class Instance Table for the specified index
• Get the current status of the specified policy-Class Instance Table row
• Obtain the next available index value to be used when creating a new row in the policy Table
• Get the storage type for the specified policy Attribute Table row
• Get the current status of the specified policy Attribute Table row
• Obtain the next available index value to be used when creating a new row in the policy Attribute Table
• Retrieve the maximum policy attribute index value allowed for the policy Attribute Table
• Get the policy Attribute statement entry type
• Get the policy Attribute statement entry associated data
• Create a new row in the policy Attribute Table for the specified index
• Delete a row from the policy Attribute Table for the specified index
• Set the policy Attribute statement entry type and associated data
• Find the policy Attribute index for the specified attribute
• Set the simple policing committed rate attribute statement value
• Get the policing committed rate unit attribute statement value
• Set the policing committed burst size attribute statement value
• Get the policing committed burst size attribute statement value
• Get the policing committed rate attribute statement value
• Set the policing exceed value attribute statement value
• Get the policing exceed value attribute statement value
• Set the policing exceed action attribute statement value
• Get the policing exceed action attribute statement value
• Determine if a DiffServ class is valid to use as a policing color aware designation
• Get the policing color conform value attribute statement value
• Set the policing color conform attribute class index value
• Get the policing color conform attribute class index value
• Set the policing nonconform action attribute statement value
• Get the policing nonconform action attribute statement value
• Set the policing nonconform value attribute statement value
• Get the policing nonconform value attribute statement value
• Set the policing conform value attribute statement value
• Get the policing conform value attribute statement value
• Determine next sequential row in the policy Attribute Table
• Set the policing conform action attribute statement value
• Get the policing conform action attribute statement value
• Set the two-rate policing peak rate attribute statement value
• Set the simple policing committed rate attribute statement value
• Get the two-rate policing peak rate attribute statement value
• Get the simple policing committed rate attribute statement value
• Set the two-rate policing peak rate attribute statement value as per unit
• Get the two-rate policing peak rate attribute statement value as per unit
• Get the policing peak rate attribute statement value
• Get the two-rate policing committed rate attribute statement value
• Set the two-rate policing committed rate attribute statement value
• Set the policing color exceed attribute class index value
• Get the policing color exceed attribute class index value

Example C Application diffserv_policy_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_policy_example

diffserv_policy_example.c is a sample application that demonstrates the use of OpEN's diffServPolicy APIs. diffserv_policy_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: ./diffserv_policy_example <test#> <arg1> <arg2> ...
• Test 1: Determine next sequential row in the policy Table: diffserv_policy_example 1 <prevPolicyIndex>
• Test 2: Get the policy name: diffserv_policy_example 2 <policyIndex>
• Test 3: Set the policy name: diffserv_policy_example 3 <policyIndex> <bufd>
• Test 4: Translate a policy name into its associated policy Table index: diffserv_policy_example 4 <stringPtr>
• Test 5: Check if class definition is suitable for inclusion by specified policy: diffserv_policy_example 5 <classIndex> <policyIndex>
• Test 6: Get the current status of the specified policy Table row: diffserv_policy_example 6 <policyIndex>
• Test 7: Create a new row in the policy Table for the specified index: diffserv_policy_example 7 <policyIndex> <actiateRow>
• Test 8: Delete a row from the policy Table for the specified index: diffserv_policy_example 8 <policyIndex>
• Test 9: Get the type of policy definition: diffserv_policy_example 9 <policyIndex>
• Test 10: Get the type of policy definition: diffserv_policy_example 10 <policyIndex> <policyType>
• Test 11: Obtain the next available index value to be used when creating a new row in the Policy-Class Instance Table: diffserv_policy_example 11 <policyIndex>
• Test 12: Get the L3 protocol of class definition: diffserv_policy_example 12 <classIndex> <pClassL3Proto>
• Test 13: Determine next sequential row in the Policy-Class Instance Table: diffserv_policy_example 13 <prevPolicyIndex> <prevPolicyInstIndex>
• Test 14: Get the class index referenced as the policy class instance: diffserv_policy_example 14 <policyIndex> <policyInstIndex>
• Test 15: Set the class index referenced as the policy class instance: diffserv_policy_example 15 <policyIndex> <policyInstIndex> <classIndex>
• Test 16: Find the policy instance index from the policy and class indexes: diffserv_policy_example 16 <policyIndex> <classIndex>
• Test 17: Create a new row in the Policy-Class Instance Table for the specified index: diffserv_policy_example 17 <policyIndex> <policyInstIndex> <activateRow>
• Test 18: Delete a row from the Policy-Class Instance Table for the specified index: diffserv_policy_example 18 <policyIndex> <policyInstIndex>
• Test 19: Get the current status of the specified Policy-Class Instance Table row: diffserv_policy_example 19 <policyIndex> <policyInstIndex>
• Test 20: Obtain the next available index value to be used when creating a new row in the policy Table: diffserv_policy_example 20
• Test 21: Get the storage type for the specified policy Attribute Table row: diffserv_policy_example 21 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 22: Get the current status of the specified policy Attribute Table row: diffserv_policy_example 22 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 23: Obtain the next available index value to be used when creating a new row in the policy Attribute Table: diffserv_policy_example 23 <policyIndex> <policyInstIndex>
• Test 24: Retrieve the maximum policy attribute index value allowed for the policy Attribute Table: diffserv_policy_example 24
• Test 25: Get the policy Attribute statement entry type: diffserv_policy_example 25 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 26: Get the policy Attribute statement entry associated data: diffserv_policy_example 26 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType>
• Test 27: Create a new row in the policy Attribute Table for the specified index: diffserv_policy_example 27 <policyIndex> <policyInstIndex> <policyAttrIndex> <activateRow>
• Test 28: Delete a row from the policy Attribute Table for the specified index: diffserv_policy_example 28 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 29: Set the policy Attribute statement entry type and associated data: diffserv_policy_example 29 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType> <data>
• Test 30: Find the policy Attribute index for the specified attribute: diffserv_policy_example 30 <policyIndex> <policyInstIndex> <inEntry>
• Test 31: Set the simple policing committed rate attribute statement value: diffserv_policy_example 31 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType> <rate_unit> <rate>
• Test 32: Get the policing committed rate unit attribute statement value: diffserv_policy_example 32 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType>
• Test 33: Set the policing committed burst size attribute statement value: diffserv_policy_example 33 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType> <burstType> <burst>
• Test 34: Get the policing committed burst size attribute statement value: diffserv_policy_example 34 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType> <burstType> <burst>
• Test 35: Get the policing committed rate attribute statement value: diffserv_policy_example 35 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType>
• Test 36: Set the policing exceed value attribute statement value: diffserv_policy_example 36 <policyIndex> <policyInstIndex> <policyAttrIndex>

• Test 37: Get the policing exceed value attribute statement value: diffserv_policy_example 37 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 38: Set the policing exceed action attribute statement value: diffserv_policy_example 38 <policyIndex> <policyInstIndex> <policyAttrIndex> <action>
• Test 39: Get the policing exceed action attribute statement value: diffserv_policy_example 39 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 40: Determine if a DiffServ class is valid for use as a policing color aware designation: diffserv_policy_example 40 <policyIndex> <policyInstIndex> <classIndex>
• Test 41: Get the policing color conform value attribute statement value: diffserv_policy_example 41 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 42: Set the policing color conform attribute class index value: diffserv_policy_example 42 <policyIndex> <policyInstIndex> <policyAttrIndex> <classIndex>
• Test 43: Get the policing color conform attribute class index value: diffserv_policy_example 43 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 44: Set the policing nonconform action attribute statement value: diffserv_policy_example 44 <policyIndex> <policyInstIndex> <policyAttrIndex> <action>
• Test 45: Get the policing nonconform action attribute statement value: diffserv_policy_example 45 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 46: Set the policing nonconform value attribute statement value: diffserv_policy_example 46 <policyIndex> <policyInstIndex> <policyAttrIndex>

• Test 47: Get the policing nonconform value attribute statement value: diffserv_policy_example 47 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 48: Set the policing conform value attribute statement value: diffserv_policy_example 48 <policyIndex> <policyInstIndex> <policyAttrIndex>

• Test 49: Get the policing conform value attribute statement value: diffserv_policy_example 49 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 50: Determine next sequential row in the policy Attribute Table: diffserv_policy_example 50 <prevPolicyIndex> <prevPolicyInstIndex> <prevPolicyAttrIndex>
• Test 51: Set the policing conform action attribute statement value: diffserv_policy_example 51 <policyIndex> <policyInstIndex> <policyAttrIndex> <action>
• Test 52: Get the policing conform action attribute statement value: diffserv_policy_example 52 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 53: Set the two-rate policing peak rate attribute statement value: diffserv_policy_example 53 <policyIndex> <policyInstIndex> <policyAttrIndex> <rate>
• Test 54: Set the simple policing committed rate attribute statement value: diffserv_policy_example 54 <policyIndex> <policyInstIndex> <policyAttrIndex> <rate>
• Test 55: Get the two-rate policing peak rate attribute statement value: diffserv_policy_example 55 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 56: Get the simple policing committed rate attribute statement value: diffserv_policy_example 56 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 57: Set the two-rate policing peak rate attribute statement value as per unit: diffserv_policy_example 57 <policyIndex> <policyInstIndex> <policyAttrIndex> <rate_unit> <rate>
• Test 58: Get the two-rate policing peak rate attribute statement value as per unit: diffserv_policy_example 58 <policyIndex> <policyInstIndex> <policyAttrIndex> <rate_unit>
• Test 59: Get the policing peak rate attribute statement value: diffserv_policy_example 59 <policyIndex> <policyInstIndex> <policyAttrIndex> <entryType>
• Test 60: Get the two-rate policing committed rate attribute statement value: diffserv_policy_example 60 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 61: Set the two-rate policing committed rate attribute statement value: diffserv_policy_example 61 <policyIndex> <policyInstIndex> <policyAttrIndex> <rate>
• Test 62: Set the policing color exceed attribute class index value: diffserv_policy_example 62 <policyIndex> <policyInstIndex> <policyAttrIndex> <classIndex>
• Test 63: Get the policing color exceed attribute class index value: diffserv_policy_example 63 <policyIndex> <policyInstIndex> <policyAttrIndex>
• Test 64: Run API sanity checks: diffserv_policy_example 64

diffServPolicy CLI/API Cross Reference

CLI Command	OpEN API Reference
(Priv-User Mode)# show policy-map	openapiDiffServPolicyNameGet() openapiDiffServPolicyGetNext() openapiDiffServPolicyTypeGet() openapiDiffServPolicyInstClassIndexGet() openapiDiffServPolicyAttrStmtEntryDataGet() openapiDiffServPolicyAttrStmtPoliceDataRateUnitGet() openapiDiffServPolicyAttrStmtPoliceBurstGet() openapiDiffServPolicyAttrStmtPoliceDataRatePercentGet() openapiDiffServPolicyAttrStmtPoliceExceedValGet() openapiDiffServPolicyAttrStmtPoliceExceedActGet() openapiDiffServPolicyAttrStmtPoliceColorConformValGet() openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet() openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet() openapiDiffServPolicyAttrStmtPoliceConformActGet() openapiDiffServPolicyAttrStmtPoliceTworatePrateGet() openapiDiffServPolicyAttrStmtPoliceSimpleCrateGet() openapiDiffServPolicyAttrStmtPolicePdataRatePercentGet() openapiDiffServPolicyAttrStmtPoliceTworateCrateGet() openapiDiffServPolicyAttrStmtPoliceColorExceedIndexGet()
(Config)# [no] policy-map	openapiDiffServPolicyNameSet() openapiDiffServPolicyDelete() openapiDiffServPolicyTypeSet() openapiDiffServPolicyIndexNext()
(Config-policy-map)# [no] class	openapiDiffServPolicyInstIndexNext() openapiDiffServPolicyInstClassIndexSet() openapiDiffServPolicyInstCreate() openapiDiffServPolicyInstDelete() openapiDiffServPolicyInstRowStatusGet()
(Config-policy-classmap)# mark	openapiDiffServPolicyInstIndexFromClass() openapiDiffServPolicyAttrRowStatusGet() openapiDiffServPolicyAttrIndexNext() openapiDiffServPolicyAttrIndexNext() openapiDiffServPolicyAttrStmtEntryTypeGet() openapiDiffServPolicyAttrCreate() openapiDiffServPolicyAttrDelete() openapiDiffServPolicyAttrIndexFind() openapiDiffServPolicyAttrStmtEntryTypeDataSet()
(Config-policy-classmap)# police-simple	openapiDiffServPolicyAttrStmtPoliceDataRateSet() openapiDiffServPolicyAttrStmtPoliceBurstSet() openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet() openapiDiffServPolicyAttrStmtPoliceConformActSet() openapiDiffServPolicyAttrStmtPoliceSimpleCrateSet()
(Config-policy-classmap)# police-single-rate	openapiDiffServPolicyAttrStmtPoliceDataRateSet() openapiDiffServPolicyAttrStmtPoliceBurstSet() openapiDiffServPolicyAttrStmtPoliceExceedValSet() openapiDiffServPolicyAttrStmtPoliceExceedActSet() openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet() openapiDiffServPolicyAttrStmtPoliceConformActSet()
(Config-policy-classmap)# police-two-rate	openapiDiffServPolicyAttrStmtPoliceDataRateSet() openapiDiffServPolicyAttrStmtPoliceBurstSet() openapiDiffServPolicyAttrStmtPoliceExceedValSet() openapiDiffServPolicyAttrStmtPoliceExceedActSet() openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet() openapiDiffServPolicyAttrStmtPoliceConformActSet() openapiDiffServPolicyAttrStmtPoliceTworatePrateSet() openapiDiffServPolicyAttrStmtPoliceTworatePdataRateSet() openapiDiffServPolicyAttrStmtPoliceTworateCrateSet()
(Config-policy-classmap)# conform-color	openapiDiffServPolicyAttrStmtPoliceColorAwareClassValidate() openapiDiffServPolicyAttrStmtPoliceColorExceedIndexSet()