This API has a deprecated equivalent from v7.0U1.
Check Install PSC Replicated
Checks whether the provided remote PSC is reachable and can be replicated.
Request
URLURL
https://{api_host}/api/vcenter/deployment/install/psc/replicated?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
DeploymentReplicatedPscSpec of mimetype application/json
Required
Information to configure a replicated PSC.
{
"partner_hostname": "string",
"sso_admin_password": "string"
}
string
partner_hostname
Required
The IP address or DNS resolvable name of the partner PSC appliance.
string
sso_admin_password
Required
The SSO administrator account password.
integer
https_port
Optional
The HTTPS port of the external PSC appliance. If unset, port 443 will be used.
string
ssl_thumbprint
Optional
SHA1 thumbprint of the server SSL certificate will be used for verification. This field is only relevant if ReplicatedSpec.ssl-verify is unset or has the value true.
boolean
ssl_verify
Optional
SSL verification should be enabled or disabled. If unset, ssl_verify true will be used.
string
sso_site_name
Optional
The SSO sitename that will be used in PSC replication. 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.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. if external PSC credentials are not valid when configuring PSC to replicate with an external existing PSC.
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
$DeploymentReplicatedPscSpec = Initialize-DeploymentReplicatedPscSpec -PartnerHostname "MyPartnerHostname" -SsoAdminPassword "MySsoAdminPassword"
Invoke-CheckPscReplicated -DeploymentReplicatedPscSpec $DeploymentReplicatedPscSpec
PowerCLI Client SDK All Parameters Example
$DeploymentReplicatedPscSpec = Initialize-DeploymentReplicatedPscSpec -SsoSiteName "MySsoSiteName" -PartnerHostname "MyPartnerHostname" -HttpsPort 0 -SsoAdminPassword "MySsoAdminPassword" -SslThumbprint "MySslThumbprint" -SslVerify $false
Invoke-CheckPscReplicated -DeploymentReplicatedPscSpec $DeploymentReplicatedPscSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"https_port":0,"partner_hostname":"string","ssl_thumbprint":"string","ssl_verify":false,"sso_admin_password":"string","sso_site_name":"string"}' https://{api_host}/api/vcenter/deployment/install/psc/replicated?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/replicated?action=check
x-vmw-doc-operation: check
Availability
Added in 7.0U2
