EdgeDnsConfig

Specifies the DNS forwarder configuration for an edge gateway backed by NSX-T.


Properties

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 has a dedicated external network 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.


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.

JSON Example

{
	"conditionalForwarderZones": [
		{
			"displayName": "string",
			"dnsDomainNames": [
				"string"
			],
			"id": "string",
			"upstreamServers": [
				"string"
			]
		}
	],
	"defaultForwarderZone": {
		"displayName": "string",
		"dnsDomainNames": [
			"string"
		],
		"id": "string",
		"upstreamServers": [
			"string"
		]
	},
	"enabled": false,
	"listenerIp": "string",
	"snatRuleEnabled": false,
	"version": {
		"version": 0
	}
}

Vendor Extensions

This class contains the following vendor extensions defined in the spec:
x-vcloud-property-annotations:
  conditionalForwarderZones:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  defaultForwarderZone:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  enabled:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
  listenerIp:
    x-vcloud-constraints:
    - constraint: NonSearchable
    - constraint: NonSortable
    - args:
      - arg: IPV4_IP
      constraint: NetworkAddress
  snatRuleEnabled:
    x-vcloud-added-in: "34.0"
    x-vcloud-constraints:
    - constraint: ReadOnly
    - constraint: NonSearchable
    - constraint: NonSortable
Availability
Added in 32.0
Parameter To

Update Edge Gateway DNS
Returned By

Get Edge Gateway DNS

Feedback

Was this page helpful?