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

vcd.getEdgegateway

Explore with Pulumi AI

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

    Provides a VMware Cloud Director NSX-V edge gateway data source, directly connected to one or more external networks. This can be used to reference edge gateways for Org VDC networks to connect.

    Supported in provider v2.5+

    Using getEdgegateway

    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 getEdgegateway(args: GetEdgegatewayArgs, opts?: InvokeOptions): Promise<GetEdgegatewayResult>
    function getEdgegatewayOutput(args: GetEdgegatewayOutputArgs, opts?: InvokeOptions): Output<GetEdgegatewayResult>
    def get_edgegateway(filter: Optional[GetEdgegatewayFilter] = None,
                        id: Optional[str] = None,
                        name: Optional[str] = None,
                        org: Optional[str] = None,
                        vdc: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetEdgegatewayResult
    def get_edgegateway_output(filter: Optional[pulumi.Input[GetEdgegatewayFilterArgs]] = None,
                        id: Optional[pulumi.Input[str]] = None,
                        name: Optional[pulumi.Input[str]] = None,
                        org: Optional[pulumi.Input[str]] = None,
                        vdc: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetEdgegatewayResult]
    func LookupEdgegateway(ctx *Context, args *LookupEdgegatewayArgs, opts ...InvokeOption) (*LookupEdgegatewayResult, error)
    func LookupEdgegatewayOutput(ctx *Context, args *LookupEdgegatewayOutputArgs, opts ...InvokeOption) LookupEdgegatewayResultOutput

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

    public static class GetEdgegateway 
    {
        public static Task<GetEdgegatewayResult> InvokeAsync(GetEdgegatewayArgs args, InvokeOptions? opts = null)
        public static Output<GetEdgegatewayResult> Invoke(GetEdgegatewayInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetEdgegatewayResult> getEdgegateway(GetEdgegatewayArgs args, InvokeOptions options)
    public static Output<GetEdgegatewayResult> getEdgegateway(GetEdgegatewayArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getEdgegateway:getEdgegateway
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filter GetEdgegatewayFilter
    Retrieves the data source using one or more filter parameters
    Id string
    Name string
    A unique name for the edge gateway (optional when filter is used)
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    Vdc string
    The name of VDC that owns the edge gateway. Optional if defined at provider level.
    Filter GetEdgegatewayFilter
    Retrieves the data source using one or more filter parameters
    Id string
    Name string
    A unique name for the edge gateway (optional when filter is used)
    Org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    Vdc string
    The name of VDC that owns the edge gateway. Optional if defined at provider level.
    filter GetEdgegatewayFilter
    Retrieves the data source using one or more filter parameters
    id String
    name String
    A unique name for the edge gateway (optional when filter is used)
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    vdc String
    The name of VDC that owns the edge gateway. Optional if defined at provider level.
    filter GetEdgegatewayFilter
    Retrieves the data source using one or more filter parameters
    id string
    name string
    A unique name for the edge gateway (optional when filter is used)
    org string
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    vdc string
    The name of VDC that owns the edge gateway. Optional if defined at provider level.
    filter GetEdgegatewayFilter
    Retrieves the data source using one or more filter parameters
    id str
    name str
    A unique name for the edge gateway (optional when filter is used)
    org str
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    vdc str
    The name of VDC that owns the edge gateway. Optional if defined at provider level.
    filter Property Map
    Retrieves the data source using one or more filter parameters
    id String
    name String
    A unique name for the edge gateway (optional when filter is used)
    org String
    The name of organization to which the VDC belongs. Optional if defined at provider level.
    vdc String
    The name of VDC that owns the edge gateway. Optional if defined at provider level.

    getEdgegateway Result

    The following output properties are available:

    Supporting Types

    GetEdgegatewayExternalNetwork

    EnableRateLimit bool
    IncomingRateLimit double
    Name string
    A unique name for the edge gateway (optional when filter is used)
    OutgoingRateLimit double
    Subnets List<GetEdgegatewayExternalNetworkSubnet>
    EnableRateLimit bool
    IncomingRateLimit float64
    Name string
    A unique name for the edge gateway (optional when filter is used)
    OutgoingRateLimit float64
    Subnets []GetEdgegatewayExternalNetworkSubnet
    enableRateLimit Boolean
    incomingRateLimit Double
    name String
    A unique name for the edge gateway (optional when filter is used)
    outgoingRateLimit Double
    subnets List<GetEdgegatewayExternalNetworkSubnet>
    enableRateLimit boolean
    incomingRateLimit number
    name string
    A unique name for the edge gateway (optional when filter is used)
    outgoingRateLimit number
    subnets GetEdgegatewayExternalNetworkSubnet[]
    enable_rate_limit bool
    incoming_rate_limit float
    name str
    A unique name for the edge gateway (optional when filter is used)
    outgoing_rate_limit float
    subnets Sequence[GetEdgegatewayExternalNetworkSubnet]
    enableRateLimit Boolean
    incomingRateLimit Number
    name String
    A unique name for the edge gateway (optional when filter is used)
    outgoingRateLimit Number
    subnets List<Property Map>

    GetEdgegatewayExternalNetworkSubnet

    GetEdgegatewayExternalNetworkSubnetSuballocatePool

    GetEdgegatewayFilter

    NameRegex string
    Search by name with a regular expression
    NameRegex string
    Search by name with a regular expression
    nameRegex String
    Search by name with a regular expression
    nameRegex string
    Search by name with a regular expression
    name_regex str
    Search by name with a regular expression
    nameRegex String
    Search by name with a regular expression

    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