Configure Dns Settings

Configure Dns Settings
Configure DNS Settings

Configures DNS server addresses and search domains for the HCX Manager appliance.

Important Notes:

  • Service Restart Required: You must restart the Application Service and Web Service for DNS changes to take effect
  • Changes are persistent across reboots
  • Maximum 3 DNS servers recommended (OS limitation)
  • DNS search domains help resolve unqualified hostnames

Restart Commands:

systemctl restart app-engine
systemctl restart web-engine

Warning: Without DNS configuration, the HCX Manager may not resolve:

  • vCenter Server hostnames
  • NSX Manager hostnames
  • NTP server hostnames
  • External service endpoints
Request
URI
PUT
https://{server}:9443/system/network/dns
COPY
Request Body
DNSConfiguration of type(s) application/json
Required 
{
    "ipv4Dns": [
        "10.0.0.10",
        "10.0.0.11"
    ],
    "ipv6Dns": [
        "2001:db8::1",
        "2001:db8::2"
    ],
    "domainList": "example.com,corp.example.com"
}
array of string
ipv4Dns
Optional

List of IPv4 DNS server addresses

array of string
ipv6Dns
Optional

List of IPv6 DNS server addresses

string
domainList
Optional

Comma-separated list of DNS search domains

Authentication
This operation uses the following authentication methods.
Responses
200

DNS settings configured successfully

Returns DNSConfiguration of type(s) application/json 
{
    "ipv4Dns": [
        "10.0.0.10",
        "10.0.0.11"
    ],
    "ipv6Dns": [
        "2001:db8::1",
        "2001:db8::2"
    ],
    "domainList": "example.com,corp.example.com"
}
array of string
ipv4Dns
Optional

List of IPv4 DNS server addresses

array of string
ipv6Dns
Optional

List of IPv6 DNS server addresses

string
domainList
Optional

Comma-separated list of DNS search domains


400

Bad request - Invalid DNS configuration

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


500

Internal server error - Failed to configure DNS

Returns ErrorResponse of type(s) application/json 
{
    "isSuccess": false,
    "message": "Request schema validation failed",
    "httpStatusCode": 400
}
boolean
isSuccess
Required

Indicates if the operation was successful

string
message
Required

Human-readable error message

integer
httpStatusCode
Required

HTTP status code


Code Samples
COPY
                    curl -X PUT -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{}' https://{api_host}/system/network/dns
On This Page
System Configuration Operations
GET
Get Nsp Configuration
Deprecated
POST
Create Nsp Configuration
Deprecated
PUT
Update Nsp Configuration
Deprecated
GET
Get Static Routes
PUT
Configure Static Route
GET
Get Network Settings
PUT
Configure Dns Settings
DELETE
Remove Dns Settings
GET
Get Time Settings
PUT
Configure Time Settings
DELETE
Remove Ntp Settings
PUT
Change Appliance Password
GET
Get Apache Proxy Configuration
Deprecated
POST
Configure Apache Proxy
Deprecated