openapi_dhcp_server.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2018-2024 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_dhcp_server.h
*
* @purpose   DHCP Server API
*
* @component OpEN
*
* @note  This code must not include any ICOS header files.
*
* @create    7/6/2018
*
* @end
*                                    
**********************************************************************/
#ifndef OPENAPI_DHCP_SERVER_H_INCLUDED
#define OPENAPI_DHCP_SERVER_H_INCLUDED

#include "openapi_common.h"

typedef enum
{
  OPEN_DHCP_SERVER_POOL_TYPE_INACTIVE      = 0, 
  OPEN_DHCP_SERVER_POOL_TYPE_DYNAMIC       = 1, 
  OPEN_DHCP_SERVER_POOL_TYPE_MANUAL        = 2  
} OPEN_DHCP_SERVER_POOL_TYPE_t;

typedef enum
{
  OPEN_DHCP_SERVER_FREE_LEASE       = 0, 
  OPEN_DHCP_SERVER_ACTIVE_LEASE     = 1, 
  OPEN_DHCP_SERVER_OFFERED_LEASE    = 2, 
  OPEN_DHCP_SERVER_EXPIRED_LEASE    = 3, 
  OPEN_DHCP_SERVER_ABANDONED_LEASE  = 4, 
} OPEN_DHCP_SERVER_LEASE_STATE_t;

#define OPEN_DHCP_SERVER_POOL_NAME_MAXLEN     32  
#define OPEN_DHCP_SERVER_CLIENT_ID_MAXLEN     255 
#define OPEN_DHCP_SERVER_POOL_VRF_NAME_MAXLEN 65  
#define OPEN_DHCP_SERVER_CLIENT_ID_STR_MAXLEN (3 * OPEN_DHCP_SERVER_CLIENT_ID_MAXLEN) 
#define OPEN_DHCP_SERVER_CLIENT_NAME_MAXLEN   31  
typedef struct
{
  char name[OPEN_DHCP_SERVER_POOL_NAME_MAXLEN];  
} OPEN_DHCP_SERVER_POOL_NAME_t;

typedef struct
{
  char name[OPEN_DHCP_SERVER_POOL_VRF_NAME_MAXLEN];  
} OPEN_DHCP_SERVER_POOL_VRF_NAME_t;

typedef struct
{
  char clientid[OPEN_DHCP_SERVER_CLIENT_ID_MAXLEN];  
} OPEN_DHCP_SERVER_CLIENT_ID_t;

typedef enum
{
  OPEN_DHCPS_STAT_ID_RESERVED          = 0,     
  OPEN_DHCPS_STAT_ID_ACTIVE_LEASES     = 1,     
  OPEN_DHCPS_STAT_ID_EXPIRED_LEASES    = 2,     
  OPEN_DHCPS_STAT_ID_MALFORMED_MSGS    = 3,     
  OPEN_DHCPS_STAT_ID_DISCOVER_DROPPED  = 4,     
  OPEN_DHCPS_STAT_ID_RX_DISCOVER       = 5,     
  OPEN_DHCPS_STAT_ID_RX_REQUEST        = 6,     
  OPEN_DHCPS_STAT_ID_RX_DECLINE        = 7,     
  OPEN_DHCPS_STAT_ID_RX_RELEASE        = 8,     
  OPEN_DHCPS_STAT_ID_RX_INFORM         = 9,     
  OPEN_DHCPS_STAT_ID_TX_OFFER          = 10,    
  OPEN_DHCPS_STAT_ID_TX_ACK            = 11,    
  OPEN_DHCPS_STAT_ID_TX_NACK           = 12,    
  OPEN_DHCPS_STAT_ID_LAST                       
} OPEN_DHCPS_STAT_ID_t;

typedef enum
{
  OPEN_NETBIOS_BROADCAST_NODE = 0x1,    
  OPEN_NETBIOS_P2P_NODE       = 0x2,    
  OPEN_NETBIOS_MIXED_NODE     = 0x4,    
  OPEN_NETBIOS_HYBRID_NODE    = 0x8     
} OPEN_NETBIOS_NODE_TYPES_t;

typedef enum
{
  OPEN_DHCPS_HW_TYPE         = 1,
  OPEN_DHCPS_HW_TYPE_10B     = 1,
  OPEN_DHCPS_HW_TYPE_IEEE802 = 6
} OPEN_DHCPS_HW_TYPES_t;

#define OPEN_DHCPS_MAX_POOL_NUMBER           256
#define OPEN_DHCPS_POOL_NAME_MINLEN          1
#define OPEN_DHCPS_POOL_NAME_MAXLEN          31
#define OPEN_DHCPS_DEFAULT_ROUTER_MAX        8
#define OPEN_DHCPS_DNS_SERVER_MAX            8
#define OPEN_DHCPS_NETBIOS_NAME_SERVER_MAX   8
#define OPEN_DHCPS_NTP_SERVER_MAX            2
#define OPEN_DHCPS_DOMAIN_NAME_MAXLEN        255
#define OPEN_DHCPS_BOOT_FILE_NAME_MAXLEN     128

#define OPEN_DHCPS_LEASETIME_MIN             1     
#define OPEN_DHCPS_LEASETIME_MAX             86400 
typedef struct
{
  uint32_t routers[OPEN_DHCPS_DEFAULT_ROUTER_MAX];
} openDhcpsDefaultRouters_t;

typedef struct
{
  uint32_t dns_servers[OPEN_DHCPS_DNS_SERVER_MAX];
} openDhcpsDnsServers_t;

typedef struct
{
  uint32_t servers [OPEN_DHCPS_NETBIOS_NAME_SERVER_MAX];
} openDhcpsNetbiosServers_t;

typedef struct
{
  uint32_t ntp_servers[OPEN_DHCPS_NTP_SERVER_MAX];
} openDhcpsNtpServers_t;

/*****************************************************************/
open_error_t openapiDhcpServerLeaseDataGet(openapiClientHandle_t *client_handle,
                                           open_inet_addr_t *ipaddr,
                                           uint32_t *mask,
                                           open_buffdesc *hwaddr,
                                           OPEN_DHCP_SERVER_CLIENT_ID_t *clientId,
                                           OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                           uint32_t *remaining);

/*****************************************************************/
open_error_t openapiDhcpServerPoolEntryFirstGet(openapiClientHandle_t *client_handle,
                                                uint32_t *poolIndex,
                                                OPEN_DHCP_SERVER_POOL_NAME_t *poolName);

/*****************************************************************/
open_error_t openapiDhcpServerPoolEntryNextGet(openapiClientHandle_t *client_handle,
                                               uint32_t *poolIndex,
                                               OPEN_DHCP_SERVER_POOL_NAME_t *poolName);


/*****************************************************************/
open_error_t openapiDhcpServerPoolTypeGet(openapiClientHandle_t *client_handle,
                                          OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                          OPEN_DHCP_SERVER_POOL_TYPE_t *type);


/*****************************************************************/
open_error_t openapiDhcpServerLeaseEntryFirstGet(openapiClientHandle_t *client_handle,
                                                 OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                                 uint32_t *leaseIndex,
                                                 open_inet_addr_t *ipaddr,
                                                 OPEN_DHCP_SERVER_LEASE_STATE_t *state);

/*****************************************************************/
open_error_t openapiDhcpServerLeaseEntryNextGet(openapiClientHandle_t *client_handle,
                                                OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                                uint32_t *leaseIndex,
                                                open_inet_addr_t *ipaddr,
                                                OPEN_DHCP_SERVER_LEASE_STATE_t *state);

/*****************************************************************/
open_error_t openapiDhcpServerStatGet(openapiClientHandle_t *client_handle, 
                                      OPEN_DHCPS_STAT_ID_t id, uint32_t *val);

/*****************************************************************/
open_error_t openapiDhcpServerPoolVrfNameGet(openapiClientHandle_t *client_handle,
                                             OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                             OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName);

/*****************************************************************/
open_error_t openapiDhcpServerPoolVrfNameSet(openapiClientHandle_t *client_handle,
                                             OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                             OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName);

/*****************************************************************/
open_error_t openapiDhcpServerPoolVrfNameSetToDefaultVrf(openapiClientHandle_t *client_handle,
                                                         OPEN_DHCP_SERVER_POOL_NAME_t *poolName);

/*****************************************************************/
open_error_t openapiDhcpServerExcludedAddressRangeEntryFirstGet(openapiClientHandle_t *client_handle,
                                                                uint32_t *pRangeIndex,
                                                                OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                                open_inet_addr_t *startIpAddr,
                                                                open_inet_addr_t *endIpAddr);

/*****************************************************************/
open_error_t openapiDhcpServerExcludedAddressRangeEntryNextGet(openapiClientHandle_t *client_handle,
                                                               uint32_t *pRangeIndex,
                                                               OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                               open_inet_addr_t *startIpAddr,
                                                               open_inet_addr_t *endIpAddr);

/*****************************************************************/
open_error_t openapiDhcpServerExcludedAddressRangeAdd(openapiClientHandle_t *client_handle,
                                                      OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                      open_inet_addr_t *lowIpAddr,
                                                      open_inet_addr_t *highIpAddr);

/*****************************************************************/
open_error_t openapiDhcpServerExcludedAddressRangeDelete(openapiClientHandle_t *client_handle,
                                                         OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                         open_inet_addr_t *lowIpAddr,
                                                         open_inet_addr_t *highIpAddr);

/*****************************************************************/
open_error_t openapiDhcpServerVrfIpAddrLeaseDataGet(openapiClientHandle_t *client_handle,
                                                    OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                    open_inet_addr_t *ipaddr,
                                                    uint32_t *mask,
                                                    open_buffdesc *hwaddr,
                                                    OPEN_DHCP_SERVER_CLIENT_ID_t *clientId,
                                                    OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                                    uint32_t *remaining);

/*****************************************************************/
open_error_t openapiDhcpServerVrfIpAddrLeaseDataClear(openapiClientHandle_t *client_handle,
                                                      OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName,
                                                      open_inet_addr_t *ipaddr);

/*****************************************************************/
open_error_t openapiDhcpServerPoolIpAddrLeaseDataClear(openapiClientHandle_t *client_handle,
                                                       OPEN_DHCP_SERVER_POOL_NAME_t *poolName,
                                                       open_inet_addr_t *ipaddr);

/*****************************************************************/
open_error_t openapiDhcpServerVrfLeaseDataClear(openapiClientHandle_t *client_handle,
                                                OPEN_DHCP_SERVER_POOL_VRF_NAME_t *vrfName);

/*****************************************************************/
open_error_t openapiDhcpServerPoolLeaseDataClear(openapiClientHandle_t *client_handle,
                                                 OPEN_DHCP_SERVER_POOL_NAME_t *poolName);

/*****************************************************************/
open_error_t openapiDhcpServerAllLeaseDataClear(openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiDhcpsAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiDhcpsAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiDhcpsBootpAutomaticSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t mode);

/*************************************************************************/
open_error_t openapiDhcpsBootpAutomaticGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *mode);

/*************************************************************************/
open_error_t openapiDhcpsNoOfPingPktSet(openapiClientHandle_t *client_handle, uint32_t pingPacketCount);

/*************************************************************************/
open_error_t openapiDhcpsNoOfPingPktGet(openapiClientHandle_t *client_handle, uint32_t *pingPacketCount);

/*************************************************************************/
open_error_t openapiDhcpsNoOfPingPktReset(openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiDhcpsPoolCreate(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsPoolDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsDefaultRoutersSet (openapiClientHandle_t *client_handle,
                                            open_buffdesc *poolName,
                                            openDhcpsDefaultRouters_t *defaultRouters);

/*************************************************************************/
open_error_t openapiDhcpsDefaultRoutersGet (openapiClientHandle_t *client_handle,
                                            open_buffdesc *poolName,
                                            openDhcpsDefaultRouters_t *defaultRouters);

/*************************************************************************/
open_error_t openapiDhcpsDefaultRoutersReset (openapiClientHandle_t *client_handle,
                                              open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsNetworkSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_pfx_t networkAddr);

/*************************************************************************/
open_error_t openapiDhcpsNetworkGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_pfx_t *networkAddr);

/*************************************************************************/
open_error_t openapiDhcpsNetworkDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsDnsServersSet (openapiClientHandle_t *client_handle,
                                        open_buffdesc *poolName,
                                        openDhcpsDnsServers_t *dnsServers);

/*************************************************************************/
open_error_t openapiDhcpsDnsServersGet (openapiClientHandle_t *client_handle,
                                        open_buffdesc *poolName,
                                        openDhcpsDnsServers_t *dnsServers);

/*************************************************************************/
open_error_t openapiDhcpsDnsServersReset(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNameServerAddressSet (openapiClientHandle_t *client_handle,
                                                      open_buffdesc *poolName,
                                                      openDhcpsNetbiosServers_t *netBiosNameServers);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNameServerAddressGet (openapiClientHandle_t *client_handle,
                                                      open_buffdesc *poolName,
                                                      openDhcpsNetbiosServers_t *netBiosNameServers);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNameServerAddressDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNodeTypeSet (openapiClientHandle_t *client_handle,
                                             open_buffdesc *poolName,
                                             OPEN_NETBIOS_NODE_TYPES_t nodeType);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNodeTypeGet (openapiClientHandle_t *client_handle,
                                             open_buffdesc *poolName,
                                             OPEN_NETBIOS_NODE_TYPES_t *nodeType);

/*************************************************************************/
open_error_t openapiDhcpsNetbiosNodeTypeDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsLeaseTimeSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t leaseTime);

/*************************************************************************/
open_error_t openapiDhcpsLeaseTimeGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *leaseTime);

/*************************************************************************/
open_error_t openapiDhcpsLeaseTimeReset(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsDomainNameSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *domainName);

/*************************************************************************/
open_error_t openapiDhcpsDomainNameGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *domainName);

/*************************************************************************/
open_error_t openapiDhcpsDomainNameDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsNextServerSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t nextAddress);

/*************************************************************************/
open_error_t openapiDhcpsNextServerGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *nextAddress);

/*************************************************************************/
open_error_t openapiDhcpsNextServerDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsHwAddressSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *hwAddr, OPEN_DHCPS_HW_TYPES_t hwType);

/*************************************************************************/
open_error_t openapiDhcpsHwAddressGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *hwAddr, OPEN_DHCPS_HW_TYPES_t *hwType);

/*************************************************************************/
open_error_t openapiDhcpsHwAddressDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsHostSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_pfx_t hostAddr);

/*************************************************************************/
open_error_t openapiDhcpsHostGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_pfx_t *hostAddr);

/*************************************************************************/
open_error_t openapiDhcpsHostDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsBootfileSet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *fileName);

/*************************************************************************/
open_error_t openapiDhcpsBootfileGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *fileName);

/*************************************************************************/
open_error_t openapiDhcpsBootfileDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsNTPServerSet (openapiClientHandle_t *client_handle,
                                       open_buffdesc *poolName,
                                       openDhcpsNtpServers_t *ntpServers);

/*************************************************************************/
open_error_t openapiDhcpsNTPServerGet (openapiClientHandle_t *client_handle,
                                       open_buffdesc *poolName,
                                       openDhcpsNtpServers_t *ntpServers);

/*************************************************************************/
open_error_t openapiDhcpsNTPServerDelete(openapiClientHandle_t *client_handle, open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsStatisticsClear (openapiClientHandle_t *client_handle);

/*************************************************************************/
open_error_t openapiConvertClientId (openapiClientHandle_t *client_handle,
                                     open_buffdesc *clientIdBuf,
                                     OPEN_DHCP_SERVER_CLIENT_ID_t *clientId,
                                     uint32_t *clientIdLen);

/*************************************************************************/
open_error_t openapiDhcpsClientIdSet (openapiClientHandle_t *client_handle,
                                      open_buffdesc *poolName,
                                      OPEN_DHCP_SERVER_CLIENT_ID_t *clientId,
                                      uint32_t clientIdLen);

/*************************************************************************/
open_error_t openapiDhcpsClientIdGet (openapiClientHandle_t *client_handle,
                                      open_buffdesc *poolName,
                                      OPEN_DHCP_SERVER_CLIENT_ID_t *clientId,
                                      uint32_t *clientIdLen);

/*************************************************************************/
open_error_t openapiDhcpsClientIdDelete (openapiClientHandle_t *client_handle,
                                         open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsClientNameSet (openapiClientHandle_t *client_handle,
                                        open_buffdesc *poolName,
                                        open_buffdesc *ClientName);

/*************************************************************************/
open_error_t openapiDhcpsClientNameGet (openapiClientHandle_t *client_handle,
                                        open_buffdesc *poolName,
                                        open_buffdesc *ClientName);

/*************************************************************************/
open_error_t openapiDhcpsClientNameDelete (openapiClientHandle_t *client_handle,
                                           open_buffdesc *poolName);

/*************************************************************************/
open_error_t openapiDhcpsPoolAutoDefaultRouterModeSet( openapiClientHandle_t *client_handle,
                                                       open_buffdesc *poolName,
                                                       OPEN_BOOL_t isAutoDefRtrModeEnabled);

/*************************************************************************/
open_error_t openapiDhcpsPoolAutoDefaultRouterModeGet( openapiClientHandle_t *client_handle,
                                                       open_buffdesc *poolName,
                                                       OPEN_BOOL_t *isAutoDefRtrModeEnabled);

#endif /* OPENAPI_DHCP_SERVER_H_INCLUDED */