Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
Enumerations | Functions
This Code Implements The OpEN Diff Serv Configuration API [OPENAPI_DIFFSERV_CONF]

Enumerations

enum  OPEN_DIFFSERV_GEN_STATUS_GROUP_OBJECT_t {
  OPEN_DIFFSERV_GEN_STATUS_TABLE_NONE = 0, OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_SIZE, OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_RULE_SIZE,
  OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_RULE_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_SIZE, OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_INST_SIZE,
  OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_INST_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_ATTR_SIZE, OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_ATTR_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_SERVICE_SIZE,
  OPEN_DIFFSERV_GEN_STATUS_TABLE_SERVICE_MAX, OPEN_DIFFSERV_GEN_STATUS_TABLE_TOTAL
}
 Enumerated values for DiffServ General Status Group objects. More...
 

Functions

open_error_t openapiDiffServGenAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *pMode)
 Gets admin mode of DiffServ administrative. More...
 
open_error_t openapiDiffServGenAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode)
 Set the value of the DiffServ administrative mode. More...
 
open_error_t openapiDiffServGenTableSizeGet (openapiClientHandle_t *client_handle, OPEN_DIFFSERV_GEN_STATUS_GROUP_OBJECT_t diffTableGrpObj, uint32_t *pSize)
 Get size of the given group Table. More...
 

Detailed Description

Enumeration Type Documentation

Enumerated values for DiffServ General Status Group objects.

Enumerator
OPEN_DIFFSERV_GEN_STATUS_TABLE_NONE 

None.

OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_SIZE 

Class table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_MAX 

Max class table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_RULE_SIZE 

Class rule table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_CLASS_RULE_MAX 

Max class rule table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_SIZE 

Policy table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_MAX 

Max policy table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_INST_SIZE 

Policy-class instance table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_INST_MAX 

Max policy-class instance tablesize.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_ATTR_SIZE 

Policy attribute table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_POLICY_ATTR_MAX 

Max policy attribute table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_SERVICE_SIZE 

Service table size.

OPEN_DIFFSERV_GEN_STATUS_TABLE_SERVICE_MAX 

Max service table size.

Definition at line 44 of file openapi_diffserv_conf.h.

Function Documentation

open_error_t openapiDiffServGenAdminModeGet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t pMode 
)

Gets admin mode of DiffServ administrative.

Parameters
[in]client_handleclient handle from registration API
[out]pModeDiffServ administrative mode [Enable/Disable]
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
Note
This API fetches DiffServ administrative admin mode state

OpEN API Version: 1.26

Examples:
diffservconf_example.c.
open_error_t openapiDiffServGenAdminModeSet ( openapiClientHandle_t client_handle,
OPEN_CONTROL_t  mode 
)

Set the value of the DiffServ administrative mode.

Parameters
[in]client_handleclient handle from registration API
[in]modeDiffServ administrative mode [Enable/Disable]
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
Note
This API sets DiffServ administrative mode.
Calling this API will change the running configuration of the switch.

OpEN API Version: 1.26

Examples:
diffservconf_example.c.
open_error_t openapiDiffServGenTableSizeGet ( openapiClientHandle_t client_handle,
OPEN_DIFFSERV_GEN_STATUS_GROUP_OBJECT_t  diffTableGrpObj,
uint32_t *  pSize 
)

Get size of the given group Table.

Parameters
[in]client_handleclient handle from registration API
[in]diffTableGrpObjDiffServ general status table group object
[out]pSizetable size value
Return values
OPEN_E_NONEOn success.
OPEN_E_FAILOn failure.
OPEN_E_PARAMInvalid argument.
Note
This API fetches size of given group Table.

OpEN API Version: 1.26

Examples:
diffservconf_example.c.