vcd.getProviderVdc

Explore with Pulumi AI

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

Example Usage

TypeScript
Python
Go
C#
Java
YAML

import * as pulumi from "@pulumi/pulumi";
import * as vcd from "@pulumi/vcd";

const my_pvdc = vcd.getProviderVdc({
    name: "my-pvdc",
});
export const providerVdc = my_pvdc.then(my_pvdc => my_pvdc.id);

import pulumi
import pulumi_vcd as vcd

my_pvdc = vcd.get_provider_vdc(name="my-pvdc")
pulumi.export("providerVdc", my_pvdc.id)

package main

import (
	"github.com/pulumi/pulumi-terraform-provider/sdks/go/vcd/v3/vcd"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		my_pvdc, err := vcd.LookupProviderVdc(ctx, &vcd.LookupProviderVdcArgs{
			Name: "my-pvdc",
		}, nil)
		if err != nil {
			return err
		}
		ctx.Export("providerVdc", my_pvdc.Id)
		return nil
	})
}

using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var my_pvdc = Vcd.GetProviderVdc.Invoke(new()
    {
        Name = "my-pvdc",
    });

    return new Dictionary<string, object?>
    {
        ["providerVdc"] = my_pvdc.Apply(my_pvdc => my_pvdc.Apply(getProviderVdcResult => getProviderVdcResult.Id)),
    };
});

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.vcd.VcdFunctions;
import com.pulumi.vcd.inputs.GetProviderVdcArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        final var my-pvdc = VcdFunctions.getProviderVdc(GetProviderVdcArgs.builder()
            .name("my-pvdc")
            .build());

        ctx.export("providerVdc", my_pvdc.id());
    }
}

variables:
  my-pvdc:
    fn::invoke:
      function: vcd:getProviderVdc
      arguments:
        name: my-pvdc
outputs:
  providerVdc: ${["my-pvdc"].id}

Compute Capacity

The compute_capacity attribute is a list with a single item which has the following nested attributes:

cpu - An indicator of CPU. See CPU and memory below.
memory - An indicator of memory. See CPU and memory below.
is_elastic - True if compute capacity can grow or shrink based on demand.
is_ha - True if compute capacity is highly available.

CPU and memory

The cpu and memory indicators have the following nested attributes:

allocation - Allocated CPU/Memory for this Provider VDC.
overhead - CPU/Memory overhead for this Provider VDC.
reserved - Reserved CPU/Memory for this Provider VDC.
total - Total CPU/Memory for this Provider VDC.
units - Units for the CPU/Memory of this Provider VDC.
used - Used CPU/Memory in this Provider VDC.

Metadata

The metadata_entry (v3.8+) is a set of metadata entries that have the following structure:

key - Key of this metadata entry.
value - Value of this metadata entry.
type - Type of this metadata entry. One of: MetadataStringValue, MetadataNumberValue, MetadataDateTimeValue, MetadataBooleanValue.
user_access - User access level for this metadata entry. One of: PRIVATE (hidden), READONLY (read only), READWRITE (read/write).
is_system - Domain for this metadata entry. true if it belongs to SYSTEM, false if it belongs to GENERAL.

Using getProviderVdc

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.

TypeScript
Python
Go
C#
Java
YAML

function getProviderVdc(args: GetProviderVdcArgs, opts?: InvokeOptions): Promise<GetProviderVdcResult>
function getProviderVdcOutput(args: GetProviderVdcOutputArgs, opts?: InvokeOptions): Output<GetProviderVdcResult>

def get_provider_vdc(id: Optional[str] = None,
                     name: Optional[str] = None,
                     opts: Optional[InvokeOptions] = None) -> GetProviderVdcResult
def get_provider_vdc_output(id: Optional[pulumi.Input[str]] = None,
                     name: Optional[pulumi.Input[str]] = None,
                     opts: Optional[InvokeOptions] = None) -> Output[GetProviderVdcResult]

func LookupProviderVdc(ctx *Context, args *LookupProviderVdcArgs, opts ...InvokeOption) (*LookupProviderVdcResult, error)
func LookupProviderVdcOutput(ctx *Context, args *LookupProviderVdcOutputArgs, opts ...InvokeOption) LookupProviderVdcResultOutput

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

public static class GetProviderVdc 
{
    public static Task<GetProviderVdcResult> InvokeAsync(GetProviderVdcArgs args, InvokeOptions? opts = null)
    public static Output<GetProviderVdcResult> Invoke(GetProviderVdcInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetProviderVdcResult> getProviderVdc(GetProviderVdcArgs args, InvokeOptions options)
public static Output<GetProviderVdcResult> getProviderVdc(GetProviderVdcArgs args, InvokeOptions options)

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

The following arguments are supported:

Name string: Provider VDC name
Id string

Name string: Provider VDC name
Id string

name String: Provider VDC name
id String

name string: Provider VDC name
id string

name str: Provider VDC name
id str

name String: Provider VDC name
id String

getProviderVdc Result

The following output properties are available:

Capabilities List<string>: Set of virtual hardware versions supported by this Provider VDC.
ComputeCapacities List<GetProviderVdcComputeCapacity>: An indicator of CPU and memory capacity. See Compute Capacity below for details.
ComputeProviderScope string: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
Description string: Optional description of the Provider VDC.
ExternalNetworkIds List<string>: Set of IDs of External Networks.
HighestSupportedHardwareVersion string: The highest virtual hardware version supported by this Provider VDC.
HostIds List<string>: Set with all the hosts which are connected to VC server.
Id string
IsEnabled bool: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
Metadata Dictionary<string, string>: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
MetadataEntries List<GetProviderVdcMetadataEntry>: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
Name string
NetworkPoolIds List<string>: Set IDs of the Network Pools used by this Provider VDC.
NsxtManagerId string: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
ResourcePoolIds List<string>: Set of IDs of the Resource Pools backing this provider VDC.
Status double: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
StorageContainerIds List<string>
StorageProfileIds List<string>: Set of IDs to the Storage Profiles available to this Provider VDC.
StorageProfileNames List<string>
UniversalNetworkPoolId string: ID of the universal network reference.
VcenterId string: ID of the vCenter Server that provides the Resource Pools and Datastores.

Capabilities []string: Set of virtual hardware versions supported by this Provider VDC.
ComputeCapacities []GetProviderVdcComputeCapacity: An indicator of CPU and memory capacity. See Compute Capacity below for details.
ComputeProviderScope string: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
Description string: Optional description of the Provider VDC.
ExternalNetworkIds []string: Set of IDs of External Networks.
HighestSupportedHardwareVersion string: The highest virtual hardware version supported by this Provider VDC.
HostIds []string: Set with all the hosts which are connected to VC server.
Id string
IsEnabled bool: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
Metadata map[string]string: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
MetadataEntries []GetProviderVdcMetadataEntry: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
Name string
NetworkPoolIds []string: Set IDs of the Network Pools used by this Provider VDC.
NsxtManagerId string: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
ResourcePoolIds []string: Set of IDs of the Resource Pools backing this provider VDC.
Status float64: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
StorageContainerIds []string
StorageProfileIds []string: Set of IDs to the Storage Profiles available to this Provider VDC.
StorageProfileNames []string
UniversalNetworkPoolId string: ID of the universal network reference.
VcenterId string: ID of the vCenter Server that provides the Resource Pools and Datastores.

capabilities List<String>: Set of virtual hardware versions supported by this Provider VDC.
computeCapacities List<GetProviderVdcComputeCapacity>: An indicator of CPU and memory capacity. See Compute Capacity below for details.
computeProviderScope String: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
description String: Optional description of the Provider VDC.
externalNetworkIds List<String>: Set of IDs of External Networks.
highestSupportedHardwareVersion String: The highest virtual hardware version supported by this Provider VDC.
hostIds List<String>: Set with all the hosts which are connected to VC server.
id String
isEnabled Boolean: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
metadata Map<String,String>: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
metadataEntries List<GetProviderVdcMetadataEntry>: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
name String
networkPoolIds List<String>: Set IDs of the Network Pools used by this Provider VDC.
nsxtManagerId String: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
resourcePoolIds List<String>: Set of IDs of the Resource Pools backing this provider VDC.
status Double: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
storageContainerIds List<String>
storageProfileIds List<String>: Set of IDs to the Storage Profiles available to this Provider VDC.
storageProfileNames List<String>
universalNetworkPoolId String: ID of the universal network reference.
vcenterId String: ID of the vCenter Server that provides the Resource Pools and Datastores.

capabilities string[]: Set of virtual hardware versions supported by this Provider VDC.
computeCapacities GetProviderVdcComputeCapacity[]: An indicator of CPU and memory capacity. See Compute Capacity below for details.
computeProviderScope string: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
description string: Optional description of the Provider VDC.
externalNetworkIds string[]: Set of IDs of External Networks.
highestSupportedHardwareVersion string: The highest virtual hardware version supported by this Provider VDC.
hostIds string[]: Set with all the hosts which are connected to VC server.
id string
isEnabled boolean: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
metadata {[key: string]: string}: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
metadataEntries GetProviderVdcMetadataEntry[]: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
name string
networkPoolIds string[]: Set IDs of the Network Pools used by this Provider VDC.
nsxtManagerId string: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
resourcePoolIds string[]: Set of IDs of the Resource Pools backing this provider VDC.
status number: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
storageContainerIds string[]
storageProfileIds string[]: Set of IDs to the Storage Profiles available to this Provider VDC.
storageProfileNames string[]
universalNetworkPoolId string: ID of the universal network reference.
vcenterId string: ID of the vCenter Server that provides the Resource Pools and Datastores.

capabilities Sequence[str]: Set of virtual hardware versions supported by this Provider VDC.
compute_capacities Sequence[GetProviderVdcComputeCapacity]: An indicator of CPU and memory capacity. See Compute Capacity below for details.
compute_provider_scope str: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
description str: Optional description of the Provider VDC.
external_network_ids Sequence[str]: Set of IDs of External Networks.
highest_supported_hardware_version str: The highest virtual hardware version supported by this Provider VDC.
host_ids Sequence[str]: Set with all the hosts which are connected to VC server.
id str
is_enabled bool: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
metadata Mapping[str, str]: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
metadata_entries Sequence[GetProviderVdcMetadataEntry]: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
name str
network_pool_ids Sequence[str]: Set IDs of the Network Pools used by this Provider VDC.
nsxt_manager_id str: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
resource_pool_ids Sequence[str]: Set of IDs of the Resource Pools backing this provider VDC.
status float: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
storage_container_ids Sequence[str]
storage_profile_ids Sequence[str]: Set of IDs to the Storage Profiles available to this Provider VDC.
storage_profile_names Sequence[str]
universal_network_pool_id str: ID of the universal network reference.
vcenter_id str: ID of the vCenter Server that provides the Resource Pools and Datastores.

capabilities List<String>: Set of virtual hardware versions supported by this Provider VDC.
computeCapacities List<Property Map>: An indicator of CPU and memory capacity. See Compute Capacity below for details.
computeProviderScope String: Represents the compute fault domain for this Provider VDC. This value is a tenant-facing tag that is shown to tenants when viewing fault domains of the child Organization VDCs (for example, a VDC Group).
description String: Optional description of the Provider VDC.
externalNetworkIds List<String>: Set of IDs of External Networks.
highestSupportedHardwareVersion String: The highest virtual hardware version supported by this Provider VDC.
hostIds List<String>: Set with all the hosts which are connected to VC server.
id String
isEnabled Boolean: True if this Provider VDC is enabled and can provide resources to organization VDCs. A Provider VDC is always enabled on creation.
metadata Map<String>: (Deprecated) Use metadata_entry instead. Key and value pairs for Provider VDC Metadata.
Deprecated: Deprecated
metadataEntries List<Property Map>: A set of metadata entries assigned to the Provider VDC. See Metadata section for details.
name String
networkPoolIds List<String>: Set IDs of the Network Pools used by this Provider VDC.
nsxtManagerId String: ID of the registered NSX-T Manager that backs networking operations for this Provider VDC.
resourcePoolIds List<String>: Set of IDs of the Resource Pools backing this provider VDC.
status Number: Status of the Provider VDC, it can be -1 (creation failed), 0 (not ready), 1 (ready), 2 (unknown) or 3 (unrecognized).
storageContainerIds List<String>
storageProfileIds List<String>: Set of IDs to the Storage Profiles available to this Provider VDC.
storageProfileNames List<String>
universalNetworkPoolId String: ID of the universal network reference.
vcenterId String: ID of the vCenter Server that provides the Resource Pools and Datastores.