Developer Documentation
Create A New SDDC
Provision an SDDC in target cloud
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs
Path Parameters
Path Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Organization identifier |
Query Parameters
Query Parameters
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
boolean | When true, only validates the given sddc configuration without provisioning. |
Request Body
Request Body
Contains
AwsSddcConfig
(required)
{
"name": "string",
"num_hosts": 0,
"provider": "string"
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | name | string | Not available |
| required | num_hosts | integer | Not available |
| required | provider | string |
Determines what additional properties are available based on cloud provider. |
| optional | account_link_config | AccountLinkConfig |
The account linking configuration, we will keep this one and remove accountLinkSddcConfig finally. |
| optional | account_link_sddc_config | array of AccountLinkSddcConfig |
A list of the SDDC linking configurations to use. |
| optional | deployment_type | string |
Denotes if request is for a SingleAZ or a MultiAZ SDDC. Default is SingleAZ. Possible values are: MultiAZ, SingleAZ |
| optional | host_instance_type | HostInstanceTypes |
The instance type for the esx hosts in the primary cluster of the SDDC. Possible values are: |
| optional | msft_license_config | MsftLicensingConfig |
Indicates the desired licensing support, if any, of Microsoft software. |
| optional | region | string | Not available |
| optional | sddc_id | string |
If provided, will be assigned as SDDC id of the provisioned SDDC. |
| optional | sddc_template_id | string |
If provided, configuration from the template will applied to the provisioned SDDC. |
| optional | sddc_type | string |
Denotes the sddc type , if the value is null or empty, the type is considered as default. |
| optional | size | string |
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: large, medium, nsx_large, nsx_small |
| optional | skip_creating_vxlan | boolean |
skip creating vxlan for compute gateway for SDDC provisioning |
| optional | sso_domain | string |
The SSO domain name to use for vSphere users. If not specified, vmc.local will be used. |
| optional | storage_capacity | integer |
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. |
| optional | vpc_cidr | string |
AWS VPC IP range. Only prefix of 16 or 20 is currently supported. |
| optional | vxlan_subnet | string |
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
}| Property Name | Type | Description |
|---|---|---|
| created | string | Not available |
| id | string |
Unique ID for this entity |
| start_time | string | Not available |
| status | string | Not available |
| sub_status | string | Not available |
| task_type | string | Not available |
| updated | string | Not available |
| updated_by_user_id | string |
User id that last updated this record |
| user_id | string |
User id that last updated this record |
| user_name | string |
User name that last updated this record |
| version | integer |
Version of this entity |
| correlation_id | string |
(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. |
| end_resource_entity_version | integer |
Entity version of the resource at the end of the task. This is only set for some task types. |
| end_time | string | Not available |
| error_message | string | Not available |
| estimated_remaining_minutes | integer |
Estimated remaining time in minute of the task execution, < 0 means no estimation for the task. |
| localized_error_message | string | Not available |
| org_id | string | Not available |
| org_type | string | Not available |
| params | object | Not available |
| parent_task_id | string |
If this task was created by another task - this provides the linkage. Mostly for debugging. |
| phase_in_progress | string |
The current in progress phase ID in the task execution, if none in progress, empty string returned. |
| progress_percent | integer |
Estimated progress percentage the task executed |
| resource_id | string |
UUID of the resource the task is acting upon |
| resource_type | string |
Type of resource being acted upon |
| service_errors | array of ServiceError |
Service errors returned from SDDC services. |
| start_resource_entity_version | integer |
Entity version of the resource at the start of the task. This is only set for some task types. |
| task_progress_phases | array of TaskProgressPhase |
Task progress phases involved in current task execution |
| task_version | string | Not available |
| updated_by_user_name | string |
User name that last updated this record |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Nothing | The request requires user authentication. |
| 403 | Nothing | The server understood the request, but is refusing to fulfill it. |
On This Page
SDDC Configuration Operations
post
post
delete
get
get
patch
