1. Packages
  2. Vcd Provider
  3. API Docs
  4. getNetworkRouted
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
Schema (JSON)
vmware/terraform-provider-vcd

vcd.getNetworkRouted

vcd logo
Viewing docs for vcd 3.14.1
published on Monday, Apr 14, 2025 by vmware
Schema (JSON)
vmware/terraform-provider-vcd

    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 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

    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)

    GetNetworkRoutedMetadataEntry

    IsSystem bool
    Key string
    Type string
    UserAccess string
    Value string
    IsSystem bool
    Key string
    Type string
    UserAccess string
    Value string
    isSystem Boolean
    key String
    type String
    userAccess String
    value String
    isSystem boolean
    key string
    type string
    userAccess string
    value string
    isSystem Boolean
    key String
    type String
    userAccess String
    value String

    GetNetworkRoutedStaticIpPool

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    Viewing docs for vcd 3.14.1
    published on Monday, Apr 14, 2025 by vmware
    Schema (JSON)
    vmware/terraform-provider-vcd
      Try Pulumi Cloud free. Your team will thank you.