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
andOrg Users
with rightView 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",
});
import pulumi
import pulumi_vcd as vcd
start_vdc = vcd.get_vdc_group(name="myVDC",
org="myOrg")
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
})
}
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",
});
});
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());
}
}
variables:
startVdc:
fn::invoke:
function: vcd:getVdcGroup
arguments:
name: myVDC
org: myOrg
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>
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]
func LookupVdcGroup(ctx *Context, args *LookupVdcGroupArgs, opts ...InvokeOption) (*LookupVdcGroupResult, error)
func LookupVdcGroupOutput(ctx *Context, args *LookupVdcGroupOutputArgs, opts ...InvokeOption) LookupVdcGroupResultOutput
> 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)
}
public static CompletableFuture<GetVdcGroupResult> getVdcGroup(GetVdcGroupArgs args, InvokeOptions options)
public static Output<GetVdcGroupResult> getVdcGroup(GetVdcGroupArgs args, InvokeOptions options)
fn::invoke:
function: vcd:index/getVdcGroup:getVdcGroup
arguments:
# arguments dictionary
The following arguments are supported:
- Default
Policy boolStatus - Description string
- Error
Message string - Id string
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- Local
Egress bool - Name string
- Name of VDC group
- Network
Pool stringId - Network
Pool stringUniversal Id - Network
Provider stringType - Org string
- Status string
- Type string
- Universal
Networking boolEnabled
- Default
Policy boolStatus - Description string
- Error
Message string - Id string
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- Local
Egress bool - Name string
- Name of VDC group
- Network
Pool stringId - Network
Pool stringUniversal Id - Network
Provider stringType - Org string
- Status string
- Type string
- Universal
Networking boolEnabled
- default
Policy BooleanStatus - description String
- error
Message String - id String
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- local
Egress Boolean - name String
- Name of VDC group
- network
Pool StringId - network
Pool StringUniversal Id - network
Provider StringType - org String
- status String
- type String
- universal
Networking BooleanEnabled
- default
Policy booleanStatus - description string
- error
Message string - id string
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- local
Egress boolean - name string
- Name of VDC group
- network
Pool stringId - network
Pool stringUniversal Id - network
Provider stringType - org string
- status string
- type string
- universal
Networking booleanEnabled
- default_
policy_ boolstatus - description str
- error_
message str - id str
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- local_
egress bool - name str
- Name of VDC group
- network_
pool_ strid - network_
pool_ struniversal_ id - network_
provider_ strtype - org str
- status str
- type str
- universal_
networking_ boolenabled
- default
Policy BooleanStatus - description String
- error
Message String - id String
ID of VDC group
Either
name
orid
must be used. If both are missing, an error arises.- local
Egress Boolean - name String
- Name of VDC group
- network
Pool StringId - network
Pool StringUniversal Id - network
Provider StringType - org String
- status String
- type String
- universal
Networking BooleanEnabled
getVdcGroup Result
The following output properties are available:
- Default
Policy boolStatus - Description string
- Dfw
Enabled bool - Error
Message string - Id string
- Local
Egress bool - Name string
- Network
Pool stringId - Network
Pool stringUniversal Id - Network
Provider stringType - Participating
Org List<GetVdcs Vdc Group Participating Org Vdc> - Status string
- Type string
- Universal
Networking boolEnabled - Org string
- Default
Policy boolStatus - Description string
- Dfw
Enabled bool - Error
Message string - Id string
- Local
Egress bool - Name string
- Network
Pool stringId - Network
Pool stringUniversal Id - Network
Provider stringType - Participating
Org []GetVdcs Vdc Group Participating Org Vdc - Status string
- Type string
- Universal
Networking boolEnabled - Org string
- default
Policy BooleanStatus - description String
- dfw
Enabled Boolean - error
Message String - id String
- local
Egress Boolean - name String
- network
Pool StringId - network
Pool StringUniversal Id - network
Provider StringType - participating
Org List<GetVdcs Vdc Group Participating Org Vdc> - status String
- type String
- universal
Networking BooleanEnabled - org String
- default
Policy booleanStatus - description string
- dfw
Enabled boolean - error
Message string - id string
- local
Egress boolean - name string
- network
Pool stringId - network
Pool stringUniversal Id - network
Provider stringType - participating
Org GetVdcs Vdc Group Participating Org Vdc[] - status string
- type string
- universal
Networking booleanEnabled - org string
- default_
policy_ boolstatus - description str
- dfw_
enabled bool - error_
message str - id str
- local_
egress bool - name str
- network_
pool_ strid - network_
pool_ struniversal_ id - network_
provider_ strtype - participating_
org_ Sequence[Getvdcs Vdc Group Participating Org Vdc] - status str
- type str
- universal_
networking_ boolenabled - org str
- default
Policy BooleanStatus - description String
- dfw
Enabled Boolean - error
Message String - id String
- local
Egress Boolean - name String
- network
Pool StringId - network
Pool StringUniversal Id - network
Provider StringType - participating
Org List<Property Map>Vdcs - status String
- type String
- universal
Networking BooleanEnabled - org String
Supporting Types
GetVdcGroupParticipatingOrgVdc
- Fault
Domain stringTag - Is
Remote boolOrg - Network
Provider stringScope - Org
Id string - Org
Name string - Site
Id string - Site
Name string - Status string
- Vdc
Id string - Vdc
Name string
- Fault
Domain stringTag - Is
Remote boolOrg - Network
Provider stringScope - Org
Id string - Org
Name string - Site
Id string - Site
Name string - Status string
- Vdc
Id string - Vdc
Name string
- fault
Domain StringTag - is
Remote BooleanOrg - network
Provider StringScope - org
Id String - org
Name String - site
Id String - site
Name String - status String
- vdc
Id String - vdc
Name String
- fault
Domain stringTag - is
Remote booleanOrg - network
Provider stringScope - org
Id string - org
Name string - site
Id string - site
Name string - status string
- vdc
Id string - vdc
Name string
- fault_
domain_ strtag - is_
remote_ boolorg - network_
provider_ strscope - org_
id str - org_
name str - site_
id str - site_
name str - status str
- vdc_
id str - vdc_
name str
- fault
Domain StringTag - is
Remote BooleanOrg - network
Provider StringScope - org
Id String - org
Name String - site
Id String - site
Name String - status String
- vdc
Id String - vdc
Name String
Package Details
- Repository
- vcd vmware/terraform-provider-vcd
- License
- Notes
- This Pulumi package is based on the
vcd
Terraform Provider.