Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. NsxvSnat
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.NsxvSnat

Explore with Pulumi AI

vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

Create NsxvSnat Resource

Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

Constructor syntax

new NsxvSnat(name: string, args: NsxvSnatArgs, opts?: CustomResourceOptions);
@overload
def NsxvSnat(resource_name: str,
             args: NsxvSnatArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def NsxvSnat(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             network_name: Optional[str] = None,
             edge_gateway: Optional[str] = None,
             original_address: Optional[str] = None,
             network_type: Optional[str] = None,
             nsxv_snat_id: Optional[str] = None,
             logging_enabled: Optional[bool] = None,
             description: Optional[str] = None,
             org: Optional[str] = None,
             enabled: Optional[bool] = None,
             rule_tag: Optional[float] = None,
             rule_type: Optional[str] = None,
             translated_address: Optional[str] = None,
             vdc: Optional[str] = None)
func NewNsxvSnat(ctx *Context, name string, args NsxvSnatArgs, opts ...ResourceOption) (*NsxvSnat, error)
public NsxvSnat(string name, NsxvSnatArgs args, CustomResourceOptions? opts = null)
public NsxvSnat(String name, NsxvSnatArgs args)
public NsxvSnat(String name, NsxvSnatArgs args, CustomResourceOptions options)

type: vcd:NsxvSnat
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. NsxvSnatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. NsxvSnatArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name This property is required. string
The unique name of the resource.
args This property is required. NsxvSnatArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. NsxvSnatArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. NsxvSnatArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

Constructor example

The following reference example uses placeholder values for all input properties.

var nsxvSnatResource = new Vcd.NsxvSnat("nsxvSnatResource", new()
{
    NetworkName = "string",
    EdgeGateway = "string",
    OriginalAddress = "string",
    NetworkType = "string",
    NsxvSnatId = "string",
    LoggingEnabled = false,
    Description = "string",
    Org = "string",
    Enabled = false,
    RuleTag = 0,
    RuleType = "string",
    TranslatedAddress = "string",
    Vdc = "string",
});
Copy
example, err := vcd.NewNsxvSnat(ctx, "nsxvSnatResource", &vcd.NsxvSnatArgs{
	NetworkName:       pulumi.String("string"),
	EdgeGateway:       pulumi.String("string"),
	OriginalAddress:   pulumi.String("string"),
	NetworkType:       pulumi.String("string"),
	NsxvSnatId:        pulumi.String("string"),
	LoggingEnabled:    pulumi.Bool(false),
	Description:       pulumi.String("string"),
	Org:               pulumi.String("string"),
	Enabled:           pulumi.Bool(false),
	RuleTag:           pulumi.Float64(0),
	RuleType:          pulumi.String("string"),
	TranslatedAddress: pulumi.String("string"),
	Vdc:               pulumi.String("string"),
})
Copy
var nsxvSnatResource = new NsxvSnat("nsxvSnatResource", NsxvSnatArgs.builder()
    .networkName("string")
    .edgeGateway("string")
    .originalAddress("string")
    .networkType("string")
    .nsxvSnatId("string")
    .loggingEnabled(false)
    .description("string")
    .org("string")
    .enabled(false)
    .ruleTag(0)
    .ruleType("string")
    .translatedAddress("string")
    .vdc("string")
    .build());
Copy
nsxv_snat_resource = vcd.NsxvSnat("nsxvSnatResource",
    network_name="string",
    edge_gateway="string",
    original_address="string",
    network_type="string",
    nsxv_snat_id="string",
    logging_enabled=False,
    description="string",
    org="string",
    enabled=False,
    rule_tag=0,
    rule_type="string",
    translated_address="string",
    vdc="string")
Copy
const nsxvSnatResource = new vcd.NsxvSnat("nsxvSnatResource", {
    networkName: "string",
    edgeGateway: "string",
    originalAddress: "string",
    networkType: "string",
    nsxvSnatId: "string",
    loggingEnabled: false,
    description: "string",
    org: "string",
    enabled: false,
    ruleTag: 0,
    ruleType: "string",
    translatedAddress: "string",
    vdc: "string",
});
Copy
type: vcd:NsxvSnat
properties:
    description: string
    edgeGateway: string
    enabled: false
    loggingEnabled: false
    networkName: string
    networkType: string
    nsxvSnatId: string
    org: string
    originalAddress: string
    ruleTag: 0
    ruleType: string
    translatedAddress: string
    vdc: string
Copy

NsxvSnat Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The NsxvSnat resource accepts the following input properties:

EdgeGateway This property is required. string
The name of the edge gateway on which to apply the SNAT rule.
NetworkName This property is required. string
The name of the network on which to apply the SNAT rule.
NetworkType This property is required. string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
OriginalAddress This property is required. string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
Description string
Free text description.
Enabled bool
Defines if the rule is enabaled. Default true.
LoggingEnabled bool
Defines if the logging for this rule is enabaled. Default false.
NsxvSnatId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
RuleTag double
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
RuleType string
Possible values - user, internal_high.
TranslatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
Vdc string
The name of VDC to use, optional if defined at provider level.
EdgeGateway This property is required. string
The name of the edge gateway on which to apply the SNAT rule.
NetworkName This property is required. string
The name of the network on which to apply the SNAT rule.
NetworkType This property is required. string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
OriginalAddress This property is required. string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
Description string
Free text description.
Enabled bool
Defines if the rule is enabaled. Default true.
LoggingEnabled bool
Defines if the logging for this rule is enabaled. Default false.
NsxvSnatId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
RuleTag float64
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
RuleType string
Possible values - user, internal_high.
TranslatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
Vdc string
The name of VDC to use, optional if defined at provider level.
edgeGateway This property is required. String
The name of the edge gateway on which to apply the SNAT rule.
networkName This property is required. String
The name of the network on which to apply the SNAT rule.
networkType This property is required. String
Type of the network on which to apply the DNAT rule. Possible values org or ext.
originalAddress This property is required. String
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
description String
Free text description.
enabled Boolean
Defines if the rule is enabaled. Default true.
loggingEnabled Boolean
Defines if the logging for this rule is enabaled. Default false.
nsxvSnatId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
ruleTag Double
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType String
Possible values - user, internal_high.
translatedAddress String
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc String
The name of VDC to use, optional if defined at provider level.
edgeGateway This property is required. string
The name of the edge gateway on which to apply the SNAT rule.
networkName This property is required. string
The name of the network on which to apply the SNAT rule.
networkType This property is required. string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
originalAddress This property is required. string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
description string
Free text description.
enabled boolean
Defines if the rule is enabaled. Default true.
loggingEnabled boolean
Defines if the logging for this rule is enabaled. Default false.
nsxvSnatId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
ruleTag number
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType string
Possible values - user, internal_high.
translatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc string
The name of VDC to use, optional if defined at provider level.
edge_gateway This property is required. str
The name of the edge gateway on which to apply the SNAT rule.
network_name This property is required. str
The name of the network on which to apply the SNAT rule.
network_type This property is required. str
Type of the network on which to apply the DNAT rule. Possible values org or ext.
original_address This property is required. str
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
description str
Free text description.
enabled bool
Defines if the rule is enabaled. Default true.
logging_enabled bool
Defines if the logging for this rule is enabaled. Default false.
nsxv_snat_id str
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
rule_tag float
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
rule_type str
Possible values - user, internal_high.
translated_address str
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc str
The name of VDC to use, optional if defined at provider level.
edgeGateway This property is required. String
The name of the edge gateway on which to apply the SNAT rule.
networkName This property is required. String
The name of the network on which to apply the SNAT rule.
networkType This property is required. String
Type of the network on which to apply the DNAT rule. Possible values org or ext.
originalAddress This property is required. String
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
description String
Free text description.
enabled Boolean
Defines if the rule is enabaled. Default true.
loggingEnabled Boolean
Defines if the logging for this rule is enabaled. Default false.
nsxvSnatId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
ruleTag Number
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType String
Possible values - user, internal_high.
translatedAddress String
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc String
The name of VDC to use, optional if defined at provider level.

Outputs

All input properties are implicitly available as output properties. Additionally, the NsxvSnat resource produces the following output properties:

Id string
The provider-assigned unique ID for this managed resource.
Id string
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.
id string
The provider-assigned unique ID for this managed resource.
id str
The provider-assigned unique ID for this managed resource.
id String
The provider-assigned unique ID for this managed resource.

Look up Existing NsxvSnat Resource

Get an existing NsxvSnat resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: NsxvSnatState, opts?: CustomResourceOptions): NsxvSnat
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        description: Optional[str] = None,
        edge_gateway: Optional[str] = None,
        enabled: Optional[bool] = None,
        logging_enabled: Optional[bool] = None,
        network_name: Optional[str] = None,
        network_type: Optional[str] = None,
        nsxv_snat_id: Optional[str] = None,
        org: Optional[str] = None,
        original_address: Optional[str] = None,
        rule_tag: Optional[float] = None,
        rule_type: Optional[str] = None,
        translated_address: Optional[str] = None,
        vdc: Optional[str] = None) -> NsxvSnat
func GetNsxvSnat(ctx *Context, name string, id IDInput, state *NsxvSnatState, opts ...ResourceOption) (*NsxvSnat, error)
public static NsxvSnat Get(string name, Input<string> id, NsxvSnatState? state, CustomResourceOptions? opts = null)
public static NsxvSnat get(String name, Output<String> id, NsxvSnatState state, CustomResourceOptions options)
resources:  _:    type: vcd:NsxvSnat    get:      id: ${id}
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name This property is required.
The unique name of the resulting resource.
id This property is required.
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
Description string
Free text description.
EdgeGateway string
The name of the edge gateway on which to apply the SNAT rule.
Enabled bool
Defines if the rule is enabaled. Default true.
LoggingEnabled bool
Defines if the logging for this rule is enabaled. Default false.
NetworkName string
The name of the network on which to apply the SNAT rule.
NetworkType string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
NsxvSnatId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
OriginalAddress string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
RuleTag double
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
RuleType string
Possible values - user, internal_high.
TranslatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
Vdc string
The name of VDC to use, optional if defined at provider level.
Description string
Free text description.
EdgeGateway string
The name of the edge gateway on which to apply the SNAT rule.
Enabled bool
Defines if the rule is enabaled. Default true.
LoggingEnabled bool
Defines if the logging for this rule is enabaled. Default false.
NetworkName string
The name of the network on which to apply the SNAT rule.
NetworkType string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
NsxvSnatId string
Org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
OriginalAddress string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
RuleTag float64
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
RuleType string
Possible values - user, internal_high.
TranslatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
Vdc string
The name of VDC to use, optional if defined at provider level.
description String
Free text description.
edgeGateway String
The name of the edge gateway on which to apply the SNAT rule.
enabled Boolean
Defines if the rule is enabaled. Default true.
loggingEnabled Boolean
Defines if the logging for this rule is enabaled. Default false.
networkName String
The name of the network on which to apply the SNAT rule.
networkType String
Type of the network on which to apply the DNAT rule. Possible values org or ext.
nsxvSnatId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
originalAddress String
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
ruleTag Double
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType String
Possible values - user, internal_high.
translatedAddress String
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc String
The name of VDC to use, optional if defined at provider level.
description string
Free text description.
edgeGateway string
The name of the edge gateway on which to apply the SNAT rule.
enabled boolean
Defines if the rule is enabaled. Default true.
loggingEnabled boolean
Defines if the logging for this rule is enabaled. Default false.
networkName string
The name of the network on which to apply the SNAT rule.
networkType string
Type of the network on which to apply the DNAT rule. Possible values org or ext.
nsxvSnatId string
org string
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
originalAddress string
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
ruleTag number
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType string
Possible values - user, internal_high.
translatedAddress string
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc string
The name of VDC to use, optional if defined at provider level.
description str
Free text description.
edge_gateway str
The name of the edge gateway on which to apply the SNAT rule.
enabled bool
Defines if the rule is enabaled. Default true.
logging_enabled bool
Defines if the logging for this rule is enabaled. Default false.
network_name str
The name of the network on which to apply the SNAT rule.
network_type str
Type of the network on which to apply the DNAT rule. Possible values org or ext.
nsxv_snat_id str
org str
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
original_address str
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
rule_tag float
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
rule_type str
Possible values - user, internal_high.
translated_address str
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc str
The name of VDC to use, optional if defined at provider level.
description String
Free text description.
edgeGateway String
The name of the edge gateway on which to apply the SNAT rule.
enabled Boolean
Defines if the rule is enabaled. Default true.
loggingEnabled Boolean
Defines if the logging for this rule is enabaled. Default false.
networkName String
The name of the network on which to apply the SNAT rule.
networkType String
Type of the network on which to apply the DNAT rule. Possible values org or ext.
nsxvSnatId String
org String
The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
originalAddress String
IP address, range or subnet. These addresses are the IP addresses of one or more virtual machines for which you are configuring the SNAT rule so that they can send traffic to the external network.
ruleTag Number
This can be used to specify user-controlled rule tag. If not specified, it will report rule ID after creation. Must be between 65537-131072.
ruleType String
Possible values - user, internal_high.
translatedAddress String
IP address, range or subnet. This address is always the public IP address of the gateway for which you are configuring the SNAT rule. Specifies the IP address to which source addresses (the virtual machines) on outbound packets are translated to when they send traffic to the external network.
vdc String
The name of VDC to use, optional if defined at provider level.

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd