NSX Edge provides network address translation (NAT) service to assign a public address to a computer or group of computers in a private network. Using this technology limits the number of public IP addresses that an organization requires. You must configure NAT rules to provide access to services running on privately addressed virtual machines.

API-URL is a URL of the form https://vcloud.example.com/network.

id is a vCloud Director unique identifier in the form of a UUID, as defined by RFC 4122.

# is a small integer used in an NSX object identifier.

Summary of NSX Edge NAT Requests

Operation

Request

Request Body

Response

Retrieve edge NAT configuration for the edge with identifier id.

GET API-URL/edges/id/nat/config

None

nat

Update edge NAT configuration for the edge with identifier id.

PUT API-URL/edges/id/nat/config

nat

204 No Content

Reset edge NAT configuration for the edge with identifier id to factory defaults.

DELETE API-URL/edges/id/nat/config

None

204 No Content

Append a NAT rule to NAT rules on the edge with identifier id.

POST API-URL/edges/id/nat/config/rules

natRules

201 Created

Add an edge NAT rule above the rule with identifier# on the edge with identifier id.

POST API-URL/edges/id/nat/config/rules/?aboveRuleId=#

natRule

201 Created

Update edge NAT rule with identifier# on the edge with identifier id.

PUT API-URL/edges/id/nat/config/rules/#

natRule

204 No Content

Delete edge NAT rule with the identifier# from the edge with identifier id.

Delete API-URL/edges/id/nat/config/rules/#

None

204 No Content

Note

Every external IP address associated with a NAT rule must be registered as a secondary address on the Edge Gateway's uplink interface. The vCloud Director API for NSX handles this registration automatically. Administrators using the NSX API must register those external IP addresses manually.