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

vcd.getVdcGroup

Explore with Pulumi AI

Supported in provider v3.5+ and VCD 10.2+.

Provides a data source to read NSX-T VDC group and reference in other resources.

Only System Administrator and Org Users with right View VDC Group can access VDC groups using this data source.

Example Usage

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

const startVdc = vcd.getVdcGroup({
    name: "myVDC",
    org: "myOrg",
});
Copy
import pulumi
import pulumi_vcd as vcd

start_vdc = vcd.get_vdc_group(name="myVDC",
    org="myOrg")
Copy
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 {
		_, err := vcd.LookupVdcGroup(ctx, &vcd.LookupVdcGroupArgs{
			Name: pulumi.StringRef("myVDC"),
			Org:  pulumi.StringRef("myOrg"),
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
Copy
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Vcd = Pulumi.Vcd;

return await Deployment.RunAsync(() => 
{
    var startVdc = Vcd.GetVdcGroup.Invoke(new()
    {
        Name = "myVDC",
        Org = "myOrg",
    });

});
Copy
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.GetVdcGroupArgs;
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 startVdc = VcdFunctions.getVdcGroup(GetVdcGroupArgs.builder()
            .name("myVDC")
            .org("myOrg")
            .build());

    }
}
Copy
variables:
  startVdc:
    fn::invoke:
      function: vcd:getVdcGroup
      arguments:
        name: myVDC
        org: myOrg
Copy

Using getVdcGroup

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 getVdcGroup(args: GetVdcGroupArgs, opts?: InvokeOptions): Promise<GetVdcGroupResult>
function getVdcGroupOutput(args: GetVdcGroupOutputArgs, opts?: InvokeOptions): Output<GetVdcGroupResult>
Copy
def get_vdc_group(default_policy_status: Optional[bool] = None,
                  description: Optional[str] = None,
                  error_message: Optional[str] = None,
                  id: Optional[str] = None,
                  local_egress: Optional[bool] = None,
                  name: Optional[str] = None,
                  network_pool_id: Optional[str] = None,
                  network_pool_universal_id: Optional[str] = None,
                  network_provider_type: Optional[str] = None,
                  org: Optional[str] = None,
                  status: Optional[str] = None,
                  type: Optional[str] = None,
                  universal_networking_enabled: Optional[bool] = None,
                  opts: Optional[InvokeOptions] = None) -> GetVdcGroupResult
def get_vdc_group_output(default_policy_status: Optional[pulumi.Input[bool]] = None,
                  description: Optional[pulumi.Input[str]] = None,
                  error_message: Optional[pulumi.Input[str]] = None,
                  id: Optional[pulumi.Input[str]] = None,
                  local_egress: Optional[pulumi.Input[bool]] = None,
                  name: Optional[pulumi.Input[str]] = None,
                  network_pool_id: Optional[pulumi.Input[str]] = None,
                  network_pool_universal_id: Optional[pulumi.Input[str]] = None,
                  network_provider_type: Optional[pulumi.Input[str]] = None,
                  org: Optional[pulumi.Input[str]] = None,
                  status: Optional[pulumi.Input[str]] = None,
                  type: Optional[pulumi.Input[str]] = None,
                  universal_networking_enabled: Optional[pulumi.Input[bool]] = None,
                  opts: Optional[InvokeOptions] = None) -> Output[GetVdcGroupResult]
Copy
func LookupVdcGroup(ctx *Context, args *LookupVdcGroupArgs, opts ...InvokeOption) (*LookupVdcGroupResult, error)
func LookupVdcGroupOutput(ctx *Context, args *LookupVdcGroupOutputArgs, opts ...InvokeOption) LookupVdcGroupResultOutput
Copy

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

public static class GetVdcGroup 
{
    public static Task<GetVdcGroupResult> InvokeAsync(GetVdcGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetVdcGroupResult> Invoke(GetVdcGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetVdcGroupResult> getVdcGroup(GetVdcGroupArgs args, InvokeOptions options)
public static Output<GetVdcGroupResult> getVdcGroup(GetVdcGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: vcd:index/getVdcGroup:getVdcGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

DefaultPolicyStatus bool
Description string
ErrorMessage string
Id string

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

LocalEgress bool
Name string
Name of VDC group
NetworkPoolId string
NetworkPoolUniversalId string
NetworkProviderType string
Org string
Status string
Type string
UniversalNetworkingEnabled bool
DefaultPolicyStatus bool
Description string
ErrorMessage string
Id string

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

LocalEgress bool
Name string
Name of VDC group
NetworkPoolId string
NetworkPoolUniversalId string
NetworkProviderType string
Org string
Status string
Type string
UniversalNetworkingEnabled bool
defaultPolicyStatus Boolean
description String
errorMessage String
id String

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

localEgress Boolean
name String
Name of VDC group
networkPoolId String
networkPoolUniversalId String
networkProviderType String
org String
status String
type String
universalNetworkingEnabled Boolean
defaultPolicyStatus boolean
description string
errorMessage string
id string

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

localEgress boolean
name string
Name of VDC group
networkPoolId string
networkPoolUniversalId string
networkProviderType string
org string
status string
type string
universalNetworkingEnabled boolean
default_policy_status bool
description str
error_message str
id str

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

local_egress bool
name str
Name of VDC group
network_pool_id str
network_pool_universal_id str
network_provider_type str
org str
status str
type str
universal_networking_enabled bool
defaultPolicyStatus Boolean
description String
errorMessage String
id String

ID of VDC group

Either name or id must be used. If both are missing, an error arises.

localEgress Boolean
name String
Name of VDC group
networkPoolId String
networkPoolUniversalId String
networkProviderType String
org String
status String
type String
universalNetworkingEnabled Boolean

getVdcGroup Result

The following output properties are available:

Supporting Types

GetVdcGroupParticipatingOrgVdc

FaultDomainTag This property is required. string
IsRemoteOrg This property is required. bool
NetworkProviderScope This property is required. string
OrgId This property is required. string
OrgName This property is required. string
SiteId This property is required. string
SiteName This property is required. string
Status This property is required. string
VdcId This property is required. string
VdcName This property is required. string
FaultDomainTag This property is required. string
IsRemoteOrg This property is required. bool
NetworkProviderScope This property is required. string
OrgId This property is required. string
OrgName This property is required. string
SiteId This property is required. string
SiteName This property is required. string
Status This property is required. string
VdcId This property is required. string
VdcName This property is required. string
faultDomainTag This property is required. String
isRemoteOrg This property is required. Boolean
networkProviderScope This property is required. String
orgId This property is required. String
orgName This property is required. String
siteId This property is required. String
siteName This property is required. String
status This property is required. String
vdcId This property is required. String
vdcName This property is required. String
faultDomainTag This property is required. string
isRemoteOrg This property is required. boolean
networkProviderScope This property is required. string
orgId This property is required. string
orgName This property is required. string
siteId This property is required. string
siteName This property is required. string
status This property is required. string
vdcId This property is required. string
vdcName This property is required. string
fault_domain_tag This property is required. str
is_remote_org This property is required. bool
network_provider_scope This property is required. str
org_id This property is required. str
org_name This property is required. str
site_id This property is required. str
site_name This property is required. str
status This property is required. str
vdc_id This property is required. str
vdc_name This property is required. str
faultDomainTag This property is required. String
isRemoteOrg This property is required. Boolean
networkProviderScope This property is required. String
orgId This property is required. String
orgName This property is required. String
siteId This property is required. String
siteName This property is required. String
status This property is required. String
vdcId This property is required. String
vdcName 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.