This API has a deprecated equivalent from v7.0U1.
Repoint PSC Registration
DescriptionRepoint this vCenter Server appliance to a different external PSC.
Request
URLURL
https://{api_host}/api/vcenter/system-config/psc-registration?action=repoint
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
DeploymentRemotePscSpec of mimetype application/json
Required
RemotePscSpec structure containing information about the external PSC node to repoint this vCenter Server appliance to.
{
"psc_hostname": "string",
"sso_admin_password": "string"
}
string
psc_hostname
Required
The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered to.
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 when ssl_verify field is set to true. This field is only relevant if RemotePscSpec.ssl-verify is unset or has the value true.
boolean
ssl_verify
Optional
SSL verification should be enabled or disabled. If RemotePscSpec.ssl-verify is true and and RemotePscSpec.ssl-thumbprint is unset, the CA certificate will be used for verification. If RemotePscSpec.ssl-verify is true and RemotePscSpec.ssl-thumbprint is set then the thumbprint will be used for verification. No verification will be performed if RemotePscSpec.ssl-verify value is set to false. If unset, RemotePscSpec.ssl-verify true will be used.
Authentication
This operation uses the following authentication methods.
Errors
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the passed external PSC is not a replicating with the current PSC this appliance is registered with. if passed arguments are invalid. | com.vmware.vapi.std.errors.unsupported : if the current appliance is not of the type VCSA_EXTERNAL. | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is NOT in CONFIGURED state.
401
com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. if the passed external PSC credentials is invalid.
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
$DeploymentRemotePscSpec = Initialize-DeploymentRemotePscSpec -PscHostname "MyPscHostname" -SsoAdminPassword "MySsoAdminPassword"
Invoke-RepointSystemConfigPscRegistration -DeploymentRemotePscSpec $DeploymentRemotePscSpec
PowerCLI Client SDK All Parameters Example
$DeploymentRemotePscSpec = Initialize-DeploymentRemotePscSpec -PscHostname "MyPscHostname" -HttpsPort 0 -SsoAdminPassword "MySsoAdminPassword" -SslThumbprint "MySslThumbprint" -SslVerify $false
Invoke-RepointSystemConfigPscRegistration -DeploymentRemotePscSpec $DeploymentRemotePscSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"https_port":0,"psc_hostname":"string","ssl_thumbprint":"string","ssl_verify":false,"sso_admin_password":"string"}' https://{api_host}/api/vcenter/system-config/psc-registration?action=repoint
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/psc-registration
x-vmw-doc-operation: repoint
Availability
Added in 7.0U2
