Resources Calculation
VCF Installer specification incorporates all the client inputs regarding VCF (or VVF) components constituting the installation. Validates the required and available resources to deploy the VCF instance by the supplied specification
Show optional properties
{
"sddcId": "sfo01-m01",
"vcenterSpec": {
"vcenterHostname": "vcenter.rainpole.io",
"rootVcenterPassword": "Sample_Password123"
},
"networkSpecs": [
{
"networkType": "MANAGEMENT",
"vlanId": 1000
}
],
"dnsSpec": {
"subdomain": "vcf.broadcom.com"
}
}{
"sddcId": "sfo01-m01",
"workflowType": "One among: VCF, VCF_EXTEND, VVF",
"hostSpecs": [
{
"hostname": "esx-1",
"credentials": {
"username": "root",
"password": "string"
},
"sshThumbprint": "SHA256:rVPNWOKE2tZjvmYvKPhtc3ghJ41Vc0G3MwASf4+8+yc",
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
}
],
"version": "9.0.0.0",
"vcenterSpec": {
"vcenterHostname": "vcenter.rainpole.io",
"rootVcenterPassword": "Sample_Password123",
"vmSize": "medium",
"storageSize": "lstorage",
"ssoDomain": "string",
"adminUserSsoUsername": "string",
"adminUserSsoPassword": "string",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"clusterSpec": {
"datacenterName": "DatacenterName",
"clusterName": "ClusterName",
"clusterEvcMode": "One among: INTEL_MEROM, INTEL_PENRYN, INTEL_NEALEM, INTEL_WESTMERE, INTEL_SANDYBRIDGE, INTEL_IVYBRIDGE, INTEL_HASWELL, INTEL_BROADWELL, INTEL_SKYLAKE, INTEL_CASCADELAKE, INTEL_ICELAKE, INTEL_SAPPHIRERAPIDS, AMD_REV_E, AMD_REV_F, AMD_GREYHOUND_NO3DNOW, AMD_GREYHOUND, AMD_BULLDOZER, AMD_PILEDRIVER, AMD_STREAMROLLER, AMD_ZEN, AMD_ZEN2, AMD_ZEN3, AMD_ZEN4",
"resourcePoolSpecs": [
{
"name": "string",
"type": "string",
"cpuReservationPercentage": 0,
"cpuReservationMhz": 0,
"cpuLimit": 0,
"cpuReservationExpandable": false,
"cpuSharesLevel": "string",
"cpuSharesValue": 0,
"memoryReservationPercentage": 0,
"memoryReservationMb": 0,
"memoryLimit": 0,
"memoryReservationExpandable": false,
"memorySharesLevel": "string",
"memorySharesValue": 0
}
]
},
"dvsSpecs": [
{
"dvsName": "VdsName",
"networks": [
"MANAGEMENT"
],
"mtu": 9000,
"nsxtSwitchConfig": {
"transportZones": [
{
"name": "string",
"transportType": "One among: VLAN, OVERLAY"
}
],
"hostSwitchOperationalMode": "One among: STANDARD, ENS, ENS_INTERRUPT",
"ipAssignmentType": "string"
},
"vmnicsToUplinks": [
{
"id": "vmnic0",
"uplink": "uplink1"
}
],
"nsxTeamings": [
{
"policy": "One among: FAILOVER_ORDER, LOADBALANCE_SRCID, LOADBALANCE_SRC_MAC",
"activeUplinks": [
"string"
],
"standByUplinks": [
"string"
]
}
],
"lagSpecs": [
{
"name": "string",
"uplinksCount": 0,
"lacpMode": "One among:ACTIVE, PASSIVE",
"loadBalancingMode": "One among:SOURCE_MAC, DESTINATION_MAC, SOURCE_AND_DESTINATION_MAC, DESTINATION_IP_AND_VLAN, SOURCE_IP_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_VLAN, DESTINATION_TCP_UDP_PORT, SOURCE_TCP_UDP_PORT, SOURCE_AND_DESTINATION_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT, SOURCE_IP_AND_TCP_UDP_PORT, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT, DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_IP_AND_TCP_UDP_PORT_AND_VLAN, SOURCE_AND_DESTINATION_IP_AND_TCP_UDP_PORT_AND_VLAN, DESTINATION_IP, SOURCE_IP, SOURCE_AND_DESTINATION_IP, VLAN, SOURCE_PORT_ID",
"lacpTimeoutMode": "One among:SLOW, FAST"
}
]
}
],
"nsxtSpec": {
"nsxtManagers": [
{
"hostname": "string"
}
],
"nsxtManagerSize": "medium",
"vipFqdn": "string",
"rootNsxtManagerPassword": "string",
"nsxtAdminPassword": "string",
"nsxtAuditPassword": "string",
"transportVlanId": 1000,
"ipAddressPoolSpec": {
"name": "string",
"description": "string",
"ignoreUnavailableNsxtCluster": false,
"subnets": [
{
"ipAddressPoolRanges": [
{
"start": "string",
"end": "string"
}
],
"cidr": "string",
"gateway": "string"
}
]
},
"vpcSpec": {
"dtgwSpec": {
"vlan": 0,
"gatewayCidr": "string",
"externalIpBlockCidr": "string",
"privateTgwIpBlockCidr": "string"
}
},
"skipNsxOverlayOverManagementNetwork": false,
"enableEdgeClusterSync": true,
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"networkSpecs": [
{
"networkType": "MANAGEMENT",
"subnet": "10.0.0.250/24",
"gateway": "10.0.0.250",
"subnetMask": "255.255.255.0",
"includeIpAddress": [
"[10.0.0.100]"
],
"includeIpAddressRanges": [
{
"startIpAddress": "192.168.0.123",
"endIpAddress": "192.168.0.128"
}
],
"vlanId": 1000,
"mtu": 0,
"teamingPolicy": "loadbalance_ip",
"activeUplinks": [
"string"
],
"standbyUplinks": [
"string"
],
"portGroupKey": "string",
"ipAddressVersion": "IPv6",
"ipAddressAssignmentMode": "SLAAC"
}
],
"dnsSpec": {
"subdomain": "vcf.broadcom.com",
"nameservers": [
"[172.0.0.4, 172.0.0.5]"
]
},
"ntpServers": [
"[10.0.0.100, 10.0.0.101]"
],
"sddcManagerSpec": {
"rootPassword": "string",
"hostname": "string",
"sshPassword": "string",
"localUserPassword": "string",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"managementPoolName": "string",
"ceipEnabled": true,
"skipEsxThumbprintValidation": false,
"skipGatewayPingValidation": false,
"securitySpec": {
"esxiCertsMode": "VMCA",
"rootCaCerts": [
{
"alias": "string",
"certChain": [
"string"
]
}
]
},
"datastoreSpec": {
"nfsDatastoreSpec": {
"datastoreName": "string",
"nasVolume": {
"serverName": [
"string"
],
"path": "string",
"readOnly": false,
"userTag": "string",
"enableBindToVmknic": false
}
},
"vmfsDatastoreSpec": {
"fcSpec": [
{
"datastoreName": "string"
}
]
},
"vsanSpec": {
"datastoreName": "string",
"vsanDedup": false,
"esaConfig": {
"enabled": false
},
"encryptionConfig": {
"dataInTransitConfig": {
"enable": false,
"rekeyInterval": 0
}
},
"failuresToTolerate": 3
},
"existingDatastoreName": "string"
},
"vspClusterSpec": {
"platformFqdn": "vsp-cluster.rainpole.io",
"systemUserPassword": "Broadcom1@!#$%?^*",
"ipv4Pool": {
"cidr": "10.0.0.0/24",
"ipRange": {
"startIpAddress": "192.168.0.123",
"endIpAddress": "192.168.0.128"
},
"addresses": [
"[\"10.0.0.80\", \"10.0.0.81\", \"10.0.0.82\", ...]"
],
"excludedAddresses": [
"[\"10.0.0.81\", ...]"
]
},
"ipv6Pool": {
"cidr": "2001:db8::00/112",
"ipRange": {
"startIpAddress": "::",
"endIpAddress": "2001:0db8:0000:0000:0000:ff00:0042:8329"
},
"addresses": [
"[\"2001:db8::80\", \"2001:db8::81\", \"2001:db8::82\", ...]"
],
"excludedAddresses": [
"[\"2001:db8::81\", ...]"
]
},
"size": "Small",
"internalClusterCidrIpv4": "198.18.0.0/15",
"internalClusterCidrIpv6": "fd00::/111",
"instanceFqdn": "instance.rainpole.io",
"fleetFqdn": "instance.rainpole.io",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"fleetLcmSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"sddcLcmSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"fleetDepotSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"telemetryAcceptorSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"vidbSpec": {
"hostname": "vidb.vcf.local",
"version": "9.0.0.0.24597083",
"size": "small"
},
"saltSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"saltRaasSpec": {
"version": "9.0.0.0.24597083",
"size": "small"
},
"vcfOperationsSpec": {
"nodes": [
{
"hostname": "vcfoperations-master.rainpole.io",
"rootUserPassword": "string",
"type": "master",
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
}
],
"adminUserPassword": "string",
"applianceSize": "medium",
"loadBalancerFqdn": "string",
"useExistingDeployment": true,
"version": "9.0.0.0.24597083"
},
"vcfOperationsCollectorSpec": {
"hostname": "vcf-operations-collector.rainpole.io",
"rootUserPassword": "string",
"applianceSize": "small",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"vcfAutomationSpec": {
"hostname": "vcfautomation.rainpole.io",
"platformFqdn": "vsp-platform.rainpole.io",
"adminUserPassword": "string",
"ipPool": [
"['10.0.0.80', '10.0.0.81', '10.0.0.82', '10.0.0.83', '10.0.0.84', '10.0.0.85']"
],
"internalClusterCidr": "string",
"nodePrefix": "node-123",
"size": "small",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"vcfManagementComponentsInfrastructureSpec": {
"localRegionNetwork": {
"networkName": "string",
"subnetMask": "255.255.255.0",
"gateway": "10.0.0.250",
"ipv6Gateway": "string",
"ipv6Prefix": 0
},
"xRegionNetwork": {
"networkName": "string",
"subnetMask": "255.255.255.0",
"gateway": "10.0.0.250",
"ipv6Gateway": "string",
"ipv6Prefix": 0
}
},
"licenseServerSpec": {
"hostname": "license-server.rainpole.io",
"version": "9.0.0.0.24597083",
"useExistingDeployment": true,
"sslThumbprint": "3D:D0:EE:B5:A0:CC:45:08:5C:4F:84:51:CD:00:B6:41:BB:4A:A2:9A:77:1C:A6:4C:6D:84:5A:D0:4F:68:7A:B8"
},
"vcfInstanceName": "string"
}Client string that identifies an SDDC by name or instance name. Used for management domain name. Can contain only letters, numbers and the following symbols: '-'. Minimum length 3, maximum length 20.
Type of workflow to initiate creation and/or validation of SDDC. If building a secondary VCF instance to connect it to the fleet, specify workflowType as VCF_EXTEND.
List of ESXi to be added to the Management Cluster
Version
Spec contains parameters for vCenter
Spec contains parameters for vCenter Cluster
List of vSphere Distributed Switches to be created. For VCF only: if blank, a default single one will be created for all types of traffic connected to vmnic0 and vmnic1
Spec contains parameters for NSX deployment and configurations
List of Networks which be created and used for Management Cluster
Spec contains parameters of Domain Name System
List of NTP servers to be used for configuring Management Appliances
Client input parameters for SDDC Manager Virtual Machine
Name for the network pool to be created and associated with the Management Cluster
Enable VCF Customer Experience Improvement Program
Skip ESXi thumbprint validation. Applies to both converting an existing environment and deploying a new one
Skip networks gateway connectivity validation
Spec contains security settings
This specification contains cluster storage configuration
Specification VSP cluster deployment
Specification for deploy/configure of Fleet LCM service
Specification for deploy/configure of a SDDC LCM service
Specification for deploy/configure of Software Depot
Specification for deploy/configure of Telemetry acceptor service
Specification for VIDB
Specification for Salt services
Specification for Salt services
Specification for VCF Operations
Specification for VCF Operations collector
Specification for VCF Automation
Specification for infrastructure to be used for VCF Management Components deployment
Specification for License Server
VCF Instance name. Minimum length 1, maximum length 300
Accepted
{
"id": "string",
"description": "string",
"executionStatus": "COMPLETED",
"resultStatus": "SUCCEEDED",
"validationChecks": [
{
"description": "string",
"severity": "One among: WARNING, ERROR, INFO",
"resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS, PENDING",
"acknowledge": false,
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
{
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
}
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
},
"nestedValidationChecks": [
{
"description": "string",
"severity": "One among: WARNING, ERROR, INFO",
"resultStatus": "One among: IN_PROGRESS, SUCCEEDED, FAILED, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS, PENDING",
"acknowledge": false,
"errorResponse": {
"errorCode": "string",
"errorType": "string",
"arguments": [
"string"
],
"context": {
"context": "string"
},
"notifications": [
{
"severity": "string",
"message": "string",
"remediations": [
{
"message": "string",
"link": "string"
}
],
"impactMessage": "string"
}
],
"message": "string",
"remediationMessage": "string",
"causes": [
{
"type": "string",
"message": "string"
}
],
"nestedErrors": [
"Error Object"
],
"referenceToken": "string",
"label": "string",
"remediationUrl": "string"
},
"nestedValidationChecks": [
"ValidationCheck Object"
]
}
]
}
],
"additionalProperties": {
"additionalProperties": "string"
},
"requiredCapacity": {
"numberOfCores": 0,
"memory": {
"value": "number",
"unit": "string"
},
"storage": {
"value": "number",
"unit": "string"
},
"numberOfEsxiHosts": 0,
"componentsVmRequirements": [
{
"cpuCores": 0,
"memoryGb": "number",
"storageGb": 0,
"ipCount": 0,
"ipCountRecommended": 0,
"ipCountLimit": 0,
"workersCount": 0,
"component": "string",
"componentType": "string"
}
],
"context": {
"context": "string"
}
},
"availableCapacity": {
"numberOfCores": 0,
"memory": {
"value": "number",
"unit": "string"
},
"storage": {
"value": "number",
"unit": "string"
},
"numberOfEsxiHosts": 0,
"componentsVmRequirements": [
{
"cpuCores": 0,
"memoryGb": "number",
"storageGb": 0,
"ipCount": 0,
"ipCountRecommended": 0,
"ipCountLimit": 0,
"workersCount": 0,
"component": "string",
"componentType": "string"
}
],
"context": {
"context": "string"
}
}
}ID of the validation
Description of the validation
Execution status of the validation. One among: IN_PROGRESS, FAILED, COMPLETED, UNKNOWN, SKIPPED, CANCELLED, CANCELLATION_IN_PROGRESS
Result status of the validation after it has completed its execution. One among: SUCCEEDED, FAILED, WARNING, UNKNOWN, CANCELLATION_IN_PROGRESS
List of one or more validation checks that are performed as part of the validation
additionalProperties
Represents a usage and capacity information of a Resource
Represents a usage and capacity information of a Resource
Bad user input
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Forbidden
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
Internal Server Error
"Error Object"The minor error code
The error type
The arguments used to localize the message, Can be used by scripts to automate the error processing.
The error context (e.g. the component where it occurred).
Detailed results of the precheck validation.
The localized error message
The localized remediation error message
The underlying cause exceptions.
A reference token correlating the error with the relevant detailed error logs. Should be sent to the service provider when reporting issues.
The localized label message
The URL string for remediation documentation link
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"dnsSpec":"object","networkSpecs":["object"],"sddcId":"string","vcenterSpec":"object"}' https://{api_host}/v1/sddcs/resources-calculation