openapi_dhcp6s.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_dhcp6s.h
*
* @purpose   This code implements the OpEN DHCPv6 API
*
* @component OPEN
*
* @create    07/26/2023
*
* @end
*
*********************************************************************/
#ifndef OPENAPI_DHCP6S_H_INCLUDED
#define OPENAPI_DHCP6S_H_INCLUDED

#include "openapi_common.h" 


#define OPEN_DHCP6S_DNS_DOMAIN_MAX      8
#define OPEN_DHCP6S_DOMAIN_NAME_MINLEN  1
#define OPEN_DHCP6S_DOMAIN_NAME_MAXLEN  253
#define OPEN_DHCP6S_DNS_SERVER_MAX      8
#define OPEN_DHCP6S_MAX_POOL_NUMBER     256

typedef struct
{
  uint8_t dns_domains[OPEN_DHCP6S_DNS_DOMAIN_MAX][OPEN_DHCP6S_DOMAIN_NAME_MAXLEN];
} openDnsDomainTable_t;

typedef struct
{
  open_in6_addr_t dns_servers[OPEN_DHCP6S_DNS_SERVER_MAX];
} openDnsServerTable_t;

typedef enum {
  OPEN_DHCP6_PREFIX_IAPD = 0,
  OPEN_DHCP6_PREFIX_IANA, 
  OPEN_DHCP6_PREFIX_IATA 
} OPEN_DHCP6_PREFIX_TYPE_t;

typedef enum {
  OPEN_DHCP6_MODE_NONE = 0,
  OPEN_DHCP6_MODE_SERVER,  
  OPEN_DHCP6_MODE_CLIENT, 
  OPEN_DHCP6_MODE_RELAY
} OPEN_DHCP6_MODE_t;

#define OPEN_DHCP6S_INACTIVE_POOL       0
#define OPEN_DHCP6S_DYNAMIC_POOL        1
#define OPEN_DHCP6S_MANUAL_POOL         2
#define OPEN_DHCP6S_NOT_READY_POOL      3  
#define OPEN_DHCP6S_POOL_NAME_MINLEN    1
#define OPEN_DHCP6S_POOL_NAME_MAXLEN    32
#define OPEN_DHCP6S_HOST_NAME_MAXLEN    32

#define OPEN_DHCP6S_MAX_DUID_STR_LEN    389
#define OPEN_DHCP6S_RELAYOPT_REMOTEID_MAXLEN  64

#define OPEN_IH_INTF_ANY 0

typedef struct openDhcp6sStatData_s
{
  uint32_t           numOfDhcpsSolicitReceived;
  uint32_t           numOfDhcpsRequestReceived;
  uint32_t           numOfDhcpsConfirmReceived;
  uint32_t           numOfDhcpsRenewReceived;
  uint32_t           numOfDhcpsRebindReceived;
  uint32_t           numOfDhcpsReleaseReceived;
  uint32_t           numOfDhcpsDeclineReceived;
  uint32_t           numOfDhcpsInformReceived;
  uint32_t           numOfDhcpsRelayReplyReceived;
  uint32_t           numOfDhcpsRelayForwReceived;
  uint32_t           totalPacketsReceived;
  uint32_t           numOfDhcpsAdvertiseSent;
  uint32_t           numOfDhcpsReplySent;
  uint32_t           numOfDhcpsReconfigureSent;
  uint32_t           numOfDhcpsRelayReplySent;
  uint32_t           numOfDhcpsRelayForwSent;

  uint32_t           numOfMalformedMessages;
  uint32_t           numOfDhcpPacketsDiscarded;
  uint32_t           totalPacketsSent;
} openDhcp6sStatData_t;

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

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

/*************************************************************************/
open_error_t openapiDhcp6sServerDuidGet(openapiClientHandle_t *client_handle, open_buffdesc *duid);

/*************************************************************************/
open_error_t openapiDhcp6sPoolNumGet(openapiClientHandle_t *client_handle, uint32_t *poolsCount);

/*************************************************************************/
open_error_t openapiDhcp6sPoolValidate(openapiClientHandle_t *client_handle, uint32_t poolNumber);

/*************************************************************************/
open_error_t openapiDhcp6sNumberToPoolNameGet(openapiClientHandle_t *client_handle, uint32_t poolNumber, open_buffdesc *poolName);

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

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

/*************************************************************************/
open_error_t openapiDhcp6sPoolEntryFirst(openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolIndex);

/*************************************************************************/
open_error_t openapiDhcp6sPoolEntryNext(openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolIndex);

/*************************************************************************/
open_error_t openapiDhcp6sPoolHostAdd(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *hostName,
                                      open_inet_addr_t *prefixAddr, uint16_t prefixLen, uint32_t validLifetime, uint32_t preferLifetime);

/*************************************************************************/
open_error_t openapiDhcp6sPoolHostRemove(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *prefixAddr, uint16_t prefixLen);

/*************************************************************************/
open_error_t openapiDhcp6sPoolHostGetNext(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_buffdesc *duidStr, open_buffdesc *hostName, uint32_t *iaid,
                                          open_inet_addr_t *prefixAddr, uint16_t *prefixLen, uint32_t *validLifetime, uint32_t *preferLifetime);

/*************************************************************************/
open_error_t openapiDhcp6sPoolTypeGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, uint32_t *poolType);

/*************************************************************************/
open_error_t openapiDhcp6sPoolDnsDomainsGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, openDnsDomainTable_t *dnsDomainNames);

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

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

/*************************************************************************/
open_error_t openapiDhcp6sPoolDnsServerAdd(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *pAddr);

/*************************************************************************/
open_error_t openapiDhcp6sPoolDnsServersGet(openapiClientHandle_t *client_handle, open_buffdesc *poolName, openDnsServerTable_t *dnsServers);

/*************************************************************************/
open_error_t openapiDhcp6sPoolDnsServerRemove(openapiClientHandle_t *client_handle, open_buffdesc *poolName, open_inet_addr_t *pAddr);

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

/*************************************************************************/
open_error_t openapiDhcp6sIntfModeRelaySet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum, open_inet_addr_t *serverAddr, uint32_t serverIfNum, open_buffdesc *remoteId);

/*************************************************************************/
open_error_t openapiDhcp6sIntfRelayEntryDelete(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t ifNum, open_inet_addr_t *serverAddr, uint32_t serverIfNum, open_buffdesc *remoteId);

/*************************************************************************/
open_error_t openapiDhcp6sIntfModeServerSet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *poolName, uint32_t serverPref, OPEN_BOOL_t rapidCommit, OPEN_BOOL_t allowUnicast);

/*************************************************************************/
open_error_t openapiDhcp6sIntfModeGet(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_DHCP6_MODE_t *mode, open_buffdesc *pPoolName, uint32_t *serverPref,
                                      open_inet_addr_t *relayAddr, uint32_t *relayIfNum, open_buffdesc *remoteId, OPEN_BOOL_t *rapidCommit, OPEN_BOOL_t *allowUnicast,
                                      open_buffdesc *localVrfName, open_buffdesc *relayDestVrfName, uint32_t *pdClientIntIfNum);

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

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

/*************************************************************************/
open_error_t openapiDhcp6MapIntfIsValid(openapiClientHandle_t *client_handle, uint32_t ifNum, OPEN_BOOL_t *isValidFlag);

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

/*************************************************************************/
open_error_t openapiDhcp6MapIntfValidNextGet(openapiClientHandle_t *client_handle, uint32_t prevIfNum, uint32_t *ifNum);

/*************************************************************************/
open_error_t openapiDhcp6sBindingGetNext(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_buffdesc *duid, uint32_t *iaid, open_inet_addr_t *prefixAddr,
                                         uint16_t *prefixLen, uint32_t *prefixType, open_inet_addr_t *clientAddr, uint32_t *clientIntfNum, uint32_t *expiration,
                                         uint32_t *validLifetime, uint32_t *preferLifetime);

/*************************************************************************/
open_error_t openapiDhcp6sBindingClear(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, OPEN_DHCP6_PREFIX_TYPE_t prefixType, open_inet_addr_t *clientAddr);

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

/*************************************************************************/
open_error_t openapiDhcp6sBindingCountGet(openapiClientHandle_t *client_handle, open_buffdesc *vrfName, uint32_t *count);

/*************************************************************************/
open_error_t openapiDhcp6sStatisticsGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_buffdesc *vrfName, openDhcp6sStatData_t *dhcp6Stats);

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

/*************************************************************************/
open_error_t openapiDhcpv6RelayEntryNextGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_inet_addr_t *relayAddr, uint32_t *relayIfNum, open_buffdesc *vrfName,
                                            uint32_t *nextIfNum, open_inet_addr_t *nextRelayAddr, uint32_t *nextRelayIfNum, open_buffdesc *nextVrfName);

/*************************************************************************/
open_error_t openapiDhcpv6RelayEntryGet(openapiClientHandle_t *client_handle, uint32_t ifNum, open_in6_addr_t *relayAddr, uint32_t *relayIfNum);


#endif /* OPENAPI_DHCP6S_H_INCLUDED */