SddcSpec
SddcSpec
VCF Installer specification
JSON Example
{
"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"
}
string
As ^[a-zA-Z0-9-]+$
sddcId
Required
Constraints:
minLength: 3
maxLength: 20
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.
string
As (VCF|VCF_COMPLETE|VCF_EXTEND|VVF|VCF_BOOTSTRAP)
workflowType
Optional
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.
string
version
Optional
Version
array of
DvsSpec
dvsSpecs
Optional
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
array of
SddcNetworkSpec
networkSpecs
Required
List of Networks which be created and used for Management Cluster
array of
string
ntpServers
Optional
List of NTP servers to be used for configuring Management Appliances
string
managementPoolName
Optional
Name for the network pool to be created and associated with the Management Cluster
boolean
ceipEnabled
Optional
Enable VCF Customer Experience Improvement Program
boolean
skipEsxThumbprintValidation
Optional
Skip ESXi thumbprint validation. Applies to both converting an existing environment and deploying a new one
boolean
skipGatewayPingValidation
Optional
Skip networks gateway connectivity validation
telemetryAcceptorSpec
Optional
Specification for deploy/configure of Telemetry acceptor service
vcfOperationsCollectorSpec
Optional
Specification for VCF Operations collector
vcfManagementComponentsInfrastructureSpec
Optional
Specification for infrastructure to be used for VCF Management Components deployment
string
vcfInstanceName
Optional
Constraints:
minLength: 1
maxLength: 300
VCF Instance name. Minimum length 1, maximum length 300
Returned By