DNS Configuration And Status [OPENAPI_DNS]

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...

Detailed Description

Macro Definition Documentation

#define OPEN_DNS_NAME_LABELS_SIZE_MAX   255

Message structures for DNS Dynamic Host entries.

Definition at line 47 of file openapi_dns.h.

Function Documentation

open_error_t openapiDNSAdminModeGet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t *	adminMode
	)

Get the global admin mode for the DNS client.

Parameters

[in]	client_handle	client handle from registration API
[out]	adminMode	Admin Mode value

Return values

OPEN_E_NONE	Get successful.
OPEN_E_FAIL	Get failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_INTERNAL	Other Internal Failure.
OPEN_E_UNAVAIL	If feature is not available.

OpEN API Version: 1.19

Examples:

dns_example.c.

open_error_t openapiDNSAdminModeSet	(	openapiClientHandle_t *	client_handle,
		OPEN_CONTROL_t	adminMode
	)

Set the global admin mode for the DNS client.

Parameters

[in]	client_handle	client handle from registration API
[in]	adminMode	Admin Mode value

Return values

OPEN_E_NONE	Set successful.
OPEN_E_FAIL	Set failed.
OPEN_E_PARAM	Error in parameter passed.
OPEN_E_UNAVAIL	If feature is not available.

OpEN API Version: 1.19

Examples:

dns_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API
[in]	hostname	Pointer to hostname string storage
	-	Minimum value OPENAPI_DNS_HOST_NAME_LEN_MIN
	-	Maximum value OPENAPI_DNS_HOST_NAME_LEN_MAX
[out]	ipAddr	Pointer to resolved IP address string storage. Buffer allocated size must be at least openapiIpAddressMaxStringLength().

Return values

OPEN_E_NONE	if successfully
OPEN_E_FAIL	if DNS hostname look up failed
OPEN_E_ERROR	if operation has failed
OPEN_E_PARAM	if invalid parameter is supplied

OpEN API Version: 1.8

Examples:

dns_example.c.

open_error_t openapiDNSDefaultDomainNameDelete

(

openapiClientHandle_t *

client_handle

)

Clear the DNS default domain name.

Parameters

[in]

client_handle

Client handle from registration API

Return values

OPEN_E_NONE	if default domain name is deleted.
OPEN_E_FAIL	if failed to delete default domain name.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Calling this API will change the running configuration of the switch.

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSDefaultDomainNameGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	defaultDomainName
	)

Get the DNS default domain name.

Parameters

[in]	client_handle	Client handle from registration API
[out]	defaultDomainName	Default domain name

Return values

OPEN_E_NONE	if default domain name is returned.
OPEN_E_NOT_FOUND	if default domain name is not configured.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSDefaultDomainNameSet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	defaultDomainName
	)

Set the DNS default domain name.

Parameters

[in]	client_handle	Client handle from registration API
[in]	defaultDomainName	Default domain name

Return values

OPEN_E_NONE	if default domain name is set.
OPEN_E_FAIL	if invalid domain name is passed.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Calling this API will change the running configuration of the switch.

A valid domain name;
(i) Must not contain spaces/dots at the end and beginning.
(ii) Each substring separated by dot must not exceed characters as returned by openapiDNSDomainLabelMaximumSizeGet() and overall length must not exceed maximum characters as returned by openapiDNSDomainNameMaxSizeGet().
(iii) Each substring must start with an alphanumeric character.
(iv) Must not contain subsequent dots.

OpEN API Version: 1.1

Examples:

dns_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API
[out]	domainLabelMaxSize	Domain name label maximum size

Return values

OPEN_E_NONE	if maximum size of domain label is returned.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

OpEN API Version: 1.1

open_error_t openapiDnsDomainNameEntryNextGet	(	openapiClientHandle_t *	client_handle,
		openDnsDynamicHostEntry_t *	domainNameEntry
	)

Get the next domain name host entry.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	domainNameEntry	Pointer to the domain name entry

Return values

OPEN_E_NONE	if name server is returned.
OPEN_E_FAIL	if no more name severs are found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.
OPEN_E_NOT_FOUND	if no entries are found.

OpEN API Version: 1.26

Examples:

dns_example.c.

open_error_t openapiDNSDomainNameMaxSizeGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	domainNameMaxSize
	)

Get the maximum size of domain name.

Parameters

[in]	client_handle	Client handle from registration API
[out]	domainNameMaxSize	Maximum size of domain name

Return values

OPEN_E_NONE	if maximum size of domain name is returned.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSIpNameServerAdd	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t *	ipAddr
	)

Add DNS IP name server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipAddr	IPv4/IPv6 address of name server

Return values

OPEN_E_NONE	if name server is added successfully.
OPEN_E_FAIL	if invalid IP address.
OPEN_E_FULL	if maximum number of name servers are reached.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Calling this API will change the running configuration of the switch.

IP name servers added will be in precedence with the first added server having first preference.

IP address validation can be made via openapiInetAddrGet() as it validates the given IP and also converts it to network byte order.

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSIpNameServerDelete	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t *	ipAddr
	)

Delete DNS IP name server.

Parameters

[in]	client_handle	Client handle from registration API
[in]	ipAddr	IPv4/IPv6 address of name server

Return values

OPEN_E_NONE	if name server is deleted successfully.
OPEN_E_FAIL	if IP address is not found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Calling this API will change the running configuration of the switch.

To delete all the servers at a time pass empty ipAddr structure.

IP address validation can be made via openapiInetAddrGet() as it validates the given IP and also converts it to network byte order.

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSIpNameServersMaxSupportedGet	(	openapiClientHandle_t *	client_handle,
		uint32_t *	maxNameServers
	)

Get the maximum number of DNS name servers supported.

Parameters

[in]	client_handle	Client handle from registration API
[out]	maxNameServers	Maximum number of name servers supported

Return values

OPEN_E_NONE	if maximum number supported is returned.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSIpNameServersNextGet	(	openapiClientHandle_t *	client_handle,
		open_inet_addr_t *	ipAddr
	)

Get next name server.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	ipAddr	IPv4/IPv6 address of name server

Return values

OPEN_E_NONE	if name server is returned.
OPEN_E_FAIL	if no more name severs are found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

OpEN API Version: 1.1

Examples:

dns_example.c.

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

Get next name server along with preference.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	ipAddr	IPv4/IPv6 address of name server
[in,out]	preference	Preference value of the name server

Return values

OPEN_E_NONE	if name server is returned.
OPEN_E_FAIL	if no more name severs are found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

OpEN API Version: 1.26

Examples:

dns_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API.
[in]	vrfName	VRF name.
[in]	hostname	DNS hostname.
[in]	family	Address family (IPv4 or IPv6).

Return values

OPEN_E_NONE	if hostname to IPv4/IPv6 address mapping id removed.
OPEN_E_NOT_FOUND	if host name is not found.
OPEN_E_FAIL	if invalid hostname is passed.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if internal error has occurred.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

A valid hostname
(i) Must not contain spaces/dot at the end and beginning.
(ii) Each substring separated by dot must not exceed 63 characters and overall length must not exceed 255 chars.
(iii) Each substring must start with an alphanumeric character.
(iv) Must not contain subsequent dots.

OpEN API Version: 1.26

Examples:

dns_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API
[in]	vrfName	VRF name.
[in,out]	hostname	DNS hostname.
[in,out]	ipAddr	IPv4/Ipv6 address associated with the static hostname.

Return values

OPEN_E_NONE	if next static entry is returned successfully.
OPEN_E_FAIL	if no more entries are found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Pass hostname as empty string to get the first entry. Pass ipAddr->family as OPEN_AF_NONE to get the first entry.

OpEN API Version: 1.26

Examples:

dns_example.c.

open_error_t openapiDNSStaticHostAddressMappingRemove	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	hostname
	)

Remove static hostname to address mapping.

Parameters

[in]	client_handle	Client handle from registration API
[in]	hostname	DNS hostname

Return values

OPEN_E_NONE	if hostname to IP address mapping id removed.
OPEN_E_NOT_FOUND	if host name is not found.
OPEN_E_FAIL	if invalid hostname is passed.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if internal error has occurred.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

A valid hostname
(i) Must not contain spaces/dot at the end and beginning.
(ii) Each substring separated by dot must not exceed 63 characters and overall length must not exceed 255 chars.
(iii) Each substring must start with an alphanumeric character.
(iv) Must not contain subsequent dots.

OpEN API Version: 1.1

Examples:

dns_example.c.

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

Set the static hostname to IP address mapping.

Parameters

[in]	client_handle	Client handle from registration API
[in]	hostname	DNS hostname
[in]	ipAddr	IP address mapped to the hostname

Return values

OPEN_E_NONE	if hostname to IP address mapping is successful.
OPEN_E_FAIL	if invalid hostname is passed.
OPEN_E_FULL	if no more space to add entries.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_INTERNAL	if internal error has occurred.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

A valid domain name;
(i) Must not contain spaces/dots at the end and beginning.
(ii) Each substring separated by dot must not exceed characters as returned by openapiDNSDomainLabelMaximumSizeGet() and overall length must not exceed maximum characters as returned by openapiDNSDomainNameMaxSizeGet().
(iii) Each substring must start with an alphanumeric character.
(iv) Must not contain subsequent dots.

IP address validation can be made via openapiInetAddrGet() as it validates the given IP and also converts it to network byte order.

OpEN API Version: 1.1

Examples:

dns_example.c.

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.

Parameters

[in]	client_handle	Client handle from registration API
[in]	hostname	DNS hostname
[out]	ipAddr	IP address associated with the static hostname

Return values

OPEN_E_NONE	if the IP address associated with the static hostname is returned.
OPEN_E_FAIL	if host name does not exist.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

OpEN API Version: 1.1

Examples:

dns_example.c.

open_error_t openapiDNSStaticHostNextGet	(	openapiClientHandle_t *	client_handle,
		open_buffdesc *	hostname
	)

Get next static hostname.

Parameters

[in]	client_handle	Client handle from registration API
[in,out]	hostname	DNS hostname

Return values

OPEN_E_NONE	if next static entry is returned successfully.
OPEN_E_FAIL	if no more entries are found.
OPEN_E_PARAM	if invalid parameter is passed.
OPEN_E_UNAVAIL	if not supported for this platform.

Note

Maximum size for defaultDomainName is determined by calling openapiDNSDomainNameMaxSizeGet().

Pass hostname as empty string to get the first entry.

OpEN API Version: 1.1

Examples:

dns_example.c.