[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update Edge Gateway DNS

Description

Updates DNS configuration of the edge gateway.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dns
Copy

Path Parameters

Path Parameters

string
gatewayId Required

Request Body

Request Body

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

The list of forwarder zones with its matching DNS domains.


defaultForwarderZone Optional

The default forwarder zone to use if there’s no matching domain in the conditional forwarder zone.


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.


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.


string
snatRuleExternalIpAddress Introduced 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.


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.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

202 Accepted

The request have been accepted and the task to monitor the request is in the Location header.

Errors

Errors

Error
400

Invalid configuration.


Error
404

The specified resource was not found

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"conditionalForwarderZones":[{"displayName":"string","dnsDomainNames":["string"],"id":"string","upstreamServers":["string"]}],"defaultForwarderZone":{"displayName":"string","dnsDomainNames":["string"],"id":"string","upstreamServers":["string"]},"enabled":false,"listenerIp":"string","snatRuleEnabled":false,"snatRuleExternalIpAddress":"string","version":{"version":0}}' https://{api_host}/cloudapi/1.0.0/edgeGateways/{gatewayId}/dns


[{"label":"Latest (v37.1)","version":"latest"},{"version":"v37.0"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Feedback

Was this page helpful?