Introduced1 Changed2 Deleted1

[{"label":"Latest (v5)","version":"latest"},{"version":"v4"}]

vmc-sizer

Get Workload Based Sizing Recommendation

Description

Get sizing estimates for the resources required to run various workloads within VMware Cloud. Currently supported cloud providers are VMware Cloud on AWS and Google Cloud VMware Engine.

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

URL

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

VMCSizerRequest of mimetype application/json Required

The sizing recommendation request with workload characteristics.

Show optional properties

{
	"configurations": {
		"addonsList": [
			{
				"additionalData": {
					"numberOfVMs": 1500
				},
				"addonMetrics": {
					"vCPU": 50,
					"vDisk": 1000,
					"vRAM": 100
				},
				"categoryID": "string",
				"id": "HCX",
				"isEnabled": true,
				"name": "string"
			}
		],
		"applianceSize": "REGULAR",
		"cloudType": "VMC_ON_AWS",
		"clusterType": "SAZ",
		"compressionRatio": 1.25,
		"computeOvercommitFactor": 4,
		"cpuHeadroom": 0.15,
		"cpuUtilization": 30,
		"dedupRatio": 1.5,
		"fttFtmType": "AUTO_AUTO",
		"hyperThreadingFactor": 1.25,
		"includeManagementVMs": true,
		"ioAccessPattern": "string",
		"ioRatio": "string",
		"ioSize": "string",
		"memoryOvercommitFactor": 1,
		"memoryUtilization": 100,
		"sddcHostType": "I4I",
		"separateClusters": false,
		"storageThresholdFactor": 1,
		"totalIOPs": 2000,
		"vmOutlierLimits": {
			"cpuLimit": 0.75,
			"memoryLimit": 0.75,
			"storageLimit": 0.5
		}
	},
	"workloadProfiles": [
		{
			"configurations": {
				"addonsList": [
					{
						"additionalData": {
							"numberOfVMs": 1500
						},
						"addonMetrics": {
							"vCPU": 50,
							"vDisk": 1000,
							"vRAM": 100
						},
						"categoryID": "string",
						"id": "HCX",
						"isEnabled": true,
						"name": "string"
					}
				],
				"applianceSize": "REGULAR",
				"cloudType": "VMC_ON_AWS",
				"clusterType": "SAZ",
				"compressionRatio": 1.25,
				"computeOvercommitFactor": 4,
				"cpuHeadroom": 0.15,
				"cpuUtilization": 30,
				"dedupRatio": 1.5,
				"fttFtmType": "AUTO_AUTO",
				"hyperThreadingFactor": 1.25,
				"includeManagementVMs": true,
				"ioAccessPattern": "string",
				"ioRatio": "string",
				"ioSize": "string",
				"memoryOvercommitFactor": 1,
				"memoryUtilization": 100,
				"sddcHostType": "I4I",
				"separateClusters": false,
				"storageThresholdFactor": 1,
				"totalIOPs": 2000,
				"vmOutlierLimits": {
					"cpuLimit": 0.75,
					"memoryLimit": 0.75,
					"storageLimit": 0.5
				}
			},
			"extStorageVendorType": "FSX_N",
			"fileImportType": {
				"fileName": "liveoptics.xslx",
				"fileType": "LIVE_OPTICS"
			},
			"isEnabled": true,
			"profileName": "Workload profile 1",
			"separateCluster": true,
			"storagePreference": "vSAN_EXT_STORAGE",
			"vmList": [
				{
					"importedFileName": "file1.xlsx",
					"vmComputeInfo": {
						"utilizationRatio": 30,
						"vCpu": 4,
						"vCpuOverall": 4,
						"vCpuPerCore": 1
					},
					"vmGroupId": "vm-gp-123",
					"vmId": "vm-123",
					"vmMemoryInfo": {
						"ramOverhead": 70,
						"utilizationRatio": 100,
						"vRam": 4,
						"vRamConsumed": 3
					},
					"vmName": "oracleVM",
					"vmState": "RUNNING",
					"vmStorageInfo": {
						"extStorageVendorType": "FSX_N",
						"peakReadIOPs": 20,
						"peakReadThroughput": 0,
						"peakWriteIOPs": 10,
						"peakWriteThroughput": 0,
						"readIOPS": 100,
						"readThroughput": 0,
						"vmdkTotal": 200,
						"vmdkUsed": 140,
						"writeIOPS": 30,
						"writeThroughput": 0
					},
					"workloadProfileIndex": 0
				}
			],
			"workloadProfileType": "GPW_GVM"
		}
	]
}

VMCConfigurations

configurations Required

The VM Sizing configurations required for computation.

array of WorkloadProfile

workloadProfiles Required

Workload profile comprises of the VM configurations and complete VM List.

Authentication

This operation uses the following authentication methods.

cspAuthToken

Response

Response Body

200 OK

Returns VMCSizerResponse of type application/json

{
    "sizingAssumtions": [
        "Default CPU Headroom: 15%",
        "Default Memory utilization: 100"
    ]
}

string

calculationLog Optional

The log containing the calculation of the number of nodes required

array of SDDCInfo

sddcList Optional

List of SDDC for SAZ and MAZ cluster details.

array of string

sizingAssumtions Optional

Assumptions for the SDDC done while doing calcultaion for the workloads.

201 Created

Recommendation executed successfully for the requested API.

Operation doesn't return any data structure.

Errors

400

Bad Request occurred for the requested path.

401

Unauthorized to access the API.

403

Forbidden to access the API.

404

Requested API is Not Found.

500

Internal Server Error occurred for the requested path.

Code Samples

cURL Command

curl -X POST -H "Content-Type: application/json" -d '{"configurations":{"addonsList":[{"additionalData":{"numberOfVMs":1500},"addonMetrics":{"vCPU":50,"vDisk":1000,"vRAM":100},"categoryID":"string","id":"HCX","isEnabled":true,"name":"string"}],"applianceSize":"REGULAR","cloudType":"VMC_ON_AWS","clusterType":"SAZ","compressionRatio":1.25,"computeOvercommitFactor":4,"cpuHeadroom":0.15,"cpuUtilization":30,"dedupRatio":1.5,"fttFtmType":"AUTO_AUTO","hyperThreadingFactor":1.25,"includeManagementVMs":true,"ioAccessPattern":"string","ioRatio":"string","ioSize":"string","memoryOvercommitFactor":1,"memoryUtilization":100,"sddcHostType":"I4I","separateClusters":false,"storageThresholdFactor":1,"totalIOPs":2000,"vmOutlierLimits":{"cpuLimit":0.75,"memoryLimit":0.75,"storageLimit":0.5}},"workloadProfiles":[{"configurations":{"addonsList":[{"additionalData":{"numberOfVMs":1500},"addonMetrics":{"vCPU":50,"vDisk":1000,"vRAM":100},"categoryID":"string","id":"HCX","isEnabled":true,"name":"string"}],"applianceSize":"REGULAR","cloudType":"VMC_ON_AWS","clusterType":"SAZ","compressionRatio":1.25,"computeOvercommitFactor":4,"cpuHeadroom":0.15,"cpuUtilization":30,"dedupRatio":1.5,"fttFtmType":"AUTO_AUTO","hyperThreadingFactor":1.25,"includeManagementVMs":true,"ioAccessPattern":"string","ioRatio":"string","ioSize":"string","memoryOvercommitFactor":1,"memoryUtilization":100,"sddcHostType":"I4I","separateClusters":false,"storageThresholdFactor":1,"totalIOPs":2000,"vmOutlierLimits":{"cpuLimit":0.75,"memoryLimit":0.75,"storageLimit":0.5}},"extStorageVendorType":"FSX_N","fileImportType":{"fileName":"liveoptics.xslx","fileType":"LIVE_OPTICS"},"isEnabled":true,"profileName":"Workload profile 1","separateCluster":true,"storagePreference":"vSAN_EXT_STORAGE","vmList":[{"importedFileName":"file1.xlsx","vmComputeInfo":{"utilizationRatio":30,"vCpu":4,"vCpuOverall":4,"vCpuPerCore":1},"vmGroupId":"vm-gp-123","vmId":"vm-123","vmMemoryInfo":{"ramOverhead":70,"utilizationRatio":100,"vRam":4,"vRamConsumed":3},"vmName":"oracleVM","vmState":"RUNNING","vmStorageInfo":{"extStorageVendorType":"FSX_N","peakReadIOPs":20,"peakReadThroughput":0,"peakWriteIOPs":10,"peakWriteThroughput":0,"readIOPS":100,"readThroughput":0,"vmdkTotal":200,"vmdkUsed":140,"writeIOPS":30,"writeThroughput":0},"workloadProfileIndex":0}],"workloadProfileType":"GPW_GVM"}]}' https://vmc.vmware.com/api/vmc-sizer/v5/recommendation

[{"label":"Latest (v5)","version":"latest"},{"version":"v4"}]

vmc-sizer

What's changed in v5?

CHANGED (2)

Property changed
operationId

INTRODUCED (1)

Added Parameters

vmPlacement

DELETED (1)

Removed Parameters

cloudProviderType

VMware Cloud Sizing Operations

post

Get Workload Based Sizing Recommendation Changed

post

Host Based Sizing Recommendation Introduced

Get Workload Based Sizing Recommendation

Request

URL

Query Parameters

vmPlacement example

Request Body

Authentication

cspAuthToken

Response

Response Body

200 OK

201 Created

Errors

Code Samples

cURL Command

What's changed in v5?

On This Page

VMware Cloud Sizing Operations

Was this page helpful?