API ReferenceNew CentralGuidesMRT APIConfiguration API
GithubAirheads Developer Community
API Reference
GithubAirheads Developer Community

Modify DNS profile

patch
https://de1.api.central.arubanetworks.com/network-config/v1alpha1/dns/

Global profile for DNS parameters

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Path Params
string
required
length ≤ 9999

DNS profile name

Query Params
string

LOCAL - To update local objects. SHARED - To update shared objects. Default - Defaults to SHARED if not provided

string

Scope at which local object needs to be updated. Mandatory if object-type = LOCAL. Should not be provided for object-type = SHARED.

string

Device function for which the local object needs to be updated. Mandatory if object_type = LOCAL. Should not be provided for object_type = SHARED.

Body Params

profilebody object

int32
150 to 4096
Defaults to 150

DNS cache size when the device is used as resolver or proxy. Default is 150

boolean
Defaults to true

DNS parameters via DHCP

boolean
Defaults to true

Enable DNS resolver functionality

boolean
Defaults to false

Enable redirect DNS resolver functionality

string
enum

Enable redirect DNS resolver functionality

Show Details
ENABLE_ALL_VLANSEnable redirect DNS resolver functionality for L2 & L3 VLANs
L2VLANS_ONLYEnable redirect DNS resolver functionality for L2 Overlay VLANs
L3VLANS_ONLYEnable redirect DNS resolver functionality for L3 VLANs
NONEDisables redirect DNS resolver functionality
Allowed:
domain
array of objects
length ≤ 2147483647

DNS domain-names to be used for name resolution

domain
domain-list
array of objects
length ≤ 2147483647

A list of domain-names used for address resolution

domain-list
resolver
array of objects
length ≤ 2147483647

List of DNS servers used for name resolution

resolver
string
length between 1 and 256

Aliases for the list of DNS name servers.

redirect
object

Grouping for configuring the DNS servers to be used by the resolver for specific domains.
The DNS queries for the configured domains will be redirected to the domain specific DNS servers.
For Gateway a maximum of 3 DNS servers per domain can be configured

static-host
array of objects
length ≤ 2147483647

List of DNS static host-ip associations

static-host
split-dns
object

When the enterprise domain is configured, the DNS resolution for domain names
in the enterprise domain list is forwarded to the default Corporate DNS server of the client.
The DNS resolution for all other domains is forwarded to the local DNS server of the AP's
uplink learned DNS server.
For example, if the enterprise domain is configured for arubanetworks.com, the DNS resolution
for host names in the arubanetworks.com domain is forwarded to the default DNS server of the client.
The DNS resolution for domain names in all other domains is forwarded to the local DNS server of the IAP.
This Split DNS functionality is supported for IAP-VPN scenarios only.
AOS8x IAP-VPN will use the enterprise domains list to split-dns, However AOS10x uses redirect
list with server ip address and domains for DNS resolutions same as BGW.

string
length between 1 and 256

DNS profile description

string
length between 1 and 256

DNS profile name

Responses

Updated 11 days ago

Language
Credentials
OAuth2
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

Updated 11 days ago