Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Vcd Provider
  3. API Docs
  4. VdcGroup
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

vcd.VdcGroup

Explore with Pulumi AI

vcd logo
vcd 3.14.1 published on Monday, Apr 14, 2025 by vmware
vmware/terraform-provider-vcd

    Create VdcGroup Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new VdcGroup(name: string, args: VdcGroupArgs, opts?: CustomResourceOptions);
    @overload
def VdcGroup(resource_name: str,
             args: VdcGroupArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def VdcGroup(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             participating_vdc_ids: Optional[Sequence[str]] = None,
             starting_vdc_id: Optional[str] = None,
             default_policy_status: Optional[bool] = None,
             description: Optional[str] = None,
             dfw_enabled: Optional[bool] = None,
             force_delete: Optional[bool] = None,
             name: Optional[str] = None,
             org: Optional[str] = None,
             remove_default_firewall_rule: Optional[bool] = None,
             vdc_group_id: Optional[str] = None)
    func NewVdcGroup(ctx *Context, name string, args VdcGroupArgs, opts ...ResourceOption) (*VdcGroup, error)
    public VdcGroup(string name, VdcGroupArgs args, CustomResourceOptions? opts = null)
    public VdcGroup(String name, VdcGroupArgs args)
public VdcGroup(String name, VdcGroupArgs args, CustomResourceOptions options)

    type: vcd:VdcGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args VdcGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args VdcGroupArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args VdcGroupArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args VdcGroupArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args VdcGroupArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var vdcGroupResource = new Vcd.VdcGroup("vdcGroupResource", new()
{
    ParticipatingVdcIds = new[]
    {
        "string",
    },
    StartingVdcId = "string",
    DefaultPolicyStatus = false,
    Description = "string",
    DfwEnabled = false,
    ForceDelete = false,
    Name = "string",
    Org = "string",
    RemoveDefaultFirewallRule = false,
    VdcGroupId = "string",
});

    example, err := vcd.NewVdcGroup(ctx, "vdcGroupResource", &vcd.VdcGroupArgs{
	ParticipatingVdcIds: pulumi.StringArray{
		pulumi.String("string"),
	},
	StartingVdcId:             pulumi.String("string"),
	DefaultPolicyStatus:       pulumi.Bool(false),
	Description:               pulumi.String("string"),
	DfwEnabled:                pulumi.Bool(false),
	ForceDelete:               pulumi.Bool(false),
	Name:                      pulumi.String("string"),
	Org:                       pulumi.String("string"),
	RemoveDefaultFirewallRule: pulumi.Bool(false),
	VdcGroupId:                pulumi.String("string"),
})

    var vdcGroupResource = new VdcGroup("vdcGroupResource", VdcGroupArgs.builder()
    .participatingVdcIds("string")
    .startingVdcId("string")
    .defaultPolicyStatus(false)
    .description("string")
    .dfwEnabled(false)
    .forceDelete(false)
    .name("string")
    .org("string")
    .removeDefaultFirewallRule(false)
    .vdcGroupId("string")
    .build());

    vdc_group_resource = vcd.VdcGroup("vdcGroupResource",
    participating_vdc_ids=["string"],
    starting_vdc_id="string",
    default_policy_status=False,
    description="string",
    dfw_enabled=False,
    force_delete=False,
    name="string",
    org="string",
    remove_default_firewall_rule=False,
    vdc_group_id="string")

    const vdcGroupResource = new vcd.VdcGroup("vdcGroupResource", {
    participatingVdcIds: ["string"],
    startingVdcId: "string",
    defaultPolicyStatus: false,
    description: "string",
    dfwEnabled: false,
    forceDelete: false,
    name: "string",
    org: "string",
    removeDefaultFirewallRule: false,
    vdcGroupId: "string",
});

    type: vcd:VdcGroup
properties:
    defaultPolicyStatus: false
    description: string
    dfwEnabled: false
    forceDelete: false
    name: string
    org: string
    participatingVdcIds:
        - string
    removeDefaultFirewallRule: false
    startingVdcId: string
    vdcGroupId: string

    VdcGroup Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The VdcGroup resource accepts the following input properties:

    ParticipatingVdcIds List<string>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    StartingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    DefaultPolicyStatus bool
    Whether this security policy is enabled. dfw_enabled must be true.
    Description string
    VDC group description
    DfwEnabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    ForceDelete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    Name string
    The name for VDC group
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    RemoveDefaultFirewallRule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    VdcGroupId string
    The VDC group ID
    ParticipatingVdcIds []string
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    StartingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    DefaultPolicyStatus bool
    Whether this security policy is enabled. dfw_enabled must be true.
    Description string
    VDC group description
    DfwEnabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    ForceDelete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    Name string
    The name for VDC group
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    RemoveDefaultFirewallRule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    VdcGroupId string
    The VDC group ID
    participatingVdcIds List<String>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    startingVdcId String
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    defaultPolicyStatus Boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description String
    VDC group description
    dfwEnabled Boolean
    Whether Distributed Firewall is enabled for this VDC group.
    forceDelete Boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    name String
    The name for VDC group
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    removeDefaultFirewallRule Boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    vdcGroupId String
    The VDC group ID
    participatingVdcIds string[]
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    startingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    defaultPolicyStatus boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description string
    VDC group description
    dfwEnabled boolean
    Whether Distributed Firewall is enabled for this VDC group.
    forceDelete boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    name string
    The name for VDC group
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    removeDefaultFirewallRule boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    vdcGroupId string
    The VDC group ID
    participating_vdc_ids Sequence[str]
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    starting_vdc_id str
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    default_policy_status bool
    Whether this security policy is enabled. dfw_enabled must be true.
    description str
    VDC group description
    dfw_enabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    force_delete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    name str
    The name for VDC group
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    remove_default_firewall_rule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    vdc_group_id str
    The VDC group ID
    participatingVdcIds List<String>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    startingVdcId String
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    defaultPolicyStatus Boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description String
    VDC group description
    dfwEnabled Boolean
    Whether Distributed Firewall is enabled for this VDC group.
    forceDelete Boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    name String
    The name for VDC group
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    removeDefaultFirewallRule Boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    vdcGroupId String
    The VDC group ID

    Outputs

    All input properties are implicitly available as output properties. Additionally, the VdcGroup resource produces the following output properties:

    ErrorMessage string
    More detailed error message when VDC group has error status
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalEgress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    NetworkPoolId string
    ID of used network pool.
    NetworkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    NetworkProviderType string
    Defines the networking provider backing the VDC group.
    ParticipatingOrgVdcs List<VdcGroupParticipatingOrgVdc>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    Type string
    Defines the group as LOCAL or UNIVERSAL.
    UniversalNetworkingEnabled bool
    True means that a VDC group router has been created.
    ErrorMessage string
    More detailed error message when VDC group has error status
    Id string
    The provider-assigned unique ID for this managed resource.
    LocalEgress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    NetworkPoolId string
    ID of used network pool.
    NetworkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    NetworkProviderType string
    Defines the networking provider backing the VDC group.
    ParticipatingOrgVdcs []VdcGroupParticipatingOrgVdc
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    Type string
    Defines the group as LOCAL or UNIVERSAL.
    UniversalNetworkingEnabled bool
    True means that a VDC group router has been created.
    errorMessage String
    More detailed error message when VDC group has error status
    id String
    The provider-assigned unique ID for this managed resource.
    localEgress Boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    networkPoolId String
    ID of used network pool.
    networkPoolUniversalId String
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType String
    Defines the networking provider backing the VDC group.
    participatingOrgVdcs List<VdcGroupParticipatingOrgVdc>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type String
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled Boolean
    True means that a VDC group router has been created.
    errorMessage string
    More detailed error message when VDC group has error status
    id string
    The provider-assigned unique ID for this managed resource.
    localEgress boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    networkPoolId string
    ID of used network pool.
    networkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType string
    Defines the networking provider backing the VDC group.
    participatingOrgVdcs VdcGroupParticipatingOrgVdc[]
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type string
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled boolean
    True means that a VDC group router has been created.
    error_message str
    More detailed error message when VDC group has error status
    id str
    The provider-assigned unique ID for this managed resource.
    local_egress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    network_pool_id str
    ID of used network pool.
    network_pool_universal_id str
    The network provider’s universal id that is backing the universal network pool.
    network_provider_type str
    Defines the networking provider backing the VDC group.
    participating_org_vdcs Sequence[VdcGroupParticipatingOrgVdc]
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    status str
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type str
    Defines the group as LOCAL or UNIVERSAL.
    universal_networking_enabled bool
    True means that a VDC group router has been created.
    errorMessage String
    More detailed error message when VDC group has error status
    id String
    The provider-assigned unique ID for this managed resource.
    localEgress Boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    networkPoolId String
    ID of used network pool.
    networkPoolUniversalId String
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType String
    Defines the networking provider backing the VDC group.
    participatingOrgVdcs List<Property Map>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type String
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled Boolean
    True means that a VDC group router has been created.

    Look up Existing VdcGroup Resource

    Get an existing VdcGroup resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: VdcGroupState, opts?: CustomResourceOptions): VdcGroup
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        default_policy_status: Optional[bool] = None,
        description: Optional[str] = None,
        dfw_enabled: Optional[bool] = None,
        error_message: Optional[str] = None,
        force_delete: Optional[bool] = 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,
        participating_org_vdcs: Optional[Sequence[VdcGroupParticipatingOrgVdcArgs]] = None,
        participating_vdc_ids: Optional[Sequence[str]] = None,
        remove_default_firewall_rule: Optional[bool] = None,
        starting_vdc_id: Optional[str] = None,
        status: Optional[str] = None,
        type: Optional[str] = None,
        universal_networking_enabled: Optional[bool] = None,
        vdc_group_id: Optional[str] = None) -> VdcGroup
    func GetVdcGroup(ctx *Context, name string, id IDInput, state *VdcGroupState, opts ...ResourceOption) (*VdcGroup, error)
    public static VdcGroup Get(string name, Input<string> id, VdcGroupState? state, CustomResourceOptions? opts = null)
    public static VdcGroup get(String name, Output<String> id, VdcGroupState state, CustomResourceOptions options)
    resources:  _:    type: vcd:VdcGroup    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    DefaultPolicyStatus bool
    Whether this security policy is enabled. dfw_enabled must be true.
    Description string
    VDC group description
    DfwEnabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    ErrorMessage string
    More detailed error message when VDC group has error status
    ForceDelete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    LocalEgress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    Name string
    The name for VDC group
    NetworkPoolId string
    ID of used network pool.
    NetworkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    NetworkProviderType string
    Defines the networking provider backing the VDC group.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    ParticipatingOrgVdcs List<VdcGroupParticipatingOrgVdc>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    ParticipatingVdcIds List<string>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    RemoveDefaultFirewallRule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    StartingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    Type string
    Defines the group as LOCAL or UNIVERSAL.
    UniversalNetworkingEnabled bool
    True means that a VDC group router has been created.
    VdcGroupId string
    The VDC group ID
    DefaultPolicyStatus bool
    Whether this security policy is enabled. dfw_enabled must be true.
    Description string
    VDC group description
    DfwEnabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    ErrorMessage string
    More detailed error message when VDC group has error status
    ForceDelete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    LocalEgress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    Name string
    The name for VDC group
    NetworkPoolId string
    ID of used network pool.
    NetworkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    NetworkProviderType string
    Defines the networking provider backing the VDC group.
    Org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    ParticipatingOrgVdcs []VdcGroupParticipatingOrgVdcArgs
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    ParticipatingVdcIds []string
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    RemoveDefaultFirewallRule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    StartingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    Type string
    Defines the group as LOCAL or UNIVERSAL.
    UniversalNetworkingEnabled bool
    True means that a VDC group router has been created.
    VdcGroupId string
    The VDC group ID
    defaultPolicyStatus Boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description String
    VDC group description
    dfwEnabled Boolean
    Whether Distributed Firewall is enabled for this VDC group.
    errorMessage String
    More detailed error message when VDC group has error status
    forceDelete Boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    localEgress Boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    name String
    The name for VDC group
    networkPoolId String
    ID of used network pool.
    networkPoolUniversalId String
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType String
    Defines the networking provider backing the VDC group.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    participatingOrgVdcs List<VdcGroupParticipatingOrgVdc>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    participatingVdcIds List<String>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    removeDefaultFirewallRule Boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    startingVdcId String
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type String
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled Boolean
    True means that a VDC group router has been created.
    vdcGroupId String
    The VDC group ID
    defaultPolicyStatus boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description string
    VDC group description
    dfwEnabled boolean
    Whether Distributed Firewall is enabled for this VDC group.
    errorMessage string
    More detailed error message when VDC group has error status
    forceDelete boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    localEgress boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    name string
    The name for VDC group
    networkPoolId string
    ID of used network pool.
    networkPoolUniversalId string
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType string
    Defines the networking provider backing the VDC group.
    org string
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    participatingOrgVdcs VdcGroupParticipatingOrgVdc[]
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    participatingVdcIds string[]
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    removeDefaultFirewallRule boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    startingVdcId string
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type string
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled boolean
    True means that a VDC group router has been created.
    vdcGroupId string
    The VDC group ID
    default_policy_status bool
    Whether this security policy is enabled. dfw_enabled must be true.
    description str
    VDC group description
    dfw_enabled bool
    Whether Distributed Firewall is enabled for this VDC group.
    error_message str
    More detailed error message when VDC group has error status
    force_delete bool
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    local_egress bool
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    name str
    The name for VDC group
    network_pool_id str
    ID of used network pool.
    network_pool_universal_id str
    The network provider’s universal id that is backing the universal network pool.
    network_provider_type str
    Defines the networking provider backing the VDC group.
    org str
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    participating_org_vdcs Sequence[VdcGroupParticipatingOrgVdcArgs]
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    participating_vdc_ids Sequence[str]
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    remove_default_firewall_rule bool
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    starting_vdc_id str
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    status str
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type str
    Defines the group as LOCAL or UNIVERSAL.
    universal_networking_enabled bool
    True means that a VDC group router has been created.
    vdc_group_id str
    The VDC group ID
    defaultPolicyStatus Boolean
    Whether this security policy is enabled. dfw_enabled must be true.
    description String
    VDC group description
    dfwEnabled Boolean
    Whether Distributed Firewall is enabled for this VDC group.
    errorMessage String
    More detailed error message when VDC group has error status
    forceDelete Boolean
    When true, will request VCD to force VDC Group deletion. It should clean up child components. Default false (VCD may fail removing VDC Group if there are child components remaining). Note: when setting it to true for existing resource, it will cause a plan change (update), but this will not alter the resource in any way.
    localEgress Boolean
    Status whether local egress is enabled for a universal router belonging to a universal VDC group.
    name String
    The name for VDC group
    networkPoolId String
    ID of used network pool.
    networkPoolUniversalId String
    The network provider’s universal id that is backing the universal network pool.
    networkProviderType String
    Defines the networking provider backing the VDC group.
    org String
    The name of organization to use, optional if defined at provider level. Useful when connected as sysadmin working across different organizations
    participatingOrgVdcs List<Property Map>
    A list of blocks providing organization VDCs that are participating in this group details. See Participating Org VDCs below for details.
    participatingVdcIds List<String>
    The list of organization VDCs that are participating in this group. Note: starting_vdc_id isn't automatically included in this list.
    removeDefaultFirewallRule Boolean
    Marks whether default firewall rule should be removed after activating. Both dfw_enabled and default_policy_status must be true. Note. This is mainly useful when using vcd.NsxtDistributedFirewallRule resource as it cannot remove the default rule.
    startingVdcId String
    With selecting a starting VDC you will be able to create a group in which this VDC can participate. Note: starting_vdc_id must be included in participating_vdc_ids to participate in this group.
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    type String
    Defines the group as LOCAL or UNIVERSAL.
    universalNetworkingEnabled Boolean
    True means that a VDC group router has been created.
    vdcGroupId String
    The VDC group ID

    Supporting Types

    VdcGroupParticipatingOrgVdc, VdcGroupParticipatingOrgVdcArgs

    FaultDomainTag string
    IsRemoteOrg bool
    NetworkProviderScope string
    OrgId string
    OrgName string
    SiteId string
    SiteName string
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    VdcId string
    VdcName string
    FaultDomainTag string
    IsRemoteOrg bool
    NetworkProviderScope string
    OrgId string
    OrgName string
    SiteId string
    SiteName string
    Status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    VdcId string
    VdcName string
    faultDomainTag String
    isRemoteOrg Boolean
    networkProviderScope String
    orgId String
    orgName String
    siteId String
    siteName String
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    vdcId String
    vdcName String
    faultDomainTag string
    isRemoteOrg boolean
    networkProviderScope string
    orgId string
    orgName string
    siteId string
    siteName string
    status string
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    vdcId string
    vdcName string
    fault_domain_tag str
    is_remote_org bool
    network_provider_scope str
    org_id str
    org_name str
    site_id str
    site_name str
    status str
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    vdc_id str
    vdc_name str
    faultDomainTag String
    isRemoteOrg Boolean
    networkProviderScope String
    orgId String
    orgName String
    siteId String
    siteName String
    status String
    The status that the group can be in (e.g. 'SAVING', 'SAVED', 'CONFIGURING', 'REALIZED', 'REALIZATION_FAILED', 'DELETING', 'DELETE_FAILED', 'OBJECT_NOT_FOUND', 'UNCONFIGURED').
    vdcId String
    vdcName 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
    vmware/terraform-provider-vcd