[{"label":"Latest (v1.1)","version":"latest"}]
vmc
Addhostprechecktask SDDCs
DescriptionTriggers an add host precheck task
Request
URLURL
https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/add-hosts-precheck
Path Parameters
Path Parameters
string
org
Required
Organization identifier
string
sddc
Required
Sddc identifier
Request Body
Request Body
{
"num_hosts": 0
}
integer as int32
num_hosts
Required
string
availability_zone
Optional
Availability zone where the hosts should be provisioned. (Can be specified only for privileged host operations).
string
cluster_id
Optional
An optional cluster id if the esxs operation has to be on a specific cluster.
array of
string as UUID
esxs
Optional
An optional list of ESX IDs to remove.
boolean
strict_placement
Optional
An option to indicate if the host needs to be strictly placed in a placement group. Fail the operation otherwise.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
202 Accepted
Returns
Task
of type(s) application/json
This response body class contains all of the following:
AbstractEntity, InlineTask1
Errors
ErrorResponse
400
Bad Request.
401
Unauthorized
ErrorResponse
403
Access not allowed to the operation for the current user.
ErrorResponse
404
Cannot find the SDDC with the given id.
Code Samples
PowerCLI Client SDK Example
$EsxConfig = Initialize-EsxConfig -AvailabilityZone "MyAvailabilityZone" -StrictPlacement $false -ClusterId "MyClusterId" -Esxs "MyEsxs" -NumHosts 0
Invoke-OrgsOrgSddcsSddcAddHostsPrecheckPost -Org "MyOrg" -Sddc "MySddc" -EsxConfig $EsxConfig
PowerCLI Client SDK Example
$EsxConfig = Initialize-EsxConfig -AvailabilityZone "MyAvailabilityZone" -StrictPlacement $false -ClusterId "MyClusterId" -Esxs "MyEsxs" -NumHosts 0
Invoke-OrgsOrgSddcsSddcAddHostsPrecheckPost -Org "MyOrg" -Sddc "MySddc" -EsxConfig $EsxConfig
cURL Command
curl -X POST -H "Content-Type: application/json" -d '{"availability_zone":"string","cluster_id":"string","esxs":["string"],"num_hosts":0,"strict_placement":false}' https://vmc.vmware.com/vmc/api/orgs/{org}/sddcs/{sddc}/add-hosts-precheck
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmc-ui-servicename: sddcs
x-vmw-vapi-methodname: addHostPrecheckTask
[{"label":"Latest (v1.1)","version":"latest"}]
vmc
