openapi_dns.h

Go to the documentation of this file.

/*********************************************************************
*
* Copyright 2016-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_dns.h
*
* @purpose   DNS Configuration and Status 
*
* @component OpEN
*
* @create    01/30/2013
*
* @end
*
**********************************************************************/
#ifndef OPENAPI_DNS_H_INCLUDED
#define OPENAPI_DNS_H_INCLUDED

#include "openapi_common.h"

#define OPEN_DNS_NAME_LABELS_SIZE_MAX      255
#define OPEN_DNS_NAME_CASE_BITS_SIZE_MAX    32

#define OPEN_DNS_DOMAIN_NAME_SIZE_MAX      255

typedef struct openDnsDomainName_s
{
  uint8_t labels[OPEN_DNS_NAME_LABELS_SIZE_MAX+1];
  uint8_t uppercase[OPEN_DNS_NAME_CASE_BITS_SIZE_MAX];

} openDnsDomainName_t;

typedef enum openDnsDomainNameType_s
{
  OPEN_DNS_RR_TYPE_INVALID = 0,
  OPEN_DNS_RR_TYPE_ADDRESS = 1,
  OPEN_DNS_RR_TYPE_CNAME = 5,
  OPEN_DNS_RR_TYPE_PTR = 12,
  OPEN_DNS_RR_TYPE_IPV6_ADDRESS = 28

} openDnsDomainNameType_t;

typedef struct openDnsDynamicHostEntry_s
{
  uint8_t hostName[OPEN_DNS_DOMAIN_NAME_SIZE_MAX];

  /* Below ones are the Keys that the user expected to return */
  uint8_t rrName[OPEN_DNS_DOMAIN_NAME_SIZE_MAX + 1];
  uint32_t rrType;
  uint32_t rrIndex;
  uint32_t rrClass;

  uint32_t ttl;

  uint32_t ttlElapsed;

  openDnsDomainNameType_t entryType;

  open_inet_addr_t hostAddr;

} openDnsDynamicHostEntry_t;

/*****************************************************************/
open_error_t openapiDNSDefaultDomainNameSet(openapiClientHandle_t *client_handle,
                                            open_buffdesc *defaultDomainName);

/*****************************************************************/
open_error_t openapiDNSDefaultDomainNameGet(openapiClientHandle_t *client_handle,
                                            open_buffdesc *defaultDomainName);

/*****************************************************************/
open_error_t openapiDNSDomainNameMaxSizeGet(openapiClientHandle_t *client_handle,
                                            uint32_t *domainNameMaxSize);

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

/*****************************************************************/
open_error_t openapiDNSIpNameServerAdd(openapiClientHandle_t *client_handle,
                                       open_inet_addr_t *ipAddr);

/*****************************************************************/
open_error_t openapiDNSIpNameServerDelete(openapiClientHandle_t *client_handle,
                                          open_inet_addr_t *ipAddr); 

/*****************************************************************/
open_error_t openapiDNSIpNameServersNextGet(openapiClientHandle_t *client_handle,
                                            open_inet_addr_t *ipAddr);

/*****************************************************************/
open_error_t
openapiDNSIpNameServersWithPrefNextGet (openapiClientHandle_t *client_handle,
                                        open_inet_addr_t *ipAddr,
                                        uint32_t *preference);

/*****************************************************************/
open_error_t
openapiDnsDomainNameEntryNextGet (openapiClientHandle_t *client_handle,
                                  openDnsDynamicHostEntry_t *domainNameEntry);

/*****************************************************************/
open_error_t openapiDNSIpNameServersMaxSupportedGet(openapiClientHandle_t *client_handle,
                                                    uint32_t *maxNameServers);

/*****************************************************************/
open_error_t openapiDNSStaticHostAddressMappingSet(openapiClientHandle_t *client_handle,
                                                   open_buffdesc *hostname,
                                                   open_inet_addr_t *ipAddr);

/*****************************************************************/
open_error_t openapiDNSStaticHostAddressMappingRemove(openapiClientHandle_t *client_handle,
                                                      open_buffdesc *hostname);

/*****************************************************************/
open_error_t openapiDNSStaticHostNextGet(openapiClientHandle_t *client_handle,
                                         open_buffdesc *hostname);

/*****************************************************************/
open_error_t openapiDNSStaticHostIpAddrGet(openapiClientHandle_t *client_handle,
                                           open_buffdesc *hostname,
                                           open_inet_addr_t *ipAddr);

/*****************************************************************/
open_error_t openapiDNSDomainLabelMaximumSizeGet(openapiClientHandle_t *client_handle,
                                                 uint32_t *domainLabelMaxSize);

/*****************************************************************/
open_error_t openapiDNSClientInetNameLookup(openapiClientHandle_t *client_handle,
                                            open_buffdesc *hostname,
                                            open_buffdesc *ipAddr);

/*****************************************************************/
open_error_t openapiDNSAdminModeGet(openapiClientHandle_t * client_handle,
                                    OPEN_CONTROL_t * adminMode);

/*****************************************************************/
open_error_t openapiDNSAdminModeSet(openapiClientHandle_t * client_handle,
                                    OPEN_CONTROL_t adminMode);

/*****************************************************************/
open_error_t openapiDNSStaticHostAddressMappingDelete(openapiClientHandle_t *client_handle,
                                                      open_buffdesc *vrfName,
                                                      open_buffdesc *hostname,
                                                      OPEN_AF_t family);

/*****************************************************************/
open_error_t openapiDNSStaticHostAddressMappingNextGet(openapiClientHandle_t *client_handle,
                                                       open_buffdesc *vrfName,
                                                       open_buffdesc *hostname,
                                                       open_inet_addr_t *ipAddr);
#endif