Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.13.1.2
openapi_diffserv_policy.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2023 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_diffserv_policy.h
28 *
29 * @purpose Diff serv Policy Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 13/05/2023
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DIFFSERV_POLICY_H_INCLUDED
39 #define OPENAPI_DIFFSERV_POLICY_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 #define OPEN_DIFFSERV_POLICY_NAME_MAX 31
44 #define OPEN_DIFFSERV_POLICY_NAME_MIN 1
45 
46 
47 /* Enumerated values for RowStatus object */
48 typedef enum
49 {
50  OPEN_DIFFSERV_ROW_STATUS_NONE = 0,
52  OPEN_DIFFSERV_ROW_STATUS_ACTIVE,
53  OPEN_DIFFSERV_ROW_STATUS_NOT_IN_SERVICE,
54  OPEN_DIFFSERV_ROW_STATUS_NOT_READY,
55  OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_GO,
56  OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_WAIT,
57  OPEN_DIFFSERV_ROW_STATUS_DESTROY
58 } OPEN_DIFFSERV_ROW_STATUS_t;
59 
60 typedef enum
61 {
62  OPEN_DIFFSERV_POLICY_TYPE_NONE = 0,
63  OPEN_DIFFSERV_POLICY_TYPE_IN,
64  OPEN_DIFFSERV_POLICY_TYPE_OUT
65 } OPEN_DIFFSERV_POLICY_TYPE_t;
66 
67 typedef enum
68 {
69  OPEN_DIFFSERV_STORAGE_TYPE_NONE = 0,
71  OPEN_DIFFSERV_STORAGE_TYPE_OTHER,
72  OPEN_DIFFSERV_STORAGE_TYPE_VOLATILE,
73  OPEN_DIFFSERV_STORAGE_TYPE_NONVOLATILE,
74  OPEN_DIFFSERV_STORAGE_TYPE_READONLY,
75  OPEN_DIFFSERV_STORAGE_TYPE_PERMANENT
76 } OPEN_DIFFSERV_STORAGE_TYPE_t;
77 
78 /* Values for DiffServ Policy Attribute statement type */
79 typedef enum
80 {
81  OPEN_DIFFSERV_POLICY_ATTR_TYPE_NONE = 0,
83  OPEN_DIFFSERV_POLICY_ATTR_TYPE_ASSIGN_QUEUE,
84  OPEN_DIFFSERV_POLICY_ATTR_TYPE_DROP,
85  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COSVAL,
86  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS2VAL,
87  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS_AS_COS2,
88  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPDSCPVAL,
89  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPPRECEDENCEVAL,
90  OPEN_DIFFSERV_POLICY_ATTR_TYPE_MIRROR,
91  OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SIMPLE,
92  OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SINGLERATE,
93  OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_TWORATE,
94  OPEN_DIFFSERV_POLICY_ATTR_TYPE_REDIRECT,
95 } OPEN_DIFFSERV_POLICY_ATTR_TYPE_t;
96 
97 
98 typedef enum
99 {
100  OPEN_BURST_POLICE_TWORATE_NONE = 0,
101  OPEN_BURST_POLICE_TWORATE_CBURST,
102  OPEN_BURST_POLICE_TWORATE_PBURST,
103  OPEN_BURST_POLICE_SINGLERATE_CBURST,
104  OPEN_BURST_POLICE_SINGLERATE_EBURST,
105  OPEN_BURST_POLICE_SIMPLE_CBURST
106 }OPEN_BURST_POLICE_TYPE_t;
107 
108 typedef enum
109 {
110  OPEN_DIFFSERV_POLICE_ACT_NONE = 0,
112  OPEN_DIFFSERV_POLICE_ACT_DROP,
113  OPEN_DIFFSERV_POLICE_ACT_MARKCOS,
114  OPEN_DIFFSERV_POLICE_ACT_MARKCOS2,
115  OPEN_DIFFSERV_POLICE_ACT_MARKCOS_AS_COS2,
116  OPEN_DIFFSERV_POLICE_ACT_MARKDSCP,
117  OPEN_DIFFSERV_POLICE_ACT_MARKPREC,
118  OPEN_DIFFSERV_POLICE_ACT_SEND
119 } OPEN_DIFFSERV_POLICE_ACT_t;
120 
121 
122 
123 /*****************************************************************/
142 open_error_t openapiDiffServPolicyGetNext(openapiClientHandle_t *client_handle,
143  uint32_t prevPolicyIndex,
144  uint32_t *pPolicyIndex);
145 
146 /*****************************************************************/
165 open_error_t openapiDiffServPolicyNameGet(openapiClientHandle_t *client_handle,
166  uint32_t policyIndex,
167  open_buffdesc *bufd);
168 
169 /*****************************************************************/
184 open_error_t openapiDiffServPolicyNameSet(openapiClientHandle_t *client_handle,
185  uint32_t policyIndex,
186  open_buffdesc *bufd);
187 
188 /*****************************************************************/
207 open_error_t openapiDiffServPolicyNameToIndex(openapiClientHandle_t *client_handle,
208  open_buffdesc *stringPtr,
209  uint32_t *pPolicyIndex);
210 
211 /*****************************************************************/
233 open_error_t openapiDiffServClassValidForPolicyCheck(openapiClientHandle_t *client_handle,
234  uint32_t classIndex,
235  uint32_t policyIndex);
236 
237 /*****************************************************************/
252 open_error_t openapiDiffServPolicyRowStatusGet(openapiClientHandle_t *client_handle,
253  uint32_t policyIndex,
254  OPEN_DIFFSERV_ROW_STATUS_t *pValue);
255 
256 /*****************************************************************/
291 open_error_t openapiDiffServPolicyCreate(openapiClientHandle_t *client_handle,
292  uint32_t policyIndex,
293  OPEN_BOOL_t activateRow);
294 /*********************************************************************/
316 open_error_t openapiDiffServPolicyDelete(openapiClientHandle_t *client_handle, uint32_t policyIndex);
317 
318 /*****************************************************************/
335 open_error_t openapiDiffServPolicyTypeGet(openapiClientHandle_t *client_handle,
336  uint32_t policyIndex,
337  OPEN_DIFFSERV_POLICY_TYPE_t *pPolicyType);
338 
339 /*****************************************************************/
356 open_error_t openapiDiffServPolicyTypeSet(openapiClientHandle_t *client_handle,
357  uint32_t policyIndex,
358  OPEN_DIFFSERV_POLICY_TYPE_t policyType);
359 
360 /*********************************************************************/
389 open_error_t openapiDiffServPolicyInstIndexNext(openapiClientHandle_t *client_handle,
390  uint32_t policyIndex,
391  uint32_t *pPolicyInstIndex);
392 /*****************************************************************/
417 open_error_t openapiDiffServPolicyInstGetNext(openapiClientHandle_t *client_handle,
418  uint32_t prevPolicyIndex,
419  uint32_t prevPolicyInstIndex,
420  uint32_t *pPolicyIndex,
421  uint32_t *pPolicyInstIndex);
422 
423 /*****************************************************************/
443 open_error_t openapiDiffServPolicyInstClassIndexGet(openapiClientHandle_t *client_handle,
444  uint32_t policyIndex,
445  uint32_t policyInstIndex,
446  uint32_t *pClassIndex);
447 
448 /*****************************************************************/
468 open_error_t openapiDiffServPolicyInstClassIndexSet(openapiClientHandle_t *client_handle,
469  uint32_t policyIndex,
470  uint32_t policyInstIndex,
471  uint32_t classIndex);
472 
473 /*****************************************************************/
493 open_error_t openapiDiffServPolicyInstIndexFromClass(openapiClientHandle_t *client_handle,
494  uint32_t policyIndex,
495  uint32_t classIndex,
496  uint32_t *pPolicyInstIndex);
497 
498 /*********************************************************************/
535 open_error_t openapiDiffServPolicyInstCreate(openapiClientHandle_t *client_handle,
536  uint32_t policyIndex,
537  uint32_t policyInstIndex,
538  OPEN_BOOL_t activateRow);
539 
540 /*********************************************************************/
560 open_error_t openapiDiffServPolicyInstDelete(openapiClientHandle_t *client_handle,
561  uint32_t policyIndex,
562  uint32_t policyInstIndex);
563 
564 /*****************************************************************/
582 open_error_t openapiDiffServPolicyInstRowStatusGet(openapiClientHandle_t *client_handle,
583  uint32_t policyIndex,
584  uint32_t policyInstIndex,
585  OPEN_DIFFSERV_ROW_STATUS_t *pValue);
586 
587 /*********************************************************************/
615 open_error_t openapiDiffServPolicyIndexNext(openapiClientHandle_t *client_handle,
616  uint32_t *pPolicyIndex);
617 
618 /*****************************************************************/
635 open_error_t openapiDiffServPolicyAttrStorageTypeGet(openapiClientHandle_t *client_handle,
636  uint32_t policyIndex,
637  uint32_t policyInstIndex,
638  uint32_t policyAttrIndex,
639  OPEN_DIFFSERV_STORAGE_TYPE_t *pValue);
640 
641 /*****************************************************************/
658 open_error_t openapiDiffServPolicyAttrRowStatusGet(openapiClientHandle_t *client_handle,
659  uint32_t policyIndex,
660  uint32_t policyInstIndex,
661  uint32_t policyAttrIndex,
662  OPEN_DIFFSERV_ROW_STATUS_t *pValue);
663 /*********************************************************************/
693 open_error_t openapiDiffServPolicyAttrIndexNext(openapiClientHandle_t *client_handle,
694  uint32_t policyIndex,
695  uint32_t policyInstIndex,
696  uint32_t *pPolicyAttrIndex);
697 
698 /*********************************************************************/
719 open_error_t openapiDiffServPolicyAttrIndexMaxGet(openapiClientHandle_t *client_handle,
720  uint32_t *pIndexMax);
721 
722 /*****************************************************************/
741 open_error_t openapiDiffServPolicyAttrStmtEntryTypeGet(openapiClientHandle_t *client_handle,
742  uint32_t policyIndex,
743  uint32_t policyInstIndex,
744  uint32_t policyAttrIndex,
745  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t *pEntryType);
746 
747 /*****************************************************************/
789 open_error_t openapiDiffServPolicyAttrStmtEntryDataGet(openapiClientHandle_t *client_handle,
790  uint32_t policyIndex,
791  uint32_t policyInstIndex,
792  uint32_t policyAttrIndex,
793  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
794  uint32_t *data);
795 
796 /*********************************************************************/
830 open_error_t openapiDiffServPolicyAttrCreate(openapiClientHandle_t *client_handle,
831  uint32_t policyIndex,
832  uint32_t policyInstIndex,
833  uint32_t policyAttrIndex,
834  OPEN_BOOL_t activateRow);
835 
836 /*********************************************************************/
853 open_error_t openapiDiffServPolicyAttrDelete(openapiClientHandle_t *client_handle,
854  uint32_t policyIndex,
855  uint32_t policyInstIndex,
856  uint32_t policyAttrIndex);
857 
858 /*****************************************************************/
909 open_error_t openapiDiffServPolicyAttrStmtEntryTypeDataSet(openapiClientHandle_t *client_handle,
910  uint32_t policyIndex,
911  uint32_t policyInstIndex,
912  uint32_t policyAttrIndex,
913  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
914  uint32_t data);
915 
916 
917 /*****************************************************************/
934 open_error_t openapiDiffServPolicyAttrIndexFind(openapiClientHandle_t *client_handle,
935  uint32_t policyIndex,
936  uint32_t policyInstIndex,
937  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t inEntry,
938  uint32_t *pPolicyAttrIndex) ;
939 
940 /*****************************************************************/
966 open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateSet(openapiClientHandle_t *client_handle,
967  uint32_t policyIndex,
968  uint32_t policyInstIndex,
969  uint32_t policyAttrIndex,
970  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
971  OPEN_RATE_UNIT_t rate_unit,
972  uint32_t rate);
973 
974 /*****************************************************************/
998 open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateUnitGet(openapiClientHandle_t *client_handle,
999  uint32_t policyIndex,
1000  uint32_t policyInstIndex,
1001  uint32_t policyAttrIndex,
1002  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
1003  OPEN_RATE_UNIT_t *pRate_unit);
1004 
1005 /*****************************************************************/
1032 open_error_t openapiDiffServPolicyAttrStmtPoliceBurstSet(openapiClientHandle_t *client_handle,
1033  uint32_t policyIndex,
1034  uint32_t policyInstIndex,
1035  uint32_t policyAttrIndex,
1036  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
1037  OPEN_BURST_POLICE_TYPE_t burstType,
1038  uint32_t burst);
1039 
1040 /*****************************************************************/
1068 open_error_t openapiDiffServPolicyAttrStmtPoliceBurstGet(openapiClientHandle_t *client_handle,
1069  uint32_t policyIndex,
1070  uint32_t policyInstIndex,
1071  uint32_t policyAttrIndex,
1072  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
1073  OPEN_BURST_POLICE_TYPE_t burstType,
1074  uint32_t *burst);
1075 /*****************************************************************/
1099 open_error_t openapiDiffServPolicyAttrStmtPoliceDataRatePercentGet(openapiClientHandle_t *client_handle,
1100  uint32_t policyIndex,
1101  uint32_t policyInstIndex,
1102  uint32_t policyAttrIndex,
1103  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
1104  uint32_t *pRate_percent);
1105 
1106 /*****************************************************************/
1129 open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValSet(openapiClientHandle_t *client_handle,
1130  uint32_t policyIndex,
1131  uint32_t policyInstIndex,
1132  uint32_t policyAttrIndex,
1133  uint32_t value);
1134 
1135 /*****************************************************************/
1158 open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValGet(openapiClientHandle_t *client_handle,
1159  uint32_t policyIndex,
1160  uint32_t policyInstIndex,
1161  uint32_t policyAttrIndex,
1162  uint32_t *pValue);
1163 
1164 /*****************************************************************/
1189 open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActSet(openapiClientHandle_t *client_handle,
1190  uint32_t policyIndex,
1191  uint32_t policyInstIndex,
1192  uint32_t policyAttrIndex,
1193  OPEN_DIFFSERV_POLICE_ACT_t action);
1194 
1195 /*****************************************************************/
1219 open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActGet(openapiClientHandle_t *client_handle,
1220  uint32_t policyIndex,
1221  uint32_t policyInstIndex,
1222  uint32_t policyAttrIndex,
1223  OPEN_DIFFSERV_POLICE_ACT_t *action);
1224 
1225 /*****************************************************************/
1250 open_error_t openapiDiffServPolicyAttrStmtPoliceColorAwareClassValidate(
1251  openapiClientHandle_t *client_handle,
1252  uint32_t policyIndex,
1253  uint32_t policyInstIndex,
1254  uint32_t classIndex);
1255 
1256 /*****************************************************************/
1277 open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformValGet(openapiClientHandle_t *client_handle,
1278  uint32_t policyIndex,
1279  uint32_t policyInstIndex,
1280  uint32_t policyAttrIndex,
1281  uint32_t *pVal);
1282 
1283 /*****************************************************************/
1312 open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet(
1313  openapiClientHandle_t *client_handle,
1314  uint32_t policyIndex,
1315  uint32_t policyInstIndex,
1316  uint32_t policyAttrIndex,
1317  uint32_t classIndex);
1318 
1319 /*****************************************************************/
1337 open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet(
1338  openapiClientHandle_t *client_handle,
1339  uint32_t policyIndex,
1340  uint32_t policyInstIndex,
1341  uint32_t policyAttrIndex,
1342  uint32_t *pClassIndex);
1343 
1344 /*****************************************************************/
1370 open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActSet(
1371  openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex,
1372  uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action);
1373 
1374 /*****************************************************************/
1399 open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActGet(
1400  openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex,
1401  uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action);
1402 
1403 /*****************************************************************/
1427 open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValSet(openapiClientHandle_t *client_handle,
1428  uint32_t policyIndex,
1429  uint32_t policyInstIndex,
1430  uint32_t policyAttrIndex,
1431  uint32_t value);
1432 
1433 /*****************************************************************/
1457 open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValGet(openapiClientHandle_t *client_handle,
1458  uint32_t policyIndex,
1459  uint32_t policyInstIndex,
1460  uint32_t policyAttrIndex,
1461  uint32_t *value);
1462 
1463 /*****************************************************************/
1488 open_error_t openapiDiffServPolicyAttrStmtPoliceConformValSet(openapiClientHandle_t *client_handle,
1489  uint32_t policyIndex,
1490  uint32_t policyInstIndex,
1491  uint32_t policyAttrIndex,
1492  uint32_t value);
1493 /*****************************************************************/
1518 open_error_t openapiDiffServPolicyAttrStmtPoliceConformValGet(openapiClientHandle_t *client_handle,
1519  uint32_t policyIndex,
1520  uint32_t policyInstIndex,
1521  uint32_t policyAttrIndex,
1522  uint32_t *value);
1523 
1524 /*****************************************************************/
1558 open_error_t openapiDiffServPolicyAttrGetNext(openapiClientHandle_t *client_handle,
1559  uint32_t prevPolicyIndex,
1560  uint32_t prevPolicyInstIndex,
1561  uint32_t prevPolicyAttrIndex,
1562  uint32_t *pPolicyIndex,
1563  uint32_t *pPolicyInstIndex,
1564  uint32_t *pPolicyAttrIndex);
1565 
1566 /*****************************************************************/
1592 open_error_t openapiDiffServPolicyAttrStmtPoliceConformActSet(openapiClientHandle_t *client_handle,
1593  uint32_t policyIndex,
1594  uint32_t policyInstIndex,
1595  uint32_t policyAttrIndex,
1596  OPEN_DIFFSERV_POLICE_ACT_t action);
1597 
1598 /*****************************************************************/
1623 open_error_t openapiDiffServPolicyAttrStmtPoliceConformActGet(openapiClientHandle_t *client_handle,
1624  uint32_t policyIndex,
1625  uint32_t policyInstIndex,
1626  uint32_t policyAttrIndex,
1627  OPEN_DIFFSERV_POLICE_ACT_t *action);
1628 
1629 /*****************************************************************/
1650 open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateSet(openapiClientHandle_t *client_handle,
1651  uint32_t policyIndex,
1652  uint32_t policyInstIndex,
1653  uint32_t policyAttrIndex,
1654  uint32_t rate);
1655 /*****************************************************************/
1676 open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateSet(openapiClientHandle_t *client_handle,
1677  uint32_t policyIndex,
1678  uint32_t policyInstIndex,
1679  uint32_t policyAttrIndex,
1680  uint32_t rate);
1681 
1682 /*****************************************************************/
1703 open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateGet(openapiClientHandle_t *client_handle,
1704  uint32_t policyIndex,
1705  uint32_t policyInstIndex,
1706  uint32_t policyAttrIndex,
1707  uint32_t *rate);
1708 /*****************************************************************/
1729 open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateGet(openapiClientHandle_t *client_handle,
1730  uint32_t policyIndex,
1731  uint32_t policyInstIndex,
1732  uint32_t policyAttrIndex,
1733  uint32_t *rate);
1734 
1735 
1736 /*****************************************************************/
1759 open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePdataRateSet(openapiClientHandle_t *client_handle,
1760  uint32_t policyIndex,
1761  uint32_t policyInstIndex,
1762  uint32_t policyAttrIndex,
1763  OPEN_RATE_UNIT_t rate_unit,
1764  uint32_t rate);
1765 /*****************************************************************/
1787 open_error_t openapiDiffServPolicyAttrStmtPolicePdataRatePercentGet(openapiClientHandle_t *client_handle,
1788  uint32_t policyIndex,
1789  uint32_t policyInstIndex,
1790  uint32_t policyAttrIndex,
1791  OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType,
1792  uint32_t *pRate_percent);
1793 
1794 /*****************************************************************/
1815 open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateGet(openapiClientHandle_t *client_handle,
1816  uint32_t policyIndex,
1817  uint32_t policyInstIndex,
1818  uint32_t policyAttrIndex,
1819  uint32_t *pRate);
1820 
1821 /*****************************************************************/
1842 open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateSet(openapiClientHandle_t *client_handle,
1843  uint32_t policyIndex,
1844  uint32_t policyInstIndex,
1845  uint32_t policyAttrIndex,
1846  uint32_t rate);
1847 
1848 
1849 /*****************************************************************/
1877 open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexSet(
1878  openapiClientHandle_t *client_handle,
1879  uint32_t policyIndex,
1880  uint32_t policyInstIndex,
1881  uint32_t policyAttrIndex,
1882  uint32_t classIndex);
1883 
1884 
1885 /*****************************************************************/
1911 open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexGet(
1912  openapiClientHandle_t *client_handle,
1913  uint32_t policyIndex,
1914  uint32_t policyInstIndex,
1915  uint32_t policyAttrIndex,
1916  uint32_t *pClassIndex);
1917 
1918 #endif /* OPENAPI_DIFFSERV_POLICY_H_INCLUDED */
1919 
openapiDiffServPolicyTypeSet
open_error_t openapiDiffServPolicyTypeSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_POLICY_TYPE_t policyType)
Set the type of policy definition.
OPEN_DIFFSERV_POLICY_TYPE_NONE
None.
Definition: openapi_diffserv_policy.h:62
openapiDiffServPolicyAttrStmtPoliceBurstGet
open_error_t openapiDiffServPolicyAttrStmtPoliceBurstGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_BURST_POLICE_TYPE_t burstType, uint32_t *burst)
Get the policing committed burst size attribute statement value.
OPEN_DIFFSERV_POLICY_ATTR_TYPE_REDIRECT
Redirect.
Definition: openapi_diffserv_policy.h:94
openapiDiffServPolicyAttrStmtPoliceSimpleCrateGet
open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *rate)
Get the simple policing committed rate attribute statement value.
openapiDiffServPolicyAttrStmtEntryTypeGet
open_error_t openapiDiffServPolicyAttrStmtEntryTypeGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t *pEntryType)
Get the Policy Attribute statement entry type.
openapiDiffServPolicyInstDelete
open_error_t openapiDiffServPolicyInstDelete(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex)
Delete a row from the Policy-Class Instance Table for the specified index.
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPPRECEDENCEVAL
IP-Precedence [0-7].
Definition: openapi_diffserv_policy.h:89
OPEN_DIFFSERV_POLICE_ACT_MARKPREC
Mark-Precedence.
Definition: openapi_diffserv_policy.h:117
openapiDiffServPolicyAttrStmtPoliceConformValSet
open_error_t openapiDiffServPolicyAttrStmtPoliceConformValSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
Set the policing conform value attribute statement value.
openapiDiffServPolicyAttrCreate
open_error_t openapiDiffServPolicyAttrCreate(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_BOOL_t activateRow)
Create a new row in the Policy Attribute Table for the specified index.
OPEN_DIFFSERV_STORAGE_TYPE_t
OPEN_DIFFSERV_STORAGE_TYPE_t
Definition: openapi_diffserv_policy.h:67
openapiDiffServPolicyTypeGet
open_error_t openapiDiffServPolicyTypeGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_POLICY_TYPE_t *pPolicyType)
Get the type of policy definition.
openapiDiffServPolicyNameSet
open_error_t openapiDiffServPolicyNameSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, open_buffdesc *bufd)
Set the policy name.
openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pClassIndex)
Get the policing color conform attribute class index value.
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MIRROR
Mirror.
Definition: openapi_diffserv_policy.h:90
OPEN_BURST_POLICE_TYPE_t
OPEN_BURST_POLICE_TYPE_t
Definition: openapi_diffserv_policy.h:98
openapiDiffServPolicyAttrStmtPoliceConformActGet
open_error_t openapiDiffServPolicyAttrStmtPoliceConformActGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
Get the policing conform action attribute statement value.
openapiDiffServPolicyAttrStmtPoliceConformValGet
open_error_t openapiDiffServPolicyAttrStmtPoliceConformValGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *value)
Get the policing conform value attribute statement value.
OPEN_DIFFSERV_POLICY_ATTR_TYPE_NONE
None.
Definition: openapi_diffserv_policy.h:81
OPEN_DIFFSERV_ROW_STATUS_NONE
not a valid value
Definition: openapi_diffserv_policy.h:50
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS_AS_COS2
CosAsCos2 [1-7].
Definition: openapi_diffserv_policy.h:87
OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_GO
Create and Go.
Definition: openapi_diffserv_policy.h:55
OPEN_DIFFSERV_POLICE_ACT_NONE
None.
Definition: openapi_diffserv_policy.h:110
openapiDiffServPolicyAttrStmtPoliceExceedActGet
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
Get the policing exceed action attribute statement value.
openapiDiffServPolicyInstClassIndexGet
open_error_t openapiDiffServPolicyInstClassIndexGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t *pClassIndex)
Get the class index referenced as the policy class instance.
openapiDiffServPolicyInstCreate
open_error_t openapiDiffServPolicyInstCreate(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_BOOL_t activateRow)
Create a new row in the Policy-Class Instance Table for the specified index.
openapiDiffServPolicyDelete
open_error_t openapiDiffServPolicyDelete(openapiClientHandle_t *client_handle, uint32_t policyIndex)
Delete a row from the Policy Table for the specified index.
openapiDiffServPolicyAttrStmtPoliceNonconformValSet
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
Set the policing nonconform value attribute statement value.
openapiDiffServPolicyAttrStmtPoliceConformActSet
open_error_t openapiDiffServPolicyAttrStmtPoliceConformActSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
Set the policing conform action attribute statement value.
open_error_t
open_error_t
OPEN uses these enumerators to indicate the error codes.
Definition: openapi_common.h:64
OPEN_DIFFSERV_STORAGE_TYPE_NONE
not a valid value
Definition: openapi_diffserv_policy.h:69
openapiDiffServPolicyAttrStmtPoliceDataRatePercentGet
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRatePercentGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *pRate_percent)
Get the policing committed rate attribute statement value.
openapiDiffServPolicyNameGet
open_error_t openapiDiffServPolicyNameGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, open_buffdesc *bufd)
Get the policy name.
OPEN_DIFFSERV_POLICY_ATTR_TYPE_DROP
Drop.
Definition: openapi_diffserv_policy.h:84
OPEN_DIFFSERV_POLICE_ACT_MARKDSCP
Mark-DSCP.
Definition: openapi_diffserv_policy.h:116
OPEN_DIFFSERV_POLICE_ACT_MARKCOS2
Mark-Cos2.
Definition: openapi_diffserv_policy.h:114
OPEN_BURST_POLICE_TWORATE_PBURST
Tworate-Peak burst [1-128].
Definition: openapi_diffserv_policy.h:102
OPEN_DIFFSERV_STORAGE_TYPE_OTHER
Other.
Definition: openapi_diffserv_policy.h:71
OPEN_DIFFSERV_STORAGE_TYPE_READONLY
Readonly.
Definition: openapi_diffserv_policy.h:74
openapiDiffServPolicyAttrStmtPoliceTworatePdataRateSet
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePdataRateSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_RATE_UNIT_t rate_unit, uint32_t rate)
Set the two-rate policing peak rate attribute statement value as per unit.
openapiDiffServPolicyAttrStmtPoliceColorExceedIndexSet
open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t classIndex)
Set the policing color exceed attribute class index value.
OPEN_DIFFSERV_POLICE_ACT_MARKCOS_AS_COS2
Mark-CosAsCos2.
Definition: openapi_diffserv_policy.h:115
open_buffdesc
Definition: openapi_common.h:138
OPEN_DIFFSERV_STORAGE_TYPE_VOLATILE
Volatile.
Definition: openapi_diffserv_policy.h:72
openapiDiffServPolicyInstRowStatusGet
open_error_t openapiDiffServPolicyInstRowStatusGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
Get the current status of the specified Policy-Class Instance Table row.
openapiClientHandle_s
Definition: openapi_common.h:131
OPEN_DIFFSERV_ROW_STATUS_ACTIVE
Active.
Definition: openapi_diffserv_policy.h:52
OPEN_DIFFSERV_ROW_STATUS_DESTROY
Destroy.
Definition: openapi_diffserv_policy.h:57
OPEN_RATE_UNIT_t
OPEN_RATE_UNIT_t
OpEN uses this enumeration to define rate units.
Definition: openapi_common.h:378
openapiDiffServPolicyAttrStmtPoliceColorConformValGet
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformValGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pVal)
Get the policing color conform value attribute statement value.
OPEN_DIFFSERV_ROW_STATUS_NOT_READY
Not Ready.
Definition: openapi_diffserv_policy.h:54
OPEN_DIFFSERV_ROW_STATUS_t
OPEN_DIFFSERV_ROW_STATUS_t
Definition: openapi_diffserv_policy.h:48
openapiDiffServPolicyRowStatusGet
open_error_t openapiDiffServPolicyRowStatusGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
Get the current status of the specified Policy Table row.
OPEN_DIFFSERV_ROW_STATUS_NOT_IN_SERVICE
Not in Service.
Definition: openapi_diffserv_policy.h:53
OPEN_DIFFSERV_POLICE_ACT_SEND
Send.
Definition: openapi_diffserv_policy.h:118
openapiDiffServPolicyAttrStmtPoliceTworateCrateSet
open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
Set the two-rate policing committed rate attribute statement value.
openapiDiffServPolicyInstIndexNext
open_error_t openapiDiffServPolicyInstIndexNext(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t *pPolicyInstIndex)
Obtain the next available index value to be used when creating a new row in the Policy-Class Instance...
openapiDiffServPolicyAttrStmtPoliceNonconformValGet
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformValGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *value)
Get the policing nonconform value attribute statement value.
openapiDiffServPolicyGetNext
open_error_t openapiDiffServPolicyGetNext(openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t *pPolicyIndex)
Determine next sequential row in the Policy Table.
openapiDiffServPolicyAttrStmtPoliceExceedActSet
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedActSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
Set the policing exceed action attribute statement value.
OPEN_DIFFSERV_ROW_STATUS_CREATE_AND_WAIT
Create and Wait.
Definition: openapi_diffserv_policy.h:56
OPEN_DIFFSERV_POLICY_ATTR_TYPE_t
OPEN_DIFFSERV_POLICY_ATTR_TYPE_t
Definition: openapi_diffserv_policy.h:79
OPEN_BURST_POLICE_TWORATE_CBURST
Tworate-Commited burst [1-128].
Definition: openapi_diffserv_policy.h:101
openapiDiffServPolicyAttrDelete
open_error_t openapiDiffServPolicyAttrDelete(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex)
Delete a row from the Policy Attribute Table for the specified index.
openapiDiffServPolicyAttrGetNext
open_error_t openapiDiffServPolicyAttrGetNext(openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t prevPolicyInstIndex, uint32_t prevPolicyAttrIndex, uint32_t *pPolicyIndex, uint32_t *pPolicyInstIndex, uint32_t *pPolicyAttrIndex)
Determine next sequential row in the Policy Attribute Table.
openapiDiffServPolicyAttrStmtPoliceExceedValSet
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t value)
Set the policing exceed value attribute statement value.
openapiDiffServPolicyAttrStmtPoliceBurstSet
open_error_t openapiDiffServPolicyAttrStmtPoliceBurstSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_BURST_POLICE_TYPE_t burstType, uint32_t burst)
Set the policing committed burst size attribute statement value.
OPEN_DIFFSERV_STORAGE_TYPE_NONVOLATILE
Non-Volatile.
Definition: openapi_diffserv_policy.h:73
OPEN_BURST_POLICE_SIMPLE_CBURST
Simple-Commited burst [1-128].
Definition: openapi_diffserv_policy.h:105
openapiDiffServPolicyAttrStmtEntryTypeDataSet
open_error_t openapiDiffServPolicyAttrStmtEntryTypeDataSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t data)
Set the Policy Attribute statement entry type and associated data.
openapiDiffServPolicyCreate
open_error_t openapiDiffServPolicyCreate(openapiClientHandle_t *client_handle, uint32_t policyIndex, OPEN_BOOL_t activateRow)
Create a new row in the Policy Table for the specified index.
OPEN_DIFFSERV_POLICE_ACT_MARKCOS
Mark-Cos.
Definition: openapi_diffserv_policy.h:113
OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_TWORATE
Police-Tworate.
Definition: openapi_diffserv_policy.h:93
openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet
open_error_t openapiDiffServPolicyAttrStmtPoliceColorConformIndexSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t classIndex)
Set the policing color conform attribute class index value.
openapiDiffServPolicyAttrStmtPoliceNonconformActGet
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t *action)
Get the policing nonconform action attribute statement value.
OPEN_DIFFSERV_STORAGE_TYPE_PERMANENT
Permanent.
Definition: openapi_diffserv_policy.h:75
OPEN_BOOL_t
OPEN_BOOL_t
OPEN uses these enumerators to indicate true or false for a given config or status parameter...
Definition: openapi_common.h:179
openapiDiffServPolicyAttrStmtPoliceExceedValGet
open_error_t openapiDiffServPolicyAttrStmtPoliceExceedValGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pValue)
Get the policing exceed value attribute statement value.
policyType
OPEN_TCAM_POLICY_TYPE_t policyType
Definition: openapi_tcam.h:235
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COSVAL
CosVal [1-7].
Definition: openapi_diffserv_policy.h:85
openapiDiffServPolicyAttrStmtPoliceSimpleCrateSet
open_error_t openapiDiffServPolicyAttrStmtPoliceSimpleCrateSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
Set the simple policing committed rate attribute statement value.
OPEN_DIFFSERV_POLICY_TYPE_OUT
Out.
Definition: openapi_diffserv_policy.h:64
openapiDiffServPolicyAttrStmtPoliceNonconformActSet
open_error_t openapiDiffServPolicyAttrStmtPoliceNonconformActSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICE_ACT_t action)
Set the policing nonconform action attribute statement value.
openapiDiffServPolicyNameToIndex
open_error_t openapiDiffServPolicyNameToIndex(openapiClientHandle_t *client_handle, open_buffdesc *stringPtr, uint32_t *pPolicyIndex)
Translate a policy name into its associated Policy Table index.
OPEN_DIFFSERV_POLICY_TYPE_t
OPEN_DIFFSERV_POLICY_TYPE_t
Definition: openapi_diffserv_policy.h:60
OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SIMPLE
Police-Simple.
Definition: openapi_diffserv_policy.h:91
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_IPDSCPVAL
Valid IPDSCP [0-63].
Definition: openapi_diffserv_policy.h:88
openapiDiffServPolicyInstClassIndexSet
open_error_t openapiDiffServPolicyInstClassIndexSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t classIndex)
Set the class index referenced as the policy class instance.
entryType
OPEN_MPLS_LFDB_ENTRY_TYPE_t entryType
Type of label.
Definition: openapi_mpls.h:98
openapiDiffServPolicyAttrRowStatusGet
open_error_t openapiDiffServPolicyAttrRowStatusGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_ROW_STATUS_t *pValue)
Get the current status of the specified Policy Attribute Table row.
OPEN_BURST_POLICE_SINGLERATE_CBURST
Singlerate-Commited burst [1-128].
Definition: openapi_diffserv_policy.h:103
OPEN_DIFFSERV_POLICY_ATTR_TYPE_POLICE_SINGLERATE
Police-Singlerate.
Definition: openapi_diffserv_policy.h:92
OPEN_DIFFSERV_POLICY_ATTR_TYPE_MARK_COS2VAL
Cos2Val [1-7].
Definition: openapi_diffserv_policy.h:86
OPEN_DIFFSERV_POLICE_ACT_t
OPEN_DIFFSERV_POLICE_ACT_t
Definition: openapi_diffserv_policy.h:108
OPEN_BURST_POLICE_TWORATE_NONE
Tworate- none.
Definition: openapi_diffserv_policy.h:100
openapi_common.h
openapiDiffServPolicyAttrStmtPoliceColorAwareClassValidate
open_error_t openapiDiffServPolicyAttrStmtPoliceColorAwareClassValidate(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t classIndex)
Determine if a DiffServ class is valid for use as a policing color aware designation.
openapiDiffServPolicyAttrStmtPolicePdataRatePercentGet
open_error_t openapiDiffServPolicyAttrStmtPolicePdataRatePercentGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *pRate_percent)
Get the policing peak rate attribute statement value.
openapiDiffServPolicyAttrStorageTypeGet
open_error_t openapiDiffServPolicyAttrStorageTypeGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_STORAGE_TYPE_t *pValue)
Get the storage type for the specified Policy Attribute Table row.
openapiDiffServPolicyAttrStmtPoliceTworateCrateGet
open_error_t openapiDiffServPolicyAttrStmtPoliceTworateCrateGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pRate)
Get the two-rate policing committed rate attribute statement value.
openapiDiffServPolicyAttrIndexFind
open_error_t openapiDiffServPolicyAttrIndexFind(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t inEntry, uint32_t *pPolicyAttrIndex)
Find the Policy Attribute index for the specified attribute.
openapiDiffServPolicyAttrStmtPoliceTworatePrateSet
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t rate)
Set the two-rate policing peak rate attribute statement value.
openapiDiffServPolicyAttrStmtPoliceDataRateSet
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateSet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_RATE_UNIT_t rate_unit, uint32_t rate)
Set the simple policing committed rate attribute statement value.
OPEN_DIFFSERV_POLICE_ACT_DROP
Drop.
Definition: openapi_diffserv_policy.h:112
openapiDiffServClassValidForPolicyCheck
open_error_t openapiDiffServClassValidForPolicyCheck(openapiClientHandle_t *client_handle, uint32_t classIndex, uint32_t policyIndex)
Check if class definition is suitable for inclusion by specified policy.
openapiDiffServPolicyAttrStmtPoliceTworatePrateGet
open_error_t openapiDiffServPolicyAttrStmtPoliceTworatePrateGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *rate)
Get the two-rate policing peak rate attribute statement value.
openapiDiffServPolicyAttrIndexMaxGet
open_error_t openapiDiffServPolicyAttrIndexMaxGet(openapiClientHandle_t *client_handle, uint32_t *pIndexMax)
Retrieve the maximum policy attribute index value allowed for the Policy Attribute Table...
OPEN_BURST_POLICE_SINGLERATE_EBURST
Singlerate-Egress burst [1-128].
Definition: openapi_diffserv_policy.h:104
OPEN_DIFFSERV_POLICY_ATTR_TYPE_ASSIGN_QUEUE
Assign-Queue [0-6].
Definition: openapi_diffserv_policy.h:83
openapiDiffServPolicyAttrStmtEntryDataGet
open_error_t openapiDiffServPolicyAttrStmtEntryDataGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, uint32_t *data)
Get the Policy Attribute statement entry associated data.
openapiDiffServPolicyAttrIndexNext
open_error_t openapiDiffServPolicyAttrIndexNext(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t *pPolicyAttrIndex)
Obtain the next available index value to be used when creating a new row in the Policy Attribute Tabl...
openapiDiffServPolicyInstGetNext
open_error_t openapiDiffServPolicyInstGetNext(openapiClientHandle_t *client_handle, uint32_t prevPolicyIndex, uint32_t prevPolicyInstIndex, uint32_t *pPolicyIndex, uint32_t *pPolicyInstIndex)
Determine next sequential row in the Policy-Class Instance Table.
openapiDiffServPolicyAttrStmtPoliceColorExceedIndexGet
open_error_t openapiDiffServPolicyAttrStmtPoliceColorExceedIndexGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, uint32_t *pClassIndex)
Get the policing color exceed attribute class index value.
openapiDiffServPolicyIndexNext
open_error_t openapiDiffServPolicyIndexNext(openapiClientHandle_t *client_handle, uint32_t *pPolicyIndex)
Obtain the next available index value to be used when creating a new row in the Policy Table...
OPEN_DIFFSERV_POLICY_TYPE_IN
In.
Definition: openapi_diffserv_policy.h:63
openapiDiffServPolicyAttrStmtPoliceDataRateUnitGet
open_error_t openapiDiffServPolicyAttrStmtPoliceDataRateUnitGet(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t policyInstIndex, uint32_t policyAttrIndex, OPEN_DIFFSERV_POLICY_ATTR_TYPE_t entryType, OPEN_RATE_UNIT_t *pRate_unit)
Get the policing committed rate unit attribute statement value.
openapiDiffServPolicyInstIndexFromClass
open_error_t openapiDiffServPolicyInstIndexFromClass(openapiClientHandle_t *client_handle, uint32_t policyIndex, uint32_t classIndex, uint32_t *pPolicyInstIndex)
Find the policy instance index from the policy and class indexes.