Get Edge Gateway Dns

Get Edge Gateway Dns

Retrieves DNS configuration of the edge gateway.

Request
URI
GET
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dns
COPY
Path Parameters
string
gatewayId
Required

gatewayId

string
gatewayId
Required

gatewayId

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns EdgeDnsConfig of type(s) application/json;version=39.0 
{
    "enabled": false,
    "listenerIp": "string",
    "defaultForwarderZone": {
        "id": "string",
        "displayName": "string",
        "dnsDomainNames": [
            "string"
        ],
        "upstreamServers": [
            "string"
        ]
    },
    "conditionalForwarderZones": [
        {
            "id": "string",
            "displayName": "string",
            "dnsDomainNames": [
                "string"
            ],
            "upstreamServers": [
                "string"
            ]
        }
    ],
    "version": {
        "version": 0
    },
    "snatRuleExternalIpAddress": "string",
    "snatRuleEnabled": false
}
boolean
enabled
Optional

True means that the forwarder is enabled. False means it's disabled.

string
listenerIp
Optional

The IP on which the DNS forwarder listens. If the Edge Gateway has a dedicated external network, this can be changed.

NsxtDnsForwarderZoneConfig
defaultForwarderZone
Optional

Specifies the list of domains and the DNS servers that handle those domains.

array of NsxtDnsForwarderZoneConfig
conditionalForwarderZones
Optional

The list of forwarder zones with its matching DNS domains.

ObjectVersion
version
Optional

This property describes the current version of the entity. To prevent clients from overwriting each other's changes, update operations must include the version which can be obtained by issuing a GET operation. If the version number on an update call is missing, the operation will be rejected. This is only needed on update calls.

string
snatRuleExternalIpAddress
Optional

The external IP address of the SNAT rule. This property only applies if the Edge Gateway is connected to a Provider Gateway using IP Space. If specified, VCD will conveniently manage the SNAT rule with the specified IP address for the DNS forwarder. In NAT routed environments, an SNAT rule is required for the Edge DNS forwarder to send the traffic to an upstream server. In fully routed environments, this is not needed if the listener IP is on an advertised subnet. If unset, the VCD-managed NAT rules will be removed and users can choose to manually manage the NAT rules.

boolean
snatRuleEnabled
Optional

Whether there is an SNAT rule exists for the DNS forwarder or not. In NAT routed environments, an SNAT rule is required for the Edge DNS forwarder to send traffic to an upstream server. In fully routed environments, this is not needed if the listener IP is on an advertised subnet. If the Edge Gateway is connected to a dedicated Provider Gateway and the listener IP has been changed, there will not be an SNAT rule for the DNS forwarder. In all other cases the SNAT rule will exist.


404

The specified resource was not found

Returns Error of type(s) application/json;version=39.0 
{
    "minorErrorCode": "string",
    "message": "string",
    "stackTrace": "string"
}
string
minorErrorCode
Required

minorErrorCode

string
message
Required

message

string
stackTrace
Optional

stackTrace


Availability
Added in 32.0
On This Page
Edge Gateway Dns Operations
DELETE
Delete Edge Gateway Dns
GET
Get Edge Gateway Dns
PUT
Update Edge Gateway Dns