openapi_iphelper.h

Go to the documentation of this file.

/**********************************************************************
*
*  Copyright 2023 Broadcom.
*
*  Licensed under the Apache License, Version 2.0 (the "License");
*  you may not use this file except in compliance with the License.
*  You may obtain a copy of the License at
*
*      http://www.apache.org/licenses/LICENSE-2.0
*
*  Unless required by applicable law or agreed to in writing, software
*  distributed under the License is distributed on an "AS IS" BASIS,
*  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
*  See the License for the specific language governing permissions and
*  limitations under the License.
*
***********************************************************************
*
* @filename  openapi_iphelper.h
*
* @purpose   This code implements the OpEN IP-HELPER API
*
* @component OPEN
*
* @create    02/28/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_IPHELPER_H_INCLUDED
#define OPENAPI_IPHELPER_H_INCLUDED

#include "openapi_common.h" 


typedef struct OPEN_IPHELPER_STATS_s                    
{
  uint32_t dhcpClientMsgsReceived;               

  uint32_t dhcpClientMsgsRelayed;                

  uint32_t dhcpServerMsgsReceived;               

  uint32_t dhcpServerMsgsRelayed;                

  uint32_t udpClientMsgsReceived;

  uint32_t udpClientMsgsRelayed;                 

  uint32_t tooManyHops;                          

  uint32_t tooEarly;                             

  uint32_t spoofedGiaddr;

  uint32_t ttlExpired;

  uint32_t matchDiscardEntry;                    

} OPEN_IPHELPER_STATS_t;

typedef enum
{
  OPEN_RELAY_INTF_DISABLE = 0,                      
  OPEN_RELAY_INTF_ENABLE,
  OPEN_RELAY_INTF_NOT_CONFIGURED
} OPEN_DHCP_RELAY_INTF_VALUE_t;


/*************************************************************************/
open_error_t openapiBootpDhcpRelayMaxHopCountGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *maxHopCount);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayMaxHopCountSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t maxHopCount);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayMinWaitTimeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *minWaitTime);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayMinWaitTimeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t minWaitTime);

/*************************************************************************/
open_error_t openapiIpHelperAdminModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiIpHelperAdminModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayCircuitIdOptionModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayCircuitIdOptionModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayCIDOptionCheckModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayCIDOptionCheckModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiIpHelperStatisticsGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_IPHELPER_STATS_t *ihStats);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayServerOverrideModeGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayServerOverrideModeSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_BOOL_t mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayIntfServerOverrideGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayIntfServerOverrideSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelaySourceInterfaceGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *ifNum);

/*************************************************************************/
open_error_t openapiBootpDhcpRelaySourceInterfaceSet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum);

/*************************************************************************/
open_error_t openapiBootpDhcpRelaySourceInterfaceClear(openapiClientHandle_t *client_handle, open_buffdesc *vrfName);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceGet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t *srcIfNum);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceSet(openapiClientHandle_t *client_handle, uint32_t ifNum, uint32_t srcIfNum);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayIntfSourceInterfaceClear(openapiClientHandle_t *client_handle, uint32_t ifNum);

/*************************************************************************/
open_error_t openapiIpHelperAddressesRemove(openapiClientHandle_t *client_handle, uint32_t ifNum);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayrtrCIDOptionModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayrtrCIDOptionModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayrtrCIDOptionCheckModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t *mode);

/*************************************************************************/
open_error_t openapiBootpDhcpRelayrtrCIDOptionCheckModeSet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP_RELAY_INTF_VALUE_t mode);

/*************************************************************************/
open_error_t openapiIpHelperStatisticsClear(openapiClientHandle_t *client_handle, open_buffdesc *vrfName);

/*************************************************************************/
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);

/*************************************************************************/
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);

#endif /* OPENAPI_IPHELPER_H_INCLUDED */