Create A New SDDC
Provision an SDDC in target cloud
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs
Parameters
Parameters
string
org
Required
Organization identifier
Query Parameters
Query Parameters
boolean
validateOnly
Optional
When true, only validates the given sddc configuration without provisioning.
Request Body
Request Body
AwsSddcConfig (required){
"name": "string",
"num_hosts": 0,
"provider": "string"
}
string
name
Required
Not available
integer
num_hosts
Required
Not available
string
provider
Required
Determines what additional properties are available based on cloud provider.
Possible values are: AWS, ZEROCLOUD
account_link_config
Optional
The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally.
array of
AccountLinkSddcConfig
account_link_sddc_config
Optional
A list of the SDDC linking configurations to use.
string
deployment_type
Optional
Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ.
Possible values are: SingleAZ, MultiAZ
host_instance_type
Optional
The instance type for the esx hosts in the primary cluster of the SDDC.
Possible values are:
msft_license_config
Optional
Indicates the desired licensing support, if any, of Microsoft software.
string
region
Optional
Not available
string
sddc_id
Optional
If provided, will be assigned as SDDC id of the provisioned SDDC.
string
sddc_template_id
Optional
If provided, configuration from the template will applied to the provisioned SDDC.
string
sddc_type
Optional
Denotes the sddc type , if the value is null or empty, the type is considered as default.
string
size
Optional
The size of the vCenter and NSX appliances. “large” sddcSize corresponds to a ‘large’ vCenter appliance and ‘large’ NSX appliance. ‘medium’ sddcSize corresponds to ‘medium’ vCenter appliance and ‘medium’ NSX appliance. Value defaults to ‘medium’.
Possible values are: nsx_small, medium, large, nsx_large
boolean
skip_creating_vxlan
Optional
skip creating vxlan for compute gateway for SDDC provisioning
string
sso_domain
Optional
The SSO domain name to use for vSphere users. If not specified, vmc.local will be used.
integer
storage_capacity
Optional
The storage capacity value to be requested for the sddc primary cluster, in GiBs. If provided, instead of using the direct-attached storage, a capacity value amount of seperable storage will be used.
string
vpc_cidr
Optional
AWS VPC IP range. Only prefix of 16 or 20 is currently supported.
string
vxlan_subnet
Optional
VXLAN IP subnet in CIDR for compute gateway
Response
Response
Response BodyResponse Body
202 Accepted returns
Task
{
"correlation_id": "string",
"created": "string",
"end_resource_entity_version": 5,
"end_time": "string",
"error_message": "string",
"estimated_remaining_minutes": 4,
"id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"localized_error_message": "string",
"org_id": "1d1c83ee-e0b7-4de9-b660-9a9ca1d22f32",
"org_type": "string",
"parent_task_id": "string",
"phase_in_progress": "string",
"progress_percent": 75,
"resource_id": "string",
"resource_type": "string",
"service_errors": [
{
"default_message": "string",
"localized_message": "string",
"original_service": "string",
"original_service_error_code": "string"
}
],
"start_resource_entity_version": 0,
"start_time": "string",
"status": "string",
"sub_status": "string",
"task_progress_phases": [
{
"id": "string",
"name": "string",
"progress_percent": 0
}
],
"task_type": "string",
"task_version": "string",
"updated": "string",
"updated_by_user_id": "string",
"updated_by_user_name": "string",
"user_id": "string",
"user_name": "string",
"version": 5
}
string
created
Required
Not available
string
id
Required
Unique ID for this entity
string
start_time
Required
Not available
string
status
Required
Not available
Possible values are: STARTED, CANCELING, FINISHED, FAILED, CANCELED
string
sub_status
Required
Not available
string
task_type
Required
Not available
string
updated
Required
Not available
string
updated_by_user_id
Required
User id that last updated this record
string
user_id
Required
User id that last updated this record
string
user_name
Required
User name that last updated this record
integer
version
Required
Version of this entity
string
correlation_id
Optional
(Optional) Client provided uniqifier to make task creation idempotent. Be aware not all tasks support this. For tasks that do - supplying the same correlation Id, for the same task type, within a predefined window will ensure the operation happens at most once.
integer
end_resource_entity_version
Optional
Entity version of the resource at the end of the task. This is only set for some task types.
string
end_time
Optional
Not available
string
error_message
Optional
Not available
integer
estimated_remaining_minutes
Optional
Estimated remaining time in minute of the task execution, < 0 means no estimation for the task.
string
localized_error_message
Optional
Not available
string
org_id
Optional
Not available
string
org_type
Optional
Not available
object
params
Optional
Not available
string
parent_task_id
Optional
If this task was created by another task - this provides the linkage. Mostly for debugging.
string
phase_in_progress
Optional
The current in progress phase ID in the task execution, if none in progress, empty string returned.
integer
progress_percent
Optional
Estimated progress percentage the task executed
string
resource_id
Optional
UUID of the resource the task is acting upon
string
resource_type
Optional
Type of resource being acted upon
integer
start_resource_entity_version
Optional
Entity version of the resource at the start of the task. This is only set for some task types.
array of
TaskProgressPhase
task_progress_phases
Optional
Task progress phases involved in current task execution
string
task_version
Optional
Not available
string
updated_by_user_name
Optional
User name that last updated this record
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"account_link_config":{"delay_account_link":false},"account_link_sddc_config":[{"connected_account_id":"string","customer_subnet_ids":["string"]}],"deployment_type":"string","host_instance_type":"enum","msft_license_config":{"mssql_licensing":"string","windows_licensing":"string"},"name":"string","num_hosts":0,"provider":"string","region":"string","sddc_id":"string","sddc_template_id":"string","sddc_type":"string","size":"string","skip_creating_vxlan":false,"sso_domain":"string","storage_capacity":0,"vpc_cidr":"string","vxlan_subnet":"string"}' https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs
Errors
Not available
401
The request requires user authentication.
Not available
403
The server understood the request, but is refusing to fulfill it.
On This Page
SDDC Configuration Operations
post
post
delete
get
get
patch
