This API has a deprecated equivalent from v7.0U1.
Check Migrate Active Directory
Checks whether the provided Active Directory user has permission to join the migrated vCenter Server appliance to the domain.
Request
URLURL
https://{api_host}/api/vcenter/deployment/migrate/active-directory?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
DeploymentMigrateActiveDirectoryCheckSpec of mimetype application/json
Required
Information to connect to Active Directory.
{
"dns_servers": [
"string"
],
"domain": "string",
"password": "string",
"username": "string"
}
array of
string
dns_servers
Required
IP addresses of the DNS servers of the Active Directory server.
string
domain
Required
The domain name of the Active Directory server to which the migrated vCenter Server appliance should be joined.
string
password
Required
Active Directory user password that has permission to join the Active Directory after the vCenter Server is migrated to appliance.
string
username
Required
Active Directory user that has permission to join the Active Directory after the vCenter Server is migrated to appliance.
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.
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
$DeploymentMigrateActiveDirectoryCheckSpec = Initialize-DeploymentMigrateActiveDirectoryCheckSpec -DnsServers "MyDnsServers" -Domain "MyDomain" -Username "MyUsername" -Password "MyPassword"
Invoke-CheckMigrateActiveDirectory -DeploymentMigrateActiveDirectoryCheckSpec $DeploymentMigrateActiveDirectoryCheckSpec
cURL Command
curl -X POST -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" -H "Content-Type: application/json" -d '{"dns_servers":["string"],"domain":"string","password":"string","username":"string"}' https://{api_host}/api/vcenter/deployment/migrate/active-directory?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/migrate/active-directory?action=check
x-vmw-doc-operation: check
Availability
Added in 7.0U2
