Open Ethernet Networking (OpEN) API Guide and Reference Manual
3.6.0.3
|
open_error_t openapiDNSAdminModeGet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t * | adminMode | ||
) |
Get the global admin mode for the DNS client.
[in] | client_handle | client handle from registration API |
[out] | adminMode | Admin Mode value |
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
open_error_t openapiDNSAdminModeSet | ( | openapiClientHandle_t * | client_handle, |
OPEN_CONTROL_t | adminMode | ||
) |
Set the global admin mode for the DNS client.
[in] | client_handle | client handle from registration API |
[in] | adminMode | Admin Mode value |
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
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.
[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.
|
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
open_error_t openapiDNSDefaultDomainNameDelete | ( | openapiClientHandle_t * | client_handle | ) |
Clear the DNS default domain name.
[in] | client_handle | Client handle from registration API |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSDefaultDomainNameGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | defaultDomainName | ||
) |
Get the DNS default domain name.
[in] | client_handle | Client handle from registration API |
[out] | defaultDomainName | Default domain name |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSDefaultDomainNameSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | defaultDomainName | ||
) |
Set the DNS default domain name.
[in] | client_handle | Client handle from registration API |
[in] | defaultDomainName | Default domain name |
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. |
OpEN API Version: 1.1
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.
[in] | client_handle | Client handle from registration API |
[out] | domainLabelMaxSize | Domain name label maximum size |
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 openapiDNSDomainNameMaxSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | domainNameMaxSize | ||
) |
Get the maximum size of domain name.
[in] | client_handle | Client handle from registration API |
[out] | domainNameMaxSize | Maximum size of domain name |
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
open_error_t openapiDNSIpNameServerAdd | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | ipAddr | ||
) |
Add DNS IP name server.
[in] | client_handle | Client handle from registration API |
[in] | ipAddr | IPv4/IPv6 address of name server |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSIpNameServerDelete | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | ipAddr | ||
) |
Delete DNS IP name server.
[in] | client_handle | Client handle from registration API |
[in] | ipAddr | IPv4/IPv6 address of name server |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSIpNameServersMaxSupportedGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | maxNameServers | ||
) |
Get the maximum number of DNS name servers supported.
[in] | client_handle | Client handle from registration API |
[out] | maxNameServers | Maximum number of name servers supported |
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
open_error_t openapiDNSIpNameServersNextGet | ( | openapiClientHandle_t * | client_handle, |
open_inet_addr_t * | ipAddr | ||
) |
Get next name server.
[in] | client_handle | Client handle from registration API |
[in,out] | ipAddr | IPv4/IPv6 address of name server |
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
open_error_t openapiDNSStaticHostAddressMappingRemove | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | hostname | ||
) |
Remove static hostname to address mapping.
[in] | client_handle | Client handle from registration API |
[in] | hostname | DNS hostname |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSStaticHostAddressMappingSet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | hostname, | ||
open_inet_addr_t * | ipAddr | ||
) |
Set the static hostname to IP address mapping.
[in] | client_handle | Client handle from registration API |
[in] | hostname | DNS hostname |
[in] | ipAddr | IP address mapped to the hostname |
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. |
OpEN API Version: 1.1
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.
[in] | client_handle | Client handle from registration API |
[in] | hostname | DNS hostname |
[out] | ipAddr | IP address associated with the static hostname |
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. |
OpEN API Version: 1.1
open_error_t openapiDNSStaticHostNextGet | ( | openapiClientHandle_t * | client_handle, |
open_buffdesc * | hostname | ||
) |
Get next static hostname.
[in] | client_handle | Client handle from registration API |
[in,out] | hostname | DNS hostname |
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. |
OpEN API Version: 1.1
open_error_t openapiInetAddrMaxSizeGet | ( | openapiClientHandle_t * | client_handle, |
uint32_t * | inetAddrMaxSize | ||
) |
Get the maximum size of inet address length.
[in] | client_handle | Client handle from registration API |
[out] | inetAddrMaxSize | Inet address maximum length |
OPEN_E_NONE | if maximum size of inet address is returned. |
OPEN_E_PARAM | if invalid parameter is passed. |
OPEN_E_UNAVAIL | if not supported for this platform. |
OpEN API Version: 1.1