vcd.getNetworkRouted

Explore with Pulumi AI

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

Using getNetworkRouted

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 getNetworkRouted(args: GetNetworkRoutedArgs, opts?: InvokeOptions): Promise<GetNetworkRoutedResult>
function getNetworkRoutedOutput(args: GetNetworkRoutedOutputArgs, opts?: InvokeOptions): Output<GetNetworkRoutedResult>

def get_network_routed(filter: Optional[GetNetworkRoutedFilter] = None,
                       id: Optional[str] = None,
                       name: Optional[str] = None,
                       org: Optional[str] = None,
                       vdc: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetNetworkRoutedResult
def get_network_routed_output(filter: Optional[pulumi.Input[GetNetworkRoutedFilterArgs]] = 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[GetNetworkRoutedResult]

func LookupNetworkRouted(ctx *Context, args *LookupNetworkRoutedArgs, opts ...InvokeOption) (*LookupNetworkRoutedResult, error)
func LookupNetworkRoutedOutput(ctx *Context, args *LookupNetworkRoutedOutputArgs, opts ...InvokeOption) LookupNetworkRoutedResultOutput

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

public static class GetNetworkRouted 
{
    public static Task<GetNetworkRoutedResult> InvokeAsync(GetNetworkRoutedArgs args, InvokeOptions? opts = null)
    public static Output<GetNetworkRoutedResult> Invoke(GetNetworkRoutedInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetNetworkRoutedResult> getNetworkRouted(GetNetworkRoutedArgs args, InvokeOptions options)
public static Output<GetNetworkRoutedResult> getNetworkRouted(GetNetworkRoutedArgs args, InvokeOptions options)

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

The following arguments are supported:

Filter GetNetworkRoutedFilter: Retrieves the data source using one or more filter parameters
Id string
Name string: A unique name for the network (optional when filter is used)
Org string: The name of organization to use, optional if defined at provider level
Vdc string: The name of VDC to use, optional if defined at provider level

Filter GetNetworkRoutedFilter: Retrieves the data source using one or more filter parameters
Id string
Name string: A unique name for the network (optional when filter is used)
Org string: The name of organization to use, optional if defined at provider level
Vdc string: The name of VDC to use, optional if defined at provider level

filter GetNetworkRoutedFilter: Retrieves the data source using one or more filter parameters
id String
name String: A unique name for the network (optional when filter is used)
org String: The name of organization to use, optional if defined at provider level
vdc String: The name of VDC to use, optional if defined at provider level

filter GetNetworkRoutedFilter: Retrieves the data source using one or more filter parameters
id string
name string: A unique name for the network (optional when filter is used)
org string: The name of organization to use, optional if defined at provider level
vdc string: The name of VDC to use, optional if defined at provider level

filter GetNetworkRoutedFilter: Retrieves the data source using one or more filter parameters
id str
name str: A unique name for the network (optional when filter is used)
org str: The name of organization to use, optional if defined at provider level
vdc str: The name of VDC to use, 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 network (optional when filter is used)
org String: The name of organization to use, optional if defined at provider level
vdc String: The name of VDC to use, optional if defined at provider level

getNetworkRouted Result

The following output properties are available:

Description string
DhcpPools List<GetNetworkRoutedDhcpPool>
Dns1 string
Dns2 string
DnsSuffix string
EdgeGateway string
Gateway string
Href string
Id string
InterfaceType string
Metadata Dictionary<string, string>: Deprecated: Deprecated
MetadataEntries List<GetNetworkRoutedMetadataEntry>
Netmask string
Shared bool
StaticIpPools List<GetNetworkRoutedStaticIpPool>
Filter GetNetworkRoutedFilter
Name string
Org string
Vdc string

Description string
DhcpPools []GetNetworkRoutedDhcpPool
Dns1 string
Dns2 string
DnsSuffix string
EdgeGateway string
Gateway string
Href string
Id string
InterfaceType string
Metadata map[string]string: Deprecated: Deprecated
MetadataEntries []GetNetworkRoutedMetadataEntry
Netmask string
Shared bool
StaticIpPools []GetNetworkRoutedStaticIpPool
Filter GetNetworkRoutedFilter
Name string
Org string
Vdc string

description String
dhcpPools List<GetNetworkRoutedDhcpPool>
dns1 String
dns2 String
dnsSuffix String
edgeGateway String
gateway String
href String
id String
interfaceType String
metadata Map<String,String>: Deprecated: Deprecated
metadataEntries List<GetNetworkRoutedMetadataEntry>
netmask String
shared Boolean
staticIpPools List<GetNetworkRoutedStaticIpPool>
filter GetNetworkRoutedFilter
name String
org String
vdc String

description string
dhcpPools GetNetworkRoutedDhcpPool[]
dns1 string
dns2 string
dnsSuffix string
edgeGateway string
gateway string
href string
id string
interfaceType string
metadata {[key: string]: string}: Deprecated: Deprecated
metadataEntries GetNetworkRoutedMetadataEntry[]
netmask string
shared boolean
staticIpPools GetNetworkRoutedStaticIpPool[]
filter GetNetworkRoutedFilter
name string
org string
vdc string

description str
dhcp_pools Sequence[GetNetworkRoutedDhcpPool]
dns1 str
dns2 str
dns_suffix str
edge_gateway str
gateway str
href str
id str
interface_type str
metadata Mapping[str, str]: Deprecated: Deprecated
metadata_entries Sequence[GetNetworkRoutedMetadataEntry]
netmask str
shared bool
static_ip_pools Sequence[GetNetworkRoutedStaticIpPool]
filter GetNetworkRoutedFilter
name str
org str
vdc str

description String
dhcpPools List<Property Map>
dns1 String
dns2 String
dnsSuffix String
edgeGateway String
gateway String
href String
id String
interfaceType String
metadata Map<String>: Deprecated: Deprecated
metadataEntries List<Property Map>
netmask String
shared Boolean
staticIpPools List<Property Map>
filter Property Map
name String
org String
vdc String

Supporting Types

GetNetworkRoutedDhcpPool

DefaultLeaseTime double
EndAddress string
MaxLeaseTime double
StartAddress string

DefaultLeaseTime float64
EndAddress string
MaxLeaseTime float64
StartAddress string

defaultLeaseTime Double
endAddress String
maxLeaseTime Double
startAddress String

defaultLeaseTime number
endAddress string
maxLeaseTime number
startAddress string

default_lease_time float
end_address str
max_lease_time float
start_address str

defaultLeaseTime Number
endAddress String
maxLeaseTime Number
startAddress String

GetNetworkRoutedFilter

Ip string: Search by IP. The value can be a regular expression
Metadatas List<GetNetworkRoutedFilterMetadata>: metadata filter
NameRegex string: Search by name with a regular expression

Ip string: Search by IP. The value can be a regular expression
Metadatas []GetNetworkRoutedFilterMetadata: metadata filter
NameRegex string: Search by name with a regular expression

ip String: Search by IP. The value can be a regular expression
metadatas List<GetNetworkRoutedFilterMetadata>: metadata filter
nameRegex String: Search by name with a regular expression

ip string: Search by IP. The value can be a regular expression
metadatas GetNetworkRoutedFilterMetadata[]: metadata filter
nameRegex string: Search by name with a regular expression

ip str: Search by IP. The value can be a regular expression
metadatas Sequence[GetNetworkRoutedFilterMetadata]: metadata filter
name_regex str: Search by name with a regular expression

ip String: Search by IP. The value can be a regular expression
metadatas List<Property Map>: metadata filter
nameRegex String: Search by name with a regular expression

GetNetworkRoutedFilterMetadata

Key string: Metadata key (field name)
Value string: Metadata value (can be a regular expression if "use_api_search" is false)
IsSystem bool: True if is a metadata@SYSTEM key
Type string: Type of metadata value (needed only if "use_api_search" is true)
UseApiSearch bool: If true, will search the vCD using native metadata query (without regular expressions)

Key string: Metadata key (field name)
Value string: Metadata value (can be a regular expression if "use_api_search" is false)
IsSystem bool: True if is a metadata@SYSTEM key
Type string: Type of metadata value (needed only if "use_api_search" is true)
UseApiSearch bool: If true, will search the vCD using native metadata query (without regular expressions)

key String: Metadata key (field name)
value String: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem Boolean: True if is a metadata@SYSTEM key
type String: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch Boolean: If true, will search the vCD using native metadata query (without regular expressions)

key string: Metadata key (field name)
value string: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem boolean: True if is a metadata@SYSTEM key
type string: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch boolean: If true, will search the vCD using native metadata query (without regular expressions)

key str: Metadata key (field name)
value str: Metadata value (can be a regular expression if "use_api_search" is false)
is_system bool: True if is a metadata@SYSTEM key
type str: Type of metadata value (needed only if "use_api_search" is true)
use_api_search bool: If true, will search the vCD using native metadata query (without regular expressions)

key String: Metadata key (field name)
value String: Metadata value (can be a regular expression if "use_api_search" is false)
isSystem Boolean: True if is a metadata@SYSTEM key
type String: Type of metadata value (needed only if "use_api_search" is true)
useApiSearch Boolean: If true, will search the vCD using native metadata query (without regular expressions)