Changed2

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

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": {
		"key": {
			"averageMetrics": {
				"avgMemoryPerVM": 0,
				"avgStoragePerVM": 0,
				"avgVCpuPerCore": 0,
				"avgVCpusPerVM": 0
			},
			"request": {
				"configurations": {
					"applianceSize": "REGULAR",
					"cloudType": "VMC_ON_AWS",
					"clusterType": "SAZ",
					"computeOvercommitFactor": 4,
					"fttFtmType": "AUTO_AUTO",
					"includeManagementVMs": true,
					"instanceSettingsList": [
						{
							"hostType": "I3",
							"name": "DEDUP_RATIO",
							"value": "1.5"
						}
					],
					"memoryOvercommitFactor": 1,
					"sddcHostType": "ALL",
					"storageThresholdFactor": 1,
					"vmOutlierLimits": {
						"cpuLimit": 0,
						"memoryLimit": 0,
						"storageLimit": 0
					}
				},
				"workloadProfiles": [
					{
						"addonsList": [
							{
								"id": "HCX",
								"isEnabled": false,
								"isGlobalAddOn": false,
								"name": "string"
							}
						],
						"configurations": {
							"applianceSize": "REGULAR",
							"cloudType": "VMC_ON_AWS",
							"clusterType": "SAZ",
							"computeOvercommitFactor": 4,
							"fttFtmType": "AUTO_AUTO",
							"includeManagementVMs": true,
							"instanceSettingsList": [
								{
									"hostType": "I3",
									"name": "DEDUP_RATIO",
									"value": "1.5"
								}
							],
							"memoryOvercommitFactor": 1,
							"sddcHostType": "ALL",
							"storageThresholdFactor": 1,
							"vmOutlierLimits": {
								"cpuLimit": 0,
								"memoryLimit": 0,
								"storageLimit": 0
							}
						},
						"vmList": [
							{
								"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": {
									"readIOPS": 100,
									"vmdkTotal": 200,
									"vmdkUsed": 140,
									"writeIOPS": 30
								}
							}
						]
					}
				]
			},
			"vmException": {
				"exceptionVMs": {
					"exceptionReason": "Memory insufficient",
					"totalDisk": 10020,
					"totalRAM": 1512,
					"totalVCPU": 1000,
					"usedDisk": 10010,
					"vmGroupId": "vm-gp-123",
					"vmId": "vm-123",
					"vmName": "oracleVM"
				},
				"limitedHostCompatablityVMs": {
					"exceptionReason": "Memory insufficient",
					"totalDisk": 10020,
					"totalRAM": 1512,
					"totalVCPU": 1000,
					"usedDisk": 10010,
					"vmGroupId": "vm-gp-123",
					"vmId": "vm-123",
					"vmName": "oracleVM"
				}
			}
		}
	}
}

map of Stats

response Optional

Holds the Stats for each kind of SddcHostType

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