This API has a deprecated equivalent from v7.0U1.
Reconfigure Deployment Type
DescriptionReconfigure the type of the vCenter appliance.
Request
URLURL
https://{api_host}/api/vcenter/system-config/deployment-type
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, acquired from Create Session API under CIS product
vmware-api-session-id example
"b00db39f948d13ea1e59b4d6fce56389"
Request Body
Request Body
SystemConfigDeploymentTypeReconfigureSpec of mimetype application/json
Required
ReconfigureSpec to set the appliance type.
{
"type": "VCSA_EMBEDDED"
}
type
Required
The ApplianceType enumerated type defines the vCenter appliance types.
VCSA_EMBEDDED : vCenter Server Appliance with an embedded Platform Services Controller.
VCSA_EXTERNAL : vCenter Server Appliance with an external Platform Services Controller.
PSC_EXTERNAL : An external Platform Services Controller.
Possible values are: VCSA_EMBEDDED , VCSA_EXTERNAL , PSC_EXTERNAL
remote_psc
Optional
External PSC to register with when reconfiguring a VCSA_EMBEDDED appliance to a VCSA_EXTERNAL appliance. Only required when reconfiguring an VCSA_EMBEDDED node to a VCSA_EXTERNAL.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.unsupported : if the appliance is in CONFIGURED state and if not changing the type from VCSA_EMBEDDED to VCSA_EXTERNAL. | com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED or CONFIGURED state.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. if external PSC credentials are not valid.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
PowerCLI Client SDK Example
$SystemConfigDeploymentTypeReconfigureSpec = Initialize-SystemConfigDeploymentTypeReconfigureSpec -Type "VCSA_EMBEDDED"
Invoke-SetSystemConfigDeploymentType -SystemConfigDeploymentTypeReconfigureSpec $SystemConfigDeploymentTypeReconfigureSpec
PowerCLI Client SDK All Parameters Example
$DeploymentRemotePscSpec = Initialize-DeploymentRemotePscSpec -PscHostname "MyPscHostname" -HttpsPort 0 -SsoAdminPassword "MySsoAdminPassword" -SslThumbprint "MySslThumbprint" -SslVerify $false
$SystemConfigDeploymentTypeReconfigureSpec = Initialize-SystemConfigDeploymentTypeReconfigureSpec -Type "VCSA_EMBEDDED" -RemotePsc $DeploymentRemotePscSpec
Invoke-SetSystemConfigDeploymentType -SystemConfigDeploymentTypeReconfigureSpec $SystemConfigDeploymentTypeReconfigureSpec
cURL Command
curl -X PUT -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"remote_psc":{"https_port":0,"psc_hostname":"string","ssl_thumbprint":"string","ssl_verify":false,"sso_admin_password":"string"},"type":"VCSA_EMBEDDED"}' https://{api_host}/api/vcenter/system-config/deployment-type
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-deprecated-method: post
x-vmw-doc-deprecated-path: /rest/vcenter/system-config/deployment-type
x-vmw-doc-operation: reconfigure
Availability
Added in 7.0U2
