Developer Documentation

Nsxnatrule

NAT rule


Properties

Required Property Name Type Description
optional action string

Action for the rule. SNAT or DNAT.

optional description string

Description for the rule.

optional dnatMatchSourceAddress string

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

optional dnatMatchSourcePort string

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

optional enabled boolean

Enable rule.

optional icmpType string

ICMP type. Only supported when protocol is icmp. Default is ‘any’.

optional loggingEnabled boolean

Enable logging for the rule.

optional originalAddress string

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

optional originalPort string

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

optional protocol string

Protocol. Default is ‘any’

optional ruleId integer

Identifier for the rule.

optional ruleTag integer

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

optional ruleType string

Identifies the type of the rule. internal_high or user.

optional snatMatchDestinationAddress string

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

optional snatMatchDestinationPort string

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

optional translatedAddress string

Translated address or address range.

optional translatedPort string

Translated port. Supported in DNAT rules only.

optional vnic string

Interface on which the NAT rule is applied.

Property of


natRules

Parameter To


Update Edge NAT Rule
Feedback

Was this page helpful?