[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1126/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1077/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1032/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1002/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/921/vmware-cloud-foundation","version":"4.0"},{"link":"https://developer.vmware.com/apis/925/vmware-cloud-foundation","version":"3.10"},{"link":"https://developer.vmware.com/apis/891/vmware-cloud-foundation","version":"3.9.1"},{"link":"https://developer.vmware.com/apis/723/vmware-cloud-foundation","version":"3.9.0"},{"link":"https://developer.vmware.com/apis/711/vmware-cloud-foundation","version":"3.8.1"},{"link":"https://developer.vmware.com/apis/685/vmware-cloud-foundation","version":"3.8"}]

vcf

Get VDses

Description

Get the list of VDSes of a cluster.

Request

URL

get

https://sfo-vcf01.rainpole.io/v1/clusters/{clusterId}/vdses

Copy

Path Parameters

string

clusterId Required

Cluster ID

Response

Response Body

200 OK

Returns array of Vds of type(s) application/json

{
	"id": "string",
	"isUsedByNsxt": false,
	"mtu": 0,
	"name": "string",
	"niocBandwidthAllocations": [
		{
			"niocTrafficResourceAllocation": {
				"limit": 0,
				"reservation": 0,
				"sharesInfo": {
					"level": "One among: low, normal, high, custom",
					"shares": 0
				}
			},
			"type": "Example: management, faultTolerance, vmotion, virtualMachine, iSCSI, nfs, hbr, vsan, vdp etc."
		}
	],
	"portGroups": [
		{
			"activeUplinks": [
				"string"
			],
			"name": "string",
			"portBindingType": "One among: STATIC, DYNAMIC, EPHEMERAL",
			"standbyUplinks": [
				"string"
			],
			"transportType": "One among: VSAN, VMOTION, MANAGEMENT, PUBLIC, NFS, VREALIZE, ISCSI, EDGE_INFRA_OVERLAY_UPLINK",
			"vlanId": 0
		}
	],
	"version": "string"
}

string

name Required

vSphere Distributed Switch name

string

id Optional

vSphere Distributed Switch id

boolean

isUsedByNsxt Optional

Boolean to identify if the vSphere distributed switch is used by NSX-T

integer as int32

mtu Optional

Maximum Transmission Unit

array of NiocBandwidthAllocation

niocBandwidthAllocations Optional

List of Network I/O Control Bandwidth Allocations for System Traffic

array of Portgroup

portGroups Optional

List of portgroups associated with the vSphere Distributed Switch

string

version Introduced Optional

vSphere Distributed Switch version

Errors

Error

400

Bad Request

Error

404

Cluster Not Found

Error

500

Internal Server Error

Code Samples

cURL Command

curl https://sfo-vcf01.rainpole.io/v1/clusters/{clusterId}/vdses

vcf

Clusters Operations

post

Add Datastore To Cluster Introduced

put

Assign Tags To Existing Cluster Introduced

get

Assignable Tags To Cluster Introduced

post

Create Cluster

delete

Delete Cluster

get

Get Cluster

get

Get Cluster Datastores Introduced

get

Get Cluster Tag Manager URL

get

Get Clusters

get

Get Datastore Criterion Introduced

get

Get Datastore Query Response Introduced

get

Get Datastores Criteria Introduced

get

Get Host Criteria

get

Get Host Criterion

get

Get Host Query Response

get

Get Tags Assigned To Cluster

get

Get Tags Assigned To Clusters Introduced

get

Get VDses

post

Post Datastore Query Introduced

post

Post Host Query

delete

Remove Datastore From Cluster Introduced

delete

Remove Tags From Existing Cluster Introduced

patch

Update Cluster

post

Validate Cluster Operations

post

Validate Clusters Operations

post

Validate vSAN Remote Datastore Introduced

Get VDses

Request

URL

Path Parameters

Response

Response Body

200 OK

Errors

Code Samples

cURL Command

On This Page

Clusters Operations

Was this page helpful?