vcd.getExternalNetwork

Explore with Pulumi AI

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

Using getExternalNetwork

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 getExternalNetwork(args: GetExternalNetworkArgs, opts?: InvokeOptions): Promise<GetExternalNetworkResult>
function getExternalNetworkOutput(args: GetExternalNetworkOutputArgs, opts?: InvokeOptions): Output<GetExternalNetworkResult>

def get_external_network(id: Optional[str] = None,
                         name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetExternalNetworkResult
def get_external_network_output(id: Optional[pulumi.Input[str]] = None,
                         name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetExternalNetworkResult]

func LookupExternalNetwork(ctx *Context, args *LookupExternalNetworkArgs, opts ...InvokeOption) (*LookupExternalNetworkResult, error)
func LookupExternalNetworkOutput(ctx *Context, args *LookupExternalNetworkOutputArgs, opts ...InvokeOption) LookupExternalNetworkResultOutput

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

public static class GetExternalNetwork 
{
    public static Task<GetExternalNetworkResult> InvokeAsync(GetExternalNetworkArgs args, InvokeOptions? opts = null)
    public static Output<GetExternalNetworkResult> Invoke(GetExternalNetworkInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetExternalNetworkResult> getExternalNetwork(GetExternalNetworkArgs args, InvokeOptions options)
public static Output<GetExternalNetworkResult> getExternalNetwork(GetExternalNetworkArgs args, InvokeOptions options)

fn::invoke:
  function: vcd:index/getExternalNetwork:getExternalNetwork
  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

getExternalNetwork Result

The following output properties are available:

Description string: Network friendly description
Id string
IpScopes List<GetExternalNetworkIpScope>: A list of IP scopes for the network. See IP Scope for details.
Name string
RetainNetInfoAcrossDeployments bool: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
VsphereNetworks List<GetExternalNetworkVsphereNetwork>: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.

Description string: Network friendly description
Id string
IpScopes []GetExternalNetworkIpScope: A list of IP scopes for the network. See IP Scope for details.
Name string
RetainNetInfoAcrossDeployments bool: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
VsphereNetworks []GetExternalNetworkVsphereNetwork: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.

description String: Network friendly description
id String
ipScopes List<GetExternalNetworkIpScope>: A list of IP scopes for the network. See IP Scope for details.
name String
retainNetInfoAcrossDeployments Boolean: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
vsphereNetworks List<GetExternalNetworkVsphereNetwork>: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.

description string: Network friendly description
id string
ipScopes GetExternalNetworkIpScope[]: A list of IP scopes for the network. See IP Scope for details.
name string
retainNetInfoAcrossDeployments boolean: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
vsphereNetworks GetExternalNetworkVsphereNetwork[]: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.

description str: Network friendly description
id str
ip_scopes Sequence[GetExternalNetworkIpScope]: A list of IP scopes for the network. See IP Scope for details.
name str
retain_net_info_across_deployments bool: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
vsphere_networks Sequence[GetExternalNetworkVsphereNetwork]: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.

description String: Network friendly description
id String
ipScopes List<Property Map>: A list of IP scopes for the network. See IP Scope for details.
name String
retainNetInfoAcrossDeployments Boolean: Specifies whether the network resources such as IP/MAC of router will be retained across deployments.
vsphereNetworks List<Property Map>: A list of DV_PORTGROUP or NETWORK objects names that back this network. Each referenced DV_PORTGROUP or NETWORK must exist on a vCenter server registered with the system. See vSphere Network for details.