Check Install PSC Replicated Deprecated
Checks whether the provided remote PSC is reachable and can be replicated.
Request
URLURL
https://{api_host}/rest/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
DeploymentInstallPscReplicatedCheckRequestBody of mimetype application/json
Required
This is a request body class for an operation.
(The request body parameter is missing description)
{
"spec": {
"partner_hostname": "string",
"sso_admin_password": "string"
}
}
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
DeploymentInstallPscReplicatedCheckResponseBody of type application/json
Information about the success or failure of the checks that were performed.
{
"value": {
"result": {
"errors": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
],
"info": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
],
"warnings": [
{
"id": "string",
"message": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"resolution": {
"args": [
"string"
],
"default_message": "string",
"id": "string",
"localized": "string",
"params": [
{
"key": "key1",
"value": {
"d": 0,
"dt": "string",
"format": "SHORT_DATE",
"i": 0,
"l": {
"id": "string",
"params": "StdLocalizationParam Object"
},
"precision": 0,
"s": "string"
}
}
]
},
"time": "string"
}
]
},
"source_info": {
"active_directory_domain": "string",
"data_migration_info": {
"all": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"all_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
},
"core_events_tasks_with_deferred": {
"estimated_export_time": 0,
"estimated_import_time": 0,
"required_free_disk_space_on_source": 0
}
},
"deployment_size": "TINY",
"deployment_type": "VCSA_EMBEDDED",
"dns_servers": [
"string"
],
"hostname": "string",
"sso_domain_name": "string",
"version": "string"
},
"status": "SUCCESS"
}
}
value
Optional
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
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"spec":{"https_port":0,"partner_hostname":"string","ssl_thumbprint":"string","ssl_verify":false,"sso_admin_password":"string","sso_site_name":"string"}}' https://{api_host}/rest/vcenter/deployment/install/psc/replicated?action=check
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-new-method: post
x-vmw-doc-new-path: /api/vcenter/deployment/install/psc/replicated?action=check
x-vmw-doc-operation: check
Availability
Added in 6.7
