Get Workload Based Sizing Recommendation
Get sizing estimates for the resources required to run various workloads within VMware Cloud. Currently supported cloud providers are VMware Cloud on AWS.
Use Accept:application/pdf for a PDF sizing report
Note - There is a limitation with VMware Developer portal, where some float/double values are rounded off. Please pay attention to the values passed in your request as it might result in incorrect sizing or an error.
Request
URI
POST
https://vmc.vmware.com/api/vmc-sizer/v5/recommendation
COPY
Query Parameters
boolean
vmPlacement
Optional
Whether or not the VM Placement details have to be included in the response.
vmPlacement example
true
Request Body
The sizing recommendation request with workload characteristics.
VMCSizerRequest of type(s) application/json
Required
{
"configurations": {
"cloudType": "VMC_ON_AWS",
"sddcHostType": "I4I",
"clusterType": "SAZ",
"computeOvercommitFactor": 4,
"cpuHeadroom": 0.15,
"hyperThreadingFactor": 1.25,
"memoryOvercommitFactor": 1,
"cpuUtilization": 30,
"memoryUtilization": 100,
"storageThresholdFactor": 1,
"compressionRatio": 1.25,
"dedupRatio": 1.5,
"ioAccessPattern": "string",
"ioSize": "string",
"ioRatio": "string",
"totalIOPs": 2000,
"includeManagementVMs": true,
"fttFtmType": "AUTO_AUTO",
"separateCluster": false,
"instanceSettingsList": [
{
"name": "DEDUP_RATIO",
"value": 1.5,
"hostType": "I3"
}
],
"vmOutlierLimits": {
"cpuLimit": 0.75,
"storageLimit": 0.5,
"memoryLimit": 0.75
},
"applianceSize": "REGULAR",
"addonsList": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"categoryID": "string",
"additionalData": {
"numberOfVMs": 1500,
"addonComponents": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
]
}
}
],
"cloudEdition": {
"id": "string",
"name": "VMware Cloud on AWS - Advanced",
"type": "string",
"enabled": false,
"cloudEditionServices": [
{
"id": "string",
"serviceMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"cloudEditionCompoments": [
{
"id": "string",
"componentMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"isMandatory": false,
"isCustomSizerAvailable": false,
"customerSizerMetadata": {
"name": "string",
"apiUrl": "string"
}
}
]
}
],
"cloudEditionMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
},
"workloadProfiles": [
{
"configurations": {
"cloudType": "VMC_ON_AWS",
"sddcHostType": "I4I",
"clusterType": "SAZ",
"computeOvercommitFactor": 4,
"cpuHeadroom": 0.15,
"hyperThreadingFactor": 1.25,
"memoryOvercommitFactor": 1,
"cpuUtilization": 30,
"memoryUtilization": 100,
"storageThresholdFactor": 1,
"compressionRatio": 1.25,
"dedupRatio": 1.5,
"ioAccessPattern": "string",
"ioSize": "string",
"ioRatio": "string",
"totalIOPs": 2000,
"includeManagementVMs": true,
"fttFtmType": "AUTO_AUTO",
"separateCluster": false,
"instanceSettingsList": [
{
"name": "DEDUP_RATIO",
"value": 1.5,
"hostType": "I3"
}
],
"vmOutlierLimits": {
"cpuLimit": 0.75,
"storageLimit": 0.5,
"memoryLimit": 0.75
},
"applianceSize": "REGULAR",
"addonsList": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"categoryID": "string",
"additionalData": {
"numberOfVMs": 1500,
"addonComponents": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
]
}
}
],
"cloudEdition": {
"id": "string",
"name": "VMware Cloud on AWS - Advanced",
"type": "string",
"enabled": false,
"cloudEditionServices": [
{
"id": "string",
"serviceMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"cloudEditionCompoments": [
{
"id": "string",
"componentMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"isMandatory": false,
"isCustomSizerAvailable": false,
"customerSizerMetadata": {
"name": "string",
"apiUrl": "string"
}
}
]
}
],
"cloudEditionMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
},
"workloadProfileType": "GPW_GVM",
"vmList": [
{
"vmId": "vm-123",
"vmGroupId": "vm-gp-123",
"vmName": "oracleVM",
"vmState": "RUNNING",
"vmComputeInfo": {
"vCpu": 4,
"vCpuOverall": 4,
"vCpuPerCore": 1,
"utilizationRatio": 30
},
"vmMemoryInfo": {
"vRam": 4,
"vRamConsumed": 3,
"ramOverhead": 70,
"utilizationRatio": 100
},
"vmStorageInfo": {
"vmdkTotal": 200,
"vmdkUsed": 140,
"readIOPS": 100,
"writeIOPS": 30,
"peakReadIOPs": 20,
"peakWriteIOPs": 10,
"readThroughput": "number",
"writeThroughput": "number",
"peakReadThroughput": "number",
"peakWriteThroughput": "number",
"extStorageVendorType": "string"
},
"importedFileName": "file1.xlsx",
"workloadProfileIndex": 0
}
],
"separateCluster": true,
"sizingType": "ADVANCED-MANUAL",
"averageWorkloadData": {
"totalVMCount": 100
},
"extStorageVendorType": "string",
"storagePreference": "string",
"profileName": "Workload profile 1",
"isEnabled": true,
"fileImportType": {
"fileName": "liveoptics.xslx",
"fileType": "LIVE_OPTICS"
},
"metadata": {
"averageMetrics": {
"avgVCpuPerCore": "number",
"avgVCpusPerVM": "number",
"avgMemoryPerVM": "number",
"avgStoragePerVM": "number"
}
}
}
]
}
Responses
200
OK
Returns VMCSizerResponse of type(s) application/json
{
"sddcList": [
{
"sddcName": "us-west-sddc",
"sddcType": "I4I",
"clusterList": {
"sazClusters": {
"hostBreakupList": [
{
"hostType": "I4I",
"totalHostCount": 1000,
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"totalIOPSCapacity": 100,
"consumedIOPSCapacity": 80
}
],
"clusterInfoList": [
{
"clusterName": "cluster-123",
"numberOfHosts": 10,
"numberOfVMs": 100,
"clusterType": "SAZ",
"hostType": "I4I",
"fttFtmType": "AUTO_AUTO",
"hostList": [
{
"hostType": "I4I",
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 90,
"totalMemoryCapacity": 100,
"usedMemoryCapacity": 70,
"totalIOPSCapacity": 100,
"usedIOPSCapacity": 70,
"numberOfVms": 1000,
"vmList": [
{
"vmId": "vm-123",
"vmGroupId": "vm-gp-123",
"vmName": "oracleVM",
"vmState": "RUNNING",
"vmComputeInfo": {
"vCpu": 4,
"vCpuOverall": 4,
"vCpuPerCore": 1,
"utilizationRatio": 30
},
"vmMemoryInfo": {
"vRam": 4,
"vRamConsumed": 3,
"ramOverhead": 70,
"utilizationRatio": 100
},
"vmStorageInfo": {
"vmdkTotal": 200,
"vmdkUsed": 140,
"readIOPS": 100,
"writeIOPS": 30,
"peakReadIOPs": 20,
"peakWriteIOPs": 10,
"readThroughput": "number",
"writeThroughput": "number",
"peakReadThroughput": "number",
"peakWriteThroughput": "number",
"extStorageVendorType": "string"
},
"importedFileName": "file1.xlsx",
"workloadProfileIndex": 0
}
]
}
],
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"storageBreakdown": {
"consumedByWorkloads": "number",
"consumedBySystem": {
"totalConsumed": "number",
"diskFormatOverhead": "number",
"dedupOverhead": "number",
"checksumOverhead": "number",
"physicalReservation": "number",
"logicalReservation": "number"
},
"freeStorage": {
"totalFreeStorage": "number",
"slackSpace": "number",
"usableFreeStorage": "number",
"vSanOverheadReservation": "number"
}
},
"workloadProfileVMMap": [
0
],
"cpuHeadroom": 0.15,
"maxHostsInCluster": 16,
"consumedIOPSCapacity": 16,
"totalIOPSCapacity": 16,
"vSANArchitecture": "string",
"sizingAssumptions": [
"Default CPU Headroom: 15%",
"Default Memory utilization: 100"
]
}
],
"applianceSize": "REGULAR",
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"recommendationType": "CPU",
"totalCoresToSubscribe": 100,
"totalIOPSCapacity": 100,
"consumedIOPSCapacity": 80
},
"mazClusters": {
"hostBreakupList": [
{
"hostType": "I4I",
"totalHostCount": 1000,
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"totalIOPSCapacity": 100,
"consumedIOPSCapacity": 80
}
],
"clusterInfoList": [
{
"clusterName": "cluster-123",
"numberOfHosts": 10,
"numberOfVMs": 100,
"clusterType": "SAZ",
"hostType": "I4I",
"fttFtmType": "AUTO_AUTO",
"hostList": [
{
"hostType": "I4I",
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 90,
"totalMemoryCapacity": 100,
"usedMemoryCapacity": 70,
"totalIOPSCapacity": 100,
"usedIOPSCapacity": 70,
"numberOfVms": 1000,
"vmList": [
{
"vmId": "vm-123",
"vmGroupId": "vm-gp-123",
"vmName": "oracleVM",
"vmState": "RUNNING",
"vmComputeInfo": {
"vCpu": 4,
"vCpuOverall": 4,
"vCpuPerCore": 1,
"utilizationRatio": 30
},
"vmMemoryInfo": {
"vRam": 4,
"vRamConsumed": 3,
"ramOverhead": 70,
"utilizationRatio": 100
},
"vmStorageInfo": {
"vmdkTotal": 200,
"vmdkUsed": 140,
"readIOPS": 100,
"writeIOPS": 30,
"peakReadIOPs": 20,
"peakWriteIOPs": 10,
"readThroughput": "number",
"writeThroughput": "number",
"peakReadThroughput": "number",
"peakWriteThroughput": "number",
"extStorageVendorType": "string"
},
"importedFileName": "file1.xlsx",
"workloadProfileIndex": 0
}
]
}
],
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"storageBreakdown": {
"consumedByWorkloads": "number",
"consumedBySystem": {
"totalConsumed": "number",
"diskFormatOverhead": "number",
"dedupOverhead": "number",
"checksumOverhead": "number",
"physicalReservation": "number",
"logicalReservation": "number"
},
"freeStorage": {
"totalFreeStorage": "number",
"slackSpace": "number",
"usableFreeStorage": "number",
"vSanOverheadReservation": "number"
}
},
"workloadProfileVMMap": [
0
],
"cpuHeadroom": 0.15,
"maxHostsInCluster": 16,
"consumedIOPSCapacity": 16,
"totalIOPSCapacity": 16,
"vSANArchitecture": "string",
"sizingAssumptions": [
"Default CPU Headroom: 15%",
"Default Memory utilization: 100"
]
}
],
"applianceSize": "REGULAR",
"allottedvCpus": 90,
"totalCpuCapacity": 100,
"consumedCpuCapacity": 90,
"consumedMemoryCapacity": 100,
"allottedMemory": 80,
"usedMemory": 100,
"totalMemoryCapacity": 100,
"allottedStorage": 80,
"totalStorageCapacity": 100,
"consumedStorageCapacity": 80,
"recommendationType": "CPU",
"totalCoresToSubscribe": 100,
"totalIOPSCapacity": 100,
"consumedIOPSCapacity": 80
}
},
"externalStorageList": [
{
"storagePreference": "string",
"extStorageVendorType": "string",
"workloadProfileVMMap": [
0
],
"consumedStorage": "number",
"aggregatedThroughput": "number",
"aggregatedIOPS": "number",
"metadata": {
"attachedClusters": [
{
"clusterName": "string",
"storage": "number"
}
],
"vendor": "string",
"fileSystem": "string",
"dataTransfer": "number",
"sizingAssumptions": [
"string"
]
}
}
],
"vmExceptions": {
"vmExceptionInfo": [
{
"vmId": "vm-123",
"vmGroupId": "vm-gp-123",
"vmName": "oracleVM",
"totalVCPU": 1000,
"totalRAM": 1512,
"totalDisk": 10020,
"usedDisk": 10010,
"exceptionReason": "Memory insufficient",
"importedFileName": "file1.xlsx",
"unsupportedResourceTypes": [
"string"
],
"notes": [
"string"
],
"uploadedWorkloadProfile": "WorkloadProfile 1",
"preferredHostType": "I4I",
"chosenHostType": "I4I"
}
],
"vmExceptionAssumptions": [
"The Virtual Machine would consume 75% or more CPU resources on a single host.",
"The Virtual Machine would consume 75% of more RAM resources on a single host.",
"The Virtual Machine would consume 50% of more available raw storage on a single host."
]
},
"addonsList": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"categoryID": "string",
"additionalData": {
"numberOfVMs": 1500,
"addonComponents": [
{
"id": "HCX",
"name": "string",
"isEnabled": true,
"addonMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
]
}
}
],
"cloudEdition": {
"id": "string",
"name": "VMware Cloud on AWS - Advanced",
"type": "string",
"enabled": false,
"cloudEditionServices": [
{
"id": "string",
"serviceMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"cloudEditionCompoments": [
{
"id": "string",
"componentMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
},
"enabled": false,
"isMandatory": false,
"isCustomSizerAvailable": false,
"customerSizerMetadata": {
"name": "string",
"apiUrl": "string"
}
}
]
}
],
"cloudEditionMetrics": {
"vCPU": 50,
"vRAM": 100,
"vDisk": 1000,
"iops": "number"
}
}
}
],
"sizingAssumtions": [
"Default CPU Headroom: 15%",
"Default Memory utilization: 100"
],
"sizingAssumptions": [
"Default CPU Headroom: 15%",
"Default Memory utilization: 100"
],
"calculationLog": "string"
}array of string
sizingAssumtions
Optional
Deprecated. Refer sizingAssumptions instead.
array of string
sizingAssumptions
Optional
Assumptions for the SDDC done while doing calculation for the workloads.
string
calculationLog
Optional
The log containing the calculation of the number of nodes required
201
Recommendation executed successfully for the requested API.
Operation doesn't return any data structure
400
Bad Request occurred for the requested path.
Operation doesn't return any data structure
401
Unauthorized to access the API.
Operation doesn't return any data structure
403
Forbidden to access the API.
Operation doesn't return any data structure
404
Requested API is Not Found.
Operation doesn't return any data structure
500
Internal Server Error occurred for the requested path.
Operation doesn't return any data structure
On This Page
Vmware Cloud Sizing Operations
POST
Get Workload Based Sizing Recommendation
POST
Host Based Sizing Recommendation