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

Go to the source code of this file.

Data Structures

struct  openDnsDomainName_s
 
struct  openDnsDynamicHostEntry_s
 

Macros

#define OPEN_DNS_DOMAIN_NAME_SIZE_MAX   255
 
#define OPEN_DNS_NAME_CASE_BITS_SIZE_MAX   32
 
#define OPEN_DNS_NAME_LABELS_SIZE_MAX   255
 Message structures for DNS Dynamic Host entries. More...
 

Typedefs

typedef struct openDnsDomainName_s openDnsDomainName_t
 
typedef enum
openDnsDomainNameType_s 
openDnsDomainNameType_t
 
typedef struct
openDnsDynamicHostEntry_s 
openDnsDynamicHostEntry_t
 

Enumerations

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
}
 

Functions

open_error_t openapiDNSAdminModeGet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
 Get the global admin mode for the DNS client. More...
 
open_error_t openapiDNSAdminModeSet (openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
 Set the global admin mode for the DNS client. More...
 
open_error_t openapiDNSClientInetNameLookup (openapiClientHandle_t *client_handle, open_buffdesc *hostname, open_buffdesc *ipAddr)
 Given a DNS hostname, resolve and return IPv4 or IPv6 address associated with it. More...
 
open_error_t openapiDNSDefaultDomainNameDelete (openapiClientHandle_t *client_handle)
 Clear the DNS default domain name. More...
 
open_error_t openapiDNSDefaultDomainNameGet (openapiClientHandle_t *client_handle, open_buffdesc *defaultDomainName)
 Get the DNS default domain name. More...
 
open_error_t openapiDNSDefaultDomainNameSet (openapiClientHandle_t *client_handle, open_buffdesc *defaultDomainName)
 Set the DNS default domain name. More...
 
open_error_t openapiDNSDomainLabelMaximumSizeGet (openapiClientHandle_t *client_handle, uint32_t *domainLabelMaxSize)
 Get the maximum size of the DNS domain label that is separated by dot. More...
 
open_error_t openapiDnsDomainNameEntryNextGet (openapiClientHandle_t *client_handle, openDnsDynamicHostEntry_t *domainNameEntry)
 Get the next domain name host entry. More...
 
open_error_t openapiDNSDomainNameMaxSizeGet (openapiClientHandle_t *client_handle, uint32_t *domainNameMaxSize)
 Get the maximum size of domain name. More...
 
open_error_t openapiDNSIpNameServerAdd (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
 Add DNS IP name server. More...
 
open_error_t openapiDNSIpNameServerDelete (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
 Delete DNS IP name server. More...
 
open_error_t openapiDNSIpNameServersMaxSupportedGet (openapiClientHandle_t *client_handle, uint32_t *maxNameServers)
 Get the maximum number of DNS name servers supported. More...
 
open_error_t openapiDNSIpNameServersNextGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
 Get next name server. More...
 
open_error_t openapiDNSIpNameServersWithPrefNextGet (openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr, uint32_t *preference)
 Get next name server along with preference. More...
 
open_error_t openapiDNSStaticHostAddressMappingDelete (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_buffdesc *hostname, OPEN_AF_t family)
 Remove IPv4/IPv6 static hostname to address mapping. More...
 
open_error_t openapiDNSStaticHostAddressMappingNextGet (openapiClientHandle_t *client_handle, open_buffdesc *vrfName, open_buffdesc *hostname, open_inet_addr_t *ipAddr)
 Get the next static hostname and the IPv6/IPv6 address associated with the static host name. More...
 
open_error_t openapiDNSStaticHostAddressMappingRemove (openapiClientHandle_t *client_handle, open_buffdesc *hostname)
 Remove static hostname to address mapping. More...
 
open_error_t openapiDNSStaticHostAddressMappingSet (openapiClientHandle_t *client_handle, open_buffdesc *hostname, open_inet_addr_t *ipAddr)
 Set the static hostname to IP address mapping. More...
 
open_error_t openapiDNSStaticHostIpAddrGet (openapiClientHandle_t *client_handle, open_buffdesc *hostname, open_inet_addr_t *ipAddr)
 Get the IP address associated with the static host name. More...
 
open_error_t openapiDNSStaticHostNextGet (openapiClientHandle_t *client_handle, open_buffdesc *hostname)
 Get next static hostname. More...