[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director

Update VDC Group Settings

Description

Updates the global vDC groups settings. These settings apply to all vDC Groups in the system and can only be updated by the provider.

Request

Request

URL

URL


put
https://{api_host}/cloudapi/1.0.0/vdcGroups/settings
Copy

Request Body

Request Body

VdcGroupSettings of type(s) application/json Required
{
	"nsxTVdcGroupFaultDomainTagType": "string"
}
string
nsxTVdcGroupFaultDomainTagType Optional

    Defines the fault domain tag that will be shown for participating/candidate Organization vDCs during creation or update of a vDC Group whose networkProviderType is NSX_T. The options a provider can choose from are COMPUTE_PROVIDER_SCOPE and NETWORK_PROVIDER_SCOPE. This should be selected based on the provider's compute or networking infrastructure. The default value is COMPUTE_PROVIDER_SCOPE.
  • NETWORK_PROVIDER_SCOPE: This represents the tenant-facing name of the backing network provider for the organization vDC (NSX-V/NSX-T manager). This should be used when the fault domains in the provider infrastructure are separated by network provider.
  • COMPUTE_PROVIDER_SCOPE: This represents the tenant-facing name of the backing compute provider for the organization vDC (Provider VDC). This should be used when the fault domains in the provider infrastructure are separated by compute provider.

Authentication

Authentication

This operation uses the following authentication methods.

Response

Response

Response Body

Response Body

200 OK

Returns VdcGroupSettings of type(s) application/json;version=36.3
{
	"nsxTVdcGroupFaultDomainTagType": "string"
}
string
nsxTVdcGroupFaultDomainTagType Optional

    Defines the fault domain tag that will be shown for participating/candidate Organization vDCs during creation or update of a vDC Group whose networkProviderType is NSX_T. The options a provider can choose from are COMPUTE_PROVIDER_SCOPE and NETWORK_PROVIDER_SCOPE. This should be selected based on the provider's compute or networking infrastructure. The default value is COMPUTE_PROVIDER_SCOPE.
  • NETWORK_PROVIDER_SCOPE: This represents the tenant-facing name of the backing network provider for the organization vDC (NSX-V/NSX-T manager). This should be used when the fault domains in the provider infrastructure are separated by network provider.
  • COMPUTE_PROVIDER_SCOPE: This represents the tenant-facing name of the backing compute provider for the organization vDC (Provider VDC). This should be used when the fault domains in the provider infrastructure are separated by compute provider.

No error details were provided in the OpenAPI specification.

Code Samples

Code Samples

cURL Command

curl -X PUT -H "Content-Type: application/json" -d '{"nsxTVdcGroupFaultDomainTagType":"string"}' https://{api_host}/cloudapi/1.0.0/vdcGroups/settings


[{"label":"Latest (v37.0)","version":"latest"},{"version":"v36.3"},{"version":"v36.2"},{"version":"v36.1"},{"version":"v36.0"},{"link":"https://developer.vmware.com/apis/1046/vmware-cloud-director","version":"v35.0"}]
vmware-cloud-director
Availability
Added in 35.0
VDC Groups Settings Operations
Feedback

Was this page helpful?