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>
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
Get
Network Routed Filter - 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
Get
Network Routed Filter - 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
Get
Network Routed Filter - 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
Get
Network Routed Filter - 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
Get
Network Routed Filter - 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
- Dhcp
Pools List<GetNetwork Routed Dhcp Pool> - Dns1 string
- Dns2 string
- Dns
Suffix string - Edge
Gateway string - Gateway string
- Href string
- Id string
- Interface
Type string - Metadata Dictionary<string, string>
- Metadata
Entries List<GetNetwork Routed Metadata Entry> - Netmask string
- bool
- Static
Ip List<GetPools Network Routed Static Ip Pool> - Filter
Get
Network Routed Filter - Name string
- Org string
- Vdc string
- Description string
- Dhcp
Pools []GetNetwork Routed Dhcp Pool - Dns1 string
- Dns2 string
- Dns
Suffix string - Edge
Gateway string - Gateway string
- Href string
- Id string
- Interface
Type string - Metadata map[string]string
- Metadata
Entries []GetNetwork Routed Metadata Entry - Netmask string
- bool
- Static
Ip []GetPools Network Routed Static Ip Pool - Filter
Get
Network Routed Filter - Name string
- Org string
- Vdc string
- description String
- dhcp
Pools List<GetNetwork Routed Dhcp Pool> - dns1 String
- dns2 String
- dns
Suffix String - edge
Gateway String - gateway String
- href String
- id String
- interface
Type String - metadata Map<String,String>
- metadata
Entries List<GetNetwork Routed Metadata Entry> - netmask String
- Boolean
- static
Ip List<GetPools Network Routed Static Ip Pool> - filter
Get
Network Routed Filter - name String
- org String
- vdc String
- description string
- dhcp
Pools GetNetwork Routed Dhcp Pool[] - dns1 string
- dns2 string
- dns
Suffix string - edge
Gateway string - gateway string
- href string
- id string
- interface
Type string - metadata {[key: string]: string}
- metadata
Entries GetNetwork Routed Metadata Entry[] - netmask string
- boolean
- static
Ip GetPools Network Routed Static Ip Pool[] - filter
Get
Network Routed Filter - name string
- org string
- vdc string
- description str
- dhcp_
pools Sequence[GetNetwork Routed Dhcp Pool] - dns1 str
- dns2 str
- dns_
suffix str - edge_
gateway str - gateway str
- href str
- id str
- interface_
type str - metadata Mapping[str, str]
- metadata_
entries Sequence[GetNetwork Routed Metadata Entry] - netmask str
- bool
- static_
ip_ Sequence[Getpools Network Routed Static Ip Pool] - filter
Get
Network Routed Filter - name str
- org str
- vdc str
- description String
- dhcp
Pools List<Property Map> - dns1 String
- dns2 String
- dns
Suffix String - edge
Gateway String - gateway String
- href String
- id String
- interface
Type String - metadata Map<String>
- metadata
Entries List<Property Map> - netmask String
- Boolean
- static
Ip List<Property Map>Pools - filter Property Map
- name String
- org String
- vdc String
Supporting Types
GetNetworkRoutedDhcpPool
- Default
Lease Time This property is required. double - End
Address This property is required. string - Max
Lease Time This property is required. double - Start
Address This property is required. string
- Default
Lease Time This property is required. float64 - End
Address This property is required. string - Max
Lease Time This property is required. float64 - Start
Address This property is required. string
- default
Lease Time This property is required. Double - end
Address This property is required. String - max
Lease Time This property is required. Double - start
Address This property is required. String
- default
Lease Time This property is required. number - end
Address This property is required. string - max
Lease Time This property is required. number - start
Address 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
- default
Lease Time This property is required. Number - end
Address This property is required. String - max
Lease Time This property is required. Number - start
Address This property is required. String
GetNetworkRoutedFilter
- Ip string
- Search by IP. The value can be a regular expression
- Metadatas
List<Get
Network Routed Filter Metadata> - metadata filter
- Name
Regex string - Search by name with a regular expression
- Ip string
- Search by IP. The value can be a regular expression
- Metadatas
[]Get
Network Routed Filter Metadata - metadata filter
- Name
Regex string - Search by name with a regular expression
- ip String
- Search by IP. The value can be a regular expression
- metadatas
List<Get
Network Routed Filter Metadata> - metadata filter
- name
Regex String - Search by name with a regular expression
- ip string
- Search by IP. The value can be a regular expression
- metadatas
Get
Network Routed Filter Metadata[] - metadata filter
- name
Regex string - Search by name with a regular expression
- ip str
- Search by IP. The value can be a regular expression
- metadatas
Sequence[Get
Network Routed Filter Metadata] - 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
- name
Regex 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)
- Is
System bool - True if is a metadata@SYSTEM key
- Type string
- Type of metadata value (needed only if "use_api_search" is true)
- Use
Api boolSearch - 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)
- Is
System bool - True if is a metadata@SYSTEM key
- Type string
- Type of metadata value (needed only if "use_api_search" is true)
- Use
Api boolSearch - 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)
- is
System Boolean - True if is a metadata@SYSTEM key
- type String
- Type of metadata value (needed only if "use_api_search" is true)
- use
Api BooleanSearch - 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)
- is
System boolean - True if is a metadata@SYSTEM key
- type string
- Type of metadata value (needed only if "use_api_search" is true)
- use
Api booleanSearch - 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_ boolsearch - 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)
- is
System Boolean - True if is a metadata@SYSTEM key
- type String
- Type of metadata value (needed only if "use_api_search" is true)
- use
Api BooleanSearch - If true, will search the vCD using native metadata query (without regular expressions)
GetNetworkRoutedMetadataEntry
- Is
System This property is required. bool - Key
This property is required. string - Type
This property is required. string - User
Access This property is required. string - Value
This property is required. string
- Is
System This property is required. bool - Key
This property is required. string - Type
This property is required. string - User
Access This property is required. string - Value
This property is required. string
- is
System This property is required. Boolean - key
This property is required. String - type
This property is required. String - user
Access This property is required. String - value
This property is required. String
- is
System This property is required. boolean - key
This property is required. string - type
This property is required. string - user
Access 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
- is
System This property is required. Boolean - key
This property is required. String - type
This property is required. String - user
Access This property is required. String - value
This property is required. String
GetNetworkRoutedStaticIpPool
- End
Address This property is required. string - Start
Address This property is required. string
- End
Address This property is required. string - Start
Address This property is required. string
- end
Address This property is required. String - start
Address This property is required. String
- end
Address This property is required. string - start
Address This property is required. string
- end_
address This property is required. str - start_
address This property is required. str
- end
Address This property is required. String - start
Address 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.