Get NAT Rule
DescriptionRetrieves a specific NAT Rule configuration of the edge gateway based on the rule id passed in.
Request
URLURL
Path Parameters
Path Parameters
Authentication
Response
Response BodyResponse Body
200 OK
{
"applicationPortProfile": {
"id": "string",
"name": "string"
},
"appliedTo": {
"id": "string",
"name": "string"
},
"description": "string",
"dnatExternalPort": "string",
"enabled": false,
"externalAddresses": "string",
"firewallMatch": "string",
"id": "string",
"internalAddresses": "string",
"internalPort": "string",
"logging": false,
"name": "string",
"priority": 0,
"ruleType": "enum",
"snatDestinationAddresses": "string",
"systemRule": false,
"type": "string",
"version": {
"version": 0
}
}
The external addresses for the NAT Rule. This must be supplied as a single IP or Network CIDR. For a DNAT rule, this is the external facing IP Address for incoming traffic. For an SNAT rule, this is the external facing IP Address for outgoing traffic. These ips are typically allocated/suballocated IP Addresses on the Edge Gateway. For a REFLEXIVE rule, these are the external facing IPs.
User friendly name for the NAT Rule. Name must be provided.
The internal addresses for the NAT Rule. This must be supplied as a single IP or Network CIDR. For a DNAT rule, this is the internal IP Address for incoming traffic. For an SNAT rule, this is the internal IP Address for outgoing traffic. For a REFLEXIVE rule, these are the internal IPs. These ips are typically the Private IPs that are allocated to workloads.
Represents the application ports on which the NAT Rule will be applied. An application port profile id in the form of URN format must be provided. If not provided then the port will be considered as “ANY”. This should not be set for a REFLEXIVE Rule. For a DNAT Rule, the source port on the application port profile represents the port from which the traffic is originating from. For a DNAT rule, the destination port on the application port profile represents the internal port on the workloads where the traffic is terminating. For a SNAT rule, the source port on the application port profile represents the internal port on the workloads where the traffic is originating from. For a SNAT rule, the destination port application port profile represents the port where the traffic is terminating.
A flag indicating whether the individual nat rule is enabled or not. The default is true.
This represents the external port number or port range when doing DNAT port forwarding from external to internal. The default dnatExternalPort is “ANY” meaning traffic on any port for the given IPs selected will be translated.
Determines how the firewall matches the address during NATing if firewall stage is not skipped. Below are valid values.
-
MATCH_INTERNAL_ADDRESSindicates the firewall will be applied to internal address of a NAT rule. For SNAT, the internal address is the original source address before NAT is done. For DNAT, the internal address is the translated destination address after NAT is done. For REFLEXIVE, to egress traffic, the internal address is the original source address before NAT is done; to ingress traffic, the internal address is the translated destination address after NAT is done. -
MATCH_EXTERNAL_ADDRESSindicates the firewall will be applied to external address of a NAT rule. For SNAT, the external address is the translated source address after NAT is done. For DNAT, the external address is the original destination address before NAT is done. For REFLEXIVE, to egress traffic, the external address is the translated internal address after NAT is done; to ingress traffic, the external address is the original destination address before NAT is done. -
BYPASSfirewall stage will be skipped.
The unique id of the NAT Rule. This must be supplied when updating a given NAT Rule. On creation, an unique id is generated for the NAT Rule.
Port number or port range for incoming network traffic. If Any Traffic is selected for the Service, the default internal port is “ANY”. Note that this field has been deprecated. Please use dnatExternalPort to set port forwarding for DNAT rules. This typically should not be set for SNAT rules as the rule would not be able to support IP Translation with multiple ports.
A flag indicating whether logging for the individual nat rule is enabled or not. The default is false.
Used to limit application of this NAT rule to the specified Org VDC network. Only networks connected as service interfaces are usable.
If an address has multiple NAT rules, the rule with the highest priority is applied. A lower value means a higher precedence for this rule.
Represents the type of NAT Rule. SNAT translates an internal IP to an external IP and is used for outbound traffic. DNAT translates the external IP to an internal IP and is used for inbound traffic. This property is now deprecated and replaced with type.
The destination addresses to match in the SNAT Rule. This must be supplied as a single IP or Network CIDR. Providing no value for this field results in match with ANY destination network. These IPs are typically the Private IPs that are allocated to destination workloads.
A flag indicating whether this NAT rule is managed by the system. This is not user editable
Represents the type of NAT Rule. Below are valid values.
-
SNAT- This translates an internal IP to an external IP and is used for outbound traffic. -
DNAT- This translates the external IP to an internal IP and is used for inbound traffic. -
NO_SNAT- No internal IP translation takes place. -
NO_DNAT- No external IP translation takes place. -
REFLEXIVE- Also known as Stateless NAT. This translates an internal IP to an external IP and vice versa. The number of internal addresses should be exactly the same as that of external addresses.
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.
Errors
The specified resource was not found
