[{"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

Request

URL

URL


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

Path Parameters

Path Parameters

string
clusterId Required

Cluster ID


Response

Response

Response Body

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
		}
	]
}
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


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

Errors

Errors

Error
400

Bad Request


Error
404

Cluster Not Found


Error
500

Internal Server Error

Code Samples

Code Samples

cURL Command

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


[{"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
Feedback

Was this page helpful?