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

vcd.getNetworkDirect

Explore with Pulumi AI

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

    Provides a VMware Cloud Director Org VDC Network data source directly connected to an external network. This can be used to reference internal networks for vApps to connect.

    Supported in provider v2.5+

    Using getNetworkDirect

    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 getNetworkDirect(args: GetNetworkDirectArgs, opts?: InvokeOptions): Promise<GetNetworkDirectResult>
    function getNetworkDirectOutput(args: GetNetworkDirectOutputArgs, opts?: InvokeOptions): Output<GetNetworkDirectResult>
    def get_network_direct(filter: Optional[GetNetworkDirectFilter] = None,
                           id: Optional[str] = None,
                           name: Optional[str] = None,
                           org: Optional[str] = None,
                           vdc: Optional[str] = None,
                           opts: Optional[InvokeOptions] = None) -> GetNetworkDirectResult
    def get_network_direct_output(filter: Optional[pulumi.Input[GetNetworkDirectFilterArgs]] = 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[GetNetworkDirectResult]
    func LookupNetworkDirect(ctx *Context, args *LookupNetworkDirectArgs, opts ...InvokeOption) (*LookupNetworkDirectResult, error)
    func LookupNetworkDirectOutput(ctx *Context, args *LookupNetworkDirectOutputArgs, opts ...InvokeOption) LookupNetworkDirectResultOutput

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

    public static class GetNetworkDirect 
    {
        public static Task<GetNetworkDirectResult> InvokeAsync(GetNetworkDirectArgs args, InvokeOptions? opts = null)
        public static Output<GetNetworkDirectResult> Invoke(GetNetworkDirectInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNetworkDirectResult> getNetworkDirect(GetNetworkDirectArgs args, InvokeOptions options)
    public static Output<GetNetworkDirectResult> getNetworkDirect(GetNetworkDirectArgs args, InvokeOptions options)
    
    fn::invoke:
      function: vcd:index/getNetworkDirect:getNetworkDirect
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Filter GetNetworkDirectFilter
    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 GetNetworkDirectFilter
    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 GetNetworkDirectFilter
    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 GetNetworkDirectFilter
    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 GetNetworkDirectFilter
    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.

    getNetworkDirect Result

    The following output properties are available:

    Description string
    ExternalNetwork string
    The name of the external network.
    ExternalNetworkDns1 string
    ExternalNetworkDns2 string
    ExternalNetworkDnsSuffix string
    ExternalNetworkGateway string
    ExternalNetworkNetmask string
    Href string
    Id string
    Metadata Dictionary<string, string>

    Deprecated: Deprecated

    MetadataEntries List<GetNetworkDirectMetadataEntry>
    Shared bool
    Defines if this network is shared between multiple vDCs in the vOrg.
    Filter GetNetworkDirectFilter
    Name string
    Org string
    Vdc string
    Description string
    ExternalNetwork string
    The name of the external network.
    ExternalNetworkDns1 string
    ExternalNetworkDns2 string
    ExternalNetworkDnsSuffix string
    ExternalNetworkGateway string
    ExternalNetworkNetmask string
    Href string
    Id string
    Metadata map[string]string

    Deprecated: Deprecated

    MetadataEntries []GetNetworkDirectMetadataEntry
    Shared bool
    Defines if this network is shared between multiple vDCs in the vOrg.
    Filter GetNetworkDirectFilter
    Name string
    Org string
    Vdc string
    description String
    externalNetwork String
    The name of the external network.
    externalNetworkDns1 String
    externalNetworkDns2 String
    externalNetworkDnsSuffix String
    externalNetworkGateway String
    externalNetworkNetmask String
    href String
    id String
    metadata Map<String,String>

    Deprecated: Deprecated

    metadataEntries List<GetNetworkDirectMetadataEntry>
    shared Boolean
    Defines if this network is shared between multiple vDCs in the vOrg.
    filter GetNetworkDirectFilter
    name String
    org String
    vdc String
    description string
    externalNetwork string
    The name of the external network.
    externalNetworkDns1 string
    externalNetworkDns2 string
    externalNetworkDnsSuffix string
    externalNetworkGateway string
    externalNetworkNetmask string
    href string
    id string
    metadata {[key: string]: string}

    Deprecated: Deprecated

    metadataEntries GetNetworkDirectMetadataEntry[]
    shared boolean
    Defines if this network is shared between multiple vDCs in the vOrg.
    filter GetNetworkDirectFilter
    name string
    org string
    vdc string
    description str
    external_network str
    The name of the external network.
    external_network_dns1 str
    external_network_dns2 str
    external_network_dns_suffix str
    external_network_gateway str
    external_network_netmask str
    href str
    id str
    metadata Mapping[str, str]

    Deprecated: Deprecated

    metadata_entries Sequence[GetNetworkDirectMetadataEntry]
    shared bool
    Defines if this network is shared between multiple vDCs in the vOrg.
    filter GetNetworkDirectFilter
    name str
    org str
    vdc str
    description String
    externalNetwork String
    The name of the external network.
    externalNetworkDns1 String
    externalNetworkDns2 String
    externalNetworkDnsSuffix String
    externalNetworkGateway String
    externalNetworkNetmask String
    href String
    id String
    metadata Map<String>

    Deprecated: Deprecated

    metadataEntries List<Property Map>
    shared Boolean
    Defines if this network is shared between multiple vDCs in the vOrg.
    filter Property Map
    name String
    org String
    vdc String

    Supporting Types

    GetNetworkDirectFilter

    Ip string
    Search by IP. The value can be a regular expression
    Metadatas List<GetNetworkDirectFilterMetadata>
    metadata filter
    NameRegex string
    Search by name with a regular expression
    Ip string
    Search by IP. The value can be a regular expression
    Metadatas []GetNetworkDirectFilterMetadata
    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<GetNetworkDirectFilterMetadata>
    metadata filter
    nameRegex String
    Search by name with a regular expression
    ip string
    Search by IP. The value can be a regular expression
    metadatas GetNetworkDirectFilterMetadata[]
    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[GetNetworkDirectFilterMetadata]
    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

    GetNetworkDirectFilterMetadata

    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)

    GetNetworkDirectMetadataEntry

    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

    Package Details

    Repository
    vcd vmware/terraform-provider-vcd
    License
    Notes
    This Pulumi package is based on the vcd Terraform Provider.
    vcd logo
    vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware