NSX-T Data Center REST API

Update a specific DNS forwarder (Deprecated)

Update a specific DNS forwarder.
Deprecated: Please use Policy API: PUT /policy/api/v1/infra/tier-0s/{tier-0-id}/dns-forwarder PUT /policy/api/v1/infra/tier-1s/{tier-1-id}/dns-forwarder

Request:

Method:

PUT

URI Path(s):

/api/v1/dns/forwarders/{forwarder-id}

Request Headers:

n/a

Query Parameters:

n/a

Request Body:

DnsForwarder+

DnsForwarder (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cache_size	Cache size in KB One DNS answer cache entry will consume ~120 bytes. Hence 1 KB cache size can cache ~8 DNS answer entries, and the default 1024 KB cache size can hold ~8k DNS answer entries.	int	Minimum: 1 Maximum: 16777216 Default: "1024"
conditional_forwarders	Conditional zone forwarders The conditional zone forwarders. During matching a zone forwarder, the DNS forwarder will use the conditional fowarder with the longest domain name that matches the query.	array of ConditionalForwarderZone	Maximum items: 5
default_forwarder	Default zone forwarder The default zone forwarder that catches all other domain names except those matched by conditional forwarder zone.	ForwarderZone	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to enable/disable the forwarder	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
listener_ip	Listener ip address The ip address the DNS forwarder listens on. It can be an ip address already owned by the logical-router uplink port or router-link, or a loopback port ip address. But it can not be a downlink port address. User needs to ensure the address is reachable via router or NAT from both client VMs and upstream servers. User will need to create Firewall rules if needed to allow such traffic on a Tier-1 or Tier-0.	IPv4Address	Required
log_level	Log level of the DNS forwarder	string	Enum: DEBUG, INFO, WARNING, ERROR, FATAL Default: "INFO"
logical_router_id	Logical router id Specify the LogicalRouter where the DnsForwarder runs. The HA mode of the hosting LogicalRouter must be Active/Standby.	string	Required
resource_type	Must be set to the value DnsForwarder	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Request:

{ "display_name": "tenant_A_dns_forwarder", "logical_router_id": "e2fa39aa-f4ca-4781-ac48-60a6c47d34f8", "cache_size": 1024, "listener_ip": "10.10.10.10", "default_forwarder": { "upstream_servers": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "source_ip": "10.10.10.11" }, "conditional_forwarders": [ { "domain_names": [ "foo.com" ], "upstream_servers": [ "8.8.8.8" ], "source_ip": "10.10.10.12" },{ "domain_names": [ "dev.foo.com" ], "upstream_servers": [ "9.9.9.9" ], "source_ip": "10.10.10.101" },{ "domain_names": [ "bar.com" ], "upstream_servers": [ "55.55.55.5" ], "source_ip": "10.10.10.13" } ], "log_level": "INFO", "_revision" : 1 }

Successful Response:

Response Code:

200 OK

Response Headers:

Content-type: application/json

Response Body:

DnsForwarder+

DnsForwarder (schema)

(Deprecated)

Name	Description	Type	Notes
_create_time	Timestamp of resource creation	EpochMsTimestamp	Readonly Sortable
_create_user	ID of the user who created this resource	string	Readonly
_last_modified_time	Timestamp of last modification	EpochMsTimestamp	Readonly Sortable
_last_modified_user	ID of the user who last modified this resource	string	Readonly
_links	References related to this resource The server will populate this field when returing the resource. Ignored on PUT and POST.	array of ResourceLink	Readonly
_protection	Indicates protection status of this resource Protection status is one of the following: PROTECTED - the client who retrieved the entity is not allowed to modify it. NOT_PROTECTED - the client who retrieved the entity is allowed to modify it REQUIRE_OVERRIDE - the client who retrieved the entity is a super user and can modify it, but only when providing the request header X-Allow-Overwrite=true. UNKNOWN - the _protection field could not be determined for this entity.	string	Readonly
_revision	Generation of this resource config The _revision property describes the current revision of the resource. To prevent clients from overwriting each other's changes, PUT operations must include the current _revision of the resource, which clients should obtain by issuing a GET operation. If the _revision provided in a PUT request is missing or stale, the operation will be rejected.	int
_schema	Schema for this resource	string	Readonly
_self	Link to this resource	SelfResourceLink	Readonly
_system_owned	Indicates system owned resource	boolean	Readonly
cache_size	Cache size in KB One DNS answer cache entry will consume ~120 bytes. Hence 1 KB cache size can cache ~8 DNS answer entries, and the default 1024 KB cache size can hold ~8k DNS answer entries.	int	Minimum: 1 Maximum: 16777216 Default: "1024"
conditional_forwarders	Conditional zone forwarders The conditional zone forwarders. During matching a zone forwarder, the DNS forwarder will use the conditional fowarder with the longest domain name that matches the query.	array of ConditionalForwarderZone	Maximum items: 5
default_forwarder	Default zone forwarder The default zone forwarder that catches all other domain names except those matched by conditional forwarder zone.	ForwarderZone	Required
description	Description of this resource	string	Maximum length: 1024 Sortable
display_name	Identifier to use when displaying entity in logs or GUI Defaults to ID if not set	string	Maximum length: 255 Sortable
enabled	Flag to enable/disable the forwarder	boolean	Default: "True"
id	Unique identifier of this resource	string	Sortable
listener_ip	Listener ip address The ip address the DNS forwarder listens on. It can be an ip address already owned by the logical-router uplink port or router-link, or a loopback port ip address. But it can not be a downlink port address. User needs to ensure the address is reachable via router or NAT from both client VMs and upstream servers. User will need to create Firewall rules if needed to allow such traffic on a Tier-1 or Tier-0.	IPv4Address	Required
log_level	Log level of the DNS forwarder	string	Enum: DEBUG, INFO, WARNING, ERROR, FATAL Default: "INFO"
logical_router_id	Logical router id Specify the LogicalRouter where the DnsForwarder runs. The HA mode of the hosting LogicalRouter must be Active/Standby.	string	Required
resource_type	Must be set to the value DnsForwarder	string
tags	Opaque identifiers meaningful to the API user	array of Tag	Maximum items: 30

Example Response:

{ "resource_type" : "DnsFowarder", "id" : "1b6cb97f-ffa3-407c-b2ed-a9616feb95dd", "display_name": "tenant_A_dns_forwarder", "logical_router_id": "e2fa39aa-f4ca-4781-ac48-60a6c47d34f8", "cache_size": 1024, "listener_ip": "10.10.10.10", "default_forwarder": { "upstream_servers": [ "1.1.1.1", "2.2.2.2", "3.3.3.3" ], "source_ip": "10.10.10.11" }, "conditional_forwarders": [ { "domain_names": [ "foo.com" ], "upstream_servers": [ "8.8.8.8" ], "source_ip": "10.10.10.12" },{ "domain_names": [ "dev.foo.com" ], "upstream_servers": [ "9.9.9.9" ], "source_ip": "10.10.10.101" },{ "domain_names": [ "bar.com" ], "upstream_servers": [ "55.55.55.5" ], "source_ip": "10.10.10.13" } ], "log_level":"INFO", "_create_user" : "admin", "_last_modified_user" : "admin", "_create_time" : 1478305498175, "_last_modified_time" : 1478305499183, "_system_owned" : false, "_revision" : 2 }

Required Permissions:

crud

Feature:

dns_forwarder

Additional Errors:

• 301 Moved Permanently
• 307 Temporary Redirect
• 400 Bad Request
• 403 Forbidden
• 409 Conflict
• 412 Precondition Failed
• 500 Internal Server Error
• 503 Service Unavailable