vcd.getNsxtEdgegateway

Explore with Pulumi AI

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

Example Usage

NSX-T Edge Gateway Belonging To VDC Group)

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const group1 = vcd.getVdcGroup({
    name: "existing-group",
});
const t1 = group1.then(group1 => vcd.getNsxtEdgegateway({
    org: "myorg",
    ownerId: group1.id,
    name: "nsxt-edge-gateway",
}));

import pulumi
import pulumi_vcd as vcd

group1 = vcd.get_vdc_group(name="existing-group")
t1 = vcd.get_nsxt_edgegateway(org="myorg",
    owner_id=group1.id,
    name="nsxt-edge-gateway")

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 {
		group1, err := vcd.LookupVdcGroup(ctx, &vcd.LookupVdcGroupArgs{
			Name: pulumi.StringRef("existing-group"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.LookupNsxtEdgegateway(ctx, &vcd.LookupNsxtEdgegatewayArgs{
			Org:     pulumi.StringRef("myorg"),
			OwnerId: pulumi.StringRef(group1.Id),
			Name:    "nsxt-edge-gateway",
		}, 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 group1 = Vcd.GetVdcGroup.Invoke(new()
    {
        Name = "existing-group",
    });

    var t1 = Vcd.GetNsxtEdgegateway.Invoke(new()
    {
        Org = "myorg",
        OwnerId = group1.Apply(getVdcGroupResult => getVdcGroupResult.Id),
        Name = "nsxt-edge-gateway",
    });

});

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.GetVdcGroupArgs;
import com.pulumi.vcd.inputs.GetNsxtEdgegatewayArgs;
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 group1 = VcdFunctions.getVdcGroup(GetVdcGroupArgs.builder()
            .name("existing-group")
            .build());

        final var t1 = VcdFunctions.getNsxtEdgegateway(GetNsxtEdgegatewayArgs.builder()
            .org("myorg")
            .ownerId(group1.applyValue(getVdcGroupResult -> getVdcGroupResult.id()))
            .name("nsxt-edge-gateway")
            .build());

    }
}

variables:
  group1:
    fn::invoke:
      function: vcd:getVdcGroup
      arguments:
        name: existing-group
  t1:
    fn::invoke:
      function: vcd:getNsxtEdgegateway
      arguments:
        org: myorg
        ownerId: ${group1.id}
        name: nsxt-edge-gateway

NSX-T Edge Gateway Belonging To VDC)

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const vdc1 = vcd.getOrgVdc({
    name: "existing-vdc",
});
const t1 = vdc1.then(vdc1 => vcd.getNsxtEdgegateway({
    org: "myorg",
    ownerId: vdc1.id,
    name: "nsxt-edge-gateway",
}));

import pulumi
import pulumi_vcd as vcd

vdc1 = vcd.get_org_vdc(name="existing-vdc")
t1 = vcd.get_nsxt_edgegateway(org="myorg",
    owner_id=vdc1.id,
    name="nsxt-edge-gateway")

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 {
		vdc1, err := vcd.LookupOrgVdc(ctx, &vcd.LookupOrgVdcArgs{
			Name: "existing-vdc",
		}, nil)
		if err != nil {
			return err
		}
		_, err = vcd.LookupNsxtEdgegateway(ctx, &vcd.LookupNsxtEdgegatewayArgs{
			Org:     pulumi.StringRef("myorg"),
			OwnerId: pulumi.StringRef(vdc1.Id),
			Name:    "nsxt-edge-gateway",
		}, 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 vdc1 = Vcd.GetOrgVdc.Invoke(new()
    {
        Name = "existing-vdc",
    });

    var t1 = Vcd.GetNsxtEdgegateway.Invoke(new()
    {
        Org = "myorg",
        OwnerId = vdc1.Apply(getOrgVdcResult => getOrgVdcResult.Id),
        Name = "nsxt-edge-gateway",
    });

});

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.GetOrgVdcArgs;
import com.pulumi.vcd.inputs.GetNsxtEdgegatewayArgs;
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 vdc1 = VcdFunctions.getOrgVdc(GetOrgVdcArgs.builder()
            .name("existing-vdc")
            .build());

        final var t1 = VcdFunctions.getNsxtEdgegateway(GetNsxtEdgegatewayArgs.builder()
            .org("myorg")
            .ownerId(vdc1.applyValue(getOrgVdcResult -> getOrgVdcResult.id()))
            .name("nsxt-edge-gateway")
            .build());

    }
}

variables:
  vdc1:
    fn::invoke:
      function: vcd:getOrgVdc
      arguments:
        name: existing-vdc
  t1:
    fn::invoke:
      function: vcd:getNsxtEdgegateway
      arguments:
        org: myorg
        ownerId: ${vdc1.id}
        name: nsxt-edge-gateway

Using getNsxtEdgegateway

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.

TypeScript
Python
Go
C#
Java
YAML

function getNsxtEdgegateway(args: GetNsxtEdgegatewayArgs, opts?: InvokeOptions): Promise<GetNsxtEdgegatewayResult>
function getNsxtEdgegatewayOutput(args: GetNsxtEdgegatewayOutputArgs, opts?: InvokeOptions): Output<GetNsxtEdgegatewayResult>

def get_nsxt_edgegateway(edge_cluster_id: Optional[str] = None,
                         id: Optional[str] = None,
                         ip_count_read_limit: Optional[float] = None,
                         name: Optional[str] = None,
                         org: Optional[str] = None,
                         owner_id: Optional[str] = None,
                         vdc: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetNsxtEdgegatewayResult
def get_nsxt_edgegateway_output(edge_cluster_id: Optional[pulumi.Input[str]] = None,
                         id: Optional[pulumi.Input[str]] = None,
                         ip_count_read_limit: Optional[pulumi.Input[float]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         org: Optional[pulumi.Input[str]] = None,
                         owner_id: Optional[pulumi.Input[str]] = None,
                         vdc: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetNsxtEdgegatewayResult]

func LookupNsxtEdgegateway(ctx *Context, args *LookupNsxtEdgegatewayArgs, opts ...InvokeOption) (*LookupNsxtEdgegatewayResult, error)
func LookupNsxtEdgegatewayOutput(ctx *Context, args *LookupNsxtEdgegatewayOutputArgs, opts ...InvokeOption) LookupNsxtEdgegatewayResultOutput

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

public static class GetNsxtEdgegateway 
{
    public static Task<GetNsxtEdgegatewayResult> InvokeAsync(GetNsxtEdgegatewayArgs args, InvokeOptions? opts = null)
    public static Output<GetNsxtEdgegatewayResult> Invoke(GetNsxtEdgegatewayInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNsxtEdgegatewayResult> getNsxtEdgegateway(GetNsxtEdgegatewayArgs args, InvokeOptions options)
public static Output<GetNsxtEdgegatewayResult> getNsxtEdgegateway(GetNsxtEdgegatewayArgs args, InvokeOptions options)

fn::invoke:
  function: vcd:index/getNsxtEdgegateway:getNsxtEdgegateway
  arguments:
    # arguments dictionary

The following arguments are supported:

Name string: NSX-T Edge Gateway name.
EdgeClusterId string
Id string
IpCountReadLimit double: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
Org string: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
OwnerId string: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
Vdc string: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated

Name string: NSX-T Edge Gateway name.
EdgeClusterId string
Id string
IpCountReadLimit float64: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
Org string: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
OwnerId string: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
Vdc string: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated

name String: NSX-T Edge Gateway name.
edgeClusterId String
id String
ipCountReadLimit Double: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
org String: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
ownerId String: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
vdc String: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated

name string: NSX-T Edge Gateway name.
edgeClusterId string
id string
ipCountReadLimit number: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
org string: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
ownerId string: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
vdc string: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated

name str: NSX-T Edge Gateway name.
edge_cluster_id str
id str
ip_count_read_limit float: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
org str: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
owner_id str: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
vdc str: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated

name String: NSX-T Edge Gateway name.
edgeClusterId String
id String
ipCountReadLimit Number: Sets a limit of IPs to count for used_ip_count and unused_ip_count attributes to avoid exhausting compute resource while counting IPs in large IPv6 subnets. It does not affect operation of Edge Gateway configuration, only IP count reporting. Defaults to 1000000. While it is unlikely that a single Edge Gateway can effectively manage more IPs, one can specify 0 for unlimited value.
org String: The name of organization to which the NSX-T Edge Gateway belongs. Optional if defined at provider level.
ownerId String: The ID of VDC or VDC Group. Note: Data sources vcd.VdcGroup or vcd.OrgVdc can be used to lookup IDs by name.
Only one of vdc or owner_id can be specified. owner_id takes precedence over vdc definition at provider level.
vdc String: Deprecated - please use owner_id field. The name of VDC that owns the NSX-T Edge Gateway. Optional if defined at provider level.
Deprecated: Deprecated