VdcGroup

VdcGroup
VdcGroup

A vDC Group holds a list of vDCs that can have a network be stretched across the vDCs.

JSON Example 
{
    "id": "string",
    "orgId": "string",
    "name": "string",
    "description": "string",
    "localEgress": false,
    "participatingOrgVdcs": [
        {
            "id": "string",
            "vdcRef": {
                "name": "string",
                "id": "string"
            },
            "orgRef": {
                "name": "string",
                "id": "string"
            },
            "siteRef": {
                "name": "string",
                "id": "string"
            },
            "networkProviderScope": "string",
            "faultDomainTag": "string",
            "remoteOrg": false,
            "status": {}
        }
    ],
    "participatingOrgVdcCount": 0,
    "universalNetworkingEnabled": false,
    "networkPoolUniversalId": "string",
    "networkPoolId": "string",
    "status": {},
    "type": "string",
    "networkProviderType": "string",
    "dfwEnabled": false,
    "errorMessage": "string",
    "networkingTenancyEnabled": false
}
string
id
Optional

The unique ID for the vDC Group (read-only).

string
orgId
Required

The organization that this group belongs to.

string
name
Required

The name of this group. The name must be unique.

string
description
Optional

The description of this group.

boolean
localEgress
Optional

Determines whether local egress is enabled for a universal router belonging to a NSX-V universal vDC group. This value is used on create if universalNetworkingEnabled is set to true. This cannot be updated. This value is always false for local vDC groups. This does not apply for NSX-T vDC groups.

array of ParticipatingVdcReference
participatingOrgVdcs
Required

The list of organization vDCs that are participating in this group. The first participating vDC must belong to the same Organization as the vDC Group, as the networking tenancy setting of the first vDC is used to decide the networking tenancy setting of the vDC Group. Note that if the vDC group has more than 16 existing vDCs, update to this property is ignored. User will need to use the participating vDC API: /1.0.0/vdcGroups/{vdcGroupId}/vdcs.

integer
participatingOrgVdcCount
Optional

The total number of participating vDCs in this vDC Group.

boolean
universalNetworkingEnabled
Optional

For a NSX-T vDC group, it means that a NSX-T edge gateway has been added or created for the group. For a NSX-V vDC group, it means that a distributed router has been created for the group. If set to true for NSX-V vdc group creation, a universal router will be created.

string
networkPoolUniversalId
Optional

The network provider's universal id that is backing the universal network pool. This field is read-only and is derived from the list of participating vDCs if a universal vDC group is created. For NSX-V universal vDC groups, each participating vDC should have a universal network pool that is backed by this same id. This will always be NULL for NSX-T vDC groups.

string
networkPoolId
Optional

ID of network pool to use if creating a local vDC group. Must be set if creating a local group. Ignored if creating an universal group.

VdcGroupEntityStatus
status
Optional

Represents status of vDC group components such as participating vdc's configured routing, egress points, etc.

Possible values are : SAVING, SAVED, CONFIGURING, REALIZED, REALIZATION_FAILED, DELETING, DELETE_FAILED, OBJECT_NOT_FOUND, UNCONFIGURED,
string
type
Optional

Defines the group as LOCAL or UNIVERSAL. This cannot be changed. Local vDC Groups can have networks stretched across multiple vDCs in a single Cloud Director instance. Local vDC Groups share the same broadcast domain/transport zone and network provider scope. Universal NSX-V backed vDC groups can have networks stretched across multiple vDCs in a single or multiple Cloud Director instance(s). Universal NSX-V vDC groups are backed by a broadcast domain/transport zone that stretches across a single or multiple Cloud Director instance(s). Universal NSX-T backed vDC groups can have networks stretched across multiple vDCs in a single Cloud Director instance using NSX-T federation.

Possible values are : LOCAL, UNIVERSAL,
string
networkProviderType
Optional

The values currently supported are NSX_V and NSX_T. Defines the networking provider backing the vDC Group. This is used on create. If not specified, NSX_V value will be used. NSX_V is used for existing vDC Groups and vDC Groups where Cross-VC NSX is used for the underlying technology. NSX_T is used when the networking provider type for the Organization vDCs in the group is NSX-T.

boolean
dfwEnabled
Optional

Whether Distributed Firewall is enabled for this vDC Group. Only applicable for NSX_T vDC Groups.

string
errorMessage
Optional

If the group has an error status, a more detailed error message is set here.

boolean
networkingTenancyEnabled
Optional

Whether this vDC Group is using networking tenancy. This is readonly. This is determined upon creation by the networking tenancy setting of the first participating vDC. After creation, vDCs with and without networking tenancy active may be added to the vDC Group.

Parameter To
Returned By