Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.12.0.1
Data Structures | Typedefs | Enumerations | Functions
openapi_iphelper.h File Reference
#include "openapi_common.h"

Go to the source code of this file.

Data Structures

struct  OPEN_IPHELPER_STATS_s
 

Typedefs

typedef struct
OPEN_IPHELPER_STATS_s 
OPEN_IPHELPER_STATS_t
 Relay interface mode values.
 

Enumerations

enum  OPEN_DHCP_RELAY_INTF_VALUE_t { OPEN_RELAY_INTF_DISABLE = 0, OPEN_RELAY_INTF_ENABLE, OPEN_RELAY_INTF_NOT_CONFIGURED }
 

Functions

open_error_t openapiBootpDhcpRelayCIDOptionCheckModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
 Get the Relay Agent global option check mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayCIDOptionCheckModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
 Set the Relay Agent global option check mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayCircuitIdOptionModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
 Get the Relay Agent Circuit ID option mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayCircuitIdOptionModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
 Set the Relay Agent Circuit ID option mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayIntfServerOverrideGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode)
 Get the Relay Agent Server Override mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayIntfServerOverrideSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode)
 Set the Relay Agent Server Override mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceClear (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Clear the interface level Source interface for DHCP relay agent. More...
 
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceGet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *srcIfNum)
 Get the interface level Source interface for DHCP relay agent. More...
 
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceSet (openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t srcIfNum)
 Set the interface level Source interface for DHCP relay agent. More...
 
open_error_t openapiBootpDhcpRelayMaxHopCountGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *maxHopCount)
 Get the Maximum Hop count configured for DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayMaxHopCountSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t maxHopCount)
 Set the Maximum Hop count for DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayMinWaitTimeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *minWaitTime)
 Get the Minimum Wait time configured for DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayMinWaitTimeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t minWaitTime)
 Set the Minimum Wait time for DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayrtrCIDOptionCheckModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode)
 Get the Relay Agent Circuit ID option check mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayrtrCIDOptionCheckModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode)
 Set the Relay Agent Circuit ID option check mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayrtrCIDOptionModeGet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode)
 Get the Relay Agent Circuit ID Option mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayrtrCIDOptionModeSet (openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode)
 Set the Relay Agent Circuit ID Option mode for the given interface. More...
 
open_error_t openapiBootpDhcpRelayServerOverrideModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t *mode)
 Get the Relay Agent global Server Override mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelayServerOverrideModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t mode)
 Set the Relay Agent global Server Override mode for the given VRF. More...
 
open_error_t openapiBootpDhcpRelaySourceInterfaceClear (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
 Clear the global Source interface of DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelaySourceInterfaceGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *ifNum)
 Get the global Source interface of DHCP relay agent for the given VRF. More...
 
open_error_t openapiBootpDhcpRelaySourceInterfaceSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum)
 Set the global Source interface of DHCP relay agent for the given VRF. More...
 
open_error_t openapiIhIpHelperAddressFirst (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *intIfNum, uint16_t *udpPort, uint32_t *serverAddr, OPEN_BOOL_t *discard, OPEN_BOOL_t *isServerVrfSet, open_buffdesc *serverVrfName, uint32_t *hitCount)
 Get the first relay entry along with the server's VRF name config. More...
 
open_error_t openapiIhIpHelperAddressNext (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *intIfNum, uint16_t *udpPort, uint32_t *serverAddr, OPEN_BOOL_t *discard, OPEN_BOOL_t *isServerVrfSet, open_buffdesc *serverVrfName, uint32_t *hitCount)
 Get the next relay entry along with the server's VRF name config. More...
 
open_error_t openapiIpHelperAddressesRemove (openapiClientHandle_t *client_handle, uint32_t ifNum)
 Remove all IP helper addresses configured on an interface. More...
 
open_error_t openapiIpHelperAdminModeGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode)
 Get the administrative mode of IP-Helper for the given VRF. More...
 
open_error_t openapiIpHelperAdminModeSet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode)
 Set the administrative mode of IP-Helper for the given VRF. More...
 
open_error_t openapiIpHelperStatisticsClear (openapiClientHandle_t *client_handle, open_buffdesc *vrfName)
 Clear IP helper statistics for the given VRF. More...
 
open_error_t openapiIpHelperStatisticsGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_IPHELPER_STATS_t *ihStats)
 Get the IP Helper statistics for the given VRF. More...