vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vcd.getEdgegateway
Explore with Pulumi AI
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
Get
Edgegateway Filter - 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
Get
Edgegateway Filter - 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
Get
Edgegateway Filter - 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
Get
Edgegateway Filter - 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
Get
Edgegateway Filter - 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:
- Configuration string
- Default
External stringNetwork Ip - Description string
- Distributed
Routing bool - External
Network List<string>Ips - External
Networks List<GetEdgegateway External Network> - Fips
Mode boolEnabled - Fw
Default stringRule Action - Fw
Default boolRule Logging Enabled - Fw
Enabled bool - Ha
Enabled bool - Id string
- Lb
Acceleration boolEnabled - Lb
Enabled bool - Lb
Logging boolEnabled - Lb
Loglevel string - Use
Default boolRoute For Dns Relay - Filter
Get
Edgegateway Filter - Name string
- Org string
- Vdc string
- Configuration string
- Default
External stringNetwork Ip - Description string
- Distributed
Routing bool - External
Network []stringIps - External
Networks []GetEdgegateway External Network - Fips
Mode boolEnabled - Fw
Default stringRule Action - Fw
Default boolRule Logging Enabled - Fw
Enabled bool - Ha
Enabled bool - Id string
- Lb
Acceleration boolEnabled - Lb
Enabled bool - Lb
Logging boolEnabled - Lb
Loglevel string - Use
Default boolRoute For Dns Relay - Filter
Get
Edgegateway Filter - Name string
- Org string
- Vdc string
- configuration String
- default
External StringNetwork Ip - description String
- distributed
Routing Boolean - external
Network List<String>Ips - external
Networks List<GetEdgegateway External Network> - fips
Mode BooleanEnabled - fw
Default StringRule Action - fw
Default BooleanRule Logging Enabled - fw
Enabled Boolean - ha
Enabled Boolean - id String
- lb
Acceleration BooleanEnabled - lb
Enabled Boolean - lb
Logging BooleanEnabled - lb
Loglevel String - use
Default BooleanRoute For Dns Relay - filter
Get
Edgegateway Filter - name String
- org String
- vdc String
- configuration string
- default
External stringNetwork Ip - description string
- distributed
Routing boolean - external
Network string[]Ips - external
Networks GetEdgegateway External Network[] - fips
Mode booleanEnabled - fw
Default stringRule Action - fw
Default booleanRule Logging Enabled - fw
Enabled boolean - ha
Enabled boolean - id string
- lb
Acceleration booleanEnabled - lb
Enabled boolean - lb
Logging booleanEnabled - lb
Loglevel string - use
Default booleanRoute For Dns Relay - filter
Get
Edgegateway Filter - name string
- org string
- vdc string
- configuration str
- default_
external_ strnetwork_ ip - description str
- distributed_
routing bool - external_
network_ Sequence[str]ips - external_
networks Sequence[GetEdgegateway External Network] - fips_
mode_ boolenabled - fw_
default_ strrule_ action - fw_
default_ boolrule_ logging_ enabled - fw_
enabled bool - ha_
enabled bool - id str
- lb_
acceleration_ boolenabled - lb_
enabled bool - lb_
logging_ boolenabled - lb_
loglevel str - use_
default_ boolroute_ for_ dns_ relay - filter
Get
Edgegateway Filter - name str
- org str
- vdc str
- configuration String
- default
External StringNetwork Ip - description String
- distributed
Routing Boolean - external
Network List<String>Ips - external
Networks List<Property Map> - fips
Mode BooleanEnabled - fw
Default StringRule Action - fw
Default BooleanRule Logging Enabled - fw
Enabled Boolean - ha
Enabled Boolean - id String
- lb
Acceleration BooleanEnabled - lb
Enabled Boolean - lb
Logging BooleanEnabled - lb
Loglevel String - use
Default BooleanRoute For Dns Relay - filter Property Map
- name String
- org String
- vdc String
Supporting Types
GetEdgegatewayExternalNetwork
- Enable
Rate boolLimit - Incoming
Rate doubleLimit - Name string
- A unique name for the edge gateway (optional when
filter
is used) - Outgoing
Rate doubleLimit - Subnets
List<Get
Edgegateway External Network Subnet>
- Enable
Rate boolLimit - Incoming
Rate float64Limit - Name string
- A unique name for the edge gateway (optional when
filter
is used) - Outgoing
Rate float64Limit - Subnets
[]Get
Edgegateway External Network Subnet
- enable
Rate BooleanLimit - incoming
Rate DoubleLimit - name String
- A unique name for the edge gateway (optional when
filter
is used) - outgoing
Rate DoubleLimit - subnets
List<Get
Edgegateway External Network Subnet>
- enable
Rate booleanLimit - incoming
Rate numberLimit - name string
- A unique name for the edge gateway (optional when
filter
is used) - outgoing
Rate numberLimit - subnets
Get
Edgegateway External Network Subnet[]
- enable_
rate_ boollimit - incoming_
rate_ floatlimit - name str
- A unique name for the edge gateway (optional when
filter
is used) - outgoing_
rate_ floatlimit - subnets
Sequence[Get
Edgegateway External Network Subnet]
- enable
Rate BooleanLimit - incoming
Rate NumberLimit - name String
- A unique name for the edge gateway (optional when
filter
is used) - outgoing
Rate NumberLimit - subnets List<Property Map>
GetEdgegatewayExternalNetworkSubnet
- gateway String
- ip
Address String - netmask String
- suballocate
Pools List<GetEdgegateway External Network Subnet Suballocate Pool> - use
For BooleanDefault Route
- gateway string
- ip
Address string - netmask string
- suballocate
Pools GetEdgegateway External Network Subnet Suballocate Pool[] - use
For booleanDefault Route
- gateway String
- ip
Address String - netmask String
- suballocate
Pools List<Property Map> - use
For BooleanDefault Route
GetEdgegatewayExternalNetworkSubnetSuballocatePool
- End
Address string - Start
Address string
- End
Address string - Start
Address string
- end
Address String - start
Address String
- end
Address string - start
Address string
- end_
address str - start_
address str
- end
Address String - start
Address String
GetEdgegatewayFilter
- Name
Regex string - Search by name with a regular expression
- Name
Regex string - Search by name with a regular expression
- name
Regex String - Search by name with a regular expression
- name
Regex string - Search by name with a regular expression
- name_
regex str - Search by name with a regular expression
- name
Regex 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.