Vcenter SystemConfig PscRegistration repoint
Repoint this vCenter Server appliance to a different external PSC.
This operation was added in vSphere API 6.7.
RemotePscSpec structure containing information about the external PSC node to repoint this vCenter Server appliance to.
Show optional properties
{
"psc_hostname": "string",
"sso_admin_password": "string"
}{
"psc_hostname": "string",
"https_port": 0,
"sso_admin_password": "string",
"ssl_thumbprint": "string",
"ssl_certificate": "string",
"ssl_verify": false
}The IP address or DNS resolvable name of the remote PSC to which this configuring vCenter Server will be registered to.
This property was added in vSphere API 6.7.
The HTTPS port of the external PSC appliance.
This property was added in vSphere API 6.7.
If missing or null, port 443 will be used.
The SSO administrator account password.
This property was added in vSphere API 6.7.
SHA1 thumbprint of the server SSL certificate will be used for verification when ssl_verify field is set to true.
This property was added in vSphere API 6.7.
This property is only relevant if ssl_verify is missing or null or has the value true.
The SSL Certificate of the server that will be used for verification. The value should be a single x509 certificate encoded in PEM format. Note: sslThumbprint and sslCertificate parameters are mutually exclusive, and should never be used simultaneously.
This property was added in vSphere API 9.0.0.0.
This property is only relevant if ssl_verify is missing or null or has the value true.
SSL verification should be enabled or disabled. If ssl_verify is true and and ssl_thumbprint is missing or null, the CA certificate will be used for verification. If ssl_verify is true and ssl_thumbprint is set then the thumbprint will be used for verification. No verification will be performed if ssl_verify value is set to false.
This property was added in vSphere API 6.7.
If missing or null, ssl_verify true will be used.
Success!
Vapi Std Errors InvalidArgument:
- if the passed external PSC is not a replicating with the current PSC this appliance is registered with.
- if passed arguments are invalid.
Vapi Std Errors Unsupported if the current appliance is not of the type VCSA_EXTERNAL.
Vapi Std Errors NotAllowedInCurrentState if the appliance is NOT in CONFIGURED state.
"Vapi Std Errors Error Object"Stack of one or more localizable messages for human error consumers.
The message at the top of the stack (first in the list) describes the error from the perspective of the operation the client invoked.
Each subsequent message in the stack describes the "cause" of the prior message.
Data to facilitate clients responding to the operation reporting a standard error to indicating that it was unable to complete successfully.
Operations may provide data that clients can use when responding to errors. Since the data that clients need may be specific to the context of the operation reporting the error, different operations that report the same error may provide different data in the error. The documentation for each each operation will describe what, if any, data it provides for each error it reports.
The Vapi Std Errors ArgumentLocations, Vapi Std Errors FileLocations, and Vapi Std Errors TransientIndication schemas are intended as possible values for this property. Vapi Std DynamicID may also be useful as a value for this property (although that is not its primary purpose). Some resources may provide their own specific schemas for use as the value of this property when reporting errors from their operations.
Some operations will not set this property when reporting errors.
Discriminator field to help API consumers identify the structure type.
For more information see: Vapi Std Errors Error Type.
This property was added in vSphere API 6.7.2.
Can be missing or null for compatibility with preceding implementations.
if the caller is not authenticated.
if the passed external PSC credentials is invalid.
"Vapi Std Errors Unauthenticated Object"Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.
For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"
This property was added in vSphere API 7.0.0.0.
This property is optional because it was added in a newer version than its parent node.
curl -X POST -H 'Authorization: <value>' -H 'Content-Type: application/json' -d '{"psc_hostname:"string","sso_admin_password:"string"}' https://{api_host}/api/vcenter/system-config/psc-registration?action=repoint