Changed1

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

vmc-sizer

Parse Excel File

Description

Parses the excel file and outputs a JSON that can be consumed by the sizing engine

Request

URL

post

https://vmc.vmware.com/api/vmc-sizer/v5/sizing/adapter/{fileType}

Copy

Path Parameters

string

fileType Required

fileType example

"live-optics"

Query Parameters

SizingCapacity

memoryType Optional

array of VMState

powerState Optional

SizingCapacity

storageType Optional

Request Body

InlineSizingAdapterFileType_RequestBody of mimetype multipart/form-data Optional

Authentication

This operation uses the following authentication methods.

cspAuthToken

Response

Response Body

200 OK

Returns ParserResponse of type application/json

{
	"response": {
		"averageMetrics": {
			"avgMemoryPerVM": 0,
			"avgStoragePerVM": 0,
			"avgVCpuPerCore": 0,
			"avgVCpusPerVM": 0
		},
		"sizerRequest": {
			"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": "AUTO",
					"fileImportType": {
						"fileName": "liveoptics.xslx",
						"fileType": "LIVE_OPTICS"
					},
					"isEnabled": true,
					"metadata": {
						"averageMetrics": {
							"avgMemoryPerVM": 0,
							"avgStoragePerVM": 0,
							"avgVCpuPerCore": 0,
							"avgVCpusPerVM": 0
						}
					},
					"profileName": "Workload profile 1",
					"separateCluster": true,
					"storagePreference": "vSAN_ONLY",
					"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"
				}
			]
		}
	}
}

Stats

response Optional

The stats regarding the parsed VMs

Errors

400

Bad request

413

Payload too large (At present we can only size upto 10,000 VMs)

500

Internal server error

Code Samples

cURL Command

curl -X POST -H "Content-Type: multipart/form-data" -d '{"excelFile":"string"}' https://vmc.vmware.com/api/vmc-sizer/v5/sizing/adapter/live-optics