Open Ethernet Networking (OpEN) API Guide and Reference Manual  3.6.0.3
openapi_dns.h
Go to the documentation of this file.
1 
9 /*********************************************************************
10 *
11 * Copyright 2016-2018 Broadcom.
12 *
13 * Licensed under the Apache License, Version 2.0 (the "License");
14 * you may not use this file except in compliance with the License.
15 * You may obtain a copy of the License at
16 *
17 * http://www.apache.org/licenses/LICENSE-2.0
18 *
19 * Unless required by applicable law or agreed to in writing, software
20 * distributed under the License is distributed on an "AS IS" BASIS,
21 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
22 * See the License for the specific language governing permissions and
23 * limitations under the License.
24 *
25 **********************************************************************
26 *
27 * @filename openapi_dns.h
28 *
29 * @purpose DNS Configuration and Status
30 *
31 * @component OpEN
32 *
33 * @create 01/30/2013
34 *
35 * @end
36 *
37 **********************************************************************/
38 #ifndef OPENAPI_DNS_H_INCLUDED
39 #define OPENAPI_DNS_H_INCLUDED
40 
41 #include "openapi_common.h"
42 
43 /*****************************************************************/
69  open_buffdesc *defaultDomainName);
70 
71 /*****************************************************************/
90  open_buffdesc *defaultDomainName);
91 
92 /*****************************************************************/
108  uint32_t *domainNameMaxSize);
109 
110 /*****************************************************************/
127 
128 /*****************************************************************/
151  open_inet_addr_t *ipAddr);
152 
153 /*****************************************************************/
174  open_inet_addr_t *ipAddr);
175 
176 /*****************************************************************/
193  open_inet_addr_t *ipAddr);
194 
195 /*****************************************************************/
212  uint32_t *maxNameServers);
213 
214 /*****************************************************************/
247  open_buffdesc *hostname,
248  open_inet_addr_t *ipAddr);
249 
250 /*****************************************************************/
277  open_buffdesc *hostname);
278 
279 /*****************************************************************/
299  open_buffdesc *hostname);
300 
301 /*****************************************************************/
323  open_buffdesc *hostname,
324  open_inet_addr_t *ipAddr);
325 
326 /*****************************************************************/
342  uint32_t *inetAddrMaxSize);
343 
344 /*****************************************************************/
360  uint32_t *domainLabelMaxSize);
361 
362 /*****************************************************************/
383  open_buffdesc *hostname,
384  open_buffdesc *ipAddr);
385 
386 /*****************************************************************/
402  OPEN_CONTROL_t * adminMode);
403 
404 /*****************************************************************/
420  OPEN_CONTROL_t adminMode);
421 
422 #endif
423 
open_error_t openapiDNSDomainNameMaxSizeGet(openapiClientHandle_t *client_handle, uint32_t *domainNameMaxSize)
Get the maximum size of domain name.
open_error_t openapiDNSAdminModeGet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t *adminMode)
Get the global admin mode for the DNS client.
open_error_t openapiDNSIpNameServerDelete(openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
Delete DNS IP name server.
open_error_t openapiDNSStaticHostAddressMappingSet(openapiClientHandle_t *client_handle, open_buffdesc *hostname, open_inet_addr_t *ipAddr)
Set the static hostname to IP address mapping.
open_error_t openapiDNSIpNameServersNextGet(openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
Get next name server.
open_error_t openapiDNSIpNameServersMaxSupportedGet(openapiClientHandle_t *client_handle, uint32_t *maxNameServers)
Get the maximum number of DNS name servers supported.
open_error_t openapiDNSStaticHostAddressMappingRemove(openapiClientHandle_t *client_handle, open_buffdesc *hostname)
Remove static hostname to address mapping.
open_error_t
OPEN uses these enumerators to indicate the error codes.
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.
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.
open_error_t openapiDNSDefaultDomainNameDelete(openapiClientHandle_t *client_handle)
Clear the DNS default domain name.
open_error_t openapiDNSDefaultDomainNameGet(openapiClientHandle_t *client_handle, open_buffdesc *defaultDomainName)
Get the DNS default domain name.
OPEN_CONTROL_t
OPEN uses these enumerators to indicate enable or disable for a given config or status parameter...
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. ...
open_error_t openapiDNSStaticHostNextGet(openapiClientHandle_t *client_handle, open_buffdesc *hostname)
Get next static hostname.
open_error_t openapiInetAddrMaxSizeGet(openapiClientHandle_t *client_handle, uint32_t *inetAddrMaxSize)
Get the maximum size of inet address length.
open_error_t openapiDNSAdminModeSet(openapiClientHandle_t *client_handle, OPEN_CONTROL_t adminMode)
Set the global admin mode for the DNS client.
open_error_t openapiDNSDefaultDomainNameSet(openapiClientHandle_t *client_handle, open_buffdesc *defaultDomainName)
Set the DNS default domain name.
open_error_t openapiDNSIpNameServerAdd(openapiClientHandle_t *client_handle, open_inet_addr_t *ipAddr)
Add DNS IP name server.