This API has a deprecated equivalent from v7.0U1.
Check Install PSC Standalone
Checks that the information to configure a non-replicated PSC satisfies the requirements.
Request
URLURL
https://{api_host}/api/vcenter/deployment/install/psc/standalone?action=check
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
DeploymentStandalonePscSpec of mimetype application/json
Required
Information to configure a non-replicated PSC.
{
"sso_admin_password": "string"
}
string
sso_admin_password
Required
The SSO administrator account password.
string
sso_domain_name
Optional
The SSO domain name to be used to configure this appliance. If unset, vsphere.local will be used.
string
sso_site_name
Optional
The SSO site name used for this PSC. If unset, default-first-site will be used.
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
Deployment_CheckInfo
of type application/json
Information about the success or failure of the checks that were performed.
Errors
400
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 state.
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
$DeploymentStandalonePscSpec = Initialize-DeploymentStandalonePscSpec -SsoAdminPassword "MySsoAdminPassword"
Invoke-CheckPscStandalone -DeploymentStandalonePscSpec $DeploymentStandalonePscSpec
PowerCLI Client SDK All Parameters Example
$DeploymentStandalonePscSpec = Initialize-DeploymentStandalonePscSpec -SsoSiteName "MySsoSiteName" -SsoAdminPassword "MySsoAdminPassword" -SsoDomainName "MySsoDomainName"
Invoke-CheckPscStandalone -DeploymentStandalonePscSpec $DeploymentStandalonePscSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"sso_admin_password":"string","sso_domain_name":"string","sso_site_name":"string"}' https://{api_host}/api/vcenter/deployment/install/psc/standalone?action=check
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/deployment/install/psc/standalone?action=check
x-vmw-doc-operation: check
Availability
Added in 7.0U2
