vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vcd.getNsxvSnat
Explore with Pulumi AI
Provides a VMware Cloud Director SNAT data source for advanced edge gateways (NSX-V). This can be used to read existing rule by ID and use its attributes in other resources.
Note: This data source requires advanced edge gateway.
Example Usage
import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";
const my_rule = vcd.getNsxvSnat({
edgeGateway: "my-edge-gw",
org: "my-org",
ruleId: "197867",
vdc: "my-org-vdc",
});
import pulumi
import pulumi_vcd as vcd
my_rule = vcd.get_nsxv_snat(edge_gateway="my-edge-gw",
org="my-org",
rule_id="197867",
vdc="my-org-vdc")
package main
import (
"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := vcd.LookupNsxvSnat(ctx, &vcd.LookupNsxvSnatArgs{
EdgeGateway: "my-edge-gw",
Org: pulumi.StringRef("my-org"),
RuleId: "197867",
Vdc: pulumi.StringRef("my-org-vdc"),
}, nil)
if err != nil {
return err
}
return nil
})
}
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;
return await Deployment.RunAsync(() =>
{
var my_rule = Vcd.GetNsxvSnat.Invoke(new()
{
EdgeGateway = "my-edge-gw",
Org = "my-org",
RuleId = "197867",
Vdc = "my-org-vdc",
});
});
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetNsxvSnatArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
final var my-rule = VcdFunctions.getNsxvSnat(GetNsxvSnatArgs.builder()
.edgeGateway("my-edge-gw")
.org("my-org")
.ruleId("197867")
.vdc("my-org-vdc")
.build());
}
}
variables:
my-rule:
fn::invoke:
function: vcd:getNsxvSnat
arguments:
edgeGateway: my-edge-gw
org: my-org
ruleId: '197867'
vdc: my-org-vdc
Using getNsxvSnat
Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.
function getNsxvSnat(args: GetNsxvSnatArgs, opts?: InvokeOptions): Promise<GetNsxvSnatResult>
function getNsxvSnatOutput(args: GetNsxvSnatOutputArgs, opts?: InvokeOptions): Output<GetNsxvSnatResult>
def get_nsxv_snat(edge_gateway: Optional[str] = None,
id: Optional[str] = None,
org: Optional[str] = None,
rule_id: Optional[str] = None,
vdc: Optional[str] = None,
opts: Optional[InvokeOptions] = None) -> GetNsxvSnatResult
def get_nsxv_snat_output(edge_gateway: Optional[pulumi.Input[str]] = None,
id: Optional[pulumi.Input[str]] = None,
org: Optional[pulumi.Input[str]] = None,
rule_id: Optional[pulumi.Input[str]] = None,
vdc: Optional[pulumi.Input[str]] = None,
opts: Optional[InvokeOptions] = None) -> Output[GetNsxvSnatResult]
func LookupNsxvSnat(ctx *Context, args *LookupNsxvSnatArgs, opts ...InvokeOption) (*LookupNsxvSnatResult, error)
func LookupNsxvSnatOutput(ctx *Context, args *LookupNsxvSnatOutputArgs, opts ...InvokeOption) LookupNsxvSnatResultOutput
> Note: This function is named LookupNsxvSnat
in the Go SDK.
public static class GetNsxvSnat
{
public static Task<GetNsxvSnatResult> InvokeAsync(GetNsxvSnatArgs args, InvokeOptions? opts = null)
public static Output<GetNsxvSnatResult> Invoke(GetNsxvSnatInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetNsxvSnatResult> getNsxvSnat(GetNsxvSnatArgs args, InvokeOptions options)
public static Output<GetNsxvSnatResult> getNsxvSnat(GetNsxvSnatArgs args, InvokeOptions options)
fn::invoke:
function: vcd:index/getNsxvSnat:getNsxvSnat
arguments:
# arguments dictionary
The following arguments are supported:
- Edge
Gateway string - The name of the edge gateway on which to apply the SNAT rule.
- Rule
Id string - ID of SNAT rule as shown in the UI.
- Id string
- Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
- Vdc string
- The name of VDC to use, optional if defined at provider level.
- Edge
Gateway string - The name of the edge gateway on which to apply the SNAT rule.
- Rule
Id string - ID of SNAT rule as shown in the UI.
- Id string
- Org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
- Vdc string
- The name of VDC to use, optional if defined at provider level.
- edge
Gateway String - The name of the edge gateway on which to apply the SNAT rule.
- rule
Id String - ID of SNAT rule as shown in the UI.
- id String
- org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
- vdc String
- The name of VDC to use, optional if defined at provider level.
- edge
Gateway string - The name of the edge gateway on which to apply the SNAT rule.
- rule
Id string - ID of SNAT rule as shown in the UI.
- id string
- org string
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
- vdc string
- The name of VDC to use, optional if defined at provider level.
- edge_
gateway str - The name of the edge gateway on which to apply the SNAT rule.
- rule_
id str - ID of SNAT rule as shown in the UI.
- 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.
- vdc str
- The name of VDC to use, optional if defined at provider level.
- edge
Gateway String - The name of the edge gateway on which to apply the SNAT rule.
- rule
Id String - ID of SNAT rule as shown in the UI.
- id String
- org String
- The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organisations.
- vdc String
- The name of VDC to use, optional if defined at provider level.
getNsxvSnat Result
The following output properties are available:
- Description string
- Edge
Gateway string - Enabled bool
- Id string
- Logging
Enabled bool - Network
Name string - Network
Type string - Original
Address string - Rule
Id string - Rule
Tag double - Rule
Type string - Translated
Address string - Org string
- Vdc string
- Description string
- Edge
Gateway string - Enabled bool
- Id string
- Logging
Enabled bool - Network
Name string - Network
Type string - Original
Address string - Rule
Id string - Rule
Tag float64 - Rule
Type string - Translated
Address string - Org string
- Vdc string
- description String
- edge
Gateway String - enabled Boolean
- id String
- logging
Enabled Boolean - network
Name String - network
Type String - original
Address String - rule
Id String - rule
Tag Double - rule
Type String - translated
Address String - org String
- vdc String
- description string
- edge
Gateway string - enabled boolean
- id string
- logging
Enabled boolean - network
Name string - network
Type string - original
Address string - rule
Id string - rule
Tag number - rule
Type string - translated
Address string - org string
- vdc string
- description str
- edge_
gateway str - enabled bool
- id str
- logging_
enabled bool - network_
name str - network_
type str - original_
address str - rule_
id str - rule_
tag float - rule_
type str - translated_
address str - org str
- vdc str
- description String
- edge
Gateway String - enabled Boolean
- id String
- logging
Enabled Boolean - network
Name String - network
Type String - original
Address String - rule
Id String - rule
Tag Number - rule
Type String - translated
Address String - org String
- vdc String
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.