[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
Get VDses
DescriptionGet the list of VDSes of a cluster.
Request
URLURL
https://sfo-vcf01.rainpole.io/v1/clusters/{clusterId}/vdses
Path Parameters
Path Parameters
string
clusterId
Required
Cluster ID
Response
Response
Response BodyResponse 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
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
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
[{"label":"Latest (4.5.0)","version":"latest"},{"version":"4.4.0"},{"version":"4.3.1"},{"link":"https://developer.vmware.com/apis/1127/vmware-cloud-foundation","version":"4.3"},{"link":"https://developer.vmware.com/apis/1078/vmware-cloud-foundation","version":"4.2"},{"link":"https://developer.vmware.com/apis/1033/vmware-cloud-foundation","version":"4.1"},{"link":"https://developer.vmware.com/apis/1003/vmware-cloud-foundation","version":"4.0.1"},{"link":"https://developer.vmware.com/apis/939/vmware-cloud-foundation","version":"4.0"}]
vcf-for-vxrail
On This Page
Clusters Operations
post
delete
get
get
get
post
patch
