A system administrator can use links in an AdminVdc element to enable, disable, or remove an organization VDC.

Prerequisites

  • Verify that you are logged in as a system administrator.

  • Retrieve the VDC that you want to enable, disable, or remove. If you don't know the URL of the VDC, you can use a query like this one to retrieve a list of references all VDCs in the system.
    GET https://vcloud.example.com/api/query?type=adminOrgVdc&format=references

Procedure

  • To enable a VDC, POST a request to its action/enable link.
  • To disable a VDC, POST a request to its action/disable link.
    When you disable an organization VDC, you prevent further use of its compute and storage resources. Running vApps and powered on virtual machines continue to run, but you cannot create or start additional vApps or virtual machines.
  • To remove a VDC, remove all the objects it contains, then disable and remove it.
    1. Relocate or remove any vApps that have been deployed in the VDC.
    2. Remove any organization VDC networks that the VDC contains.
    3. Remove any Edge Gateways that the VDC contains.
    4. Disable the VDC by making POST a request to its action/disable link.
      After the VDC is disabled, its representation includes a rel="remove" link if it no longer contains any objects.
    5. Make a DELETE request to the VDC's rel="remove" link.
    Note: You can make a request like this one, which adds the query string recursive=true to the VDC href, to remove a VDC that contains one or more objects as long as those objects are in a state that normally allows removal.
    DELETE https://vcloud.example.com/api/admin/vdc/44?recursive=true
    You can use an additional query parameter to force this kind of recursive removal even when the VDC contains objects that are not in an appropriate state.
    DELETE https://vcloud.example.com/api/admin/vdc/44?recursive=true&force=true

Results

The server takes the requested action and returns an HTTP status of 204 No Content.