Parse Excel File

Parse Excel File

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

Request
URI
POST
https://vmc.vmware.com/api/vmc-sizer/v5/sizing/adapter/{fileType}
COPY
Path Parameters
string
fileType
Required

fileType

fileType example
live-optics
Possible values are : live-optics, rv-tools, vrops,
Query Parameters
storageType
Optional

storageType

memoryType
Optional

memoryType

of VMState array
powerState
Optional

powerState


Request Body
File of type(s) multipart/form-data
Optional
{
    "excelFile": "string"
}
string
excelFile
Optional

excelFile

Authentication
This operation uses the following authentication methods.
Responses
200

OK

Returns ParserResponse of type(s) application/json
{
    "response": {
        "sizerRequest": {
            "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"
                        }
                    }
                }
            ]
        },
        "averageMetrics": {
            "avgVCpuPerCore": "number",
            "avgVCpusPerVM": "number",
            "avgMemoryPerVM": "number",
            "avgStoragePerVM": "number"
        }
    }
}
response
Optional

response


400

Bad request

Operation doesn't return any data structure

413

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

Operation doesn't return any data structure

500

Internal server error

Operation doesn't return any data structure