1. Packages
  2. Vcd Provider
  3. API Docs
  4. getExternalNetworkV2
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

vcd.getExternalNetworkV2

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware

    Provides a VMware Cloud Director External Network data source (version 2). New version of this data source uses new VCD API and is capable of handling NSX-T backed external networks as well as port group backed ones.

    Note: This resource uses new VMware Cloud Director OpenAPI and requires at least VCD 10.0+. It supports both NSX-T and NSX-V backed networks (NSX-T 3.0+ requires VCD 10.1.1+)

    Supported in provider v3.0+.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as vcd from "@pulumi/vcd";
    
    const extNet = vcd.getExternalNetworkV2({
        name: "my-nsxt-net",
    });
    
    import pulumi
    import pulumi_vcd as vcd
    
    ext_net = vcd.get_external_network_v2(name="my-nsxt-net")
    
    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.LookupExternalNetworkV2(ctx, &vcd.LookupExternalNetworkV2Args{
    			Name: "my-nsxt-net",
    		}, 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 extNet = Vcd.GetExternalNetworkV2.Invoke(new()
        {
            Name = "my-nsxt-net",
        });
    
    });
    
    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.GetExternalNetworkV2Args;
    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 extNet = VcdFunctions.getExternalNetworkV2(GetExternalNetworkV2Args.builder()
                .name("my-nsxt-net")
                .build());
    
        }
    }
    
    variables:
      extNet:
        fn::invoke:
          function: vcd:getExternalNetworkV2
          arguments:
            name: my-nsxt-net
    

    Using getExternalNetworkV2

    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 getExternalNetworkV2(args: GetExternalNetworkV2Args, opts?: InvokeOptions): Promise<GetExternalNetworkV2Result>
    function getExternalNetworkV2Output(args: GetExternalNetworkV2OutputArgs, opts?: InvokeOptions): Output<GetExternalNetworkV2Result>
    def get_external_network_v2(id: Optional[str] = None,
                                name: Optional[str] = None,
                                opts: Optional[InvokeOptions] = None) -> GetExternalNetworkV2Result
    def get_external_network_v2_output(id: Optional[pulumi.Input[str]] = None,
                                name: Optional[pulumi.Input[str]] = None,
                                opts: Optional[InvokeOptions] = None) -> Output[GetExternalNetworkV2Result]
    func LookupExternalNetworkV2(ctx *Context, args *LookupExternalNetworkV2Args, opts ...InvokeOption) (*LookupExternalNetworkV2Result, error)
    func LookupExternalNetworkV2Output(ctx *Context, args *LookupExternalNetworkV2OutputArgs, opts ...InvokeOption) LookupExternalNetworkV2ResultOutput

    > Note: This function is named LookupExternalNetworkV2 in the Go SDK.

    public static class GetExternalNetworkV2 
    {
        public static Task<GetExternalNetworkV2Result> InvokeAsync(GetExternalNetworkV2Args args, InvokeOptions? opts = null)
        public static Output<GetExternalNetworkV2Result> Invoke(GetExternalNetworkV2InvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetExternalNetworkV2Result> getExternalNetworkV2(GetExternalNetworkV2Args args, InvokeOptions options)
    public static Output<GetExternalNetworkV2Result> getExternalNetworkV2(GetExternalNetworkV2Args args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getExternalNetworkV2:getExternalNetworkV2
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    external network name
    Id string
    Name string
    external network name
    Id string
    name String
    external network name
    id String
    name string
    external network name
    id string
    name str
    external network name
    id str
    name String
    external network name
    id String

    getExternalNetworkV2 Result

    The following output properties are available:

    Supporting Types

    GetExternalNetworkV2IpScope

    GetExternalNetworkV2IpScopeStaticIpPool

    GetExternalNetworkV2NsxtNetwork

    GetExternalNetworkV2VsphereNetwork

    PortgroupId string
    VcenterId string
    PortgroupId string
    VcenterId string
    portgroupId String
    vcenterId String
    portgroupId string
    vcenterId string
    portgroupId String
    vcenterId String

    Package Details

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