EdgeNatRule

EdgeNatRule
EdgeNatRule

The configuration for a given NAT Rule.

JSON Example 
{
    "id": "string",
    "name": "string",
    "description": "string",
    "enabled": false,
    "type": "string",
    "applicationPortProfile": {
        "name": "string",
        "id": "string"
    },
    "externalAddresses": "string",
    "internalAddresses": "string",
    "internalPort": "string",
    "dnatExternalPort": "string",
    "logging": false,
    "systemRule": false,
    "snatDestinationAddresses": "string",
    "firewallMatch": "string",
    "priority": 0,
    "version": {
        "version": 0
    },
    "appliedTo": {
        "name": "string",
        "id": "string"
    }
}
string
id
Optional

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.

string
name
Required

User friendly name for the NAT Rule. Name must be provided.

string
description
Optional

description

boolean
enabled
Optional

A flag indicating whether the individual nat rule is enabled or not. The default is true.

NatRuleType
ruleType
Optional

ruleType

string
type
Optional

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.
EntityReference
applicationPortProfile
Optional

applicationPortProfile

string
externalAddresses
Required

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.

string
internalAddresses
Optional

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. Property must be set for rule types: REFLEXIVE, NO_SNAT, DNAT. If property is unset, the field means ANY network.

string
internalPort
Optional

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.

string
dnatExternalPort
Optional

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.

boolean
logging
Optional

A flag indicating whether logging for the individual nat rule is enabled or not. The default is false.

boolean
systemRule
Optional

A flag indicating whether this NAT rule is managed by the system. This is not user editable

string
snatDestinationAddresses
Optional

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.

string
firewallMatch
Optional

Determines how the firewall matches the address during NATing if firewall stage is not skipped. Below are valid values.

  • MATCH_INTERNAL_ADDRESS indicates 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_ADDRESS indicates 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.
  • BYPASS firewall stage will be skipped.
The default is MATCH_INTERNAL_ADDRESS.
integer As int32 As int32
priority
Optional

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. For API version below 38.0, this value defaults to 0. For API version 38.0 and above, this value defaults to 50.

ObjectVersion
version
Optional

version

EntityReference
appliedTo
Optional

appliedTo

Availability
Added in 33.0
Deprecated in 38.0
With alternative: see
See /cloudapi/2.0.0/edgeGateways/{gatewayId}/nat/rules/{ruleId}. New Model is GatewayNatRule.
Parameter To
Returned By