nsxnatrule

nsxnatrule
nsxnatrule

NAT rule

JSON Example
{
    "vnic": "string",
    "ruleType": "string",
    "protocol": "string",
    "description": "string",
    "ruleId": 0,
    "snatMatchDestinationPort": "string",
    "originalAddress": "string",
    "dnatMatchSourceAddress": "string",
    "dnatMatchSourcePort": "string",
    "snatMatchDestinationAddress": "string",
    "originalPort": "string",
    "loggingEnabled": false,
    "translatedAddress": "string",
    "enabled": false,
    "icmpType": "string",
    "translatedPort": "string",
    "action": "string",
    "ruleTag": 0
}
string
vnic
Optional

Interface on which the NAT rule is applied.

string
ruleType
Optional

Identifies the type of the rule. internal_high or user.

string
protocol
Optional

Protocol. Default is 'any'

string
description
Optional

Description for the rule.

integer As int64 As int64
ruleId
Optional

Identifier for the rule.

string
snatMatchDestinationPort
Optional

Apply SNAT rule only if traffic has this destination port. Default is 'any'.

string
originalAddress
Optional

Original address or address range. This is the original source address for SNAT rules and the original destination address for DNAT rules.

string
dnatMatchSourceAddress
Optional

Apply DNAT rule only if traffic has this source address. Default is 'any'.

string
dnatMatchSourcePort
Optional

Apply DNAT rule only if traffic has this source port. Default is 'any'.

string
snatMatchDestinationAddress
Optional

Apply SNAT rule only if traffic has this destination address. Default is 'any'.

string
originalPort
Optional

Original port. This is the original source port for SNAT rules, and the original destination port for DNAT rules.

boolean
loggingEnabled
Optional

Enable logging for the rule.

string
translatedAddress
Optional

Translated address or address range.

boolean
enabled
Optional

Enable rule.

string
icmpType
Optional

ICMP type. Only supported when protocol is icmp. Default is 'any'.

string
translatedPort
Optional

Translated port. Supported in DNAT rules only.

string
action
Optional

Action for the rule. SNAT or DNAT.

integer As int64 As int64
ruleTag
Optional

Rule tag. Used to specify user-defined ruleId. If not specified NSX Manager will generate ruleId.