Developer Documentation
Check Migrate Active Directory
Released in v7.0.0Checks whether the provided Active Directory user has permission to join the migrated vCenter Server appliance to the domain.
Request
URLURL
https://{api_host}/rest/vcenter/deployment/migrate/active-directory?action=check
Request Body
Request Body
Contains
CheckRequestBody
of type application/json
(required)
{
"spec": {
"dns_servers": [
"string"
],
"domain": "string",
"password": "string",
"username": "string"
}
}| Required | Property Name | Type | Description |
|---|---|---|---|
| required | spec | ActiveDirectoryCheckSpec |
Information to connect to Active Directory. |
Response
Response
Response BodyResponse Body
200 OK returns
CheckResponseBody
of type application/json
This structure was autogenerated to hold a response body. It contains: Information about the success or failure of the checks that were performed.
{
"value": {
"result": {
"errors": [
{
"id": "string",
"time": "string"
}
],
"info": [
{
"id": "string",
"time": "string"
}
],
"warnings": [
{
"id": "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": "enum",
"deployment_type": "enum",
"dns_servers": [
"string"
],
"hostname": "string",
"sso_domain_name": "string",
"version": "string"
},
"status": "enum"
}
}| Property Name | Type | Description |
|---|---|---|
| value | DeploymentCheckInfo |
Information about the success or failure of the checks that were performed. |
Errors
| Code | Returns | Description |
|---|---|---|
| 401 | Error | com.vmware.vapi.std.errors.unauthenticated : if the caller is not authenticated. |
| 409 | Error | com.vmware.vapi.std.errors.not_allowed_in_current_state : if the appliance is not in INITIALIZED state. |
| default | Error | Not available |
| 400 | Error | com.vmware.vapi.std.errors.invalid_argument : if passed arguments are invalid. |
