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

vcd.getNetworkRouted

Explore with Pulumi AI

Provides a VMware Cloud Director Org VDC routed Network data source. This can be used to reference internal networks for vApps to connect.

Supported in provider v2.5+

Note: This data source supports only NSX-V backed Org VDC networks. Please use newer vcd.NetworkRoutedV2 data source which is compatible with NSX-T.

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>
Copy
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]
Copy
func LookupNetworkRouted(ctx *Context, args *LookupNetworkRoutedArgs, opts ...InvokeOption) (*LookupNetworkRoutedResult, error)
func LookupNetworkRoutedOutput(ctx *Context, args *LookupNetworkRoutedOutputArgs, opts ...InvokeOption) LookupNetworkRoutedResultOutput
Copy

> 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)
}
Copy
public static CompletableFuture<GetNetworkRoutedResult> getNetworkRouted(GetNetworkRoutedArgs args, InvokeOptions options)
public static Output<GetNetworkRoutedResult> getNetworkRouted(GetNetworkRoutedArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getNetworkRouted:getNetworkRouted
  arguments:
    # arguments dictionary
Copy

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<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 This property is required. double
EndAddress This property is required. string
MaxLeaseTime This property is required. double
StartAddress This property is required. string
DefaultLeaseTime This property is required. float64
EndAddress This property is required. string
MaxLeaseTime This property is required. float64
StartAddress This property is required. string
defaultLeaseTime This property is required. Double
endAddress This property is required. String
maxLeaseTime This property is required. Double
startAddress This property is required. String
defaultLeaseTime This property is required. number
endAddress This property is required. string
maxLeaseTime This property is required. number
startAddress This property is required. string
default_lease_time This property is required. float
end_address This property is required. str
max_lease_time This property is required. float
start_address This property is required. str
defaultLeaseTime This property is required. Number
endAddress This property is required. String
maxLeaseTime This property is required. Number
startAddress This property is required. 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 This property is required. string
Metadata key (field name)
Value This property is required. 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 This property is required. string
Metadata key (field name)
Value This property is required. 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 This property is required. String
Metadata key (field name)
value This property is required. 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 This property is required. string
Metadata key (field name)
value This property is required. 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 This property is required. str
Metadata key (field name)
value This property is required. 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 This property is required. String
Metadata key (field name)
value This property is required. 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)

GetNetworkRoutedMetadataEntry

IsSystem This property is required. bool
Key This property is required. string
Type This property is required. string
UserAccess This property is required. string
Value This property is required. string
IsSystem This property is required. bool
Key This property is required. string
Type This property is required. string
UserAccess This property is required. string
Value This property is required. string
isSystem This property is required. Boolean
key This property is required. String
type This property is required. String
userAccess This property is required. String
value This property is required. String
isSystem This property is required. boolean
key This property is required. string
type This property is required. string
userAccess This property is required. string
value This property is required. string
is_system This property is required. bool
key This property is required. str
type This property is required. str
user_access This property is required. str
value This property is required. str
isSystem This property is required. Boolean
key This property is required. String
type This property is required. String
userAccess This property is required. String
value This property is required. String

GetNetworkRoutedStaticIpPool

EndAddress This property is required. string
StartAddress This property is required. string
EndAddress This property is required. string
StartAddress This property is required. string
endAddress This property is required. String
startAddress This property is required. String
endAddress This property is required. string
startAddress This property is required. string
end_address This property is required. str
start_address This property is required. str
endAddress This property is required. String
startAddress This property is required. String

Package Details

Repository
vcd vmware/terraform-provider-vcd
License
Notes
This Pulumi package is based on the vcd Terraform Provider.