VMware Cloud Foundation as a Service API

Introduction

Last updated: 2025-12-09

End of Marketing: As of 31 October 2025, new deployments of VMware Solutions offerings are no longer available for new customers. Existing customers can still use and expand their active VMware® workloads on IBM Cloud®. For more information, see End of Marketing for VMware on IBM Cloud.

With the IBM Cloud® for VMware Cloud Foundation as a Service API, you can quickly and seamlessly integrate or migrate your on-premises VMware® workloads to IBM Cloud®. This is done by using the scalable, secure, and high-performance IBM Cloud infrastructure and the industry-leading VMware hybrid virtualization technology. You can easily deploy your VMware virtual environments and manage the infrastructure resources on IBM Cloud. At the same time, you can still use your familiar native VMware product console to manage the VMware workloads. For more information, see the VCF as a Service documentation.

By using the IBM Cloud for VMware Cloud Foundation as a Service REST API, you acknowledge that you have read and accepted the following third-party agreements:

Endpoint URLs

The API is available at:

https://api.{region}.vmware.cloud.ibm.com/v1

Not all regions support VCF as a Service. For more information, see IBM Cloud data center availability.

To successfully invoke an API, the endpoint URL must be qualified with a method and authentication credential through an IAM token in the request header.

For VMware licenses and Usage Meter registrations, the APIs are available at https://licensing.vmware.cloud.ibm.com/v1

Authentication

Authentication to the API is managed by IBM Cloud Identity and Access Management (IAM). To work with the API, you must add an IBM Cloud IAM access token in the API request authentication header:

-H 'Authorization: Bearer <IAM_TOKEN>'

To call each method, you'll need to be assigned a role that includes the required IAM actions. Each method lists the associated action. For more information about IAM actions and how they map to roles, see Managing IAM access for VCF as a Service.

You can build your API request by pairing a service endpoint with your authentication credentials. For example, if you list the Cloud Director site service instances for the us-south region, use the following endpoint and API headers to retrieve instances in your service:

curl -X GET \
    https://api.us-south.vmware.cloud.ibm.com/v1/director_sites \
    -H "authorization: Bearer <access_token>"

Replace <access_token> with your Cloud IAM token.

You can retrieve an IBM Cloud IAM access token by using the IBM Cloud CLI or by creating an API key and then exchanging the API key for an IBM Cloud IAM access token. For more information, see Generating an IBM Cloud IAM token by using an API key.

When you use the SDK, configure an IAM authenticator with the IAM API key. The authenticator automatically obtains the IAM access token for the API key and includes it with each request. You can construct an authenticator in the following ways:

Programmatically, by constructing an IAM authenticator instance and supplying your IAM API key.
Externally, in configuration options that are then used by the SDK to construct an IAM authenticator at run time.

Provide external configuration options by either:

Storing the configuration options in environment variables. When you initialize the service client, the SDK constructs the authenticator by reading the configuration properties directly from the environment variables.
Saving the configuration options in a file. When you initialize the service client, the SDK constructs the authenticator by reading the configuration properties from the file that is specified by the IBM_CREDENTIALS_FILE environment variable.

In this example of using external configuration properties, an IAM authenticator instance is created with the configured API key, and then the service client is constructed with this authenticator instance and the configured service URL.

For more information, see the Authentication section in the IBM Cloud SDK Common documentation.

Outside of development and testing, never hardcode secrets (such as IAM API keys) into a client application.

Setting client options programmatically

Construct the service client programmatically, where {api_key} is your hardcoded IAM API key:

import {
  "github.com/IBM/go-sdk-core/v5/core"
  "github.com/IBM/vmware-go-sdk/vmwarev1"
}
// Create an IAM authenticator.
authenticator := &core.IamAuthenticator{
  ApiKey: "{api_key}",
}
// Construct an "options" struct for creating the service client.
options := &vmwarev1.VmwareV1Options{
  Authenticator: authenticator,                            // required
  URL:           "https://api.us-south.vmware.cloud.ibm.com/v1",  // optional
}
// Construct the service client.
vmwareService, err := vmwarev1.NewVmwareV1(options)
if err != nil {
  panic(err)
}

Service operations can now be invoked by using the vmwareService variable.

Setting client options through environment variables

Export environment variables to implement service client options, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

export VMWARE_URL={service_url}
export VMWARE_AUTH_TYPE=iam
export VMWARE_APIKEY={api_key}
export VMWARE_AUTH_URL=https://iam.cloud.ibm.com

Construct the service client by using external configuration. vmwarev1.NewVmwareV1UsingExternalConfig() initializes the client with the environment variables and it uses them for subsequent authentication.

vmwareService, err := vmwarev1.NewVmwareV1UsingExternalConfig()

Setting client options through a credentials file

Store credentials in a file such as my-credentials.env, where {service_url} is an endpoint URL for the service and {api_key} is an IAM API key.

VMWARE_URL={service_url}
VMWARE_AUTH_TYPE=iam
VMWARE_APIKEY={api_key}
VMWARE_AUTH_URL=https://iam.cloud.ibm.com

Export the name of the file with an environment variable, where {credential_file_path} is the absolute path to your credentials file, such as "$HOME/secrets/vmware-credentials.env".

export IBM_CREDENTIALS_FILE={credential_file_path}

Construct the service client by using external configuration. vmwarev1.NewVmwareV1UsingExternalConfig() initializes with the defined credential file, and it uses it for subsequent authentication.

vmwareService, err := vmwarev1.NewVmwareV1UsingExternalConfig()

Auditing

You can monitor API activity within your account. Whenever an API method is called, an event is generated that you can then track and audit. The specific event type is listed for each method that generates auditing events. For methods that don't list any events, no events are generated.

For more information about how to track VCF as a Service activity, see Activity tracking events for VCF as a Service.

Error handling

This API uses standard HTTP response codes to indicate whether a method completed successfully. A 200 type response indicates success. A 400 type response indicates a failure. A 500 type response indicates an internal system error.

HTTP error code	Description	Recovery
`200`	Success	The request was successful.
`202`	Success	The request was submitted successfully.
`400`	Bad request	The input parameters in the request body are either incomplete or in the wrong format. Be sure to include all required parameters in your request.
`401`	Unauthorized	You are not authorized to make this request because of missing or bad authentication token.
`403`	Forbidden	The supplied authentication is not authorized to make this request. Contact the account owner to check your permissions.
`409`	Conflict	The request cannot be completed because of a conflict with the current state of the target resource.
`500`	Internal server error	Your request cannot be processed. Wait a few minutes and try again. If the error persists, contact IBM Support.

When an API operation fails, detailed information about the failure is provided in the response. In addition, in every response there is a header named x-global-transaction-id, which is a unique ID for the API operation. When contacting IBM Support on API operation failures, you can provide the x-global-transaction-id for better debugging.

Create an instance of a Cloud Director site with specified configurations. The Cloud Director site instance is the infrastructure and associated VMware software stack, which consists of VMware vCenter Server, VMware NSX-T, and VMware Cloud Director. VMware platform management and operations are performed with Cloud Director. The minimum initial order size is 2 hosts (2-Socket 32 Cores, 192 GB RAM) with 24 TB of 2.0 IOPS/GB storage.

POST /director_sites

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.create

Auditing

Calling this method generates the following auditing event.

vmware.directorsite.create

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Request Body

Required*

DirectorSitePrototype

Create VMware Cloud Director site request body

Examples:

Example request

curl -X POST   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "name": "my_director_site",
    "private_only": True,
    "console_connection_type": "private",
    "ip_allow_list": ['1.1.1.1/24', '2.2.2.2/24'],
    "resource_group": {"id": "some_resourcegroupid"},
    "services": [
      {
        "name": "veeam"
      },
      {
        "name": "vcda"
      }
    ]
    "pvdcs": [
      {
        "name": "pvdc-1",
        "data_center_name": "dal10",
        "clusters": [
          {
            "name": "cluster_1",
            "host_count": 3,
            "file_shares": {
              "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
              "STORAGE_TWO_IOPS_GB": 24000,
              "STORAGE_FOUR_IOPS_GB": 24000,
              "STORAGE_TEN_IOPS_GB": 8000
              },
            "host_profile": "BM_2S_20_CORES_192_GB"
            }
          ]
        }
      ]
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/go-sdk-core/v5/core"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	fileSharesPrototypeModel := &vmwarev1.FileSharesPrototype{}

	clusterPrototypeModel := &vmwarev1.ClusterPrototype{
		Name:        core.StringPtr("cluster_1"),
		HostCount:   core.Int64Ptr(int64(2)),
		HostProfile: core.StringPtr("BM_2S_20_CORES_192_GB"),
		FileShares:  fileSharesPrototypeModel,
	}

	pvdcPrototypeModel := &vmwarev1.PVDCPrototype{
		Name:           core.StringPtr("pvdc-1"),
		DataCenterName: core.StringPtr("dal10"),
		Clusters:       []vmwarev1.ClusterPrototype{*clusterPrototypeModel},
	}

	createDirectorSitesOptions := vmwareService.NewCreateDirectorSitesOptions(
		"my_director_site",
		[]vmwarev1.PVDCPrototype{*pvdcPrototypeModel},
	)
	createDirectorSitesOptions.SetAcceptLanguage("en-us")
	createDirectorSitesOptions.SetXGlobalTransactionID("transaction1")

	directorSite, response, err := vmwareService.CreateDirectorSites(createDirectorSitesOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSite, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSite

A Cloud Director site resource. The Cloud Director site instance is the infrastructure and the associated VMware software stack, which consists of VMware vCenter Server, VMware NSX-T, and VMware Cloud Director.

Status Code

202
OK
400
Bad Request
401
Unauthorized

Example responses

Status 202

{
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid001",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001",
  "id": "directorsiteuuid001",
  "ordered_at": "2022-12-12 12:12:12Z",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "name": "MyInstance",
  "status": "creating",
  "console_connection_type": "private",
  "console_connection_status": "creating",
  "ip_allow_list": [
    "1.1.1.1/24"
  ],
  "type": "multitenant",
  "rhel_vm_activation_key": "xxxxxxxxxxxxxxxxxxx",
  "services": [
    {
      "name": "veeam",
      "id": "ed5372b9-c67a-4b4d-a43f-3ac01a6e191e",
      "provisioned_at": "2022-12-06T20:06:59.137069+00:00",
      "ordered_at": "2022-12-06T20:06:59.137069+00:00",
      "status": "creating",
      "console_url": "https://sdirw.jp-tok.vmware.test.cloud.ibm.com:9443/vCloud/1"
    }
  ],
  "resource_group": {
    "name": "default",
    "id": "a_resource_group_id",
    "crn": "crn:v1:bluemix:public:resource-controller::a/accuntid::resource-group:resourcegroupid"
  },
  "pvdcs": [
    {
      "id": "pvdcuuid001",
      "name": "pvdc-1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001",
      "status": "creating",
      "data_center_name": "dal10",
      "clusters": [
        {
          "id": "clusteruuid001",
          "name": "cluster_1",
          "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001/clusters/clusteruuid001",
          "status": "creating",
          "data_center_name": "dal10",
          "host_count": 3,
          "file_shares": {
            "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
            "STORAGE_TWO_IOPS_GB": 24000,
            "STORAGE_FOUR_IOPS_GB": 24000,
            "STORAGE_TEN_IOPS_GB": 8000
          },
          "host_profile": "BM_2S_20_CORES_192_GB"
        }
      ],
      "provider_types": [
        {
          "name": "on_demand"
        },
        {
          "name": "reserved"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

List all VMware Cloud Director site instances that the user can access in the cloud account.

GET /director_sites

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/go-sdk-core/v5/core"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listDirectorSitesOptions := vmwareService.NewListDirectorSitesOptions()
	listDirectorSitesOptions.SetAcceptLanguage("en-us")
	listDirectorSitesOptions.SetXGlobalTransactionID("transaction1")

	directorSiteCollection, response, err := vmwareService.ListDirectorSites(listDirectorSitesOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSiteCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSiteCollection

Return all Cloud Director site instances.

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "director_sites": [
    {
      "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid004",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid004",
      "id": "directorsiteuuid004",
      "ordered_at": "2022-12-12 12:12:12Z",
      "provisioned_at": "2022-12-12 12:12:12Z",
      "name": "MyInstance",
      "type": "multitenant",
      "rhel_vm_activation_key": "xxxxxxxxxxxxxxxxxxx",
      "console_connection_type": "private",
      "console_connection_status": "creating",
      "ip_allow_list": [
        "1.1.1.1/24"
      ],
      "services": [
        {
          "name": "veeam",
          "id": "ed5372b9-c67a-4b4d-a43f-3ac01a6e191e",
          "provisioned_at": "2022-12-06T20:06:59.137069+00:00",
          "ordered_at": "2022-12-06T20:06:59.137069+00:00",
          "status": "creating",
          "console_url": "https://sdirw.jp-tok.vmware.test.cloud.ibm.com:9443/vCloud/1"
        }
      ],
      "status": "ready_to_use",
      "resource_group": {
        "name": "default",
        "id": "b_resource_group_id",
        "crn": "crn:v1:bluemix:public:resource-controller::a/accuntid::resource-group:resourcegroupid"
      },
      "pvdcs": [
        {
          "id": "pvdcuuid005",
          "name": "pvdc-1",
          "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid004/pvdcs/pvdcuuid005",
          "data_center_name": "dal10",
          "status": "creating",
          "clusters": [
            {
              "id": "clusteruuid007",
              "name": "cluster_1",
              "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid004/pvdcs/pvdcuuid005/clusters/clusteruuid007",
              "status": "creating",
              "data_center_name": "dal10",
              "host_count": 3,
              "file_shares": {
                "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
                "STORAGE_TWO_IOPS_GB": 24000,
                "STORAGE_FOUR_IOPS_GB": 24000,
                "STORAGE_TEN_IOPS_GB": 8000
              },
              "host_profile": "BM_2S_20_CORES_192_GB"
            }
          ],
          "provider_types": [
            {
              "name": "on_demand"
            },
            {
              "name": "reserved"
            }
          ]
        }
      ]
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Get a Cloud Director site instance by specifying the instance ID.

GET /director_sites/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	getDirectorSiteOptions := vmwareService.NewGetDirectorSiteOptions(
		"site_id",
	)
	getDirectorSiteOptions.SetAcceptLanguage("en-us")
	getDirectorSiteOptions.SetXGlobalTransactionID("transaction1")

	directorSite, response, err := vmwareService.GetDirectorSite(getDirectorSiteOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSite, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSite

A Cloud Director site resource. The Cloud Director site instance is the infrastructure and the associated VMware software stack, which consists of VMware vCenter Server, VMware NSX-T, and VMware Cloud Director.

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid001",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001",
  "id": "directorsiteuuid001",
  "ordered_at": "2022-12-12 12:12:12Z",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "name": "MyInstance",
  "status": "creating",
  "console_connection_type": "private",
  "console_connection_status": "creating",
  "ip_allow_list": [
    "1.1.1.1/24"
  ],
  "type": "multitenant",
  "rhel_vm_activation_key": "xxxxxxxxxxxxxxxxxxx",
  "services": [
    {
      "name": "veeam",
      "id": "ed5372b9-c67a-4b4d-a43f-3ac01a6e191e",
      "provisioned_at": "2022-12-06T20:06:59.137069+00:00",
      "ordered_at": "2022-12-06T20:06:59.137069+00:00",
      "status": "creating",
      "console_url": "https://sdirw.jp-tok.vmware.test.cloud.ibm.com:9443/vCloud/1"
    }
  ],
  "resource_group": {
    "name": "default",
    "id": "a_resource_group_id",
    "crn": "crn:v1:bluemix:public:resource-controller::a/accuntid::resource-group:resourcegroupid"
  },
  "pvdcs": [
    {
      "id": "pvdcuuid001",
      "name": "pvdc-1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001",
      "status": "creating",
      "data_center_name": "dal10",
      "clusters": [
        {
          "id": "clusteruuid001",
          "name": "cluster_1",
          "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001/clusters/clusteruuid001",
          "status": "creating",
          "data_center_name": "dal10",
          "host_count": 3,
          "file_shares": {
            "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
            "STORAGE_TWO_IOPS_GB": 24000,
            "STORAGE_FOUR_IOPS_GB": 24000,
            "STORAGE_TEN_IOPS_GB": 8000
          },
          "host_profile": "BM_2S_20_CORES_192_GB"
        }
      ],
      "provider_types": [
        {
          "name": "on_demand"
        },
        {
          "name": "reserved"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Delete a Cloud Director site instance by specifying the instance ID.

DELETE /director_sites/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.delete

Auditing

Calling this method generates the following auditing event.

vmware.directorsite.delete

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Example request

curl -X DELETE   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	deleteDirectorSiteOptions := vmwareService.NewDeleteDirectorSiteOptions(
		"site_id",
	)
	deleteDirectorSiteOptions.SetAcceptLanguage("en-us")
	deleteDirectorSiteOptions.SetXGlobalTransactionID("transaction1")

	directorSite, response, err := vmwareService.DeleteDirectorSite(deleteDirectorSiteOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSite, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSite

A Cloud Director site resource. The Cloud Director site instance is the infrastructure and the associated VMware software stack, which consists of VMware vCenter Server, VMware NSX-T, and VMware Cloud Director.

Status Code

202
OK
400
Bad Request
404
Not found

Example responses

Status 202

{
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid001",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001",
  "id": "directorsiteuuid001",
  "ordered_at": "2022-12-12 12:12:12Z",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "name": "MyInstance",
  "status": "creating",
  "console_connection_type": "private",
  "console_connection_status": "creating",
  "ip_allow_list": [
    "1.1.1.1/24"
  ],
  "type": "multitenant",
  "rhel_vm_activation_key": "xxxxxxxxxxxxxxxxxxx",
  "services": [
    {
      "name": "veeam",
      "id": "ed5372b9-c67a-4b4d-a43f-3ac01a6e191e",
      "provisioned_at": "2022-12-06T20:06:59.137069+00:00",
      "ordered_at": "2022-12-06T20:06:59.137069+00:00",
      "status": "creating",
      "console_url": "https://sdirw.jp-tok.vmware.test.cloud.ibm.com:9443/vCloud/1"
    }
  ],
  "resource_group": {
    "name": "default",
    "id": "a_resource_group_id",
    "crn": "crn:v1:bluemix:public:resource-controller::a/accuntid::resource-group:resourcegroupid"
  },
  "pvdcs": [
    {
      "id": "pvdcuuid001",
      "name": "pvdc-1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001",
      "status": "creating",
      "data_center_name": "dal10",
      "clusters": [
        {
          "id": "clusteruuid001",
          "name": "cluster_1",
          "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid001/pvdcs/pvdcuuid001/clusters/clusteruuid001",
          "status": "creating",
          "data_center_name": "dal10",
          "host_count": 3,
          "file_shares": {
            "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
            "STORAGE_TWO_IOPS_GB": 24000,
            "STORAGE_FOUR_IOPS_GB": 24000,
            "STORAGE_TEN_IOPS_GB": 8000
          },
          "host_profile": "BM_2S_20_CORES_192_GB"
        }
      ],
      "provider_types": [
        {
          "name": "on_demand"
        },
        {
          "name": "reserved"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Enable or disable Veeam on a Cloud Director site.

POST /director_sites/{site_id}/action/enable_veeam

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Request Body

Required*

EnableServicePrototype

Enable or Disable service request body

Examples:

Response

Response Body

ServiceEnabled

Enable Service response for accepted request

Status Code

200
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 200

{
  "message": "The request has been accepted."
}

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Enable or disable VMware Cloud Director Availability (VCDA) on a Cloud Director site.

POST /director_sites/{site_id}/action/enable_vcda

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Request Body

Required*

EnableServicePrototype

Enable or Disable service request body

Examples:

Response

Response Body

ServiceEnabled

Enable Service response for accepted request

Status Code

200
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 200

{
  "message": "The request has been accepted."
}

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Create a VMware Cloud Director Availability (VCDA) connection in the Cloud Director site identified by {site_id}.

POST /director_sites/{site_id}/vcda/connection_endpoints

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Request Body

Required*

VcdaConnectionPrototype

Create VCDA connection request body

Examples:

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	createDirectorSitesVcdaConnectionEndpointsOptions := vmwareService.NewCreateDirectorSitesVcdaConnectionEndpointsOptions(
		"site_id",
		"private",
		"dal10",
	)
	createDirectorSitesVcdaConnectionEndpointsOptions.SetAcceptLanguage("en-us")
	createDirectorSitesVcdaConnectionEndpointsOptions.SetXGlobalTransactionID("transaction1")

	vcdaConnection, response, err := vmwareService.CreateDirectorSitesVcdaConnectionEndpoints(createDirectorSitesVcdaConnectionEndpointsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vcdaConnection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VcdaConnection

Created VCDA connection

Status Code

202
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 202

{
  "name": "Providervdc_1",
  "data_center_name": "dal10",
  "status": "ready_to_use",
  "id": "testx",
  "type": "private",
  "speed": "speed_20g",
  "allow_list": [
    "1.1.1.1"
  ]
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Delete a VMware Cloud Director Availability (VCDA) connection in the Cloud Director site identified by {site_id} and {vcda_connections_id}.

DELETE /director_sites/{site_id}/services/vcda/connection_endpoints/{id}

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
A unique ID for the VCDA connections in the relationship Cloud Director site.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
Example: vcda_connections_id

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	deleteDirectorSitesVcdaConnectionEndpointsOptions := vmwareService.NewDeleteDirectorSitesVcdaConnectionEndpointsOptions(
		"site_id",
		"vcda_connections_id",
	)
	deleteDirectorSitesVcdaConnectionEndpointsOptions.SetAcceptLanguage("en-us")
	deleteDirectorSitesVcdaConnectionEndpointsOptions.SetXGlobalTransactionID("transaction1")

	vcdaConnection, response, err := vmwareService.DeleteDirectorSitesVcdaConnectionEndpoints(deleteDirectorSitesVcdaConnectionEndpointsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vcdaConnection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VcdaConnection

Created VCDA connection

Status Code

202
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 202

{
  "name": "Providervdc_1",
  "data_center_name": "dal10",
  "status": "ready_to_use",
  "id": "testx",
  "type": "private",
  "speed": "speed_20g",
  "allow_list": [
    "1.1.1.1"
  ]
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Update the allowlist for a private connection to a specific VCDA instance.

PATCH /director_sites/{site_id}/services/vcda/connection_endpoints/{id}

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
A unique ID for the VCDA connections in the relationship Cloud Director site.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
Example: vcda_connections_id

Request Body

PrivateConnectionPatch

Data to update a private connection.

Examples:

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	updateDirectorSitesVcdaConnectionEndpointsOptions := vmwareService.NewUpdateDirectorSitesVcdaConnectionEndpointsOptions(
		"site_id",
		"vcda_connections_id",
	)
	updateDirectorSitesVcdaConnectionEndpointsOptions.SetAcceptLanguage("en-us")
	updateDirectorSitesVcdaConnectionEndpointsOptions.SetXGlobalTransactionID("transaction1")

	updatedVcdaConnection, response, err := vmwareService.UpdateDirectorSitesVcdaConnectionEndpoints(updateDirectorSitesVcdaConnectionEndpointsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(updatedVcdaConnection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

UpdatedVcdaConnection

Update private connection

Status Code

202
Task to update the connection created.
400
Bad Request
401
Unauthorized Error
404
Not found

Example responses

Status 202

{
  "id": "9165a9a4-cb70-4248-99ce-661106d89b83",
  "status": "updating"
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Create a VCDA cloud-to-cloud connection in the Cloud Director site identified by {site_id}.

POST /director_sites/{site_id}/services/vcda/c2c_connections

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Request Body

Required*

VcdaC2cPrototype

Create VCDA cloud-to-cloud connection request body.

Examples:

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	createDirectorSitesVcdaC2cConnectionOptions := vmwareService.NewCreateDirectorSitesVcdaC2cConnectionOptions(
		"site_id",
		"dal10",
		"ddirw002-gr80d10vcda",
		"dirw274t02vcda",
		"jp-tok",
	)
	createDirectorSitesVcdaC2cConnectionOptions.SetAcceptLanguage("en-us")
	createDirectorSitesVcdaC2cConnectionOptions.SetXGlobalTransactionID("transaction1")

	vcdaC2c, response, err := vmwareService.CreateDirectorSitesVcdaC2cConnection(createDirectorSitesVcdaC2cConnectionOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vcdaC2c, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VcdaC2c

Response to create cloud-to-cloud connection.

Status Code

202
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 202

{
  "id": "4b8d2641-5e1b-48c4-bd03-dd66edc824d7",
  "status": "creating",
  "peer_offering": "gen2",
  "local_data_center_name": "dal10",
  "local_site_name": "ddirw002-gr80d10vcda",
  "peer_site_name": "dirw274t02vcda",
  "peer_region": "jp-tok",
  "note": "Text of the note..."
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Delete a VCDA cloud-to-cloud connection in the Cloud Director site identified by {site_id}.

DELETE /director_sites/{site_id}/services/vcda/c2c_connections/{id}

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
A unique ID for the cloud-to-cloud connections in the relationship Cloud Director site.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
Example: connection_id

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	deleteDirectorSitesVcdaC2cConnectionOptions := vmwareService.NewDeleteDirectorSitesVcdaC2cConnectionOptions(
		"site_id",
		"connection_id",
	)
	deleteDirectorSitesVcdaC2cConnectionOptions.SetAcceptLanguage("en-us")
	deleteDirectorSitesVcdaC2cConnectionOptions.SetXGlobalTransactionID("transaction1")

	vcdaC2c, response, err := vmwareService.DeleteDirectorSitesVcdaC2cConnection(deleteDirectorSitesVcdaC2cConnectionOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vcdaC2c, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VcdaC2c

Response to create cloud-to-cloud connection.

Status Code

202
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 202

{
  "id": "4b8d2641-5e1b-48c4-bd03-dd66edc824d7",
  "status": "creating",
  "peer_offering": "gen2",
  "local_data_center_name": "dal10",
  "local_site_name": "ddirw002-gr80d10vcda",
  "peer_site_name": "dirw274t02vcda",
  "peer_region": "jp-tok",
  "note": "Text of the note..."
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Update the note in the VCDA cloud-to-cloud connection in the Cloud Director site identified by {site_id}.

PATCH /director_sites/{site_id}/services/vcda/c2c_connections/{id}

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
A unique ID for the cloud-to-cloud connections in the relationship Cloud Director site.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
Example: connection_id

Request Body

Required*

VcdaC2cPatch

Update VCDA cloud-to-cloud connection note.

Examples:

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	updateDirectorSitesVcdaC2cConnectionOptions := vmwareService.NewUpdateDirectorSitesVcdaC2cConnectionOptions(
		"site_id",
		"connection_id",
		"Text of the note...",
	)
	updateDirectorSitesVcdaC2cConnectionOptions.SetAcceptLanguage("en-us")
	updateDirectorSitesVcdaC2cConnectionOptions.SetXGlobalTransactionID("transaction1")

	updatedVcdaC2c, response, err := vmwareService.UpdateDirectorSitesVcdaC2cConnection(updateDirectorSitesVcdaC2cConnectionOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(updatedVcdaC2c, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

UpdatedVcdaC2c

Updated VCDA cloud-to-cloud connection note.

Status Code

200
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 200

{
  "id": "4b8d2641-5e1b-48c4-bd03-dd66edc824d7",
  "note": "New text of the note..."
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Return the details of an OpenID Connect (OIDC) configuration on a Cloud Director site.

GET /director_sites/{site_id}/oidc_configuration

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Auditing

Calling this method generates the following auditing event.

vmware.directorsite-iam.read

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/oidc_configuration'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	getOidcConfigurationOptions := vmwareService.NewGetOidcConfigurationOptions(
		"site_id",
	)
	getOidcConfigurationOptions.SetAcceptLanguage("en-us")

	oidc, response, err := vmwareService.GetOidcConfiguration(getOidcConfigurationOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(oidc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

OIDC

Details of the OIDC configuration on a Cloud Director site.

Status Code

200
The request to get the OIDC configuration is successful.
400
The input data is either incomplete or in the wrong format.
423
The request cannot be completed at this time. Try again later.

Example responses

Status 200

{
  "status": "ready_to_use",
  "last_set_at": "2022-01-01T12:00:00.000Z"
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 423

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Request to configure OpenID Connect (OIDC) on a Cloud Director site.

PUT /director_sites/{site_id}/oidc_configuration

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.account

Auditing

Calling this method generates the following auditing event.

vmware.directorsite-iam.config

Request

Custom Headers

Content-Length
Required*
integer
Size of the message body in bytes.

Allowable values: [0]
Possible values: value = 0
Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Example request

curl -X PUT   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/oidc_configuration'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'   -H 'Content-Length: 0'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	setOidcConfigurationOptions := vmwareService.NewSetOidcConfigurationOptions(
		"site_id",
      int64(0),
	)
	setOidcConfigurationOptions.SetAcceptLanguage("en-us")

	oidc, response, err := vmwareService.SetOidcConfiguration(setOidcConfigurationOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(oidc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

OIDC

Details of the OIDC configuration on a Cloud Director site.

Status Code

202
The request to create an OIDC configuration is accepted.
400
The input data is either incomplete or in the wrong format.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
409
The request cannot be completed because of a conflict.
423
The request cannot be completed at this time. Try again later.

Example responses

Status 202

{
  "status": "pending",
  "last_set_at": "2022-01-01T12:00:00.000Z"
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 409

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 423

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

List the resource pools in a specified Cloud Director site.

GET /director_sites/{site_id}/pvdcs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listDirectorSitesPvdcsOptions := vmwareService.NewListDirectorSitesPvdcsOptions(
		"site_id",
	)
	listDirectorSitesPvdcsOptions.SetAcceptLanguage("en-us")
	listDirectorSitesPvdcsOptions.SetXGlobalTransactionID("transaction1")

	pvdcCollection, response, err := vmwareService.ListDirectorSitesPvdcs(listDirectorSitesPvdcsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(pvdcCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

PVDCCollection

Return all resource pool instances.

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "pvdcs": [
    {
      "id": "pvdcuuid004",
      "name": "pvdc-1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid004",
      "data_center_name": "dal10",
      "status": "creating",
      "clusters": [
        {
          "id": "clusteruuid005",
          "name": "cluster_1",
          "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid004/clusters/clusteruuid005",
          "status": "creating",
          "data_center_name": "dal10",
          "host_count": 3,
          "file_shares": {
            "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
            "STORAGE_TWO_IOPS_GB": 24000,
            "STORAGE_FOUR_IOPS_GB": 24000,
            "STORAGE_TEN_IOPS_GB": 8000
          },
          "host_profile": "BM_2S_20_CORES_192_GB"
        }
      ],
      "provider_types": [
        {
          "name": "on_demand"
        },
        {
          "name": "reserved"
        }
      ]
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Create an instance of a resource pool with specified configurations. The Cloud Director site instance is the infrastructure and associated VMware software stack, which consists of VMware vCenter Server, VMware NSX-T, and VMware Cloud Director. VMware platform management and operations are performed with Cloud Director. The minimum initial order size is 2 hosts (2-Socket 32 Cores, 192 GB RAM) with 24 TB of 2.0 IOPS/GB storage.

POST /director_sites/{site_id}/pvdcs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.create

Auditing

Calling this method generates the following auditing event.

vmware.directorsite-pvdc.create

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id

Request Body

Required*

PVDCPrototype

VMware resource pool order information.

Examples:

Example request

curl -X POST   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "name": "pvdc-1",
    "data_center_name": "dal10",
    "clusters": [
      {
        "name": "cluster_1",
        "host_count": 3,
        "file_shares": {
          "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
          "STORAGE_TWO_IOPS_GB": 24000,
          "STORAGE_FOUR_IOPS_GB": 24000,
          "STORAGE_TEN_IOPS_GB": 8000
          },
        "host_profile": "BM_2S_20_CORES_192_GB"
        }
      ]
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/go-sdk-core/v5/core"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	fileSharesPrototypeModel := &vmwarev1.FileSharesPrototype{}

	clusterPrototypeModel := &vmwarev1.ClusterPrototype{
		Name:        core.StringPtr("cluster_1"),
		HostCount:   core.Int64Ptr(int64(2)),
		HostProfile: core.StringPtr("BM_2S_20_CORES_192_GB"),
		FileShares:  fileSharesPrototypeModel,
	}

	createDirectorSitesPvdcsOptions := vmwareService.NewCreateDirectorSitesPvdcsOptions(
		"site_id",
		"pvdc-1",
		"dal10",
		[]vmwarev1.ClusterPrototype{*clusterPrototypeModel},
	)
	createDirectorSitesPvdcsOptions.SetAcceptLanguage("en-us")
	createDirectorSitesPvdcsOptions.SetXGlobalTransactionID("transaction1")

	pvdc, response, err := vmwareService.CreateDirectorSitesPvdcs(createDirectorSitesPvdcsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(pvdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

PVDC

VMware resource pool information.

Status Code

202
OK
400
Bad Request
401
Unauthorized

Example responses

Status 202

{
  "id": "pvdcuuid003",
  "name": "pvdc-1",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid003",
  "data_center_name": "dal10",
  "status": "creating",
  "clusters": [
    {
      "id": "clusteruuid004",
      "name": "cluster_1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid003/clusters/clusteruuid004",
      "status": "creating",
      "data_center_name": "dal10",
      "host_count": 3,
      "file_shares": {
        "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
        "STORAGE_TWO_IOPS_GB": 24000,
        "STORAGE_FOUR_IOPS_GB": 24000,
        "STORAGE_TEN_IOPS_GB": 8000
      },
      "host_profile": "BM_2S_20_CORES_192_GB"
    }
  ],
  "provider_types": [
    {
      "name": "on_demand"
    },
    {
      "name": "reserved"
    }
  ]
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Get the specified resource pools in a specified Cloud Director site.

GET /director_sites/{site_id}/pvdcs/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc-id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/go-sdk-core/v5/core"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	getDirectorSitesPvdcsOptions := vmwareService.NewGetDirectorSitesPvdcsOptions(
		"site_id",
		"pvdc_id",
	)
	getDirectorSitesPvdcsOptions.SetAcceptLanguage("en-us")
	getDirectorSitesPvdcsOptions.SetXGlobalTransactionID("transaction1")

	pvdc, response, err := vmwareService.GetDirectorSitesPvdcs(getDirectorSitesPvdcsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(pvdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

PVDC

VMware resource pool information.

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "id": "pvdcuuid003",
  "name": "pvdc-1",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid003",
  "data_center_name": "dal10",
  "status": "creating",
  "clusters": [
    {
      "id": "clusteruuid004",
      "name": "cluster_1",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid003/clusters/clusteruuid004",
      "status": "creating",
      "data_center_name": "dal10",
      "host_count": 3,
      "file_shares": {
        "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
        "STORAGE_TWO_IOPS_GB": 24000,
        "STORAGE_FOUR_IOPS_GB": 24000,
        "STORAGE_TEN_IOPS_GB": 8000
      },
      "host_profile": "BM_2S_20_CORES_192_GB"
    }
  ],
  "provider_types": [
    {
      "name": "on_demand"
    },
    {
      "name": "reserved"
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

List all VMware clusters of a Cloud Director site instance by specifying the instance ID.

GET /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
pvdc_id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc_id>/clusters'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listDirectorSitesPvdcsClustersOptions := vmwareService.NewListDirectorSitesPvdcsClustersOptions(
		"site_id",
		"pvdc_id",
	)
	listDirectorSitesPvdcsClustersOptions.SetAcceptLanguage("en-us")
	listDirectorSitesPvdcsClustersOptions.SetXGlobalTransactionID("transaction1")

	clusterCollection, response, err := vmwareService.ListDirectorSitesPvdcsClusters(listDirectorSitesPvdcsClustersOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(clusterCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

ClusterCollection

Return all clusters instances.

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "clusters": [
    {
      "id": "clusteruuid008",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid005/pvdcs/pvdcuuid/clusters/clusteruuid008",
      "data_center_name": "dal10",
      "director_site": {
        "id": "directorsiteuuid005",
        "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid005",
        "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid005"
      },
      "ordered_at": "2022-12-12 12:12:12Z",
      "provisioned_at": "2022-12-12 12:12:12Z",
      "instance_deleted": "2022-12-12 12:12:12Z",
      "host_count": 4,
      "name": "Cluster instance Name",
      "status": "creating",
      "host_profile": "bx2-metal-20x128",
      "billing_plan": "monthly",
      "storage_type": "nfs",
      "file_shares": {
        "STORAGE_POINT_TWO_FIVE_IOPS_GB": 24000,
        "STORAGE_TWO_IOPS_GB": 24000,
        "STORAGE_FOUR_IOPS_GB": 24000,
        "STORAGE_TEN_IOPS_GB": 24000
      }
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Create a VMware cluster under a specified resource pool in a Cloud Director site instance.

POST /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.create

Auditing

Calling this method generates the following auditing event.

vmware.directorsite-cluster.create

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
pvdc_id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Request Body

Required*

ClusterPrototype

VMware Cluster order information. Clusters form VMware workload availability boundaries.

Examples:

Example request

curl -X POST   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc_id>/clusters'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "name": "cluster_1",
    "host_count": 3,
    "file_shares": {
      "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
      "STORAGE_TWO_IOPS_GB": 24000,
      "STORAGE_FOUR_IOPS_GB": 24000,
      "STORAGE_TEN_IOPS_GB": 8000
      },
    "host_profile": "BM_2S_20_CORES_192_GB"
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	fileSharesPrototypeModel := &vmwarev1.FileSharesPrototype{}

	createDirectorSitesPvdcsClustersOptions := vmwareService.NewCreateDirectorSitesPvdcsClustersOptions(
		"site_id",
		"pvdc_id",
		"cluster_1",
		int64(2),
		"BM_2S_20_CORES_192_GB",
		fileSharesPrototypeModel,
	)
	createDirectorSitesPvdcsClustersOptions.SetAcceptLanguage("en-us")
	createDirectorSitesPvdcsClustersOptions.SetXGlobalTransactionID("transaction1")

	cluster, response, err := vmwareService.CreateDirectorSitesPvdcsClusters(createDirectorSitesPvdcsClustersOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(cluster, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

Cluster

A cluster resource

Status Code

202
Ok
400
Bad Request
401
Unauthorized_Error

Example responses

Status 202

{
  "id": "clusteruuid006",
  "data_center_name": "dal10",
  "director_site": {
    "id": "directorsiteuuid003",
    "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid003",
    "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid003"
  },
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid003/pvdcs/pvdcuuid/clusters/clusteruuid006",
  "ordered_at": "2022-12-12 12:12:12Z",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "instance_deleted": "2022-12-12 12:12:12Z",
  "host_count": 4,
  "name": "Cluster name",
  "status": "creating",
  "host_profile": "bx2-metal-20x128",
  "billing_plan": "monthly",
  "storage_type": "nfs",
  "file_shares": {
    "STORAGE_POINT_TWO_FIVE_IOPS_GB": 24000,
    "STORAGE_TWO_IOPS_GB": 24000,
    "STORAGE_FOUR_IOPS_GB": 24000,
    "STORAGE_TEN_IOPS_GB": 24000
  }
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Get a specific VMware cluster from the resource pool in a Cloud Director site instance.

GET /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
The cluster to query.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: cluster_id
pvdc_id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/{pvdc_id}/clusters/<cluster_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	getDirectorInstancesPvdcsClusterOptions := vmwareService.NewGetDirectorInstancesPvdcsClusterOptions(
		"site_id",
		"cluster_id",
		"pvdc_id",
	)
	getDirectorInstancesPvdcsClusterOptions.SetAcceptLanguage("en-us")
	getDirectorInstancesPvdcsClusterOptions.SetXGlobalTransactionID("transaction1")

	cluster, response, err := vmwareService.GetDirectorInstancesPvdcsCluster(getDirectorInstancesPvdcsClusterOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(cluster, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

Cluster

A cluster resource

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "id": "clusteruuid006",
  "data_center_name": "dal10",
  "director_site": {
    "id": "directorsiteuuid003",
    "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::directorsite:directorsiteuuid003",
    "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid003"
  },
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid003/pvdcs/pvdcuuid/clusters/clusteruuid006",
  "ordered_at": "2022-12-12 12:12:12Z",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "instance_deleted": "2022-12-12 12:12:12Z",
  "host_count": 4,
  "name": "Cluster name",
  "status": "creating",
  "host_profile": "bx2-metal-20x128",
  "billing_plan": "monthly",
  "storage_type": "nfs",
  "file_shares": {
    "STORAGE_POINT_TWO_FIVE_IOPS_GB": 24000,
    "STORAGE_TWO_IOPS_GB": 24000,
    "STORAGE_FOUR_IOPS_GB": 24000,
    "STORAGE_TEN_IOPS_GB": 24000
  }
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Delete a cluster from a resource pool in a Cloud Director site instance by specifying the instance ID.

DELETE /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.delete

Auditing

Calling this method generates the following auditing event.

vmware.directorsite-cluster.delete

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
The cluster to query.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: cluster_id
pvdc_id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Example request

curl -X DELETE   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc_id>/clusters/<cluster_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	deleteDirectorSitesPvdcsClusterOptions := vmwareService.NewDeleteDirectorSitesPvdcsClusterOptions(
		"site_id",
		"cluster_id",
		"pvdc_id",
	)
	deleteDirectorSitesPvdcsClusterOptions.SetAcceptLanguage("en-us")
	deleteDirectorSitesPvdcsClusterOptions.SetXGlobalTransactionID("transaction1")

	clusterSummary, response, err := vmwareService.DeleteDirectorSitesPvdcsCluster(deleteDirectorSitesPvdcsClusterOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(clusterSummary, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

ClusterSummary

VMware Cluster basic information.

Status Code

202
OK
400
Bad Request
404
Not found

Example responses

Status 202

{
  "id": "clusteruuid003",
  "name": "cluster_1",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid/pvdcs/pvdcuuid/clusters/clusteruuid003",
  "status": "creating",
  "data_center_name": "dal10",
  "host_count": 3,
  "file_shares": {
    "STORAGE_POINT_TWO_FIVE_IOPS_GB": 0,
    "STORAGE_TWO_IOPS_GB": 24000,
    "STORAGE_FOUR_IOPS_GB": 24000,
    "STORAGE_TEN_IOPS_GB": 8000
  },
  "host_profile": "BM_2S_20_CORES_192_GB"
}
Copy to clipboard

Status 400

{
  "trace": "trace id",
  "status_code": 400,
  "errors": [
    {
      "code": "m010_cannot_delete_workload_domain",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b is already deleting."
    }
  ]
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

Update the number of hosts or file storage shares of a specific cluster in a specific Cloud Director site instance. VMware clusters must have between [2-25] hosts.

PATCH /director_sites/{site_id}/pvdcs/{pvdc_id}/clusters/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.update

Auditing

Calling this method generates the following auditing events, depending on any listed conditions.

The event that is generated depends on whether the count passed in the request is larger than the existing number of hosts.

vmware.directorsite-host.add
Generated if count is larger than existing number of hosts.
vmware.directorsite-host.remove
Generated if count is less than existing number of hosts.
vmware.directorsite-nfs-storage.add
Generated if the storage size that is passed in the request is larger than the current storage size.
vmware.directorsite-nfs-storage.remove
Generated if the storage size that is passed in the request is smaller than the current storage size.

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

site_id
Required*
string
A unique ID for the Cloud Director site in which the virtual data center was created.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: site_id
id
Required*
string
The cluster to query.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: cluster_id
pvdc_id
Required*
string
A unique ID for the resource pool in a Cloud Director site.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: pvdc_id

Request Body

Required*

application/merge-patch+jsonClusterPatch

The cluster patch. Currently, specifying both file_shares and host_count in one call is not supported.

Examples:

Example request for update host count

curl -X PATCH   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc_id>/clusters/<cluster_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "host_count": 2
    }'
Copy to clipboard

Example request for update file shares

curl -X PATCH   'https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/<site_id>/pvdcs/<pvdc_id>/clusters/<cluster_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "file_shares": {
      "STORAGE_TWO_IOPS_GB": 24000,
      "STORAGE_FOUR_IOPS_GB": 48000,
      "STORAGE_TEN_IOPS_GB": 72000
      }
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	clusterPatchModel := &vmwarev1.ClusterPatch{}
	clusterPatchModelAsPatch, asPatchErr := clusterPatchModel.AsPatch()

	updateDirectorSitesPvdcsClusterOptions := vmwareService.NewUpdateDirectorSitesPvdcsClusterOptions(
		"site_id",
		"cluster_id",
		"pvdc_id",
		clusterPatchModelAsPatch,
	)
	updateDirectorSitesPvdcsClusterOptions.SetAcceptLanguage("en-us")
	updateDirectorSitesPvdcsClusterOptions.SetXGlobalTransactionID("transaction1")

	updateCluster, response, err := vmwareService.UpdateDirectorSitesPvdcsCluster(updateDirectorSitesPvdcsClusterOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(updateCluster, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

UpdateCluster

Response of cluster update

Status Code

200
OK
401
Unauthorized
404
Not found

Example responses

Status 200

{
  "id": "3b51c519-de2a-47d3-8a69-edf70e52097b",
  "director_site": {
    "id": "4b8d2641-5e1b-48c4-bd03-dd66edc824d8",
    "crn": "crn:v1:staging:public:vmware:us-south:a/3886cae42be94f6a89c4b7c282708f34::directorsite: 4b8d2641-5e1b-48c4-bd03-dd66edc824d8",
    "href": "https://api.us-south.vmware.cloud.ibm.com/director_sites/4b8d2641-5e1b-48c4-bd03-dd66edc824d8"
  },
  "ordered_at": "2021-08-26T23:15:55.682215+00:00",
  "provisioned_at": "2021-08-26T23:15:55.682215+00:00",
  "host_count": 4,
  "name": "cluster_instance_1",
  "status": "creating",
  "data_center_name": "dal10",
  "deduplication_and_compression": true,
  "host_profile": "BM_2S_20_CORES_192_GB",
  "billing_plan": "hourly",
  "storage_type": "vsan",
  "file_shares": {
    "STORAGE_POINT_TWO_FIVE_IOPS_GB": 200,
    "STORAGE_TWO_IOPS_GB": 24000,
    "STORAGE_FOUR_IOPS_GB": 3,
    "STORAGE_TEN_IOPS_GB": 1
  },
  "message": "The request has been accepted.",
  "operation_id": "4b8d2641-5e1b-48c4-bd03-dd66edc824d7",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/director_sites/directorsiteuuid003/pvdcs/pvdcuuid/clusters/clusteruuid006",
  "instance_deleted": "2022-12-12 12:12:12Z"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 404

{
  "trace": "a736a57f-0584-474f-8411-55dc7d9dc811",
  "status_code": 404,
  "errors": [
    {
      "code": "m013_no_datacenters_found",
      "message": "The requested Cloud Director site instance acfb9e70-99ac-47fb-9fbc-38ce7f716e5b was not found."
    }
  ]
}
Copy to clipboard

List all IBM Cloud regions enabled for users to create a new Cloud Director site instance.

GET /director_site_regions

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_site_regions'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listDirectorSiteRegionsOptions := vmwareService.NewListDirectorSiteRegionsOptions()
	listDirectorSiteRegionsOptions.SetAcceptLanguage("en-us")
	listDirectorSiteRegionsOptions.SetXGlobalTransactionID("transaction1")

	directorSiteRegionCollection, response, err := vmwareService.ListDirectorSiteRegions(listDirectorSiteRegionsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSiteRegionCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSiteRegionCollection

Success. The request was successfully processed.

Status Code

200
Enabled regions found.

Example responses

Status 200

{
  "director_site_regions": [
    {
      "name": "us-south",
      "data_centers": [
        {
          "display_name": "Dallas 10",
          "name": "dal10",
          "uplink_speed": "25GB"
        },
        {
          "display_name": "Dallas 12",
          "name": "dal12",
          "uplink_speed": "25GB"
        },
        {
          "display_name": "Dallas 13",
          "name": "dal13",
          "uplink_speed": "25GB"
        }
      ],
      "endpoint": "https://us-south.managed.vmware.cloud.ibm.com"
    }
  ]
}
Copy to clipboard

Retrieve a collection of multitenant Cloud Director sites.

GET /multitenant_director_sites

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/multitenant_director_sites'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listMultitenantDirectorSitesOptions := vmwareService.NewListMultitenantDirectorSitesOptions()
	listMultitenantDirectorSitesOptions.SetAcceptLanguage("en-us")
	listMultitenantDirectorSitesOptions.SetXGlobalTransactionID("transaction1")

	multitenantDirectorSiteCollection, response, err := vmwareService.ListMultitenantDirectorSites(listMultitenantDirectorSitesOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(multitenantDirectorSiteCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

MultitenantDirectorSiteCollection

List of multitenant Cloud Director sites.

Status Code

200
Multitenant Cloud Director sites found.

Example responses

Status 200

{
  "multitenant_director_sites": [
    {
      "display_name": "Dallas Multitenant",
      "name": "dal_multi-tenant",
      "id": "123456789",
      "private_only": false,
      "services": [
        "veeam",
        "vcda"
      ],
      "region": "us-south",
      "pvdcs": [
        {
          "name": "Pvdc_1",
          "id": "123456789",
          "private_only": false,
          "data_center_name": "dal12",
          "provider_types": [
            {
              "name": "on_demand"
            },
            {
              "name": "reserved"
            }
          ]
        }
      ]
    }
  ]
}
Copy to clipboard

List available host profiles that can be used when you create a Cloud Director site instance. IBM Cloud offers several different host types. Typically, the host type is selected based on the properties of the workload to be run in the VMware cluster.

GET /director_site_host_profiles

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.infrastructure.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/director_site_host_profiles'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listDirectorSiteHostProfilesOptions := vmwareService.NewListDirectorSiteHostProfilesOptions()
	listDirectorSiteHostProfilesOptions.SetAcceptLanguage("en-us")
	listDirectorSiteHostProfilesOptions.SetXGlobalTransactionID("transaction1")

	directorSiteHostProfileCollection, response, err := vmwareService.ListDirectorSiteHostProfiles(listDirectorSiteHostProfilesOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(directorSiteHostProfileCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

DirectorSiteHostProfileCollection

Success. The request was successfully processed.

Status Code

200
Host profiles found.

Example responses

Status 200

{
  "director_site_host_profiles": [
    {
      "cpu": 32,
      "family": "cascade",
      "features": [
        "UEFI",
        "NVMe"
      ],
      "id": "BM_2S_32_CORES_192_GB",
      "manufacturer": "intel",
      "processor": "Dual Intel 5218 Xeon",
      "ram": 192,
      "socket": 2,
      "speed": "2.3 GHz"
    },
    {
      "cpu": 48,
      "family": "cascade",
      "features": [
        "UEFI",
        "NVMe"
      ],
      "id": "BM_2S_48_CORES_384_GB",
      "manufacturer": "intel",
      "processor": "Dual Intel 8260 Xeon",
      "ram": 384,
      "socket": 2,
      "speed": "2.4 GHz"
    },
    {
      "cpu": 48,
      "family": "cascade",
      "features": [
        "UEFI",
        "NVMe"
      ],
      "id": "BM_2S_48_CORES_768_GB",
      "manufacturer": "intel",
      "processor": "Dual Intel 8260 Xeon",
      "ram": 768,
      "socket": 2,
      "speed": "2.4 GHz"
    },
    {
      "cpu": 96,
      "family": "cascade",
      "features": [
        "UEFI",
        "NVMe"
      ],
      "id": "BM_4S_96_CORES_1536_GB",
      "manufacturer": "intel",
      "processor": "Quad Intel 8260 Xeon",
      "ram": 1536,
      "socket": 4,
      "speed": "2.4 GHz"
    }
  ]
}
Copy to clipboard

List all virtual data centers (VDCs) that user has access to in the cloud account.

GET /vdcs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	listVdcsOptions := vmwareService.NewListVdcsOptions()
	listVdcsOptions.SetAcceptLanguage("en-us")

	vdcCollection, response, err := vmwareService.ListVdcs(listVdcsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vdcCollection, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VDCCollection

A list of virtual data centers (VDCs).

Status Code

200
The request to list virtual data centers (VDCs) completed successfully.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.

Example responses

Status 200

{
  "vdcs": [
    {
      "id": "id",
      "provisioned_at": "2022-12-12 12:12:12Z",
      "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::vdc:vdcuuid",
      "href": "https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/id",
      "director_site": {
        "id": "directorsiteuuid010",
        "pvdc": {
          "id": "pvdcuuid010",
          "provider_type": {
            "name": "paygo"
          }
        },
        "url": "https://sdaldir04.vmware-solutions.cloud.ibm.com/tenant/org"
      },
      "edges": [
        {
          "id": "edge-id-1",
          "public_ips": [
            "192.168.0.2",
            "192.168.0.3",
            "192.168.0.4",
            "192.168.0.5",
            "192.168.0.6",
            "192.168.0.7"
          ],
          "private_ips": [],
          "size": "medium",
          "status": "ready_to_use",
          "transit_gateways": [
            {
              "id": "id",
              "status": "ready_to_use",
              "region": "us-south",
              "connections": [
                {
                  "name": "connection",
                  "transit_gateway_connection_name": "transit_gateway_connection",
                  "local_gateway_ip": "192.168.1.1",
                  "remote_gateway_ip": "192.168.1.2",
                  "local_tunnel_ip": "192.168.2.1",
                  "remote_tunnel_ip": "192.168.2.2",
                  "local_bgp_asn": 987654321,
                  "remote_bgp_asn": 987654321,
                  "status": "ready_to_use",
                  "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
                  "network_type": "unbound_gre_tunnel",
                  "base_network_type": "classic",
                  "zone": "us-south-1"
                }
              ]
            }
          ],
          "type": "performance",
          "version": "2.0",
          "private_only": false
        }
      ],
      "status_reasons": [],
      "name": "vdc",
      "ordered_at": "2022-12-12 12:12:12Z",
      "org_href": "https://api.us-south.vmware.cloud.ibm.com/api/org/id",
      "org_name": "org",
      "rhel_activation_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
      "resource_group": {
        "id": "default"
      },
      "status": "ready_to_use",
      "type": "single_tenant",
      "fast_provisioning_enabled": false,
      "rhel_byol": false,
      "windows_byol": false
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Create a virtual data center (VDC) with specified configurations.

POST /vdcs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.create

Auditing

Calling this method generates the following auditing event.

vmware.vdc.create

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Request Body

Required*

VDCPrototype

Information required to create a virtual data center (VDC).

Examples:

Example request (Use quotation marks for URL with parameters)

curl -X POST   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'   -d '{
    "edge": {
      "size": "medium",
      "type": "performance"
      },
    "name": "sampleVDC",
    "fast_provisioning_enabled": false,
    "director_site": {
      "id": "directorsiteuuid",
      "pvdc": {
        "id": "pvdc_uuid"
        }
      }
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/go-sdk-core/v5/core"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	directorSitePvdcModel := &vmwarev1.DirectorSitePVDC{
		ID: core.StringPtr("pvdc_id"),
	}

	vdcDirectorSitePrototypeModel := &vmwarev1.VDCDirectorSitePrototype{
		ID:   core.StringPtr("site_id"),
		Pvdc: directorSitePvdcModel,
	}

	createVdcOptions := vmwareService.NewCreateVdcOptions(
		"sampleVDC",
		vdcDirectorSitePrototypeModel,
	)
	createVdcOptions.SetAcceptLanguage("en-us")

	vdc, response, err := vmwareService.CreateVdc(createVdcOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VDC

A VMware virtual data center (VDC). VMware VDCs are used to deploy and run VMware virtualized networking and run VMware workloads. VMware VDCs form loose boundaries of networking and workload where networking and workload can be shared or optionally isolated between VDCs. You can deploy one or more VDCs in an instance except when you are using the minimal instance configuration, which consists of 2 hosts (2-Socket 32 Cores, 192 GB RAM). With the minimal instance configuration, you can start with just one VDC and a performance network edge of medium size until additional hosts are added to the cluster.

Status Code

202
The request to create a virtual data center (VDC) is accepted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 202

{
  "id": "id",
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::vdc:vdcuuid",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/id",
  "director_site": {
    "id": "directorsiteuuid007",
    "pvdc": {
      "id": "pvdcuuid007",
      "provider_type": {
        "name": "paygo"
      }
    },
    "url": "https://sdaldir04.vmware-solutions.cloud.ibm.com/tenant/org"
  },
  "edges": [],
  "status_reasons": [],
  "name": "vdc",
  "ordered_at": "2022-12-12 12:12:12Z",
  "org_href": "https://api.us-south.vmware.cloud.ibm.com/api/org/id",
  "org_name": "org",
  "rhel_activation_key": "xxxxxxx-xxx-xxxx-xxxx-xxxxxxxxxx",
  "resource_group": {
    "id": "default"
  },
  "status": "creating",
  "type": "single_tenant",
  "fast_provisioning_enabled": false,
  "rhel_byol": false,
  "windows_byol": false
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Get details about a virtual data center (VDC) by specifying the VDC ID.

GET /vdcs/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.view

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

id
Required*
string
A unique ID for a specified virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id

Example request

curl -X GET   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	getVdcOptions := vmwareService.NewGetVdcOptions(
		"vdc_id",
	)
	getVdcOptions.SetAcceptLanguage("en-us")

	vdc, response, err := vmwareService.GetVdc(getVdcOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VDC

A VMware virtual data center (VDC). VMware VDCs are used to deploy and run VMware virtualized networking and run VMware workloads. VMware VDCs form loose boundaries of networking and workload where networking and workload can be shared or optionally isolated between VDCs. You can deploy one or more VDCs in an instance except when you are using the minimal instance configuration, which consists of 2 hosts (2-Socket 32 Cores, 192 GB RAM). With the minimal instance configuration, you can start with just one VDC and a performance network edge of medium size until additional hosts are added to the cluster.

Status Code

200
The request to get a virtual data center (VDC) completed successfully.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 200

{
  "id": "id",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::vdc:vdcuuid",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/id",
  "director_site": {
    "id": "directorsiteuuid008",
    "pvdc": {
      "id": "pvdcuuid008",
      "provider_type": {
        "name": "paygo"
      }
    },
    "url": "https://sdaldir04.vmware-solutions.cloud.ibm.com/tenant/org"
  },
  "edges": [
    {
      "id": "edge-id-1",
      "public_ips": [
        "192.168.0.2",
        "192.168.0.3",
        "192.168.0.4",
        "192.168.0.5",
        "192.168.0.6",
        "192.168.0.7"
      ],
      "private_ips": [],
      "size": "medium",
      "status": "ready_to_use",
      "transit_gateways": [
        {
          "id": "id",
          "region": "us-south",
          "status": "ready_to_use",
          "connections": [
            {
              "name": "connection",
              "transit_gateway_connection_name": "transit_gateway_connection",
              "local_gateway_ip": "192.168.1.1",
              "remote_gateway_ip": "192.168.1.2",
              "local_tunnel_ip": "192.168.2.1",
              "remote_tunnel_ip": "192.168.2.2",
              "local_bgp_asn": 987654321,
              "remote_bgp_asn": 987654321,
              "status": "ready_to_use",
              "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
              "network_type": "unbound_gre_tunnel",
              "base_network_type": "classic",
              "zone": "us-south-1"
            }
          ]
        }
      ],
      "type": "performance",
      "version": "2.0",
      "private_only": false
    }
  ],
  "status_reasons": [],
  "name": "vdc",
  "ordered_at": "2022-12-12 12:12:12Z",
  "org_href": "https://api.us-south.vmware.cloud.ibm.com/api/org/id",
  "org_name": "org",
  "rhel_activation_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "resource_group": {
    "id": "resourcegroupuuid008"
  },
  "status": "ready_to_use",
  "type": "single_tenant",
  "fast_provisioning_enabled": false,
  "rhel_byol": false,
  "windows_byol": false
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Delete a virtual data center (VDC) by specifying the VDC ID.

DELETE /vdcs/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.delete

Auditing

Calling this method generates the following auditing event.

vmware.vdc.delete

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

id
Required*
string
A unique ID for a specified virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id

Example request

curl -X DELETE   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>'   -H 'authorization: Bearer <IAM_token>'   -H 'Content-Type:application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	deleteVdcOptions := vmwareService.NewDeleteVdcOptions(
		"vdc_id",
	)
	deleteVdcOptions.SetAcceptLanguage("en-us")

	vdc, response, err := vmwareService.DeleteVdc(deleteVdcOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VDC

A VMware virtual data center (VDC). VMware VDCs are used to deploy and run VMware virtualized networking and run VMware workloads. VMware VDCs form loose boundaries of networking and workload where networking and workload can be shared or optionally isolated between VDCs. You can deploy one or more VDCs in an instance except when you are using the minimal instance configuration, which consists of 2 hosts (2-Socket 32 Cores, 192 GB RAM). With the minimal instance configuration, you can start with just one VDC and a performance network edge of medium size until additional hosts are added to the cluster.

Status Code

202
The request to delete a virtual data center (VDC) is accepted.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 202

{
  "id": "id",
  "provisioned_at": "2022-12-12 12:12:12Z",
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/accuntid::vdc:vdcuuid",
  "deleted_at": "2022-01-02 12:00:00+00",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/id",
  "director_site": {
    "id": "directorsiteuuid009",
    "pvdc": {
      "id": "pvdcuuid009",
      "provider_type": {
        "name": "paygo"
      }
    },
    "url": "https://sdaldir04.vmware-solutions.cloud.ibm.com/tenant/org"
  },
  "edges": [
    {
      "id": "edge-id-1",
      "public_ips": [
        "192.168.0.2",
        "192.168.0.3",
        "192.168.0.4",
        "192.168.0.5",
        "192.168.0.6",
        "192.168.0.7"
      ],
      "private_ips": [],
      "size": "medium",
      "status": "ready_to_use",
      "transit_gateways": [],
      "type": "performance",
      "version": "1.0",
      "private_only": false
    }
  ],
  "status_reasons": [],
  "name": "vdc",
  "ordered_at": "2022-12-12 12:12:12Z",
  "org_href": "https://api.us-south.vmware.cloud.ibm.com/api/org/id",
  "org_name": "org",
  "resource_group": {
    "id": "default"
  },
  "rhel_activation_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "deleting",
  "type": "single_tenant",
  "fast_provisioning_enabled": false,
  "rhel_byol": false,
  "windows_byol": false
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Update a virtual data center with the specified ID.

PATCH /vdcs/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.update

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

id
Required*
string
A unique ID for a specified virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id

Request Body

Required*

application/merge-patch+jsonVDCPatch

Information required to update a virtual data center (VDC).

Example request

curl -X PATCH   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'   -d '{
    "fast_provisioning_enabled": true
    }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	vdcPatchModel := &vmwarev1.VDCPatch{}
	vdcPatchModelAsPatch, asPatchErr := vdcPatchModel.AsPatch()

	updateVdcOptions := vmwareService.NewUpdateVdcOptions(
		"vdc_id",
		vdcPatchModelAsPatch,
	)
	updateVdcOptions.SetAcceptLanguage("en-us")

	vdc, response, err := vmwareService.UpdateVdc(updateVdcOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(vdc, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

VDC

A VMware virtual data center (VDC). VMware VDCs are used to deploy and run VMware virtualized networking and run VMware workloads. VMware VDCs form loose boundaries of networking and workload where networking and workload can be shared or optionally isolated between VDCs. You can deploy one or more VDCs in an instance except when you are using the minimal instance configuration, which consists of 2 hosts (2-Socket 32 Cores, 192 GB RAM). With the minimal instance configuration, you can start with just one VDC and a performance network edge of medium size until additional hosts are added to the cluster.

Status Code

202
The request to update a virtual data center (VDC) is accepted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.
423
The request cannot be completed at this time. Try again later.

Example responses

Status 202

{
  "id": "id",
  "crn": "crn:v1:bluemix:public:vmware:us-south:a/account_id::vdc:id",
  "href": "https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/id",
  "director_site": {
    "ha": "compute_only",
    "id": "12345678-9abc-defg-ijkl-mnopqrstuvwx",
    "pvdc": {
      "id": "12345678-9abc-defg-ijkl-mnopqrstuvwx",
      "provider_type": {
        "name": "paygo"
      }
    },
    "url": "https://sdaldir04.vmware-solutions.cloud.ibm.com/tenant/org"
  },
  "edges": [
    {
      "id": "edge-id-1",
      "public_ips": [
        "192.168.0.2",
        "192.168.0.3",
        "192.168.0.4",
        "192.168.0.5",
        "192.168.0.6",
        "192.168.0.7"
      ],
      "private_ips": [],
      "size": "medium",
      "status": "ready_to_use",
      "type": "performance",
      "transit_gateways": [],
      "version": "1.0",
      "private_only": false
    }
  ],
  "status_reasons": [],
  "name": "vdc",
  "ordered_at": "2022-01-01 12:00:00+00",
  "org_href": "https://api.us-south.vmware.cloud.ibm.com/api/org/id",
  "org_name": "org",
  "provisioned_at": "2022-01-01 12:00:00+00",
  "resource_group": {
    "id": "default"
  },
  "rhel_activation_key": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx",
  "status": "modifying",
  "type": "single_tenant",
  "fast_provisioning_enabled": false,
  "rhel_byol": false,
  "windows_byol": false
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 423

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Add IBM Transit Gateway connections to an edge and virtual data center.

PUT /vdcs/{vdc_id}/edges/{edge_id}/transit_gateways/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.update

Auditing

Calling this method generates the following auditing event.

vmware.vdc.update

Request

Custom Headers

Content-Length
Required*
integer
Size of the message body in bytes.

Allowable values: [0]
Possible values: value = 0
Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

vdc_id
Required*
string
A unique ID for a virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id
edge_id
Required*
string
A unique ID for an edge.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: edge_id
id
Required*
string
A unique ID for an IBM Transit Gateway.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: transit_gateway_id

Request Body

TransitGatewayRegion

The region where the IBM Transit Gateway is deployed. If not specified, the IBM Transit Gateway is assumed to be in the same region as the Cloud Director site where the VDC is deployed.

Example request where the IBM Transit Gateway is deployed in the same region as the Cloud Director site where the virtual data center is deployed

curl -X PUT   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>/edges/<edge_id>/transit_gateways/<transit_gateway_id>'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'   -H 'Content-Length: 0'
Copy to clipboard

Example request where the IBM Transit Gateway is deployed in a different region than the Cloud Director site where the VDC is deployed

curl -X PUT   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>/edges/<edge_id>/transit_gateways/<transit_gateway_id>'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'   -d '{
    "region": "jp-tok"
  }'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	addTransitGatewayConnectionsOptions := vmwareService.NewAddTransitGatewayConnectionsOptions(
		"vdc_id",
		"edge_id",
		"transit_gateway_id",
      int64(0),
	)
	addTransitGatewayConnectionsOptions.SetAcceptLanguage("en-us")

	transitGateway, response, err := vmwareService.AddTransitGatewayConnections(addTransitGatewayConnectionsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(transitGateway, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

TransitGateway

An IBM Transit Gateway.

Status Code

202
The request to connect to an IBM Transit Gateway is accepted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 202

{
  "id": "20bcbdac-27ed-4186-a1da-de6f28de401e",
  "region": "jp-tok",
  "connections": [
    {
      "name": "connection",
      "status": "pending",
      "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
      "network_type": "unbound_gre_tunnel",
      "base_network_type": "classic",
      "zone": "jp-tok-1"
    }
  ],
  "status": "pending"
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Remove IBM Transit Gateway connections from an edge and virtual data center.

DELETE /vdcs/{vdc_id}/edges/{edge_id}/transit_gateways/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.update

Auditing

Calling this method generates the following auditing event.

vmware.vdc.update

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

vdc_id
Required*
string
A unique ID for a virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id
edge_id
Required*
string
A unique ID for an edge.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: edge_id
id
Required*
string
A unique ID for an IBM Transit Gateway.

Possible values: length = 36, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$
Example: transit_gateway_id

Example request

curl -X DELETE   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>/edges/<edge_id>/transit_gateways/<transit_gateway_id>'   -H 'Authorization: Bearer <IAM_token>'   -H 'Content-Type: application/json'
Copy to clipboard

Example request

package main

import (
	"encoding/json"
	"fmt"
	"github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
	vmwareService *vmwarev1.VmwareV1
)

func main() {
	removeTransitGatewayConnectionsOptions := vmwareService.NewRemoveTransitGatewayConnectionsOptions(
		"vdc_id",
		"edge_id",
		"transit_gateway_id",
	)
	removeTransitGatewayConnectionsOptions.SetAcceptLanguage("en-us")

	transitGateway, response, err := vmwareService.RemoveTransitGatewayConnections(removeTransitGatewayConnectionsOptions)
	if err != nil {
		panic(err)
	}
	b, _ := json.MarshalIndent(transitGateway, "", "  ")
	fmt.Println(string(b))
	fmt.Println(response)
}
Copy to clipboard

Response

Response Body

TransitGateway

An IBM Transit Gateway.

Status Code

202
The request to disconnect from an IBM Transit Gateway is accepted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 202

{
  "id": "20bcbdac-27ed-4186-a1da-de6f28de401e",
  "region": "us-south",
  "connections": [
    {
      "name": "connection",
      "transit_gateway_connection_name": "transit_gateway_connection",
      "local_gateway_ip": "192.168.1.1",
      "remote_gateway_ip": "192.168.1.2",
      "local_tunnel_ip": "192.168.2.1",
      "remote_tunnel_ip": "192.168.2.2",
      "local_bgp_asn": 987654321,
      "remote_bgp_asn": 987654321,
      "status": "ready_to_use",
      "network_account_id": "28e4d90ac7504be694471ee66e70d0d5",
      "network_type": "unbound_gre_tunnel",
      "base_network_type": "classic",
      "zone": "us-south-1"
    }
  ],
  "status": "ready_to_use"
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Swap the primary and secondary locations for network regional high availability (HA) edges.

PATCH /vdcs/{vdc_id}/edges/{edge_id}/swap_primary_and_secondary_network_locations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.directorsite.director.update

Auditing

Calling this method generates the following auditing event.

vmware.vdc.update

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us

Path Parameters

vdc_id
Required*
string
A unique ID for a virtual data center.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: vdc_id
edge_id
Required*
string
A unique ID for an edge.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: edge_id

Example request to support switching the edge's primary and secondary network locations

curl -X PATCH   'https://api.us-south.vmware.cloud.ibm.com/v1/vdcs/<vdc_id>/edges/<edge_id>/swap_primary_and_secondary_network_locations'   -H 'Authorization: Bearer <IAM_token>'

Example request

package main

import (
  "encoding/json"
  "fmt"
  "github.com/IBM/vmware-go-sdk/vmwarev1"
)

var (
  vmwareService *vmwarev1.VmwareV1
)

func main() {
  swapHaEdgePrimaryAndSecondarySiteOptions := vmwareService.NewSwapHaEdgePrimaryAndSecondarySiteOptions(
      "vdc_id",
      "edge_id"
  )
  swapHaEdgePrimaryAndSecondarySiteOptions.SetAcceptLanguage("en-us")

  swapHaEdgeSite, response, err := vmwareService.SwapHaEdgePrimaryAndSecondarySite(swapHaEdgePrimaryAndSecondarySiteOptions)
  if err != nil {
      panic(err)
  }
  b, _ := json.MarshalIndent(swapHaEdgeSite, "", "  ")
  fmt.Println(string(b))
  fmt.Println(response)
}
Copy to clipboard

Response

Response Body

object

Status Code

202
The request to swap the locations of the network regional HA edge is accepted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 202

{
  "message": "The request to swap the locations of the network regional HA edge is accepted"
}

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

List the VMware licenses provided by IBM if you are entitled to them.

GET /licenses

Request

No Request Parameters

This method does not accept any request parameters.

Example request

curl -X GET 'https://licensing.vmware.cloud.ibm.com/v1/licenses' -H 'Authorization: Bearer <IAM_TOKEN>'

Response

Response Body

LicenseCollection

Collection of licenses.

Status Code

200
The collection of VMware licenses was returned.
401
You are not allowed to make this request because of a missing or bad authentication token.

Example responses

Status 200

{
  "licenses": [
    {
      "license_keys": [
        {
          "value": "XXXXX-XXXXX-XXXXX-XXXXX-XXXXX",
          "name": "VMware NSX 4 Networking"
        }
      ],
      "version": "8"
    },
    {
      "license_keys": [
        {
          "value": "YYYYY-YYYYY-YYYYY-YYYYY-YYYYY",
          "name": "VMware vSphere 8 Enterprise Plus for VCF"
        },
        {
          "value": "ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ-ZZZZZ",
          "name": "VMware vSAN 8 for Foundation (Supports vCenter Server 8.0.0a and later)"
        }
      ],
      "version": "8.0u2b"
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

List all your Usage Meter registrations.

GET /usage_meter_registrations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.usage-meter.read

Auditing

Calling this method generates the following auditing event.

vmware.usage-meter.read

Request

No Request Parameters

This method does not accept any request parameters.

Example request

curl -X GET   'https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations'   -H 'Authorization: Bearer <IAM_TOKEN>'

Response

Response Body

UsageMeterRegistrationCollection

Collection of Usage Meter registrations.

Status Code

200
The collection of Usage Meter registrations was returned.

Example responses

Status 200: Default

{
  "usage_meter_registrations": [
    {
      "id": "04588250-131a-41d6-ac8c-671f768aaa18",
      "crn": "crn:v1:bluemix:public:vmware:global:a/a16bedb7571f43f8920a49e037f598d7::usage-meter:04588250-131a-41d6-ac8c-671f768aaa18",
      "name": "name",
      "status": "active",
      "usage_meter": {
        "id": "4242b01d-2db2-4d7b-ad5d-0792c61295a8",
        "health": "ok"
      },
      "locked": false,
      "created_at": "2024-11-18T17:24:37.720474+00:00",
      "href": "https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations/04588250-131a-41d6-ac8c-671f768aaa18"
    }
  ]
}
Copy to clipboard

Register your Usage Meter to start reporting usage.

POST /usage_meter_registrations

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.usage-meter.write

Auditing

Calling this method generates the following auditing event.

vmware.usage-meter.write

Request

Request Body

Required*

UsageMeterRegistrationPrototype

Details for creating a Usage Meter registration.

Examples:

Example request

curl -X POST   'https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations'   -H 'Authorization: Bearer <IAM_TOKEN>'   -H 'Content-Type: application/json'   -d '{
  "name": "string",
  "usage_meter": {
    "id": "4242b01d-2db2-4d7b-ad5d-0792c61295a8"
  }
}'
Copy to clipboard

Response

Response Body

UsageMeterRegistration

Details of a Usage Meter registration.

Status Code

201
The Usage Meter registration was created.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
503
The request cannot be completed because the service is not available.

Example responses

Status 201: Default

{
  "id": "04588250-131a-41d6-ac8c-671f768aaa18",
  "crn": "crn:v1:bluemix:public:vmware:global:a/a16bedb7571f43f8920a49e037f598d7::usage-meter:04588250-131a-41d6-ac8c-671f768aaa18",
  "name": "name",
  "status": "active",
  "usage_meter": {
    "id": "4242b01d-2db2-4d7b-ad5d-0792c61295a8",
    "health": "ok"
  },
  "locked": false,
  "created_at": "2024-11-18T17:24:37.720474+00:00",
  "href": "https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations/04588250-131a-41d6-ac8c-671f768aaa18"
}
Copy to clipboard

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Get a Usage Meter registration.

GET /usage_meter_registrations/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.usage-meter.read

Auditing

Calling this method generates the following auditing event.

vmware.usage-meter.read

Request

Path Parameters

id
Required*
string
Identifier for a Usage Meter registration.

Possible values: 36 ≤ length ≤ 128, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example request

curl -X GET   'https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations/<id>'   -H 'Authorization: Bearer <IAM_TOKEN>'

Response

Response Body

UsageMeterRegistration

Details of a Usage Meter registration.

Status Code

200
The Usage Meter registration was returned.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.

Example responses

Status 200: Default

{
  "id": "04588250-131a-41d6-ac8c-671f768aaa18",
  "crn": "crn:v1:bluemix:public:vmware:global:a/a16bedb7571f43f8920a49e037f598d7::usage-meter:04588250-131a-41d6-ac8c-671f768aaa18",
  "name": "name",
  "status": "active",
  "usage_meter": {
    "id": "4242b01d-2db2-4d7b-ad5d-0792c61295a8",
    "health": "ok"
  },
  "locked": false,
  "created_at": "2024-11-18T17:24:37.720474+00:00",
  "href": "https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations/04588250-131a-41d6-ac8c-671f768aaa18"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Unregister your Usage Meter to stop reporting usage.

DELETE /usage_meter_registrations/{id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.usage-meter.write

Auditing

Calling this method generates the following auditing event.

vmware.usage-meter.write

Request

Path Parameters

id
Required*
string
Identifier for a Usage Meter registration.

Possible values: 36 ≤ length ≤ 128, Value must match regular expression ^[0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{4}-[0-9a-fA-F]{12}$

Example request

curl -X DELETE   'https://licensing.vmware.cloud.ibm.com/v1/usage_meter_registrations/<id>'   -H 'Authorization: Bearer <IAM_TOKEN>'

Response

Status Code

204
The Usage Meter registration was deleted.
400
The input data is either incomplete or in the wrong format.
401
You are not allowed to make this request because of a missing or bad authentication token.
403
You are not allowed to make this request because you do not have enough permissions to perform this operation.
404
The requested resource cannot be found.
503
The request cannot be completed because the service is not available.

Example responses

Status 400

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "bad_request_problem",
      "message": "The service encountered an unexpected error",
      "more_info": "/link/to/error/doc"
    }
  ],
  "status_code": 400,
  "trace": "some trace info"
}
Copy to clipboard

List all regions supported by VCF on VPC

GET /vcfs/regions

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Response

Response Body

VcfvpcRegions

List of VCF on VPC regions

Status Code

200
OK
500
Internal Server error

Example responses

Status 200

{
  "regions": [
    {
      "id": "region-001",
      "name": "us-east-1",
      "display_name": "US East 1",
      "geography": "North America",
      "default": true,
      "zones": [
        {
          "id": "zone-001",
          "name": "us-east-1a",
          "display_name": "US East 1a",
          "default": true
        },
        {
          "id": "zone-002",
          "name": "us-east-1b",
          "display_name": "US East 1b",
          "default": false
        }
      ]
    }
  ]
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

List VPC host-profiles supported for VCF on VPC per region

GET /vcfs/hostprofiles

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Response

Response Body

VcfvpcHostprofiles

Success. The request was successfully processed.

Status Code

200
OK
500
Internal Server error

Example responses

Status 200

{
  "hostprofiles": [
    {
      "id": "hostprofile-001",
      "name": "test-metal-64x512",
      "bandwidth": [
        {
          "default": true,
          "display_value": 100
        }
      ],
      "category": "Balanced",
      "core": 32,
      "localdisk": [
        "1x480",
        "4x7680"
      ],
      "planid": "46fba1c7-621e-451e-9925-b5eb7218d42e",
      "processor": "x86_64",
      "ram": 512,
      "vcpu": 64,
      "region_id": "region-001",
      "region_name": "us-east-1",
      "default": true
    }
  ]
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

List VCF on VPC pricing metrics per region

GET /vcfs/pricing

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Response

Response Body

VcfvpcPricingInfo

Success. The request was successfully processed.

Status Code

200
OK
500
Internal Server error

Example responses

Status 200

{
  "privatepath_pricing": [
    {
      "description": "Instance",
      "metric": "INSTANCES",
      "price_list": [
        {
          "country": "USA",
          "currency": "USD",
          "prices": [
            {
              "price": 7.3,
              "quantity_tier": 1
            }
          ]
        },
        {
          "country": "USD",
          "currency": "USD",
          "prices": [
            {
              "price": 7.3,
              "quantity_tier": 1
            }
          ]
        }
      ],
      "region": "us-east-1"
    }
  ],
  "nlb_pricing": [
    {
      "description": "GB per Month",
      "metric": "GB_MONTH",
      "price_list": [
        {
          "country": "USA",
          "currency": "USD",
          "prices": [
            {
              "price": 3.3,
              "quantity_tier": 1
            }
          ]
        },
        {
          "country": "USD",
          "currency": "USD",
          "prices": [
            {
              "price": 3.3,
              "quantity_tier": 1
            }
          ]
        }
      ],
      "region": "us-east-1"
    }
  ],
  "vsi_pricing": [
    {
      "description": "Memory per hr",
      "metric": "MEMORY_HOURS",
      "price_list": [
        {
          "country": "USA",
          "currency": "USD",
          "prices": [
            {
              "price": 3.3,
              "quantity_tier": 1
            }
          ]
        },
        {
          "country": "USD",
          "currency": "USD",
          "prices": [
            {
              "price": 3.3,
              "quantity_tier": 1
            }
          ]
        }
      ],
      "region": "us-east-1"
    }
  ],
  "dns_pricing": [
    {
      "description": "DNS-ZONES",
      "metric": "ITEMS",
      "price_list": [
        {
          "country": "USA",
          "currency": "USD",
          "prices": [
            {
              "price": 9.3,
              "quantity_tier": 1
            }
          ]
        },
        {
          "country": "USD",
          "currency": "USD",
          "prices": [
            {
              "price": 9.3,
              "quantity_tier": 1
            }
          ]
        }
      ],
      "region": "global"
    }
  ],
  "hostprofile_pricing": [
    {
      "description": "BMS Hour",
      "hostprofile": "test-metal-64x512",
      "hostprofile_id": "hostprofile-001",
      "metric": "BMS_SERVER_HOURS",
      "price_list": [
        {
          "country": "USA",
          "currency": "USD",
          "prices": [
            {
              "price": 5.3,
              "quantity_tier": 1
            }
          ]
        },
        {
          "country": "USD",
          "currency": "USD",
          "prices": [
            {
              "price": 5.3,
              "quantity_tier": 1
            }
          ]
        }
      ],
      "region": "us-east-1"
    }
  ]
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Based on the host profiles local disk storage and the quantity of hosts this API estimates the usable ammount of VMware vSAN storage

POST /vcfs/vsan/calculatestorage

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Request Body

Required*

object

Required info to calculate resources

Response

Response Body

VcfvpcVsanStorage

VCF on VPC vSAN storage estimation

Status Code

200
OK
500
Internal Server error

Example responses

Status 200

{
  "storage": {
    "assumptions": [
      "vSAN type: All Flash"
    ],
    "result": {
      "available_storage": {
        "hint": "If vSAN deduplication and compression is enabled, a ratio of 2.0 is assumed",
        "unit": "TB",
        "value": 80.5
      },
      "total_raw_storage": {
        "unit": "TB",
        "value": 76.5
      }
    }
  }
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

List all instances of VCF on VPC

GET /vcfs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.read

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.read

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Response

Response Body

FetchVcfvpcInstances

List of VCF on VPC Instances

Status Code

200
Ok
401
Unauthorized_Error
500
Internal Server Error

Example responses

Status 200

{
  "vcfs": [
    {
      "created_at": "2025-04-24T05:17:55.677602Z",
      "id": "bdd6f4d1-b635-4340-ac99-ec1b7911c7ab",
      "location": "US South (us-south)",
      "name": "example-vcf",
      "status": "Creating"
    },
    {
      "created_at": "2024-04-24T05:17:55.677602Z",
      "id": "asd6f4yt-1234-9874-85ds-ec1b7911c7ab",
      "location": "US South (us-south)",
      "name": "example-vcf2",
      "status": "Creating"
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Order an instance of VCF on VPC

POST /vcfs

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.write

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.create

Request

Custom Headers

X-Auth-Refresh-Token
Required*
string
User's Refresh Token
Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Request Body

Required*

VcfvpcOrderInstance

Order Specification

Examples:

Response

Response Body

PostVcfvpcInstances

List of VCF on VPC Instances

Status Code

200
Order accepted
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
500
Internal Server Error

Example responses

Status 200

{
  "id": "abcd",
  "name": "vcf1",
  "account_id": "account123",
  "resource_group_id": "resource_grp_1",
  "tags": "",
  "crn": "crn_1",
  "created_at": "2024-02-22T18:12:10.878203+00:00"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Get VCF on VPC instance by ID

GET /vcfs/{vcf_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.read

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.read

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Response

Response Body

VcfvpcInstance

VCF on VPC Instance

Status Code

200
OK
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
404
VCF instance not found
500
Internal Server Error

Example responses

Status 200

{
  "vcf": {
    "account_id": "3881def42de43t9a89c4b7c282708f34",
    "created_at": "2025-04-24T05:17:55.677602Z",
    "crn": "crn:v1:bluemix:vcf::...",
    "id": "bdd6f4d1-b635-4340-ac99-ec1b7911c7ab",
    "vpc_id": "vpc_id_123",
    "root_domain": "ibm.zone.priv",
    "vcf_version": "vcf_version_no",
    "name": "example-vcf",
    "vmware_aria": {
      "name": "xint-vrslcm01.ibmcloud.priv",
      "ip": "172.27.17.20",
      "admin_user": "vcfadmin@local",
      "admin_password": "***",
      "root_password": "***"
    },
    "usage_meter": {
      "name": "usage-meter.ibmcloud.priv",
      "ip": "10.100.1.135",
      "admin_user": "usagemeter",
      "admin_password": "***"
    },
    "vmware_nsxt": {
      "name": "fqdn.ibmcloud.priv",
      "ip": "10.100.0.150",
      "root_password": "***"
    },
    "region_data": {
      "display_name": "US South",
      "geography": "North America",
      "id": "region-us-south-001",
      "name": "us-south"
    },
    "requester": "user@example.com",
    "resource_group_id": "d1586ff2-215b-486d-8767-1c57598f0ef0",
    "resource_group": "Default",
    "sso_domain": "example.com",
    "status": "Creating",
    "tags_list": [
      "tag1",
      "tag2"
    ],
    "zone": "us-south-1",
    "location": "Dallas (us-south)",
    "sddc_info": {
      "id": "d1586ff2-215b-486d-8767-1c57598f0ef0",
      "name": "sddc-mock",
      "ip_address": "192.168.100.10",
      "root_user": "root",
      "root_password": "***",
      "auto_user": "vcf",
      "auto_password": "***",
      "local_user": "admin@local",
      "local_account_password": "***",
      "day2_user": "ibm_admin",
      "day2_password": "***"
    },
    "vcenter_info": {
      "id": "48c8a1e1-6429-4d7d-84b4-c9c976d46e33",
      "name": "vsphere-mock",
      "ip_address": "10.0.0.5",
      "root_account": "mocked_password",
      "admin_username": "administrator@vsphere.local",
      "admin_password": "***"
    },
    "nsxt_info": {
      "id": "48c8a1e1-6429-4d7d-84b4-c9c976d46e33",
      "name": "nsx_mock",
      "virtual_ip_address": "10.0.0.2",
      "hosts": [
        {
          "name": "mgmt-nsx-t-0",
          "ip": "192.168.1.1"
        },
        {
          "name": "mgmt-nsx-t-1",
          "ip": "192.168.1.2"
        },
        {
          "name": "mgmt-nsx-t-2",
          "ip": "192.168.1.3"
        }
      ],
      "root_account": "mocked_password",
      "admin_account": "mocked_password",
      "audit_account": "mocked_password"
    },
    "dns": {
      "crn": "mock_crn",
      "dashboard_url": "mock_dns_url",
      "name": "mock_crn_name",
      "domain": "mock_domain"
    },
    "vcf_metadata": {
      "latest_operation_attempt_date": "2025-04-24T05:17:55.677602Z",
      "delete_error": [
        "sddc_password_incorrect",
        "nsx_password_incorrect"
      ]
    },
    "domains": [
      {
        "id": "5167c692-821d-4d53-bed1-672b66a347f5",
        "name": "my domain",
        "domain_type": "management",
        "network_type": "private",
        "cluster": {
          "name": "br-sao-2-m1",
          "status": "Available",
          "cluster_type": "Consolidated",
          "host_count": 2,
          "network_type": "private",
          "subnets": [
            {
              "url": "vni-large-y86vpc-br-sao-2-host.ibm.priv",
              "name": "vni-large-y86vpc-br-sao-2-host",
              "ip_range": "10.100.0.0/25"
            },
            {
              "url": "vni-large-y86vpc-br-sao-2-host.ibm.priv",
              "name": "vni-large-y86vpc-br-sao-3-host",
              "ip_range": "10.100.10.0/25"
            }
          ]
        },
        "hosts": [
          {
            "id": "random-hostname-id",
            "created_at": "2025-05-15T20:33:59.356315+00:00",
            "ip": "10.100.1.4",
            "name": "vcfvpc-fvt-esx001",
            "password": "******",
            "profile": "mx3d-metal-192x2048",
            "status": "Available",
            "user": "root",
            "host_metadata\"": {
              "latest_operation_attempt_date": "2025-04-24T05:17:55.677602Z",
              "delete_error": [
                "sddc_password_incorrect",
                "nsx_password_incorrect"
              ]
            },
            "storage": {
              "storage_type": "vSAN OSA",
              "disk_size": "3200 GB",
              "disk_number": "8 X 4 GB",
              "disk_type": "NVMe U.2 SSDs",
              "uplink_speed": "100 Gbps"
            }
          }
        ],
        "edge_nodes": {
          "edge_node_size": "Extra large",
          "edge_node_0": {
            "name": "mgmt-edge-0.ibm.cloud.priv",
            "ip": "10.100.0.144",
            "account_password": "***"
          },
          "edge_node_1": {
            "name": "mgmt-edge-1.ibm.cloud.priv",
            "ip": "10.100.0.145",
            "account_password": "***"
          }
        },
        "nsxt_edge_cluster_uplinks": [
          {
            "name": "edge_0",
            "ip": "172.198.61.2",
            "vlan_id": "2712",
            "vlan_name": "vlan-nic-mgmt10-uplink-private-edge-0"
          },
          {
            "name": "edge_1",
            "ip": "172.198.61.3",
            "vlan_id": "2712",
            "vlan_name": "vlan-nic-mgmt10-uplink-private-edge-1"
          },
          {
            "name": "edge_2",
            "ip": "172.198.61.4",
            "vlan_id": "2712",
            "vlan_name": "vlan-nic-mgmt10-uplink-private-edge-2"
          }
        ]
      }
    ]
  }
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "exceptionvcfnotfound",
      "message": "“VCF Not found”",
      "more_info": "Traceback (): raise ExceptionVCFNotFound"
    }
  ],
  "status_code": 404,
  "trace": "b04971ed-a782-4289-8e77-efa1fdfc40cb"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Delete VCF on VPC instance with the given id

DELETE /vcfs/{vcf_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.manager

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.delete

Request

Custom Headers

X-Auth-Refresh-Token
Required*
string
User's Refresh Token
Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Response

Response Body

DeleteVcfvpcInstance

delete vcf instance for given account_id

Status Code

200
Instance deleted
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
404
VCF on VPC instance not found
500
Internal Server error

Example responses

Status 200

{
  "id": "87b6c8b2-108b-419a-8562-5dfe2df01edd",
  "task_group_id": 1598,
  "trace_id": "6452f6a2-793a-463d-b7ed-f4d14a06763d"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "exceptionvcfnotfound",
      "message": "“VCF Not found”",
      "more_info": "Traceback (): raise ExceptionVCFNotFound"
    }
  ],
  "status_code": 404,
  "trace": "b04971ed-a782-4289-8e77-efa1fdfc40cb"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Reset vcf error status.

PUT /vcfs/{vcf_id}

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.write

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.write

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Response

Response Body

StatusTransaction

Response of transaction

Status Code

200
Ok
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
404
VCF on VPC instance not found
500
Internal server error

Example responses

{ "status_success": true }

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "exceptionvcfnotfound",
      "message": "“VCF Not found”",
      "more_info": "Traceback (): raise ExceptionVCFNotFound"
    }
  ],
  "status_code": 404,
  "trace": "b04971ed-a782-4289-8e77-efa1fdfc40cb"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Add one or more hosts to a VCF on VPC instance

POST /vcfs/{vcf_id}/domain/{domain_id}/host

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.write

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.addhost

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
domain_id
Required*
string
A unique identifier for the Domain.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Request Body

Required*

AddHostVpc

Order Specification

Examples:

Response

Response Body

AddHost

VCF on VPC Add host

Status Code

200
Add host accepted
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
500
Internal Server Error

Example responses

Status 200

{
  "status": "Modifying",
  "trace_id": "db484d3d-23fb-4eae-8364-9c5d4205af6a"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Remove one or more hosts from a VCF on VPC instance

PATCH /vcfs/{vcf_id}/domain/{domain_id}/host

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.write

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.removehost

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$
domain_id
Required*
string
A unique identifier for the Domain.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Request Body

Required*

RemoveHostVpc

Remove host Specification

Examples:

Response

Response Body

RemoveHost

VCF on VPC Remove host

Status Code

200
Removing host accepted
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
500
Internal Server Error

Example responses

Status 200

{
  "hosts": [
    {
      "host": "host-1",
      "status": "Deleting",
      "error_message": ""
    },
    {
      "host": "host-2",
      "status": "Failed",
      "error_message": "The host is still assigned to a cluster"
    }
  ],
  "status": "Modifying",
  "task_group_id": 25,
  "trace_id": "d3ddb484-23fb-4eae-8364-9c5d4205af6a"
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Change password for sddc manager: ibm_admin

PATCH /vcfs/{vcf_id}/sddcmgr/ibm_admin/password

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.manager

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.changepassword

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Request Body

Required*

password

New password

Examples:

Response

Response Body

StatusTransaction

Response of transaction

Status Code

200
Status of transaction
401
Unauthorized_Error
500
Internal Server Error

Example responses

{ "status_success": true }

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Change password for nsx manager: ibm_admin

PATCH /vcfs/{vcf_id}/nsxmgr/ibm_admin/password

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.manager

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.changepassword

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Path Parameters

vcf_id
Required*
string
A unique identifier for the VCF on VPC Instance.

Possible values: 1 ≤ length ≤ 64, Value must match regular expression ^[-0-9a-z_]+$

Request Body

Required*

password

New password

Examples:

Response

Response Body

StatusTransaction

Response of transaction

Status Code

200
Status of transaction
401
Unauthorized_Error
500
Internal Server Error

Example responses

{ "status_success": true }

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Verify if the VCFon VPC name exists under same cloud account with in the same region

POST /vcfs/name

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Request Body

Required*

VcfvpcName

Order Specification

Response

Response Body

VcfvpcExistingName

Flag to confirm if name exist or not

Status Code

200
Order accepted
401
Unauthorized_Error
500
Internal Server Error

Example responses

{ "existing_name": true }

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Retrieve List of hostnames

GET /vcfs/hostnames

Authorization

To call this method, you must be assigned one or more IAM access roles that include the following action. You can check your access by going to Users > User > Access.

vmware.vcfonvpc.read

Auditing

Calling this method generates the following auditing event.

vmware.vcfonvpc.read

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Query Parameters

host_count
Required*
integer
Number of hostnames to generate
hostname_prefix
string
Optional prefix for the hostnames

Possible values: 1 ≤ length ≤ 13

Response

Response Body

ListHostnameInstances

List of hostnames

Status Code

200
OK
401
Unauthorized_Error
403
Unauthorized_Error_Required_Role
404
VCF instance not found
500
Internal Server Error

Example responses

Status 200: Default hostname prefix (not provided in query)

{
  "hostnames": [
    "host-000",
    "host-001",
    "host-002"
  ]
}
Copy to clipboard

Status 200: Custom hostname prefix provided (e.g., "custom_prefix")

{
  "hostnames": [
    "custom_prefix-000",
    "custom_prefix-001",
    "custom_prefix-002"
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 403

{
  "errors": [
    {
      "code": "exception_resource_group",
      "message": "There are not enough permisions for the selected resource group",
      "more_info": "Traceback (): raise Exception(f\"No resource group crn was found for {account_id}"
    }
  ],
  "status_code": 403,
  "trace": "90fe9b8f-0cb7-4747-9e12-03e8ce868051"
}
Copy to clipboard

Status 404

{
  "errors": [
    {
      "code": "exceptionvcfnotfound",
      "message": "“VCF Not found”",
      "more_info": "Traceback (): raise ExceptionVCFNotFound"
    }
  ],
  "status_code": 404,
  "trace": "b04971ed-a782-4289-8e77-efa1fdfc40cb"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Verifies if the list of hostnames are valid

POST /vcfs/hostnames

Request

Custom Headers

Accept-Language
string
Language.

Possible values: 1 ≤ length ≤ 256, Value must match regular expression ^[A-Za-z0-9-,;=\.\*\s]{1,256}$
Example: en-us
X-Global-Transaction-ID
string
Transaction ID.

Possible values: 1 ≤ length ≤ 128, Value must match regular expression ^[A-Za-z0-9_-]{1,128}$
Example: transaction1

Request Body

Required*

VcfvpcHosts

Order Specification

Response

Response Body

VcfvpcValidHosts

Indicates whether each hostname in the list is valid or not

Status Code

200
Order accepted
401
Unauthorized_Error
500
Internal Server Error

Example responses

Status 200

{
  "hostnames": [
    {
      "hostname": "vcf-node-001",
      "is_valid": true
    },
    {
      "hostname": "invalid_host_#1",
      "is_valid": false
    }
  ]
}
Copy to clipboard

Status 401

{
  "errors": [
    {
      "code": "unauthorized",
      "message": "The server could not verify that you are authorized to access the URL requested. You either supplied the wrong credentials (e.g. a bad password), or your browser doesn't understand how to supply the credentials required.",
      "more_info": "NoneType: None\n"
    }
  ],
  "status_code": 401,
  "trace": "26578124-d72c-465c-8b8d-f7098e39250c"
}
Copy to clipboard

Status 500

{
  "errors": [
    {
      "code": "internal_server_error",
      "message": "Internal server error. Your request cannot be processed.",
      "more_info": "Traceback (...), raise IntrenalServerError: Unexpected error occured"
    }
  ],
  "status_code": 500,
  "trace": "request_tracing_uuid"
}
Copy to clipboard

Introduction

Endpoint URLs

Authentication

Setting client options programmatically

Setting client options through environment variables

Setting client options through a credentials file

Auditing

Error handling

Methods

Create a Cloud Director site instance

Authorization

Auditing

Request

Custom Headers

Accept-Language

X-Global-Transaction-ID

Request Body

name

pvdcs

resource_group

services

private_only

console_connection_type

ip_allow_list

Response

Response Body

crn

href

id

ordered_at

name

status

resource_group

pvdcs

type

services

console_connection_type

console_connection_status

ip_allow_list

provisioned_at

rhel_vm_activation_key

Status Code

202

400

401

List Cloud Director site instances

Authorization

Request

Custom Headers

Accept-Language

X-Global-Transaction-ID

Response

Response Body

director_sites

Status Code

200

401

404

Get a Cloud Director site instance

Authorization

Request

Custom Headers

Accept-Language

X-Global-Transaction-ID

Path Parameters

id

Response

Response Body

crn

href

id

ordered_at

name

status

resource_group

pvdcs

type

services

console_connection_type

console_connection_status